@rsdoctor/sdk 0.0.2-beta.0

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,15 @@
+# Rsdoctor
+
+Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
+
+It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
+
+## Documentation
+
+## Contributing
+
+Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).
+
+## License
+
+Rsdoctor is [MIT licensed](https://github.com/web-infra-dev/rsdoctor/blob/main/LICENSE).

package/dist/cjs/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("./sdk"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./sdk")
+});

package/dist/cjs/sdk/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var sdk_exports = {};
+module.exports = __toCommonJS(sdk_exports);
+__reExport(sdk_exports, require("./sdk"), module.exports);
+__reExport(sdk_exports, require("./multiple"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./sdk"),
+  ...require("./multiple")
+});

package/dist/cjs/sdk/multiple/controller.js

@@ -0,0 +1,72 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var controller_exports = {};
+__export(controller_exports, {
+  DoctorSDKController: () => DoctorSDKController
+});
+module.exports = __toCommonJS(controller_exports);
+var import_slave = require("./slave");
+class DoctorSDKController {
+  constructor(root = process.cwd()) {
+    this.slaves = [];
+    this.root = "";
+    this.root = root;
+  }
+  get master() {
+    return this.slaves[0];
+  }
+  getLastSdk() {
+    return this.slaves[this.slaves.length - 1];
+  }
+  hasName(name) {
+    return Boolean(this.slaves.find((item) => item.name === name));
+  }
+  getSeriesData(serverUrl = false) {
+    return this.slaves.map((item) => {
+      const data = {
+        name: item.name,
+        path: item.diskManifestPath,
+        stage: item.stage
+      };
+      if (serverUrl) {
+        data.origin = item.server.origin;
+      }
+      return data;
+    });
+  }
+  createSlave({
+    name,
+    stage,
+    extraConfig
+  }) {
+    const slave = new import_slave.DoctorSlaveSDK({
+      name,
+      stage,
+      controller: this,
+      extraConfig
+    });
+    this.slaves.push(slave);
+    this.slaves.sort((a, b) => a.stage - b.stage);
+    return slave;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DoctorSDKController
+});

package/dist/cjs/sdk/multiple/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var multiple_exports = {};
+module.exports = __toCommonJS(multiple_exports);
+__reExport(multiple_exports, require("./controller"), module.exports);
+__reExport(multiple_exports, require("./slave"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./controller"),
+  ...require("./slave")
+});

package/dist/cjs/sdk/multiple/server.js

@@ -0,0 +1,41 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var server_exports = {};
+__export(server_exports, {
+  DoctorSlaveServer: () => DoctorSlaveServer
+});
+module.exports = __toCommonJS(server_exports);
+var import_build = require("@rsdoctor/utils/build");
+var import_server = require("../server");
+class DoctorSlaveServer extends import_server.DoctorServer {
+  constructor(sdk, port = import_build.Server.defaultPort) {
+    super(sdk, port);
+    this.sdk = sdk;
+  }
+  async openClientPage(...args) {
+    if (this.sdk.isMaster) {
+      return super.openClientPage(...args);
+    }
+    return Promise.resolve();
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DoctorSlaveServer
+});

package/dist/cjs/sdk/multiple/slave.js

@@ -0,0 +1,98 @@
+"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 __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 slave_exports = {};
+__export(slave_exports, {
+  DoctorSlaveSDK: () => DoctorSlaveSDK
+});
+module.exports = __toCommonJS(slave_exports);
+var import_path = __toESM(require("path"));
+var import_sdk = require("../sdk");
+var import_server = require("./server");
+let id = 1;
+class DoctorSlaveSDK extends import_sdk.DoctorWebpackSDK {
+  constructor({ name, stage, controller, extraConfig }) {
+    super({ name, root: controller.root });
+    const lastSdk = controller.getLastSdk();
+    const port = lastSdk ? lastSdk.server.port + 1 : this.server.port;
+    this.id = id++;
+    this.stage = typeof stage === "number" ? stage : 1;
+    this.extraConfig = extraConfig;
+    this.parent = controller;
+    this.server = new import_server.DoctorSlaveServer(this, port);
+    this.setName(name);
+    this.clearSwitch();
+  }
+  clearSwitch() {
+    this.uploadPieces = new Promise((resolve) => {
+      this.finishUploadPieceSwitch = resolve;
+    });
+  }
+  get isMaster() {
+    return this.parent.master === this;
+  }
+  async writePieces() {
+    const { name, parent, isMaster, outputDir, finishUploadPieceSwitch } = this;
+    this.setOutputDir(
+      isMaster ? outputDir : import_path.default.join(
+        parent.master.outputDir,
+        ".slaves",
+        name.replace(/\s+/g, "-")
+      )
+    );
+    await super.writePieces(this.getStoreData());
+    finishUploadPieceSwitch?.();
+  }
+  async writeManifest() {
+    const { parent, cloudData } = this;
+    await Promise.all(this.parent.slaves.map((item) => item.uploadPieces));
+    if (cloudData) {
+      cloudData.name = this.name;
+      cloudData.series = parent.getSeriesData();
+    }
+    const result = await super.writeManifest();
+    this.clearSwitch();
+    return result;
+  }
+  getSeriesData(serverUrl = false) {
+    return this.parent.getSeriesData(serverUrl);
+  }
+  setName(name) {
+    this._name = this.parent.hasName(name) ? `${name}-${id}` : name;
+  }
+  getManifestData() {
+    const data = super.getManifestData();
+    data.name = this.name;
+    data.series = this.getSeriesData(true);
+    return data;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DoctorSlaveSDK
+});

package/dist/cjs/sdk/sdk/core.js

@@ -0,0 +1,185 @@
+"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 __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 core_exports = {};
+__export(core_exports, {
+  SDKCore: () => SDKCore
+});
+module.exports = __toCommonJS(core_exports);
+var import_types = require("@rsdoctor/types");
+var import_build = require("@rsdoctor/utils/build");
+var import_common = require("@rsdoctor/utils/common");
+var import_path = __toESM(require("path"));
+var import_crypto = require("crypto");
+var import_process = __toESM(require("process"));
+var import_tapable = require("tapable");
+var import_logger = require("@rsdoctor/utils/logger");
+var import_utils = require("../utils");
+class SDKCore {
+  constructor({ name, root }) {
+    this.hooks = {
+      afterSaveManifest: new import_tapable.AsyncSeriesHook(["result"])
+    };
+    this._envinfo = {};
+    this._clientRoutes = /* @__PURE__ */ new Set([
+      import_types.Manifest.DoctorManifestClientRoutes.Overall
+    ]);
+    this.diskManifestPath = "";
+    this._name = name;
+    this.root = root;
+    this.pid = import_process.default.pid;
+    this._outputDir = import_path.default.join(this.root, import_types.Constants.DoctorOutputFolder);
+  }
+  get outputDir() {
+    return this._outputDir;
+  }
+  get name() {
+    return this._name;
+  }
+  async bootstrap() {
+    const [cpu, memory, nodeVersion, yarnVersion, npmVersion, pnpmVersion] = await Promise.all([
+      import_build.EnvInfo.getCPUInfo(),
+      import_build.EnvInfo.getMemoryInfo(),
+      import_build.EnvInfo.getNodeVersion(),
+      import_build.EnvInfo.getYarnVersion(),
+      import_build.EnvInfo.getNpmVersion(),
+      import_build.EnvInfo.getGlobalNpmPackageVersion("pnpm")
+    ]);
+    this._envinfo = {
+      ...this._envinfo,
+      cpu,
+      memory,
+      nodeVersion,
+      yarnVersion,
+      npmVersion,
+      pnpmVersion
+    };
+    const hash = (0, import_crypto.createHash)("md5").update(
+      [this.name, this.root, JSON.stringify(this._envinfo), Date.now()].join(
+        "_"
+      )
+    ).digest("hex");
+    this.setHash(hash);
+  }
+  async dispose() {
+  }
+  setOutputDir(outputDir) {
+    this._outputDir = outputDir;
+  }
+  setName(name) {
+    this._name = name;
+  }
+  setHash(hash) {
+    this.hash = hash;
+  }
+  getClientRoutes() {
+    return [...this._clientRoutes];
+  }
+  addClientRoutes(routes) {
+    routes.forEach((route) => {
+      this._clientRoutes.add(route);
+    });
+    this.onDataReport();
+  }
+  /** Upload analysis data pieces */
+  async writePieces(storeData, _options) {
+    const { outputDir } = this;
+    const manifest = import_path.default.resolve(outputDir, import_types.Constants.DoctorOutputManifest);
+    this.diskManifestPath = manifest;
+    await import_build.File.fse.ensureDir(outputDir);
+    const dataUrls = await Promise.all(
+      Object.keys(storeData).map(async (key) => {
+        const data = storeData[key];
+        if (typeof data !== "object") {
+          return {
+            name: key,
+            files: data
+          };
+        }
+        const jsonstr = await (async () => {
+          try {
+            return JSON.stringify(data);
+          } catch (error) {
+            return import_build.Json.stringify(data);
+          }
+        })();
+        return this.writeToFolder(jsonstr, outputDir, key);
+      })
+    );
+    (0, import_logger.debug)(
+      () => `SDKCore.writePieces extraConfig: ${JSON.stringify(this.extraConfig)}`,
+      "[SDKCore.writePieces]"
+    );
+    this.cloudData = {
+      client: {
+        enableRoutes: this.getClientRoutes()
+      },
+      data: (0, import_utils.transformDataUrls)(dataUrls)
+    };
+  }
+  /** Upload manifest file */
+  async writeManifest() {
+    const { cloudData: data, diskManifestPath } = this;
+    const dataStr = JSON.stringify(data, null, 2);
+    (0, import_logger.debug)(
+      () => `SDKCore.writeManifest extraConfig: ${this.extraConfig}`,
+      "[SDKCore.writeManifest]"
+    );
+    await Promise.all([import_build.File.fse.writeFile(diskManifestPath, dataStr)]);
+    return diskManifestPath;
+  }
+  async saveManifest(data, options) {
+    await this.writePieces(data, options);
+    const manifestDiskPath = await this.writeManifest();
+    await this.hooks.afterSaveManifest.promise({
+      manifestWithShardingFiles: this.cloudData,
+      manifestDiskPath
+    });
+    return manifestDiskPath;
+  }
+  writeToFolder(jsonstr, dir, key) {
+    const sharding = new import_build.File.FileSharding(import_common.Algorithm.compressText(jsonstr));
+    const folder = import_path.default.resolve(dir, key);
+    const writer = sharding.writeStringToFolder(folder);
+    return writer.then((item) => {
+      const res = {
+        name: key,
+        files: item.map((el) => ({
+          path: import_path.default.resolve(folder, el.filename),
+          basename: el.filename,
+          content: el.content
+        }))
+      };
+      return res;
+    });
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SDKCore
+});

package/dist/cjs/sdk/sdk/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var sdk_exports = {};
+__export(sdk_exports, {
+  DoctorSDK: () => import_webpack.DoctorWebpackSDK
+});
+module.exports = __toCommonJS(sdk_exports);
+__reExport(sdk_exports, require("./webpack"), module.exports);
+var import_webpack = require("./webpack");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DoctorSDK,
+  ...require("./webpack")
+});

package/dist/cjs/sdk/sdk/types.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);