com.jimuwd.xian.registry-proxy 1.0.131 → 1.0.133

package/README.MD

@@ -70,142 +70,6 @@ unsafeHttpWhitelist:
 
 在 `scripts/` 目录下创建 `install-from-proxy-registries.sh` 脚本，用于自动化代理设置和依赖安装：
 
-```bash
-#!/bin/bash
-
-# 启用严格模式，但移除 set -e，手动处理错误
-set -u  # 未定义变量时退出
-set -o pipefail  # 管道中任一命令失败时退出
-
-# 动态确定项目根目录（假设 package.json 所在目录为根目录）
-find_project_root() {
-  local dir="$PWD"
-  while [ "$dir" != "/" ]; do
-    if [ -f "$dir/package.json" ]; then
-      echo "$dir"
-      return 0
-    fi
-    dir=$(dirname "$dir")
-  done
-  echo "Error: Could not find project root (package.json not found)" >&2
-  exit 1
-}
-
-PROJECT_ROOT=$(find_project_root)
-
-# 定义锁文件和端口文件路径（固定在项目根目录）
-LOCK_FILE="$PROJECT_ROOT/.registry-proxy-install.lock"
-
-# 检查是否已经在运行（通过锁文件）
-if [ -f "$LOCK_FILE" ]; then
-  echo "Custom install script is already running (lock file $LOCK_FILE exists)."
-  echo "If this is unexpected, please remove $LOCK_FILE and try again."
-  exit 0  # 内层脚本直接退出，表示任务已由外层脚本完成
-fi
-
-# 创建锁文件
-touch "$LOCK_FILE"
-
-# 清理函数，支持不同的退出状态
-# 参数 $1：退出状态（0 表示正常退出，1 表示异常退出）
-cleanup() {
-  local exit_code=${1:-1}  # 默认退出码为 1（异常退出）
-
-  # 显式清除 EXIT 信号的 trap，避免潜在的误解
-  trap - EXIT
-
-  if [ "$exit_code" -eq 0 ]; then
-    echo "Cleaning up after successful execution..."
-  else
-    echo "Caught interrupt signal or error, cleaning up..."
-  fi
-
-  # 清理临时文件
-  rm -f "$LOCK_FILE" 2>/dev/null
-  # PORT_FILE端口临时文件是registry-proxy服务器管理的文件这里不负责清理，服务器退出时会自动清理
-  #rm -f "$PORT_FILE" 2>/dev/null
-
-  # 停止代理服务器
-  if [ -n "${PROXY_PID:-}" ]; then
-    echo "Stopping proxy server (PID: $PROXY_PID)..."
-    kill -TERM "$PROXY_PID" 2>/dev/null
-    wait "$PROXY_PID" 2>/dev/null || true
-    echo "Proxy server stopped."
-  fi
-
-  # 切换到项目根目录
-  # shellcheck disable=SC2164
-  cd "$PROJECT_ROOT"
-
-  # 清理 npmRegistryServer 配置
-  yarn config unset npmRegistryServer 2>/dev/null || true
-  echo "Cleared npmRegistryServer configuration"
-
-  # 根据退出状态退出
-  exit "$exit_code"
-}
-
-# 注册信号处理
-trap 'cleanup 1' SIGINT SIGTERM EXIT  # 异常退出时调用 cleanup，退出码为 1
-
-# 切换到项目根目录
-# shellcheck disable=SC2164
-cd "$PROJECT_ROOT"
-
-# 使用 yarn dlx 直接运行 registry-proxy，可通过环境变量指定registry-proxy版本号，默认是latest，registry-proxy将会被放入后台运行，并在安装结束后自动退出。
-REGISTRY_PROXY_VERSION="${REGISTRY_PROXY_VERSION:-latest}"
-echo "Starting registry-proxy@$REGISTRY_PROXY_VERSION in the background (logs will be displayed below)..."
-# 下载registry-proxy临时可执行程序并运行  因yarn可能会缓存tarball url的缘故（yarn.lock内<package>.resolution值），这里不得已只能写死本地代理端口地址，以便无论是从缓存获取tarball url还是从代理服务提供的元数据获取tarball url地址都能成功下载tarball文件
-# 但是注意 这个端口不能暴露到外部使用，只允许本地使用，避免不必要的安全隐患 事实上registry-proxy server也是只监听着::1本机端口的。
-yarn dlx com.jimuwd.xian.registry-proxy@"$REGISTRY_PROXY_VERSION" .registry-proxy.yml .yarnrc.yml ~/.yarnrc.yml 40061 &
-PROXY_PID=$!
-
-# 等待代理服务器启动并写入端口，最多 30 秒
-echo "Waiting for proxy server to start (up to 30 seconds)..."
-PORT_FILE="$PROJECT_ROOT/.registry-proxy-port"
-# shellcheck disable=SC2034
-for i in {1..300}; do  # 300 次循环，每次 0.1 秒，总共 30 秒
-  if [ -f "$PORT_FILE" ]; then
-    PROXY_PORT=$(cat "$PORT_FILE")
-    if [ -z "$PROXY_PORT" ]; then
-      echo "Error: Port file $PORT_FILE is empty"
-      cleanup 1
-    fi
-    if nc -z localhost "$PROXY_PORT" 2>/dev/null; then
-      echo "Proxy server is ready on port $PROXY_PORT!"
-      break
-    else
-      # 检查端口是否被占用
-      if netstat -tuln 2>/dev/null | grep -q ":$PROXY_PORT "; then
-        echo "Error: Port $PROXY_PORT is already in use by another process"
-        cleanup 1
-      fi
-    fi
-  fi
-  sleep 0.1
-done
-
-# 检查是否成功启动
-if [ -z "${PROXY_PORT:-}" ] || ! nc -z localhost "$PROXY_PORT" 2>/dev/null; then
-  echo "Error: Proxy server failed to start after 30 seconds"
-  echo "Please check the registry-proxy logs above for more details."
-  cleanup 1
-fi
-
-# 动态设置 npmRegistryServer 为代理地址 注意：yarn对“localhost”域名不友好，请直接使用 [::1]
-yarn config set npmRegistryServer "http://[::1]:$PROXY_PORT"
-echo "Set npmRegistryServer to http://[::1]:$PROXY_PORT"
-
-# 使用动态代理端口运行 yarn install，并捕获错误
-if ! yarn install; then
-  echo "Error: yarn install failed"
-  cleanup 1
-fi
-
-# 正常执行完成，调用 cleanup 并传入退出码 0
-cleanup 0
-```
-
 ### 5. 设置脚本权限
 
 确保脚本具有可执行权限，并将权限状态提交到版本控制：

package/dist/client/yarn-install.js

@@ -3,8 +3,8 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import { execa } from 'execa';
-import net from 'node:net';
-import { fileURLToPath } from 'node:url';
+import findProjectRoot from "../utils/findProjectRoot.js";
+import { isPortConnectable } from "../utils/portTester.js";
 // Constants
 const REGISTRY_PROXY_VERSION = process.env.REGISTRY_PROXY_VERSION || 'latest';
 const LOCK_FILE_NAME = '.registry-proxy-install.lock';
@@ -15,31 +15,6 @@ const CHECK_INTERVAL_MS = 100; // 0.1 seconds
 let proxyProcess = null;
 let cleanupHandlers = [];
 let signalHandlers = [];
-// Helper functions
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-async function findProjectRoot(startDir = process.cwd()) {
-    let dir = startDir;
-    while (dir !== '/') {
-        try {
-            await fs.access(path.join(dir, 'package.json'));
-            return dir;
-        }
-        catch {
-            dir = path.dirname(dir);
-        }
-    }
-    throw new Error('Could not find project root (package.json not found)');
-}
-async function isPortAvailable(port) {
-    return new Promise(resolve => {
-        const server = net.createServer();
-        server.unref();
-        server.on('error', () => resolve(false));
-        server.listen({ port }, () => {
-            server.close(() => resolve(true));
-        });
-    });
-}
 async function waitForFile(filePath, timeoutMs) {
     const startTime = Date.now();
     while (Date.now() - startTime < timeoutMs) {
@@ -53,6 +28,10 @@ async function waitForFile(filePath, timeoutMs) {
     }
     return false;
 }
+/**
+ * 读取约定的端口文件内容
+ * @param filePath 由server端启动时生成的端口文件路径
+ */
 async function readPortFile(filePath) {
     const content = await fs.readFile(filePath, 'utf-8');
     const port = parseInt(content.trim(), 10);
@@ -61,17 +40,6 @@ async function readPortFile(filePath) {
     }
     return port;
 }
-async function checkPortListening(port) {
-    return new Promise(resolve => {
-        const socket = new net.Socket();
-        socket.on('error', () => resolve(false));
-        socket.on('connect', () => {
-            socket.destroy();
-            resolve(true);
-        });
-        socket.connect({ port, host: '::1' });
-    });
-}
 // Cleanup management
 async function cleanup(exitCode = 1) {
     // Run all cleanup handlers in reverse order
@@ -94,10 +62,10 @@ function registerSignalHandler(handler) {
 // Main implementation
 async function main() {
     try {
-        // Find project root
-        const PROJECT_ROOT = await findProjectRoot();
-        const LOCK_FILE = path.join(PROJECT_ROOT, LOCK_FILE_NAME);
-        const PORT_FILE = path.join(PROJECT_ROOT, PORT_FILE_NAME);
+        // Find project root as base dir to get config file and other tmp files.
+        const INSTALLATION_ROOT = await findProjectRoot();
+        const LOCK_FILE = path.join(INSTALLATION_ROOT, LOCK_FILE_NAME);
+        const PORT_FILE = path.join(INSTALLATION_ROOT, PORT_FILE_NAME);
         // Check for existing lock file
         try {
             await fs.access(LOCK_FILE);
@@ -117,12 +85,12 @@ async function main() {
             }
         });
         // Change to project root
-        process.chdir(PROJECT_ROOT);
+        process.chdir(INSTALLATION_ROOT);
         // Start registry proxy
         console.log(`Starting registry-proxy@${REGISTRY_PROXY_VERSION} in the background...`);
         proxyProcess = execa('yarn', [
-            'dlx',
-            `com.jimuwd.xian.registry-proxy@${REGISTRY_PROXY_VERSION}`,
+            'dlx', '-p', `com.jimuwd.xian.registry-proxy@${REGISTRY_PROXY_VERSION}`,
+            'registry-proxy',
             '.registry-proxy.yml',
             '.yarnrc.yml',
             path.join(process.env.HOME || '', '.yarnrc.yml'),
@@ -151,15 +119,10 @@ async function main() {
             throw new Error(`Proxy server failed to create port file after ${MAX_WAIT_TIME_MS / 1000} seconds`);
         }
         const PROXY_PORT = await readPortFile(PORT_FILE);
-        const portAvailable = await isPortAvailable(PROXY_PORT);
-        if (!portAvailable) {
-            throw new Error(`Port ${PROXY_PORT} is already in use by another process`);
-        }
-        const isListening = await checkPortListening(PROXY_PORT);
-        if (!isListening) {
+        const portConnectable = await isPortConnectable(PROXY_PORT);
+        if (!portConnectable) {
             throw new Error(`Proxy server not listening on port ${PROXY_PORT}`);
         }
-        console.log(`Proxy server is ready on port ${PROXY_PORT}!`);
         // Configure yarn
         await execa('yarn', ['config', 'set', 'npmRegistryServer', `http://[::1]:${PROXY_PORT}`]);
         console.log(`Set npmRegistryServer to http://[::1]:${PROXY_PORT}`);
@@ -187,23 +150,26 @@ async function main() {
         await cleanup(1);
     }
 }
-// Signal handling
-['SIGINT', 'SIGTERM', 'SIGHUP'].forEach(signal => {
-    process.on(signal, async () => {
-        console.log(`Received ${signal}, cleaning up...`);
-        for (const handler of signalHandlers) {
-            try {
-                await handler();
-            }
-            catch (err) {
-                console.error('Signal handler error:', err);
+// 当前模块是否是直接运行的入口文件，而不是被其他模块导入的
+if (import.meta.url === `file://${process.argv[1]}`) {
+    // Signal handling
+    ['SIGINT', 'SIGTERM', 'SIGHUP'].forEach(signal => {
+        process.on(signal, async () => {
+            console.log(`Received ${signal}, cleaning up...`);
+            for (const handler of signalHandlers) {
+                try {
+                    await handler();
+                }
+                catch (err) {
+                    console.error('Signal handler error:', err);
+                }
             }
-        }
-        await cleanup(1);
+            await cleanup(1);
+        });
     });
-});
-// Start the program
-main().catch(err => {
-    console.error('Unhandled error:', err);
-    cleanup(1);
-});
+    // Start the program
+    main().catch(err => {
+        console.error('Unhandled error:', err);
+        cleanup(1);
+    });
+}

package/dist/utils/findProjectRoot.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 获取以package.json为基准的工程路径
+ * @param startDir 起点路径，由此向上逐级搜索package.json文件直到找到其路径作为工程基础路径值返回
+ */
+export default function findProjectRoot(startDir?: string): Promise<string>;

package/dist/utils/findProjectRoot.js

@@ -0,0 +1,19 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+/**
+ * 获取以package.json为基准的工程路径
+ * @param startDir 起点路径，由此向上逐级搜索package.json文件直到找到其路径作为工程基础路径值返回
+ */
+export default async function findProjectRoot(startDir = process.cwd()) {
+    let dir = startDir;
+    while (dir !== '/') {
+        try {
+            await fs.access(path.join(dir, 'package.json'));
+            return dir;
+        }
+        catch {
+            dir = path.dirname(dir);
+        }
+    }
+    throw new Error('Could not find project root (package.json not found)');
+}

package/dist/utils/portTester.d.ts

@@ -0,0 +1,18 @@
+export declare function isPortFree(port: number): Promise<boolean>;
+/**
+ * 检查指定端口是否可连接（有服务正在监听）
+ * @param port 要检查的端口号
+ * @param host 目标主机（默认本地IPv6 ::1）
+ * @param timeout 超时时间（毫秒，默认1000ms）
+ */
+export declare function isPortConnectable(port: number, host?: string, timeout?: number): Promise<boolean>;
+/**
+ * 简单的检查，若需要更高级的检查，请使用{@link isPortConnectable}
+ */
+declare function checkPortListening(port: number): Promise<boolean>;
+declare const _default: {
+    isPortFree: typeof isPortFree;
+    isPortConnectable: typeof isPortConnectable;
+    checkPortListening: typeof checkPortListening;
+};
+export default _default;

package/dist/utils/portTester.js

@@ -0,0 +1,52 @@
+import net from "node:net";
+export async function isPortFree(port) {
+    return new Promise(resolve => {
+        const server = net.createServer();
+        server.unref();
+        server.on('error', () => resolve(false));
+        server.listen({ port }, () => {
+            server.close(() => resolve(true));
+        });
+    });
+}
+/**
+ * 检查指定端口是否可连接（有服务正在监听）
+ * @param port 要检查的端口号
+ * @param host 目标主机（默认本地IPv6 ::1）
+ * @param timeout 超时时间（毫秒，默认1000ms）
+ */
+export async function isPortConnectable(port, host = '::1', timeout = 1000) {
+    return new Promise((resolve) => {
+        const socket = new net.Socket();
+        // 设置超时
+        socket.setTimeout(timeout);
+        socket.on('connect', () => {
+            socket.destroy();
+            resolve(true);
+        });
+        socket.on('timeout', () => {
+            socket.destroy();
+            resolve(false);
+        });
+        socket.on('error', () => {
+            socket.destroy();
+            resolve(false);
+        });
+        socket.connect(port, host);
+    });
+}
+/**
+ * 简单的检查，若需要更高级的检查，请使用{@link isPortConnectable}
+ */
+async function checkPortListening(port) {
+    return new Promise(resolve => {
+        const socket = new net.Socket();
+        socket.on('error', () => resolve(false));
+        socket.on('connect', () => {
+            socket.destroy();
+            resolve(true);
+        });
+        socket.connect({ port, host: '::1' });
+    });
+}
+export default { isPortFree, isPortConnectable, checkPortListening };

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "com.jimuwd.xian.registry-proxy",
-  "version": "1.0.131",
+  "version": "1.0.133",
   "description": "A lightweight npm registry proxy with fallback support",
   "type": "module",
   "main": "dist/server/index.js",
   "bin": {
-    "registry-proxy": "dist/server/index.js"
+    "registry-proxy": "dist/server/index.js",
+    "yarn-install": "dist/client/yarn-install.js",
+    "yarn-install-bash": "src/client/yarn-install.sh"
   },
   "files": [
-    "dist"
+    "dist",
+    "src/client/yarn-install.sh"
   ],
   "scripts": {
     "build": "tsc",

package/src/client/yarn-install.sh

@@ -0,0 +1,133 @@
+#!/bin/bash
+
+# 启用严格模式，但移除 set -e，手动处理错误
+set -u  # 未定义变量时退出
+set -o pipefail  # 管道中任一命令失败时退出
+
+# 动态确定项目根目录（假设 package.json 所在目录为根目录）
+find_project_root() {
+  local dir="$PWD"
+  while [ "$dir" != "/" ]; do
+    if [ -f "$dir/package.json" ]; then
+      echo "$dir"
+      return 0
+    fi
+    dir=$(dirname "$dir")
+  done
+  echo "Error: Could not find project root (package.json not found)" >&2
+  exit 1
+}
+
+PROJECT_ROOT=$(find_project_root)
+
+# 定义锁文件和端口文件路径（固定在项目根目录）
+LOCK_FILE="$PROJECT_ROOT/.registry-proxy-install.lock"
+
+# 检查是否已经在运行（通过锁文件）
+if [ -f "$LOCK_FILE" ]; then
+  echo "Custom install script is already running (lock file $LOCK_FILE exists)."
+  echo "If this is unexpected, please remove $LOCK_FILE and try again."
+  exit 0  # 内层脚本直接退出，表示任务已由外层脚本完成
+fi
+
+# 创建锁文件
+touch "$LOCK_FILE"
+
+# 清理函数，支持不同的退出状态
+# 参数 $1：退出状态（0 表示正常退出，1 表示异常退出）
+cleanup() {
+  local exit_code=${1:-1}  # 默认退出码为 1（异常退出）
+
+  # 显式清除 EXIT 信号的 trap，避免潜在的误解
+  trap - EXIT
+
+  if [ "$exit_code" -eq 0 ]; then
+    echo "Cleaning up after successful execution..."
+  else
+    echo "Caught interrupt signal or error, cleaning up..."
+  fi
+
+  # 清理临时文件
+  rm -f "$LOCK_FILE" 2>/dev/null
+  # PORT_FILE端口临时文件是registry-proxy服务器管理的文件这里不负责清理，服务器退出时会自动清理
+  #rm -f "$PORT_FILE" 2>/dev/null
+
+  # 停止代理服务器
+  if [ -n "${PROXY_PID:-}" ]; then
+    echo "Stopping proxy server (PID: $PROXY_PID)..."
+    kill -TERM "$PROXY_PID" 2>/dev/null
+    wait "$PROXY_PID" 2>/dev/null || true
+    echo "Proxy server stopped."
+  fi
+
+  # 切换到项目根目录
+  # shellcheck disable=SC2164
+  cd "$PROJECT_ROOT"
+
+  # 清理 npmRegistryServer 配置
+  yarn config unset npmRegistryServer 2>/dev/null || true
+  echo "Cleared npmRegistryServer configuration"
+
+  # 根据退出状态退出
+  exit "$exit_code"
+}
+
+# 注册信号处理
+trap 'cleanup 1' SIGINT SIGTERM EXIT  # 异常退出时调用 cleanup，退出码为 1
+
+# 切换到项目根目录
+# shellcheck disable=SC2164
+cd "$PROJECT_ROOT"
+
+# 使用 yarn dlx 直接运行 registry-proxy，可通过环境变量指定registry-proxy版本号，默认是latest，registry-proxy将会被放入后台运行，并在安装结束后自动退出。
+REGISTRY_PROXY_VERSION="${REGISTRY_PROXY_VERSION:-latest}"
+echo "Starting registry-proxy@$REGISTRY_PROXY_VERSION in the background (logs will be displayed below)..."
+# 下载registry-proxy临时可执行程序并运行  因yarn可能会缓存tarball url的缘故（yarn.lock内<package>.resolution值），这里不得已只能写死本地代理端口地址，以便无论是从缓存获取tarball url还是从代理服务提供的元数据获取tarball url地址都能成功下载tarball文件
+# 但是注意 这个端口不能暴露到外部使用，只允许本地使用，避免不必要的安全隐患 事实上registry-proxy server也是只监听着::1本机端口的。
+yarn dlx -p com.jimuwd.xian.registry-proxy@"$REGISTRY_PROXY_VERSION" registry-proxy .registry-proxy.yml .yarnrc.yml ~/.yarnrc.yml 40061 &
+PROXY_PID=$!
+
+# 等待代理服务器启动并写入端口，最多 30 秒
+echo "Waiting for proxy server to start (up to 30 seconds)..."
+PORT_FILE="$PROJECT_ROOT/.registry-proxy-port"
+# shellcheck disable=SC2034
+for i in {1..300}; do  # 300 次循环，每次 0.1 秒，总共 30 秒
+  if [ -f "$PORT_FILE" ]; then
+    PROXY_PORT=$(cat "$PORT_FILE")
+    if [ -z "$PROXY_PORT" ]; then
+      echo "Error: Port file $PORT_FILE is empty"
+      cleanup 1
+    fi
+    if nc -z localhost "$PROXY_PORT" 2>/dev/null; then
+      echo "Proxy server is ready on port $PROXY_PORT!"
+      break
+    else
+      # 检查端口是否被占用
+      if netstat -tuln 2>/dev/null | grep -q ":$PROXY_PORT "; then
+        echo "Error: Port $PROXY_PORT is already in use by another process"
+        cleanup 1
+      fi
+    fi
+  fi
+  sleep 0.1
+done
+
+# 检查是否成功启动
+if [ -z "${PROXY_PORT:-}" ] || ! nc -z localhost "$PROXY_PORT" 2>/dev/null; then
+  echo "Error: Proxy server failed to start after 30 seconds"
+  echo "Please check the registry-proxy logs above for more details."
+  cleanup 1
+fi
+
+# 动态设置 npmRegistryServer 为代理地址 注意：yarn对“localhost”域名不友好，请直接使用 [::1]
+yarn config set npmRegistryServer "http://[::1]:$PROXY_PORT"
+echo "Set npmRegistryServer to http://[::1]:$PROXY_PORT"
+
+# 使用动态代理端口运行 yarn install，并捕获错误
+if ! yarn install; then
+  echo "Error: yarn install failed"
+  cleanup 1
+fi
+
+# 正常执行完成，调用 cleanup 并传入退出码 0
+cleanup 0