feat(cli): fastlane APNs key setup on spaceship

[ArnabChatterjee20k]

Stacked on #1992 (the APNs key setup adapters). This is the fastlane adapter, built on spaceship, fastlane's open-source (MIT) Apple Developer portal client. spaceship is the most actively maintained of the three implementations, which makes it a good fallback when Apple changes its API.

What

internal/apns/fastlane: an apns.Adapter named fastlane that creates the key with the fastlane the person already has installed.

appwrite init apns --create-key --provider fastlane
# or
APPWRITE_APNS_SETUP=fastlane appwrite init apns --create-key

How

• The lane: a Fastfile with one lane, create_apns_key, is embedded with go:embed. On each run it's written to fastlane/Fastfile in a private temp folder and run there with fastlane create_apns_key out:… name:… environment:… [team_id:…]. The CLI ships no Ruby; it uses the fastlane already installed:
  • Bundler: when the Gemfile in the folder the CLI runs in, or in its ios/ folder (Flutter and React Native keep it there), lists fastlane and bundle is installed, it runs bundle exec fastlane with BUNDLE_GEMFILE set to that Gemfile, so the project's pinned fastlane runs from the temp folder.
  • Otherwise: fastlane from PATH (a gem or Homebrew installation).
• Requirements: fastlane 2.225.0 or later. Its release notes (21 October 2024) call it "a required fix for authenticating with Apple via Apple ID": the first spaceship with SRP sign-in, without which Apple answers 503. A missing or older fastlane returns apns.ErrUnavailable before anything is sent to Apple, with fastlane update_fastlane advice.
• Credentials: the adapter asks for the Apple ID and password through the CLI's prompts when the request has none (APPWRITE_APPLE_ID / APPWRITE_APPLE_PASSWORD answer them), and passes them as FASTLANE_USER / FASTLANE_PASSWORD, so fastlane's credentials manager never offers to store them in the Keychain.
• Terminal: spaceship asks for the two-factor code, and for a team when the account has several, on the terminal. Its own session cache (~/.fastlane/spaceship/) skips two-factor on later runs.
• The lane's steps:
  1. Spaceship::Portal.login
  2. select_team(team_id:), or picks the only team or asks
  3. client.create_key! with { scope: 'team', environment: <requested> } for the APNs service
  4. client.download_key
• Environment: Key.create hard-codes environment: 'all', so the lane calls the client directly to honour --environment.
• Errors:
  • "maximum allowed number of Keys" becomes apns.MaxKeysError with the team's keys from list_keys.
  • Spaceship::InvalidUserCredentialsError becomes apns.ErrInvalidCredentials.
  • Anything else comes back as spaceship's message.
• Result: fastlane logs to stdout, so the lane writes it as JSON to a 0600 file named by out:.
• Environment variables: FASTLANE_SKIP_UPDATE_CHECK, FASTLANE_OPT_OUT_USAGE and FASTLANE_HIDE_CHANGELOG keep fastlane from checking for updates, sending usage data or printing changelogs during the run.

Tests

• Version parsing from fastlane --version output, including the multi-line installation banner, and the 2.225.0 minimum.
• Result decoding: key, full team, invalid credentials, failure, empty.
• With a stand-in fastlane:
  • the Fastfile is in place
  • the lane gets out:, name:, environment: and team_id:
  • the Apple ID and password are asked when missing and passed through the environment, and not asked when the request has them
  • an old or missing fastlane is refused without running the lane
• Bundler: finding a Gemfile that lists fastlane (project root or ios/), ignoring one that doesn't, and running bundle exec fastlane with BUNDLE_GEMFILE through a stand-in bundle.
• ruby -c on the Fastfile.

Not yet verified

A real run against Apple with fastlane installed, which wasn't possible on the machine this was written on. The spaceship calls used (login, select_team, client.create_key!, client.list_keys, client.download_key, client.team_id) were checked against spaceship's current source.

Note

Like #1993 and #1994, this adds one line to apnsAdapters(). Once all three are merged it reads apns.NewRegistry(appwrite.New(), expo.New(), fastlane.New()).

[hansi-codes]

🟢 Tier S · Ready to merge

The previously reported Bundler fallback issue is fixed, and the incremental changes introduce no additional defects.

Adds a fastlane APNs key setup adapter to the CLI, embedding a Fastfile that uses spaceship to create and download keys. It supports project Bundler installations, validates the installed fastlane version, and maps lane results and errors into the APNs adapter contract. The CLI registers the adapter and includes tests for its setup and execution paths.

Latest changes: The newest commits make the adapter return ErrUnavailable instead of falling back to a global fastlane when the project pins fastlane but Bundler is unavailable, and add a test for that case.

Verdict	New comments	Fixed	Still open
✅ Approved	0	1	0

📂 Walkthrough · 5

File	Change
src/SDK/Language/CLI.php	Registers the fastlane adapter, test file, and embedded Fastfile in the generated CLI.
templates/cli/internal/apns/fastlane/adapter.go	Runs the embedded spaceship lane, selects project Bundler when configured, validates fastlane, and maps results to APNs keys and errors.
templates/cli/internal/apns/fastlane/adapter_test.go	Covers fastlane version and result parsing, credentials, lane execution, Bundler selection, and unavailable Bundler behavior.
templates/cli/internal/apns/fastlane/helper/Fastfile	Defines the lane for signing in, selecting a team, creating an APNs key, and writing its result.
templates/cli/internal/cmd/initpush.go	Adds fastlane to the CLI's APNs adapter registry.

✅ Fixed since the last review · 1

• Don't silently bypass a detected Bundler fastlane · templates/cli/internal/apns/fastlane/adapter.go:216

---

_{Reviewed the commits since 5dfc509 · Details · Comment @hansi-codes review to re-run, or mention @hansi-codes with a question.}

[hansi-codes]

🔵 Tier A · See the inline comments. Summary

[hansi-codes]

🔵 Tier A · See the inline comments. Summary

[hansi-codes]

🟢 Tier S · Looks good to merge. Summary