Update Firestore Indices File (#1717)

[alex-berliner]

Summary

The version of firestore.indexes.json in the maple repo root isn't updated automatically, and it becomes out of sync with the indexes in the firebase project when developers add new commands through the online console.

This is a one-time update to bring the repo's version of firestore.indexes.json in line with firebase firestore:indexes > firestore.indexes.json, and an update to the PR template to remind backend developers to add their Firestore indexes if they've made updates.

Checklist

• On the frontend, I've made my strings translate-able.
• If I've added shared components, I've added a storybook story.
• I've made pages responsive and look good on mobile.

Screenshots

N/A

Known issues

N/A

Steps to test/reproduce

N/A

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
maple-dev	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 5, 2025 1:30am

[Mephistic]

Looks good - I just had one minor (but long-winded) point about the wording on the deploy checklist update. Should be good to merge if we adjust that.

[Mephistic]

Just a note for posterity: We're fine removing the comments here - the context is mostly obvious from the collection/fields being indexed and they'll clash with the firebase firestore:indexes output if we ever need to refresh these indexes from source again.

[Mephistic]

Love this as a start, but I think we should be clear that we need to actually create the new indexes first for this command to do anything.

Come to think of it, we should think through the desired deploy process here. There are a few problems:

• Indexes take a few minutes to create - and the firebase deploy process doesn't naturally block until indexes are created to finish deploying the queries that use them
  • This was a bit of a WTF moment for me (firebase cli: wait for Firestore indexes deployment firebase/firebase-tools#7959)
• It's easy to forget to add indexes when developing locally because the Firebase emulators and flawed and don't check indexes at all (so you can test fully while running locally and your new query will work fine, but it will blow up when it hits production).
  • There is some tooling to try and sync local dev with the state of the real environment indexes, but it's unsupported and I'm not sure it's worth the effort to maintain just yet.
  • The best way to test them AFAIK is to open a firebase console against the dev environment (with yarn firebase-admin -e dev console) and try to run your query there - it seems like the easiest way to tell if new queries need a new index.

For now, it might be easier just to explicit build out a manual deploy checklist and ensure we hit the steps:

TL;DR

This is a longwinded way to say: Let's break this into three smaller checkboxes that are something like:

• For any new firestore queries, are all new required indexes:
  • Created on development
  • Created on production
  • Added to firestore.indexes.json (either manually or with the command firebase firestore:indexes > firestore.indexes.json)

One last note: most devs don't have access to the production environment - so this would really be a step for PR reviewers if we move it out of the deploy automation.

After typing all this, it may be worth adding a note to the Wiki about how to add new firestore queries.