@rsdoctor/sdk 0.1.0 → 0.1.1

package/README.md

@@ -1,11 +1,18 @@
-# Rsdoctor
+# Rsdoctor SDK
 
-Rsdoctor is a tool for diagnosing and analyzing the build process and build artifacts to help developers quickly identify and solve problems.
+This package is the intermediate data layer of Rsdoctor.
 
-It also supports Webpack and Rspack builders, as well as various build frameworks, such as Rsbuild.
+## features
+
+- Rsdoctor is a one-stop tool for diagnosing and analyzing the build process and build artifacts.
+- Rsdoctor is a tool that supports Webpack and Rspack build analysis.
+- Rsdoctor is an analysis tool that can display the time-consuming and behavioral details of the compilation.
+- Rsdoctor is a tool that provides bundle Diff and other anti-degradation capabilities simultaneously.
 
 ## Documentation
 
+https://rsdoctor.dev/
+
 ## Contributing
 
 Please read the [Contributing Guide](https://github.com/web-infra-dev/rsdoctor/blob/main/CONTRIBUTING.md).

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

@@ -37,13 +37,14 @@ var import_build = require("@rsdoctor/utils/build");
 var import_common = require("@rsdoctor/utils/common");
 var import_assert = __toESM(require("assert"));
 var import_body_parser = __toESM(require("body-parser"));
-var import_open = __toESM(require("open"));
 var import_ip = __toESM(require("ip"));
 var import_cors = __toESM(require("cors"));
 var import_stream = require("stream");
 var import_socket = require("./socket");
 var import_router = require("./router");
 var APIs = __toESM(require("./apis"));
+var import_logger = require("@rsdoctor/utils/logger");
+var import_openBrowser = require("../utils/openBrowser");
 __reExport(server_exports, require("./utils"), module.exports);
 class RsdoctorServer {
   constructor(sdk, port = import_build.Server.defaultPort) {
@@ -167,8 +168,8 @@ class RsdoctorServer {
     const url = this.getClientUrl(
       ...args
     );
-    await (0, import_open.default)(url);
-    console.log(`Rsdoctor analyze run at: ${url}`);
+    await (0, import_openBrowser.openBrowser)(url);
+    import_logger.logger.info(`Rsdoctor analyze server running on: ${import_logger.chalk.cyan(url)}`);
   }
   sendAPIDataToClient(api, msg) {
     this._socket?.sendAPIData(api, msg);

package/dist/cjs/sdk/utils/openBrowser.js

@@ -0,0 +1,92 @@
+"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 openBrowser_exports = {};
+__export(openBrowser_exports, {
+  openBrowser: () => openBrowser
+});
+module.exports = __toCommonJS(openBrowser_exports);
+var import_node_child_process = require("node:child_process");
+var import_node_util = require("node:util");
+var import_logger = require("@rsdoctor/utils/logger");
+var import_open = __toESM(require("open"));
+var import_node_path = require("node:path");
+const execAsync = (0, import_node_util.promisify)(import_node_child_process.exec);
+const supportedChromiumBrowsers = [
+  "Google Chrome Canary",
+  "Google Chrome Dev",
+  "Google Chrome Beta",
+  "Google Chrome",
+  "Microsoft Edge",
+  "Brave Browser",
+  "Vivaldi",
+  "Chromium"
+];
+const getTargetBrowser = async () => {
+  let targetBrowser = process.env.BROWSER;
+  if (!targetBrowser || !supportedChromiumBrowsers.includes(targetBrowser)) {
+    const { stdout: ps } = await execAsync("ps cax");
+    targetBrowser = supportedChromiumBrowsers.find((b) => ps.includes(b));
+  }
+  return targetBrowser;
+};
+async function openBrowser(url) {
+  const shouldTryOpenChromeWithAppleScript = process.platform === "darwin";
+  if (shouldTryOpenChromeWithAppleScript) {
+    try {
+      const targetBrowser = await getTargetBrowser();
+      if (targetBrowser) {
+        await execAsync(
+          `osascript openChrome.applescript "${encodeURI(
+            url
+          )}" "${targetBrowser}"`,
+          {
+            cwd: (0, import_node_path.join)(__dirname, "../../../../static")
+          }
+        );
+        return true;
+      }
+      import_logger.logger.debug("Failed to find the target browser.");
+    } catch (err) {
+      import_logger.logger.debug("Failed to open Rsdoctor URL with apple script.");
+      import_logger.logger.debug(err);
+    }
+  }
+  try {
+    await (0, import_open.default)(url);
+    return true;
+  } catch (err) {
+    import_logger.logger.error("Failed to open Rsdoctor URL.");
+    import_logger.logger.error(err);
+    return false;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  openBrowser
+});

package/dist/esm/sdk/server/index.js

@@ -3,13 +3,14 @@ import { Server } from "@rsdoctor/utils/build";
 import { Bundle } from "@rsdoctor/utils/common";
 import assert from "assert";
 import bodyParser from "body-parser";
-import open from "open";
 import ip from "ip";
 import cors from "cors";
 import { PassThrough } from "stream";
 import { Socket } from "./socket";
 import { Router } from "./router";
 import * as APIs from "./apis";
+import { chalk, logger } from "@rsdoctor/utils/logger";
+import { openBrowser } from "../utils/openBrowser";
 export * from "./utils";
 class RsdoctorServer {
   constructor(sdk, port = Server.defaultPort) {
@@ -133,8 +134,8 @@ class RsdoctorServer {
     const url = this.getClientUrl(
       ...args
     );
-    await open(url);
-    console.log(`Rsdoctor analyze run at: ${url}`);
+    await openBrowser(url);
+    logger.info(`Rsdoctor analyze server running on: ${chalk.cyan(url)}`);
   }
   sendAPIDataToClient(api, msg) {
     this._socket?.sendAPIData(api, msg);

package/dist/esm/sdk/utils/openBrowser.js

@@ -0,0 +1,58 @@
+import { exec } from "node:child_process";
+import { promisify } from "node:util";
+import { logger } from "@rsdoctor/utils/logger";
+import open from "open";
+import { join } from "node:path";
+const execAsync = promisify(exec);
+const supportedChromiumBrowsers = [
+  "Google Chrome Canary",
+  "Google Chrome Dev",
+  "Google Chrome Beta",
+  "Google Chrome",
+  "Microsoft Edge",
+  "Brave Browser",
+  "Vivaldi",
+  "Chromium"
+];
+const getTargetBrowser = async () => {
+  let targetBrowser = process.env.BROWSER;
+  if (!targetBrowser || !supportedChromiumBrowsers.includes(targetBrowser)) {
+    const { stdout: ps } = await execAsync("ps cax");
+    targetBrowser = supportedChromiumBrowsers.find((b) => ps.includes(b));
+  }
+  return targetBrowser;
+};
+async function openBrowser(url) {
+  const shouldTryOpenChromeWithAppleScript = process.platform === "darwin";
+  if (shouldTryOpenChromeWithAppleScript) {
+    try {
+      const targetBrowser = await getTargetBrowser();
+      if (targetBrowser) {
+        await execAsync(
+          `osascript openChrome.applescript "${encodeURI(
+            url
+          )}" "${targetBrowser}"`,
+          {
+            cwd: join(__dirname, "../../../../static")
+          }
+        );
+        return true;
+      }
+      logger.debug("Failed to find the target browser.");
+    } catch (err) {
+      logger.debug("Failed to open Rsdoctor URL with apple script.");
+      logger.debug(err);
+    }
+  }
+  try {
+    await open(url);
+    return true;
+  } catch (err) {
+    logger.error("Failed to open Rsdoctor URL.");
+    logger.error(err);
+    return false;
+  }
+}
+export {
+  openBrowser
+};

package/dist/type/sdk/utils/openBrowser.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Reads the BROWSER environment variable and decides what to do with it.
+ */
+export declare function openBrowser(url: string): Promise<boolean>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdoctor/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/web-infra-dev/rsdoctor",
@@ -11,7 +11,8 @@
   "module": "dist/esm/index.js",
   "types": "dist/type/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "static"
   ],
   "dependencies": {
     "body-parser": "1.20.1",
@@ -24,10 +25,10 @@
     "socket.io": "4.7.2",
     "source-map": "^0.7.4",
     "tapable": "2.2.1",
-    "@rsdoctor/client": "0.1.0",
-    "@rsdoctor/graph": "0.1.0",
-    "@rsdoctor/utils": "0.1.0",
-    "@rsdoctor/types": "0.1.0"
+    "@rsdoctor/client": "0.1.1",
+    "@rsdoctor/utils": "0.1.1",
+    "@rsdoctor/graph": "0.1.1",
+    "@rsdoctor/types": "0.1.1"
   },
   "devDependencies": {
     "@types/body-parser": "1.19.2",

package/static/openChrome.applescript

@@ -0,0 +1,95 @@
+(*
+Copyright (c) 2015-present, Facebook, Inc.
+
+This source code is licensed under the MIT license found in the
+LICENSE file at
+https://github.com/facebookincubator/create-react-app/blob/master/LICENSE
+*)
+
+property targetTab: null
+property targetTabIndex: -1
+property targetWindow: null
+property theProgram: "Google Chrome"
+
+on run argv
+  set theURL to item 1 of argv
+
+  -- Allow requested program to be optional,
+  -- default to Google Chrome
+  if (count of argv) > 1 then
+    set theProgram to item 2 of argv
+  end if
+
+  using terms from application "Google Chrome"
+    tell application theProgram
+
+      if (count every window) = 0 then
+        make new window
+      end if
+
+      -- 1: Looking for tab running debugger
+      -- then, Reload debugging tab if found
+      -- then return
+      set found to my lookupTabWithUrl(theURL)
+      if found then
+        set targetWindow's active tab index to targetTabIndex
+        tell targetTab to reload
+        tell targetWindow to activate
+        set index of targetWindow to 1
+        return
+      end if
+
+      -- 2: Looking for Empty tab
+      -- In case debugging tab was not found
+      -- We try to find an empty tab instead
+      set found to my lookupTabWithUrl("chrome://newtab/")
+      if found then
+        set targetWindow's active tab index to targetTabIndex
+        set URL of targetTab to theURL
+        tell targetWindow to activate
+        return
+      end if
+
+      -- 3: Create new tab
+      -- both debugging and empty tab were not found
+      -- make a new tab with url
+      tell window 1
+        activate
+        make new tab with properties {URL:theURL}
+      end tell
+    end tell
+  end using terms from
+end run
+
+-- Function:
+-- Lookup tab with given url
+-- if found, store tab, index, and window in properties
+-- (properties were declared on top of file)
+on lookupTabWithUrl(lookupUrl)
+  using terms from application "Google Chrome"
+    tell application theProgram
+      -- Find a tab with the given url
+      set found to false
+      set theTabIndex to -1
+      repeat with theWindow in every window
+        set theTabIndex to 0
+        repeat with theTab in every tab of theWindow
+          set theTabIndex to theTabIndex + 1
+          if (theTab's URL as string) contains lookupUrl then
+            -- assign tab, tab index, and window to properties
+            set targetTab to theTab
+            set targetTabIndex to theTabIndex
+            set targetWindow to theWindow
+            set found to true
+            exit repeat
+          end if
+        end repeat
+
+        if found then
+          exit repeat
+        end if
+      end repeat
+    end tell
+  end using terms from
+  return found
+end lookupTabWithUrl