Notebook Snapshot menu is only updating section and page names for the editor's view #3982 (#4002)

* if default section/page is missing then clear default notebook and hide option from dropdown.

* handle edge case when section is null/undefined.

* refactored notebook localstorage data + fixed some edge cases when default section/page gets deleted.

Co-authored-by: Shefali Joshi <simplyrender@gmail.com>

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

@@ -9,24 +9,24 @@ const TIME_BOUNDS = {
 };
 
 export function addEntryIntoPage(notebookStorage, entries, entry) {
-    const defaultSection = notebookStorage.section;
-    const defaultPage = notebookStorage.page;
-    if (!defaultSection || !defaultPage) {
+    const defaultSectionId = notebookStorage.defaultSectionId;
+    const defaultPageId = notebookStorage.defaultPageId;
+    if (!defaultSectionId || !defaultPageId) {
         return;
     }
 
     const newEntries = JSON.parse(JSON.stringify(entries));
-    let section = newEntries[defaultSection.id];
+    let section = newEntries[defaultSectionId];
     if (!section) {
-        newEntries[defaultSection.id] = {};
+        newEntries[defaultSectionId] = {};
     }
 
-    let page = newEntries[defaultSection.id][defaultPage.id];
+    let page = newEntries[defaultSectionId][defaultPageId];
     if (!page) {
-        newEntries[defaultSection.id][defaultPage.id] = [];
+        newEntries[defaultSectionId][defaultPageId] = [];
     }
 
-    newEntries[defaultSection.id][defaultPage.id].push(entry);
+    newEntries[defaultSectionId][defaultPageId].push(entry);
 
     return newEntries;
 }

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

@@ -23,28 +23,13 @@ import * as NotebookEntries from './notebook-entries';
 import { createOpenMct, resetApplicationState } from 'utils/testing';
 
 const notebookStorage = {
-    notebookMeta: {
-        name: 'notebook',
-        identifier: {
-            namespace: '',
-            key: 'test-notebook'
-        }
+    name: 'notebook',
+    identifier: {
+        namespace: '',
+        key: 'test-notebook'
     },
-    section: {
-        id: '03a79b6a-971c-4e56-9892-ec536332c3f0',
-        isDefault: true,
-        isSelected: true,
-        name: 'section',
-        pages: [],
-        sectionTitle: 'Section'
-    },
-    page: {
-        id: '8b548fd9-2b8a-4b02-93a9-4138e22eba00',
-        isDefault: true,
-        isSelected: true,
-        name: 'page',
-        pageTitle: 'Page'
-    }
+    defaultSectionId: '03a79b6a-971c-4e56-9892-ec536332c3f0',
+    defaultPageId: '8b548fd9-2b8a-4b02-93a9-4138e22eba00'
 };
 
 const notebookEntries = {

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

@@ -19,18 +19,22 @@ function defaultNotebookObjectChanged(newDomainObject) {
     clearDefaultNotebook();
 }
 
-function observeDefaultNotebookObject(openmct, notebookMeta, domainObject) {
+function observeDefaultNotebookObject(openmct, notebookStorage, domainObject) {
     if (currentNotebookObjectIdentifier
-            && objectUtils.makeKeyString(currentNotebookObjectIdentifier) === objectUtils.makeKeyString(notebookMeta.identifier)) {
+            && objectUtils.makeKeyString(currentNotebookObjectIdentifier) === objectUtils.makeKeyString(notebookStorage.identifier)) {
         return;
     }
 
+    removeListener();
+
+    unlisten = openmct.objects.observe(domainObject, '*', defaultNotebookObjectChanged);
+}
+
+function removeListener() {
     if (unlisten) {
         unlisten();
         unlisten = null;
     }
-
-    unlisten = openmct.objects.observe(domainObject, '*', defaultNotebookObjectChanged);
 }
 
 function saveDefaultNotebook(notebookStorage) {
@@ -39,6 +43,8 @@ function saveDefaultNotebook(notebookStorage) {
 
 export function clearDefaultNotebook() {
     currentNotebookObjectIdentifier = null;
+    removeListener();
+
     window.localStorage.setItem(NOTEBOOK_LOCAL_STORAGE, null);
 }
 
@@ -48,6 +54,17 @@ export function getDefaultNotebook() {
     return JSON.parse(notebookStorage);
 }
 
+export function getNotebookSectionAndPage(domainObject, sectionId, pageId) {
+    const configuration = domainObject.configuration;
+    const section = configuration && configuration.sections.find(s => s.id === sectionId);
+    const page = section && section.pages.find(p => p.id === pageId);
+
+    return {
+        section,
+        page
+    };
+}
+
 export async function getDefaultNotebookLink(openmct, domainObject = null) {
     if (!domainObject) {
         return null;
@@ -59,9 +76,9 @@ export async function getDefaultNotebookLink(openmct, domainObject = null) {
             .reverse()
             .join('/')
         );
-    const { page, section } = getDefaultNotebook();
+    const { defaultPageId, defaultSectionId } = getDefaultNotebook();
 
-    return `#/browse/${path}?sectionId=${section.id}&pageId=${page.id}`;
+    return `#/browse/${path}?sectionId=${defaultSectionId}&pageId=${defaultPageId}`;
 }
 
 export function setDefaultNotebook(openmct, notebookStorage, domainObject) {
@@ -69,15 +86,15 @@ export function setDefaultNotebook(openmct, notebookStorage, domainObject) {
     saveDefaultNotebook(notebookStorage);
 }
 
-export function setDefaultNotebookSection(section) {
+export function setDefaultNotebookSectionId(sectionId) {
     const notebookStorage = getDefaultNotebook();
-    notebookStorage.section = section;
+    notebookStorage.defaultSectionId = sectionId;
     saveDefaultNotebook(notebookStorage);
 }
 
-export function setDefaultNotebookPage(page) {
+export function setDefaultNotebookPageId(pageId) {
     const notebookStorage = getDefaultNotebook();
-    notebookStorage.page = page;
+    notebookStorage.defaultPageId = pageId;
     saveDefaultNotebook(notebookStorage);
 }
 

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

@@ -23,37 +23,44 @@
 import * as NotebookStorage from './notebook-storage';
 import { createOpenMct, resetApplicationState } from 'utils/testing';
 
+const notebookSection = {
+    id: 'temp-section',
+    isDefault: false,
+    isSelected: true,
+    name: 'section',
+    pages: [
+        {
+            id: 'temp-page',
+            isDefault: false,
+            isSelected: true,
+            name: 'page',
+            pageTitle: 'Page'
+        }
+    ],
+    sectionTitle: 'Section'
+};
+
 const domainObject = {
     name: 'notebook',
     identifier: {
         namespace: '',
         key: 'test-notebook'
+    },
+    configuration: {
+        sections: [
+            notebookSection
+        ]
     }
 };
 
 const notebookStorage = {
-    notebookMeta: {
-        name: 'notebook',
-        identifier: {
-            namespace: '',
-            key: 'test-notebook'
-        }
+    name: 'notebook',
+    identifier: {
+        namespace: '',
+        key: 'test-notebook'
     },
-    section: {
-        id: 'temp-section',
-        isDefault: false,
-        isSelected: true,
-        name: 'section',
-        pages: [],
-        sectionTitle: 'Section'
-    },
-    page: {
-        id: 'temp-page',
-        isDefault: false,
-        isSelected: true,
-        name: 'page',
-        pageTitle: 'Page'
-    }
+    defaultSectionId: 'temp-section',
+    defaultPageId: 'temp-page'
 };
 
 let openmct;
@@ -104,7 +111,7 @@ describe('Notebook Storage:', () => {
         expect(JSON.stringify(defaultNotebook)).toBe(JSON.stringify(notebookStorage));
     });
 
-    it('has correct section on setDefaultNotebookSection', () => {
+    it('has correct section on setDefaultNotebookSectionId', () => {
         const section = {
             id: 'new-temp-section',
             isDefault: true,
@@ -115,14 +122,14 @@ describe('Notebook Storage:', () => {
         };
 
         NotebookStorage.setDefaultNotebook(openmct, notebookStorage, domainObject);
-        NotebookStorage.setDefaultNotebookSection(section);
+        NotebookStorage.setDefaultNotebookSectionId(section.id);
 
         const defaultNotebook = NotebookStorage.getDefaultNotebook();
-        const newSection = defaultNotebook.section;
-        expect(JSON.stringify(section)).toBe(JSON.stringify(newSection));
+        const defaultSectionId = defaultNotebook.defaultSectionId;
+        expect(section.id).toBe(defaultSectionId);
     });
 
-    it('has correct page on setDefaultNotebookPage', () => {
+    it('has correct page on setDefaultNotebookPageId', () => {
         const page = {
             id: 'new-temp-page',
             isDefault: true,
@@ -132,10 +139,52 @@ describe('Notebook Storage:', () => {
         };
 
         NotebookStorage.setDefaultNotebook(openmct, notebookStorage, domainObject);
-        NotebookStorage.setDefaultNotebookPage(page);
+        NotebookStorage.setDefaultNotebookPageId(page.id);
 
         const defaultNotebook = NotebookStorage.getDefaultNotebook();
-        const newPage = defaultNotebook.page;
-        expect(JSON.stringify(page)).toBe(JSON.stringify(newPage));
+        const newPageId = defaultNotebook.defaultPageId;
+        expect(page.id).toBe(newPageId);
+    });
+
+    describe('is getNotebookSectionAndPage function searches and returns correct,', () => {
+        let section;
+        let page;
+
+        beforeEach(() => {
+            const sectionId = 'temp-section';
+            const pageId = 'temp-page';
+
+            const sectionAndpage = NotebookStorage.getNotebookSectionAndPage(domainObject, sectionId, pageId);
+            section = sectionAndpage.section;
+            page = sectionAndpage.page;
+        });
+
+        it('id for section from notebook domain object', () => {
+            expect(section.id).toEqual('temp-section');
+        });
+
+        it('name for section from notebook domain object', () => {
+            expect(section.name).toEqual('section');
+        });
+
+        it('sectionTitle for section from notebook domain object', () => {
+            expect(section.sectionTitle).toEqual('Section');
+        });
+
+        it('number of pages for section from notebook domain object', () => {
+            expect(section.pages.length).toEqual(1);
+        });
+
+        it('id for page from notebook domain object', () => {
+            expect(page.id).toEqual('temp-page');
+        });
+
+        it('name for page from notebook domain object', () => {
+            expect(page.name).toEqual('page');
+        });
+
+        it('pageTitle for page from notebook domain object', () => {
+            expect(page.pageTitle).toEqual('Page');
+        });
     });
 });