Issue #2677938 by balsama, timmillwood, josephdpurcell, phenaproxima, jeqq, dixon_: Implement a Workspace Preview System

Author: balsama

.travis.yml

@@ -7,10 +7,10 @@ cache:
     - "$HOME/.drush/cache"
     - "$HOME/.npm"
 php:
-  - 7
   - 5.6
 env:
   - VERSION=HEAD
+  - VERSION=8.x-1.10
   - VERSION=8.x-1.06
   - VERSION=8.x-1.05
   - VERSION=8.x-1.04

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.10
+* Drupal core updated to 8.2.1.
+* Introduced Lightning Preview module and Workspace Preview System.
+
 ## 1.06
 * Drupal core updated to 8.2.0!
 * Previously, the Metatag module could break Drush. This is now patched

README.md

@@ -54,6 +54,13 @@ as many additional states as you like and define transitions between them. It's
 also possible to schedule content (either a single node or many at once) to be
 transitioned between states at a specific future date and time.
 
+## Preview (Experimental)
+The Workspace Preview System (WPS) gives site builders, editors, authors, and
+reviews the ability to send collections of content through an editorial workflow
+and preview that content within the context of the current live site. WPS is a
+collection of contributed Drupal modules with additional configuration UX
+improvements that all just works out of the box.
+
 ## Installing Lightning
 The preferred way to install Lightning is using our
 [Composer-based project template][template]. It's easy!
@@ -68,7 +75,6 @@ The roadmap is subject to change, but our projected schedule is:
 * QTR3/4, 2016
   * Point in time preview
   * Personalization
-  * Workspace Preview System
   * Remote replication (store workspaces on external apps)
   * Search API integration
 
@@ -94,11 +100,48 @@ If necessary, edit behat.local.yml to match your environment. Generally you
 will not need to do this.
 
 ## Known Issues
+
+### Media
+
 * If you upload an image into an image field using the new image browser, you
   can set the image's alt text at upload time, but that text will not be
   replicated to the image field. This is due to a limitation of Entity Browser's
   API.
 
+### Preview
+
+* This functionality relies on Multiversion, which:
+  * Does not yet have a stable release
+  * Modifies internal data structures
+  * Leaves permanent changes in the database after being uninstalled
+  * Introduces the concept of a trash bin. Deleted content is hidden, but not
+    immediately removed from the database anymore. It needs to be deleted and
+    then "purged" to be completely wiped from the database. However, the user
+    interface to purge deleted content is provided by the Trash module, which
+    is not yet ready. This makes it impossible to truly delete content from the
+    UI. (Lightning provides a shim for this, but it only works for nodes at this
+    time.)
+* There are several scenarios where URL aliases might produce unexpected
+  results, including:
+  * Pathauto is enabled, but rules are not configured for all content types
+  * Overriding aliases generated by Pathauto
+  * Aliases for any non-node entities
+* Blocks on the block listing page(s) are not properly filtered by workspace
+  under certain circumstances.
+* The Workspace listing page will display a PHP warning caused by the Workspace
+  module which is effectively harmless but may look alarming.
+* The Author user-reference relationship that is implicit with all Node Entities
+  is lost when replicating from workspace to workspace. So if UserA creates
+  NodeB on the Live workspace, and that node is pulled to the Stage workspace,
+  the Stage workspace will be unaware of the author and will set the author to
+  Anonymous. Furthermore, if an edit is then made to NodeB on the Stage
+  workspace, and that edit is pushed back to Live, NodeB on the Live workspace
+  will also lose its author.
+* There is no way yet to properly resolve conflicts between workspaces. Users
+  can delete conflicting entities from one of the two workspaces to remove
+  conflicts, but there is no interface yet for picking the winner and keeping
+  both versions.
+
 [issue_queue]: https://www.drupal.org/project/issues/lightning "Lightning Issue Queue"
 [template]: https://github.com/acquia/lightning-project "Composer-based project template"
 [d.o_semver]: https://www.drupal.org/node/1612910

UPDATE.md

@@ -54,6 +54,13 @@ use. For example, if you are currently running Beta 1 and are trying to update
 to Beta 3, you will need to follow the instructions for updating from Beta 1 to
 Beta 2, then from Beta 2 to Beta 3, in that order.
 
+## 1.06 to 1.10
+There are no manual update steps for this version.
+If you would like to test the new Lightning Preview module and Workspace Preview
+System in a development environment, enable the Lightning Preview module from
+module listing page. Note that Lightning Preview and WPS are not yet ready for
+production environements.
+
 ## 1.05 to 1.06
 There are no manual update steps for this version.
 

behat.yml

@@ -21,5 +21,7 @@ default:
         paths:
           - tests/features/bootstrap
         autoload: false
+      selectors:
+        login_form_selector: '#user-login-form'
 imports:
   - behat.local.yml

build-lightning.make

@@ -4,4 +4,4 @@ includes[] = drupal-org-core.make
 projects[lightning][type] = profile
 projects[lightning][download][type] = git
 projects[lightning][download][branch] = 8.x-1.x
-projects[lightning][download][tag] = 8.x-1.06
+projects[lightning][download][tag] = 8.x-1.10

build.xml

@@ -15,6 +15,7 @@
   <property name="profile" value="${docroot}/profiles/lightning" />
   <property name="site" value="${docroot}/sites/default" />
   <property name="version" value="HEAD" />
+  <property name="module" value="lightning_preview" />
 
   <!-- Finds Composer, NPM, and rsync. -->
   <target name="env">
@@ -117,6 +118,19 @@
     <exec command="${drush} config-set system.performance css.preprocess 0 --yes --format=boolean" dir="${docroot}" />
     <exec command="${drush} config-set system.performance js.preprocess 0 --yes --format=boolean" dir="${docroot}" />
     <exec command="${drush} config-set system.logging error_level all --yes" dir="${docroot}" />
+    <!--
+    Install Lightning Preview, which is not installed by default because it's experimental.
+    Enable passthru() for this as well since it has a lot of dependencies and is therefore
+    more prone to errors than other extensions.
+    -->
+    <exec command="${drush} pm-enable lightning_preview --yes" dir="${docroot}" passthru="true" />
+
+    <if>
+      <isset property="www.group" />
+      <then>
+        <chown file="${site}/files" user="${env.USER}" group="${www.group}" />
+      </then>
+    </if>
   </target>
 
   <!-- Builds the Lightning code base from HEAD, overwriting docroot, and
@@ -125,6 +139,7 @@
     <phingcall target="build" />
     <exec command="${drush} cache-rebuild" />
     <exec command="${drush} updatedb --yes" dir="${docroot}" passthru="true" />
+    <exec command="${drush} enable lightning_preview --yes" dir="${docroot}" passthru="true" />
     <!-- TODO: Execute manual update steps as needed. -->
   </target>
 

composer.json

@@ -53,10 +53,6 @@
             ]
         },
         "patches": {
-            "drupal/layout_plugin": {
-                "2811423: Add public getLayout() method to LayoutBase - via mega patch":
-                "https://www.drupal.org/files/issues/2747739-26--layout_plugin-alpha22-to-96a5cf90.patch"
-            },
             "drupal/panelizer": {
                 "2747739 - Mega Patch":
                 "https://www.drupal.org/files/issues/panelizer--alpha2-1ddfa61--2747739-5.patch",
@@ -94,6 +90,14 @@
             "drupal/metatag": {
                 "2786795 - DrupalConsole integration breaks Drush":
                 "https://www.drupal.org/files/issues/metatag-deactivate_drupalconsole_services_0.patch"
+            },
+            "drupal/workspace": {
+                "2791789 - Workspace should report conflicts before replication":
+                "https://www.drupal.org/files/issues/2791789-34.patch"
+            },
+            "drupal/replication": {
+                "2814055 - Allow modules to react to replication events":
+                "https://www.drupal.org/files/issues/2814055-2.patch"
             }
         }
     },
@@ -120,9 +124,18 @@
         "drupal/metatag": "8.1.0-beta10",
         "drupal/token": "^8.1.0",
         "drupal/pathauto": "^8.1.0",
+        "drupal/multiversion": "8.1.0-alpha10",
+        "drupal/workspace": "8.1.0-alpha3",
+        "drupal/replication": "8.1.0-alpha4",
+        "drupal/key_value": "^8.1.0",
         "drupal/entity_browser": "8.1.0-alpha9",
         "drupal/views_infinite_scroll": "^8.1.1",
         "drupal/media_entity_document": "^8.1.0",
         "drupal/video_embed_field": "^8.1.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Acquia\\LightningExtension\\": "src/LightningExtension"
+        }
     }
 }