Make FirebaseError publicly accessible

[justinattw]

Closes #576, towards #736

Allow integrators to access the FirebaseError by moving it from internal/errors.go to errorutils/errorutils.go, so that it is no longer internal only.

internal/errors.go will alias from errorutils/errorutils.go.

This brings feature parity with the Python library firebase/firebase-admin-python

Also, updates FirebaseError.String to FirebaseError.Message, as .String is not idiomatic for an error message in Go (#737 (review)).

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[gemini-code-assist]

Summary of Changes

Hello @justinattw, I'm Gemini Code Assist¹! 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!

This pull request significantly improves the usability of the Firebase Admin Go SDK by making its core error type, FirebaseError, and related error codes publicly available. Previously confined to an internal package, these error constructs are now exposed through a new errorutils package. This refactoring enables external developers to programmatically inspect and react to specific Firebase errors, leading to more sophisticated and reliable error handling within their applications. The change maintains backward compatibility for internal components by aliasing the moved types and functions.

Highlights

• Public FirebaseError: The FirebaseError type, along with its associated ErrorCode and utility functions, has been moved from the internal/errors.go package to a new, publicly accessible errorutils/errorutils.go package.
• Backwards Compatibility: The original internal/errors.go file now aliases the ErrorCode type, FirebaseError struct, and error code constants from the new errorutils package, ensuring existing internal code continues to function without modification.
• Enhanced Error Handling: This change allows external integrators to directly access and inspect FirebaseError instances, facilitating more robust and granular error handling in applications using the Firebase Admin Go SDK.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

Footnotes

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request successfully makes the FirebaseError type and related error-checking functions publicly accessible by moving them to the errorutils package. The changes are well-structured, and the addition of a comprehensive test suite for the new public API is a great inclusion. My review includes a suggestion to improve the public API of FirebaseError by renaming a field for better clarity, which is best done now as it's being exposed. I've also pointed out a couple of minor typos in comments. I've provided code suggestions for all changes within the diff.

[justinattw]

/gemini review

[gemini-code-assist]

Code Review

This pull request is a great step towards improving the public API of the SDK. Moving FirebaseError to a public package errorutils and renaming the String field to Message for idiomatic Go are excellent changes. The aliasing in the internal package ensures backward compatibility, which is well thought out.

I have one suggestion to further improve the new errorutils package by using errors.As for more robust error handling, which will be very beneficial for developers using this library. The rest of the changes look good.