File size: 10,554 Bytes
0ed8124
 
 
 
 
 
 
 
 
 
 
3fd9ca4
0ed8124
 
 
 
b4f163f
c3633b1
0ed8124
 
 
 
 
 
b4f163f
c3633b1
0ed8124
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3fd9ca4
 
 
 
 
0ed8124
 
 
 
3fd9ca4
0ed8124
 
 
3fd9ca4
0ed8124
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3fd9ca4
 
 
 
0ed8124
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
c3633b1
0ed8124
b4f163f
 
c3633b1
 
0ed8124
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
306
307
308
309
310
311
312
313
314
import type {
  EngineErrorPayload,
  EngineEvent,
  EngineMethod,
  EngineRequest,
  EngineRequestMap,
  EngineResponse,
  EngineResponseMap,
  EngineWorkerMessage,
  GenerateParams,
  LoadModelParams,
  ScoreSequenceParams,
} from './protocol';

type ProgressEvent = Extract<EngineEvent, { event: 'progress' }>;
type TokenEvent = Extract<EngineEvent, { event: 'token' }>;
type ToolCallEvent = Extract<EngineEvent, { event: 'tool-call' }>;
type GenerationEvent = Extract<EngineEvent, { event: 'generation' }>;

export interface EngineRequestOptions {
  requestId?: string;
  signal?: AbortSignal;
  onProgress?: (event: ProgressEvent) => void;
  onToken?: (text: string, reasoningDelta?: string) => void;
  onToolCallProgress?: (event: ToolCallEvent) => void;
  onGenerationProgress?: (event: GenerationEvent) => void;
}

interface PendingRequest {
  method: EngineMethod;
  resolve: (result: never) => void;
  reject: (error: unknown) => void;
  options: EngineRequestOptions;
  abortListener?: () => void;
  loadPhase?: ProgressEvent['phase'];
  abortFallbackTimer?: ReturnType<typeof setTimeout>;
}

const LOAD_ABORT_CLEANUP_TIMEOUT_MS = 30_000;
// Native generation may be blocked inside a proxy call that cannot observe AbortSignal.
const GENERATION_ABORT_GRACE_MS = 5_000;

export class EngineClientError extends Error {
  readonly code: string;
  readonly details?: unknown;

  constructor(payload: EngineErrorPayload) {
    super(payload.message);
    this.name = 'EngineClientError';
    this.code = payload.code;
    this.details = payload.details;
  }
}

function nextRequestId(): string {
  return typeof crypto.randomUUID === 'function'
    ? crypto.randomUUID()
    : `${Date.now()}-${Math.random().toString(16).slice(2)}`;
}

export class BrowserEngineClient {
  private worker: Worker | null;
  private readonly workerFactory: (() => Worker) | null;
  private readonly pending = new Map<string, PendingRequest>();
  private closed = false;

  constructor(worker?: Worker) {
    this.workerFactory = worker ? null : () => new Worker(new URL('./worker.ts', import.meta.url), {
      type: 'module',
      name: 'bonsai-browser-engine',
    });
    this.worker = worker ?? this.workerFactory?.() ?? null;
    if (!this.worker) throw new Error('Browser engine worker could not be created.');
    this.attachWorker(this.worker);
  }

  private attachWorker(worker: Worker): void {
    worker.onmessage = (event: MessageEvent<EngineWorkerMessage>) => {
      if (this.worker !== worker) return;
      this.handleMessage(event.data);
    };
    worker.onerror = (event) => {
      if (this.worker !== worker) return;
      this.failWorker(new Error(event.message || 'Browser engine worker failed.'));
    };
    worker.onmessageerror = () => {
      if (this.worker !== worker) return;
      this.failWorker(new Error('Browser engine worker sent an invalid message.'));
    };
  }

  private ensureWorker(): Worker {
    if (this.closed) throw new Error('Browser engine client is closed.');
    if (!this.worker) {
      if (!this.workerFactory) throw new Error('Browser engine worker failed and cannot be recreated.');
      this.worker = this.workerFactory();
      this.attachWorker(this.worker);
    }
    return this.worker;
  }

  request<Method extends EngineMethod>(
    method: Method,
    params: EngineRequestMap[Method],
    options: EngineRequestOptions = {},
  ): Promise<EngineResponseMap[Method]> {
    if (options.signal?.aborted) {
      return Promise.reject(new DOMException('The engine operation was aborted.', 'AbortError'));
    }
    let worker: Worker;
    try {
      worker = this.ensureWorker();
    } catch (error) {
      return Promise.reject(error);
    }
    const requestId = options.requestId ?? nextRequestId();
    if (this.pending.has(requestId)) {
      return Promise.reject(new Error(`Duplicate engine request id: ${requestId}`));
    }
    const request = { type: 'request', requestId, method, params } as EngineRequest;
    return new Promise<EngineResponseMap[Method]>((resolve, reject) => {
      const pending: PendingRequest = {
        method,
        resolve: resolve as (result: never) => void,
        reject,
        options,
      };
      if (options.signal) {
        pending.abortListener = () => {
          if (method === 'loadModel' && pending.loadPhase === 'load') {
            this.restart(new DOMException('Model loading was aborted.', 'AbortError'));
          } else {
            if (method === 'loadModel') {
              pending.abortFallbackTimer = setTimeout(() => {
                if (this.pending.has(requestId)) {
                  this.restart(new DOMException(
                    'Model download cleanup timed out after abort.',
                    'AbortError',
                  ));
                }
              }, LOAD_ABORT_CLEANUP_TIMEOUT_MS);
            } else if (method === 'generate' || method === 'scoreSequence') {
              const operationLabel = method === 'generate' ? 'Generation' : 'Sequence scoring';
              const cause = method === 'generate'
                ? 'generation-abort-timeout'
                : 'score-sequence-abort-timeout';
              pending.abortFallbackTimer = setTimeout(() => {
                if (this.pending.has(requestId)) {
                  this.restart(new EngineClientError({
                    code: 'ENGINE_WORKER_FAILED',
                    message: `${operationLabel} did not stop within 5 seconds. The browser engine worker was restarted and the loaded model was invalidated.`,
                    details: {
                      recoverable: true,
                      nextAction: 'reload-model',
                      cause,
                      graceMs: GENERATION_ABORT_GRACE_MS,
                    },
                  }));
                }
              }, GENERATION_ABORT_GRACE_MS);
            }
            void this.abort(requestId).catch(() => undefined);
          }
        };
        options.signal.addEventListener('abort', pending.abortListener, { once: true });
      }
      this.pending.set(requestId, pending);
      try {
        worker.postMessage(request);
      } catch (error) {
        this.failWorker(error);
      }
    });
  }

  capabilities() {
    return this.request('capabilities', {});
  }

  loadModel(params: LoadModelParams, options?: EngineRequestOptions) {
    return this.request('loadModel', params, options);
  }

  generate(params: GenerateParams, options?: EngineRequestOptions) {
    return this.request('generate', params, options);
  }

  scoreSequence(params: ScoreSequenceParams, options?: EngineRequestOptions) {
    return this.request('scoreSequence', params, options);
  }

  abort(targetRequestId: string) {
    return this.request('abort', { targetRequestId });
  }

  unload() {
    return this.request('unload', {});
  }

  backendReport() {
    return this.request('backendReport', {});
  }

  storageEstimate() {
    return this.request('storageEstimate', {});
  }

  storagePersist() {
    return this.request('storagePersist', {});
  }

  storageClear() {
    return this.request('storageClear', {});
  }

  close(): void {
    this.closed = true;
    this.worker?.terminate();
    this.worker = null;
    this.rejectAll(new Error('Browser engine client was closed.'));
  }

  restart(reason: unknown = new Error('Browser engine worker was restarted.')): void {
    if (this.closed) return;
    this.worker?.terminate();
    this.worker = null;
    this.rejectAll(reason);
    if (this.workerFactory) {
      this.worker = this.workerFactory();
      this.attachWorker(this.worker);
    }
  }

  private handleMessage(message: EngineWorkerMessage): void {
    const pending = this.pending.get(message.requestId);
    if (!pending) {
      return;
    }
    if (message.type === 'event') {
      if (message.event === 'progress') {
        pending.loadPhase = message.phase;
        if (
          pending.method === 'loadModel'
          && pending.options.signal?.aborted
          && message.phase === 'load'
        ) {
          this.restart(new DOMException('Model loading was aborted.', 'AbortError'));
          return;
        }
        pending.options.onProgress?.(message);
      } else if (message.event === 'token') {
        pending.options.onToken?.(message.text, message.reasoningDelta);
      } else if (message.event === 'tool-call') {
        pending.options.onToolCallProgress?.(message);
      } else {
        pending.options.onGenerationProgress?.(message);
      }
      return;
    }
    this.finishPending(message, pending);
  }

  private finishPending(response: EngineResponse, pending: PendingRequest): void {
    this.pending.delete(response.requestId);
    if (pending.abortListener && pending.options.signal) {
      pending.options.signal.removeEventListener('abort', pending.abortListener);
    }
    if (pending.abortFallbackTimer !== undefined) clearTimeout(pending.abortFallbackTimer);
    if (response.method !== pending.method) {
      pending.reject(new Error(
        `Engine response method mismatch: expected ${pending.method}, received ${response.method}.`,
      ));
    } else if (response.ok) {
      if (pending.options.signal?.aborted) {
        const abort = new DOMException('The engine operation was aborted.', 'AbortError');
        pending.reject(abort);
        if (pending.method === 'loadModel') this.restart(abort);
      } else {
        pending.resolve(response.result as never);
      }
    } else {
      const error = new EngineClientError(response.error);
      pending.reject(error);
      if (error.code === 'WEBGPU_DEVICE_LOST') {
        this.restart(error);
      }
    }
  }

  private rejectAll(error: unknown): void {
    for (const [requestId, pending] of this.pending) {
      this.pending.delete(requestId);
      if (pending.abortListener && pending.options.signal) {
        pending.options.signal.removeEventListener('abort', pending.abortListener);
      }
      if (pending.abortFallbackTimer !== undefined) clearTimeout(pending.abortFallbackTimer);
      pending.reject(error);
    }
  }

  private failWorker(error: unknown): void {
    const failure = error instanceof EngineClientError
      ? error
      : new EngineClientError({
        code: 'ENGINE_WORKER_FAILED',
        message: `Browser engine worker failed: ${error instanceof Error ? error.message : String(error)}`,
        details: { recoverable: true, nextAction: 'reload-model' },
      });
    this.worker?.terminate();
    this.worker = null;
    this.rejectAll(failure);
  }
}