@wmfs/tymly-schedule-plugin 1.5.0 → 1.6.0

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.0

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+# [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/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,9 @@ 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.  note that in British Summer Time (for example, on the 5th June),
+  // now.getTimezoneOffset() will return -60.
+  return moment(date).add(now.getTimezoneOffset(), 'minutes').toDate()
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wmfs/tymly-schedule-plugin",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "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.282.0",
     "@wmfs/tymly-test-helpers": "1.22.2",
     "chai": "4.3.7",
     "codecov": "3.8.3",
@@ -38,9 +39,8 @@
     "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",
+    "semantic-release": "21.0.0",
     "standard": "17.0.0"
   },
   "scripts": {

package/plugin.json

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

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

@@ -7,8 +7,9 @@ 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()
+  it('No options, should default to now (UTC)', () => {
+    let now = new Date()
+    now = moment(now).add(now.getTimezoneOffset(), 'minutes').toDate()
     const datetime = ruleToDatetime()
 
     expect(datetime.getFullYear()).to.eql(now.getFullYear())
@@ -20,7 +21,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).add(now.getTimezoneOffset(), 'minutes').toDate()
     const year = now.getFullYear() + 2
 
     const datetime = ruleToDatetime({ year })
@@ -34,43 +36,49 @@ 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).add(now.getTimezoneOffset(), 'minutes').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).add(now.getTimezoneOffset(), 'minutes').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())
   })
 })