[ENG-1271] make iOS credentials manager work with multi-target projects #441

dsokal · 2021-06-04T10:32:18Z

Checklist

I've added an entry to CHANGELOG.md if necessary.
I've tagged the changelog entry with [EAS BUILD API] if it's a part of a breaking change to EAS Build API (only possible when updating @expo/eas-build-job package).

Why

Credentials Manager doesn't work with multi-target iOS projects.
Fixes https://linear.app/expo/issue/ENG-1271/eas-credentials-downloads-to-ioscerts-which-conflicts-with-workflow

How

I know this is quite big PR but I didn't know how to divide work into smaller pieces.

Notable changes:

Manager can now print credentials for all targets - similarly to how SetupBuildCredentials prints the summary after all targets are set up.
When a project has multiple schemes, the user is asked which scheme they want to configure.
If the scheme has multiple targets and the user selects an action that works in the scope of the target credentials (UseExistingDistributionCertificate, CreateDistributionCertificate and RemoveProvisioningProfile) they are asked which target to use.
I changed the default directory for backing up credentials on the local machine (this fixes the linear task):
- ios/certs -> credentials/ios
- android/keystores -> credentials/android

Test Plan

I tested credentials manager manually (by executing all available commands) for 3 different projects:

multi-target generic project
single-target generic project
managed project

github-actions · 2021-06-04T10:35:57Z

Size Change: +2 kB (0%)

Total Size: 37.5 MB

Filename	Size	Change
`./packages/eas-cli/dist/eas-linux-x64.tar.gz`	37.5 MB	+2 kB (0%)

_{compressed-size-action}

linear · 2021-06-07T07:37:21Z

ENG-1271 eas credentials downloads to ios/certs, which conflicts with workflow detection

If you have a managed project and run eas credentials and download credentials.json then eas-cli will start assuming you have a bare project.

wkozyra95 · 2021-06-08T08:39:33Z

packages/eas-cli/src/credentials/credentialsJson/utils.ts

+  if (notConfiguredTargets.length > 0) {
+    throw new Error(
+      `Credentials for target${
+        notConfiguredTargets.length === 1 ? '' : 's'


if there is only one target error message should state sth less specific e.g. credentials are not configured or sth like this, without talking about targets

wkozyra95 · 2021-06-08T08:43:11Z

packages/eas-cli/src/credentials/credentialsJson/update.ts

+  const provisioningProfilePath: string =
+    currentRawTargetCredentialsObject?.provisioningProfilePath ??
+    `credentials/ios/${target.targetName}-profile.mobileprovision`;
+  const distCertPath: string =


what if existing paths pointed to the same file on the disk, when updating you will replace it for all of them

wkozyra95 · 2021-06-08T08:53:44Z

packages/eas-cli/src/credentials/manager/ManageIos.ts

+              exp: ctx.exp,
+            },
+            {
+              workflow: buildProfile.workflow,


maybe pass buildProfile here

quinlanj

thanks!

quinlanj · 2021-06-08T07:43:13Z

packages/eas-cli/src/credentials/ios/utils/printCredentials.ts

+  targets: Target[]
+): void {
+  const projectFullName = `@${app.account.name}/${app.projectName}`;


ignore this suggestion if theres an edge case (ie) targets is a subset of the appCredentials keys

Suggested change

targets: Target[]

): void {

const projectFullName = `@${app.account.name}/${app.projectName}`;

): void {

const targets = Object.keys(appCredentials);

const projectFullName = `@${app.account.name}/${app.projectName}`;

I use the Target[] type here because it contains bundle identifiers of the targets. If the build credentials for a target in appCredentials don't exist, then I couldn't determine the bundle id. See line 79.

quinlanj · 2021-06-08T07:47:08Z

packages/eas-cli/src/credentials/ios/utils/printCredentials.ts

-export function displayIosAppCredentials(credentials: CommonIosAppCredentialsFragment): void {
+export function displayIosCredentials(
+  app: App,
+  appCredentials: IosAppCredentialsMap,


Suggested change

appCredentials: IosAppCredentialsMap,

appCredentialsMap: IosAppCredentialsMap,

quinlanj · 2021-06-08T07:55:35Z

packages/eas-cli/src/credentials/manager/ManageIos.ts

+          app = { account, projectName: ctx.exp.slug };
+          const easJsonReader = new EasJsonReader(ctx.projectDir, 'ios');
+          const easConfig = await new SelectBuildProfileFromEasJson(easJsonReader).runAsync(ctx);
+          buildProfile = nullthrows(easConfig.builds.ios, 'iOS build profile must be defined');
+          const xcodeBuildContext = await resolveXcodeBuildContextAsync(
+            {
+              projectDir: ctx.projectDir,
+              nonInteractive: ctx.nonInteractive,
+              exp: ctx.exp,
+            },
+            {
+              workflow: buildProfile.workflow,
+              ...(buildProfile.workflow === Workflow.GENERIC && {
+                buildConfiguration: buildProfile.schemeBuildConfiguration,
+                buildScheme: buildProfile.scheme,
+              }),
+            }
          );
-          if (!iosAppCredentials) {
-            displayEmptyIosCredentials(appLookupParams);
-          } else {
-            displayIosAppCredentials(iosAppCredentials);
+          targets = await resolveTargetsAsync(
+            { exp: ctx.exp, projectDir: ctx.projectDir },
+            xcodeBuildContext
+          );
+          const iosAppCredentialsMap: IosAppCredentialsMap = {};
+          for (const target of targets) {
+            const appLookupParams = getAppLookupParamsFromContext(ctx, target);
+            iosAppCredentialsMap[
+              target.targetName
+            ] = await ctx.ios.getIosAppCredentialsWithCommonFieldsAsync(appLookupParams);


might be cleaner to refactor this into a separate method that returns {isProjectContext: true, app: App, targets: Target[], buildProfile: BuildProfile} | {isProjectContext: false, app: null, targets: null, buildProfile: null} and populate it on line 83-86 (moving line 87-96 out of the while loop so you can use account)

dsokal force-pushed the @dsokal/multitarget-credentials-manager branch from 104f046 to 7076162 Compare June 4, 2021 10:32

dsokal added 2 commits June 4, 2021 13:17

make function for selecting Xcode scheme generic

e7156eb

move XcodeBuildContext resolver

0139afe

dsokal force-pushed the @dsokal/multitarget-credentials-manager branch 2 times, most recently from ca992ea to 818b23d Compare June 4, 2021 11:58

dsokal changed the title ~~@dsokal/multitarget credentials manager~~ make ios credentials manager work with multitarget projects Jun 4, 2021

dsokal requested a review from wkozyra95 June 4, 2021 11:59

dsokal changed the title ~~make ios credentials manager work with multitarget projects~~ [ENG-1271] make ios credentials manager work with multitarget projects Jun 7, 2021

dsokal force-pushed the @dsokal/multitarget-credentials-manager branch 4 times, most recently from 2d2dd5b to a7edaeb Compare June 7, 2021 09:20

adjust ios credentials manager to multitarget projects

a296bc0

dsokal force-pushed the @dsokal/multitarget-credentials-manager branch from a7edaeb to a296bc0 Compare June 7, 2021 09:30

update CHANGELOG

cc28f39

dsokal changed the title ~~[ENG-1271] make ios credentials manager work with multitarget projects~~ [ENG-1271] make iOS credentials manager work with multi-target projects Jun 7, 2021

dsokal marked this pull request as ready for review June 7, 2021 10:14

dsokal requested a review from quinlanj June 7, 2021 10:14

wkozyra95 reviewed Jun 8, 2021

View reviewed changes

quinlanj approved these changes Jun 8, 2021

View reviewed changes

dsokal force-pushed the @dsokal/multitarget-credentials-manager branch from 3982742 to b03c1c9 Compare June 9, 2021 11:41

address PR feedback

fe314e7

dsokal force-pushed the @dsokal/multitarget-credentials-manager branch from b03c1c9 to fe314e7 Compare June 9, 2021 11:52

dsokal merged commit 2bdaa0d into main Jun 9, 2021

dsokal deleted the @dsokal/multitarget-credentials-manager branch June 9, 2021 11:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ENG-1271] make iOS credentials manager work with multi-target projects #441

[ENG-1271] make iOS credentials manager work with multi-target projects #441

dsokal commented Jun 4, 2021 •

edited

Loading

github-actions bot commented Jun 4, 2021 •

edited

Loading

linear bot commented Jun 7, 2021

wkozyra95 Jun 8, 2021

wkozyra95 Jun 8, 2021

wkozyra95 Jun 8, 2021

quinlanj left a comment

quinlanj Jun 8, 2021

dsokal Jun 9, 2021 •

edited

Loading

quinlanj Jun 8, 2021

quinlanj Jun 8, 2021

	appCredentials: IosAppCredentialsMap,
	appCredentialsMap: IosAppCredentialsMap,

[ENG-1271] make iOS credentials manager work with multi-target projects #441

[ENG-1271] make iOS credentials manager work with multi-target projects #441

Conversation

dsokal commented Jun 4, 2021 • edited Loading

Checklist

Why

How

Test Plan

github-actions bot commented Jun 4, 2021 • edited Loading

linear bot commented Jun 7, 2021

wkozyra95 Jun 8, 2021

Choose a reason for hiding this comment

wkozyra95 Jun 8, 2021

Choose a reason for hiding this comment

wkozyra95 Jun 8, 2021

Choose a reason for hiding this comment

quinlanj left a comment

Choose a reason for hiding this comment

quinlanj Jun 8, 2021

Choose a reason for hiding this comment

dsokal Jun 9, 2021 • edited Loading

Choose a reason for hiding this comment

quinlanj Jun 8, 2021

Choose a reason for hiding this comment

quinlanj Jun 8, 2021

Choose a reason for hiding this comment

dsokal commented Jun 4, 2021 •

edited

Loading

github-actions bot commented Jun 4, 2021 •

edited

Loading

dsokal Jun 9, 2021 •

edited

Loading