Skip to content

Mila/count add api interface #6499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Aug 4, 2022
Merged

Mila/count add api interface #6499

merged 5 commits into from
Aug 4, 2022

Conversation

milaGGL
Copy link
Contributor

@milaGGL milaGGL commented Aug 3, 2022 •
edited
Loading

This count query interface is implemented based on the COUNT Query API proposal.

Based on the demo provided:

async function Demo1_CountOfDocumentsInACollection(db: Firestore) {
  const countQuery_ = countQuery(collection(db, "games/halo/players"));
  const snapshot = await getAggregateFromServerDirect(countQuery_);
  expect(snapshot.getCount()).to.equal(5000000);
}

async function Demo2_CountOfDocumentsInACollectionWithFilter(db: Firestore) {
  const query_ = query(collection(db, "games/halo/players"), where("online", "==", true));
  const countQuery_ = countQuery(query_);
  const snapshot = await getAggregateFromServerDirect(countQuery_);
  expect(snapshot.getCount()).to.equal(2000);
}
  • countQuery function will accept a collection or query reference
  • countQuery will create a aggregateQuery instance, and return it. (class AggregateQuery)
  • getAggregateFromServerDirect function will take aggregateQuery object, create AggregateQuerySnapshot instance, and return a promise
  • AggregateQuerySnapshot object has getCount public method to access the document count

@changeset-bot
Copy link

changeset-bot bot commented Aug 3, 2022 •
edited
Loading

⚠️ No Changeset found

Latest commit: 0a2f104

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@milaGGL milaGGL changed the base branch from master to mila/count August 3, 2022 00:46
milaGGL
milaGGL commented Aug 3, 2022
View reviewed changes
common/api-review/firestore.api.md
@@ -17,6 +17,30 @@ export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unkn
[K in keyof T & string as `${Prefix}.${K}`]+?: T[K];
};

Copy link
Contributor Author

@milaGGL milaGGL Aug 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

auto-updated file by API Extractor

milaGGL
milaGGL commented Aug 3, 2022
View reviewed changes
packages/firestore/src/lite-api/aggregate.ts Outdated
import {DocumentData, Query, queryEqual} from './reference';


export class AggregateQuery<T = DocumentData>{
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

created class only, hasn't implement the internal methods

@milaGGL milaGGL requested a review from dconeybe August 3, 2022 00:56
@google-oss-bot
Copy link
Contributor

google-oss-bot commented Aug 3, 2022 •
edited
Loading

Size Report 1

Affected Products

  • @firebase/firestore

    TypeBase (598e948)Merge (52d3f9c)Diff
    browser264 kB264 kB+547 B (+0.2%)
    esm5327 kB327 kB+579 B (+0.2%)
    main526 kB528 kB+1.41 kB (+0.3%)
    module264 kB264 kB+547 B (+0.2%)
    react-native264 kB264 kB+547 B (+0.2%)

  • firebase

    TypeBase (598e948)Merge (52d3f9c)Diff
    firebase-firestore.js851 kB853 kB+1.35 kB (+0.2%)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/MIflKVxzUv.html

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Aug 3, 2022 •
edited
Loading

Size Analysis Report 1

This report is too large (134,688 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/BtynnqTb2l.html

milaGGL
milaGGL commented Aug 3, 2022
View reviewed changes
packages/firestore/test/integration/api/count.test.ts Outdated
query
} from '../util/firebase_export';
import { apiDescribe, withTestCollection } from '../util/helpers';

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

both tests will fail as the count API internal logic is not implemented yet, and only returning 42 as dummy count.

@dconeybe dconeybe removed their assignment Aug 4, 2022
@milaGGL milaGGL merged commit 7f42490 into mila/count Aug 4, 2022
@milaGGL milaGGL deleted the mila/count-add-API-interface branch August 4, 2022 16:57
@firebase firebase locked and limited conversation to collaborators Sep 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dconeybe dconeybe dconeybe approved these changes

@dwyfrequency dwyfrequency Awaiting requested review from dwyfrequency

@hsubox76 hsubox76 Awaiting requested review from hsubox76

Assignees

@milaGGL milaGGL

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@milaGGL @google-oss-bot @dconeybe