Remove bundles from public interfaces take 2.

Author: wu-hui

.changeset/lemon-steaks-draw.md

@@ -1,5 +1,5 @@
 ---
-"@firebase/firestore": feature
+"@firebase/firestore": internal
 ---
 
-Add support for loading Firestore Bundle Files.
+Merge bundle loading implementation without exposing public API

packages/firebase/index.d.ts

@@ -8285,43 +8285,6 @@ declare namespace firebase.firestore {
     INTERNAL: { delete: () => Promise<void> };
   }
 
-  export function loadBundle(
-    db: Firestore,
-    bundleData: ArrayBuffer | ReadableStream<ArrayBuffer> | string
-  ): LoadBundleTask;
-
-  export function namedQuery(
-    db: Firestore,
-    name: string
-  ): Promise<Query<DocumentData> | null>;
-
-  export interface LoadBundleTask {
-    onProgress(
-      next?: (progress: LoadBundleTaskProgress) => any,
-      error?: (error: Error) => any,
-      complete?: () => void
-    ): void;
-
-    then<T, R>(
-      onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>,
-      onRejected?: (a: Error) => R | PromiseLike<R>
-    ): Promise<T | R>;
-
-    catch<R>(
-      onRejected: (a: Error) => R | PromiseLike<R>
-    ): Promise<R | LoadBundleTaskProgress>;
-  }
-
-  export interface LoadBundleTaskProgress {
-    documentsLoaded: number;
-    totalDocuments: number;
-    bytesLoaded: number;
-    totalBytes: number;
-    taskState: TaskState;
-  }
-
-  export type TaskState = 'Error' | 'Running' | 'Success';
-
   /**
    * An immutable object representing a geo point in Firestore. The geo point
    * is represented as latitude/longitude pair.

packages/firestore-types/index.d.ts

@@ -99,33 +99,6 @@ export class FirebaseFirestore {
   INTERNAL: { delete: () => Promise<void> };
 }
 
-export interface LoadBundleTask {
-  onProgress(
-    next?: (progress: LoadBundleTaskProgress) => any,
-    error?: (error: Error) => any,
-    complete?: () => void
-  ): void;
-
-  then<T, R>(
-    onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>,
-    onRejected?: (a: Error) => R | PromiseLike<R>
-  ): Promise<T | R>;
-
-  catch<R>(
-    onRejected: (a: Error) => R | PromiseLike<R>
-  ): Promise<R | LoadBundleTaskProgress>;
-}
-
-export interface LoadBundleTaskProgress {
-  documentsLoaded: number;
-  totalDocuments: number;
-  bytesLoaded: number;
-  totalBytes: number;
-  taskState: TaskState;
-}
-
-export type TaskState = 'Error' | 'Running' | 'Success';
-
 export class GeoPoint {
   constructor(latitude: number, longitude: number);
 

packages/firestore/exp-types/index.d.ts

@@ -516,43 +516,6 @@ export function snapshotEqual<T>(
   right: DocumentSnapshot<T> | QuerySnapshot<T>
 ): boolean;
 
-export interface LoadBundleTask {
-  onProgress(
-    next?: (progress: LoadBundleTaskProgress) => any,
-    error?: (error: Error) => any,
-    complete?: () => void
-  ): void;
-
-  then<T, R>(
-    onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>,
-    onRejected?: (a: Error) => R | PromiseLike<R>
-  ): Promise<T | R>;
-
-  catch<R>(
-    onRejected: (a: Error) => R | PromiseLike<R>
-  ): Promise<R | LoadBundleTaskProgress>;
-}
-
-export interface LoadBundleTaskProgress {
-  documentsLoaded: number;
-  totalDocuments: number;
-  bytesLoaded: number;
-  totalBytes: number;
-  taskState: TaskState;
-}
-
-export type TaskState = 'Error' | 'Running' | 'Success';
-
-export function loadBundle(
-  firestore: FirebaseFirestore,
-  bundleData: ArrayBuffer | ReadableStream<Uint8Array> | string
-): LoadBundleTask;
-
-export function namedQuery(
-  firestore: FirebaseFirestore,
-  name: string
-): Promise<Query<DocumentData> | null>;
-
 export type FirestoreErrorCode =
   | 'cancelled'
   | 'unknown'

packages/firestore/src/api/bundle.ts

@@ -15,24 +15,46 @@
  * limitations under the License.
  */
 
-import * as firestore from '@firebase/firestore-types';
 import { Deferred } from '../util/promise';
 import { PartialObserver } from './observer';
 import { debugAssert } from '../util/assert';
 import { FirestoreError } from '../util/error';
 
+export interface ApiLoadBundleTask {
+  onProgress(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    next?: (progress: ApiLoadBundleTaskProgress) => any,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    error?: (error: Error) => any,
+    complete?: () => void
+  ): void;
+
+  then<T, R>(
+    onFulfilled?: (a: ApiLoadBundleTaskProgress) => T | PromiseLike<T>,
+    onRejected?: (a: Error) => R | PromiseLike<R>
+  ): Promise<T | R>;
+
+  catch<R>(
+    onRejected: (a: Error) => R | PromiseLike<R>
+  ): Promise<R | ApiLoadBundleTaskProgress>;
+}
+
+export interface ApiLoadBundleTaskProgress {
+  documentsLoaded: number;
+  totalDocuments: number;
+  bytesLoaded: number;
+  totalBytes: number;
+  taskState: TaskState;
+}
+
+export type TaskState = 'Error' | 'Running' | 'Success';
+
 export class LoadBundleTask
-  implements
-    firestore.LoadBundleTask,
-    PromiseLike<firestore.LoadBundleTaskProgress> {
-  private _progressObserver: PartialObserver<
-    firestore.LoadBundleTaskProgress
-  > = {};
-  private _taskCompletionResolver = new Deferred<
-    firestore.LoadBundleTaskProgress
-  >();
-
-  private _lastProgress: firestore.LoadBundleTaskProgress = {
+  implements ApiLoadBundleTask, PromiseLike<ApiLoadBundleTaskProgress> {
+  private _progressObserver: PartialObserver<ApiLoadBundleTaskProgress> = {};
+  private _taskCompletionResolver = new Deferred<ApiLoadBundleTaskProgress>();
+
+  private _lastProgress: ApiLoadBundleTaskProgress = {
     taskState: 'Running',
     totalBytes: 0,
     totalDocuments: 0,
@@ -41,7 +63,7 @@ export class LoadBundleTask
   };
 
   onProgress(
-    next?: (progress: firestore.LoadBundleTaskProgress) => unknown,
+    next?: (progress: ApiLoadBundleTaskProgress) => unknown,
     error?: (err: Error) => unknown,
     complete?: () => void
   ): void {
@@ -54,12 +76,12 @@ export class LoadBundleTask
 
   catch<R>(
     onRejected: (a: Error) => R | PromiseLike<R>
-  ): Promise<R | firestore.LoadBundleTaskProgress> {
+  ): Promise<R | ApiLoadBundleTaskProgress> {
     return this._taskCompletionResolver.promise.catch(onRejected);
   }
 
   then<T, R>(
-    onFulfilled?: (a: firestore.LoadBundleTaskProgress) => T | PromiseLike<T>,
+    onFulfilled?: (a: ApiLoadBundleTaskProgress) => T | PromiseLike<T>,
     onRejected?: (a: Error) => R | PromiseLike<R>
   ): Promise<T | R> {
     return this._taskCompletionResolver.promise.then(onFulfilled, onRejected);
@@ -69,7 +91,7 @@ export class LoadBundleTask
    * Notifies all observers that bundle loading has completed, with a provided
    * `LoadBundleTaskProgress` object.
    */
-  _completeWith(progress: firestore.LoadBundleTaskProgress): void {
+  _completeWith(progress: ApiLoadBundleTaskProgress): void {
     debugAssert(
       progress.taskState === 'Success',
       'Task is not completed with Success.'
@@ -104,7 +126,7 @@ export class LoadBundleTask
    * Notifies a progress update of loading a bundle.
    * @param progress The new progress.
    */
-  _updateProgress(progress: firestore.LoadBundleTaskProgress): void {
+  _updateProgress(progress: ApiLoadBundleTaskProgress): void {
     debugAssert(
       this._lastProgress.taskState === 'Running',
       'Cannot update progress on a completed or failed task'

packages/firestore/src/api/database.ts

@@ -28,7 +28,9 @@ import {
   firestoreClientGetDocumentsFromLocalCache,
   firestoreClientGetDocumentsViaSnapshotListener,
   firestoreClientGetDocumentViaSnapshotListener,
+  firestoreClientGetNamedQuery,
   firestoreClientListen,
+  firestoreClientLoadBundle,
   firestoreClientTransaction,
   firestoreClientWrite
 } from '../core/firestore_client';
@@ -141,6 +143,7 @@ import {
 import { newUserDataReader } from '../../lite/src/api/reference';
 import { makeDatabaseInfo } from '../../lite/src/api/database';
 import { DEFAULT_HOST } from '../../lite/src/api/components';
+import { ApiLoadBundleTask, LoadBundleTask } from './bundle';
 
 /**
  * Constant used to indicate the LRU garbage collection should be disabled.
@@ -424,6 +427,36 @@ export function setLogLevel(level: PublicLogLevel): void {
   setClientLogLevel(level);
 }
 
+export function loadBundle(
+  db: Firestore,
+  bundleData: ArrayBuffer | ReadableStream<Uint8Array> | string
+): ApiLoadBundleTask {
+  const resultTask = new LoadBundleTask();
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
+  firestoreClientLoadBundle(
+    ensureFirestoreConfigured(db._delegate),
+    bundleData,
+    resultTask
+  );
+  return resultTask;
+}
+
+export function namedQuery(
+  db: Firestore,
+  name: string
+): Promise<PublicQuery | null> {
+  return firestoreClientGetNamedQuery(
+    ensureFirestoreConfigured(db._delegate),
+    name
+  ).then(namedQuery => {
+    if (!namedQuery) {
+      return null;
+    }
+
+    return new Query(namedQuery.query, db, null);
+  });
+}
+
 /**
  * A reference to a transaction.
  */

packages/firestore/src/core/bundle.ts

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 
-import * as firestore from '@firebase/firestore-types';
 import { Query } from './query';
 import { SnapshotVersion } from './snapshot_version';
 import {
@@ -41,6 +40,7 @@ import {
   DocumentKeySet,
   MaybeDocumentMap
 } from '../model/collections';
+import { ApiLoadBundleTaskProgress } from '../api/bundle';
 
 /**
  * Represents a Firestore bundle saved by the SDK in its local storage.
@@ -118,7 +118,7 @@ export class BundleConverter {
  */
 export function bundleInitialProgress(
   metadata: BundleMetadata
-): firestore.LoadBundleTaskProgress {
+): ApiLoadBundleTaskProgress {
   return {
     taskState: 'Running',
     documentsLoaded: 0,
@@ -134,7 +134,7 @@ export function bundleInitialProgress(
  */
 export function bundleSuccessProgress(
   metadata: BundleMetadata
-): firestore.LoadBundleTaskProgress {
+): ApiLoadBundleTaskProgress {
   return {
     taskState: 'Success',
     documentsLoaded: metadata.totalDocuments!,
@@ -146,7 +146,7 @@ export function bundleSuccessProgress(
 
 export class BundleLoadResult {
   constructor(
-    readonly progress: firestore.LoadBundleTaskProgress,
+    readonly progress: ApiLoadBundleTaskProgress,
     readonly changedDocs: MaybeDocumentMap
   ) {}
 }
@@ -157,7 +157,7 @@ export class BundleLoadResult {
  */
 export class BundleLoader {
   /** The current progress of loading */
-  private progress: firestore.LoadBundleTaskProgress;
+  private progress: ApiLoadBundleTaskProgress;
   /** Batched queries to be saved into storage */
   private queries: bundleProto.NamedQuery[] = [];
   /** Batched documents to be saved into storage */
@@ -179,7 +179,7 @@ export class BundleLoader {
    */
   addSizedElement(
     element: SizedBundleElement
-  ): firestore.LoadBundleTaskProgress | null {
+  ): ApiLoadBundleTaskProgress | null {
     debugAssert(!element.isBundleMetadata(), 'Unexpected bundle metadata.');
 
     this.progress.bytesLoaded += element.byteLength;

packages/firestore/src/core/firestore_client.ts

@@ -662,8 +662,6 @@ export async function firestoreClientLoadBundle(
   data: ReadableStream<Uint8Array> | ArrayBuffer | string,
   resultTask: LoadBundleTask
 ): Promise<void> {
-  client.verifyNotTerminated();
-
   const reader = createBundleReader(
     data,
     newSerializer((await client.getConfiguration()).databaseInfo.databaseId)
@@ -677,7 +675,6 @@ export function firestoreClientGetNamedQuery(
   client: FirestoreClient,
   queryName: string
 ): Promise<NamedQuery | undefined> {
-  client.verifyNotTerminated();
   return client.asyncQueue.enqueue(async () =>
     getNamedQuery(await getLocalStore(client), queryName)
   );