[Config] Split Codable APIs up and improve doc comments #14552
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ncooke3, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request refactors the RemoteConfig extension for Codable support by splitting the consolidated decoded and setDefaults functions into separate functions. This change aims to avoid potential breaking changes that could arise from adding new parameters with default values to existing functions. Additionally, the documentation for these functions has been improved for better clarity.
Highlights
- API Refactoring: The
decodedandsetDefaultsfunctions in theRemoteConfigextension have been split into two versions each: one with a defaultFirebaseDataDecoder/FirebaseDataEncoderand one that accepts a custom decoder/encoder. This provides more flexibility and avoids potential breaking changes. - Documentation Improvements: The documentation comments for the
decodedandsetDefaultsfunctions have been updated to provide more clarity on the parameters, return values, and potential errors.
Changelog
- FirebaseRemoteConfig/Swift/Codable.swift
- Introduced a new
decodedfunction without a decoder parameter that defaults toFirebaseDataDecoderat line 52. - Modified the existing
decodedfunction to explicitly require adecoderparameter at line 62. - Introduced a new
setDefaultsfunction without an encoder parameter that defaults toFirebaseDataEncoderat line 75. - Modified the existing
setDefaultsfunction to explicitly require anencoderparameter at line 84. - Added
ThrowsandReturnsdocumentation to thedecodedfunction at lines 50-51 and 60-61. - Added
Throwsdocumentation to thesetDefaultsfunction at lines 74 and 83.
- Introduced a new
Using Gemini Code Assist
The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Trivia time!
What is the purpose of the Codable protocol in Swift?
Click here for the answer
The `Codable` protocol in Swift is a type alias for the `Encodable` and `Decodable` protocols. Types that conform to `Codable` can be easily converted to and from a serialized format, such as JSON.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request splits the Codable APIs into two methods each, one with a default FirebaseDataDecoder/Encoder and one that allows a custom decoder/encoder to be passed in. This improves flexibility and avoids potential breaking changes. The documentation has also been improved. Overall, the changes look good.
Merge Readiness
The code changes look good and address the potential breaking change issue. The documentation improvements are also a plus. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging. There are no critical or high severity issues, so the pull request is ready to be merged once other reviewers have approved it.
Generated by 🚫 Danger |
|
CI issues are same of what I saw in CI and should be transient: https://github.com/firebase/firebase-ios-sdk/actions/runs/13768196350/job/38503479300?pr=14552 |
…)" This reverts commit ec29695.
Successor to #14525
After thinking about #14525 (comment) more, I don't think the consolidated signature is worth the potential of a breaking change. Besides assigning functions to variables, there are some possible other potentials of breaking: https://forums.swift.org/t/pitch-adding-new-parameters-w-default-values-should-not-break-api/66847
Also, improved documentation clarity.