refactor(desktop): simplify TypeScript contracts and test mocks (#214)

Author: AkiKurisu

desktop/src/main/appServerRetry.ts

@@ -1,8 +1,6 @@
 import type { ConnectionMode } from './settings'
-
-export interface RetryConnectionRequest {
-  restartManaged?: boolean
-}
+import type { RetryConnectionRequest } from '../shared/connectionStatus'
+export type { RetryConnectionRequest } from '../shared/connectionStatus'
 
 export interface AppServerRetryContext {
   currentWorkspacePath: string

desktop/src/main/browserUseManager.ts

@@ -18,6 +18,13 @@ import {
   normalizeBrowserUseDomainList,
   resolveBrowserUseNavigationDecision
 } from './browserUsePolicy'
+import type {
+  BrowserUseApprovalRequestPayload,
+  BrowserUseApprovalResponseAction,
+  BrowserUseApprovalResponsePayload,
+  BrowserUseClosePayload,
+  BrowserUseOpenPayload
+} from '../shared/viewer/types'
 
 const require = createRequire(import.meta.url)
 const playwrightCoreRoot = dirname(require.resolve('playwright-core/package.json'))
@@ -242,35 +249,6 @@ export interface BrowserUseImageResult {
   dataBase64: string
 }
 
-export interface BrowserUseOpenPayload {
-  threadId: string
-  tabId: string
-  initialUrl: string
-  title?: string
-  focusMode: 'first-open' | 'none'
-}
-
-export interface BrowserUseClosePayload {
-  threadId: string
-  tabId: string
-}
-
-export type BrowserUseApprovalResponseAction = 'allowOnce' | 'allowDomain' | 'blockDomain' | 'deny'
-
-export interface BrowserUseApprovalRequestPayload {
-  requestId: string
-  threadId: string
-  tabId: string
-  url: string
-  domain: string
-  sessionName?: string
-}
-
-export interface BrowserUseApprovalResponsePayload {
-  requestId: string
-  action: BrowserUseApprovalResponseAction
-}
-
 interface BrowserUseViewerHost {
   createAutomationTab(win: BrowserWindow, params: {
     tabId: string

desktop/src/main/channelModuleManager.ts

@@ -1,26 +1,22 @@
 import { promises as fs } from 'fs'
 import * as path from 'path'
 import type { DesktopAppServerClient } from './DesktopAppServerClient'
-import type { DiscoveredModule } from './moduleScanner'
-import { QrFileWatcher, type QrUpdatePayload } from './qrWatcher'
-
-export type ProcessState = 'starting' | 'running' | 'stopping' | 'stopped' | 'crashed'
+import type {
+  DiscoveredModule,
+  ModuleProcessState,
+  ModuleStatusMap,
+  QrUpdatePayload
+} from '../shared/channelModules'
+export type { ModuleStatusEntry, ModuleStatusMap } from '../shared/channelModules'
+import { QrFileWatcher } from './qrWatcher'
 
 interface ManagedModuleProcess {
   moduleId: string
   channelName: string
-  state: ProcessState
+  state: ModuleProcessState
   failureCode: string | null
 }
 
-export interface ModuleStatusEntry {
-  processState: ProcessState
-  connected: boolean
-  failureCode?: string
-}
-
-export type ModuleStatusMap = Record<string, ModuleStatusEntry>
-
 interface ChannelStatusWire {
   name: string
   enabled: boolean

desktop/src/main/chromeSetup.ts

@@ -4,28 +4,13 @@ import { existsSync, promises as fsPromises, readFileSync } from 'fs'
 import { tmpdir } from 'os'
 import { join } from 'path'
 import net from 'net'
+import type { ChromeSetupCheckStatus, ChromeSetupStatus } from '../shared/chromeSetup'
+export type { ChromeSetupCheckStatus, ChromeSetupStatus } from '../shared/chromeSetup'
 
 export interface ChromeOpenRequest {
   url?: string
 }
 
-export interface ChromeSetupCheckStatus {
-  ok: boolean
-  code: string
-  message: string
-  action?: string
-  safeDetails?: Record<string, string | number | boolean>
-}
-
-export interface ChromeSetupStatus {
-  extension: ChromeSetupCheckStatus
-  nativeHost: ChromeSetupCheckStatus
-  chromeRunning: ChromeSetupCheckStatus
-  installedBrowsers: ChromeSetupCheckStatus
-  backend: ChromeSetupCheckStatus
-  bridge: ChromeSetupCheckStatus
-}
-
 export function resolveBundledChromePluginRoot(): string {
   if (app.isPackaged) {
     return join(process.resourcesPath, 'plugins', 'dotcraft-bundled', 'plugins', 'chrome')

desktop/src/main/externalEditors.ts

@@ -2,25 +2,8 @@ import { access, stat } from 'fs/promises'
 import * as path from 'path'
 import { execFile, spawn, type ChildProcess, type SpawnOptions } from 'child_process'
 import { app, shell } from 'electron'
-
-export type EditorId =
-  | 'explorer'
-  | 'vs'
-  | 'cursor'
-  | 'vscode'
-  | 'rider'
-  | 'webstorm'
-  | 'idea'
-  | 'github-desktop'
-  | 'git-bash'
-  | 'terminal'
-
-export interface EditorInfo {
-  id: EditorId
-  labelKey: string
-  iconKey: string
-  iconDataUrl?: string
-}
+import type { EditorId, EditorInfo } from '../shared/externalEditors'
+export type { EditorId, EditorInfo } from '../shared/externalEditors'
 
 interface EditorDescriptor extends EditorInfo {
   command: string

desktop/src/main/index.ts

@@ -55,10 +55,12 @@ import {
   createServerRequestBridge,
   sanitizeHttpOrHttpsUrl,
   openExternalHttpUrl,
-  type ConnectionErrorType,
-  type ConnectionStatusPayload,
   type IpcHandlerCallbacks
 } from './ipcBridge'
+import type {
+  ConnectionErrorType,
+  ConnectionStatusPayload
+} from '../shared/connectionStatus'
 import {
   loadSettings,
   saveSettings,
@@ -105,11 +107,13 @@ import {
   shouldRouteWorkspaceThroughSetupBeforeAppServerStart,
   runWorkspaceSetup,
   listSetupModels,
-  loginSetupChatGpt,
-  type WorkspaceStatusPayload,
-  type WorkspaceSetupRequest,
-  type WorkspaceSetupModelListRequest
+  loginSetupChatGpt
 } from './workspaceSetup'
+import type {
+  WorkspaceSetupModelListRequest,
+  WorkspaceSetupRequest,
+  WorkspaceStatusPayload
+} from '../shared/workspaceSetup'
 import { encodeInitialWorkspaceStatusArg } from '../shared/initialWorkspaceStatus'
 import { getEnabledEmbeddedModuleChannelNames } from '../shared/channelModulePersistence'
 import { applyWindowBackdropTheme, resolveInitialTheme, resolveWindowBackdropOptions } from './windowTheme'

desktop/src/main/ipcBridge.ts

@@ -60,7 +60,8 @@ import {
 } from './desktopExtensionGrants'
 import { partitionForWorkspace, viewerBrowserManager } from './viewerBrowser'
 import { viewerTerminalManager } from './viewerTerminal'
-import { browserUseManager, type BrowserUseApprovalResponsePayload } from './browserUseManager'
+import { browserUseManager } from './browserUseManager'
+import type { BrowserUseApprovalResponsePayload } from '../shared/viewer/types'
 import {
   checkChromeSetup,
   installChromeNativeHost,
@@ -79,11 +80,11 @@ import {
 import type { QrUpdatePayload } from './qrWatcher'
 import type {
   WorkspaceSetupRequest,
-  WorkspaceSetupResult,
   WorkspaceStatusPayload,
   WorkspaceSetupModelListRequest,
   WorkspaceSetupModelListResult
-} from './workspaceSetup'
+} from '../shared/workspaceSetup'
+import type { WorkspaceSetupResult } from './workspaceSetup'
 import { normalizeRemoteHosts, type RemoteHost, type RemoteStack } from '../shared/remoteServers'
 import { translate, normalizeLocale, DEFAULT_LOCALE, type AppLocale } from '../shared/locales'
 import { parseJsonObjectConfig } from '../shared/jsonConfig'
@@ -112,46 +113,22 @@ import { sendDesktopAppServerRequest } from './desktopRuntimeThreadTools'
 import { resolveBundledBuiltInPluginRoot } from './ripgrepRuntime'
 import type { WorkspaceProjectsPayload } from '../shared/workspaceProjects'
 import type { AppServerRequestMethod } from '../shared/appServerBoundary'
+import type {
+  ConnectionStatusPayload,
+  RetryConnectionRequest
+} from '../shared/connectionStatus'
 
 interface WindowVisibilityState {
   minimized: boolean
   visible: boolean
   focused: boolean
 }
 
-export type ConnectionStatus = 'connecting' | 'connected' | 'disconnected' | 'error'
-
-export type ConnectionErrorType = 'binary-not-found' | 'handshake-timeout' | 'crash' | 'remote-config-invalid'
-
-export interface ConnectionStatusPayload {
-  status: ConnectionStatus
-  serverInfo?: {
-    name: string
-    version: string
-    protocolVersion?: string
-  }
-  capabilities?: Record<string, unknown>
-  /** DashBoard URL when the server hosts it (initialize). */
-  dashboardUrl?: string
-  errorMessage?: string
-  errorType?: ConnectionErrorType
-  binarySource?: BinarySource
-}
-
-export interface RetryConnectionRequest {
-  restartManaged?: boolean
-}
-
 export interface ResolvedBinaryRequest {
   binarySource?: BinarySource
   binaryPath?: string
 }
 
-export interface ResolvedBinaryPayload {
-  source: BinarySource
-  path: string | null
-}
-
 interface ModulesRescanSummaryPayload {
   addedModuleIds: string[]
   removedModuleIds: string[]

desktop/src/main/moduleScanner.ts

@@ -4,68 +4,20 @@ import type { Dirent } from 'fs'
 import * as path from 'path'
 import type { AppSettings } from './settings'
 import { SUPPORTED_LOCALE_VALUES, type LocalizedTextMap } from '../shared/locales'
-
-export interface ConfigDescriptorWire {
-  key: string
-  displayLabel: string
-  description: string
-  localizedDisplayLabel?: LocalizedTextMap
-  localizedDescription?: LocalizedTextMap
-  required: boolean
-  dataKind: string
-  masked: boolean
-  interactiveSetupOnly: boolean
-  group?: string
-  advanced?: boolean
-  defaultValue?: unknown
-  options?: ConfigFieldOptionWire[]
-  allowCustomValue?: boolean
-  enumValues?: string[]
-}
-
-export interface ConfigFieldOptionWire {
-  value: string
-  displayLabel: string
-  localizedDisplayLabel?: LocalizedTextMap
-  description?: string
-  localizedDescription?: LocalizedTextMap
-  preview?: string
-}
-
-export interface ConfigGroupDescriptorWire {
-  id: string
-  displayLabel: string
-  localizedDisplayLabel?: LocalizedTextMap
-  description?: string
-  localizedDescription?: LocalizedTextMap
-}
-
-export interface ModuleInterfaceWire {
-  shortDescription?: string
-  localizedShortDescription?: LocalizedTextMap
-  longDescription?: string
-  localizedLongDescription?: LocalizedTextMap
-  previewPrompt?: string
-  localizedPreviewPrompt?: LocalizedTextMap
-}
-
-export interface DiscoveredModule {
-  moduleId: string
-  channelName: string
-  displayName: string
-  localizedDisplayName?: LocalizedTextMap
-  interface?: ModuleInterfaceWire
-  packageName: string
-  configFileName: string
-  supportedTransports: string[]
-  requiresInteractiveSetup: boolean
-  capabilitySummary?: Record<string, unknown>
-  variant: string
-  source: 'bundled' | 'user'
-  absolutePath: string
-  configGroups?: ConfigGroupDescriptorWire[]
-  configDescriptors: ConfigDescriptorWire[]
-}
+import type {
+  ConfigDescriptorWire,
+  ConfigFieldOptionWire,
+  ConfigGroupDescriptorWire,
+  DiscoveredModule,
+  ModuleInterfaceWire
+} from '../shared/channelModules'
+export type {
+  ConfigDescriptorWire,
+  ConfigFieldOptionWire,
+  ConfigGroupDescriptorWire,
+  DiscoveredModule,
+  ModuleInterfaceWire
+} from '../shared/channelModules'
 
 export interface ChannelModuleGroup {
   channelName: string

desktop/src/main/qrWatcher.ts

@@ -1,18 +1,14 @@
 import { promises as fs, watch, type FSWatcher } from 'fs'
 import * as path from 'path'
+import type { QrUpdatePayload } from '../shared/channelModules'
+export type { QrUpdatePayload } from '../shared/channelModules'
 
 const DIR_POLL_INTERVAL_MS = 500
 const DIR_POLL_MAX_ATTEMPTS = 60
 const QR_READ_DEBOUNCE_MS = 200
 
 export type QrWatchPhase = 'idle' | 'waitingForDir' | 'watching' | 'loginComplete'
 
-export interface QrUpdatePayload {
-  moduleId: string
-  qrDataUrl: string | null
-  timestamp: number
-}
-
 interface QrWatchState {
   moduleId: string
   phase: QrWatchPhase