@nocobase/plugin-workflow-request 0.18.0-alpha.8 → 0.19.0-alpha.1

package/dist/client/RequestInstruction.d.ts

@@ -1,4 +1,4 @@
-import { Instruction, WorkflowVariableInput, WorkflowVariableJSON } from '@nocobase/plugin-workflow/client';
+import { Instruction, WorkflowVariableInput, WorkflowVariableJSON, WorkflowVariableTextArea } from '@nocobase/plugin-workflow/client';
 export default class extends Instruction {
     title: string;
     type: string;
@@ -166,6 +166,7 @@ export default class extends Instruction {
             }>;
         };
         WorkflowVariableInput: typeof WorkflowVariableInput;
+        WorkflowVariableTextArea: typeof WorkflowVariableTextArea;
         WorkflowVariableJSON: typeof WorkflowVariableJSON;
     };
     useVariables({ key, title }: {

package/dist/client/index.js

@@ -1 +1 @@
-(function(t,o){typeof exports=="object"&&typeof module!="undefined"?o(exports,require("@nocobase/client"),require("@formily/antd-v5"),require("@nocobase/plugin-workflow/client"),require("react-i18next")):typeof define=="function"&&define.amd?define(["exports","@nocobase/client","@formily/antd-v5","@nocobase/plugin-workflow/client","react-i18next"],o):(t=typeof globalThis!="undefined"?globalThis:t||self,o(t["@nocobase/plugin-workflow-request"]={},t["@nocobase/client"],t["@formily/antd-v5"],t["@nocobase/plugin-workflow"]))})(this,function(t,o,r,s){"use strict";var x=Object.defineProperty;var y=(t,o,r)=>o in t?x(t,o,{enumerable:!0,configurable:!0,writable:!0,value:r}):t[o]=r;var a=(t,o,r)=>(y(t,typeof o!="symbol"?o+"":o,r),r);var l=(t,o,r)=>new Promise((s,e)=>{var d=n=>{try{p(r.next(n))}catch(i){e(i)}},m=n=>{try{p(r.throw(n))}catch(i){e(i)}},p=n=>n.done?s(n.value):Promise.resolve(n.value).then(d,m);p((r=r.apply(t,o)).next())});const e="workflow-request";class d extends s.Instruction{constructor(){super(...arguments);a(this,"title",`{{t("HTTP request", { ns: "${e}" })}}`);a(this,"type","request");a(this,"group","extended");a(this,"description",`{{t("Send HTTP request to a URL. You can use the variables in the upstream nodes as request headers, parameters and request body.", { ns: "${e}" })}}`);a(this,"fieldset",{method:{type:"string",required:!0,title:`{{t("HTTP method", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-component":"Select","x-component-props":{showSearch:!1,allowClear:!1,className:"auto-width"},enum:[{label:"GET",value:"GET"},{label:"POST",value:"POST"},{label:"PUT",value:"PUT"},{label:"PATCH",value:"PATCH"},{label:"DELETE",value:"DELETE"}],default:"POST"},url:{type:"string",required:!0,title:`{{t("URL", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-decorator-props":{},"x-component":"Input","x-component-props":{placeholder:"https://www.nocobase.com"}},headers:{type:"array","x-component":"ArrayItems","x-decorator":"FormItem",title:`{{t("Headers", { ns: "${e}" })}}`,description:`{{t('"Content-Type" only support "application/json", and no need to specify', { ns: "${e}" })}}`,items:{type:"object",properties:{space:{type:"void","x-component":"Space",properties:{name:{type:"string","x-decorator":"FormItem","x-component":"Input","x-component-props":{placeholder:'{{t("Name")}}'}},value:{type:"string","x-decorator":"FormItem","x-component":"WorkflowVariableInput","x-component-props":{useTypedConstant:!0}},remove:{type:"void","x-decorator":"FormItem","x-component":"ArrayItems.Remove"}}}}},properties:{add:{type:"void",title:`{{t("Add request header", { ns: "${e}" })}}`,"x-component":"ArrayItems.Addition"}}},params:{type:"array","x-component":"ArrayItems","x-decorator":"FormItem",title:`{{t("Parameters", { ns: "${e}" })}}`,items:{type:"object",properties:{space:{type:"void","x-component":"Space",properties:{name:{type:"string","x-decorator":"FormItem","x-component":"Input","x-component-props":{placeholder:'{{t("Name")}}'}},value:{type:"string","x-decorator":"FormItem","x-component":"WorkflowVariableInput","x-component-props":{useTypedConstant:!0}},remove:{type:"void","x-decorator":"FormItem","x-component":"ArrayItems.Remove"}}}}},properties:{add:{type:"void",title:`{{t("Add parameter", { ns: "${e}" })}}`,"x-component":"ArrayItems.Addition"}}},data:{type:"string",title:`{{t("Body", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-decorator-props":{},"x-component":"WorkflowVariableJSON","x-component-props":{changeOnSelect:!0,autoSize:{minRows:10},placeholder:`{{t("Input request data", { ns: "${e}" })}}`},description:`{{t("Only support standard JSON data", { ns: "${e}" })}}`},timeout:{type:"number",title:`{{t("Timeout config", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-decorator-props":{},"x-component":"InputNumber","x-component-props":{addonAfter:`{{t("ms", { ns: "${e}" })}}`,min:1,step:1e3,defaultValue:5e3}},ignoreFail:{type:"boolean",title:`{{t("Ignore failed request and continue workflow", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-component":"Checkbox"}});a(this,"components",{ArrayItems:r.ArrayItems,WorkflowVariableInput:s.WorkflowVariableInput,WorkflowVariableJSON:s.WorkflowVariableJSON})}useVariables({key:i,title:u},{types:f,fieldNames:c=s.defaultFieldNames}){return{[c.value]:i,[c.label]:u}}}class m extends o.Plugin{afterAdd(){return l(this,null,function*(){})}beforeLoad(){return l(this,null,function*(){})}load(){return l(this,null,function*(){this.app.pm.get("workflow").registerInstruction("request",d)})}}t.default=m,Object.defineProperties(t,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});
+(function(t,o){typeof exports=="object"&&typeof module!="undefined"?o(exports,require("@nocobase/client"),require("@formily/antd-v5"),require("@nocobase/plugin-workflow/client"),require("react-i18next")):typeof define=="function"&&define.amd?define(["exports","@nocobase/client","@formily/antd-v5","@nocobase/plugin-workflow/client","react-i18next"],o):(t=typeof globalThis!="undefined"?globalThis:t||self,o(t["@nocobase/plugin-workflow-request"]={},t["@nocobase/client"],t["@formily/antd-v5"],t["@nocobase/plugin-workflow"]))})(this,function(t,o,r,a){"use strict";var x=Object.defineProperty;var y=(t,o,r)=>o in t?x(t,o,{enumerable:!0,configurable:!0,writable:!0,value:r}):t[o]=r;var s=(t,o,r)=>(y(t,typeof o!="symbol"?o+"":o,r),r);var l=(t,o,r)=>new Promise((a,e)=>{var d=n=>{try{p(r.next(n))}catch(i){e(i)}},m=n=>{try{p(r.throw(n))}catch(i){e(i)}},p=n=>n.done?a(n.value):Promise.resolve(n.value).then(d,m);p((r=r.apply(t,o)).next())});const e="workflow-request";class d extends a.Instruction{constructor(){super(...arguments);s(this,"title",`{{t("HTTP request", { ns: "${e}" })}}`);s(this,"type","request");s(this,"group","extended");s(this,"description",`{{t("Send HTTP request to a URL. You can use the variables in the upstream nodes as request headers, parameters and request body.", { ns: "${e}" })}}`);s(this,"fieldset",{method:{type:"string",required:!0,title:`{{t("HTTP method", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-component":"Select","x-component-props":{showSearch:!1,allowClear:!1,className:"auto-width"},enum:[{label:"GET",value:"GET"},{label:"POST",value:"POST"},{label:"PUT",value:"PUT"},{label:"PATCH",value:"PATCH"},{label:"DELETE",value:"DELETE"}],default:"POST"},url:{type:"string",required:!0,title:`{{t("URL", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-decorator-props":{},"x-component":"WorkflowVariableTextArea","x-component-props":{placeholder:"https://www.nocobase.com"}},headers:{type:"array","x-component":"ArrayItems","x-decorator":"FormItem",title:`{{t("Headers", { ns: "${e}" })}}`,description:`{{t('"Content-Type" only support "application/json", and no need to specify', { ns: "${e}" })}}`,items:{type:"object",properties:{space:{type:"void","x-component":"Space",properties:{name:{type:"string","x-decorator":"FormItem","x-component":"Input","x-component-props":{placeholder:'{{t("Name")}}'}},value:{type:"string","x-decorator":"FormItem","x-component":"WorkflowVariableInput","x-component-props":{useTypedConstant:!0}},remove:{type:"void","x-decorator":"FormItem","x-component":"ArrayItems.Remove"}}}}},properties:{add:{type:"void",title:`{{t("Add request header", { ns: "${e}" })}}`,"x-component":"ArrayItems.Addition"}}},params:{type:"array","x-component":"ArrayItems","x-decorator":"FormItem",title:`{{t("Parameters", { ns: "${e}" })}}`,items:{type:"object",properties:{space:{type:"void","x-component":"Space",properties:{name:{type:"string","x-decorator":"FormItem","x-component":"Input","x-component-props":{placeholder:'{{t("Name")}}'}},value:{type:"string","x-decorator":"FormItem","x-component":"WorkflowVariableInput","x-component-props":{useTypedConstant:!0}},remove:{type:"void","x-decorator":"FormItem","x-component":"ArrayItems.Remove"}}}}},properties:{add:{type:"void",title:`{{t("Add parameter", { ns: "${e}" })}}`,"x-component":"ArrayItems.Addition"}}},data:{type:"string",title:`{{t("Body", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-decorator-props":{},"x-component":"WorkflowVariableJSON","x-component-props":{changeOnSelect:!0,autoSize:{minRows:10},placeholder:`{{t("Input request data", { ns: "${e}" })}}`},description:`{{t("Only support standard JSON data", { ns: "${e}" })}}`},timeout:{type:"number",title:`{{t("Timeout config", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-decorator-props":{},"x-component":"InputNumber","x-component-props":{addonAfter:`{{t("ms", { ns: "${e}" })}}`,min:1,step:1e3,defaultValue:5e3}},ignoreFail:{type:"boolean",title:`{{t("Ignore failed request and continue workflow", { ns: "${e}" })}}`,"x-decorator":"FormItem","x-component":"Checkbox"}});s(this,"components",{ArrayItems:r.ArrayItems,WorkflowVariableInput:a.WorkflowVariableInput,WorkflowVariableTextArea:a.WorkflowVariableTextArea,WorkflowVariableJSON:a.WorkflowVariableJSON})}useVariables({key:i,title:u},{types:f,fieldNames:c=a.defaultFieldNames}){return{[c.value]:i,[c.label]:u}}}class m extends o.Plugin{afterAdd(){return l(this,null,function*(){})}beforeLoad(){return l(this,null,function*(){})}load(){return l(this,null,function*(){this.app.pm.get("workflow").registerInstruction("request",d)})}}t.default=m,Object.defineProperties(t,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/dist/externalVersion.js

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

package/package.json

@@ -4,7 +4,7 @@
   "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.8",
+  "version": "0.19.0-alpha.1",
   "license": "AGPL-3.0",
   "main": "./dist/server/index.js",
   "devDependencies": {
@@ -19,5 +19,5 @@
     "@nocobase/server": "0.x",
     "@nocobase/test": "0.x"
   },
-  "gitHead": "727d42f6f14e5f863831da3dbf3255ba1165b567"
+  "gitHead": "64601944412fc4d2e2bd05f4b982118dd28247dc"
 }

package/src/client/RequestInstruction.tsx

@@ -4,6 +4,7 @@ import {
   Instruction,
   WorkflowVariableInput,
   WorkflowVariableJSON,
+  WorkflowVariableTextArea,
   defaultFieldNames,
 } from '@nocobase/plugin-workflow/client';
 
@@ -41,7 +42,7 @@ export default class extends Instruction {
       title: `{{t("URL", { ns: "${NAMESPACE}" })}}`,
       'x-decorator': 'FormItem',
       'x-decorator-props': {},
-      'x-component': 'Input',
+      'x-component': 'WorkflowVariableTextArea',
       'x-component-props': {
         placeholder: 'https://www.nocobase.com',
       },
@@ -175,6 +176,7 @@ export default class extends Instruction {
   components = {
     ArrayItems,
     WorkflowVariableInput,
+    WorkflowVariableTextArea,
     WorkflowVariableJSON,
   };
   useVariables({ key, title }, { types, fieldNames = defaultFieldNames }) {

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 { 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);
+      });
     });
+  }
 
-    await app.start();
+  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;
+
+  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,8 @@ describe('workflow > instructions > request', () => {
       const [job] = await execution.getJobs();
       expect(job.status).toBe(JOB_STATUS.RESOLVED);
       expect(job.result.data).toMatchObject({});
+
+      server.close();
     });
   });
 });