com.jimuwd.xian.registry-proxy 1.1.0 → 1.1.1

package/dist/server/index.js

@@ -11,6 +11,7 @@ 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;
 const limiter = new ConcurrencyLimiter(Infinity);
 function removeEndingSlashAndForceStartingSlash(str) {
@@ -57,6 +58,11 @@ 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);
@@ -74,6 +80,10 @@ async function readProxyConfig(proxyConfigPath = './.registry-proxy.yml') {
     }
     return config;
 }
+/**
+ * 读取yml配置文件为yml对象
+ * @param path yml文件路径
+ */
 async function readYarnConfig(path) {
     try {
         const content = await readFile(resolvePath(path), 'utf8');
@@ -93,7 +103,7 @@ async function loadProxyInfo(proxyConfigPath = './.registry-proxy.yml', localYar
     const registryMap = new Map();
     for (const [proxiedRegUrl, proxyRegConfig] of Object.entries(proxyConfig.registries)) {
         const normalizedProxiedRegUrl = normalizeUrl(proxiedRegUrl);
-        let token = proxyRegConfig?.npmAuthToken;
+        let token = resolveEnvValue(proxyRegConfig?.npmAuthToken);
         if (!token) {
             const yarnConfigs = [localYarnConfig, globalYarnConfig];
             for (const yarnConfig of yarnConfigs) {
@@ -103,6 +113,7 @@ async function loadProxyInfo(proxyConfigPath = './.registry-proxy.yml', localYar
                     if (foundEntry) {
                         const [, registryConfig] = foundEntry;
                         if (registryConfig?.npmAuthToken) {
+                            // .yarnrc.yml内的配置值，暂时不处理环境变量值，未来按需扩展
                             token = registryConfig.npmAuthToken;
                             break;
                         }
@@ -110,7 +121,10 @@ async function loadProxyInfo(proxyConfigPath = './.registry-proxy.yml', localYar
                 }
             }
         }
-        registryMap.set(normalizedProxiedRegUrl, { normalizedRegistryUrl: normalizedProxiedRegUrl, token });
+        registryMap.set(normalizedProxiedRegUrl, {
+            normalizedRegistryUrl: normalizedProxiedRegUrl,
+            token: token ? token : undefined
+        });
     }
     const registries = Array.from(registryMap.values());
     const https = proxyConfig.https;

package/dist/utils/resolveEnvValue.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 解析字符串中的环境变量占位符（格式为 `${ENV_VAR}`），并替换为实际环境变量的值。
+ * - 若环境变量不存在，则占位符会被替换为空字符串 `''`。
+ * - 若输入为 `null` 或 `undefined`，直接返回原值（不处理）。
+ *
+ * @param str - 待处理的字符串，可能包含环境变量占位符（如 `${API_URL}`）。支持 `null` 或 `undefined`。
+ * @returns 处理后的字符串。若输入为 `null` 或 `undefined`，返回原值；否则返回替换后的新字符串。
+ *
+ * @example
+ * // 环境变量未定义时，替换为 ''
+ * resolveEnvValue('${UNDEFINED_VAR}'); // => ''
+ *
+ * // 混合替换
+ * resolveEnvValue('Host: ${HOST}, Port: ${PORT}'); // => 'Host: 127.0.0.1, Port: 3000'（假设环境变量已定义）
+ *
+ * // 保留 null/undefined
+ * resolveEnvValue(null); // => null
+ */
+export default function resolveEnvValue(str: string | null | undefined): string | null | undefined;

package/dist/utils/resolveEnvValue.js

@@ -0,0 +1,33 @@
+/**
+ * 解析字符串中的环境变量占位符（格式为 `${ENV_VAR}`），并替换为实际环境变量的值。
+ * - 若环境变量不存在，则占位符会被替换为空字符串 `''`。
+ * - 若输入为 `null` 或 `undefined`，直接返回原值（不处理）。
+ *
+ * @param str - 待处理的字符串，可能包含环境变量占位符（如 `${API_URL}`）。支持 `null` 或 `undefined`。
+ * @returns 处理后的字符串。若输入为 `null` 或 `undefined`，返回原值；否则返回替换后的新字符串。
+ *
+ * @example
+ * // 环境变量未定义时，替换为 ''
+ * resolveEnvValue('${UNDEFINED_VAR}'); // => ''
+ *
+ * // 混合替换
+ * resolveEnvValue('Host: ${HOST}, Port: ${PORT}'); // => 'Host: 127.0.0.1, Port: 3000'（假设环境变量已定义）
+ *
+ * // 保留 null/undefined
+ * resolveEnvValue(null); // => null
+ */
+export default function resolveEnvValue(str) {
+    // 1. 处理 null 或 undefined 输入：直接返回原值
+    if (str == null) {
+        return str;
+    }
+    // 2. 使用正则表达式全局匹配所有 ${...} 占位符
+    //    - 正则说明: \${(.+?)}
+    //      - \${ 匹配字面量 `${`
+    //      - (.+?) 非贪婪匹配任意字符（环境变量名），直到遇到第一个 `}`
+    //      - /g 标志确保替换全部匹配项（而非仅第一个）
+    //    - 替换逻辑: 若 process.env[key] 不存在（undefined/null），则返回 ''
+    return str.replace(/\${(.+?)}/g, (_, key) => {
+        return process.env[key] ?? '';
+    });
+}

package/package.json

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