chore: dynamically activate menu options when file is opened

alexzurbonsen · alexzurbonsen · commit 2be9cac5b804 · 2024-04-24T09:43:05.000+02:00
Signed-off-by: alexzurbonsen &lt;alexander.zur.bonsen@tngtech.com&gt;
diff --git a/src/ElectronBackend/main/listeners.ts b/src/ElectronBackend/main/listeners.ts
@@ -46,7 +46,7 @@ import {
   setGlobalBackendState,
 } from './globalBackendState';
 import logger from './logger';
-import {activateMenuOptions} from "./menu";
+import { activateMenuItems } from './menu';
 
 const outputFileEnding = '_attributions.json';
 const jsonGzipFileExtension = '.json.gz';
@@ -140,7 +140,7 @@ export async function handleOpeningFile(
   }
 
   await openFile(mainWindow, filePath);
-  activateMenuOptions();
+  activateMenuItems();
 }
 
 function initializeGlobalBackendState(
diff --git a/src/ElectronBackend/main/menu.ts b/src/ElectronBackend/main/menu.ts
@@ -25,33 +25,68 @@ import {
 } from './notice-document-helpers';
 import { UserSettings } from './user-settings';
 
-// type Item = {label: string, id: string}
+const INITIALLY_DISABLED_MENU_ITEMS = [
+  'save',
+  'projectMetadata',
+  'projectStatistics',
+  'followUp',
+  'compactComponentList',
+  'detailedComponentList',
+  'spdxYAML',
+  'spdxJSON',
+  'selectAll',
+  'searchAttributions',
+  'searchSignals',
+  'searchResourcesAll',
+  'searchResourceLinked',
+] as const;
 
-const MENU_ITEMS = {
-  file: {label: 'File', id: 'file'},
-  open: {label: 'Open File', id: 'open'},
-  save: {label: 'Save', id: 'save'},
-  export: {label: 'Export', id: 'export'},
-  followUp: {label: 'Follow-Up', id: 'follow-up'},
-  compactComponentList: {label: 'Compact component list', id: 'compact-list'},
-  detailedComponentList: {label: 'Detailed component list', id: 'detailed-list'},
-  spdxYAML: {label: 'SPDX (yaml)', id: 'spdx-yaml'},
-  spdxJSON: {label: 'SPDX (json)', id: 'spdx-json'},
-  projectMetadata: {label: 'Project Metadata', id: 'project-metadata'},
-  projectStatistics: {label: 'Project Statistics', id: 'project-statistics'},
-  pathToSources: {label: 'Set Path to Sources', id: 'path-to-sources'},
-  quit: {label: 'Quit', id: 'quit'},
-}
+type Item = { label: string; id: string };
 
-const INITIALLY_DISABLED_MENU_ITEM_IDS: Array<string> = [MENU_ITEMS.save.id, MENU_ITEMS.export.id, MENU_ITEMS.projectMetadata.id, MENU_ITEMS.projectStatistics.id]
+const INITIALLY_DISABLED_ITEM_INFO: Record<
+  (typeof INITIALLY_DISABLED_MENU_ITEMS)[number],
+  Item
+> = {
+  save: { label: 'Save', id: 'save' },
+  followUp: { label: 'Follow-Up', id: 'follow-up' },
+  compactComponentList: {
+    label: 'Compact component list',
+    id: 'compact-list',
+  },
+  detailedComponentList: {
+    label: 'Detailed component list',
+    id: 'detailed-list',
+  },
+  spdxYAML: { label: 'SPDX (yaml)', id: 'spdx-yaml' },
+  spdxJSON: { label: 'SPDX (json)', id: 'spdx-json' },
+  projectMetadata: { label: 'Project Metadata', id: 'project-metadata' },
+  projectStatistics: {
+    label: 'Project Statistics',
+    id: 'project-statistics',
+  },
+  selectAll: { label: 'Select All', id: 'select-all' },
+  searchAttributions: {
+    label: 'Search Attributions',
+    id: 'search-attributions',
+  },
+  searchSignals: { label: 'Search Signals', id: 'search-signals' },
+  searchResourcesAll: {
+    label: 'Search All Resources',
+    id: 'search-resources-all',
+  },
+  searchResourceLinked: {
+    label: 'Search Linked Resources',
+    id: 'search-resources-linked',
+  },
+};
 
 export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
   const webContents = mainWindow.webContents;
   const qaMode = await UserSettings.get('qaMode');
 
   return Menu.buildFromTemplate([
     {
-      label: MENU_ITEMS.file.label,
+      label: 'File',
       submenu: [
         {
           icon: getIconBasedOnTheme(
@@ -69,27 +104,25 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
             'icons/save-white.png',
             'icons/save-black.png',
           ),
-          label: MENU_ITEMS.save.label,
+          label: INITIALLY_DISABLED_ITEM_INFO.save.label,
           accelerator: 'CmdOrCtrl+S',
           click: () => {
             webContents.send(AllowedFrontendChannels.SaveFileRequest, {
               saveFile: true,
             });
           },
-          id: MENU_ITEMS.save.id,
+          id: INITIALLY_DISABLED_ITEM_INFO.save.id,
           enabled: false,
         },
         {
-          label: MENU_ITEMS.export.label,
+          label: 'Export',
           icon: getIconBasedOnTheme(
             'icons/export-white.png',
             'icons/export-black.png',
           ),
-          id: MENU_ITEMS.export.id,
-          enabled: false,
           submenu: [
             {
-              label: MENU_ITEMS.followUp.label,
+              label: INITIALLY_DISABLED_ITEM_INFO.followUp.label,
               icon: getIconBasedOnTheme(
                 'icons/follow-up-white.png',
                 'icons/follow-up-black.png',
@@ -102,13 +135,15 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.FollowUp,
                 );
               },
+              id: INITIALLY_DISABLED_ITEM_INFO.followUp.id,
+              enabled: false,
             },
             {
               icon: getIconBasedOnTheme(
                 'icons/com-list-white.png',
                 'icons/com-list-black.png',
               ),
-              label: MENU_ITEMS.compactComponentList.label,
+              label: INITIALLY_DISABLED_ITEM_INFO.compactComponentList.label,
               click: () => {
                 setLoadingState(mainWindow.webContents, true);
                 logger.info('Preparing data for compact component list export');
@@ -117,14 +152,15 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.CompactBom,
                 );
               },
-
+              id: INITIALLY_DISABLED_ITEM_INFO.compactComponentList.id,
+              enabled: false,
             },
             {
               icon: getIconBasedOnTheme(
                 'icons/det-list-white.png',
                 'icons/det-list-black.png',
               ),
-              label: MENU_ITEMS.detailedComponentList.label,
+              label: INITIALLY_DISABLED_ITEM_INFO.detailedComponentList.label,
               click: () => {
                 setLoadingState(mainWindow.webContents, true);
                 logger.info(
@@ -135,13 +171,15 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.DetailedBom,
                 );
               },
+              id: INITIALLY_DISABLED_ITEM_INFO.detailedComponentList.id,
+              enabled: false,
             },
             {
               icon: getIconBasedOnTheme(
                 'icons/yaml-white.png',
                 'icons/yaml-black.png',
               ),
-              label: MENU_ITEMS.spdxYAML.label,
+              label: INITIALLY_DISABLED_ITEM_INFO.spdxYAML.label,
               click: () => {
                 setLoadingState(mainWindow.webContents, true);
                 logger.info('Preparing data for SPDX (yaml) export');
@@ -150,13 +188,15 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.SpdxDocumentYaml,
                 );
               },
+              id: INITIALLY_DISABLED_ITEM_INFO.spdxYAML.id,
+              enabled: false,
             },
             {
               icon: getIconBasedOnTheme(
                 'icons/json-white.png',
                 'icons/json-black.png',
               ),
-              label: MENU_ITEMS.spdxJSON.label,
+              label: INITIALLY_DISABLED_ITEM_INFO.spdxJSON.label,
               click: () => {
                 setLoadingState(mainWindow.webContents, true);
                 logger.info('Preparing data for SPDX (json) export');
@@ -165,6 +205,8 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
                   ExportType.SpdxDocumentJson,
                 );
               },
+              id: INITIALLY_DISABLED_ITEM_INFO.spdxJSON.id,
+              enabled: false,
             },
           ],
         },
@@ -173,7 +215,7 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
             'icons/about-white.png',
             'icons/about-black.png',
           ),
-          label: MENU_ITEMS.projectMetadata.label,
+          label: INITIALLY_DISABLED_ITEM_INFO.projectMetadata.label,
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(
@@ -184,15 +226,15 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
               );
             }
           },
-          id: MENU_ITEMS.projectMetadata.id,
+          id: INITIALLY_DISABLED_ITEM_INFO.projectMetadata.id,
           enabled: false,
         },
         {
           icon: getIconBasedOnTheme(
             'icons/statictics-white.png',
             'icons/statictics-black.png',
           ),
-          label: MENU_ITEMS.projectStatistics.label,
+          label: INITIALLY_DISABLED_ITEM_INFO.projectStatistics.label,
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(
@@ -203,15 +245,15 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
               );
             }
           },
-          id: MENU_ITEMS.projectStatistics.id,
+          id: INITIALLY_DISABLED_ITEM_INFO.projectStatistics.id,
           enabled: false,
         },
         {
           icon: getIconBasedOnTheme(
             'icons/restore-white.png',
             'icons/restore-black.png',
           ),
-          label: MENU_ITEMS.pathToSources.label,
+          label: 'Set Path to Sources',
           click: () => {
             getSelectBaseURLListener(mainWindow)();
           },
@@ -221,7 +263,7 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
             'icons/quit-white.png',
             'icons/quit-black.png',
           ),
-          label: MENU_ITEMS.quit.label,
+          label: 'Quit',
           accelerator: 'CmdOrCtrl+Q',
           click: () => {
             app.quit();
@@ -283,62 +325,72 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
             'icons/select-all-white.png',
             'icons/select-all-black.png',
           ),
-          label: 'Select All',
+          label: INITIALLY_DISABLED_ITEM_INFO.selectAll.label,
           accelerator: 'CmdOrCtrl+A',
           role: 'selectAll',
+          id: INITIALLY_DISABLED_ITEM_INFO.selectAll.id,
+          enabled: false,
         },
         { type: 'separator' },
         {
           icon: getIconBasedOnTheme(
             'icons/magnifying-glass-white.png',
             'icons/magnifying-glass-black.png',
           ),
-          label: 'Search Attributions',
+          label: INITIALLY_DISABLED_ITEM_INFO.searchAttributions.label,
           accelerator: 'CmdOrCtrl+Shift+A',
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(AllowedFrontendChannels.SearchAttributions);
             }
           },
+          id: INITIALLY_DISABLED_ITEM_INFO.searchAttributions.id,
+          enabled: false,
         },
         {
           icon: getIconBasedOnTheme(
             'icons/magnifying-glass-white.png',
             'icons/magnifying-glass-black.png',
           ),
-          label: 'Search Signals',
+          label: INITIALLY_DISABLED_ITEM_INFO.searchSignals.label,
           accelerator: 'CmdOrCtrl+Shift+S',
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(AllowedFrontendChannels.SearchSignals);
             }
           },
+          id: INITIALLY_DISABLED_ITEM_INFO.searchSignals.id,
+          enabled: false,
         },
         {
           icon: getIconBasedOnTheme(
             'icons/search-white.png',
             'icons/search-black.png',
           ),
-          label: 'Search All Resources',
+          label: INITIALLY_DISABLED_ITEM_INFO.searchResourcesAll.label,
           accelerator: 'CmdOrCtrl+Shift+R',
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(AllowedFrontendChannels.SearchResources);
             }
           },
+          id: INITIALLY_DISABLED_ITEM_INFO.searchResourcesAll.id,
+          enabled: false,
         },
         {
           icon: getIconBasedOnTheme(
             'icons/search-white.png',
             'icons/search-black.png',
           ),
-          label: 'Search Linked Resources',
+          label: INITIALLY_DISABLED_ITEM_INFO.searchResourceLinked.label,
           accelerator: 'CmdOrCtrl+Shift+L',
           click: () => {
             if (isFileLoaded(getGlobalBackendState())) {
               webContents.send(AllowedFrontendChannels.SearchLinkedResources);
             }
           },
+          id: INITIALLY_DISABLED_ITEM_INFO.searchResourceLinked.id,
+          enabled: false,
         },
       ],
     },
@@ -480,19 +532,14 @@ export async function createMenu(mainWindow: BrowserWindow): Promise<Menu> {
   ]);
 }
 
-export function activateMenuOptions(): void {
+export function activateMenuItems(): void {
   const menu = Menu.getApplicationMenu();
-  // INITIALLY_DISABLED_MENU_ITEM_IDS.forEach((id) => {
-  //   console.log("key: ", id)
-  //   const item = menu?.getMenuItemById(id)
-  //   if (item) {
-  //     console.log("enable: ", item.label)
-  //     item.enabled = true;
-  //   }
-  // })
-  const save = menu?.getMenuItemById(MENU_ITEMS['save'].id)
-  if (save) {
-    console.log("heeereeeee");
-    save.enabled = true;
-  }
+  INITIALLY_DISABLED_MENU_ITEMS.forEach((key) => {
+    const menuItem = menu?.getMenuItemById(
+      INITIALLY_DISABLED_ITEM_INFO[key].id,
+    );
+    if (menuItem) {
+      menuItem.enabled = true;
+    }
+  });
 }

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ import {`
`46`	`46`	`setGlobalBackendState,`
`47`	`47`	`} from './globalBackendState';`
`48`	`48`	`import logger from './logger';`
`49`		`-import {activateMenuOptions} from "./menu";`
	`49`	`+import { activateMenuItems } from './menu';`
`50`	`50`
`51`	`51`	`const outputFileEnding = '_attributions.json';`
`52`	`52`	`const jsonGzipFileExtension = '.json.gz';`
`@@ -140,7 +140,7 @@ export async function handleOpeningFile(`
`140`	`140`	`}`
`141`	`141`
`142`	`142`	`await openFile(mainWindow, filePath);`
`143`		`- activateMenuOptions();`
	`143`	`+ activateMenuItems();`
`144`	`144`	`}`
`145`	`145`
`146`	`146`	`function initializeGlobalBackendState(`