Build - refactor background process to use html (#10769)

* build - declare background as html * build - fill in empty file when a missing file is expected * lint - fix * Update development/build/manifest.js Co-authored-by: Mark Stacey <markjstacey@gmail.com> * Update development/build/manifest.js Co-authored-by: Mark Stacey <markjstacey@gmail.com> Co-authored-by: Mark Stacey <markjstacey@gmail.com>
4 years ago · 952adbce44
parent 2dadf4374a
commit 952adbce44
7 changed files with 42 additions and 32 deletions
--- a/.eslintrc.js
+++ b/.eslintrc.js
@ -26,7 +26,7 @@ module.exports = {
    'test-*/**',
    'docs/**',
    'coverage/',
-    'app/scripts/chromereload.js',
+    'development/chromereload.js',
    'app/vendor/**',
    'test/e2e/send-eth-with-private-key-test/**',
    'nyc_output/**',
--- a/app/background.html
+++ b/app/background.html
@ -0,0 +1,15 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+  </head>
+  <body>
+    <script src="./globalthis.js" type="text/javascript" charset="utf-8"></script>
+    <script src="./initSentry.js" type="text/javascript" charset="utf-8"></script>
+    <script src="./lockdown.js" type="text/javascript" charset="utf-8"></script>
+    <script src="./runLockdown.js" type="text/javascript" charset="utf-8"></script>
+    <script src="./bg-libs.js" type="text/javascript" charset="utf-8"></script>
+    <script src="./background.js" type="text/javascript" charset="utf-8"></script>
+    <script src="./chromereload.js" type="text/javascript" charset="utf-8"></script>
+  </body>
+</html>
--- a/app/manifest/_base.json
+++ b/app/manifest/_base.json
@ -1,14 +1,7 @@
 {
  "author": "https://metamask.io",
  "background": {
-    "scripts": [
-      "globalthis.js",
-      "initSentry.js",
-      "lockdown.js",
-      "runLockdown.js",
-      "bg-libs.js",
-      "background.js"
-    ],
+    "page": "background.html",
    "persistent": true
  },
  "browser_action": {
--- a/development/build/manifest.js
+++ b/development/build/manifest.js
@ -8,10 +8,6 @@ const { createTask, composeSeries } = require('./task');

 module.exports = createManifestTasks;

-const scriptsToExcludeFromBackgroundDevBuild = {
-  'bg-libs.js': true,
-};
-
 function createManifestTasks({ browserPlatforms }) {
  // merge base manifest with per-platform manifests
  const prepPlatforms = async () => {
@ -35,29 +31,13 @@ function createManifestTasks({ browserPlatforms }) {
    );
  };

-  // dev: remove bg-libs, add chromereload, add perms
+  // dev: add perms
  const envDev = createTaskForModifyManifestForEnvironment((manifest) => {
-    const scripts = manifest.background.scripts.filter(
-      (scriptName) => !scriptsToExcludeFromBackgroundDevBuild[scriptName],
-    );
-    scripts.push('chromereload.js');
-    manifest.background = {
-      ...manifest.background,
-      scripts,
-    };
    manifest.permissions = [...manifest.permissions, 'webRequestBlocking'];
  });

-  // testDev: remove bg-libs, add perms
+  // testDev: add perms
  const envTestDev = createTaskForModifyManifestForEnvironment((manifest) => {
-    const scripts = manifest.background.scripts.filter(
-      (scriptName) => !scriptsToExcludeFromBackgroundDevBuild[scriptName],
-    );
-    scripts.push('chromereload.js');
-    manifest.background = {
-      ...manifest.background,
-      scripts,
-    };
    manifest.permissions = [
      ...manifest.permissions,
      'webRequestBlocking',
--- a/development/build/static.js
+++ b/development/build/static.js
@ -80,13 +80,34 @@ const copyTargetsDev = [
    pattern: '/chromereload.js',
    dest: ``,
  },
+  // empty files to suppress missing file errors
+  {
+    src: './development/',
+    pattern: '/empty.js',
+    dest: `bg-libs.js`,
+  },
+  {
+    src: './development/',
+    pattern: '/empty.js',
+    dest: `ui-libs.js`,
+  },
+];
+
+const copyTargetsProd = [
+  ...copyTargets,
+  // empty files to suppress missing file errors
+  {
+    src: './development/',
+    pattern: '/empty.js',
+    dest: `chromereload.js`,
+  },
 ];

 function createStaticAssetTasks({ livereload, browserPlatforms }) {
  const prod = createTask(
    'static:prod',
    composeSeries(
-      ...copyTargets.map((target) => {
+      ...copyTargetsProd.map((target) => {
        return async function copyStaticAssets() {
          await performCopy(target);
        };
--- a/development/chromereload.js
+++ b/development/chromereload.js
--- a/development/empty.js
+++ b/development/empty.js
@ -0,0 +1 @@
+// this file intentionally left blank : )