Firestore: Fix "missing index" error message #6712

milaGGL · 2022-10-20T23:43:07Z

Fix a bug where missing index error message is not displayed as expected.

Expected error message

It should display "The query requires an index. Please create it here: http://.....". By clicking the link, user will be directed to console where they can create the required index.

Current error message:

Full SDK: "Server responded with status 400"
Lite SDK:"Bad request"

Cause

when server respond to the request with missing index, error object is wrapped inside an array. By trying to read the error message field directly from the array, it always fails and get "undefined".
So, extract the error object from the array before reading the error message field.

Fixes #6613

changeset-bot · 2022-10-20T23:43:09Z

🦋 Changeset detected

Latest commit: d4012d9

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

packages/firestore/src/platform/browser_lite/fetch_connection.ts

google-oss-bot · 2022-10-21T00:07:18Z

Size Report ¹

Affected Products

@firebase/firestore
Type Base (941ad29) Merge (089aa6c) Diff
browser 266 kB 266 kB +84 B (+0.0%)
esm5 330 kB 330 kB +84 B (+0.0%)
main 531 kB 531 kB +11 B (+0.0%)
module 266 kB 266 kB +84 B (+0.0%)
react-native 266 kB 266 kB +84 B (+0.0%)

`@firebase/firestore-lite`

Type	Base (`941ad29`)	Merge (`089aa6c`)	Diff
browser	82.3 kB	82.4 kB	+138 B (+0.2%)
esm5	98.5 kB	98.6 kB	+157 B (+0.2%)
main	139 kB	139 kB	+303 B (+0.2%)
module	82.3 kB	82.4 kB	+138 B (+0.2%)
react-native	82.4 kB	82.6 kB	+138 B (+0.2%)

@firebase/messaging
Type Base (941ad29) Merge (089aa6c) Diff
browser 21.3 kB 21.4 kB +94 B (+0.4%)
esm5 26.7 kB 26.8 kB +92 B (+0.3%)
main 27.4 kB 27.5 kB +92 B (+0.3%)
module 21.3 kB 21.4 kB +94 B (+0.4%)
@firebase/messaging-sw
Type Base (941ad29) Merge (089aa6c) Diff
main 30.1 kB 30.2 kB +92 B (+0.3%)
module 23.3 kB 23.4 kB +94 B (+0.4%)
@firebase/performance
Type Base (941ad29) Merge (089aa6c) Diff
browser 29.1 kB 29.1 kB +40 B (+0.1%)
esm5 30.8 kB 30.8 kB +40 B (+0.1%)
main 31.2 kB 31.3 kB +40 B (+0.1%)
module 29.1 kB 29.1 kB +40 B (+0.1%)

`bundle`

14 size changes

Type	Base (`941ad29`)	Merge (`089aa6c`)	Diff
firestore (Persistence)	276 kB	276 kB	+73 B (+0.0%)
firestore (Query Cursors)	213 kB	213 kB	+84 B (+0.0%)
firestore (Query)	214 kB	214 kB	+84 B (+0.0%)
firestore (Read data once)	202 kB	202 kB	+84 B (+0.0%)
firestore (Realtime updates)	205 kB	205 kB	+84 B (+0.0%)
firestore (Transaction)	186 kB	186 kB	+73 B (+0.0%)
firestore (Write data)	186 kB	186 kB	+73 B (+0.0%)
firestore-lite (Query Cursors)	71.4 kB	71.5 kB	+138 B (+0.2%)
firestore-lite (Query)	74.6 kB	74.7 kB	+138 B (+0.2%)
firestore-lite (Read data once)	59.0 kB	59.1 kB	+138 B (+0.2%)
firestore-lite (Transaction)	83.6 kB	83.7 kB	+138 B (+0.2%)
firestore-lite (Write data)	68.7 kB	68.9 kB	+138 B (+0.2%)
messaging (send + receive)	46.3 kB	46.4 kB	+58 B (+0.1%)
performance (trace)	50.8 kB	50.8 kB	+24 B (+0.0%)

`firebase`

11 size changes

Type	Base (`941ad29`)	Merge (`089aa6c`)	Diff
firebase-compat.js	740 kB	740 kB	+196 B (+0.0%)
firebase-firestore-compat.js	313 kB	314 kB	+92 B (+0.0%)
firebase-firestore-lite.js	89.0 kB	89.1 kB	+138 B (+0.2%)
firebase-firestore.js	314 kB	314 kB	+84 B (+0.0%)
firebase-messaging-compat.js	38.2 kB	38.3 kB	+98 B (+0.3%)
firebase-messaging-sw.js	26.0 kB	26.0 kB	+55 B (+0.2%)
firebase-messaging.js	24.8 kB	24.9 kB	+55 B (+0.2%)
firebase-performance-compat.js	30.7 kB	30.7 kB	+6 B (+0.0%)
firebase-performance-standalone-compat.es2017.js	90.0 kB	90.0 kB	+13 B (+0.0%)
firebase-performance-standalone-compat.js	66.5 kB	66.5 kB	+6 B (+0.0%)
firebase-performance.js	30.7 kB	30.7 kB	+13 B (+0.0%)

Test Logs

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

google-oss-bot · 2022-10-21T00:15:18Z

Size Analysis Report ¹

Affected Products

@firebase/firestore
- addDoc
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 116 kB 116 kB +73 B (+0.1%)
  size-with-ext-deps 176 kB 176 kB +73 B (+0.0%)
- deleteDoc
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 107 kB 107 kB +73 B (+0.1%)
  size-with-ext-deps 167 kB 167 kB +73 B (+0.0%)
- disableNetwork
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 95.7 kB 95.8 kB +73 B (+0.1%)
  size-with-ext-deps 155 kB 155 kB +73 B (+0.0%)
- enableIndexedDbPersistence
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 174 kB 174 kB +73 B (+0.0%)
  size-with-ext-deps 234 kB 234 kB +73 B (+0.0%)
- enableMultiTabIndexedDbPersistence
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 207 kB 207 kB +73 B (+0.0%)
  size-with-ext-deps 267 kB 267 kB +73 B (+0.0%)
- enableNetwork
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 95.7 kB 95.8 kB +73 B (+0.1%)
  size-with-ext-deps 155 kB 155 kB +73 B (+0.0%)
- executeWrite
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 106 kB 106 kB +73 B (+0.1%)
  size-with-ext-deps 166 kB 166 kB +73 B (+0.0%)
- getCountFromServer
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 102 kB 102 kB +73 B (+0.1%)
  size-with-ext-deps 162 kB 162 kB +73 B (+0.0%)
- getDoc
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 133 kB 133 kB +84 B (+0.1%)
  size-with-ext-deps 192 kB 192 kB +84 B (+0.0%)
- getDocFromServer
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 133 kB 133 kB +84 B (+0.1%)
  size-with-ext-deps 192 kB 192 kB +84 B (+0.0%)
- getDocs
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 134 kB 134 kB +84 B (+0.1%)
  size-with-ext-deps 194 kB 194 kB +84 B (+0.0%)
- getDocsFromServer
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 134 kB 134 kB +84 B (+0.1%)
  size-with-ext-deps 194 kB 194 kB +84 B (+0.0%)
- loadBundle
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 105 kB 105 kB +73 B (+0.1%)
  size-with-ext-deps 164 kB 164 kB +73 B (+0.0%)
- onSnapshot
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 135 kB 135 kB +84 B (+0.1%)
  size-with-ext-deps 194 kB 194 kB +84 B (+0.0%)
- onSnapshotsInSync
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 124 kB 125 kB +84 B (+0.1%)
  size-with-ext-deps 184 kB 184 kB +84 B (+0.0%)
- runTransaction
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 116 kB 116 kB +73 B (+0.1%)
  size-with-ext-deps 176 kB 176 kB +73 B (+0.0%)
- setDoc
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 115 kB 115 kB +73 B (+0.1%)
  size-with-ext-deps 175 kB 175 kB +73 B (+0.0%)
- updateDoc
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 116 kB 116 kB +73 B (+0.1%)
  size-with-ext-deps 175 kB 175 kB +73 B (+0.0%)
- waitForPendingWrites
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 96.1 kB 96.2 kB +73 B (+0.1%)
  size-with-ext-deps 156 kB 156 kB +73 B (+0.0%)
- writeBatch
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 118 kB 118 kB +73 B (+0.1%)
  size-with-ext-deps 177 kB 177 kB +73 B (+0.0%)
@firebase/messaging
- deleteToken
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 12.7 kB 12.8 kB +58 B (+0.5%)
  size-with-ext-deps 38.5 kB 38.5 kB +58 B (+0.2%)
- getMessaging
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 13.2 kB 13.2 kB +58 B (+0.4%)
  size-with-ext-deps 46.0 kB 46.1 kB +58 B (+0.1%)
- getToken
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 12.6 kB 12.7 kB +58 B (+0.5%)
  size-with-ext-deps 38.3 kB 38.4 kB +58 B (+0.2%)
- isSupported
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 13.0 kB 13.0 kB +58 B (+0.4%)
  size-with-ext-deps 38.6 kB 38.7 kB +58 B (+0.2%)
- onMessage
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 12.7 kB 12.8 kB +58 B (+0.5%)
  size-with-ext-deps 38.5 kB 38.5 kB +58 B (+0.2%)
@firebase/performance
- getPerformance
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 18.0 kB 18.0 kB +24 B (+0.1%)
  size-with-ext-deps 50.7 kB 50.7 kB +24 B (+0.0%)
- initializePerformance
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 18.2 kB 18.2 kB +24 B (+0.1%)
  size-with-ext-deps 44.1 kB 44.1 kB +24 B (+0.1%)
- trace
  Size
  Type Base (941ad29) Merge (089aa6c) Diff
  size 17.9 kB 17.9 kB +24 B (+0.1%)
  size-with-ext-deps 43.5 kB 43.5 kB +24 B (+0.1%)

Test Logs

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

dconeybe

This fix looks perfect to me. Nice work! Just a few minor comments.

packages/firestore/src/platform/browser_lite/fetch_connection.ts

packages/firestore/src/util/async_observer.ts

dconeybe

Add a changeset please.

Great work! What an elegant fix.

packages/firestore/test/integration/api/aggregation.test.ts

packages/firestore/test/integration/api/query.test.ts

packages/firestore/test/lite/integration.test.ts

dconeybe

Just one tiny change to the changelog entry. Otherwise LGTM.

.changeset/little-rats-relax.md

milaGGL and others added 3 commits October 18, 2022 12:24

Enable COUNT integration tests

2ba62a9

add integration tests for count queries with a missing index

acf89d2

get error message from REST response.json()

0a6cdfe

milaGGL added the work-in-progress label Oct 20, 2022

Merge branch 'master' into dconeybe/CountMissingIndexTest

79b3938

milaGGL commented Oct 20, 2022

View reviewed changes

packages/firestore/src/platform/browser_lite/fetch_connection.ts Show resolved Hide resolved

milaGGL added 2 commits October 20, 2022 17:25

extract out the error message from an response.json

fd3df59

add back the USE_EMULATOR deleted by accident

cb8b4b5

milaGGL changed the title ~~Dconeybe/count missing index test~~ Fix missing index error message in Firestore Lite Oct 21, 2022

dconeybe requested changes Oct 21, 2022

View reviewed changes

milaGGL added 4 commits October 21, 2022 09:34

resolve comments

cdd774f

extract response from array

ff92e5c

remove getDocsFromServer test

bce2947

fix lint check

e13f9bd

milaGGL marked this pull request as ready for review October 24, 2022 21:16

milaGGL requested a review from dconeybe October 24, 2022 21:22

milaGGL added 2 commits October 24, 2022 14:43

assume error response might or might not wrapped in an array

4150469

stringify error to display full error message

b08285a

milaGGL commented Oct 26, 2022

View reviewed changes

packages/firestore/src/util/async_observer.ts Show resolved Hide resolved

dconeybe assigned milaGGL Oct 26, 2022

dconeybe changed the title ~~Fix missing index error message in Firestore Lite~~ Firestore: Fix "missing index" error message Oct 26, 2022

dconeybe requested changes Oct 26, 2022

View reviewed changes

resolve comments

716f149

milaGGL requested a review from egilmorez as a code owner October 26, 2022 16:55

resolve comments

8db30a1

milaGGL removed the work-in-progress label Oct 26, 2022

milaGGL requested a review from dconeybe October 26, 2022 18:26

dconeybe requested changes Oct 26, 2022

View reviewed changes

.changeset/little-rats-relax.md Outdated Show resolved Hide resolved

update changeset

d4012d9

dconeybe approved these changes Oct 26, 2022

View reviewed changes

milaGGL merged commit bf7cc8f into master Oct 27, 2022

milaGGL deleted the dconeybe/CountMissingIndexTest branch October 27, 2022 00:58

google-oss-bot mentioned this pull request Nov 8, 2022

Version Packages #6767

Merged

firebase locked and limited conversation to collaborators Nov 26, 2022

Firestore: Fix "missing index" error message #6712

Firestore: Fix "missing index" error message #6712

Conversation

milaGGL commented Oct 20, 2022 • edited by dconeybe Loading

Expected error message

Current error message:

Cause

changeset-bot bot commented Oct 20, 2022 • edited Loading

🦋 Changeset detected

google-oss-bot commented Oct 21, 2022 • edited Loading

Size Report 1

Affected Products

@firebase/firestore

@firebase/firestore-lite

@firebase/messaging

@firebase/messaging-sw

@firebase/performance

bundle

firebase

Test Logs

google-oss-bot commented Oct 21, 2022 • edited Loading

Size Analysis Report 1

Affected Products

@firebase/firestore

addDoc

deleteDoc

disableNetwork

enableIndexedDbPersistence

enableMultiTabIndexedDbPersistence

enableNetwork

executeWrite

getCountFromServer

getDoc

getDocFromServer

getDocs

getDocsFromServer

loadBundle

onSnapshot

onSnapshotsInSync

runTransaction

setDoc

updateDoc

waitForPendingWrites

writeBatch

@firebase/messaging

deleteToken

getMessaging

getToken

isSupported

onMessage

@firebase/performance

getPerformance

initializePerformance

trace

Test Logs

dconeybe left a comment

Choose a reason for hiding this comment

dconeybe left a comment

Choose a reason for hiding this comment

dconeybe left a comment

Choose a reason for hiding this comment

milaGGL commented Oct 20, 2022 •

edited by dconeybe

Loading

changeset-bot bot commented Oct 20, 2022 •

edited

Loading

google-oss-bot commented Oct 21, 2022 •

edited

Loading

Size Report ¹

`@firebase/firestore`

`@firebase/firestore-lite`

`@firebase/messaging`

`@firebase/messaging-sw`

`@firebase/performance`

`bundle`

`firebase`

google-oss-bot commented Oct 21, 2022 •

edited

Loading

Size Analysis Report ¹

`@firebase/firestore`

`addDoc`

`deleteDoc`

`disableNetwork`

`enableIndexedDbPersistence`

`enableMultiTabIndexedDbPersistence`

`enableNetwork`

`executeWrite`

`getCountFromServer`

`getDoc`

`getDocFromServer`

`getDocs`

`getDocsFromServer`

`loadBundle`

`onSnapshot`

`onSnapshotsInSync`

`runTransaction`

`setDoc`

`updateDoc`

`waitForPendingWrites`

`writeBatch`

`@firebase/messaging`

`deleteToken`

`getMessaging`

`getToken`

`isSupported`

`onMessage`

`@firebase/performance`

`getPerformance`

`initializePerformance`

`trace`