Merge pull request #6 from NerdWalletOSS/clangen/fix-release-preloads

Fix preload module loading in release builds.

app/.gitignore

@@ -11,6 +11,10 @@ node_modules
 /build
 /dist
 
+# generated files
+public/preload-manifest.js
+public/preload-module-*
+
 # misc
 .DS_Store
 .env.local

app/public/preload.js

@@ -13,6 +13,7 @@ const { app, dialog } = remote;
 const { spawn } = require('child_process');
 
 const version = remote.app.getVersion();
+const { isPackaged, getAppPath } = remote.app;
 
 const adb = require('@devicefarmer/adbkit').Adb;
 
@@ -55,7 +56,6 @@ const IS_MACOS = getPlatform() === 'mac';
 const getPathToBinary = (name) => {
   const resolvedName = IS_WINDOWS ? `${name}.exe` : name;
   const root = process.cwd();
-  const { isPackaged, getAppPath } = remote.app;
   const binariesPath = isPackaged
     ? path.join(path.dirname(getAppPath()), '..', './Resources', './bin')
     : path.join(root, './resources', getPlatform(), './bin');
@@ -410,23 +410,31 @@ global.ipc = {
  * JS modules, so they must use `require` and not `import`.
  */
 
-const PRELOADS_PATH = path.join(__dirname, '../src/App/Plugins/preloads.js');
-/* eslint-disable-next-line import/no-dynamic-require */
-const PRELOADS = require(PRELOADS_PATH).default();
+let PRELOADS;
+if (isPackaged) {
+  /* release builds cannot load preload scripts outside of the current working
+  directory; we have a build process to aggregate these all together at build
+  time, and place them in ./preload-modules.js. */
+  PRELOADS = require('./preload-manifest').default || [];
+} else {
+  /* debug builds load directly from the filesystem for quicker iteration and
+  easier debugging... */
+  const PRELOADS_PATH = '../src/App/Plugins/preloads.js';
+  /* eslint-disable-next-line import/no-dynamic-require */
+  PRELOADS = require(PRELOADS_PATH).default() || [];
+}
+
+console.log('[plugin-preloads', 'resolved', PRELOADS);
 PRELOADS.forEach((preloadPath) => {
-  if (fs.existsSync(preloadPath)) {
-    console.log('[plugin-preloads]', 'trying to load', preloadPath);
-    try {
-      /* eslint-disable-next-line import/no-dynamic-require */
-      const preload = require(preloadPath);
-      if (preload && preload.default && preload.default.start) {
-        console.log('[plugin-preloads]', 'starting', preloadPath);
-        preload.default.start(global.ipc);
-      }
-    } catch (e) {
-      console.warn('[plugin-preloads]', preloadPath, 'failed', e);
+  console.log('[plugin-preloads]', 'trying to load', preloadPath);
+  try {
+    /* eslint-disable-next-line import/no-dynamic-require */
+    const preload = require(preloadPath);
+    if (preload && preload.default && preload.default.start) {
+      console.log('[plugin-preloads]', 'starting', preloadPath);
+      preload.default.start(global.ipc);
     }
-  } else {
-    console.warn('[plugin-preloads]', `'${preloadPath}' file not found`);
+  } catch (e) {
+    console.warn('[plugin-preloads]', preloadPath, 'failed', e);
   }
 });

app/script/build-release.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 yarn install-patch
 yarn forwarder:build
+rm public/preload-manifest.js
+rm public/preload-module-*.js
+node script/collect-preload-scripts.js
 yarn build
 yarn package

app/script/collect-preload-scripts.js

@@ -0,0 +1,63 @@
+const path = require('path');
+const crypto = require('crypto');
+const fs = require('fs');
+
+console.log('\n\ncollecting preload scripts and generating manifest...\n\n');
+
+const preloadsModuleFn = path.join(
+  __dirname,
+  '..',
+  'src/App/Plugins/preloads.js'
+);
+
+const outDir = path.join(__dirname, '..', 'public');
+const outManifestFn = path.normalize(`${outDir}/preload-manifest.js`);
+
+const MANIFEST_TEMPLATE = `/* this is an automatically generated file, DO NOT MODIFY! */
+exports.default = [{{MODULES}}];`;
+
+/* eslint-disable-next-line import/no-dynamic-require */
+const preloadFilenames = require(preloadsModuleFn).default();
+const outputFilenames = new Set([]);
+
+console.log(preloadsModuleFn, preloadFilenames);
+
+const rmFile = (fn) => {
+  if (fs.existsSync(fn)) {
+    try {
+      fs.rmSync(fn);
+    } catch (e) {}
+    try {
+      fs.unlinkSync(fn);
+    } catch (e) {}
+  }
+};
+
+const copyFile = (inFn) => {
+  const hash = crypto
+    .createHash('sha256')
+    .update(inFn)
+    .digest('hex')
+    .toString();
+  const leaf = `preload-module-${hash}.js`;
+  const outFn = path.normalize(`${outDir}/${leaf}`);
+  rmFile(outFn);
+  outputFilenames.add(`'./${leaf}'`);
+  fs.copyFileSync(inFn, outFn);
+};
+
+for (let i = 0; i < preloadFilenames.length; i++) {
+  copyFile(preloadFilenames[i]);
+}
+
+const manifestEntries = Array.from(outputFilenames).join(', ');
+const manifestDocument = MANIFEST_TEMPLATE.replace(
+  '{{MODULES}}',
+  manifestEntries
+);
+rmFile(outManifestFn);
+fs.writeFileSync(outManifestFn, manifestDocument);
+
+console.log(
+  `\n\nwrote manifest to ${outManifestFn} with scripts: ${manifestEntries}\n\n`
+);

app/src/App/Plugins/preloads.js

@@ -8,7 +8,8 @@ const resolveExternalPreloads = () => {
       return resolver() || [];
     }
   } catch (e) {
-    console.error('failed to load external preloads', e);
+    console.warn('failed to load external preloads', e);
+    console.warn('the warning above can probably be safely ignored...');
   }
   return [];
 };