Add support for R-GCIP tenant configuration #14979
Conversation
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback. |
Generated by 🚫 Danger |
| /// | ||
| /// - Parameters: | ||
| /// - tenantId: The ID of the tenant. | ||
| /// - location: The location of the tenant. Defaults to "prod-global". |
There was a problem hiding this comment.
Is there any documentation URL we can link to for other acceptable strings?
There was a problem hiding this comment.
@ncooke3 Thanks for the suggestion. We will eventually publish this in our public docs, at that time we can update the documentation here. As of now, we do not have this public docs so we cannot add a link.
| @@ -140,6 +140,22 @@ extension Auth: AuthInterop { | |||
| } | |||
| } | |||
|
|
|||
| /// Holds configuration for a Regional Google Cloud Identity Platform (R-GCIP) tenant. | |||
| public struct TenantConfig: Sendable { | |||
There was a problem hiding this comment.
Because this type is defined within class Auth { ... }, clients outside the module would access it like:
let tenant = Auth.TenantConfig(...)I was thinking this should be moved into the top-level scope of the module, WDYT?
| /// - tenantConfig: The configuration for the R-GCIP tenant, specifying the tenant ID and its | ||
| /// location. | ||
| /// - Returns: The `Auth` instance associated with the given app and tenant config. | ||
| public static func auth(app: FirebaseApp, tenantConfig: TenantConfig) -> Auth { |
There was a problem hiding this comment.
Totally optional, but it may help to put regionalization related API in an Auth extension.
class Auth {}
// Down below/Another file
public extension Auth {
// regionalization API
}Since it's just one API, it might not be worth doing now, but something to keep in mind as the project expands.
| @@ -140,6 +140,22 @@ extension Auth: AuthInterop { | |||
| } | |||
| } | |||
|
|
|||
| /// Holds configuration for a Regional Google Cloud Identity Platform (R-GCIP) tenant. | |||
| public struct TenantConfig: Sendable { | |||
| /// | ||
| /// - Parameters: | ||
| /// - tenantId: The ID of the tenant. | ||
| /// - location: The location of the tenant. Defaults to "prod-global". |
There was a problem hiding this comment.
@ncooke3 Thanks for the suggestion. We will eventually publish this in our public docs, at that time we can update the documentation here. As of now, we do not have this public docs so we cannot add a link.
| /// The Regional Google Cloud Identity Platform (R-GCIP) location. | ||
| /// This is set when the `Auth` instance is initialized with a `TenantConfig`. | ||
| var location: String? | ||
|
|
||
| /// The Regional Google Cloud Identity Platform (R-GCIP) tenant ID. | ||
| /// This is set when the `Auth` instance is initialized with a `TenantConfig`. | ||
| var tenantId: String? | ||
|
|
There was a problem hiding this comment.
Can we not have this as TenantConfig type instead of splitting them separately? Any reason to keep it separate? Ideally these should not be separately set by themselves, so IMO we should not keep it separate.
Description
This PR introduces support for Regional GCIP (R-GCIP) within the Firebase Auth iOS SDK. Developers can now initialize an
Authinstance tied to a specific tenant ID and location.The key changes are:
TenantConfigStruct: ASendablestructTenantConfighas been added to hold thetenantIdandlocation(defaulting to "prod-global").AuthFactory Method: A new static methodAuth.auth(app: FirebaseApp, tenantConfig: TenantConfig)allows initialization with R-GCIP parameters.AuthRequestConfiguration: The internalAuthRequestConfigurationclass now includeslocationandtenantIdproperties, populated during initialization if aTenantConfigis provided.These changes enable applications to work with regionalized Firebase Authentication backends.
Changelog
TenantConfigand a newAuthinitializer to specify tenant ID and location.