Nick Cooke d91a5bc06f [Remote Config] Attempt to reduce int. tests flakes (#13019) 1 rok temu
..
FakeConsole e8a12e04c2 Improve/use shorthand syntax for unwrapping optionals and fix typos (#12369) 1 rok temu
FakeUtils 2246d8ff8c RC Swift pod and codable (#9084) 4 lat temu
ObjC 4e5b83f2d9 Merge Realtime into Remote Config (#10060) 3 lat temu
SwiftAPI d91a5bc06f [Remote Config] Attempt to reduce int. tests flakes (#13019) 1 rok temu
AccessToken.json 2246d8ff8c RC Swift pod and codable (#9084) 4 lat temu
Defaults-testInfo.plist bc2bc6b9f2 Fix RC Codable to handle arrays and dictionaries from plist defaults (#10046) 3 lat temu
README.md ca522d2d2a [Infra] Rename references from `master` to `main` (#12203) 2 lat temu

README.md

Remote Config Swift Tests

Currently the Remote Config tests run in two configurations:

  1. Fake Console - mocks the console to run tests with a dummy GoogleService-Info.plist.
  2. Remote Config Console API - relies on generating an access token to use a real Firebase project.

Remote Config Console API

RemoteConfigConsole.swift provides a simple API for interacting with an app's Remote Config on the Firebase console.

Local Development Setup

  1. Create a Firebase project on the Firebase Console and download the GoogleService-Info.plist.
  2. Navigate to your project's settings. Click on the Service accounts tab and then download a private key by clicking the blue button that says "Generate new private key". Rename it ServiceAccount.json.
  3. Within the firebase-ios-sdk, run:

    ./scripts/generate_access_token.sh local_dev PATH/TO/ServiceAccount.json FirebaseRemoteConfigSwift/Tests/AccessToken.json
    
  4. Generate the FirebaseRemoteConfig project:

    pod gen FirebaseRemoteConfig.podspec --local-sources=./ --auto-open --platforms=ios
    
  5. Copy the GoogleService-Info.plist you downloaded earlier into the generated Xcode project.

🚀 Everything is ready to go! Run the tests in the swift-api-tests target.

How it works

While the RemoteConfigConsole API basically just makes simple network calls, we need to include an access token so our requests do the proper "handshake" with the Firebase console.

Firebase Service Account Private Key

This private key is needed to create an access token with the valid parameters that authorizes our requests to programmatically make changes to remote config on the Firebase console.

The private key can be located on the Firebase console and navigate to your project's settings. To download, click on the Service accounts tab and then generate the private key by clicking the blue button that says "Generate new private key".

Create the Access Token

We use Google's Auth Library for Swift to generate the access token. There are a few example use cases provided. We use the TokenSource example.

For the access token to be generated, the GOOGLE_APPLICATION_CREDENTIALS env var should be set to point to where the Firebase project's service account key is stored. This is set in the generate_access_token.sh script.

Remote Config API Tests

There is a section of tests in APITests.swift showcasing the RemoteConfigConsole in action.