@etainabl/nodejs-sdk 1.2.11 → 1.2.12

package/__tests__/reporting.test.ts

@@ -0,0 +1,88 @@
+import moment from 'moment';
+import { reporting } from '../src/index.js';
+
+const exampleScheduledReport = {
+  "_id" : "66964ddcdc2a32666b573d4b",
+  "name" : "Last Months Meter Report - 008453651410226013008",
+  "startDate" : moment('2024-07-18T08:03:00.000+0000'),
+  "frequency" : "1|month",
+  "frequencyDay" : "any",
+  "frequencyPeriod" : "any",
+  "reportPeriod" : "1|month",
+  "subject" : "{{ siteName }} Last Month Meter Report for {{ accountMeterPointNumber }}",
+  "message" : "Hi\n\nPlease find attached last month's meter management report for {{ accountName }} at {{ siteName }} covering the periods {{ reportStartDate }} to {{ reportEndDate }} for {{ accountMeterSerialNumber }}. \n\nIf you have any questions, please contact helpdesk@carbonxgen.com.\n\nMany thanks\nCarbonxgen",
+  "recipients" : [
+      "test@etainabl.com"
+  ],
+  "enabled" : true,
+  "reportTemplateId" : "668f0cfd341c6b91bee5add3",
+  "overrides" : {
+      "accountId" : "655fcf07b7d3920014045314"
+  },
+  "userSub" : "auth0|6560834e165d6e67c4a4b8c9",
+  "companyId" : "655b6d833f36810014b817a1",
+  "deleted" : false,
+  "createdAt" : moment('2024-07-16T10:39:24.917+0000'),
+  "updatedAt" : moment('2024-08-14T10:37:16.263+0000'),
+  "bulkUpdateCode" : "rerun17092024"
+};
+
+describe('Scheduled report run times', () => {
+
+  it('should generate the correct run times for monthly report', async () => {
+    const nextRunTimes = reporting.getScheduledReportRunTimes(exampleScheduledReport, 5, moment('2024-06-23T00:00:00.000+0000'));
+
+    expect(nextRunTimes.map(t => t.toDate())).toEqual([
+      new Date('2024-07-18T08:03:00.000+0000'),
+      new Date('2024-08-18T08:03:00.000+0000'),
+      new Date('2024-09-18T08:03:00.000+0000'),
+      new Date('2024-10-18T08:03:00.000+0000'),
+      new Date('2024-11-18T08:03:00.000+0000')
+    ]);
+  });
+
+  it('should generate the correct run times for weekly report', async () => {
+    const simulatedTaskTime = moment('2024-07-23T00:00:00.000+0000');
+
+    const editedScheduledReport = {
+      ...exampleScheduledReport,
+      frequency: "1|week"
+    };
+
+    const scheduledStartDate = moment(editedScheduledReport.startDate);
+
+    const nextRunTimes = reporting.getScheduledReportRunTimes(editedScheduledReport, 5, simulatedTaskTime);
+
+    expect(nextRunTimes.map(t => t.toDate())).toEqual([
+      scheduledStartDate.add(1, 'week').toDate(),
+      scheduledStartDate.add(1, 'week').toDate(),
+      scheduledStartDate.add(1, 'week').toDate(),
+      scheduledStartDate.add(1, 'week').toDate(),
+      scheduledStartDate.add(1, 'week').toDate()
+    ]);
+  });
+
+  it('should generate a single run time for a one-time report', async () => {
+
+    const expiredScheduledReport = {
+      ...exampleScheduledReport,
+      frequency: "1|once",
+      startDate: moment('2024-07-25T08:03:00.000+0000')
+    };
+
+    const nextRunTimes = reporting.getScheduledReportRunTimes(expiredScheduledReport, 5, moment('2024-06-23T00:00:00.000+0000'));
+    expect(nextRunTimes.map(t => t.toDate())).toEqual([new Date("2024-07-25T08:03:00.000Z")]);
+  });
+
+  it('should generate no run times for an expired one-time report', async () => {
+
+    const expiredScheduledReport = {
+      ...exampleScheduledReport,
+      frequency: "1|once",
+      startDate: moment('2024-06-18T08:03:00.000+0000')
+    };
+
+    const nextRunTimes = reporting.getScheduledReportRunTimes(expiredScheduledReport, 5, moment('2024-06-23T00:00:00.000+0000'));
+    expect(nextRunTimes).toEqual([]);
+  });
+});

package/dist/cjs/reporting.js

@@ -53,8 +53,11 @@ const getScheduledReportRunTimes = (schedule, limit = 1, taskTime = (0, moment_1
     if (includeStartDate) {
         runTimes = [originalStartDate];
     }
-    if (schedule.frequency === 'once') {
-        return runTimes;
+    const [, freq] = schedule.frequency.split('|');
+    if (freq === 'once') {
+        const nextRunTime = runTimes[0];
+        // If this is now beyond the start date, return an empty array
+        return taskTime.isAfter(nextRunTime, 'minute') ? [] : runTimes;
     }
     const scheduleRunTimes = Array.from(Array(includeStartDate ? limit - 1 : limit).keys()).map(() => {
         const nextRunTime = getNextRunTime(startDate, schedule, taskTime);

package/dist/mjs/reporting.js

@@ -47,8 +47,11 @@ export const getScheduledReportRunTimes = (schedule, limit = 1, taskTime = momen
     if (includeStartDate) {
         runTimes = [originalStartDate];
     }
-    if (schedule.frequency === 'once') {
-        return runTimes;
+    const [, freq] = schedule.frequency.split('|');
+    if (freq === 'once') {
+        const nextRunTime = runTimes[0];
+        // If this is now beyond the start date, return an empty array
+        return taskTime.isAfter(nextRunTime, 'minute') ? [] : runTimes;
     }
     const scheduleRunTimes = Array.from(Array(includeStartDate ? limit - 1 : limit).keys()).map(() => {
         const nextRunTime = getNextRunTime(startDate, schedule, taskTime);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etainabl/nodejs-sdk",
-  "version": "1.2.11",
+  "version": "1.2.12",
   "main": "dist/cjs/index.js",
   "module": "dist/mjs/index.js",
   "author": "Jonathan Lambert <jonathan@etainabl.com>",
@@ -12,11 +12,13 @@
     "winston": "^3.10.0"
   },
   "devDependencies": {
-    "@types/node": "^20.4.5"
+    "@types/node": "^20.4.5",
+    "vitest": "^2.1.1"
   },
   "scripts": {
-    "process": "yarn build && yarn publish",
-    "build": "rm -rf dist/* && tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && ./fixup.sh"
+    "process": "vitest run && yarn build && yarn publish",
+    "build": "rm -rf dist/* && tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && ./fixup.sh",
+    "test": "vitest"
   },
   "exports": {
     ".": {

package/src/reporting.ts

@@ -55,10 +55,14 @@ export const getScheduledReportRunTimes = (schedule: any, limit = 1, taskTime =
   if (includeStartDate) {
     runTimes = [originalStartDate];
   }
-  
+
   const [, freq] = schedule.frequency.split('|');
+
   if (freq === 'once') {
-    return runTimes;
+    const nextRunTime = runTimes[0];
+
+    // If this is now beyond the start date, return an empty array
+    return taskTime.isAfter(nextRunTime, 'minute') ? [] : runTimes;
   }
 
 

package/tsconfig.base.json

@@ -17,7 +17,7 @@
         "skipLibCheck": true,
         "strict": true,
         "traceResolution": false,
-        "types": ["node"]
+        "types": ["node", "vitest/globals"]
     },
     "watchOptions": {
         // Use native file system events for files and directories

package/tsconfig.test.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+      "outDir": "./dist",                      
+      "rootDir": ".",  // Set rootDir to the root folder for tests and mocks
+      "types": ["vitest/globals"],
+      "noEmit": true   // Prevents emitting files since these are test files
+  },
+  "include": [
+      "__tests__/**/*",
+      "__mocks__/**/*"
+  ]
+}

package/vitest.config.js

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    coverage: {
+      provider: 'v8'
+    },
+    globals: true
+  }
+});