Couchdb object provider (#3245)

* Added legacy persistence service adapter
* Use new couch provider
* Added queuing of requests
Co-authored-by: Andrew Henry <akhenry@gmail.com>

platform/commonUI/edit/src/actions/SaveAsAction.js

@@ -79,12 +79,6 @@ function (
         return this.objectService;
     };
 
-    function resolveWith(object) {
-        return function () {
-            return object;
-        };
-    }
-
     /**
          * Save changes and conclude editing.
          *
@@ -102,7 +96,6 @@ function (
     SaveAsAction.prototype.save = function () {
         var self = this,
             domainObject = this.domainObject,
-            copyService = this.copyService,
             dialog = new SaveInProgressDialog(this.dialogService),
             toUndirty = [];
 
@@ -139,19 +132,22 @@ function (
             return fetchObject(object.getModel().location);
         }
 
-        function allowClone(objectToClone) {
-            var allowed =
-                    (objectToClone.getId() === domainObject.getId())
-                        || objectToClone.getCapability('location').isOriginal();
-            if (allowed) {
-                toUndirty.push(objectToClone);
-            }
-
-            return allowed;
+        function saveObject(parent) {
+            return self.openmct.editor.save().then(() => {
+                // Force mutation for search indexing
+                return parent;
+            });
         }
 
-        function cloneIntoParent(parent) {
-            return copyService.perform(domainObject, parent, allowClone);
+        function addSavedObjectToParent(parent) {
+            return parent.getCapability("composition")
+                .add(domainObject)
+                .then(function (addedObject) {
+                    return parent.getCapability("persistence").persist()
+                        .then(function () {
+                            return addedObject;
+                        });
+                });
         }
 
         function undirty(object) {
@@ -160,26 +156,17 @@ function (
 
         function undirtyOriginals(object) {
             return Promise.all(toUndirty.map(undirty))
-                .then(resolveWith(object));
+                .then(() => {
+                    return object;
+                });
         }
 
-        function saveAfterClone(clonedObject) {
-            return self.openmct.editor.save().then(() => {
-                // Force mutation for search indexing
-                return clonedObject;
-            });
-        }
-
-        function finishEditing(clonedObject) {
-            return fetchObject(clonedObject.getId());
-        }
-
-        function indexForSearch(savedObject) {
-            savedObject.useCapability('mutation', (model) => {
+        function indexForSearch(addedObject) {
+            addedObject.useCapability('mutation', (model) => {
                 return model;
             });
 
-            return savedObject;
+            return addedObject;
         }
 
         function onSuccess(object) {
@@ -201,10 +188,12 @@ function (
             .then(doWizardSave)
             .then(showBlockingDialog)
             .then(getParent)
-            .then(cloneIntoParent)
+            .then(saveObject)
+            .then(addSavedObjectToParent)
             .then(undirtyOriginals)
-            .then(saveAfterClone)
-            .then(finishEditing)
+            .then((addedObject) => {
+                return fetchObject(addedObject.getId());
+            })
             .then(indexForSearch)
             .then(hideBlockingDialog)
             .then(onSuccess)

src/adapter/bundle.js

@@ -35,7 +35,8 @@ define([
     './services/LegacyObjectAPIInterceptor',
     './views/installLegacyViews',
     './policies/LegacyCompositionPolicyAdapter',
-    './actions/LegacyActionAdapter'
+    './actions/LegacyActionAdapter',
+    './services/LegacyPersistenceAdapter'
 ], function (
     ActionDialogDecorator,
     AdapterCapability,
@@ -51,7 +52,8 @@ define([
     LegacyObjectAPIInterceptor,
     installLegacyViews,
     legacyCompositionPolicyAdapter,
-    LegacyActionAdapter
+    LegacyActionAdapter,
+    LegacyPersistenceAdapter
 ) {
     return {
         name: 'src/adapter',
@@ -114,6 +116,15 @@ define([
                             "instantiate",
                             "topic"
                         ]
+                    },
+                    {
+                        provides: "persistenceService",
+                        type: "provider",
+                        priority: "fallback",
+                        implementation: function legacyPersistenceProvider(openmct) {
+                            return new LegacyPersistenceAdapter.default(openmct);
+                        },
+                        depends: ["openmct"]
                     }
                 ],
                 policies: [

src/adapter/services/LegacyPersistenceAdapter.js

@@ -0,0 +1,47 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+
+import objectUtils from 'objectUtils';
+
+export default class LegacyPersistenceAdapter {
+    constructor(openmct) {
+        this.openmct = openmct;
+    }
+
+    listObjects() {
+        return Promise.resolve([]);
+    }
+
+    listSpaces() {
+        return Promise.resolve(Object.keys(this.openmct.objects.providers));
+    }
+
+    updateObject(legacyDomainObject) {
+        return this.openmct.objects.save(legacyDomainObject.useCapability('adapter'));
+    }
+
+    readObject(keystring) {
+        let identifier = objectUtils.parseKeyString(keystring);
+
+        return this.openmct.legacyObject(this.openmct.objects.get(identifier));
+    }
+}

src/plugins/persistence/couch/CouchDocument.js

@@ -0,0 +1,53 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+
+/**
+ * A CouchDocument describes domain object model in a format
+ * which is easily read-written to CouchDB. This includes
+ * Couch's _id and _rev fields, as well as a separate
+ * metadata field which contains a subset of information found
+ * in the model itself (to support search optimization with
+ * CouchDB views.)
+ * @memberof platform/persistence/couch
+ * @constructor
+ * @param {string} id the id under which to store this mode
+ * @param {object} model the model to store
+ * @param {string} rev the revision to include (or undefined,
+ *        if no revision should be noted for couch)
+ * @param {boolean} whether or not to mark this document as
+ *        deleted (see CouchDB docs for _deleted)
+ */
+export default function CouchDocument(id, model, rev, markDeleted) {
+    return {
+        "_id": id,
+        "_rev": rev,
+        "_deleted": markDeleted,
+        "metadata": {
+            "category": "domain object",
+            "type": model.type,
+            "owner": "admin",
+            "name": model.name,
+            "created": Date.now()
+        },
+        "model": model
+    };
+}

src/plugins/persistence/couch/CouchObjectProvider.js

@@ -0,0 +1,156 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+
+import CouchDocument from "./CouchDocument";
+import CouchObjectQueue from "./CouchObjectQueue";
+
+const REV = "_rev";
+const ID = "_id";
+
+export default class CouchObjectProvider {
+    constructor(openmct, url, namespace) {
+        this.openmct = openmct;
+        this.url = url;
+        this.namespace = namespace;
+        this.objectQueue = {};
+    }
+
+    request(subPath, method, value) {
+        return fetch(this.url + '/' + subPath, {
+            method: method,
+            body: JSON.stringify(value)
+        }).then(response => response.json())
+            .then(function (response) {
+                return response;
+            }, function () {
+                return undefined;
+            });
+    }
+
+    // Check the response to a create/update/delete request;
+    // track the rev if it's valid, otherwise return false to
+    // indicate that the request failed.
+    // persist any queued objects
+    checkResponse(response, intermediateResponse) {
+        let requestSuccess = false;
+        const id = response ? response.id : undefined;
+        let rev;
+        if (response && response.ok) {
+            rev = response.rev;
+            requestSuccess = true;
+        }
+
+        intermediateResponse.resolve(requestSuccess);
+
+        if (id) {
+            if (!this.objectQueue[id]) {
+                this.objectQueue[id] = new CouchObjectQueue(undefined, rev);
+            }
+
+            this.objectQueue[id].updateRevision(rev);
+            this.objectQueue[id].pending = false;
+            if (this.objectQueue[id].hasNext()) {
+                this.updateQueued(id);
+            }
+        }
+    }
+
+    getModel(response) {
+        if (response && response.model) {
+            let key = response[ID];
+            let object = response.model;
+            object.identifier = {
+                namespace: this.namespace,
+                key: key
+            };
+            if (!this.objectQueue[key]) {
+                this.objectQueue[key] = new CouchObjectQueue(undefined, response[REV]);
+            }
+
+            this.objectQueue[key].updateRevision(response[REV]);
+
+            return object;
+        } else {
+            return undefined;
+        }
+    }
+
+    get(identifier) {
+        return this.request(identifier.key, "GET").then(this.getModel.bind(this));
+    }
+
+    getIntermediateResponse() {
+        let intermediateResponse = {};
+        intermediateResponse.promise = new Promise(function (resolve, reject) {
+            intermediateResponse.resolve = resolve;
+            intermediateResponse.reject = reject;
+        });
+
+        return intermediateResponse;
+    }
+
+    enqueueObject(key, model, intermediateResponse) {
+        if (this.objectQueue[key]) {
+            this.objectQueue[key].enqueue({
+                model,
+                intermediateResponse
+            });
+        } else {
+            this.objectQueue[key] = new CouchObjectQueue({
+                model,
+                intermediateResponse
+            });
+        }
+    }
+
+    create(model) {
+        let intermediateResponse = this.getIntermediateResponse();
+        const key = model.identifier.key;
+        this.enqueueObject(key, model, intermediateResponse);
+        this.objectQueue[key].pending = true;
+        const queued = this.objectQueue[key].dequeue();
+        this.request(key, "PUT", new CouchDocument(key, queued.model)).then((response) => {
+            this.checkResponse(response, queued.intermediateResponse);
+        });
+
+        return intermediateResponse.promise;
+    }
+
+    updateQueued(key) {
+        if (!this.objectQueue[key].pending) {
+            this.objectQueue[key].pending = true;
+            const queued = this.objectQueue[key].dequeue();
+            this.request(key, "PUT", new CouchDocument(key, queued.model, this.objectQueue[key].rev)).then((response) => {
+                this.checkResponse(response, queued.intermediateResponse);
+            });
+        }
+    }
+
+    update(model) {
+        let intermediateResponse = this.getIntermediateResponse();
+        const key = model.identifier.key;
+        this.enqueueObject(key, model, intermediateResponse);
+        this.updateQueued(key);
+
+        return intermediateResponse.promise;
+    }
+}

src/plugins/persistence/couch/CouchObjectQueue.js

@@ -0,0 +1,51 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+
+export default class CouchObjectQueue {
+    constructor(object, rev) {
+        this.rev = rev;
+        this.objects = object ? [object] : [];
+        this.pending = false;
+    }
+
+    updateRevision(rev) {
+        this.rev = rev;
+    }
+
+    hasNext() {
+        return this.objects.length;
+    }
+
+    enqueue(item) {
+        this.objects.push(item);
+    }
+
+    dequeue() {
+        return this.objects.shift();
+    }
+
+    clear() {
+        this.rev = undefined;
+        this.objects = [];
+    }
+
+}

src/plugins/persistence/couch/plugin.js

@@ -0,0 +1,30 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+
+import CouchObjectProvider from './CouchObjectProvider';
+const NAMESPACE = '';
+
+export default function CouchPlugin(url) {
+    return function install(openmct) {
+        openmct.objects.addProvider(NAMESPACE, new CouchObjectProvider(openmct, url, NAMESPACE));
+    };
+}

src/plugins/persistence/couch/pluginSpec.js

@@ -0,0 +1,116 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+import CouchPlugin from './plugin.js';
+import {
+    createOpenMct,
+    resetApplicationState, spyOnBuiltins
+} from 'utils/testing';
+import CouchObjectProvider from './CouchObjectProvider';
+
+describe('the plugin', () => {
+    let openmct;
+    let element;
+    let child;
+    let provider;
+    let testSpace = 'testSpace';
+    let testPath = '/test/db';
+    let mockDomainObject = {
+        identifier: {
+            namespace: '',
+            key: 'some-value'
+        }
+    };
+
+    beforeEach((done) => {
+        openmct = createOpenMct(false);
+        openmct.install(new CouchPlugin(testSpace, testPath));
+
+        element = document.createElement('div');
+        child = document.createElement('div');
+        element.appendChild(child);
+
+        openmct.on('start', done);
+        openmct.startHeadless();
+
+        provider = openmct.objects.getProvider(mockDomainObject.identifier);
+        spyOn(provider, 'get').and.callThrough();
+        spyOn(provider, 'create').and.callThrough();
+        spyOn(provider, 'update').and.callThrough();
+
+        spyOnBuiltins(['fetch'], window);
+        fetch.and.returnValue(Promise.resolve({
+            json: () => {
+                return {
+                    ok: true,
+                    _id: 'some-value',
+                    _rev: 1,
+                    model: {}
+                };
+            }
+        }));
+    });
+
+    afterEach(() => {
+        return resetApplicationState(openmct);
+    });
+
+    it('gets an object', () => {
+        openmct.objects.get(mockDomainObject.identifier).then((result) => {
+            expect(result.identifier.key).toEqual(mockDomainObject.identifier.key);
+        });
+    });
+
+    it('creates an object', () => {
+        openmct.objects.save(mockDomainObject).then((result) => {
+            expect(provider.create).toHaveBeenCalled();
+            expect(result).toBeTrue();
+        });
+    });
+
+    it('updates an object', () => {
+        openmct.objects.save(mockDomainObject).then((result) => {
+            expect(result).toBeTrue();
+            expect(provider.create).toHaveBeenCalled();
+            openmct.objects.save(mockDomainObject).then((updatedResult) => {
+                expect(updatedResult).toBeTrue();
+                expect(provider.update).toHaveBeenCalled();
+            });
+        });
+    });
+
+    it('updates queued objects', () => {
+        let couchProvider = new CouchObjectProvider(openmct, 'http://localhost', '');
+        let intermediateResponse = couchProvider.getIntermediateResponse();
+        spyOn(couchProvider, 'updateQueued');
+        couchProvider.enqueueObject(mockDomainObject.identifier.key, mockDomainObject, intermediateResponse);
+        couchProvider.objectQueue[mockDomainObject.identifier.key].updateRevision(1);
+        couchProvider.update(mockDomainObject);
+        expect(couchProvider.objectQueue[mockDomainObject.identifier.key].hasNext()).toBe(2);
+        couchProvider.checkResponse({
+            ok: true,
+            rev: 2,
+            id: mockDomainObject.identifier.key
+        }, intermediateResponse);
+
+        expect(couchProvider.updateQueued).toHaveBeenCalledTimes(2);
+    });
+});

src/plugins/plugins.js

@@ -55,6 +55,7 @@ define([
     './URLTimeSettingsSynchronizer/plugin',
     './notificationIndicator/plugin',
     './newFolderAction/plugin',
+    './persistence/couch/plugin',
     './defaultRootName/plugin'
 ], function (
     _,
@@ -91,12 +92,12 @@ define([
     URLTimeSettingsSynchronizer,
     NotificationIndicator,
     NewFolderAction,
+    CouchDBPlugin,
     DefaultRootName
 ) {
     const bundleMap = {
         LocalStorage: 'platform/persistence/local',
         MyItems: 'platform/features/my-items',
-        CouchDB: 'platform/persistence/couch',
         Elasticsearch: 'platform/persistence/elastic'
     };
 
@@ -128,27 +129,7 @@ define([
 
     plugins.Conductor = TimeConductorPlugin.default;
 
-    plugins.CouchDB = function (url) {
-        return function (openmct) {
-            if (url) {
-                const bundleName = "config/couch";
-                openmct.legacyRegistry.register(bundleName, {
-                    "extensions": {
-                        "constants": [
-                            {
-                                "key": "COUCHDB_PATH",
-                                "value": url,
-                                "priority": "mandatory"
-                            }
-                        ]
-                    }
-                });
-                openmct.legacyRegistry.enable(bundleName);
-            }
-
-            openmct.legacyRegistry.enable(bundleMap.CouchDB);
-        };
-    };
+    plugins.CouchDB = CouchDBPlugin.default;
 
     plugins.Elasticsearch = function (url) {
         return function (openmct) {