react-native-bundle-discovery-ui 2.1.0 → 2.2.0-rc.1

package/README.md

@@ -3,13 +3,11 @@
 [![react-native-bundle-discovery on npm](https://badgen.net/npm/v/react-native-bundle-discovery)](https://www.npmjs.com/package/react-native-bundle-discovery)
 [![react-native-bundle-discovery downloads](https://badgen.net/npm/dm/react-native-bundle-discovery)](https://www.npmtrends.com/react-native-bundle-discovery)
 
-
 A simple package that helps developers visualize and analyze the bundle size of React Native apps.
 With this tool, you can easily explore your app's codebase, identify large or heavy packages, and inspect the structure of modules and code within your project.
 
 <img width="800" alt="" src="./assets/img.png" />
 
-
 ### Packages:
 
 - `react-native-bundle-discovery` - simple JS library to generate a JSON report of the bundle.
@@ -17,13 +15,20 @@ With this tool, you can easily explore your app's codebase, identify large or he
 - `react-native-bundle-discovery-cli` - CLI to analyze the bundle report.
 - `react-native-bundle-discovery-rozenite-plugin` - Rozenite plugin to integrate UI tool to [React Native DevTools](https://reactnative.dev/docs/react-native-devtools).
 
+---
+
 ### Setup:
 
 There are two ways to install the package:
 
-1. As in independent tool (UI + CLI) 
+1. As in independent tool (UI + CLI)
 2. Or as a [Rozenite](_rozenite/README.md) plugin (see: [_rozenite/README.md](_rozenite/README.md))
 
+
+> 🚀 If you've migrated to [Re.Pack](https://re-pack.dev/), you can still use this package to analyze 📊 JS bundles 📦 generated by Re.Pack.
+>
+> 💡 Learn more: 📖 [Re.Pack.md](./Re.Pack.md)
+
 #### 1. Install (independent tool)
 
 ```bash
@@ -62,7 +67,7 @@ See: [_rozenite/README.md](_rozenite/README.md)
 
 ### 3. Build the app
 
-As example, for iOS you can run the following command, and it will generate the `metro-stats.json` file in the root of your project:
+For example, for iOS you can run the following command, and it will generate the `metro-stats.json` file in the root of your project:
 
 ```bash
 npx react-native bundle \
@@ -112,30 +117,34 @@ npx react-native-bundle-discovery-ui build metro-stats.json
 | outputJsonPath: string | `<root>/metro-stats.json` | The path where the JSON report will be saved. Defaults to `metro-stats.json` in project root.                                            |
 | includeCode: boolean   | `true`                    | Whether to include the source and output code in the JSON report.                                                                        |
 
-### `createProcessModuleFilter(options: ProcessModuleFilterOptions)`
+**⚠️ Be cautious sharing reports with `includeCode` enabled**
+
+Enabling this option significantly increases report size and **embeds the source code** of your assets.
 
+If your code is proprietary 🔒, share these reports responsibly 🤝!
+
+---
 
-| Prop                   | Default value             | Description                   |
-| ---------------------- | ------------------------- | ----------------------------- |
-| removePromisePolyfill: boolean | `false` | Remove the Promise polyfill as Hermes provide own impl. (issue: [#57702](https://github.com/react/react-native/issues/57702)) |
-| removeOldRenderer: boolean     | `false` | Whether to remove the old renderer. Set to `true` when New Arch is enabled    |
-| removeNewRenderer: boolean     | `false` | Whether to remove the new renderer. Set to `true` when New Arch is disabled    |
-| removeUTFSequence: boolean     | `false` | Remove useless undocumented RN module.     |
+### `createResolveRequest(options: ResolveRequestOptions)`
 
+| Prop                           | Default value | Description                                                                                                                   |
+| ------------------------------ | ------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| removePromisePolyfill: boolean | `false`       | Remove the Promise polyfill as Hermes provide own impl. (issue: [#57702](https://github.com/react/react-native/issues/57702)) |
+| removeUTFSequence: boolean     | `false`       | Remove useless undocumented RN module.                                                                                        |
 
-Simple helper that devs can use to filter out unnecessary modules from the bundle report.
+Helper that creates a custom resolve request function to filter out unnecessary modules from the bundle.
 You can get recommendations during the analysis of the bundle report using the CLI tool.
 
 ```js
 // metro.config.js
-const {createProcessModuleFilter} = require('react-native-bundle-discovery');
+const { createResolveRequest } = require("react-native-bundle-discovery");
+const resolveRequest = createResolveRequest({
+  removePromisePolyfill: true,
+  removeUTFSequence: true,
+});
 const config = {
-  serializer: {
-    processModuleFilter: createProcessModuleFilter({
-      removePromisePolyfill: true,
-      removeOldRenderer: true,
-      removeUTFSequence: true,
-    }),
+  resolver: {
+    resolveRequest,
   },
 };
 ```

package/lib/build.js

@@ -3,6 +3,7 @@ const path = require("path");
 const chalk = require("chalk");
 const { build } = require("@discoveryjs/cli");
 const config = require("../.discoveryrc.js");
+const { isRsdoctorReport } = require("./utils.js");
 
 function buildHtmlPage(filePath, output, clean, singleFile, verbose) {
   if (verbose) {
@@ -46,13 +47,20 @@ function buildHtmlPage(filePath, output, clean, singleFile, verbose) {
       `Creating temporary config file at: ${chalk.green(configFile)}, for discovery.js`,
     );
   }
+  const transformRcdoctor = require.resolve("./rsdoctor.js");
   fs.writeFileSync(
     configFile,
-    `module.exports = ${JSON.stringify(
+    `const {transformRSDoctorData} = require("${transformRcdoctor}");
+module.exports = ${JSON.stringify(
       { ...config, data: "<tmp>" },
       null,
       1,
-    ).replace(`"<tmp>"`, `() => require("${fullJsonPath}")`)};`,
+    ).replace(
+      `"<tmp>"`,
+      isRsdoctorReport(fullJsonPath)
+        ? `() => transformRSDoctorData(require("${fullJsonPath}"))`
+        : `() => require("${fullJsonPath}")`,
+    )};`,
   );
 
   if (verbose) {

package/lib/rsdoctor.js

@@ -0,0 +1,149 @@
+const { resolve } = require("path");
+
+const possibleEntryFiles = [
+  "index.js",
+  "index.jsx",
+  "index.ts",
+  "index.tsx",
+  "index.mjs",
+  "index.cjs",
+];
+
+const doStructureCheck = (rsdoctorData) => {
+  if (!(
+    Array.isArray(rsdoctorData?.data?.configs) &&
+    rsdoctorData.data.configs.length === 1
+  )) {
+    throw new Error(
+      `Unexpected number of "data.configs[]" in rsdoctor-data.json. Work only with single config. Found: ${rsdoctorData?.data?.configs?.length}`,
+    );
+  }
+
+  if (!Array.isArray(rsdoctorData?.data?.packageGraph?.packages)) {
+    throw new Error(
+      `Unexpected "data.packageGraph.packages[]" in rsdoctor-data.json. Expected array. Found: ${typeof rsdoctorData?.data?.packageGraph?.packages}`,
+    );
+  }
+
+  const firstConfig = rsdoctorData.data.configs[0];
+
+  if (!(firstConfig.name === "rspack" || firstConfig.name === "webpack")) {
+    throw new Error(
+      `Unsupported bundler: ${firstConfig.name}@${firstConfig.version}. Only 'rspack' is supported.`,
+    );
+  }
+};
+
+const getDependenciesMap = (rsdoctorData) => {
+  const depsMap = new Map(
+    rsdoctorData.data.moduleGraph.dependencies.map((dep) => [dep.id, dep]),
+  );
+  return depsMap;
+};
+
+const getEntryFile = (rsdoctorData) => {
+  const firstConfig = rsdoctorData?.data?.configs?.[0];
+  const entry = firstConfig?.config?.entry;
+  const entryFile =
+    typeof entry?.main === "string"
+      ? entry.main
+      : typeof entry?.main?.import === "string"
+        ? entry.main.import
+        : entry?.main.import[0];
+
+  if (entryFile) {
+    return resolve(firstConfig.root, entryFile);
+  }
+
+  const pathsToCheck = possibleEntryFiles.map((f) =>
+    resolve(firstConfig.root, f),
+  );
+  const indexFile = rsdoctorData.data.moduleGraph.modules.find((mdl) =>
+    pathsToCheck.some((entry) => mdl.path === entry),
+  );
+
+  if (indexFile && indexFile.imported?.length === 0) {
+    return indexFile.path;
+  }
+
+  return `${firstConfig.root}/index.js`;
+};
+
+const transformRSDoctorData = (rsdoctorData) => {
+  doStructureCheck(rsdoctorData);
+  const tmpDependenciesMap = getDependenciesMap(rsdoctorData);
+  const firstConfig = rsdoctorData.data.configs[0];
+  return {
+    date: Date.now(), // no info in rspack report
+    entryPoint: getEntryFile(rsdoctorData),
+    rootFolder: firstConfig.root,
+    // envs: {},
+    transformOptions: {
+      // customTransformOptions: {},
+      dev: firstConfig.config.mode !== "production",
+      minify: firstConfig.config.optimization?.minimize ?? false,
+      platform: firstConfig.config.name ?? "ios",
+      // type: "module",
+      // unstable_transformProfile: "default",
+    },
+    // Example of package:
+    // {
+    //   name: "@react-native/js-polyfills",
+    //   absolutePath:
+    //     "/Users/xd/tmp/RN84/node_modules/@react-native/js-polyfills",
+    //   version: "0.84.1",
+    // }
+    packages: rsdoctorData.data.packageGraph.packages.map((pkg) => ({
+      name: pkg.name,
+      absolutePath: pkg.root,
+      version: pkg.version,
+      source: { sizeInBytes: pkg.size?.sourceSize ?? 1 },
+      output: { sizeInBytes: pkg.size?.parsedSize ?? 1 },
+    })),
+    // Example of module:
+    // {
+    //   "path": "/Users/xd/tmp/RN84/node_modules/react-native/Libraries/BatchedBridge/BatchedBridge.js",
+    //   "source": {
+    //     "code": "",
+    //     "lineCount": 32,
+    //     "sizeInBytes": 954
+    //   },
+    //   "output": {
+    //     "code": "",
+    //     "lineCount": 1,
+    //     "sizeInBytes": 219
+    //   },
+    //   "dependencies": [
+    //     {
+    //       "absolutePath": "/Users/xd/tmp/RN84/node_modules/react-native/Libraries/BatchedBridge/MessageQueue.js",
+    //       "name": "./MessageQueue"
+    //     }
+    //   ]
+    // },
+    modules: rsdoctorData.data.moduleGraph.modules.map((mdl) => ({
+      path: mdl.path,
+      source: {
+        code: "", // no code in rspack report
+        lineCount: 0, // no code to count lines in rspack report
+        sizeInBytes: mdl.size?.sourceSize ?? 0,
+      },
+      output: {
+        code: "",
+        lineCount: 0,
+        sizeInBytes: mdl.size?.parsedSize ?? 0,
+      },
+      dependencies: mdl.dependencies
+        .map((depNumId) => {
+          const dep = tmpDependenciesMap.get(depNumId);
+          return dep
+            ? { absolutePath: dep.resolvedRequest, name: dep.request }
+            : null;
+        })
+        .filter((e) => e !== null),
+    })),
+  };
+};
+
+module.exports = {
+  transformRSDoctorData,
+};

package/lib/server.js

@@ -4,6 +4,7 @@ const chalk = require("chalk");
 const { createServer } = require("@discoveryjs/cli");
 const { silent } = require("@discoveryjs/cli/lib/shared/utils.js");
 const config = require("../.discoveryrc.js");
+const { isRsdoctorReport } = require("./utils.js");
 
 function serve(filePath, port, verbose) {
   const PORT = process.env.PORT || port;
@@ -45,13 +46,20 @@ function serve(filePath, port, verbose) {
       `Creating temporary config file at: ${chalk.green(configFile)}, for discovery.js`,
     );
   }
+  const transformRcdoctor = require.resolve("./rsdoctor.js");
   fs.writeFileSync(
     configFile,
-    `module.exports = ${JSON.stringify(
+    `const {transformRSDoctorData} = require("${transformRcdoctor}");
+module.exports = ${JSON.stringify(
       { ...config, data: "<tmp>" },
       null,
       1,
-    ).replace(`"<tmp>"`, `() => require("${fullJsonPath}")`)};`,
+    ).replace(
+      `"<tmp>"`,
+      isRsdoctorReport(fullJsonPath)
+        ? `() => transformRSDoctorData(require("${fullJsonPath}"))`
+        : `() => require("${fullJsonPath}")`,
+    )};`,
   );
 
   if (verbose) {

package/lib/utils.js

@@ -0,0 +1,23 @@
+const chalk = require("chalk");
+
+const isRsdoctorReport = (fullJsonPath) => {
+  try {
+    const json = require(fullJsonPath);
+    if (
+      Array.isArray(json?.data?.moduleGraph?.modules) ||
+      Array.isArray(json?.data?.packageGraph?.packages)
+    ) {
+      console.info(
+        `Detected ${chalk.red("rsdoctor")} format in the input file: ${chalk.green(fullJsonPath)}`,
+      );
+      return true;
+    }
+    return false;
+  } catch {
+    return false;
+  }
+};
+
+module.exports = {
+  isRsdoctorReport,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-bundle-discovery-ui",
-  "version": "2.1.0",
+  "version": "2.2.0-rc.1",
   "main": "lib/bin.js",
   "bin": "lib/bin.js",
   "repository": "git@github.com:retyui/react-native-bundle-discovery.git",
@@ -38,5 +38,9 @@
     "queryHelpers.js",
     ".discoveryrc.js"
   ],
-  "packageManager": "yarn@4.18.0"
+  "packageManager": "yarn@4.18.0",
+  "devDependencies": {
+    "acorn": "^8.18.0",
+    "acorn-walk": "^8.3.5"
+  }
 }

package/queryHelpers.js

@@ -17,6 +17,9 @@ const helpers = {
       .then((formatted) => {
         helpers.prettifyMap.set(sourceStr, formatted);
         return formatted;
+      })
+      .catch(() => {
+        return sourceStr;
       });
   },
   askChatGPTAboutPackages() {