Files
bDS/src/renderer/python/PythonRuntimeManager.ts
Georg Bauer 4f9be93c6d Feature/worker threads generation (#43)
* Add worker threads architecture plan for blog generation

* fix: tries to optimize rendering, still slow

* feat: moved site rendering into web worker

* fix: calendar grabs from central data source for calendar

* fix: feeds now use blog language content and not canonical content

---------

Co-authored-by: hugo <hugoms@me.com>
2026-03-09 22:49:25 +01:00

521 lines
15 KiB
TypeScript

import { createPythonRuntimeWorker } from './createPythonRuntimeWorker';
import type { PythonWorkerMessage, PythonWorkerRequest } from './runtimeProtocol';
import type { PythonSyntaxError } from './runtimeProtocol';
import { parseMacroContextV1, parseMacroResultV1, type MacroResultV1 } from './abiV1';
import { invokePythonApiMethodV1 } from './pythonApiInvokerV1';
import { showToast } from '../components/Toast';
type WorkerFactory = () => Worker;
type PythonApiInvoker = (method: string, args: unknown) => Promise<unknown>;
type ToastHandler = (message: string, toastType?: string) => void;
const TOAST_TYPES = new Set(['success', 'error', 'info']);
function defaultToastHandler(message: string, toastType?: string): void {
const resolvedType = (toastType && TOAST_TYPES.has(toastType) ? toastType : 'info') as 'success' | 'error' | 'info';
showToast[resolvedType](message);
}
interface PythonRuntimeManagerOptions {
invokeApiCall?: PythonApiInvoker;
onToast?: ToastHandler;
}
interface InitializeDeferred {
resolve: () => void;
reject: (error: Error) => void;
}
interface PendingRun {
kind: 'run' | 'macro-v1' | 'inspect-entrypoints' | 'syntax-check';
stdout: string;
resolve: (value: PythonRunResult | PythonMacroV1Result | string[] | PythonSyntaxCheckResult) => void;
reject: (error: Error) => void;
timeoutId: ReturnType<typeof setTimeout> | null;
timeoutMs: number;
onStdout?: (chunk: string) => void;
}
export interface PythonRunResult {
result: string;
stdout: string;
}
export interface PythonExecuteOptions {
timeoutMs?: number;
cacheKey?: string;
entrypoint?: string;
onStdout?: (chunk: string) => void;
}
export interface PythonMacroSourceOptions {
kind: string;
id?: string;
}
export interface PythonMacroRenderOptions extends PythonExecuteOptions {
macroHook?: string;
macroSource?: PythonMacroSourceOptions;
postDataJson?: string | null;
}
export interface PythonMacroV1Result {
result: MacroResultV1;
stdout: string;
}
export interface PythonSyntaxCheckResult {
errors: PythonSyntaxError[];
}
export class PythonRuntimeManager {
private worker: Worker | null = null;
private initializingPromise: Promise<void> | null = null;
private initializeDeferred: InitializeDeferred | null = null;
private ready = false;
private pendingRuns = new Map<string, PendingRun>();
private requestQueue: PythonWorkerRequest[] = [];
private activeRequestId: string | null = null;
private requestCounter = 0;
private readonly invokeApiCall: PythonApiInvoker;
private readonly onToast: ToastHandler;
constructor(
private readonly workerFactory: WorkerFactory = createPythonRuntimeWorker,
options: PythonRuntimeManagerOptions = {}
) {
this.invokeApiCall = options.invokeApiCall ?? invokePythonApiMethodV1;
this.onToast = options.onToast ?? defaultToastHandler;
}
initialize(): Promise<void> {
if (this.ready) {
return Promise.resolve();
}
if (this.initializingPromise) {
return this.initializingPromise;
}
this.worker = this.workerFactory();
this.ready = false;
this.initializingPromise = new Promise<void>((resolve, reject) => {
this.initializeDeferred = { resolve, reject };
if (!this.worker) {
this.initializeDeferred = null;
reject(new Error('Python runtime worker factory returned no worker'));
return;
}
this.worker.onmessage = (event: MessageEvent<PythonWorkerMessage>) => {
this.handleWorkerMessage(event.data);
};
this.worker.onerror = (event: ErrorEvent) => {
this.handleWorkerError(event.error instanceof Error ? event.error : new Error(event.message || 'Python runtime worker failed to initialize'));
};
});
return this.initializingPromise;
}
async execute(code: string, options?: PythonExecuteOptions): Promise<PythonRunResult> {
await this.initialize();
if (!this.worker || !this.ready) {
throw new Error('Python runtime is not ready');
}
const requestId = this.nextRequestId();
const timeoutMs = options?.timeoutMs ?? 5000;
return new Promise<PythonRunResult>((resolve, reject) => {
this.pendingRuns.set(requestId, {
kind: 'run',
stdout: '',
resolve: (value) => resolve(value as PythonRunResult),
reject,
timeoutId: null,
timeoutMs,
onStdout: options?.onStdout,
});
const message: PythonWorkerRequest = {
type: 'run',
requestId,
code,
cacheKey: options?.cacheKey,
entrypoint: options?.entrypoint,
};
this.enqueueRequest(message);
});
}
async renderMacroV1(code: string, context: unknown, options?: PythonMacroRenderOptions): Promise<PythonMacroV1Result> {
const contextWithMetadata = this.withMacroEnvMetadata(context, options);
const validatedContext = parseMacroContextV1(contextWithMetadata);
await this.initialize();
if (!this.worker || !this.ready) {
throw new Error('Python runtime is not ready');
}
const requestId = this.nextRequestId();
const timeoutMs = options?.timeoutMs ?? 5000;
return new Promise<PythonMacroV1Result>((resolve, reject) => {
this.pendingRuns.set(requestId, {
kind: 'macro-v1',
stdout: '',
resolve: (value) => resolve(value as PythonMacroV1Result),
reject,
timeoutId: null,
timeoutMs,
});
const message: PythonWorkerRequest = {
type: 'renderMacroV1',
requestId,
code,
context: validatedContext,
entrypoint: options?.entrypoint,
postDataJson: options?.postDataJson,
cacheKey: options?.cacheKey,
};
this.enqueueRequest(message);
});
}
async inspectEntrypoints(code: string, options?: PythonExecuteOptions): Promise<string[]> {
await this.initialize();
if (!this.worker || !this.ready) {
throw new Error('Python runtime is not ready');
}
const requestId = this.nextRequestId();
const timeoutMs = options?.timeoutMs ?? 5000;
return new Promise<string[]>((resolve, reject) => {
this.pendingRuns.set(requestId, {
kind: 'inspect-entrypoints',
stdout: '',
resolve: (value) => resolve(value as string[]),
reject,
timeoutId: null,
timeoutMs,
});
const message: PythonWorkerRequest = {
type: 'inspectEntrypoints',
requestId,
code,
cacheKey: options?.cacheKey,
};
this.enqueueRequest(message);
});
}
async syntaxCheck(code: string, options?: PythonExecuteOptions): Promise<PythonSyntaxCheckResult> {
await this.initialize();
if (!this.worker || !this.ready) {
throw new Error('Python runtime is not ready');
}
const requestId = this.nextRequestId();
const timeoutMs = options?.timeoutMs ?? 5000;
return new Promise<PythonSyntaxCheckResult>((resolve, reject) => {
this.pendingRuns.set(requestId, {
kind: 'syntax-check',
stdout: '',
resolve: (value) => resolve(value as PythonSyntaxCheckResult),
reject,
timeoutId: null,
timeoutMs,
});
const message: PythonWorkerRequest = {
type: 'syntaxCheck',
requestId,
code,
cacheKey: options?.cacheKey,
};
this.enqueueRequest(message);
});
}
isReady(): boolean {
return this.ready;
}
dispose(): void {
this.resetRuntime();
}
private handleWorkerMessage(payload: PythonWorkerMessage): void {
if (payload.type === 'ready') {
this.ready = true;
this.initializingPromise = null;
this.initializeDeferred?.resolve();
this.initializeDeferred = null;
return;
}
if (payload.type === 'error') {
this.handleWorkerError(new Error(payload.error));
return;
}
if (payload.type === 'apiCall') {
void this.handleApiCall(payload);
return;
}
if (payload.type === 'toast') {
this.onToast(payload.message, payload.toastType);
return;
}
const pendingRun = this.pendingRuns.get(payload.requestId);
if (!pendingRun) {
if (this.activeRequestId === payload.requestId && payload.type !== 'stdout') {
this.activeRequestId = null;
this.dispatchNextRequest();
}
return;
}
if (payload.type === 'stdout') {
pendingRun.stdout += payload.chunk;
pendingRun.onStdout?.(payload.chunk);
return;
}
this.pendingRuns.delete(payload.requestId);
if (pendingRun.timeoutId) {
clearTimeout(pendingRun.timeoutId);
}
if (payload.type === 'runResult') {
if (pendingRun.kind !== 'run') {
pendingRun.reject(new Error('Invalid response type for pending macro request'));
this.finishRequest(payload.requestId);
return;
}
pendingRun.resolve({ result: payload.result, stdout: pendingRun.stdout });
this.finishRequest(payload.requestId);
return;
}
if (payload.type === 'entrypoints') {
if (pendingRun.kind !== 'inspect-entrypoints') {
pendingRun.reject(new Error('Invalid response type for pending run request'));
this.finishRequest(payload.requestId);
return;
}
pendingRun.resolve(payload.entrypoints);
this.finishRequest(payload.requestId);
return;
}
if (payload.type === 'syntaxResult') {
if (pendingRun.kind !== 'syntax-check') {
pendingRun.reject(new Error('Invalid response type for pending syntax check request'));
this.finishRequest(payload.requestId);
return;
}
pendingRun.resolve({ errors: payload.errors });
this.finishRequest(payload.requestId);
return;
}
if (payload.type === 'macroResult') {
if (pendingRun.kind !== 'macro-v1') {
pendingRun.reject(new Error('Invalid response type for pending run request'));
this.finishRequest(payload.requestId);
return;
}
try {
const validatedResult = parseMacroResultV1(payload.result);
pendingRun.resolve({ result: validatedResult, stdout: pendingRun.stdout });
} catch (error) {
pendingRun.reject(error instanceof Error ? error : new Error(String(error)));
}
this.finishRequest(payload.requestId);
return;
}
pendingRun.reject(new Error(payload.error));
this.finishRequest(payload.requestId);
}
private async handleApiCall(payload: Extract<PythonWorkerMessage, { type: 'apiCall' }>): Promise<void> {
if (!this.worker || !this.ready) {
return;
}
try {
const result = await this.invokeApiCall(payload.method, payload.args);
const response: PythonWorkerRequest = {
type: 'apiResult',
requestId: payload.requestId,
callId: payload.callId,
ok: true,
result,
};
this.worker.postMessage(response);
} catch (error) {
const response: PythonWorkerRequest = {
type: 'apiResult',
requestId: payload.requestId,
callId: payload.callId,
ok: false,
error: error instanceof Error ? error.message : String(error),
};
this.worker.postMessage(response);
}
}
private handleWorkerError(error: Error): void {
if (this.initializeDeferred) {
this.initializeDeferred.reject(error);
this.initializeDeferred = null;
}
for (const run of this.pendingRuns.values()) {
if (run.timeoutId) {
clearTimeout(run.timeoutId);
}
run.reject(error);
}
this.pendingRuns.clear();
this.requestQueue = [];
this.activeRequestId = null;
this.worker?.terminate();
this.worker = null;
this.initializingPromise = null;
this.ready = false;
}
private resetRuntime(timeoutErrorMessage?: string): void {
if (this.initializeDeferred) {
this.initializeDeferred.reject(new Error(timeoutErrorMessage ?? 'Python runtime reset'));
this.initializeDeferred = null;
}
for (const run of this.pendingRuns.values()) {
if (run.timeoutId) {
clearTimeout(run.timeoutId);
}
if (timeoutErrorMessage) {
run.reject(new Error(timeoutErrorMessage));
}
}
this.pendingRuns.clear();
this.requestQueue = [];
this.activeRequestId = null;
this.worker?.terminate();
this.worker = null;
this.initializingPromise = null;
this.ready = false;
}
private enqueueRequest(request: PythonWorkerRequest): void {
if (!this.worker || !this.ready) {
this.requestQueue.push(request);
return;
}
if (this.activeRequestId !== null) {
this.requestQueue.push(request);
return;
}
this.activeRequestId = request.requestId;
this.startTimeoutForRequest(request.requestId);
this.worker.postMessage(request);
}
private dispatchNextRequest(): void {
if (!this.worker || !this.ready || this.activeRequestId !== null || this.requestQueue.length === 0) {
return;
}
const nextRequest = this.requestQueue.shift();
if (!nextRequest) {
return;
}
this.activeRequestId = nextRequest.requestId;
this.startTimeoutForRequest(nextRequest.requestId);
this.worker.postMessage(nextRequest);
}
private startTimeoutForRequest(requestId: string): void {
const pendingRun = this.pendingRuns.get(requestId);
if (!pendingRun || pendingRun.timeoutMs <= 0) {
return;
}
pendingRun.timeoutId = setTimeout(() => {
this.pendingRuns.delete(requestId);
this.resetRuntime(`Python script execution timed out after ${pendingRun.timeoutMs}ms`);
pendingRun.reject(new Error(`Python script execution timed out after ${pendingRun.timeoutMs}ms`));
}, pendingRun.timeoutMs);
}
private finishRequest(requestId: string): void {
if (this.activeRequestId === requestId) {
this.activeRequestId = null;
}
this.dispatchNextRequest();
}
private nextRequestId(): string {
this.requestCounter += 1;
return `req-${this.requestCounter}`;
}
private withMacroEnvMetadata(context: unknown, options?: PythonMacroRenderOptions): unknown {
if (!options?.macroHook && !options?.macroSource) {
return context;
}
if (!context || typeof context !== 'object' || Array.isArray(context)) {
return context;
}
const contextRecord = context as Record<string, unknown>;
const envValue = contextRecord.env;
if (!envValue || typeof envValue !== 'object' || Array.isArray(envValue)) {
return context;
}
const envRecord = envValue as Record<string, unknown>;
const nextEnv: Record<string, unknown> = { ...envRecord };
if (nextEnv.hook === undefined && options.macroHook !== undefined) {
nextEnv.hook = options.macroHook;
}
if (nextEnv.source === undefined && options.macroSource !== undefined) {
nextEnv.source = options.macroSource;
}
return {
...contextRecord,
env: nextEnv,
};
}
}