@php-wasm/cli 0.1.2 → 0.1.7

package/README.md

@@ -1,11 +0,0 @@
-# php-wasm-cli
-
-This library was generated with [Nx](https://nx.dev).
-
-## Building
-
-Run `nx build php-wasm-cli` to build the library.
-
-## Running unit tests
-
-Run `nx test php-wasm-cli` to execute the unit tests via [Jest](https://jestjs.io).

package/jest.config.ts

@@ -1,13 +0,0 @@
-/* eslint-disable */
-export default {
-	displayName: 'nx-extensions',
-	preset: '../../../jest.preset.js',
-	transform: {
-		'^.+\\.[tj]s$': [
-			'ts-jest',
-			{ tsconfig: '<rootDir>/tsconfig.spec.json' },
-		],
-	},
-	moduleFileExtensions: ['ts', 'js', 'html'],
-	coverageDirectory: '../../../coverage/packages/nx-extensions',
-};

package/project.json

@@ -1,78 +0,0 @@
-{
-	"name": "php-wasm-cli",
-	"$schema": "../../../node_modules/nx/schemas/project-schema.json",
-	"sourceRoot": "packages/php-wasm/cli/src",
-	"projectType": "library",
-	"targets": {
-		"build": {
-			"executor": "@wp-playground/nx-extensions:package-json",
-			"options": {
-				"tsConfig": "packages/php-wasm/cli/tsconfig.lib.json",
-				"outputPath": "dist/packages/php-wasm/cli",
-				"buildTarget": "php-wasm-cli:build:bundle:production"
-			}
-		},
-		"build:bundle": {
-			"executor": "@nrwl/vite:build",
-			"outputs": ["{options.outputPath}"],
-			"options": {
-				"main": "dist/packages/php-wasm/cli/main.js",
-				"outputPath": "dist/packages/php-wasm/cli"
-			},
-			"defaultConfiguration": "production",
-			"configurations": {
-				"development": {
-					"minify": false
-				},
-				"production": {
-					"minify": true
-				}
-			}
-		},
-		"start": {
-			"executor": "@wp-playground/nx-extensions:built-script",
-			"options": {
-				"scriptPath": "dist/packages/php-wasm/cli/main.js"
-			},
-			"dependsOn": ["build", "^build-for-cli-run"]
-		},
-		"publish": {
-			"executor": "nx:run-commands",
-			"options": {
-				"command": "node tools/scripts/publish.mjs php-wasm-cli {args.ver} {args.tag}"
-			},
-			"dependsOn": ["build"]
-		},
-		"lint": {
-			"executor": "@nrwl/linter:eslint",
-			"outputs": ["{options.outputFile}"],
-			"options": {
-				"lintFilePatterns": ["packages/php-wasm/cli/**/*.ts"]
-			}
-		},
-		"test": {
-			"executor": "@nrwl/jest:jest",
-			"outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-			"options": {
-				"jestConfig": "packages/php-wasm/cli/jest.config.ts",
-				"passWithNoTests": true
-			},
-			"configurations": {
-				"ci": {
-					"ci": true,
-					"codeCoverage": true
-				}
-			}
-		},
-		"typecheck": {
-			"executor": "@nrwl/workspace:run-commands",
-			"options": {
-				"commands": [
-					"yarn tsc -p packages/php-wasm/cli/tsconfig.lib.json --noEmit",
-					"yarn tsc -p packages/php-wasm/cli/tsconfig.spec.json --noEmit"
-				]
-			}
-		}
-	},
-	"tags": ["scope:php-wasm-public"]
-}

package/src/lib/inbound-tcp-to-ws-proxy.ts

@@ -1,89 +0,0 @@
-import { createServer } from 'net';
-import { WebSocketServer, WebSocket } from 'ws';
-import { debugLog } from './utils.js';
-function log(...args: any[]) {
-	debugLog('[TCP Server]', ...args);
-}
-
-export function addTCPServerToWebSocketServerClass(
-	wsListenPort: number,
-	WSServer: typeof WebSocketServer
-): any {
-	return class PHPWasmWebSocketServer extends WSServer {
-		constructor(options: any, callback: any) {
-			const requestedPort = options.port;
-			options.port = wsListenPort;
-			listenTCPToWSProxy({
-				tcpListenPort: requestedPort,
-				wsConnectPort: wsListenPort,
-			});
-			super(options, callback);
-		}
-	};
-}
-
-export interface InboundTcpToWsProxyOptions {
-	tcpListenPort: number;
-	wsConnectHost?: string;
-	wsConnectPort: number;
-}
-export function listenTCPToWSProxy(options: InboundTcpToWsProxyOptions) {
-	options = {
-		wsConnectHost: '127.0.0.1',
-		...options,
-	};
-	const { tcpListenPort, wsConnectHost, wsConnectPort } = options;
-	const server = createServer();
-	server.on('connection', function handleConnection(tcpSource) {
-		const inBuffer: Buffer[] = [];
-
-		const wsTarget = new WebSocket(
-			`ws://${wsConnectHost}:${wsConnectPort}/`
-		);
-		wsTarget.binaryType = 'arraybuffer';
-		function wsSend(data: Buffer) {
-			wsTarget.send(new Uint8Array(data));
-		}
-
-		wsTarget.addEventListener('open', function () {
-			log('Outbound WebSocket connection established');
-			while (inBuffer.length > 0) {
-				wsSend(inBuffer.shift()!);
-			}
-		});
-		wsTarget.addEventListener('message', (e) => {
-			log(
-				'WS->TCP message:',
-				new TextDecoder().decode(e.data as ArrayBuffer)
-			);
-			tcpSource.write(Buffer.from(e.data as ArrayBuffer));
-		});
-		wsTarget.addEventListener('close', () => {
-			log('WebSocket connection closed');
-			tcpSource.end();
-		});
-
-		tcpSource.on('data', function (data) {
-			log('TCP->WS message:', data);
-			if (wsTarget.readyState === WebSocket.OPEN) {
-				while (inBuffer.length > 0) {
-					wsSend(inBuffer.shift()!);
-				}
-				wsSend(data);
-			} else {
-				inBuffer.push(data);
-			}
-		});
-		tcpSource.once('close', function () {
-			log('TCP connection closed');
-			wsTarget.close();
-		});
-		tcpSource.on('error', function () {
-			log('TCP connection error');
-			wsTarget.close();
-		});
-	});
-	server.listen(tcpListenPort, function () {
-		log('TCP server listening');
-	});
-}

package/src/lib/outbound-ws-to-tcp-proxy.ts

@@ -1,231 +0,0 @@
-/**
- * This is a simple TCP proxy server that allows PHP to connect to a remote
- * server via WebSockets. This is necessary because WebAssembly has no access
- * to the network.
- *
- * This module was forked from the @maximegris/node-websockify npm package.
- */
-'use strict';
-
-import * as dns from 'dns';
-import * as util from 'util';
-import * as net from 'net';
-import * as http from 'http';
-import { WebSocketServer } from 'ws';
-import { debugLog } from './utils.js';
-
-function log(...args: any[]) {
-	debugLog('[WS Server]', ...args);
-}
-
-const lookup = util.promisify(dns.lookup);
-
-function prependByte(
-	chunk: string | ArrayBuffer | ArrayLike<number>,
-	byte: number
-) {
-	if (typeof chunk === 'string') {
-		chunk = String.fromCharCode(byte) + chunk;
-	} else if (chunk instanceof ArrayBuffer) {
-		const buffer = new Uint8Array(chunk.byteLength + 1);
-		buffer[0] = byte;
-		buffer.set(new Uint8Array(chunk), 1);
-		chunk = buffer.buffer;
-	} else {
-		throw new Error('Unsupported chunk type');
-	}
-	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.
- *
- * 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.
- *
- * @param  WebSocketConstructor
- * @returns Decorated constructor
- */
-export function addSocketOptionsSupportToWebSocketClass(
-	WebSocketConstructor: typeof WebSocket
-) {
-	return class PHPWasmWebSocketConstructor extends WebSocketConstructor {
-		override CONNECTING = 0;
-		override OPEN = 1;
-		override CLOSING = 2;
-		override CLOSED = 3;
-
-		// @ts-ignore
-		send(chunk: any, callback: any) {
-			return this.sendCommand(COMMAND_CHUNK, chunk, callback);
-		}
-
-		setSocketOpt(
-			optionClass: number,
-			optionName: number,
-			optionValue: number
-		) {
-			return this.sendCommand(
-				COMMAND_SET_SOCKETOPT,
-				new Uint8Array([optionClass, optionName, optionValue]).buffer,
-				() => undefined
-			);
-		}
-		sendCommand(
-			commandType: number,
-			chunk: string | ArrayBuffer | ArrayLike<number>,
-			callback: any
-		) {
-			return (WebSocketConstructor.prototype.send as any).call(
-				this,
-				prependByte(chunk, commandType),
-				callback
-			);
-		}
-	};
-}
-
-export function initOutboundWebsocketProxyServer(
-	listenPort: number,
-	listenHost = '127.0.0.1'
-): Promise<http.Server> {
-	log(`Binding the WebSockets server to ${listenHost}:${listenPort}...`);
-	const webServer = http.createServer((request, response) => {
-		response.writeHead(403, { 'Content-Type': 'text/plain' });
-		response.write(
-			'403 Permission Denied\nOnly websockets are allowed here.\n'
-		);
-		response.end();
-	});
-	return new Promise((resolve) => {
-		webServer.listen(listenPort, listenHost, function () {
-			const wsServer = new WebSocketServer({ server: webServer });
-			wsServer.on('connection', onWsConnect);
-			resolve(webServer);
-		});
-	});
-}
-
-// Handle new WebSocket client
-async function onWsConnect(client: any, request: http.IncomingMessage) {
-	const clientAddr = client._socket.remoteAddress;
-	const clientLog = function (...args: any[]) {
-		log(' ' + clientAddr + ': ', ...args);
-	};
-
-	clientLog(
-		'WebSocket connection from : ' +
-			clientAddr +
-			' at URL ' +
-			(request ? request.url : client.upgradeReq.url)
-	);
-	clientLog(
-		'Version ' +
-			client.protocolVersion +
-			', subprotocol: ' +
-			client.protocol
-	);
-
-	// Parse the search params (the host doesn't matter):
-	const reqUrl = new URL(`ws://0.0.0.0` + request.url);
-	const reqTargetPort = Number(reqUrl.searchParams.get('port'));
-	const reqTargetHost = reqUrl.searchParams.get('host');
-	if (!reqTargetPort || !reqTargetHost) {
-		clientLog('Missing host or port information');
-		client.close(3000);
-		return;
-	}
-
-	// eslint-disable-next-line prefer-const
-	let target: any;
-	const recvQueue: Buffer[] = [];
-	function flushMessagesQueue() {
-		while (recvQueue.length > 0) {
-			const msg = recvQueue.pop()! as Buffer;
-			const commandType = msg[0];
-			clientLog('flushing', { commandType }, msg);
-			if (commandType === COMMAND_CHUNK) {
-				target.write(msg.slice(1));
-			} else if (commandType === COMMAND_SET_SOCKETOPT) {
-				const SOL_SOCKET = 1;
-				const SO_KEEPALIVE = 9;
-
-				const IPPROTO_TCP = 6;
-				const TCP_NODELAY = 1;
-				if (msg[1] === SOL_SOCKET && msg[2] === SO_KEEPALIVE) {
-					target.setKeepAlive(msg[3]);
-				} else if (msg[1] === IPPROTO_TCP && msg[2] === TCP_NODELAY) {
-					target.setNoDelay(msg[3]);
-				}
-			} else {
-				clientLog('Unknown command type: ' + commandType);
-				process.exit();
-			}
-		}
-	}
-
-	client.on('message', function (msg: Buffer) {
-		// clientLog('PHP -> network buffer:', msg);
-		recvQueue.unshift(msg);
-		if (target) {
-			flushMessagesQueue();
-		}
-	});
-	client.on('close', function (code: any, reason: any) {
-		clientLog(
-			'WebSocket client disconnected: ' + code + ' [' + reason + ']'
-		);
-		target.end();
-	} as any);
-	client.on('error', function (a: string | Buffer) {
-		clientLog('WebSocket client error: ' + a);
-		target.end();
-	});
-
-	// Resolve the target host to an IP address if it isn't one already
-	let reqTargetIp;
-	if (net.isIP(reqTargetHost) === 0) {
-		clientLog('resolving ' + reqTargetHost + '... ');
-		const resolution = await lookup(reqTargetHost);
-		reqTargetIp = resolution.address;
-		clientLog('resolved ' + reqTargetHost + ' -> ' + reqTargetIp);
-	} else {
-		reqTargetIp = reqTargetHost;
-	}
-	clientLog(
-		'Opening a socket connection to ' + reqTargetIp + ':' + reqTargetPort
-	);
-	target = net.createConnection(reqTargetPort, reqTargetIp, function () {
-		clientLog('Connected to target');
-		flushMessagesQueue();
-	});
-	target.on('data', function (data: any) {
-		// clientLog('network -> PHP buffer:', [...data.slice(0, 100)].join(', ') + '...');
-		try {
-			client.send(data);
-		} catch (e) {
-			clientLog('Client closed, cleaning up target');
-			target.end();
-		}
-	});
-	target.on('end', function () {
-		clientLog('target disconnected');
-		client.close();
-	});
-	target.on('error', function (e: any) {
-		clientLog('target connection error', e);
-		target.end();
-		client.close(3000);
-	});
-}

package/src/lib/utils.ts

@@ -1,33 +0,0 @@
-import * as net from 'net';
-
-export function debugLog(...args: any[]) {
-	if (process.env['DEV']) {
-		console.log(...args);
-	}
-}
-
-export async function findFreePorts(n: number) {
-	const serversPromises: Promise<net.Server>[] = [];
-	for (let i = 0; i < n; i++) {
-		serversPromises.push(listenOnRandomPort());
-	}
-
-	const servers = await Promise.all(serversPromises);
-	const ports: number[] = [];
-	for (const server of servers) {
-		const address = server.address()! as net.AddressInfo;
-		ports.push(address.port);
-		server.close();
-	}
-
-	return ports;
-}
-
-function listenOnRandomPort(): Promise<net.Server> {
-	return new Promise((resolve) => {
-		const server = net.createServer();
-		server.listen(0, () => {
-			resolve(server);
-		});
-	});
-}

package/src/main.ts

@@ -1,74 +0,0 @@
-/**
- * A CLI script that runs PHP CLI via the WebAssembly build.
- */
-import { writeFileSync, existsSync } from 'fs';
-import { rootCertificates } from 'tls';
-
-import {
-	initOutboundWebsocketProxyServer,
-	addSocketOptionsSupportToWebSocketClass,
-} from './lib/outbound-ws-to-tcp-proxy.js';
-import { addTCPServerToWebSocketServerClass } from './lib/inbound-tcp-to-ws-proxy.js';
-import { findFreePorts } from './lib/utils.js';
-import { PHP, loadPHPRuntime, getPHPLoaderModule } from '@php-wasm/node';
-
-let args = process.argv.slice(2);
-if (!args.length) {
-	args = ['--help'];
-}
-
-// Write the ca-bundle.crt file to disk so that PHP can find it.
-const caBundlePath = new URL('ca-bundle.crt', (import.meta || {}).url).pathname;
-if (!existsSync(caBundlePath)) {
-	writeFileSync(caBundlePath, rootCertificates.join('\n'));
-}
-
-async function main() {
-	// @ts-ignore
-	const defaultPhpIniPath = await import('./lib/php.ini');
-
-	const phpVersion = process.env['PHP'] || '8.2';
-
-	const [inboundProxyWsServerPort, outboundProxyWsServerPort] =
-		await findFreePorts(2);
-
-	await initOutboundWebsocketProxyServer(outboundProxyWsServerPort);
-
-	// This dynamic import only works after the build step
-	// when the PHP files are present in the same directory
-	// as this script.
-	const phpLoaderModule = await getPHPLoaderModule(phpVersion);
-	const loaderId = await loadPHPRuntime(phpLoaderModule, {
-		ENV: {
-			...process.env,
-			TERM: 'xterm',
-		},
-		websocket: {
-			url: (_: any, host: string, port: string) => {
-				const query = new URLSearchParams({ host, port }).toString();
-				return `ws://127.0.0.1:${outboundProxyWsServerPort}/?${query}`;
-			},
-			subprotocol: 'binary',
-			decorator: addSocketOptionsSupportToWebSocketClass,
-			serverDecorator: addTCPServerToWebSocketServerClass.bind(
-				null,
-				inboundProxyWsServerPort
-			),
-		},
-	});
-	const hasMinusCOption = args.some((arg) => arg.startsWith('-c'));
-	if (!hasMinusCOption) {
-		args.unshift('-c', defaultPhpIniPath);
-	}
-	const php = new PHP(loaderId);
-	php.writeFile(caBundlePath, rootCertificates.join('\n'));
-	args.unshift('-d', `openssl.cafile=${caBundlePath}`);
-	php.cli(['php', ...args]).catch((result) => {
-		if (result.name === 'ExitStatus') {
-			process.exit(result.status === undefined ? 1 : result.status);
-		}
-		throw result;
-	});
-}
-
-main();

package/tsconfig.json

@@ -1,21 +0,0 @@
-{
-	"extends": "../../../tsconfig.base.json",
-	"compilerOptions": {
-		"forceConsistentCasingInFileNames": true,
-		"strict": true,
-		"noImplicitOverride": true,
-		"noPropertyAccessFromIndexSignature": true,
-		"noImplicitReturns": true,
-		"noFallthroughCasesInSwitch": true
-	},
-	"files": [],
-	"include": [],
-	"references": [
-		{
-			"path": "./tsconfig.lib.json"
-		},
-		{
-			"path": "./tsconfig.spec.json"
-		}
-	]
-}

package/tsconfig.lib.json

@@ -1,10 +0,0 @@
-{
-	"extends": "./tsconfig.json",
-	"compilerOptions": {
-		"outDir": "../../../dist/out-tsc",
-		"declaration": true,
-		"types": ["node"]
-	},
-	"include": ["src/**/*.ts"],
-	"exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.spec.json

@@ -1,14 +0,0 @@
-{
-	"extends": "./tsconfig.json",
-	"compilerOptions": {
-		"outDir": "../../../dist/out-tsc",
-		"module": "commonjs",
-		"types": ["jest", "node"]
-	},
-	"include": [
-		"jest.config.ts",
-		"src/**/*.test.ts",
-		"src/**/*.spec.ts",
-		"src/**/*.d.ts"
-	]
-}

package/vite.config.ts

@@ -1,50 +0,0 @@
-/// <reference types="vitest" />
-import { defineConfig } from 'vite';
-import viteTsConfigPaths from 'vite-tsconfig-paths';
-
-export default defineConfig(() => {
-	return {
-		assetsInclude: ['**/*.ini'],
-		cacheDir: '../../../node_modules/.vite/php-cli',
-
-		plugins: [
-			viteTsConfigPaths({
-				root: '../../../',
-			}),
-		],
-
-		// Configuration for building your library.
-		// See: https://vitejs.dev/guide/build.html#library-mode
-		build: {
-			assetsInlineLimit: 0,
-			target: 'es2020',
-			rollupOptions: {
-				external: [
-					'@php-wasm/node',
-					'net',
-					'fs',
-					'path',
-					'http',
-					'tls',
-					'util',
-					'dns',
-					'ws',
-				],
-				input: 'packages/php-wasm/cli/src/main.ts',
-				output: {
-					format: 'esm',
-					entryFileNames: '[name].js',
-				},
-			},
-		},
-
-		test: {
-			globals: true,
-			cache: {
-				dir: '../../../node_modules/.vitest',
-			},
-			environment: 'jsdom',
-			include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
-		},
-	};
-});