[Notebook] Do not persist notebook objects in notebook Local Storage (#3295)

* [Notebook] Do not persist domain objects on notebooks or snapshots #3291
Co-authored-by: Deep Tailor <deep.j.tailor@nasa.gov>

src/plugins/notebook/components/Notebook.vue

@@ -225,14 +225,12 @@ export default {
         },
         createNotebookStorageObject() {
             const notebookMeta = {
-                name: this.internalDomainObject.name,
                 identifier: this.internalDomainObject.identifier
             };
             const page = this.getSelectedPage();
             const section = this.getSelectedSection();
 
             return {
-                domainObject: this.internalDomainObject,
                 notebookMeta,
                 section,
                 page
@@ -442,10 +440,10 @@ export default {
         async updateDefaultNotebook(notebookStorage) {
             const defaultNotebookObject = await this.getDefaultNotebookObject();
             if (!defaultNotebookObject) {
-                setDefaultNotebook(this.openmct, notebookStorage);
+                setDefaultNotebook(this.openmct, notebookStorage, this.internalDomainObject);
             } else if (objectUtils.makeKeyString(defaultNotebookObject.identifier) !== objectUtils.makeKeyString(notebookStorage.notebookMeta.identifier)) {
                 this.removeDefaultClass(defaultNotebookObject);
-                setDefaultNotebook(this.openmct, notebookStorage);
+                setDefaultNotebook(this.openmct, notebookStorage, this.internalDomainObject);
             }
 
             if (this.defaultSectionId && this.defaultSectionId.length === 0 || this.defaultSectionId !== notebookStorage.section.id) {

src/plugins/notebook/components/NotebookMenuSwitcher.vue

@@ -44,38 +44,46 @@ export default {
     },
     data() {
         return {
-            notebookSnapshot: null,
+            notebookSnapshot: undefined,
             notebookTypes: []
         };
     },
     mounted() {
         validateNotebookStorageObject();
+        this.getDefaultNotebookObject();
 
         this.notebookSnapshot = new Snapshot(this.openmct);
         this.setDefaultNotebookStatus();
     },
     methods: {
-        showMenu(event) {
+        async getDefaultNotebookObject() {
-            const notebookTypes = [];
             const defaultNotebook = getDefaultNotebook();
+            const defaultNotebookObject = defaultNotebook && await this.openmct.objects.get(defaultNotebook.notebookMeta.identifier);
+
+            return defaultNotebookObject;
+        },
+        async showMenu(event) {
+            const notebookTypes = [];
             const elementBoundingClientRect = this.$el.getBoundingClientRect();
             const x = elementBoundingClientRect.x;
             const y = elementBoundingClientRect.y + elementBoundingClientRect.height;
 
-            if (defaultNotebook) {
+            const defaultNotebookObject = await this.getDefaultNotebookObject();
-                const domainObject = defaultNotebook.domainObject;
+            if (defaultNotebookObject) {
+                const name = defaultNotebookObject.name;
 
-                if (domainObject.location) {
+                const defaultNotebook = getDefaultNotebook();
-                    const defaultPath = `${domainObject.name} - ${defaultNotebook.section.name} - ${defaultNotebook.page.name}`;
+                const sectionName = defaultNotebook.section.name;
+                const pageName = defaultNotebook.page.name;
+                const defaultPath = `${name} - ${sectionName} - ${pageName}`;
 
-                    notebookTypes.push({
+                notebookTypes.push({
-                        cssClass: 'icon-notebook',
+                    cssClass: 'icon-notebook',
-                        name: `Save to Notebook ${defaultPath}`,
+                    name: `Save to Notebook ${defaultPath}`,
-                        callBack: () => {
+                    callBack: () => {
-                            return this.snapshot(NOTEBOOK_DEFAULT);
+                        return this.snapshot(NOTEBOOK_DEFAULT);
-                        }
+                    }
-                    });
+                });
-                }
             }
 
             notebookTypes.push({

src/plugins/notebook/utils/notebook-entriesSpec.js

@@ -23,13 +23,6 @@ import * as NotebookEntries from './notebook-entries';
 import { createOpenMct, resetApplicationState } from 'utils/testing';
 
 const notebookStorage = {
-    domainObject: {
-        name: 'notebook',
-        identifier: {
-            namespace: '',
-            key: 'test-notebook'
-        }
-    },
     notebookMeta: {
         name: 'notebook',
         identifier: {

src/plugins/notebook/utils/notebook-storage.js

@@ -1,13 +1,12 @@
+import objectUtils from 'objectUtils';
+
 const NOTEBOOK_LOCAL_STORAGE = 'notebook-storage';
-let currentNotebookObject = null;
+let currentNotebookObjectIdentifier = null;
 let unlisten = null;
 
 function defaultNotebookObjectChanged(newDomainObject) {
     if (newDomainObject.location !== null) {
-        currentNotebookObject = newDomainObject;
+        currentNotebookObjectIdentifier = newDomainObject.identifier;
-        const notebookStorage = getDefaultNotebook();
-        notebookStorage.domainObject = newDomainObject;
-        saveDefaultNotebook(notebookStorage);
 
         return;
     }
@@ -20,10 +19,9 @@ function defaultNotebookObjectChanged(newDomainObject) {
     clearDefaultNotebook();
 }
 
-function observeDefaultNotebookObject(openmct, notebookStorage) {
+function observeDefaultNotebookObject(openmct, notebookMeta, domainObject) {
-    const domainObject = notebookStorage.domainObject;
+    if (currentNotebookObjectIdentifier
-    if (currentNotebookObject
+            && objectUtils.makeKeyString(currentNotebookObjectIdentifier) === objectUtils.makeKeyString(notebookMeta.identifier)) {
-            && currentNotebookObject.identifier.key === domainObject.identifier.key) {
         return;
     }
 
@@ -32,7 +30,7 @@ function observeDefaultNotebookObject(openmct, notebookStorage) {
         unlisten = null;
     }
 
-    unlisten = openmct.objects.observe(notebookStorage.domainObject, '*', defaultNotebookObjectChanged);
+    unlisten = openmct.objects.observe(domainObject, '*', defaultNotebookObjectChanged);
 }
 
 function saveDefaultNotebook(notebookStorage) {
@@ -40,7 +38,7 @@ function saveDefaultNotebook(notebookStorage) {
 }
 
 export function clearDefaultNotebook() {
-    currentNotebookObject = null;
+    currentNotebookObjectIdentifier = null;
     window.localStorage.setItem(NOTEBOOK_LOCAL_STORAGE, null);
 }
 
@@ -50,8 +48,8 @@ export function getDefaultNotebook() {
     return JSON.parse(notebookStorage);
 }
 
-export function setDefaultNotebook(openmct, notebookStorage) {
+export function setDefaultNotebook(openmct, notebookStorage, domainObject) {
-    observeDefaultNotebookObject(openmct, notebookStorage);
+    observeDefaultNotebookObject(openmct, notebookStorage.notebookMeta, domainObject);
     saveDefaultNotebook(notebookStorage);
 }
 

src/plugins/notebook/utils/notebook-storageSpec.js

@@ -23,14 +23,15 @@
 import * as NotebookStorage from './notebook-storage';
 import { createOpenMct, resetApplicationState } from 'utils/testing';
 
+const domainObject = {
+    name: 'notebook',
+    identifier: {
+        namespace: '',
+        key: 'test-notebook'
+    }
+};
+
 const notebookStorage = {
-    domainObject: {
-        name: 'notebook',
-        identifier: {
-            namespace: '',
-            key: 'test-notebook'
-        }
-    },
     notebookMeta: {
         name: 'notebook',
         identifier: {
@@ -82,7 +83,7 @@ describe('Notebook Storage:', () => {
     });
 
     it('has correct notebookstorage on setDefaultNotebook', () => {
-        NotebookStorage.setDefaultNotebook(openmct, notebookStorage);
+        NotebookStorage.setDefaultNotebook(openmct, notebookStorage, domainObject);
         const defaultNotebook = NotebookStorage.getDefaultNotebook();
 
         expect(JSON.stringify(defaultNotebook)).toBe(JSON.stringify(notebookStorage));
@@ -98,7 +99,7 @@ describe('Notebook Storage:', () => {
             sectionTitle: 'Section'
         };
 
-        NotebookStorage.setDefaultNotebook(openmct, notebookStorage);
+        NotebookStorage.setDefaultNotebook(openmct, notebookStorage, domainObject);
         NotebookStorage.setDefaultNotebookSection(section);
 
         const defaultNotebook = NotebookStorage.getDefaultNotebook();
@@ -115,7 +116,7 @@ describe('Notebook Storage:', () => {
             pageTitle: 'Page'
         };
 
-        NotebookStorage.setDefaultNotebook(openmct, notebookStorage);
+        NotebookStorage.setDefaultNotebook(openmct, notebookStorage, domainObject);
         NotebookStorage.setDefaultNotebookPage(page);
 
         const defaultNotebook = NotebookStorage.getDefaultNotebook();