Share RPC method constants

This commit is contained in:
weishu
2026-05-21 10:53:31 +08:00
parent 41f6b37d69
commit b79f50f815
29 changed files with 129 additions and 68 deletions
+2 -1
View File
@@ -1,6 +1,7 @@
import { logger } from '@/ui/logger'
import { exec, type ExecOptions } from 'child_process'
import { promisify } from 'util'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager'
import { validatePath } from '../pathSecurity'
import { getErrorMessage, rpcError } from '../rpcResponses'
@@ -22,7 +23,7 @@ interface BashResponse {
}
export function registerBashHandlers(rpcHandlerManager: RpcHandlerManager, workingDirectory: string): void {
rpcHandlerManager.registerHandler<BashRequest, BashResponse>('bash', async (data) => {
rpcHandlerManager.registerHandler<BashRequest, BashResponse>(RPC_METHODS.Bash, async (data) => {
logger.debug('Shell command request:', data.command)
if (data.cwd) {
@@ -1,4 +1,5 @@
import { logger } from '@/ui/logger';
import { RPC_METHODS } from '@hapi/protocol/rpcMethods';
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager';
import {
listCodexModels,
@@ -8,7 +9,7 @@ import {
import { getErrorMessage, rpcError } from '../rpcResponses';
export function registerCodexModelHandlers(rpcHandlerManager: RpcHandlerManager): void {
rpcHandlerManager.registerHandler<ListCodexModelsRequest, ListCodexModelsResponse>('listCodexModels', async (data) => {
rpcHandlerManager.registerHandler<ListCodexModelsRequest, ListCodexModelsResponse>(RPC_METHODS.ListCodexModels, async (data) => {
logger.debug('List Codex models request');
try {
@@ -1,4 +1,5 @@
import { logger } from '@/ui/logger'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager'
import { run as runDifftastic } from '@/modules/difftastic/index'
import { validatePath } from '../pathSecurity'
@@ -18,7 +19,7 @@ interface DifftasticResponse {
}
export function registerDifftasticHandlers(rpcHandlerManager: RpcHandlerManager, workingDirectory: string): void {
rpcHandlerManager.registerHandler<DifftasticRequest, DifftasticResponse>('difftastic', async (data) => {
rpcHandlerManager.registerHandler<DifftasticRequest, DifftasticResponse>(RPC_METHODS.Difftastic, async (data) => {
logger.debug('Difftastic request with args:', data.args, 'cwd:', data.cwd)
if (data.cwd) {
@@ -2,6 +2,7 @@ import { logger } from '@/ui/logger'
import { readdir, stat } from 'fs/promises'
import { basename, join, resolve } from 'path'
import type { DirectoryEntry, ListDirectoryResponse } from '@hapi/protocol/apiTypes'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager'
import { validatePath } from '../pathSecurity'
import { getErrorMessage, rpcError } from '../rpcResponses'
@@ -31,7 +32,7 @@ interface GetDirectoryTreeResponse {
}
export function registerDirectoryHandlers(rpcHandlerManager: RpcHandlerManager, workingDirectory: string): void {
rpcHandlerManager.registerHandler<ListDirectoryRequest, ListDirectoryResponse>('listDirectory', async (data) => {
rpcHandlerManager.registerHandler<ListDirectoryRequest, ListDirectoryResponse>(RPC_METHODS.ListDirectory, async (data) => {
logger.debug('List directory request:', data.path)
const targetPath = data.path || '.'
@@ -92,7 +93,7 @@ export function registerDirectoryHandlers(rpcHandlerManager: RpcHandlerManager,
}
})
rpcHandlerManager.registerHandler<GetDirectoryTreeRequest, GetDirectoryTreeResponse>('getDirectoryTree', async (data) => {
rpcHandlerManager.registerHandler<GetDirectoryTreeRequest, GetDirectoryTreeResponse>(RPC_METHODS.GetDirectoryTree, async (data) => {
logger.debug('Get directory tree request:', data.path, 'maxDepth:', data.maxDepth)
const targetPath = data.path || '.'
+4 -3
View File
@@ -3,6 +3,7 @@ import { readFile, stat, writeFile } from 'fs/promises'
import { createHash } from 'crypto'
import { resolve } from 'path'
import type { FileReadResponse, GeneratedImageResponse } from '@hapi/protocol/apiTypes'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager'
import { validatePath } from '../pathSecurity'
import { getGeneratedImage } from '../generatedImages'
@@ -33,7 +34,7 @@ interface WriteFileResponse {
}
export function registerFileHandlers(rpcHandlerManager: RpcHandlerManager, workingDirectory: string): void {
rpcHandlerManager.registerHandler<ReadFileRequest, ReadFileResponse>('readFile', async (data) => {
rpcHandlerManager.registerHandler<ReadFileRequest, ReadFileResponse>(RPC_METHODS.ReadFile, async (data) => {
logger.debug('Read file request:', data.path)
const validation = validatePath(data.path, workingDirectory)
@@ -52,7 +53,7 @@ export function registerFileHandlers(rpcHandlerManager: RpcHandlerManager, worki
}
})
rpcHandlerManager.registerHandler<ReadGeneratedImageRequest, ReadGeneratedImageResponse>('readGeneratedImage', async (data) => {
rpcHandlerManager.registerHandler<ReadGeneratedImageRequest, ReadGeneratedImageResponse>(RPC_METHODS.ReadGeneratedImage, async (data) => {
logger.debug('Read generated image request:', data.id)
const image = getGeneratedImage(data.id)
@@ -74,7 +75,7 @@ export function registerFileHandlers(rpcHandlerManager: RpcHandlerManager, worki
}
})
rpcHandlerManager.registerHandler<WriteFileRequest, WriteFileResponse>('writeFile', async (data) => {
rpcHandlerManager.registerHandler<WriteFileRequest, WriteFileResponse>(RPC_METHODS.WriteFile, async (data) => {
logger.debug('Write file request:', data.path)
const validation = validatePath(data.path, workingDirectory)
+4 -3
View File
@@ -1,6 +1,7 @@
import { execFile, type ExecFileOptions } from 'child_process'
import { promisify } from 'util'
import type { CommandResponse } from '@hapi/protocol/apiTypes'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager'
import { validatePath } from '../pathSecurity'
import { rpcError } from '../rpcResponses'
@@ -86,7 +87,7 @@ async function runGitCommand(
}
export function registerGitHandlers(rpcHandlerManager: RpcHandlerManager, workingDirectory: string): void {
rpcHandlerManager.registerHandler<GitStatusRequest, GitCommandResponse>('git-status', async (data) => {
rpcHandlerManager.registerHandler<GitStatusRequest, GitCommandResponse>(RPC_METHODS.GitStatus, async (data) => {
const resolved = resolveCwd(data.cwd, workingDirectory)
if (resolved.error) {
return rpcError(resolved.error)
@@ -98,7 +99,7 @@ export function registerGitHandlers(rpcHandlerManager: RpcHandlerManager, workin
)
})
rpcHandlerManager.registerHandler<GitDiffNumstatRequest, GitCommandResponse>('git-diff-numstat', async (data) => {
rpcHandlerManager.registerHandler<GitDiffNumstatRequest, GitCommandResponse>(RPC_METHODS.GitDiffNumstat, async (data) => {
const resolved = resolveCwd(data.cwd, workingDirectory)
if (resolved.error) {
return rpcError(resolved.error)
@@ -109,7 +110,7 @@ export function registerGitHandlers(rpcHandlerManager: RpcHandlerManager, workin
return await runGitCommand(args, resolved.cwd, data.timeout)
})
rpcHandlerManager.registerHandler<GitDiffFileRequest, GitCommandResponse>('git-diff-file', async (data) => {
rpcHandlerManager.registerHandler<GitDiffFileRequest, GitCommandResponse>(RPC_METHODS.GitDiffFile, async (data) => {
const resolved = resolveCwd(data.cwd, workingDirectory)
if (resolved.error) {
return rpcError(resolved.error)
@@ -1,4 +1,5 @@
import { logger } from '@/ui/logger';
import { RPC_METHODS } from '@hapi/protocol/rpcMethods';
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager';
import {
listOpencodeModelsForCwd,
@@ -9,7 +10,7 @@ import { getErrorMessage, rpcError } from '../rpcResponses';
export function registerOpencodeModelHandlers(rpcHandlerManager: RpcHandlerManager): void {
rpcHandlerManager.registerHandler<ListOpencodeModelsForCwdRequest, ListOpencodeModelsForCwdResponse>(
'listOpencodeModelsForCwd',
RPC_METHODS.ListOpencodeModelsForCwd,
async (data) => {
logger.debug('List OpenCode models for cwd request', { cwd: data?.cwd });
+2 -1
View File
@@ -1,4 +1,5 @@
import { logger } from '@/ui/logger'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager'
import { run as runRipgrep } from '@/modules/ripgrep/index'
import { validatePath } from '../pathSecurity'
@@ -18,7 +19,7 @@ interface RipgrepResponse {
}
export function registerRipgrepHandlers(rpcHandlerManager: RpcHandlerManager, workingDirectory: string): void {
rpcHandlerManager.registerHandler<RipgrepRequest, RipgrepResponse>('ripgrep', async (data) => {
rpcHandlerManager.registerHandler<RipgrepRequest, RipgrepResponse>(RPC_METHODS.Ripgrep, async (data) => {
logger.debug('Ripgrep request with args:', data.args, 'cwd:', data.cwd)
if (data.cwd) {
+2 -1
View File
@@ -1,10 +1,11 @@
import { logger } from '@/ui/logger'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager'
import { listSkills, type ListSkillsRequest, type ListSkillsResponse } from '../skills'
import { getErrorMessage, rpcError } from '../rpcResponses'
export function registerSkillsHandlers(rpcHandlerManager: RpcHandlerManager, workingDirectory: string): void {
rpcHandlerManager.registerHandler<ListSkillsRequest, ListSkillsResponse>('listSkills', async () => {
rpcHandlerManager.registerHandler<ListSkillsRequest, ListSkillsResponse>(RPC_METHODS.ListSkills, async () => {
logger.debug('List skills request')
try {
@@ -1,10 +1,11 @@
import { logger } from '@/ui/logger'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager'
import { listSlashCommands, type ListSlashCommandsRequest, type ListSlashCommandsResponse } from '../slashCommands'
import { getErrorMessage, rpcError } from '../rpcResponses'
export function registerSlashCommandHandlers(rpcHandlerManager: RpcHandlerManager, workingDirectory: string): void {
rpcHandlerManager.registerHandler<ListSlashCommandsRequest, ListSlashCommandsResponse>('listSlashCommands', async (data) => {
rpcHandlerManager.registerHandler<ListSlashCommandsRequest, ListSlashCommandsResponse>(RPC_METHODS.ListSlashCommands, async (data) => {
logger.debug('List slash commands request for agent:', data.agent)
try {
+3 -2
View File
@@ -3,6 +3,7 @@ import { mkdir, mkdtemp, rm, writeFile } from 'fs/promises'
import { join, resolve, sep } from 'path'
import { rmSync } from 'node:fs'
import type { DeleteUploadResponse, UploadFileResponse } from '@hapi/protocol/apiTypes'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
import type { RpcHandlerManager } from '@/api/rpc/RpcHandlerManager'
import { getErrorMessage, rpcError } from '../rpcResponses'
import { getHapiBlobsDir } from '@/constants/uploadPaths'
@@ -153,7 +154,7 @@ export function registerUploadHandlers(rpcHandlerManager: RpcHandlerManager): vo
process.once('exit', cleanupUploadDirsSync)
}
rpcHandlerManager.registerHandler<UploadFileRequest, UploadFileResponse>('uploadFile', async (data) => {
rpcHandlerManager.registerHandler<UploadFileRequest, UploadFileResponse>(RPC_METHODS.UploadFile, async (data) => {
logger.debug('Upload file request:', data.filename, 'mimeType:', data.mimeType)
if (!data.filename) {
@@ -193,7 +194,7 @@ export function registerUploadHandlers(rpcHandlerManager: RpcHandlerManager): vo
}
})
rpcHandlerManager.registerHandler<DeleteUploadRequest, DeleteUploadResponse>('deleteUpload', async (data) => {
rpcHandlerManager.registerHandler<DeleteUploadRequest, DeleteUploadResponse>(RPC_METHODS.DeleteUpload, async (data) => {
const path = data?.path?.trim()
if (!path) {
return rpcError('Path is required')
@@ -2,6 +2,7 @@ import { logger } from '@/ui/logger'
import { Future } from '@/utils/future'
import { getLocalLaunchExitReason } from '@/agent/localLaunchPolicy'
import type { LocalLaunchExitReason, StartedBy } from '@/agent/localLaunchPolicy'
import { RPC_METHODS } from '@hapi/protocol/rpcMethods'
type QueueLike = {
size(): number
@@ -88,8 +89,8 @@ export class BaseLocalLauncher {
await abortProcess()
}
rpcHandlerManager.registerHandler('abort', doAbort)
rpcHandlerManager.registerHandler('switch', doSwitch)
rpcHandlerManager.registerHandler(RPC_METHODS.Abort, doAbort)
rpcHandlerManager.registerHandler(RPC_METHODS.Switch, doSwitch)
queue.setOnMessage(() => {
void doSwitch()
})
@@ -139,8 +140,8 @@ export class BaseLocalLauncher {
}
} finally {
this.exitFuture.resolve(undefined)
rpcHandlerManager.registerHandler('abort', async () => {})
rpcHandlerManager.registerHandler('switch', async () => {})
rpcHandlerManager.registerHandler(RPC_METHODS.Abort, async () => {})
rpcHandlerManager.registerHandler(RPC_METHODS.Switch, async () => {})
queue.setOnMessage(null)
}
@@ -1,5 +1,6 @@
import type { AgentState } from "@/api/types";
import type { PermissionMode } from "@hapi/protocol/types";
import { RPC_METHODS } from '@hapi/protocol/rpcMethods';
type RpcHandlerManagerLike = {
registerHandler<TRequest = unknown, TResponse = unknown>(
@@ -204,7 +205,7 @@ export abstract class BasePermissionHandler<TResponse extends { id: string }, TR
}
private setupRpcHandler(): void {
this.client.rpcHandlerManager.registerHandler<TResponse, void>('permission', async (response) => {
this.client.rpcHandlerManager.registerHandler<TResponse, void>(RPC_METHODS.Permission, async (response) => {
const pending = this.pendingRequests.get(response.id);
if (!pending) {
@@ -2,6 +2,7 @@ import { render } from 'ink';
import type { ReactElement } from 'react';
import { MessageBuffer } from '@/ui/ink/messageBuffer';
import { restoreTerminalState } from '@/ui/terminalState';
import { RPC_METHODS } from '@hapi/protocol/rpcMethods';
export type RemoteLauncherExitReason = 'switch' | 'exit';
@@ -76,18 +77,18 @@ export abstract class RemoteLauncherBase {
rpcHandlerManager: RpcHandlerManagerLike,
handlers: RemoteLauncherAbortHandlers
): void {
rpcHandlerManager.registerHandler('abort', async () => {
rpcHandlerManager.registerHandler(RPC_METHODS.Abort, async () => {
await handlers.onAbort();
});
rpcHandlerManager.registerHandler('switch', async () => {
rpcHandlerManager.registerHandler(RPC_METHODS.Switch, async () => {
await handlers.onSwitch();
});
}
protected clearAbortHandlers(rpcHandlerManager: RpcHandlerManagerLike): void {
rpcHandlerManager.registerHandler('abort', async () => {});
rpcHandlerManager.registerHandler('switch', async () => {});
rpcHandlerManager.registerHandler(RPC_METHODS.Abort, async () => {});
rpcHandlerManager.registerHandler(RPC_METHODS.Switch, async () => {});
}
protected async requestExit(