Refactor submit config resolution by platform

packages/build-tools/package.json

@@ -39,6 +39,7 @@
     "@expo/config-plugins": "55.0.7",
     "@expo/downloader": "18.5.0",
     "@expo/eas-build-job": "18.8.0",
+    "@expo/eas-json": "18.8.0",
     "@expo/env": "^0.4.0",
     "@expo/logger": "18.5.0",
     "@expo/package-manager": "1.9.10",

packages/build-tools/src/steps/easFunctions.ts

@@ -27,6 +27,7 @@ import { createRepackBuildFunction } from './functions/repack';
 import { createReportMaestroTestResultsFunction } from './functions/reportMaestroTestResults';
 import { resolveAppleTeamIdFromCredentialsFunction } from './functions/resolveAppleTeamIdFromCredentials';
 import { createResolveBuildConfigBuildFunction } from './functions/resolveBuildConfig';
+import { createResolveSubmitConfigBuildFunction } from './functions/resolveSubmitConfig';
 import {
   createCacheStatsBuildFunction,
   createRestoreBuildCacheFunction,
@@ -88,6 +89,7 @@ export function getEasFunctions(ctx: CustomBuildContext): BuildFunction[] {
     calculateEASUpdateRuntimeVersionFunction(),
 
     createSubmissionEntityFunction(),
+    createResolveSubmitConfigBuildFunction(ctx),
     createUploadToAscBuildFunction(),
 
     createReportMaestroTestResultsFunction(ctx),

packages/build-tools/src/steps/functions/resolveSubmitConfig/android.ts

@@ -0,0 +1,182 @@
+import { Platform, SubmissionConfig, SystemError, UserError } from '@expo/eas-build-job';
+import { AndroidReleaseStatus, SubmitProfile } from '@expo/eas-json';
+import { bunyan } from '@expo/logger';
+import { asyncResult } from '@expo/results';
+import spawn from '@expo/turtle-spawn';
+import { BuildStepEnv } from '@expo/steps';
+import fs from 'fs-extra';
+import { graphql } from 'gql.tada';
+import path from 'node:path';
+import { z } from 'zod';
+
+import { BuildInfo, ResolvedSubmitConfig } from './common';
+import { CustomBuildContext } from '../../../customBuildContext';
+
+const ANDROID_APP_CREDENTIALS_QUERY = graphql(`
+  query ResolveSubmitConfigAndroidAppCredentials(
+    $appId: String!
+    $applicationIdentifier: String
+  ) {
+    app {
+      byId(appId: $appId) {
+        id
+        androidAppCredentials(filter: { applicationIdentifier: $applicationIdentifier }) {
+          id
+          googleServiceAccountKeyForSubmissions {
+            id
+            keyJson
+          }
+        }
+      }
+    }
+  }
+`);
+
+const AndroidReleaseStatusToSubmissionReleaseStatus: Record<
+  AndroidReleaseStatus,
+  SubmissionConfig.Android.ReleaseStatus
+> = {
+  [AndroidReleaseStatus.completed]: SubmissionConfig.Android.ReleaseStatus.COMPLETED,
+  [AndroidReleaseStatus.draft]: SubmissionConfig.Android.ReleaseStatus.DRAFT,
+  [AndroidReleaseStatus.halted]: SubmissionConfig.Android.ReleaseStatus.HALTED,
+  [AndroidReleaseStatus.inProgress]: SubmissionConfig.Android.ReleaseStatus.IN_PROGRESS,
+};
+
+export async function resolveAndroidSubmitConfigAsync({
+  artifactPath,
+  build,
+  ctx,
+  env,
+  logger,
+  profile,
+  workingDirectory,
+}: {
+  artifactPath: string;
+  build: BuildInfo;
+  ctx: CustomBuildContext;
+  env: BuildStepEnv;
+  logger: bunyan;
+  profile: SubmitProfile<Platform.ANDROID>;
+  workingDirectory: string;
+}): Promise<ResolvedSubmitConfig> {
+  const applicationId =
+    build.appIdentifier ??
+    profile.applicationId ??
+    (await readAndroidApplicationIdAsync(artifactPath, env, logger));
+  if (!applicationId) {
+    throw new UserError(
+      'EAS_RESOLVE_SUBMIT_CONFIG_ANDROID_APPLICATION_ID_NOT_FOUND',
+      'Could not resolve Android applicationId from build metadata or artifact. Set applicationId in the Android submit profile, or pass an APK/AAB artifact with a readable package name.'
+    );
+  }
+
+  const googleServiceAccountKeyJson = profile.serviceAccountKeyPath
+    ? await fs.readFile(path.resolve(workingDirectory, profile.serviceAccountKeyPath), 'utf8')
+    : await getGoogleServiceAccountKeyJsonAsync({
+        applicationId,
+        appId: build.appId,
+        ctx,
+      });
+
+  const releaseStatus = AndroidReleaseStatusToSubmissionReleaseStatus[profile.releaseStatus];
+  const baseConfigInput = {
+    changesNotSentForReview: profile.changesNotSentForReview,
+    googleServiceAccountKeyJson,
+    track: profile.track,
+  };
+  const configInput: z.input<typeof SubmissionConfig.Android.SchemaZ> =
+    releaseStatus === SubmissionConfig.Android.ReleaseStatus.IN_PROGRESS
+      ? {
+          ...baseConfigInput,
+          releaseStatus,
+          rollout: profile.rollout,
+        }
+      : {
+          ...baseConfigInput,
+          releaseStatus,
+        };
+
+  return {
+    appIdentifier: applicationId,
+    config: SubmissionConfig.Android.SchemaZ.parse(configInput),
+    platform: Platform.ANDROID,
+  };
+}
+
+async function getGoogleServiceAccountKeyJsonAsync({
+  applicationId,
+  appId,
+  ctx,
+}: {
+  applicationId: string;
+  appId: string;
+  ctx: CustomBuildContext;
+}): Promise<string> {
+  const credentialsResult = await ctx.graphqlClient
+    .query(ANDROID_APP_CREDENTIALS_QUERY, {
+      appId,
+      applicationIdentifier: applicationId,
+    })
+    .toPromise();
+  if (credentialsResult.error) {
+    throw credentialsResult.error;
+  }
+
+  const key =
+    credentialsResult.data?.app.byId.androidAppCredentials[0]
+      ?.googleServiceAccountKeyForSubmissions;
+  if (!key) {
+    throw new UserError(
+      'EAS_RESOLVE_SUBMIT_CONFIG_ANDROID_SERVICE_ACCOUNT_KEY_NOT_CONFIGURED',
+      `Google Service Account Key for submissions is not configured for ${applicationId}. Configure a Google Service Account Key for submissions in EAS credentials, or set serviceAccountKeyPath in the Android submit profile.`
+    );
+  }
+
+  if (!key.keyJson) {
+    throw new SystemError(`Google Service Account Key ${key.id} could not be resolved.`);
+  }
+  return key.keyJson;
+}
+
+async function readAndroidApplicationIdAsync(
+  artifactPath: string,
+  env: BuildStepEnv,
+  logger: bunyan
+): Promise<string | undefined> {
+  if (artifactPath.endsWith('.apk')) {
+    return await readAndroidApplicationIdFromApkAsync(artifactPath, env, logger);
+  } else if (artifactPath.endsWith('.aab')) {
+    return await readAndroidApplicationIdFromAabAsync(artifactPath, env, logger);
+  }
+  return undefined;
+}
+
+async function readAndroidApplicationIdFromApkAsync(
+  apkPath: string,
+  env: BuildStepEnv,
+  logger: bunyan
+): Promise<string | undefined> {
+  const aapt2Result = await asyncResult(spawn('aapt2', ['dump', 'packagename', apkPath], { env }));
+  if (aapt2Result.ok) {
+    return aapt2Result.value.stdout.trim();
+  }
+  logger.warn('Failed to read APK package name with aapt2.');
+  return undefined;
+}
+
+async function readAndroidApplicationIdFromAabAsync(
+  aabPath: string,
+  env: BuildStepEnv,
+  logger: bunyan
+): Promise<string | undefined> {
+  const result = await asyncResult(
+    spawn('bundletool', ['dump', 'manifest', `--bundle=${aabPath}`, '--xpath=/manifest/@package'], {
+      env,
+    })
+  );
+  if (!result.ok) {
+    logger.warn('Failed to read AAB package name with bundletool.');
+    return undefined;
+  }
+  return result.value.stdout.trim();
+}

packages/build-tools/src/steps/functions/resolveSubmitConfig/common.ts

@@ -0,0 +1,84 @@
+import { Platform, SubmissionConfig, UserError } from '@expo/eas-build-job';
+import { EasJsonAccessor, EasJsonUtils, SubmitProfile } from '@expo/eas-json';
+import { graphql } from 'gql.tada';
+
+import { CustomBuildContext } from '../../../customBuildContext';
+
+export type AppPlatform = 'ANDROID' | 'IOS';
+
+export const AppPlatformToPlatform: Record<AppPlatform, Platform> = {
+  ANDROID: Platform.ANDROID,
+  IOS: Platform.IOS,
+};
+
+export type BuildInfo = {
+  appIdentifier?: string | null;
+  appId: string;
+  buildId: string;
+  projectOwnerAccountId: string;
+  platform: Platform;
+};
+
+export type ResolvedSubmitConfig = {
+  appIdentifier?: string;
+  config: SubmissionConfig.Android | SubmissionConfig.Ios;
+  platform: Platform;
+};
+
+const BUILD_BY_ID_QUERY = graphql(`
+  query ResolveSubmitConfigBuildById($buildId: ID!) {
+    builds {
+      byId(buildId: $buildId) {
+        id
+        platform
+        appIdentifier
+        app {
+          id
+          ownerAccount {
+            id
+          }
+        }
+      }
+    }
+  }
+`);
+
+export async function getBuildInfoAsync(
+  ctx: CustomBuildContext,
+  buildId: string
+): Promise<BuildInfo> {
+  const result = await ctx.graphqlClient.query(BUILD_BY_ID_QUERY, { buildId }).toPromise();
+  if (result.error) {
+    throw result.error;
+  }
+  const build = result.data?.builds.byId;
+  if (!build) {
+    throw new UserError(
+      'EAS_RESOLVE_SUBMIT_CONFIG_BUILD_NOT_FOUND',
+      `Could not find build ${buildId}.`
+    );
+  }
+  return {
+    appIdentifier: build.appIdentifier,
+    appId: build.app.id,
+    buildId: build.id,
+    projectOwnerAccountId: build.app.ownerAccount.id,
+    platform: AppPlatformToPlatform[build.platform],
+  };
+}
+
+export async function getSubmitProfileAsync<T extends Platform>({
+  platform,
+  profileName,
+  workingDirectory,
+}: {
+  platform: T;
+  profileName: string;
+  workingDirectory: string;
+}): Promise<SubmitProfile<T>> {
+  return await EasJsonUtils.getSubmitProfileAsync(
+    EasJsonAccessor.fromProjectPath(workingDirectory),
+    platform,
+    profileName
+  );
+}