Add SimpleQueryEngine

Author: schmidt-sebastian

packages/firestore/src/core/firestore_client.ts

@@ -21,6 +21,7 @@ import { IndexedDbPersistence } from '../local/indexeddb_persistence';
 import { LocalStore } from '../local/local_store';
 import { MemoryPersistence } from '../local/memory_persistence';
 import { Persistence } from '../local/persistence';
+import { SimpleQueryEngine } from '../local/simple_query_engine';
 import {
   DocumentKeySet,
   documentKeySet,
@@ -406,7 +407,9 @@ export class FirestoreClient {
     return this.platform
       .loadConnection(this.databaseInfo)
       .then(async connection => {
-        this.localStore = new LocalStore(this.persistence, user);
+        // TODO(index-free): Use IndexFreeQueryEngine/IndexedQueryEngine as appropriate.
+        const queryEngine = new SimpleQueryEngine();
+        this.localStore = new LocalStore(this.persistence, queryEngine, user);
         if (maybeLruGc) {
           // We're running LRU Garbage collection. Set up the scheduler.
           this.lruScheduler = new LruScheduler(

packages/firestore/src/local/local_store.ts

@@ -48,6 +48,7 @@ import { Persistence, PersistenceTransaction } from './persistence';
 import { PersistencePromise } from './persistence_promise';
 import { QueryCache } from './query_cache';
 import { QueryData, QueryPurpose } from './query_data';
+import { QueryEngine } from './query_engine';
 import { ReferenceSet } from './reference_set';
 import { RemoteDocumentCache } from './remote_document_cache';
 import { RemoteDocumentChangeBuffer } from './remote_document_change_buffer';
@@ -158,6 +159,7 @@ export class LocalStore {
   constructor(
     /** Manages our in-memory or durable persistence. */
     private persistence: Persistence,
+    private queryEngine: QueryEngine,
     initialUser: User
   ) {
     assert(
@@ -175,6 +177,7 @@ export class LocalStore {
       this.mutationQueue,
       this.persistence.getIndexManager()
     );
+    this.queryEngine.setLocalDocumentsView(this.localDocuments);
   }
 
   /**
@@ -819,7 +822,7 @@ export class LocalStore {
    */
   executeQuery(query: Query): Promise<DocumentMap> {
     return this.persistence.runTransaction('Execute query', 'readonly', txn => {
-      return this.localDocuments.getDocumentsMatchingQuery(
+      return this.queryEngine.getDocumentsMatchingQuery(
         txn,
         query,
         SnapshotVersion.MIN

packages/firestore/src/local/query_engine.ts

@@ -0,0 +1,39 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { LocalDocumentsView } from './local_documents_view';
+import { PersistenceTransaction } from './persistence';
+import { Query } from '../core/query';
+import { SnapshotVersion } from '../core/snapshot_version';
+import { PersistencePromise } from './persistence_promise';
+import { DocumentMap } from '../model/collections';
+
+/**
+ * Represents a query engine capable of performing queries over the local
+ * document cache. You must call `setLocalDocumentsView()` before using.
+ */
+export interface QueryEngine {
+  /** Sets the document view to query against. */
+  setLocalDocumentsView(localDocuments: LocalDocumentsView): void;
+
+  /** Returns all local documents matching the specified query. */
+  getDocumentsMatchingQuery(
+    transaction: PersistenceTransaction,
+    query: Query,
+    sinceReadTime: SnapshotVersion
+  ): PersistencePromise<DocumentMap>;
+}

packages/firestore/src/local/simple_query_engine.ts

@@ -0,0 +1,57 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { LocalDocumentsView } from './local_documents_view';
+import { PersistenceTransaction } from './persistence';
+import { Query } from '../core/query';
+import { SnapshotVersion } from '../core/snapshot_version';
+import { PersistencePromise } from './persistence_promise';
+import { DocumentMap } from '../model/collections';
+import { QueryEngine } from './query_engine';
+import { assert } from '../util/assert';
+
+/**
+ * A naive implementation of QueryEngine that just loads all the documents in
+ * the queried collection and then filters them in memory.
+ */
+export class SimpleQueryEngine implements QueryEngine {
+  private localDocumentsView: LocalDocumentsView | undefined;
+
+  setLocalDocumentsView(localDocuments: LocalDocumentsView): void {
+    this.localDocumentsView = localDocuments;
+  }
+
+  /** Returns all local documents matching the specified query. */
+  getDocumentsMatchingQuery(
+    transaction: PersistenceTransaction,
+    query: Query,
+    sinceReadTime: SnapshotVersion
+  ): PersistencePromise<DocumentMap> {
+    assert(
+      this.localDocumentsView !== undefined,
+      'setLocalDocumentsView() not called'
+    );
+
+    // TODO: Once LocalDocumentsView provides a getCollectionDocuments()
+    // method, we should call that here and then filter the results.
+    return this.localDocumentsView!.getDocumentsMatchingQuery(
+      transaction,
+      query,
+      SnapshotVersion.MIN
+    );
+  }
+}

packages/firestore/test/unit/local/local_store.test.ts

@@ -25,6 +25,8 @@ import { IndexedDbPersistence } from '../../../src/local/indexeddb_persistence';
 import { LocalStore, LocalWriteResult } from '../../../src/local/local_store';
 import { LocalViewChanges } from '../../../src/local/local_view_changes';
 import { Persistence } from '../../../src/local/persistence';
+import { QueryEngine } from '../../../src/local/query_engine';
+import { SimpleQueryEngine } from '../../../src/local/simple_query_engine';
 import {
   documentKeySet,
   DocumentMap,
@@ -280,6 +282,7 @@ describe('LocalStore w/ Memory Persistence', () => {
   addEqualityMatcher();
   genericLocalStoreTests(
     persistenceHelpers.testMemoryEagerPersistence,
+    new SimpleQueryEngine(),
     /* gcIsEager= */ true
   );
 });
@@ -295,20 +298,22 @@ describe('LocalStore w/ IndexedDB Persistence', () => {
   addEqualityMatcher();
   genericLocalStoreTests(
     persistenceHelpers.testIndexedDbPersistence,
+    new SimpleQueryEngine(),
     /* gcIsEager= */ false
   );
 });
 
 function genericLocalStoreTests(
   getPersistence: () => Promise<Persistence>,
+  queryEngine: QueryEngine,
   gcIsEager: boolean
 ): void {
   let persistence: Persistence;
   let localStore: LocalStore;
 
   beforeEach(async () => {
     persistence = await getPersistence();
-    localStore = new LocalStore(persistence, User.UNAUTHENTICATED);
+    localStore = new LocalStore(persistence, queryEngine, User.UNAUTHENTICATED);
   });
 
   afterEach(async () => {

packages/firestore/test/unit/specs/spec_test_runner.ts

@@ -57,6 +57,7 @@ import {
   WebStorageSharedClientState
 } from '../../../src/local/shared_client_state';
 import { SimpleDb } from '../../../src/local/simple_db';
+import { SimpleQueryEngine } from '../../../src/local/simple_query_engine';
 import { DocumentOptions } from '../../../src/model/document';
 import { DocumentKey } from '../../../src/model/document_key';
 import { JsonObject } from '../../../src/model/field_value';
@@ -434,7 +435,9 @@ abstract class TestRunner {
       this.useGarbageCollection
     );
 
-    this.localStore = new LocalStore(this.persistence, this.user);
+    // TODO(index-free): Update to index-free query engine when it becomes default.
+    const queryEngine = new SimpleQueryEngine();
+    this.localStore = new LocalStore(this.persistence, queryEngine, this.user);
 
     this.connection = new MockConnection(this.queue);
     this.datastore = new Datastore(