Repository navigation
Expand file tree
/
Copy pathdispatch.lua
More file actions
305 lines (254 loc) · 8.85 KB
/
Copy pathdispatch.lua
File metadata and controls
305 lines (254 loc) · 8.85 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
local config = require('opencode.config')
local log = require('opencode.log')
local M = {}
local lifecycle_hook_keys = {
before = 'on_command_before',
after = 'on_command_after',
error = 'on_command_error',
finally = 'on_command_finally',
}
---@type table<OpencodeCommandLifecycleStage, { id: string, fn: OpencodeCommandDispatchHook, command_filter: table<string, true>|nil }[]>
local hook_registry = {
before = {},
after = {},
error = {},
finally = {},
}
local hook_sequence = 0
---@alias OpencodeCommandHookEntry { id: string, fn: OpencodeCommandDispatchHook, command_filter: table<string, true>|nil }
---@param command? string|string[]
---@return table<string, true>|nil
local function normalize_command_filter(command)
if command == nil or command == '*' then
return nil
end
if type(command) == 'string' then
return { [command] = true }
end
if type(command) ~= 'table' then
error('Hook command filter must be "*", string, or string[]')
end
local filter = {}
for _, name in ipairs(command) do
if name == '*' then
return nil
end
if type(name) ~= 'string' or name == '' then
error('Hook command filter entries must be non-empty strings')
end
filter[name] = true
end
if next(filter) == nil then
error('Hook command filter list cannot be empty')
end
return filter
end
---@param entry { id: string, fn: OpencodeCommandDispatchHook, command_filter: table<string, true>|nil }
---@param ctx OpencodeCommandDispatchContext
---@return boolean
local function should_run_hook(entry, ctx)
if entry.command_filter == nil then
return true
end
local intent = ctx.intent
local name = intent and intent.name or nil
local hook_key = intent and intent.hook_key or nil
if not name and not hook_key then
return false
end
if hook_key and entry.command_filter[hook_key] == true then
return true
end
return name and entry.command_filter[name] == true or false
end
---@param stage OpencodeCommandLifecycleStage
---@param hook_id string
---@param hook_fn OpencodeCommandDispatchHook
---@param ctx OpencodeCommandDispatchContext
---@return OpencodeCommandDispatchContext
local function run_hook(stage, hook_id, hook_fn, ctx)
local ok, next_ctx_or_err = pcall(hook_fn, ctx)
if not ok then
-- Keep observer failures isolated so command execution stays deterministic.
local command_name = (ctx.intent and ctx.intent.name) or 'unknown'
log.warn(
'event=command_hook_error command=%s stage=%s hook_id=%s error=%s',
command_name,
stage,
hook_id,
tostring(next_ctx_or_err)
)
return ctx
end
if type(next_ctx_or_err) == 'table' then
return next_ctx_or_err
end
return ctx
end
---@param stage OpencodeCommandLifecycleStage
---@param ctx OpencodeCommandDispatchContext
---@return OpencodeCommandDispatchContext
local function run_hook_pipeline(stage, ctx)
local next_ctx = ctx
-- Contract: config hook runs first, runtime hooks run after it, then the stage event is emitted.
-- This keeps hook ordering deterministic across all command entries.
local config_hook_name = lifecycle_hook_keys[stage]
local config_hook = config.hooks and config.hooks[config_hook_name]
if type(config_hook) == 'function' then
next_ctx = run_hook(stage, 'config:' .. config_hook_name, config_hook, next_ctx)
end
for _, entry in ipairs(hook_registry[stage]) do
if should_run_hook(entry, next_ctx) then
next_ctx = run_hook(stage, entry.id, entry.fn, next_ctx)
end
end
return next_ctx
end
-- Parse/bind failures may not have a stable intent yet; execute failures must carry intent for callers.
local failure_profiles = {
parse = { fallback_code = 'invalid_arguments', fallback_message = 'Invalid command', include_intent = false },
bind = { fallback_code = 'missing_handler', fallback_message = nil, include_intent = false },
execute_missing = { fallback_code = 'missing_execute', fallback_message = nil, include_intent = true },
execute_error = { fallback_code = 'execute_error', fallback_message = nil, include_intent = true },
}
---@param err any
---@param fallback_code? string
---@param fallback_message? string
---@return OpencodeCommandDispatchError
function M.normalize_error(err, fallback_code, fallback_message)
local code = fallback_code or 'execute_error'
if type(err) == 'table' then
local normalized = {
code = err.code or code,
message = err.message,
}
if not normalized.message or normalized.message == '' then
normalized.message = fallback_message or tostring(err)
end
if err.subcommand ~= nil then
normalized.subcommand = err.subcommand
end
return normalized
end
return {
code = code,
message = tostring(err or fallback_message or 'Unknown command error'),
}
end
---@param stage OpencodeCommandLifecycleStage
---@param hook_fn OpencodeCommandDispatchHook
---@param hook_id_or_opts? string|{ command?: string|string[] }
---@param hook_opts? { command?: string|string[] }
---@return string
function M.register_hook(stage, hook_fn, hook_id_or_opts, hook_opts)
if not hook_registry[stage] then
error('Unknown hook stage: ' .. tostring(stage))
end
if type(hook_fn) ~= 'function' then
error('Hook must be a function')
end
local hook_id = nil
local opts = hook_opts
if type(hook_id_or_opts) == 'table' and hook_opts == nil then
opts = hook_id_or_opts
elseif hook_id_or_opts ~= nil then
if type(hook_id_or_opts) ~= 'string' then
error('Hook ID must be a string')
end
hook_id = hook_id_or_opts
end
hook_sequence = hook_sequence + 1
local id = hook_id or ('dispatch:' .. stage .. ':' .. hook_sequence)
local command_filter = normalize_command_filter(opts and opts.command)
table.insert(hook_registry[stage], { id = id, fn = hook_fn, command_filter = command_filter })
return id
end
---@param stage OpencodeCommandLifecycleStage
---@param hook_id string
---@return boolean
function M.unregister_hook(stage, hook_id)
local hooks = hook_registry[stage]
if not hooks then
error('Unknown hook stage: ' .. tostring(stage))
end
for i, entry in ipairs(hooks) do
if entry.id == hook_id then
table.remove(hooks, i)
return true
end
end
return false
end
function M.reset_hooks_for_test()
for stage, _ in pairs(hook_registry) do
hook_registry[stage] = {}
end
hook_sequence = 0
end
---@param ctx OpencodeCommandActionContext
---@return OpencodeCommandDispatchResult
function M.execute(ctx)
---@type OpencodeCommandDispatchContext
local dispatch_ctx = {
parsed = ctx.parsed,
intent = ctx.intent or (ctx.parsed and ctx.parsed.intent) or nil,
args = ctx.args,
range = ctx.range,
}
local command_name = dispatch_ctx.intent and dispatch_ctx.intent.name or 'unknown'
log.debug('event=command_execute_start command=%s', command_name)
---@param stage 'parse'|'bind'|'execute'
---@param err any
---@param profile_key 'parse'|'bind'|'execute_missing'|'execute_error'
---@return OpencodeCommandDispatchResult
local function fail(stage, err, profile_key)
local profile = failure_profiles[profile_key]
dispatch_ctx.error = M.normalize_error(err, profile.fallback_code, profile.fallback_message)
dispatch_ctx = run_hook_pipeline('error', dispatch_ctx)
dispatch_ctx = run_hook_pipeline('finally', dispatch_ctx)
log.warn(
'event=command_execute_error command=%s stage=%s code=%s message=%s',
command_name,
stage,
dispatch_ctx.error.code,
dispatch_ctx.error.message
)
local result = {
ok = false,
error = dispatch_ctx.error,
}
if profile.include_intent then
result.intent = dispatch_ctx.intent
end
return result
end
if not (ctx.parsed and ctx.parsed.ok) then
return fail('parse', ctx.parsed and ctx.parsed.error, 'parse')
end
if not dispatch_ctx.intent then
return fail('bind', { code = 'missing_handler', message = 'Missing command intent' }, 'bind')
end
dispatch_ctx.args = dispatch_ctx.args or dispatch_ctx.intent.args or {}
dispatch_ctx.range = dispatch_ctx.range or dispatch_ctx.intent.range
dispatch_ctx.intent.args = dispatch_ctx.args
dispatch_ctx.intent.range = dispatch_ctx.range
dispatch_ctx = run_hook_pipeline('before', dispatch_ctx)
local execute_fn = ctx.execute
if not execute_fn then
return fail('execute', { code = 'missing_execute', message = 'Command has no execute function' }, 'execute_missing')
end
local ok, result_or_err = pcall(execute_fn, dispatch_ctx.args, dispatch_ctx.range)
if not ok then
return fail('execute', result_or_err, 'execute_error')
end
dispatch_ctx.result = result_or_err
dispatch_ctx = run_hook_pipeline('after', dispatch_ctx)
dispatch_ctx = run_hook_pipeline('finally', dispatch_ctx)
log.debug('event=command_execute_success command=%s', command_name)
return {
ok = true,
result = dispatch_ctx.result,
intent = dispatch_ctx.intent,
}
end
return M