expo-release 2.3.1 → 2.4.0

package/src/eas-json.ts

@@ -0,0 +1,128 @@
+import type { ReleasePlatform } from './args'
+
+/** The fields of an eas.json build profile that expo-release reads. */
+export type BuildProfile = {
+	channel?: string
+	environment?: string
+	env?: Record<string, string>
+	node?: string
+	bun?: string
+}
+
+export type EasJson = {
+	cli?: { version?: string }
+	build?: Record<string, Record<string, unknown>>
+	submit?: Record<string, unknown>
+}
+
+/** Reads eas.json from the working directory. eas-cli accepts JSON5 there. */
+export async function readEasJson(path = 'eas.json'): Promise<EasJson | null> {
+	const file = Bun.file(path)
+	if (!(await file.exists())) return null
+	const text = await file.text()
+	let value: unknown
+	try {
+		value = JSON.parse(text)
+	} catch (error) {
+		// eas-cli also accepts JSON5 (comments, trailing commas). Bun.JSON5 is
+		// missing on older Bun, where plain JSON still works.
+		const json5 = (Bun as { JSON5?: { parse(text: string): unknown } }).JSON5
+		if (!json5) throw error
+		value = json5.parse(text)
+	}
+	if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+		throw new Error(`${path} must hold an object`)
+	}
+	return value as EasJson
+}
+
+type RawProfile = Record<string, unknown>
+
+function asRecord(value: unknown): RawProfile | undefined {
+	return typeof value === 'object' && value !== null && !Array.isArray(value)
+		? (value as RawProfile)
+		: undefined
+}
+
+// The merge eas-cli applies (@expo/eas-json build/resolver): later keys win,
+// `env` and the platform blocks merge one level deep.
+function merge(base: RawProfile, update: RawProfile): RawProfile {
+	const result = { ...base, ...update }
+	for (const key of ['env', 'ios', 'android']) {
+		const a = asRecord(base[key])
+		const b = asRecord(update[key])
+		if (a && b) result[key] = key === 'env' ? { ...a, ...b } : merge(a, b)
+	}
+	return result
+}
+
+function resolveRaw(
+	easJson: EasJson,
+	name: string,
+	depth: number
+): RawProfile | null {
+	if (depth >= 5) {
+		throw new Error(
+			'eas.json: too long a chain of "extends"; check the build profiles for a cycle'
+		)
+	}
+	const profile = asRecord(easJson.build?.[name])
+	if (!profile) {
+		if (depth === 0) return null
+		throw new Error(`eas.json: build profile extends missing "${name}"`)
+	}
+	const { extends: parent, ...rest } = profile
+	return typeof parent === 'string'
+		? merge(resolveRaw(easJson, parent, depth + 1) ?? {}, rest)
+		: rest
+}
+
+/** `build.<name>` with `extends` and the platform block applied, or null. */
+export function resolveBuildProfile(
+	easJson: EasJson,
+	name: string,
+	platform: ReleasePlatform
+): BuildProfile | null {
+	const raw = resolveRaw(easJson, name, 0)
+	if (!raw) return null
+	const { ios, android, ...base } = raw
+	const resolved = merge(
+		base,
+		asRecord(platform === 'ios' ? ios : android) ?? {}
+	)
+	const text = (key: string) =>
+		typeof resolved[key] === 'string' && resolved[key] !== ''
+			? (resolved[key] as string)
+			: undefined
+	const env = asRecord(resolved.env)
+	return {
+		channel: text('channel'),
+		environment: text('environment'),
+		node: text('node'),
+		bun: text('bun'),
+		...(env
+			? {
+					env: Object.fromEntries(
+						Object.entries(env).map(([key, value]) => [key, String(value)])
+					)
+				}
+			: {})
+	}
+}
+
+/**
+ * Puts the profile's `env` into this process, so every EAS command and hook
+ * sees what the EAS build machine sees. Variables already set win.
+ */
+export function applyProfileEnv(
+	profile: BuildProfile | null,
+	env: Record<string, string | undefined> = process.env
+): string[] {
+	const applied: string[] = []
+	for (const [key, value] of Object.entries(profile?.env ?? {})) {
+		if (env[key] !== undefined) continue
+		env[key] = value
+		applied.push(key)
+	}
+	return applied
+}

package/src/index.ts

@@ -8,7 +8,9 @@ export {
 } from './args'
 export {
 	type DecisionInput,
+	type DecisionReason,
 	type EASBuild,
+	type FingerprintDiff,
 	type ReleaseDecision,
 	decideRelease
 } from './decide'

package/src/operate.ts

@@ -1,11 +1,13 @@
 import type { DeployType, Operation, ReleasePlatform } from './args'
+import { type EASBuild, parseBuildList } from './decide'
 import { appendGitHubOutput } from './github-output'
 import {
 	type CommandRunner,
 	dryRunCommand,
 	easCommand,
 	generateFingerprint,
-	runInherited
+	runInherited,
+	stage
 } from './run'
 import {
 	assertSourceMaps,
@@ -32,14 +34,23 @@ export type OperationInput = {
 	updateExtraArgs?: string
 	exportSourceMaps?: boolean
 	dryRun?: boolean
+	/** Called with the native build `eas build` queued, when it printed one. */
+	onQueuedBuild?: (build: EASBuild) => void
 	readPackageJson?: () => Promise<unknown>
 	hasSourceMaps?: () => Promise<boolean>
 }
 
 export type OperationResult = 'skipped' | 'ota' | 'native-build' | 'recovery'
 
-function extraUpdateArgs(value: string | undefined): string[] {
-	return value?.split(/\s+/).filter(Boolean) ?? []
+/** Splits like a shell: whitespace separates, single or double quotes group. */
+export function splitArgs(value: string | undefined): string[] {
+	const args: string[] = []
+	for (const match of (value ?? '').matchAll(
+		/"((?:\\.|[^"\\])*)"|'([^']*)'|(\S+)/g
+	)) {
+		args.push(match[1]?.replace(/\\(.)/g, '$1') ?? match[2] ?? match[3] ?? '')
+	}
+	return args
 }
 
 export function updateMessage(input: {
@@ -69,31 +80,40 @@ async function defaultReadPackageJson(): Promise<unknown> {
 	return file.json()
 }
 
-export async function requireEnvironmentIfNeeded(
-	input: Pick<OperationInput, 'environment' | 'readPackageJson'>
-) {
-	if (input.environment) return
-	const pkg = await (input.readPackageJson ?? defaultReadPackageJson)()
-	if (!pkg || typeof pkg !== 'object' || pkg === null) return
+/** The Expo SDK major from package.json, or null when it is not a version. */
+export async function readExpoSdkMajor(
+	readPackageJson: () => Promise<unknown> = defaultReadPackageJson
+): Promise<number | null> {
+	const pkg = await readPackageJson()
+	if (!pkg || typeof pkg !== 'object') return null
 	const record = pkg as {
 		dependencies?: { expo?: string }
 		devDependencies?: { expo?: string }
 	}
-	const version = record.dependencies?.expo ?? record.devDependencies?.expo
-	const major = parseExpoSdkMajor(version)
+	return parseExpoSdkMajor(
+		record.dependencies?.expo ?? record.devDependencies?.expo
+	)
+}
+
+export async function requireEnvironmentIfNeeded(
+	input: Pick<OperationInput, 'environment' | 'readPackageJson'>
+) {
+	if (input.environment) return
+	const major = await readExpoSdkMajor(input.readPackageJson)
 	if (major !== null && major >= 55) {
 		throw new Error(
-			'EAS Update requires --environment for Expo SDK 55+. Pass --environment <name>.'
+			'EAS Update requires --environment for Expo SDK 55+. Pass --environment <name> or set build.<profile>.environment in eas.json.'
 		)
 	}
 }
 
 async function runHook(
+	name: 'pre-update' | 'post-update',
 	command: string | undefined,
 	commandRunner: CommandRunner
 ) {
 	if (!command) return
-	await commandRunner(['bash', '-c', command])
+	await stage(name, () => commandRunner(['bash', '-c', command]))
 }
 
 function mutatingRunner(
@@ -115,12 +135,14 @@ async function publishUpdate(
 ) {
 	await requireEnvironmentIfNeeded(input)
 	if (input.exportSourceMaps) {
-		await commandRunner(sourceMapExportCommand(input.platform))
-		if (input.dryRun !== true) {
-			await assertSourceMaps(input.hasSourceMaps)
-		}
+		await stage('ota export', async () => {
+			await commandRunner(sourceMapExportCommand(input.platform))
+			if (input.dryRun !== true) {
+				await assertSourceMaps(input.hasSourceMaps)
+			}
+		})
 	}
-	await runHook(input.preUpdate, commandRunner)
+	await runHook('pre-update', input.preUpdate, commandRunner)
 	const command = easCommand(
 		'update',
 		'--channel',
@@ -136,18 +158,19 @@ async function publishUpdate(
 	}
 	command.push(
 		...mergeUpdateArgs(
-			extraUpdateArgs(input.updateExtraArgs),
+			splitArgs(input.updateExtraArgs),
 			input.exportSourceMaps === true
 		)
 	)
-	await commandRunner(command)
-	await runHook(input.postUpdate, commandRunner)
+	await stage('ota update', () => commandRunner(command))
+	await runHook('post-update', input.postUpdate, commandRunner)
 }
 
+/** Queues the build and reports the build EAS started (none in a dry run). */
 async function queueNativeBuild(
 	input: OperationInput,
 	commandRunner: CommandRunner
-) {
+): Promise<OperationResult> {
 	const command = easCommand(
 		'build',
 		'--platform',
@@ -155,12 +178,23 @@ async function queueNativeBuild(
 		'--profile',
 		input.profile,
 		'--non-interactive',
-		'--no-wait'
+		'--no-wait',
+		'--json'
 	)
 	if (input.autoSubmit) {
 		command.push('--auto-submit')
 	}
-	await commandRunner(command)
+	const output = await stage('native build', () => commandRunner(command))
+	// The build is queued; an unreadable record only loses the outputs.
+	try {
+		const queued = output.trim() ? parseBuildList(output)[0] : undefined
+		if (queued) input.onQueuedBuild?.(queued)
+	} catch (error) {
+		process.stderr.write(
+			`Warning: could not read the queued build from eas build --json: ${error instanceof Error ? error.message : String(error)}\n`
+		)
+	}
+	return 'native-build'
 }
 
 async function resolveRuntimeVersion(
@@ -169,7 +203,7 @@ async function resolveRuntimeVersion(
 ): Promise<string> {
 	if (input.runtimeVersion) return input.runtimeVersion
 	if (input.fingerprint) return input.fingerprint
-	return generateFingerprint(input, commandRunner)
+	return stage('fingerprint', () => generateFingerprint(input, commandRunner))
 }
 
 export async function operateRelease(
@@ -185,17 +219,20 @@ export async function operateRelease(
 					'Usage: --operation republish requires --group <update-group-id>'
 				)
 			}
+			const group = input.group
 			await requireEnvironmentIfNeeded(input)
-			await execute(
-				easCommand(
-					'update:republish',
-					'--group',
-					input.group,
-					'--platform',
-					input.platform,
-					'--message',
-					updateMessage(input),
-					'--non-interactive'
+			await stage('recovery', () =>
+				execute(
+					easCommand(
+						'update:republish',
+						'--group',
+						group,
+						'--platform',
+						input.platform,
+						'--message',
+						updateMessage(input),
+						'--non-interactive'
+					)
 				)
 			)
 			return 'recovery'
@@ -203,25 +240,26 @@ export async function operateRelease(
 		case 'rollback-embedded': {
 			await requireEnvironmentIfNeeded(input)
 			const runtimeVersion = await resolveRuntimeVersion(input, commandRunner)
-			await execute(
-				easCommand(
-					'update:roll-back-to-embedded',
-					'--channel',
-					input.channel,
-					'--platform',
-					input.platform,
-					'--runtime-version',
-					runtimeVersion,
-					'--message',
-					updateMessage(input),
-					'--non-interactive'
+			await stage('recovery', () =>
+				execute(
+					easCommand(
+						'update:roll-back-to-embedded',
+						'--channel',
+						input.channel,
+						'--platform',
+						input.platform,
+						'--runtime-version',
+						runtimeVersion,
+						'--message',
+						updateMessage(input),
+						'--non-interactive'
+					)
 				)
 			)
 			return 'recovery'
 		}
 		case 'force-native':
-			await queueNativeBuild(input, execute)
-			return 'native-build'
+			return queueNativeBuild(input, execute)
 		case 'retry-ota':
 			await publishUpdate(input, execute)
 			return 'ota'
@@ -237,8 +275,7 @@ export async function operateRelease(
 		case 'none':
 			return 'skipped'
 		case 'native':
-			await queueNativeBuild(input, execute)
-			return 'native-build'
+			return queueNativeBuild(input, execute)
 		case 'ota':
 			await publishUpdate(input, execute)
 			return 'ota'
@@ -249,6 +286,13 @@ export async function operateRelease(
 	}
 }
 
-export async function writeOperateGitHubOutput(result: OperationResult) {
-	await appendGitHubOutput({ result })
+export async function writeOperateGitHubOutput(
+	result: OperationResult,
+	queuedBuild?: EASBuild
+) {
+	await appendGitHubOutput({
+		result,
+		queued_build_id: queuedBuild?.id ?? '',
+		queued_build_url: queuedBuild?.buildUrl ?? ''
+	})
 }