Delay before disconnecting useFirestore

[Zehir]

Clear and concise description of the problem

In the case you are using vue-plugin-pages you can have a case that you load the same documents multiple times in case you came back to a page you already loaded once.
But when you change the page the connection is closed at the moment you left the page thanks to:

    tryOnScopeDispose(() => {
      close()
    })

So you will be charged by one read each time.

Suggested solution

Using a little delay could alow you to use the cached document instead of get one new.

    tryOnScopeDispose(() => {
      useTimeoutFn(() => {
        close()
      }, 30000)
    })

You don't need more code because the firestore sdk handle it by default. Even if the first useFirestore is closed I still get updates on the new useFirestore

Alternative

An alternative is to store your useFirestore in a pinia store but it's lead to many tracks of what you put there.

Additional context

I can make a PR for that but I don't know about the delay, should it's be lower ? configurable ?
Maybe a force close option ?
Maybe a close if I get an update during the timeout ?

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[kiyopikko]

I think it's the simplest way autoDispose option also accept milliseconds of timeout (number) not only false.

Maybe a close if I get an update during the timeout ?

Can you do this? I want to know how it is implemented.

[Zehir]

I will make a PR to have some code to discuss on. But yes you can do that with a watchOnce and call the close method when data is updated. If it's an other listener on the same document it's won't be an issue because it's will just close the old one.

[Zehir]

This is my current implementation using a custom composable;
https://gist.github.com/Zehir/be3b229e36963b1e4d6869207b231ac0

[kiyopikko]

Thanks, let's discuss on your PR 👍

[Zehir]

Thanks, let's discuss on your PR 👍

It's may take a few days, I have some issues to setup a dev env #2268

[Zehir]

@kiyopikko why did you limit close to query only ? Documents read need to be closed too.

vueuse/packages/firebase/useFirestore/index.ts

Lines 99 to 103 in 2419803

	if (autoDispose && !isDocumentReference<T>(refOfDocRef.value)) {
	tryOnScopeDispose(() => {
	close()
	})
	}

[kiyopikko]

@Zehir oh, that's a mistake and thanks for making PR!

I cared about compatibility, I wanted to write

if (autoDispose || isDocumentReference<T>(refOfDocRef.value)) { 
  tryOnScopeDispose(() => {})
}

because documents always close regardless autoDispose option in previous code.

but almost users will expect to be able to use autoDispose to documents so

if (autoDispose) { 
  tryOnScopeDispose(() => {})
}

is good like your PR.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[Zehir]

Up

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[Zehir]

#2276 is updated

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.