Isomorphic PHP, Isomorphic Blueprints

.eslintrc.json

@@ -11,7 +11,12 @@
 					{
 						"enforceBuildableLibDependency": true,
 						"allow": [],
-						"depConstraints": []
+						"depConstraints": [
+							{
+								"sourceTag": "*",
+								"notDependOnLibsWithTags": ["scope:web-client"]
+							}
+						]
 					}
 				],
 				"no-inner-declarations": 0,

packages/nx-extensions/executors.json

@@ -15,6 +15,11 @@
 			"implementation": "./src/executors/package-json/executor",
 			"schema": "./src/executors/package-json/schema.json",
 			"description": "package-json executor"
+		},
+		"assert-built-esm-and-cjs": {
+			"implementation": "./src/executors/assert-built-esm-and-cjs/executor",
+			"schema": "./src/executors/assert-built-esm-and-cjs/schema.json",
+			"description": "assert-built-esm-and-cjs executor"
 		}
 	}
 }

packages/nx-extensions/src/executors/assert-built-esm-and-cjs/executor.ts

@@ -0,0 +1,57 @@
+import { ExecutorContext } from '@nrwl/devkit';
+import { spawnSync } from 'child_process';
+import { existsSync, mkdirSync, writeFileSync } from 'fs';
+import * as path from 'path';
+import { AssertBuiltEsmAndCjsExecutorSchema } from './schema';
+
+/**
+ * Test whether a module can be imported as both ESM and CJS.
+ *
+ * @param options
+ * @param context
+ * @returns
+ */
+export default async function runExecutor(
+	options: AssertBuiltEsmAndCjsExecutorSchema,
+	context: ExecutorContext
+) {
+	const buildDir = options.outputPath.split('/')[0];
+	const testsPath = path.join(context.root, buildDir, 'test-esm-cjs');
+	if (!existsSync(testsPath)) {
+		mkdirSync(testsPath);
+	}
+
+	writeFileSync(
+		path.join(testsPath, 'test-esm.mjs'),
+		`import * as result from '../../${options.outputPath}/index.js';`
+	);
+	writeFileSync(
+		path.join(testsPath, 'test-cjs.cjs'),
+		`require('../../${options.outputPath}');`
+	);
+	writeFileSync(
+		path.join(testsPath, 'test.sh'),
+		`#!/bin/sh
+set -e
+node test-esm.mjs;
+node test-cjs.cjs;
+echo Success;`
+	);
+
+	// Run test.sh and check exit code:
+	const test = spawnSync('sh', ['test.sh'], {
+		cwd: testsPath,
+		stdio: 'pipe',
+		encoding: 'utf-8',
+	});
+	// Trim spaces and newlines
+	const stdout = test.output.toString();
+	const success =
+		test.status === 0 && stdout.replace(/[^A-Za-z]/g, '') === 'Success';
+	if (!success) {
+		throw `${context.targetName} could not be imported as both ESM and CJS: ${stdout}`;
+	}
+	return {
+		success,
+	};
+}

packages/nx-extensions/src/executors/assert-built-esm-and-cjs/schema.d.ts

@@ -0,0 +1,3 @@
+export interface AssertBuiltEsmAndCjsExecutorSchema {
+	outputPath: string;
+} // eslint-disable-line

packages/nx-extensions/src/executors/assert-built-esm-and-cjs/schema.json

@@ -0,0 +1,15 @@
+{
+	"$schema": "http://json-schema.org/schema",
+	"version": 2,
+	"cli": "nx",
+	"title": "AssertBuiltEsmAndCjs executor",
+	"description": "",
+	"type": "object",
+	"properties": {
+		"outputPath": {
+			"type": "string",
+			"description": "The path to the built module"
+		}
+	},
+	"required": ["outputPath"]
+}

packages/php-wasm/cli/project.json

@@ -34,7 +34,7 @@
 			"options": {
 				"scriptPath": "dist/packages/php-wasm/cli/main.js"
 			},
-			"dependsOn": ["build", "^build-for-cli-run"]
+			"dependsOn": ["build"]
 		},
 		"publish": {
 			"executor": "nx:run-commands",

packages/php-wasm/cli/src/main.ts

@@ -6,10 +6,11 @@ import { rootCertificates } from 'tls';
 
 import {
 	LatestSupportedPHPVersion,
-	PHP,
 	SupportedPHPVersion,
 	SupportedPHPVersionsList,
-} from '@php-wasm/node';
+} from '@php-wasm/universal';
+
+import { NodePHP } from '@php-wasm/node';
 
 let args = process.argv.slice(2);
 if (!args.length) {
@@ -31,7 +32,7 @@ if (!SupportedPHPVersionsList.includes(phpVersion)) {
 	throw new Error(`Unsupported PHP version ${phpVersion}`);
 }
 
-const php = await PHP.load(phpVersion, {
+const php = await NodePHP.load(phpVersion, {
 	emscriptenOptions: {
 		ENV: {
 			...process.env,

packages/php-wasm/node/.eslintrc.json

@@ -4,15 +4,7 @@
 	"overrides": [
 		{
 			"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-			"rules": {
-				"@nrwl/nx/enforce-module-boundaries": [
-					"error",
-					{
-						"enforceBuildableLibDependency": true,
-						"allow": ["@php-wasm/abstract"]
-					}
-				]
-			}
+			"rules": {}
 		},
 		{
 			"files": ["*.ts", "*.tsx"],

packages/php-wasm/node/src/index.ts

@@ -1,37 +1 @@
-import { TextEncoder, TextDecoder } from 'util';
-global.TextEncoder = TextEncoder as any;
-global.TextDecoder = TextDecoder as any;
-
 export * from './lib';
-
-export {
-	LatestSupportedPHPVersion,
-	PHPBrowser,
-	SupportedPHPVersions,
-	SupportedPHPVersionsList,
-} from '@php-wasm/abstract';
-
-// Wildcard re-export of type is unfortunately unsupported by TypeScript.
-export type {
-	DataModule,
-	EmscriptenOptions,
-	ErrnoError,
-	FileInfo,
-	HTTPMethod,
-	MountSettings,
-	PHPLoaderModule,
-	PHPOutput,
-	PHPRequest,
-	PHPRequestHandler,
-	PHPRequestHeaders,
-	PHPResponse,
-	PHPRunOptions,
-	PHPRuntime,
-	PHPRuntimeId,
-	PHPRequestHandlerConfiguration,
-	RuntimeType,
-	SupportedPHPVersion,
-	WithFilesystem,
-	WithPHPIniBindings,
-	WorkerStartupOptions,
-} from '@php-wasm/abstract';

packages/php-wasm/node/src/lib/get-php-loader-module.ts

@@ -1,5 +1,5 @@
-import { LatestSupportedPHPVersion } from '@php-wasm/abstract';
-import type { PHPLoaderModule, SupportedPHPVersion } from '@php-wasm/abstract';
+import { LatestSupportedPHPVersion } from '@php-wasm/universal';
+import type { PHPLoaderModule, SupportedPHPVersion } from '@php-wasm/universal';
 
 export async function getPHPLoaderModule(
 	version: SupportedPHPVersion = LatestSupportedPHPVersion

packages/php-wasm/node/src/lib/networking/outbound-ws-to-tcp-proxy.ts

@@ -41,27 +41,23 @@ function prependByte(
 	return chunk;
 }
 
-/**
- * Send a chunk of data to the remote server.
- */
 export const COMMAND_CHUNK = 0x01;
-/**
- * Set a TCP socket option.
- */
 export const COMMAND_SET_SOCKETOPT = 0x02;
 
 /**
- * Adds support for TCP socket options to WebSocket class.
+ * Add socket options support to a WebSocket class. This function takes a WebSocket class and
+ * extends it with new methods for setting socket options. The resulting class has an additional
+ * 'setSocketOpt' method for setting socket options, and an overridden 'send' method that sends
+ * data with the COMMAND_CHUNK command type.
  *
- * Socket options are implemented by adopting a specific data transmission
- * protocol between WS client and WS server The first byte
- * of every message is a command type, and the remaining bytes
- * are the actual data.
+ * @example
+ * const WebSocketWithOptions = addSocketOptionsSupportToWebSocketClass(WebSocket);
  *
- * @param  WebSocketConstructor
- * @returns Decorated constructor
+ * @param WebSocketConstructor - The WebSocket class to extend.
+ * @returns - A new WebSocket class with additional methods for setting socket options and sending
+ *            data with the COMMAND_CHUNK command type.
  */
-export function addSocketOptionsSupportToWebSocketClass(
+export function withSocketOptionsSupport(
 	WebSocketConstructor: typeof WebSocket
 ) {
 	return class PHPWasmWebSocketConstructor extends WebSocketConstructor {

packages/php-wasm/node/src/lib/networking/with-networking.ts

@@ -1,7 +1,7 @@
-import { EmscriptenOptions } from '@php-wasm/abstract';
+import { EmscriptenOptions } from '@php-wasm/universal';
 import {
 	initOutboundWebsocketProxyServer,
-	addSocketOptionsSupportToWebSocketClass,
+	withSocketOptionsSupport,
 } from './outbound-ws-to-tcp-proxy.js';
 import { addTCPServerToWebSocketServerClass } from './inbound-tcp-to-ws-proxy.js';
 import { findFreePorts } from './utils.js';
@@ -26,7 +26,7 @@ export async function withNetworking(
 				return `ws://127.0.0.1:${outboundProxyWsServerPort}/?${query}`;
 			},
 			subprotocol: 'binary',
-			decorator: addSocketOptionsSupportToWebSocketClass,
+			decorator: withSocketOptionsSupport,
 			serverDecorator: addTCPServerToWebSocketServerClass.bind(
 				null,
 				inboundProxyWsServerPort

packages/php-wasm/node/src/lib/parse-worker-startup-options.ts

@@ -1,5 +1,3 @@
-import { WorkerStartupOptions } from '@php-wasm/abstract';
-
-export function parseWorkerStartupOptions(): WorkerStartupOptions {
+export function parseWorkerStartupOptions(): Record<string, string> {
 	return JSON.parse(process.env['WORKER_OPTIONS'] || '{}');
 }