[🐛] New modular API for `FieldPath` no longer has `documentId()` (resolution: it does not exist anymore in firebase-js-sdk, use other methods)

[gigilibala]

Issue

The new modular API doesn't seem to have the static documentId() from FieldPath. This field is used to query based on document ID. The Namespaces API has it, but not the modular so it is breaking compatibility.
Or am I missing something?

---

Project Files

N/A

Javascript

Click To Expand

package.json:

# N/A

firebase.json for react-native-firebase v6:

# N/A

iOS

Click To Expand

ios/Podfile:

• I'm not using Pods
• I'm using Pods and my Podfile looks like:

# N/A

AppDelegate.m:

// N/A

---

Android

Click To Expand

Have you converted to AndroidX?

• my application is an AndroidX application?
• I am using android/gradle.settings jetifier=true for Android compatibility?
• I am using the NPM package jetifier for react-native compatibility?

android/build.gradle:

// N/A

android/app/build.gradle:

// N/A

android/settings.gradle:

// N/A

MainApplication.java:

// N/A

AndroidManifest.xml:

<!-- N/A -->

---

Environment

Click To Expand

react-native info output:

 N/A

• Platform that you're experiencing the issue on:
  • iOS
  • Android
  • iOS but have not tested behavior on Android
  • Android but have not tested behavior on iOS
  • Both
• react-native-firebase version you're using that has this issue:
  • e.g. 5.4.3
• Firebase module(s) you're using that has the issue:
  • e.g. Instance ID
• Are you using TypeScript?
  • Y/N & VERSION

---

• 👉 Check out React Native Firebase and Invertase on Twitter for updates on the library.

[mikehardy]

I don't see it on the upstream firebase-js-sdk API? https://firebase.google.com/docs/reference/js/firestore_.fieldpath

Can you point to a reference doc for the firebase-js-sdk modular API that has it, I may be looking at the wrong thing - but it seems like if that one was on namespaced but not modular that perhaps it moved or was present in another (preferred) location and you need to port this specific code to use the other spot

I do see it on the old API https://firebase.google.com/docs/reference/js/v8/firebase.firestore.FieldPath

Perhaps it is because it is clearer to simply specify the document and do a get (or ==) vs using that, it was simply removed? It appears to just be removed -- see https://stackoverflow.com/a/62562787/9910298 for this idea

[gigilibala]

Hmmm. You might be right. I can see this function on the node API and namespaced API for sure but not the modular API. Not sure if they never included it or there is a technical reason for not having it in the modular API, but either way unless they add it there, to stay consistent we can't have it here either.

Although I don't think I agree much with the reasoning in the stackoverflow post. For my project I use the documentId() in snapshot query to sort based on some timestamp and then by documentId. So, just relying on .get() is not enough. For now, I'm going to just use __name__ which works, but that's something internal I'm using it and probably brittle. :(

Thanks for looking into this. Feel free to close this issue if no further action is warranted.

Cheers.

[aazarkhish]

I think documentId is missing in types and it has other purposes other than just accessing a doc by id for example

query(usersColRef(), where(FieldPath.documentId(), "in", userIds));

how else we could achieve this query ?

And I believe the function exists it's just missing in the types

[mikehardy]

@aazarkhish if it is missing in firebase-js-sdk it will be missing here, we follow them. If this is something the modular API needs for FieldPath, you should open an issue with firebase-js-sdk, and if they make this change then you can open a feature request here for us to follow them. We need to follow their API though, we are designed to be a drop-in replacement for them with our only deviations being things that are truly platform differences (like, we have some modules they don't and some APIs they don't because we have platform API access, but this is not one of those differences)

[aazarkhish]

Thanks @mikehardy
But I believe firebase-js-sd has that in their types

https://github.com/firebase/firebase-js-sdk/blob/feb2c9dfa29c9dff01c1272e56f6258176dc6b3a/packages/firestore-types/index.d.ts#L494

But it is missing in modular types in this repo

react-native-firebase/packages/firestore/lib/modular/FieldPath.d.ts

Line 9 in e6642ec

export declare class FieldPath {

[mikehardy]

@aazarkhish 🤔 and yet, in their docs it does not exist? https://firebase.google.com/docs/reference/js/firestore_.fieldpath
Does it actually work on firebase-js-sdk using their modular APIs if you attempt it ? I haven't tried personally - been quite busy with other stuff and haven't been able to do concrete testing, apologies.

[aazarkhish]

No Problems @mikehardy
It actually works in @react-native-firebase v21.12.0 it's just missing in types ,
I have to brute force the type

import {
  query,
  FieldPath,
  where
} from "@react-native-firebase/firestore";

  query(usersColRef(), where((FieldPath as any).documentId(), "in", userIds));

[mikehardy]

Yes but does it work in firebase-js-sdk - that's our template

[andrastoth-ws]

While migrating a project to version 21.12.0 I was encountering this issue: still there's no static property like this on the type working nor there's any workaround apart from casting FieldPath as any.

[mikehardy]

@andrastoth-ws

Yes but does it work in firebase-js-sdk - that's our template

[andrastoth-ws]

@mikehardy

The minimal reproduction:

import { FieldPath } from '@react-native-firebase/firestore'; // version 21.12.0

console.log('!!!! HELLO', (FieldPath as any).documentId());

Logs:

Android Bundled 8292ms index.js (3393 modules)
 LOG  !!!! HELLO {"_segments": ["__name__"]}

Does this answer the question?