refactor: use new processAssets api to handle SRI (#2971)

web-infra-dev · Jul 21, 2024 · ed6d0f8 · ed6d0f8
1 parent eebe00d
commit ed6d0f8
Show file tree

Hide file tree

Showing 9 changed files with 42 additions and 59 deletions.
diff --git a/examples/react/index.html b/examples/react/index.html
diff --git a/examples/react/rsbuild.config.ts b/examples/react/rsbuild.config.ts
@@ -3,7 +3,4 @@ import { pluginReact } from '@rsbuild/plugin-react';
 
 export default defineConfig({
   plugins: [pluginReact()],
-  html: {
-    template: './index.html',
-  },
 });
diff --git a/packages/compat/webpack/tests/__snapshots__/default.test.ts.snap b/packages/compat/webpack/tests/__snapshots__/default.test.ts.snap
@@ -340,6 +340,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly 1`] = `
         "process.env.NODE_ENV": ""development"",
       },
     },
+    RsbuildProcessAssetsPlugin {},
     ProgressPlugin {
       "compileTime": null,
       "dependenciesCount": 10000,
@@ -730,6 +731,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly when produ
         "process.env.NODE_ENV": ""production"",
       },
     },
+    RsbuildProcessAssetsPlugin {},
     ProgressPlugin {
       "compileTime": null,
       "dependenciesCount": 10000,
@@ -1034,6 +1036,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly when targe
         "process.env.NODE_ENV": ""production"",
       },
     },
+    RsbuildProcessAssetsPlugin {},
     ProgressPlugin {
       "compileTime": null,
       "dependenciesCount": 10000,
@@ -1320,6 +1323,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly when targe
         "process.env.NODE_ENV": ""production"",
       },
     },
+    RsbuildProcessAssetsPlugin {},
     ProgressPlugin {
       "compileTime": null,
       "dependenciesCount": 10000,

diff --git a/packages/compat/webpack/tests/__snapshots__/webpackConfig.test.ts.snap b/packages/compat/webpack/tests/__snapshots__/webpackConfig.test.ts.snap
@@ -73,6 +73,7 @@ exports[`webpackConfig > should allow to append and prepend plugins 1`] = `
       "process.env.NODE_ENV": ""test"",
     },
   },
+  RsbuildProcessAssetsPlugin {},
   ProgressPlugin {
     "compileTime": null,
     "dependenciesCount": 10000,

diff --git a/packages/core/src/plugins/sri.ts b/packages/core/src/plugins/sri.ts
@@ -145,67 +145,40 @@ export const pluginSri = (): RsbuildPlugin => ({
       return replacedHtml;
     };
 
-    class SriReplaceIntegrityPlugin {
-      algorithm: SriAlgorithm;
+    api.processAssets(
+      {
+        // use to final stage to get the final asset content
+        stage: 'report',
+      },
+      ({ assets, compiler, environment }) => {
+        const { htmlPaths } = environment;
 
-      constructor(algorithm: SriAlgorithm) {
-        this.algorithm = algorithm;
-      }
+        if (Object.keys(htmlPaths).length === 0) {
+          return;
+        }
 
-      apply(compiler: Rspack.Compiler): void {
-        compiler.hooks.compilation.tap(
-          'SriReplaceIntegrityPlugin',
-          (compilation) => {
-            compilation.hooks.processAssets.tapPromise(
-              {
-                name: 'SriReplaceIntegrityPlugin',
-                // use to final stage to get the final asset content
-                stage: compiler.webpack.Compilation.PROCESS_ASSETS_STAGE_REPORT,
-              },
-              async (assets) => {
-                const integrityCache = new Map<string, string>();
-
-                for (const asset of Object.keys(assets)) {
-                  if (!HTML_REGEX.test(asset)) {
-                    continue;
-                  }
-
-                  const htmlContent = assets[asset].source() as string;
-                  if (!htmlContent.includes(placeholder)) {
-                    continue;
-                  }
-
-                  assets[asset] = new compiler.webpack.sources.RawSource(
-                    replaceIntegrity(
-                      htmlContent,
-                      assets,
-                      this.algorithm,
-                      integrityCache,
-                    ),
-                  );
-                }
-              },
-            );
-          },
-        );
-      }
-    }
+        const algorithm = getAlgorithm(environment);
+        if (!algorithm) {
+          return;
+        }
 
-    api.modifyBundlerChain((chain, { environment }) => {
-      const { htmlPaths } = environment;
+        const integrityCache = new Map<string, string>();
 
-      if (Object.keys(htmlPaths).length === 0) {
-        return;
-      }
+        for (const asset of Object.keys(assets)) {
+          if (!HTML_REGEX.test(asset)) {
+            continue;
+          }
 
-      const algorithm = getAlgorithm(environment);
-      if (!algorithm) {
-        return;
-      }
+          const htmlContent = assets[asset].source() as string;
+          if (!htmlContent.includes(placeholder)) {
+            continue;
+          }
 
-      chain
-        .plugin('rsbuild-sri-replace')
-        .use(SriReplaceIntegrityPlugin, [algorithm]);
-    });
+          assets[asset] = new compiler.webpack.sources.RawSource(
+            replaceIntegrity(htmlContent, assets, algorithm, integrityCache),
+          );
+        }
+      },
+    );
   },
 });
diff --git a/packages/core/tests/__snapshots__/builder.test.ts.snap b/packages/core/tests/__snapshots__/builder.test.ts.snap
@@ -392,6 +392,7 @@ exports[`should use rspack as default bundler > apply rspack correctly 1`] = `
       "affectedHooks": "compilation",
       "name": "DefinePlugin",
     },
+    RsbuildProcessAssetsPlugin {},
   ],
   "resolve": {
     "alias": {

diff --git a/packages/core/tests/__snapshots__/default.test.ts.snap b/packages/core/tests/__snapshots__/default.test.ts.snap
@@ -392,6 +392,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly 1`] = `
       "affectedHooks": "compilation",
       "name": "DefinePlugin",
     },
+    RsbuildProcessAssetsPlugin {},
   ],
   "resolve": {
     "alias": {
@@ -834,6 +835,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly when prod
       "affectedHooks": undefined,
       "name": "ProgressPlugin",
     },
+    RsbuildProcessAssetsPlugin {},
   ],
   "resolve": {
     "alias": {
@@ -1160,6 +1162,7 @@ exports[`applyDefaultPlugins > should apply default plugins correctly when targe
       "affectedHooks": "compilation",
       "name": "DefinePlugin",
     },
+    RsbuildProcessAssetsPlugin {},
   ],
   "resolve": {
     "alias": {
@@ -1584,6 +1587,7 @@ exports[`tools.rspack > should match snapshot 1`] = `
       "affectedHooks": "compilation",
       "name": "DefinePlugin",
     },
+    RsbuildProcessAssetsPlugin {},
   ],
   "resolve": {
     "alias": {

diff --git a/packages/core/tests/__snapshots__/environments.test.ts.snap b/packages/core/tests/__snapshots__/environments.test.ts.snap
@@ -1680,6 +1680,7 @@ exports[`environment config > tools.rspack / bundlerChain can be used in environ
         "affectedHooks": "compilation",
         "name": "DefinePlugin",
       },
+      RsbuildProcessAssetsPlugin {},
     ],
     "resolve": {
       "alias": {
@@ -1996,6 +1997,7 @@ exports[`environment config > tools.rspack / bundlerChain can be used in environ
         "affectedHooks": "compilation",
         "name": "DefinePlugin",
       },
+      RsbuildProcessAssetsPlugin {},
     ],
     "resolve": {
       "alias": {

diff --git a/packages/plugin-react/tests/__snapshots__/index.test.ts.snap b/packages/plugin-react/tests/__snapshots__/index.test.ts.snap
@@ -427,6 +427,7 @@ exports[`plugins/react > should work with swc-loader 1`] = `
       "affectedHooks": "compilation",
       "name": "DefinePlugin",
     },
+    RsbuildProcessAssetsPlugin {},
     ReactRefreshRspackPlugin {
       "options": {
         "exclude": /node_modules/i,