@rsbuild/plugin-assets-retry 0.0.18

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+<p align="center">
+  <a href="https://rsbuild.dev" target="blank"><img src="https://github.com/web-infra-dev/rsbuild/assets/7237365/84abc13e-b620-468f-a90b-dbf28e7e9427" alt="Rsbuild Logo" /></a>
+</p>
+
+# Rsbuild
+
+Unleash the power of Rspack with the out-of-the-box build tool.
+
+## Documentation
+
+https://rsbuild.dev/
+
+## Contributing
+
+Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
+
+## License
+
+Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import { RsbuildPlugin, RsbuildPluginAPI } from '@rsbuild/core';
+import { CrossOrigin } from '@rsbuild/shared';
+
+type PluginAssetsRetryOptions = {
+    max?: number;
+    type?: string[];
+    test?: string | ((url: string) => boolean);
+    domain?: string[];
+    crossOrigin?: boolean | CrossOrigin;
+    inlineScript?: boolean;
+    onFail?: (options: AssetsRetryHookContext) => void;
+    onRetry?: (options: AssetsRetryHookContext) => void;
+    onSuccess?: (options: AssetsRetryHookContext) => void;
+};
+type AssetsRetryHookContext = {
+    url: string;
+    times: number;
+    domain: string;
+    tagName: string;
+};
+
+declare const pluginAssetsRetry: (options?: PluginAssetsRetryOptions) => RsbuildPlugin<RsbuildPluginAPI>;
+
+export { PluginAssetsRetryOptions, pluginAssetsRetry };

package/dist/index.js

@@ -0,0 +1,180 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __esm = (fn, res) => function __init() {
+  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+
+// src/AssetsRetryPlugin.ts
+var AssetsRetryPlugin_exports = {};
+__export(AssetsRetryPlugin_exports, {
+  AssetsRetryPlugin: () => AssetsRetryPlugin
+});
+var import_path, import_webpack_sources, import_fs_extra, import_shared, _retryOptions, AssetsRetryPlugin;
+var init_AssetsRetryPlugin = __esm({
+  "src/AssetsRetryPlugin.ts"() {
+    "use strict";
+    import_path = __toESM(require("path"));
+    import_webpack_sources = require("webpack-sources");
+    import_fs_extra = require("@rsbuild/shared/fs-extra");
+    import_shared = require("@rsbuild/shared");
+    AssetsRetryPlugin = class {
+      constructor(options) {
+        __privateAdd(this, _retryOptions, void 0);
+        const {
+          distDir,
+          HtmlPlugin,
+          inlineScript = true,
+          ...retryOptions
+        } = options;
+        this.name = "AssetsRetryPlugin";
+        __privateSet(this, _retryOptions, retryOptions);
+        this.distDir = distDir;
+        this.HtmlPlugin = HtmlPlugin;
+        this.inlineScript = inlineScript;
+        this.scriptPath = "";
+      }
+      async getRetryCode() {
+        const { default: serialize } = await import("serialize-javascript");
+        const runtimeFilePath = import_path.default.join(__dirname, "./runtime.js");
+        const runtimeCode = await import_fs_extra.fs.readFile(runtimeFilePath, "utf-8");
+        return `(function(){${runtimeCode};init(${serialize(
+          __privateGet(this, _retryOptions)
+        )});})()`;
+      }
+      async getScriptPath() {
+        if (!this.scriptPath) {
+          const version = await (0, import_shared.getRsbuildVersion)();
+          this.scriptPath = import_path.default.join(this.distDir, `assets-retry.${version}.js`);
+        }
+        return this.scriptPath;
+      }
+      apply(compiler) {
+        if (!this.inlineScript) {
+          compiler.hooks.thisCompilation.tap(
+            this.name,
+            (compilation) => {
+              compilation.hooks.processAssets.tapPromise(
+                {
+                  name: this.name,
+                  stage: import_shared.COMPILATION_PROCESS_STAGE.PROCESS_ASSETS_STAGE_PRE_PROCESS
+                },
+                async (assets) => {
+                  const scriptPath = await this.getScriptPath();
+                  assets[scriptPath] = new import_webpack_sources.RawSource(
+                    await this.getRetryCode(),
+                    false
+                  );
+                }
+              );
+            }
+          );
+        }
+        compiler.hooks.compilation.tap(this.name, (compilation) => {
+          this.HtmlPlugin.getHooks(compilation).alterAssetTagGroups.tapPromise(
+            this.name,
+            async (data) => {
+              const scriptTag = (0, import_shared.generateScriptTag)();
+              if (this.inlineScript) {
+                data.headTags.unshift({
+                  ...scriptTag,
+                  innerHTML: await this.getRetryCode()
+                });
+              } else {
+                const publicPath = (0, import_shared.getPublicPathFromCompiler)(compiler);
+                const url = (0, import_shared.withPublicPath)(await this.getScriptPath(), publicPath);
+                data.headTags.unshift({
+                  ...scriptTag,
+                  attributes: {
+                    ...scriptTag.attributes,
+                    src: url
+                  }
+                });
+              }
+              return data;
+            }
+          );
+        });
+      }
+    };
+    _retryOptions = new WeakMap();
+  }
+});
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  pluginAssetsRetry: () => pluginAssetsRetry
+});
+module.exports = __toCommonJS(src_exports);
+var import_shared2 = require("@rsbuild/shared");
+var pluginAssetsRetry = (options = {}) => ({
+  name: "plugin-assets-retry",
+  setup(api) {
+    api.modifyBundlerChain(async (chain, { CHAIN_ID, target, HtmlPlugin }) => {
+      const config = api.getNormalizedConfig();
+      if (!options || (0, import_shared2.isHtmlDisabled)(config, target)) {
+        return;
+      }
+      const { AssetsRetryPlugin: AssetsRetryPlugin2 } = await Promise.resolve().then(() => (init_AssetsRetryPlugin(), AssetsRetryPlugin_exports));
+      const distDir = (0, import_shared2.getDistPath)(config.output, "js");
+      if (options.crossOrigin === void 0) {
+        options.crossOrigin = config.html.crossorigin;
+      }
+      chain.plugin(CHAIN_ID.PLUGIN.ASSETS_RETRY).use(AssetsRetryPlugin2, [
+        {
+          ...options,
+          distDir,
+          HtmlPlugin
+        }
+      ]);
+    });
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  pluginAssetsRetry
+});

package/dist/index.mjs

@@ -0,0 +1,184 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __esm = (fn, res) => function __init() {
+  return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __accessCheck = (obj, member, msg) => {
+  if (!member.has(obj))
+    throw TypeError("Cannot " + msg);
+};
+var __privateGet = (obj, member, getter) => {
+  __accessCheck(obj, member, "read from private field");
+  return getter ? getter.call(obj) : member.get(obj);
+};
+var __privateAdd = (obj, member, value) => {
+  if (member.has(obj))
+    throw TypeError("Cannot add the same private member more than once");
+  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+};
+var __privateSet = (obj, member, value, setter) => {
+  __accessCheck(obj, member, "write to private field");
+  setter ? setter.call(obj, value) : member.set(obj, value);
+  return value;
+};
+
+// ../../node_modules/.pnpm/@modern-js+module-tools@2.39.2_typescript@5.2.2/node_modules/@modern-js/module-tools/shims/esm.js
+import { fileURLToPath } from "url";
+import path from "path";
+var getFilename, getDirname, __dirname;
+var init_esm = __esm({
+  "../../node_modules/.pnpm/@modern-js+module-tools@2.39.2_typescript@5.2.2/node_modules/@modern-js/module-tools/shims/esm.js"() {
+    "use strict";
+    getFilename = () => fileURLToPath(import.meta.url);
+    getDirname = () => path.dirname(getFilename());
+    __dirname = /* @__PURE__ */ getDirname();
+  }
+});
+
+// ../../scripts/require_shims.js
+import { createRequire } from "module";
+var init_require_shims = __esm({
+  "../../scripts/require_shims.js"() {
+    "use strict";
+    global.require = createRequire(import.meta.url);
+  }
+});
+
+// src/AssetsRetryPlugin.ts
+var AssetsRetryPlugin_exports = {};
+__export(AssetsRetryPlugin_exports, {
+  AssetsRetryPlugin: () => AssetsRetryPlugin
+});
+import path2 from "path";
+import { RawSource } from "webpack-sources";
+import { fs } from "@rsbuild/shared/fs-extra";
+import {
+  withPublicPath,
+  generateScriptTag,
+  getRsbuildVersion,
+  getPublicPathFromCompiler,
+  COMPILATION_PROCESS_STAGE
+} from "@rsbuild/shared";
+var _retryOptions, AssetsRetryPlugin;
+var init_AssetsRetryPlugin = __esm({
+  "src/AssetsRetryPlugin.ts"() {
+    "use strict";
+    init_esm();
+    init_require_shims();
+    AssetsRetryPlugin = class {
+      constructor(options) {
+        __privateAdd(this, _retryOptions, void 0);
+        const {
+          distDir,
+          HtmlPlugin,
+          inlineScript = true,
+          ...retryOptions
+        } = options;
+        this.name = "AssetsRetryPlugin";
+        __privateSet(this, _retryOptions, retryOptions);
+        this.distDir = distDir;
+        this.HtmlPlugin = HtmlPlugin;
+        this.inlineScript = inlineScript;
+        this.scriptPath = "";
+      }
+      async getRetryCode() {
+        const { default: serialize } = await import("serialize-javascript");
+        const runtimeFilePath = path2.join(__dirname, "./runtime.js");
+        const runtimeCode = await fs.readFile(runtimeFilePath, "utf-8");
+        return `(function(){${runtimeCode};init(${serialize(
+          __privateGet(this, _retryOptions)
+        )});})()`;
+      }
+      async getScriptPath() {
+        if (!this.scriptPath) {
+          const version = await getRsbuildVersion();
+          this.scriptPath = path2.join(this.distDir, `assets-retry.${version}.js`);
+        }
+        return this.scriptPath;
+      }
+      apply(compiler) {
+        if (!this.inlineScript) {
+          compiler.hooks.thisCompilation.tap(
+            this.name,
+            (compilation) => {
+              compilation.hooks.processAssets.tapPromise(
+                {
+                  name: this.name,
+                  stage: COMPILATION_PROCESS_STAGE.PROCESS_ASSETS_STAGE_PRE_PROCESS
+                },
+                async (assets) => {
+                  const scriptPath = await this.getScriptPath();
+                  assets[scriptPath] = new RawSource(
+                    await this.getRetryCode(),
+                    false
+                  );
+                }
+              );
+            }
+          );
+        }
+        compiler.hooks.compilation.tap(this.name, (compilation) => {
+          this.HtmlPlugin.getHooks(compilation).alterAssetTagGroups.tapPromise(
+            this.name,
+            async (data) => {
+              const scriptTag = generateScriptTag();
+              if (this.inlineScript) {
+                data.headTags.unshift({
+                  ...scriptTag,
+                  innerHTML: await this.getRetryCode()
+                });
+              } else {
+                const publicPath = getPublicPathFromCompiler(compiler);
+                const url = withPublicPath(await this.getScriptPath(), publicPath);
+                data.headTags.unshift({
+                  ...scriptTag,
+                  attributes: {
+                    ...scriptTag.attributes,
+                    src: url
+                  }
+                });
+              }
+              return data;
+            }
+          );
+        });
+      }
+    };
+    _retryOptions = new WeakMap();
+  }
+});
+
+// src/index.ts
+init_esm();
+init_require_shims();
+import { getDistPath, isHtmlDisabled } from "@rsbuild/shared";
+var pluginAssetsRetry = (options = {}) => ({
+  name: "plugin-assets-retry",
+  setup(api) {
+    api.modifyBundlerChain(async (chain, { CHAIN_ID, target, HtmlPlugin }) => {
+      const config = api.getNormalizedConfig();
+      if (!options || isHtmlDisabled(config, target)) {
+        return;
+      }
+      const { AssetsRetryPlugin: AssetsRetryPlugin2 } = await Promise.resolve().then(() => (init_AssetsRetryPlugin(), AssetsRetryPlugin_exports));
+      const distDir = getDistPath(config.output, "js");
+      if (options.crossOrigin === void 0) {
+        options.crossOrigin = config.html.crossorigin;
+      }
+      chain.plugin(CHAIN_ID.PLUGIN.ASSETS_RETRY).use(AssetsRetryPlugin2, [
+        {
+          ...options,
+          distDir,
+          HtmlPlugin
+        }
+      ]);
+    });
+  }
+});
+export {
+  pluginAssetsRetry
+};

package/dist/runtime.js

@@ -0,0 +1 @@
+"use strict";var TAG_TYPE={link:HTMLLinkElement,script:HTMLScriptElement,img:HTMLImageElement},TYPES=Object.keys(TAG_TYPE);function findCurrentDomain(e,t){for(var n="",r=0;r<t.length;r++)if(-1!==e.indexOf(t[r])){n=t[r];break}return n||e}function findNextDomain(e,t){var n=findCurrentDomain(e,t),r=t.indexOf(n);return t[(r+1)%t.length]||e}function getRequestUrl(e){return e instanceof HTMLScriptElement||e instanceof HTMLImageElement?e.src:e instanceof HTMLLinkElement?e.href:null}var defaultConfig={max:3,type:TYPES,domain:[],crossOrigin:!1};function validateTargetInfo(e,t){var n,r=t.target,i=null===(n=r.tagName)||void 0===n?void 0:n.toLocaleLowerCase(),a=e.type,o=getRequestUrl(r);return!!(i&&-1!==a.indexOf(i)&&TAG_TYPE[i]&&r instanceof TAG_TYPE[i]&&o)&&{target:r,tagName:i,url:o}}function createElement(e,t){var n=!0===t.crossOrigin?"anonymous":t.crossOrigin,r=n?'crossorigin="'.concat(n,'"'):"",i=t.times?'data-rsbuild-retry-times="'.concat(t.times,'"'):"",a=t.isAsync?"data-rsbuild-async":"";if(e instanceof HTMLScriptElement){var o=document.createElement("script");return o.src=t.url,n&&(o.crossOrigin=n),t.times&&(o.dataset.rsbuildRetryTimes=String(t.times)),t.isAsync&&(o.dataset.rsbuildAsync=""),{element:o,str:'<script src="'.concat(t.url,'" ').concat(r," ").concat(i," ").concat(a,"><\/script>")}}if(e instanceof HTMLLinkElement){var s=document.createElement("link");return s.rel=e.rel||"stylesheet",e.as&&(s.as=e.as),s.href=t.url,n&&(s.crossOrigin=n),t.times&&(s.dataset.rsbuildRetryTimes=String(t.times)),{element:s,str:'<link rel="'.concat(s.rel,'" href="').concat(t.url,'" ').concat(r," ").concat(i," ").concat(s.as?'as="'.concat(s.as,'"'):"","></link>")}}}function reloadElementResource(e,t,n){e instanceof HTMLScriptElement&&(n.isAsync?document.body.appendChild(t.element):document.write(t.str)),e instanceof HTMLLinkElement&&document.getElementsByTagName("head")[0].appendChild(t.element),e instanceof HTMLImageElement&&(e.src=n.url,e.dataset.rsbuildRetryTimes=String(n.times))}function retry(e,t){var n=validateTargetInfo(e,t);if(!1!==n){var r=n.target,i=n.tagName,a=n.url,o=e.test;if(o){if("string"==typeof o){var s=new RegExp(o);o=function(e){return s.test(e)}}if("function"!=typeof o||!o(a))return}var c=findCurrentDomain(a,e.domain);if(!(e.domain&&e.domain.length>0&&-1===e.domain.indexOf(c))){var l=Number(r.dataset.rsbuildRetryTimes)||0;if(l!==e.max){var m=findNextDomain(c,e.domain),d=Boolean(r.dataset.rsbuildAsync)||r.async||r.defer,u={url:a.replace(c,m),times:l+1,crossOrigin:e.crossOrigin,isAsync:d},f=createElement(r,u);if(e.onRetry&&"function"==typeof e.onRetry){var g={times:l,domain:c,url:a,tagName:i};e.onRetry(g)}reloadElementResource(r,f,u)}else if("function"==typeof e.onFail){var y={times:l,domain:c,url:a,tagName:i};e.onFail(y)}}}}function load(e,t){var n=validateTargetInfo(e,t);if(!1!==n){var r=n.target,i=n.tagName,a=n.url,o=findCurrentDomain(a,e.domain),s=Number(r.dataset.rsbuildRetryTimes)||0;if(0!==s&&"function"==typeof e.onSuccess){var c={times:s,domain:o,url:a,tagName:i};e.onSuccess(c)}}}function resourceMonitor(e,t){"undefined"!=typeof window&&void 0!==window.document&&(document.addEventListener("error",(function(t){t&&t.target instanceof Element&&e(t)}),!0),document.addEventListener("load",(function(e){e&&e.target instanceof Element&&t(e)}),!0))}function init(e){var t=Object.assign({},defaultConfig,e);Array.isArray(t.type)&&0!==t.type.length||(t.type=defaultConfig.type),Array.isArray(t.domain)&&0!==t.domain.length||(t.domain=defaultConfig.domain),Array.isArray(t.domain)&&(t.domain=t.domain.filter(Boolean));try{resourceMonitor((function(e){try{retry(t,e)}catch(e){console.error("retry error captured",e)}}),(function(e){try{load(t,e)}catch(e){console.error("load error captured",e)}}))}catch(e){console.error("monitor error captured",e)}}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@rsbuild/plugin-assets-retry",
+  "version": "0.0.18",
+  "description": "Assets retry plugin for Rsbuild",
+  "homepage": "https://rsbuild.dev",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/rsbuild",
+    "directory": "packages/plugin-assets-retry"
+  },
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "serialize-javascript": "^6.0.0",
+    "webpack-sources": "^3.2.3",
+    "@rsbuild/shared": "0.0.18"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.23.2",
+    "@babel/preset-env": "^7.23.2",
+    "@babel/preset-typescript": "^7.23.2",
+    "@types/serialize-javascript": "^5.0.1",
+    "html-webpack-plugin": "5.5.3",
+    "terser": "5.19.2",
+    "typescript": "^5.2.2",
+    "@rsbuild/core": "0.0.18",
+    "@rsbuild/test-helper": "0.0.18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "modern build && node scripts/postCompile.js",
+    "dev": "modern build --watch"
+  }
+}