fix: timing of loading extensions

Author: qazbnm456

docs/state.md

@@ -2,7 +2,7 @@
 
 Lulumi browser takes advantage of using [vuex](https://github.com/vuejs/vuex) to store lots of information. If you are not familiar with it, I suggest taking a look at its [guide](https://vuex.vuejs.org/).
 
-# appState
+# State
 
 ```javascript
 {

src/main/api/lulumi-extension.ts

@@ -14,7 +14,6 @@ import './listeners';
 /* tslint:disable:max-line-length */
 
 const globalObject = global as Lulumi.API.GlobalObject;
-globalObject.persistentLoaded = false;
 
 // ../../shared/store/mainStore.ts
 const { default: mainStore } = require('../../shared/store/mainStore');
@@ -55,6 +54,7 @@ const getManifestFromPath: (srcDirectory: string) => Lulumi.API.ManifestObject |
     if (!manifestNameMap[manifest.name]) {
       const extensionId = generateExtensionIdFromName();
       manifestMap[extensionId] = manifestNameMap[manifest.name] = manifest;
+      globalObject.manifestMap = manifestMap;
 
       let messages = {};
       if (manifest.default_locale) {
@@ -123,6 +123,7 @@ const startBackgroundPages = (manifest: Lulumi.API.ManifestObject) => {
     webSecurity: false,
   });
   backgroundPages[manifest.extensionId] = { html, name, webContentsId: contents.id };
+  globalObject.backgroundPages = backgroundPages;
   contents.loadURL(urllib.format({
     protocol: 'lulumi-extension',
     slashes: true,
@@ -311,6 +312,9 @@ app.on('will-quit', () => {
 });
 
 app.whenReady().then(() => {
+  // load persisted extensions
+  loadExtensions();
+
   // the public API to add/remove extensions
   ((BrowserWindow as any) as Lulumi.BrowserWindow).addLulumiExtension = (srcDirectory: string): string => {
     const manifest = getManifestFromPath(srcDirectory);
@@ -352,22 +356,19 @@ app.whenReady().then(() => {
 // we can not use protocol or BrowserWindow until app is ready,
 // and hopefully, this function will be called after app is ready
 const loadExtensions = () => {
-  if (!globalObject.persistentLoaded) {
-    try {
-      const loadedExtensions = JSON.parse(fs.readFileSync(loadedExtensionsPath, 'utf8'));
-      if (Array.isArray(loadedExtensions)) {
-        for (const srcDirectory of loadedExtensions) {
-          // start background pages and set content scripts
-          const manifest = getManifestFromPath(srcDirectory);
-          if (manifest !== null) {
-            loadExtension(manifest);
-          }
+  try {
+    const loadedExtensions = JSON.parse(fs.readFileSync(loadedExtensionsPath, 'utf8'));
+    if (Array.isArray(loadedExtensions)) {
+      for (const srcDirectory of loadedExtensions) {
+        // start background pages and set content scripts
+        const manifest = getManifestFromPath(srcDirectory);
+        if (manifest !== null) {
+          loadExtension(manifest);
         }
       }
-    } catch (error) {
-      // ignore error
     }
-    globalObject.persistentLoaded = true;
+  } catch (error) {
+    // ignore error
   }
 };
 
@@ -376,5 +377,4 @@ export default {
   manifestNameMap,
   backgroundPages,
   registerLocalCommands,
-  loadExtensions,
 };

src/main/constants.ts

@@ -14,5 +14,5 @@ export default {
   lulumiPreloadPath: `${path.resolve(lulumiRootPath, 'dist')}`,
   lulumiPagesPath: `${path.resolve(lulumiHelperPath, 'pages')}`,
   lulumiPDFJSPath: `${path.resolve(lulumiHelperPath, 'pdfjs')}`,
-  lulumiRev: '4394e37117dec5924585f5fe41a45fa27f9fb156',
+  lulumiRev: '228257bc22568e8ef8b63c85cadbea512afb53e1',
 };

src/main/index.ts

@@ -51,7 +51,7 @@ if (process.env.NODE_ENV === 'development') {
 const storagePath: string = path.join(app.getPath('userData'), 'lulumi-state');
 const langPath: string = path.join(app.getPath('userData'), 'lulumi-lang');
 
-let appStateSaveHandler: any = null;
+let lulumiStateSaveHandler: any = null;
 let setLanguage: boolean = false;
 
 const autoHideMenuBarSetting: boolean = is.macos;
@@ -76,7 +76,7 @@ let windowCount: number = 0;
 // ./api/lulumi-extension.ts
 const { default: lulumiExtension } = require('./api/lulumi-extension');
 
-function appStateSave(soft: boolean = true): void {
+function lulumiStateSave(soft: boolean = true): void {
   if (!soft) {
     windowCount = Object.keys(windows).length;
     Object.keys(windows).forEach((key) => {
@@ -86,11 +86,11 @@ function appStateSave(soft: boolean = true): void {
       window.removeAllListeners('close');
     });
   }
-  mainStore.saveAppState(soft)
+  mainStore.saveLulumiState(soft)
     .then((state) => {
       if (state) {
         promisify(writeFile, storagePath, JSON.stringify(state)).then(() => {
-          if (appStateSaveHandler === null) {
+          if (lulumiStateSaveHandler === null) {
             shuttingDown = true;
             app.quit();
           }
@@ -184,7 +184,7 @@ function createWindow(options?: Electron.BrowserWindowConstructorOptions, callba
 
   if (process.env.NODE_ENV !== 'testing' || process.env.TEST_ENV !== 'e2e') {
     // save app-state every 5 mins
-    appStateSaveHandler = setInterval(appStateSave, 1000 * 60 * 5);
+    lulumiStateSaveHandler = setInterval(lulumiStateSave, 1000 * 60 * 5);
   }
   if (callback) {
     (mainWindow as any).callback = callback;
@@ -216,6 +216,7 @@ app.whenReady().then(() => {
   session.registerScheme(constants.lulumiPagesCustomProtocol);
   session.registerCertificateVerifyProc();
   session.registerWebRequestListeners();
+
   // load lulumi-state
   let data: string = '""';
   try {
@@ -247,9 +248,9 @@ app.whenReady().then(() => {
           }
         });
         (data as any).windows = [];
-        store.dispatch('setAppState', data);
+        store.dispatch('setLulumiState', data);
       } else {
-        store.dispatch('setAppState', data);
+        store.dispatch('setLulumiState', data);
         createWindow();
       }
     } else {
@@ -285,11 +286,11 @@ app.on('before-quit', (event: Electron.Event) => {
   }
   event.preventDefault();
   mainStore.updateWindowStates();
-  if (appStateSaveHandler !== null) {
-    clearInterval(appStateSaveHandler);
-    appStateSaveHandler = null;
+  if (lulumiStateSaveHandler !== null) {
+    clearInterval(lulumiStateSaveHandler);
+    lulumiStateSaveHandler = null;
   }
-  appStateSave(false);
+  lulumiStateSave(false);
 });
 
 // https://github.com/electron/electron/pull/12782
@@ -617,23 +618,14 @@ ipcMain.on('request-lang', (event: Electron.Event) => {
 
 // load extension objects for each BrowserWindow instance
 ipcMain.on('request-extension-objects', (event: Electron.Event) => {
-  // load persisted extensions
-  lulumiExtension.loadExtensions();
-
-  // assign extension objects to global variables
-  globalObject.backgroundPages = lulumiExtension.backgroundPages;
-  globalObject.manifestMap = lulumiExtension.manifestMap;
-
   Object.keys(windows).forEach((key) => {
     const id = parseInt(key, 10);
     const window = windows[id];
-    window.webContents.send(
-      'response-extension-objects',
-      lulumiExtension.manifestMap);
     Object.keys(lulumiExtension.manifestMap).forEach((manifest) => {
       lulumiExtension.registerLocalCommands(window, lulumiExtension.manifestMap[manifest]);
     });
   });
+  event.sender.send('response-extension-objects', lulumiExtension.manifestMap);
 });
 
 ipcMain.on('fetch-search-suggestions',

src/main/lib/menu.ts

@@ -1,52 +1,9 @@
-import { app, Menu, BrowserWindow, ipcMain } from 'electron';
+import { app, Menu, BrowserWindow } from 'electron';
 import { is } from 'electron-util';
 import i18n from './i18n';
-import * as fs from 'fs';
-import * as path from 'path';
 
 const { openProcessManager } = require('electron-process-manager');
 
-function reloadBrowserWindow(browserWindow: Electron.BrowserWindow): void {
-  const globalObject = global as Lulumi.API.GlobalObject;
-  const count = Object.keys(globalObject.backgroundPages).length;
-  let counting = 0;
-
-  const objectValues = object => Object.keys(object).map(key => object[key]);
-  if (count === 0) {
-    browserWindow.webContents.reloadIgnoringCache();
-  } else {
-    const loadedExtensionsPath = path.join(app.getPath('userData'), 'lulumi-extensions');
-    const loadedExtensions
-      = objectValues(globalObject.manifestMap).map(manifest => manifest.srcDirectory);
-    if (loadedExtensions.length > 0) {
-      try {
-        fs.mkdirSync(path.dirname(loadedExtensionsPath));
-      } catch (error) {
-        // Ignore error
-      }
-      fs.writeFileSync(loadedExtensionsPath, JSON.stringify(loadedExtensions));
-      globalObject.persistentLoaded = false;
-      ipcMain.on('force-reload-result', (event, success): void => {
-        if (success) {
-          counting += 1;
-          if (counting === count) {
-            ipcMain.removeAllListeners('force-reload-result');
-            browserWindow.webContents.reloadIgnoringCache();
-          }
-        } else {
-          ipcMain.removeAllListeners('force-reload-result');
-          browserWindow.webContents.reloadIgnoringCache();
-        }
-      });
-      Object.keys(globalObject.backgroundPages).forEach((extensionId) => {
-        browserWindow.webContents.send('remove-lulumi-extension', extensionId);
-      });
-    } else {
-      fs.unlinkSync(loadedExtensionsPath);
-    }
-  }
-}
-
 const getTemplate = () => {
   const template: Electron.MenuItemConstructorOptions[] = [
     {
@@ -397,7 +354,7 @@ const getTemplate = () => {
           click: () => {
             const browserWindow = BrowserWindow.getFocusedWindow();
             if (browserWindow !== null) {
-              reloadBrowserWindow(browserWindow);
+              browserWindow.webContents.reloadIgnoringCache();
             }
           },
         },

src/renderer/mainBrowserWindow/components/BrowserMainView.vue

@@ -1510,6 +1510,9 @@ export default class BrowserMainView extends Vue {
     }
   }
 
+  created() {
+    this.extensionService = new ExtensionService(this);
+  }
   beforeMount() {
     const ipc = this.$electron.ipcRenderer;
 
@@ -1542,8 +1545,6 @@ export default class BrowserMainView extends Vue {
         this.onNewTab(this.windowId, 'https://github.com/LulumiProject/lulumi-browser', true);
       }
     }
-
-    this.extensionService = new ExtensionService(this);
   }
   mounted() {
     if (is.macos) {

src/renderer/mainBrowserWindow/components/BrowserMainView/Navbar.vue

@@ -864,11 +864,9 @@ export default class Navbar extends Vue {
     });
     ipc.on('remove-lulumi-extension-result', (event: Electron.IpcMessageEvent, data): void => {
       if (data.result === 'OK') {
-        ipc.send('force-reload-result', true);
         (this.$parent as BrowserMainView).extensionService.update();
         this.$forceUpdate();
       } else {
-        ipc.send('force-reload-result', false);
         alert(data.result);
       }
     });

src/renderer/preferenceView/components/AboutMainView/Lulumi.vue

@@ -6,7 +6,7 @@
     el-table-column(:label="$t('about.lulumiPage.value')", width="180", align="center")
       template(slot-scope="scope")
         a.cell(v-if="scope.row.key === 'rev'", :href="`https://github.com/LulumiProject/lulumi-browser/commit/${scope.row.value}`") {{ scope.row.value.substring(0, 7) }}
-        .cell(v-else-if="scope.row.key === 'userData'", style="color: cornflowerblue; cursor: pointer;", @click="showItemInFolder(scope.row.value)") {{ scope.row.value }}
+        .cell(v-else-if="scope.row.key === 'userData'", style="color: cornflowerblue; cursor: pointer;", @click="openItem(scope.row.value)") {{ scope.row.value }}
         .cell(v-else) {{ scope.row.value }}
 </template>
 
@@ -28,8 +28,8 @@ export default class Lulumi extends Vue {
     return this.$store.getters.about;
   }
 
-  showItemInFolder(userData: string): void {
-    ipcRenderer.send('show-item-in-folder', userData);
+  openItem(userData: string): void {
+    ipcRenderer.send('open-item', userData);
   }
 }
 </script>

src/shared/store/actions.ts

@@ -237,8 +237,8 @@ export const actions = {
     });
   },
 
-  setAppState({ commit }, newState) {
-    commit(types.SET_APP_STATE, { newState });
+  setLulumiState({ commit }, newState) {
+    commit(types.SET_LULUMI_STATE, { newState });
   },
 
   createWindow({ commit }, { windowId, width, height, left, top, windowState, type }) {

src/shared/store/mainStore.ts

@@ -22,8 +22,6 @@ const isWindows: boolean = is.windows;
 
 const windows: Electron.BrowserWindow[] = [];
 
-let close: boolean = false;
-
 const broadcastMutations = (store) => {
   store.subscribe((mutation) => {
     Object.keys(windows).forEach((key) => {
@@ -80,7 +78,15 @@ function handleWindowProperty(window: Electron.BrowserWindow, action: string) {
 
 const register = (storagePath: string, swipeGesture: boolean): void => {
   ipcMain.on('vuex-connect', (event: Electron.Event) => {
-    const window = BrowserWindow.fromWebContents(event.sender);
+    let close: boolean = false;
+    const window: BrowserWindow = BrowserWindow.fromWebContents(event.sender);
+
+    // we've registered this window, so we just return
+    if (windows[window.id] !== undefined) {
+      event.returnValue = store.state;
+      return;
+    }
+
     window.setMaxListeners(0);
 
     window.on('blur', () => {
@@ -343,7 +349,7 @@ function collect(newStart: number, newTabs: Lulumi.Store.TabObject[], newCurrent
   };
 }
 
-function saveAppState(soft: boolean = true, bumpWindowIdsBy: number = 0): Promise<any> {
+function saveLulumiState(soft: boolean = true, bumpWindowIdsBy: number = 0): Promise<any> {
   const newStart = Math.ceil(Math.random() * 10000);
   const { tabObjects: newTabs, currentTabIndexes: newCurrentTabIndexes }
     = tabsOrdering(newStart, bumpWindowIdsBy);
@@ -373,7 +379,7 @@ function saveAppState(soft: boolean = true, bumpWindowIdsBy: number = 0): Promis
 }
 
 function bumpWindowIds(bumpWindowIdsBy: number) {
-  saveAppState(true, bumpWindowIdsBy).then((state) => {
+  saveLulumiState(true, bumpWindowIdsBy).then((state) => {
     if (state && state.windows.length > 0) {
       let tmpWindow: Electron.BrowserWindow;
       state.windows.forEach((window) => {
@@ -395,7 +401,7 @@ function bumpWindowIds(bumpWindowIdsBy: number) {
         }
       });
       state.windows = [];
-      store.dispatch('setAppState', state);
+      store.dispatch('setLulumiState', state);
     } else {
       (BrowserWindow as any).createWindow();
     }
@@ -418,7 +424,7 @@ export default {
   getStore: () => store,
   register,
   updateWindowStates,
-  saveAppState,
+  saveLulumiState,
   bumpWindowIds,
   getWindows: () => windows,
 };