node-red-contrib-power-saver 3.6.2 → 4.1.0

package/test/strategy-fixed-schedule.test.js

@@ -0,0 +1,117 @@
+const cloneDeep = require("lodash.clonedeep");
+const { DateTime } = require("luxon");
+const expect = require("expect");
+const helper = require("node-red-node-test-helper");
+const fixedSchedule = require("../src/strategy-fixed-schedule.js");
+const prices = require("./data/converted-prices.json");
+const result = require("./data/fixed-schedule-result.json");
+const { testPlan: plan, equalPlan, equalSchedule } = require("./test-utils");
+
+helper.init(require.resolve("node-red"));
+
+describe("ps-strategy-fixed-schedule node", function () {
+  beforeEach(function (done) {
+    helper.startServer(done);
+  });
+
+  afterEach(function (done) {
+    helper.unload().then(function () {
+      helper.stopServer(done);
+    });
+  });
+
+  it("should be loaded", function (done) {
+    const flow = [{ id: "n1", type: "ps-strategy-fixed-schedule", name: "test name" }];
+    helper.load(fixedSchedule, flow, function () {
+      const n1 = helper.getNode("n1");
+      expect(n1).toHaveProperty("name", "test name");
+      done();
+    });
+  });
+
+  it("should turn on 2 to 6", function (done) {
+    const flow = makeFlow();
+    const expected = cloneDeep(result);
+    helper.load(fixedSchedule, flow, function () {
+      const n1 = helper.getNode("n1");
+      const n2 = helper.getNode("n2");
+      n2.on("input", function (msg) {
+        expect(equalPlan(expected, msg.payload)).toBeTruthy();
+        n1.warn.should.not.be.called;
+        done();
+      });
+      n1.receive({ payload: prices, time: prices.priceData[0].start });
+    });
+  });
+  it("should send correct if no schedule", function (done) {
+    const flow = makeFlow(true);
+    const expected = cloneDeep(result);
+    expected.schedule.push({
+      time: "2021-10-13T00:00:00.000+02:00",
+      value: true,
+      countHours: null,
+    });
+    expected.config.outputIfNoSchedule = true;
+
+    helper.load(fixedSchedule, flow, function () {
+      const n1 = helper.getNode("n1");
+      const n2 = helper.getNode("n2");
+      n2.on("input", function (msg) {
+        expect(equalPlan(expected, msg.payload)).toBeTruthy();
+        n1.warn.should.not.be.called;
+        done();
+      });
+      n1.receive({ payload: prices, time: prices.priceData[0].start });
+    });
+  });
+  it("should work only on days specified", function (done) {
+    const flow = makeFlow(false);
+    flow[0].periods.splice(1, 1);
+    flow[0].days["Tue"] = false;
+    const expected = [
+      {
+        time: "2021-10-11T00:00:00.000+02:00",
+        value: true,
+        countHours: 24,
+      },
+      {
+        time: "2021-10-12T00:00:00.000+02:00",
+        value: false,
+        countHours: 24,
+      },
+    ];
+
+    helper.load(fixedSchedule, flow, function () {
+      const n1 = helper.getNode("n1");
+      const n2 = helper.getNode("n2");
+      n2.on("input", function (msg) {
+        expect(equalSchedule(expected, msg.payload.schedule)).toBeTruthy();
+        done();
+      });
+      n1.receive({ payload: prices, time: prices.priceData[0].start });
+    });
+  });
+});
+
+function makeFlow(outputIfNoSchedule = false) {
+  return [
+    {
+      id: "n1",
+      type: "ps-strategy-fixed-schedule",
+      name: "test name",
+      days: { Mon: true, Tue: true, Wed: true, Thu: true, Fri: true, Sat: true, Sun: true },
+      periods: [
+        { start: "02", value: true },
+        { start: "06", value: false },
+      ],
+      sendCurrentValueWhenRescheduling: true,
+      outputIfNoSchedule,
+      // validFrom: null,
+      // validTo: null,
+      wires: [["n3"], ["n4"], ["n2"]],
+    },
+    { id: "n2", type: "helper" },
+    { id: "n3", type: "helper" },
+    { id: "n4", type: "helper" },
+  ];
+}

package/test/strategy-heat-capacitor.test.js

@@ -11,7 +11,7 @@ const {
 const converted_prices = require("./data/converted-prices.json");
 const decreasing_end_prices = require("./data/tibber-decreasing2-24h.json");
 
-describe("Test heat capacitor strategy functions", () => {
+describe("ps-strategy-heat-capacitor-functions", () => {
   let prices, decreasing_24h_prices, start_date, buy_pattern, sell_pattern;
 
   //User input

package/test/strategy-lowest-price-functions.test.js

@@ -4,7 +4,7 @@ const { getBestContinuous, getBestX } = require("../src/strategy-lowest-price-fu
 const convertedPrices = require("./data/converted-prices.json");
 const cloneDeep = require("lodash.clonedeep");
 
-describe("strategy-utils", () => {
+describe("strategy-lowest-price-functions", () => {
   it("can find best x", () => {
     const values = convertedPrices.priceData.slice(0, 48).map((p) => p.value);
     const result = cloneDeep(values).fill(false);

package/test/strategy-lowest-price-test-utils.js

@@ -0,0 +1,31 @@
+const cloneDeep = require("lodash.clonedeep");
+const { DateTime } = require("luxon");
+
+function makeFlow(hoursOn, maxPrice = null, doNotSplit = true, fromTime = "10", toTime = "20") {
+  return [
+    {
+      id: "n1",
+      type: "ps-strategy-lowest-price",
+      name: "test name",
+      fromTime,
+      toTime,
+      hoursOn,
+      maxPrice,
+      doNotSplit,
+      sendCurrentValueWhenRescheduling: true,
+      outputIfNoSchedule: true,
+      wires: [["n3"], ["n4"], ["n2"]],
+    },
+    { id: "n2", type: "helper" },
+    { id: "n3", type: "helper" },
+    { id: "n4", type: "helper" },
+  ];
+}
+
+function makePayload(prices, time) {
+  const payload = cloneDeep(prices);
+  payload.time = time;
+  return payload;
+}
+
+module.exports = { makeFlow, makePayload };

package/test/strategy-lowest-price.test.js

@@ -4,8 +4,9 @@ const expect = require("expect");
 const helper = require("node-red-node-test-helper");
 const lowestPrice = require("../src/strategy-lowest-price.js");
 const prices = require("./data/converted-prices.json");
-const { testPlan: plan } = require("./test-utils");
+const negativePrices = require("./data/negative-prices.json");
 const { version } = require("../package.json");
+const { makeFlow, makePayload } = require("./strategy-lowest-price-test-utils");
 
 helper.init(require.resolve("node-red"));
 
@@ -83,7 +84,6 @@ describe("ps-strategy-lowest-price node", function () {
       const n2 = helper.getNode("n2");
       n2.on("input", function (msg) {
         expect(msg.payload).toHaveProperty("schedule", resultSplitted.schedule);
-        expect(msg.payload).toHaveProperty("config", resultSplitted.config);
         n1.warn.should.not.be.called;
         done();
       });
@@ -91,6 +91,38 @@ describe("ps-strategy-lowest-price node", function () {
       n1.receive({ payload: makePayload(prices, time) });
     });
   });
+  it("should plan correct negative prices continuous schedule", function (done) {
+    const resultContinuous = require("./data/lowest-price-result-neg-cont.json");
+    const flow = makeFlow(5, null, true, "00", "00");
+    helper.load(lowestPrice, flow, function () {
+      const n1 = helper.getNode("n1");
+      const n2 = helper.getNode("n2");
+      n2.on("input", function (msg) {
+        expect(msg.payload).toHaveProperty("schedule", resultContinuous.schedule);
+        expect(msg.payload).toHaveProperty("config", resultContinuous.config);
+        n1.warn.should.not.be.called;
+        done();
+      });
+      const time = DateTime.fromISO(prices.priceData[10].start);
+      n1.receive({ payload: makePayload(negativePrices, time) });
+    });
+  });
+  it("should plan correct negative prices splitted schedule", function (done) {
+    const resultSplitted = require("./data/lowest-price-result-neg-split.json");
+    const flow = makeFlow(5, null, true, "00", "00");
+    flow[0].doNotSplit = false;
+    helper.load(lowestPrice, flow, function () {
+      const n1 = helper.getNode("n1");
+      const n2 = helper.getNode("n2");
+      n2.on("input", function (msg) {
+        expect(msg.payload).toHaveProperty("schedule", resultSplitted.schedule);
+        n1.warn.should.not.be.called;
+        done();
+      });
+      const time = DateTime.fromISO(prices.priceData[10].start);
+      n1.receive({ payload: makePayload(negativePrices, time) });
+    });
+  });
   it("should plan correct continuous schedule with max price ok", function (done) {
     const resultContinuousMax = require("./data/lowest-price-result-cont-max.json");
     const flow = makeFlow(4, 1.0);
@@ -99,7 +131,6 @@ describe("ps-strategy-lowest-price node", function () {
       const n2 = helper.getNode("n2");
       n2.on("input", function (msg) {
         expect(msg.payload).toHaveProperty("schedule", resultContinuousMax.schedule);
-        expect(msg.payload).toHaveProperty("config", resultContinuousMax.config);
         n1.warn.should.not.be.called;
         done();
       });
@@ -115,7 +146,6 @@ describe("ps-strategy-lowest-price node", function () {
       const n2 = helper.getNode("n2");
       n2.on("input", function (msg) {
         expect(msg.payload).toHaveProperty("schedule", resultContinuousMax.schedule);
-        expect(msg.payload).toHaveProperty("config", resultContinuousMax.config);
         n1.warn.should.not.be.called;
         done();
       });
@@ -132,7 +162,6 @@ describe("ps-strategy-lowest-price node", function () {
       const n2 = helper.getNode("n2");
       n2.on("input", function (msg) {
         expect(msg.payload).toHaveProperty("schedule", resultSplittedMax.schedule);
-        expect(msg.payload).toHaveProperty("config", resultSplittedMax.config);
         n1.warn.should.not.be.called;
         done();
       });
@@ -151,7 +180,6 @@ describe("ps-strategy-lowest-price node", function () {
       const n2 = helper.getNode("n2");
       n2.on("input", function (msg) {
         expect(msg.payload).toHaveProperty("schedule", resultAllDay.schedule);
-        expect(msg.payload).toHaveProperty("config", resultAllDay.config);
         n1.warn.should.not.be.called;
         done();
       });
@@ -171,7 +199,6 @@ describe("ps-strategy-lowest-price node", function () {
       n2.on("input", function (msg) {
         const config = cloneDeep(resultAllDay10.config);
         expect(msg.payload).toHaveProperty("schedule", resultAllDay10.schedule);
-        expect(msg.payload).toHaveProperty("config", config);
         n1.warn.should.not.be.called;
         done();
       });
@@ -193,7 +220,6 @@ describe("ps-strategy-lowest-price node", function () {
         const config = cloneDeep(resultAllDay10.config);
         config.outputOutsidePeriod = true;
         expect(msg.payload).toHaveProperty("schedule", resultAllDay10.schedule);
-        expect(msg.payload).toHaveProperty("config", config);
         n1.warn.should.not.be.called;
         done();
       });
@@ -215,7 +241,6 @@ describe("ps-strategy-lowest-price node", function () {
         const config = cloneDeep(resultAllDay10.config);
         config.outputIfNoSchedule = true;
         expect(msg.payload).toHaveProperty("schedule", resultAllDay10.schedule);
-        expect(msg.payload).toHaveProperty("config", config);
         n1.warn.should.not.be.called;
         done();
       });
@@ -242,8 +267,8 @@ describe("ps-strategy-lowest-price node", function () {
         config.outputOutsidePeriod = true;
         const res = msg.payload.schedule.map((s) => ({ time: s.time, value: s.value }));
         const exp = schedule.map((s) => ({ time: s.time, value: s.value }));
+        exp.pop();
         expect(res).toEqual(exp);
-        expect(msg.payload).toHaveProperty("config", config);
         n1.warn.should.not.be.called;
         done();
       });
@@ -267,10 +292,10 @@ describe("ps-strategy-lowest-price node", function () {
         schedule.splice(4, 0, { time: "2021-10-11T20:00:00.000+02:00", value: true });
         schedule.splice(5, 0, { time: "2021-10-12T10:00:00.000+02:00", value: false });
         schedule.splice(schedule.length, 0, { time: "2021-10-12T20:00:00.000+02:00", value: true });
-        // schedule.splice(schedule.length - 1, 1);
         config.outputOutsidePeriod = true;
         const res = msg.payload.schedule.map((s) => ({ time: s.time, value: s.value }));
         const exp = schedule.map((s) => ({ time: s.time, value: s.value }));
+        exp.splice(8, 1);
         expect(res).toEqual(exp);
         expect(msg.payload).toHaveProperty("config", config);
         n1.warn.should.not.be.called;
@@ -281,7 +306,10 @@ describe("ps-strategy-lowest-price node", function () {
     });
   });
   it("should work with 0 hours on", function (done) {
-    const result = [{ time: "2021-10-11T00:00:00.000+02:00", value: false, countHours: 48 }];
+    const result = [
+      { time: "2021-10-11T00:00:00.000+02:00", value: false, countHours: 48 },
+      { time: "2021-10-13T00:00:00.000+02:00", value: true, countHours: null },
+    ];
     const flow = makeFlow(0);
     helper.load(lowestPrice, flow, function () {
       const n1 = helper.getNode("n1");
@@ -324,6 +352,7 @@ describe("ps-strategy-lowest-price node", function () {
       { time: "2021-10-11T13:00:00.000+02:00", value: false, countHours: 25 },
       { time: "2021-10-12T14:00:00.000+02:00", value: true, countHours: 1 },
       { time: "2021-10-12T15:00:00.000+02:00", value: false, countHours: 9 },
+      { time: "2021-10-13T00:00:00.000+02:00", value: true, countHours: null },
     ];
     const flow = makeFlow(1);
     helper.load(lowestPrice, flow, function () {
@@ -345,6 +374,7 @@ describe("ps-strategy-lowest-price node", function () {
       { time: "2021-10-11T20:00:00.000+02:00", value: false, countHours: 14 },
       { time: "2021-10-12T10:00:00.000+02:00", value: true, countHours: 10 },
       { time: "2021-10-12T20:00:00.000+02:00", value: false, countHours: 4 },
+      { time: "2021-10-13T00:00:00.000+02:00", value: true, countHours: null },
     ];
     const flow = makeFlow(24);
     helper.load(lowestPrice, flow, function () {
@@ -367,6 +397,7 @@ describe("ps-strategy-lowest-price node", function () {
       { time: "2021-10-11T00:00:00.000+02:00", value: false, countHours: 12 },
       { time: "2021-10-11T12:00:00.000+02:00", value: true, countHours: 1 },
       { time: "2021-10-11T13:00:00.000+02:00", value: false, countHours: 11 },
+      { time: "2021-10-12T00:00:00.000+02:00", value: true, countHours: null },
     ];
     const flow = makeFlow(1);
     helper.load(lowestPrice, flow, function () {
@@ -393,7 +424,10 @@ describe("ps-strategy-lowest-price node", function () {
   });
 
   it("should handle hours on > period", function (done) {
-    const result = [{ time: "2021-10-11T00:00:00.000+02:00", value: true, countHours: 48 }];
+    const result = [
+      { time: "2021-10-11T00:00:00.000+02:00", value: true, countHours: 48 },
+      { time: "2021-10-13T00:00:00.000+02:00", value: false, countHours: null },
+    ];
     const flow = [
       {
         id: "n1",
@@ -446,6 +480,7 @@ describe("ps-strategy-lowest-price node", function () {
       { time: "2021-10-11T22:00:00.000+02:00", value: false, countHours: 19 },
       { time: "2021-10-12T17:00:00.000+02:00", value: true, countHours: 5 },
       { time: "2021-10-12T22:00:00.000+02:00", value: false, countHours: 2 },
+      { time: "2021-10-13T00:00:00.000+02:00", value: true, countHours: null },
     ];
     const flow = [
       {
@@ -496,6 +531,8 @@ describe("ps-strategy-lowest-price node", function () {
     const input = require("./data/tibber-data-end-0.json");
     const result = require("./data/tibber-result-end-0.json");
     result.version = version;
+    result.strategyNodeId = "n1";
+    result.current = false;
     const flow = [
       {
         id: "n1",
@@ -509,6 +546,7 @@ describe("ps-strategy-lowest-price node", function () {
         sendCurrentValueWhenRescheduling: true,
         outputIfNoSchedule: false,
         outputOutsidePeriod: false,
+        override: "auto",
         wires: [["n3"], ["n4"], ["n2"]],
       },
       { id: "n2", type: "helper" },
@@ -531,6 +569,8 @@ describe("ps-strategy-lowest-price node", function () {
     const input = require("./data/tibber-data-end-0-24h.json");
     const result = require("./data/tibber-result-end-0-24h.json");
     result.version = version;
+    result.strategyNodeId = "n1";
+    result.current = false;
     const flow = [
       {
         id: "n1",
@@ -566,6 +606,8 @@ describe("ps-strategy-lowest-price node", function () {
     const input = require("./data/lowest-price-input-missing-end.json");
     const result = require("./data/lowest-price-result-missing-end.json");
     result.payload.version = version;
+    result.payload.strategyNodeId = "n1";
+    result.payload.current = false;
     const flow = [
       {
         id: "n1",
@@ -599,35 +641,3 @@ describe("ps-strategy-lowest-price node", function () {
     });
   });
 });
-
-function makeFlow(hoursOn, maxPrice = null) {
-  return [
-    {
-      id: "n1",
-      type: "ps-strategy-lowest-price",
-      name: "test name",
-      fromTime: "10",
-      toTime: "20",
-      hoursOn: hoursOn,
-      maxPrice: maxPrice,
-      doNotSplit: true,
-      sendCurrentValueWhenRescheduling: true,
-      outputIfNoSchedule: true,
-      wires: [["n3"], ["n4"], ["n2"]],
-    },
-    { id: "n2", type: "helper" },
-    { id: "n3", type: "helper" },
-    { id: "n4", type: "helper" },
-  ];
-}
-
-function makePayload(prices, time) {
-  const payload = cloneDeep(prices);
-  payload.time = time;
-  // let entryTime = DateTime.fromISO(payload.time);
-  // payload.priceData.forEach((e) => {
-  //   e.start = entryTime.toISO();
-  //   entryTime = entryTime.plus({ milliseconds: 10 });
-  // });
-  return payload;
-}

package/test/test-utils.js

@@ -37,59 +37,64 @@ function makePayload(prices, time) {
 
 function equalPlan(expected, actual) {
   let res = true;
-  if (expected.schedule.length !== actual.schedule.length) {
-    console.log(
-      "Schedules have different lengths: Expected " + expected.schedule.length + ", got " + actual.schedule.length
-    );
+
+  if (!equalSchedule(expected.schedule, actual.schedule)) {
     res = false;
   }
-  if (expected.hours.length !== actual.hours.length) {
-    console.log("Hours have different lengths: Expected " + expected.hours.length + ", got " + actual.hours.length);
+
+  if (!equalHours(expected.hours, actual.hours)) {
+    res = false;
   }
-  expected.schedule.forEach((s, i) => {
+
+  ["maxHoursToSaveInSequence", "minHoursOnAfterMaxSequenceSaved", "minSaving", "outputIfNoSchedule"].forEach((key) => {
+    if (expected.config[key] != actual.config[key]) {
+      console.log(
+        "Different config values for " + key + ": Expected " + expected.config[key] + ", got " + actual.config[key]
+      );
+      res = false;
+    }
+  });
+
+  return res;
+}
+
+function equalSchedule(expected, actual) {
+  let res = true;
+  if (expected.length !== actual.length) {
+    console.log("Schedules have different lengths: Expected " + expected.length + ", got " + actual.length);
+    res = false;
+  }
+
+  expected.forEach((s, i) => {
     ["time", "value"].forEach((key) => {
-      if (s[key] != actual.schedule[i][key]) {
+      if (s[key] != actual[i][key]) {
         console.log(
-          "Different schedule values for " +
-            key +
-            " at index " +
-            i +
-            ": Expected " +
-            s[key] +
-            ", got " +
-            actual.schedule[i][key]
+          "Different schedule values for " + key + " at index " + i + ": Expected " + s[key] + ", got " + actual[i][key]
         );
         res = false;
       }
     });
   });
-  expected.hours.forEach((s, i) => {
-    ["price", "onOff", "start", "saving"].forEach((key) => {
-      if (s[key] != actual.hours[i][key]) {
+  return res;
+}
+
+function equalHours(expected, actual, properties = ["price", "onOff", "start", "saving"]) {
+  let res = true;
+  if (expected.length !== actual.length) {
+    console.log("Hours have different lengths: Expected " + expected.hours.length + ", got " + actual.hours.length);
+  }
+
+  expected.forEach((s, i) => {
+    properties.forEach((key) => {
+      if (s[key] != actual[i][key]) {
         console.log(
-          "Different hour values for " +
-            key +
-            " at index " +
-            i +
-            ": Expected " +
-            s[key] +
-            ", got " +
-            actual.hours[i][key]
+          "Different hour values for " + key + " at index " + i + ": Expected " + s[key] + ", got " + actual[i][key]
         );
         res = false;
       }
     });
   });
 
-  ["maxHoursToSaveInSequence", "minHoursOnAfterMaxSequenceSaved", "minSaving", "outputIfNoSchedule"].forEach((key) => {
-    if (expected.config[key] != actual.config[key]) {
-      console.log(
-        "Different config values for " + key + ": Expected " + expected.config[key] + ", got " + actual.config[key]
-      );
-      res = false;
-    }
-  });
-
   return res;
 }
 
@@ -97,4 +102,6 @@ module.exports = {
   testPlan,
   makePayload,
   equalPlan,
+  equalHours,
+  equalSchedule,
 };

package/test/utils.test.js

@@ -1,3 +1,4 @@
+const cloneDeep = require("lodash.clonedeep");
 const { DateTime } = require("luxon");
 const expect = require("expect");
 const {
@@ -8,10 +9,12 @@ const {
   getSavings,
   countAtEnd,
   makeSchedule,
+  makeScheduleFromHours,
   fillArray,
   extractPlanForDate,
   isSameDate,
 } = require("../src/utils");
+const testResult = require("./data/best-save-result.json");
 
 describe("utils", () => {
   it("can test boolean config", () => {
@@ -195,4 +198,14 @@ describe("utils", () => {
     };
     expect(extractPlanForDate(plan, "2021-06-20T01:50:00.000+02:00")).toEqual(part1);
   });
+  it("Can make schedule from hours", () => {
+    const hours = cloneDeep(testResult.hours);
+    const schedule = makeScheduleFromHours(hours, null);
+    const resultToValidate = schedule.map((s) => ({ time: s.time, value: s.value }));
+    resultToValidate.push({
+      time: "2021-06-20T02:50:00.470+02:00",
+      value: false,
+    });
+    expect(resultToValidate).toEqual(testResult.schedule);
+  });
 });

package/docs/nodes/power-saver.md

@@ -1,23 +0,0 @@
----
-next: ./ps-strategy-best-save.md
----
-
-# power-saver <Badge type="warning" text="deprecated" vertical="middle" />
-
-![Power Saver node](../images/node-power-saver.png)
-
-This is the node from version 2. It is still working, but should be replaced.
-
-To migrate, just replace the Power Saver node by a combination of the ps-receive-price and the ps-best-save nodes:
-
-Replace the `Power Saver` node from version 2:
-
-![Power Saver node](../images/migrate-power-saver.png)
-
-with this combination of `ps-receive-price` and `ps-strategy-best-save` from version 3:
-
-![Migrate Power Saver](../images/migrate-best-save.png)
-
-The configuration is done in the `ps-strategy-best-save` node, and is the same as in the old `Power Saver` node.
-
-Should you need it, here is the [old documentation](./old-power-saver-doc) for the PowerSaver node from version 2.