Better JSON messages #8379

maneesht · 2024-07-19T21:17:26Z

When the server responds with an error, the response includes irrelevant information to the user in addition to the message itself. Instead of reporting this redundant information, we throw an error with just the nested message object.

changeset-bot · 2024-07-19T21:17:30Z

⚠️ No Changeset found

Latest commit: a18d457

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

google-oss-bot · 2024-07-19T21:33:04Z

Size Report ¹

Affected Products

@firebase/data-connect
Type Base (92caa93) Merge (773c8e7) Diff
browser 17.3 kB 17.4 kB +88 B (+0.5%)
esm5 19.5 kB 19.6 kB +90 B (+0.5%)
main 21.5 kB 21.6 kB +90 B (+0.4%)
module 17.3 kB 17.4 kB +88 B (+0.5%)
firebase
Type Base (92caa93) Merge (773c8e7) Diff
firebase-data-connect.js 14.8 kB 14.9 kB +62 B (+0.4%)

Test Logs

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

google-oss-bot · 2024-07-19T21:45:17Z

Size Analysis Report ¹

Affected Products

`@firebase/data-connect`

`DataConnect`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.6%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

13 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.5%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

13 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`FirebaseAuthProvider`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.5%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

13 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`MUTATION_STR`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.5%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

13 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`MutationManager`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.5%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

13 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`QUERY_STR`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.6%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

13 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`SOURCE_CACHE`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.6%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

13 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`SOURCE_SERVER`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.6%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

13 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`connectDataConnectEmulator`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.1 kB	10.1 kB	+55 B (+0.5%)
size-with-ext-deps	28.1 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

14 dependencies

addToken
compareDates
connectDataConnectEmulator
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

15 dependencies

addToken
compareDates
connectDataConnectEmulator
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`executeMutation`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.1 kB	10.1 kB	+55 B (+0.5%)
size-with-ext-deps	28.1 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

14 dependencies

addToken
compareDates
dcFetch
executeMutation
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

15 dependencies

addToken
compareDates
dcFetch
executeMutation
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`executeQuery`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.1 kB	10.1 kB	+55 B (+0.5%)
size-with-ext-deps	28.1 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

14 dependencies

addToken
compareDates
dcFetch
executeQuery
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

15 dependencies

addToken
compareDates
dcFetch
executeQuery
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`getDataConnect`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.7 kB	10.7 kB	+55 B (+0.5%)
size-with-ext-deps	35.8 kB	35.8 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

15 dependencies

addToken
compareDates
dcFetch
getDataConnect
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder
validateDCOptions

16 dependencies

addToken
compareDates
dcFetch
getDataConnect
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder
validateDCOptions

+ getMessage

`mutationRef`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.1 kB	10.2 kB	+55 B (+0.5%)
size-with-ext-deps	28.1 kB	28.2 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
mutationRef
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

15 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
mutationRef
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`parseOptions`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.6%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

13 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`queryRef`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.1 kB	10.2 kB	+55 B (+0.5%)
size-with-ext-deps	28.1 kB	28.2 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
queryRef
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

15 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
queryRef
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder

+ getMessage

`setLogLevel`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.5%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setLogLevel
setSDKVersion
urlBuilder

15 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setLogLevel
setSDKVersion
urlBuilder

+ getMessage

`subscribe`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	11.2 kB	11.3 kB	+55 B (+0.5%)
size-with-ext-deps	36.3 kB	36.4 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

18 dependencies

addToken
compareDates
dcFetch
getDataConnect
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
queryRef
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
subscribe
toQueryRef
urlBuilder
validateDCOptions

19 dependencies

addToken
compareDates
dcFetch
getDataConnect
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
queryRef
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
subscribe
toQueryRef
urlBuilder
validateDCOptions

+ getMessage

`terminate`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.0 kB	10.1 kB	+55 B (+0.5%)
size-with-ext-deps	28.0 kB	28.1 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
terminate
urlBuilder

15 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
terminate
urlBuilder

+ getMessage

`toQueryRef`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.9 kB	10.9 kB	+55 B (+0.5%)
size-with-ext-deps	36.0 kB	36.0 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

17 dependencies

addToken
compareDates
dcFetch
getDataConnect
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
queryRef
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
toQueryRef
urlBuilder
validateDCOptions

18 dependencies

addToken
compareDates
dcFetch
getDataConnect
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
queryRef
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
toQueryRef
urlBuilder
validateDCOptions

+ getMessage

`validateDCOptions`

Size

Type	Base (`92caa93`)	Merge (`773c8e7`)	Diff
size	10.2 kB	10.3 kB	+55 B (+0.5%)
size-with-ext-deps	28.2 kB	28.3 kB	+57 B (+0.2%)

Dependency

Type Base (92caa93) Merge (773c8e7) Diff

functions

14 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder
validateDCOptions

15 dependencies

addToken
compareDates
dcFetch
getGoogApiClientValue
getMessage
getRefSerializer
logDebug
logError
parseOptions
registerDataConnect
setEncoder
setIfNotExists
setSDKVersion
urlBuilder
validateDCOptions

+ getMessage

Test Logs

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

…-json-messages

Reported better error messages

ba8dba2

Removed console.log

0dff7a2

maneesht marked this pull request as ready for review July 19, 2024 21:19

maneesht requested a review from a team as a code owner July 19, 2024 21:19

maneesht added 4 commits July 19, 2024 15:47

Merge remote-tracking branch 'public/dataconnect' into mtewani/better…

c8b5a61

…-json-messages

Fixed formatting

26ee5fe

Fixed linting

56c6b40

Updated changelog

a18d457

maneesht merged commit 608cebf into dataconnect Jul 24, 2024
18 of 21 checks passed

maneesht deleted the mtewani/better-json-messages branch July 24, 2024 22:43

firebase locked and limited conversation to collaborators Aug 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Better JSON messages #8379

Better JSON messages #8379

Uh oh!

maneesht commented Jul 19, 2024

Uh oh!

changeset-bot bot commented Jul 19, 2024 •

edited

Loading

Uh oh!

google-oss-bot commented Jul 19, 2024 •

edited

Loading

`@firebase/data-connect`

`firebase`

Uh oh!

google-oss-bot commented Jul 19, 2024 •

edited

Loading

`@firebase/data-connect`

`DataConnect`

`FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR`

`FirebaseAuthProvider`

`MUTATION_STR`

`MutationManager`

`QUERY_STR`

`SOURCE_CACHE`

`SOURCE_SERVER`

`connectDataConnectEmulator`

`executeMutation`

`executeQuery`

`getDataConnect`

`mutationRef`

`parseOptions`

`queryRef`

`setLogLevel`

`subscribe`

`terminate`

`toQueryRef`

`validateDCOptions`

Uh oh!

Uh oh!

Uh oh!

Better JSON messages #8379

Better JSON messages #8379

Uh oh!

Conversation

maneesht commented Jul 19, 2024

Uh oh!

changeset-bot bot commented Jul 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

google-oss-bot commented Jul 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report 1

Affected Products

@firebase/data-connect

firebase

Test Logs

Uh oh!

google-oss-bot commented Jul 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Analysis Report 1

Affected Products

@firebase/data-connect

DataConnect

FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR

FirebaseAuthProvider

MUTATION_STR

MutationManager

QUERY_STR

SOURCE_CACHE

SOURCE_SERVER

connectDataConnectEmulator

executeMutation

executeQuery

getDataConnect

mutationRef

parseOptions

queryRef

setLogLevel

subscribe

terminate

toQueryRef

validateDCOptions

Test Logs

Uh oh!

Uh oh!

Uh oh!

changeset-bot bot commented Jul 19, 2024 •

edited

Loading

google-oss-bot commented Jul 19, 2024 •

edited

Loading

Size Report ¹

`@firebase/data-connect`

`firebase`

google-oss-bot commented Jul 19, 2024 •

edited

Loading

Size Analysis Report ¹

`@firebase/data-connect`

`DataConnect`

`FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR`

`FirebaseAuthProvider`

`MUTATION_STR`

`MutationManager`

`QUERY_STR`

`SOURCE_CACHE`

`SOURCE_SERVER`

`connectDataConnectEmulator`

`executeMutation`

`executeQuery`

`getDataConnect`

`mutationRef`

`parseOptions`

`queryRef`

`setLogLevel`

`subscribe`

`terminate`

`toQueryRef`

`validateDCOptions`