[eas-cli] Fix metadata:push silently skipping screenshot reorder when set already matches by (filename, fileSize)

[Maples7]

Why

Refs #3690. Closes #3690.

eas metadata:push can finish reporting success while App Store Connect still shows screenshots in a different order than the local store.config.json. This happens when every (filename, fileSize) pair in a screenshot set already matches what's live, so eas-cli skips upload — but the reorder step that should still run is silently a no-op, locking in whatever order ASC currently has (often stale from an earlier transient failure).

Root cause

In packages/eas-cli/src/metadata/apple/tasks/screenshots.ts, after the upload pass, eas-cli refreshes the set to read the live order:

const refreshedSet = await AppScreenshotSet.infoAsync(localization.context, {
  id: screenshotSet.id,
});
const refreshedScreenshots = refreshedSet.attributes.appScreenshots || [];

AppScreenshotSet.infoAsync is defined in @expo/apple-utils (≤ 2.1.21) without a defaultQuery, so the underlying request is GET /v1/appScreenshotSets/{id} with no ?include=appScreenshots.

I verified empirically against a live ASC app:

Call	relationships.appScreenshots.data
GET /v1/appScreenshotSets/{id} (no ?include)	completely missing
GET /v1/appScreenshotSets/{id}?include=appScreenshots	10 entries, canonical order
GET /v1/appScreenshotSets/{id}/relationships/appScreenshots	10 entries, canonical order

The JSON:API parser in @expo/apple-utils skips relationships with no data:

for (const [t, a] of Object.entries(r)) {
  const r = a?.data;
  if (!r) continue;   // ← include omitted → data undefined → relationship dropped
  ...
}

So refreshedSet.attributes.appScreenshots ends up undefined → refreshedScreenshots = [] → screenshotsByFilename is empty → orderedIds is empty → the if (orderedIds.length > 0 && …) reorder guard is never satisfied → reorderScreenshotsAsync is never called → live order stays stale.

It's worth noting AppStoreVersionLocalization.getAppScreenshotSetsAsync (the call eas-cli uses to populate the initial screenshotSets map in prepareAsync) hardcodes includes: [..., 'appScreenshots'], which is why everything else in this file works. Only the post-upload refresh was affected.

How

AppScreenshotSet.infoAsync accepts query?: ConnectQueryParams, so we can compensate from eas-cli without waiting for an @expo/apple-utils release:

const refreshedSet = await AppScreenshotSet.infoAsync(localization.context, {
  id: screenshotSet.id,
  query: { includes: ['appScreenshots'] },
});

The longer-term fix is to add defaultQuery: { includes: ['appScreenshots'] } to AppScreenshotSet.infoAsync inside @expo/apple-utils (it's already done for similar models like CustomerReview, which uses DEFAULT_INCLUDES). I'm filing that suggestion separately on #3690 so the maintainers of the package can route it.

Test Plan

• Added a regression test in screenshots.test.ts:
  • asserts AppScreenshotSet.infoAsync is called with query: { includes: ['appScreenshots'] },
  • simulates a live store whose order is reversed compared to the local config,
  • asserts reorderScreenshotsAsync is called with the desired order.

Local results:

• yarn build → green (lerna build for 13 projects).
• yarn lint → no new errors (12 pre-existing warnings unrelated to this change).
• yarn jest --testPathPattern='metadata' → 191 / 191 passing (16 suites).

/changelog-entry bug-fix [eas-cli] Fix metadata:push silently skipping screenshot reorder when every (filename, fileSize) already matches the live set.

[github-actions]

Subscribed to pull request

File Patterns	Mentions
**/*	@douglowder
packages/eas-cli/src/metadata/**	@byCedric

Generated by CodeMention