Referenced documents do not have id

[donatas-luciunas]

Reproduction

N / A

Steps to reproduce the bug

Use useDocument for a document that has at least one reference

Expected behavior

Referenced document has id property

Actual behavior

Referenced document does not have id property

Additional information

I guess the fix should be somewhere here

vuefire/src/firestore/bind.ts

Line 123 in ae85a41

const [data, refs] = extractRefs(

A default converter should be added for refs here.

[michaelpelletier]

Thanks for posting this! I'd posted on the Vue Discord last night hoping to get an answer as to what I was doing wrong that useDocument was giving me the content of the referenced items but not the actual ID.

[posva]

Note that if you only want the id, you can use maxRefDepth: 0

[michaelpelletier]

Yeah, I want both, though. The use case I was describing on the Discord is something like this:

I have a student who has a collection of current courses that they are enrolled in this semester. On the student's Dashboad, for each of those courses, I can display the information like the course title or when it meets or who the professor is, but because I can't access the ID, I couldn't build a link to actually view that course's page.

[donatas-luciunas]

I recommend to fix it this way
This line

vuefire/src/firestore/utils.ts

Line 101 in ae85a41

refs[refSubKey] = ref

should be changed to

refs[refSubKey] = ref.withConverter(firestoreDefaultConverter);

[posva]

yeah, that would be one way. I think we could also have an option for this that allows to use any custom converter and that by default uses the default converter. What do you think?

[donatas-luciunas]

Sorry, I mean DEFAULT_OPTIONS.converter (source) instead of firestoreDefaultConverter.
This way as you say a developer could provide a custom converter.

Providing custom converter per dependency could also be nice. In my head a solution could be additional useDocument options property mask that follows retrieved document structure while also providing instructions how to expand it, for example

{
  "converter": commentConverter,
  "$user": {
    "converter": userConverter,
    "$roles": {}  // instructs to expand with default converter
  }
}

Not mentioned fields should not be expanded. I use $ prefix for actual document fields.
This would also solve #281
This seems to me as a separate feature.

[posva]

The converter will likely be passed as an argument to be able to use local options.

I think that instead, allowing both the converter object and a function that returns a converter based on the ref or false or null to skip it could also enable this behavior in a more concise syntax:

useDocument(..., {
  refConverter: customConverter
})

useDocument(..., {
  refConverter: (docRef) => docRef.id.includes(...) ? false : customConverter
})

[donatas-luciunas]

Sure, that could work as well.

Could you please implement the use of globalFirestoreOptions.converter separately? This seems to be a quick fix. This is a blocker for me to migrate from v2 to v3 😬

[posva]

Unfortunately it will have to wait a bit. Use https://www.npmjs.com/package/patch-package and locally patch the package in the meantime, it should be pretty straightforward. v2 didn't have this behavior either

[donatas-luciunas]

Thanks for recommendation.

I use 2.2.5 and it gives id property on referenced document.

[michaelpelletier]

Just popping back to say patch-package with donatas-luciunas's original suggestion worked like a dream.