com.jimuwd.xian.registry-proxy 1.0.123 → 1.0.125

package/dist/gracefullShutdown.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 优雅退出
+ * 本函数是对process.exit的封装，同时执行资源释放动作，程序必须统一调用本方法退出，决不允许直接调用{@link process.exit}来退出。
+ */
+export declare function gracefulShutdown(): Promise<void>;

package/dist/gracefullShutdown.js

@@ -0,0 +1,34 @@
+import { deletePortFile } from "./port.js";
+import logger from "./utils/logger.js";
+/**
+ * 优雅退出
+ * 本函数是对process.exit的封装，同时执行资源释放动作，程序必须统一调用本方法退出，决不允许直接调用{@link process.exit}来退出。
+ */
+export async function gracefulShutdown() {
+    try {
+        logger.info('Shutdown...');
+        await doCleanup();
+        logger.info('Shutdown completed.');
+        process.exit(0);
+    }
+    catch (err) {
+        logger.error('Failed to clean:', err);
+        process.exit(1);
+    }
+}
+async function doCleanup() {
+    await deletePortFile();
+}
+// 捕获信号或异常
+process.on('SIGINT', () => {
+    logger.info('收到 SIGINT（Ctrl+C）');
+    process.exit(0); // 触发 exit 事件
+});
+process.on('SIGTERM', () => {
+    logger.info('收到 SIGTERM');
+    process.exit(0); // 触发 exit 事件
+});
+process.on('uncaughtException', (err) => {
+    logger.info('uncaughtException:', err);
+    process.exit(1); // 触发 exit 事件
+});

package/dist/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import http, { createServer } from 'node:http';
 import https, { createServer as createHttpsServer } from 'node:https';
-import { promises as fsPromises, readFileSync } from 'fs';
+import { promises as fsPromises, readFileSync } from 'node:fs';
 import { load } from 'js-yaml';
 import fetch from 'node-fetch';
 import { homedir } from 'os';
@@ -9,6 +9,8 @@ import { join, resolve } from 'path';
 import { URL } from 'url';
 import logger from "./utils/logger.js";
 import ConcurrencyLimiter from "./utils/ConcurrencyLimiter.js";
+import { gracefulShutdown } from "./gracefullShutdown.js";
+import { writePortFile } from "./port.js";
 const { readFile, writeFile } = fsPromises;
 const limiter = new ConcurrencyLimiter(Infinity);
 function removeEndingSlashAndForceStartingSlash(str) {
@@ -56,20 +58,21 @@ function removeRegistryPrefix(tarballUrl, registries) {
     throw new Error(`Can't find tarball url ${tarballUrl} does not match given registries ${normalizedRegistries}`);
 }
 async function readProxyConfig(proxyConfigPath = './.registry-proxy.yml') {
+    let config = undefined;
     const resolvedPath = resolvePath(proxyConfigPath);
     try {
         const content = await readFile(resolvedPath, 'utf8');
-        const config = load(content);
-        if (!config.registries) {
-            logger.error('Missing required "registries" field in config');
-            process.exit(1);
-        }
-        return config;
+        config = load(content);
     }
     catch (e) {
         logger.error(`Failed to load proxy config from ${resolvedPath}:`, e);
-        process.exit(1);
+        await gracefulShutdown();
+    }
+    if (!config?.registries) {
+        logger.error('Missing required "registries" field in config');
+        await gracefulShutdown();
     }
+    return config;
 }
 async function readYarnConfig(path) {
     try {
@@ -171,7 +174,7 @@ async function writeResponseToDownstreamClient(registryInfo, targetUrl, resToDow
             const data = await upstreamResponse.json();
             if (data.versions) { // 处理node依赖包元数据
                 logger.info("Write package meta data application/json response from upstream to downstream", targetUrl);
-                const host = reqFromDownstreamClient.headers.host || `127.0.0.1:${proxyPort}`;
+                const host = reqFromDownstreamClient.headers.host /*|| `[::1]:${proxyPort}`*/;
                 const baseUrl = `${proxyInfo.https ? 'https' : 'http'}://${host}${proxyInfo.basePath === '/' ? '' : proxyInfo.basePath}`;
                 for (const versionKey in data.versions) {
                     const packageVersion = data.versions[versionKey];
@@ -299,7 +302,6 @@ function getDownstreamClientIp(req) {
     // 直接连接时，取 socket.remoteAddress
     return req.socket.remoteAddress;
 }
-// deprecated 出于安全考虑只监听::1地址，废弃本注释：同时启动ipv6,ipv4监听，比如当客户端访问http://localhost:port时，无论客户端DNS解析到IPV4-127.0.0.1还是IPV6-::1地址，咱server都能轻松应对！
 export async function startProxyServer(proxyConfigPath, localYarnConfigPath, globalYarnConfigPath, port = 0) {
     const proxyInfo = await loadProxyInfo(proxyConfigPath, localYarnConfigPath, globalYarnConfigPath);
     const registryInfos = proxyInfo.registries;
@@ -358,7 +360,6 @@ export async function startProxyServer(proxyConfigPath, localYarnConfigPath, glo
             resToDownstreamClient.writeHead(404).end('All upstream registries failed');
         }
     };
-    // deprecated 废弃本注释：需要同时启动ipv6,ipv4监听，比如当客户端访问http://localhost:port时，无论客户端DNS解析到IPV4-127.0.0.1还是IPV6-::1地址，咱server都能轻松应对！
     let server;
     if (proxyInfo.https) {
         const { key, cert } = proxyInfo.https;
@@ -407,12 +408,12 @@ export async function startProxyServer(proxyConfigPath, localYarnConfigPath, glo
         server.on('error', errHandler /*this handler will call 'reject'*/);
         server.on('connection', connectionHandler);
         // 为了代理服务器的安全性，暂时只监听本机ipv6地址【::1】，不能对本机之外暴露本代理服务地址避免造成安全隐患
+        // 注意：截止目前yarn客户端如果通过localhost:<port>来访问本服务，可能会报错ECONNREFUSED错误码，原因是yarn客户端环境解析“localhost”至多个地址，它会尝试轮询每个地址。
         const listenOptions = { port, host: '::1', ipv6Only: true };
-        server.listen(listenOptions, () => {
+        server.listen(listenOptions, async () => {
             const addressInfo = server.address();
             port = addressInfo.port; // 回写上层局部变量
-            const portFile = join(process.env.PROJECT_ROOT || process.cwd(), '.registry-proxy-port');
-            writeFile(portFile, addressInfo.port.toString()).catch(e => logger.error(`Failed to write port file: ${portFile}`, e));
+            await writePortFile(port);
             logger.info(`Proxy server running on ${proxyInfo.https ? 'https' : 'http'}://localhost:${addressInfo.port}${basePathPrefixedWithSlash === '/' ? '' : basePathPrefixedWithSlash}`);
             resolve(server);
         });

package/dist/port.d.ts

@@ -0,0 +1,4 @@
+export declare const PORT_FILE_NAME = ".registry-proxy-port";
+export declare const portFile: string;
+export declare function writePortFile(port: number): Promise<void>;
+export declare const deletePortFile: () => Promise<void>;

package/dist/port.js

@@ -0,0 +1,26 @@
+import { basename, join } from "node:path";
+import { promises as nodeFsPromises } from 'node:fs';
+import logger from "./utils/logger.js";
+const { unlink, writeFile, } = nodeFsPromises;
+export const PORT_FILE_NAME = '.registry-proxy-port';
+export const portFile = join(process.env.PROJECT_ROOT || process.cwd(), PORT_FILE_NAME);
+export async function writePortFile(port) {
+    await writeFile(portFile, port.toString()).catch(e => logger.error(`Failed to write port file: ${portFile}`, e));
+}
+export const deletePortFile = async () => {
+    await deleteFile(portFile);
+};
+async function deleteFile(filePath) {
+    try {
+        await unlink(filePath);
+        console.log(`文件 ${basename(filePath)} 已删除`);
+    }
+    catch (err) {
+        if (err.code === 'ENOENT') {
+            console.log('文件不存在');
+        }
+        else {
+            console.error('删除失败:', err.message);
+        }
+    }
+}

package/package.json

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