[KingDarBoja]

Checklist

• Issue number for this PR: Fixes Add support for Firestore Enterprise Pipeline Queries #3693, Refs Six firebase entry points have no @angular/fire equivalent, so their exports are unreachable #3755
• Docs included?: Yes
• Test units included?: Yes
• Breaking change?: No
• In a clean directory, yarn install, yarn test run successfully? Yes

Description

Implement Firestore Pipelines (including lite version).

Code sample

[armando-navarro]

Thank you for submitting this. This was on my plan of things to add. There's actually so much more than this that needs to be included from Firebase. We'll get this done together. Thank you again.

[armando-navarro]

Hi @KingDarBoja, thanks again, and sorry for taking this long to review this. I had prioritized the AngularFire 22 planning, but now that that's done, and the AngularFire 22 PRs are going to roll out swiftly as a result, I felt it was time for me to get to your PR.

There are three things I'd like changed before approving, plus one optional item.

Lite: pipeline() doesn't type-check

With Firestore from @angular/fire/firestore/lite, inject(Firestore).pipeline() fails to compile:

• The error is TS2339: Property 'pipeline' does not exist on type 'Firestore'.
• The cause is in firebase's typings. The types its exports map serves for the Lite pipelines path leave out the pipeline() declaration, so importing straight from firebase/firestore/lite/pipelines fails the same way.
• At runtime the method is there. Only the type is missing.

Since the docs point Lite users at this entry point, I think we should add the declaration ourselves. With this in src/firestore/lite/pipelines/public_api.ts, the package builds and the Lite call compiles:

import type { Pipeline, PipelineSource } from 'firebase/firestore/lite/pipelines';

declare module '@firebase/firestore/lite' {
  interface Firestore {
    pipeline(): PipelineSource<Pipeline>;
  }
}

export * from './firebase';

Docs

The new section shows only the imports. Could you add:

• A short example that gets a pipeline from the injected Firestore with firestore.pipeline() and passes it to execute().
• A note that pipelines need an Enterprise edition database. Firebase's edition comparison says Standard edition is "Limited to Firestore Core operations".

PR description

• "Issue number for this PR: #3693" won't close the issue when this merges. Fixes #3693 will.
• Please add Refs #3755 as well, since this covers 2 of the 6 missing entry points listed there.

Optional: a spec for the Lite fix

Could you add a spec that calls pipeline() on the injected Firestore from both entry points, so the Lite fix can't regress? The Lite one fails to compile without the declaration above and passes with it.

Once these are in, mark the PR ready for review and I'll take another look. If I've misread anything here, let me know.

[KingDarBoja]

@armando-navarro take into account before merging that this PR is pointing to main branch instead of the 21.x.x one.

[armando-navarro]

Hi @KingDarBoja. All the changes I asked for look good. I'm approving.

On the base branch, main is the right one:

• main is now the AngularFire 22 line, so this will ship with AngularFire 22.0.0-rc.0.
• 21.0.x only takes fixes for AngularFire 21. I can cherry-pick backport this to that line, though.

Before I merge, could you add @Component({ ... }) to the docs snippet's class, with Component added to the @angular/core import? Without it, it reads as a plain class, not a component. It's minor, I know, but I thought it was worth mentioning.

Another optional cleanup, if you'd like: the docs snippet imports greaterThan but never uses it, since it calls field('rating').greaterThan(4.5).

These suggestions are optional (not crucial).

Thanks again for building this.

[KingDarBoja]

@armando-navarro I decided to add both approaches (chaining and functional) instead of removing the function import 😄

[armando-navarro]

Thanks for adding @Component and both approaches.

Also a correction to my review above: this will ship in AngularFire 21 as well. After it merges to main, I'll cherry-pick it onto a new 21.1.x line for AngularFire 21.1.0.