@php-wasm/universal 0.1.39 → 0.1.41

package/src/lib/rethrow-file-system-error.ts

@@ -1,125 +0,0 @@
-/**
- * Emscripten's filesystem-related Exception.
- *
- * @see https://emscripten.org/docs/api_reference/Filesystem-API.html
- * @see https://github.com/emscripten-core/emscripten/blob/main/system/lib/libc/musl/arch/emscripten/bits/errno.h
- * @see https://github.com/emscripten-core/emscripten/blob/38eedc630f17094b3202fd48ac0c2c585dbea31e/system/include/wasi/api.h#L336
- */
-
-export interface ErrnoError extends Error {
-	node?: any;
-	errno: number;
-	message: string;
-}
-/**
- * @see https://github.com/emscripten-core/emscripten/blob/38eedc630f17094b3202fd48ac0c2c585dbea31e/system/include/wasi/api.h#L336
- */
-const FileErrorCodes = {
-	0: 'No error occurred. System call completed successfully.',
-	1: 'Argument list too long.',
-	2: 'Permission denied.',
-	3: 'Address in use.',
-	4: 'Address not available.',
-	5: 'Address family not supported.',
-	6: 'Resource unavailable, or operation would block.',
-	7: 'Connection already in progress.',
-	8: 'Bad file descriptor.',
-	9: 'Bad message.',
-	10: 'Device or resource busy.',
-	11: 'Operation canceled.',
-	12: 'No child processes.',
-	13: 'Connection aborted.',
-	14: 'Connection refused.',
-	15: 'Connection reset.',
-	16: 'Resource deadlock would occur.',
-	17: 'Destination address required.',
-	18: 'Mathematics argument out of domain of function.',
-	19: 'Reserved.',
-	20: 'File exists.',
-	21: 'Bad address.',
-	22: 'File too large.',
-	23: 'Host is unreachable.',
-	24: 'Identifier removed.',
-	25: 'Illegal byte sequence.',
-	26: 'Operation in progress.',
-	27: 'Interrupted function.',
-	28: 'Invalid argument.',
-	29: 'I/O error.',
-	30: 'Socket is connected.',
-	31: 'There is a directory under that path.',
-	32: 'Too many levels of symbolic links.',
-	33: 'File descriptor value too large.',
-	34: 'Too many links.',
-	35: 'Message too large.',
-	36: 'Reserved.',
-	37: 'Filename too long.',
-	38: 'Network is down.',
-	39: 'Connection aborted by network.',
-	40: 'Network unreachable.',
-	41: 'Too many files open in system.',
-	42: 'No buffer space available.',
-	43: 'No such device.',
-	44: 'There is no such file or directory OR the parent directory does not exist.',
-	45: 'Executable file format error.',
-	46: 'No locks available.',
-	47: 'Reserved.',
-	48: 'Not enough space.',
-	49: 'No message of the desired type.',
-	50: 'Protocol not available.',
-	51: 'No space left on device.',
-	52: 'Function not supported.',
-	53: 'The socket is not connected.',
-	54: 'Not a directory or a symbolic link to a directory.',
-	55: 'Directory not empty.',
-	56: 'State not recoverable.',
-	57: 'Not a socket.',
-	58: 'Not supported, or operation not supported on socket.',
-	59: 'Inappropriate I/O control operation.',
-	60: 'No such device or address.',
-	61: 'Value too large to be stored in data type.',
-	62: 'Previous owner died.',
-	63: 'Operation not permitted.',
-	64: 'Broken pipe.',
-	65: 'Protocol error.',
-	66: 'Protocol not supported.',
-	67: 'Protocol wrong type for socket.',
-	68: 'Result too large.',
-	69: 'Read-only file system.',
-	70: 'Invalid seek.',
-	71: 'No such process.',
-	72: 'Reserved.',
-	73: 'Connection timed out.',
-	74: 'Text file busy.',
-	75: 'Cross-device link.',
-	76: 'Extension: Capabilities insufficient.',
-} as any;
-export function rethrowFileSystemError(messagePrefix = '') {
-	return function catchFileSystemError(
-		target: any,
-		methodName: string,
-		descriptor: PropertyDescriptor
-	) {
-		const method = descriptor.value;
-		descriptor.value = function (...args: any[]) {
-			try {
-				return method.apply(this, args);
-			} catch (e) {
-				const errno =
-					typeof e === 'object' ? ((e as any)?.errno as any) : null;
-				if (errno in FileErrorCodes) {
-					const errmsg = FileErrorCodes[errno];
-					const path = typeof args[0] === 'string' ? args[0] : null;
-					const formattedPrefix =
-						path !== null
-							? messagePrefix.replaceAll('{path}', path)
-							: messagePrefix;
-					throw new Error(`${formattedPrefix}: ${errmsg}`, {
-						cause: e,
-					});
-				}
-
-				throw e;
-			}
-		};
-	};
-}

package/src/lib/supported-php-versions.ts

@@ -1,14 +0,0 @@
-export const SupportedPHPVersions = [
-	'8.2',
-	'8.1',
-	'8.0',
-	'7.4',
-	'7.3',
-	'7.2',
-	'7.1',
-	'7.0',
-	'5.6',
-] as const;
-export const LatestSupportedPHPVersion = SupportedPHPVersions[0];
-export const SupportedPHPVersionsList = SupportedPHPVersions as any as string[];
-export type SupportedPHPVersion = (typeof SupportedPHPVersions)[number];

package/src/lib/universal-php.ts

@@ -1,354 +0,0 @@
-import { Remote } from 'comlink';
-import { PHPResponse } from './php-response';
-
-/**
- * Handles HTTP requests using PHP runtime as a backend.
- *
- * @public
- * @example Use PHPRequestHandler implicitly with a new PHP instance:
- * ```js
- * import { PHP } from '@php-wasm/web';
- *
- * const php = await PHP.load( '7.4', {
- *     requestHandler: {
- *         // PHP FS path to serve the files from:
- *         documentRoot: '/www',
- *
- *         // Used to populate $_SERVER['SERVER_NAME'] etc.:
- *         absoluteUrl: 'http://127.0.0.1'
- *     }
- * } );
- *
- * php.mkdirTree('/www');
- * php.writeFile('/www/index.php', '<?php echo "Hi from PHP!"; ');
- *
- * const response = await php.request({ path: '/index.php' });
- * console.log(response.text);
- * // "Hi from PHP!"
- * ```
- *
- * @example Explicitly create a PHPRequestHandler instance and run a PHP script:
- * ```js
- * import {
- *   loadPHPRuntime,
- *   PHP,
- *   PHPRequestHandler,
- *   getPHPLoaderModule,
- * } from '@php-wasm/web';
- *
- * const runtime = await loadPHPRuntime( await getPHPLoaderModule('7.4') );
- * const php = new PHP( runtime );
- *
- * php.mkdirTree('/www');
- * php.writeFile('/www/index.php', '<?php echo "Hi from PHP!"; ');
- *
- * const server = new PHPRequestHandler(php, {
- *     // PHP FS path to serve the files from:
- *     documentRoot: '/www',
- *
- *     // Used to populate $_SERVER['SERVER_NAME'] etc.:
- *     absoluteUrl: 'http://127.0.0.1'
- * });
- *
- * const response = server.request({ path: '/index.php' });
- * console.log(response.text);
- * // "Hi from PHP!"
- * ```
- */
-export interface RequestHandler {
-	/**
-	 * Serves the request – either by serving a static file, or by
-	 * dispatching it to the PHP runtime.
-	 * Cannot be used in conjunction with `cli()`.
-	 *
-	 * @example
-	 * ```js
-	 * const output = await php.request({
-	 * 	method: 'GET',
-	 * 	url: '/index.php',
-	 * 	headers: {
-	 * 		'X-foo': 'bar',
-	 * 	},
-	 * 	formData: {
-	 * 		foo: 'bar',
-	 * 	},
-	 * });
-	 * console.log(output.stdout); // "Hello world!"
-	 * ```
-	 *
-	 * @param  request - PHP Request data.
-	 */
-	request(request: PHPRequest, maxRedirects?: number): Promise<PHPResponse>;
-
-	/**
-	 * Converts a path to an absolute URL based at the PHPRequestHandler
-	 * root.
-	 *
-	 * @param  path The server path to convert to an absolute URL.
-	 * @returns The absolute URL.
-	 */
-	pathToInternalUrl(path: string): string;
-
-	/**
-	 * Converts an absolute URL based at the PHPRequestHandler to a relative path
-	 * without the server pathname and scope.
-	 *
-	 * @param  internalUrl An absolute URL based at the PHPRequestHandler root.
-	 * @returns The relative path.
-	 */
-	internalUrlToPath(internalUrl: string): string;
-
-	/**
-	 * The absolute URL of this PHPRequestHandler instance.
-	 */
-	absoluteUrl: string;
-
-	/**
-	 * The directory in the PHP filesystem where the server will look
-	 * for the files to serve. Default: `/var/www`.
-	 */
-	documentRoot: string;
-}
-
-export interface IsomorphicLocalPHP extends RequestHandler {
-	setPhpIniPath(path: string): void;
-	setPhpIniEntry(key: string, value: string): void;
-	/**
-	 * Recursively creates a directory with the given path in the PHP filesystem.
-	 * For example, if the path is `/root/php/data`, and `/root` already exists,
-	 * it will create the directories `/root/php` and `/root/php/data`.
-	 *
-	 * @param  path - The directory path to create.
-	 */
-	mkdir(path: string): void;
-
-	/**
-	 * @deprecated Use mkdir instead.
-	 */
-	mkdirTree(path: string): void;
-
-	/**
-	 * Reads a file from the PHP filesystem and returns it as a string.
-	 *
-	 * @throws {@link @php-wasm/universal:ErrnoError} – If the file doesn't exist.
-	 * @param  path - The file path to read.
-	 * @returns The file contents.
-	 */
-	readFileAsText(path: string): string;
-
-	/**
-	 * Reads a file from the PHP filesystem and returns it as an array buffer.
-	 *
-	 * @throws {@link @php-wasm/universal:ErrnoError} – If the file doesn't exist.
-	 * @param  path - The file path to read.
-	 * @returns The file contents.
-	 */
-	readFileAsBuffer(path: string): Uint8Array;
-
-	/**
-	 * Overwrites data in a file in the PHP filesystem.
-	 * Creates a new file if one doesn't exist yet.
-	 *
-	 * @param  path - The file path to write to.
-	 * @param  data - The data to write to the file.
-	 */
-	writeFile(path: string, data: string | Uint8Array): void;
-
-	/**
-	 * Removes a file from the PHP filesystem.
-	 *
-	 * @throws {@link @php-wasm/universal:ErrnoError} – If the file doesn't exist.
-	 * @param  path - The file path to remove.
-	 */
-	unlink(path: string): void;
-
-	/**
-	 * Moves a file or directory in the PHP filesystem to a
-	 * new location.
-	 *
-	 * @param oldPath The path to rename.
-	 * @param newPath The new path.
-	 */
-	mv(oldPath: string, newPath: string): void;
-
-	/**
-	 * Removes a directory from the PHP filesystem.
-	 *
-	 * @param path The directory path to remove.
-	 * @param options Options for the removal.
-	 */
-	rmdir(path: string, options?: RmDirOptions): void;
-
-	/**
-	 * Lists the files and directories in the given directory.
-	 *
-	 * @param  path - The directory path to list.
-	 * @returns The list of files and directories in the given directory.
-	 */
-	listFiles(path: string): string[];
-
-	/**
-	 * Checks if a directory exists in the PHP filesystem.
-	 *
-	 * @param  path – The path to check.
-	 * @returns True if the path is a directory, false otherwise.
-	 */
-	isDir(path: string): boolean;
-
-	/**
-	 * Checks if a file (or a directory) exists in the PHP filesystem.
-	 *
-	 * @param  path - The file path to check.
-	 * @returns True if the file exists, false otherwise.
-	 */
-	fileExists(path: string): boolean;
-
-	/**
-	 * Changes the current working directory in the PHP filesystem.
-	 * This is the directory that will be used as the base for relative paths.
-	 * For example, if the current working directory is `/root/php`, and the
-	 * path is `data`, the absolute path will be `/root/php/data`.
-	 *
-	 * @param  path - The new working directory.
-	 */
-	chdir(path: string): void;
-
-	/**
-	 * Runs PHP code.
-	 * Cannot be used in conjunction with `cli()`.
-	 *
-	 * @example
-	 * ```js
-	 * const output = await php.run('<?php echo "Hello world!";');
-	 * console.log(output.stdout); // "Hello world!"
-	 * ```
-	 *
-	 * @example
-	 * ```js
-	 * console.log(await php.run(`<?php
-	 *  $fp = fopen('php://stderr', 'w');
-	 *  fwrite($fp, "Hello, world!");
-	 * `));
-	 * // {"exitCode":0,"stdout":"","stderr":["Hello, world!"]}
-	 * ```
-	 *
-	 * @param  options - PHP run options.
-	 */
-	run(options: PHPRunOptions): Promise<PHPResponse>;
-}
-
-export type IsomorphicRemotePHP = Remote<IsomorphicLocalPHP>;
-export type UniversalPHP = IsomorphicLocalPHP | IsomorphicRemotePHP;
-
-export type HTTPMethod =
-	| 'GET'
-	| 'POST'
-	| 'HEAD'
-	| 'OPTIONS'
-	| 'PATCH'
-	| 'PUT'
-	| 'DELETE';
-export type PHPRequestHeaders = Record<string, string>;
-export interface PHPRequest {
-	/**
-	 * Request method. Default: `GET`.
-	 */
-	method?: HTTPMethod;
-
-	/**
-	 * Request path or absolute URL.
-	 */
-	url: string;
-
-	/**
-	 * Request headers.
-	 */
-	headers?: PHPRequestHeaders;
-
-	/**
-	 * Uploaded files
-	 */
-	files?: Record<string, File>;
-
-	/**
-	 * Request body without the files.
-	 */
-	body?: string;
-
-	/**
-	 * Form data. If set, the request body will be ignored and
-	 * the content-type header will be set to `application/x-www-form-urlencoded`.
-	 */
-	formData?: Record<string, unknown>;
-}
-
-export interface PHPRunOptions {
-	/**
-	 * Request path following the domain:port part.
-	 */
-	relativeUri?: string;
-
-	/**
-	 * Path of the .php file to execute.
-	 */
-	scriptPath?: string;
-
-	/**
-	 * Request protocol.
-	 */
-	protocol?: string;
-
-	/**
-	 * Request method. Default: `GET`.
-	 */
-	method?: HTTPMethod;
-
-	/**
-	 * Request headers.
-	 */
-	headers?: PHPRequestHeaders;
-
-	/**
-	 * Request body without the files.
-	 */
-	body?: string;
-
-	/**
-	 * Uploaded files.
-	 */
-	fileInfos?: FileInfo[];
-
-	/**
-	 * The code snippet to eval instead of a php file.
-	 */
-	code?: string;
-}
-
-/**
- * Output of the PHP.wasm runtime.
- */
-export interface PHPOutput {
-	/** Exit code of the PHP process. 0 means success, 1 and 2 mean error. */
-	exitCode: number;
-
-	/** Stdout data */
-	stdout: ArrayBuffer;
-
-	/** Stderr lines */
-	stderr: string[];
-}
-
-export interface FileInfo {
-	key: string;
-	name: string;
-	type: string;
-	data: Uint8Array;
-}
-
-export interface RmDirOptions {
-	/**
-	 * If true, recursively removes the directory and all its contents.
-	 * Default: true.
-	 */
-	recursive?: boolean;
-}

package/src/lib/wasm-error-reporting.ts

@@ -1,172 +0,0 @@
-import { ErrorEvent } from './error-event-polyfill';
-
-type Runtime = {
-	asm: Record<string, unknown>;
-	lastAsyncifyStackSource?: Error;
-};
-
-export class UnhandledRejectionsTarget extends EventTarget {
-	listenersCount = 0;
-	override addEventListener(type: unknown, callback: unknown): void {
-		++this.listenersCount;
-		super.addEventListener(type as string, callback as EventListener);
-	}
-	override removeEventListener(type: unknown, callback: unknown): void {
-		--this.listenersCount;
-		super.removeEventListener(type as string, callback as EventListener);
-	}
-	hasListeners() {
-		return this.listenersCount > 0;
-	}
-}
-
-/**
- * Creates Asyncify errors listener.
- *
- * Emscripten turns Asyncify errors into unhandled rejections by
- * throwing them outside of the context of the original function call.
- *
- * With this listener, we can catch and rethrow them in a proper context,
- * or at least log them in a more readable way.
- *
- * @param runtime
- */
-export function improveWASMErrorReporting(runtime: Runtime) {
-	runtime.asm = {
-		...runtime.asm,
-	};
-	const target = new UnhandledRejectionsTarget();
-	for (const key in runtime.asm) {
-		if (typeof runtime.asm[key] == 'function') {
-			const original = runtime.asm[key] as any;
-			runtime.asm[key] = function (...args: any[]) {
-				try {
-					return original(...args);
-				} catch (e) {
-					if (!(e instanceof Error)) {
-						throw e;
-					}
-					if ('exitCode' in e && e?.exitCode === 0) {
-						return;
-					}
-					const clearMessage = clarifyErrorMessage(
-						e,
-						runtime.lastAsyncifyStackSource?.stack
-					);
-
-					if (runtime.lastAsyncifyStackSource) {
-						e.cause = runtime.lastAsyncifyStackSource;
-					}
-
-					if (!target.hasListeners()) {
-						showCriticalErrorBox(clearMessage);
-						throw e;
-					}
-
-					target.dispatchEvent(
-						new ErrorEvent('error', {
-							error: e,
-							message: clearMessage,
-						})
-					);
-				}
-			};
-		}
-	}
-	return target;
-}
-
-let functionsMaybeMissingFromAsyncify: string[] = [];
-export function getFunctionsMaybeMissingFromAsyncify() {
-	return functionsMaybeMissingFromAsyncify;
-}
-
-export function clarifyErrorMessage(
-	crypticError: Error,
-	asyncifyStack?: string
-) {
-	if (crypticError.message === 'unreachable') {
-		let betterMessage = UNREACHABLE_ERROR;
-		if (!asyncifyStack) {
-			betterMessage +=
-				`\n\nThis stack trace is lacking. For a better one initialize \n` +
-				`the PHP runtime with { debug: true }, e.g. PHPNode.load('8.1', { debug: true }).\n\n`;
-		}
-		functionsMaybeMissingFromAsyncify = extractPHPFunctionsFromStack(
-			asyncifyStack || crypticError.stack || ''
-		);
-		for (const fn of functionsMaybeMissingFromAsyncify) {
-			betterMessage += `    * ${fn}\n`;
-		}
-		return betterMessage;
-	}
-	return crypticError.message;
-}
-
-const UNREACHABLE_ERROR = `
-"unreachable" WASM instruction executed.
-
-The typical reason is a PHP function missing from the ASYNCIFY_ONLY
-list when building PHP.wasm.
-
-You will need to file a new issue in the WordPress Playground repository
-and paste this error message there:
-
-https://github.com/WordPress/wordpress-playground/issues/new
-
-If you're a core developer, the typical fix is to:
-
-* Isolate a minimal reproduction of the error
-* Add a reproduction of the error to php-asyncify.spec.ts in the WordPress Playground repository
-* Run 'npm run fix-asyncify'
-* Commit the changes, push to the repo, release updated NPM packages
-
-Below is a list of all the PHP functions found in the stack trace to
-help with the minimal reproduction. If they're all already listed in
-the Dockerfile, you'll need to trigger this error again with long stack
-traces enabled. In node.js, you can do it using the --stack-trace-limit=100
-CLI option: \n\n`;
-
-// ANSI escape codes for CLI colors and formats
-const redBg = '\x1b[41m';
-const bold = '\x1b[1m';
-const reset = '\x1b[0m';
-const eol = '\x1B[K';
-
-let logged = false;
-export function showCriticalErrorBox(message: string) {
-	if (logged) {
-		return;
-	}
-	logged = true;
-	console.log(`${redBg}\n${eol}\n${bold}  WASM ERROR${reset}${redBg}`);
-	for (const line of message.split('\n')) {
-		console.log(`${eol}  ${line} `);
-	}
-	console.log(`${reset}`);
-}
-
-function extractPHPFunctionsFromStack(stack: string) {
-	try {
-		const names = stack
-			.split('\n')
-			.slice(1)
-			.map((line) => {
-				const parts = line.trim().substring('at '.length).split(' ');
-				return {
-					fn: parts.length >= 2 ? parts[0] : '<unknown>',
-					isWasm: line.includes('wasm://'),
-				};
-			})
-			.filter(
-				({ fn, isWasm }) =>
-					isWasm &&
-					!fn.startsWith('dynCall_') &&
-					!fn.startsWith('invoke_')
-			)
-			.map(({ fn }) => fn);
-		return Array.from(new Set(names));
-	} catch (err) {
-		return [];
-	}
-}

package/tsconfig.json

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

package/tsconfig.lib.json

@@ -1,14 +0,0 @@
-{
-	"extends": "./tsconfig.json",
-	"compilerOptions": {
-		"outDir": "../../../dist/out-tsc",
-		"declaration": true,
-		"types": ["node"]
-	},
-	"include": [
-		"src/**/*.ts",
-		"../web/src/php-library/parse-worker-startup-options.ts",
-		"../web/src/lib/api.ts"
-	],
-	"exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}