@nocobase/plugin-workflow-request 2.1.0-beta.8 → 2.2.0-alpha.1

package/dist/server/RequestInstruction.js

@@ -39,10 +39,14 @@ __export(RequestInstruction_exports, {
   default: () => RequestInstruction_default
 });
 module.exports = __toCommonJS(RequestInstruction_exports);
-var import_axios = __toESM(require("axios"));
+var import_joi = __toESM(require("joi"));
 var import_lodash = require("lodash");
 var import_plugin_workflow = require("@nocobase/plugin-workflow");
 var import_plugin_file_manager = __toESM(require("@nocobase/plugin-file-manager"));
+var import_utils = require("@nocobase/utils");
+function toRequestError(error) {
+  return error instanceof Error ? error : new Error(String(error));
+}
 function getContentTypeTransformer(mimeType, app) {
   switch (mimeType) {
     case "text/plain":
@@ -85,8 +89,30 @@ function getContentTypeTransformer(mimeType, app) {
       };
   }
 }
-async function request(config, app) {
+function createInvalidUrlError(cause) {
+  if (cause instanceof TypeError && typeof cause.code !== "undefined") {
+    return cause;
+  }
+  const error = new TypeError("Invalid URL");
+  error.code = "ERR_INVALID_URL";
+  return error;
+}
+function validateUrl(url) {
+  if (!url) {
+    throw createInvalidUrlError();
+  }
+  try {
+    const parsed = new URL(url);
+    if (parsed.protocol !== "http:" && parsed.protocol !== "https:") {
+      throw createInvalidUrlError();
+    }
+  } catch (error) {
+    throw createInvalidUrlError(error);
+  }
+}
+async function request(config, app, signal) {
   const { url, method = "POST", contentType = "application/json", data, timeout = 5e3 } = config;
+  validateUrl(url);
   const headers = (config.headers ?? []).reduce((result, header) => {
     const name = (0, import_lodash.trim)(header.name);
     if (name.toLowerCase() === "content-type") {
@@ -102,12 +128,13 @@ async function request(config, app) {
     headers["Content-Type"] = contentType;
   }
   const transformer = getContentTypeTransformer(contentType, app);
-  return import_axios.default.request({
+  return (0, import_utils.serverRequest)({
     url: (0, import_lodash.trim)(url),
     method,
     headers,
     params,
     timeout,
+    signal,
     ...method.toLowerCase() !== "get" && data != null ? {
       data: transformer ? await transformer(data) : data
     } : {}
@@ -118,46 +145,91 @@ function responseSuccess(response, onlyData = false) {
     status: response.status,
     statusText: response.statusText,
     headers: response.headers,
-    config: response.config,
     data: response.data
   };
 }
 function responseFailure(error) {
-  let result = {
-    message: error.message,
-    stack: error.stack
+  const result = {
+    message: error instanceof Error ? error.message : String(error)
   };
-  if (error.isAxiosError) {
-    if (error.response) {
-      Object.assign(result, {
-        status: error.response.status,
-        statusText: error.response.statusText,
-        headers: error.response.headers,
-        config: error.response.config,
-        data: error.response.data
-      });
-    } else if (error.request) {
-      result = error.toJSON();
-    }
+  if (typeof (error == null ? void 0 : error.code) !== "undefined") {
+    result["code"] = error.code;
+  }
+  if ((error == null ? void 0 : error.isAxiosError) && error.response) {
+    Object.assign(result, {
+      status: error.response.status,
+      statusText: error.response.statusText,
+      data: error.response.data
+    });
   }
   return result;
 }
+function failureStatus(config, error) {
+  if (config.ignoreFail) {
+    return import_plugin_workflow.JOB_STATUS.RESOLVED;
+  }
+  return (error == null ? void 0 : error.code) === "ECONNABORTED" ? import_plugin_workflow.JOB_STATUS.ABORTED : import_plugin_workflow.JOB_STATUS.FAILED;
+}
+const METHODS = ["GET", "POST", "PUT", "PATCH", "DELETE"];
+const CONTENT_TYPES = [
+  "application/json",
+  "application/x-www-form-urlencoded",
+  "multipart/form-data",
+  "application/xml",
+  "text/plain"
+];
+function logFailureDebug(logger, error) {
+  if (!(error == null ? void 0 : error.isAxiosError)) {
+    return;
+  }
+  if (error.response) {
+    logger.debug("request failed response details", {
+      status: error.response.status,
+      statusText: error.response.statusText,
+      data: error.response.data
+    });
+    return;
+  }
+  logger.debug("request failed error details", responseFailure(error));
+}
 class RequestInstruction_default extends import_plugin_workflow.Instruction {
-  async run(node, prevJob, processor) {
+  configSchema = import_joi.default.object({
+    url: import_joi.default.string(),
+    method: import_joi.default.string().valid(...METHODS),
+    contentType: import_joi.default.string().valid(...CONTENT_TYPES),
+    headers: import_joi.default.array().items(
+      import_joi.default.object({
+        name: import_joi.default.string(),
+        value: import_joi.default.string()
+      })
+    ),
+    params: import_joi.default.array().items(
+      import_joi.default.object({
+        name: import_joi.default.string(),
+        value: import_joi.default.string()
+      })
+    ),
+    data: import_joi.default.alternatives().try(import_joi.default.object(), import_joi.default.array(), import_joi.default.string()),
+    timeout: import_joi.default.number().integer().positive().default(5e3),
+    ignoreFail: import_joi.default.boolean().default(false),
+    onlyData: import_joi.default.boolean().default(false)
+  });
+  async run(node, prevJob, processor, options) {
     const config = processor.getParsedValue(node.config, node.id);
     const { workflow } = processor.execution;
     const sync = this.workflow.isWorkflowSync(workflow);
     if (sync) {
       try {
-        const response = await request(config, this.workflow.app);
+        const response = await request(config, this.workflow.app, options == null ? void 0 : options.signal);
         return {
           status: import_plugin_workflow.JOB_STATUS.RESOLVED,
           result: responseSuccess(response, config.onlyData)
         };
       } catch (error) {
+        logFailureDebug(this.workflow.app.logger, error);
         return {
-          status: config.ignoreFail ? import_plugin_workflow.JOB_STATUS.RESOLVED : import_plugin_workflow.JOB_STATUS.FAILED,
-          result: error.isAxiosError ? error.toJSON() : error.message
+          status: failureStatus(config, error),
+          result: responseFailure(error)
         };
       }
     }
@@ -168,34 +240,55 @@ class RequestInstruction_default extends import_plugin_workflow.Instruction {
       upstreamId: (prevJob == null ? void 0 : prevJob.id) ?? null
     });
     await processor.exit();
+    const abortHandle = processor.createBackgroundAbortHandle();
     const jobDone = { status: import_plugin_workflow.JOB_STATUS.PENDING };
-    try {
-      processor.logger.info(`request (#${node.id}) sent to "${config.url}", waiting for response...`);
-      const response = await request(config, this.workflow.app);
-      processor.logger.info(`request (#${node.id}) response success, status: ${response.status}`);
-      jobDone.status = import_plugin_workflow.JOB_STATUS.RESOLVED;
-      jobDone.result = responseSuccess(response, config.onlyData);
-    } catch (error) {
-      if (error.isAxiosError) {
-        if (error.response) {
-          processor.logger.info(`request (#${node.id}) failed with response, status: ${error.response.status}`);
-        } else if (error.request) {
-          processor.logger.error(`request (#${node.id}) failed without response: ${error.message}`);
+    const settleRequest = async () => {
+      try {
+        processor.logger.info(`request (#${node.id}) sent to "${config.url}", waiting for response...`);
+        const response = await request(config, this.workflow.app, abortHandle.signal);
+        processor.logger.info(`request (#${node.id}) response success, status: ${response.status}`);
+        jobDone.status = import_plugin_workflow.JOB_STATUS.RESOLVED;
+        jobDone.result = responseSuccess(response, config.onlyData);
+      } catch (caught) {
+        const error = toRequestError(caught);
+        if (error.isAxiosError) {
+          if (error.response) {
+            processor.logger.info(`request (#${node.id}) failed with response, status: ${error.response.status}`);
+          } else if (error.request) {
+            processor.logger.error(`request (#${node.id}) failed without response: ${error.message}`);
+          } else {
+            processor.logger.error(`request (#${node.id}) initiation failed: ${error.message}`);
+          }
+        } else {
+          processor.logger.error(`request (#${node.id}) failed unexpectedly: ${error.message}`);
+        }
+        logFailureDebug(processor.logger, error);
+        jobDone.status = abortHandle.signal.aborted ? import_plugin_workflow.JOB_STATUS.ABORTED : failureStatus(config, error);
+        jobDone.result = responseFailure(error);
+      } finally {
+        abortHandle.dispose();
+        const job = await this.workflow.app.db.getRepository("jobs").findOne({
+          filterByTk: id
+        });
+        const execution = await job.getExecution();
+        const aborted = await this.workflow.abortExecutionIfExpired(execution);
+        if (!aborted) {
+          await execution.reload();
+          await job.reload();
+        }
+        if (!aborted && execution.status === import_plugin_workflow.EXECUTION_STATUS.STARTED && job.status === import_plugin_workflow.JOB_STATUS.PENDING) {
+          job.set(jobDone);
+          job.execution = execution;
+          this.workflow.resume(job);
         } else {
-          processor.logger.error(`request (#${node.id}) initiation failed: ${error.message}`);
+          processor.logger.warn(`request (#${node.id}) result discarded because execution (${execution.id}) is ended`);
         }
-      } else {
-        processor.logger.error(`request (#${node.id}) failed unexpectedly: ${error.message}`);
       }
-      jobDone.status = config.ignoreFail ? import_plugin_workflow.JOB_STATUS.RESOLVED : import_plugin_workflow.JOB_STATUS.FAILED;
-      jobDone.result = responseFailure(error);
-    } finally {
-      const job = await this.workflow.app.db.getRepository("jobs").findOne({
-        filterByTk: id
-      });
-      job.set(jobDone);
-      this.workflow.resume(job);
-    }
+    };
+    settleRequest().catch((caught) => {
+      const error = toRequestError(caught);
+      processor.logger.error(`request (#${node.id}) async settling failed: ${error.message}`, { error });
+    });
   }
   async resume(node, job, processor) {
     const { ignoreFail } = node.config;
@@ -212,9 +305,10 @@ class RequestInstruction_default extends import_plugin_workflow.Instruction {
         result: responseSuccess(response, config.onlyData)
       };
     } catch (error) {
+      logFailureDebug(this.workflow.app.logger, error);
       return {
-        status: config.ignoreFail ? import_plugin_workflow.JOB_STATUS.RESOLVED : import_plugin_workflow.JOB_STATUS.FAILED,
-        result: error.isAxiosError ? error.toJSON() : error.message
+        status: failureStatus(config, error),
+        result: responseFailure(error)
       };
     }
   }

package/package.json

@@ -6,7 +6,7 @@
   "description": "Send HTTP requests to any HTTP service for data interaction in workflow.",
   "description.ru-RU": "Отправляет HTTP-запросы к любому HTTP-сервису для взаимодействия с данными в рабочем процессе.",
   "description.zh-CN": "可用于在工作流中向任意 HTTP 服务发送请求，进行数据交互。",
-  "version": "2.1.0-beta.8",
+  "version": "2.2.0-alpha.1",
   "license": "Apache-2.0",
   "main": "./dist/server/index.js",
   "homepage": "https://docs.nocobase.com/handbook/workflow-request",
@@ -15,6 +15,7 @@
   "devDependencies": {
     "antd": "5.x",
     "axios": "^1.7.0",
+    "joi": "^17.13.3",
     "react": "18.x",
     "react-i18next": "^11.15.1"
   },
@@ -26,7 +27,7 @@
     "@nocobase/server": "2.x",
     "@nocobase/test": "2.x"
   },
-  "gitHead": "5099d561c5467292414c1e77ad6bad3730d97344",
+  "gitHead": "303663aba6c6eefa27e6a6435b4c0352074ec40f",
   "keywords": [
     "Workflow"
   ]