Improved serialport implementation

apps/app/src/main/index.ts

@@ -32,10 +32,10 @@ function createWindow(): void {
   mainWindow.webContents.openDevTools()
 
   mainWindow.on("ready-to-show", () => {
+    mainWindow.show()
+
     initSerialPort(ipcMain, mainWindow.webContents)
     initSql(ipcMain)
-
-    mainWindow.show()
   })
 
   mainWindow.webContents.setWindowOpenHandler((details) => {
@@ -66,9 +66,6 @@ app.whenReady().then(() => {
     optimizer.watchWindowShortcuts(window)
   })
 
-  // IPC test
-  ipcMain.on("ping", () => console.log("pong"))
-
   createWindow()
 
   app.on("activate", function () {

apps/web/src/app/app.spec.tsx

@@ -5,19 +5,19 @@
 
 import { render } from "@testing-library/react"
 import App from "./app"
-import { Device } from "app-serialport/models"
+import { SerialPortDeviceInfo } from "app-serialport/models"
 
 jest.mock("app-serialport/renderer", () => {
   return {
     AppSerialPort: {
-      onChange: jest.fn().mockResolvedValue([
+      onDevicesChanged: jest.fn().mockResolvedValue([
         {
           vendorId: "0e8d",
           productId: "2006",
           path: "/dev/ttyUSB0.KOM123456789",
         },
-      ] as Device[]),
-      write: jest.fn(),
+      ] as SerialPortDeviceInfo[]),
+      request: jest.fn(),
     },
   }
 })

apps/web/src/app/serialport-demo.ts

@@ -3,153 +3,58 @@
  * For licensing, see https://github.com/mudita/mudita-center/blob/master/LICENSE.md
  */
 
-import { useCallback, useEffect, useRef } from "react"
-import { AppSerialPort } from "app-serialport/renderer"
-import { ChangedDevices } from "app-serialport/models"
+import { useCallback, useEffect } from "react"
 import { isEmpty } from "lodash"
+import { SerialPortDeviceInfo } from "app-serialport/models"
+import { AppSerialPort } from "app-serialport/renderer"
 
 export const useSerialPortListener = () => {
-  // const interval = useRef<NodeJS.Timeout>()
-  const ref = useRef(false)
-
-  const listenPorts = useCallback(async () => {
-    if (!ref.current) {
-      ref.current = true
-      const onAttach = async (added: NonNullable<ChangedDevices["added"]>) => {
-        const apiConfigurationResponse = await AppSerialPort.write(added.path, {
-          endpoint: "API_CONFIGURATION",
-          method: "GET",
-          body: {},
-          options: {
-            connectionTimeOut: 30000,
-          },
-        })
-        const entitiesConfigurationResponse = await AppSerialPort.write(
-          added.path,
-          {
-            endpoint: "ENTITIES_CONFIGURATION",
-            method: "GET",
-            body: {
-              entityType: "contacts",
-            },
-            options: {
-              connectionTimeOut: 30000,
-            },
-          }
-        )
-        console.log({ apiConfigurationResponse, entitiesConfigurationResponse })
-      }
-      AppSerialPort.onChange((changes) => {
-        console.log(changes)
-        if (!isEmpty(changes.added)) {
-          void onAttach(changes.added)
-        }
+  const listenForDevicesChange = useCallback(async () => {
+    const onAttach = async (device: SerialPortDeviceInfo) => {
+      const resp1 = await AppSerialPort.request(device.path, {
+        endpoint: "API_CONFIGURATION",
+        method: "GET",
+        body: {},
+        options: {
+          connectionTimeOut: 30000,
+        },
+      })
+      console.log(resp1)
+
+      const resp2 = await AppSerialPort.request(device.path, {
+        endpoint: "ENTITIES_CONFIGURATION",
+        method: "GET",
+        body: {
+          entityType: "contacts",
+        },
+        options: {
+          connectionTimeOut: 30000,
+        },
+      })
+      console.log(resp2)
+
+      const resp3 = await AppSerialPort.request(device.path, {
+        endpoint: "ENTITIES_DATA",
+        method: "GET",
+        body: {
+          entityType: "contacts",
+          responseType: "json",
+        },
+        options: {
+          connectionTimeOut: 30000,
+        },
       })
+      console.log(resp3)
     }
-
-    // const req1 = () =>
-    //   AppSerialPort.write(ports[0].path, {
-    //     endpoint: "API_CONFIGURATION",
-    //     method: "GET",
-    //     body: {},
-    //     options: {
-    //       connectionTimeOut: 30000,
-    //     },
-    //   })
-
-    // const req2 = () =>
-    //   AppSerialPort.write(ports[0].path, {
-    //     endpoint: "ENTITIES_CONFIGURATION",
-    //     method: "GET",
-    //     body: {
-    //       entityType: "contacts",
-    //     },
-    //     options: {
-    //       connectionTimeOut: 30000,
-    //     },
-    //   })
-
-    // await AppSerialPort.write(ports[0].path, {
-    //   endpoint: "API_CONFIGURATION",
-    //   method: "GET",
-    //   body: {},
-    //   options: {
-    //     connectionTimeOut: 30000,
-    //   },
-    // })
-    // await new Promise((resolve) => setTimeout(resolve, 100))
-    // await AppSerialPort.write(ports[0].path, {
-    //   endpoint: "ENTITIES_CONFIGURATION",
-    //   method: "GET",
-    //   body: {
-    //     entityType: "contacts",
-    //   },
-    //   options: {
-    //     connectionTimeOut: 30000,
-    //   },
-    // })
-    // await new Promise((resolve) => setTimeout(resolve, 100))
-    // void AppSerialPort.write(ports[0].path, {
-    //   endpoint: "ENTITIES_DATA",
-    //   method: "GET",
-    //   body: {
-    //     entityType: "contacts",
-    //     responseType: "json",
-    //   },
-    //   options: {
-    //     connectionTimeOut: 30000,
-    //   },
-    // })
-    // await new Promise((resolve) => setTimeout(resolve, 100))
-    // await AppSerialPort.write(ports[0].path, {
-    //   endpoint: "ENTITIES_CONFIGURATION",
-    //   method: "GET",
-    //   body: {
-    //     entityType: "contacts",
-    //   },
-    //   options: {
-    //     connectionTimeOut: 30000,
-    //   },
-    // })
-
-    Promise.all([
-      // AppSerialPort.write(ports[0].path, {
-      //   endpoint: "API_CONFIGURATION",
-      //   method: "GET",
-      //   body: {},
-      //   options: {
-      //     connectionTimeOut: 30000,
-      //   },
-      // }),
-      // AppSerialPort.write(ports[0].path, {
-      //   endpoint: "ENTITIES_CONFIGURATION",
-      //   method: "GET",
-      //   body: {
-      //     entityType: "contacts",
-      //   },
-      //   options: {
-      //     connectionTimeOut: 30000,
-      //   },
-      // }),
-      // AppSerialPort.write(ports[0].path, {
-      //   endpoint: "ENTITIES_DATA",
-      //   method: "GET",
-      //   body: {
-      //     entityType: "contacts",
-      //     responseType: "json",
-      //   },
-      //   options: {
-      //     connectionTimeOut: 30000,
-      //   },
-      // }),
-    ]).then((resp) => {
-      console.log(resp)
+    AppSerialPort.onDevicesChanged((changes) => {
+      console.log(changes)
+      if (!isEmpty(changes.added)) {
+        void onAttach(changes.added[0])
+      }
     })
   }, [])
 
   useEffect(() => {
-    void listenPorts()
-    // interval.current = setInterval(listenPorts, 2000)
-    // return () => clearInterval(interval.current)
-  }, [listenPorts])
+    void listenForDevicesChange()
+  }, [listenForDevicesChange])
 }

apps/web/src/main.tsx

@@ -3,13 +3,8 @@
  * For licensing, see https://github.com/mudita/mudita-center/blob/master/LICENSE.md
  */
 
-import { StrictMode } from "react"
 import * as ReactDOM from "react-dom/client"
 import App from "./app/app"
 
 const root = ReactDOM.createRoot(document.getElementById("root") as HTMLElement)
-root.render(
-  <StrictMode>
-    <App />
-  </StrictMode>
-)
+root.render(<App />)

jest.config.ts

@@ -5,11 +5,6 @@
 
 import { getJestProjectsAsync } from "@nx/jest"
 
-void (async () => {
-  const p = await getJestProjectsAsync()
-  console.log(p)
-})()
-
 export default async () => ({
   projects: await getJestProjectsAsync(),
 })

libs/app-serialport/devices/.babelrc

@@ -0,0 +1,11 @@
+{
+  "presets": [
+    [
+      "@nx/react/babel",
+      {
+        "runtime": "automatic",
+        "useBuiltIns": "usage"
+      }
+    ]
+  ]
+}

libs/app-serialport/devices/README.md

@@ -0,0 +1,7 @@
+# app-serialport-devices
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test app-serialport-devices` to execute the unit tests via [Vitest](https://vitest.dev/).

libs/app-serialport/devices/eslint.config.js

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Mudita sp. z o.o. All rights reserved.
+ * For licensing, see https://github.com/mudita/mudita-center/blob/master/LICENSE.md
+ */
+
+const nx = require("@nx/eslint-plugin")
+const baseConfig = require("../../../eslint.config.js")
+
+module.exports = [
+  ...baseConfig,
+  ...nx.configs["flat/react"],
+  {
+    files: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"],
+    // Override or add rules here
+    rules: {},
+  },
+]

libs/app-serialport/devices/jest.config.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Mudita sp. z o.o. All rights reserved.
+ * For licensing, see https://github.com/mudita/mudita-center/blob/master/LICENSE.md
+ */
+
+export default {
+  displayName: "app-serialport-devices",
+  preset: "../../../jest.preset.js",
+  transform: {
+    "^(?!.*\\.(js|jsx|ts|tsx|css|json)$)": "@nx/react/plugins/jest",
+    "^.+\\.[tj]sx?$": ["babel-jest", { presets: ["@nx/react/babel"] }],
+  },
+  moduleFileExtensions: ["ts", "tsx", "js", "jsx"],
+  coverageDirectory: "../../../coverage/libs/app-serialport/devices",
+}

libs/app-serialport/devices/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "app-serialport/devices",
+  "version": "0.0.1",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
+  }
+}

libs/app-serialport/devices/project.json

@@ -0,0 +1,9 @@
+{
+  "name": "app-serialport-devices",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/app-serialport/devices/src",
+  "projectType": "library",
+  "tags": ["scope:main"],
+  "// targets": "to see all targets run: nx show project app-serialport-devices --web",
+  "targets": {}
+}

libs/app-serialport/models/src/lib/serialport-ipc-events.ts → libs/app-serialport/devices/src/index.ts

@@ -3,7 +3,5 @@
  * For licensing, see https://github.com/mudita/mudita-center/blob/master/LICENSE.md
  */
 
-export enum SerialportIpcEvents {
-  Change = "serialport:change",
-  Write = "serialport:write",
-}
+export * from "./lib/serial-port-device"
+export * from "./lib/devices"

libs/app-serialport/devices/src/lib/api-device/api-device-request-parser.test.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) Mudita sp. z o.o. All rights reserved.
+ * For licensing, see https://github.com/mudita/mudita-center/blob/master/LICENSE.md
+ */
+
+import {
+  apiDeviceRequestParser,
+  ApiDeviceRequest,
+} from "./api-device-request-parser"
+
+describe("apiDeviceRequestParser", () => {
+  const request: ApiDeviceRequest = {
+    rid: 1,
+    endpoint: "API_CONFIGURATION",
+    method: "GET",
+  }
+
+  it("returns a proper starting with #", () => {
+    const result = apiDeviceRequestParser(request)
+    expect(result[0]).toBe("#")
+  })
+
+  it("properly calculates the length of the payload", () => {
+    const result = apiDeviceRequestParser(request)
+    expect(result.slice(1, 10)).toBe("000000055")
+  })
+
+  it("properly attaches the payload", () => {
+    const result = apiDeviceRequestParser(request)
+    expect(result.slice(10)).toBe(JSON.stringify(request))
+  })
+})