Deduplicate bundled PHP binary helpers

Author: bcotrim

apps/cli/lib/dependency-management/php-binary.ts

@@ -5,9 +5,12 @@ import path from 'path';
 import { downloadFile } from '@studio/common/lib/download-file';
 import { extractZip } from '@studio/common/lib/extract-zip';
 import { isErrnoException } from '@studio/common/lib/is-errno-exception';
+import {
+	findBundledPhpBinary,
+	verifyBundledPhpBinaryHash,
+} from '@studio/common/lib/php-binary-bundle';
 import {
 	buildPhpBinaryUrl,
-	getBundledPhpBinaryRelativePath,
 	getPhpBinaryHash,
 	validateNativePhpVersion,
 	PHP_PATCH_VERSIONS,
@@ -72,7 +75,12 @@ async function claimInstallSlot( destDir: string, destPath: string ): Promise< b
 async function installBundledBinaryIfAvailable(
 	version: NativePhpSupportedVersion
 ): Promise< boolean > {
-	const sourcePath = findBundledBinary( version, process.platform, process.arch );
+	const sourcePath = findBundledPhpBinary( version, process.platform, process.arch, [
+		// Built CLI bundle: dist/cli/bin/php/...
+		path.join( import.meta.dirname, 'bin', 'php' ),
+		// Source tree fallback for local development before the Vite build runs.
+		path.resolve( import.meta.dirname, '..', '..', 'bin', 'php' ),
+	] );
 	if ( ! sourcePath ) {
 		return false;
 	}
@@ -85,7 +93,7 @@ async function installBundledBinaryIfAvailable(
 	}
 
 	try {
-		await verifyBundledHash( sourcePath );
+		await verifyBundledPhpBinaryHash( sourcePath );
 		fs.copyFileSync( sourcePath, destPath );
 		if ( process.platform !== 'win32' ) {
 			fs.chmodSync( destPath, 0o755 );
@@ -97,43 +105,6 @@ async function installBundledBinaryIfAvailable(
 	}
 }
 
-function findBundledBinary(
-	version: NativePhpSupportedVersion,
-	platform: NodeJS.Platform,
-	arch: string
-): string | undefined {
-	const relativePath = getBundledPhpBinaryRelativePath( version, platform, arch );
-	const roots = [
-		path.join( import.meta.dirname, 'bin', 'php' ),
-		path.resolve( import.meta.dirname, '..', '..', 'bin', 'php' ),
-	];
-
-	for ( const root of roots ) {
-		const sourcePath = path.join( root, relativePath );
-		if ( fs.existsSync( sourcePath ) ) {
-			return sourcePath;
-		}
-	}
-}
-
-async function verifyBundledHash( sourcePath: string ): Promise< void > {
-	const hashPath = `${ sourcePath }.sha256`;
-	if ( ! fs.existsSync( hashPath ) ) {
-		throw new Error( `No pinned SHA-256 hash for bundled PHP binary at ${ sourcePath }.` );
-	}
-
-	const [ expected ] = ( await fs.promises.readFile( hashPath, 'utf8' ) ).trim().split( /\s+/ );
-	const data = await fs.promises.readFile( sourcePath );
-	const actual = crypto.createHash( 'sha256' ).update( data ).digest( 'hex' );
-	if ( actual !== expected ) {
-		throw new Error(
-			`SHA-256 mismatch for bundled PHP binary at ${ sourcePath }:\n` +
-				`  expected ${ expected }\n` +
-				`  got      ${ actual }`
-		);
-	}
-}
-
 async function downloadAndInstall(
 	version: NativePhpSupportedVersion,
 	onProgress?: ( downloaded: number, total: number ) => void

scripts/build-php-cli-macos.sh

@@ -236,7 +236,6 @@ patch(
 )
 PY
 
-php bin/spc doctor
 php bin/spc download --with-php="$PHP_MINOR" --for-extensions="$EXTENSIONS" --retry=2
 
 build_arch() {

scripts/download-php-binary.ts

@@ -26,9 +26,12 @@ import { z } from 'zod';
 import { downloadFile } from '../tools/common/lib/download-file';
 import { extractZip } from '../tools/common/lib/extract-zip';
 import { isErrnoException } from '../tools/common/lib/is-errno-exception';
+import {
+	findBundledPhpBinary,
+	verifyBundledPhpBinaryHash,
+} from '../tools/common/lib/php-binary-bundle';
 import {
 	buildPhpBinaryUrl,
-	getBundledPhpBinaryRelativePath,
 	getPhpBinaryHash,
 	getPhpBinaryFilename,
 	getPhpBinaryPlatformArch,
@@ -119,12 +122,14 @@ async function main(): Promise< void > {
 		}
 
 		try {
-			const bundledPath = findBundledBinary( version, args.platform, args.arch );
+			const bundledPath = findBundledPhpBinary( version, args.platform, args.arch, [
+				path.join( __dirname, '..', 'apps', 'cli', 'bin', 'php' ),
+			] );
 			if ( bundledPath ) {
 				console.log(
 					`Installing bundled PHP ${ version } (${ patchVersion }) for ${ platformKey }…`
 				);
-				await verifyBundledHash( bundledPath );
+				await verifyBundledPhpBinaryHash( bundledPath );
 				fs.copyFileSync( bundledPath, destPath );
 				if ( ! isWindows ) {
 					fs.chmodSync( destPath, 0o755 );
@@ -203,33 +208,6 @@ async function main(): Promise< void > {
 	}
 }
 
-function findBundledBinary(
-	bundledVersion: NativePhpSupportedVersion,
-	platform: NodeJS.Platform,
-	arch: string
-): string | undefined {
-	const sourcePath = path.join(
-		__dirname,
-		'..',
-		'apps',
-		'cli',
-		'bin',
-		'php',
-		getBundledPhpBinaryRelativePath( bundledVersion, platform, arch )
-	);
-	return fs.existsSync( sourcePath ) ? sourcePath : undefined;
-}
-
-async function verifyBundledHash( sourcePath: string ): Promise< void > {
-	const hashPath = `${ sourcePath }.sha256`;
-	const [ expected ] = ( await fs.promises.readFile( hashPath, 'utf8' ) ).trim().split( /\s+/ );
-	const data = await fs.promises.readFile( sourcePath );
-	const actual = crypto.createHash( 'sha256' ).update( data ).digest( 'hex' );
-	if ( actual !== expected ) {
-		throw new Error( `SHA-256 mismatch:\n  expected ${ expected }\n  got      ${ actual }` );
-	}
-}
-
 function logInstalledBinary( destPath: string ): void {
 	const stats = fs.statSync( destPath );
 	console.log(

tools/common/lib/php-binary-bundle.ts

@@ -0,0 +1,41 @@
+import crypto from 'crypto';
+import fs from 'fs';
+import path from 'path';
+import {
+	getBundledPhpBinaryRelativePath,
+	type NativePhpSupportedVersion,
+} from './php-binary-metadata';
+
+export function findBundledPhpBinary(
+	version: NativePhpSupportedVersion,
+	platform: NodeJS.Platform,
+	arch: string,
+	roots: string[]
+): string | undefined {
+	const relativePath = getBundledPhpBinaryRelativePath( version, platform, arch );
+
+	for ( const root of roots ) {
+		const sourcePath = path.join( root, relativePath );
+		if ( fs.existsSync( sourcePath ) ) {
+			return sourcePath;
+		}
+	}
+}
+
+export async function verifyBundledPhpBinaryHash( sourcePath: string ): Promise< void > {
+	const hashPath = `${ sourcePath }.sha256`;
+	if ( ! fs.existsSync( hashPath ) ) {
+		throw new Error( `No pinned SHA-256 hash for bundled PHP binary at ${ sourcePath }.` );
+	}
+
+	const [ expected ] = ( await fs.promises.readFile( hashPath, 'utf8' ) ).trim().split( /\s+/ );
+	const data = await fs.promises.readFile( sourcePath );
+	const actual = crypto.createHash( 'sha256' ).update( data ).digest( 'hex' );
+	if ( actual !== expected ) {
+		throw new Error(
+			`SHA-256 mismatch for bundled PHP binary at ${ sourcePath }:\n` +
+				`  expected ${ expected }\n` +
+				`  got      ${ actual }`
+		);
+	}
+}