Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 7x 7x 7x 7x 7x 3x 2x 2x 2x 4x 3x 5x 5x 2x 2x 2x 2x 3x 3x | /**
* Worker Thread Communication Protocol
*
* Defines strict types for message passing between main thread and worker threads.
* Eliminates 'any' types and enforces type safety in the compilation worker pool.
*
* Architecture:
* - Main Thread (compilation-worker-pool.ts) sends WorkerMessage<CompileRequestPayload>
* - Worker Thread (compile-worker.ts) sends WorkerMessage<CompileResponsePayload>
* - Generic WorkerMessage<T> ensures type safety across all message types
*/
import type { CompilationResult } from "../server/services/arduino-compiler";
/**
* Commands that can be sent to worker threads
*/
export enum WorkerCommand {
COMPILE = "compile",
READY = "ready",
SHUTDOWN = "shutdown",
COMPILE_RESULT = "compile_result",
}
/**
* Compilation request payload sent from main thread to worker
*/
export interface CompileRequestPayload {
code: string;
headers?: Array<{ name: string; content: string }>;
tempRoot?: string;
fqbn?: string;
libraries?: string[];
sketchHash?: string;
coreFingerprint?: string;
}
/**
* Compilation response payload sent from worker to main thread
*/
export interface CompileResponsePayload {
result?: CompilationResult;
error?: WorkerError;
}
/**
* Structured error object for worker errors
*/
export interface WorkerError {
message: string;
code?: string;
stack?: string;
}
/**
* Generic worker message envelope
* T = payload type (CompileRequestPayload | CompileResponsePayload | void)
*/
export interface WorkerMessage<T = void> {
type: WorkerCommand;
taskId?: string;
payload?: T;
}
/**
* Specific message types for type narrowing
*/
export interface CompileRequestMessage extends WorkerMessage<CompileRequestPayload> {
type: WorkerCommand.COMPILE;
payload: CompileRequestPayload;
}
export interface CompileResponseMessage extends WorkerMessage<CompileResponsePayload> {
type: WorkerCommand.COMPILE_RESULT;
payload: CompileResponsePayload;
}
export interface ReadyMessage extends WorkerMessage<void> {
type: WorkerCommand.READY;
}
export interface ShutdownMessage extends WorkerMessage<void> {
type: WorkerCommand.SHUTDOWN;
}
/**
* Union type for all possible worker messages
*/
export type AnyWorkerMessage =
| CompileRequestMessage
| CompileResponseMessage
| ReadyMessage
| ShutdownMessage;
/**
* Type guard to check if a message is a compile request
*/
export function isCompileRequest(msg: WorkerMessage<unknown>): msg is CompileRequestMessage {
return msg.type === WorkerCommand.COMPILE && msg.payload !== undefined;
}
/**
* Type guard to check if a message is a compile response
*/
export function isCompileResponse(msg: WorkerMessage<unknown>): msg is CompileResponseMessage {
return msg.type === WorkerCommand.COMPILE_RESULT && msg.payload !== undefined;
}
/**
* Type guard to check if a message is a ready signal
*/
export function isReadyMessage(msg: WorkerMessage<unknown>): msg is ReadyMessage {
return msg.type === WorkerCommand.READY;
}
/**
* Type guard to check if a message is a shutdown signal
*/
export function isShutdownMessage(msg: WorkerMessage<unknown>): msg is ShutdownMessage {
return msg.type === WorkerCommand.SHUTDOWN;
}
/**
* Helper to create a compile request message
*/
export function createCompileRequest(
payload: CompileRequestPayload,
taskId?: string
): CompileRequestMessage {
return {
type: WorkerCommand.COMPILE,
payload,
taskId,
};
}
/**
* Helper to create a compile response message
*/
export function createCompileResponse(
payload: CompileResponsePayload,
taskId?: string
): CompileResponseMessage {
return {
type: WorkerCommand.COMPILE_RESULT,
payload,
taskId,
};
}
/**
* Helper to create a ready message
*/
export function createReadyMessage(): ReadyMessage {
return {
type: WorkerCommand.READY,
};
}
/**
* Helper to create a structured worker error
*/
export function createWorkerError(err: unknown): WorkerError {
if (err instanceof Error) {
// Access code property safely without type assertion (S4325)
const errObject = err as unknown as Record<string, unknown>;
const maybeCode = errObject.code;
const code = typeof maybeCode === "string" ? maybeCode : undefined;
return {
message: err.message,
code,
stack: err.stack,
};
}
Iif (err instanceof Object) {
return { message: JSON.stringify(err) };
}
// err is a primitive (string, number, boolean, null, undefined) — String() is safe
return { message: String(err as string | number | boolean | null | undefined) };
}
|