@nocobase/plugin-workflow-request 0.18.0-alpha.9 → 0.19.0-alpha.10

package/dist/externalVersion.js

@@ -1,8 +1,8 @@
 module.exports = {
   "@formily/antd-v5": "1.1.9",
-  "@nocobase/plugin-workflow": "0.18.0-alpha.9",
-  "@nocobase/client": "0.18.0-alpha.9",
+  "@nocobase/plugin-workflow": "0.19.0-alpha.10",
+  "@nocobase/client": "0.19.0-alpha.10",
   "react-i18next": "11.18.6",
-  "@nocobase/server": "0.18.0-alpha.9",
+  "@nocobase/server": "0.19.0-alpha.10",
   "axios": "0.26.1"
 };

package/dist/locale/ko_KR.json

@@ -0,0 +1,22 @@
+{
+  "HTTP request": "HTTP 요청",
+  "Send HTTP request to a URL. You can use the variables in the upstream nodes as request headers, parameters and request body.": 
+    "URL에 HTTP 요청을 보냅니다. 상류 노드의 변수를 요청 헤더, 매개변수 및 요청 본문으로 사용할 수 있습니다.",
+  "HTTP method": "HTTP 메서드",
+  "URL": "주소",
+  "Headers": "헤더",
+  "Add request header": "요청 헤더 추가",
+  "Parameters": "매개변수",
+  "Add parameter": "매개변수 추가",
+  "Body": "본문",
+  "Use variable": "변수 사용",
+  "Format": "형식",
+  "Insert": "삽입",
+  "Timeout config": "시간 초과 설정",
+  "ms": "밀리초",
+  "Input request data": "요청 데이터 입력",
+  "Only support standard JSON data": "표준 JSON 데이터만 지원합니다",
+  "\"Content-Type\" only support \"application/json\", and no need to specify": 
+    "\"Content-Type\" 헤더는 \"application/json\"만 지원하며 지정할 필요가 없습니다",
+  "Ignore failed request and continue workflow": "실패한 요청을 무시하고 워크플로를 계속합니다"
+}

package/dist/server/RequestInstruction.js

@@ -56,12 +56,29 @@ async function request(config) {
 }
 class RequestInstruction_default extends import_plugin_workflow.Instruction {
   async run(node, prevJob, processor) {
+    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);
+        return {
+          status: import_plugin_workflow.JOB_STATUS.RESOLVED,
+          result: response.data
+        };
+      } catch (error) {
+        return {
+          status: import_plugin_workflow.JOB_STATUS.FAILED,
+          result: error.isAxiosError ? error.toJSON() : error.message
+        };
+      }
+    }
     const job = await processor.saveJob({
       status: import_plugin_workflow.JOB_STATUS.PENDING,
       nodeId: node.id,
+      nodeKey: node.key,
       upstreamId: (prevJob == null ? void 0 : prevJob.id) ?? null
     });
-    const config = processor.getParsedValue(node.config, node.id);
     request(config).then((response) => {
       job.set({
         status: import_plugin_workflow.JOB_STATUS.RESOLVED,

package/package.json

@@ -4,9 +4,11 @@
   "displayName.zh-CN": "工作流：HTTP 请求节点",
   "description": "Send HTTP requests to any HTTP service for data interaction in workflow.",
   "description.zh-CN": "可用于在工作流中向任意 HTTP 服务发送请求，进行数据交互。",
-  "version": "0.18.0-alpha.9",
+  "version": "0.19.0-alpha.10",
   "license": "AGPL-3.0",
   "main": "./dist/server/index.js",
+  "homepage": "https://docs.nocobase.com/plugins/workflow-request",
+  "homepage.zh-CN": "https://docs-cn.nocobase.com/plugins/workflow-request",
   "devDependencies": {
     "antd": "5.x",
     "react": "18.x",
@@ -19,5 +21,8 @@
     "@nocobase/server": "0.x",
     "@nocobase/test": "0.x"
   },
-  "gitHead": "34ca0df4eede2e83fc86297b0fe19eba970e2b1b"
+  "gitHead": "d09d81eba67339da36bcec27939a85b35d180770",
+  "keywords": [
+    "Workflow"
+  ]
 }

package/src/locale/ko_KR.json

@@ -0,0 +1,22 @@
+{
+  "HTTP request": "HTTP 요청",
+  "Send HTTP request to a URL. You can use the variables in the upstream nodes as request headers, parameters and request body.": 
+    "URL에 HTTP 요청을 보냅니다. 상류 노드의 변수를 요청 헤더, 매개변수 및 요청 본문으로 사용할 수 있습니다.",
+  "HTTP method": "HTTP 메서드",
+  "URL": "주소",
+  "Headers": "헤더",
+  "Add request header": "요청 헤더 추가",
+  "Parameters": "매개변수",
+  "Add parameter": "매개변수 추가",
+  "Body": "본문",
+  "Use variable": "변수 사용",
+  "Format": "형식",
+  "Insert": "삽입",
+  "Timeout config": "시간 초과 설정",
+  "ms": "밀리초",
+  "Input request data": "요청 데이터 입력",
+  "Only support standard JSON data": "표준 JSON 데이터만 지원합니다",
+  "\"Content-Type\" only support \"application/json\", and no need to specify": 
+    "\"Content-Type\" 헤더는 \"application/json\"만 지원하며 지정할 필요가 없습니다",
+  "Ignore failed request and continue workflow": "실패한 요청을 무시하고 워크플로를 계속합니다"
+}

package/src/server/RequestInstruction.ts

@@ -41,14 +41,33 @@ async function request(config) {
 
 export default class extends Instruction {
   async run(node: FlowNodeModel, prevJob, processor: Processor) {
+    const config = processor.getParsedValue(node.config, node.id) as RequestConfig;
+
+    const { workflow } = processor.execution;
+    const sync = this.workflow.isWorkflowSync(workflow);
+
+    if (sync) {
+      try {
+        const response = await request(config);
+        return {
+          status: JOB_STATUS.RESOLVED,
+          result: response.data,
+        };
+      } catch (error) {
+        return {
+          status: JOB_STATUS.FAILED,
+          result: error.isAxiosError ? error.toJSON() : error.message,
+        };
+      }
+    }
+
     const job = await processor.saveJob({
       status: JOB_STATUS.PENDING,
       nodeId: node.id,
+      nodeKey: node.key,
       upstreamId: prevJob?.id ?? null,
     });
 
-    const config = processor.getParsedValue(node.config, node.id) as RequestConfig;
-
     // eslint-disable-next-line promise/catch-or-return
     request(config)
       .then((response) => {

package/src/server/__tests__/instruction.test.ts

@@ -1,41 +1,42 @@
+import { Server } from 'http';
 import jwt from 'jsonwebtoken';
+import Koa from 'koa';
+import bodyParser from 'koa-bodyparser';
 
-import { Gateway } from '@nocobase/server';
 import Database from '@nocobase/database';
 import { MockServer } from '@nocobase/test';
 
-import { EXECUTION_STATUS, JOB_STATUS } from '@nocobase/plugin-workflow';
+import PluginWorkflow, { Processor, EXECUTION_STATUS, JOB_STATUS } from '@nocobase/plugin-workflow';
 import { getApp, sleep } from '@nocobase/plugin-workflow-test';
 
-import Plugin from '..';
 import { RequestConfig } from '../RequestInstruction';
 
 const HOST = 'localhost';
-const PORT = 12345;
 
-const URL_DATA = `http://${HOST}:${PORT}/api/data`;
-const URL_400 = `http://${HOST}:${PORT}/api/400`;
-const URL_TIMEOUT = `http://${HOST}:${PORT}/api/timeout`;
-
-describe('workflow > instructions > request', () => {
-  let app: MockServer;
-  let db: Database;
-  let PostRepo;
-  let PostCollection;
-  let ReplyRepo;
-  let WorkflowModel;
-  let workflow;
-
-  beforeEach(async () => {
-    app = await getApp({
-      plugins: ['users', 'auth', Plugin],
-      resourcer: {
-        prefix: '/api',
-      },
-      autoStart: false,
-    });
-
-    app.use(async (ctx, next) => {
+function getRandomPort() {
+  const minPort = 1024;
+  const maxPort = 49151;
+  return Math.floor(Math.random() * (maxPort - minPort + 1)) + minPort;
+}
+
+class MockAPI {
+  app: Koa;
+  server: Server;
+  port: number;
+  get URL_DATA() {
+    return `http://${HOST}:${this.port}/api/data`;
+  }
+  get URL_400() {
+    return `http://${HOST}:${this.port}/api/400`;
+  }
+  get URL_TIMEOUT() {
+    return `http://${HOST}:${this.port}/api/timeout`;
+  }
+  constructor() {
+    this.app = new Koa();
+    this.app.use(bodyParser());
+
+    this.app.use(async (ctx, next) => {
       if (ctx.path === '/api/400') {
         return ctx.throw(400);
       }
@@ -46,7 +47,6 @@ describe('workflow > instructions > request', () => {
       }
       if (ctx.path === '/api/data') {
         await sleep(100);
-        ctx.withoutDataWrapping = true;
         ctx.body = {
           meta: { title: ctx.query.title },
           data: { title: ctx.request.body['title'] },
@@ -54,13 +54,45 @@ describe('workflow > instructions > request', () => {
       }
       await next();
     });
+  }
 
-    Gateway.getInstance().start({
-      port: PORT,
-      host: HOST,
+  async start() {
+    return new Promise((resolve) => {
+      this.server = this.app.listen(0, () => {
+        this.port = this.server.address()['port'];
+        resolve(true);
+      });
+    });
+  }
+
+  async close() {
+    return new Promise((resolve) => {
+      this.server.close(() => {
+        resolve(true);
+      });
     });
+  }
+}
+
+describe('workflow > instructions > request', () => {
+  let app: MockServer;
+  let db: Database;
+  let PostRepo;
+  let PostCollection;
+  let ReplyRepo;
+  let WorkflowModel;
+  let workflow;
+  let api: MockAPI;
 
-    await app.start();
+  beforeEach(async () => {
+    api = new MockAPI();
+    api.start();
+    app = await getApp({
+      resourcer: {
+        prefix: '/api',
+      },
+      plugins: ['users', 'auth', 'workflow-request'],
+    });
 
     db = app.db;
     WorkflowModel = db.getCollection('workflows').model;
@@ -78,14 +110,17 @@ describe('workflow > instructions > request', () => {
     });
   });
 
-  afterEach(() => app.destroy());
+  afterEach(async () => {
+    await api.close();
+    await app.destroy();
+  });
 
   describe('request static app routes', () => {
     it('get data', async () => {
       await workflow.createNode({
         type: 'request',
         config: {
-          url: URL_DATA,
+          url: api.URL_DATA,
           method: 'GET',
         } as RequestConfig,
       });
@@ -105,7 +140,7 @@ describe('workflow > instructions > request', () => {
       await workflow.createNode({
         type: 'request',
         config: {
-          url: URL_TIMEOUT,
+          url: api.URL_TIMEOUT,
           method: 'GET',
           timeout: 250,
         } as RequestConfig,
@@ -134,7 +169,7 @@ describe('workflow > instructions > request', () => {
       await workflow.createNode({
         type: 'request',
         config: {
-          url: URL_TIMEOUT,
+          url: api.URL_TIMEOUT,
           method: 'GET',
           timeout: 250,
           ignoreFail: true,
@@ -160,7 +195,7 @@ describe('workflow > instructions > request', () => {
       await workflow.createNode({
         type: 'request',
         config: {
-          url: URL_400,
+          url: api.URL_400,
           method: 'GET',
           ignoreFail: false,
         } as RequestConfig,
@@ -180,7 +215,7 @@ describe('workflow > instructions > request', () => {
       await workflow.createNode({
         type: 'request',
         config: {
-          url: URL_400,
+          url: api.URL_400,
           method: 'GET',
           timeout: 1000,
           ignoreFail: true,
@@ -201,7 +236,7 @@ describe('workflow > instructions > request', () => {
       const n1 = await workflow.createNode({
         type: 'request',
         config: {
-          url: URL_DATA,
+          url: api.URL_DATA,
           method: 'POST',
           data: { title: '{{$context.data.title}}' },
         } as RequestConfig,
@@ -222,7 +257,7 @@ describe('workflow > instructions > request', () => {
       const n1 = await workflow.createNode({
         type: 'request',
         config: {
-          url: URL_DATA,
+          url: api.URL_DATA,
           method: 'POST',
           data: { title: '{{$context.data.title}}' },
         } as RequestConfig,
@@ -254,7 +289,7 @@ describe('workflow > instructions > request', () => {
         upstreamId: n1.id,
         branchIndex: 0,
         config: {
-          url: URL_DATA,
+          url: api.URL_DATA,
           method: 'GET',
         },
       });
@@ -286,10 +321,14 @@ describe('workflow > instructions > request', () => {
         },
       );
 
+      const server = app.listen(12346, () => {});
+
+      await sleep(1000);
+
       const n1 = await workflow.createNode({
         type: 'request',
         config: {
-          url: `http://localhost:${PORT}/api/categories`,
+          url: `http://localhost:12346/api/categories`,
           method: 'POST',
           headers: [{ name: 'Authorization', value: `Bearer ${token}` }],
         } as RequestConfig,
@@ -306,6 +345,35 @@ describe('workflow > instructions > request', () => {
       const [job] = await execution.getJobs();
       expect(job.status).toBe(JOB_STATUS.RESOLVED);
       expect(job.result.data).toMatchObject({});
+
+      server.close();
+    });
+  });
+
+  describe('sync request', () => {
+    it('sync trigger', async () => {
+      const syncFlow = await WorkflowModel.create({
+        type: 'syncTrigger',
+        enabled: true,
+      });
+      await syncFlow.createNode({
+        type: 'request',
+        config: {
+          url: api.URL_DATA,
+          method: 'GET',
+        } as RequestConfig,
+      });
+
+      const workflowPlugin = app.pm.get(PluginWorkflow) as PluginWorkflow;
+      const processor = (await workflowPlugin.trigger(syncFlow, { data: { title: 't1' } })) as Processor;
+
+      const [execution] = await syncFlow.getExecutions();
+      expect(processor.execution.id).toEqual(execution.id);
+      expect(processor.execution.status).toEqual(execution.status);
+      expect(execution.status).toEqual(EXECUTION_STATUS.RESOLVED);
+      const [job] = await execution.getJobs();
+      expect(job.status).toEqual(JOB_STATUS.RESOLVED);
+      expect(job.result).toEqual({ meta: {}, data: {} });
     });
   });
 });