Final indexeddb pass

Author: maneesht

common/api-review/data-connect.api.md

@@ -11,6 +11,17 @@ import { FirebaseError } from '@firebase/util';
 import { LogLevelString } from '@firebase/logger';
 import { Provider } from '@firebase/component';
 
+// @public (undocumented)
+export const CacheOnly = "cacheOnly";
+
+// @public
+export interface CacheSettings {
+    // (undocumented)
+    maxSizeBytes: number;
+    // (undocumented)
+    storage: DataConnectStorage;
+}
+
 // @public
 export type CallerSdkType = 'Base' | 'Generated' | 'TanstackReactCore' | 'GeneratedReact' | 'TanstackAngularCore' | 'GeneratedAngular';
 
@@ -98,7 +109,7 @@ export interface DataConnectOperationFailureResponseErrorInfo {
 }
 
 // @public
-export interface DataConnectOptions extends ConnectorConfig {
+export interface DataConnectOptions extends ConnectorConfig, DataConnectSettings {
     // (undocumented)
     projectId: string;
 }
@@ -109,6 +120,15 @@ export interface DataConnectResult<Data, Variables> extends OpResult<Data> {
     ref: OperationRef<Data, Variables>;
 }
 
+// @public (undocumented)
+export interface DataConnectSettings {
+    // (undocumented)
+    cacheSettings?: CacheSettings;
+}
+
+// @public (undocumented)
+export type DataConnectStorage = typeof Memory | typeof Persistent;
+
 // @public
 export interface DataConnectSubscription<Data, Variables> {
     // (undocumented)
@@ -126,13 +146,28 @@ export type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
 export function executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
 
 // @public
-export function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
+export function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>, options?: ExecuteQueryOptions): QueryPromise<Data, Variables>;
+
+// @public (undocumented)
+export interface ExecuteQueryOptions {
+    // (undocumented)
+    fetchPolicy: QueryFetchPolicy;
+}
 
 // @public
+export function getDataConnect(options: ConnectorConfig, settings?: DataConnectSettings): DataConnect;
+
+// @public (undocumented)
 export function getDataConnect(options: ConnectorConfig): DataConnect;
 
 // @public
-export function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
+export function getDataConnect(app: FirebaseApp, connectorConfig: ConnectorConfig): DataConnect;
+
+// @public
+export function getDataConnect(app: FirebaseApp, connectorConfig: ConnectorConfig, settings: DataConnectSettings): DataConnect;
+
+// @public (undocumented)
+export const Memory = "memory";
 
 // @public (undocumented)
 export const MUTATION_STR = "mutation";
@@ -190,9 +225,18 @@ export interface OpResult<Data> {
     source: DataSource;
 }
 
+// @public (undocumented)
+export const Persistent = "persistent";
+
+// @public (undocumented)
+export const PreferCache = "preferCache";
+
 // @public (undocumented)
 export const QUERY_STR = "query";
 
+// @public (undocumented)
+export type QueryFetchPolicy = typeof PreferCache | typeof CacheOnly | typeof ServerOnly;
+
 // @public
 export interface QueryPromise<Data, Variables> extends Promise<QueryResult<Data, Variables>> {
 }
@@ -239,6 +283,9 @@ export interface SerializedRef<Data, Variables> extends OpResult<Data> {
     refInfo: RefInfo<Variables>;
 }
 
+// @public (undocumented)
+export const ServerOnly = "serverOnly";
+
 // @public (undocumented)
 export function setLogLevel(logLevel: LogLevelString): void;
 

common/api-review/util.api.md

@@ -221,6 +221,11 @@ export class FirebaseError extends Error {
 // @public
 export type FirebaseSignInProvider = 'custom' | 'email' | 'password' | 'phone' | 'anonymous' | 'google.com' | 'facebook.com' | 'github.com' | 'twitter.com' | 'microsoft.com' | 'apple.com';
 
+// Warning: (ae-missing-release-tag) "generateSHA256HashBrowser" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function generateSHA256HashBrowser(input: string): Promise<string>;
+
 // @public
 export const getDefaultAppConfig: () => Record<string, string> | undefined;
 

packages/data-connect/src/api.browser.ts

@@ -15,94 +15,4 @@
  * limitations under the License.
  */
 
-import {
-  OnCompleteSubscription,
-  OnErrorSubscription,
-  OnResultSubscription,
-  QueryRef,
-  QueryUnsubscribe,
-  SubscriptionOptions,
-  toQueryRef
-} from './api/query';
-import { OpResult, SerializedRef } from './api/Reference';
-import { DataConnectError, Code } from './core/error';
-
-/**
- * Subscribe to a `QueryRef`
- * @param queryRefOrSerializedResult query ref or serialized result.
- * @param observer observer object to use for subscribing.
- * @returns `SubscriptionOptions`
- */
-export function subscribe<Data, Variables>(
-  queryRefOrSerializedResult:
-    | QueryRef<Data, Variables>
-    | SerializedRef<Data, Variables>,
-  observer: SubscriptionOptions<Data, Variables>
-): QueryUnsubscribe;
-/**
- * Subscribe to a `QueryRef`
- * @param queryRefOrSerializedResult query ref or serialized result.
- * @param onNext Callback to call when result comes back.
- * @param onError Callback to call when error gets thrown.
- * @param onComplete Called when subscription completes.
- * @returns `SubscriptionOptions`
- */
-export function subscribe<Data, Variables>(
-  queryRefOrSerializedResult:
-    | QueryRef<Data, Variables>
-    | SerializedRef<Data, Variables>,
-  onNext: OnResultSubscription<Data, Variables>,
-  onError?: OnErrorSubscription,
-  onComplete?: OnCompleteSubscription
-): QueryUnsubscribe;
-/**
- * Subscribe to a `QueryRef`
- * @param queryRefOrSerializedResult query ref or serialized result.
- * @param observerOrOnNext observer object or next function.
- * @param onError Callback to call when error gets thrown.
- * @param onComplete Called when subscription completes.
- * @returns `SubscriptionOptions`
- */
-export function subscribe<Data, Variables>(
-  queryRefOrSerializedResult:
-    | QueryRef<Data, Variables>
-    | SerializedRef<Data, Variables>,
-  observerOrOnNext:
-    | SubscriptionOptions<Data, Variables>
-    | OnResultSubscription<Data, Variables>,
-  onError?: OnErrorSubscription,
-  onComplete?: OnCompleteSubscription
-): QueryUnsubscribe {
-  let ref: QueryRef<Data, Variables>;
-  let initialCache: OpResult<Data> | undefined;
-  if ('refInfo' in queryRefOrSerializedResult) {
-    const serializedRef: SerializedRef<Data, Variables> =
-      queryRefOrSerializedResult;
-    const { data, source, fetchTime } = serializedRef;
-    initialCache = {
-      data,
-      source,
-      fetchTime
-    };
-    ref = toQueryRef(serializedRef);
-  } else {
-    ref = queryRefOrSerializedResult;
-  }
-  let onResult: OnResultSubscription<Data, Variables> | undefined = undefined;
-  if (typeof observerOrOnNext === 'function') {
-    onResult = observerOrOnNext;
-  } else {
-    onResult = observerOrOnNext.onNext;
-    onError = observerOrOnNext.onErr;
-    onComplete = observerOrOnNext.onComplete;
-  }
-  if (!onResult) {
-    throw new DataConnectError(Code.INVALID_ARGUMENT, 'Must provide onNext');
-  }
-  return ref.dataConnect._queryManager.addSubscription(
-    ref,
-    onResult,
-    onError,
-    initialCache
-  );
-}
+export * from './core/query/subscribe';

packages/data-connect/src/api/DataConnect.ts

@@ -30,14 +30,14 @@ import {
   updateEmulatorBanner
 } from '@firebase/util';
 
-import { Cache as DataConnectCache } from '../cache/Cache';
+import { CacheSettings, DataConnectCache, InMemoryCacheProvider } from '../cache/Cache';
 import { AppCheckTokenProvider } from '../core/AppCheckTokenProvider';
 import { Code, DataConnectError } from '../core/error';
 import {
   AuthTokenProvider,
   FirebaseAuthProvider
 } from '../core/FirebaseAuthProvider';
-import { QueryManager } from '../core/QueryManager';
+import { QueryManager } from '../core/query/QueryManager';
 import { logDebug, logError } from '../logger';
 import {
   CallerSdkType,
@@ -46,8 +46,11 @@ import {
   TransportClass
 } from '../network';
 import { RESTTransport } from '../network/transport/rest';
+import { PROD_HOST } from '../util/url';
 
 import { MutationManager } from './Mutation';
+import { IndexedDBCacheProvider } from '../cache/IndexedDBCacheProvider';
+import { CacheProvider } from '../cache/CacheProvider';
 
 /**
  * Connector Config for calling Data Connect backend.
@@ -86,7 +89,7 @@ export function parseOptions(fullHost: string): TransportOptions {
 /**
  * DataConnectOptions including project id
  */
-export interface DataConnectOptions extends ConnectorConfig, DataConnectInitOptions {
+export interface DataConnectOptions extends ConnectorConfig, DataConnectSettings {
   projectId: string;
 }
 
@@ -122,7 +125,6 @@ export class DataConnect {
         this._transportOptions = parseOptions(host);
       }
     }
-    this.cache = new DataConnectCache(this.dataConnectOptions.cacheSettings);
   }
   // @internal
   _useGeneratedSdk(): void {
@@ -168,16 +170,23 @@ export class DataConnect {
         this.app.options,
         this._authProvider
       );
-      this.cache.setAuthProvider(this._authTokenProvider);
+
+
     }
+    const connectorConfig: ConnectorConfig = {
+      connector: this.dataConnectOptions.connector,
+      service: this.dataConnectOptions.service,
+      location: this.dataConnectOptions.location
+    };
+    this.cache = new DataConnectCache(this._authTokenProvider, this.app.options.projectId, connectorConfig, this._transportOptions.host || PROD_HOST, this.dataConnectOptions.cacheSettings);
+    this.cache.setAuthProvider(this._authTokenProvider);
     if (this._appCheckProvider) {
       this._appCheckTokenProvider = new AppCheckTokenProvider(
         this.app,
         this._appCheckProvider
       );
     }
 
-    this._initialized = true;
     this._transport = new this._transportClass(
       this.dataConnectOptions,
       this.app.options.apiKey,
@@ -195,8 +204,10 @@ export class DataConnect {
         this._transportOptions.sslEnabled
       );
     }
+
     this._queryManager = new QueryManager(this._transport, this.cache, this);
     this._mutationManager = new MutationManager(this._transport);
+    this._initialized = true;
   }
 
   // @internal
@@ -255,26 +266,36 @@ export function connectDataConnectEmulator(
   dc.enableEmulator({ host, port, sslEnabled });
 }
 
-// TODO: Can we do something to make sure that this is more tree-shakable?
-export enum Storage {
-  memory,
-  persistent
+export type CacheProviderImpl = PublicIndexedDbProvider | PublicEphemeralDbProvider;
+
+class PublicIndexedDbProvider {
+  
+  /**
+   * @internal
+   */
+  initializeProvider(cacheId: string): CacheProvider {
+    return new IndexedDBCacheProvider(cacheId);
+  }
 }
 
-export interface CacheSettings {
-  storage: Storage;
-  maxSizeBytes: number;
+class PublicEphemeralDbProvider {
+  /**
+   * @internal
+   */
+  initializeProvider(cacheId: string): CacheProvider {
+    return new InMemoryCacheProvider(cacheId);
+  }
 }
 
-export interface DataConnectInitOptions {
-  cacheSettings?: CacheSettings;
+export interface DataConnectSettings {
+  cacheSettings?: CacheProviderImpl;
 }
 
 /**
  * Initialize DataConnect instance
  * @param options ConnectorConfig
  */
-export function getDataConnect(options: ConnectorConfig, extraOptions?: DataConnectInitOptions): DataConnect;
+export function getDataConnect(options: ConnectorConfig, settings?: DataConnectSettings): DataConnect;
 export function getDataConnect(options: ConnectorConfig): DataConnect;
 /** 
  * Initialize DataConnect instance
@@ -294,36 +315,39 @@ export function getDataConnect(
 export function getDataConnect(
   app: FirebaseApp,
   connectorConfig: ConnectorConfig,
-  extraOptions: DataConnectInitOptions
+  settings: DataConnectSettings
 ): DataConnect;
 
 export function getDataConnect(
   appOrConnectorConfig: FirebaseApp | ConnectorConfig,
-  optionsOrConnectorConfig?: ConnectorConfig | DataConnectInitOptions,
-  extraOptions?: DataConnectInitOptions
+  settingsOrConnectorConfig?: ConnectorConfig | DataConnectSettings,
+  settings?: DataConnectSettings
 ): DataConnect {
   let app: FirebaseApp;
   let connectorConfig: ConnectorConfig;
-  let options: DataConnectInitOptions;
+  let realSettings: DataConnectSettings;
   if ('location' in appOrConnectorConfig) {
     connectorConfig = appOrConnectorConfig;
     app = getApp();
-    options = optionsOrConnectorConfig as DataConnectInitOptions;
+    realSettings = settingsOrConnectorConfig as DataConnectSettings;
   } else {
     app = appOrConnectorConfig;
-    connectorConfig = optionsOrConnectorConfig as ConnectorConfig;
-    options = extraOptions as DataConnectInitOptions;
+    connectorConfig = settingsOrConnectorConfig as ConnectorConfig;
+    realSettings = settings as DataConnectSettings;
   }
 
-  const dcOptions = {
-    ...options,
-    connectorConfig
-  };
+
 
   if (!app || Object.keys(app).length === 0) {
     app = getApp();
   }
+  const dcOptions: DataConnectOptions = {
+    ...realSettings,
+    ...connectorConfig,
+    projectId: app.options.projectId
+  };
   const provider = _getProvider(app, 'data-connect');
+  // TODO: Deal with the parsing of these options properly.
   const identifier = JSON.stringify(dcOptions);
   if (provider.isInitialized(identifier)) {
     const dcInstance = provider.getImmediate({ identifier });