@wmfs/tymly-schedule-plugin 1.0.0 → 1.1.0

package/.version

@@ -1 +1 @@
-VERSION=1.0.0
+VERSION=1.1.0

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+# [1.1.0](https://github.com/wmfs/tymly-schedule-plugin/compare/v1.0.1...v1.1.0) (2022-03-16)
+
+
+### ✨ Features
+
+* ability to create/modify tasks from ui ([b7d56c5](https://github.com/wmfs/tymly-schedule-plugin/commit/b7d56c5e44609d4b2b14dbdc4e13a6c91f784eee))
+* admin tools to create scheduled task ([b0e6ddc](https://github.com/wmfs/tymly-schedule-plugin/commit/b0e6ddc5325ace6332516275893471b39703c1ba))
+* admin tools to start/stop tasks ([106f5fa](https://github.com/wmfs/tymly-schedule-plugin/commit/106f5fa7daedca13030b49fac473a891c5c6d9e1))
+* admin tools to update schedule of state machine ([c6df466](https://github.com/wmfs/tymly-schedule-plugin/commit/c6df4669823e002916d4b86a0458e4e1d57ab45d))
+* admin tools to update state machine config ([e26928a](https://github.com/wmfs/tymly-schedule-plugin/commit/e26928a276c1783fb92785eb2355570dd01f32ac))
+* admin tools to view all and view specific tasks ([b9f80c8](https://github.com/wmfs/tymly-schedule-plugin/commit/b9f80c89077115ae2c783c0b03e8de322111319f))
+* admin tools to view scheduled executions ([89b9094](https://github.com/wmfs/tymly-schedule-plugin/commit/89b90941de1b48a14896043ec3710df2c2440949))
+* remove last ran start/end and total run count, as these can be found from executions ([d6c673b](https://github.com/wmfs/tymly-schedule-plugin/commit/d6c673b926654c564d08f6de1b5f22bcf61b3783))
+
+
+### 🐛 Bug Fixes
+
+* issue with finding scheduled executions ([b198bd1](https://github.com/wmfs/tymly-schedule-plugin/commit/b198bd1bf49ffb517229309eadaf7fdaed9f1ff7))
+* use function from service to get executions ([b9082bc](https://github.com/wmfs/tymly-schedule-plugin/commit/b9082bc49ccdbd39c1316c786f83efddd7396a7d))
+
+
+### 🚨 Tests
+
+* fix status after re-boot with datetime schedule in past ([e4e9cba](https://github.com/wmfs/tymly-schedule-plugin/commit/e4e9cba84fbdaf91838e880b7dacda4659e60119))
+* remove unused executions model ([92e888d](https://github.com/wmfs/tymly-schedule-plugin/commit/92e888d266803dac531a27f0c8d74ff6d6b22e52))
+
+## [1.0.1](https://github.com/wmfs/tymly-schedule-plugin/compare/v1.0.0...v1.0.1) (2022-03-15)
+
+
+### 🐛 Bug Fixes
+
+* handle no blueprint components ([1d05697](https://github.com/wmfs/tymly-schedule-plugin/commit/1d05697563434dd01274121b5db59db3ec0e39ae))
+
 # 1.0.0 (2022-03-15)
 
 

package/lib/blueprints/schedule-blueprint/card-templates/create-scheduled-task.json

@@ -0,0 +1,97 @@
+{
+  "templateMeta": {
+    "name": "create-scheduled-task",
+    "title": "Configure a Scheduled State Machine",
+    "category": "schedule"
+  },
+  "hooks": {
+    "afterSubmit": {
+      "actions": [
+        {
+          "type": "Action.PushCard",
+          "stateMachineName": "schedule_viewScheduledTask_1_0",
+          "input": {
+            "key": "$.key"
+          }
+        }
+      ]
+    }
+  },
+  "type": "AdaptiveCard",
+  "body": [
+    {
+      "showWhen": "data.editing !== true",
+      "id": "name",
+      "type": "Input.Text",
+      "title": "Schedule name",
+      "validation": {
+        "requiredIf": "data.editing !== true"
+      }
+    },
+    {
+      "id": "scheduleType",
+      "type": "Input.ChoiceSet",
+      "title": "What type of schedule?",
+      "choices": [
+        {
+          "title": "Interval",
+          "value": "interval"
+        },
+        {
+          "title": "Date/time",
+          "value": "datetime"
+        }
+      ],
+      "validation": {
+        "required": true
+      }
+    },
+    {
+      "showWhen": "data.scheduleType === 'interval'",
+      "id": "interval",
+      "type": "Input.Text",
+      "title": "Interval",
+      "validation": {
+        "requiredIf": "data.scheduleType === 'interval'"
+      }
+    },
+    {
+      "showWhen": "data.scheduleType === 'datetime'",
+      "id": "datetime",
+      "type": "Input.DateTime",
+      "title": "Date/time",
+      "validation": {
+        "requiredIf": "data.scheduleType === 'datetime'"
+      }
+    },
+    {
+      "id": "stateMachineName",
+      "type": "Input.ChoiceSet",
+      "title": "Which state machine?",
+      "filter": true,
+      "choicesPath": "data.availableStateMachines",
+      "validation": {
+        "required": true
+      }
+    },
+    {
+      "id": "inputStr",
+      "type": "Input.Text",
+      "title": "Input",
+      "isMultiline": true,
+      "value": "{}"
+    }
+  ],
+  "actions": [
+    {
+      "type": "Action.Cancel",
+      "title": "Cancel"
+    },
+    {
+      "type": "Action.Submit",
+      "title": "Submit"
+    }
+  ],
+  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+  "version": "1.0"
+}

package/lib/blueprints/schedule-blueprint/card-templates/view-all-scheduled-tasks.json

@@ -0,0 +1,36 @@
+{
+  "templateMeta": {
+    "name": "view-scheduled-tasks",
+    "title": "View Scheduled State Machines",
+    "category": "schedule"
+  },
+  "type": "AdaptiveCard",
+  "body": [
+    {
+      "type": "MarkupTable",
+      "title": "Scheduled State Machines",
+      "arrayPath": "data.tasks",
+      "clickToLaunch": true,
+      "columns": [
+        {
+          "title": "Key",
+          "value": "{{ item.key }}"
+        },
+        {
+          "title": "Schedule",
+          "value": "{{ item.scheduleType === 'datetime' ? item.datetime : item.interval }}"
+        },
+        {
+          "title": "State machine name",
+          "value": "{{ item.stateMachineName }}"
+        },
+        {
+          "title": "Status",
+          "value": "{{ item.status }}"
+        }
+      ]
+    }
+  ],
+  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+  "version": "1.0"
+}

package/lib/blueprints/schedule-blueprint/card-templates/view-scheduled-task.json

@@ -0,0 +1,148 @@
+{
+  "templateMeta": {
+    "name": "view-scheduled-task",
+    "title": "View Scheduled State Machine",
+    "category": "schedule"
+  },
+  "type": "AdaptiveCard",
+  "body": [
+    {
+      "type": "Container",
+      "color": "accent",
+      "spacing": "none",
+      "items": [
+        {
+          "type": "TextBlock",
+          "text": "{{ data.key }}",
+          "weight": "bolder",
+          "spacing": "none"
+        }
+      ]
+    },
+    {
+      "type": "ColumnSet",
+      "columns": [
+        {
+          "type": "Column",
+          "width": 8,
+          "items": [
+            {
+              "type": "FactSet",
+              "showAllIfUndefined": true,
+              "facts": [
+                {
+                  "title": "Key",
+                  "value": "{{ data.key }}"
+                },
+                {
+                  "title": "Schedule",
+                  "value": "{{ data.scheduleType === 'datetime' ? data.datetime : data.interval }}"
+                },
+                {
+                  "title": "State machine name",
+                  "value": "{{ data.stateMachineName }}"
+                },
+                {
+                  "title": "Input",
+                  "value": "{{ JSON.stringify(data.input) }}"
+                },
+                {
+                  "title": "Send response",
+                  "value": "{{ data.sendResponse }}"
+                },
+                {
+                  "title": "Start on boot?",
+                  "value": "{{ data.startOnBoot ? 'Yes' : 'No' }}"
+                },
+                {
+                  "title": "Status",
+                  "value": "{{ data.status }}"
+                },
+                {
+                  "title": "Created",
+                  "value": "{{ formatDate(data.created, 'DD/MM/YYYY HH:mm') }}"
+                },
+                {
+                  "title": "Created by",
+                  "value": "{{ data.createdBy || '-' }}"
+                },
+                {
+                  "title": "Modified",
+                  "value": "{{ formatDate(data.modified, 'DD/MM/YYYY HH:mm') }}"
+                },
+                {
+                  "title": "Modified by",
+                  "value": "{{ data.modifiedBy || '-' }}"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "type": "Column",
+          "width": 4,
+          "items": [
+            {
+              "type": "ActionSet",
+              "actions": [
+                {
+                  "showWhen": "data.status === 'STARTED'",
+                  "type": "Action.PushCard",
+                  "title": "Stop task",
+                  "stateMachineName": "schedule_stopTask_1_0",
+                  "input": {
+                    "key": "$.key"
+                  }
+                },
+                {
+                  "showWhen": "data.status !== 'STARTED'",
+                  "type": "Action.PushCard",
+                  "title": "Start task",
+                  "stateMachineName": "schedule_startTask_1_0",
+                  "input": {
+                    "key": "$.key"
+                  }
+                },
+                {
+                  "type": "Action.PushCard",
+                  "title": "Modify schedule",
+                  "stateMachineName": "schedule_modifyScheduledTask_1_0",
+                  "input": {
+                    "key": "$.key"
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "title": "State machine executions",
+      "type": "Table",
+      "arrayPath": "data.executions",
+      "columns": [
+        {
+          "title": "Execution name",
+          "field": "executionName"
+        },
+        {
+          "title": "Status",
+          "field": "status"
+        },
+        {
+          "title": "Created",
+          "field": "created",
+          "format": "formatDate(val, 'DD/MM/YYYY HH:mm')"
+        },
+        {
+          "title": "Modified",
+          "field": "modified",
+          "format": "formatDate(val, 'DD/MM/YYYY HH:mm')"
+        }
+      ]
+    }
+  ],
+  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+  "version": "1.0"
+}

package/lib/blueprints/schedule-blueprint/categories/schedule.json

@@ -0,0 +1,8 @@
+{
+  "label": "Schedule",
+  "description": "Scheduled state machines",
+  "style": {
+    "icon": "schedule",
+    "backgroundColor": "#008800"
+  }
+}

package/lib/blueprints/schedule-blueprint/functions/generate-key.js

@@ -0,0 +1,16 @@
+const capitalise = str => str.charAt(0).toUpperCase() + str.slice(1)
+const schema = 'schedule'
+
+module.exports = function () {
+  return function (event, env) {
+    const now = env.bootedServices.timestamp.now()
+
+    const key = [
+      schema,
+      event.trim().split(' ').map((n, i) => i === 0 ? n : capitalise(n)).join(''),
+      now.format('YYYYMMDD-HHmm')
+    ].join('_')
+
+    return { key }
+  }
+}

package/lib/blueprints/schedule-blueprint/functions/get-available-state-machines.js

@@ -0,0 +1,18 @@
+module.exports = function () {
+  return async function getAvailableStateMachines (event, env) {
+    const availableStateMachines = env.bootedServices.statebox
+      .listStateMachines()
+      .map(({ name }) => {
+        return {
+          title: name,
+          value: name
+        }
+      })
+
+    return {
+      availableStateMachines,
+      availableStateMachinesOrig: availableStateMachines,
+      availableStateMachinesFilt: availableStateMachines
+    }
+  }
+}

package/lib/blueprints/schedule-blueprint/models/task.json

@@ -35,20 +35,6 @@
     "startOnBoot": {
       "type": "boolean"
     },
-    "lastRanStart": {
-      "type": "string",
-      "format": "date-time"
-    },
-    "lastRanEnd": {
-      "type": "string",
-      "format": "date-time"
-    },
-    "lastRanExecutionName": {
-      "type": "string"
-    },
-    "totalRunCount": {
-      "type": "integer"
-    },
     "status": {
       "type": "string"
     }

package/lib/blueprints/schedule-blueprint/state-machines/create-scheduled-task.json

@@ -0,0 +1,66 @@
+{
+  "Comment": "Set up a Scheduled State Machine",
+  "name": "Set up a Scheduled State Machine",
+  "version": "1.0",
+  "categories": [
+    "schedule"
+  ],
+  "instigators": [
+    "user"
+  ],
+  "instigatorGroup": "form",
+  "StartAt": "GetStateMachines",
+  "States": {
+    "GetStateMachines": {
+      "Type": "Task",
+      "Resource": "function:schedule_getAvailableStateMachines",
+      "ResultPath": "$",
+      "Next": "DefaultInput"
+    },
+    "DefaultInput": {
+      "Type": "Pass",
+      "ResultSelector": {
+        "inputStr": "{}"
+      },
+      "Next": "View"
+    },
+    "View": {
+      "Type": "Task",
+      "Resource": "module:awaitingHumanInput",
+      "ResourceConfig": {
+        "uiType": "app",
+        "uiName": "schedule_createScheduledTask",
+        "dataPath": "$"
+      },
+      "Next": "GenerateKey"
+    },
+    "GenerateKey": {
+      "Type": "Task",
+      "InputPath": "$.name",
+      "Resource": "function:schedule_generateKey",
+      "ResultPath": "$",
+      "Next": "CreateScheduledTask"
+    },
+    "CreateScheduledTask": {
+      "Type": "Task",
+      "Parameters": {
+        "key.$": "$.key",
+        "scheduleType.$": "$.scheduleType",
+        "datetime.$": "$.datetime",
+        "interval.$": "$.interval",
+        "stateMachineName.$": "$.stateMachineName",
+        "input.$": "$.inputStr"
+      },
+      "Resource": "module:createScheduledTask",
+      "End": true
+    }
+  },
+  "restrictions": [
+    {
+      "roleId": "schedule_scheduleAdmin",
+      "allows": [
+        "*"
+      ]
+    }
+  ]
+}

package/lib/blueprints/schedule-blueprint/state-machines/modify-scheduled-task.json

@@ -0,0 +1,74 @@
+{
+  "Comment": "Modify a Scheduled State Machine",
+  "name": "Modify a Scheduled State Machine",
+  "version": "1.0",
+  "categories": [
+    "schedule"
+  ],
+  "StartAt": "SetAsEditing",
+  "States": {
+    "SetAsEditing": {
+      "Type": "Pass",
+      "Result": {
+        "editing": true
+      },
+      "ResultPath": "$",
+      "Next": "FindTask"
+    },
+    "FindTask": {
+      "Type": "Task",
+      "InputPath": "$.key",
+      "Resource": "module:findingById",
+      "ResourceConfig": {
+        "modelId": "schedule_task"
+      },
+      "ResultPath": "$",
+      "Next": "GetStateMachines"
+    },
+    "GetStateMachines": {
+      "Type": "Task",
+      "Resource": "function:schedule_getAvailableStateMachines",
+      "ResultPath": "$",
+      "Next": "View"
+    },
+    "View": {
+      "Type": "Task",
+      "Resource": "module:awaitingHumanInput",
+      "ResourceConfig": {
+        "uiType": "app",
+        "uiName": "schedule_createScheduledTask",
+        "dataPath": "$"
+      },
+      "Next": "UpdateScheduledTask"
+    },
+    "UpdateScheduledTask": {
+      "Type": "Task",
+      "Parameters": {
+        "key.$": "$.key",
+        "scheduleType.$": "$.scheduleType",
+        "datetime.$": "$.datetime",
+        "interval.$": "$.interval"
+      },
+      "Resource": "module:updateScheduledTask",
+      "Next": "UpdateScheduledStateMachineConfig"
+    },
+    "UpdateScheduledStateMachineConfig": {
+      "Type": "Task",
+      "Parameters": {
+        "key.$": "$.key",
+        "stateMachineName.$": "$.stateMachineName",
+        "input.$": "$.inputStr"
+      },
+      "Resource": "module:updateScheduledStateMachineConfig",
+      "End": true
+    }
+  },
+  "restrictions": [
+    {
+      "roleId": "schedule_scheduleAdmin",
+      "allows": [
+        "*"
+      ]
+    }
+  ]
+}

package/lib/blueprints/schedule-blueprint/state-machines/start-task.json

@@ -0,0 +1,36 @@
+{
+  "Comment": "Start Scheduled State Machine",
+  "name": "Start Scheduled State Machine",
+  "version": "1.0",
+  "categories": [
+    "schedule"
+  ],
+  "StartAt": "StartScheduledTask",
+  "States": {
+    "StartScheduledTask": {
+      "Type": "Task",
+      "InputPath": "$.key",
+      "Resource": "module:startScheduledTask",
+      "Next": "View"
+    },
+    "View": {
+      "Type": "Task",
+      "Parameters": {
+        "key.$": "$.key"
+      },
+      "Resource": "module:runStateMachine",
+      "ResourceConfig": {
+        "stateMachine": "schedule_viewScheduledTask_1_0"
+      },
+      "End": true
+    }
+  },
+  "restrictions": [
+    {
+      "roleId": "schedule_scheduleAdmin",
+      "allows": [
+        "*"
+      ]
+    }
+  ]
+}

package/lib/blueprints/schedule-blueprint/state-machines/stop-task.json

@@ -0,0 +1,36 @@
+{
+  "Comment": "Stop Scheduled State Machine",
+  "name": "Stop Scheduled State Machine",
+  "version": "1.0",
+  "categories": [
+    "schedule"
+  ],
+  "StartAt": "StopScheduledTask",
+  "States": {
+    "StopScheduledTask": {
+      "Type": "Task",
+      "InputPath": "$.key",
+      "Resource": "module:stopScheduledTask",
+      "Next": "View"
+    },
+    "View": {
+      "Type": "Task",
+      "Parameters": {
+        "key.$": "$.key"
+      },
+      "Resource": "module:runStateMachine",
+      "ResourceConfig": {
+        "stateMachine": "schedule_viewScheduledTask_1_0"
+      },
+      "End": true
+    }
+  },
+  "restrictions": [
+    {
+      "roleId": "schedule_scheduleAdmin",
+      "allows": [
+        "*"
+      ]
+    }
+  ]
+}

package/lib/blueprints/schedule-blueprint/state-machines/view-all-scheduled-tasks.json

@@ -0,0 +1,69 @@
+{
+  "Comment": "View Scheduled State Machines",
+  "name": "View Scheduled State Machines",
+  "version": "1.0",
+  "categories": [
+    "schedule"
+  ],
+  "instigators": [
+    "user"
+  ],
+  "instigatorGroup": "app",
+  "StartAt": "FindTasks",
+  "States": {
+    "FindTasks": {
+      "Type": "Task",
+      "Resource": "module:finding",
+      "ResourceConfig": {
+        "modelId": "schedule_task"
+      },
+      "ResultPath": "$.tasks",
+      "Next": "AddTaskLaunches"
+    },
+    "AddTaskLaunches": {
+      "Type": "Map",
+      "ItemsPath": "$.tasks",
+      "Iterator": {
+        "StartAt": "AddLaunches",
+        "States": {
+          "AddLaunches": {
+            "Type": "Pass",
+            "Parameters": {
+              "launches": [
+                {
+                  "title": "View",
+                  "stateMachineName": "schedule_viewScheduledTask",
+                  "input": {
+                    "key.$": "$.key"
+                  }
+                }
+              ]
+            },
+            "ResultPath": "$",
+            "End": true
+          }
+        }
+      },
+      "ResultPath": "$.tasks",
+      "Next": "View"
+    },
+    "View": {
+      "Type": "Task",
+      "Resource": "module:awaitingHumanInput",
+      "ResourceConfig": {
+        "uiType": "app",
+        "uiName": "schedule_viewAllScheduledTasks",
+        "dataPath": "$"
+      },
+      "End": true
+    }
+  },
+  "restrictions": [
+    {
+      "roleId": "schedule_scheduleAdmin",
+      "allows": [
+        "*"
+      ]
+    }
+  ]
+}