guest registar staging app (#1026)

Deploys app that can connect to UDM and receive real time events on
clients' status and network connection state.

#1002

Author: andrew-codes

.pnp.cjs

@@ -0,0 +1,26 @@
+{
+  "name": "@ha/guest-registrar-unifi",
+  "version": "0.0.1",
+  "description": "Register guests upon connecting phone devices to the Unifi guest network.",
+  "dependencies": {
+    "@ha/logger": "workspace:^0.0.1",
+    "@ha/mqtt-client": "workspace:^0.0.1",
+    "axios": "^1.8.4",
+    "lodash": "^4.17.21",
+    "ws": "^8.18.1"
+  },
+  "devDependencies": {
+    "@ha/build-ts": "workspace:^1.0.0",
+    "@ha/configuration-api": "workspace:^0.0.1",
+    "@ha/configuration-workspace": "workspace:^0.0.1",
+    "@ha/docker": "workspace:^0.0.1",
+    "@ha/nx-executors": "workspace:^0.1.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^18.19.76",
+    "@types/nodemon": "^3.1.1",
+    "esbuild": "^0.25.2",
+    "esbuild-register": "^3.6.0",
+    "nodemon": "^3.1.9",
+    "nx": "^20.7.0"
+  }
+}

.yarn/cache/@esbuild-darwin-arm64-npm-0.25.2-db3ebc4e25-10.zip

@@ -0,0 +1,37 @@
+{
+  "name": "guest-registrar-unifi",
+  "sourceRoot": "{projectRoot}/src",
+  "projectType": "application",
+  "targets": {
+    "start": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "yarn node --trace-warnings --require esbuild-register scripts/nodemon.ts",
+        "cwd": "{projectRoot}"
+      }
+    },
+    "compile": {
+      "executor": "@ha/nx-executors:invoke",
+      "options": {
+        "cwd": "{projectRoot}",
+        "module": "scripts/compile.ts"
+      }
+    },
+    "package": {
+      "executor": "@ha/nx-executors:invoke",
+      "options": {
+        "cwd": "{projectRoot}",
+        "module": "scripts/package.ts"
+      }
+    },
+    "publish": {
+      "executor": "@ha/nx-executors:invoke",
+      "options": {
+        "cwd": "{projectRoot}",
+        "module": "scripts/publish.ts"
+      }
+    }
+  },
+  "tags": [],
+  "implicitDependencies": []
+}

.yarn/cache/@types-nodemon-npm-3.1.1-687e43baab-5e07f8ba46.zip

@@ -0,0 +1,12 @@
+import build from "@ha/build-ts"
+import type { ConfigurationApi } from "@ha/configuration-api"
+
+import type { Configuration } from "@ha/configuration-workspace"
+
+const run = async (
+  configurationApi: ConfigurationApi<Configuration>,
+): Promise<void> => {
+  await build()
+}
+
+export default run

.yarn/cache/esbuild-npm-0.25.2-1486e883dd-3b16423d33.zip

@@ -0,0 +1,33 @@
+import nodemon from "nodemon"
+import path from "path"
+
+const run = async () => {
+  nodemon({
+    verbose: true,
+    ignore: ["*.test.js", "fixtures/*"],
+    watch: [path.join(__dirname, "..", "src")],
+    script: path.join(__dirname, "..", "src", "index.ts"),
+    execMap: {
+      js: "yarn node --require esbuild-register",
+      ts: "yarn node --require esbuild-register",
+      tsx: "yarn node --require esbuild-register",
+    },
+  })
+    .on("start", () => {
+      console.log("nodemon started")
+    })
+    .on("restart", (files) => {
+      console.log("nodemon restarted")
+    })
+    .on("exit", () => {
+      console.log("exiting")
+    })
+    .on("quit", () => console.log("quiting"))
+    .on("crash", () => console.log("crashed"))
+}
+
+if (require.main === module) {
+  run()
+}
+
+export default run

.yarn/cache/nodemon-npm-3.1.9-f1382c5541-7c01ddfa30.zip

@@ -0,0 +1,16 @@
+import type { ConfigurationApi } from "@ha/configuration-api"
+import type { Configuration } from "@ha/configuration-workspace"
+import createClient from "@ha/docker"
+import path from "path"
+
+const run = async (
+  configurationApi: ConfigurationApi<Configuration>,
+): Promise<void> => {
+  const docker = await createClient(configurationApi)
+  await docker.build(`guest-registrar-unifi:latest`, {
+    context: path.join(__dirname, "../"),
+    dockerFile: path.join("src", "Dockerfile"),
+  })
+}
+
+export default run

.yarn/cache/simple-update-notifier-npm-2.0.0-4d6e5dba61-40bd4f96aa.zip

@@ -0,0 +1,12 @@
+import type { ConfigurationApi } from "@ha/configuration-api"
+import type { Configuration } from "@ha/configuration-workspace"
+import createClient from "@ha/docker"
+
+const run = async (
+  configurationApi: ConfigurationApi<Configuration>,
+): Promise<void> => {
+  const docker = await createClient(configurationApi)
+  await docker.pushImage(`guest-registrar-unifi:latest`)
+}
+
+export default run

.yarn/cache/ws-npm-8.18.1-369b0f5491-3f38e9594f.zip

@@ -0,0 +1,9 @@
+FROM node:22.14.0-alpine
+
+WORKDIR /app
+
+ENV NODE_ENV production
+
+COPY dist dist
+
+ENTRYPOINT [ "node", "dist/index.js" ]

apps/guest-registrar-unifi/package.json

@@ -0,0 +1,156 @@
+import { logger } from "@ha/logger"
+import axios from "axios"
+import https from "https"
+import { isEmpty, throttle } from "lodash"
+import { env } from "node:process"
+import WebSocket from "ws"
+
+interface IHandleWebSocketMessage {
+  (messageType: string, payload: any): void
+}
+
+const connectWebSocket = async (
+  messageHandlers: Array<IHandleWebSocketMessage>,
+) => {
+  const { UNIFI_IP, UNIFI_USERNAME, UNIFI_PASSWORD } = env
+  logger.debug(
+    `Connecting to Unifi controller at ${UNIFI_IP} with username ${UNIFI_USERNAME}`,
+  )
+  const api = axios.create({
+    baseURL: `https://${UNIFI_IP}`,
+    withCredentials: true,
+    httpsAgent: new https.Agent({ rejectUnauthorized: false }),
+  })
+
+  const cookieJar = {}
+  const response = await api.post("/api/auth/login", {
+    username: UNIFI_USERNAME,
+    password: UNIFI_PASSWORD,
+    rememberMe: true,
+    remember: true,
+  })
+  const cookies = response.headers["set-cookie"]
+  if (cookies) {
+    cookies.forEach((cookie) => {
+      const [key, value] = cookie.split(";")[0].split("=")
+      cookieJar[key] = value
+    })
+  }
+  const cookieString = Object.entries(cookieJar)
+    .map(([key, value]) => `${key}=${value}`)
+    .join("; ")
+
+  const ws = new WebSocket(
+    `wss://${UNIFI_IP}/proxy/network/wss/s/default/events`,
+    {
+      headers: {
+        Cookie: cookieString,
+        Upgrade: "websocket",
+      },
+      rejectUnauthorized: false,
+    },
+  )
+
+  const connectionTimeout = setTimeout(() => {
+    if (ws.readyState !== WebSocket.OPEN) {
+      ws.terminate()
+      logger.info("Connection attempt timed out, retrying...")
+      setTimeout(connectWebSocket, 5000)
+    }
+  }, 10000)
+
+  ws.on("open", () => {
+    clearTimeout(connectionTimeout)
+    logger.info("WebSocket connection established")
+
+    // Set up a keepalive ping
+    const pingInterval = setInterval(() => {
+      if (ws.readyState === WebSocket.OPEN) {
+        ws.ping()
+      } else {
+        clearInterval(pingInterval)
+      }
+    }, 30000)
+  })
+
+  ws.on("message", (data) => {
+    const event = JSON.parse(data)
+    if (event.data && event.meta && event.meta.message) {
+      const msgType = event.meta.message
+      switch (msgType) {
+        case "sta:sync":
+          for (const handler of messageHandlers) {
+            try {
+              handler(msgType, event.data)
+            } catch (error) {
+              logger.error(`Error in message handler: ${error}`)
+            }
+          }
+          break
+        default:
+          break
+      }
+    }
+  })
+
+  ws.on("close", (code, reason) => {
+    logger.debug(`WebSocket closed: ${code} - ${reason}`)
+    logger.info("Connection closed, attempting to reconnect...")
+    setTimeout(connectWebSocket, 5000)
+  })
+
+  ws.on("error", (error) => {
+    logger.error(`WebSocket error: ${error.message}`)
+    if (ws.readyState !== WebSocket.OPEN) {
+      ws.terminate()
+      setTimeout(connectWebSocket, 5000)
+    }
+  })
+}
+
+const run = async () => {
+  logger.info("Starting guest-registrar-unifi application...")
+  // const mqtt = await createMqtt()
+  const handleClientStat = throttle(
+    (type: string, payload: any) => {
+      if (type !== "sta:sync") {
+        return
+      }
+      logger.debug("Handling client stat")
+      const data = payload as Array<{
+        confidence?: number
+        dev_cat?: number
+        dev_family?: number
+        mac: string
+        name: string
+        hostname: string
+        network: string
+        os_name?: number
+        is_guest: boolean
+      }>
+      const guestDeviceTrackers = data
+        .filter((client) => client.is_guest)
+        .filter(
+          (client) =>
+            (((client.dev_cat === 1 || client.dev_family === 9) &&
+              client?.confidence) ??
+              0 >= 50) ||
+            /.*phone.*/i.test(client.hostname),
+        )
+      if (!isEmpty(guestDeviceTrackers)) {
+        console.debug(
+          `${guestDeviceTrackers.length} guest device trackers found: ${guestDeviceTrackers.map((client) => `[${client.hostname}, ${client.mac}]`).join(", ")}`,
+        )
+      }
+    },
+    { leading: true, trailing: false, wait: 60000 },
+  )
+  const handlers = [handleClientStat]
+  await connectWebSocket(handlers)
+}
+
+if (require.main === module) {
+  run()
+}
+
+export default run

apps/guest-registrar-unifi/project.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "include": [
+      "src/**/*.ts",
+      "scripts/**/*.ts"
+    ],
+    "types": ["@types/node", "@types/jest", "@types/nodemon"]
+  }
+}

apps/guest-registrar-unifi/scripts/compile.ts

@@ -6,8 +6,6 @@
     "@ha/configuration-api": "workspace:^0.0.1",
     "@ha/configuration-workspace": "workspace:^0.0.1",
     "@ha/docker": "workspace:^0.0.1",
-    "@ha/jsonnet": "workspace:^0.0.1",
-    "@ha/kubectl": "workspace:^1.0.0",
     "@ha/nx-executors": "workspace:^0.1.0",
     "nx": "^20.7.0"
   }

apps/guest-registrar-unifi/scripts/nodemon.ts

@@ -35,6 +35,25 @@ spec:
 ---
 apiVersion: kustomize.toolkit.fluxcd.io/v1
 kind: Kustomization
+metadata:
+  name: guest-registrar-unifi
+  namespace: default
+spec:
+  dependsOn:
+    - name: sealed-secrets
+    - name: secrets
+    - name: mqtt
+  interval: 10m0s
+  sourceRef:
+    kind: GitRepository
+    name: default
+  path: ./deployments/staging/guest-registrar-unifi
+  prune: true
+  wait: true
+  timeout: 5m0s
+---
+apiVersion: kustomize.toolkit.fluxcd.io/v1
+kind: Kustomization
 metadata:
   name: grafana
   namespace: default
@@ -165,3 +184,4 @@ spec:
   timeout: 5m0s
 ---
 
+