Make watchedObjects case insensitive (#138)

* Make watchedObjects case insensitive
Fixes #134

* Update changelog

* 1.6.0

* Bump version in changelog

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+## Version 1.6.0
+
+- watchObjects is now case insensitive when comparing against the matched objects ([issue 134](https://github.com/danecreekphotography/node-deepstackai-trigger/issues/134))
 - Address a warning during config file validation ([issue 123](https://github.com/danecreekphotography/node-deepstackai-trigger/issues/123)).
 - Document the available Docker image tags ([issue 128](https://github.com/danecreekphotography/node-deepstackai-trigger/issues/128)).
 - Addresses code cleanup [issue 136](https://github.com/danecreekphotography/node-deepstackai-trigger/issues/136).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-deepstackai-trigger",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Detects motion using DeepStack AI and calls registered triggers based on trigger rules.",
   "main": "dist/src/main.js",
   "files": [
@@ -32,6 +32,7 @@
   "homepage": "https://github.com/danecreekphotography/node-deepstackai-trigger#readme",
   "dependencies": {
     "ajv": "^6.12.2",
+    "ajv-keywords": "^3.4.1",
     "async-mqtt": "^2.6.0",
     "bufferutil": "^4.0.1",
     "chalk": "^3.0.0",
@@ -47,6 +48,7 @@
     "utf-8-validate": "^5.0.2"
   },
   "devDependencies": {
+    "@types/ajv-keywords": "^3.4.0",
     "@types/jest": "^25.2.3",
     "@types/node": "^13.1.2",
     "@types/node-telegram-bot-api": "^0.40.3",

src/Trigger.ts

@@ -210,7 +210,10 @@ export default class Trigger {
    * @returns True if the trigger is activated by the label
    */
   public isRegisteredForObject(fileName: string, label: string): boolean {
-    const isRegistered = this.watchObjects?.includes(label);
+    const isRegistered = this.watchObjects?.some(watchLabel => {
+      return watchLabel.toLowerCase() === label?.toLowerCase();
+    });
+
     if (!isRegistered) {
       log.info(
         `Trigger ${this.name}`,

src/schemaValidator.ts

@@ -10,6 +10,7 @@ import telegramHandlerConfiguration from "./schemas/telegramHandlerConfiguration
 import triggerSchema from "./schemas/triggerConfiguration.schema.json";
 import webRequestHandlerConfig from "./schemas/webRequestHandlerConfig.schema.json";
 import maskConfiguration from "./schemas/maskConfiguration.schema.json";
+import ajvkeywords from "ajv-keywords";
 
 /**
  * Validates an object against a schema file
@@ -23,6 +24,8 @@ export default async function validateJsonAgainstSchema(
 ): Promise<boolean> {
   const validator = new Ajv();
 
+  ajvkeywords(validator, "transform");
+
   // Register all the schemas that get used with this app. It doesn't matter
   // if they are for different schema files/uses, ajv only loads them when
   // actually required by the file being processed.

src/schemas/triggerConfiguration.schema.json

@@ -99,6 +99,7 @@
             "type": "array",
             "items": {
               "type": "string",
+              "transform": ["toLowerCase"],
               "enum": [
                 "person",
                 "bicycle",

tests/Trigger.test.ts

@@ -2,18 +2,45 @@
  *  Copyright (c) Neil Enns. All rights reserved.
  *  Licensed under the MIT License. See LICENSE in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-import trigger from "../src/Trigger";
+import Trigger from "../src/Trigger";
+import validateJsonAgainstSchema from "../src/schemaValidator";
+import triggerConfigJson from "../src/schemas/triggerConfiguration.schema.json";
+import triggerJson from "./triggers.json";
 
-test("Verify watchObjects", () => {
-  const testTrigger = new trigger();
-  testTrigger.watchObjects = ["cat", "elephant", "bike"];
+test("Verify isRegisteredForObject()", () => {
+  // Empty constructor should default to enabled true
+  const trigger = new Trigger();
+  trigger.name = "Trigger.test.ts";
 
-  expect(testTrigger.isRegisteredForObject("test", "dog")).toBe(false);
-  expect(testTrigger.isRegisteredForObject("test", "cat")).toBe(true);
+  trigger.watchObjects = ["dog"];
+  expect(trigger.isRegisteredForObject("unit test", "dog")).toBe(true);
 
-  // testTrigger.watchObjects = undefined;
-  // expect(testTrigger.isRegisteredForObject("test", "cat")).toBe(false);
+  trigger.watchObjects = [];
+  expect(trigger.isRegisteredForObject("unit test", "dog")).toBe(false);
 
-  testTrigger.watchObjects = [];
-  expect(testTrigger.isRegisteredForObject("test", "cat")).toBe(false);
+  trigger.watchObjects = undefined;
+  expect(trigger.isRegisteredForObject("unit test", "dog")).toBe(false);
+
+  trigger.watchObjects = null;
+  expect(trigger.isRegisteredForObject("unit test", "dog")).toBe(false);
+
+  trigger.watchObjects = ["DoG"];
+  expect(trigger.isRegisteredForObject("unit test", "dog")).toBe(true);
+
+  trigger.watchObjects = ["dog"];
+  expect(trigger.isRegisteredForObject("unit test", "doG")).toBe(true);
+
+  trigger.watchObjects = ["cat", "elephant"];
+  expect(trigger.isRegisteredForObject("unit test", "dog")).toBe(false);
+
+  trigger.watchObjects = ["cat", "elephant"];
+  expect(trigger.isRegisteredForObject("unit test", undefined)).toBe(false);
+});
+
+test("Verify isRegisteredForObject()", async () => {
+  await expect(validateJsonAgainstSchema(triggerJson, triggerConfigJson)).resolves.toEqual(true);
+
+  // Check that case doesn't matter for string arrays that take an enum
+  triggerJson.triggers[0].watchObjects = ["dOg"];
+  await expect(validateJsonAgainstSchema(triggerJson, triggerConfigJson)).resolves.toEqual(true);
 });

tests/triggers.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://raw.githubusercontent.com/danecreekphotography/node-deepstackai-trigger/master/src/schemas/triggerConfiguration.schema.json",
+  "triggers": [
+    {
+      "name": "Dog detector",
+      "watchPattern": "/aiinput/Dog*.jpg",
+      "enabled": true,
+      "threshold": {
+        "minimum": 50,
+        "maximum": 100
+      },
+      "handlers": {
+        "webRequest": {
+          "triggerUris": ["http://localhost:81/admin?trigger&camera=Dog"]
+        },
+        "mqtt": {
+          "topic": "aimotion/triggers/dog"
+        },
+        "telegram": {
+          "chatIds": [1],
+          "cooldownTime": 60
+        }
+      },
+      "watchObjects": ["dog"]
+    }
+  ]
+}