@nocobase/plugin-workflow-request 0.17.0-alpha.4

package/src/client/RequestInstruction.tsx

@@ -0,0 +1,183 @@
+import { ArrayItems } from '@formily/antd-v5';
+
+import { defaultFieldNames } from '@nocobase/client';
+
+import { Instruction, WorkflowVariableInput, WorkflowVariableJSON } from '@nocobase/plugin-workflow/client';
+
+import { NAMESPACE } from '../locale';
+
+export default class extends Instruction {
+  title = `{{t("HTTP request", { ns: "${NAMESPACE}" })}}`;
+  type = 'request';
+  group = 'extended';
+  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: "${NAMESPACE}" })}}`;
+  fieldset = {
+    method: {
+      type: 'string',
+      required: true,
+      title: `{{t("HTTP method", { ns: "${NAMESPACE}" })}}`,
+      'x-decorator': 'FormItem',
+      'x-component': 'Select',
+      'x-component-props': {
+        showSearch: false,
+        allowClear: false,
+        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: true,
+      title: `{{t("URL", { ns: "${NAMESPACE}" })}}`,
+      '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: "${NAMESPACE}" })}}`,
+      description: `{{t('"Content-Type" only support "application/json", and no need to specify', { ns: "${NAMESPACE}" })}}`,
+      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: true,
+                },
+              },
+              remove: {
+                type: 'void',
+                'x-decorator': 'FormItem',
+                'x-component': 'ArrayItems.Remove',
+              },
+            },
+          },
+        },
+      },
+      properties: {
+        add: {
+          type: 'void',
+          title: `{{t("Add request header", { ns: "${NAMESPACE}" })}}`,
+          'x-component': 'ArrayItems.Addition',
+        },
+      },
+    },
+    params: {
+      type: 'array',
+      'x-component': 'ArrayItems',
+      'x-decorator': 'FormItem',
+      title: `{{t("Parameters", { ns: "${NAMESPACE}" })}}`,
+      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: true,
+                },
+              },
+              remove: {
+                type: 'void',
+                'x-decorator': 'FormItem',
+                'x-component': 'ArrayItems.Remove',
+              },
+            },
+          },
+        },
+      },
+      properties: {
+        add: {
+          type: 'void',
+          title: `{{t("Add parameter", { ns: "${NAMESPACE}" })}}`,
+          'x-component': 'ArrayItems.Addition',
+        },
+      },
+    },
+    data: {
+      type: 'string',
+      title: `{{t("Body", { ns: "${NAMESPACE}" })}}`,
+      'x-decorator': 'FormItem',
+      'x-decorator-props': {},
+      'x-component': 'WorkflowVariableJSON',
+      'x-component-props': {
+        changeOnSelect: true,
+        autoSize: {
+          minRows: 10,
+        },
+        placeholder: `{{t("Input request data", { ns: "${NAMESPACE}" })}}`,
+      },
+      description: `{{t("Only support standard JSON data", { ns: "${NAMESPACE}" })}}`,
+    },
+    timeout: {
+      type: 'number',
+      title: `{{t("Timeout config", { ns: "${NAMESPACE}" })}}`,
+      'x-decorator': 'FormItem',
+      'x-decorator-props': {},
+      'x-component': 'InputNumber',
+      'x-component-props': {
+        addonAfter: `{{t("ms", { ns: "${NAMESPACE}" })}}`,
+        min: 1,
+        step: 1000,
+        defaultValue: 5000,
+      },
+    },
+    ignoreFail: {
+      type: 'boolean',
+      title: `{{t("Ignore failed request and continue workflow", { ns: "${NAMESPACE}" })}}`,
+      'x-decorator': 'FormItem',
+      'x-component': 'Checkbox',
+    },
+  };
+  components = {
+    ArrayItems,
+    WorkflowVariableInput,
+    WorkflowVariableJSON,
+  };
+  useVariables({ key, title }, { types, fieldNames = defaultFieldNames }) {
+    return {
+      [fieldNames.value]: key,
+      [fieldNames.label]: title,
+    };
+  }
+}

package/src/client/index.ts

@@ -0,0 +1,19 @@
+import { Plugin } from '@nocobase/client';
+import WorkflowPlugin from '@nocobase/plugin-workflow/client';
+
+import RequestInstruction from './RequestInstruction';
+
+export default class extends Plugin {
+  async afterAdd() {
+    // await this.app.pm.add()
+  }
+
+  async beforeLoad() {}
+
+  // You can get and modify the app instance here
+  async load() {
+    const workflow = this.app.pm.get('workflow') as WorkflowPlugin;
+    const requestInstruction = new RequestInstruction();
+    workflow.instructions.register(requestInstruction.type, requestInstruction);
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './server';
+export { default } from './server';

package/src/locale/en-US.json

@@ -0,0 +1,20 @@
+{
+  "HTTP request": "HTTP request",
+  "Send HTTP request to a URL. You can use the variables in the upstream nodes as request headers, parameters and request body.": "Send HTTP request to a URL. You can use the variables in the upstream nodes as request headers, parameters and request body.",
+  "HTTP method": "HTTP method",
+  "URL": "URL",
+  "Headers": "Headers",
+  "Add request header": "Add request header",
+  "Parameters": "Parameters",
+  "Add parameter": "Add parameter",
+  "Body": "Body",
+  "Use variable": "Use variable",
+  "Format": "Format",
+  "Insert": "Insert",
+  "Timeout config": "Timeout config",
+  "ms": "ms",
+  "Input request data": "Input request data",
+  "Only support standard JSON data": "Only support standard JSON data",
+  "\"Content-Type\" only support \"application/json\", and no need to specify": "\"Content-Type\" only support \"application/json\", and no need to specify",
+  "Ignore failed request and continue workflow": "Ignore failed request and continue workflow"
+}

package/src/locale/es-ES.json

@@ -0,0 +1,19 @@
+{
+  "HTTP request": "Petición HTTP",
+  "HTTP method": "Método HTTP",
+  "URL": "URL",
+  "Headers": "Encabezados",
+  "Add request header": "Añadir encabezado de petición",
+  "Parameters": "Parámetros",
+  "Add parameter": "Añadir parámetro",
+  "Body": "Cuerpo",
+  "Use variable": "Utilizar variable",
+  "Format": "Formato",
+  "Insert": "Insertar",
+  "Timeout config": "Tiempo de espera config",
+  "ms": "ms",
+  "Input request data": "Datos de solicitud de entrada",
+  "Only support standard JSON data": "Sólo admite datos JSON estándar",
+  "\"Content-Type\" only support \"application/json\", and no need to specify": "\"Content-Type\" sólo admite \"application/json\", y no es necesario especificar",
+  "Ignore fail request and continue workflow": "Ignorar solicitud fallida y continuar flujo de trabajo"
+}

package/src/locale/fr-FR.json

@@ -0,0 +1,19 @@
+{
+  "HTTP request": "Requête HTTP",
+  "HTTP method": "Méthode HTTP",
+  "URL": "URL",
+  "Headers": "En-têtes",
+  "Add request header": "Ajouter un en-tête de requête",
+  "Parameters": "Paramètres",
+  "Add parameter": "Ajouter un paramètre",
+  "Body": "Corps",
+  "Use variable": "Utiliser une variable",
+  "Format": "Format",
+  "Insert": "Insérer",
+  "Timeout config": "Configuration du délai d'expiration",
+  "ms": "ms",
+  "Input request data": "Entrée des données de requête",
+  "Only support standard JSON data": "Prend uniquement en charge les données JSON standard",
+  "\"Content-Type\" only support \"application/json\", and no need to specify": "\"Content-Type\" prend uniquement en charge \"application/json\" et n'a pas besoin d'être spécifié",
+  "Ignore fail request and continue workflow": "Ignorer l'échec de la requête et continuer le workflow"
+}

package/src/locale/index.ts

@@ -0,0 +1,12 @@
+import { useTranslation } from 'react-i18next';
+
+export const NAMESPACE = 'workflow-request';
+
+export function useLang(key: string, options = {}) {
+  const { t } = usePluginTranslation(options);
+  return t(key);
+}
+
+export function usePluginTranslation(options) {
+  return useTranslation(NAMESPACE, options);
+}

package/src/locale/pt-BR.json

@@ -0,0 +1,19 @@
+{
+  "HTTP request": "Requisição HTTP",
+  "HTTP method": "Método HTTP",
+  "URL": "URL",
+  "Headers": "Cabeçalhos",
+  "Add request header": "Adicionar cabeçalho de requisição",
+  "Parameters": "Parâmetros",
+  "Add parameter": "Adicionar parâmetro",
+  "Body": "Corpo",
+  "Use variable": "Usar variável",
+  "Format": "Formato",
+  "Insert": "Inserir",
+  "Timeout config": "Configuração de tempo limite",
+  "ms": "ms",
+  "Input request data": "Dados de entrada da requisição",
+  "Only support standard JSON data": "Suporta somente dados JSON padrão",
+  "\"Content-Type\" only support \"application/json\", and no need to specify": "\"Content-Type\" somente suporta \"application/json\" e não precisa ser especificado",
+  "Ignore fail request and continue workflow": "Ignorar falhas na requisição e continuar o fluxo de trabalho"
+}

package/src/locale/zh-CN.json

@@ -0,0 +1,20 @@
+{
+  "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/Plugin.ts

@@ -0,0 +1,14 @@
+import { Plugin } from '@nocobase/server';
+import WorkflowPlugin from '@nocobase/plugin-workflow';
+
+import RequestInstruction from './RequestInstruction';
+
+export default class extends Plugin {
+  workflow: WorkflowPlugin;
+
+  async load() {
+    const workflowPlugin = this.app.getPlugin('workflow') as WorkflowPlugin;
+    this.workflow = workflowPlugin;
+    workflowPlugin.instructions.register('request', new RequestInstruction(workflowPlugin));
+  }
+}

package/src/server/RequestInstruction.ts

@@ -0,0 +1,83 @@
+import axios, { AxiosRequestConfig } from 'axios';
+
+import { Processor, Instruction, JOB_STATUS, FlowNodeModel } from '@nocobase/plugin-workflow';
+
+export interface Header {
+  name: string;
+  value: string;
+}
+
+export type RequestConfig = Pick<AxiosRequestConfig, 'url' | 'method' | 'params' | 'data' | 'timeout'> & {
+  headers: Array<Header>;
+  ignoreFail: boolean;
+};
+
+async function request(config) {
+  // default headers
+  const { url, method = 'POST', data, timeout = 5000 } = config;
+  const headers = (config.headers ?? []).reduce((result, header) => {
+    if (header.name.toLowerCase() === 'content-type') {
+      return result;
+    }
+    return Object.assign(result, { [header.name]: header.value });
+  }, {});
+  const params = (config.params ?? []).reduce(
+    (result, param) => Object.assign(result, { [param.name]: param.value }),
+    {},
+  );
+
+  // TODO(feat): only support JSON type for now, should support others in future
+  headers['Content-Type'] = 'application/json';
+
+  return axios.request({
+    url,
+    method,
+    headers,
+    params,
+    data,
+    timeout,
+  });
+}
+
+export default class extends Instruction {
+  async run(node: FlowNodeModel, prevJob, processor: Processor) {
+    const job = await processor.saveJob({
+      status: JOB_STATUS.PENDING,
+      nodeId: node.id,
+      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) => {
+        job.set({
+          status: JOB_STATUS.RESOLVED,
+          result: response.data,
+        });
+      })
+      .catch((error) => {
+        job.set({
+          status: JOB_STATUS.FAILED,
+          result: error.isAxiosError ? error.toJSON() : error.message,
+        });
+      })
+      .finally(() => {
+        processor.logger.info(`request (#${node.id}) response received, status: ${job.get('status')}`);
+        this.plugin.resume(job);
+      });
+
+    processor.logger.info(`request (#${node.id}) sent to "${config.url}", waiting for response...`);
+
+    return processor.exit();
+  }
+
+  async resume(node: FlowNodeModel, job, processor: Processor) {
+    const { ignoreFail } = node.config as RequestConfig;
+    if (ignoreFail) {
+      job.set('status', JOB_STATUS.RESOLVED);
+    }
+    return job;
+  }
+}