@steedos/standard-object-database 2.7.1-beta.1 → 2.7.1-beta.3

package/main/default/objectTranslations/object_webhooks.en/object_webhooks.en.objectTranslation.yml

@@ -0,0 +1,46 @@
+name: object_webhooks
+label: Object Webhook
+description: 
+fields:
+  name:
+    label: Name
+    help: 
+    description: 
+  object_name:
+    label: Object
+    help: 
+    description: 
+  events:
+    label: Events
+    help: 
+    options:
+      - label: create
+        value: create
+      - label: update
+        value: update
+      - label: delete
+        value: delete
+    description: 
+  fields:
+    label: Fields
+    help: 
+    description: 
+  payload_url:
+    label: Payload URL
+    help: 
+    description: 
+  content_type:
+    label: Format of Request
+    help: 
+    description: 
+  active:
+    label: Active
+    help: 
+    description: 
+  space:
+    label: Company
+    help: 
+    description: 
+listviews:
+  all:
+    label: All Object Webhooks

package/main/default/objectTranslations/object_webhooks.zh-CN/object_webhooks.zh-CN.objectTranslation.yml

@@ -0,0 +1,48 @@
+name: object_webhooks
+label: WebHooks
+description: 
+fields:
+  name:
+    label: 名称
+    help: 
+    description: 
+  object_name:
+    label: 对象
+    help: 
+    description: 
+  events:
+    label: 何时触发
+    help: 
+    options:
+      - label: 记录已创建
+        value: create
+      - label: 记录已更新
+        value: update
+      - label: 记录已创建或已更新
+        value: createAndUpdate
+      - label: 记录已删除
+        value: delete
+    description: 
+  fields:
+    label: 推送字段
+    help: 
+    description: 
+  payload_url:
+    label: URL
+    help: 
+    description: 
+  content_type:
+    label: 请求数据格式
+    help: 
+    description: 
+  active:
+    label: 激活
+    help: 
+    description: 
+  space:
+    label: 所属工作区
+    help: 
+    description: 
+listviews:
+  all:
+    label: 所有

package/main/default/objects/object_webhooks/fields/active.field.yml

@@ -0,0 +1,5 @@
+name: active
+label: Active
+type: boolean
+defaultValue: true
+sort_no: 80

package/main/default/objects/object_webhooks/fields/condition.field.yml

@@ -0,0 +1,6 @@
+name: condition
+type: text
+sort_no: 40
+is_wide: true
+label: 准入条件
+inlineHelpText: 指定准入条件，减少触发执行次数。最大限度地减少非必要执行次数，这将有助于节省资源。如果您创建将在记录更新时触发，我们建议先定义准入条件。然后，对于何时为更新的记录运行，选择仅在更新记录满足条件要求时选项。

package/main/default/objects/object_webhooks/fields/content_type.field.yml

@@ -0,0 +1,5 @@
+name: content_type
+label: Format of Request
+type: text
+defaultValue: '"application/json"'
+hidden: true

package/main/default/objects/object_webhooks/fields/event.field.yml

@@ -0,0 +1,15 @@
+name: event
+type: select
+label: 何时触发
+required: true
+multiple: false
+sort_no: 30
+options:
+  - label: 记录已创建
+    value: create
+  - label: 记录已更新
+    value: update
+  - label: 记录已创建或已更新
+    value: createAndUpdate
+  - label: 记录已删除
+    value: delete

package/main/default/objects/object_webhooks/fields/execute_when.field.yml

@@ -0,0 +1,12 @@
+name: execute_when
+label: 何时运行更新记录的webhook
+type: select
+inlineHelpText: 您可能希望仅在将触发记录从不满足条件要求更改为满足条件要求时运行。在出现此情况时，选择第二个选项。
+visible_on: ${!!condition && (event === 'update' || event === 'createAndUpdate')}
+sort_no: 50
+is_wide: true
+options:
+  - label: 每次更新记录并满足条件要求
+    value: trueEveryTime
+  - label: 仅在更新记录以满足条件要求时
+    value: trueOnChangeOnly

package/main/default/objects/object_webhooks/fields/fields.field.yml

@@ -0,0 +1,27 @@
+name: fields
+type: lookup
+label: Fields
+multiple: true
+is_wide: true
+sort_no: 60
+depend_on:
+  - object_name
+optionsFunction: !!js/function |
+  function(values) {
+    var _object, _options, fields, icon, object_name;
+    object_name = values.object_name;
+    if (!object_name) {
+      return [];
+    }
+    _options = [];
+    _object = Creator.getObject(object_name);
+    fields = _object.fields;
+    icon = _object.icon;
+    _.forEach(fields, function(f, k) {
+      return _options.push({
+        label: f.label || k,
+        value: k
+      });
+    });
+    return _options;
+  }

package/main/default/objects/object_webhooks/fields/name.field.yml

@@ -0,0 +1,5 @@
+name: name
+type: text
+label: Name
+required: true
+sort_no: 10

package/main/default/objects/object_webhooks/fields/object_name.field.yml

@@ -0,0 +1,8 @@
+name: object_name
+type: lookup
+reference_to: objects
+reference_to_field: name
+label: Object
+required: true
+index: true
+sort_no: 20

package/main/default/objects/object_webhooks/fields/payload_url.field.yml

@@ -0,0 +1,7 @@
+name: payload_url
+label: Payload URL
+type: text
+is_wide: true
+# regEx: /^(?:(?:https?|ftp):\/\/)(?:\S+(?::\S*)?@)?(?:(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9]+-?)*[a-z\u00a1-\uffff0-9]+)(?:\.(?:[a-z\u00a1-\uffff0-9]+-?)*[a-z\u00a1-\uffff0-9]+)*(?:\.(?:[a-z\u00a1-\uffff]{2,})))(?::\d{2,5})?(?:\/[^\s]*)?$/i
+required: true
+sort_no: 70

package/main/default/objects/object_webhooks/listviews/all.listview.yml

@@ -0,0 +1,9 @@
+name: all
+columns:
+  - name
+  - object_name
+  - event
+  - payload_url
+  - active
+label: All Object Webhooks
+filter_scope: space

package/main/default/objects/object_webhooks/object_webhooks.object.yml

@@ -0,0 +1,5 @@
+name: object_webhooks
+label: Object Webhook
+icon: output
+hidden: true
+version: 2

package/main/default/objects/object_webhooks/permissions/admin.permission.yml

@@ -0,0 +1,7 @@
+permission_set_id: admin
+allowCreate: true
+allowDelete: true
+allowEdit: true
+allowRead: true
+modifyAllRecords: true
+viewAllRecords: true

package/main/default/objects/object_webhooks/permissions/user.permission.yml

@@ -0,0 +1,7 @@
+permission_set_id: user
+allowCreate: false
+allowDelete: false
+allowEdit: false
+allowRead: false
+modifyAllRecords: false
+viewAllRecords: false

package/main/default/pages/object_webhooks_form.page.amis.json

@@ -0,0 +1,51 @@
+{
+    "type": "service",
+    "body": [{
+        "type": "steedos-object-form",
+        "label": "Object Webhook",
+        "objectApiName": "object_webhooks",
+        "recordId": "${recordId}",
+        "mode": "edit",
+        "layout": "horizontal",
+    
+        "fieldsExtend": {
+            "condition": {
+                "amis": {
+                    "type": "service",
+                    "schemaApi": {
+                        "method": "get",
+                        "url": "/service/api/amis-metadata-objects/objects/${object_name}/fields/options",
+                        "cache": 30000,
+                        "adaptor": "const visibleOnVariables = SteedosUI.getFormulaVariables(payload.data.options);\n const defaultValueVariables = [visibleOnVariables[1]];\n const variables = [];\n const varItem = {\n     label: '对象字段',\n     children: _.map(payload.data.options, (item)=>{\n         return {\n             label: item.label,\n             value: item.value\n         }\n     })\n };\n variables.push(varItem);\n payload.data={label: '准入条件', type:'input-formula', name: 'condition', variables: variables} \n return payload;",
+                        "trackExpression": "${object_name}",
+                        "sendOn": "${object_name}"
+                    }
+                  }
+            },
+            "execute_when":{
+                "amis": {
+                    "type": "radios",
+                    "inline": false
+                }
+            },
+            "event": {
+                "amis":{
+                    "type": "radios",
+                    "inline": false
+                }
+            }
+        },
+        "form": {
+            "id": "steedos_object_webhooks_form"
+        },
+        "id": "u:e17c57cce896",
+        "tabsMode": "line"
+    }],
+    "data": {
+        "context": {},
+        "visibleOnVariables": "",
+        "defaultValueVariables": ""
+    },
+    "name": "object_webhooks_form",
+    "id": "steedos_object_webhooks_service"
+}

package/main/default/pages/object_webhooks_form.page.yml

@@ -0,0 +1,12 @@
+name: object_webhooks_form
+is_active: true
+label: 对象字段表单
+object_name: object_webhooks
+pageAssignments:
+  - type: orgDefault
+    page: object_webhooks_form
+    desktop: true
+    mobile: true
+render_engine: amis
+type: form
+widgets: []

package/main/default/services/object_webhooks.service.js

@@ -0,0 +1,136 @@
+/*
+ * @Author: baozhoutao@steedos.com
+ * @Date: 2024-04-23 14:35:03
+ * @LastEditors: baozhoutao@steedos.com
+ * @LastEditTime: 2024-04-26 12:02:56
+ * @Description: 
+ */
+
+const BullMqMixin = require('moleculer-bullmq');
+const axios = require('axios');
+const { evaluate } = require("amis-formula")
+const serviceObjectMixin = require('@steedos/service-object-mixin');
+
+module.exports = {
+    name: "object_webhooks",
+    mixins: [serviceObjectMixin, BullMqMixin],
+    settings: {
+      bullmq: {
+        client: process.env.QUEUE_BACKEND,
+        worker: { concurrency: 50 }
+      }
+    },
+    events: {
+      "*.inserted": async function(ctx){
+        // TODO 校验是否是objectql的记录新增事件.  使用@objectApiName + .inserted 后,与ctx.eventName对比,看是否相同
+        const { objectApiName, id, spaceId, userId  } = ctx.params;
+        if(objectApiName && id && spaceId){
+          await this.addQueue(ctx, objectApiName, "create", id, spaceId, userId)
+        }
+      },
+      "*.updated": async function(ctx){
+        // TODO 校验是否是objectql的记录新增事件.  使用@objectApiName + .updated 后,与ctx.eventName对比,看是否相同
+        const { objectApiName, id, spaceId, userId, previousDoc } = ctx.params;
+        if(objectApiName && id && spaceId){
+          await this.addQueue(ctx, objectApiName, "update", id, spaceId, userId, previousDoc)
+        }
+      },
+      "*.deleted": async function(ctx){
+        // TODO 校验是否是objectql的记录新增事件.  使用@objectApiName + .deleted 后,与ctx.eventName对比,看是否相同
+        const { objectApiName, id, spaceId, userId, previousDoc } = ctx.params;
+        if(objectApiName && id){
+          await this.addQueue(ctx, objectApiName, "delete", id, spaceId, userId, previousDoc)
+        }
+      }
+    },
+    actions: {
+      send: {
+        queue: true,
+        async handler(ctx) {
+          const { url, data } = ctx.params
+          const result = await axios.post(url, data);
+          ctx.locals.job.updateProgress(100)
+          console.log('====>send', url, data.doc?.name)
+          return result.data;
+        }
+      }
+    },
+    methods: {
+
+      async addQueue(ctx, objectName, actionName, recordId, spaceId, userId, previousDoc){
+        const hooks = await this.getObjectWebhooks(objectName, spaceId)
+        if(hooks.length === 0) return
+
+        let newDoc;
+        if(recordId && (actionName === 'update' || actionName === 'create')){
+          newDoc = await this.getObject(objectName).findOne(recordId)
+        }
+        let sender;
+        let space;
+        if(userId && spaceId){
+          const userSession  = await ctx.call('@steedos/service-accounts.getUserSession', {userId, spaceId})
+          if(userSession){
+            sender = {
+              id: userSession.userId,
+              username: userSession.username,
+              name: userSession.name,
+              email: userSession.email
+            }
+
+            space = {
+              id: userSession.space._id,
+              name: userSession.space.name
+            }
+          }
+        }
+
+        for (const hook of hooks) {
+
+          if(hook.event != 'createAndUpdate' && hook.event != actionName){
+            continue;
+          }
+
+          if(hook.event == 'createAndUpdate' && actionName != 'create' && actionName != 'update'){
+            continue;
+          }
+
+          const { execute_when, condition } = hook;
+
+          if(hook.event == 'createAndUpdate' && actionName == 'create' && execute_when == 'trueOnChangeOnly'){
+            continue;
+          }
+
+          if(condition){
+
+            if(actionName == 'update' && execute_when === 'trueOnChangeOnly'){
+              const oldResult = evaluate(condition, previousDoc);
+              if(oldResult){
+                continue;
+              }
+            }
+
+            const result = evaluate(condition, newDoc);
+            if(!result){
+              continue;
+            }
+          }
+          let data  = newDoc || previousDoc;
+          if(hook.fields && hook.fields.length > 0){
+            data = _.map(data, hook.fields)
+          }
+          await this.queue(ctx, 'object_webhooks', 'send', { url: hook.payload_url, data: {
+            action: actionName,
+            object_name: objectName,
+            doc: data,
+            sender: sender,
+            space: space
+          }, space: spaceId, user: userId }, { priority: 10 })
+        }
+      },
+      async getObjectWebhooks(objectName, spaceId){
+        const SERVICE_NAME = 'metadata-cachers-service'
+        const hooks = await global.broker.call(`${SERVICE_NAME}.find`, {metadataName: 'object_webhooks', filters: ['object_name', '=', objectName], spaceId});
+        return hooks;
+      }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@steedos/standard-object-database",
-    "version": "2.7.1-beta.1",
+    "version": "2.7.1-beta.3",
     "main": "package.service.js",
     "private": false,
     "publishConfig": {
@@ -12,10 +12,13 @@
     "description": "steedos package",
     "dependencies": {
         "@steedos-widgets/amis-lib": "^1.0.22",
-        "@steedos/metadata-core": "2.7.1-beta.1",
-        "@steedos/standard-objects": "2.7.1-beta.1"
+        "@steedos/metadata-core": "2.7.1-beta.3",
+        "@steedos/service-object-mixin": "2.7.1-beta.3",
+        "@steedos/standard-objects": "2.7.1-beta.3",
+        "amis-formula": "~6.3.0",
+        "moleculer-bullmq": "3.0.0"
     },
     "repository": {},
     "license": "MIT",
-    "gitHead": "869f9bbc7438f42da31a8bfd91c83f088fe88079"
+    "gitHead": "f154c292cacb12408aa6383e8667a3f6dcd38fb6"
 }