com.jimuwd.xian.registry-proxy 1.1.21 → 1.1.24

package/dist/client/yarn-install.js

@@ -5,6 +5,7 @@ import path from 'node:path';
 import { execa } from 'execa';
 import findProjectRoot from "../utils/findProjectRoot.js";
 import { isPortConnectable } from "../utils/portTester.js";
+import { readYarnConfig } from "../utils/configFileReader.js";
 // Constants
 const REGISTRY_PROXY_VERSION = process.env.REGISTRY_PROXY_VERSION || 'latest';
 const LOCK_FILE_NAME = '.registry-proxy-install.lock';
@@ -63,105 +64,114 @@ function registerSignalHandler(handler) {
 // Main implementation
 async function main() {
     try {
-        // 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
+        await startLocalRegistryProxyServerAndYarnInstallWithoutCleanup();
+        await cleanup(0);
+    }
+    catch (err) {
+        console.error('Error:', err instanceof Error ? err.message : String(err));
+        await cleanup(1);
+    }
+}
+async function startLocalRegistryProxyServerAndYarnInstallWithoutCleanup() {
+    // 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);
+        console.log(`Custom install script is already running (lock file ${LOCK_FILE} exists).`);
+        console.log(`If this is unexpected, please remove ${LOCK_FILE} and try again.`);
+        return cleanup(0);
+    }
+    catch {
+    }
+    // Create lock file
+    await fs.writeFile(LOCK_FILE, process.pid.toString());
+    registerCleanup(async () => {
         try {
-            await fs.access(LOCK_FILE);
-            console.log(`Custom install script is already running (lock file ${LOCK_FILE} exists).`);
-            console.log(`If this is unexpected, please remove ${LOCK_FILE} and try again.`);
-            return cleanup(0);
+            await fs.unlink(LOCK_FILE);
         }
-        catch {
+        catch (err) { //cleanup程序不要抛出任何异常
+            console.error(`Failed to delete lock file: ${LOCK_FILE}`, err);
         }
-        // Create lock file
-        await fs.writeFile(LOCK_FILE, process.pid.toString());
-        registerCleanup(async () => {
+    });
+    // Change to project root
+    process.chdir(INSTALLATION_ROOT);
+    // Start registry proxy
+    console.log(`Starting registry-proxy@${REGISTRY_PROXY_VERSION} in the background...`);
+    // 提示：这里借助了execa调用"yarn dlx"后台运行registry proxy server的功能，没有直接使用本地ts函数调用的方式启动本地代理服务器，因为后者不太容易达到后台运行的效果。
+    proxyProcess = execa('yarn', [
+        'dlx', '-p', `com.jimuwd.xian.registry-proxy@${REGISTRY_PROXY_VERSION}`,
+        'registry-proxy',
+        '.registry-proxy.yml',
+        '.yarnrc.yml',
+        path.join(process.env.HOME || '', '.yarnrc.yml'),
+        /*之前是写死的静态端口40061，它有个缺点就是本地无法为多个项目工程并发执行yarn-install，现改为使用随机可用端口作为本地代理服务器端口，传'0'/''空串即可*/ '0'
+    ], {
+        detached: true,
+        stdio: 'inherit'
+    });
+    registerCleanup(async (_exitCode) => {
+        if (proxyProcess && !proxyProcess.killed) {
+            console.log('Stopping proxy server...');
             try {
-                await fs.unlink(LOCK_FILE);
-            }
-            catch (err) { //cleanup程序不要抛出任何异常
-                console.error(`Failed to delete lock file: ${LOCK_FILE}`, err);
+                proxyProcess.kill('SIGTERM');
+                await proxyProcess;
+                console.log('Proxy server stopped.');
             }
-        });
-        // Change to project root
-        process.chdir(INSTALLATION_ROOT);
-        // Start registry proxy
-        console.log(`Starting registry-proxy@${REGISTRY_PROXY_VERSION} in the background...`);
-        // 提示：这里借助了execa调用"yarn dlx"后台运行registry proxy server的功能，没有直接使用本地ts函数调用的方式启动本地代理服务器，因为后者不太容易达到后台运行的效果。
-        proxyProcess = execa('yarn', [
-            'dlx', '-p', `com.jimuwd.xian.registry-proxy@${REGISTRY_PROXY_VERSION}`,
-            'registry-proxy',
-            '.registry-proxy.yml',
-            '.yarnrc.yml',
-            path.join(process.env.HOME || '', '.yarnrc.yml'),
-            /*之前是写死的静态端口40061，它有个缺点就是本地无法为多个项目工程并发执行yarn-install，现改为使用随机可用端口作为本地代理服务器端口，传'0'/''空串即可*/ '0'
-        ], {
-            detached: true,
-            stdio: 'inherit'
-        });
-        registerCleanup(async (exitCode) => {
-            if (proxyProcess && !proxyProcess.killed) {
-                console.log('Stopping proxy server...');
-                try {
-                    proxyProcess.kill('SIGTERM');
-                    await proxyProcess;
-                    console.log('Proxy server stopped.');
-                }
-                catch (err) { // cleanup程序不要抛出异常
-                    console.error('Proxy server stopping with error', err);
-                }
+            catch (err) { // cleanup程序不要抛出异常
+                console.error('Proxy server stopping with error', err);
             }
-        });
-        // Wait for proxy to start
-        console.log('Waiting for proxy server to start (up to 30 seconds)...');
-        const fileExists = await waitForFile(PORT_FILE, MAX_WAIT_TIME_MS);
-        if (!fileExists) {
-            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 portConnectable = await isPortConnectable(PROXY_PORT);
-        if (!portConnectable) {
-            throw new Error(`Proxy server not listening on port ${PROXY_PORT}`);
         }
-        // Configure yarn
-        const { exitCode, stdout } = await execa('yarn', ['config', 'get', 'npmRegistryServer']);
-        await execa('yarn', ['config', 'set', 'npmRegistryServer', `http://127.0.0.1:${PROXY_PORT}`]);
-        console.log(`Set npmRegistryServer to http://127.0.0.1:${PROXY_PORT}`);
-        registerCleanup(async () => {
-            try {
-                let npmRegistryServer = stdout.trim();
-                if (exitCode === 0 && npmRegistryServer) { //恢复为原来的 npmRegistryServer
-                    await execa('yarn', ['config', 'set', 'npmRegistryServer', npmRegistryServer]);
-                    console.log(`Recover npmRegistryServer to ${npmRegistryServer}`);
-                }
-                else { //原来没有npmRegistryServer，则重置npmRegistryServer
-                    await execa('yarn', ['config', 'unset', 'npmRegistryServer']);
-                    console.log(`Unset npmRegistryServer.`);
-                }
+    });
+    // Wait for proxy to start
+    console.log('Waiting for proxy server to start (up to 30 seconds)...');
+    const fileExists = await waitForFile(PORT_FILE, MAX_WAIT_TIME_MS);
+    if (!fileExists) {
+        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 portConnectable = await isPortConnectable(PROXY_PORT);
+    if (!portConnectable) {
+        throw new Error(`Proxy server not listening on port ${PROXY_PORT}`);
+    }
+    // Configure yarn
+    const { exitCode, stdout } = await execa('yarn', ['config', 'get', 'npmRegistryServer']);
+    const npmRegistryServer = (exitCode === 0 && stdout) ? stdout.trim() : undefined;
+    const localNpmRegistryServer = (await readYarnConfig('.yarnrc.yml')).npmRegistryServer;
+    if (localNpmRegistryServer && localNpmRegistryServer === npmRegistryServer)
+        console.log("Using npmRegistryServer value in project local .yarnrc.yml config file.");
+    else
+        console.log("Using npmRegistryServer value in global config file.");
+    await execa('yarn', ['config', 'set', 'npmRegistryServer', `http://127.0.0.1:${PROXY_PORT}`]);
+    console.log(`Set npmRegistryServer to http://127.0.0.1:${PROXY_PORT}`);
+    registerCleanup(async () => {
+        try {
+            //if (npmRegistryServer) {//不能用这个变量来恢复为原来的 npmRegistryServer，因为它可能是全局配置~/.yarnrc.yml内的配置值或yarn工具官方默认值，而非本地.yarnrc.yml配置值。
+            if (localNpmRegistryServer && localNpmRegistryServer.trim()) { //恢复为本地配置文件原来的 npmRegistryServer 配置值
+                await execa('yarn', ['config', 'set', 'npmRegistryServer', localNpmRegistryServer]);
+                console.log(`Recover npmRegistryServer to ${localNpmRegistryServer}`);
             }
-            catch (err) { //cleanup程序不要抛出异常
-                console.error('Recover yarn config npmRegistryServer error.', err);
+            else { //原来本地配置文件中没有npmRegistryServer，则重置npmRegistryServer
+                await execa('yarn', ['config', 'unset', 'npmRegistryServer']);
+                console.log(`Unset npmRegistryServer.`);
             }
-        });
-        // Run yarn install
-        console.log('Running yarn install...');
-        try {
-            await execa('yarn', ['install'], { stdio: 'inherit' });
         }
-        catch (err) {
-            throw new Error('yarn install failed');
+        catch (err) { //cleanup程序不要抛出异常
+            console.error('Recover yarn config npmRegistryServer error.', err);
         }
-        // Success
-        console.info("Yarn install with local registry-proxy server success.");
-        await cleanup(0);
+    });
+    // Run yarn install
+    console.log('Running yarn install...');
+    try {
+        await execa('yarn', ['install'], { stdio: 'inherit' });
     }
     catch (err) {
-        console.error('Error:', err instanceof Error ? err.message : String(err));
-        await cleanup(1);
+        throw new Error('yarn install failed');
     }
+    // Success
+    console.info("Yarn install with local registry-proxy server success.");
 }
 // 当前模块是否是直接运行的入口文件，而不是被其他模块导入的
 if (import.meta.url === `file://${process.argv[1]}`) {

package/dist/models.d.ts

@@ -0,0 +1,34 @@
+interface RegistryConfig {
+    npmAuthToken?: string;
+}
+interface HttpsConfig {
+    key: string;
+    cert: string;
+}
+interface ProxyConfig {
+    registries: Record<string, RegistryConfig | null>;
+    https?: HttpsConfig;
+    basePath?: string;
+}
+interface YarnConfig {
+    npmRegistryServer?: string | null | undefined;
+    npmRegistries?: Record<string, RegistryConfig | null>;
+}
+interface RegistryInfo {
+    normalizedRegistryUrl: string;
+    token?: string;
+}
+interface ProxyInfo {
+    registries: RegistryInfo[];
+    https?: HttpsConfig;
+    basePath?: string;
+}
+interface PackageVersion {
+    dist?: {
+        tarball?: string;
+    };
+}
+interface PackageData {
+    versions?: Record<string, PackageVersion>;
+}
+export { RegistryConfig, HttpsConfig, ProxyConfig, YarnConfig, RegistryInfo, ProxyInfo, PackageVersion, PackageData };

package/dist/models.js

@@ -0,0 +1 @@
+export {};

package/dist/server/index.js

@@ -1,18 +1,18 @@
 #!/usr/bin/env node
 import http, { createServer } from 'node:http';
 import https, { createServer as createHttpsServer } from 'node:https';
-import { existsSync, promises as fsPromises, readFileSync } from 'node:fs';
-import { load } from 'js-yaml';
+import { promises as fsPromises, readFileSync } from 'node:fs';
 import fetch from 'node-fetch';
 import { homedir } from 'os';
-import { join, resolve } from 'path';
+import { join } from 'path';
 import { URL } from 'url';
 import logger from "../utils/logger.js";
 import ConcurrencyLimiter from "../utils/ConcurrencyLimiter.js";
 import { gracefulShutdown, registerProcessShutdownHook } from "./gracefullShutdown.js";
 import { writePortFile } from "../port.js";
 import resolveEnvValue from "../utils/resolveEnvValue.js";
-const { readFile } = fsPromises;
+import { readYarnConfig, resolvePath, } from "../utils/configFileReader.js";
+import { readProxyConfig, } from "./serverConfigReader.js";
 // 整个registry-proxy server实例 使用的全局限流器
 const LIMITER = new ConcurrencyLimiter(5);
 function removeEndingSlashAndForceStartingSlash(str) {
@@ -44,9 +44,6 @@ function normalizeUrl(httpOrHttpsUrl) {
         throw new Error(`Invalid URL: ${httpOrHttpsUrl}`, { cause: e });
     }
 }
-function resolvePath(path) {
-    return path.startsWith('~/') ? join(homedir(), path.slice(2)) : resolve(path);
-}
 function removeRegistryPrefix(tarballUrl, registries) {
     const normalizedTarball = normalizeUrl(tarballUrl);
     const normalizedRegistries = registries
@@ -59,48 +56,6 @@ function removeRegistryPrefix(tarballUrl, registries) {
     }
     throw new Error(`Can't find tarball url ${tarballUrl} does not match given registries ${normalizedRegistries}`);
 }
-/**
- * 读取yml配置文件得到配置值对象{@link ProxyConfig}
- * @note 本读取操作不会解析环境变量值
- * @param proxyConfigPath 配置文件路径
- */
-async function readProxyConfig(proxyConfigPath = './.registry-proxy.yml') {
-    let config = undefined;
-    const resolvedPath = resolvePath(proxyConfigPath);
-    try {
-        const content = await readFile(resolvedPath, 'utf8');
-        config = load(content);
-    }
-    catch (e) {
-        logger.error(`Failed to load proxy config from ${resolvedPath}:`, e);
-        await gracefulShutdown();
-    }
-    if (!config?.registries) {
-        logger.error('Missing required "registries" field in config');
-        await gracefulShutdown();
-    }
-    return config;
-}
-/**
- * 读取yml配置文件为yml对象
- * @param path yml文件路径
- */
-async function readYarnConfig(path) {
-    try {
-        if (existsSync(path)) {
-            const content = await readFile(resolvePath(path), 'utf8');
-            return load(content);
-        }
-        else {
-            logger.info(`Skip reading ${path}, because it does not exist.`);
-            return {};
-        }
-    }
-    catch (e) {
-        logger.warn(`Failed to load Yarn config from ${path}:`, e);
-        return {};
-    }
-}
 async function loadProxyInfo(proxyConfigPath = './.registry-proxy.yml', localYarnConfigPath = './.yarnrc.yml', globalYarnConfigPath = join(homedir(), '.yarnrc.yml')) {
     const [proxyConfig, localYarnConfig, globalYarnConfig] = await Promise.all([
         readProxyConfig(proxyConfigPath),

package/dist/server/serverConfigReader.d.ts

@@ -0,0 +1,8 @@
+import { ProxyConfig } from "../models.js";
+/**
+ * 读取yml配置文件得到配置值对象{@link ProxyConfig}
+ * @note 本读取操作不会解析环境变量值
+ * @param proxyConfigPath 配置文件路径
+ */
+declare function readProxyConfig(proxyConfigPath?: string): Promise<ProxyConfig>;
+export { readProxyConfig };

package/dist/server/serverConfigReader.js

@@ -0,0 +1,29 @@
+import { load } from "js-yaml";
+import { promises as fsPromises } from 'node:fs';
+import { gracefulShutdown } from "./gracefullShutdown.js";
+import { resolvePath } from "../utils/configFileReader.js";
+import logger from "../utils/logger.js";
+const { readFile } = fsPromises;
+/**
+ * 读取yml配置文件得到配置值对象{@link ProxyConfig}
+ * @note 本读取操作不会解析环境变量值
+ * @param proxyConfigPath 配置文件路径
+ */
+async function readProxyConfig(proxyConfigPath = './.registry-proxy.yml') {
+    let config = undefined;
+    const resolvedPath = resolvePath(proxyConfigPath);
+    try {
+        const content = await readFile(resolvedPath, 'utf8');
+        config = load(content);
+    }
+    catch (e) {
+        logger.error(`Failed to load proxy config from ${resolvedPath}:`, e);
+        await gracefulShutdown();
+    }
+    if (!config?.registries) {
+        logger.error('Missing required "registries" field in config');
+        await gracefulShutdown();
+    }
+    return config;
+}
+export { readProxyConfig };

package/dist/utils/configFileReader.d.ts

@@ -0,0 +1,13 @@
+import { YarnConfig } from "../models.js";
+/**
+ * 读取yml配置文件为yml对象
+ * @note 如果配置文件不存在，那么返回空对象，不抛异常。
+ * @param path yml文件路径
+ */
+declare function readYarnConfig(path: string): Promise<YarnConfig>;
+/**
+ * 标准化处理路径值
+ * @param path
+ */
+declare function resolvePath(path: string): string;
+export { readYarnConfig, resolvePath, };

package/dist/utils/configFileReader.js

@@ -0,0 +1,35 @@
+import { load } from "js-yaml";
+import { join, resolve } from "path";
+import { homedir } from "os";
+import { existsSync, promises as fsPromises } from 'node:fs';
+import logger from "./logger.js";
+const { readFile } = fsPromises;
+/**
+ * 读取yml配置文件为yml对象
+ * @note 如果配置文件不存在，那么返回空对象，不抛异常。
+ * @param path yml文件路径
+ */
+async function readYarnConfig(path) {
+    try {
+        if (existsSync(path)) {
+            const content = await readFile(resolvePath(path), 'utf8');
+            return load(content);
+        }
+        else {
+            logger.info(`Skip reading ${path}, because it does not exist.`);
+            return {};
+        }
+    }
+    catch (e) {
+        logger.warn(`Failed to load Yarn config from ${path}:`, e);
+        return {};
+    }
+}
+/**
+ * 标准化处理路径值
+ * @param path
+ */
+function resolvePath(path) {
+    return path.startsWith('~/') ? join(homedir(), path.slice(2)) : resolve(path);
+}
+export { readYarnConfig, resolvePath, };

package/dist/utils/logger.js

@@ -15,10 +15,10 @@ const PREFIX = {
 };
 // 代理服务器专用日志
 const logger = {
-    info: (...args) => console.log(`${PREFIX.proxy}`, ...args),
-    success: (...args) => console.log(`${PREFIX.proxy} ${COLORS.success}✓${COLORS.reset}`, ...args),
+    info: (...args) => { },
+    success: (...args) => { },
     error: (...args) => console.error(`${PREFIX.error}`, ...args),
-    warn: (...args) => console.warn(`${PREFIX.warn}`, ...args),
+    warn: (...args) => { },
     debug: (...args) => process.env.DEBUG && console.debug(`${PREFIX.debug}`, ...args)
 };
 export default logger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.jimuwd.xian.registry-proxy",
-  "version": "1.1.21",
+  "version": "1.1.24",
   "description": "A lightweight npm registry local proxy with fallback support",
   "type": "module",
   "main": "dist/server/index.js",