Add IndexManager API

Author: schmidt-sebastian

packages/firestore/src/local/index_manager.ts

@@ -57,8 +57,8 @@ export interface IndexManager {
   /**
    * Adds a field path index.
    *
-   * <p>Values for this index are persisted asynchronously. The index will only be used for query
-   * execution once values are persisted.
+   * Values for this index are persisted asynchronously. The index will only be
+   * used for query execution once values are persisted.
    */
   addFieldIndex(
     transaction: PersistenceTransaction,
@@ -72,9 +72,11 @@ export interface IndexManager {
   ): PersistencePromise<void>;
 
   /**
-   * Returns a list of field indexes that correspond to the specified collection group.
+   * Returns a list of field indexes that correspond to the specified collection
+   * group.
    *
-   * @param collectionGroup The collection group to get matching field indexes for.
+   * @param collectionGroup The collection group to get matching field indexes
+   * for.
    * @return A collection of field indexes for the specified collection group.
    */
   getFieldIndexes(
@@ -112,7 +114,7 @@ export interface IndexManager {
    */
   getNextCollectionGroupToUpdate(
     transaction: PersistenceTransaction
-  ): string | null;
+  ): PersistencePromise<string | null>;
 
   /**
    * Sets the collection group's latest read time.

packages/firestore/src/local/indexeddb_index_manager.ts

@@ -15,6 +15,13 @@
  * limitations under the License.
  */
 
+import { Target } from '../core/target';
+import {
+  documentKeySet,
+  DocumentKeySet,
+  DocumentMap
+} from '../model/collections';
+import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { debugAssert } from '../util/assert';
 import { immediateSuccessor } from '../util/misc';
@@ -102,6 +109,71 @@ export class IndexedDbIndexManager implements IndexManager {
         return parentPaths;
       });
   }
+
+  addFieldIndex(
+    transaction: PersistenceTransaction,
+    index: FieldIndex
+  ): PersistencePromise<void> {
+    // TODO(indexing): Implement
+    return PersistencePromise.resolve();
+  }
+
+  deleteFieldIndex(
+    transaction: PersistenceTransaction,
+    index: FieldIndex
+  ): PersistencePromise<void> {
+    // TODO(indexing): Implement
+    return PersistencePromise.resolve();
+  }
+
+  getDocumentsMatchingTarget(
+    transaction: PersistenceTransaction,
+    fieldIndex: FieldIndex,
+    target: Target
+  ): PersistencePromise<DocumentKeySet> {
+    // TODO(indexing): Implement
+    return PersistencePromise.resolve(documentKeySet());
+  }
+
+  getFieldIndex(
+    transaction: PersistenceTransaction,
+    target: Target
+  ): PersistencePromise<FieldIndex | null> {
+    // TODO(indexing): Implement
+    return PersistencePromise.resolve<FieldIndex | null>(null);
+  }
+
+  getFieldIndexes(
+    transaction: PersistenceTransaction,
+    collectionGroup?: string
+  ): PersistencePromise<FieldIndex[]> {
+    // TODO(indexing): Implement
+    return PersistencePromise.resolve<FieldIndex[]>([]);
+  }
+
+  getNextCollectionGroupToUpdate(
+    transaction: PersistenceTransaction
+  ): PersistencePromise<string | null> {
+    // TODO(indexing): Implement
+    return PersistencePromise.resolve<string | null>(null);
+  }
+
+  updateCollectionGroup(
+    transaction: PersistenceTransaction,
+    collectionGroup: string,
+    offset: IndexOffset
+  ): PersistencePromise<void> {
+    // TODO(indexing): Implement
+    return PersistencePromise.resolve();
+  }
+
+  updateIndexEntries(
+    transaction: PersistenceTransaction,
+    documents: DocumentMap
+  ): PersistencePromise<void> {
+    // TODO(indexing): Implement
+    return PersistencePromise.resolve();
+  }
 }
 
 /**

packages/firestore/src/local/memory_index_manager.ts

@@ -15,6 +15,13 @@
  * limitations under the License.
  */
 
+import { Target } from '../core/target';
+import {
+  documentKeySet,
+  DocumentKeySet,
+  DocumentMap
+} from '../model/collections';
+import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { debugAssert } from '../util/assert';
 import { SortedSet } from '../util/sorted_set';
@@ -45,6 +52,71 @@ export class MemoryIndexManager implements IndexManager {
       this.collectionParentIndex.getEntries(collectionId)
     );
   }
+
+  addFieldIndex(
+    transaction: PersistenceTransaction,
+    index: FieldIndex
+  ): PersistencePromise<void> {
+    // Field indices are not supported with memory persistence.
+    return PersistencePromise.resolve();
+  }
+
+  deleteFieldIndex(
+    transaction: PersistenceTransaction,
+    index: FieldIndex
+  ): PersistencePromise<void> {
+    // Field indices are not supported with memory persistence.
+    return PersistencePromise.resolve();
+  }
+
+  getDocumentsMatchingTarget(
+    transaction: PersistenceTransaction,
+    fieldIndex: FieldIndex,
+    target: Target
+  ): PersistencePromise<DocumentKeySet> {
+    // Field indices are not supported with memory persistence.
+    return PersistencePromise.resolve(documentKeySet());
+  }
+
+  getFieldIndex(
+    transaction: PersistenceTransaction,
+    target: Target
+  ): PersistencePromise<FieldIndex | null> {
+    // Field indices are not supported with memory persistence.
+    return PersistencePromise.resolve<FieldIndex | null>(null);
+  }
+
+  getFieldIndexes(
+    transaction: PersistenceTransaction,
+    collectionGroup?: string
+  ): PersistencePromise<FieldIndex[]> {
+    // Field indices are not supported with memory persistence.
+    return PersistencePromise.resolve<FieldIndex[]>([]);
+  }
+
+  getNextCollectionGroupToUpdate(
+    transaction: PersistenceTransaction
+  ): PersistencePromise<string | null> {
+    // Field indices are not supported with memory persistence.
+    return PersistencePromise.resolve<string | null>(null);
+  }
+
+  updateCollectionGroup(
+    transaction: PersistenceTransaction,
+    collectionGroup: string,
+    offset: IndexOffset
+  ): PersistencePromise<void> {
+    // Field indices are not supported with memory persistence.
+    return PersistencePromise.resolve();
+  }
+
+  updateIndexEntries(
+    transaction: PersistenceTransaction,
+    documents: DocumentMap
+  ): PersistencePromise<void> {
+    // Field indices are not supported with memory persistence.
+    return PersistencePromise.resolve();
+  }
 }
 
 /**