Import packages/plugin/src/plugin-route-bridge.ts
This commit is contained in:
parent
49cc56fc72
commit
cbe69d83bb
|
|
@ -1,25 +1,49 @@
|
|||
import { MAX_SECURE_MESSAGE_BYTES } from '@dsh-remote/protocol'
|
||||
import { MAX_SECURE_MESSAGE_BYTES, MAX_HARNESS_API_TRANSFER_BYTES } from '@dsh-remote/protocol'
|
||||
import type { PluginRouteCallParams, PluginRouteCallResult } from '@dsh-remote/protocol'
|
||||
import { z } from 'zod'
|
||||
import type { SafeLogger } from './logging.js'
|
||||
import { RpcError } from './safe-error.js'
|
||||
|
||||
/** Local plugin web routes forwardable over the authenticated channel (POST only). */
|
||||
export const PLUGIN_ROUTE_ALLOWLIST = ['api/bot'] as const
|
||||
export const PLUGIN_ROUTE_ALLOWLIST = ['api/bot', 'api/session/uploadFileBinary'] as const
|
||||
|
||||
/** Reviewed DS Bot operations; new upstream operations stay local by default. */
|
||||
/** DS-Bot v0.3.6 channel + computer endpoints; unknown future operations stay local. */
|
||||
export const BOT_REMOTE_OPERATIONS = [
|
||||
'state', 'models', 'efforts', 'providers', 'local-agents',
|
||||
'exchange', 'exchange-text', 'file-text', 'earlier', 'chat', 'run-stats', 'thinking', 'usage', 'room-progress', 'group-rows',
|
||||
'schedules', 'schedule-create', 'schedule-delete',
|
||||
'memory-view', 'memory-history', 'memory-ask', 'memory-forget', 'memory-restore',
|
||||
'folders', 'folder-list', 'team-workspace', 'set-prefs',
|
||||
'browser-takeover', 'browser-give-back', 'browser-stop',
|
||||
'create-bot', 'duplicate-bot', 'update-bot', 'delete-bot', 'set-main', 'set-flags', 'resume', 'bot-new-part', 'bot-open-part',
|
||||
'create-room', 'update-room', 'delete-room', 'stop-room-work', 'goal-draft', 'goal-control',
|
||||
'add-agent', 'agent-session', 'agent-adopt', 'agent-archive', 'agent-rename', 'remove-agent',
|
||||
'send', 'btw', 'btw-cancel', 'btw-delete', 'side-new', 'side-ask', 'side-cancel', 'side-close',
|
||||
'room-continue', 'answer-question', 'dismiss-question', 'dismiss-view', 'view-reply', 'approval-answer', 'stop-member-work',
|
||||
'abandon-work', 'add-agent', 'agent-adopt', 'agent-archive', 'agent-rename',
|
||||
'agent-session', 'answer-question', 'approval-answer', 'avatar', 'avatar-delete',
|
||||
'avatar-import', 'avatar-library', 'bot-capability', 'bot-new-part', 'bot-open-part',
|
||||
'browser-frame', 'browser-give-back', 'browser-result', 'browser-stop', 'browser-takeover',
|
||||
'browser-wait', 'btw-delete', 'capability-approve', 'capability-delete', 'capability-save',
|
||||
'chat', 'computer-allow-foreground', 'computer-app-answer', 'computer-cursor-wait', 'computer-handback',
|
||||
'computer-hold-answer', 'computer-open-settings', 'computer-permission', 'computer-provider-retry', 'computer-revoke-app',
|
||||
'computer-set-enabled', 'computer-set-level', 'computer-shot', 'computer-stop', 'computer-system-status',
|
||||
'computer-takeover', 'computer-user-active', 'connector-add', 'connector-cancel', 'connector-client',
|
||||
'connector-connect', 'connector-disconnect', 'connector-import', 'connector-import-scan', 'connector-remove',
|
||||
'connector-request-cancel', 'connector-retry', 'connector-set', 'connector-sign-in-code', 'create-bot',
|
||||
'create-room', 'delete-bot', 'delete-room', 'diagnostics', 'diagnostics-clear',
|
||||
'diagnostics-log', 'dismiss-question', 'dismiss-view', 'dsh-update-install', 'duplicate-bot',
|
||||
'earlier', 'efforts', 'exchange', 'exchange-text', 'file-text',
|
||||
'folder-list', 'folder-pick', 'folders', 'goal-control', 'goal-draft',
|
||||
'group-rows', 'hello', 'im-add', 'im-chat', 'im-login-start',
|
||||
'im-login-wait', 'im-pair', 'im-remove', 'im-retry', 'im-unpair',
|
||||
'im-update', 'image', 'learning-answer', 'local-agent-add', 'local-agent-models',
|
||||
'local-agent-refresh', 'local-agent-remove', 'local-agent-update', 'local-agents', 'mail-account-add',
|
||||
'mail-account-remove', 'mail-rule-set', 'mail-send-answer', 'mail-sign-in-code', 'memory-add',
|
||||
'memory-ask', 'memory-edit', 'memory-forget', 'memory-history', 'memory-layer',
|
||||
'memory-move', 'memory-pin', 'memory-restore', 'memory-tidy-undo', 'memory-view',
|
||||
'models', 'notices', 'phone-pair', 'phone-pair-cancel', 'phone-remove',
|
||||
'phone-set', 'private-release', 'provider-add', 'provider-key', 'provider-models',
|
||||
'provider-remove', 'providers', 'remove-agent', 'repo-stars', 'resume',
|
||||
'room-chat', 'room-progress', 'run-stats', 'schedule-create', 'schedule-delete',
|
||||
'schedules', 'secret-allow', 'secret-cancel', 'secret-delete', 'secret-set',
|
||||
'secret-update', 'section-delete', 'section-order', 'section-save', 'send',
|
||||
'set-flags', 'set-main', 'set-prefs', 'side-ask', 'side-cancel',
|
||||
'side-close', 'side-new', 'stage-image', 'state', 'stop-chat',
|
||||
'stop-member-work', 'stop-room-work', 'team-workspace', 'thinking', 'update-bot',
|
||||
'update-check', 'update-install', 'update-room', 'usage', 'usage-summary',
|
||||
'view-reply',
|
||||
// Older DS-Bot Hosts still implement these operations.
|
||||
'btw', 'btw-cancel', 'room-continue',
|
||||
] as const
|
||||
|
||||
export function isAllowedPluginRoute(route: string): route is typeof PLUGIN_ROUTE_ALLOWLIST[number] {
|
||||
|
|
@ -37,11 +61,23 @@ const callSchema = z.object({
|
|||
body: z.object({
|
||||
endpoint: z.enum(BOT_REMOTE_OPERATIONS),
|
||||
payload: z.record(z.string(), z.unknown()).nullable().optional(),
|
||||
}).strict().superRefine((body, ctx) => {
|
||||
if (body.endpoint === 'approval-answer' && body.payload?.choice !== 'allow' && body.payload?.choice !== 'reject') {
|
||||
ctx.addIssue({ code: z.ZodIssueCode.custom, message: 'Only one-time approval or rejection is supported.' })
|
||||
}
|
||||
}),
|
||||
}).strict(),
|
||||
}).strict()
|
||||
|
||||
/** Fixed official attachment intake; caller-selected filesystem paths are forbidden. */
|
||||
const uploadFields = {
|
||||
sessionId: z.string().min(1).max(512),
|
||||
name: z.string().max(512).optional(),
|
||||
data: z.string().max(256 * 1024 * 1024).regex(/^[A-Za-z0-9+/]*={0,2}$/).refine(value => value.length % 4 === 0),
|
||||
}
|
||||
const imageUploadCallSchema = z.object({
|
||||
route: z.literal('api/session/uploadFileBinary'),
|
||||
body: z.discriminatedUnion('endpoint', [
|
||||
z.object({ endpoint: z.literal('image'), payload: z.object({ ...uploadFields,
|
||||
mediaType: z.enum(['image/png', 'image/jpeg', 'image/webp', 'image/gif']),
|
||||
}).strict() }).strict(),
|
||||
z.object({ endpoint: z.literal('file'), payload: z.object(uploadFields).strict() }).strict(),
|
||||
]),
|
||||
}).strict()
|
||||
|
||||
/** Local plugin route call timeout, mirroring the Harness API bridge budget. */
|
||||
|
|
@ -58,17 +94,19 @@ export class PluginRouteBridge {
|
|||
private readonly logger?: SafeLogger,
|
||||
) {}
|
||||
|
||||
async call(input: unknown): Promise<PluginRouteCallResult> {
|
||||
async call(input: unknown, transferred = false): Promise<PluginRouteCallResult> {
|
||||
let params: PluginRouteCallParams
|
||||
try {
|
||||
params = callSchema.parse(input) as PluginRouteCallParams
|
||||
params = (typeof input === 'object' && input !== null && 'route' in input
|
||||
&& input.route === 'api/session/uploadFileBinary'
|
||||
? imageUploadCallSchema.parse(input) : callSchema.parse(input)) as PluginRouteCallParams
|
||||
} catch (error) {
|
||||
if (error instanceof z.ZodError) {
|
||||
throw new RpcError('INVALID_MESSAGE', 'The plugin route call is invalid for the remote channel.')
|
||||
}
|
||||
throw error
|
||||
}
|
||||
if (serializedBytes(params) > MAX_SECURE_MESSAGE_BYTES) {
|
||||
if (serializedBytes(params) > (transferred && params.route === 'api/session/uploadFileBinary' ? MAX_HARNESS_API_TRANSFER_BYTES : MAX_SECURE_MESSAGE_BYTES)) {
|
||||
throw new RpcError('INVALID_MESSAGE', `The plugin route call exceeds the ${MAX_SECURE_MESSAGE_BYTES}-byte remote limit.`)
|
||||
}
|
||||
const startedAt = performance.now()
|
||||
|
|
|
|||
Loading…
Reference in New Issue