@wmfs/tymly-schedule-plugin 1.5.0 → 1.6.1

package/.circleci/config.yml

@@ -10,7 +10,7 @@ jobs:
           TZ: "Europe/London"
           PG_CONNECTION_STRING: postgres://postgres:postgres@localhost:5432/circle_test
           TIMEOUT: 15000
-      - image: cimg/postgres:15.1-postgis
+      - image: cimg/postgres:15.2-postgis
         auth:
           username: $DOCKERHUB_USERNAME
           password: $DOCKERHUB_PASSWORD

package/.version

@@ -1 +1 @@
-VERSION=1.5.0
+VERSION=1.6.1

package/CHANGELOG.md

@@ -1,3 +1,57 @@
+## [1.6.1](https://github.com/wmfs/tymly-schedule-plugin/compare/v1.6.0...v1.6.1) (2023-06-07)
+
+
+### 🐛 Bug Fixes
+
+* better utc handling with consequent test updates ([d15c042](https://github.com/wmfs/tymly-schedule-plugin/commit/d15c042987ebb61fb382eedb057413d718e825ea))
+
+
+### 🛠 Builds
+
+* **deps-dev:** update dependency [@wmfs](https://github.com/wmfs)/tymly-pg-plugin to v1.283.0 ([3322021](https://github.com/wmfs/tymly-schedule-plugin/commit/332202187f248defb6a68403dec428e9176efdbb))
+* **deps-dev:** update dependency semantic-release to v21.0.3 ([b2da7ba](https://github.com/wmfs/tymly-schedule-plugin/commit/b2da7babde8a45e0d899870ee5b4021c8a662d3b))
+* **deps-dev:** update dependency standard to v17.1.0 ([f7def04](https://github.com/wmfs/tymly-schedule-plugin/commit/f7def04f6abdb127fb0aa6ad02cc7b069480dee9))
+
+
+### 📦 Code Refactoring
+
+* renamed vars to improve clarity ([4ed331c](https://github.com/wmfs/tymly-schedule-plugin/commit/4ed331c0edbbd3740e72b18961122d2710ce4e39))
+
+
+### 🚨 Tests
+
+* minor change from let to const for standard ([e81e5de](https://github.com/wmfs/tymly-schedule-plugin/commit/e81e5dec130e9d35ad9460a316a3bce42ea9fcfc))
+* restored tests that were inadvertantly removed ([843e6d5](https://github.com/wmfs/tymly-schedule-plugin/commit/843e6d5e0ddd9e5046e39df8ff068e489e7fdfd7))
+
+# [1.6.0](https://github.com/wmfs/tymly-schedule-plugin/compare/v1.5.0...v1.6.0) (2023-06-06)
+
+
+### ✨ Features
+
+* updated schema for cardscript files ([02156dc](https://github.com/wmfs/tymly-schedule-plugin/commit/02156dc4efbc13795523ed130de1ad3144e932fe))
+
+
+### 🐛 Bug Fixes
+
+* fixed bug with scheduling an event at a timestamp, to account for timezone offset ([a4b561b](https://github.com/wmfs/tymly-schedule-plugin/commit/a4b561b5592f3bb59b1f1399ac95d87b47b1dc3d))
+* moved moment dep from dev dependencies to main dependencies as serice class uses it ([0d39fca](https://github.com/wmfs/tymly-schedule-plugin/commit/0d39fcad9274c68a04251c98184439d8403b2230))
+
+
+### 🛠 Builds
+
+* **deps-dev:** update dependency [@semantic-release](https://github.com/semantic-release)/changelog to v6.0.3 ([b36f0c4](https://github.com/wmfs/tymly-schedule-plugin/commit/b36f0c4fbcc3c1d3a5f5c614f74c0640e1196791))
+* **deps-dev:** update dependency [@wmfs](https://github.com/wmfs)/tymly-pg-plugin to v1.277.0 ([1af6de4](https://github.com/wmfs/tymly-schedule-plugin/commit/1af6de41da845a565a656b8facd31874fc1ee6d1))
+* **deps-dev:** update dependency [@wmfs](https://github.com/wmfs)/tymly-pg-plugin to v1.278.0 ([befcf37](https://github.com/wmfs/tymly-schedule-plugin/commit/befcf37d7a756e0ca9a19393c4d1870fc8857e53))
+* **deps-dev:** update dependency [@wmfs](https://github.com/wmfs)/tymly-pg-plugin to v1.282.0 ([a9dc578](https://github.com/wmfs/tymly-schedule-plugin/commit/a9dc5789864b9fab522d7a44d830f4679bb93af8))
+* **deps-dev:** update dependency semantic-release to v20.1.1 ([c825925](https://github.com/wmfs/tymly-schedule-plugin/commit/c8259255193dde8730188686542f8da785f319a0))
+* **deps-dev:** update dependency semantic-release to v20.1.3 ([eb9d5ee](https://github.com/wmfs/tymly-schedule-plugin/commit/eb9d5eec5a10356ffefebb0837800aa7d752cbfe))
+* **deps-dev:** update dependency semantic-release to v21 ([cbe91b5](https://github.com/wmfs/tymly-schedule-plugin/commit/cbe91b5118564c1cbb9f43854a611934efc60289))
+
+
+### ⚙️ Continuous Integrations
+
+* **circle:** update postgres to 15.2-postgis [sc-19693] ([a7e5b6c](https://github.com/wmfs/tymly-schedule-plugin/commit/a7e5b6cc54612947118887e15647caf62174e172))
+
 # [1.5.0](https://github.com/wmfs/tymly-schedule-plugin/compare/v1.4.0...v1.5.0) (2023-02-17)
 
 

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

@@ -4,19 +4,6 @@
     "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": [
     {
@@ -92,6 +79,19 @@
       "title": "Submit"
     }
   ],
-  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+  "hooks": {
+    "afterSubmit": {
+      "actions": [
+        {
+          "type": "Action.PushCard",
+          "stateMachineName": "schedule_viewScheduledTask_1_0",
+          "input": {
+            "key": "$.key"
+          }
+        }
+      ]
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/wmfs/cardscript-schema/master/lib/schema.json",
   "version": "1.0"
 }

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

@@ -31,6 +31,6 @@
       ]
     }
   ],
-  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+  "$schema": "https://raw.githubusercontent.com/wmfs/cardscript-schema/master/lib/schema.json",
   "version": "1.0"
 }

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

@@ -143,6 +143,6 @@
       ]
     }
   ],
-  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+  "$schema": "https://raw.githubusercontent.com/wmfs/cardscript-schema/master/lib/schema.json",
   "version": "1.0"
 }

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

@@ -1,8 +1,8 @@
 const INSTIGATING_CLIENT_DOMAIN = 'tymly-schedule-plugin'
 
 const nodeSchedule = require('node-schedule')
-const ruleToDatetime = require('./utils/rule-to-datetime')
-const datetimeToRule = require('./utils/datetime-to-rule')
+const ruleToUTCDateTime = require('./utils/rule-to-datetime')
+const localDateTimeToUTCRule = require('./utils/datetime-to-rule')
 const { v4: uuidv4 } = require('uuid')
 
 class CronService {
@@ -45,7 +45,7 @@ class CronService {
     if (scheduleType === 'interval') {
       jobOptions.rule = interval
     } else if (scheduleType === 'datetime') {
-      const rule = datetimeToRule(datetime)
+      const rule = localDateTimeToUTCRule(datetime)
 
       Object
         .entries(rule)
@@ -58,7 +58,7 @@ class CronService {
     task.job = nodeSchedule.scheduleJob(
       jobOptions,
       () => {
-        console.log(`Running scheduled state machine ${stateMachineName}`)
+        console.log(`Running scheduled state machine ${stateMachineName} at ${new Date()}`)
         const executionOptions = {
           instigatingClient: {
             appName: 'tymly',
@@ -145,7 +145,7 @@ class CronService {
         config.datetime = null
       } else if (typeof config.rule === 'object') {
         config.scheduleType = 'datetime'
-        config.datetime = ruleToDatetime(config.rule)
+        config.datetime = ruleToUTCDateTime(config.rule)
         config.interval = null
       }
 
@@ -219,7 +219,7 @@ class CronService {
       this.scheduledTasks[key].scheduleType = 'interval'
     } else if (typeof rule === 'object') {
       this.scheduledTasks[key].interval = null
-      this.scheduledTasks[key].datetime = ruleToDatetime(rule)
+      this.scheduledTasks[key].datetime = ruleToUTCDateTime(rule)
       this.scheduledTasks[key].scheduleType = 'datetime'
     }
 

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

@@ -5,6 +5,9 @@ module.exports = function (datetime) {
     datetime = new Date()
   }
 
+  // convert local time back to UTC
+  datetime = moment(datetime).utc()
+
   return {
     year: moment(datetime).year(),
     month: moment(datetime).month(),

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

@@ -1,6 +1,8 @@
+const moment = require('moment')
+
 module.exports = function (rule = {}) {
   const now = new Date()
-  return new Date(
+  const date = new Date(
     isNaN(rule.year) ? now.getFullYear() : rule.year,
     isNaN(rule.month) ? now.getMonth() : rule.month,
     isNaN(rule.date) ? now.getDate() : rule.date,
@@ -8,4 +10,8 @@ module.exports = function (rule = {}) {
     isNaN(rule.minute) ? now.getMinutes() : rule.minute,
     isNaN(rule.second) ? now.getSeconds() : rule.second
   )
+  // note that rule does not specify a timezone, so we have to assume that
+  // the timestamp provided is a local timestamp - as such, we have to convert
+  // to UTC
+  return moment(date).utc().toDate()
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wmfs/tymly-schedule-plugin",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "Provides state machine scheduling for the Tymly framework",
   "homepage": "https://github.com/wmfs/tymly-schedule-plugin#readme",
   "author": "West Midlands Fire Service",
@@ -23,14 +23,15 @@
   "main": "./lib/index.js",
   "dependencies": {
     "node-schedule": "2.1.1",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.0",
+    "moment": "2.29.4"
   },
   "devDependencies": {
-    "@semantic-release/changelog": "6.0.2",
+    "@semantic-release/changelog": "6.0.3",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@wmfs/tymly": "1.242.0",
-    "@wmfs/tymly-pg-plugin": "1.276.0",
+    "@wmfs/tymly-pg-plugin": "1.283.0",
     "@wmfs/tymly-test-helpers": "1.22.2",
     "chai": "4.3.7",
     "codecov": "3.8.3",
@@ -38,10 +39,9 @@
     "cz-conventional-changelog": "3.3.0",
     "dirty-chai": "2.0.1",
     "mocha": "10.2.0",
-    "moment": "2.29.4",
     "nyc": "15.1.0",
-    "semantic-release": "20.1.0",
-    "standard": "17.0.0"
+    "semantic-release": "21.0.3",
+    "standard": "17.1.0"
   },
   "scripts": {
     "lint": "standard",

package/plugin.json

@@ -1,6 +1,6 @@
 {
   "name": "schedule-plugin",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "label": "Tymly Schedule Plugin",
   "author": "WMFS",
   "organisation": "West Midlands Fire Service",

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

@@ -7,10 +7,10 @@ const ruleToDatetime = require('../lib/components/services/schedule/utils/rule-t
 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()
+  it('No options, should default to now (UTC)', () => {
+    const now = moment().utc().toDate()
 
+    const datetime = ruleToDatetime()
     expect(datetime.getFullYear()).to.eql(now.getFullYear())
     expect(datetime.getMonth()).to.eql(now.getMonth())
     expect(datetime.getDate()).to.eql(now.getDate())
@@ -20,7 +20,8 @@ describe('Rule to datetime tests', function () {
   })
 
   it('Year only, the rest defaults to now', () => {
-    const now = new Date()
+    let now = new Date()
+    now = moment(now).utc().toDate()
     const year = now.getFullYear() + 2
 
     const datetime = ruleToDatetime({ year })
@@ -34,49 +35,55 @@ describe('Rule to datetime tests', function () {
   })
 
   it('All options passed in as integers', () => {
+    const now = new Date()
     const rule = {
-      year: 2020,
-      month: 1,
-      date: 2,
-      hour: 12,
-      minute: 30,
-      second: 0
+      year: now.getFullYear(),
+      month: now.getMonth(),
+      date: now.getDate(),
+      hour: now.getHours(),
+      minute: now.getMinutes(),
+      second: now.getSeconds()
     }
 
     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)
+    const utcTimestamp = moment(now).utc().toDate()
+
+    expect(datetime.getFullYear()).to.eql(utcTimestamp.getFullYear())
+    expect(datetime.getMonth()).to.eql(utcTimestamp.getMonth())
+    expect(datetime.getDate()).to.eql(utcTimestamp.getDate())
+    expect(datetime.getHours()).to.eql(utcTimestamp.getHours())
+    expect(datetime.getMinutes()).to.eql(utcTimestamp.getMinutes())
+    expect(datetime.getSeconds()).to.eql(utcTimestamp.getSeconds())
   })
 
   it('All options passed in as strings', () => {
+    const now = new Date()
     const rule = {
-      year: '2020',
-      month: '1',
-      date: '2',
-      hour: '12',
-      minute: '30',
-      second: '0'
+      year: '' + now.getFullYear(),
+      month: '' + now.getMonth(),
+      date: '' + now.getDate(),
+      hour: '' + now.getHours(),
+      minute: '' + now.getMinutes(),
+      second: '' + now.getSeconds()
     }
 
     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)
+    const utcTimestamp = moment(now).utc().toDate()
+
+    expect(datetime.getFullYear()).to.eql(utcTimestamp.getFullYear())
+    expect(datetime.getMonth()).to.eql(utcTimestamp.getMonth())
+    expect(datetime.getDate()).to.eql(utcTimestamp.getDate())
+    expect(datetime.getHours()).to.eql(utcTimestamp.getHours())
+    expect(datetime.getMinutes()).to.eql(utcTimestamp.getMinutes())
+    expect(datetime.getSeconds()).to.eql(utcTimestamp.getSeconds())
   })
 })
 
 describe('Datetime to rule tests', function () {
-  it('No options, should default to now', () => {
-    const now = moment()
+  it('No options, should default to now (UTC)', () => {
+    const now = moment().utc()
     const rule = datetimeToRule()
 
     expect(rule.year).to.eql(now.year())
@@ -87,47 +94,35 @@ describe('Datetime to rule tests', function () {
     expect(rule.second).to.eql(now.second())
   })
 
-  it('Specific year, the rest should default to now', () => {
-    let datetime = new Date()
-    const year = datetime.getFullYear() + 2
-    datetime.setFullYear(year)
-
-    const rule = datetimeToRule(datetime)
-    datetime = moment(datetime)
-
-    expect(rule.year).to.eql(year)
-    expect(rule.month).to.eql(datetime.month())
-    expect(rule.date).to.eql(datetime.date())
-    expect(rule.hour).to.eql(datetime.hour())
-    expect(rule.minute).to.eql(datetime.minute())
-    expect(rule.second).to.eql(datetime.second())
-  })
-
   it('DST test, should change time by +1 hour', () => {
-    const currentDateTime = new Date('Sunday March 27 2022 00:59:00')
+    const lastMinuteOfGMT = new Date('Sunday March 27 2022 00:59:00')
+    console.log(`last minute of GMT: ${lastMinuteOfGMT}`)
 
-    // 2022-03-27T02:00:00+01:00
-    const startDSTDateTime = moment(currentDateTime).add(1, 'minutes')
+    let startOfBSTDateTime = moment(lastMinuteOfGMT).add(1, 'minutes').toDate()
+    console.log(`start of BST: ${startOfBSTDateTime}`)
 
     // adding 1 min and setting as Date object
-    const rule = datetimeToRule(new Date(currentDateTime.getTime() + (60 * 1000)))
+    const rule = datetimeToRule(new Date(lastMinuteOfGMT.getTime() + (60 * 1000)))
 
-    expect(rule.date).to.eql(startDSTDateTime.date())
-    expect(rule.hour).to.eql(startDSTDateTime.hour())
-    expect(rule.minute).to.eql(startDSTDateTime.minute())
+    startOfBSTDateTime = moment(startOfBSTDateTime).utc()
+    expect(rule.date).to.eql(startOfBSTDateTime.date())
+    expect(rule.hour).to.eql(startOfBSTDateTime.hour())
+    expect(rule.minute).to.eql(startOfBSTDateTime.minute())
   })
 
   it('DST test, should change time by -1 hour', () => {
-    const currentDateTime = new Date('Sunday October 30 2022 01:59:00')
+    const lastMinuteOfBST = new Date('Sunday October 30 2022 01:59:00')
+    console.log(`last minute of BST: ${lastMinuteOfBST}`)
 
-    // 2022-10-30T01:00:00+00:00
-    const endDSTDateTime = moment(currentDateTime).add(1, 'minutes')
+    let startOfGMTDateTime = moment(lastMinuteOfBST).add(1, 'minutes').toDate()
+    console.log(`start of GMT: ${startOfGMTDateTime}`)
 
     // adding 1 min and setting as Date object
-    const rule = datetimeToRule(new Date(currentDateTime.getTime() + (60 * 1000)))
+    const rule = datetimeToRule(new Date(lastMinuteOfBST.getTime() + (60 * 1000)))
 
-    expect(rule.date).to.eql(endDSTDateTime.date())
-    expect(rule.hour).to.eql(endDSTDateTime.hour())
-    expect(rule.minute).to.eql(endDSTDateTime.minute())
+    startOfGMTDateTime = moment(startOfGMTDateTime).utc()
+    expect(rule.date).to.eql(startOfGMTDateTime.date())
+    expect(rule.hour).to.eql(startOfGMTDateTime.hour())
+    expect(rule.minute).to.eql(startOfGMTDateTime.minute())
   })
 })

package/test/schedule-tests.js

@@ -3,6 +3,7 @@
 const expect = require('chai').expect
 const tymly = require('@wmfs/tymly')
 const path = require('path')
+const moment = require('moment')
 
 const scheduleKey = 'tymlyTest_twoSecondCatUpdates'
 
@@ -100,8 +101,8 @@ describe('Tymly schedule tests', function () {
   })
 
   it('update task to specific date/time', async () => {
-    const datetime = new Date()
-    datetime.setSeconds(datetime.getSeconds() + 10)
+    const datetime = moment().utc().add(10, 'seconds').toDate()
+    console.log(`scheduled: ${datetime}`)
 
     await scheduleService.stopAndUpdateTaskSchedule(
       scheduleKey,