sanitize model name (+ tests)

.editorconfig

@@ -0,0 +1,2 @@
+indent_style = space
+indent_size = 2

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Use Node.js ${{ matrix.node-version }} 
+      - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
@@ -25,6 +25,9 @@ jobs:
       - name: Lint the project
         run: npm run lint
 
+      - name: Test the project
+        run: npm run test
+
       - name: Build the project
         run: npm run build
         env:

jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/src/**/*.spec.ts'],
+};

package.json

@@ -20,7 +20,10 @@
     "lint": "eslint src/**.ts",
     "watch": "npm run build && nodemon",
     "build": "rimraf ./dist && tsc",
-    "prepublishOnly": "npm run lint && npm run build"
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:ci": "jest --ci",
+    "prepublishOnly": "npm run lint && npm run test:ci && npm run build"
   },
   "keywords": [
     "homebridge-plugin",
@@ -37,13 +40,16 @@
     "govee-bt-client": "1.0.11"
   },
   "devDependencies": {
+    "@types/jest": "^26.0.21",
     "@types/node": "^14.11.2",
     "@typescript-eslint/eslint-plugin": "^3.10.1",
     "@typescript-eslint/parser": "^3.10.1",
     "eslint": "^7.10.0",
+    "jest": "^26.6.3",
     "homebridge": "^1.2.3",
     "nodemon": "^2.0.4",
     "rimraf": "^3.0.2",
+    "ts-jest": "^26.5.4",
     "ts-node": "^8.10.2",
     "typescript": "^3.9.7"
   }

src/utils.spec.ts

@@ -0,0 +1,19 @@
+import { sanitizeDeviceName } from "./utils";
+
+describe("sanitizeDeviceName", () => {
+  it("should handle mixed case", () => {
+    const original = "Ab3dE";
+    const s = sanitizeDeviceName(original);
+    expect(s).toEqual(original);
+  });
+
+  it("should ignore underscore", () => {
+    const s = sanitizeDeviceName("a_b");
+    expect(s).toEqual("ab");
+  });
+
+  it("should ignore disallowed characters", () => {
+    const s = sanitizeDeviceName("abцd");
+    expect(s).toEqual("abd");
+  });
+});

src/utils.ts

@@ -0,0 +1,71 @@
+const lowerAlpha = [
+  "a",
+  "b",
+  "c",
+  "d",
+  "e",
+  "f",
+  "g",
+  "h",
+  "i",
+  "j",
+  "k",
+  "l",
+  "m",
+  "n",
+  "o",
+  "p",
+  "q",
+  "r",
+  "s",
+  "t",
+  "u",
+  "v",
+  "w",
+  "x",
+  "y",
+  "z",
+];
+const upperAlpha = [
+  "A",
+  "B",
+  "C",
+  "D",
+  "E",
+  "F",
+  "G",
+  "H",
+  "I",
+  "J",
+  "K",
+  "L",
+  "M",
+  "N",
+  "O",
+  "P",
+  "Q",
+  "R",
+  "S",
+  "T",
+  "U",
+  "V",
+  "W",
+  "X",
+  "Y",
+  "Z",
+];
+const numeric = ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9"];
+
+const allowedCharsSet = new Set([...lowerAlpha, ...upperAlpha, ...numeric]);
+
+export function sanitizeDeviceName(s: string): string {
+  const out: string[] = [];
+  for (const c of s) {
+    if (!allowedCharsSet.has(c)) {
+      continue;
+    }
+    out.push(c);
+  }
+
+  return out.join("");
+}