feat!: optimize web accessible resources (#89)

adds an optimizeWebAccessibleResources option that, in Manifest V3, will merge web accessible resource definitions that have matching non-`resource` properties and dedupe and sort `resources`. In Manifest V2, will sort web accessible resources.
samrum · Apr 9, 2023 · d673de2 · d673de2
1 parent cd9590e
commit d673de2
Show file tree

Hide file tree

Showing 38 changed files with 1,331 additions and 281 deletions.
diff --git a/README.md b/README.md
@@ -167,6 +167,12 @@ useDynamicUrlWebAccessibleResources (optional)
 - Default: `true`
 - Adds the `use_dynamic_url` property to web accessible resources generated by the plugin
 
+optimizeWebAccessibleResources (optional)
+
+- Type: `boolean`
+- Default: `true`
+- On build, in Manifest V3, merge web accessible resource definitions that have matching non-`resource` properties and dedupe and sort `resources`. In Manifest V2, sort web accessible resources.
+
 devHtmlTransform (optional)
 
 - Type: `boolean`

diff --git a/src/manifestParser/manifestParser.ts b/src/manifestParser/manifestParser.ts
@@ -80,6 +80,10 @@ export default abstract class ManifestParser<
       result = await parseMethod(result, bundle);
     }
 
+    if (this.pluginOptions.optimizeWebAccessibleResources !== false) {
+      result = this.optimizeWebAccessibleResources(result);
+    }
+
     result.emitFiles.push({
       type: "asset",
       fileName: "manifest.json",
@@ -116,6 +120,10 @@ export default abstract class ManifestParser<
     bundle: OutputBundle
   ): Promise<ParseResult<Manifest>>;
 
+  protected abstract optimizeWebAccessibleResources(
+    result: ParseResult<Manifest>
+  ): ParseResult<Manifest>;
+
   protected parseInputAdditionalInputs(
     result: ParseResult<Manifest>
   ): ParseResult<Manifest> {

diff --git a/src/manifestParser/manifestV2.ts b/src/manifestParser/manifestV2.ts
@@ -120,4 +120,17 @@ export default class ManifestV2 extends ManifestParser<Manifest> {
 
     return result;
   }
+
+  protected optimizeWebAccessibleResources(
+    result: ParseResult<chrome.runtime.ManifestV2>
+  ): ParseResult<chrome.runtime.ManifestV2> {
+    if (!result.manifest.web_accessible_resources) {
+      return result;
+    }
+
+    result.manifest.web_accessible_resources =
+      result.manifest.web_accessible_resources.sort();
+
+    return result;
+  }
 }
diff --git a/src/manifestParser/manifestV3.ts b/src/manifestParser/manifestV3.ts
@@ -207,4 +207,39 @@ export default class ManifestV3 extends ManifestParser<Manifest> {
 
     return result;
   }
+
+  protected optimizeWebAccessibleResources(
+    result: ParseResult<chrome.runtime.ManifestV3>
+  ): ParseResult<chrome.runtime.ManifestV3> {
+    if (!result.manifest.web_accessible_resources) {
+      return result;
+    }
+
+    const resourceMap = new Map();
+
+    result.manifest.web_accessible_resources.forEach((resource) => {
+      const resourceKey = JSON.stringify({
+        ...resource,
+        resources: [],
+      });
+
+      if (resourceMap.has(resourceKey)) {
+        const existingEntry = resourceMap.get(resourceKey);
+
+        resourceMap.set(resourceKey, {
+          ...existingEntry,
+          ...resource,
+          resources: [
+            ...new Set([...existingEntry.resources, ...resource.resources]),
+          ].sort(),
+        });
+      } else {
+        resourceMap.set(resourceKey, resource);
+      }
+    });
+
+    result.manifest.web_accessible_resources = [...resourceMap.values()];
+
+    return result;
+  }
 }
diff --git a/test/manifest/__snapshots__/additionalInputsScriptsChunkedImport.v2.test.ts.snap b/test/manifest/__snapshots__/additionalInputsScriptsChunkedImport.v2.test.ts.snap
@@ -140,10 +140,10 @@ export {
   \\"name\\": \\"Manifest Name\\",
   \\"manifest_version\\": 2,
   \\"web_accessible_resources\\": [
-    \\"assets/test/manifest/resources/additionalInputsScriptsChunkedImport/script1.js\\",
     \\"assets/log.js\\",
-    \\"test/manifest/resources/additionalInputsScriptsChunkedImport/script1.js\\",
+    \\"assets/test/manifest/resources/additionalInputsScriptsChunkedImport/script1.js\\",
     \\"assets/test/manifest/resources/additionalInputsScriptsChunkedImport/script2.js\\",
+    \\"test/manifest/resources/additionalInputsScriptsChunkedImport/script1.js\\",
     \\"test/manifest/resources/additionalInputsScriptsChunkedImport/script2.js\\"
   ]
 }",

diff --git a/test/manifest/__snapshots__/additionalInputsScriptsChunkedImport.v3.test.ts.snap b/test/manifest/__snapshots__/additionalInputsScriptsChunkedImport.v3.test.ts.snap
@@ -142,19 +142,10 @@ export {
   \\"web_accessible_resources\\": [
     {
       \\"resources\\": [
-        \\"assets/test/manifest/resources/additionalInputsScriptsChunkedImport/script1.js\\",
         \\"assets/log.js\\",
-        \\"test/manifest/resources/additionalInputsScriptsChunkedImport/script1.js\\"
-      ],
-      \\"matches\\": [
-        \\"<all_urls>\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
+        \\"assets/test/manifest/resources/additionalInputsScriptsChunkedImport/script1.js\\",
         \\"assets/test/manifest/resources/additionalInputsScriptsChunkedImport/script2.js\\",
-        \\"assets/log.js\\",
+        \\"test/manifest/resources/additionalInputsScriptsChunkedImport/script1.js\\",
         \\"test/manifest/resources/additionalInputsScriptsChunkedImport/script2.js\\"
       ],
       \\"matches\\": [

diff --git a/test/manifest/__snapshots__/additionalInputsScriptsNoImport.v3.test.ts.snap b/test/manifest/__snapshots__/additionalInputsScriptsNoImport.v3.test.ts.snap
@@ -26,15 +26,7 @@ exports[`additionalInputsScriptsNoImport - Manifest V3 1`] = `
   \\"web_accessible_resources\\": [
     {
       \\"resources\\": [
-        \\"test/manifest/resources/additionalInputsScriptsNoImport/script1.js\\"
-      ],
-      \\"matches\\": [
-        \\"<all_urls>\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
+        \\"test/manifest/resources/additionalInputsScriptsNoImport/script1.js\\",
         \\"test/manifest/resources/additionalInputsScriptsNoImport/script2.js\\"
       ],
       \\"matches\\": [

diff --git a/test/manifest/__snapshots__/additionalInputsScriptsTypes.v3.test.ts.snap b/test/manifest/__snapshots__/additionalInputsScriptsTypes.v3.test.ts.snap
@@ -26,15 +26,7 @@ exports[`additionalInputsScriptsTypes - Manifest V3 1`] = `
   \\"web_accessible_resources\\": [
     {
       \\"resources\\": [
-        \\"test/manifest/resources/additionalInputsScriptsTypes/script1.js\\"
-      ],
-      \\"matches\\": [
-        \\"<all_urls>\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
+        \\"test/manifest/resources/additionalInputsScriptsTypes/script1.js\\",
         \\"test/manifest/resources/additionalInputsScriptsTypes/script2.js\\"
       ],
       \\"matches\\": [

diff --git a/test/manifest/__snapshots__/additionalInputsScriptsUnchunkedImport.v3.test.ts.snap b/test/manifest/__snapshots__/additionalInputsScriptsUnchunkedImport.v3.test.ts.snap
@@ -29,15 +29,7 @@ log(\\"script1\\");
   \\"web_accessible_resources\\": [
     {
       \\"resources\\": [
-        \\"test/manifest/resources/additionalInputsScriptsUnchunkedImport/script1.js\\"
-      ],
-      \\"matches\\": [
-        \\"<all_urls>\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
+        \\"test/manifest/resources/additionalInputsScriptsUnchunkedImport/script1.js\\",
         \\"test/manifest/resources/additionalInputsScriptsUnchunkedImport/script2.js\\"
       ],
       \\"matches\\": [

diff --git a/test/manifest/__snapshots__/additionalInputsStylesTypes.v3.test.ts.snap b/test/manifest/__snapshots__/additionalInputsStylesTypes.v3.test.ts.snap
@@ -29,15 +29,7 @@ exports[`additionalInputsStylesTypes - Manifest V3 1`] = `
   \\"web_accessible_resources\\": [
     {
       \\"resources\\": [
-        \\"test/manifest/resources/additionalInputsStylesTypes/style1.css\\"
-      ],
-      \\"matches\\": [
-        \\"<all_urls>\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
+        \\"test/manifest/resources/additionalInputsStylesTypes/style1.css\\",
         \\"test/manifest/resources/additionalInputsStylesTypes/style2.css\\"
       ],
       \\"matches\\": [

diff --git a/test/manifest/__snapshots__/additionalInputsWebAccessible.v2.test.ts.snap b/test/manifest/__snapshots__/additionalInputsWebAccessible.v2.test.ts.snap
@@ -219,17 +219,17 @@ export {
   \\"name\\": \\"Manifest Name\\",
   \\"manifest_version\\": 2,
   \\"web_accessible_resources\\": [
-    \\"test/manifest/resources/additionalInputsWebAccessible/script1.js\\",
-    \\"test/manifest/resources/additionalInputsWebAccessible/script3.js\\",
-    \\"test/manifest/resources/additionalInputsWebAccessible/script4.js\\",
-    \\"test/manifest/resources/additionalInputsWebAccessible/script5.js\\",
-    \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
     \\"assets/log.js\\",
-    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
+    \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
     \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
-    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
     \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\",
-    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\"
+    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
+    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
+    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\",
+    \\"test/manifest/resources/additionalInputsWebAccessible/script1.js\\",
+    \\"test/manifest/resources/additionalInputsWebAccessible/script3.js\\",
+    \\"test/manifest/resources/additionalInputsWebAccessible/script4.js\\",
+    \\"test/manifest/resources/additionalInputsWebAccessible/script5.js\\"
   ]
 }",
     "type": "asset",

diff --git a/test/manifest/__snapshots__/additionalInputsWebAccessible.v3.test.ts.snap b/test/manifest/__snapshots__/additionalInputsWebAccessible.v3.test.ts.snap
@@ -221,15 +221,7 @@ export {
   \\"web_accessible_resources\\": [
     {
       \\"resources\\": [
-        \\"test/manifest/resources/additionalInputsWebAccessible/script1.js\\"
-      ],
-      \\"matches\\": [
-        \\"<all_urls>\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
+        \\"test/manifest/resources/additionalInputsWebAccessible/script1.js\\",
         \\"test/manifest/resources/additionalInputsWebAccessible/script3.js\\"
       ],
       \\"matches\\": [
@@ -239,38 +231,12 @@ export {
     },
     {
       \\"resources\\": [
-        \\"test/manifest/resources/additionalInputsWebAccessible/script4.js\\"
-      ],
-      \\"matches\\": [
-        \\"https://example.com/\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
-        \\"test/manifest/resources/additionalInputsWebAccessible/script5.js\\"
-      ],
-      \\"extension_ids\\": [
-        \\"oilkjaldkfjlasdf\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
-        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
         \\"assets/log.js\\",
-        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\"
-      ],
-      \\"matches\\": [
-        \\"https://example.com/\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
+        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
         \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
-        \\"assets/log.js\\",
-        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\"
+        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
+        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
+        \\"test/manifest/resources/additionalInputsWebAccessible/script4.js\\"
       ],
       \\"matches\\": [
         \\"https://example.com/\\"
@@ -279,9 +245,10 @@ export {
     },
     {
       \\"resources\\": [
-        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\",
         \\"assets/log.js\\",
-        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\"
+        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\",
+        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\",
+        \\"test/manifest/resources/additionalInputsWebAccessible/script5.js\\"
       ],
       \\"extension_ids\\": [
         \\"oilkjaldkfjlasdf\\"

diff --git a/test/manifest/__snapshots__/additionalInputsWebAccessibleExcludeEntryFile.v2.test.ts.snap b/test/manifest/__snapshots__/additionalInputsWebAccessibleExcludeEntryFile.v2.test.ts.snap
@@ -233,17 +233,17 @@ export {
   \\"name\\": \\"Manifest Name\\",
   \\"manifest_version\\": 2,
   \\"web_accessible_resources\\": [
+    \\"assets/log.js\\",
+    \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
+    \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
+    \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\",
+    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
+    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
     \\"test/manifest/resources/additionalInputsWebAccessible/script1.js\\",
     \\"test/manifest/resources/additionalInputsWebAccessible/script2.js\\",
     \\"test/manifest/resources/additionalInputsWebAccessible/script3.js\\",
     \\"test/manifest/resources/additionalInputsWebAccessible/script5.js\\",
-    \\"test/manifest/resources/additionalInputsWebAccessible/script6.js\\",
-    \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
-    \\"assets/log.js\\",
-    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
-    \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
-    \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
-    \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\"
+    \\"test/manifest/resources/additionalInputsWebAccessible/script6.js\\"
   ]
 }",
     "type": "asset",

diff --git a/test/manifest/__snapshots__/additionalInputsWebAccessibleExcludeEntryFile.v3.test.ts.snap b/test/manifest/__snapshots__/additionalInputsWebAccessibleExcludeEntryFile.v3.test.ts.snap
@@ -244,15 +244,13 @@ export {
     },
     {
       \\"resources\\": [
-        \\"test/manifest/resources/additionalInputsWebAccessible/script2.js\\"
-      ],
-      \\"matches\\": [
-        \\"https://example.com/\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
+        \\"assets/log.js\\",
+        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
+        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
+        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\",
+        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
+        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
+        \\"test/manifest/resources/additionalInputsWebAccessible/script2.js\\",
         \\"test/manifest/resources/additionalInputsWebAccessible/script3.js\\"
       ],
       \\"matches\\": [
@@ -262,53 +260,13 @@ export {
     },
     {
       \\"resources\\": [
-        \\"test/manifest/resources/additionalInputsWebAccessible/script5.js\\"
-      ],
-      \\"extension_ids\\": [
-        \\"oilkjaldkfjlasdf\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
+        \\"test/manifest/resources/additionalInputsWebAccessible/script5.js\\",
         \\"test/manifest/resources/additionalInputsWebAccessible/script6.js\\"
       ],
       \\"extension_ids\\": [
         \\"oilkjaldkfjlasdf\\"
       ],
       \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
-        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\",
-        \\"assets/log.js\\",
-        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript1.js\\"
-      ],
-      \\"matches\\": [
-        \\"https://example.com/\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
-        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\",
-        \\"assets/log.js\\",
-        \\"test/manifest/resources/additionalInputsWebAccessible/chunkedScript2.js\\"
-      ],
-      \\"matches\\": [
-        \\"https://example.com/\\"
-      ],
-      \\"use_dynamic_url\\": true
-    },
-    {
-      \\"resources\\": [
-        \\"assets/test/manifest/resources/additionalInputsWebAccessible/chunkedScript3.js\\",
-        \\"assets/log.js\\"
-      ],
-      \\"matches\\": [
-        \\"https://example.com/\\"
-      ],
-      \\"use_dynamic_url\\": true
     }
   ]
 }",