A place to cache linked articles (think custom and personal wayback machine)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

index.md 19KB

4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  1. title: Eco-système et stockage générique
  2. url: http://www.servicedenuages.fr/eco-systeme-et-stockage-generique.html
  3. hash_url: 56a65f2910bbf3fc01d248c0826bbcf9
  4. <p>Comme nous l'écrivions <a class="reference external" href="http://www.servicedenuages.fr/service-de-nuages.html">dans l'article précédent</a>, nous souhaitons construire une
  5. solution de stockage générique.</p>
  6. <p>Notre objectif est simple: permettre aux développeurs d'application, internes
  7. à Mozilla ou du monde entier, de faire persister et synchroniser facilement des
  8. données associées à un utilisateur.</p>
  9. <p id="storage-specs">Les aspects de l'architecture qui nous semblent incontournables:</p>
  10. <ul class="simple">
  11. <li>La solution doit reposer sur un protocole, et non sur une implémentation ;</li>
  12. <li>L'auto-hébergement de l'ensemble doit être simplissime ;</li>
  13. <li>L'authentification doit être <em>pluggable</em>, voire décentralisée (OAuth2, FxA,
  14. Persona) ;</li>
  15. <li>Les enregistrements doivent pouvoir être validés par le serveur ;</li>
  16. <li>Les données doivent pouvoir être stockées dans n'importe quel backend ;</li>
  17. <li>Un système de permissions doit permettre de protéger des collections, ou de
  18. partager des enregistrements de manière fine ;</li>
  19. <li>La résolution de conflits doit pouvoir avoir lieu sur le serveur ;</li>
  20. <li>Le client doit être pensé «<em>offline-first</em>» ;</li>
  21. <li>Le client doit pouvoir réconcilier les données simplement ;</li>
  22. <li>Le client doit pouvoir être utilisé aussi bien dans le navigateur que côté
  23. serveur.</li>
  24. </ul>
  25. <p>La première question qui nous a été posée fût «<em>Pourquoi vous n'utilisez pas
  26. PouchDB ou Remote Storage ?</em>»</p>
  27. <div class="section" id="remote-storage">
  28. <h2>Remote Storage</h2>
  29. <p>Remote Storage est un standard ouvert pour du stockage par utilisateur. <a class="reference external" href="http://tools.ietf.org/html/draft-dejong-remotestorage-04">La
  30. specification</a> se
  31. base sur des standards déjà existants et éprouvés: Webfinger, OAuth 2, CORS et
  32. REST.</p>
  33. <p>L'API est simple, des <a class="reference external" href="http://blog.cozycloud.cc/news/2014/08/12/when-unhosted-meets-cozy-cloud/">projets prestigieux l'utilisent</a>.
  34. Il y a plusieurs <a class="reference external" href="https://github.com/jcoglan/restore">implémentations</a> du
  35. serveur, et il existe <a class="reference external" href="https://www.npmjs.com/package/remotestorage-server">un squelette Node</a> pour construire un
  36. serveur sur mesure.</p>
  37. <img alt="Remote Storage widget" class="align-left" src="http://www.servicedenuages.fr/images/remotestorage-widget.png"/>
  38. <p>Le client <a class="reference external" href="https://github.com/remotestorage/remotestorage.js/">remoteStorage.js</a> permet d'intégrer la
  39. solution dans les applications Web. Il se charge du «store local», du cache,
  40. de la synchronization, et fournit un widget qui permet aux utilisateurs des
  41. applications de choisir le serveur qui recevra les données (via Webfinger).</p>
  42. <p><a class="reference external" href="https://github.com/michielbdejong/ludbud">ludbud</a>, la version épurée de
  43. <em>remoteStorage.js</em>, se limite à l'abstraction du stockage distant. Cela
  44. permettrait à terme, d'avoir une seule bibliothèque pour stocker dans un
  45. serveur <em>remoteStorage</em>, <em>ownCloud</em> ou chez les méchants comme <em>Google Drive</em>
  46. ou <em>Dropbox</em>.</p>
  47. <p>Au premier abord, la spécification correspond à ce que nous voulons accomplir:</p>
  48. <ul class="simple">
  49. <li>La philosophie du protocole est saine;</li>
  50. <li>L'éco-système est bien fichu;</li>
  51. <li>La vision politique colle: redonner le contrôle des données aux utilisateurs
  52. (voir <a class="reference external" href="http://unhosted.org/">unhosted</a>);</li>
  53. <li>Les choix techniques compatibles avec ce qu'on a commencé (CORS, REST, OAuth 2);</li>
  54. </ul>
  55. <p>En revanche, vis à vis de la manipulation des données, il y a plusieurs
  56. différences avec ce que nous souhaitons faire:</p>
  57. <p>En résumé, il semblerait que ce que nous souhaitons faire avec le stockage
  58. d'enregistrements validés est complémentaire avec <em>Remote Storage</em>.</p>
  59. <p>Si des besoin de persistence orientés «fichiers» se présentent, a priori nous aurions tort
  60. de réinventer les solutions apportées par cette spécification. Il y a donc de grandes
  61. chances que nous l´intégrions à terme, et que <em>Remote Storage</em> devienne une facette
  62. de notre service.</p>
  63. </div>
  64. <div class="section" id="pouchdb">
  65. <h2>PouchDB</h2>
  66. <p><a class="reference external" href="http://pouchdb.com/">PouchDB</a> est une bibliothèque JavaScript qui permet
  67. de manipuler des enregistrements en local et de les synchroniser vers une base distante.</p>
  68. <div class="highlight"><pre><span class="kd">var</span> <span class="nx">db</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PouchDB</span><span class="p">(</span><span class="s1">'dbname'</span><span class="p">);</span>
  69. <span class="nx">db</span><span class="p">.</span><span class="nx">put</span><span class="p">({</span>
  70. <span class="nx">_id</span><span class="o">:</span> <span class="s1">'dave@gmail.com'</span><span class="p">,</span>
  71. <span class="nx">name</span><span class="o">:</span> <span class="s1">'David'</span><span class="p">,</span>
  72. <span class="nx">age</span><span class="o">:</span> <span class="mi">68</span>
  73. <span class="p">});</span>
  74. <span class="nx">db</span><span class="p">.</span><span class="nx">replicate</span><span class="p">.</span><span class="nx">to</span><span class="p">(</span><span class="s1">'http://example.com/mydb'</span><span class="p">);</span>
  75. </pre></div>
  76. <p>Le projet a le vent en poupe, bénéficie de nombreux contributeurs,
  77. l'éco-système est très riche et l'adoption par des projets <a class="reference external" href="https://github.com/hoodiehq/wip-hoodie-store-on-pouchdb">comme Hoodie</a> ne fait que
  78. confirmer la pertinence de l'outil pour les développeurs frontend.</p>
  79. <p><em>PouchDB</em> gère un « store » local, dont la persistence est abstraite et <a class="reference external" href="http://pouchdb.com/2014/07/25/pouchdb-levels-up.html">repose
  80. sur</a> l'API <a class="reference external" href="https://github.com/level/levelup#relationship-to-leveldown">LevelDown</a> pour persister
  81. les données dans <a class="reference external" href="https://github.com/Level/levelup/wiki/Modules#storage-back-ends">n'importe quel backend</a>.</p>
  82. <p>Même si <em>PouchDB</em> adresse principalement les besoins des applications
  83. «<em>offline-first</em>», il peut être utilisé aussi bien dans le navigateur que côté
  84. serveur, via Node.</p>
  85. <div class="section" id="synchronisation">
  86. <h3>Synchronisation</h3>
  87. <p>La synchronisation (ou réplication) des données locales s'effectue sur un
  88. <a class="reference external" href="http://couchdb.apache.org/">CouchDB</a> distant.</p>
  89. <p>Le projet <a class="reference external" href="https://github.com/pouchdb/pouchdb-server">PouchDB Server</a>
  90. implémente l'API de CouchDB en NodeJS. Comme <em>PouchDB</em> est utilisé, on obtient
  91. un service qui se comporte comme un <em>CouchDB</em> mais qui stocke ses données
  92. n'importe où, dans un <em>Redis</em> ou un <em>PostgreSQL</em> par exemple.</p>
  93. <p>La synchronisation est complète. Autrement dit, tous les enregistrements qui
  94. sont sur le serveur se retrouvent synchronisés dans le client. Il est possible
  95. de filtrer les collections synchronisées, mais cela <a class="reference external" href="http://pouchdb.com/2015/04/05/filtered-replication.html">n'a pas pour objectif de
  96. sécuriser l'accès aux données</a>.</p>
  97. <p>L'approche recommandée pour cloisonner les données par utilisateur consiste
  98. à créer <a class="reference external" href="https://github.com/nolanlawson/pouchdb-authentication#some-people-can-read-some-docs-some-people-can-write-those-same-docs">une base de données par utilisateur</a>.</p>
  99. <p>Ce n'est pas forcément un problème, CouchDB <a class="reference external" href="https://mail-archives.apache.org/mod_mbox/couchdb-user/201401.mbox/%3C52CEB873.7080404@ironicdesign.com%3E">supporte des centaines de milliers
  100. de bases sans sourciller</a>.
  101. Mais selon les cas d'utilisation, le cloisement n'est pas toujours facile
  102. à déterminer (par rôle, par application, par collection, ...).</p>
  103. </div>
  104. </div>
  105. <div class="section" id="le-cas-d-utilisation-payments">
  106. <h2>Le cas d'utilisation « Payments »</h2>
  107. <img alt="Put Payments Here -- Before the Internet - CC-NC-SA Katy Silberger https://www.flickr.com/photos/katysilbs/11163812186" src="http://www.servicedenuages.fr/images/put-payments.jpg"/>
  108. <p>Dans les prochaines semaines, nous devrons mettre sur pied un prototype pour
  109. tracer l'historique des paiements et abonnements d'un utilisateur.</p>
  110. <p>Le besoin est simple:</p>
  111. <ul class="simple">
  112. <li>l'application « Payment » enregistre les paiements et abonnements d'un
  113. utilisateur pour une application donnée;</li>
  114. <li>l'application « Donnée » interroge le service pour vérifier qu'un utilisateur
  115. a payé ou est abonné;</li>
  116. <li>l'utilisateur interroge le service pour obtenir la liste de tous ses
  117. abonnements.</li>
  118. </ul>
  119. <p>Seule l'application « Payment » a le droit de créer/modifier/supprimer des
  120. enregistrements, les deux autres ne peuvent que consulter en lecture seule.</p>
  121. <p>Une application donnée ne peut pas accéder aux paiements des autres
  122. applications, et un utilisateur ne peut pas accéder aux paiements des autres
  123. utilisateurs.</p>
  124. <div class="section" id="avec-remotestorage">
  125. <h3>Avec RemoteStorage</h3>
  126. <img alt="Remote Love - CC-BY-NC Julie https://www.flickr.com/photos/mamajulie2008/2609549461" class="align-center" src="http://www.servicedenuages.fr/images/remote-love.jpg"/>
  127. <p>Clairement, l'idée de <em>RemoteStorage</em> est de dissocier l'application executée,
  128. et les données crées par l'utilisateur avec celle-ci.</p>
  129. <p>Dans notre cas, c'est l'application « Payment » qui manipule des données
  130. concernant un utilisateur. Mais celles-ci ne lui appartiennent pas directement:
  131. certes un utilisateur doit pouvoir les supprimer, surtout pas en créer ou les
  132. modifier!</p>
  133. <p>La notion de permissions limitée à privé/publique ne suffit pas dans ce cas
  134. précis.</p>
  135. </div>
  136. <div class="section" id="avec-pouchdb">
  137. <h3>Avec PouchDB</h3>
  138. <p>Il va falloir créer une <em>base de données</em> par utilisateur, afin d'isoler les
  139. enregistrements de façon sécurisée. Seule l'application « Payment » aura tous
  140. les droits sur les databases.</p>
  141. <p>Mais cela ne suffit pas.</p>
  142. <p>Il ne faut pas qu'une application puisse voir les paiements des autres
  143. applications, donc il va aussi falloir recloisonner, et créer une <em>base de
  144. données</em> par application.</p>
  145. <p>Quand un utilisateur voudra accéder à l'ensemble de ses paiements, il faudra
  146. agréger les <em>databases</em> de toutes les applications. Quand l'équipe marketing
  147. voudra faire des statistiques sur l'ensemble des applications, il faudra
  148. agrégér des centaines de milliers de <em>databases</em>.</p>
  149. <p>Ce qui est fort dommage, puisqu'il est probable que les paiements ou
  150. abonnements d'un utilisateur pour une application se comptent sur les doigts
  151. d'une main. Des centaines de milliers de bases contenant moins de
  152. 5 enregistrements ?</p>
  153. <p>De plus, dans le cas de l'application « Payment », le serveur est implémenté en
  154. Python. Utiliser un wrapper JavaScript comme le fait <a class="reference external" href="https://pythonhosted.org/Python-PouchDB/">python-pouchdb</a> cela ne nous fait pas trop rêver.</p>
  155. </div>
  156. </div>
  157. <div class="section" id="un-nouvel-eco-systeme">
  158. <h2>Un nouvel éco-système ?</h2>
  159. <img alt="Wagon wheel - CC-BY-NC-SA arbyreed https://www.flickr.com/photos/19779889@N00/16161808220" src="http://www.servicedenuages.fr/images/wagon-wheel.jpg"/>
  160. <p>Évidemment, quand on voit la richesse des projets <em>PouchDB</em> et <em>Remote Storage</em>
  161. et la dynamique de ces communautés, il est légitime d'hésiter avant de
  162. développer une solution alternative.</p>
  163. <p>Quand nous avons créé le serveur <em>Reading List</em>, nous l'avons construit avec
  164. <a class="reference external" href="http://cliquet.readthedocs.org/">Cliquet</a>, ce fût l'occasion de mettre au
  165. point <a class="reference external" href="http://cliquet.readthedocs.org/en/latest/api/">un protocole très simple</a>, fortement inspiré de
  166. <a class="reference external" href="http://en.wikipedia.org/wiki/Firefox_Sync">Firefox Sync</a>, pour faire de la
  167. synchronisation d'enregistrements.</p>
  168. <p>Et si les clients <em>Reading List</em> ont pu être implémentés en quelques semaines,
  169. que ce soit en JavaScript, Java (Android) et ASM (Add-on Firefox), c'est que le
  170. principe «<em>offline first</em>» du service est trivial.</p>
  171. <div class="section" id="les-compromis">
  172. <h3>Les compromis</h3>
  173. <p>Évidemment, nous n'avons pas la prétention de concurrencer <em>CouchDB</em>. Nous faisons plusieurs
  174. concessions:</p>
  175. <ul class="simple">
  176. <li>De base, les collections d'enregistrements sont cloisonnées par utilisateur;</li>
  177. <li>Pas d'historique des révisions;</li>
  178. <li>Pas de diff sur les enregistrements entre révisions;</li>
  179. <li>De base, pas de résolution de conflit automatique;</li>
  180. <li>Pas de synchronisation par flux (<em>streams</em>);</li>
  181. </ul>
  182. <p>Jusqu'à preuve du contraire, ces compromis excluent la possibilité
  183. d'implémenter un <a class="reference external" href="https://github.com/pouchdb/pouchdb/blob/master/lib/adapters/http/http.js#L721-L946">adapter PouchDB</a>
  184. pour la synchronisation avec le protocole HTTP de <em>Cliquet</em>.</p>
  185. <p>Dommage puisque capitaliser sur l'expérience client de <em>PouchDB</em> au niveau
  186. synchro client semble être une très bonne idée.</p>
  187. <p>En revanche, nous avons plusieurs fonctionnalités intéressantes:</p>
  188. <ul class="simple">
  189. <li>Pas de map-reduce;</li>
  190. <li>Synchronisation partielle et/ou ordonnée et/ou paginée ;</li>
  191. <li>Le client choisit, via des headers, d'écraser la donnée ou de respecter la version du serveur ;</li>
  192. <li>Un seul serveur à déployer pour N applications ;</li>
  193. <li>Auto-hébergement simplissime ;</li>
  194. <li>Le client peut choisir de ne pas utiliser de « store local » du tout ;</li>
  195. <li>Dans le client JS, la gestion du « store local » sera externalisée (on pense
  196. à <a class="reference external" href="https://github.com/mozilla/localForage">LocalForage</a> ou <a class="reference external" href="https://github.com/dfahlander/Dexie.js">Dexie.js</a>) ;</li>
  197. </ul>
  198. <p>Et, on répond au reste des <a class="reference external" href="storage-specs">specifications mentionnées au début de l'article</a> !</p>
  199. </div>
  200. <div class="section" id="les-arguments-philosophiques">
  201. <h3>Les arguments philosophiques</h3>
  202. <p>Il est <a class="reference external" href="http://en.wikipedia.org/wiki/Law_of_the_instrument">illusoire de penser qu'on peut tout faire avec un seul outil</a>.</p>
  203. <p>Nous avons d'autres cas d'utilisations dans les cartons qui semblent correspondre au scope de <em>PouchDB</em>
  204. (<em>pas de notion de permissions ou de partage, environnement JavaScript, ...</em>). Nous saurons en tirer
  205. profit quand cela s'avèrera pertinent !</p>
  206. <p>L'éco-système que nous voulons construire tentera de couvrir les cas d'utilisation
  207. qui sont mal adressés par <em>PouchDB</em>. Il se voudra:</p>
  208. <ul class="simple">
  209. <li>Basé sur notre protocole très simple ;</li>
  210. <li>Minimaliste et multi-usages (<em>comme la fameuse 2CV</em>) ;</li>
  211. <li>Naïf (<em>pas de rocket science</em>) ;</li>
  212. <li>Sans magie (<em>explicite et facile à réimplémenter from scratch</em>) ;</li>
  213. </ul>
  214. <p><a class="reference external" href="http://cliquet.readthedocs.org/en/latest/rationale.html">La philosophie et les fonctionnalités du toolkit python *Cliquet*</a> seront bien entendu
  215. à l'honneur :)</p>
  216. <p>Quant à <em>Remote Storage</em>, dès que le besoin se présentera, nous serons très fier
  217. de rejoindre l'initiative, mais pour l'instant cela nous paraît risqué de démarrer
  218. en tordant la solution.</p>
  219. </div>
  220. <div class="section" id="les-arguments-pratiques">
  221. <h3>Les arguments pratiques</h3>
  222. <p>Avant d'accepter de déployer une solution à base de <em>CouchDB</em>, les <em>ops</em> de Mozilla
  223. vont nous demander de leur prouver par A+B que ce n'est pas faisable avec
  224. les stacks qui sont déjà rodées en interne (i.e. MySQL, Redis, PostgreSQL).</p>
  225. <p>De plus, on doit s'engager sur une pérennité d'au moins 5 ans pour les données.
  226. Avec <em>Cliquet</em>, en utilisant le backend PostgreSQL, les données sont persistées
  227. à plat dans un <a class="reference external" href="https://github.com/mozilla-services/cliquet/blob/40aa33/cliquet/storage/postgresql/schema.sql#L14-L28">schéma PostgreSQL tout bête</a>.
  228. Ce qui ne sera pas le cas d'un adapteur LevelDown qui va manipuler des notions
  229. de révisions éclatées dans un schéma clé-valeur.</p>
  230. <p>Si nous basons le service sur <em>Cliquet</em>, tout le travail d'automatisation
  231. de la mise en production (<em>monitoring, builds RPM, Puppet...</em>) que nous avons
  232. fait pour <em>Reading List</em> est complètement réutilisable.</p>
  233. <p>De même, si on repart avec une stack complètement différente, nous allons
  234. devoir recommencer tout le travail de rodage, de profiling et d'optimisation
  235. effectué au premier trimestre.</p>
  236. </div>
  237. </div>
  238. <div class="section" id="les-prochaines-etapes">
  239. <h2>Les prochaines étapes</h2>
  240. <p>Et il est encore temps de changer de stratégie :) Nous aimerions avoir un
  241. maximum de retours ! C'est toujours une décision difficile à prendre...
  242. <tt class="docutils literal">&lt;/appel à troll&gt;</tt></p>
  243. <ul class="simple">
  244. <li>Tordre un éco-système existant vs. constuire sur mesure ;</li>
  245. <li>Maîtriser l'ensemble vs. s'intégrer ;</li>
  246. <li>Contribuer vs. refaire ;</li>
  247. <li>Guider vs. suivre.</li>
  248. </ul>
  249. <p>Nous avons vraiment l'intention de rejoindre l'initiative <a class="reference external" href="https://nobackend.org/">no-backend</a>, et ce premier pas n'exclue pas que nous convergions
  250. à terme ! Peut-être que nous allons finir par rendre notre service compatible
  251. avec <em>Remote Storage</em>, et peut-être que <em>PouchDB</em> deviendra plus agnostique
  252. quand au protocole de synchronisation...</p>
  253. <img alt="XKCD — Standards https://xkcd.com/927/" src="http://www.servicedenuages.fr/images/standards.png"/>
  254. <p>Utiliser ce nouvel écosystème pour le projet « Payments » va nous permettre de
  255. mettre au point un système de permissions (<em>basés sur les scopes OAuth</em>) qui
  256. correspond au besoin exprimé. Et nous avons bien l'intention de puiser dans
  257. <a class="reference external" href="http://blog.daybed.io/daybed-revival.html">notre expérience avec Daybed sur le sujet</a>.</p>
  258. <p>Nous extrairons aussi le code des clients implémentés pour <em>Reading List</em> afin
  259. de faire un client JavaScript minimaliste.</p>
  260. <p>En partant dans notre coin, nous prenons plusieurs risques:</p>
  261. <ul class="simple">
  262. <li>réinventer une roue dont nous n'avons pas connaissance;</li>
  263. <li>échouer à faire de l'éco-système <em>Cliquet</em> un projet communautaire;</li>
  264. <li>échouer à positionner <em>Cliquet</em> dans la niche des cas non couverts par PouchDB :)</li>
  265. </ul>
  266. <p>Comme <a class="reference external" href="http://pouchdb.com/2015/04/05/filtered-replication.html">le dit Giovanni Ornaghi</a>:</p>
  267. <blockquote>
  268. Rolling out your set of webservices, push notifications, or background services
  269. might give you more control, but at the same time it will force you to engineer,
  270. write, test, and maintain a whole new ecosystem.</blockquote>
  271. <p>C'est justement l'éco-système dont est responsable l'équipe <em>Mozilla Cloud Services</em>!</p>