Merge branch 'dev' of github.com:mStirner/backend into dev

Marc Stirner · Marc Stirner · commit 24a4c3d58cc5 · 2022-11-23T13:17:11.000+01:00
diff --git a/components/endpoints/class.command.js b/components/endpoints/class.command.js
@@ -19,13 +19,13 @@ const { interfaces } = require("../../system/shared.js");
  * @property {String} alias Machine friendly name, e.g.: `POWER_ON`
  * @property {String} [identifier=null] Simple/custom identifiert for custom command handler
  * @property {String} payload The payload to send over the device interface
- * @property {String} [description=""] Command description, displayed on the frontend
+ * @property {String} [description=null] Command description, displayed on the frontend
  * @property {Array} params Possible parameter for the command
  * @property {String} params[].key Custom key
- * @property {Any} params[].value Value to set
- * @property {String} params[].default Default thing if nothing is send from client
- * @property {String} params[].min Min value if param type is a number
- * @property {String} params[].max Max value if param type is a number
+ * @property {String} params[].type Type of value: "string", "number" or "boolean"
+ * @property {String|Number|Boolean} params[].value Value to set
+ * @property {Number} [params[].min=0] Min value if param type is a number (`type=number`)
+ * @property {Number} [params[].max=100] Max value if param type is a number (`type=number`)
  * 
  * @example 
  * ```json
@@ -223,13 +223,29 @@ module.exports = class Command {
             identifier: Joi.string().allow(null).default(null),   // NOTE: move to endpoint schema?               // Thing api provides you, like light id or some custom thing for you
             payload: Joi.string().allow(null).default(null),
             description: Joi.string().allow(null).default(null),
-            params: Joi.array().items({
-                key: Joi.string().required(),
-                value: Joi.any(),
-                default: Joi.string(),
-                min: Joi.number(),
-                max: Joi.number()
-            })
+            params: Joi.array().items(Joi.object({
+                type: Joi.string().valid("number", "string", "boolean").required(),
+                key: Joi.string().required()
+            }).when(".type", {
+                switch: [{
+                    is: "number",
+                    then: Joi.object({
+                        value: Joi.number().default(null).allow(null),
+                        min: Joi.number().default(0),
+                        max: Joi.number().default(100)
+                    })
+                }, {
+                    is: "string",
+                    then: Joi.object({
+                        value: Joi.string().default(null).allow(null)
+                    })
+                }, {
+                    is: "boolean",
+                    then: Joi.object({
+                        value: Joi.boolean().default(null).allow(null)
+                    })
+                }]
+            }))
         });
     }
 
diff --git a/components/vault/index.js b/components/vault/index.js
@@ -70,6 +70,28 @@ class C_VAULT extends COMPONENT {
             next(null, new Vault(data, this));
         });
 
+        /*
+        // investigation of #208
+        this.hooks.post("update", (data, next) => {
+
+            console.log("update post:", data);
+
+            let valid = data.secrets.every((secret) => {
+                return secret instanceof Secret;
+            });
+
+            console.log("Secrets instances valid:", valid, data.secrets)
+
+            if (!valid) {
+                //_merge(item, new Vault(data, this));
+                //Object.assign(data, new Vault(data, this));
+            }
+
+            next(null);
+
+        });
+        */
+
     }
 
 }
diff --git a/tests/components/devices.js b/tests/components/devices.js
@@ -92,6 +92,31 @@ try {
     });
 
 
+    workflow(C_COMPONENT, "update", "Double update result / event arguments check", (done, { event }) => {
+        Promise.all([
+
+            // update call 1
+            C_COMPONENT.update(_id, {
+                name: "Device #2",
+            }),
+
+            // update call 2
+            C_COMPONENT.update(_id, {
+                enabled: true
+            })
+
+        ]).then(() => {
+
+            event.args.forEach((args) => {
+                assert.equal(args[0] instanceof Device, true);
+            });
+
+            done();
+
+        }).catch(done);
+    });
+
+
     workflow(C_COMPONENT, "remove", (done, { post }) => {
         C_COMPONENT.remove(_id, (err, item) => {
             try {
diff --git a/tests/components/endpoints.js b/tests/components/endpoints.js
@@ -78,6 +78,31 @@ try {
     });
 
 
+    workflow(C_COMPONENT, "update", "Double update result / event arguments check", (done, { event }) => {
+        Promise.all([
+
+            // update call 1
+            C_COMPONENT.update(_id, {
+                name: "Endpoint #42",
+            }),
+
+            // update call 2
+            C_COMPONENT.update(_id, {
+                enabled: false
+            })
+
+        ]).then(() => {
+
+            event.args.forEach((args) => {
+                assert.equal(args[0] instanceof Endpoint, true);
+            });
+
+            done();
+
+        }).catch(done);
+    });
+
+
     workflow(C_COMPONENT, "remove", (done, { post }) => {
         C_COMPONENT.remove(_id, (err, item) => {
             try {
diff --git a/tests/components/plugins.js b/tests/components/plugins.js
@@ -78,6 +78,31 @@ try {
     });
 
 
+    workflow(C_COMPONENT, "update", "Double update result / event arguments check", (done, { event }) => {
+        Promise.all([
+
+            // update call 1
+            C_COMPONENT.update(_id, {
+                version: 3
+            }),
+
+            // update call 2
+            C_COMPONENT.update(_id, {
+                enabled: false
+            })
+
+        ]).then(() => {
+
+            event.args.forEach((args) => {
+                assert.equal(args[0] instanceof Plugin, true);
+            });
+
+            done();
+
+        }).catch(done);
+    });
+
+
     workflow(C_COMPONENT, "remove", (done, { post }) => {
         C_COMPONENT.remove(_id, (err, item) => {
             try {
diff --git a/tests/components/rooms.js b/tests/components/rooms.js
@@ -78,6 +78,33 @@ try {
     });
 
 
+    workflow(C_COMPONENT, "update", "Double update result / event arguments check", (done, { event }) => {
+        Promise.all([
+
+            // update call 1
+            C_COMPONENT.update(_id, {
+                name: "New name",
+                floor: 2
+            }),
+
+            // update call 2
+            C_COMPONENT.update(_id, {
+                floor: 9,
+                number: 42069
+            })
+
+        ]).then(() => {
+
+            event.args.forEach((args) => {
+                assert.equal(args[0] instanceof Room, true);
+            });
+
+            done();
+
+        }).catch(done);
+    });
+
+
     workflow(C_COMPONENT, "remove", (done, { post }) => {
         C_COMPONENT.remove(_id, (err, item) => {
             try {
diff --git a/tests/components/ssdp.js b/tests/components/ssdp.js
@@ -1,4 +1,5 @@
 const assert = require("assert");
+const crypto = require("crypto");
 const mongodb = require("mongodb");
 
 try {
@@ -75,6 +76,35 @@ try {
     });
 
 
+    workflow(C_COMPONENT, "update", "Double update result / event arguments check", (done, { event }) => {
+
+        let uuid1 = crypto.randomUUID();
+        let uuid2 = crypto.randomUUID();
+
+        Promise.all([
+
+            // update call 1
+            C_COMPONENT.update(_id, {
+                usn: `uuid:${uuid1}`
+            }),
+
+            // update call 2
+            C_COMPONENT.update(_id, {
+                usn: `uuid:${uuid2}`
+            })
+
+        ]).then(() => {
+
+            event.args.forEach((args) => {
+                assert.equal(args[0] instanceof SSDP, true);
+            });
+
+            done();
+
+        }).catch(done);
+    });
+
+
     workflow(C_COMPONENT, "remove", (done, { post }) => {
         C_COMPONENT.remove(_id, (err, item) => {
             try {
diff --git a/tests/components/store.js b/tests/components/store.js
@@ -80,6 +80,31 @@ try {
     });
 
 
+    workflow(C_COMPONENT, "update", "Double update result / event arguments check", (done, { event }) => {
+        Promise.all([
+
+            // update call 1
+            C_COMPONENT.update(_id, {
+                item: uuidv4()
+            }),
+
+            // update call 2
+            C_COMPONENT.update(_id, {
+                item: uuidv4()
+            })
+
+        ]).then(() => {
+
+            event.args.forEach((args) => {
+                assert.equal(args[0] instanceof Store, true);
+            });
+
+            done();
+
+        }).catch(done);
+    });
+
+
     workflow(C_COMPONENT, "remove", (done, { post }) => {
         C_COMPONENT.remove(_id, (err, item) => {
             try {
diff --git a/tests/components/test.workflow.js b/tests/components/test.workflow.js
@@ -4,7 +4,12 @@ const sinon = require("sinon");
 
 const _iterate = require("../../helper/iterate.js");
 
-module.exports = (C_COMPONENT, method, worker) => {
+module.exports = (C_COMPONENT, method, desc, worker) => {
+
+    if (!worker && desc instanceof Function) {
+        worker = desc;
+        desc = null;
+    }
 
     let pre = sinon.spy();
     let post = sinon.spy();
@@ -20,31 +25,33 @@ module.exports = (C_COMPONENT, method, worker) => {
         args[args.length - 1](null);
     });
 
-    C_COMPONENT.events.once(method, (...args) => {
+    C_COMPONENT.events.on(method, (...args) => {
+        //console.log("Event", method, args);
         event(...args);
     });
 
-    it(`Should perform method "${method}"`, (done) => {
+    it(`Should perform method "${method}" ${desc ? "(" + desc + ")" : ""}`, (done) => {
         worker(done, {
             pre,
             post,
             event
         });
     });
 
-    it(`Should fired event "${method}"`, (done) => {
-        assert.equal(event.calledOnce, true);
+    it(`Should fired event "${method}" at least once ${desc ? "(" + desc + ")" : ""}`, (done) => {
+        //assert.equal(event.calledOnce, true);
+        assert.ok(event.callCount >= 1);
         done();
     });
 
     if (method === "add") {
 
-        it(`Items array should have 1 item`, (done) => {
+        it(`Items array should have 1 item ${desc ? "(" + desc + ")" : ""}`, (done) => {
             assert.equal(C_COMPONENT.items.length, 1);
             done();
         });
 
-        it(`Every array in item should have a _id property`, (done) => {
+        it(`Every array in item should have a _id property ${desc ? "(" + desc + ")" : ""}`, (done) => {
             try {
 
                 _iterate(C_COMPONENT.items[0], (key, value, type) => {
@@ -78,7 +85,7 @@ module.exports = (C_COMPONENT, method, worker) => {
 
     }
 
-    it(`Should fire pre hook "${method}"`, (done) => {
+    it(`Should fire pre hook "${method}" ${desc ? "(" + desc + ")" : ""}`, (done) => {
         try {
 
             // NOTE:
@@ -97,7 +104,7 @@ module.exports = (C_COMPONENT, method, worker) => {
         }
     });
 
-    it(`Should fire post hook "${method}"`, (done) => {
+    it(`Should fire post hook "${method}" ${desc ? "(" + desc + ")" : ""}`, (done) => {
         try {
 
             if (method === "remove") {
diff --git a/tests/components/users.js b/tests/components/users.js
@@ -78,6 +78,31 @@ try {
     });
 
 
+    workflow(C_COMPONENT, "update", "Double update result / event arguments check", (done, { event }) => {
+        Promise.all([
+
+            // update call 1
+            C_COMPONENT.update(_id, {
+                password: "12345678"
+            }),
+
+            // update call 2
+            C_COMPONENT.update(_id, {
+                enabled: true
+            })
+
+        ]).then(() => {
+
+            event.args.forEach((args) => {
+                assert.equal(args[0] instanceof User, true);
+            });
+
+            done();
+
+        }).catch(done);
+    });
+
+
     workflow(C_COMPONENT, "remove", (done, { post }) => {
         C_COMPONENT.remove(_id, (err, item) => {
             try {
diff --git a/tests/components/vault.js b/tests/components/vault.js
