@nocobase/plugin-workflow-sql 1.0.0-alpha.2 → 1.0.0-alpha.4

package/src/client/index.ts

@@ -1,18 +0,0 @@
-import { Plugin } from '@nocobase/client';
-import WorkflowPlugin from '@nocobase/plugin-workflow/client';
-
-import SQLInstruction from './SQLInstruction';
-
-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;
-    workflow.registerInstruction('sql', SQLInstruction);
-  }
-}

package/src/index.ts

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

package/src/locale/en-US.json

@@ -1,5 +0,0 @@
-{
-  "SQL action": "SQL action",
-  "Execute a SQL statement in database": "Execute a SQL statement in database",
-  "Usage of SQL query result is not supported yet.": "Usage of SQL query result is not supported yet."
-}

package/src/locale/index.ts

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

package/src/locale/ko_KR.json

@@ -1,5 +0,0 @@
-{
-  "SQL action": "SQL 작업",
-  "Execute a SQL statement in database": "데이터베이스에서 SQL 문을 실행합니다",
-  "Usage of SQL query result is not supported yet.": "아직 SQL 쿼리 결과의 사용은 지원되지 않습니다."
-}

package/src/locale/zh-CN.json

@@ -1,6 +0,0 @@
-{
-  "SQL action": "SQL 操作",
-  "Execute a SQL statement in database.": "在数据库中执行一个 SQL 语句",
-  "Select a data source to execute SQL.": "选择一个数据源来执行 SQL",
-  "SQL query result could be used through <1>JSON query node</1> (Commercial plugin).": "SQL 执行的结果可在 <1>JSON 解析节点</1> 中使用（商业插件）。"
-}

package/src/server/Plugin.ts

@@ -1,11 +0,0 @@
-import { Plugin } from '@nocobase/server';
-import WorkflowPlugin from '@nocobase/plugin-workflow';
-
-import SQLInstruction from './SQLInstruction';
-
-export default class extends Plugin {
-  async load() {
-    const workflowPlugin = this.app.getPlugin<WorkflowPlugin>(WorkflowPlugin);
-    workflowPlugin.registerInstruction('sql', SQLInstruction);
-  }
-}

package/src/server/SQLInstruction.ts

@@ -1,31 +0,0 @@
-import { Processor, Instruction, JOB_STATUS, FlowNodeModel } from '@nocobase/plugin-workflow';
-
-export default class extends Instruction {
-  async run(node: FlowNodeModel, input, processor: Processor) {
-    // @ts-ignore
-    const { db } = this.workflow.app.dataSourceManager.dataSources.get(
-      node.config.dataSource || 'main',
-    ).collectionManager;
-    if (!db) {
-      throw new Error(`type of data source "${node.config.dataSource}" is not database`);
-    }
-    const sql = processor.getParsedValue(node.config.sql || '', node.id).trim();
-    if (!sql) {
-      return {
-        status: JOB_STATUS.RESOLVED,
-      };
-    }
-
-    // @ts-ignore
-    const result = await db.sequelize.query(sql, {
-      transaction: processor.transaction,
-      // plain: true,
-      // model: db.getCollection(node.config.collection).model
-    });
-
-    return {
-      result,
-      status: JOB_STATUS.RESOLVED,
-    };
-  }
-}

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

@@ -1,249 +0,0 @@
-import Database, { fn } from '@nocobase/database';
-import { Application } from '@nocobase/server';
-import { EXECUTION_STATUS, JOB_STATUS } from '@nocobase/plugin-workflow';
-import { getApp, sleep } from '@nocobase/plugin-workflow-test';
-
-import Plugin from '..';
-
-describe('workflow > instructions > sql', () => {
-  let app: Application;
-  let db: Database;
-  let PostRepo;
-  let PostCollection;
-  let ReplyRepo;
-  let WorkflowModel;
-  let workflow;
-
-  beforeEach(async () => {
-    app = await getApp({
-      plugins: [Plugin],
-    });
-
-    db = app.db;
-    WorkflowModel = db.getCollection('workflows').model;
-    PostCollection = db.getCollection('posts');
-    PostRepo = PostCollection.repository;
-    ReplyRepo = db.getCollection('replies').repository;
-
-    workflow = await WorkflowModel.create({
-      enabled: true,
-      type: 'collection',
-      config: {
-        mode: 1,
-        collection: 'posts',
-      },
-    });
-  });
-
-  afterEach(() => app.destroy());
-
-  describe('invalid', () => {
-    it('no sql', async () => {
-      const n1 = await workflow.createNode({
-        type: 'sql',
-        config: {},
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const [execution] = await workflow.getExecutions();
-      const [sqlJob] = await execution.getJobs({ order: [['id', 'ASC']] });
-      expect(execution.status).toBe(EXECUTION_STATUS.RESOLVED);
-      expect(sqlJob.status).toBe(JOB_STATUS.RESOLVED);
-    });
-
-    it('empty sql', async () => {
-      const n1 = await workflow.createNode({
-        type: 'sql',
-        config: {
-          sql: '',
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const [execution] = await workflow.getExecutions();
-      const [sqlJob] = await execution.getJobs({ order: [['id', 'ASC']] });
-      expect(execution.status).toBe(EXECUTION_STATUS.RESOLVED);
-      expect(sqlJob.status).toBe(JOB_STATUS.RESOLVED);
-    });
-
-    it('invalid sql', async () => {
-      const n1 = await workflow.createNode({
-        type: 'sql',
-        config: {
-          sql: '1',
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const [execution] = await workflow.getExecutions();
-      const [sqlJob] = await execution.getJobs({ order: [['id', 'ASC']] });
-      expect(execution.status).toBe(EXECUTION_STATUS.ERROR);
-      expect(sqlJob.status).toBe(JOB_STATUS.ERROR);
-    });
-  });
-
-  describe('sql with variables', () => {
-    it('$system.now', async () => {
-      const queryInterface = db.sequelize.getQueryInterface();
-      const n1 = await workflow.createNode({
-        type: 'sql',
-        config: {
-          sql: `select '{{$system.now}}' as a`,
-        },
-      });
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const [execution] = await workflow.getExecutions();
-      const [sqlJob] = await execution.getJobs({ order: [['id', 'ASC']] });
-      expect(sqlJob.status).toBe(JOB_STATUS.RESOLVED);
-      // expect(queryJob.status).toBe(JOB_STATUS.RESOLVED);
-      // expect(queryJob.result.read).toBe(post.id);
-    });
-
-    it('update', async () => {
-      const queryInterface = db.sequelize.getQueryInterface();
-      const n1 = await workflow.createNode({
-        type: 'sql',
-        config: {
-          sql: `update ${PostCollection.quotedTableName()} set ${queryInterface.quoteIdentifier(
-            'read',
-          )}={{$context.data.id}} where ${queryInterface.quoteIdentifier('id')}={{$context.data.id}}`,
-        },
-      });
-
-      const n2 = await workflow.createNode({
-        type: 'query',
-        config: {
-          collection: 'posts',
-          params: {
-            filter: {
-              id: '{{ $context.data.id }}',
-            },
-          },
-        },
-        upstreamId: n1.id,
-      });
-
-      await n1.setDownstream(n2);
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const [execution] = await workflow.getExecutions();
-      const [sqlJob, queryJob] = await execution.getJobs({ order: [['id', 'ASC']] });
-      expect(sqlJob.status).toBe(JOB_STATUS.RESOLVED);
-      expect(queryJob.status).toBe(JOB_STATUS.RESOLVED);
-      expect(queryJob.result.read).toBe(post.id);
-    });
-
-    it('delete', async () => {
-      const queryInterface = db.sequelize.getQueryInterface();
-      const n1 = await workflow.createNode({
-        type: 'sql',
-        config: {
-          sql: `delete from ${PostCollection.quotedTableName()} where ${queryInterface.quoteIdentifier(
-            'id',
-          )}={{$context.data.id}};`,
-        },
-      });
-
-      const n2 = await workflow.createNode({
-        type: 'query',
-        config: {
-          collection: 'posts',
-          params: {
-            filter: {
-              id: '{{ $context.data.id }}',
-            },
-          },
-        },
-        upstreamId: n1.id,
-      });
-
-      await n1.setDownstream(n2);
-
-      const post = await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const [execution] = await workflow.getExecutions();
-      const [sqlJob, queryJob] = await execution.getJobs({ order: [['id', 'ASC']] });
-      expect(sqlJob.status).toBe(JOB_STATUS.RESOLVED);
-      expect(queryJob.status).toBe(JOB_STATUS.RESOLVED);
-      expect(queryJob.result).toBeNull();
-    });
-  });
-
-  describe('run in sync mode', () => {
-    it('sync workflow', async () => {
-      const w2 = await WorkflowModel.create({
-        enabled: true,
-        sync: true,
-        type: 'collection',
-        config: {
-          mode: 1,
-          collection: 'categories',
-        },
-      });
-
-      const n1 = await w2.createNode({
-        type: 'sql',
-        config: {
-          sql: `select count(id) from ${PostCollection.quotedTableName()}`,
-        },
-      });
-
-      const CategoryRepo = db.getCollection('categories').repository;
-      const category = await CategoryRepo.create({ values: { title: 't1' } });
-
-      const [execution] = await w2.getExecutions();
-      expect(execution.status).toBe(EXECUTION_STATUS.RESOLVED);
-      const [job] = await execution.getJobs();
-      expect(job.status).toBe(JOB_STATUS.RESOLVED);
-    });
-  });
-
-  describe('multiple data source', () => {
-    it('query on another data source', async () => {
-      const anotherSource = app.dataSourceManager.dataSources.get('another');
-      const PostCollection = anotherSource.collectionManager.getCollection('posts');
-      const { repository: AnotherPostRepo } = PostCollection;
-      const post = await AnotherPostRepo.create({ values: { title: 't1' } });
-      const p1s = await AnotherPostRepo.find();
-      expect(p1s.length).toBe(1);
-
-      const n1 = await workflow.createNode({
-        type: 'sql',
-        config: {
-          dataSource: 'another',
-          sql: `select * from ${PostCollection.quotedTableName()}`,
-        },
-      });
-
-      await PostRepo.create({ values: { title: 't1' } });
-
-      await sleep(500);
-
-      const [execution] = await workflow.getExecutions();
-      expect(execution.status).toBe(EXECUTION_STATUS.RESOLVED);
-      const [job] = await execution.getJobs();
-      expect(job.result.length).toBe(2);
-      expect(job.result[0].length).toBe(1);
-      // @ts-ignore
-      expect(job.result[0][0].id).toBe(post.id);
-    });
-  });
-});

package/src/server/index.ts

@@ -1 +0,0 @@
-export { default } from './Plugin';