Content Staging in Drupal 8
Download as ODP, PDF3 likes2,123 views
The document discusses the implementation of content staging in Drupal 8, focusing on a flexible content replication framework rather than just a content staging system. It outlines desired features such as bi-directional replication, conflict detection, and support for revisions, as well as the use of protocols inspired by Git and CouchDB. The document also highlights the contributions of various modules that enable these functionalities and invites community participation in improving Drupal.
![{
id: [{value: 1}],
uuid: [{value: aabbcc}]
_revs_info: [
{rev: 2-gghhii},
{rev: 1-ddeeff}
],
_local_seq: 1,
_deleted: 0,
}
multiversion.module](https://image.slidesharecdn.com/dixon-content-staging-d8-141001054258-phpapp02/85/Content-Staging-in-Drupal-8-19-320.jpg)
![<?php
namespace DrupalmultiversionEntity;
class SqlContentEntityStorage extends [...] {
use SqlContentEntityTrait;
//...
}
multiversion.module](https://image.slidesharecdn.com/dixon-content-staging-d8-141001054258-phpapp02/85/Content-Staging-in-Drupal-8-21-320.jpg)
Content Staging in Drupal 8
- 1. CONTENT STAGING IN DRUPAL 8 DICK OLSSON TWITTER: @dickolsson ADVANCED SITE BUILDING
- 2. AGENDA What is content staging? What we want from the solution How it's (being) built for Drupal 8 Reusable protocols Headless Drupal
- 3. WHO AM I? Dick Olsson Digital Engineering Manager at Pfizer dixon_ on drupal.org @dickolsson on Twitter Web technologist Drupal contributor
- 4. WHAT IS CONTENT STAGING?
- 5. SIMPLE WORKFLOW Stage Prod
- 6. SECURE PUBLISHING Stage Prod Corporate firewall
- 7. MERGE WORKFLOW Stage Edit 1 Edit 2 Edit 3 Prod
- 8. HUB/SPOKE WORKFLOW A D Editorial B C
- 9. RING MODEL A D B C
- 10. IT'S SORT OF... Content staging Content sharing Replication Syndication
- 11. WHAT WE WANT
- 12. WHAT WE WANT We don't want to build just a “content staging” system. We need a generic and loosely coupled “content replication” framework capable of arbitrarily moving content between system.
- 13. WHAT WE WANT Learning from the Drupal 7 implementations of UUID, Deploy and WF Tools modules.
- 14. WHAT WE WANT Revisions everywhere Conflict detection Easier dependency management Ad-hoc / Continuous replication Bi-directional replication REST API
- 15. HOW IT'S BUILT
- 16. HOW IT'S BUILT Contrib: Multiversion Relaxed Web Services Deploy Core: Serialization Restful Web Services Entity API
- 17. multiversion.module Tracks update sequences in order to make dependency management a lot easier. Provides revision support for all content entities. Tracks revision trees in a way similar to Git to support conflict detection.
- 18. multiversion.module Revisions are not tracked with a UUID. A hash calculated from the actual changes is better. This way it's easier for each server to detect conflicts without deep inspection or asking the network. <?php md5($this->serialize(array( $deleted, $sequence_id, $old_rev, $normalized_entity ), 'json'));
- 19. { id: [{value: 1}], uuid: [{value: aabbcc}] _revs_info: [ {rev: 2-gghhii}, {rev: 1-ddeeff} ], _local_seq: 1, _deleted: 0, } multiversion.module
- 20. multiversion.module CRAP instead of CRUD. Entities are never deleted. This is needed in order to replicate deletions while also being able to handle conflicts. Much like Git. A “compaction” job can be run on cron to purge old revisions if needed.
- 21. <?php namespace DrupalmultiversionEntity; class SqlContentEntityStorage extends [...] { use SqlContentEntityTrait; //... } multiversion.module
- 22. <?php namespace DrupalmultiversionEntity; class SequenceIndex implements SequenceIndexInterface { function _construct(KeyValueFactoryInterface $kv) {} // ... } multiversion.module
- 23. <?php namespace DrupalmultiversionEntity; class ConflictManager implements ConflictManagerIf { // ... } class CompactionManager implements CompactionManagerIf { // ... } multiversion.module
- 24. relaxed.module Provides a Restful/Relaxed JSON API. Endpoints for all content entities and file attachments. Endpoints for comparing revisions, starting/stopping replications and other administrative tasks. Drush plugin for running replications.
- 25. <?php namespace DrupalrelaxedPluginrestresource; /** * @RestResource( * id = “relaxed:doc” * ) */ class DocResource extends ResourceBase { //... } relaxed.module
- 26. <?php namespace DrupalrelaxedPluginrestresource; /** * @RestResource( * id = “relaxed:_bulk_docs” * ) */ class BulkDocsResource extends ResourceBase { //... } relaxed.module
- 27. <?php namespace DrupalrelaxedPluginrestresource; /** * @RestResource( * id = “relaxed:_changes” * ) */ class ChangesResource extends ResourceBase { //... } relaxed.module
- 28. <?php namespace DrupalrelaxedPluginrestresource; /** * @RestResource( * id = “relaxed:_revs_diff” * ) */ class RevsDiffResource extends ResourceBase { //... } relaxed.module
- 29. deploy.module A simple UI to manage replications and conflicts
- 30. HOW REPLICATION WORKS 1. Identify source and target by UUID 2. Get the current checkpoint from target site 3. GET /_changes?since=N from source site 4. Pass result to /_revs_diff on target site 5. Collect all missing revisions from source site 6. POST /_bulk_docs on target 7. Save new checkpoint on target site
- 31. DEMO
- 32. DEMO :-(
- 33. REUSABLE PROTOCOLS The revision and conflict detection model is taken from both Git and CouchDB. The replication protocol along with the API spec is taken from CouchDB.
- 34. REUSABLE PROTOCOLS Reusing API specifications lends the framework to unexpected use cases and that otherwise would not be possible (CouchDB, PouchDB, TouchDB etc).
- 35. HEADLESS DRUPAL AngularJS PouchDB Replication
- 36. CONCLUSIONS Not straight port of the Drupal 7 modules. Loosely coupled system will cover more use cases and lend itself to unexpected ones as well. Implementing battle tested protocols.
- 37. SPECIAL THANKS Andrei Jechiu (jeqq on drupal.org for working to these modules.
- 38. FRIDAY CODE SPRINT Follow @drupalmentoring https://amsterdam2014.drupal.org/sprints Help improve Drupal: Sprint with the community on Friday. - We have tasks for every skill set. - Mentors are available for new contributors. - An optional Friday morning workshop will help you set up community tools.
- 39. WHAT DID YOU THINK? EVAULATE THIS SESSION - AMSTERDAM2014.DRUPAL.ORG/SCHEDULE THANK YOU! DRUPAL: dixon_ TWITTER: @dickolsson