@wmfs/tymly-schedule-plugin 1.0.0

package/.circleci/config.yml

@@ -0,0 +1,111 @@
+version: 2
+jobs:
+  unit test:
+    docker:
+      - image: cimg/node:lts
+        auth:
+          username: $DOCKERHUB_USERNAME
+          password: $DOCKERHUB_PASSWORD
+        environment:
+          TZ: "Europe/London"
+          PG_CONNECTION_STRING: postgres://postgres:postgres@localhost:5432/circle_test
+          TIMEOUT: 15000
+      - image: cimg/postgres:13.4-postgis
+        auth:
+          username: $DOCKERHUB_USERNAME
+          password: $DOCKERHUB_PASSWORD
+        environment:
+          POSTGRES_USER: postgres
+          POSTGRES_HOST_AUTH_METHOD: trust
+          POSTGRES_DB: circle_test
+          TZ: "Europe/London"
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-deps-{{ checksum "package.json" }}
+            - v1-deps-
+      - run:
+          name: install
+          command: |
+            npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN
+            npm install
+      - save_cache:
+          key: v1-deps-{{ checksum "package.json" }}
+          paths:
+            - node_modules
+      - run:
+          name: test
+          command: npm test
+      - run:
+          name: codecov
+          command: npm run coverage
+  lint:
+    docker:
+      - image: cimg/node:lts
+        auth:
+          username: $DOCKERHUB_USERNAME
+          password: $DOCKERHUB_PASSWORD
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run:
+          name: install standard
+          command: |
+            npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN
+            npm install
+      - run:
+          name: lint
+          command: npm run lint
+  release:
+    docker:
+      - image: cimg/node:lts
+        auth:
+          username: $DOCKERHUB_USERNAME
+          password: $DOCKERHUB_PASSWORD
+        environment:
+          TZ: "Europe/London"
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v1-deps-{{ checksum "package.json" }}
+            - v1-deps-
+      - run:
+          name: install
+          command: |
+            npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN
+            npm install
+      - save_cache:
+          key: v1-deps-{{ checksum "package.json" }}
+          paths:
+            - node_modules
+      - run:
+          name: release
+          command: |
+            chmod +x version_plugin
+            npx semantic-release
+workflows:
+  version: 2
+  test_and_release:
+    jobs:
+      - unit test:
+          context:
+            - docker-hub-creds
+            - build-env-vars
+      - lint:
+          context:
+            - docker-hub-creds
+            - build-env-vars
+      - release:
+          context:
+            - docker-hub-creds
+            - build-env-vars
+          requires:
+            - unit test
+            - lint
+          filters:
+            branches:
+              only: master

package/.releaserc.json

@@ -0,0 +1,38 @@
+{
+  "branch": "master",
+  "analyzeCommits": {
+    "preset": "angular",
+    "releaseRules": [
+      {"type": "build", "scope":"deps", "release": "minor"}
+    ]
+  },
+  "verifyConditions": [
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/git"
+  ],
+  "generateNotes": {
+    "preset": "metahub"
+  },
+  "prepare": [
+    {
+      "path": "@semantic-release/exec",
+      "cmd": "echo 'VERSION=${nextRelease.version}' > .version && ./version_plugin"
+    },
+    {
+      "path": "@semantic-release/changelog",
+      "changelogFile": "CHANGELOG.md"
+    },
+    {
+      "path": "@semantic-release/git",
+      "assets": ["CHANGELOG.md"]
+    },
+    "@semantic-release/npm"
+  ],
+  "publish": [
+    "@semantic-release/npm",
+    "@semantic-release/github"
+  ],
+  "success": ["@semantic-release/github"],
+  "fail": ["@semantic-release/github"]
+}

package/.version

@@ -0,0 +1 @@
+VERSION=1.0.0

package/CHANGELOG.md

@@ -0,0 +1,41 @@
+# 1.0.0 (2022-03-15)
+
+
+### ✨ Features
+
+* ability to stop tasks ([1540f7a](https://github.com/wmfs/tymly-schedule-plugin/commit/1540f7ae85aac4ae9cdd87b3b12ee9ddadf6beb3))
+* allow for timezone option ([6dc4082](https://github.com/wmfs/tymly-schedule-plugin/commit/6dc408296538b4f3815a5aad372b140ce5651529))
+* allow rescheduling ([3b3f1f9](https://github.com/wmfs/tymly-schedule-plugin/commit/3b3f1f9e7e4b788a24ee45559e351a873d7c46dc))
+* allow rescheduling, cron style or date style ([a55b75c](https://github.com/wmfs/tymly-schedule-plugin/commit/a55b75c5a639ad5aa49cbaea929fbc9ff82dea09))
+* function to convert datetime back to rule ([b7b68e7](https://github.com/wmfs/tymly-schedule-plugin/commit/b7b68e7c4836001965243fef22773703553f574e))
+* move rule/datetime converting into utils directory ([a425105](https://github.com/wmfs/tymly-schedule-plugin/commit/a42510596a87bb1fc617a18526bb9b1d14b92ab3))
+
+
+### 🐛 Bug Fixes
+
+* add log for execution error ([c49d261](https://github.com/wmfs/tymly-schedule-plugin/commit/c49d26104a72be787d361b1df2381ecbe5ca13f2))
+* issues with scheduling for dates ([9c4b40f](https://github.com/wmfs/tymly-schedule-plugin/commit/9c4b40f9bf88ae7eaf8398a9634c065f935d91ae))
+* persist schedule config from db ([5034eff](https://github.com/wmfs/tymly-schedule-plugin/commit/5034eff6dd953653b1094f132112992b25232413))
+* rename some things ([b42cf44](https://github.com/wmfs/tymly-schedule-plugin/commit/b42cf447eb02e20435498c19c159fb64f787293e))
+
+
+### 📦 Code Refactoring
+
+* use node-schedule instead ([a8e57ff](https://github.com/wmfs/tymly-schedule-plugin/commit/a8e57ffe1a7d4728596eac187cfe7229f6a4d6a3))
+
+
+### 🚨 Tests
+
+* more tests ([87f9de1](https://github.com/wmfs/tymly-schedule-plugin/commit/87f9de1a1133d0ffe1421e699d260da3f677af85))
+
+
+### ⚙️ Continuous Integrations
+
+* add db config for circle ([4541e9d](https://github.com/wmfs/tymly-schedule-plugin/commit/4541e9d9df5794c55acc618ff8ce3fa5aa03a4ef))
+
+
+### ♻️ Chores
+
+* disable tymly sync ([d0776ba](https://github.com/wmfs/tymly-schedule-plugin/commit/d0776ba009ae234a5644b64911142ef8abc7bc54))
+* initial commit, simple state machine scheduling ([26d7163](https://github.com/wmfs/tymly-schedule-plugin/commit/26d7163980df98100bf561237af339123c710e8d))
+* rename to tymly schedule plugin ([2937228](https://github.com/wmfs/tymly-schedule-plugin/commit/29372288cfeefba537afdb6d65e4c11709ddfbb0))

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 West Midlands Fire Service
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# tymly-schedule-plugin
+[![Tymly Package](https://img.shields.io/badge/tymly-package-blue.svg)](https://tymly.io/)
+[![npm (scoped)](https://img.shields.io/npm/v/@wmfs/tymly-schedule-plugin.svg)](https://www.npmjs.com/package/@wmfs/tymly-schedule-plugin)
+[![CircleCI](https://circleci.com/gh/wmfs/tymly-schedule-plugin.svg?style=svg)](https://circleci.com/gh/wmfs/tymly-schedule-plugin)[![codecov](https://codecov.io/gh/wmfs/tymly-schedule-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/tymly-schedule-plugin)
+[![CodeFactor](https://www.codefactor.io/repository/github/wmfs/tymly-schedule-plugin/badge)](https://www.codefactor.io/repository/github/wmfs/tymly-schedule-plugin)
+[![Dependabot badge](https://img.shields.io/badge/Dependabot-active-brightgreen.svg)](https://dependabot.com/)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly-schedule-plugin/blob/master/LICENSE)
+
+> Provides state machine scheduling for the Tymly framework
+
+## <a name="install"></a>Install
+```bash
+$ npm install tymly-schedule-plugin --save
+```
+
+
+## <a name="license"></a>License
+
+MIT

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

@@ -0,0 +1,9 @@
+{
+  "name": "schedule",
+  "namespace": "schedule",
+  "version": "2.171.0",
+  "label": "Tymly schedule plugin for scheduling state machines",
+  "author": "WMFS",
+  "description": "Tymly schedule plugin for scheduling state machines",
+  "tags": []
+}

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

@@ -0,0 +1,56 @@
+{
+  "title": "State machine schedules",
+  "description": "Stores schedule configuration for state machines",
+  "type": "object",
+  "primaryKey": [
+    "key"
+  ],
+  "properties": {
+    "key": {
+      "type": "string"
+    },
+    "stateMachineName": {
+      "type": "string"
+    },
+    "input": {
+      "type": "object"
+    },
+    "sendResponse": {
+      "type": "string"
+    },
+    "scheduleType": {
+      "type": "string",
+      "enum": [
+        "interval",
+        "datetime"
+      ]
+    },
+    "interval": {
+      "type": "string"
+    },
+    "datetime": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "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/components/services/schedule/doc/index.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = {
+  description: 'Tymly Schedule Service'
+}

package/lib/components/services/schedule/index.js

@@ -0,0 +1,225 @@
+const nodeSchedule = require('node-schedule')
+const ruleToDatetime = require('./utils/rule-to-datetime')
+const datetimeToRule = require('./utils/datetime-to-rule')
+
+class CronService {
+  async boot (options) {
+    this.statebox = options.bootedServices.statebox
+    this.taskModel = options.bootedServices.storage.models.schedule_task
+    this.scheduledTasks = await this.findTasks(options.blueprintComponents.stateMachineSchedules)
+
+    for (const [key, task] of Object.entries(this.scheduledTasks)) {
+      if (task.startOnBoot === true) {
+        await this.startTask(key)
+      }
+    }
+  } // boot
+
+  startTask (key) {
+    const task = this.scheduledTasks[key]
+
+    if (!task) {
+      console.log(`Cannot find schedule task to start '${key}'`)
+      return
+    }
+
+    const {
+      scheduleType,
+      interval,
+      datetime,
+      stateMachineName,
+      sendResponse,
+      input
+    } = task
+
+    const jobOptions = {
+      tz: 'UTC'
+    }
+
+    if (scheduleType === 'interval') {
+      jobOptions.rule = interval
+    } else if (scheduleType === 'datetime') {
+      const rule = datetimeToRule(datetime)
+
+      Object
+        .entries(rule)
+        .forEach(([key, value]) => {
+          jobOptions[key] = value
+        })
+    }
+
+    // todo: allow window for start/end datetimes
+
+    task.job = nodeSchedule.scheduleJob(
+      jobOptions,
+      () => {
+        console.log(`Running scheduled state machine ${stateMachineName}`)
+        const startedAt = new Date()
+        const executionOptions = {
+          instigatingClient: {
+            appName: 'tymly',
+            domain: 'tymly-schedule-plugin'
+          },
+          sendResponse
+        }
+        const cb = async (err, executionDescription) => {
+          if (err) {
+            console.log(`There was an error on execution of scheduled state machine ${stateMachineName}`)
+          }
+          await this.updateTaskOnExecution(key, executionDescription.executionName, startedAt)
+        }
+        this.statebox.startExecution(input, stateMachineName, executionOptions, cb)
+      }
+    )
+
+    this.scheduledTasks[key] = task
+
+    return this.updateTaskStatus(key, 'STARTED')
+  } // startTask
+
+  stopTask (key) {
+    const task = this.scheduledTasks[key]
+
+    if (!task) {
+      console.log(`Cannot find schedule task to stop '${key}'`)
+      return
+    }
+
+    if (!task.job) {
+      console.log(`Cannot find job on task to stop '${key}'`)
+      return
+    }
+
+    task.job.cancel()
+
+    return this.updateTaskStatus(key, 'STOPPED')
+  } // stopTask
+
+  updateTaskStatus (key, status) {
+    return this.taskModel.update(
+      {
+        key,
+        status
+      },
+      {
+        setMissingPropertiesToNull: false
+      }
+    )
+  }
+
+  stopTasks () {
+    return Promise.all(
+      Object.keys(this.scheduledTasks).map(key => this.stopTask(key))
+    )
+  } // stopTasks
+
+  async findTasks (blueprintTasks) {
+    const tasks = {}
+
+    // From database
+    const persistedTasks = await this.taskModel.find({})
+
+    for (const config of persistedTasks) {
+      tasks[config.key] = config
+    }
+
+    // From blueprint
+    for (const [key, config] of Object.entries(blueprintTasks)) {
+      if (tasks[key]) {
+        continue
+      }
+
+      // todo: recurrence rules?
+
+      if (typeof config.interval === 'string') {
+        config.scheduleType = 'interval'
+        config.datetime = null
+      } else if (typeof config.rule === 'object') {
+        config.scheduleType = 'datetime'
+        config.datetime = ruleToDatetime(config.rule)
+        config.interval = null
+      }
+
+      tasks[key] = config
+
+      await this.persistTask(key, config)
+    }
+
+    return tasks
+  } // findTasks
+
+  persistTask (key, config) {
+    return this.taskModel.create({
+      key,
+      stateMachineName: config.stateMachineName,
+      input: config.input,
+      sendResponse: config.sendResponse,
+      scheduleType: config.scheduleType,
+      interval: config.interval,
+      datetime: config.datetime,
+      startOnBoot: config.startOnBoot,
+      lastRanStart: null,
+      lastRanEnd: null,
+      lastRanExecutionName: null,
+      totalRunCount: 0,
+      status: null
+    })
+  }
+
+  async updateTaskOnExecution (key, executionName, startedAt) {
+    const { totalRunCount } = await this.taskModel.findOne(
+      {
+        where: { key: { equals: key } },
+        fields: ['totalRunCount']
+      }
+    )
+
+    return this.taskModel.update(
+      {
+        key,
+        lastRanStart: startedAt,
+        lastRanEnd: new Date(),
+        lastRanExecutionName: executionName,
+        totalRunCount: totalRunCount + 1
+      },
+      {
+        setMissingPropertiesToNull: false
+      }
+    )
+  }
+
+  async stopAndUpdateTaskSchedule (key, rule) {
+    await this.stopTask(key)
+
+    if (typeof rule === 'string') {
+      this.scheduledTasks[key].interval = rule
+      this.scheduledTasks[key].datetime = null
+      this.scheduledTasks[key].scheduleType = 'interval'
+    } else if (typeof rule === 'object') {
+      this.scheduledTasks[key].interval = null
+      this.scheduledTasks[key].datetime = ruleToDatetime(rule)
+      this.scheduledTasks[key].scheduleType = 'datetime'
+    }
+
+    return this.taskModel.update(
+      {
+        key,
+        interval: this.scheduledTasks[key].interval,
+        datetime: this.scheduledTasks[key].datetime,
+        scheduleType: this.scheduledTasks[key].scheduleType
+      },
+      {
+        setMissingPropertiesToNull: false
+      }
+    )
+  }
+
+  async shutdown () {
+    await nodeSchedule.gracefulShutdown()
+  } // shutdown
+} // class CronService
+
+module.exports = {
+  serviceClass: CronService,
+  bootAfter: ['statebox']
+}

package/lib/components/services/schedule/utils/datetime-to-rule.js

@@ -0,0 +1,14 @@
+module.exports = function (datetime) {
+  if (!(datetime instanceof Date)) {
+    datetime = new Date()
+  }
+
+  return {
+    year: datetime.getFullYear(),
+    month: datetime.getMonth(),
+    date: datetime.getDate(),
+    hour: datetime.getHours(),
+    minute: datetime.getMinutes(),
+    second: datetime.getSeconds()
+  }
+}

package/lib/components/services/schedule/utils/rule-to-datetime.js

@@ -0,0 +1,11 @@
+module.exports = function (rule = {}) {
+  const now = new Date()
+  return new Date(
+    isNaN(rule.year) ? now.getFullYear() : rule.year,
+    isNaN(rule.month) ? now.getMonth() : rule.month,
+    isNaN(rule.date) ? now.getDate() : rule.date,
+    isNaN(rule.hour) ? now.getHours() : rule.hour,
+    isNaN(rule.minute) ? now.getMinutes() : rule.minute,
+    isNaN(rule.second) ? now.getSeconds() : rule.second
+  )
+}

package/lib/index.js

@@ -0,0 +1,2 @@
+'use strict'
+module.exports = {}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@wmfs/tymly-schedule-plugin",
+  "version": "1.0.0",
+  "description": "Provides state machine scheduling for the Tymly framework",
+  "homepage": "https://github.com/wmfs/tymly-schedule-plugin#readme",
+  "author": "West Midlands Fire Service",
+  "keywords": [
+    "tymly",
+    "plugin",
+    "task",
+    "scheduling",
+    "schedule",
+    "cron"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wmfs/tymly-schedule-plugin.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wmfs/tymly-schedule-plugin/issues"
+  },
+  "main": "./lib/index.js",
+  "dependencies": {
+    "node-schedule": "2.1.0"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/exec": "6.0.3",
+    "@semantic-release/git": "10.0.1",
+    "@wmfs/tymly": "1.235.1",
+    "@wmfs/tymly-pg-plugin": "1.268.0",
+    "chai": "4.3.6",
+    "codecov": "3.8.3",
+    "conventional-changelog-metahub": "4.0.1",
+    "cz-conventional-changelog": "3.3.0",
+    "dirty-chai": "2.0.1",
+    "mocha": "9.2.2",
+    "moment": "2.29.1",
+    "nyc": "15.1.0",
+    "semantic-release": "19.0.2",
+    "standard": "16.0.4"
+  },
+  "scripts": {
+    "lint": "standard",
+    "test": "nyc mocha",
+    "coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
+    "semantic-release": "semantic-release"
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    },
+    "tymly": {
+      "sync": false
+    }
+  },
+  "publishConfig": {
+    "access": "restricted"
+  }
+}

package/plugin.json

@@ -0,0 +1,13 @@
+{
+  "name": "schedule-plugin",
+  "version": "1.0.0",
+  "label": "Tymly Schedule Plugin",
+  "author": "WMFS",
+  "organisation": "West Midlands Fire Service",
+  "description": "Provides state machine scheduling for the Tymly framework",
+  "categories": [
+    "cron",
+    "scheduling",
+    "schedule"
+  ]
+}

package/renovate.json

@@ -0,0 +1,26 @@
+{
+  "extends": [
+    "config:base"
+  ],
+  "dependencyDashboard": true,
+  "enabledManagers": ["npm"],
+  "packageRules": [
+    {
+      "matchDepTypes": ["devDependencies"],
+      "automerge": true,
+      "semanticCommitType": "build",
+      "semanticCommitScope": "deps-dev",
+      "labels": ["devDependencies"]
+    },
+    {
+      "matchDepTypes": ["dependencies"],
+      "semanticCommitType": "build",
+      "semanticCommitScope": "deps",
+      "labels": ["dependencies"],
+      "reviewers": ["team:tymly-reviewers"]
+    }
+  ],
+    "vulnerabilityAlerts": {
+    "labels": ["security"]
+  }
+}

package/test/fixtures/cats-blueprint/blueprint.json

@@ -0,0 +1,14 @@
+{
+
+  "namespace": "tymlyTest",
+  "name": "cats",
+  "version": "1.0",
+
+  "label": "Cats",
+  "author": "WMFS",
+
+  "organisation": "Tymlys",
+  "description": "An example Tymly Blueprint to help model cat behaviour...",
+  "categories": ["cats", "pets"]
+
+}

package/test/fixtures/cats-blueprint/functions/random-number.js

@@ -0,0 +1,7 @@
+module.exports = function () {
+  return function () {
+    const min = 1
+    const max = 10
+    return Math.floor(Math.random() * (max - min + 1) + min)
+  }
+}

package/test/fixtures/cats-blueprint/models/cat-stats.json

@@ -0,0 +1,10 @@
+{
+  "properties": {
+    "happinessLevel": {
+      "type": "integer"
+    },
+    "hungerLevel": {
+      "type": "integer"
+    }
+  }
+}

package/test/fixtures/cats-blueprint/state-machine-schedules/two-second-cat-updates.json

@@ -0,0 +1,7 @@
+{
+  "startOnBoot": true,
+  "interval": "*/2 * * * * *",
+  "input": {},
+  "stateMachineName": "tymlyTest_sendCatUpdate",
+  "sendResponse": "COMPLETE"
+}

package/test/fixtures/cats-blueprint/state-machines/send-cat-update.json

@@ -0,0 +1,35 @@
+{
+  "Comment": "Send cat update",
+  "StartAt": "HappinessLevel",
+  "States": {
+    "HappinessLevel": {
+      "Type": "Task",
+      "Resource": "function:tymlyTest_randomNumber",
+      "ResultPath": "$.happinessLevel",
+      "Next": "HungerLevel"
+    },
+    "HungerLevel": {
+      "Type": "Task",
+      "Resource": "function:tymlyTest_randomNumber",
+      "ResultPath": "$.hungerLevel",
+      "Next": "Upserting"
+    },
+    "Upserting": {
+      "Type": "Task",
+      "InputPath": "$",
+      "Resource": "module:upserting",
+      "ResourceConfig": {
+        "modelId": "tymlyTest_catStats"
+      },
+      "End": true
+    }
+  },
+  "restrictions": [
+    {
+      "roleId": "$everyone",
+      "allows": [
+        "*"
+      ]
+    }
+  ]
+}

package/test/fixtures/cats-blueprint/state-machines/set-tiredness-level.json

@@ -0,0 +1,29 @@
+{
+  "Comment": "Send cat update",
+  "StartAt": "TirednessLevel",
+  "States": {
+    "TirednessLevel": {
+      "Type": "Task",
+      "Resource": "function:tymlyTest_randomNumber",
+      "ResultPath": "$.tirednessLevel",
+      "Next": "Upserting"
+    },
+    "Upserting": {
+      "Type": "Task",
+      "InputPath": "$",
+      "Resource": "module:upserting",
+      "ResourceConfig": {
+        "modelId": "tymlyTest_catStats"
+      },
+      "End": true
+    }
+  },
+  "restrictions": [
+    {
+      "roleId": "$everyone",
+      "allows": [
+        "*"
+      ]
+    }
+  ]
+}

package/test/rule-to-datetime-tests.js

@@ -0,0 +1,103 @@
+/* eslint-env mocha */
+
+const expect = require('chai').expect
+
+const ruleToDatetime = require('../lib/components/services/schedule/utils/rule-to-datetime')
+const datetimeToRule = require('../lib/components/services/schedule/utils/datetime-to-rule')
+
+describe('Rule to datetime tests', function () {
+  it('No options, should default to now', () => {
+    const now = new Date()
+    const datetime = ruleToDatetime()
+
+    expect(datetime.getFullYear()).to.eql(now.getFullYear())
+    expect(datetime.getMonth()).to.eql(now.getMonth())
+    expect(datetime.getDate()).to.eql(now.getDate())
+    expect(datetime.getHours()).to.eql(now.getHours())
+    expect(datetime.getMinutes()).to.eql(now.getMinutes())
+    expect(datetime.getSeconds()).to.eql(now.getSeconds())
+  })
+
+  it('Year only, the rest defaults to now', () => {
+    const now = new Date()
+    const year = now.getFullYear() + 2
+
+    const datetime = ruleToDatetime({ year })
+
+    expect(datetime.getFullYear()).to.eql(year)
+    expect(datetime.getMonth()).to.eql(now.getMonth())
+    expect(datetime.getDate()).to.eql(now.getDate())
+    expect(datetime.getHours()).to.eql(now.getHours())
+    expect(datetime.getMinutes()).to.eql(now.getMinutes())
+    expect(datetime.getSeconds()).to.eql(now.getSeconds())
+  })
+
+  it('All options passed in as integers', () => {
+    const rule = {
+      year: 2020,
+      month: 1,
+      date: 2,
+      hour: 12,
+      minute: 30,
+      second: 0
+    }
+
+    const datetime = ruleToDatetime(rule)
+
+    expect(datetime.getFullYear()).to.eql(rule.year)
+    expect(datetime.getMonth()).to.eql(rule.month)
+    expect(datetime.getDate()).to.eql(rule.date)
+    expect(datetime.getHours()).to.eql(rule.hour)
+    expect(datetime.getMinutes()).to.eql(rule.minute)
+    expect(datetime.getSeconds()).to.eql(rule.second)
+  })
+
+  it('All options passed in as strings', () => {
+    const rule = {
+      year: '2020',
+      month: '1',
+      date: '2',
+      hour: '12',
+      minute: '30',
+      second: '0'
+    }
+
+    const datetime = ruleToDatetime(rule)
+
+    expect(datetime.getFullYear().toString()).to.eql(rule.year)
+    expect(datetime.getMonth().toString()).to.eql(rule.month)
+    expect(datetime.getDate().toString()).to.eql(rule.date)
+    expect(datetime.getHours().toString()).to.eql(rule.hour)
+    expect(datetime.getMinutes().toString()).to.eql(rule.minute)
+    expect(datetime.getSeconds().toString()).to.eql(rule.second)
+  })
+})
+
+describe('Datetime to rule tests', function () {
+  it('No options, should default to now', () => {
+    const now = new Date()
+    const rule = datetimeToRule()
+
+    expect(rule.year).to.eql(now.getFullYear())
+    expect(rule.month).to.eql(now.getMonth())
+    expect(rule.date).to.eql(now.getDate())
+    expect(rule.hour).to.eql(now.getHours())
+    expect(rule.minute).to.eql(now.getMinutes())
+    expect(rule.second).to.eql(now.getSeconds())
+  })
+
+  it('Specific year, the rest should default to now', () => {
+    const datetime = new Date()
+    const year = datetime.getFullYear() + 2
+    datetime.setFullYear(year)
+
+    const rule = datetimeToRule(datetime)
+
+    expect(rule.year).to.eql(year)
+    expect(rule.month).to.eql(datetime.getMonth())
+    expect(rule.date).to.eql(datetime.getDate())
+    expect(rule.hour).to.eql(datetime.getHours())
+    expect(rule.minute).to.eql(datetime.getMinutes())
+    expect(rule.second).to.eql(datetime.getSeconds())
+  })
+})

package/test/schedule-tests.js

@@ -0,0 +1,198 @@
+/* eslint-env mocha */
+
+const expect = require('chai').expect
+const tymly = require('@wmfs/tymly')
+const path = require('path')
+
+const scheduleKey = 'tymlyTest_twoSecondCatUpdates'
+
+describe('Tymly schedule tests', function () {
+  this.timeout(60000) // 60 second timeout
+
+  before(function () {
+    if (process.env.PG_CONNECTION_STRING && !/^postgres:\/\/[^:]+:[^@]+@(?:localhost|127\.0\.0\.1).*$/.test(process.env.PG_CONNECTION_STRING)) {
+      console.log(`Skipping tests due to unsafe PG_CONNECTION_STRING value (${process.env.PG_CONNECTION_STRING})`)
+      this.skip()
+    }
+  })
+
+  let tymlyService
+  let scheduleService
+  // let statebox
+  let catStatsModel
+  // let executionsModel
+  let taskModel
+  let client
+
+  let lastRunCount
+
+  it('boot Tymly', async () => {
+    const tymlyServices = await tymly.boot(
+      {
+        blueprintPaths: [
+          path.resolve(__dirname, './fixtures/cats-blueprint')
+        ],
+        pluginPaths: [
+          path.resolve(__dirname, '..'),
+          require.resolve('@wmfs/tymly-pg-plugin')
+        ]
+      }
+    )
+
+    tymlyService = tymlyServices.tymly
+    scheduleService = tymlyServices.schedule
+    // statebox = tymlyServices.statebox
+    taskModel = tymlyServices.storage.models.schedule_task
+    catStatsModel = tymlyServices.storage.models.tymlyTest_catStats
+    // executionsModel = tymlyServices.storage.models.tymly_execution
+    client = tymlyServices.storage.client
+
+    const catStats = await catStatsModel.find({})
+    expect(catStats.length).to.eql(0)
+  })
+
+  it('check the task has persisted to the database', async () => {
+    const tasks = await taskModel.find({})
+    expect(tasks.length).to.eql(1)
+    expect(tasks[0].scheduleType).to.eql('interval')
+    expect(tasks[0].interval).to.eql('*/2 * * * * *')
+    expect(tasks[0].datetime).to.eql(null)
+    expect(tasks[0].status).to.eql('STARTED')
+  })
+
+  it('wait 10 seconds, let the updates run for a bit', done => setTimeout(done, 10000))
+
+  it('stop cat updates', async () => {
+    await scheduleService.stopTask(scheduleKey)
+  })
+
+  it('check the state machine has run multiple times', async () => {
+    const tasks = await taskModel.find({})
+    expect(tasks.length).to.eql(1)
+    expect(tasks[0].scheduleType).to.eql('interval')
+    expect(tasks[0].interval).to.eql('*/2 * * * * *')
+    expect(tasks[0].datetime).to.eql(null)
+    expect(tasks[0].status).to.eql('STOPPED')
+
+    const { totalRunCount } = tasks[0]
+
+    lastRunCount = totalRunCount
+
+    // Waited 10 seconds and runs every 2 seconds so can be 5 or 6
+    expect(lastRunCount).to.be.greaterThanOrEqual(5)
+    expect(lastRunCount).to.be.lessThanOrEqual(6)
+
+    const catStats = await catStatsModel.find({})
+    expect(catStats.length).to.eql(lastRunCount)
+  })
+
+  it('wait 5 seconds', done => setTimeout(done, 5000))
+
+  it('ensure scheduled task has not run again', async () => {
+    const tasks = await taskModel.find({})
+    expect(tasks.length).to.eql(1)
+    expect(tasks[0].scheduleType).to.eql('interval')
+    expect(tasks[0].interval).to.eql('*/2 * * * * *')
+    expect(tasks[0].datetime).to.eql(null)
+    expect(tasks[0].status).to.eql('STOPPED')
+
+    expect(tasks[0].totalRunCount).to.eql(lastRunCount)
+
+    const catStats = await catStatsModel.find({})
+    expect(catStats.length).to.eql(lastRunCount)
+  })
+
+  it('update task to specific date/time', async () => {
+    const datetime = new Date()
+    datetime.setSeconds(datetime.getSeconds() + 10)
+
+    await scheduleService.stopAndUpdateTaskSchedule(
+      scheduleKey,
+      {
+        year: datetime.getFullYear(),
+        month: datetime.getMonth(),
+        date: datetime.getDate(),
+        hour: datetime.getHours(),
+        minute: datetime.getMinutes(),
+        second: datetime.getSeconds()
+      }
+    )
+
+    await scheduleService.startTask(scheduleKey)
+  })
+
+  it('wait 15 seconds', done => setTimeout(done, 15000))
+
+  it('check the state machine has run once more', async () => {
+    lastRunCount++
+
+    const tasks = await taskModel.find({})
+    expect(tasks.length).to.eql(1)
+    expect(tasks[0].interval).to.eql(null)
+    expect(tasks[0].datetime).to.not.eql(null)
+    expect(tasks[0].scheduleType).to.eql('datetime')
+    expect(tasks[0].totalRunCount).to.eql(lastRunCount)
+    expect(tasks[0].status).to.eql('STARTED')
+
+    const catStats = await catStatsModel.find({})
+    expect(catStats.length).to.eql(lastRunCount)
+  })
+
+  it('wait 10 seconds', done => setTimeout(done, 10000))
+
+  it('ensure scheduled task has not run again', async () => {
+    const tasks = await taskModel.find({})
+    expect(tasks.length).to.eql(1)
+    expect(tasks[0].status).to.eql('STARTED')
+
+    expect(tasks[0].totalRunCount).to.eql(lastRunCount)
+
+    const catStats = await catStatsModel.find({})
+    expect(catStats.length).to.eql(lastRunCount)
+  })
+
+  it('shutdown Tymly', async () => {
+    await tymlyService.shutdown()
+  })
+
+  it('re-boot tymly', async () => {
+    const tymlyServices = await tymly.boot(
+      {
+        blueprintPaths: [
+          path.resolve(__dirname, './fixtures/cats-blueprint')
+        ],
+        pluginPaths: [
+          path.resolve(__dirname, '..'),
+          require.resolve('@wmfs/tymly-pg-plugin')
+        ]
+      }
+    )
+
+    tymlyService = tymlyServices.tymly
+    scheduleService = tymlyServices.schedule
+    taskModel = tymlyServices.storage.models.schedule_task
+    catStatsModel = tymlyServices.storage.models.tymlyTest_catStats
+    client = tymlyServices.storage.client
+  })
+
+  it('check blueprint tasks not overwritten updates', async () => {
+    const tasks = await taskModel.find({})
+    expect(tasks.length).to.eql(1)
+    expect(tasks[0].key).to.eql(scheduleKey)
+    expect(tasks[0].stateMachineName).to.eql('tymlyTest_sendCatUpdate')
+    expect(tasks[0].scheduleType).to.eql('datetime')
+    expect(tasks[0].interval).to.eql(null)
+    expect(tasks[0].status).to.eql('STARTED')
+    expect(tasks[0].totalRunCount).to.eql(lastRunCount)
+  })
+
+  it('clean up data', async () => {
+    await client.query('DROP SCHEMA tymly CASCADE;')
+    await client.query('DROP SCHEMA tymly_test CASCADE;')
+    await client.query('DROP SCHEMA schedule CASCADE;')
+  })
+
+  it('shutdown Tymly again', async () => {
+    await tymlyService.shutdown()
+  })
+})

package/version_plugin

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+. .version
+echo $VERSION
+version=$VERSION
+sudo apt-get install jq
+sudo jq --arg version "$version" '.version=$version' plugin.json > plugin_edit.json && mv plugin_edit.json plugin.json
+git config --global user.name "$GIT_COMMITTER_NAME"
+git config --global user.email "$GIT_COMMITTER_EMAIL"
+git remote set-url origin https://${GIT_COMMITTER_NAME}:${GH_TOKEN}@github.com/wmfs/tymly-schedule-plugin.git
+git checkout master
+git add plugin.json
+git commit -m "chore(version): plugin $version [skip ci]"
+git push