Make the `FunctionsError` class publicly exported #8546

dlarocque · 2024-09-30T16:21:39Z

We should export the FunctionsError class to users, so that they can perform instanceof checks.

Tested using:

import { FirebaseError, initializeApp } from "firebase/app";
import { FunctionsError, getFunctions, httpsCallable } from "firebase/functions";

const firebaseConfig = {
  /* ... */
};

const app = initializeApp(firebaseConfig);
const functions = getFunctions(app);
(async () => {
  try {
    const addMessage = httpsCallable(functions, 'addMessage'); // Function does not exist
    await addMessage({ text: 'hello' });
  } catch (err) {
    console.log(err instanceof FirebaseError); // true
    console.log(err instanceof FunctionsError); // true
    throw err;
  }
})();

Also added an expect(error).to.be.instanceOf(FunctionsError) to all error checks in the tests.

Fixes #8511

changeset-bot · 2024-09-30T16:21:43Z

🦋 Changeset detected

Latest commit: 2aa4f34

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@firebase/functions	Patch
firebase	Patch
@firebase/functions-compat	Patch

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

google-oss-bot · 2024-09-30T16:38:21Z

Size Report ¹

Affected Products

@firebase/data-connect
Type Base (beaa4df) Merge (c351ba6) Diff
browser 19.8 kB 19.8 kB -1 B (-0.0%)
esm5 22.5 kB 22.5 kB -1 B (-0.0%)
main 24.3 kB 24.3 kB -1 B (-0.0%)
module 19.8 kB 19.8 kB -1 B (-0.0%)
@firebase/functions
Type Base (beaa4df) Merge (c351ba6) Diff
browser 9.76 kB 9.83 kB +68 B (+0.7%)
esm5 12.1 kB 12.2 kB +69 B (+0.6%)
main 12.8 kB 12.9 kB +155 B (+1.2%)
module 9.76 kB 9.83 kB +68 B (+0.7%)
@firebase/messaging
Type Base (beaa4df) Merge (c351ba6) Diff
browser 21.3 kB 21.3 kB -84 B (-0.4%)
esm5 26.8 kB 26.7 kB -84 B (-0.3%)
main 27.4 kB 27.4 kB -84 B (-0.3%)
module 21.3 kB 21.3 kB -84 B (-0.4%)
@firebase/messaging-sw
Type Base (beaa4df) Merge (c351ba6) Diff
main 30.4 kB 30.4 kB -59 B (-0.2%)
module 23.6 kB 23.5 kB -59 B (-0.3%)
bundle
Type Base (beaa4df) Merge (c351ba6) Diff
functions (call) 32.0 kB 32.1 kB +41 B (+0.1%)
messaging (send + receive) 47.0 kB 46.9 kB -73 B (-0.2%)

`firebase`

Type	Base (`beaa4df`)	Merge (`c351ba6`)	Diff
firebase-compat.js	788 kB	788 kB	-102 B (-0.0%)
firebase-data-connect.js	16.5 kB	16.5 kB	-1 B (-0.0%)
firebase-functions-compat.js	8.22 kB	8.26 kB	+40 B (+0.5%)
firebase-functions.js	12.0 kB	12.0 kB	+68 B (+0.6%)
firebase-messaging-compat.js	38.4 kB	38.3 kB	-143 B (-0.4%)
firebase-messaging-sw.js	30.2 kB	30.1 kB	-71 B (-0.2%)
firebase-messaging.js	28.7 kB	28.7 kB	-96 B (-0.3%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/rIrdZ0MgCh.html

google-oss-bot · 2024-09-30T16:50:51Z

Size Analysis Report ¹

Affected Products

@firebase/data-connect
- DataConnect
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.5 kB 11.5 kB -1 B (-0.0%)
  size-with-ext-deps 29.6 kB 29.6 kB -1 B (-0.0%)
- MUTATION_STR
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.5 kB 11.5 kB -1 B (-0.0%)
  size-with-ext-deps 29.6 kB 29.6 kB -1 B (-0.0%)
- MutationManager
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.5 kB 11.5 kB -1 B (-0.0%)
  size-with-ext-deps 29.6 kB 29.6 kB -1 B (-0.0%)
- QUERY_STR
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.5 kB 11.5 kB -1 B (-0.0%)
  size-with-ext-deps 29.6 kB 29.6 kB -1 B (-0.0%)
- SOURCE_CACHE
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.5 kB 11.5 kB -1 B (-0.0%)
  size-with-ext-deps 29.6 kB 29.6 kB -1 B (-0.0%)
- SOURCE_SERVER
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.5 kB 11.5 kB -1 B (-0.0%)
  size-with-ext-deps 29.6 kB 29.6 kB -1 B (-0.0%)
- connectDataConnectEmulator
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.6 kB 11.6 kB -1 B (-0.0%)
  size-with-ext-deps 29.7 kB 29.7 kB -1 B (-0.0%)
- executeMutation
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.6 kB 11.6 kB -1 B (-0.0%)
  size-with-ext-deps 29.7 kB 29.7 kB -1 B (-0.0%)
- executeQuery
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.6 kB 11.6 kB -1 B (-0.0%)
  size-with-ext-deps 29.7 kB 29.7 kB -1 B (-0.0%)
- getDataConnect
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 12.2 kB 12.2 kB -1 B (-0.0%)
  size-with-ext-deps 37.4 kB 37.4 kB -1 B (-0.0%)
- mutationRef
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.6 kB 11.6 kB -1 B (-0.0%)
  size-with-ext-deps 29.7 kB 29.7 kB -1 B (-0.0%)
- parseOptions
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.5 kB 11.5 kB -1 B (-0.0%)
  size-with-ext-deps 29.6 kB 29.6 kB -1 B (-0.0%)
- queryRef
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.6 kB 11.6 kB -1 B (-0.0%)
  size-with-ext-deps 29.7 kB 29.7 kB -1 B (-0.0%)
- setLogLevel
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.6 kB 11.6 kB -1 B (-0.0%)
  size-with-ext-deps 29.6 kB 29.6 kB -1 B (-0.0%)
- subscribe
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 12.8 kB 12.8 kB -1 B (-0.0%)
  size-with-ext-deps 37.9 kB 37.9 kB -1 B (-0.0%)
- terminate
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.6 kB 11.6 kB -1 B (-0.0%)
  size-with-ext-deps 29.6 kB 29.6 kB -1 B (-0.0%)
- toQueryRef
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 12.4 kB 12.4 kB -1 B (-0.0%)
  size-with-ext-deps 37.6 kB 37.6 kB -1 B (-0.0%)
- validateArgs
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 12.4 kB 12.4 kB -1 B (-0.0%)
  size-with-ext-deps 37.5 kB 37.5 kB -1 B (-0.0%)
- validateDCOptions
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 11.8 kB 11.8 kB -1 B (-0.0%)
  size-with-ext-deps 29.8 kB 29.8 kB -1 B (-0.0%)

`@firebase/functions`

`FunctionsError`

Size

Type	Base (`beaa4df`)	Merge (`c351ba6`)	Diff
size	?	2.52 kB	? (?)
size-with-ext-deps	?	20.3 kB	? (?)

Dependency

Type	Base (`beaa4df`)	Merge (`c351ba6`)	Diff
functions	?	registerFunctions	?
classes	?	ContextProvider FunctionsError FunctionsService	?
variables	?	APP_CHECK_INTERNAL_NAME AUTH_INTERNAL_NAME DEFAULT_REGION FUNCTIONS_TYPE MESSAGING_INTERNAL_NAME name version	?
enums	?		?

External Dependency

Module	Base (`beaa4df`)	Merge (`c351ba6`)	Diff
`@firebase/app`	?	_registerComponent registerVersion	?
`@firebase/component`	?	Component	?
`@firebase/util`	?	FirebaseError	?

httpsCallable
Size
Type Base (beaa4df) Merge (c351ba6) Diff
size 6.13 kB 6.17 kB +40 B (+0.7%)
size-with-ext-deps 24.0 kB 24.1 kB +41 B (+0.2%)
httpsCallableFromURL
Size
Type Base (beaa4df) Merge (c351ba6) Diff
size 6.08 kB 6.12 kB +40 B (+0.7%)
size-with-ext-deps 24.0 kB 24.0 kB +41 B (+0.2%)

@firebase/messaging
- deleteToken
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 12.7 kB 12.7 kB -72 B (-0.6%)
  size-with-ext-deps 39.5 kB 39.4 kB -73 B (-0.2%)
- getMessaging
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 12.8 kB 12.7 kB -73 B (-0.6%)
  size-with-ext-deps 46.7 kB 46.6 kB -73 B (-0.2%)
- getToken
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 12.2 kB 12.2 kB -72 B (-0.6%)
  size-with-ext-deps 39.0 kB 38.9 kB -73 B (-0.2%)
- isSupported
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 12.6 kB 12.5 kB -72 B (-0.6%)
  size-with-ext-deps 39.3 kB 39.2 kB -73 B (-0.2%)
- onMessage
  Size
  Type Base (beaa4df) Merge (c351ba6) Diff
  size 12.4 kB 12.3 kB -72 B (-0.6%)
  size-with-ext-deps 39.1 kB 39.0 kB -73 B (-0.2%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/6I17bQUjkj.html

packages/functions/src/error.ts

egilmorez

LG with tiny nits, thanks!

docs-devsite/functions.functionserror.md

github-actions · 2024-10-15T14:12:19Z

Vertex AI Mock Responses Check ⚠️

A newer major version of the mock responses for Vertex AI unit tests is available. update_vertexai_responses.sh should be updated to clone the latest version of the responses: v4.0

dlarocque added 4 commits September 26, 2024 16:27

Remove FunctionsError interface

f3402b9

Make FunctionsError class public

d1d9b01

Add changeset

2c6084e

Add instanceof check in tests

876e938

dlarocque requested a review from hsubox76 September 30, 2024 16:21

dlarocque requested review from a team as code owners September 30, 2024 16:21

dlarocque changed the title ~~Make the FunctionsError class publicly exported.~~ Make the FunctionsError class publicly exported Sep 30, 2024

hsubox76 approved these changes Oct 2, 2024

View reviewed changes

packages/functions/src/error.ts Outdated Show resolved Hide resolved

Make FunctionsError doc comment the same as the old interface

a5caf51

dlarocque requested a review from egilmorez October 3, 2024 15:50

Update devsite docs

f694fe1

egilmorez approved these changes Oct 7, 2024

View reviewed changes

docs-devsite/functions.functionserror.md Outdated Show resolved Hide resolved

docs-devsite/functions.functionserror.md Show resolved Hide resolved

dlarocque and others added 4 commits October 10, 2024 10:51

Add period to constructor doc comment

bae5c2e

Formatting

f934823

Update API reports

705a6c1

update docs

2aa4f34

dlarocque merged commit a214691 into main Oct 15, 2024
38 of 39 checks passed

dlarocque deleted the dl/functions-error branch October 15, 2024 14:57

google-oss-bot mentioned this pull request Oct 17, 2024

Version Packages #8581

Merged

Tech-FestivalDoJapao mentioned this pull request Nov 12, 2024

[Snyk] Upgrade firebase from 10.14.1 to 11.0.0 Tech-FestivalDoJapao/Gerenciamento#35

Merged

firebase locked and limited conversation to collaborators Nov 15, 2024

Make the FunctionsError class publicly exported #8546

Make the FunctionsError class publicly exported #8546

Conversation

dlarocque commented Sep 30, 2024 • edited Loading

changeset-bot bot commented Sep 30, 2024 • edited Loading

🦋 Changeset detected

google-oss-bot commented Sep 30, 2024 • edited Loading

Size Report 1

Affected Products

@firebase/data-connect

@firebase/functions

@firebase/messaging

@firebase/messaging-sw

bundle

firebase

Test Logs

google-oss-bot commented Sep 30, 2024 • edited Loading

Size Analysis Report 1

Affected Products

@firebase/data-connect

DataConnect

MUTATION_STR

MutationManager

QUERY_STR

SOURCE_CACHE

SOURCE_SERVER

connectDataConnectEmulator

executeMutation

executeQuery

getDataConnect

mutationRef

parseOptions

queryRef

setLogLevel

subscribe

terminate

toQueryRef

validateArgs

validateDCOptions

@firebase/functions

FunctionsError

httpsCallable

httpsCallableFromURL

@firebase/messaging

deleteToken

getMessaging

getToken

isSupported

onMessage

Test Logs

egilmorez left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 15, 2024

Vertex AI Mock Responses Check ⚠️

Make the `FunctionsError` class publicly exported #8546

Make the `FunctionsError` class publicly exported #8546

dlarocque commented Sep 30, 2024 •

edited

Loading

changeset-bot bot commented Sep 30, 2024 •

edited

Loading

google-oss-bot commented Sep 30, 2024 •

edited

Loading

Size Report ¹

`@firebase/data-connect`

`@firebase/functions`

`@firebase/messaging`

`@firebase/messaging-sw`

`bundle`

`firebase`

google-oss-bot commented Sep 30, 2024 •

edited

Loading

Size Analysis Report ¹

`@firebase/data-connect`

`DataConnect`

`MUTATION_STR`

`MutationManager`

`QUERY_STR`

`SOURCE_CACHE`

`SOURCE_SERVER`

`connectDataConnectEmulator`

`executeMutation`

`executeQuery`

`getDataConnect`

`mutationRef`

`parseOptions`

`queryRef`

`setLogLevel`

`subscribe`

`terminate`

`toQueryRef`

`validateArgs`

`validateDCOptions`

`@firebase/functions`

`FunctionsError`

`httpsCallable`

`httpsCallableFromURL`

`@firebase/messaging`

`deleteToken`

`getMessaging`

`getToken`

`isSupported`

`onMessage`