@nocobase/cli-v1 2.4.0-alpha.8 → 2.4.0-alpha.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli-v1",
-  "version": "2.4.0-alpha.8",
+  "version": "2.4.0-alpha.9",
   "description": "",
   "license": "Apache-2.0",
   "main": "./src/index.js",
@@ -9,9 +9,9 @@
     "nocobase-v1": "./bin/index.js"
   },
   "dependencies": {
-    "@nocobase/cli": "2.4.0-alpha.8",
+    "@nocobase/cli": "2.4.0-alpha.9",
     "@nocobase/license-kit": "^0.3.8",
-    "@nocobase/utils": "2.4.0-alpha.8",
+    "@nocobase/utils": "2.4.0-alpha.9",
     "chalk": "^4.1.1",
     "commander": "^9.2.0",
     "deepmerge": "^4.3.1",
@@ -20,7 +20,7 @@
     "fast-glob": "^3.3.1",
     "fs-extra": "^11.1.1",
     "p-all": "3.0.0",
-    "pm2": "^6.0.5",
+    "pm2": "^7.0.0",
     "portfinder": "^1.0.28",
     "tar": "^7.4.3",
     "tree-kill": "^1.2.2"
@@ -33,5 +33,5 @@
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/core/cli"
   },
-  "gitHead": "e8ec2bff07f4b405e08f984c9e92b44491bde462"
+  "gitHead": "d383bdb224c62d1ba21c3dffd682165f3385a11b"
 }

package/src/__tests__/client-upload.test.js

@@ -0,0 +1,60 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+/* eslint-env jest */
+/* global vi */
+
+const { putWithRetry, OSS_TIMEOUT, OSS_MAX_ATTEMPTS } = require('../commands/client')._test;
+
+describe('cli-v1 client:upload', () => {
+  let warn;
+
+  beforeEach(() => {
+    warn = vi.spyOn(console, 'warn').mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    warn.mockRestore();
+  });
+
+  it('should raise the ali-oss response timeout above its 60s default', () => {
+    expect(OSS_TIMEOUT).toBeGreaterThan(60000);
+  });
+
+  it('should return the result without retrying when the upload succeeds', async () => {
+    const put = vi.fn().mockResolvedValue({ name: 'a.js' });
+
+    await expect(putWithRetry({ put }, 'a.js', '/tmp/a.js')).resolves.toEqual({ name: 'a.js' });
+
+    expect(put).toHaveBeenCalledTimes(1);
+    expect(put).toHaveBeenCalledWith('a.js', '/tmp/a.js');
+    expect(warn).not.toHaveBeenCalled();
+  });
+
+  it('should retry a transient timeout and resolve', async () => {
+    const put = vi
+      .fn()
+      .mockRejectedValueOnce(new Error('Response timeout for 60000ms'))
+      .mockResolvedValue({ name: 'a.js' });
+
+    await expect(putWithRetry({ put }, 'a.js', '/tmp/a.js')).resolves.toEqual({ name: 'a.js' });
+
+    expect(put).toHaveBeenCalledTimes(2);
+    expect(warn).toHaveBeenCalledTimes(1);
+  });
+
+  it('should give up and rethrow after the attempt limit', async () => {
+    const error = new Error('Response timeout for 60000ms');
+    const put = vi.fn().mockRejectedValue(error);
+
+    await expect(putWithRetry({ put }, 'a.js', '/tmp/a.js')).rejects.toThrow(error);
+
+    expect(put).toHaveBeenCalledTimes(OSS_MAX_ATTEMPTS);
+  });
+});

package/src/commands/client.js

@@ -156,6 +156,31 @@ async function writeActiveVersion(version) {
   return activeVersionFile;
 }
 
+// 客户端资源里有体积较大的 bundle，ali-oss 默认的 60s 响应超时在 CI 上不够用。
+const OSS_TIMEOUT = 300000;
+// 单个文件偶发超时不应该让整次上传前功尽弃，做有限重试。
+const OSS_MAX_ATTEMPTS = 3;
+
+/**
+ * 上传单个文件，对偶发失败重试
+ * @param {Client} client - OSS 客户端实例
+ * @param {string} ossKey - OSS 对象名
+ * @param {string} filePath - 本地文件路径
+ */
+async function putWithRetry(client, ossKey, filePath) {
+  for (let attempt = 1; ; attempt++) {
+    try {
+      return await client.put(ossKey, filePath);
+    } catch (error) {
+      if (attempt >= OSS_MAX_ATTEMPTS) {
+        throw error;
+      }
+      console.warn(chalk.yellow(`Retrying ${ossKey} (${attempt}/${OSS_MAX_ATTEMPTS - 1}): ${error.message}`));
+      await new Promise((_resolve) => setTimeout(_resolve, attempt * 2000));
+    }
+  }
+}
+
 /**
  * 递归上传目录到 OSS
  * @param {Client} client - OSS 客户端实例
@@ -189,7 +214,7 @@ async function uploadDirectoryToOSS(client, localDir, ossPrefix = '') {
       // 上传文件
       const ossKey = ossPrefix ? `${ossPrefix}/${file}` : file;
       try {
-        await client.put(ossKey, filePath);
+        await putWithRetry(client, ossKey, filePath);
         // console.log(chalk.green(`Uploaded: ${ossKey}`));
         uploadedCount++;
       } catch (error) {
@@ -273,6 +298,7 @@ module.exports = (cli) => {
         accessKeySecret: process.env.CDN_ALI_OSS_ACCESS_KEY_SECRET,
         bucket: process.env.CDN_ALI_OSS_BUCKET,
         region: process.env.CDN_ALI_OSS_REGION,
+        timeout: OSS_TIMEOUT,
       });
 
       if (!(await fs.exists(target))) {
@@ -294,3 +320,9 @@ module.exports = (cli) => {
 };
 
 module.exports.renderExtractedClientIndexHtml = renderExtractedClientIndexHtml;
+
+module.exports._test = {
+  putWithRetry,
+  OSS_TIMEOUT,
+  OSS_MAX_ATTEMPTS,
+};