Moved tRPC to Electron IPC from WebSocket

src/core/error-handling.ts

@@ -1,7 +1,6 @@
+import type { IsAny } from 'type-fest'
 import type { z } from 'zod'
 
-export type ToError<E> = E extends Error ? E : Error
-
 const toPath = (path: (number | string)[]) =>
   path
     .map((segment) => (typeof segment === 'number' ? `[${segment}]` : segment))
@@ -31,9 +30,12 @@ export function getMessage(cause: unknown) {
   return cause.message
 }
 
-export function toError<Cause>(cause: Cause) {
-  if (cause instanceof Error) return cause as ToError<Cause>
-  return new Error(String(cause)) as ToError<Cause>
+export type AsError<T> = IsAny<T> extends true ? Error : T extends Error ? T : Error
+
+export function toError<Cause>(cause: Cause): AsError<Cause>
+export function toError(cause: unknown) {
+  if (cause instanceof Error) return cause
+  return new Error(getMessage(cause))
 }
 
 export function raiseError(factory: () => Error): never {

src/core/rpc/ipc.ts

@@ -0,0 +1,7 @@
+import type { IpcMainInvokeEvent } from 'electron'
+
+export const theRpcChannel = 'trpc:msg'
+
+export interface CreateContextOptions {
+  event: IpcMainInvokeEvent
+}

src/core/rpc/transformer.ts

@@ -0,0 +1,36 @@
+import { Base64 } from 'js-base64'
+import { SuperJSON } from 'superjson'
+import { Attachment } from '../attachments'
+import { raiseError } from '../error-handling'
+
+export default function useSuperJson() {
+  SuperJSON.registerCustom(
+    {
+      isApplicable: (v) => v instanceof Attachment,
+      serialize: (attachment) => ({
+        name: attachment.name,
+        type: attachment.type,
+        data: Base64.fromUint8Array(attachment)
+      }),
+      deserialize: (attachment) =>
+        new Attachment(attachment.name, attachment.type, Base64.toUint8Array(attachment.data))
+    },
+    'Attachment'
+  )
+
+  // HACK: tRPC won't serialize functions; but doesn't filter
+  // them out, so IPC throws an error if they are passed.
+  // This can also ensure any types with functions
+  // won't be returned as seen in the return
+  // type information for the router.
+  SuperJSON.registerCustom(
+    {
+      isApplicable: (v): v is () => undefined => typeof v === 'function',
+      serialize: (_: () => undefined) => raiseError(() => new TypeError('Functions may not be serialized')),
+      deserialize: (_: never) => () => undefined
+    },
+    'Function'
+  )
+
+  return SuperJSON
+}

src/main/main.ts

@@ -5,8 +5,8 @@ import { app, shell, BrowserWindow, nativeTheme } from 'electron'
 import Logger from 'electron-log'
 import { sleep } from 'radash'
 import appIcon from '../../resources/icon.png?asset&asarUnpack'
-import useApiServer from './server'
-import { getAuthToken } from './services/trpc'
+import { useAppRouter } from './routes/router'
+import { createIpcHandler } from './services/rpc/ipc'
 import { logError } from './utilities'
 import { toError } from '@/error-handling'
 
@@ -18,7 +18,7 @@ Logger.transports.console.format = '{h}:{i}:{s}.{ms} [{level}] › {text}'
 Logger.transports.file.level = 'debug'
 Logger.errorHandler.startCatching()
 
-async function createWindow(port: number) {
+async function createWindow() {
   const willStartWithDark = nativeTheme.shouldUseDarkColors || nativeTheme.shouldUseInvertedColorScheme
 
   const window = new BrowserWindow({
@@ -27,7 +27,11 @@ async function createWindow(port: number) {
     backgroundColor: willStartWithDark ? '#121212' : 'white',
     icon: appIcon,
     show: true,
-    useContentSize: true
+    useContentSize: true,
+    webPreferences: {
+      preload: joinPath(__dirname, '../preload/index.mjs'),
+      sandbox: false
+    }
   })
 
   window.removeMenu()
@@ -55,14 +59,9 @@ async function createWindow(port: number) {
       // HMR for renderer base on electron-vite cli.
       // Load the remote URL for development or the local html file for production.
       if (is.dev && process.env.ELECTRON_RENDERER_URL != null) {
-        const url = new URL(process.env.ELECTRON_RENDERER_URL)
-        url.searchParams.set('port', String(port))
-        url.searchParams.set('auth', getAuthToken())
-        await window.loadURL(url.toString())
+        await window.loadURL(process.env.ELECTRON_RENDERER_URL)
       } else {
-        await window.loadFile(joinPath(__dirname, '../renderer/index.html'), {
-          query: { port: String(port), auth: getAuthToken() }
-        })
+        await window.loadFile(joinPath(__dirname, '../renderer/index.html'))
       }
 
       return window
@@ -110,5 +109,7 @@ await app.whenReady()
 // Set app user model id for windows
 electronApp.setAppUserModelId('org.sleepingcats.BridgeCmdr')
 
-const port = useApiServer()
-await createWindow(port)
+// If macOS close vs quit behavior is reimplemented, we will have
+// to make sure port and handler are accessible earlier.
+const handler = createIpcHandler({ router: useAppRouter() })
+handler.attachWindow(await createWindow())

src/main/routes/data/sources.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod'
 import { NewSource, SourceUpdate, useSourcesDatabase } from '../../dao/sources'
 import { DocumentId } from '../../services/database'
-import { procedure, router } from '../../services/trpc'
+import { procedure, router } from '../../services/rpc/trpc'
 import { Attachment } from '@/attachments'
 
 export type { Source, NewSource, SourceUpdate } from '../../dao/sources'

src/main/routes/data/storage.ts

@@ -1,7 +1,7 @@
 import { memo } from 'radash'
 import { z } from 'zod'
 import useUserStore from '../../dao/storage'
-import { procedure, router } from '../../services/trpc'
+import { procedure, router } from '../../services/rpc/trpc'
 
 const useUserStoreRouter = memo(function useUserStoreRouter() {
   const storage = useUserStore()

src/main/routes/data/switches.ts

@@ -1,6 +1,6 @@
 import { NewSwitch, SwitchUpdate, useSwitchesDatabase } from '../../dao/switches'
 import { DocumentId } from '../../services/database'
-import { procedure, router } from '../../services/trpc'
+import { procedure, router } from '../../services/rpc/trpc'
 
 export { Switch, NewSwitch, SwitchUpdate } from '../../dao/switches'
 

src/main/routes/data/ties.ts

@@ -1,6 +1,6 @@
 import useTiesDatabase, { NewTie, TieUpdate } from '../../dao/ties'
 import { DocumentId } from '../../services/database'
-import { procedure, router } from '../../services/trpc'
+import { procedure, router } from '../../services/rpc/trpc'
 
 export type { Tie, NewTie, TieUpdate } from '../../dao/ties'
 

src/main/routes/drivers.ts

@@ -1,7 +1,7 @@
 import { memo } from 'radash'
 import { z } from 'zod'
 import useDrivers from '../services/drivers'
-import { procedure, router } from '../services/trpc'
+import { procedure, router } from '../services/rpc/trpc'
 
 const Channel = z.number().int().nonnegative().finite()
 
@@ -12,7 +12,7 @@ const useDriversRouter = memo(function useDriversRoute() {
   const drivers = useDrivers()
 
   return router({
-    all: procedure.query(drivers.all),
+    all: procedure.query(drivers.allInfo),
     get: procedure.input(z.string().uuid()).query(async ({ input }) => {
       await drivers.get(input)
     }),

src/main/routes/ports.ts

@@ -1,7 +1,7 @@
 import { memo } from 'radash'
 import { z } from 'zod'
 import useSerialPorts from '../services/ports'
-import { procedure, router } from '../services/trpc'
+import { procedure, router } from '../services/rpc/trpc'
 
 const useSerialPortRouter = memo(function useSerialPortRouter() {
   const ports = useSerialPorts()

src/main/routes/router.ts

@@ -1,7 +1,7 @@
 import { memo } from 'radash'
 import useAppInfo from '../info/app'
 import useUserInfo from '../info/user'
-import { createCallerFactory, procedure, router } from '../services/trpc'
+import { procedure, router } from '../services/rpc/trpc'
 import useSourcesRouter from './data/sources'
 import useUserStoreRouter from './data/storage'
 import useSwitchesRouter from './data/switches'
@@ -32,4 +32,3 @@ export const useAppRouter = memo(() =>
 )
 
 export type AppRouter = ReturnType<typeof useAppRouter>
-export const createCaller = createCallerFactory(useAppRouter())

src/main/routes/startup.ts

@@ -1,6 +1,6 @@
 import { memo } from 'radash'
+import { procedure, router } from '../services/rpc/trpc'
 import useStartup from '../services/startup'
-import { procedure, router } from '../services/trpc'
 
 const useStartupRouter = memo(function useStartupRouter() {
   const startup = useStartup()

src/main/routes/system.ts

@@ -1,7 +1,7 @@
 import { memo } from 'radash'
 import { z } from 'zod'
+import { procedure, router } from '../services/rpc/trpc'
 import useSystem from '../services/system'
-import { procedure, router } from '../services/trpc'
 
 const useSystemRouter = memo(function useSystemRouter() {
   const system = useSystem()

src/main/routes/updater.ts

@@ -1,6 +1,6 @@
 import { observable } from '@trpc/server/observable'
 import { memo } from 'radash'
-import { procedure, router } from '../services/trpc'
+import { procedure, router } from '../services/rpc/trpc'
 import useUpdater from '../services/updater'
 import type { AppUpdaterEventMap } from '../services/updater'
 

src/main/services/drivers.ts

@@ -162,7 +162,13 @@ const useDrivers = memo(function useDriver() {
     }
   }
 
-  const all = defineOperation(() => Array.from(registry.values()).filter((driver) => driver.enabled))
+  const registered = defineOperation(() => Array.from(registry.values()).filter((driver) => driver.enabled))
+
+  const allInfo = defineOperation(() =>
+    Array.from(registry.values())
+      .filter((driver) => driver.enabled)
+      .map((d) => d.metadata)
+  )
 
   const get = defineOperation((guid: string) => registry.get(guid) ?? null)
 
@@ -193,7 +199,8 @@ const useDrivers = memo(function useDriver() {
   })
 
   return {
-    all,
+    registered,
+    allInfo,
     get,
     activate,
     powerOn,