chore: merge #358 from refactor/worker-extraction

Neosoulink · web-flow · commit b7f610d3cc68 · 2025-09-12T23:52:43.000+03:00
### Description

refactor: worker extraction-
diff --git a/.changeset/metal-chairs-confess.md b/.changeset/metal-chairs-confess.md
@@ -0,0 +1,8 @@
+---
+"@quick-threejs/utils": patch
+"@quick-threejs/worker": patch
+---
+
+# 09-12-2025
+
+## refactor: move worker out of utils
diff --git a/packages/reactive/package.json b/packages/reactive/package.json
@@ -45,6 +45,7 @@
 	},
 	"dependencies": {
 		"@quick-threejs/utils": "workspace:*",
+		"@quick-threejs/worker": "workspace:*",
 		"rxjs": "^7.8.1",
 		"threads": "^1.7.0",
 		"three": "^0.172.0",
diff --git a/packages/reactive/src/core/app/app.module.ts b/packages/reactive/src/core/app/app.module.ts
@@ -1,6 +1,6 @@
 import "reflect-metadata";
 
-import { type WorkerThreadModule } from "@quick-threejs/utils";
+import type { WorkerThreadModule } from "@quick-threejs/worker";
 import { Observable } from "rxjs";
 import { inject, scoped, Lifecycle } from "tsyringe";
 
diff --git a/packages/reactive/src/core/app/app.worker.ts b/packages/reactive/src/core/app/app.worker.ts
@@ -1,4 +1,5 @@
-import { ExposedWorkerThreadModule, Methods } from "@quick-threejs/utils";
+import type { Methods } from "@quick-threejs/utils";
+import type { ExposedWorkerThreadModule } from "@quick-threejs/worker";
 import { container as parentContainer } from "tsyringe";
 import { expose } from "threads/worker";
 import type { WorkerFunction } from "threads/dist/types/worker";
diff --git a/packages/reactive/src/core/register/register.service.ts b/packages/reactive/src/core/register/register.service.ts
@@ -1,10 +1,10 @@
 import { inject, Lifecycle, scoped } from "tsyringe";
+import { copyProperties } from "@quick-threejs/utils";
 import {
-	copyProperties,
 	createWorkerPool,
-	WorkerPool
-} from "@quick-threejs/utils";
-import { WorkerThreadResolution } from "@quick-threejs/utils";
+	type WorkerPool,
+	type WorkerThreadResolution
+} from "@quick-threejs/worker";
 
 import { KEYBOARD_EVENT_CODES, RegisterPropsBlueprint } from "../../common";
 import { ExposedAppModule } from "../app/app.worker";
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/shared/utils/package.json b/shared/utils/package.json
@@ -14,7 +14,6 @@
 	"module": "./dist/main.mjs",
 	"types": "./dist/main.d.ts",
 	"dependencies": {
-		"threads": "^1.7.0",
 		"three": "^0.172.0"
 	},
 	"devDependencies": {
@@ -23,7 +22,6 @@
 		"@types/three": "^0.172.0"
 	},
 	"peerDependencies": {
-		"threads": "^1.7.0",
 		"three": "^0.172.0"
 	}
 }
diff --git a/shared/utils/src/main.ts b/shared/utils/src/main.ts
@@ -1,10 +1,8 @@
 export * from "./proxy/";
 export * from "./types/";
-export * from "./worker/";
 
 export * from "./hardware";
 export * from "./material";
 export * from "./object";
-export * from "./tokens";
 export * from "./type";
 export * from "./url";
diff --git a/shared/utils/src/types/index.ts b/shared/utils/src/types/index.ts
@@ -1,2 +1 @@
 export * from "./object.type";
-export * from "./worker.type";
diff --git a/shared/utils/src/worker/index.ts b/shared/utils/src/worker/index.ts
diff --git a/shared/worker/CHANGELOG.md b/shared/worker/CHANGELOG.md
@@ -0,0 +1,34 @@
+# @quick-threejs/worker
+
+## 0.1.16
+
+## 0.1.15
+
+### Patch Changes
+
+- 4ca0a3a: # Logs
+
+  ## `@quick-threejs/utils`
+
+  - `Threads.js` is now a part of `@quick-threejs/utils`
+  - Dropped `rxjs` and the worker lifecycle approach
+  - `WorkerPool#run` now returns an array of `WorkerThread` & `queue` boolean
+  - Add worker resources documentation
+  - Can manually run `WorkerPool#runNext`
+  - Improve `terminateAll` behavior
+  - Can terminate a thread from a worker using `MessageEvent`
+
+## 0.1.8
+
+### Patch Changes
+
+- 4874023: # Logs
+
+  ## fix(utils): `Object3D` serializer resolution
+
+  - **Stringify** the received converted Object for worker messaging support
+  - Deserializer now support the **stringify** JSON `Object3D`
+
+  ## feat(reactive): share screen sizings to events
+
+  - All the register events now share the `canvas` & `window` `height` and `width`
diff --git a/shared/worker/eslint.config.mjs b/shared/worker/eslint.config.mjs
@@ -0,0 +1,35 @@
+// @ts-check
+
+import globals from "globals";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+import tsEslint from "typescript-eslint";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+	baseDirectory: __dirname,
+	recommendedConfig: js.configs.recommended,
+	allConfig: js.configs.all
+});
+
+export default tsEslint.config(
+	...tsEslint.configs.recommended,
+	...compat.extends("./node_modules/@quick-threejs/config/eslint"),
+	{
+		languageOptions: {
+			ecmaVersion: 5,
+			sourceType: "script"
+		}
+	},
+	{
+		files: ["./src/**/*.js?(x)", "./src/**/*.ts?(x)"],
+		languageOptions: {
+			globals: {
+				...globals.browser
+			}
+		}
+	}
+);
diff --git a/shared/worker/package.json b/shared/worker/package.json
@@ -0,0 +1,30 @@
+{
+	"name": "@quick-threejs/worker",
+	"version": "0.1.16",
+	"scripts": {
+		"prepare": "pnpm run build",
+		"lint": "eslint && tsc --noEmit",
+		"dev": "vite build --watch",
+		"build": "pnpm run lint && vite build"
+	},
+	"files": [
+		"dist"
+	],
+	"main": "./dist/main.umd.js",
+	"module": "./dist/main.mjs",
+	"types": "./dist/main.d.ts",
+	"dependencies": {
+		"@quick-threejs/utils": "workspace:*",
+		"threads": "^1.7.0",
+		"three": "^0.172.0"
+	},
+	"devDependencies": {
+		"@quick-threejs/config": "workspace:*",
+		"@types/node": "^24.3.1",
+		"@types/three": "^0.172.0"
+	},
+	"peerDependencies": {
+		"threads": "^1.7.0",
+		"three": "^0.172.0"
+	}
+}
diff --git a/shared/worker/src/main.ts b/shared/worker/src/main.ts
@@ -0,0 +1,13 @@
+import { getSafeAvailableCoresCount } from "@quick-threejs/utils";
+
+import { WorkerPool } from "./pool";
+
+export const createWorkerPool = (maxWorkers?: number, debug?: boolean) => {
+	return new WorkerPool(maxWorkers || getSafeAvailableCoresCount(), !!debug);
+};
+
+export * from "./types/";
+export * from "./tokens/";
+
+export * from "./thread";
+export * from "./pool";
diff --git a/shared/worker/src/pool.ts b/shared/worker/src/pool.ts
@@ -1,9 +1,9 @@
-import { WorkerThread } from "./worker-thread";
+import { WorkerThread } from "./thread";
 import {
 	ExposedWorkerThreadModule,
 	WorkerThreadResolution,
 	WorkerThreadTask
-} from "../types/worker.type";
+} from "./types/worker.type";
 
 /**
  * @description {@link WorkerThread} Pool.
diff --git a/shared/worker/src/thread.ts b/shared/worker/src/thread.ts
@@ -5,8 +5,8 @@ import {
 	ExposedWorkerThreadModule,
 	WorkerThreadProps,
 	WorkerThreadTask
-} from "../types/worker.type";
-import { TERMINATE_THREAD_FROM_WORKER_TOKEN } from "../tokens";
+} from "./types/worker.type";
+import { TERMINATE_THREAD_FROM_WORKER_TOKEN } from "./tokens";
 
 let auto_increment_unique_id = -1;
 
diff --git a/shared/worker/src/tokens/index.ts b/shared/worker/src/tokens/index.ts
diff --git a/shared/worker/src/tokens/worker.ts b/shared/worker/src/tokens/worker.ts
diff --git a/shared/worker/src/types/index.ts b/shared/worker/src/types/index.ts
@@ -0,0 +1 @@
+export * from "./worker.type";
diff --git a/shared/worker/src/types/worker.type.ts b/shared/worker/src/types/worker.type.ts
@@ -1,6 +1,6 @@
-import { spawn, Worker } from "threads";
-import { WorkerFunction, WorkerModule } from "threads/dist/types/worker";
-import { ThreadsWorkerOptions } from "threads/dist/types/master";
+import type { spawn, Worker } from "threads";
+import type { WorkerFunction, WorkerModule } from "threads/dist/types/worker";
+import type { ThreadsWorkerOptions } from "threads/dist/types/master";
 
 /**
  * @description {@link WorkerModule} representation.
diff --git a/shared/worker/tsconfig.json b/shared/worker/tsconfig.json
@@ -0,0 +1,10 @@
+{
+	"extends": "@quick-threejs/config/typescript",
+	"compilerOptions": {
+		"experimentalDecorators": true,
+		"emitDecoratorMetadata": true,
+
+		"outDir": "./dist"
+	},
+	"include": ["src", "*.config.mjs"]
+}
diff --git a/shared/worker/vite.config.mts b/shared/worker/vite.config.mts
@@ -0,0 +1,30 @@
+import { resolve } from "path";
+import { defineConfig } from "vite";
+import dts from "vite-plugin-dts";
+import configs from "@quick-threejs/config";
+
+export default defineConfig({
+	...configs.vite,
+	build: {
+		lib: {
+			entry: resolve(__dirname, "src/main.ts"),
+			name: "QuickThreeUtils",
+			fileName: "main"
+		},
+		rollupOptions: {
+			external: ["threads", "three"],
+			output: {
+				globals: {
+					three: "THREE",
+					threads: "THREADS"
+				}
+			}
+		}
+	},
+	resolve: {
+		alias: {
+			"@/": resolve(__dirname, "src/")
+		}
+	},
+	plugins: [dts()]
+});

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`	`1`	`export * from "./object.type";`
`2`		`-export * from "./worker.type";`