Include declarativeNetRequest JSON file rules as dependencies when bu…

…ndling web extensions (#8189)
parcel-bundler · Jun 13, 2022 · d2d0d33 · d2d0d33
1 parent 52296ad
commit d2d0d33
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 0 deletions.
diff --git a/packages/core/integration-tests/test/integration/webextension/manifest.json b/packages/core/integration-tests/test/integration/webextension/manifest.json
@@ -26,6 +26,13 @@
     "js": ["src/content.js"],
     "css": ["src/content.css"]
   }],
+  "declarative_net_request": {
+    "rule_resources": [{
+      "id": "ruleset_1",
+      "enabled": true,
+      "path": "./rulesets/ruleset_1.json"
+    }]
+  },
   "dictionaries": {
     "en-US": "./dicts/tmp.dic"
   },

diff --git a/packages/core/integration-tests/test/integration/webextension/rulesets/ruleset_1.json b/packages/core/integration-tests/test/integration/webextension/rulesets/ruleset_1.json
@@ -0,0 +1 @@
+[]
diff --git a/packages/core/integration-tests/test/webextension.js b/packages/core/integration-tests/test/webextension.js
@@ -35,6 +35,9 @@ describe('webextension', function () {
       {assets: ['devtools.html']},
       {assets: ['content.js']},
       {assets: ['content.css']},
+      {
+        assets: ['ruleset_1.json'],
+      },
     ]);
     assert(
       await outputFS.exists(
@@ -49,6 +52,10 @@ describe('webextension', function () {
     );
     const scripts = manifest.background.scripts;
     assert.equal(scripts.length, 1);
+    for (const {path: resourcePath} of manifest.declarative_net_request
+      ?.rule_resources ?? []) {
+      assert(await outputFS.exists(path.join(distDir, resourcePath)));
+    }
     assert(
       (
         await outputFS.readFile(path.join(distDir, scripts[0]), 'utf-8')

diff --git a/packages/transformers/webextension/src/WebExtensionTransformer.js b/packages/transformers/webextension/src/WebExtensionTransformer.js
@@ -218,6 +218,23 @@ async function collectDependencies(
     }
     program.web_accessible_resources = war;
   }
+  if (program.declarative_net_request) {
+    const rrs: {|path: string, id: string, enabled: boolean|}[] =
+      program.declarative_net_request?.rule_resources ?? [];
+    rrs.forEach((resources, i) => {
+      resources.path = asset.addURLDependency(resources.path, {
+        pipeline: 'raw',
+        loc: {
+          filePath,
+          ...getJSONSourceLocation(
+            ptrs[`/declarative_net_request/rule_resources/${i}/path`],
+            'value',
+          ),
+        },
+      });
+    });
+  }
+
   for (const loc of DEP_LOCS) {
     const location = '/' + loc.join('/');
     if (!ptrs[location]) continue;

diff --git a/packages/transformers/webextension/src/schema.js b/packages/transformers/webextension/src/schema.js
@@ -179,6 +179,26 @@ const commonProps = {
       required: ['matches'],
     },
   },
+  declarative_net_request: ({
+    type: 'object',
+    properties: {
+      rule_resources: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            id: string,
+            enabled: boolean,
+            path: string,
+          },
+          additionalProperties: false,
+          required: ['id', 'enabled', 'path'],
+        },
+      },
+    },
+    additionalProperties: false,
+    required: ['rule_resources'],
+  }: SchemaEntity),
   devtools_page: string,
   // looks to be FF only
   dictionaries: ({