Rename SpawnedPHP to AcquiredPHP throughout codebase

The AcquiredPHP type better describes what the interface represents:
a PHP instance that has been acquired from the instance manager and
must be reaped when done. SpawnedPHP is now a backwards-compatible
type alias exported from index.ts.

Author: adamziel

packages/php-wasm/node/src/test/php-part-1.spec.ts

@@ -4,7 +4,7 @@ import {
 	PHPProcessManager,
 	sandboxedSpawnHandlerFactory,
 	setPhpIniEntries,
-	type SpawnedPHP,
+	type AcquiredPHP,
 	SupportedPHPVersions,
 } from '@php-wasm/universal';
 import { createSpawnHandler, phpVar } from '@php-wasm/util';
@@ -1829,7 +1829,7 @@ phpLoaderOptions.forEach((options) => {
 describe('sandboxedSpawnHandlerFactory', () => {
 	const phpVersion = RecommendedPHPVersion;
 	let php: PHP;
-	let spawnedPhp: SpawnedPHP;
+	let spawnedPhp: AcquiredPHP;
 	let processManager: PHPProcessManager;
 	beforeEach(async () => {
 		processManager = new PHPProcessManager({

packages/php-wasm/node/src/test/php-part-2.spec.ts

@@ -5,7 +5,7 @@ import {
 	PHPProcessManager,
 	sandboxedSpawnHandlerFactory,
 	setPhpIniEntries,
-	type SpawnedPHP,
+	type AcquiredPHP,
 	SupportedPHPVersions,
 } from '@php-wasm/universal';
 import { joinPaths } from '@php-wasm/util';
@@ -1159,7 +1159,7 @@ phpLoaderOptions.forEach((options) => {
 describe('sandboxedSpawnHandlerFactory', () => {
 	const phpVersion = RecommendedPHPVersion;
 	let php: PHP;
-	let spawnedPhp: SpawnedPHP;
+	let spawnedPhp: AcquiredPHP;
 	let processManager: PHPProcessManager;
 	beforeEach(async () => {
 		processManager = new PHPProcessManager({

packages/php-wasm/universal/src/lib/index.ts

@@ -24,7 +24,14 @@ export { HttpCookieStore } from './http-cookie-store';
 export type { IteratePhpFilesOptions as IterateFilesOptions } from './iterate-files';
 export { iteratePhpFiles as iterateFiles } from './iterate-files';
 export { writeFilesStreamToPhp } from './write-files-stream-to-php';
-export type { PHPInstanceManager, AcquiredPHP } from './php-instance-manager';
+export type {
+	PHPInstanceManager,
+	AcquiredPHP,
+	/**
+	 * Backwards compatibility alias.
+	 */
+	AcquiredPHP as SpawnedPHP,
+} from './php-instance-manager';
 export { SinglePHPInstanceManager } from './single-php-instance-manager';
 export type { SinglePHPInstanceManagerOptions } from './single-php-instance-manager';
 export { PHPProcessManager } from './php-process-manager';
@@ -33,7 +40,6 @@ export type {
 	PHPFactory,
 	PHPFactoryOptions,
 	ProcessManagerOptions,
-	SpawnedPHP,
 } from './php-process-manager';
 
 export { PHPResponse, StreamedPHPResponse } from './php-response';

packages/php-wasm/universal/src/lib/php-process-manager.ts

@@ -8,11 +8,6 @@ export type PHPFactoryOptions = {
 
 export type PHPFactory = (options: PHPFactoryOptions) => Promise<PHP>;
 
-/**
- * @deprecated Use AcquiredPHP from './php-instance-manager' instead.
- */
-export type SpawnedPHP = AcquiredPHP;
-
 export interface ProcessManagerOptions {
 	/**
 	 * The maximum number of PHP instances that can exist at
@@ -74,14 +69,14 @@ export class MaxPhpInstancesError extends Error {
  */
 export class PHPProcessManager implements PHPInstanceManager {
 	private primaryPhp?: PHP;
-	private primaryPhpPromise?: Promise<SpawnedPHP>;
+	private primaryPhpPromise?: Promise<AcquiredPHP>;
 	private primaryIdle = true;
-	private nextInstance: Promise<SpawnedPHP> | null = null;
+	private nextInstance: Promise<AcquiredPHP> | null = null;
 	/**
 	 * All spawned PHP instances, including the primary PHP instance.
 	 * Used for bookkeeping and reaping all instances on dispose.
 	 */
-	private allInstances: Promise<SpawnedPHP>[] = [];
+	private allInstances: Promise<AcquiredPHP>[] = [];
 	private phpFactory?: PHPFactory;
 	private maxPhpInstances: number;
 	private semaphore: Semaphore;
@@ -148,7 +143,7 @@ export class PHPProcessManager implements PHPInstanceManager {
 		considerPrimary = false,
 	}: {
 		considerPrimary?: boolean;
-	} = {}): Promise<SpawnedPHP> {
+	} = {}): Promise<AcquiredPHP> {
 		/**
 		 * First and foremost, make sure we have the primary PHP instance in place.
 		 * We may not actually acquire it. We just need it to exist.
@@ -179,7 +174,7 @@ export class PHPProcessManager implements PHPInstanceManager {
 		 *   budget left to optimistically start spawning the next
 		 *   instance.
 		 */
-		const spawnedPhp =
+		const AcquiredPHP =
 			this.nextInstance || this.spawn({ isPrimary: false });
 
 		/**
@@ -192,7 +187,7 @@ export class PHPProcessManager implements PHPInstanceManager {
 		} else {
 			this.nextInstance = null;
 		}
-		return await spawnedPhp;
+		return await AcquiredPHP;
 	}
 
 	/**
@@ -201,7 +196,7 @@ export class PHPProcessManager implements PHPInstanceManager {
 	 * add the spawn promise to the allInstances array without waiting
 	 * for PHP to spawn.
 	 */
-	private spawn(factoryArgs: PHPFactoryOptions): Promise<SpawnedPHP> {
+	private spawn(factoryArgs: PHPFactoryOptions): Promise<AcquiredPHP> {
 		if (factoryArgs.isPrimary && this.allInstances.length > 0) {
 			throw new Error(
 				'Requested spawning a primary PHP instance when another primary instance already started spawning.'
@@ -231,7 +226,9 @@ export class PHPProcessManager implements PHPInstanceManager {
 	/**
 	 * Actually acquires the lock and spawns a new PHP instance.
 	 */
-	private async doSpawn(factoryArgs: PHPFactoryOptions): Promise<SpawnedPHP> {
+	private async doSpawn(
+		factoryArgs: PHPFactoryOptions
+	): Promise<AcquiredPHP> {
 		let release: () => void;
 		try {
 			release = await this.semaphore.acquire();