@cjser/make-synchronous 2.1.0-cjser.2

package/dist-cjser/index.cjs

@@ -0,0 +1,80 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/make-synchronous.tmp-26-1778153404829/index.js
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_worker_threads = require("node:worker_threads");
+var import_meta = {};
+var IS_WORKER_MARK = "is-make-synchronous-worker";
+var _a;
+var IS_WORKER = (_a = import_node_worker_threads.workerData) == null ? void 0 : _a[IS_WORKER_MARK];
+function setupWorker(function_) {
+  const { workerPort } = import_node_worker_threads.workerData;
+  import_node_worker_threads.parentPort.on("message", async ({ arguments_, semaphore }) => {
+    try {
+      workerPort.postMessage({ result: await function_(...arguments_) });
+    } catch (error) {
+      workerPort.postMessage({ error });
+    } finally {
+      Atomics.store(semaphore, 0, 1);
+      Atomics.notify(semaphore, 0, 1);
+    }
+  });
+}
+function makeSynchronous(function_) {
+  let cache;
+  function createWorker() {
+    if (!cache) {
+      const { port1: mainThreadPort, port2: workerPort } = new MessageChannel();
+      mainThreadPort.unref();
+      workerPort.unref();
+      const code = `
+				import setupWorker from ${JSON.stringify(import_meta.url)};
+
+				setupWorker(${function_});
+			`;
+      const worker = new import_node_worker_threads.Worker(code, {
+        eval: true,
+        workerData: {
+          workerPort,
+          [IS_WORKER_MARK]: true
+        },
+        transferList: [workerPort]
+      });
+      worker.unref();
+      cache = { worker, mainThreadPort };
+    }
+    return cache;
+  }
+  return (...arguments_) => {
+    const { worker, mainThreadPort } = createWorker();
+    const semaphore = new Int32Array(new SharedArrayBuffer(Int32Array.BYTES_PER_ELEMENT));
+    worker.postMessage({ arguments_, semaphore });
+    Atomics.wait(semaphore, 0, 0);
+    const { error, result } = (0, import_node_worker_threads.receiveMessageOnPort)(mainThreadPort).message;
+    if (error) {
+      throw error;
+    }
+    return result;
+  };
+}
+var index_default = IS_WORKER ? setupWorker : makeSynchronous;

package/dist-cjser/subprocess.cjs

@@ -0,0 +1,87 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/make-synchronous.tmp-26-1778153404829/subprocess.js
+var subprocess_exports = {};
+__export(subprocess_exports, {
+  default: () => makeSynchronous
+});
+module.exports = __toCommonJS(subprocess_exports);
+var import_node_buffer = require("node:buffer");
+var import_node_child_process = __toESM(require("node:child_process"), 1);
+var import_node_v8 = __toESM(require("node:v8"), 1);
+var import_node_process = __toESM(require("node:process"), 1);
+var import_subsume = __toESM(require("@cjser/subsume"), 1);
+var HUNDRED_MEGABYTES = 1e3 * 1e3 * 100;
+function makeSynchronous(function_) {
+  return (...arguments_) => {
+    const serializedArguments = import_node_v8.default.serialize(arguments_).toString("hex");
+    const subsume = new import_subsume.default();
+    const input = `
+			import v8 from 'node:v8';
+			import Subsume from '@cjser/subsume';
+
+			const subsume = new Subsume('${subsume.id}');
+
+			const send = value => {
+				const serialized = v8.serialize(value).toString('hex');
+				process.stdout.write(subsume.compose(serialized));
+			};
+
+			try {
+				const arguments_ = v8.deserialize(Buffer.from('${serializedArguments}', 'hex'));
+				const result = await (${function_})(...arguments_);
+				send({result});
+			} catch (error) {
+				send({error});
+			}
+		`;
+    const env = { ...import_node_process.default.env, ELECTRON_RUN_AS_NODE: "1" };
+    env.NODE_OPTIONS &&= env.NODE_OPTIONS.split(/\s+/).filter((option) => !/^--(?:inspect|debug)/.test(option)).join(" ");
+    const { error: subprocessError, stdout, stderr } = import_node_child_process.default.spawnSync(import_node_process.default.execPath, ["--input-type=module", "-"], {
+      input,
+      encoding: "utf8",
+      maxBuffer: HUNDRED_MEGABYTES,
+      env
+    });
+    if (subprocessError) {
+      throw subprocessError;
+    }
+    const { data, rest } = subsume.parse(stdout);
+    import_node_process.default.stdout.write(rest);
+    import_node_process.default.stderr.write(stderr);
+    if (!data) {
+      return;
+    }
+    const { error, result } = import_node_v8.default.deserialize(import_node_buffer.Buffer.from(data, "hex"));
+    if (error) {
+      throw error;
+    }
+    return result;
+  };
+}

package/index.d.ts

@@ -0,0 +1,39 @@
+import type {AsyncReturnType} from 'type-fest';
+
+// TODO: Move these to https://github.com/sindresorhus/type-fest
+type AnyAsyncFunction = (...argumentsList: any[]) => Promise<unknown | void>;
+type ReplaceReturnType<T extends (...arguments_: any) => unknown, NewReturnType> = (...arguments_: Parameters<T>) => NewReturnType;
+
+/**
+Returns a wrapped version of the given async function or a string representation to a async function which executes synchronously. This means no other code will execute (not even async code) until the given async function is done.
+
+The function is executed in a worker or subprocess, so you cannot access variables or imports from outside its scope. Use `await import(…)` to import dependencies inside the function.
+
+Uses [`MessagePort#postMessage()`](https://nodejs.org/api/worker_threads.html#portpostmessagevalue-transferlist) or the V8 serialization API to transfer arguments, return values, errors between the worker or subprocess and the current process. Most values are supported — except functions and symbols.
+
+@example
+```
+import makeSynchronous from '@cjser/make-synchronous';
+
+const fn = makeSynchronous(async number => {
+	const {default: delay} = await import('delay');
+
+	await delay(100);
+
+	return number * 2;
+});
+
+console.log(fn(2));
+//=> 4
+```
+
+@example
+```
+import makeSynchronous from '@cjser/make-synchronous/subprocess';
+
+makeSynchronous(async () => {
+	// Runs in a subprocess.
+});
+```
+*/
+export default function makeSynchronous<T extends AnyAsyncFunction = AnyAsyncFunction>(asyncFunction: T | string): ReplaceReturnType<T, AsyncReturnType<T>>;

package/index.js

@@ -0,0 +1,74 @@
+import {
+	workerData,
+	receiveMessageOnPort,
+	parentPort,
+	Worker,
+} from 'node:worker_threads';
+
+// Not using `isMainThread` so it can be used in another worker.
+const IS_WORKER_MARK = 'is-make-synchronous-worker';
+const IS_WORKER = workerData?.[IS_WORKER_MARK];
+
+function setupWorker(function_) {
+	const {workerPort} = workerData;
+	parentPort.on('message', async ({arguments_, semaphore}) => {
+		try {
+			workerPort.postMessage({result: await function_(...arguments_)});
+		} catch (error) {
+			workerPort.postMessage({error});
+		} finally {
+			Atomics.store(semaphore, 0, 1);
+			Atomics.notify(semaphore, 0, 1);
+		}
+	});
+}
+
+function makeSynchronous(function_) {
+	let cache;
+
+	function createWorker() {
+		if (!cache) {
+			const {port1: mainThreadPort, port2: workerPort} = new MessageChannel();
+			mainThreadPort.unref();
+			workerPort.unref();
+
+			const code = `
+				import setupWorker from ${JSON.stringify(import.meta.url)};
+
+				setupWorker(${function_});
+			`;
+
+			const worker = new Worker(code, {
+				eval: true,
+				workerData: {
+					workerPort,
+					[IS_WORKER_MARK]: true,
+				},
+				transferList: [workerPort],
+			});
+			worker.unref();
+
+			cache = {worker, mainThreadPort};
+		}
+
+		return cache;
+	}
+
+	return (...arguments_) => {
+		const {worker, mainThreadPort} = createWorker();
+		const semaphore = new Int32Array(new SharedArrayBuffer(Int32Array.BYTES_PER_ELEMENT));
+
+		worker.postMessage({arguments_, semaphore});
+		Atomics.wait(semaphore, 0, 0);
+
+		const {error, result} = receiveMessageOnPort(mainThreadPort).message;
+
+		if (error) {
+			throw error;
+		}
+
+		return result;
+	};
+}
+
+export default IS_WORKER ? setupWorker : makeSynchronous;

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@cjser/make-synchronous",
+  "version": "2.1.0-cjser.2",
+  "description": "Make an asynchronous function synchronous",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://code.moenext.com/3rdeye/cjser.git"
+  },
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "https://sindresorhus.com"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./dist-cjser/index.cjs",
+      "default": "./index.js"
+    },
+    "./subprocess": {
+      "types": "./index.d.ts",
+      "require": "./dist-cjser/subprocess.cjs",
+      "default": "./subprocess.js"
+    }
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "subprocess.js",
+    "index.d.ts",
+    "dist-cjser"
+  ],
+  "keywords": [
+    "function",
+    "synchronous",
+    "sync",
+    "block",
+    "main",
+    "thread",
+    "deasync",
+    "fiber",
+    "asynchronous",
+    "async",
+    "worker"
+  ],
+  "dependencies": {
+    "type-fest": "^4.40.1",
+    "@cjser/subsume": "4.0.0-cjser.2"
+  },
+  "devDependencies": {
+    "ava": "^6.2.0",
+    "delay": "^6.0.0",
+    "in-range": "^3.0.0",
+    "time-span": "^5.1.0",
+    "tsd": "^0.32.0",
+    "xo": "^0.60.0"
+  },
+  "types": "./index.d.ts",
+  "main": "./dist-cjser/index.cjs",
+  "cjser": {
+    "sourceVersion": "2.1.0",
+    "cjserVersion": 2,
+    "original": {
+      "name": "make-synchronous",
+      "version": "2.1.0",
+      "exports": {
+        ".": {
+          "types": "./index.d.ts",
+          "default": "./index.js"
+        },
+        "./subprocess": {
+          "types": "./index.d.ts",
+          "default": "./subprocess.js"
+        }
+      },
+      "repository": "sindresorhus/make-synchronous",
+      "dependencies": {
+        "subsume": "^4.0.0",
+        "type-fest": "^4.40.1"
+      },
+      "files": [
+        "index.js",
+        "subprocess.js",
+        "index.d.ts"
+      ],
+      "scripts": {
+        "test": "xo && ava && tsd"
+      }
+    }
+  }
+}

package/readme.md

@@ -0,0 +1,67 @@
+# make-synchronous
+
+> Make an asynchronous function synchronous
+
+**This is the wrong tool for most tasks!** Prefer async APIs whenever possible.
+
+The benefit of this package over packages like [`deasync`](https://github.com/abbr/deasync) is that this one is not a native Node.js addon (which comes with a lot of problems). Instead, this package executes the given function synchronously in a [`worker`](https://nodejs.org/api/worker_threads.html) or [`subprocess`](https://nodejs.org/api/child_process.html).
+
+Works in Node.js only — not the browser.
+
+## Install
+
+```sh
+npm install make-synchronous
+```
+
+## Usage
+
+Runs in a worker thread by default:
+
+```js
+import makeSynchronous from 'make-synchronous';
+
+const fn = makeSynchronous(async number => {
+	const {default: delay} = await import('delay');
+
+	await delay(100);
+
+	return number * 2;
+});
+
+console.log(fn(2));
+//=> 4
+```
+
+To run in a subprocess instead:
+
+```js
+import makeSynchronous from 'make-synchronous/subprocess';
+
+makeSynchronous(async () => {
+	// Runs in a subprocess.
+});
+```
+
+Subprocess execution is slower, but has the benefit of full process isolation.
+
+## API
+
+### makeSynchronous(asyncFunction | string)
+
+Returns a wrapped version of the given async function or a string representation to a async function which executes synchronously. This means no other code will execute (not even async code) until the given async function is done.
+
+The function is executed in a worker or subprocess, so you cannot access variables or imports from outside its scope. Use `await import(…)` to import dependencies inside the function.
+
+Uses [`MessagePort#postMessage()`](https://nodejs.org/api/worker_threads.html#portpostmessagevalue-transferlist) or the V8 serialization API to transfer arguments, return values, errors between the worker or subprocess and the current process. Most values are supported — except functions and symbols.
+
+## Related
+
+- [make-asynchronous](https://github.com/sindresorhus/make-asynchronous) - Make a synchronous function asynchronous by running it in a worker
+- [sleep-synchronously](https://github.com/sindresorhus/sleep-synchronously) - Block the main thread for a given amount of time
+- [make-synchronized](https://github.com/fisker/make-synchronized) - For advanced cases like fully synchronizing an existing module or needing top-level imports
+
+## cjser
+
+This package is a CommonJS-compatible build generated by cjser for projects that still need `require()` support. The source version matches the original npm package version, with a cjser prerelease suffix for this generated build.
+Original repository: https://github.com/sindresorhus/make-synchronous

package/subprocess.js

@@ -0,0 +1,70 @@
+import {Buffer} from 'node:buffer';
+import childProcess from 'node:child_process';
+import v8 from 'node:v8';
+import process from 'node:process';
+import Subsume from '@cjser/subsume';
+
+const HUNDRED_MEGABYTES = 1000 * 1000 * 100;
+
+export default function makeSynchronous(function_) {
+	return (...arguments_) => {
+		const serializedArguments = v8.serialize(arguments_).toString('hex');
+		const subsume = new Subsume();
+
+		const input = `
+			import v8 from 'node:v8';
+			import Subsume from '@cjser/subsume';
+
+			const subsume = new Subsume('${subsume.id}');
+
+			const send = value => {
+				const serialized = v8.serialize(value).toString('hex');
+				process.stdout.write(subsume.compose(serialized));
+			};
+
+			try {
+				const arguments_ = v8.deserialize(Buffer.from('${serializedArguments}', 'hex'));
+				const result = await (${function_})(...arguments_);
+				send({result});
+			} catch (error) {
+				send({error});
+			}
+		`;
+
+		const env = {...process.env, ELECTRON_RUN_AS_NODE: '1'};
+
+		// Prevent debugger flags from the parent from forcing the child to open a debug port.
+		env.NODE_OPTIONS &&= env.NODE_OPTIONS
+			.split(/\s+/)
+			.filter(option => !/^--(?:inspect|debug)/.test(option))
+			.join(' ');
+
+		const {error: subprocessError, stdout, stderr} = childProcess.spawnSync(process.execPath, ['--input-type=module', '-'], {
+			input,
+			encoding: 'utf8',
+			maxBuffer: HUNDRED_MEGABYTES,
+			env,
+		});
+
+		if (subprocessError) {
+			throw subprocessError;
+		}
+
+		const {data, rest} = subsume.parse(stdout);
+
+		process.stdout.write(rest);
+		process.stderr.write(stderr);
+
+		if (!data) {
+			return;
+		}
+
+		const {error, result} = v8.deserialize(Buffer.from(data, 'hex'));
+
+		if (error) {
+			throw error;
+		}
+
+		return result;
+	};
+}