Add `x-goog-request-params` to request header. #7440

tom-andersen · 2023-07-11T14:32:29Z

Fix named databases calls to backend with REST connection that experience error:

Missing routing header. Please fill in the request header with format x-goog-request-params:project_id=mrenshaw-multi-db&database_id=my-database

changeset-bot · 2023-07-11T14:32:33Z

🦋 Changeset detected

Latest commit: a61a8e6

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

This PR includes changesets to release 3 packages

Name	Type
@firebase/firestore	Patch
firebase	Patch
@firebase/firestore-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 · 2023-07-11T14:54:03Z

Size Report ¹

Affected Products

@firebase/firestore
Type Base (fa160f7) Merge (9617f55) Diff
browser 370 kB 371 kB +206 B (+0.1%)
esm5 356 kB 356 kB +242 B (+0.1%)
main 569 kB 569 kB +1 B (+0.0%)
module 370 kB 371 kB +206 B (+0.1%)
react-native 371 kB 371 kB +206 B (+0.1%)
@firebase/firestore-lite
Type Base (fa160f7) Merge (9617f55) Diff
browser 110 kB 110 kB +205 B (+0.2%)
esm5 106 kB 107 kB +241 B (+0.2%)
main 151 kB 151 kB +319 B (+0.2%)
module 110 kB 110 kB +205 B (+0.2%)
react-native 110 kB 110 kB +205 B (+0.2%)

`bundle`

12 size changes

Type	Base (`fa160f7`)	Merge (`9617f55`)	Diff
firestore (Persistence)	301 kB	301 kB	+206 B (+0.1%)
firestore (Query Cursors)	239 kB	239 kB	+206 B (+0.1%)
firestore (Query)	236 kB	236 kB	+206 B (+0.1%)
firestore (Read data once)	224 kB	224 kB	+206 B (+0.1%)
firestore (Realtime updates)	226 kB	226 kB	+206 B (+0.1%)
firestore (Transaction)	202 kB	203 kB	+206 B (+0.1%)
firestore (Write data)	202 kB	203 kB	+206 B (+0.1%)
firestore-lite (Query Cursors)	82.9 kB	83.1 kB	+203 B (+0.2%)
firestore-lite (Query)	79.0 kB	79.2 kB	+203 B (+0.3%)
firestore-lite (Read data once)	61.1 kB	61.3 kB	+203 B (+0.3%)
firestore-lite (Transaction)	85.9 kB	86.1 kB	+203 B (+0.2%)
firestore-lite (Write data)	70.6 kB	70.8 kB	+203 B (+0.3%)

`firebase`

Type	Base (`fa160f7`)	Merge (`9617f55`)	Diff
firebase-compat.js	774 kB	774 kB	+206 B (+0.0%)
firebase-firestore-compat.js	340 kB	340 kB	+206 B (+0.1%)
firebase-firestore-lite.js	117 kB	118 kB	+205 B (+0.2%)
firebase-firestore.js	430 kB	430 kB	+206 B (+0.0%)

Test Logs

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

google-oss-bot · 2023-07-11T15:11:38Z

Size Analysis Report ¹

Affected Products

@firebase/firestore
- addDoc
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 122 kB 122 kB +206 B (+0.2%)
  size-with-ext-deps 192 kB 192 kB +206 B (+0.1%)
- deleteDoc
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 113 kB 113 kB +206 B (+0.2%)
  size-with-ext-deps 183 kB 183 kB +206 B (+0.1%)
- disableNetwork
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 101 kB 101 kB +206 B (+0.2%)
  size-with-ext-deps 171 kB 172 kB +206 B (+0.1%)
- enableIndexedDbPersistence
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 183 kB 184 kB +206 B (+0.1%)
  size-with-ext-deps 255 kB 255 kB +206 B (+0.1%)
- enableMultiTabIndexedDbPersistence
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 220 kB 221 kB +206 B (+0.1%)
  size-with-ext-deps 292 kB 292 kB +206 B (+0.1%)
- enableNetwork
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 101 kB 101 kB +206 B (+0.2%)
  size-with-ext-deps 171 kB 172 kB +206 B (+0.1%)
- executeWrite
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 112 kB 112 kB +206 B (+0.2%)
  size-with-ext-deps 182 kB 182 kB +206 B (+0.1%)
- getAggregateFromServer
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 108 kB 108 kB +206 B (+0.2%)
  size-with-ext-deps 178 kB 179 kB +206 B (+0.1%)
- getCountFromServer
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 108 kB 109 kB +206 B (+0.2%)
  size-with-ext-deps 179 kB 179 kB +206 B (+0.1%)
- getDoc
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 143 kB 143 kB +206 B (+0.1%)
  size-with-ext-deps 213 kB 213 kB +206 B (+0.1%)
- getDocFromServer
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 143 kB 143 kB +206 B (+0.1%)
  size-with-ext-deps 213 kB 213 kB +206 B (+0.1%)
- getDocs
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 145 kB 145 kB +206 B (+0.1%)
  size-with-ext-deps 215 kB 215 kB +206 B (+0.1%)
- getDocsFromServer
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 144 kB 145 kB +206 B (+0.1%)
  size-with-ext-deps 215 kB 215 kB +206 B (+0.1%)
- loadBundle
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 111 kB 111 kB +206 B (+0.2%)
  size-with-ext-deps 181 kB 181 kB +206 B (+0.1%)
- memoryLocalCache
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 98.2 kB 98.5 kB +206 B (+0.2%)
  size-with-ext-deps 168 kB 169 kB +206 B (+0.1%)
- onSnapshot
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 145 kB 145 kB +206 B (+0.1%)
  size-with-ext-deps 215 kB 216 kB +206 B (+0.1%)
- onSnapshotsInSync
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 135 kB 135 kB +206 B (+0.2%)
  size-with-ext-deps 205 kB 205 kB +206 B (+0.1%)
- persistentLocalCache
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 181 kB 181 kB +206 B (+0.1%)
  size-with-ext-deps 252 kB 253 kB +206 B (+0.1%)
- persistentMultipleTabManager
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 217 kB 217 kB +206 B (+0.1%)
  size-with-ext-deps 289 kB 289 kB +206 B (+0.1%)
- persistentSingleTabManager
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 180 kB 181 kB +206 B (+0.1%)
  size-with-ext-deps 252 kB 252 kB +206 B (+0.1%)
- runTransaction
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 122 kB 122 kB +206 B (+0.2%)
  size-with-ext-deps 192 kB 192 kB +206 B (+0.1%)
- setDoc
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 121 kB 121 kB +206 B (+0.2%)
  size-with-ext-deps 191 kB 192 kB +206 B (+0.1%)
- updateDoc
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 122 kB 122 kB +206 B (+0.2%)
  size-with-ext-deps 192 kB 192 kB +206 B (+0.1%)
- waitForPendingWrites
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 102 kB 102 kB +206 B (+0.2%)
  size-with-ext-deps 172 kB 172 kB +206 B (+0.1%)
- writeBatch
  Size
  Type Base (fa160f7) Merge (9617f55) Diff
  size 124 kB 124 kB +206 B (+0.2%)
  size-with-ext-deps 194 kB 194 kB +206 B (+0.1%)

Test Logs

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

MarkDuckworth

I think the fix looks good. I've not been able to determine if the latest emulator supports this x-goog-request-params format. If not, then we may have to tweak this PR further.

MarkDuckworth · 2023-07-11T21:49:59Z

.changeset/eighty-roses-appear.md

+"@firebase/firestore": patch
+---
+
+Add `x-goog-request-params` to REST request header.


What do you think about release notes stating what is fixed in terms of what the customer understands?

For example this could be "Fixed issue where count and lite API queries did not work with named databases."

packages/firestore/src/remote/rest_connection.ts

tom-andersen

I need to clarify proper header format with Firestore team. The failing CI is due to a different format being expected by emulator.

…into tomandersen/x-goog-request-params

tom-andersen · 2023-07-14T19:03:41Z

@hsubox76 Ready for review.

…request-params

Add x-goog-request-params to request header.

adc145c

tom-andersen requested review from a team as code owners July 11, 2023 14:32

Create eighty-roses-appear.md

ca5694e

tom-andersen requested a review from a team as a code owner July 11, 2023 14:33

tom-andersen requested a review from MarkDuckworth July 11, 2023 14:34

tom-andersen assigned MarkDuckworth Jul 11, 2023

tom-andersen added 3 commits July 11, 2023 10:43

Pretty

19afe7b

Fix

23d05f9

Pretty

04fdf00

tom-andersen added 2 commits July 11, 2023 10:56

Pretty

924dfc6

Pretty

1b79205

tom-andersen requested a review from hsubox76 July 11, 2023 15:53

tom-andersen assigned hsubox76 Jul 11, 2023

tom-andersen added 5 commits July 11, 2023 13:24

Failing CI fix (maybe)

3fed99b

Fix test

8958fa3

Fix test

0034772

Complete solution

d625eb5

Complete solution

b60b73d

MarkDuckworth approved these changes Jul 11, 2023

View reviewed changes

dconeybe reviewed Jul 12, 2023

View reviewed changes

packages/firestore/src/remote/rest_connection.ts Outdated Show resolved Hide resolved

Update testing emulator to 1.18.1 (#7445)

ea0a70e

tom-andersen requested a review from dwyfrequency as a code owner July 12, 2023 14:02

tom-andersen commented Jul 12, 2023

View reviewed changes

tom-andersen added 3 commits July 12, 2023 16:06

Attempt to make backward compatible with emulator.

8a31353

Pretty

6eb76d3

Pretty

f26c712

tom-andersen added 3 commits July 13, 2023 12:07

Merge branch 'master' of https://github.com/firebase/firebase-js-sdk …

c2e17fc

…into tomandersen/x-goog-request-params

Improve changeset message.

614e23d

Encode values on 'x-goog-request-params' header.

0457b63

hsubox76 approved these changes Jul 17, 2023

View reviewed changes

tom-andersen added 3 commits July 17, 2023 13:58

Merge remote-tracking branch 'origin/master' into tomandersen/x-goog-…

513e0bb

…request-params

Try slightly older version of emulator will pass auth test.

4e616b8

Revert emulator change

a61a8e6

tom-andersen merged commit c5518c8 into master Jul 17, 2023

tom-andersen deleted the tomandersen/x-goog-request-params branch July 17, 2023 21:55

google-oss-bot mentioned this pull request Jul 18, 2023

Version Packages #7478

Merged

firebase locked and limited conversation to collaborators Aug 17, 2023

Add x-goog-request-params to request header. #7440

Add x-goog-request-params to request header. #7440

Conversation

tom-andersen commented Jul 11, 2023 • edited Loading

changeset-bot bot commented Jul 11, 2023 • edited Loading

🦋 Changeset detected

google-oss-bot commented Jul 11, 2023 • edited Loading

Size Report 1

Affected Products

@firebase/firestore

@firebase/firestore-lite

bundle

firebase

Test Logs

google-oss-bot commented Jul 11, 2023 • edited Loading

Size Analysis Report 1

Affected Products

@firebase/firestore

addDoc

deleteDoc

disableNetwork

enableIndexedDbPersistence

enableMultiTabIndexedDbPersistence

enableNetwork

executeWrite

getAggregateFromServer

getCountFromServer

getDoc

getDocFromServer

getDocs

getDocsFromServer

loadBundle

memoryLocalCache

onSnapshot

onSnapshotsInSync

persistentLocalCache

persistentMultipleTabManager

persistentSingleTabManager

runTransaction

setDoc

updateDoc

waitForPendingWrites

writeBatch

Test Logs

MarkDuckworth left a comment

Choose a reason for hiding this comment

MarkDuckworth Jul 11, 2023

Choose a reason for hiding this comment

tom-andersen left a comment

Choose a reason for hiding this comment

tom-andersen commented Jul 14, 2023

Add `x-goog-request-params` to request header. #7440

Add `x-goog-request-params` to request header. #7440

tom-andersen commented Jul 11, 2023 •

edited

Loading

changeset-bot bot commented Jul 11, 2023 •

edited

Loading

google-oss-bot commented Jul 11, 2023 •

edited

Loading

Size Report ¹

`@firebase/firestore`

`@firebase/firestore-lite`

`bundle`

`firebase`

google-oss-bot commented Jul 11, 2023 •

edited

Loading

Size Analysis Report ¹

`@firebase/firestore`

`addDoc`

`deleteDoc`

`disableNetwork`

`enableIndexedDbPersistence`

`enableMultiTabIndexedDbPersistence`

`enableNetwork`

`executeWrite`

`getAggregateFromServer`

`getCountFromServer`

`getDoc`

`getDocFromServer`

`getDocs`

`getDocsFromServer`

`loadBundle`

`memoryLocalCache`

`onSnapshot`

`onSnapshotsInSync`

`persistentLocalCache`

`persistentMultipleTabManager`

`persistentSingleTabManager`

`runTransaction`

`setDoc`

`updateDoc`

`waitForPendingWrites`

`writeBatch`