Optimistic Updates (#114)

* Optimistic Updates structure
* Optimistic update for Editorial Workflow

src/actions/editorialWorkflow.js

@@ -1,3 +1,5 @@
+import uuid from 'uuid';
+import { BEGIN, COMMIT, REVERT } from 'redux-optimist';
 import { currentBackend } from '../backends/backend';
 import { getMedia } from '../reducers';
 import { EDITORIAL_WORKFLOW } from '../constants/publishModes';
@@ -16,9 +18,12 @@ export const UNPUBLISHED_ENTRY_PERSIST_SUCCESS = 'UNPUBLISHED_ENTRY_PERSIST_SUCC
 
 export const UNPUBLISHED_ENTRY_STATUS_CHANGE_REQUEST = 'UNPUBLISHED_ENTRY_STATUS_CHANGE_REQUEST';
 export const UNPUBLISHED_ENTRY_STATUS_CHANGE_SUCCESS = 'UNPUBLISHED_ENTRY_STATUS_CHANGE_SUCCESS';
+export const UNPUBLISHED_ENTRY_STATUS_CHANGE_FAILURE = 'UNPUBLISHED_ENTRY_STATUS_CHANGE_FAILURE';
+
 
 export const UNPUBLISHED_ENTRY_PUBLISH_REQUEST = 'UNPUBLISHED_ENTRY_PUBLISH_REQUEST';
 export const UNPUBLISHED_ENTRY_PUBLISH_SUCCESS = 'UNPUBLISHED_ENTRY_PUBLISH_SUCCESS';
+export const UNPUBLISHED_ENTRY_PUBLISH_FAILURE = 'UNPUBLISHED_ENTRY_PUBLISH_FAILURE';
 
 /*
  * Simple Action Creators (Internal)
@@ -27,20 +32,20 @@ export const UNPUBLISHED_ENTRY_PUBLISH_SUCCESS = 'UNPUBLISHED_ENTRY_PUBLISH_SUCC
 function unpublishedEntryLoading(status, slug) {
   return {
     type: UNPUBLISHED_ENTRY_REQUEST,
-    payload: { status,  slug }
+    payload: { status, slug },
   };
 }
 
 function unpublishedEntryLoaded(status, entry) {
   return {
     type: UNPUBLISHED_ENTRY_SUCCESS,
-    payload: { status, entry }
+    payload: { status, entry },
   };
 }
 
 function unpublishedEntriesLoading() {
   return {
-    type: UNPUBLISHED_ENTRIES_REQUEST
+    type: UNPUBLISHED_ENTRIES_REQUEST,
   };
 }
 
@@ -48,9 +53,9 @@ function unpublishedEntriesLoaded(entries, pagination) {
   return {
     type: UNPUBLISHED_ENTRIES_SUCCESS,
     payload: {
-      entries: entries,
-      pages: pagination
-    }
+      entries,
+      pages: pagination,
+    },
   };
 }
 
@@ -66,49 +71,69 @@ function unpublishedEntriesFailed(error) {
 function unpublishedEntryPersisting(entry) {
   return {
     type: UNPUBLISHED_ENTRY_PERSIST_REQUEST,
-    payload: { entry }
+    payload: { entry },
   };
 }
 
 function unpublishedEntryPersisted(entry) {
   return {
     type: UNPUBLISHED_ENTRY_PERSIST_SUCCESS,
-    payload: { entry }
+    payload: { entry },
   };
 }
 
 function unpublishedEntryPersistedFail(error) {
   return {
     type: UNPUBLISHED_ENTRY_PERSIST_SUCCESS,
-    payload: { error }
+    payload: { error },
   };
 }
 
-function unpublishedEntryStatusChangeRequest(collection, slug, oldStatus, newStatus) {
+function unpublishedEntryStatusChangeRequest(collection, slug, oldStatus, newStatus, transactionID) {
   return {
     type: UNPUBLISHED_ENTRY_STATUS_CHANGE_REQUEST,
-    payload: { collection, slug, oldStatus, newStatus }
+    payload: { collection, slug, oldStatus, newStatus },
+    optimist: { type: BEGIN, id: transactionID },
   };
 }
 
-function unpublishedEntryStatusChangePersisted(collection, slug, oldStatus, newStatus) {
+function unpublishedEntryStatusChangePersisted(collection, slug, oldStatus, newStatus, transactionID) {
   return {
     type: UNPUBLISHED_ENTRY_STATUS_CHANGE_SUCCESS,
-    payload: { collection, slug, oldStatus, newStatus }
+    payload: { collection, slug, oldStatus, newStatus },
+    optimist: { type: COMMIT, id: transactionID },
   };
 }
 
-function unpublishedEntryPublishRequest(collection, slug, status) {
+function unpublishedEntryStatusChangeError(collection, slug, transactionID) {
+  return {
+    type: UNPUBLISHED_ENTRY_STATUS_CHANGE_FAILURE,
+    payload: { collection, slug },
+    optimist: { type: REVERT, id: transactionID },
+  };
+}
+
+function unpublishedEntryPublishRequest(collection, slug, status, transactionID) {
   return {
     type: UNPUBLISHED_ENTRY_PUBLISH_REQUEST,
-    payload: { collection, slug, status }
+    payload: { collection, slug, status },
+    optimist: { type: BEGIN, id: transactionID },
   };
 }
 
-function unpublishedEntryPublished(collection, slug, status) {
+function unpublishedEntryPublished(collection, slug, status, transactionID) {
   return {
     type: UNPUBLISHED_ENTRY_PUBLISH_SUCCESS,
-    payload: { collection, slug, status }
+    payload: { collection, slug, status },
+    optimist: { type: COMMIT, id: transactionID },
+  };
+}
+
+function unpublishedEntryPublishError(collection, slug, transactionID) {
+  return {
+    type: UNPUBLISHED_ENTRY_PUBLISH_FAILURE,
+    payload: { collection, slug },
+    optimist: { type: REVERT, id: transactionID },
   };
 }
 
@@ -122,7 +147,7 @@ export function loadUnpublishedEntry(collection, status, slug) {
     const backend = currentBackend(state.config);
     dispatch(unpublishedEntryLoading(status, slug));
     backend.unpublishedEntry(collection, slug)
-      .then((entry) => dispatch(unpublishedEntryLoaded(status, entry)));
+      .then(entry => dispatch(unpublishedEntryLoaded(status, entry)));
   };
 }
 
@@ -133,8 +158,8 @@ export function loadUnpublishedEntries() {
     const backend = currentBackend(state.config);
     dispatch(unpublishedEntriesLoading());
     backend.unpublishedEntries().then(
-      (response) => dispatch(unpublishedEntriesLoaded(response.entries, response.pagination)),
-      (error) => dispatch(unpublishedEntriesFailed(error))
+      response => dispatch(unpublishedEntriesLoaded(response.entries, response.pagination)),
+      error => dispatch(unpublishedEntriesFailed(error))
     );
   };
 }
@@ -149,7 +174,7 @@ export function persistUnpublishedEntry(collection, entry) {
       () => {
         dispatch(unpublishedEntryPersisted(entry));
       },
-      (error) => dispatch(unpublishedEntryPersistedFail(error))
+      error => dispatch(unpublishedEntryPersistedFail(error))
     );
   };
 }
@@ -158,10 +183,14 @@ export function updateUnpublishedEntryStatus(collection, slug, oldStatus, newSta
   return (dispatch, getState) => {
     const state = getState();
     const backend = currentBackend(state.config);
-    dispatch(unpublishedEntryStatusChangeRequest(collection, slug, oldStatus, newStatus));
+    const transactionID = uuid.v4();
+    dispatch(unpublishedEntryStatusChangeRequest(collection, slug, oldStatus, newStatus, transactionID));
     backend.updateUnpublishedEntryStatus(collection, slug, newStatus)
     .then(() => {
-      dispatch(unpublishedEntryStatusChangePersisted(collection, slug, oldStatus, newStatus));
+      dispatch(unpublishedEntryStatusChangePersisted(collection, slug, oldStatus, newStatus, transactionID));
+    })
+    .catch(() => {
+      dispatch(unpublishedEntryStatusChangeError(collection, slug, transactionID));
     });
   };
 }
@@ -170,10 +199,14 @@ export function publishUnpublishedEntry(collection, slug, status) {
   return (dispatch, getState) => {
     const state = getState();
     const backend = currentBackend(state.config);
+    const transactionID = uuid.v4();
     dispatch(unpublishedEntryPublishRequest(collection, slug, status));
-    backend.publishUnpublishedEntry(collection, slug, status)
+    backend.publishUnpublishedEntry(collection, slug, status, transactionID)
     .then(() => {
-      dispatch(unpublishedEntryPublished(collection, slug, status));
+      dispatch(unpublishedEntryPublished(collection, slug, status, transactionID));
+    })
+    .catch(() => {
+      dispatch(unpublishedEntryPublishError(collection, slug, transactionID));
     });
   };
 }