@firebase/app 0.7.17 → 0.7.18-20222320822

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @firebase/app
 
+## 0.7.18-20222320822
+
+### Patch Changes
+
+- [`1588990b7`](https://github.com/firebase/firebase-js-sdk/commit/1588990b7fb06b6fa545c0d478663e137ec0ea07) [#5723](https://github.com/firebase/firebase-js-sdk/pull/5723) - Add heartbeat controller for platform logging.
+
 ## 0.7.17
 
 ### Patch Changes

package/dist/app/src/errors.d.ts

@@ -21,7 +21,11 @@ export declare const enum AppError {
     DUPLICATE_APP = "duplicate-app",
     APP_DELETED = "app-deleted",
     INVALID_APP_ARGUMENT = "invalid-app-argument",
-    INVALID_LOG_ARGUMENT = "invalid-log-argument"
+    INVALID_LOG_ARGUMENT = "invalid-log-argument",
+    STORAGE_OPEN = "storage-open",
+    STORAGE_GET = "storage-get",
+    STORAGE_WRITE = "storage-set",
+    STORAGE_DELETE = "storage-delete"
 }
 interface ErrorParams {
     [AppError.NO_APP]: {
@@ -39,6 +43,18 @@ interface ErrorParams {
     [AppError.INVALID_APP_ARGUMENT]: {
         appName: string;
     };
+    [AppError.STORAGE_OPEN]: {
+        originalErrorMessage?: string;
+    };
+    [AppError.STORAGE_GET]: {
+        originalErrorMessage?: string;
+    };
+    [AppError.STORAGE_WRITE]: {
+        originalErrorMessage?: string;
+    };
+    [AppError.STORAGE_DELETE]: {
+        originalErrorMessage?: string;
+    };
 }
 export declare const ERROR_FACTORY: ErrorFactory<AppError, ErrorParams>;
 export {};

package/dist/app/src/heartbeatService.d.ts

@@ -0,0 +1,84 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * 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 { ComponentContainer } from '@firebase/component';
+import { FirebaseApp } from './public-types';
+import { HeartbeatsByUserAgent, HeartbeatService, HeartbeatStorage, SingleDateHeartbeat } from './types';
+export declare class HeartbeatServiceImpl implements HeartbeatService {
+    private readonly container;
+    /**
+     * The persistence layer for heartbeats
+     * Leave public for easier testing.
+     */
+    _storage: HeartbeatStorageImpl;
+    /**
+     * In-memory cache for heartbeats, used by getHeartbeatsHeader() to generate
+     * the header string.
+     * Stores one record per date. This will be consolidated into the standard
+     * format of one record per user agent string before being sent as a header.
+     * Populated from indexedDB when the controller is instantiated and should
+     * be kept in sync with indexedDB.
+     * Leave public for easier testing.
+     */
+    _heartbeatsCache: SingleDateHeartbeat[] | null;
+    /**
+     * the initialization promise for populating heartbeatCache.
+     * If getHeartbeatsHeader() is called before the promise resolves
+     * (hearbeatsCache == null), it should wait for this promise
+     * Leave public for easier testing.
+     */
+    _heartbeatsCachePromise: Promise<SingleDateHeartbeat[]>;
+    constructor(container: ComponentContainer);
+    /**
+     * Called to report a heartbeat. The function will generate
+     * a HeartbeatsByUserAgent object, update heartbeatsCache, and persist it
+     * to IndexedDB.
+     * Note that we only store one heartbeat per day. So if a heartbeat for today is
+     * already logged, subsequent calls to this function in the same day will be ignored.
+     */
+    triggerHeartbeat(): Promise<void>;
+    /**
+     * Returns a base64 encoded string which can be attached to the heartbeat-specific header directly.
+     * It also clears all heartbeats from memory as well as in IndexedDB.
+     *
+     * NOTE: It will read heartbeats from the heartbeatsCache, instead of from indexedDB to reduce latency
+     */
+    getHeartbeatsHeader(): Promise<string>;
+}
+export declare function extractHeartbeatsForHeader(heartbeatsCache: SingleDateHeartbeat[], maxSize?: number): {
+    heartbeatsToSend: HeartbeatsByUserAgent[];
+    unsentEntries: SingleDateHeartbeat[];
+};
+export declare class HeartbeatStorageImpl implements HeartbeatStorage {
+    app: FirebaseApp;
+    private _canUseIndexedDBPromise;
+    constructor(app: FirebaseApp);
+    runIndexedDBEnvironmentCheck(): Promise<boolean>;
+    /**
+     * Read all heartbeats.
+     */
+    read(): Promise<SingleDateHeartbeat[]>;
+    overwrite(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    add(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    delete(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    deleteAll(): Promise<void>;
+}
+/**
+ * Calculate bytes of a HeartbeatsByUserAgent array after being wrapped
+ * in a platform logging header JSON object, stringified, and converted
+ * to base 64.
+ */
+export declare function countBytes(heartbeatsCache: HeartbeatsByUserAgent[]): number;

package/dist/app/src/heartbeatService.test.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * 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 '../test/setup';
+import { PlatformLoggerService } from './types';
+declare module '@firebase/component' {
+    interface NameServiceMapping {
+        'platform-logger': PlatformLoggerService;
+    }
+}

package/dist/app/src/indexeddb.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * 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 { FirebaseApp } from './public-types';
+import { HeartbeatsInIndexedDB } from './types';
+export declare function readHeartbeatsFromIndexedDB(app: FirebaseApp): Promise<HeartbeatsInIndexedDB | undefined>;
+export declare function writeHeartbeatsToIndexedDB(app: FirebaseApp, heartbeatObject: HeartbeatsInIndexedDB): Promise<void>;
+export declare function deleteHeartbeatsFromIndexedDB(app: FirebaseApp): Promise<void>;

package/dist/app/src/public-types.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { ComponentContainer } from '@firebase/component';
-import { PlatformLoggerService, VersionService } from './types';
+import { PlatformLoggerService, VersionService, HeartbeatService } from './types';
 /**
  * A {@link @firebase/app#FirebaseApp} holds the initialization information for a collection of
  * services.
@@ -151,6 +151,7 @@ declare module '@firebase/component' {
     interface NameServiceMapping {
         'app': FirebaseApp;
         'app-version': VersionService;
+        'heartbeat': HeartbeatService;
         'platform-logger': PlatformLoggerService;
     }
 }

package/dist/app/src/types.d.ts

@@ -21,3 +21,36 @@ export interface VersionService {
 export interface PlatformLoggerService {
     getPlatformInfoString(): string;
 }
+export interface HeartbeatService {
+    /**
+     * Called to report a heartbeat. The function will generate
+     * a HeartbeatsByUserAgent object, update heartbeatsCache, and persist it
+     * to IndexedDB.
+     * Note that we only store one heartbeat per day. So if a heartbeat for today is
+     * already logged, subsequent calls to this function in the same day will be ignored.
+     */
+    triggerHeartbeat(): Promise<void>;
+    /**
+     * Returns a base64 encoded string which can be attached to the heartbeat-specific header directly.
+     * It also clears all heartbeats from memory as well as in IndexedDB.
+     */
+    getHeartbeatsHeader(): Promise<string>;
+}
+export interface HeartbeatsByUserAgent {
+    userAgent: string;
+    dates: string[];
+}
+export interface SingleDateHeartbeat {
+    userAgent: string;
+    date: string;
+}
+export interface HeartbeatStorage {
+    overwrite(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    add(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    delete(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    deleteAll(): Promise<void>;
+    read(): Promise<SingleDateHeartbeat[]>;
+}
+export interface HeartbeatsInIndexedDB {
+    heartbeats: SingleDateHeartbeat[];
+}

package/dist/esm/app/src/errors.d.ts

@@ -21,7 +21,11 @@ export declare const enum AppError {
     DUPLICATE_APP = "duplicate-app",
     APP_DELETED = "app-deleted",
     INVALID_APP_ARGUMENT = "invalid-app-argument",
-    INVALID_LOG_ARGUMENT = "invalid-log-argument"
+    INVALID_LOG_ARGUMENT = "invalid-log-argument",
+    STORAGE_OPEN = "storage-open",
+    STORAGE_GET = "storage-get",
+    STORAGE_WRITE = "storage-set",
+    STORAGE_DELETE = "storage-delete"
 }
 interface ErrorParams {
     [AppError.NO_APP]: {
@@ -39,6 +43,18 @@ interface ErrorParams {
     [AppError.INVALID_APP_ARGUMENT]: {
         appName: string;
     };
+    [AppError.STORAGE_OPEN]: {
+        originalErrorMessage?: string;
+    };
+    [AppError.STORAGE_GET]: {
+        originalErrorMessage?: string;
+    };
+    [AppError.STORAGE_WRITE]: {
+        originalErrorMessage?: string;
+    };
+    [AppError.STORAGE_DELETE]: {
+        originalErrorMessage?: string;
+    };
 }
 export declare const ERROR_FACTORY: ErrorFactory<AppError, ErrorParams>;
 export {};

package/dist/esm/app/src/heartbeatService.d.ts

@@ -0,0 +1,84 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * 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 { ComponentContainer } from '@firebase/component';
+import { FirebaseApp } from './public-types';
+import { HeartbeatsByUserAgent, HeartbeatService, HeartbeatStorage, SingleDateHeartbeat } from './types';
+export declare class HeartbeatServiceImpl implements HeartbeatService {
+    private readonly container;
+    /**
+     * The persistence layer for heartbeats
+     * Leave public for easier testing.
+     */
+    _storage: HeartbeatStorageImpl;
+    /**
+     * In-memory cache for heartbeats, used by getHeartbeatsHeader() to generate
+     * the header string.
+     * Stores one record per date. This will be consolidated into the standard
+     * format of one record per user agent string before being sent as a header.
+     * Populated from indexedDB when the controller is instantiated and should
+     * be kept in sync with indexedDB.
+     * Leave public for easier testing.
+     */
+    _heartbeatsCache: SingleDateHeartbeat[] | null;
+    /**
+     * the initialization promise for populating heartbeatCache.
+     * If getHeartbeatsHeader() is called before the promise resolves
+     * (hearbeatsCache == null), it should wait for this promise
+     * Leave public for easier testing.
+     */
+    _heartbeatsCachePromise: Promise<SingleDateHeartbeat[]>;
+    constructor(container: ComponentContainer);
+    /**
+     * Called to report a heartbeat. The function will generate
+     * a HeartbeatsByUserAgent object, update heartbeatsCache, and persist it
+     * to IndexedDB.
+     * Note that we only store one heartbeat per day. So if a heartbeat for today is
+     * already logged, subsequent calls to this function in the same day will be ignored.
+     */
+    triggerHeartbeat(): Promise<void>;
+    /**
+     * Returns a base64 encoded string which can be attached to the heartbeat-specific header directly.
+     * It also clears all heartbeats from memory as well as in IndexedDB.
+     *
+     * NOTE: It will read heartbeats from the heartbeatsCache, instead of from indexedDB to reduce latency
+     */
+    getHeartbeatsHeader(): Promise<string>;
+}
+export declare function extractHeartbeatsForHeader(heartbeatsCache: SingleDateHeartbeat[], maxSize?: number): {
+    heartbeatsToSend: HeartbeatsByUserAgent[];
+    unsentEntries: SingleDateHeartbeat[];
+};
+export declare class HeartbeatStorageImpl implements HeartbeatStorage {
+    app: FirebaseApp;
+    private _canUseIndexedDBPromise;
+    constructor(app: FirebaseApp);
+    runIndexedDBEnvironmentCheck(): Promise<boolean>;
+    /**
+     * Read all heartbeats.
+     */
+    read(): Promise<SingleDateHeartbeat[]>;
+    overwrite(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    add(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    delete(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    deleteAll(): Promise<void>;
+}
+/**
+ * Calculate bytes of a HeartbeatsByUserAgent array after being wrapped
+ * in a platform logging header JSON object, stringified, and converted
+ * to base 64.
+ */
+export declare function countBytes(heartbeatsCache: HeartbeatsByUserAgent[]): number;

package/dist/esm/app/src/heartbeatService.test.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * 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 '../test/setup';
+import { PlatformLoggerService } from './types';
+declare module '@firebase/component' {
+    interface NameServiceMapping {
+        'platform-logger': PlatformLoggerService;
+    }
+}

package/dist/esm/app/src/indexeddb.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * 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 { FirebaseApp } from './public-types';
+import { HeartbeatsInIndexedDB } from './types';
+export declare function readHeartbeatsFromIndexedDB(app: FirebaseApp): Promise<HeartbeatsInIndexedDB | undefined>;
+export declare function writeHeartbeatsToIndexedDB(app: FirebaseApp, heartbeatObject: HeartbeatsInIndexedDB): Promise<void>;
+export declare function deleteHeartbeatsFromIndexedDB(app: FirebaseApp): Promise<void>;

package/dist/esm/app/src/public-types.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { ComponentContainer } from '@firebase/component';
-import { PlatformLoggerService, VersionService } from './types';
+import { PlatformLoggerService, VersionService, HeartbeatService } from './types';
 /**
  * A {@link @firebase/app#FirebaseApp} holds the initialization information for a collection of
  * services.
@@ -151,6 +151,7 @@ declare module '@firebase/component' {
     interface NameServiceMapping {
         'app': FirebaseApp;
         'app-version': VersionService;
+        'heartbeat': HeartbeatService;
         'platform-logger': PlatformLoggerService;
     }
 }

package/dist/esm/app/src/types.d.ts

@@ -21,3 +21,36 @@ export interface VersionService {
 export interface PlatformLoggerService {
     getPlatformInfoString(): string;
 }
+export interface HeartbeatService {
+    /**
+     * Called to report a heartbeat. The function will generate
+     * a HeartbeatsByUserAgent object, update heartbeatsCache, and persist it
+     * to IndexedDB.
+     * Note that we only store one heartbeat per day. So if a heartbeat for today is
+     * already logged, subsequent calls to this function in the same day will be ignored.
+     */
+    triggerHeartbeat(): Promise<void>;
+    /**
+     * Returns a base64 encoded string which can be attached to the heartbeat-specific header directly.
+     * It also clears all heartbeats from memory as well as in IndexedDB.
+     */
+    getHeartbeatsHeader(): Promise<string>;
+}
+export interface HeartbeatsByUserAgent {
+    userAgent: string;
+    dates: string[];
+}
+export interface SingleDateHeartbeat {
+    userAgent: string;
+    date: string;
+}
+export interface HeartbeatStorage {
+    overwrite(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    add(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    delete(heartbeats: SingleDateHeartbeat[]): Promise<void>;
+    deleteAll(): Promise<void>;
+    read(): Promise<SingleDateHeartbeat[]>;
+}
+export interface HeartbeatsInIndexedDB {
+    heartbeats: SingleDateHeartbeat[];
+}