retry-async-wrapper 1.0.0

package/.idea/jsLibraryMappings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptLibraryMappings">
+    <includedPredefinedLibrary name="Node.js Core" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/veepai_retry.iml" filepath="$PROJECT_DIR$/.idea/veepai_retry.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/retry-async-wrapper.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -0,0 +1,61 @@
+# retry-async-wrapper
+
+一个基于 `retry` 库的 Promise 重试工具，支持单次任务执行超时控制和自定义重试策略。
+
+## 安装
+
+```bash
+npm install retry-async-wrapper
+```
+
+## 使用示例
+
+```javascript
+const retryPromise = require('retry-async-wrapper');
+
+// 定义一个可能失败的任务
+const task = (attempt) => {
+    console.log(`第 ${attempt} 次尝试`);
+    return new Promise((resolve, reject) => {
+        if (Math.random() > 0.3) {
+            reject(new Error('任务失败'));
+        } else {
+            resolve('任务成功');
+        }
+    });
+};
+
+// 使用默认配置重试任务
+retryPromise(task)
+    .then(result => console.log('成功:', result))
+    .catch(error => console.error('最终失败:', error));
+```
+
+## 配置选项
+
+可以通过 `options` 参数自定义重试行为，支持的配置如下：
+
+| 属性        | 类型      | 默认值       | 描述                                                                 |
+|-------------|-----------|--------------|----------------------------------------------------------------------|
+| `retries`   | `number`  | `10`         | 最大重试次数                                                         |
+| `factor`    | `number`  | `2`          | 重试间隔时间的指数因子                                               |
+| `minTimeout`| `number`  | `1000`       | 最小重试间隔时间（毫秒）                                             |
+| `maxTimeout`| `number`  | `Infinity`   | 最大重试间隔时间（毫秒）                                             |
+| `randomize` | `boolean` | `false`      | 是否随机化重试间隔时间                                               |
+| `timeout`   | `number`  | `5000`       | 单次任务的超时时间（毫秒）                                           |
+
+## 坑点
+
+1. **超时控制**：如果任务本身没有超时机制，建议设置 `timeout` 参数，否则任务可能会无限期挂起。
+2. **重试次数**：默认重试次数为 10 次，如果任务失败率较高，可能需要调整 `retries` 参数。
+3. **随机化间隔**：启用 `randomize` 可以避免重试风暴，但可能会导致重试间隔不可预测。
+4. **错误处理**：任务失败时，确保错误信息足够清晰，以便调试。
+5. **性能影响**：频繁的重试可能会对性能产生影响，尤其是在高并发场景下。
+
+## 贡献
+
+欢迎提交 Issue 或 Pull Request！
+
+## 许可证
+
+MIT

package/index.js

@@ -0,0 +1,51 @@
+const retry = require('retry');
+
+/**
+ * 默认重试配置选项
+ * @property {number} retries - 最大重试次数，默认为10
+ * @property {number} factor - 重试间隔时间的指数因子，默认为2
+ * @property {number} minTimeout - 最小重试间隔时间（毫秒），默认为1000
+ * @property {number} maxTimeout - 最大重试间隔时间（毫秒），默认为Infinity
+ * @property {boolean} randomize - 是否随机化重试间隔时间，默认为false
+ * @property {number} timeout - 单次任务的超时时间（毫秒），默认为5000
+ */
+const DEFAULT_OPTIONS = {
+    retries: 10,
+    factor: 2,
+    minTimeout: 1000,
+    maxTimeout: Infinity,
+    randomize: false,
+    timeout: 5000
+};
+
+function withTimeout(promise, ms) {
+    return new Promise((resolve, reject) => {
+        const timer = setTimeout(() => reject(new Error('retry timeout')), ms);
+        promise.then(
+            val => { clearTimeout(timer); resolve(val); },
+            err => { clearTimeout(timer); reject(err); }
+        );
+    });
+}
+
+function retryPromise(fn, options = {}) {
+    const opts = { ...DEFAULT_OPTIONS, ...options };
+
+    return new Promise((resolve, reject) => {
+        const operation = retry.operation(opts);
+
+        operation.attempt((currentAttempt) => {
+            const exec = Promise.resolve(fn(currentAttempt));
+
+            withTimeout(exec, opts.timeout)
+                .then(resolve)
+                .catch(err => {
+                    if (!operation.retry(err)) {
+                        return reject(operation.mainError());
+                    }
+                });
+        });
+    });
+}
+
+module.exports = retryPromise;

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "retry-async-wrapper",
+  "version": "1.0.0",
+  "description": "基于 retry 二次封装的重试包，保留了 retry 的所有功能，简化了使用方式",
+  "main": "index.js",
+  "private": false,
+  "dependencies": {
+    "retry": "^0.13.1"
+  }
+}