Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: worker pooling #962

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 20 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .ghjk/deno.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 12 additions & 12 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ exclude = [
]

[workspace.package]
version = "0.5.0"
version = "0.5.1-rc.0"
edition = "2021"

[workspace.dependencies]
Expand Down
442 changes: 442 additions & 0 deletions deno.lock

Large diffs are not rendered by default.

64 changes: 35 additions & 29 deletions docs/metatype.dev/docs/reference/typegate/index.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions examples/templates/deno/api/example.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Policy, t, typegraph } from "jsr:@typegraph/[email protected]";
import { PythonRuntime } from "jsr:@typegraph/[email protected]/runtimes/python";
import { DenoRuntime } from "jsr:@typegraph/[email protected]/runtimes/deno";
import { Policy, t, typegraph } from "jsr:@typegraph/[email protected].1-rc.0";
import { PythonRuntime } from "jsr:@typegraph/[email protected].1-rc.0/runtimes/python";
import { DenoRuntime } from "jsr:@typegraph/[email protected].1-rc.0/runtimes/deno";

await typegraph("example", (g) => {
const pub = Policy.public();
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/deno/compose.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
services:
typegate:
image: ghcr.io/metatypedev/typegate:v0.5.0
image: ghcr.io/metatypedev/typegate:v0.5.1-rc.0
restart: always
ports:
- "7890:7890"
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/node/compose.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
services:
typegate:
image: ghcr.io/metatypedev/typegate:v0.5.0
image: ghcr.io/metatypedev/typegate:v0.5.1-rc.0
restart: always
ports:
- "7890:7890"
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"dev": "MCLI_LOADER_CMD='npm x tsx' meta dev"
},
"dependencies": {
"@typegraph/sdk": "^0.5.0"
"@typegraph/sdk": "^0.5.1-rc.0"
},
"devDependencies": {
"tsx": "^3.13.0",
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/python/compose.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
services:
typegate:
image: ghcr.io/metatypedev/typegate:v0.5.0
image: ghcr.io/metatypedev/typegate:v0.5.1-rc.0
restart: always
ports:
- "7890:7890"
Expand Down
4 changes: 2 additions & 2 deletions examples/templates/python/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[tool.poetry]
name = "example"
version = "0.5.0"
version = "0.5.1-rc.0"
description = ""
authors = []

[tool.poetry.dependencies]
python = ">=3.8,<4.0"
typegraph = "0.5.0"
typegraph = "0.5.1-rc.0"

[build-system]
requires = ["poetry-core"]
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[tool.poetry]
name = "metatype"
version = "0.5.0"
version = "0.5.1-rc.0"
description = ""
authors = []

Expand Down
2 changes: 1 addition & 1 deletion src/pyrt_wit_wire/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "pyrt_wit_wire"
version = "0.5.0"
version = "0.5.1-rc.0"
description = "Wasm component implementing the PythonRuntime host using wit_wire protocol."
license = "MPL-2.0"
readme = "README.md"
Expand Down
2 changes: 1 addition & 1 deletion src/typegate/engine/src/runtimes/wit_wire.rs
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ pub fn op_wit_wire_destroy(
scope: &mut v8::HandleScope<'_>,
#[string] instance_id: String,
) {
debug!("destroying wit_wire instnace {instance_id}");
debug!("destroying wit_wire instance {instance_id}");
let ctx = {
let state = state.borrow();
let ctx = state.borrow::<Ctx>();
Expand Down
12 changes: 11 additions & 1 deletion src/typegate/src/config/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@ export const globalConfigSchema = z.object({
sentry_sample_rate: z.coerce.number().positive().min(0).max(1),
sentry_traces_sample_rate: z.coerce.number().positive().min(0).max(1),
deno_v8_flags: z.string().optional(),
min_deno_workers: z.coerce.number().positive().default(2),
max_deno_workers: z.coerce.number().positive().default(8),
deno_worker_wait_timeout_ms: z.coerce.number().positive().default(5000),
// deno_idle_worker_timeout_ms: z.coerce.number().positive().optional(), // auto remove idle workers
min_substantial_workers: z.coerce.number().positive().default(2),
max_substantial_workers: z.coerce.number().positive().default(8),
substantial_worker_wait_timeout_ms: z.coerce.number().positive().default(
15000,
),
// substantial_idle_worker_timeout_ms: z.coerce.number().positive().optional(), // auto remove idle workers
Comment on lines +63 to +72
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Allow zero values for worker configuration parameters

The use of .positive() in z.coerce.number().positive() disallows zero values. However, in the worker pool configuration, a value of zero for maxWorkers or waitTimeoutMs may be used to indicate "no limit" or "no timeout". Consider using .nonnegative() instead to allow zero values where appropriate.

Apply this diff to allow zero values:

-    min_deno_workers: z.coerce.number().positive().default(2),
-    max_deno_workers: z.coerce.number().positive().default(8),
-    deno_worker_wait_timeout_ms: z.coerce.number().positive().default(5000),
-    min_substantial_workers: z.coerce.number().positive().default(2),
-    max_substantial_workers: z.coerce.number().positive().default(8),
-    substantial_worker_wait_timeout_ms: z.coerce.number().positive().default(
-        15000,
-      ),
+    min_deno_workers: z.coerce.number().nonnegative().default(2),
+    max_deno_workers: z.coerce.number().nonnegative().default(8),
+    deno_worker_wait_timeout_ms: z.coerce.number().nonnegative().default(5000),
+    min_substantial_workers: z.coerce.number().nonnegative().default(2),
+    max_substantial_workers: z.coerce.number().nonnegative().default(8),
+    substantial_worker_wait_timeout_ms: z.coerce.number().nonnegative().default(
+        15000,
+      ),
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
min_deno_workers: z.coerce.number().positive().default(2),
max_deno_workers: z.coerce.number().positive().default(8),
deno_worker_wait_timeout_ms: z.coerce.number().positive().default(5000),
// deno_idle_worker_timeout_ms: z.coerce.number().positive().optional(), // auto remove idle workers
min_substantial_workers: z.coerce.number().positive().default(2),
max_substantial_workers: z.coerce.number().positive().default(8),
substantial_worker_wait_timeout_ms: z.coerce.number().positive().default(
15000,
),
// substantial_idle_worker_timeout_ms: z.coerce.number().positive().optional(), // auto remove idle workers
min_deno_workers: z.coerce.number().nonnegative().default(2),
max_deno_workers: z.coerce.number().nonnegative().default(8),
deno_worker_wait_timeout_ms: z.coerce.number().nonnegative().default(5000),
// deno_idle_worker_timeout_ms: z.coerce.number().positive().optional(), // auto remove idle workers
min_substantial_workers: z.coerce.number().nonnegative().default(2),
max_substantial_workers: z.coerce.number().nonnegative().default(8),
substantial_worker_wait_timeout_ms: z.coerce.number().nonnegative().default(
15000,
),
// substantial_idle_worker_timeout_ms: z.coerce.number().positive().optional(), // auto remove idle workers

});
export type GlobalConfig = z.infer<typeof globalConfigSchema>;

Expand Down Expand Up @@ -122,7 +132,7 @@ export type SyncConfigX = {
redis: RedisConnectOptions;
s3: S3ClientConfig;
s3Bucket: string;
forceRemove?: boolean
forceRemove?: boolean;
};

export type TypegateConfig = {
Expand Down
2 changes: 1 addition & 1 deletion src/typegate/src/runtimes/deno/deno.ts
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ export class DenoRuntime extends Runtime {
}

async deinit(): Promise<void> {
// await this.workerManager.deinit();
this.workerManager.deinit();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Consider awaiting worker manager deinitialization.

Not awaiting workerManager.deinit() could lead to resource leaks or race conditions during shutdown. Consider maintaining the async await to ensure proper cleanup.

Apply this diff to ensure proper resource cleanup:

-    this.workerManager.deinit();
+    await this.workerManager.deinit();

Committable suggestion skipped: line range outside the PR's diff.

}

materialize(
Expand Down
32 changes: 23 additions & 9 deletions src/typegate/src/runtimes/deno/worker_manager.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
// Copyright Metatype OÜ, licensed under the Mozilla Public License Version 2.0.
// SPDX-License-Identifier: MPL-2.0

import { globalConfig } from "../../config.ts";
import { getLogger } from "../../log.ts";
import { DenoWorker } from "../patterns/worker_manager/deno.ts";
import {
BaseWorkerManager,
createTaskId,
} from "../patterns/worker_manager/mod.ts";
import { WorkerPool } from "../patterns/worker_manager/pooling.ts";
import { TaskId } from "../patterns/worker_manager/types.ts";
import { TaskContext } from "./shared_types.ts";
import { DenoEvent, DenoMessage, TaskSpec } from "./types.ts";
Expand All @@ -19,23 +21,35 @@ export type WorkerManagerConfig = {

export class WorkerManager
extends BaseWorkerManager<TaskSpec, DenoMessage, DenoEvent> {
static #pool: WorkerPool<TaskSpec, DenoMessage, DenoEvent> | null = null;
static #getPool() {
if (!WorkerManager.#pool) {
WorkerManager.#pool = new WorkerPool(
"deno runtime",
{
minWorkers: globalConfig.min_deno_workers,
maxWorkers: globalConfig.max_deno_workers,
waitTimeoutMs: globalConfig.deno_worker_wait_timeout_ms,
},
(id: string) => new DenoWorker(id, import.meta.resolve("./worker.ts")),
);
}
return WorkerManager.#pool!;
}

constructor(private config: WorkerManagerConfig) {
super(
(taskId: TaskId) => {
return new DenoWorker(taskId, import.meta.resolve("./worker.ts"));
},
);
super(WorkerManager.#getPool());
}

callFunction(
async callFunction(
name: string,
modulePath: string,
relativeModulePath: string,
args: unknown,
internalTCtx: TaskContext,
) {
const taskId = createTaskId(`${name}@${relativeModulePath}`);
this.createWorker(name, taskId, {
await this.delegateTask(name, taskId, {
modulePath,
functionName: name,
});
Expand All @@ -49,13 +63,13 @@ export class WorkerManager

return new Promise((resolve, reject) => {
const timeoutId = setTimeout(() => {
this.destroyWorker(name, taskId);
this.deallocateWorker(name, taskId);
reject(new Error(`${this.config.timeout_ms}ms timeout exceeded`));
}, this.config.timeout_ms);

const handler: (event: DenoEvent) => void = (event) => {
clearTimeout(timeoutId);
this.destroyWorker(name, taskId);
this.deallocateWorker(name, taskId);
switch (event.type) {
case "SUCCESS":
resolve(event.result);
Expand Down
17 changes: 9 additions & 8 deletions src/typegate/src/runtimes/patterns/worker_manager/deno.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import { envSharedWithWorkers } from "../../../config/shared.ts";
import { BaseWorker } from "./mod.ts";
import { BaseMessage, EventHandler, TaskId } from "./types.ts";
import { BaseMessage, EventHandler } from "./types.ts";

export interface DenoWorkerError extends BaseMessage {
type: "WORKER_ERROR";
Expand All @@ -15,11 +15,11 @@ export type BaseDenoWorkerMessage = BaseMessage | DenoWorkerError;
export class DenoWorker<M extends BaseMessage, E extends BaseDenoWorkerMessage>
extends BaseWorker<M, E> {
#worker: Worker;
#taskId: TaskId;
constructor(taskId: TaskId, workerPath: string) {
#workerId: string;
constructor(workerId: string, workerPath: string) {
super();
this.#worker = new Worker(workerPath, {
name: taskId,
name: workerId,
type: "module",
deno: {
permissions: {
Expand All @@ -35,21 +35,22 @@ export class DenoWorker<M extends BaseMessage, E extends BaseDenoWorkerMessage>
},
},
});
this.#taskId = taskId;
this.#workerId = workerId;
}

listen(handlerFn: EventHandler<E>) {
this.#worker.onmessage = async (message) => {
await handlerFn(message.data as E);
};

this.#worker.onerror = /*async*/ (event) =>
handlerFn(
this.#worker.onerror = async (event) => {
await handlerFn(
{
type: "WORKER_ERROR",
event,
} as E,
);
};
}

send(msg: M) {
Expand All @@ -61,6 +62,6 @@ export class DenoWorker<M extends BaseMessage, E extends BaseDenoWorkerMessage>
}

get id() {
return this.#taskId;
return this.#workerId;
}
}
Loading
Loading