Add public FunctionsErrorCode type #6344
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 7664c1e The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1This report is too large (930,087 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.Test Logs |
egilmorez
reviewed
Jun 10, 2022
| @@ -72,6 +72,30 @@ export interface Functions { | |||
| customDomain: string | null; | |||
| } | |||
|
|
|||
| /** | |||
| * Functions error code string before adding "functions/" product prefix. | |||
There was a problem hiding this comment.
This makes it sound like the strings come before the prefix -- is that right?
Also, why specifically "product prefix?" Would that mean something like "functions/firestore?"
If we have a staged version of this, that could help me grok it I think.
There was a problem hiding this comment.
Staging it won't add anything that isn't here, unfortunately. Users were reporting that in v8, error codes were coming back as, for example, "deadline-exceeded" (one of the possible strings here) and in v9 they are coming back (more correctly) as "functions/deadline-exceeded" (since this is the functions package). We try to put a prefix with the SDK package name and a "/" before every error thrown by that SDK package. So Firestore should be throwing errors with code "firestore/something", auth should be throwing errors with code "auth/something", etc.
Lines 99-132 below have the main documentation for this code since that's the actual error code (with the prefix added) that users will see.
There was a problem hiding this comment.
Thanks!
So yes, if this is how it works, I'd expect something more like "* Functions error code string following the "functions/" product prefix."
or maybe "* Functions error code string appended after "functions/" product prefix."
WDYT?
There was a problem hiding this comment.
Oh, I see. I've changed it to "appended after".
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a public
FunctionsErrorCodetype that is prefixed with "functions/" to match the exact strings found inFunctionsError.Code.This uses template literal types which were introduced in Typescript 4.1. This should be ok for most users I hope? 4.1 was released in Nov 2020.
Fixes #6281