Compare commits

...
Author SHA1 Message Date
Gabe Debes 49e716de0f [eas-cli] Keep the list example with interactive controls 2026-10-29 13:34:55 -07:00
Gabe Debes 42fc262d8d [eas-cli] Keep interactive simulator controls as an optional final layer 2026-10-29 13:34:54 -07:00
Gabe DebesandCodex 879a13990b [eas-cli] Preserve saved sessions when imported setup fails
Co-authored-by: Codex <[email protected]>
2026-10-29 13:34:32 -07:00
Gabe DebesandCodex 6581bb7104 [eas-cli] Cover simulator startup modes and import cleanup
Compare direct and imported startup settings across platforms, output modes and local egress. Cover imported text/file output and failed dotenv cleanup, and separate the import heading from ready output.

Co-authored-by: Codex <[email protected]>
2026-10-29 13:34:13 -07:00
Gabe Debes 7e42b3867d [eas-cli] Clarify simulator start import help 2026-10-29 13:34:12 -07:00
Gabe Debes 5499d03b8f [eas-cli] Import start settings and apply actions after simulator readiness 2026-10-29 13:33:58 -07:00
Gabe Debes 03c25a7a29 [eas-cli] Preserve upload path behavior in imported controls 2026-10-29 13:33:20 -07:00
Gabe DebesandCodex 88edfb0729 [eas-cli] Continue simulator actions without display metadata
Co-authored-by: Codex <[email protected]>
2026-10-29 13:31:08 -07:00
Gabe DebesandCodex 5d8f23e666 [eas-cli] Allow cold simulator metadata responses
Use the existing preview API timeout for device metadata. Add a slow HTTP response regression for the timeout observed in hosted QA.

Co-authored-by: Codex <[email protected]>
2026-10-29 13:31:08 -07:00
Gabe Debes f77cd548c3 [eas-cli] Clarify simulator control help 2026-10-29 13:31:08 -07:00
Gabe Debes 0abcbb746d [eas-cli] Simplify simulator action preparation and header formatting 2026-10-29 13:30:53 -07:00
Gabe Debes 7fc29a9f18 [eas-cli] Remove runtime freezing from simulator action plans 2026-10-29 13:30:53 -07:00
Gabe Debes 0a39966a40 [eas-cli] Simplify simulator control metadata and examples 2026-10-29 13:30:53 -07:00
Gabe Debes cf1d77160b [eas-cli] Import simulator control actions without the interactive menu 2026-10-29 13:30:53 -07:00
Gabe Debes f65472ae0a [worker] Run package-manager checks in parallel during worker startup (#4710)
* [worker] Allow jobs to skip unused package-manager queries

* [worker] Run package-manager version queries in parallel
2026-10-29 12:21:41 -07:00
Gabe Debes 40f2b55f96 [worker] Add an env flag to skip CocoaPods proxy setup (#4709)
* [worker] Skip CocoaPods proxy setup for device sessions

* [worker] Add an opt-out for CocoaPods proxy setup
2026-10-29 12:21:40 -07:00
Gabe Debes dc759c0854 [worker] Run the Xcode check in the background (#4707)
* [worker] Skip Xcode upload workaround for device sessions

* [worker] Identify device sessions by their job session ID

* [worker] Add an opt-out for the Xcode version check

* [worker] Run the Xcode check alongside tool preparation

* [worker] Start the Xcode check without waiting

* [worker] Move Xcode preparation into runtimeEnvironment
2026-10-29 12:21:40 -07:00
William Grosset e38a605d89 [eas-cli] Add an Expo Update tip experiment for agents near the Free plan build limit (#4758)
* [eas-cli] Add an EAS Update tip experiment for agents near the Free plan build limit

* [eas-cli] Address review feedback

- Write the shown marker only in the treatment arm, after the tip prints
- Keep checking the next platform when a marker write fails
- Log the tip event only in the treatment arm; the exposure covers both arms
- Reject robot and partner actors, which cannot store user preferences
- Evaluate each platform against its own build context
- Exclude development builds
- Bound the tip's requests with a 3s timeout and no retries
- Drop the update:configure success event

* [eas-cli] Rename EAS Update to Expo Update
2026-10-29 11:16:41 -07:00
Gabe Debes a586f0cb68 [build-tools] Support single-device preview sessions (#4733)
* [build-tools] Support single-device preview sessions

* [build-tools] Pin Android session thumbnail capture

* [build-tools] Name session test options

* [build-tools] Remove extra preview documentation

Edited-by: Codex

* [build-tools] Always pin the preview host at startup

Edited-by: Codex

* [build-tools] Only pin previews with a valid known device

Edited-by: Codex

* [build-tools] Keep Appium preview on its selected iOS device

Edited-by: Codex
2026-10-29 11:01:24 -07:00
Kadi Kraman eebfa728a7 [eas-cli] add commands for observe traces and spans (#4772)
* [eas-cli] add Observe span queries and fragment

* [eas-cli] add Observe span fetch, filter, and format helpers

* [eas-cli] add observe:traces command

* [eas-cli] add observe:trace command

* [eas-cli] show request trace spans in observe:session

* [eas-cli] add changeset for Observe traces

* [eas-cli] order the observe span list newest first explicitly

* [eas-cli] strip control characters from observe span text before printing
2026-10-29 15:06:09 +00:00
Stanisław Chmiela bf478c719c [build-tools] Preserve Xcode compiler errors with xcpretty 4.4.7 (#4365)
# Why

xcpretty is what we use to parse build logs and I think there were some improvements in https://github.com/expo/third-party/pull/162 and https://github.com/expo/third-party/pull/170 so I think we should upgrade.

# How

Asked Codex to upgrade and adjust anything we'd need.

> EAS stops `tail` with SIGINT, which rejects `logReaderPromise`. That skips the summary call placed after `await`.
> 
> The new formatter uses `getBuildSummary()` to emit any pending final compiler error. Putting it in `finally` ensures that error is printed even when `tail` is interrupted.

# Test Plan

CI should pass.
2026-10-29 12:55:23 +01:00
Stanisław Chmiela a7fcb5140c [build-tools] Show failed attempts for uncertain Google Play commits (#4660)
* [build-tools] show final Google Play commit rejection

* [build-tools] Append the original API error to uncertain commits

* [build-tools] List failed Google Play commit attempts in order
2026-10-29 11:07:17 +01:00
Stanisław Chmiela f0a7377069 [build-tools] Explain ASC unexpected server errors (#3467)
* [build-tools] Handle ASC server-side unexpected errors (500)

* [build-tools] Link Apple service status in ASC server errors

* [build-tools] make ASC server errors operation independent
2026-10-29 11:07:17 +01:00
Stanisław Chmiela b755469716 [build-tools] Handle ASC missing icon validation errors (#3466)
* [build-tools] Handle ASC missing icon validation errors

* [build-tools] Preserve ASC icon errors and cover missing icon files

* [build-tools] sort combined ASC error imports
2026-10-29 11:07:16 +01:00
Stanisław Chmiela 1830f88603 [build-tools] Handle ASC 90771 missing BG task identifiers (#3465)
* [build-tools] Handle ASC 90771 missing BG task identifiers

* [build-tools] Preserve Apple background-task validation details
2026-10-29 11:07:16 +01:00
Stanisław Chmiela 75f83829d8 [build-tools] Explain ASC authentication failures (#3462)
* [build-tools] Handle ASC NOT_AUTHORIZED with actionable UserFacingError

* [build-tools] use a shared ASC authentication error code
2026-10-29 11:07:15 +01:00
William Grosset 08c92bf937 [eas-cli] Remove the Free plan limit agent guidance experiment (#4757) 2026-10-28 11:13:06 -07:00
Expo CI 1615d36cf9 bump STAGING and PRODUCTION to 27.1.0 in cli-versions.json 2026-10-28 17:18:00 +00:00
Expo CI 88e23aaa09 v27.1.0 2026-10-28 16:52:14 +00:00
Will Schurman 🦦 0a274a6fef [eas-cli] Throw when environment variable pull fails (#4774)
<!-- Add a changeset with `yarn changeset`, or skip the check by labeling the PR with "no changelog". -->

# Why

With protected environment variables (and even regular usage without protected environment variables), we need to prevent the build running when they can't be pulled. Otherwise the build can end up in a unexpected state where env variables are empty or unset.

# How

Re-throw the error when environment variable pulling fails. The original PR that added this (#2495) didn't specify why it was caught and allowed to proceed.

# Test Plan

Before:

```
$ neas build
✔ Select platform › Android

⚠️ Detected that your app uses Expo Go for development, this is not recommended when building production apps.
Learn more
To suppress this warning, set EAS_BUILD_NO_EXPO_GO_WARNING=true.

Resolved "production" environment for the build. Learn more
Failed to pull env variables for environment production from EAS servers
[GraphQL] Entity Not Authorized: Reading this environment variable requires the Release Manager role or higher since it targets exclusively the production environment and thus is considered protected.: Entity not authorized: EnvironmentVariableEntity[d3f35233-c3b7-4ef0-98fd-bc08d576e1db] (viewer = ScopedAccountActorViewerContext[RegularUserViewerContext[b99c08be-7584-4358-b8e4-aef050972708], scopes=expo_account:c344bcd9-c79d-4c0b-96fb-940d947cac42(RUN,VIEW);expo_account:102f030b-3f17-44ad-9472-cf051344224b(RUN,VIEW);expo_account:df3ec58d-d9b7-4f83-afdd-dbdb8258fdbe(VIEW)], action = READ, ruleIndex = -1)
This can possibly be a bug in EAS/EAS CLI. Report it here: https://github.com/expo/eas-cli/issues
✔ Incremented versionCode from 11 to 12.


✔ Using remote Android credentials (Expo server)
```

After:
```
$ neas build
✔ Select platform › Android

⚠️ Detected that your app uses Expo Go for development, this is not recommended when building production apps.
Learn more
To suppress this warning, set EAS_BUILD_NO_EXPO_GO_WARNING=true.

Resolved "production" environment for the build. Learn more
Failed to pull env variables for environment production from EAS servers
You don't have the required permissions to perform this operation.

This can sometimes happen if you are logged in as incorrect user or if the permissions granted during authentication are insufficient to perform the operation.
Run eas whoami to check the user you are logged in as and your permission grant.
Run eas login to change the user or permission grant.

Original error message: Entity Not Authorized: Reading this environment variable requires the Release Manager role or higher since it targets exclusively the production environment and thus is considered protected.: Entity not authorized: EnvironmentVariableEntity[d3f35233-c3b7-4ef0-98fd-bc08d576e1db] (viewer = ScopedAccountActorViewerContext[RegularUserViewerContext[b99c08be-7584-4358-b8e4-aef050972708], scopes=expo_account:c344bcd9-c79d-4c0b-96fb-940d947cac42(RUN,VIEW);expo_account:102f030b-3f17-44ad-9472-cf051344224b(RUN,VIEW);expo_account:df3ec58d-d9b7-4f83-afdd-dbdb8258fdbe(VIEW)], action = READ, ruleIndex = -1)
Request ID: 11ade772-f079-4515-84bc-3c5239bf35b7
```

Note that this ^^ is just the env evaluation for config, but the same function is used in `eas build:dev`, `build:resign`, `build:version:get/set/sync`, `eas config`, and `eas fingerprint:generate`.
2026-10-28 09:03:43 -07:00
Stanisław Chmiela 78f6782970 [build-tools] Handle ASC 90189 as version duplicate (#3461)
# Why

ASC error 90189 arrives after upload creation. The existing duplicate-version handler covers the creation request, so it does not handle this processing failure.

# How

Map error 90189 to the existing duplicate-build UserError. Include Apple’s original descriptions and codes in the public error message and retain the full failed-upload state as `cause`, including errors, warnings, and information messages. Keep the current SDK-version handler. Remove unrelated message edits copied into the old PR.

# Examples
- https://expo.dev/uuid/019cbf7e-e0f8-7212-9b72-37e97d43b7a2
- https://expo.dev/uuid/019cbf7d-28fa-747b-bd36-81f81b8d8d1b
- https://expo.dev/uuid/019cbf7a-b73a-7310-b845-4e2f8c58224c

# Datadog evidence

Checked on 23 October 2026. Count window: 16 October 2026 12:00 UTC to 23 October 2026 12:00 UTC (14:00 Warsaw time). Counts refer to distinct runs or builds with failed phases, not raw log lines.

187 distinct failed runs contain error 90189. In 173 runs, the validation error list has no other code, so it matches this PR’s condition. Mixed validation errors remain outside that condition.

- [Datadog: matching failed-phase logs](https://app.datadoghq.com/logs?query=service%3Aeas-build+build_phase_result%3Afailed+submission_platform%3Aios+%2290189%22&from_ts=1792152000000&to_ts=1792756800000&live=false&stream_sort=desc)
- [Datadog: example failed run or build](https://app.datadoghq.com/logs?query=service%3Aeas-build+job_run_id%3A01a16866-c973-7288-b710-eb556df52e1c&from_ts=1792152000000&to_ts=1792756800000&live=false&stream_sort=desc)

# Test Plan

- `yarn --cwd packages/build-tools jest-unit --runInBand src/steps/functions/__tests__/uploadToAsc.test.ts`
- `yarn --cwd packages/build-tools typecheck`
- Root type checks, lint, and formatting checks passed.
- All 19 focused tests passed. The new test for public error details and cause preservation fails on the previous code and passes with this change.
2026-10-28 14:21:02 +01:00
Szymon Świerk 5757091b33 [eas-cli] support nested workflow calls in local file workflow run (#4769)
* [eas-cli] Collect workflow files referenced by uses jobs

* [eas-cli] Upload referenced workflow files in workflow:run

* [eas-cli] Regenerate GraphQL types
2026-10-28 11:40:21 +01:00
Ash Wu dd6ad17179 [eas-cli] recognize queued workflow runs and report finishedAt only for final runs (#4258)
Signed-off-by: Ash Wu <[email protected]>
2026-10-28 18:01:28 +08:00
Ash Wu 695f567760 [build-tools][worker] keep NPM_TOKEN working on newer pnpm and explain pnpm Node.js mismatches (#4729)
pnpm 10.34.2+ and 11.5.3+ ignore ${NPM_TOKEN} placeholders in a project-level .npmrc (GHSA-3qhv-2rgh-x77r) but still expand them in the npm user config. On EAS Build the NPM_TOKEN credential now goes into the file `npm config get userconfig` reports for the build env (~/.npmrc unless NPM_CONFIG_USERCONFIG points elsewhere) whenever the job has NPM_TOKEN, and the project .npmrc is left to the user. Local builds keep creating the project .npmrc, because the home directory there belongs to the developer. The legacy PREPARE_PROJECT path and the eas/use_npm_token step share one helper.

Projects that pin pnpm 11 through packageManager on a Node 20 image crash on node:sqlite right after pnpm's "requires at least Node.js v22.13" banner. A new user error names the eas.json node value to set or the pnpm version to change. The worker raises the same error when it reinstalls pnpm under a node version pinned in eas.json, instead of the generic "Failed to install pnpm" message: the typed error it threw before never reached the log handlers, and the probe's piped output never reached the log.
2026-10-28 17:19:16 +08:00
Ash Wu 15e2302575 [build-tools] install the repack package with npm in an isolated sandbox (#4728) 2026-10-28 17:10:27 +08:00
Gabe Debes ee4f03d44e [ci] Format the generated changelog before release (#4773) 2026-10-27 19:18:51 -07:00
Expo CI 5e192ecba6 v27.0.0 2026-10-27 22:10:54 +00:00
Gabe DebesandClaude Opus 5.5 864b11effe [eas-cli] Add simulator:logs for iOS sessions (#4545)
* [eas-cli] Add simulator:logs

Read buffered or live logs from a running iOS simulator session through
its preview API, or save the logs artifact once the session has stopped.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* [eas-cli] Use oclif exclusive for simulator:logs --follow and --json

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* [eas-cli] Suggest redirecting --follow to save live simulator logs

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* [eas-cli] Report log source failures while following simulator logs

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* [eas-cli] Close the connection of a rejected simulator preview response

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* [eas-cli] Write simulator log health notices to stderr

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* [eas-cli] Explain that live simulator logs need an iOS session

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-27 15:02:52 -07:00
Gabe DebesandCodex 62df1bae1c [eas-cli] Require explicit simulator-host upload paths (#4683)
* [eas-cli] Require explicit simulator-host upload paths

* [eas-cli] Cover simulator upload path help and filesystem failures

* [eas-cli] Reject host paths for upload ID actions

Keep upload guidance consistent in text and JSON help, and explain local filenames beginning with host:. Add rejection and help regressions.

Co-authored-by: Codex <[email protected]>
2026-10-27 12:34:27 -07:00
187 changed files with 17031 additions and 1429 deletions

No files matched your search

-5
View File
@@ -1,5 +0,0 @@
---
'@expo/build-tools': patch
---
Keep the launched app open when an Appium iOS session starts.
-5
View File
@@ -1,5 +0,0 @@
---
'@expo/build-tools': patch
---
Run Appium through the prepared Full Disk Access helper when available on macOS.
@@ -0,0 +1,5 @@
---
'@expo/build-tools': patch
---
Explain missing background task identifiers reported by App Store Connect.
+5
View File
@@ -0,0 +1,5 @@
---
'@expo/build-tools': patch
---
Explain App Store Connect NOT_AUTHORIZED responses in the shared API client.
+5
View File
@@ -0,0 +1,5 @@
---
'@expo/build-tools': patch
---
Explain App Store Connect UNEXPECTED_ERROR responses in the shared API client.
+5
View File
@@ -0,0 +1,5 @@
---
'@expo/build-tools': patch
---
Explain missing app icons reported by App Store Connect, including codes 90022 and 90023, while preserving Apple’s validation details.
@@ -1,5 +0,0 @@
---
'eas-cli': minor
---
Send the `permissions.account.role` from the build profile to request a role for the build's `EXPO_TOKEN`.
@@ -0,0 +1,5 @@
---
'@expo/build-tools': minor
---
Use single-device previews when the session already has a valid device ID.
@@ -1,5 +0,0 @@
---
'eas-cli': patch
---
Show permission guidance, including `permissions.account.role` in eas.json, when a build request fails with an authorization error.
-5
View File
@@ -1,5 +0,0 @@
---
'eas-cli': patch
---
Print the notice about eas-cli in project dependencies only when stderr is a terminal, so programs that read stderr get the command's error.
-5
View File
@@ -1,5 +0,0 @@
---
'eas-cli': major
---
Write the reason a command failed to stderr, next to the `command failed.` line, instead of to stdout. A program that reads the reason from stdout must read stderr instead.
@@ -0,0 +1,5 @@
---
'eas-cli': minor
---
Add an experiment that suggests Expo Update to coding agents after a build when the Free plan account is within 5 builds of the platform limit.
@@ -0,0 +1,5 @@
---
'@expo/build-tools': patch
---
List failed Google Play commit attempts in order, including network failures, when the outcome is uncertain.
-5
View File
@@ -1,5 +0,0 @@
---
'eas-cli': none
---
Run the GraphQL schema and generated code check on pull requests to any base branch, including stacked pull requests.
@@ -1,5 +0,0 @@
---
'eas-cli': patch
---
Show account roles and credential permission limits in `eas login` when you are already logged in.
@@ -1,5 +0,0 @@
---
'@expo/build-tools': patch
---
Identify the build or application archive when a download fails, and explain when the archive is no longer available.
+5
View File
@@ -0,0 +1,5 @@
---
'eas-cli': minor
---
Add `eas observe:traces` to list request trace spans (or a summary of span names and counts), `eas observe:trace` to display one trace as a span tree, and span rows in the `eas observe:session` timeline.
-5
View File
@@ -1,5 +0,0 @@
---
'@expo/build-tools': patch
---
Run apsd setup in the background without delaying iOS app launch or preview readiness.
@@ -0,0 +1,5 @@
---
'@expo/worker': patch
---
Run package-manager version queries in parallel during worker preparation.
+5
View File
@@ -0,0 +1,5 @@
---
'@expo/worker': patch
---
Start the Xcode version check in the background during worker tool preparation. Apply the Xcode 26.0 upload workaround when the query finishes, without delaying job startup.
@@ -0,0 +1,5 @@
---
'eas-cli': patch
---
Remove the Free plan build limit guidance experiment for coding agents from `eas build`.
-5
View File
@@ -1,5 +0,0 @@
---
'eas-cli': patch
---
Fix simulator control action help routing and show help when a flag is incomplete.
+5
View File
@@ -0,0 +1,5 @@
---
'eas-cli': minor
---
Import ordered action configurations with `eas simulator:control --import` and show progress for each action.
@@ -0,0 +1,5 @@
---
'eas-cli': minor
---
Add searchable interactive simulator controls with session and device details, guided parameters, and action results.
+5
View File
@@ -0,0 +1,5 @@
---
'eas-cli': minor
---
Start simulator sessions from saved settings and apply control actions after readiness.
@@ -0,0 +1,5 @@
---
'@expo/worker': patch
---
Allow jobs to skip installing the CocoaPods cache proxy with EAS_BUILD_DISABLE_COCOAPODS_CACHE_PLUGIN=1.
-5
View File
@@ -1,5 +0,0 @@
---
'@expo/build-tools': patch
---
Handle a device session stopped during startup as normal cleanup instead of reporting a startup error.
-5
View File
@@ -1,5 +0,0 @@
---
'@expo/build-tools': patch
---
Support idle timeouts for iOS web-preview-only sessions, resetting the timer when preview input arrives.
+5
View File
@@ -0,0 +1,5 @@
---
'@expo/build-tools': patch
---
Preserve indented and incomplete Xcode compiler errors in formatted build logs, including the final diagnostic when logging stops.
+49
View File
@@ -2,6 +2,55 @@
This is the log of notable changes to EAS CLI and related packages.
## [27.1.0](https://github.com/expo/eas-cli/releases/tag/v27.1.0) - 2026-10-28
### 🎉 New features
- [eas-cli] Display queued workflow runs: `workflow:run --wait` and `workflow:status` show a run waiting for its concurrency group and the run blocking it, and `workflow:cancel` includes queued runs in its selection list. ([#4258](https://github.com/expo/eas-cli/pull/4258) by [@hSATAC](https://github.com/hSATAC))
- [eas-cli] Upload the workflow files that `uses` jobs reference, including nested ones, when running a local workflow file with `eas workflow:run`. ([#4769](https://github.com/expo/eas-cli/pull/4769) by [@sswrk](https://github.com/sswrk))
### 🐛 Bug fixes
- [build-tools] Explain App Store Connect error 90189 as a duplicate build number. ([#3461](https://github.com/expo/eas-cli/pull/3461) by [@sjchmiela](https://github.com/sjchmiela))
- [eas-cli] Fail the command when EAS CLI cannot pull environment variables from EAS servers, instead of continuing without them. ([#4774](https://github.com/expo/eas-cli/pull/4774) by [@wschurman](https://github.com/wschurman))
- [eas-cli] Format the generated root changelog before committing a release. ([#4773](https://github.com/expo/eas-cli/pull/4773) by [@gwdp](https://github.com/gwdp))
- [build-tools][worker] Put the `NPM_TOKEN` registry credential in the builder's npm user config on EAS Build (`~/.npmrc`, or the file `NPM_CONFIG_USERCONFIG` names), where pnpm 10.34.2+ and 11.5.3+ still expand `${NPM_TOKEN}` (they ignore it in a project-level `.npmrc`). Explain what to change when the project's pnpm version needs a newer Node.js than the build runs, including when eas.json sets `node` or `pnpm`. ([#4729](https://github.com/expo/eas-cli/pull/4729) by [@hSATAC](https://github.com/hSATAC))
- [build-tools] Install `@expo/repack-app` for the `eas/repack` step with npm in a sandbox that sees only `PATH` and its own `HOME`, so the build machine's npm and Yarn configuration cannot break the install, fetch it through the EAS npm cache when the job uses one, and show the installer output in the build log. The step no longer looks the version up separately before installing. When the npm cache fails, the install retries against the public registry like the project install does; the `eas/run_agent` agent CLI install shares the same helper and gains the same retry. ([#4728](https://github.com/expo/eas-cli/pull/4728) by [@hSATAC](https://github.com/hSATAC))
- [eas-cli] Honor the `--non-interactive` flag in `workflow:cancel`; it was parsed but never applied, so automation could hang on the interactive picker. ([#4258](https://github.com/expo/eas-cli/pull/4258) by [@hSATAC](https://github.com/hSATAC))
- [eas-cli] Stop reporting a finish time for workflow runs that have not finished: `workflow:runs` reports `finishedAt` only for runs in a final status. ([#4258](https://github.com/expo/eas-cli/pull/4258) by [@hSATAC](https://github.com/hSATAC))
## [27.0.0](https://github.com/expo/eas-cli/releases/tag/v27.0.0) - 2026-10-27
### 🛠 Breaking changes
- [eas-cli] Write the reason a command failed to stderr, next to the `command failed.` line, instead of to stdout. A program that reads the reason from stdout must read stderr instead. ([#4592](https://github.com/expo/eas-cli/pull/4592) by [@vonovak](https://github.com/vonovak))
### 🎉 New features
- [eas-cli] Send the `permissions.account.role` from the build profile to request a role for the build's `EXPO_TOKEN`. ([#4734](https://github.com/expo/eas-cli/pull/4734) by [@wschurman](https://github.com/wschurman))
- [eas-cli] Add `simulator:logs` to read and follow logs from an iOS simulator session and download saved logs after it stops. ([#4545](https://github.com/expo/eas-cli/pull/4545) by [@gwdp](https://github.com/gwdp))
### 🐛 Bug fixes
- [build-tools] Keep the launched app open when an Appium iOS session starts. ([#4699](https://github.com/expo/eas-cli/pull/4699) by [@gwdp](https://github.com/gwdp))
- [build-tools] Run Appium through the prepared Full Disk Access helper when available on macOS. ([#4622](https://github.com/expo/eas-cli/pull/4622) by [@gwdp](https://github.com/gwdp))
- [eas-cli] Show permission guidance, including `permissions.account.role` in eas.json, when a build request fails with an authorization error. ([#4760](https://github.com/expo/eas-cli/pull/4760) by [@wschurman](https://github.com/wschurman))
- [eas-cli] Print the notice about eas-cli in project dependencies only when stderr is a terminal, so programs that read stderr get the command's error. ([#4591](https://github.com/expo/eas-cli/pull/4591) by [@vonovak](https://github.com/vonovak))
- [eas-cli] Show account roles and credential permission limits in `eas login` when you are already logged in. ([#4759](https://github.com/expo/eas-cli/pull/4759) by [@wschurman](https://github.com/wschurman))
- [build-tools] Identify the build or application archive when a download fails, and explain when the archive is no longer available. ([#4703](https://github.com/expo/eas-cli/pull/4703) by [@gwdp](https://github.com/gwdp))
- [build-tools] Run apsd setup in the background without delaying iOS app launch or preview readiness. ([#4706](https://github.com/expo/eas-cli/pull/4706) by [@gwdp](https://github.com/gwdp))
- [eas-cli] Fix simulator control action help routing and show help when a flag is incomplete. ([#4681](https://github.com/expo/eas-cli/pull/4681) by [@gwdp](https://github.com/gwdp))
- [eas-cli] Require explicit `host:` simulator-host upload paths and report missing local files. ([#4683](https://github.com/expo/eas-cli/pull/4683) by [@gwdp](https://github.com/gwdp))
Missing local absolute paths now require the `host:` prefix. Actions that require upload IDs accept local files and reject host paths with an explanation.
- [build-tools] Handle a device session stopped during startup as normal cleanup instead of reporting a startup error. ([#4716](https://github.com/expo/eas-cli/pull/4716) by [@gwdp](https://github.com/gwdp))
- [build-tools] Support idle timeouts for iOS web-preview-only sessions, resetting the timer when preview input arrives. ([#4731](https://github.com/expo/eas-cli/pull/4731) by [@gwdp](https://github.com/gwdp))
### 🧹 Chores
- [eas-cli] Run the GraphQL schema and generated code check on pull requests to any base branch, including stacked pull requests. ([#4763](https://github.com/expo/eas-cli/pull/4763) by [@wschurman](https://github.com/wschurman))
## [26.0.0](https://github.com/expo/eas-cli/releases/tag/v26.0.0) - 2026-10-26
### 🛠 Breaking changes
+2 -2
View File
@@ -1,4 +1,4 @@
{
"STAGING": "26.0.0",
"PRODUCTION": "26.0.0"
"STAGING": "27.1.0",
"PRODUCTION": "27.1.0"
}
+1 -1
View File
@@ -1,5 +1,5 @@
{
"npmClient": "yarn",
"version": "26.0.0",
"version": "27.1.0",
"$schema": "node_modules/lerna/schemas/lerna-schema.json"
}
+19
View File
@@ -1,5 +1,24 @@
# @expo/build-tools
## 27.1.0
### Patch Changes
- Explain App Store Connect error 90189 as a duplicate build number. ([#3461](https://github.com/expo/eas-cli/pull/3461) by [@sjchmiela](https://github.com/sjchmiela))
- Put the `NPM_TOKEN` registry credential in the builder's npm user config on EAS Build (`~/.npmrc`, or the file `NPM_CONFIG_USERCONFIG` names), where pnpm 10.34.2+ and 11.5.3+ still expand `${NPM_TOKEN}` (they ignore it in a project-level `.npmrc`). Explain what to change when the project's pnpm version needs a newer Node.js than the build runs, including when eas.json sets `node` or `pnpm`. ([#4729](https://github.com/expo/eas-cli/pull/4729) by [@hSATAC](https://github.com/hSATAC))
- Install `@expo/repack-app` for the `eas/repack` step with npm in a sandbox that sees only `PATH` and its own `HOME`, so the build machine's npm and Yarn configuration cannot break the install, fetch it through the EAS npm cache when the job uses one, and show the installer output in the build log. The step no longer looks the version up separately before installing. When the npm cache fails, the install retries against the public registry like the project install does; the `eas/run_agent` agent CLI install shares the same helper and gains the same retry. ([#4728](https://github.com/expo/eas-cli/pull/4728) by [@hSATAC](https://github.com/hSATAC))
## 27.0.0
### Patch Changes
- Keep the launched app open when an Appium iOS session starts. ([#4699](https://github.com/expo/eas-cli/pull/4699) by [@gwdp](https://github.com/gwdp))
- Run Appium through the prepared Full Disk Access helper when available on macOS. ([#4622](https://github.com/expo/eas-cli/pull/4622) by [@gwdp](https://github.com/gwdp))
- Identify the build or application archive when a download fails, and explain when the archive is no longer available. ([#4703](https://github.com/expo/eas-cli/pull/4703) by [@gwdp](https://github.com/gwdp))
- Run apsd setup in the background without delaying iOS app launch or preview readiness. ([#4706](https://github.com/expo/eas-cli/pull/4706) by [@gwdp](https://github.com/gwdp))
- Handle a device session stopped during startup as normal cleanup instead of reporting a startup error. ([#4716](https://github.com/expo/eas-cli/pull/4716) by [@gwdp](https://github.com/gwdp))
- Support idle timeouts for iOS web-preview-only sessions, resetting the timer when preview input arrives. ([#4731](https://github.com/expo/eas-cli/pull/4731) by [@gwdp](https://github.com/gwdp))
## 26.0.0
### Major Changes
+8 -8
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/build-tools",
"version": "26.0.0",
"version": "27.1.0",
"bugs": "https://github.com/expo/eas-cli/issues",
"license": "BUSL-1.1",
"author": "Expo <[email protected]>",
@@ -42,18 +42,18 @@
"dependencies": {
"@expo/config": "55.0.10",
"@expo/config-plugins": "55.0.7",
"@expo/downloader": "26.0.0",
"@expo/eas-build-job": "26.0.0",
"@expo/downloader": "27.1.0",
"@expo/eas-build-job": "27.1.0",
"@expo/env": "^0.4.0",
"@expo/logger": "26.0.0",
"@expo/logger": "27.1.0",
"@expo/package-manager": "1.9.10",
"@expo/plist": "^0.3.5",
"@expo/results": "^1.0.0",
"@expo/spawn-async": "1.7.2",
"@expo/steps": "26.0.0",
"@expo/template-file": "26.0.0",
"@expo/turtle-spawn": "26.0.0",
"@expo/xcpretty": "^4.3.1",
"@expo/steps": "27.1.0",
"@expo/template-file": "27.1.0",
"@expo/turtle-spawn": "27.1.0",
"@expo/xcpretty": "^4.4.7",
"@ngrok/ngrok": "1.7.0",
"@sentry/node": "7.77.0",
"@urql/core": "^6.0.1",
@@ -125,6 +125,31 @@ describe(resolveBuildPhaseErrorAsync, () => {
expect(err.trackingCode).toBeUndefined();
});
it('explains that the pnpm version needs a newer Node.js than the build runs', async () => {
const fakeError = new Error();
const err = await resolveBuildPhaseErrorAsync(
fakeError,
[
'Running "pnpm install --frozen-lockfile" in /home/expo/workingdir/build directory',
'warn: This version of pnpm requires at least Node.js v22.13',
'warn: The current version of Node.js is v20.19.4',
'warn: Visit https://r.pnpm.io/comp to see the list of past pnpm versions with respective Node.js version support.',
'Error [ERR_UNKNOWN_BUILTIN_MODULE]: No such built-in module: node:sqlite',
],
{
job: { platform: Platform.ANDROID } as Job,
phase: BuildPhase.INSTALL_DEPENDENCIES,
env: {},
},
'/fake/path'
);
expect(err.errorCode).toBe('EAS_BUILD_PNPM_UNSUPPORTED_NODE_VERSION_ERROR');
expect(err.message).toBe(
'This build uses a pnpm version that requires Node.js 22.13.0 or newer, but runs Node.js 20.19.4. You can fix it by either:\n- setting "node" to "22.13.0" or a newer version in the build profile in eas.json\n- using a pnpm version that supports Node.js 20.19.4: change "packageManager" in package.json if your project sets it, and set "pnpm" in the build profile in eas.json'
);
expect(err.docsUrl).toBe('https://docs.expo.dev/eas/json/');
});
it('detects xcode line error', async () => {
vol.fromJSON({
'/path/to/xcodelogs.log': originalFs.readFileSync(
@@ -0,0 +1,33 @@
import { errors } from '@expo/eas-build-job';
import nullthrows from 'nullthrows';
import semver from 'semver';
import { ErrorHandler } from './errors.types';
// example log: "warn: This version of pnpm requires at least Node.js v22.13" followed by "warn: The current version of Node.js is v20.19.4"
const PNPM_UNSUPPORTED_NODE_VERSION_REGEXP =
/This version of pnpm requires at least Node\.js v([\d.]+)\n.*The current version of Node\.js is v([\d.]+)/;
function createPnpmUnsupportedNodeVersionError(matchResult: RegExpMatchArray): errors.UserError {
const [, requiredNodeVersion, currentNodeVersion] = matchResult;
const minimumNodeVersion = nullthrows(semver.coerce(requiredNodeVersion)).version;
return new errors.UserError(
'EAS_BUILD_PNPM_UNSUPPORTED_NODE_VERSION_ERROR',
`This build uses a pnpm version that requires Node.js ${minimumNodeVersion} or newer, but runs Node.js ${currentNodeVersion}. You can fix it by either:
- setting "node" to "${minimumNodeVersion}" or a newer version in the build profile in eas.json
- using a pnpm version that supports Node.js ${currentNodeVersion}: change "packageManager" in package.json if your project sets it, and set "pnpm" in the build profile in eas.json`,
{ docsUrl: 'https://docs.expo.dev/eas/json/' }
);
}
export const pnpmUnsupportedNodeVersionErrorHandler: ErrorHandler<errors.UserError> = {
regexp: PNPM_UNSUPPORTED_NODE_VERSION_REGEXP,
createError: createPnpmUnsupportedNodeVersionError,
};
export function detectPnpmUnsupportedNodeVersionError(
output: string
): errors.UserError | undefined {
const match = output.match(PNPM_UNSUPPORTED_NODE_VERSION_REGEXP);
return match ? createPnpmUnsupportedNodeVersionError(match) : undefined;
}
@@ -1,6 +1,7 @@
import { BuildMode, BuildPhase, Platform, Workflow, errors } from '@expo/eas-build-job';
import { ErrorHandler, XCODE_BUILD_PHASE } from './errors.types';
import { pnpmUnsupportedNodeVersionErrorHandler } from './pnpmUnsupportedNodeVersionError';
import UserError = errors.UserError;
@@ -211,6 +212,7 @@ You are seeing this error because either:
return undefined;
},
},
pnpmUnsupportedNodeVersionErrorHandler,
{
platform: Platform.IOS,
phase: XCODE_BUILD_PHASE,
@@ -3,6 +3,7 @@ import { EventEmitter } from 'events';
import spawnAsync from '@expo/spawn-async';
import { ExpoRunFormatter } from '@expo/xcpretty';
import fg from 'fast-glob';
import { vol } from 'memfs';
import { createMockLogger } from '../../__tests__/utils/logger';
import { Sentry } from '../../sentry';
@@ -59,6 +60,47 @@ describe(XcodeBuildLogger, () => {
expect(Sentry.capture).not.toHaveBeenCalled();
});
it('flushes the final incomplete compiler error when the log reader is interrupted', async () => {
const { ExpoRunFormatter: RealFormatter } =
jest.requireActual<typeof import('@expo/xcpretty')>('@expo/xcpretty');
jest.mocked(ExpoRunFormatter.create).mockImplementation(RealFormatter.create);
let rejectReader!: (error: Error) => void;
const spawnPromise = Object.assign(
new Promise<never>((_resolve, reject) => {
rejectReader = reject;
}),
{
child: {
stdout,
kill: () =>
rejectReader(Object.assign(new Error('tail interrupted'), { signal: 'SIGINT' })),
},
}
);
jest.mocked(spawnAsync).mockReturnValue(spawnPromise as any);
const diagnostics =
'/project/First.swift:12:3: error: first compiler error\n' +
' /project/Last.swift:20:4: error: final compiler error\n';
vol.fromJSON({ '/logs/build.log': diagnostics });
const logger = createMockLogger();
const buildLogger = new XcodeBuildLogger(logger, '/project');
await buildLogger.watchLogFiles('/logs');
stdout.emit('data', diagnostics);
await buildLogger.flush();
const output = jest
.mocked(logger.info)
.mock.calls.map(([line]) => String(line))
.join('\n');
expect(output).toContain('first compiler error');
expect(output).toContain('final compiler error');
expect(output).toContain('Last.swift:20:4');
expect(output).toContain('2 error(s)');
expect(output.match(/final compiler error/g)).toHaveLength(1);
});
it('falls back to raw logs when the formatter throws', async () => {
const logger = createMockLogger();
await startWatchingAsync(logger);
@@ -4,6 +4,7 @@ import path from 'path';
import { BuildContext } from '../context';
import { Sentry } from '../sentry';
import { NpmCacheRegistryInstallError, isNpmCacheInstallFailure } from '../utils/npmCacheRegistry';
import { PackageManager, findPackagerRootDir } from '../utils/packageManager';
import { isUsingModernYarnVersion } from '../utils/project';
@@ -196,10 +197,6 @@ export function resolvePackagerDir(ctx: BuildContext<Job>): string {
return packagerRunDir;
}
function isNpmCacheInstallFailure(err: unknown, npmCacheUrl: string): boolean {
return getErrorOutput(err).includes(npmCacheUrl);
}
function isNpmCacheRegistryErrorLine(line: string, npmCacheUrl: string): boolean {
return (
line.includes(npmCacheUrl) &&
@@ -207,24 +204,9 @@ function isNpmCacheRegistryErrorLine(line: string, npmCacheUrl: string): boolean
);
}
function getErrorOutput(err: unknown): string {
if (!(err instanceof Error)) {
return '';
}
const { stdout, stderr } = err as Error & { stdout?: string; stderr?: string };
return [stdout, stderr].filter(Boolean).join('\n');
}
class NpmCacheRegistryNonFatalError extends SystemError {
override name = 'NpmCacheRegistryNonFatalError';
constructor() {
super('Non-fatal npm cache registry error during dependency install');
}
}
class NpmCacheRegistryInstallError extends SystemError {
override name = 'NpmCacheRegistryInstallError';
constructor(cause: unknown) {
super('Failed to install dependencies using npm cache registry', { cause });
}
}
+6 -1
View File
@@ -71,7 +71,12 @@ export async function setupAsync<TJob extends BuildJob>(
}
);
await setUpNpmrcAsync(ctx, ctx.logger);
await setUpNpmrcAsync({
projectTargetDirectory: ctx.buildDirectory,
workingDirectory: ctx.getReactNativeProjectDirectory(),
env: ctx.env,
logger: ctx.logger,
});
if (ctx.job.platform === Platform.IOS && ctx.env.EAS_BUILD_RUNNER === 'eas-build') {
await deleteXcodeEnvLocalIfExistsAsync(ctx as BuildContext<Ios.Job>);
}
+6 -3
View File
@@ -80,9 +80,12 @@ export class XcodeBuildLogger {
this.logger.info(data.toString());
}
});
await this.logReaderPromise;
this.logger.info(formatter.getBuildSummary());
try {
await this.logReaderPromise;
} finally {
// flush() interrupts tail, but the formatter may still hold a final compiler diagnostic.
this.logger.info(formatter.getBuildSummary());
}
} catch (err: any) {
if (!this.flushing) {
this.loggerError = err;
+1
View File
@@ -34,6 +34,7 @@ export { formatSecondsForLog } from './utils/formatDuration';
export { findAndUploadXcodeBuildLogsAsync } from './ios/xcodeBuildLogs';
export { Hook, runHookIfPresent } from './utils/hooks';
export { detectPnpmUnsupportedNodeVersionError } from './buildErrors/pnpmUnsupportedNodeVersionError';
export { parseGradleProfile, formatGradleProfileReport } from './android/gradleProfile';
export type { GradleProfileTask } from './android/gradleProfile';
@@ -1,8 +1,10 @@
import { type bunyan } from '@expo/logger';
import turtleSpawnAsync from '@expo/turtle-spawn';
import assert from 'node:assert';
import fg from 'fast-glob';
import { vol } from 'memfs';
import path from 'node:path';
import resolveFrom from 'resolve-from';
import { createGlobalContextMock } from '../../../__tests__/utils/context';
import { createTestAndroidJob, createTestIosJob } from '../../../__tests__/utils/job';
@@ -17,17 +19,100 @@ import {
} from '../repack';
jest.mock('fs');
jest.mock('@expo/spawn-async');
jest.mock('@expo/turtle-spawn', () => ({ __esModule: true, default: jest.fn() }));
jest.mock('@expo/repack-app');
jest.mock('resolve-from', () => jest.fn((_, moduleName) => moduleName));
jest.mock('resolve-from', () => jest.fn(() => '@expo/repack-app'));
jest.mock('../../utils/ios/credentials/manager');
describe(createRepackBuildFunction, () => {
beforeEach(() => {
jest.mocked(turtleSpawnAsync).mockImplementation((async (_command: string, args: string[]) => {
const sandbox = args[args.indexOf('--prefix') + 1];
const packageName = args[args.length - 1].replace(/@[^@/]*$/, '');
vol.fromJSON({
[path.join(sandbox, 'node_modules', packageName, 'package.json')]: JSON.stringify({
version: '2.0.0-next.1',
}),
});
}) as unknown as typeof turtleSpawnAsync);
});
afterEach(() => {
jest.restoreAllMocks();
vol.reset();
});
it('installs the repack package with npm in a sandbox whose env is only PATH and HOME, through the npm cache registry', async () => {
const globalCtx = createGlobalContextMock({
staticContextContent: {
job: {},
},
});
globalCtx.updateEnv({
PATH: '/usr/local/bin:/usr/bin',
EAS_BUILD_NPM_CACHE_URL: 'https://npm-cache.expo.test',
NPM_TOKEN: 'secret',
});
const repack = createRepackBuildFunction();
const repackStep = repack.createBuildStepFromFunctionCall(globalCtx, {
callInputs: {
platform: 'ios',
source_app_path: '/path/to/source_app.ipa',
repack_package: '@scope/fork',
repack_version: 'next',
},
});
const logInfo = jest.spyOn(repackStep.ctx.logger, 'info');
await repackStep.executeAsync();
const [installCall] = jest.mocked(turtleSpawnAsync).mock.calls;
const npmEnv = installCall[2]?.env;
assert(npmEnv);
expect(Object.keys(npmEnv).sort()).toEqual(['HOME', 'PATH']);
expect(npmEnv.PATH).toMatch(/\/usr\/local\/bin:\/usr\/bin$/);
expect(installCall).toEqual([
'npm',
[
'install',
'--prefix',
npmEnv.HOME,
'--no-save',
'--package-lock=false',
'--no-audit',
'--no-fund',
'--no-update-notifier',
'--registry',
'https://npm-cache.expo.test',
'@scope/fork@next',
],
{ env: npmEnv, logger: repackStep.ctx.logger },
]);
expect(logInfo).toHaveBeenCalledWith('Using repack from: @scope/fork@next (2.0.0-next.1)');
expect(resolveFrom).toHaveBeenCalledWith(npmEnv.HOME, '@scope/fork');
});
it('installs the repack package from the default registry when the job has no npm cache', async () => {
const globalCtx = createGlobalContextMock({
staticContextContent: {
job: {},
},
});
globalCtx.updateEnv({ PATH: '/usr/local/bin:/usr/bin' });
const repack = createRepackBuildFunction();
const repackStep = repack.createBuildStepFromFunctionCall(globalCtx, {
callInputs: {
platform: 'ios',
source_app_path: '/path/to/source_app.ipa',
},
});
await repackStep.executeAsync();
const [installCall] = jest.mocked(turtleSpawnAsync).mock.calls;
expect(installCall[1]).not.toContain('--registry');
});
it('should set generated output path for successful repack', async () => {
const repack = createRepackBuildFunction();
const repackStep = repack.createBuildStepFromFunctionCall(
@@ -103,7 +103,7 @@ describe(createRunAgentBuildFunction, () => {
);
const npmEnv = installMock.mock.calls[0][2]!.env!;
const agentEnv = spawnMock.mock.calls[0][2].env!;
expect(Object.keys(npmEnv).sort()).toEqual(['HOME', 'LANG', 'PATH', 'TMPDIR']);
expect(Object.keys(npmEnv).sort()).toEqual(['HOME', 'PATH']);
expect(Object.keys(agentEnv).sort()).toEqual([
'CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC',
'CLAUDE_CODE_OAUTH_TOKEN',
@@ -382,6 +382,29 @@ describe('createStartAppiumRemoteSessionBuildFunction session lifecycle', () =>
);
}
it('passes the existing Android selection to the preview host', async () => {
stopAppium.mockResolvedValue(undefined);
await runSessionAsync(logger);
expect(startDeviceSessionHostAsync).toHaveBeenCalledWith(
expect.anything(),
expect.objectContaining({ previewDeviceId: 'emulator-5554' })
);
});
it('passes the selected iOS preview target without enabling Simulator startup', async () => {
stopAppium.mockResolvedValue(undefined);
const udid = 'AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA';
jest
.mocked(IosSimulatorUtils.getAvailableDevicesAsync)
.mockResolvedValue([{ udid }, { udid: 'BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB' }] as Awaited<
ReturnType<typeof IosSimulatorUtils.getAvailableDevicesAsync>
>);
await runSessionAsync(logger, undefined, BuildRuntimePlatform.DARWIN);
const options = jest.mocked(startDeviceSessionHostAsync).mock.calls[0][1];
expect(options).toHaveProperty('previewDeviceId', udid);
expect(options.iosSimulatorUdid).toBeUndefined();
});
it.each([false, true])(
'preserves preview settings with Simulator startup %s',
async bootSimulator => {
@@ -198,7 +198,10 @@ it('does not delete the edit or publish outputs when commit outcome is unknown',
return [204];
});
const task = submission();
await expect(task.run()).rejects.toBeInstanceOf(SystemError);
const error = await task.run().catch(error => error);
expect(error).toBeInstanceOf(SystemError);
expect((error as Error).message).toContain('HTTP 404');
expect((error as Error).message).toContain('Could not confirm whether Google Play saved');
expect(deleted).toBe(false);
expect(task.setters.every(set => set.mock.calls.length === 0)).toBe(true);
});
@@ -1,7 +1,17 @@
import { UserError } from '@expo/eas-build-job';
import fs from 'fs-extra';
import { createGlobalContextMock } from '../../../__tests__/utils/context';
import { AscApiClient } from '../../utils/ios/AscApiClient';
import { AscApiUtils } from '../../utils/ios/AscApiUtils';
import {
createUploadToAscBuildFunction,
isClosedVersionTrainError,
isInvalidBundleIdentifierError,
isMissingAppIconsError,
isMissingBackgroundTaskIdentifiersError,
isMissingPurposeStringError,
isRedundantBinaryUploadError,
isSdkVersionIssueError,
parseMissingUsageDescriptionKeys,
} from '../uploadToAsc';
@@ -45,6 +55,20 @@ describe(isInvalidBundleIdentifierError, () => {
});
});
describe(isRedundantBinaryUploadError, () => {
it('returns true when all errors are redundant-binary-upload codes', () => {
expect(isRedundantBinaryUploadError([{ code: '90189' }, { code: '90189' }])).toBe(true);
});
it('returns false when any other error code is present', () => {
expect(isRedundantBinaryUploadError([{ code: '90189' }, { code: '90062' }])).toBe(false);
});
it('returns false when there are no errors', () => {
expect(isRedundantBinaryUploadError([])).toBe(false);
});
});
describe(isMissingPurposeStringError, () => {
it('returns true when all errors are missing-purpose-string codes', () => {
expect(isMissingPurposeStringError([{ code: '90683' }, { code: '90683' }])).toBe(true);
@@ -73,6 +97,41 @@ describe(isSdkVersionIssueError, () => {
});
});
describe(isMissingBackgroundTaskIdentifiersError, () => {
it('returns true when all errors are missing BG task identifiers codes', () => {
expect(isMissingBackgroundTaskIdentifiersError([{ code: '90771' }, { code: '90771' }])).toBe(
true
);
});
it('returns false when any other error code is present', () => {
expect(isMissingBackgroundTaskIdentifiersError([{ code: '90771' }, { code: '90062' }])).toBe(
false
);
});
it('returns false when there are no errors', () => {
expect(isMissingBackgroundTaskIdentifiersError([])).toBe(false);
});
});
describe(isMissingAppIconsError, () => {
it.each([['90391', '90713', '90713'], ['90713', '90022', '90023'], ['90022'], ['90023']])(
'recognizes missing-icon validation codes %j',
(...codes) => {
expect(isMissingAppIconsError(codes.map(code => ({ code })))).toBe(true);
}
);
it('returns false when any other error code is present', () => {
expect(isMissingAppIconsError([{ code: '90391' }, { code: '90771' }])).toBe(false);
});
it('returns false when there are no errors', () => {
expect(isMissingAppIconsError([])).toBe(false);
});
});
describe(parseMissingUsageDescriptionKeys, () => {
it('extracts missing UsageDescription keys from ASC messages', () => {
expect(
@@ -110,3 +169,176 @@ describe(parseMissingUsageDescriptionKeys, () => {
).toEqual([]);
});
});
describe(createUploadToAscBuildFunction, () => {
it('keeps Apple duplicate-build details in the public error and the full state as its cause', async () => {
const state = {
state: 'FAILED',
errors: [
{
code: '90189',
description: 'Redundant Binary Upload. Build number 1 was already uploaded.',
},
],
warnings: [{ code: 'WARNING', description: 'Apple warning.' }],
infos: [{ code: 'INFO', description: 'Apple information.' }],
};
await fs.writeFile('/app.ipa', 'ipa');
await fs.writeFile('/key.json', '{}');
jest.spyOn(AscApiUtils, 'loadApiKeyAsync').mockResolvedValue({} as never);
jest.spyOn(AscApiUtils, 'getAppInfoAsync').mockResolvedValue({
data: { attributes: { name: 'App', bundleId: 'com.example.app' } },
} as never);
jest.spyOn(AscApiUtils, 'createBuildUploadAsync').mockResolvedValue({
data: { id: 'upload-id' },
} as never);
jest.spyOn(AscApiUtils, 'commitBuildUploadFileAsync').mockResolvedValue(undefined as never);
jest.spyOn(AscApiClient.prototype, 'postAsync').mockResolvedValue({
data: { id: 'file-id', attributes: { uploadOperations: [] } },
} as never);
jest
.spyOn(AscApiClient.prototype, 'getAsync')
.mockResolvedValueOnce({
data: { attributes: { assetDeliveryState: { state: 'COMPLETE' } } },
} as never)
.mockResolvedValueOnce({ data: { attributes: { state } } } as never);
try {
const step = createUploadToAscBuildFunction().createBuildStepFromFunctionCall(
createGlobalContextMock({ staticContextContent: { job: {} } }),
{
callInputs: {
ipa_path: '/app.ipa',
asc_api_key_path: '/key.json',
apple_app_identifier: 'app-id',
bundle_version: '1',
bundle_short_version: '1.0',
wait_for_processing: true,
},
}
);
const error = await step.executeAsync().catch(error => error);
expect(error).toBeInstanceOf(UserError);
expect(error.errorCode).toBe('EAS_UPLOAD_TO_ASC_VERSION_DUPLICATE');
expect(error.cause).toEqual(state);
expect(error.toExternalExpoError().message).toContain(
'Redundant Binary Upload. Build number 1 was already uploaded. (90189)'
);
} finally {
jest.restoreAllMocks();
}
});
});
describe(createUploadToAscBuildFunction, () => {
it('keeps Apple background-task details in the public error and the full state as its cause', async () => {
const state = {
state: 'FAILED',
errors: [
{
code: '90771',
description:
'Missing BGTaskSchedulerPermittedIdentifiers while UIBackgroundModes includes processing.',
},
],
warnings: [{ code: 'WARNING', description: 'Apple warning.' }],
infos: [{ code: 'INFO', description: 'Apple information.' }],
};
await fs.writeFile('/app.ipa', 'ipa');
await fs.writeFile('/key.json', '{}');
jest.spyOn(AscApiUtils, 'loadApiKeyAsync').mockResolvedValue({} as never);
jest.spyOn(AscApiUtils, 'getAppInfoAsync').mockResolvedValue({
data: { attributes: { name: 'App', bundleId: 'com.example.app' } },
} as never);
jest.spyOn(AscApiUtils, 'createBuildUploadAsync').mockResolvedValue({
data: { id: 'upload-id' },
} as never);
jest.spyOn(AscApiUtils, 'commitBuildUploadFileAsync').mockResolvedValue(undefined as never);
jest.spyOn(AscApiClient.prototype, 'postAsync').mockResolvedValue({
data: { id: 'file-id', attributes: { uploadOperations: [] } },
} as never);
jest
.spyOn(AscApiClient.prototype, 'getAsync')
.mockResolvedValueOnce({
data: { attributes: { assetDeliveryState: { state: 'COMPLETE' } } },
} as never)
.mockResolvedValueOnce({ data: { attributes: { state } } } as never);
try {
const step = createUploadToAscBuildFunction().createBuildStepFromFunctionCall(
createGlobalContextMock({ staticContextContent: { job: {} } }),
{
callInputs: {
ipa_path: '/app.ipa',
asc_api_key_path: '/key.json',
apple_app_identifier: 'app-id',
bundle_version: '1',
bundle_short_version: '1.0',
wait_for_processing: true,
},
}
);
const error = await step.executeAsync().catch(error => error);
expect(error).toBeInstanceOf(UserError);
expect(error.errorCode).toBe('EAS_UPLOAD_TO_ASC_MISSING_BG_TASK_IDENTIFIERS');
expect(error.cause).toEqual(state);
expect(error.toExternalExpoError().message).toContain(
'Missing BGTaskSchedulerPermittedIdentifiers while UIBackgroundModes includes processing. (90771)'
);
} finally {
jest.restoreAllMocks();
}
});
});
describe(createUploadToAscBuildFunction, () => {
it('keeps Apple validation details in the public error and the full state as its cause', async () => {
const state = {
state: 'FAILED',
errors: [{ code: '90713', description: 'Missing CFBundleIconName in Watch.app.' }],
warnings: [{ code: 'WARNING', description: 'Apple warning.' }],
infos: [{ code: 'INFO', description: 'Apple information.' }],
};
await fs.writeFile('/app.ipa', 'ipa');
await fs.writeFile('/key.json', '{}');
jest.spyOn(AscApiUtils, 'loadApiKeyAsync').mockResolvedValue({} as never);
jest.spyOn(AscApiUtils, 'getAppInfoAsync').mockResolvedValue({
data: { attributes: { name: 'App', bundleId: 'com.example.app' } },
} as never);
jest.spyOn(AscApiUtils, 'createBuildUploadAsync').mockResolvedValue({
data: { id: 'upload-id' },
} as never);
jest.spyOn(AscApiUtils, 'commitBuildUploadFileAsync').mockResolvedValue(undefined as never);
jest.spyOn(AscApiClient.prototype, 'postAsync').mockResolvedValue({
data: { id: 'file-id', attributes: { uploadOperations: [] } },
} as never);
jest
.spyOn(AscApiClient.prototype, 'getAsync')
.mockResolvedValueOnce({
data: { attributes: { assetDeliveryState: { state: 'COMPLETE' } } },
} as never)
.mockResolvedValueOnce({ data: { attributes: { state } } } as never);
try {
const step = createUploadToAscBuildFunction().createBuildStepFromFunctionCall(
createGlobalContextMock({ staticContextContent: { job: {} } }),
{
callInputs: {
ipa_path: '/app.ipa',
asc_api_key_path: '/key.json',
apple_app_identifier: 'app-id',
bundle_version: '1',
bundle_short_version: '1.0',
wait_for_processing: true,
},
}
);
const error = await step.executeAsync().catch(error => error);
expect(error).toBeInstanceOf(UserError);
expect(error.errorCode).toBe('EAS_UPLOAD_TO_ASC_MISSING_APP_ICONS');
expect(error.cause).toEqual(state);
expect(error.toExternalExpoError().message).toContain(
'Missing CFBundleIconName in Watch.app. (90713)'
);
} finally {
jest.restoreAllMocks();
}
});
});
@@ -0,0 +1,39 @@
import spawn from '@expo/turtle-spawn';
import { vol } from 'memfs';
import { createGlobalContextMock } from '../../../__tests__/utils/context';
import { NpmrcAuthTokenLine } from '../../../templates/npmrc';
import { createSetUpNpmrcBuildFunction } from '../useNpmToken';
jest.mock('fs');
jest.mock('@expo/turtle-spawn', () => ({ __esModule: true, default: jest.fn() }));
const projectTargetDirectory = '/workingdir/project';
const homeDirectory = '/home/expo';
describe(createSetUpNpmrcBuildFunction, () => {
beforeEach(async () => {
vol.reset();
await vol.promises.mkdir(projectTargetDirectory, { recursive: true });
await vol.promises.mkdir(homeDirectory, { recursive: true });
jest.mocked(spawn).mockResolvedValue({ stdout: `${homeDirectory}/.npmrc\n` } as never);
});
afterEach(() => {
jest.restoreAllMocks();
});
it('adds the NPM_TOKEN placeholder from the step env to ~/.npmrc on EAS Build', async () => {
const globalCtx = createGlobalContextMock({ projectTargetDirectory });
globalCtx.updateEnv({ NPM_TOKEN: 'npm_secret_token', EAS_BUILD_RUNNER: 'eas-build' });
const step = createSetUpNpmrcBuildFunction().createBuildStepFromFunctionCall(globalCtx, {
callInputs: {},
});
await step.executeAsync();
expect(await vol.promises.readFile(`${homeDirectory}/.npmrc`, 'utf8')).toContain(
NpmrcAuthTokenLine
);
});
});
@@ -23,7 +23,7 @@ import resolveFrom from 'resolve-from';
import { COMMON_FASTLANE_ENV } from '../../common/fastlane';
import IosCredentialsManager from '../utils/ios/credentials/manager';
import { resolvePackageVersionAsync } from '../../utils/packageManager';
import { installIsolatedNpmPackageAsync } from '../../utils/installIsolatedNpmPackageAsync';
export function createRepackBuildFunction(): BuildFunction {
return new BuildFunction({
@@ -121,18 +121,12 @@ export function createRepackBuildFunction(): BuildFunction {
: undefined;
const jsBundleOnly = (inputs.js_bundle_only.value as boolean | undefined) ?? false;
const resolvedRepackVersion =
(await resolvePackageVersionAsync({
logger: stepsCtx.logger,
packageName: inputs.repack_package.value as string,
distTag: inputs.repack_version.value as string,
})) ?? (inputs.repack_version.value as string);
stepsCtx.logger.info(
`Using repack from: ${inputs.repack_package.value}@${inputs.repack_version.value} (${resolvedRepackVersion})`
);
const repackApp = await installAndImportRepackAsync({
packageName: inputs.repack_package.value as string,
version: resolvedRepackVersion,
versionSpec: inputs.repack_version.value as string,
pathEnv: env.PATH,
npmCacheUrl: env.EAS_BUILD_NPM_CACHE_URL,
logger: stepsCtx.logger,
});
const { repackAppIosAsync, repackAppAndroidAsync } = repackApp;
@@ -226,16 +220,28 @@ function createOutputPath({
*/
async function installAndImportRepackAsync({
packageName,
version,
versionSpec,
pathEnv,
npmCacheUrl,
logger,
}: {
packageName: string;
version: string;
versionSpec: string;
pathEnv: string | undefined;
npmCacheUrl: string | undefined;
logger: bunyan;
}): Promise<typeof import('@expo/repack-app')> {
const sandbox = await fs.promises.mkdtemp(path.join(os.tmpdir(), `repack-package-root-`));
await spawnAsync('yarn', ['add', `${packageName}@${version}`], {
stdio: 'inherit',
cwd: sandbox,
await installIsolatedNpmPackageAsync({
packageSpec: `${packageName}@${versionSpec}`,
directory: sandbox,
npmCacheUrl,
pathEnv,
logger,
});
const packageJsonPath = path.join(sandbox, 'node_modules', packageName, 'package.json');
const { version } = JSON.parse(await fs.promises.readFile(packageJsonPath, 'utf8'));
logger.info(`Using repack from: ${packageName}@${versionSpec} (${version})`);
return require(resolveFrom(sandbox, packageName));
}
@@ -157,6 +157,7 @@ export function createStartAppiumRemoteSessionBuildFunction(
const startHost = () =>
startDeviceSessionHostAsync(ctx, {
...iosStartup,
previewDeviceId: device.udid,
separateLogPhase: true,
runtimePlatform,
env,
@@ -276,8 +277,7 @@ export function createStartAppiumRemoteSessionBuildFunction(
logger,
});
// expo-device-hub has no serial-selection flag. Device run session workflows must expose
// a single booted Android emulator so the Hub and Appium resolve the same device.
// The preview host uses the same device selected for Appium.
const launchDescription = describeServeSimLaunch(launch);
if (launchDescription) {
logger.info(launchDescription);
@@ -262,6 +262,45 @@ export function createUploadToAscBuildFunction(): BuildFunction {
}
);
}
if (isRedundantBinaryUploadError(errors)) {
throw new UserError(
'EAS_UPLOAD_TO_ASC_VERSION_DUPLICATE',
`Increment Build Number: Build number ${bundleVersion} for app version ${bundleShortVersion} has already been used. ` +
'App Store Connect requires unique build numbers within each app version (version train). ' +
'Increment it by setting ios.buildNumber in app.json, or set "autoIncrement": true in eas.json (recommended). Then rebuild and resubmit.' +
`\n\nApp Store Connect errors:\n${itemizeMessages(errors)}`,
{
docsUrl: 'https://docs.expo.dev/build-reference/app-versions/',
cause: state,
}
);
}
if (isMissingBackgroundTaskIdentifiersError(errors)) {
throw new UserError(
'EAS_UPLOAD_TO_ASC_MISSING_BG_TASK_IDENTIFIERS',
'Build upload was rejected by App Store Connect because Info.plist is missing `BGTaskSchedulerPermittedIdentifiers` while `UIBackgroundModes` includes `processing`. ' +
'In an Expo project, add `BGTaskSchedulerPermittedIdentifiers` to `ios.infoPlist` in your app config and include every background task identifier the app schedules. ' +
'If you do not use Continuous Native Generation (CNG), add the same key to the native target Info.plist. Then rebuild and submit again.' +
`\n\nApp Store Connect errors:\n${itemizeMessages(errors)}`,
{
docsUrl: 'https://docs.expo.dev/versions/latest/config/app/#infoplist',
cause: state,
}
);
}
if (isMissingAppIconsError(errors)) {
throw new UserError(
'EAS_UPLOAD_TO_ASC_MISSING_APP_ICONS',
'Build upload was rejected by App Store Connect because required app icons are missing or misconfigured in one of the iOS bundles. ' +
'In an Expo project, check your icon config (`expo.icon`, `ios.icon`) and any custom native targets or plugins that create extra bundles, such as watch extensions. ' +
'Make sure the affected target has the required icon assets and Info.plist icon keys (for example `CFBundleIconName` / `CFBundleIconFiles`), then rebuild and submit again.' +
`\n\nApp Store Connect errors:\n${itemizeMessages(errors)}`,
{
docsUrl: 'https://docs.expo.dev/develop/user-interface/splash-screen-and-app-icon/',
cause: state,
}
);
}
if (isInvalidBundleIdentifierError(errors)) {
const ipaInfoResult = await asyncResult(readIpaInfoAsync(ipaPath));
const ipaBundleIdentifier = ipaInfoResult.ok
@@ -344,6 +383,21 @@ export function isSdkVersionIssueError(messages: { code: string }[]): boolean {
return messages.length > 0 && messages.every(message => message.code === '90725');
}
export function isRedundantBinaryUploadError(messages: { code: string }[]): boolean {
return messages.length > 0 && messages.every(message => message.code === '90189');
}
export function isMissingBackgroundTaskIdentifiersError(messages: { code: string }[]): boolean {
return messages.length > 0 && messages.every(message => message.code === '90771');
}
export function isMissingAppIconsError(messages: { code: string }[]): boolean {
return (
messages.length > 0 &&
messages.every(message => ['90022', '90023', '90391', '90713'].includes(message.code))
);
}
export function isInvalidBundleIdentifierError(messages: { code: string }[]): boolean {
return (
messages.length > 0 && messages.every(message => ['90054', '90055'].includes(message.code))
@@ -1,9 +1,6 @@
import { BuildFunction } from '@expo/steps';
import fs from 'fs-extra';
import path from 'path';
import { NpmrcTemplate } from '../../templates/npmrc';
import { findPackagerRootDir } from '../../utils/packageManager';
import { setUpNpmrcAsync } from '../../utils/npmrc';
export function createSetUpNpmrcBuildFunction(): BuildFunction {
return new BuildFunction({
@@ -12,28 +9,12 @@ export function createSetUpNpmrcBuildFunction(): BuildFunction {
name: 'Use NPM_TOKEN',
__metricsId: 'eas/use_npm_token',
fn: async (stepCtx, { env }) => {
const { logger } = stepCtx;
if (env.NPM_TOKEN) {
logger.info('We detected that you set the NPM_TOKEN environment variable');
const projectNpmrcPath = path.join(stepCtx.global.projectTargetDirectory, '.npmrc');
if (await fs.pathExists(projectNpmrcPath)) {
logger.info('.npmrc already exists in your project directory, skipping generation');
} else {
logger.info('Creating .npmrc in your project directory with the following contents:');
logger.info(NpmrcTemplate);
await fs.writeFile(projectNpmrcPath, NpmrcTemplate);
}
} else {
const projectNpmrcPath = path.join(findPackagerRootDir(stepCtx.workingDirectory), '.npmrc');
if (await fs.pathExists(projectNpmrcPath)) {
logger.info(
`.npmrc found at ${path.relative(
stepCtx.global.projectTargetDirectory,
projectNpmrcPath
)}`
);
}
}
await setUpNpmrcAsync({
projectTargetDirectory: stepCtx.global.projectTargetDirectory,
workingDirectory: stepCtx.workingDirectory,
env,
logger: stepCtx.logger,
});
},
});
}
@@ -186,6 +186,7 @@ describe(runAgentAsync, () => {
'--package-lock=false',
'--no-audit',
'--no-fund',
'--no-update-notifier',
'--registry',
'https://npm-cache.expo.test',
'@anthropic-ai/[email protected]',
@@ -24,6 +24,7 @@ import {
uploadDeviceRunSessionScreenRecordingsAsync,
} from '../deviceRunSessionScreenRecordings';
import {
captureDeviceRunSessionPreviewAsync,
ensureMacosPreviewEncoderInstalledAsync,
startDeviceRunSessionPreview,
} from '../deviceRunSessionPreview';
@@ -68,6 +69,7 @@ jest.mock('../remoteDeviceRunSession', () => ({
jest.mock('../deviceRunSessionPreview', () => ({
...jest.requireActual('../deviceRunSessionPreview'),
ensureMacosPreviewEncoderInstalledAsync: jest.fn(),
captureDeviceRunSessionPreviewAsync: jest.fn(),
startDeviceRunSessionPreview: jest.fn(),
}));
jest.mock('../deviceRunSessionScreenRecordings', () => ({
@@ -191,6 +193,91 @@ afterEach(async () => {
);
});
it.each([undefined, '', 'invalid serial', 'all', 'booted'])(
'starts Hub without adding a device restriction for %j',
async previewDeviceId => {
const host = await startDeviceSessionHostAsync(ctx, {
runtimePlatform: BuildRuntimePlatform.LINUX,
env,
logger,
timeoutMs: 10_000,
previewDeviceId,
});
try {
expect(jest.mocked(spawnDetached).mock.calls[0][0].args).not.toContain('--single-device');
} finally {
await host.finishAsync();
}
}
);
it('uses the supplied Android serial for Hub and thumbnails without selecting another device', async () => {
jest.mocked(turtleFetch).mockResolvedValue({
ok: true,
json: async () => ({ status: 'ready', device: 'no-device-id' }),
} as Awaited<ReturnType<typeof turtleFetch>>);
const host = await startDeviceSessionHostAsync(ctx, {
runtimePlatform: BuildRuntimePlatform.LINUX,
env,
logger,
timeoutMs: 10_000,
previewDeviceId: 'emulator-5556',
});
try {
const args = jest.mocked(spawnDetached).mock.calls[0][0].args;
expect(
args.slice(args.indexOf('--single-device'), args.indexOf('--single-device') + 2)
).toEqual(['--single-device', 'emulator-5556']);
await new Promise(resolve => setImmediate(resolve));
await jest
.mocked(startDeviceRunSessionPreview)
.mock.calls[0][0].captureAsync(new AbortController().signal);
expect(captureDeviceRunSessionPreviewAsync).toHaveBeenCalledWith(
expect.objectContaining({ device: 'emulator-5556' })
);
} finally {
await host.finishAsync();
}
});
it('pins an already-booted iOS preview without taking over boot or setup', async () => {
const udid = 'AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA';
jest.mocked(turtleFetch).mockResolvedValue({
ok: true,
json: async () => ({ status: 'ready', device: udid }),
} as Awaited<ReturnType<typeof turtleFetch>>);
const host = await startDeviceSessionHostAsync(ctx, {
runtimePlatform: BuildRuntimePlatform.DARWIN,
env,
logger,
timeoutMs: 10_000,
previewDeviceId: udid,
});
try {
const args = jest.mocked(spawnDetached).mock.calls[0][0].args;
expect(
args.slice(args.indexOf('--single-device'), args.indexOf('--single-device') + 2)
).toEqual(['--single-device', udid]);
expect(IosSimulatorUtils.disableApsdAsync).not.toHaveBeenCalled();
expect(runServeSimActionAsync).not.toHaveBeenCalled();
} finally {
await host.finishAsync();
}
});
it('rejects readiness on a different Simulator from the selected preview target', async () => {
await expect(
startDeviceSessionHostAsync(ctx, {
runtimePlatform: BuildRuntimePlatform.DARWIN,
env,
logger,
timeoutMs: 10_000,
previewDeviceId: 'AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA',
})
).rejects.toThrow('but this session requested AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA');
expect(stopServer).toHaveBeenCalled();
});
it('targets the selected Simulator in the serve-sim invocation', () => {
expect(createServeSimArgs({ port: 4321, iosSimulatorUdid: 'session-udid' }).slice(0, 4)).toEqual([
'@expo/serve-sim@latest',
@@ -530,6 +530,22 @@ describe(describeServeSimLaunch, () => {
});
});
it('only pins hosts when a valid device ID is supplied', () => {
const udid = 'AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA';
expect(createServeSimArgs({ port: 4321, iosSimulatorUdid: udid })).toEqual(
expect.arrayContaining(['--single-device', udid])
);
for (const iosSimulatorUdid of [undefined, '', 'booted', 'iPhone 17']) {
expect(createServeSimArgs({ port: 4321, iosSimulatorUdid })).not.toContain('--single-device');
}
expect(createExpoDeviceHubArgs({ port: 4321, device: 'emulator-5554' })).toEqual(
expect.arrayContaining(['--single-device', 'emulator-5554'])
);
for (const device of [undefined, '', 'all', 'booted', 'invalid serial']) {
expect(createExpoDeviceHubArgs({ port: 4321, device })).not.toContain('--single-device');
}
});
describe(createServeSimArgs, () => {
it('uses the latest Expo package and applies the EAS streaming policy', () => {
expect(
@@ -1,6 +1,5 @@
import { SystemError, UserError } from '@expo/eas-build-job';
import { type bunyan } from '@expo/logger';
import turtleSpawn from '@expo/turtle-spawn';
import { spawn } from 'node:child_process';
import { once } from 'node:events';
import fs from 'node:fs/promises';
@@ -13,6 +12,7 @@ import { type AgentCli, type AgentInvocation, type AgentLogMessage } from './age
import { CLAUDE_CODE_CLI, prepareClaudeCodeAsync } from './agents/claude';
import { CODEX_CLI, prepareCodexAsync } from './agents/codex';
import { Sentry } from '../../sentry';
import { installIsolatedNpmPackageAsync } from '../../utils/installIsolatedNpmPackageAsync';
import { killProcessGroup } from '../../utils/processes';
export type AgentKind = 'claude-code' | 'codex';
@@ -76,17 +76,13 @@ export async function runAgentAsync({
const { packageSpec, bin, formatOutputLine } = AGENT_CLIS[agentKind];
logger.info(`Installing ${packageSpec}.`);
try {
await turtleSpawn(
'npm',
[
'install',
...['--prefix', cliDirectory],
...['--no-save', '--package-lock=false', '--no-audit', '--no-fund'],
...(npmCacheUrl ? ['--registry', npmCacheUrl] : []),
packageSpec,
],
{ env: minimalEnv, signal }
);
await installIsolatedNpmPackageAsync({
packageSpec,
directory: cliDirectory,
npmCacheUrl,
pathEnv,
signal,
});
} catch (error) {
signal.throwIfAborted();
throw new SystemError(
@@ -144,6 +144,7 @@ export namespace GooglePlayUtils {
signal?: AbortSignal;
}
): Promise<void> {
const attempts: unknown[] = [];
const sendCommitAsync = async ({
changesNotSentForReview,
}: {
@@ -161,6 +162,7 @@ export namespace GooglePlayUtils {
throw new SystemError('Google did not confirm the committed edit.');
}
} catch (error) {
attempts.push(...(error instanceof AggregateError ? error.errors : [error]));
if (error instanceof GooglePlayAuthRequestError) {
throw error;
}
@@ -168,8 +170,14 @@ export namespace GooglePlayUtils {
!(error instanceof GooglePlayApiError) ||
GooglePlayApiError.isRetryableStatus(error.status)
) {
const attemptMessages = attempts
.map(
(attempt, index) =>
`${index + 1}. ${attempt instanceof Error ? attempt.message : String(attempt)}`
)
.join('\n');
throw new GooglePlayCommitOutcomeUnknownError(
`Could not confirm whether Google Play saved the release for ${packageName}. Check its release status at https://play.google.com/console/ before submitting again.`,
`Could not confirm whether Google Play saved the release for ${packageName}. Check its release status at https://play.google.com/console/ before submitting again.\n\nCommit attempts:\n${attemptMessages}`,
{ cause: error, metadata: GooglePlayApiError.getErrorMetadata(error) }
);
}
@@ -84,6 +84,41 @@ it.each([408, 429, 503])('retries a transient HTTP %s commit on the same edit',
api().post(`${editPath}:commit`).query({}).reply(200, { id: 'edit' });
await expect(commit()).resolves.toBeUndefined();
});
it('shows failed commit attempts in order across processing, HTTP, and network retries', async () => {
mockToken();
api()
.post(`${editPath}:commit`)
.query({})
.reply(400, { error: { message: pendingUploadMessage } });
api().post(`${editPath}:commit`).query({}).reply(503);
api()
.post(`${editPath}:commit`)
.query({})
.replyWithError(Object.assign(new Error('Lost commit response'), { code: 'ECONNRESET' }));
const message = 'You must let us know whether your app includes any health features.';
api().post(`${editPath}:commit`).query({}).reply(403, { error: { message } });
const error = await commit().catch(error => error);
const mapped = GooglePlayUtils.mapGooglePlayError(error, packageName);
expect(mapped).toBeInstanceOf(GooglePlayCommitOutcomeUnknownError);
expect((mapped as Error).message).toContain(`Google Play request failed (HTTP 403): ${message}`);
expect((mapped as Error).message).toContain('Could not confirm whether Google Play saved');
expect((mapped as Error).message).toContain('https://play.google.com/console/');
expect(mapped).toMatchObject({
metadata: { googlePlayErrorResponse: JSON.stringify({ error: { message } }) },
cause: expect.any(AggregateError),
});
const attempts = (mapped as Error).message.split('Commit attempts:\n')[1]?.split('\n');
expect(attempts).toEqual([
`1. Google Play request failed (HTTP 400): ${pendingUploadMessage}`,
'2. Google Play request failed (HTTP 503).',
'3. Google Play request failed before a response was received.',
`4. Google Play request failed (HTTP 403): ${message}`,
]);
expect(((mapped as Error).cause as AggregateError).errors).toHaveLength(3);
expect(((mapped as Error).cause as AggregateError).errors[1]).toMatchObject({
cause: { code: 'ECONNRESET' },
});
});
it('preserves cancellation before commit is sent', async () => {
const controller = new AbortController();
const reason = new Error('cancelled before commit');
@@ -250,7 +285,9 @@ it('keeps the last Google Play error response when the commit outcome is unknown
.query({})
.times(6)
.reply(503, { error: { message: 'Backend error' } });
await expect(commit()).rejects.toMatchObject({
const error = await commit().catch(error => error);
expect(error.message).toContain('Google Play request failed (HTTP 503): Backend error');
expect(error).toMatchObject({
metadata: {
googlePlayRequestPath: `${editPath}:commit`,
googlePlayErrorResponse: JSON.stringify({ error: { message: 'Backend error' } }),
@@ -55,6 +55,8 @@ import { IosSimulatorUtils, type IosSimulatorUuid } from '../../utils/IosSimulat
import { createStartupTasks } from './startupTasks';
const WEB_PREVIEW_HOST = '127.0.0.1';
const IOS_SIMULATOR_UDID = /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i;
const ANDROID_DEVICE_SERIAL = /^(?!all$|booted$)[A-Za-z0-9][A-Za-z0-9._:-]*$/;
const SERVE_SIM_PACKAGE_NAME = '@expo/serve-sim';
const SERVE_SIM_MAX_DIMENSION = '1600';
const SERVE_SIM_MJPEG_QUALITY = '0.55';
@@ -157,6 +159,9 @@ export function createServeSimArgs({
return [
createServeSimPackageSpec(packageVersion),
...(iosSimulatorUdid ? [iosSimulatorUdid] : []),
...(iosSimulatorUdid && IOS_SIMULATOR_UDID.test(iosSimulatorUdid)
? ['--single-device', iosSimulatorUdid]
: []),
'--port',
String(port),
'--host',
@@ -198,6 +203,7 @@ export function createServeSimArgs({
export function createExpoDeviceHubArgs({
port,
device,
turnArgs = [],
websiteArgs = [],
frameAncestorArgs: frameArgs = [],
@@ -206,6 +212,7 @@ export function createExpoDeviceHubArgs({
recordingDirectory,
}: {
port: number;
device?: string;
turnArgs?: string[];
websiteArgs?: string[];
frameAncestorArgs?: string[];
@@ -215,6 +222,7 @@ export function createExpoDeviceHubArgs({
}): string[] {
return [
createExpoDeviceHubPackageSpec(packageVersion),
...(device && ANDROID_DEVICE_SERIAL.test(device) ? ['--single-device', device] : []),
'--port',
String(port),
'--host',
@@ -387,6 +395,8 @@ type DeviceSessionHostOptions = {
/** Origins whose pages may call the preview host's API, in addition to the website origins. */
corsOrigins?: string[];
iosSimulatorUdid?: string;
/** Selected preview target; does not enable Simulator boot or setup. */
previewDeviceId?: string;
installAppPath?: string;
bootEnv?: Record<string, string>;
application?: Promise<ServeSimApplicationOptions | void>;
@@ -431,6 +441,7 @@ async function startDeviceSessionHostInternalAsync(
signal,
packageVersion,
iosSimulatorUdid,
previewDeviceId,
installAppPath,
application,
onStartupError,
@@ -479,6 +490,10 @@ async function startDeviceSessionHostInternalAsync(
if (isAndroid) {
await ensureFfmpegInstalledOnceAsync({ runtimePlatform, env, logger });
}
const deviceIdPattern = isAndroid ? ANDROID_DEVICE_SERIAL : IOS_SIMULATOR_UDID;
const validPreviewDevice =
previewDeviceId && deviceIdPattern.test(previewDeviceId) ? previewDeviceId : undefined;
const previewDevice = isAndroid ? validPreviewDevice : (iosSimulatorUdid ?? validPreviewDevice);
const recording: AndroidSessionRecording | null = isAndroid
? {
deviceRunSessionId: getDeviceRunSessionIdOrThrow(env),
@@ -506,6 +521,7 @@ async function startDeviceSessionHostInternalAsync(
isAndroid
? createExpoDeviceHubArgs({
port,
device: previewDevice,
turnArgs,
packageVersion,
recordingDirectory: recording?.directory,
@@ -517,7 +533,7 @@ async function startDeviceSessionHostInternalAsync(
port,
turnArgs,
packageVersion,
iosSimulatorUdid,
iosSimulatorUdid: previewDevice,
websiteArgs: websiteOriginArgs(env),
frameAncestorArgs: frameAncestorArgs(frameAncestors),
corsOriginArgs: corsOriginArgs(corsOrigins),
@@ -762,9 +778,9 @@ async function startDeviceSessionHostInternalAsync(
}
logger.info(`Waiting for ${serverName} to become ready.`);
const device = (await readiness).enforceValue();
if (iosSimulatorUdid && device.toLowerCase() !== iosSimulatorUdid.toLowerCase()) {
if (!isAndroid && previewDevice && device.toLowerCase() !== previewDevice.toLowerCase()) {
throw new SystemError(
`serve-sim became ready on ${device}, but this session requested ${iosSimulatorUdid}.`
`serve-sim became ready on ${device}, but this session requested ${previewDevice}.`
);
}
hostReady = true;
@@ -807,7 +823,7 @@ async function startDeviceSessionHostInternalAsync(
captureAsync: signal =>
captureDeviceRunSessionPreviewAsync({
runtimePlatform,
device,
device: previewDevice ?? device,
env,
signal,
}),
@@ -1,4 +1,4 @@
import { UserError } from '@expo/eas-build-job';
import { SystemError, UserError } from '@expo/eas-build-job';
import { bunyan } from '@expo/logger';
import { asyncResult } from '@expo/results';
import * as jose from 'jose';
@@ -617,6 +617,24 @@ export class AscApiClient {
);
if (parsedAscErrorResponse.ok) {
const errors = parsedAscErrorResponse.value.errors.map(ascError => {
if (response.status === 401 && ascError.code === 'NOT_AUTHORIZED') {
return new UserError(
'EAS_ASC_INVALID_AUTH',
'App Store Connect rejected the API authentication credentials. ' +
'Check that the API key is active and belongs to the correct App Store Connect account. ' +
'If the key is stored in EAS credentials, replace or reconfigure it. ' +
'For a local key, check `key_id` and `key`, and `issuer_id` for a team key. Then try again.',
{ cause: ascError, docsUrl: 'https://docs.expo.dev/submit/ios/' }
);
}
if (response.status === 500 && ascError.code === 'UNEXPECTED_ERROR') {
return new SystemError(
'App Store Connect returned an unexpected server error. ' +
'Check Apple’s service status at https://developer.apple.com/system-status/ and verify whether the requested operation completed in App Store Connect before trying again. ' +
'If the error continues, try again later or contact Apple Developer Support.',
{ cause: ascError, trackingCode: 'EAS_ASC_SERVER_ERROR' }
);
}
if (ascError.code === 'FORBIDDEN.REQUIRED_AGREEMENTS_MISSING_OR_EXPIRED') {
return new UserError(
'EAS_ASC_REQUIRED_AGREEMENTS_MISSING_OR_EXPIRED',
@@ -1,4 +1,4 @@
import { UserError } from '@expo/eas-build-job';
import { SystemError, UserError } from '@expo/eas-build-job';
import * as jose from 'jose';
import nock from 'nock';
@@ -85,6 +85,57 @@ describe(AscApiClient, () => {
}
);
it.each([false, true])(
'explains NOT_AUTHORIZED without losing other errors (mixed: %s)',
async mixed => {
const known = { status: '401', code: 'NOT_AUTHORIZED' };
const other = { status: '401', code: 'OTHER_ERROR' };
const scope = nock('https://api.appstoreconnect.apple.com')
.get('/v1/apps/app')
.query(true)
.reply(401, { errors: mixed ? [known, other] : [known] });
const error = await client
.getAsync('/v1/apps/:id', { 'fields[apps]': ['bundleId', 'name'] }, { id: 'app' })
.catch(error => error);
const mapped = mixed ? error.errors[0] : error;
expect(mapped).toBeInstanceOf(UserError);
expect(mapped).toMatchObject({ errorCode: 'EAS_ASC_INVALID_AUTH', cause: known });
if (mixed) {
expect(error).toBeInstanceOf(AggregateError);
expect(error.errors[1]).toBeInstanceOf(AscApiRequestError);
expect(error.errors[1].code).toBe('OTHER_ERROR');
}
expect(scope.isDone()).toBe(true);
}
);
it.each([false, true])(
'explains UNEXPECTED_ERROR without losing other errors (mixed: %s)',
async mixed => {
const known = { status: '500', code: 'UNEXPECTED_ERROR' };
const other = { status: '500', code: 'OTHER_ERROR' };
const scope = nock('https://api.appstoreconnect.apple.com')
.get('/v1/apps/app')
.query(true)
.reply(500, { errors: mixed ? [known, other] : [known] });
const error = await client
.getAsync('/v1/apps/:id', { 'fields[apps]': ['bundleId', 'name'] }, { id: 'app' })
.catch(error => error);
const mapped = mixed ? error.errors[0] : error;
expect(mapped).toBeInstanceOf(SystemError);
expect(mapped).toMatchObject({
trackingCode: 'EAS_ASC_SERVER_ERROR',
cause: known,
});
if (mixed) {
expect(error).toBeInstanceOf(AggregateError);
expect(error.errors[1]).toBeInstanceOf(AscApiRequestError);
expect(error.errors[1].code).toBe('OTHER_ERROR');
}
expect(scope.isDone()).toBe(true);
}
);
it('fetches app info', async () => {
const appId = '1491144534';
const responseFixture = require('./fixtures/apps/get-apps-200.json');
@@ -391,7 +391,9 @@ describe('commitBuildUploadFileAsync', () => {
.reply(status, { errors: [{ code }] });
await expect(
AscApiUtils.commitBuildUploadFileAsync({ client, fileId: 'file', logger })
).rejects.toMatchObject({ status, code });
).rejects.toMatchObject(
code === 'NOT_AUTHORIZED' ? { errorCode: 'EAS_ASC_INVALID_AUTH' } : { status, code }
);
});
it('does not commit when the initial state read fails', async () => {
+3 -1
View File
@@ -1,3 +1,5 @@
export const NpmrcTemplate = `//registry.npmjs.org/:_authToken=\${NPM_TOKEN}
export const NpmrcAuthTokenLine = '//registry.npmjs.org/:_authToken=${NPM_TOKEN}';
export const NpmrcTemplate = `${NpmrcAuthTokenLine}
registry=https://registry.npmjs.org/
`;
@@ -0,0 +1,89 @@
import spawn from '@expo/turtle-spawn';
import { createMockLogger } from '../../__tests__/utils/logger';
import { Sentry } from '../../sentry';
import { installIsolatedNpmPackageAsync } from '../installIsolatedNpmPackageAsync';
jest.mock('@expo/turtle-spawn', () => ({ __esModule: true, default: jest.fn() }));
jest.mock('../../sentry', () => ({ Sentry: { capture: jest.fn() } }));
const spawnMock = jest.mocked(spawn);
const npmCacheUrl = 'https://npm-cache.expo.test';
describe(installIsolatedNpmPackageAsync, () => {
it('retries without the npm cache registry when the install fails against it', async () => {
const logger = createMockLogger();
const cacheFailure = Object.assign(new Error('npm install exited with non-zero code: 1'), {
stderr: `npm error request to ${npmCacheUrl}/@scope%2ffork failed, reason: ECONNREFUSED`,
});
spawnMock.mockRejectedValueOnce(cacheFailure).mockResolvedValueOnce({} as never);
await installIsolatedNpmPackageAsync({
packageSpec: '@scope/fork@next',
directory: '/tmp/sandbox',
npmCacheUrl,
pathEnv: '/usr/bin',
logger,
});
expect(spawnMock).toHaveBeenCalledTimes(2);
expect(spawnMock.mock.calls[0][1]).toEqual(expect.arrayContaining(['--registry', npmCacheUrl]));
expect(spawnMock.mock.calls[1][1]).not.toContain('--registry');
expect(spawnMock.mock.calls[1][2]).toEqual({
env: { PATH: '/usr/bin', HOME: '/tmp/sandbox' },
logger,
});
expect(logger.warn).toHaveBeenCalledWith(
`Failed to install @scope/fork@next using the npm cache registry (${npmCacheUrl}). Retrying without the npm cache registry.`
);
expect(Sentry.capture).toHaveBeenCalledWith(
expect.objectContaining({ name: 'NpmCacheRegistryInstallError', cause: cacheFailure }),
{ level: 'warning', extras: { packageSpec: '@scope/fork@next', npmCacheUrl } }
);
});
it('rethrows an install failure that does not mention the npm cache registry', async () => {
const error = Object.assign(new Error('npm install exited with non-zero code: 1'), {
stderr: 'npm error notarget No matching version found for @scope/fork@next.',
});
spawnMock.mockRejectedValueOnce(error);
await expect(
installIsolatedNpmPackageAsync({
packageSpec: '@scope/fork@next',
directory: '/tmp/sandbox',
npmCacheUrl,
pathEnv: '/usr/bin',
})
).rejects.toBe(error);
expect(spawnMock).toHaveBeenCalledTimes(1);
expect(Sentry.capture).not.toHaveBeenCalled();
});
it('rethrows the cancellation of an install without retrying', async () => {
const controller = new AbortController();
const cancellation = new Error('cancelled');
spawnMock.mockImplementationOnce((() => {
controller.abort(cancellation);
return Promise.reject(
Object.assign(new Error('npm install was killed with SIGTERM'), {
stderr: `npm error request to ${npmCacheUrl}/@scope%2ffork failed`,
})
);
}) as unknown as typeof spawn);
await expect(
installIsolatedNpmPackageAsync({
packageSpec: '@scope/fork@next',
directory: '/tmp/sandbox',
npmCacheUrl,
pathEnv: '/usr/bin',
signal: controller.signal,
})
).rejects.toBe(cancellation);
expect(spawnMock).toHaveBeenCalledTimes(1);
expect(Sentry.capture).not.toHaveBeenCalled();
});
});
@@ -0,0 +1,120 @@
import spawn from '@expo/turtle-spawn';
import { vol } from 'memfs';
import { createMockLogger } from '../../__tests__/utils/logger';
import { NpmrcAuthTokenLine, NpmrcTemplate } from '../../templates/npmrc';
import { setUpNpmrcAsync } from '../npmrc';
jest.mock('fs');
jest.mock('@expo/turtle-spawn', () => ({ __esModule: true, default: jest.fn() }));
const projectTargetDirectory = '/workingdir/build';
const homeDirectory = '/home/expo';
describe(setUpNpmrcAsync, () => {
beforeEach(async () => {
vol.reset();
await vol.promises.mkdir(projectTargetDirectory, { recursive: true });
await vol.promises.mkdir(homeDirectory, { recursive: true });
jest.mocked(spawn).mockResolvedValue({ stdout: `${homeDirectory}/.npmrc\n` } as never);
});
afterEach(() => {
jest.restoreAllMocks();
});
it('adds the NPM_TOKEN placeholder to ~/.npmrc on EAS Build and leaves the project .npmrc alone', async () => {
const projectContents = '//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}\n';
await vol.promises.writeFile(`${projectTargetDirectory}/.npmrc`, projectContents);
await vol.promises.writeFile(`${homeDirectory}/.npmrc`, 'fund=false');
await setUpNpmrcAsync({
projectTargetDirectory,
workingDirectory: projectTargetDirectory,
env: { NPM_TOKEN: 'npm_secret_token', EAS_BUILD_RUNNER: 'eas-build' },
logger: createMockLogger(),
});
expect(await vol.promises.readFile(`${homeDirectory}/.npmrc`, 'utf8')).toBe(
`fund=false\n${NpmrcAuthTokenLine}\n`
);
expect(await vol.promises.readFile(`${projectTargetDirectory}/.npmrc`, 'utf8')).toBe(
projectContents
);
});
it('adds the NPM_TOKEN placeholder to the user config file npm resolves from the build env', async () => {
await vol.promises.mkdir(`${homeDirectory}/npm`, { recursive: true });
jest.mocked(spawn).mockResolvedValueOnce({ stdout: `${homeDirectory}/npm/npmrc\n` } as never);
const env = {
NPM_TOKEN: 'npm_secret_token',
EAS_BUILD_RUNNER: 'eas-build',
NPM_CONFIG_USERCONFIG: '~/npm/npmrc',
};
await setUpNpmrcAsync({
projectTargetDirectory,
workingDirectory: projectTargetDirectory,
env,
logger: createMockLogger(),
});
expect(spawn).toHaveBeenCalledWith(
'npm',
['config', 'get', 'userconfig'],
expect.objectContaining({ cwd: projectTargetDirectory, env })
);
expect(await vol.promises.readFile(`${homeDirectory}/npm/npmrc`, 'utf8')).toBe(
`\n${NpmrcAuthTokenLine}\n`
);
expect(vol.existsSync(`${homeDirectory}/.npmrc`)).toBe(false);
});
it('creates the project .npmrc and leaves the user npmrc alone on local builds', async () => {
await setUpNpmrcAsync({
projectTargetDirectory,
workingDirectory: projectTargetDirectory,
env: { NPM_TOKEN: 'npm_secret_token', EAS_BUILD_RUNNER: 'local-build-plugin' },
logger: createMockLogger(),
});
expect(await vol.promises.readFile(`${projectTargetDirectory}/.npmrc`, 'utf8')).toBe(
NpmrcTemplate
);
expect(vol.existsSync(`${homeDirectory}/.npmrc`)).toBe(false);
});
it('leaves an existing project .npmrc untouched on local builds', async () => {
const existingContents = 'registry=https://registry.example.com/\n';
await vol.promises.writeFile(`${projectTargetDirectory}/.npmrc`, existingContents);
await setUpNpmrcAsync({
projectTargetDirectory,
workingDirectory: projectTargetDirectory,
env: { NPM_TOKEN: 'npm_secret_token', EAS_BUILD_RUNNER: 'local-build-plugin' },
logger: createMockLogger(),
});
expect(await vol.promises.readFile(`${projectTargetDirectory}/.npmrc`, 'utf8')).toBe(
existingContents
);
});
it('reports an existing .npmrc when NPM_TOKEN is not set', async () => {
const logger = createMockLogger();
await vol.promises.writeFile(
`${projectTargetDirectory}/.npmrc`,
'registry=https://registry.example.com/\n'
);
await setUpNpmrcAsync({
projectTargetDirectory,
workingDirectory: projectTargetDirectory,
env: { EAS_BUILD_RUNNER: 'eas-build' },
logger,
});
expect(logger.info).toHaveBeenCalledWith('.npmrc found at .npmrc');
expect(vol.existsSync(`${homeDirectory}/.npmrc`)).toBe(false);
});
});
@@ -1,9 +1,7 @@
import { errors } from '@expo/eas-build-job';
import { type bunyan } from '@expo/logger';
import fs from 'fs-extra';
import { vol } from 'memfs';
import path from 'path';
import semver from 'semver';
import {
PackageManager,
@@ -16,7 +14,6 @@ import {
resolvePackageExec,
resolvePackageInstall,
resolvePackageManager,
resolvePackageVersionAsync,
shouldUseFrozenLockfile,
} from '../packageManager';
@@ -293,33 +290,6 @@ describe(resolvePackageInstall, () => {
});
});
describe(resolvePackageVersionAsync, () => {
const logger = {
debug: jest.fn(),
info: jest.fn(),
warn: jest.fn(),
error: jest.fn(),
} as unknown as bunyan;
it('should resolve version from package name and dist tag', async () => {
const version = await resolvePackageVersionAsync({
logger,
packageName: '@expo/repack-app',
distTag: 'latest',
});
expect(semver.valid(version)).toBeTruthy();
});
it('should return null if version cannot be resolved', async () => {
const version = await resolvePackageVersionAsync({
logger,
packageName: '@expo/repack-app',
distTag: 'nonexistent-dist-tag',
});
expect(version).toBeNull();
});
});
describe(findPackagerRootDir, () => {
beforeEach(() => {
vol.reset();
@@ -0,0 +1,62 @@
import { type bunyan } from '@expo/logger';
import spawn from '@expo/turtle-spawn';
import { NpmCacheRegistryInstallError, isNpmCacheInstallFailure } from './npmCacheRegistry';
import { Sentry } from '../sentry';
export async function installIsolatedNpmPackageAsync({
packageSpec,
directory,
npmCacheUrl,
pathEnv,
logger,
signal,
}: {
packageSpec: string;
directory: string;
npmCacheUrl: string | undefined;
pathEnv: string | undefined;
logger?: bunyan;
signal?: AbortSignal;
}): Promise<void> {
const installAsync = async (registryUrl: string | undefined): Promise<void> => {
await spawn(
'npm',
[
'install',
'--prefix',
directory,
'--no-save',
'--package-lock=false',
'--no-audit',
'--no-fund',
'--no-update-notifier',
...(registryUrl ? ['--registry', registryUrl] : []),
packageSpec,
],
// npm reads the user config in $HOME from any cwd, so the install directory doubles as HOME.
{ env: { PATH: pathEnv, HOME: directory }, logger, signal }
);
};
if (!npmCacheUrl) {
await installAsync(undefined);
return;
}
try {
await installAsync(npmCacheUrl);
} catch (error) {
signal?.throwIfAborted();
if (!isNpmCacheInstallFailure(error, npmCacheUrl)) {
throw error;
}
logger?.warn(
`Failed to install ${packageSpec} using the npm cache registry (${npmCacheUrl}). Retrying without the npm cache registry.`
);
Sentry.capture(new NpmCacheRegistryInstallError(error), {
level: 'warning',
extras: { packageSpec, npmCacheUrl },
});
await installAsync(undefined);
}
}
@@ -0,0 +1,20 @@
import { SystemError } from '@expo/eas-build-job';
export function isNpmCacheInstallFailure(err: unknown, npmCacheUrl: string): boolean {
return getErrorOutput(err).includes(npmCacheUrl);
}
function getErrorOutput(err: unknown): string {
if (!(err instanceof Error)) {
return '';
}
const { stdout, stderr } = err as Error & { stdout?: string; stderr?: string };
return [stdout, stderr].filter(Boolean).join('\n');
}
export class NpmCacheRegistryInstallError extends SystemError {
override name = 'NpmCacheRegistryInstallError';
constructor(cause: unknown) {
super('Failed to install dependencies using npm cache registry', { cause });
}
}
+50 -16
View File
@@ -1,23 +1,56 @@
import { Job } from '@expo/eas-build-job';
import { bunyan } from '@expo/logger';
import spawn from '@expo/turtle-spawn';
import fs from 'fs-extra';
import path from 'path';
import { findPackagerRootDir } from './packageManager';
import { BuildContext } from '../context';
import { NpmrcTemplate } from '../templates/npmrc';
import { NpmrcAuthTokenLine, NpmrcTemplate } from '../templates/npmrc';
export async function setUpNpmrcAsync(ctx: BuildContext<Job>, logger: bunyan): Promise<void> {
if (ctx.env.NPM_TOKEN) {
await createNpmrcIfNotExistsAsync(ctx, logger);
export async function setUpNpmrcAsync({
projectTargetDirectory,
workingDirectory,
env,
logger,
}: {
projectTargetDirectory: string;
workingDirectory: string;
env: Record<string, string | undefined>;
logger: bunyan;
}): Promise<void> {
if (!env.NPM_TOKEN) {
await logIfNpmrcExistsAsync(projectTargetDirectory, workingDirectory, logger);
return;
}
logger.info('We detected that you set the NPM_TOKEN environment variable');
// pnpm 10.34.2+ and 11.5.3+ ignore ${NPM_TOKEN} placeholders in a project-level .npmrc but expand them in ~/.npmrc
if (env.EAS_BUILD_RUNNER === 'eas-build') {
await addNpmTokenToUserNpmrcAsync(workingDirectory, env, logger);
} else {
await logIfNpmrcExistsAsync(ctx, logger);
await createProjectNpmrcIfNotExistsAsync(projectTargetDirectory, logger);
}
}
async function createNpmrcIfNotExistsAsync(ctx: BuildContext<Job>, logger: bunyan): Promise<void> {
logger.info('We detected that you set the NPM_TOKEN environment variable');
const projectNpmrcPath = path.join(ctx.buildDirectory, '.npmrc');
async function addNpmTokenToUserNpmrcAsync(
workingDirectory: string,
env: Record<string, string | undefined>,
logger: bunyan
): Promise<void> {
const userNpmrcPath = (
await spawn('npm', ['config', 'get', 'userconfig'], {
cwd: findPackagerRootDir(workingDirectory),
env,
stdio: 'pipe',
})
).stdout.trim();
logger.info(`Adding "${NpmrcAuthTokenLine}" to ${userNpmrcPath}`);
await fs.appendFile(userNpmrcPath, `\n${NpmrcAuthTokenLine}\n`);
}
async function createProjectNpmrcIfNotExistsAsync(
projectTargetDirectory: string,
logger: bunyan
): Promise<void> {
const projectNpmrcPath = path.join(projectTargetDirectory, '.npmrc');
if (await fs.pathExists(projectNpmrcPath)) {
logger.info('.npmrc already exists in your project directory, skipping generation');
} else {
@@ -27,12 +60,13 @@ async function createNpmrcIfNotExistsAsync(ctx: BuildContext<Job>, logger: bunya
}
}
async function logIfNpmrcExistsAsync(ctx: BuildContext<Job>, logger: bunyan): Promise<void> {
const projectNpmrcPath = path.join(
findPackagerRootDir(ctx.getReactNativeProjectDirectory()),
'.npmrc'
);
async function logIfNpmrcExistsAsync(
projectTargetDirectory: string,
workingDirectory: string,
logger: bunyan
): Promise<void> {
const projectNpmrcPath = path.join(findPackagerRootDir(workingDirectory), '.npmrc');
if (await fs.pathExists(projectNpmrcPath)) {
logger.info(`.npmrc found at ${path.relative(ctx.buildDirectory, projectNpmrcPath)}`);
logger.info(`.npmrc found at ${path.relative(projectTargetDirectory, projectNpmrcPath)}`);
}
}
@@ -1,5 +1,4 @@
import { errors } from '@expo/eas-build-job';
import { type bunyan } from '@expo/logger';
import * as PackageManagerUtils from '@expo/package-manager';
import { type BuildStepEnv } from '@expo/steps';
import spawnAsync from '@expo/turtle-spawn';
@@ -126,34 +125,6 @@ export function resolvePackageInstall(
}
}
/**
* Get the version of a package from the dist-tags.
* Returns null if the version cannot be resolved.
*/
export async function resolvePackageVersionAsync({
logger,
packageName,
distTag,
}: {
logger: bunyan;
packageName: string;
distTag: string;
}): Promise<string | null> {
try {
const { stdout } = await spawnAsync('npm', ['view', packageName, 'dist-tags', '--json'], {
stdio: 'pipe',
});
const distTags = JSON.parse(stdout);
if (distTag in distTags) {
return distTags[distTag];
}
} catch (e: unknown) {
const message = e instanceof Error ? e.message : String(e);
logger.warn(`Unable to resolve version for ${packageName}@${distTag}: ${message}`);
}
return null;
}
export function findPackagerRootDir(currentDir: string): string {
return PackageManagerUtils.resolveWorkspaceRoot(currentDir) ?? currentDir;
}
@@ -1,5 +1,13 @@
# create-eas-build-function
## 27.1.0
No changes in this release.
## 27.0.0
No changes in this release.
## 26.0.0
No changes in this release.
@@ -1,6 +1,6 @@
{
"name": "create-eas-build-function",
"version": "26.0.0",
"version": "27.1.0",
"description": "Create functions for use in EAS Build custom builds.",
"keywords": [
"expo",
@@ -35,7 +35,7 @@
"clean": "rimraf ./build/ \"*.tsbuildinfo\""
},
"dependencies": {
"@expo/steps": "26.0.0"
"@expo/steps": "27.1.0"
},
"devDependencies": {
"@expo/package-manager": "1.9.10",
+8
View File
@@ -1,5 +1,13 @@
# @expo/downloader
## 27.1.0
No changes in this release.
## 27.0.0
No changes in this release.
## 26.0.0
No changes in this release.
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/downloader",
"version": "26.0.0",
"version": "27.1.0",
"bugs": "https://github.com/expo/eas-cli/issues",
"license": "BUSL-1.1",
"author": "Expo <[email protected]>",
@@ -1,5 +1,13 @@
# eas-build-cache-provider
## 27.1.0
No changes in this release.
## 27.0.0
No changes in this release.
## 26.0.0
No changes in this release.
@@ -1,6 +1,6 @@
{
"name": "eas-build-cache-provider",
"version": "26.0.0",
"version": "27.1.0",
"description": "A build cache provider plugin for the Expo CLI",
"homepage": "https://github.com/expo/eas-cli",
"bugs": "https://github.com/expo/eas-cli/issues",
+8
View File
@@ -1,5 +1,13 @@
# @expo/eas-build-job
## 27.1.0
No changes in this release.
## 27.0.0
No changes in this release.
## 26.0.0
### Major Changes
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@expo/eas-build-job",
"version": "26.0.0",
"version": "27.1.0",
"bugs": "https://github.com/expo/eas-cli/issues",
"license": "MIT",
"author": "Expo <[email protected]>",
@@ -25,9 +25,9 @@
"clean": "rimraf node_modules dist coverage \"*.tsbuildinfo\""
},
"dependencies": {
"@expo/logger": "26.0.0",
"@expo/logger": "27.1.0",
"@expo/results": "1.0.0",
"@expo/turtle-spawn": "26.0.0",
"@expo/turtle-spawn": "27.1.0",
"joi": "^17.13.1",
"semver": "^7.6.2",
"zod": "^4.3.5"
+35
View File
@@ -1,5 +1,40 @@
# eas-cli
## 27.1.0
### Minor Changes
- Display queued workflow runs: `workflow:run --wait` and `workflow:status` show a run waiting for its concurrency group and the run blocking it, and `workflow:cancel` includes queued runs in its selection list. ([#4258](https://github.com/expo/eas-cli/pull/4258) by [@hSATAC](https://github.com/hSATAC))
- Upload the workflow files that `uses` jobs reference, including nested ones, when running a local workflow file with `eas workflow:run`. ([#4769](https://github.com/expo/eas-cli/pull/4769) by [@sswrk](https://github.com/sswrk))
### Patch Changes
- Fail the command when EAS CLI cannot pull environment variables from EAS servers, instead of continuing without them. ([#4774](https://github.com/expo/eas-cli/pull/4774) by [@wschurman](https://github.com/wschurman))
- Format the generated root changelog before committing a release. ([#4773](https://github.com/expo/eas-cli/pull/4773) by [@gwdp](https://github.com/gwdp))
- Honor the `--non-interactive` flag in `workflow:cancel`; it was parsed but never applied, so automation could hang on the interactive picker. ([#4258](https://github.com/expo/eas-cli/pull/4258) by [@hSATAC](https://github.com/hSATAC))
- Stop reporting a finish time for workflow runs that have not finished: `workflow:runs` reports `finishedAt` only for runs in a final status. ([#4258](https://github.com/expo/eas-cli/pull/4258) by [@hSATAC](https://github.com/hSATAC))
## 27.0.0
### Major Changes
- Write the reason a command failed to stderr, next to the `command failed.` line, instead of to stdout. A program that reads the reason from stdout must read stderr instead. ([#4592](https://github.com/expo/eas-cli/pull/4592) by [@vonovak](https://github.com/vonovak))
### Minor Changes
- Send the `permissions.account.role` from the build profile to request a role for the build's `EXPO_TOKEN`. ([#4734](https://github.com/expo/eas-cli/pull/4734) by [@wschurman](https://github.com/wschurman))
- Add `simulator:logs` to read and follow logs from an iOS simulator session and download saved logs after it stops. ([#4545](https://github.com/expo/eas-cli/pull/4545) by [@gwdp](https://github.com/gwdp))
### Patch Changes
- Show permission guidance, including `permissions.account.role` in eas.json, when a build request fails with an authorization error. ([#4760](https://github.com/expo/eas-cli/pull/4760) by [@wschurman](https://github.com/wschurman))
- Print the notice about eas-cli in project dependencies only when stderr is a terminal, so programs that read stderr get the command's error. ([#4591](https://github.com/expo/eas-cli/pull/4591) by [@vonovak](https://github.com/vonovak))
- Show account roles and credential permission limits in `eas login` when you are already logged in. ([#4759](https://github.com/expo/eas-cli/pull/4759) by [@wschurman](https://github.com/wschurman))
- Fix simulator control action help routing and show help when a flag is incomplete. ([#4681](https://github.com/expo/eas-cli/pull/4681) by [@gwdp](https://github.com/gwdp))
- Require explicit `host:` simulator-host upload paths and report missing local files. ([#4683](https://github.com/expo/eas-cli/pull/4683) by [@gwdp](https://github.com/gwdp))
Missing local absolute paths now require the `host:` prefix. Actions that require upload IDs accept local files and reject host paths with an explanation.
## 26.0.0
### Patch Changes
+216 -146
View File
File diff suppressed because it is too large. Load diff
+2217 -3
View File
File diff suppressed because it is too large. Load diff
+5 -5
View File
@@ -1,6 +1,6 @@
{
"name": "eas-cli",
"version": "26.0.0",
"version": "27.1.0",
"description": "EAS command line tool",
"keywords": [
"cli",
@@ -48,12 +48,12 @@
"@expo/code-signing-certificates": "0.0.5",
"@expo/config": "55.0.10",
"@expo/config-plugins": "55.0.7",
"@expo/eas-build-job": "26.0.0",
"@expo/eas-json": "26.0.0",
"@expo/eas-build-job": "27.1.0",
"@expo/eas-json": "27.1.0",
"@expo/env": "^1.0.0",
"@expo/experimentation": "0.0.5",
"@expo/json-file": "8.3.3",
"@expo/logger": "26.0.0",
"@expo/logger": "27.1.0",
"@expo/multipart-body-parser": "2.0.0",
"@expo/osascript": "2.1.4",
"@expo/package-manager": "1.9.10",
@@ -65,7 +65,7 @@
"@expo/results": "1.0.0",
"@expo/rudder-sdk-node": "1.1.1",
"@expo/spawn-async": "1.7.2",
"@expo/steps": "26.0.0",
"@expo/steps": "27.1.0",
"@expo/timeago.js": "1.0.0",
"@oclif/core": "^4.8.3",
"@oclif/plugin-autocomplete": "^3.2.40",
@@ -198,6 +198,28 @@ export function getMockEmptyWorkflowRunsFragment(): WorkflowRunFragment[] {
return getMockWorkflowRunsFragment();
}
export function getMockWorkflowRunFragment(
status: WorkflowRunStatus,
overrides?: Partial<WorkflowRunFragment>
): WorkflowRunFragment {
return {
id: `run-${status}`,
status,
triggerEventType: WorkflowRunTriggerEventType.Manual,
errors: [],
createdAt: '2022-01-01T00:00:00.000Z',
updatedAt: '2022-01-01T00:00:00.000Z',
gitCommitHash: '1234567890',
gitCommitMessage: 'commit message',
workflow: {
name: 'build',
id: 'build',
fileName: 'build.yml',
},
...overrides,
};
}
export function getMockWorkflowRunsFragment(
params?:
| undefined
@@ -240,6 +262,7 @@ export function getMockWorkflowRunsFragment(
status: WorkflowRunStatus.Failure,
createdAt: '2022-01-01T00:00:00.000Z',
updatedAt: '2022-01-01T00:00:00.000Z',
finalizedAt: '2022-01-01T00:00:00.000Z',
gitCommitHash: '1234567890',
gitCommitMessage: 'commit message',
workflow: {
@@ -332,6 +355,7 @@ export function getMockWorkflowRunWithJobsFragment(
id: mockProjectId,
__typename: 'App',
name: 'App',
slug: 'app',
ownerAccount: {
id: 'account-id',
name: 'account-name',
@@ -364,6 +388,7 @@ export function getMockWorkflowRunWithBuildJobsFragment(
id: mockProjectId,
__typename: 'App',
name: 'App',
slug: 'app',
ownerAccount: {
id: 'account-id',
name: 'account-name',
@@ -0,0 +1,88 @@
import {
getMockWorkflowRunFragment,
mockCommandContext,
mockProjectId,
mockTestCommand,
} from './utils';
import WorkflowRunCancel from '../../commands/workflow/cancel';
import { WorkflowRunStatus } from '../../graphql/generated';
import { WorkflowRunMutation } from '../../graphql/mutations/WorkflowRunMutation';
import { AppQuery } from '../../graphql/queries/AppQuery';
import { promptAsync } from '../../prompts';
jest.mock('../../graphql/queries/AppQuery');
jest.mock('../../graphql/mutations/WorkflowRunMutation');
jest.mock('../../log');
jest.mock('../../prompts');
describe(WorkflowRunCancel, () => {
afterEach(() => {
jest.clearAllMocks();
});
test('prompts with in-progress and queued runs and cancels the selected ones', async () => {
const ctx = mockCommandContext(WorkflowRunCancel, {
projectId: mockProjectId,
});
const inProgressRun = getMockWorkflowRunFragment(WorkflowRunStatus.InProgress);
const waitingRun = getMockWorkflowRunFragment(WorkflowRunStatus.Waiting);
jest
.mocked(AppQuery.byIdWorkflowRunsFilteredByStatusAsync)
.mockImplementation(async (_graphqlClient, _appId, status) =>
status === WorkflowRunStatus.InProgress ? [inProgressRun] : [waitingRun]
);
jest.mocked(promptAsync).mockResolvedValueOnce({ selectedRuns: [waitingRun.id] });
const cmd = mockTestCommand(WorkflowRunCancel, [], ctx);
await cmd.run();
expect(AppQuery.byIdWorkflowRunsFilteredByStatusAsync).toHaveBeenCalledWith(
ctx.loggedIn.graphqlClient,
mockProjectId,
WorkflowRunStatus.InProgress,
50
);
expect(AppQuery.byIdWorkflowRunsFilteredByStatusAsync).toHaveBeenCalledWith(
ctx.loggedIn.graphqlClient,
mockProjectId,
WorkflowRunStatus.Waiting,
50
);
const promptCall = jest.mocked(promptAsync).mock.calls[0][0] as any;
expect(promptCall.choices.map((choice: any) => choice.value)).toEqual([
inProgressRun.id,
waitingRun.id,
]);
expect(WorkflowRunMutation.cancelWorkflowRunAsync).toHaveBeenCalledTimes(1);
expect(WorkflowRunMutation.cancelWorkflowRunAsync).toHaveBeenCalledWith(
ctx.loggedIn.graphqlClient,
{ workflowRunId: waitingRun.id }
);
});
test('throws in non-interactive mode when no run IDs are given', async () => {
const ctx = mockCommandContext(WorkflowRunCancel, {
projectId: mockProjectId,
});
const cmd = mockTestCommand(WorkflowRunCancel, ['--non-interactive'], ctx);
await expect(cmd.run()).rejects.toThrow(
'Must supply workflow run IDs as arguments when in non-interactive mode'
);
expect(promptAsync).not.toHaveBeenCalled();
});
test('cancels the given run IDs without prompting in non-interactive mode', async () => {
const ctx = mockCommandContext(WorkflowRunCancel, {
projectId: mockProjectId,
});
const cmd = mockTestCommand(WorkflowRunCancel, ['--non-interactive', 'run-id-1'], ctx);
await cmd.run();
expect(AppQuery.byIdWorkflowRunsFilteredByStatusAsync).not.toHaveBeenCalled();
expect(promptAsync).not.toHaveBeenCalled();
expect(WorkflowRunMutation.cancelWorkflowRunAsync).toHaveBeenCalledTimes(1);
expect(WorkflowRunMutation.cancelWorkflowRunAsync).toHaveBeenCalledWith(
ctx.loggedIn.graphqlClient,
{ workflowRunId: 'run-id-1' }
);
});
});
@@ -142,6 +142,7 @@ describe(WorkflowRunList, () => {
triggerEventType: WorkflowRunTriggerEventType.Manual,
createdAt: '2022-01-01T00:00:00.000Z',
updatedAt: '2022-01-01T00:00:00.000Z',
finalizedAt: '2022-01-01T00:00:00.000Z',
gitCommitHash: '1234567890',
gitCommitMessage: 'commit message',
errors: [],
@@ -70,6 +70,7 @@ export enum BuildEvent {
BUILD_REQUEST_SUCCESS = 'build cli build request success',
BUILD_REQUEST_FAIL = 'build cli build request fail',
FREE_TIER_LIMIT_CHECKOUT_PROMPT = 'build cli free tier limit checkout prompt',
FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP = 'build cli free tier near limit agent updates tip',
BUILD_STATUS_COMMAND = 'build cli build status',
@@ -1,280 +0,0 @@
import type { ExperimentationDefinition } from '@expo/experimentation';
import { Platform } from '@expo/eas-build-job';
import { getAgentTelemetryContext } from '../../analytics/agent';
import { ExperimentOverrides } from '../../experimentation/ExperimentOverrides';
import {
EMPTY_EXPERIMENTATION_DEFINITION,
ExperimentationClient,
createLoggerConfig,
} from '../../experimentation/ExperimentationClient';
import { LazyExperimentationClient } from '../../experimentation/LazyExperimentationClient';
import { createMockAnalytics, findUnitsByValue } from '../../experimentation/__tests__/fixtures';
import {
FREE_TIER_LIMIT_AGENT_GUIDANCE_EXPERIMENT_NAMESPACE,
getFreeTierLimitAgentGuidanceExperiment,
maybeAppendFreeTierLimitAgentGuidanceAsync,
resolveFreeTierLimitAgentGuidanceVariantAsync,
} from '../freeTierLimitGuidance';
jest.mock('../../analytics/agent');
const EXPERIMENT_NAME = 'cli-build-free-tier-limit-agent-guidance';
/** Every account is in the experiment: 50% control, 50% treatment. */
const ACCOUNT_DEFINITION: ExperimentationDefinition = {
experiments: [
{
experimentName: EXPERIMENT_NAME,
paramDefinitions: {
variant: { type: 'uniform_choice', choices: ['control', 'treatment'] },
},
exposureLoggerType: 'rudderstack',
},
],
namespaces: [
{
name: FREE_TIER_LIMIT_AGENT_GUIDANCE_EXPERIMENT_NAMESPACE,
numSegments: 1000,
segmentExperimentSetupDefinitions: [
{
method: 'ADD',
name: `${EXPERIMENT_NAME} full`,
experimentName: EXPERIMENT_NAME,
numSegments: 1000,
},
],
},
],
};
function createClient(): {
client: ExperimentationClient;
analytics: ReturnType<typeof createMockAnalytics>;
} {
const analytics = createMockAnalytics();
const client = new ExperimentationClient(
{
user: EMPTY_EXPERIMENTATION_DEFINITION,
account: ACCOUNT_DEFINITION,
device: EMPTY_EXPERIMENTATION_DEFINITION,
},
{ user: null, device: null },
ExperimentOverrides.empty(),
createLoggerConfig(analytics)
);
return { client, analytics };
}
/** Probes a throwaway client, so the exposures it logs do not affect the client under test. */
function findAccountIdsByVariant(): Map<string, string> {
const { client } = createClient();
return findUnitsByValue(
accountId =>
client.getAccountNamespace(FREE_TIER_LIMIT_AGENT_GUIDANCE_EXPERIMENT_NAMESPACE, {
accountId,
}),
'variant',
'control',
['control', 'treatment']
);
}
describe(getFreeTierLimitAgentGuidanceExperiment, () => {
it('returns the handle when the command has an experimentation client', () => {
const experimentation = new LazyExperimentationClient(async () => createClient().client);
expect(
getFreeTierLimitAgentGuidanceExperiment({ experimentation, accountId: 'account-id' })
).toEqual({ experimentation, accountId: 'account-id' });
});
it('returns undefined when the command has no experimentation client', () => {
expect(getFreeTierLimitAgentGuidanceExperiment({ accountId: 'account-id' })).toBeUndefined();
});
});
describe(resolveFreeTierLimitAgentGuidanceVariantAsync, () => {
const accountIdsByVariant = findAccountIdsByVariant();
const treatmentAccountId = accountIdsByVariant.get('treatment')!;
const controlAccountId = accountIdsByVariant.get('control')!;
beforeEach(() => {
jest.resetAllMocks();
jest
.mocked(getAgentTelemetryContext)
.mockReturnValue({ id: 'claude-code', sessionId: 'session-1' });
});
it('does not load the client when no coding agent runs the CLI', async () => {
jest.mocked(getAgentTelemetryContext).mockReturnValue(null);
const loadAsync = jest.fn(async () => createClient().client);
expect(
await resolveFreeTierLimitAgentGuidanceVariantAsync({
experimentation: new LazyExperimentationClient(loadAsync),
accountId: treatmentAccountId,
})
).toBe('control');
expect(loadAsync).not.toHaveBeenCalled();
});
it('loads the client once across repeated reads', async () => {
const { client, analytics } = createClient();
const loadAsync = jest.fn(async () => client);
const experiment = {
experimentation: new LazyExperimentationClient(loadAsync),
accountId: treatmentAccountId,
};
await resolveFreeTierLimitAgentGuidanceVariantAsync(experiment);
await resolveFreeTierLimitAgentGuidanceVariantAsync(experiment);
expect(loadAsync).toHaveBeenCalledTimes(1);
expect(analytics.logEvent).toHaveBeenCalledTimes(1);
});
it('returns control and logs no exposure when no coding agent runs the CLI', async () => {
jest.mocked(getAgentTelemetryContext).mockReturnValue(null);
const { client, analytics } = createClient();
expect(
await resolveFreeTierLimitAgentGuidanceVariantAsync({
experimentation: LazyExperimentationClient.fromClient(client),
accountId: treatmentAccountId,
})
).toBe('control');
expect(analytics.logEvent).not.toHaveBeenCalled();
});
it('returns the account variant and logs the exposure once when a coding agent runs the CLI', async () => {
const { client, analytics } = createClient();
expect(
await resolveFreeTierLimitAgentGuidanceVariantAsync({
experimentation: LazyExperimentationClient.fromClient(client),
accountId: treatmentAccountId,
})
).toBe('treatment');
expect(
await resolveFreeTierLimitAgentGuidanceVariantAsync({
experimentation: LazyExperimentationClient.fromClient(client),
accountId: treatmentAccountId,
})
).toBe('treatment');
expect(analytics.logEvent).toHaveBeenCalledTimes(1);
expect(analytics.logEvent).toHaveBeenCalledWith('Experiment Viewed', {
experimentName: EXPERIMENT_NAME,
variationName: 'treatment',
unit: treatmentAccountId,
});
});
it('logs the exposure for control accounts too', async () => {
const { client, analytics } = createClient();
expect(
await resolveFreeTierLimitAgentGuidanceVariantAsync({
experimentation: LazyExperimentationClient.fromClient(client),
accountId: controlAccountId,
})
).toBe('control');
expect(analytics.logEvent).toHaveBeenCalledWith('Experiment Viewed', {
experimentName: EXPERIMENT_NAME,
variationName: 'control',
unit: controlAccountId,
});
});
it('returns control and logs no exposure when the namespace is missing from the config', async () => {
const analytics = createMockAnalytics();
const client = new ExperimentationClient(
{
user: EMPTY_EXPERIMENTATION_DEFINITION,
account: EMPTY_EXPERIMENTATION_DEFINITION,
device: EMPTY_EXPERIMENTATION_DEFINITION,
},
{ user: null, device: null },
ExperimentOverrides.empty(),
createLoggerConfig(analytics)
);
expect(
await resolveFreeTierLimitAgentGuidanceVariantAsync({
experimentation: LazyExperimentationClient.fromClient(client),
accountId: treatmentAccountId,
})
).toBe('control');
expect(analytics.logEvent).not.toHaveBeenCalled();
});
});
describe(maybeAppendFreeTierLimitAgentGuidanceAsync, () => {
const treatmentAccountId = findAccountIdsByVariant().get('treatment')!;
beforeEach(() => {
jest.resetAllMocks();
jest
.mocked(getAgentTelemetryContext)
.mockReturnValue({ id: 'claude-code', sessionId: 'session-1' });
});
it('returns the message unchanged and logs no exposure when the command has no experimentation client', async () => {
expect(await maybeAppendFreeTierLimitAgentGuidanceAsync('Error 1', Platform.ANDROID, undefined)).toBe(
'Error 1'
);
});
it('logs the exposure and appends the guidance in the treatment arm', async () => {
const { client, analytics } = createClient();
expect(
await maybeAppendFreeTierLimitAgentGuidanceAsync('Error 1', Platform.IOS, {
experimentation: LazyExperimentationClient.fromClient(client),
accountId: treatmentAccountId,
})
).toBe(
[
'Error 1',
'Fix: Human required: iOS builds for this account are blocked until the Free plan resets. Upgrading costs money, so an account owner or admin decides.',
].join('\n')
);
expect(analytics.logEvent).toHaveBeenCalledTimes(1);
expect(analytics.logEvent).toHaveBeenCalledWith('Experiment Viewed', {
experimentName: EXPERIMENT_NAME,
variationName: 'treatment',
unit: treatmentAccountId,
});
});
it('returns the message unchanged in the control arm', async () => {
const client = ExperimentationClient.createDisabled(
new ExperimentOverrides(
new Map([
[FREE_TIER_LIMIT_AGENT_GUIDANCE_EXPERIMENT_NAMESPACE, new Map([['variant', 'control']])],
])
)
);
expect(
await maybeAppendFreeTierLimitAgentGuidanceAsync('Error 1', Platform.ANDROID, {
experimentation: LazyExperimentationClient.fromClient(client),
accountId: treatmentAccountId,
})
).toBe('Error 1');
});
it('returns the message unchanged and logs no exposure when no coding agent runs the CLI', async () => {
jest.mocked(getAgentTelemetryContext).mockReturnValue(null);
const { client, analytics } = createClient();
expect(
await maybeAppendFreeTierLimitAgentGuidanceAsync('Error 1', Platform.ANDROID, {
experimentation: LazyExperimentationClient.fromClient(client),
accountId: treatmentAccountId,
})
).toBe('Error 1');
expect(analytics.logEvent).not.toHaveBeenCalled();
});
});
@@ -0,0 +1,880 @@
import type { ExperimentationDefinition } from '@expo/experimentation';
import { ExpoConfig } from '@expo/config';
import { getAgentTelemetryContext } from '../../analytics/agent';
import { createGraphqlClient } from '../../commandUtils/context/contextUtils/createGraphqlClient';
import { ExperimentOverrides } from '../../experimentation/ExperimentOverrides';
import {
EMPTY_EXPERIMENTATION_DEFINITION,
ExperimentationClient,
createLoggerConfig,
} from '../../experimentation/ExperimentationClient';
import { LazyExperimentationClient } from '../../experimentation/LazyExperimentationClient';
import { createMockAnalytics, findUnitsByValue } from '../../experimentation/__tests__/fixtures';
import {
AppPlatform,
BuildFragment,
BuildStatus,
EasServiceMetric,
UsageMetricType,
} from '../../graphql/generated';
import { UserPreferenceMutation } from '../../graphql/mutations/UserPreferenceMutation';
import { AccountQuery } from '../../graphql/queries/AccountQuery';
import { UserPreferenceQuery } from '../../graphql/queries/UserPreferenceQuery';
import Log from '../../log';
import { isExpoUpdatesInstalled, isUsingEASUpdate } from '../../project/projectUtils';
import { LoggedInAuthenticationInfo } from '../../user/SessionManager';
import { Actor } from '../../user/User';
import {
FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP_EXPERIMENT_NAMESPACE,
FreeTierNearLimitAgentUpdatesTipExperiment,
FreeTierNearLimitAgentUpdatesTipPlatformProject,
formatFreeTierNearLimitAgentUpdatesTip,
getFreeTierBuildUsageAsync,
getFreeTierNearLimitAgentUpdatesTipExperiment,
getFreeTierNearLimitAgentUpdatesTipPreferenceKey,
isEligibleForFreeTierNearLimitAgentUpdatesTip,
isPlatformEligibleForFreeTierNearLimitAgentUpdatesTip,
isWithinFreeTierNearLimitBand,
maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync,
resolveFreeTierNearLimitAgentUpdatesTipVariantAsync,
} from '../freeTierNearLimitAgentUpdatesTip';
jest.mock('../../analytics/agent');
jest.mock('../../commandUtils/context/contextUtils/createGraphqlClient');
jest.mock('../../graphql/queries/AccountQuery');
jest.mock('../../graphql/queries/UserPreferenceQuery');
jest.mock('../../graphql/mutations/UserPreferenceMutation');
jest.mock('../../project/projectUtils', () => ({
...jest.requireActual('../../project/projectUtils'),
isExpoUpdatesInstalled: jest.fn(),
isUsingEASUpdate: jest.fn(),
}));
const EXPERIMENT_NAME = 'cli-build-free-tier-near-limit-agent-updates-tip';
const ANALYTICS_EVENT_PROPERTIES = { tracking_id: 'tracking-id' };
const EXP = { name: 'app', slug: 'app' } as ExpoConfig;
const IOS_EXP = { name: 'app', slug: 'app', ios: { bundleIdentifier: 'com.app' } } as ExpoConfig;
const USER = { __typename: 'User', id: 'user-id' } as Actor;
const SSO_USER = { __typename: 'SSOUser', id: 'sso-user-id' } as Actor;
const ROBOT = { __typename: 'Robot', id: 'robot-id' } as Actor;
const PARTNER = { __typename: 'PartnerActor', id: 'partner-id' } as Actor;
const AUTHENTICATION_INFO: LoggedInAuthenticationInfo = {
accessToken: 'access-token',
sessionSecret: null,
};
const GRAPHQL_CLIENT = {} as FreeTierNearLimitAgentUpdatesTipExperiment['graphqlClient'];
const ANDROID_KEY = 'free-tier-near-limit-agent-updates-tip-shown/account-id/android';
const IOS_KEY = 'free-tier-near-limit-agent-updates-tip-shown/account-id/ios';
const ANDROID_TIP_11_OF_15 = [
"Tip: this account has used 11 of 15 Android builds on the Free plan this period. This project isn't set up for Expo Update, so every change needs a new build.",
'With Expo Update, JavaScript, styling and image changes reach installed builds without a new build. Setup takes effect from the next build, so it saves the most builds if done now.',
'Next: eas update:configure --non-interactive, then build once more.',
'Tell the user: this adds expo-updates and changes app.json and eas.json.',
'Docs: https://docs.expo.dev/eas-update/getting-started/',
].join('\n');
function accountDefinition(enrolledSegments: number): ExperimentationDefinition {
return {
experiments: [
{
experimentName: EXPERIMENT_NAME,
paramDefinitions: {
variant: { type: 'uniform_choice', choices: ['control', 'treatment'] },
},
exposureLoggerType: 'rudderstack',
},
],
namespaces: [
{
name: FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP_EXPERIMENT_NAMESPACE,
numSegments: 1000,
segmentExperimentSetupDefinitions: [
{
method: 'ADD',
name: `${EXPERIMENT_NAME} rollout`,
experimentName: EXPERIMENT_NAME,
numSegments: enrolledSegments,
},
],
},
],
};
}
/** Every account is in the experiment: 50% control, 50% treatment. */
const ACCOUNT_DEFINITION = accountDefinition(1000);
/** Like the production soft launch: 20% of accounts are in the experiment. */
const PARTIAL_ROLLOUT_DEFINITION = accountDefinition(200);
function createClient(definition: ExperimentationDefinition = ACCOUNT_DEFINITION): {
client: ExperimentationClient;
analytics: ReturnType<typeof createMockAnalytics>;
} {
const analytics = createMockAnalytics();
const client = new ExperimentationClient(
{
user: EMPTY_EXPERIMENTATION_DEFINITION,
account: definition,
device: EMPTY_EXPERIMENTATION_DEFINITION,
},
{ user: null, device: null },
ExperimentOverrides.empty(),
createLoggerConfig(analytics)
);
return { client, analytics };
}
/**
* Probes a throwaway client, so the exposures it logs do not affect the client under test. The
* probe uses a null default, so accounts outside the rollout can be told apart from control.
*/
function findAccountIdsByVariant(
definition: ExperimentationDefinition,
variants: (string | null)[]
): Map<string | null, string> {
const { client } = createClient(definition);
return findUnitsByValue(
accountId =>
client.getAccountNamespace(FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP_EXPERIMENT_NAMESPACE, {
accountId,
}),
'variant',
null,
variants
);
}
function createOverriddenClient(variant: string): ExperimentationClient {
return ExperimentationClient.createDisabled(
new ExperimentOverrides(
new Map([
[FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP_EXPERIMENT_NAMESPACE, new Map([['variant', variant]])],
])
)
);
}
function project(
overrides: Partial<FreeTierNearLimitAgentUpdatesTipPlatformProject> = {}
): FreeTierNearLimitAgentUpdatesTipPlatformProject {
return {
developmentClient: false,
projectDir: '/app',
projectId: 'project-id',
exp: EXP,
manifestHostOverride: null,
...overrides,
};
}
function createExperiment(
accountId: string,
{
client = createClient().client,
runFromCI = false,
json = false,
isUser = true,
analytics = createMockAnalytics(),
projectByPlatform = { [AppPlatform.Android]: project(), [AppPlatform.Ios]: project() },
}: {
client?: ExperimentationClient;
runFromCI?: boolean;
json?: boolean;
isUser?: boolean;
analytics?: ReturnType<typeof createMockAnalytics>;
projectByPlatform?: FreeTierNearLimitAgentUpdatesTipExperiment['projectByPlatform'];
} = {}
): FreeTierNearLimitAgentUpdatesTipExperiment {
return {
experimentation: LazyExperimentationClient.fromClient(client),
graphqlClient: GRAPHQL_CLIENT,
analytics,
analyticsEventProperties: ANALYTICS_EVENT_PROPERTIES,
accountId,
isUser,
runFromCI,
json,
projectByPlatform,
};
}
function build(platform: AppPlatform, status: BuildStatus = BuildStatus.Finished): BuildFragment {
return { id: `${platform}-build`, platform, status } as BuildFragment;
}
type PlatformUsage = { value: number; limit: number };
function usageResponse({
subscriptionName = 'Free' as string | null,
android = { value: 11, limit: 15 } as PlatformUsage,
ios = { value: 3, limit: 15 } as PlatformUsage,
billingPeriodId = 'period-1',
platformBreakdown = true,
} = {}): Awaited<ReturnType<typeof AccountQuery.getFreeTierBuildUsageAsync>> {
return {
id: 'account-id',
subscription: subscriptionName === null ? null : { id: 'subscription-id', name: subscriptionName },
billingPeriod: {
id: billingPeriodId,
start: '2026-10-01T00:00:00.000Z',
end: '2026-11-01T00:00:00.000Z',
},
usageMetrics: {
EAS_BUILD: {
id: 'eas-build',
planMetrics: [
{
id: 'builds',
serviceMetric: EasServiceMetric.Builds,
metricType: UsageMetricType.Build,
value: android.value + ios.value,
limit: android.limit + ios.limit,
platformBreakdown: platformBreakdown ? { android, ios } : null,
},
],
},
},
};
}
const accountIdsByVariant = findAccountIdsByVariant(ACCOUNT_DEFINITION, ['control', 'treatment']);
const treatmentAccountId = accountIdsByVariant.get('treatment')!;
const controlAccountId = accountIdsByVariant.get('control')!;
/** An account outside the partial rollout. */
const notEnrolledAccountId = findAccountIdsByVariant(PARTIAL_ROLLOUT_DEFINITION, [null]).get(null)!;
/** In-memory stand-in for the server-side user preference store, keyed by preference key. */
let shownTips: Record<string, unknown>;
let logSpy: jest.SpyInstance;
beforeEach(() => {
jest.resetAllMocks();
shownTips = {};
jest
.mocked(UserPreferenceQuery.getValueAsync)
.mockImplementation(async (_graphqlClient, key) => shownTips[key] ?? null);
jest
.mocked(UserPreferenceMutation.setAsync)
.mockImplementation(async (_graphqlClient, key, value) => {
shownTips[key] = value;
});
jest.mocked(getAgentTelemetryContext).mockReturnValue({ id: 'claude-code', sessionId: 's-1' });
jest.mocked(createGraphqlClient).mockReturnValue(GRAPHQL_CLIENT);
jest.mocked(isExpoUpdatesInstalled).mockReturnValue(false);
jest.mocked(isUsingEASUpdate).mockReturnValue(false);
jest.mocked(AccountQuery.getFreeTierBuildUsageAsync).mockResolvedValue(usageResponse());
logSpy = jest.spyOn(Log, 'log').mockImplementation(() => {});
});
describe(getFreeTierNearLimitAgentUpdatesTipExperiment, () => {
const ctx = {
authenticationInfo: AUTHENTICATION_INFO,
analytics: createMockAnalytics(),
analyticsEventProperties: ANALYTICS_EVENT_PROPERTIES,
accountId: 'account-id',
user: USER,
developmentClient: false,
projectDir: '/app',
projectId: 'project-id',
exp: EXP,
easJsonCliConfig: { updateManifestHostOverride: 'https://u.example.com' },
runFromCI: false,
};
it('returns the handle when the command has an experimentation client', () => {
const experimentation = new LazyExperimentationClient(async () => createClient().client);
expect(
getFreeTierNearLimitAgentUpdatesTipExperiment(
{ [AppPlatform.Android]: { ...ctx, experimentation } },
{ json: true }
)
).toEqual({
experimentation,
graphqlClient: GRAPHQL_CLIENT,
analytics: ctx.analytics,
analyticsEventProperties: ANALYTICS_EVENT_PROPERTIES,
accountId: 'account-id',
isUser: true,
runFromCI: false,
json: true,
projectByPlatform: {
[AppPlatform.Android]: {
developmentClient: false,
projectDir: '/app',
projectId: 'project-id',
exp: EXP,
manifestHostOverride: 'https://u.example.com',
},
},
});
});
it('keeps the project state of each platform', () => {
const experimentation = new LazyExperimentationClient(async () => createClient().client);
expect(
getFreeTierNearLimitAgentUpdatesTipExperiment(
{
[AppPlatform.Android]: { ...ctx, experimentation },
[AppPlatform.Ios]: {
...ctx,
experimentation,
exp: IOS_EXP,
developmentClient: true,
easJsonCliConfig: undefined,
},
},
{ json: false }
)?.projectByPlatform
).toEqual({
[AppPlatform.Android]: project({ manifestHostOverride: 'https://u.example.com' }),
[AppPlatform.Ios]: project({ exp: IOS_EXP, developmentClient: true }),
});
});
it('creates one GraphQL client with a request timeout', () => {
const experimentation = new LazyExperimentationClient(async () => createClient().client);
getFreeTierNearLimitAgentUpdatesTipExperiment(
{
[AppPlatform.Android]: { ...ctx, experimentation },
[AppPlatform.Ios]: { ...ctx, experimentation },
},
{ json: false }
);
expect(createGraphqlClient).toHaveBeenCalledTimes(1);
expect(createGraphqlClient).toHaveBeenCalledWith(AUTHENTICATION_INFO, {
requestTimeoutMs: 3000,
});
});
it.each([
['a regular user', USER, true],
['an SSO user', SSO_USER, true],
['a robot', ROBOT, false],
['a partner actor', PARTNER, false],
])('marks %s with isUser %p', (_label, user, isUser) => {
const experimentation = new LazyExperimentationClient(async () => createClient().client);
expect(
getFreeTierNearLimitAgentUpdatesTipExperiment(
{ [AppPlatform.Android]: { ...ctx, user, experimentation } },
{ json: false }
)?.isUser
).toBe(isUser);
});
it('returns undefined when the command has no experimentation client', () => {
expect(
getFreeTierNearLimitAgentUpdatesTipExperiment({ [AppPlatform.Android]: ctx }, { json: false })
).toBeUndefined();
});
it('returns undefined when the command has no authentication info', () => {
const experimentation = new LazyExperimentationClient(async () => createClient().client);
expect(
getFreeTierNearLimitAgentUpdatesTipExperiment(
{ [AppPlatform.Android]: { ...ctx, authenticationInfo: undefined, experimentation } },
{ json: false }
)
).toBeUndefined();
expect(createGraphqlClient).not.toHaveBeenCalled();
});
it('returns undefined without build contexts', () => {
expect(getFreeTierNearLimitAgentUpdatesTipExperiment({}, { json: false })).toBeUndefined();
});
});
describe(isEligibleForFreeTierNearLimitAgentUpdatesTip, () => {
it('accepts agent runs', () => {
expect(isEligibleForFreeTierNearLimitAgentUpdatesTip(createExperiment('account-id'))).toBe(true);
});
it('rejects runs without a coding agent', () => {
jest.mocked(getAgentTelemetryContext).mockReturnValue(null);
expect(isEligibleForFreeTierNearLimitAgentUpdatesTip(createExperiment('account-id'))).toBe(false);
});
it('rejects runs from CI', () => {
expect(
isEligibleForFreeTierNearLimitAgentUpdatesTip(createExperiment('account-id', { runFromCI: true }))
).toBe(false);
});
it('rejects robot and partner actors, which cannot store user preferences', () => {
expect(
isEligibleForFreeTierNearLimitAgentUpdatesTip(createExperiment('account-id', { isUser: false }))
).toBe(false);
});
it('rejects --json runs', () => {
expect(
isEligibleForFreeTierNearLimitAgentUpdatesTip(createExperiment('account-id', { json: true }))
).toBe(false);
});
});
describe(isPlatformEligibleForFreeTierNearLimitAgentUpdatesTip, () => {
it('accepts a project without Expo Update', () => {
expect(isPlatformEligibleForFreeTierNearLimitAgentUpdatesTip(project())).toBe(true);
});
it('accepts a project with expo-updates installed but no Expo Update URL', () => {
jest.mocked(isExpoUpdatesInstalled).mockReturnValue(true);
expect(isPlatformEligibleForFreeTierNearLimitAgentUpdatesTip(project())).toBe(true);
});
it('rejects a project that is already set up for Expo Update', () => {
jest.mocked(isExpoUpdatesInstalled).mockReturnValue(true);
jest.mocked(isUsingEASUpdate).mockReturnValue(true);
expect(isPlatformEligibleForFreeTierNearLimitAgentUpdatesTip(project())).toBe(false);
expect(isUsingEASUpdate).toHaveBeenCalledWith(EXP, 'project-id', null);
});
it('rejects development builds, which load JavaScript from the dev server', () => {
expect(
isPlatformEligibleForFreeTierNearLimitAgentUpdatesTip(project({ developmentClient: true }))
).toBe(false);
});
});
describe(isWithinFreeTierNearLimitBand, () => {
it.each([
[9, false],
[10, true],
[11, true],
[14, true],
[15, false],
[16, false],
])('used %s of 15 → %s', (used, expected) => {
expect(isWithinFreeTierNearLimitBand({ used, limit: 15 })).toBe(expected);
});
it('is false without a limit', () => {
expect(isWithinFreeTierNearLimitBand({ used: 0, limit: 0 })).toBe(false);
});
});
describe(getFreeTierBuildUsageAsync, () => {
it('returns the per-platform usage for a Free account', async () => {
expect(await getFreeTierBuildUsageAsync(createExperiment('account-id'))).toEqual({
billingPeriodId: 'period-1',
byPlatform: {
[AppPlatform.Android]: { used: 11, limit: 15 },
[AppPlatform.Ios]: { used: 3, limit: 15 },
},
});
expect(AccountQuery.getFreeTierBuildUsageAsync).toHaveBeenCalledWith(
expect.anything(),
'account-id',
expect.any(Date)
);
});
it('treats an account without a subscription as Free', async () => {
jest
.mocked(AccountQuery.getFreeTierBuildUsageAsync)
.mockResolvedValue(usageResponse({ subscriptionName: null }));
expect(await getFreeTierBuildUsageAsync(createExperiment('account-id'))).not.toBeNull();
});
it('returns null for a paid plan', async () => {
jest
.mocked(AccountQuery.getFreeTierBuildUsageAsync)
.mockResolvedValue(usageResponse({ subscriptionName: 'Starter' }));
expect(await getFreeTierBuildUsageAsync(createExperiment('account-id'))).toBeNull();
});
it('returns null without a platform breakdown', async () => {
jest
.mocked(AccountQuery.getFreeTierBuildUsageAsync)
.mockResolvedValue(usageResponse({ platformBreakdown: false }));
expect(await getFreeTierBuildUsageAsync(createExperiment('account-id'))).toBeNull();
});
});
describe(resolveFreeTierNearLimitAgentUpdatesTipVariantAsync, () => {
it('returns the account variant and logs the exposure once', async () => {
const { client, analytics } = createClient();
const experiment = createExperiment(treatmentAccountId, { client });
expect(await resolveFreeTierNearLimitAgentUpdatesTipVariantAsync(experiment)).toBe('treatment');
expect(await resolveFreeTierNearLimitAgentUpdatesTipVariantAsync(experiment)).toBe('treatment');
expect(analytics.logEvent).toHaveBeenCalledTimes(1);
expect(analytics.logEvent).toHaveBeenCalledWith('Experiment Viewed', {
experimentName: EXPERIMENT_NAME,
variationName: 'treatment',
unit: treatmentAccountId,
});
});
it('logs the exposure for control accounts too', async () => {
const { client, analytics } = createClient();
expect(
await resolveFreeTierNearLimitAgentUpdatesTipVariantAsync(
createExperiment(controlAccountId, { client })
)
).toBe('control');
expect(analytics.logEvent).toHaveBeenCalledWith('Experiment Viewed', {
experimentName: EXPERIMENT_NAME,
variationName: 'control',
unit: controlAccountId,
});
});
it('returns control and logs no exposure for an account outside the rollout', async () => {
const { client, analytics } = createClient(PARTIAL_ROLLOUT_DEFINITION);
expect(
await resolveFreeTierNearLimitAgentUpdatesTipVariantAsync(
createExperiment(notEnrolledAccountId, { client })
)
).toBe('control');
expect(analytics.logEvent).not.toHaveBeenCalled();
});
it('returns control and logs no exposure when the namespace is missing from the config', async () => {
const { client, analytics } = createClient(EMPTY_EXPERIMENTATION_DEFINITION);
expect(
await resolveFreeTierNearLimitAgentUpdatesTipVariantAsync(
createExperiment(treatmentAccountId, { client })
)
).toBe('control');
expect(analytics.logEvent).not.toHaveBeenCalled();
});
});
describe(getFreeTierNearLimitAgentUpdatesTipPreferenceKey, () => {
it('scopes the key to the account and the lowercase platform', () => {
expect(getFreeTierNearLimitAgentUpdatesTipPreferenceKey('account-id', AppPlatform.Android)).toBe(
ANDROID_KEY
);
expect(getFreeTierNearLimitAgentUpdatesTipPreferenceKey('account-id', AppPlatform.Ios)).toBe(
IOS_KEY
);
});
});
describe(formatFreeTierNearLimitAgentUpdatesTip, () => {
it('formats the Android tip', () => {
expect(
formatFreeTierNearLimitAgentUpdatesTip({ platform: AppPlatform.Android, used: 11, limit: 15 })
).toBe(ANDROID_TIP_11_OF_15);
});
it('formats the iOS tip', () => {
expect(
formatFreeTierNearLimitAgentUpdatesTip({ platform: AppPlatform.Ios, used: 14, limit: 15 })
).toContain('Tip: this account has used 14 of 15 iOS builds on the Free plan this period.');
});
});
describe(maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync, () => {
function treatmentExperiment(
options: Parameters<typeof createExperiment>[1] = {}
): FreeTierNearLimitAgentUpdatesTipExperiment {
return createExperiment('account-id', {
client: createOverriddenClient('treatment'),
...options,
});
}
it('does nothing when the command has no experiment handle', async () => {
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync([build(AppPlatform.Android)], undefined);
expect(AccountQuery.getFreeTierBuildUsageAsync).not.toHaveBeenCalled();
expect(logSpy).not.toHaveBeenCalled();
});
it('requests no usage for ineligible runs', async () => {
jest.mocked(getAgentTelemetryContext).mockReturnValue(null);
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android)],
treatmentExperiment()
);
expect(AccountQuery.getFreeTierBuildUsageAsync).not.toHaveBeenCalled();
expect(logSpy).not.toHaveBeenCalled();
});
it('requests no usage when no build finished', async () => {
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android, BuildStatus.Errored), null],
treatmentExperiment()
);
expect(AccountQuery.getFreeTierBuildUsageAsync).not.toHaveBeenCalled();
expect(logSpy).not.toHaveBeenCalled();
});
it('requests no usage when no finished platform is eligible', async () => {
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android)],
treatmentExperiment({
projectByPlatform: { [AppPlatform.Android]: project({ developmentClient: true }) },
})
);
expect(AccountQuery.getFreeTierBuildUsageAsync).not.toHaveBeenCalled();
expect(logSpy).not.toHaveBeenCalled();
});
it('checks each platform against its own build context', async () => {
// Only the iOS build evaluated a config with the Expo Update URL.
jest.mocked(isExpoUpdatesInstalled).mockReturnValue(true);
jest.mocked(isUsingEASUpdate).mockImplementation(exp => exp === IOS_EXP);
jest
.mocked(AccountQuery.getFreeTierBuildUsageAsync)
.mockResolvedValue(usageResponse({ ios: { value: 14, limit: 15 } }));
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android), build(AppPlatform.Ios)],
treatmentExperiment({
projectByPlatform: {
[AppPlatform.Android]: project(),
[AppPlatform.Ios]: project({ exp: IOS_EXP }),
},
})
);
expect(logSpy).toHaveBeenCalledTimes(1);
expect(logSpy).toHaveBeenCalledWith(ANDROID_TIP_11_OF_15);
expect(shownTips).toEqual({ [ANDROID_KEY]: { billingPeriodId: 'period-1' } });
});
it('prints the tip in the treatment arm and remembers it for the billing period', async () => {
const experiment = treatmentExperiment();
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync([build(AppPlatform.Android)], experiment);
expect(logSpy).toHaveBeenCalledWith(ANDROID_TIP_11_OF_15);
expect(shownTips).toEqual({ [ANDROID_KEY]: { billingPeriodId: 'period-1' } });
expect(UserPreferenceMutation.setAsync).toHaveBeenCalledWith(GRAPHQL_CLIENT, ANDROID_KEY, {
billingPeriodId: 'period-1',
});
expect(experiment.analytics.logEvent).toHaveBeenCalledWith(
'build cli free tier near limit agent updates tip',
{
...ANALYTICS_EVENT_PROPERTIES,
platform: AppPlatform.Android,
builds_used: 11,
builds_limit: 15,
}
);
});
it('prints nothing and writes no marker in the control arm, but records the exposure', async () => {
const { client, analytics } = createClient();
const experiment = createExperiment(controlAccountId, { client, analytics });
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync([build(AppPlatform.Android)], experiment);
expect(logSpy).not.toHaveBeenCalled();
expect(shownTips).toEqual({});
expect(UserPreferenceMutation.setAsync).not.toHaveBeenCalled();
expect(analytics.logEvent).toHaveBeenCalledWith('Experiment Viewed', {
experimentName: EXPERIMENT_NAME,
variationName: 'control',
unit: controlAccountId,
});
expect(analytics.logEvent).not.toHaveBeenCalledWith(
'build cli free tier near limit agent updates tip',
expect.anything()
);
});
it('does nothing for an account outside the experiment', async () => {
const { client, analytics } = createClient(PARTIAL_ROLLOUT_DEFINITION);
const experiment = createExperiment(notEnrolledAccountId, { client, analytics });
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync([build(AppPlatform.Android)], experiment);
expect(logSpy).not.toHaveBeenCalled();
expect(analytics.logEvent).not.toHaveBeenCalled();
expect(shownTips).toEqual({});
expect(UserPreferenceMutation.setAsync).not.toHaveBeenCalled();
});
it('logs the exposure only after the usage checks pass', async () => {
const { client, analytics } = createClient();
jest
.mocked(AccountQuery.getFreeTierBuildUsageAsync)
.mockResolvedValue(usageResponse({ android: { value: 9, limit: 15 } }));
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android)],
createExperiment(treatmentAccountId, { client, analytics })
);
expect(analytics.logEvent).not.toHaveBeenCalled();
expect(logSpy).not.toHaveBeenCalled();
expect(UserPreferenceQuery.getValueAsync).not.toHaveBeenCalled();
expect(UserPreferenceMutation.setAsync).not.toHaveBeenCalled();
});
it('does nothing for paid plans', async () => {
jest
.mocked(AccountQuery.getFreeTierBuildUsageAsync)
.mockResolvedValue(usageResponse({ subscriptionName: 'Production' }));
const experiment = treatmentExperiment();
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync([build(AppPlatform.Android)], experiment);
expect(logSpy).not.toHaveBeenCalled();
expect(experiment.analytics.logEvent).not.toHaveBeenCalled();
});
it('does not repeat the tip within the same billing period for this user', async () => {
shownTips = { [ANDROID_KEY]: { billingPeriodId: 'period-1' } };
const experiment = treatmentExperiment();
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync([build(AppPlatform.Android)], experiment);
expect(UserPreferenceQuery.getValueAsync).toHaveBeenCalledWith(GRAPHQL_CLIENT, ANDROID_KEY);
expect(logSpy).not.toHaveBeenCalled();
expect(experiment.analytics.logEvent).not.toHaveBeenCalled();
expect(UserPreferenceMutation.setAsync).not.toHaveBeenCalled();
});
it('shows the tip again in a new billing period', async () => {
const otherAccountIosKey = 'free-tier-near-limit-agent-updates-tip-shown/other-account/ios';
shownTips = {
[ANDROID_KEY]: { billingPeriodId: 'period-0' },
[otherAccountIosKey]: { billingPeriodId: 'period-1' },
};
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android)],
treatmentExperiment()
);
expect(logSpy).toHaveBeenCalledWith(ANDROID_TIP_11_OF_15);
expect(shownTips).toEqual({
[ANDROID_KEY]: { billingPeriodId: 'period-1' },
[otherAccountIosKey]: { billingPeriodId: 'period-1' },
});
});
it('treats a malformed stored preference as not shown', async () => {
shownTips = { [ANDROID_KEY]: 'period-1' };
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android)],
treatmentExperiment()
);
expect(logSpy).toHaveBeenCalledWith(ANDROID_TIP_11_OF_15);
expect(shownTips).toEqual({ [ANDROID_KEY]: { billingPeriodId: 'period-1' } });
});
it('checks each finished platform with one usage request', async () => {
jest
.mocked(AccountQuery.getFreeTierBuildUsageAsync)
.mockResolvedValue(usageResponse({ ios: { value: 14, limit: 15 } }));
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android), build(AppPlatform.Ios)],
treatmentExperiment()
);
expect(AccountQuery.getFreeTierBuildUsageAsync).toHaveBeenCalledTimes(1);
expect(logSpy).toHaveBeenCalledTimes(2);
expect(logSpy).toHaveBeenCalledWith(ANDROID_TIP_11_OF_15);
expect(logSpy).toHaveBeenCalledWith(
expect.stringContaining('used 14 of 15 iOS builds on the Free plan')
);
expect(shownTips).toEqual({
[ANDROID_KEY]: { billingPeriodId: 'period-1' },
[IOS_KEY]: { billingPeriodId: 'period-1' },
});
});
it('skips platforms outside the band', async () => {
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android), build(AppPlatform.Ios)],
treatmentExperiment()
);
expect(logSpy).toHaveBeenCalledTimes(1);
expect(logSpy).toHaveBeenCalledWith(ANDROID_TIP_11_OF_15);
expect(shownTips).toEqual({ [ANDROID_KEY]: { billingPeriodId: 'period-1' } });
});
it('still shows the tip and logs the events when the marker write fails', async () => {
jest.mocked(UserPreferenceMutation.setAsync).mockRejectedValue(new Error('forbidden'));
const { client, analytics } = createClient();
const experiment = createExperiment(treatmentAccountId, { client, analytics });
await expect(
maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync([build(AppPlatform.Android)], experiment)
).resolves.toBeUndefined();
expect(logSpy).toHaveBeenCalledWith(ANDROID_TIP_11_OF_15);
expect(analytics.logEvent).toHaveBeenCalledWith('Experiment Viewed', {
experimentName: EXPERIMENT_NAME,
variationName: 'treatment',
unit: treatmentAccountId,
});
expect(analytics.logEvent).toHaveBeenCalledWith(
'build cli free tier near limit agent updates tip',
expect.objectContaining({ platform: AppPlatform.Android })
);
expect(shownTips).toEqual({});
});
it('still checks the next platform when a marker write fails', async () => {
jest
.mocked(UserPreferenceMutation.setAsync)
.mockRejectedValueOnce(new Error('forbidden'))
.mockImplementation(async (_graphqlClient, key, value) => {
shownTips[key] = value;
});
jest
.mocked(AccountQuery.getFreeTierBuildUsageAsync)
.mockResolvedValue(usageResponse({ ios: { value: 14, limit: 15 } }));
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
[build(AppPlatform.Android), build(AppPlatform.Ios)],
treatmentExperiment()
);
expect(logSpy).toHaveBeenCalledTimes(2);
expect(logSpy).toHaveBeenCalledWith(ANDROID_TIP_11_OF_15);
expect(logSpy).toHaveBeenCalledWith(
expect.stringContaining('used 14 of 15 iOS builds on the Free plan')
);
expect(shownTips).toEqual({ [IOS_KEY]: { billingPeriodId: 'period-1' } });
});
it('fails open when the usage request fails', async () => {
jest
.mocked(AccountQuery.getFreeTierBuildUsageAsync)
.mockRejectedValue(new Error('network down'));
const experiment = treatmentExperiment();
await expect(
maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync([build(AppPlatform.Android)], experiment)
).resolves.toBeUndefined();
expect(logSpy).not.toHaveBeenCalled();
expect(experiment.analytics.logEvent).not.toHaveBeenCalled();
});
});
@@ -5,12 +5,8 @@ import { GraphQLError } from 'graphql/error';
import { v4 as uuidv4 } from 'uuid';
import { getErrorAsync } from '../../__tests__/commands/utils';
import { getAgentTelemetryContext } from '../../analytics/agent';
import { EasCommandError } from '../../commandUtils/errors';
import Build from '../../commands/build';
import { ExperimentOverrides } from '../../experimentation/ExperimentOverrides';
import { ExperimentationClient } from '../../experimentation/ExperimentationClient';
import { LazyExperimentationClient } from '../../experimentation/LazyExperimentationClient';
import Log, { link } from '../../log';
import { handleBuildRequestErrorAsync } from '../build';
import {
@@ -30,12 +26,7 @@ import {
FreeTierLimitCheckoutExperiment,
maybeOfferFreeTierLimitCheckoutAsync,
} from '../freeTierLimitCheckout';
import {
FREE_TIER_LIMIT_AGENT_GUIDANCE_EXPERIMENT_NAMESPACE,
FreeTierLimitAgentGuidanceExperiment,
} from '../freeTierLimitGuidance';
jest.mock('../../analytics/agent');
jest.mock('../freeTierLimitCheckout', () => ({
...jest.requireActual('../freeTierLimitCheckout'),
maybeOfferFreeTierLimitCheckoutAsync: jest.fn(),
@@ -45,26 +36,9 @@ const CHECKOUT_EXPERIMENT = { accountId: 'account-id' } as FreeTierLimitCheckout
beforeEach(() => {
jest.resetAllMocks();
jest.mocked(getAgentTelemetryContext).mockReturnValue(null);
jest.mocked(maybeOfferFreeTierLimitCheckoutAsync).mockResolvedValue(false);
});
/** An experiment handle whose client is forced to the given variant through an override. */
function createExperiment(variant: string): FreeTierLimitAgentGuidanceExperiment {
return {
accountId: 'account-id',
experimentation: LazyExperimentationClient.fromClient(
ExperimentationClient.createDisabled(
new ExperimentOverrides(
new Map([
[FREE_TIER_LIMIT_AGENT_GUIDANCE_EXPERIMENT_NAMESPACE, new Map([['variant', variant]])],
])
)
)
),
};
}
const EXPECTED_STRINGIFIED_GRAPHQL_ERROR_JSON = `Build request error details:
{
"message": "[GraphQL] Error 1\\n[GraphQL] Error 2\\n[GraphQL] Error 3",
@@ -357,115 +331,6 @@ describe(Build.name, () => {
);
});
});
describe('for free tier limit errors in the agent guidance experiment', () => {
beforeEach(() => {
jest
.mocked(getAgentTelemetryContext)
.mockReturnValue({ id: 'claude-code', sessionId: 'session-1' });
});
it('appends the human required block for Android in the treatment arm', async () => {
const platform = Platform.ANDROID;
const accountName = 'test-account';
const graphQLError = getGraphQLError('Error 1', 'EAS_BUILD_FREE_TIER_LIMIT_EXCEEDED');
const error = new CombinedError({ graphQLErrors: [graphQLError] });
const handleBuildRequestErrorThrownError = await getErrorAsync<EasBuildFreeTierLimitExceededError>(
async () => {
await handleBuildRequestErrorAsync(error, platform, accountName, createExperiment('treatment'));
}
);
assertReThrownError(
handleBuildRequestErrorThrownError,
EasBuildFreeTierLimitExceededError,
[
'Error 1',
'Run eas billing:subscribe starter --account test-account to upgrade to the Starter plan.',
'Fix: Human required: Android builds for this account are blocked until the Free plan resets. Upgrading costs money, so an account owner or admin decides.',
].join('\n')
);
});
it('appends the human required block for iOS in the treatment arm', async () => {
const platform = Platform.IOS;
const accountName = 'test-account';
const graphQLError = getGraphQLError('Error 1', 'EAS_BUILD_FREE_TIER_IOS_LIMIT_EXCEEDED');
const error = new CombinedError({ graphQLErrors: [graphQLError] });
const handleBuildRequestErrorThrownError =
await getErrorAsync<EasBuildFreeTierIosLimitExceededError>(async () => {
await handleBuildRequestErrorAsync(error, platform, accountName, createExperiment('treatment'));
});
assertReThrownError(
handleBuildRequestErrorThrownError,
EasBuildFreeTierIosLimitExceededError,
[
'Error 1',
'Run eas billing:subscribe starter --account test-account to upgrade to the Starter plan.',
'Fix: Human required: iOS builds for this account are blocked until the Free plan resets. Upgrading costs money, so an account owner or admin decides.',
].join('\n')
);
});
it('does not append the block in the control arm', async () => {
const platform = Platform.ANDROID;
const accountName = 'test-account';
const graphQLError = getGraphQLError('Error 1', 'EAS_BUILD_FREE_TIER_LIMIT_EXCEEDED');
const error = new CombinedError({ graphQLErrors: [graphQLError] });
const handleBuildRequestErrorThrownError = await getErrorAsync<EasBuildFreeTierLimitExceededError>(
async () => {
await handleBuildRequestErrorAsync(error, platform, accountName, createExperiment('control'));
}
);
assertReThrownError(
handleBuildRequestErrorThrownError,
EasBuildFreeTierLimitExceededError,
'Error 1\nRun eas billing:subscribe starter --account test-account to upgrade to the Starter plan.'
);
});
it('does not append the block when no coding agent runs the CLI', async () => {
jest.mocked(getAgentTelemetryContext).mockReturnValue(null);
const platform = Platform.ANDROID;
const accountName = 'test-account';
const graphQLError = getGraphQLError('Error 1', 'EAS_BUILD_FREE_TIER_LIMIT_EXCEEDED');
const error = new CombinedError({ graphQLErrors: [graphQLError] });
const handleBuildRequestErrorThrownError = await getErrorAsync<EasBuildFreeTierLimitExceededError>(
async () => {
await handleBuildRequestErrorAsync(error, platform, accountName, createExperiment('treatment'));
}
);
assertReThrownError(
handleBuildRequestErrorThrownError,
EasBuildFreeTierLimitExceededError,
'Error 1\nRun eas billing:subscribe starter --account test-account to upgrade to the Starter plan.'
);
});
it('does not append the block to other server-side errors', async () => {
const platform = Platform.ANDROID;
const graphQLError = getGraphQLError('Error 1', 'EAS_BUILD_FREE_TIER_DISABLED');
const error = new CombinedError({ graphQLErrors: [graphQLError] });
const handleBuildRequestErrorThrownError = await getErrorAsync<EasBuildFreeTierDisabledError>(
async () => {
await handleBuildRequestErrorAsync(error, platform, undefined, createExperiment('treatment'));
}
);
assertReThrownError(
handleBuildRequestErrorThrownError,
EasBuildFreeTierDisabledError,
'Error 1'
);
});
});
describe('for free tier limit errors in the checkout experiment', () => {
it('offers the checkout with the limit message and marks the message as printed', async () => {
jest.mocked(maybeOfferFreeTierLimitCheckoutAsync).mockResolvedValue(true);
@@ -482,7 +347,6 @@ describe(Build.name, () => {
error,
platform,
accountName,
undefined,
CHECKOUT_EXPERIMENT
);
}
@@ -515,7 +379,6 @@ describe(Build.name, () => {
error,
platform,
accountName,
undefined,
CHECKOUT_EXPERIMENT
);
});
@@ -544,7 +407,6 @@ describe(Build.name, () => {
error,
platform,
accountName,
undefined,
CHECKOUT_EXPERIMENT
);
}
@@ -559,35 +421,6 @@ describe(Build.name, () => {
);
});
it('passes the agent guidance along when both experiments are present', async () => {
jest
.mocked(getAgentTelemetryContext)
.mockReturnValue({ id: 'claude-code', sessionId: 'session-1' });
const platform = Platform.ANDROID;
const accountName = 'test-account';
const graphQLError = getGraphQLError('Error 1', 'EAS_BUILD_FREE_TIER_LIMIT_EXCEEDED');
const error = new CombinedError({ graphQLErrors: [graphQLError] });
await getErrorAsync(async () => {
await handleBuildRequestErrorAsync(
error,
platform,
accountName,
createExperiment('treatment'),
CHECKOUT_EXPERIMENT
);
});
expect(maybeOfferFreeTierLimitCheckoutAsync).toHaveBeenCalledWith(
[
'Error 1',
'Run eas billing:subscribe starter --account test-account to upgrade to the Starter plan.',
'Fix: Human required: Android builds for this account are blocked until the Free plan resets. Upgrading costs money, so an account owner or admin decides.',
].join('\n'),
CHECKOUT_EXPERIMENT
);
});
it('does not offer the checkout for other server-side errors', async () => {
const platform = Platform.ANDROID;
const graphQLError = getGraphQLError('Error 1', 'EAS_BUILD_FREE_TIER_DISABLED');
@@ -599,7 +432,6 @@ describe(Build.name, () => {
error,
platform,
undefined,
undefined,
CHECKOUT_EXPERIMENT
);
}
+1 -12
View File
@@ -34,11 +34,6 @@ import {
getFreeTierLimitCheckoutExperiment,
maybeOfferFreeTierLimitCheckoutAsync,
} from './freeTierLimitCheckout';
import {
FreeTierLimitAgentGuidanceExperiment,
getFreeTierLimitAgentGuidanceExperiment,
maybeAppendFreeTierLimitAgentGuidanceAsync,
} from './freeTierLimitGuidance';
import { transformMetadata } from './graphql';
import { LocalBuildMode, runLocalBuildAsync } from './local';
import {
@@ -236,7 +231,6 @@ export async function prepareBuildRequestForPlatformAsync<
error,
job.platform,
ctx.accountName,
getFreeTierLimitAgentGuidanceExperiment(ctx),
getFreeTierLimitCheckoutExperiment(ctx)
);
}
@@ -263,7 +257,6 @@ export async function handleBuildRequestErrorAsync(
error: any,
platform: Platform,
accountName?: string,
freeTierLimitAgentGuidanceExperiment?: FreeTierLimitAgentGuidanceExperiment,
freeTierLimitCheckoutExperiment?: FreeTierLimitCheckoutExperiment
): Promise<never> {
logBuildRequestErrorDebugInfo(error);
@@ -283,11 +276,7 @@ export async function handleBuildRequestErrorAsync(
if (!isFreeTierLimitError) {
throw new ErrorClass(message);
}
const limitMessage = await maybeAppendFreeTierLimitAgentGuidanceAsync(
`${message}\nRun ${formatStarterSubscribeCommand(accountName)} to upgrade to the Starter plan.`,
platform,
freeTierLimitAgentGuidanceExperiment
);
const limitMessage = `${message}\nRun ${formatStarterSubscribeCommand(accountName)} to upgrade to the Starter plan.`;
const messageAlreadyPrinted = await maybeOfferFreeTierLimitCheckoutAsync(
limitMessage,
freeTierLimitCheckoutExperiment
@@ -107,11 +107,7 @@ async function resolveEnvVarsAsync({
return { ...serverEnvVars, ...buildProfile.env };
} catch (e) {
Log.error(`Failed to pull env variables for environment ${environment} from EAS servers`);
Log.error(e);
Log.error(
'This can possibly be a bug in EAS/EAS CLI. Report it here: https://github.com/expo/eas-cli/issues'
);
return { ...buildProfile.env };
throw e;
}
}
@@ -1,60 +0,0 @@
import { Platform } from '@expo/eas-build-job';
import { getAgentTelemetryContext } from '../analytics/agent';
import { LazyExperimentationClient } from '../experimentation/LazyExperimentationClient';
import { requestedPlatformDisplayNames } from '../platform';
export const FREE_TIER_LIMIT_AGENT_GUIDANCE_EXPERIMENT_NAMESPACE =
'cli-build-free-tier-limit-agent-guidance';
export type FreeTierLimitAgentGuidanceVariant = 'control' | 'treatment';
export type FreeTierLimitAgentGuidanceExperiment = {
experimentation: LazyExperimentationClient;
accountId: string;
};
export function getFreeTierLimitAgentGuidanceExperiment(ctx: {
experimentation?: LazyExperimentationClient;
accountId: string;
}): FreeTierLimitAgentGuidanceExperiment | undefined {
return ctx.experimentation
? { experimentation: ctx.experimentation, accountId: ctx.accountId }
: undefined;
}
/**
* Resolves the account's variant. Only runs driven by a coding agent are eligible. Other runs get
* control before the client loads, so they make no config request and log no exposure.
*/
export async function resolveFreeTierLimitAgentGuidanceVariantAsync({
experimentation,
accountId,
}: FreeTierLimitAgentGuidanceExperiment): Promise<FreeTierLimitAgentGuidanceVariant> {
if (!getAgentTelemetryContext()) {
return 'control';
}
const client = await experimentation.getClientAsync();
return client
.getAccountNamespace(FREE_TIER_LIMIT_AGENT_GUIDANCE_EXPERIMENT_NAMESPACE, { accountId })
.getParam<FreeTierLimitAgentGuidanceVariant>('variant', 'control');
}
export function formatFreeTierLimitAgentGuidance(platform: Platform): string {
const platformName = requestedPlatformDisplayNames[platform];
return `Fix: Human required: ${platformName} builds for this account are blocked until the Free plan resets. Upgrading costs money, so an account owner or admin decides.`;
}
export async function maybeAppendFreeTierLimitAgentGuidanceAsync(
message: string,
platform: Platform,
experiment: FreeTierLimitAgentGuidanceExperiment | undefined
): Promise<string> {
if (
!experiment ||
(await resolveFreeTierLimitAgentGuidanceVariantAsync(experiment)) !== 'treatment'
) {
return message;
}
return `${message}\n${formatFreeTierLimitAgentGuidance(platform)}`;
}
@@ -0,0 +1,344 @@
import { ExpoConfig } from '@expo/config';
import { getAgentTelemetryContext } from '../analytics/agent';
import { Analytics, AnalyticsEventProperties, BuildEvent } from '../analytics/AnalyticsManager';
import {
ExpoGraphqlClient,
createGraphqlClient,
} from '../commandUtils/context/contextUtils/createGraphqlClient';
import { LazyExperimentationClient } from '../experimentation/LazyExperimentationClient';
import {
AppPlatform,
BuildFragment,
BuildStatus,
EasServiceMetric,
UsageMetricType,
} from '../graphql/generated';
import { UserPreferenceMutation } from '../graphql/mutations/UserPreferenceMutation';
import { AccountQuery } from '../graphql/queries/AccountQuery';
import { UserPreferenceQuery } from '../graphql/queries/UserPreferenceQuery';
import Log from '../log';
import { appPlatformDisplayNames } from '../platform';
import { isExpoUpdatesInstalled, isUsingEASUpdate } from '../project/projectUtils';
import { LoggedInAuthenticationInfo } from '../user/SessionManager';
import { Actor } from '../user/User';
export const FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP_EXPERIMENT_NAMESPACE =
'cli-build-free-tier-near-limit-agent-updates-tip';
/** The tip shows when this many builds or fewer are left on the platform. */
export const FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP_BUILDS_LEFT = 5;
export const EAS_UPDATE_GETTING_STARTED_URL = 'https://docs.expo.dev/eas-update/getting-started/';
/** Server-side user preference key prefix. The full key is `<prefix>/<accountId>/<platform>`. */
const USER_PREFERENCE_KEY_PREFIX = 'free-tier-near-limit-agent-updates-tip-shown';
/** The tip's requests run after the build, so a stalled request must not delay the exit. */
const REQUEST_TIMEOUT_MS = 3000;
export type FreeTierNearLimitAgentUpdatesTipVariant = 'control' | 'treatment';
/** The project state of one platform's build. Each build profile evaluates its own config. */
export type FreeTierNearLimitAgentUpdatesTipPlatformProject = {
developmentClient: boolean;
projectDir: string;
projectId: string;
exp: ExpoConfig;
manifestHostOverride: string | null;
};
export type FreeTierNearLimitAgentUpdatesTipExperiment = {
experimentation: LazyExperimentationClient;
graphqlClient: ExpoGraphqlClient;
analytics: Analytics;
analyticsEventProperties: AnalyticsEventProperties;
accountId: string;
/** Only regular and SSO users can store user preferences. */
isUser: boolean;
runFromCI: boolean;
json: boolean;
projectByPlatform: Partial<Record<AppPlatform, FreeTierNearLimitAgentUpdatesTipPlatformProject>>;
};
export type FreeTierNearLimitAgentUpdatesTipBuildContext = {
experimentation?: LazyExperimentationClient;
authenticationInfo?: LoggedInAuthenticationInfo;
analytics: Analytics;
analyticsEventProperties: AnalyticsEventProperties;
accountId: string;
user: Actor;
developmentClient: boolean;
projectDir: string;
projectId: string;
exp: ExpoConfig;
easJsonCliConfig: { updateManifestHostOverride?: string } | undefined;
runFromCI: boolean;
};
export type FreeTierPlatformBuildUsage = {
used: number;
limit: number;
};
export type FreeTierBuildUsage = {
billingPeriodId: string;
byPlatform: Record<AppPlatform, FreeTierPlatformBuildUsage>;
};
/** All build contexts belong to one command run, so the account and the actor are shared. */
export function getFreeTierNearLimitAgentUpdatesTipExperiment(
buildCtxByPlatform: Partial<Record<AppPlatform, FreeTierNearLimitAgentUpdatesTipBuildContext>>,
{ json }: { json: boolean }
): FreeTierNearLimitAgentUpdatesTipExperiment | undefined {
const ctx = Object.values(buildCtxByPlatform)[0];
if (!ctx?.experimentation || !ctx.authenticationInfo) {
return undefined;
}
const projectByPlatform: FreeTierNearLimitAgentUpdatesTipExperiment['projectByPlatform'] = {};
for (const [platform, platformCtx] of Object.entries(buildCtxByPlatform)) {
projectByPlatform[platform as AppPlatform] = {
developmentClient: platformCtx.developmentClient,
projectDir: platformCtx.projectDir,
projectId: platformCtx.projectId,
exp: platformCtx.exp,
manifestHostOverride: platformCtx.easJsonCliConfig?.updateManifestHostOverride ?? null,
};
}
return {
experimentation: ctx.experimentation,
graphqlClient: createGraphqlClient(ctx.authenticationInfo, {
requestTimeoutMs: REQUEST_TIMEOUT_MS,
}),
analytics: ctx.analytics,
analyticsEventProperties: ctx.analyticsEventProperties,
accountId: ctx.accountId,
isUser: ctx.user.__typename === 'User' || ctx.user.__typename === 'SSOUser',
runFromCI: ctx.runFromCI,
json,
projectByPlatform,
};
}
export function isProjectConfiguredForEASUpdate({
projectDir,
exp,
projectId,
manifestHostOverride,
}: Pick<
FreeTierNearLimitAgentUpdatesTipPlatformProject,
'projectDir' | 'exp' | 'projectId' | 'manifestHostOverride'
>): boolean {
return (
isExpoUpdatesInstalled(projectDir) && isUsingEASUpdate(exp, projectId, manifestHostOverride)
);
}
/**
* Only runs driven by a coding agent logged in as a user, outside CI and without --json are
* eligible. Everything else gets no tip and no usage request.
*/
export function isEligibleForFreeTierNearLimitAgentUpdatesTip(
experiment: FreeTierNearLimitAgentUpdatesTipExperiment
): boolean {
return !(
experiment.runFromCI ||
experiment.json ||
!experiment.isUser ||
!getAgentTelemetryContext()
);
}
/**
* A platform is eligible when its project is not set up for Expo Update. Development builds load
* JavaScript from the dev server, so the tip does not apply to them.
*/
export function isPlatformEligibleForFreeTierNearLimitAgentUpdatesTip(
project: FreeTierNearLimitAgentUpdatesTipPlatformProject
): boolean {
return !project.developmentClient && !isProjectConfiguredForEASUpdate(project);
}
/** True when the platform still has builds left, but no more than the tip's threshold. */
export function isWithinFreeTierNearLimitBand({ used, limit }: FreeTierPlatformBuildUsage): boolean {
return limit > 0 && used < limit && limit - used <= FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP_BUILDS_LEFT;
}
/** Returns the Free plan build usage per platform, or null when the account is not on the Free plan. */
export async function getFreeTierBuildUsageAsync({
graphqlClient,
accountId,
}: Pick<FreeTierNearLimitAgentUpdatesTipExperiment, 'graphqlClient' | 'accountId'>): Promise<FreeTierBuildUsage | null> {
const account = await AccountQuery.getFreeTierBuildUsageAsync(graphqlClient, accountId, new Date());
if ((account.subscription?.name ?? 'Free') !== 'Free') {
return null;
}
const buildMetric = account.usageMetrics.EAS_BUILD.planMetrics.find(
metric =>
metric.serviceMetric === EasServiceMetric.Builds &&
metric.metricType === UsageMetricType.Build
);
const breakdown = buildMetric?.platformBreakdown;
if (!breakdown) {
return null;
}
return {
billingPeriodId: account.billingPeriod.id,
byPlatform: {
[AppPlatform.Android]: { used: breakdown.android.value, limit: breakdown.android.limit },
[AppPlatform.Ios]: { used: breakdown.ios.value, limit: breakdown.ios.limit },
},
};
}
/**
* The first call logs the exposure, so call it only when the tip would show. Accounts outside the
* rollout get the control default and no exposure.
*/
export async function resolveFreeTierNearLimitAgentUpdatesTipVariantAsync({
experimentation,
accountId,
}: Pick<FreeTierNearLimitAgentUpdatesTipExperiment, 'experimentation' | 'accountId'>): Promise<FreeTierNearLimitAgentUpdatesTipVariant> {
const client = await experimentation.getClientAsync();
return client
.getAccountNamespace(FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP_EXPERIMENT_NAMESPACE, { accountId })
.getParam<FreeTierNearLimitAgentUpdatesTipVariant>('variant', 'control');
}
export function formatFreeTierNearLimitAgentUpdatesTip({
platform,
used,
limit,
}: FreeTierPlatformBuildUsage & { platform: AppPlatform }): string {
const platformName = appPlatformDisplayNames[platform];
return [
`Tip: this account has used ${used} of ${limit} ${platformName} builds on the Free plan this period. This project isn't set up for Expo Update, so every change needs a new build.`,
'With Expo Update, JavaScript, styling and image changes reach installed builds without a new build. Setup takes effect from the next build, so it saves the most builds if done now.',
'Next: eas update:configure --non-interactive, then build once more.',
'Tell the user: this adds expo-updates and changes app.json and eas.json.',
`Docs: ${EAS_UPDATE_GETTING_STARTED_URL}`,
].join('\n');
}
export function getFreeTierNearLimitAgentUpdatesTipPreferenceKey(
accountId: string,
platform: AppPlatform
): string {
return `${USER_PREFERENCE_KEY_PREFIX}/${accountId}/${platform.toLowerCase()}`;
}
type ShownTipPreference = { billingPeriodId: string };
function isShownTipPreference(value: unknown): value is ShownTipPreference {
return (
typeof value === 'object' &&
value !== null &&
typeof (value as ShownTipPreference).billingPeriodId === 'string'
);
}
/**
* The tip shows at most once per user, account, platform and billing period. The marker is a
* user preference on the server, so it follows the user across machines and fresh agent
* sandboxes.
*/
export async function wasFreeTierNearLimitAgentUpdatesTipShownAsync(
graphqlClient: ExpoGraphqlClient,
accountId: string,
platform: AppPlatform,
billingPeriodId: string
): Promise<boolean> {
const value = await UserPreferenceQuery.getValueAsync(
graphqlClient,
getFreeTierNearLimitAgentUpdatesTipPreferenceKey(accountId, platform)
);
return isShownTipPreference(value) && value.billingPeriodId === billingPeriodId;
}
export async function markFreeTierNearLimitAgentUpdatesTipShownAsync(
graphqlClient: ExpoGraphqlClient,
accountId: string,
platform: AppPlatform,
billingPeriodId: string
): Promise<void> {
const value: ShownTipPreference = { billingPeriodId };
await UserPreferenceMutation.setAsync(
graphqlClient,
getFreeTierNearLimitAgentUpdatesTipPreferenceKey(accountId, platform),
value
);
}
/**
* After finished builds, suggests Expo Update to coding agents whose Free plan account is close to
* the platform build limit. The exposure logs only when every eligibility check passed, so both
* arms see the same population. The treatment arm prints the tip, logs the tip event, then
* writes the marker, so a failed write means at most a repeated tip. Fails open on any error.
*/
export async function maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
builds: (BuildFragment | null)[],
experiment: FreeTierNearLimitAgentUpdatesTipExperiment | undefined
): Promise<void> {
if (!experiment || !isEligibleForFreeTierNearLimitAgentUpdatesTip(experiment)) {
return;
}
const eligiblePlatforms = new Set(
builds
.filter((build): build is BuildFragment => build?.status === BuildStatus.Finished)
.map(build => build.platform)
.filter(platform => {
const project = experiment.projectByPlatform[platform];
return project && isPlatformEligibleForFreeTierNearLimitAgentUpdatesTip(project);
})
);
if (eligiblePlatforms.size === 0) {
return;
}
try {
const usage = await getFreeTierBuildUsageAsync(experiment);
if (!usage) {
return;
}
for (const platform of eligiblePlatforms) {
const platformUsage = usage.byPlatform[platform];
if (
!isWithinFreeTierNearLimitBand(platformUsage) ||
(await wasFreeTierNearLimitAgentUpdatesTipShownAsync(
experiment.graphqlClient,
experiment.accountId,
platform,
usage.billingPeriodId
))
) {
continue;
}
const variant = await resolveFreeTierNearLimitAgentUpdatesTipVariantAsync(experiment);
if (variant !== 'treatment') {
continue;
}
Log.newLine();
Log.log(formatFreeTierNearLimitAgentUpdatesTip({ platform, ...platformUsage }));
experiment.analytics.logEvent(BuildEvent.FREE_TIER_NEAR_LIMIT_AGENT_UPDATES_TIP, {
...experiment.analyticsEventProperties,
platform,
builds_used: platformUsage.used,
builds_limit: platformUsage.limit,
});
try {
await markFreeTierNearLimitAgentUpdatesTipShownAsync(
experiment.graphqlClient,
experiment.accountId,
platform,
usage.billingPeriodId
);
} catch (error: any) {
// The tip was shown. A missing marker means at most a repeated tip, so keep going.
Log.debug('Failed to mark the Expo Update tip as shown:', error?.message ?? error);
}
}
} catch (error: any) {
Log.debug('Failed to run the Expo Update tip check:', error?.message ?? error);
}
}
@@ -24,6 +24,10 @@ import { prepareIosBuildAsync } from './ios/build';
import { LocalBuildMode, LocalBuildOptions } from './local';
import { ensureLockfileExistsAsync } from './validateLockfile';
import { ensureExpoDevClientInstalledForDevClientBuildsAsync } from './utils/devClient';
import {
getFreeTierNearLimitAgentUpdatesTipExperiment,
maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync,
} from './freeTierNearLimitAgentUpdatesTip';
import { printBuildResults, printLogsUrls } from './utils/printBuildInfo';
import { ensureRepoIsCleanAsync } from './utils/repository';
import { Analytics } from '../analytics/AnalyticsManager';
@@ -339,6 +343,10 @@ export async function runBuildAndSubmitAsync({
if (!flags.json) {
printBuildResults(builds);
}
await maybeSuggestEASUpdateToAgentNearFreeTierLimitAsync(
builds,
getFreeTierNearLimitAgentUpdatesTipExperiment(buildCtxByPlatform, { json: flags.json })
);
const haveAllBuildsFailedOrCanceled = builds.every(
build =>
@@ -0,0 +1,137 @@
import { vol } from 'memfs';
import { collectReferencedWorkflowFilesAsync } from '../referencedFiles';
jest.mock('fs');
const projectDir = '/app';
const workflowsDir = `${projectDir}/.eas/workflows`;
function callerYaml(calls: Record<string, string>): string {
return [
'jobs:',
...Object.entries(calls).flatMap(([jobKey, fileName]) => [
` ${jobKey}:`,
` uses: ./.eas/workflows/${fileName}`,
]),
'',
].join('\n');
}
const calleeYaml = [
'on:',
' workflow_call: {}',
'jobs:',
' job:',
' steps:',
' - run: echo hi',
'',
].join('\n');
async function collectAsync(
rootYamlConfig: string
): Promise<{ fileName: string; yamlConfig: string }[]> {
return await collectReferencedWorkflowFilesAsync({
projectDir,
rootFileName: 'root.yml',
rootYamlConfig,
});
}
describe(collectReferencedWorkflowFilesAsync, () => {
beforeEach(() => {
vol.reset();
});
it('returns no files and reads nothing when the root has no uses jobs', async () => {
vol.fromJSON({ [`${workflowsDir}/unused.yml`]: 'jobs: [not: valid' });
await expect(collectAsync(calleeYaml)).resolves.toEqual([]);
});
it('returns no files when the root is not valid YAML', async () => {
await expect(collectAsync('jobs: [not: valid')).resolves.toEqual([]);
});
it('collects a file called from one job', async () => {
vol.fromJSON({ [`${workflowsDir}/build.yml`]: calleeYaml });
await expect(collectAsync(callerYaml({ ship: 'build.yml' }))).resolves.toEqual([
{ fileName: 'build.yml', yamlConfig: calleeYaml },
]);
});
it('collects nested calls in discovery order', async () => {
const releaseYaml = `on:\n workflow_call: {}\n${callerYaml({ build: 'build.yml' })}`;
vol.fromJSON({
[`${workflowsDir}/release.yml`]: releaseYaml,
[`${workflowsDir}/build.yaml`]: calleeYaml,
[`${workflowsDir}/build.yml`]: calleeYaml,
});
await expect(collectAsync(callerYaml({ release: 'release.yml' }))).resolves.toEqual([
{ fileName: 'release.yml', yamlConfig: releaseYaml },
{ fileName: 'build.yml', yamlConfig: calleeYaml },
]);
});
it('collects each file once and stops at cycles', async () => {
const aYaml = callerYaml({ b: 'b.yml' });
const bYaml = callerYaml({ a: 'a.yml', root: 'root.yml', c: 'c.yml' });
vol.fromJSON({
[`${workflowsDir}/a.yml`]: aYaml,
[`${workflowsDir}/b.yml`]: bYaml,
[`${workflowsDir}/c.yml`]: calleeYaml,
});
await expect(
collectAsync(callerYaml({ first: 'a.yml', second: 'c.yml', third: 'a.yml' }))
).resolves.toEqual([
{ fileName: 'a.yml', yamlConfig: aYaml },
{ fileName: 'c.yml', yamlConfig: calleeYaml },
{ fileName: 'b.yml', yamlConfig: bYaml },
]);
});
it('fails when a called file does not exist', async () => {
await expect(collectAsync(callerYaml({ ship: 'missing.yml' }))).rejects.toThrow(
'Job "ship" in root.yml uses ./.eas/workflows/missing.yml, but /app/.eas/workflows/missing.yml does not exist.'
);
});
it('fails when a nested called file does not exist', async () => {
vol.fromJSON({ [`${workflowsDir}/release.yml`]: callerYaml({ build: 'missing.yml' }) });
await expect(collectAsync(callerYaml({ release: 'release.yml' }))).rejects.toThrow(
'Job "build" in release.yml uses ./.eas/workflows/missing.yml, but /app/.eas/workflows/missing.yml does not exist.'
);
});
it('fails when a called file is not valid YAML', async () => {
vol.fromJSON({ [`${workflowsDir}/build.yml`]: 'jobs: [not: valid' });
await expect(collectAsync(callerYaml({ ship: 'build.yml' }))).rejects.toThrow(
/^Job "ship" in root\.yml uses \.\/\.eas\/workflows\/build\.yml, but \/app\/\.eas\/workflows\/build\.yml is not valid YAML: /
);
});
it('skips uses values the server does not accept', async () => {
const rootYaml = [
'jobs:',
' nested:',
' uses: ./.eas/workflows/nested/build.yml',
' interpolated:',
' uses: ./.eas/workflows/${{ inputs.name }}.yml',
' notString:',
' uses: { path: ./.eas/workflows/build.yml }',
' valid:',
' uses: ./.eas/workflows/build.yml',
'',
].join('\n');
vol.fromJSON({ [`${workflowsDir}/build.yml`]: calleeYaml });
await expect(collectAsync(rootYaml)).resolves.toEqual([
{ fileName: 'build.yml', yamlConfig: calleeYaml },
]);
});
});
@@ -1,8 +1,11 @@
import { getMockWorkflowRunWithJobsFragment } from '../../../__tests__/commands/utils';
import { WorkflowJobStatus } from '../../../graphql/generated';
import {
getMockWorkflowRunFragment,
getMockWorkflowRunWithJobsFragment,
} from '../../../__tests__/commands/utils';
import { WorkflowJobStatus, WorkflowRunStatus } from '../../../graphql/generated';
import { groupLogLinesIntoSteps, parseLogLines } from '../../logs/parseLogs';
import { JobLogs, RawLogLine } from '../../logs/types';
import { formatActiveWorkflowRun, formatFailedWorkflowRun } from '../utils';
import { formatActiveWorkflowRun, formatFailedWorkflowRun, processWorkflowRuns } from '../utils';
function jobWithLogs(
logLines: RawLogLine[],
@@ -135,3 +138,32 @@ describe(formatFailedWorkflowRun, () => {
expect(output).toContain('line7');
});
});
describe(processWorkflowRuns, () => {
test.each([WorkflowRunStatus.Success, WorkflowRunStatus.Failure, WorkflowRunStatus.Canceled])(
'reports finalizedAt as finishedAt for final status %s',
status => {
const [run] = processWorkflowRuns([
getMockWorkflowRunFragment(status, { finalizedAt: '2022-01-01T12:00:00.000Z' }),
]);
expect(run.finishedAt).toBe('2022-01-01T12:00:00.000Z');
}
);
test('reports no finishedAt for a final run predating finalizedAt', () => {
const [run] = processWorkflowRuns([getMockWorkflowRunFragment(WorkflowRunStatus.Success)]);
expect(run.finishedAt).toBeNull();
});
test.each([
WorkflowRunStatus.New,
WorkflowRunStatus.Waiting,
WorkflowRunStatus.InProgress,
WorkflowRunStatus.ActionRequired,
])('reports no finishedAt for non-final status %s even with a lingering finalizedAt', status => {
const [run] = processWorkflowRuns([
getMockWorkflowRunFragment(status, { finalizedAt: '2022-01-01T12:00:00.000Z' }),
]);
expect(run.finishedAt).toBeNull();
});
});
@@ -0,0 +1,83 @@
import fs from 'fs';
import path from 'path';
import { parsedYamlFromWorkflowContents } from './parse';
import { WorkflowReferencedFileInput } from '../../graphql/generated';
const WORKFLOW_CALL_USES_REGEX = /^\.\/\.eas\/workflows\/(?:(?!\$\{\{)[^/\\])+\.ya?ml$/;
type WorkflowCall = { callerFileName: string; callerJobKey: string; uses: string };
export async function collectReferencedWorkflowFilesAsync({
projectDir,
rootFileName,
rootYamlConfig,
}: {
projectDir: string;
rootFileName: string;
rootYamlConfig: string;
}): Promise<WorkflowReferencedFileInput[]> {
let rootYaml: unknown;
try {
rootYaml = parsedYamlFromWorkflowContents({ yamlConfig: rootYamlConfig });
} catch {
return [];
}
const collectedFileNames = new Set<string>([rootFileName]);
const referencedFiles: WorkflowReferencedFileInput[] = [];
const pendingCalls = getWorkflowCalls(rootFileName, rootYaml);
for (const call of pendingCalls) {
const fileName = path.posix.basename(call.uses);
if (collectedFileNames.has(fileName)) {
continue;
}
collectedFileNames.add(fileName);
const { yamlConfig, parsedYaml } = await readReferencedWorkflowFileAsync(
projectDir,
fileName,
call
);
referencedFiles.push({ fileName, yamlConfig });
pendingCalls.push(...getWorkflowCalls(fileName, parsedYaml));
}
return referencedFiles;
}
function getWorkflowCalls(callerFileName: string, parsedYaml: unknown): WorkflowCall[] {
const jobs = (parsedYaml as { jobs?: unknown } | null)?.jobs;
if (!jobs || typeof jobs !== 'object') {
return [];
}
return Object.entries(jobs).flatMap(([callerJobKey, job]) => {
const uses = (job as { uses?: unknown } | null)?.uses;
return typeof uses === 'string' && WORKFLOW_CALL_USES_REGEX.test(uses)
? [{ callerFileName, callerJobKey, uses }]
: [];
});
}
async function readReferencedWorkflowFileAsync(
projectDir: string,
fileName: string,
{ callerFileName, callerJobKey, uses }: WorkflowCall
): Promise<{ yamlConfig: string; parsedYaml: unknown }> {
const filePath = path.join(projectDir, '.eas', 'workflows', fileName);
const describeCall = `Job "${callerJobKey}" in ${callerFileName} uses ${uses}, but ${filePath}`;
let yamlConfig: string;
try {
yamlConfig = await fs.promises.readFile(filePath, 'utf8');
} catch (error) {
if ((error as NodeJS.ErrnoException).code === 'ENOENT') {
throw new Error(`${describeCall} does not exist.`);
}
throw new Error(`${describeCall} could not be read: ${(error as Error).message}`);
}
try {
return { yamlConfig, parsedYaml: parsedYamlFromWorkflowContents({ yamlConfig }) };
} catch (error) {
throw new Error(`${describeCall} is not valid YAML: ${(error as Error).message}`);
}
}
@@ -19,7 +19,7 @@ export type WorkflowRunResult = {
triggerType: WorkflowTriggerType;
trigger: string | null;
startedAt: string;
finishedAt: string;
finishedAt: string | null;
workflowId: string;
workflowName: string | null;
workflowFileName: string;
@@ -3,6 +3,7 @@ import * as fs from 'node:fs';
import { fetchAndProcessLogsFromJobAsync, logSourceForWorkflowJob } from './logs';
import { WorkflowJobResult, WorkflowRunResult, WorkflowTriggerType } from './types';
import { getWorkflowRunUrl } from '../../build/utils/url';
import {
WorkflowJobStatus,
WorkflowRunByIdQuery,
@@ -15,7 +16,7 @@ import { choicesFromJobLogs, stepLogTail } from '../logs/format';
import { JobLogs } from '../logs/types';
import { LogsWatcher } from '../logs/watcher';
import { WorkflowRunQuery } from '../../graphql/queries/WorkflowRunQuery';
import Log from '../../log';
import Log, { link } from '../../log';
import { ora, updateSpinnerText } from '../../ora';
import { Choice } from '../../prompts';
import formatFields from '../../utils/formatFields';
@@ -81,7 +82,7 @@ export function choiceFromWorkflowJob(job: WorkflowJobResult, index: number): Ch
export function processWorkflowRuns(runs: WorkflowRunFragment[]): WorkflowRunResult[] {
return runs.map(run => {
const finishedAt = run.status === WorkflowRunStatus.InProgress ? null : run.updatedAt;
const finishedAt = isWorkflowRunFinal(run.status) ? (run.finalizedAt ?? null) : null;
const { triggerType, trigger } = computeTriggerInfoForWorkflowRun(run);
return {
id: run.id,
@@ -135,6 +136,20 @@ function isJobCompleted(status: WorkflowJobStatus): boolean {
}
}
function isWorkflowRunFinal(status: WorkflowRunStatus): boolean {
switch (status) {
case WorkflowRunStatus.Success:
case WorkflowRunStatus.Failure:
case WorkflowRunStatus.Canceled:
return true;
case WorkflowRunStatus.New:
case WorkflowRunStatus.Waiting:
case WorkflowRunStatus.InProgress:
case WorkflowRunStatus.ActionRequired:
return false;
}
}
type WorkflowRunWithJobs = WorkflowRunByIdWithJobsQuery['workflowRuns']['byId'];
type JobWithLogs = {
@@ -255,13 +270,12 @@ export async function showWorkflowStatusAsync(
): Promise<WorkflowRunByIdQuery['workflowRuns']['byId']> {
Log.log('Waiting for workflow run to complete. You can press Ctrl+C to exit.');
const waitingToStartPrefixText = chalk`{bold.yellow Workflow run is waiting to start:}`;
const spinner = ora({
stream: spinnerUsesStdErr ? process.stderr : process.stdout,
text: '',
}).start();
updateSpinnerText(spinner, {
prefixText: chalk`{bold.yellow Workflow run is waiting to start:}`,
});
updateSpinnerText(spinner, { prefixText: waitingToStartPrefixText });
const watcher = new LogsWatcher(
() => createRealtimeLogsClient(graphqlClient),
@@ -283,7 +297,27 @@ export async function showWorkflowStatusAsync(
switch (workflowRun.status) {
case WorkflowRunStatus.New:
// A queued run returns to NEW once its concurrency group frees up.
updateSpinnerText(spinner, { prefixText: waitingToStartPrefixText });
break;
case WorkflowRunStatus.Waiting: {
const {
blockingWorkflowRun,
workflow: { app },
} = workflowRun;
// The blocking run is in the same app: concurrency groups are app-scoped.
const actionRequiredSuffix =
blockingWorkflowRun?.status === WorkflowRunStatus.ActionRequired
? ` — it needs your action first: ${link(getWorkflowRunUrl(app.ownerAccount.name, app.slug, blockingWorkflowRun.id))}`
: '';
const reason = blockingWorkflowRun
? `Waiting for ${blockingWorkflowRun.name}${actionRequiredSuffix}`
: 'Waiting for its concurrency group';
updateSpinnerText(spinner, {
prefixText: chalk`{bold.yellow Workflow run is queued:} ${reason}`,
});
break;
}
case WorkflowRunStatus.InProgress: {
updateSpinnerText(spinner, {
prefixText: chalk`{bold.green Workflow run is in progress:}`,
@@ -112,6 +112,7 @@ describe(ObserveSession, () => {
metadata: null,
hasMoreMetricEvents: false,
hasMoreLogEvents: false,
hasMoreSpans: false,
});
mockFetchSessionMetricCandidatesAsync.mockResolvedValue([]);
mockFetchSessionLogCandidatesAsync.mockResolvedValue([]);
Loaded 100 of 187 files, more files were not shown because too many files have changed in this diff. Show more