Merge master into release

Author: google-oss-bot

.changeset/late-ducks-invite.md

@@ -0,0 +1,5 @@
+---
+'firebase': patch
+---
+
+Add installations CDN build and entry point.

.changeset/metal-spies-shave.md

@@ -0,0 +1,6 @@
+---
+"@firebase/database": patch
+"@firebase/util": patch
+---
+
+Forced `get()` to wait until db is online to resolve.

.changeset/shiny-bats-reflect.md

@@ -0,0 +1,5 @@
+---
+'@firebase/analytics': minor
+---
+
+Add function `setConsent()` to set the applicable end user "consent" state.

.changeset/silly-panthers-mix.md

@@ -0,0 +1,5 @@
+---
+'@firebase/analytics': minor
+---
+
+Add function `setDefaultEventParameters()` to set data that will be logged on every Analytics SDK event

.changeset/tiny-donuts-draw.md

@@ -0,0 +1,5 @@
+---
+'@firebase/functions': patch
+---
+
+Update public `FunctionsErrorCode` type to include "functions/" prefix.

.changeset/witty-windows-unite.md

@@ -0,0 +1,5 @@
+---
+"@firebase/auth": patch
+---
+
+Update user agent detection to better detect iPad; fixes bug for some iPad devices running Cordova apps

.github/CODEOWNERS

@@ -16,6 +16,7 @@
 #   - @lahirumaramba
 #   - @hsubox76
 #   - @allspain
+#   - @dwyfrequency
 
 
 # ===========================================================
@@ -32,7 +33,7 @@
 
 
 # These owners will be the default owners for everything in the repo.
-*       @allspain @hsubox76 @firebase/jssdk-global-approvers
+*       @dwyfrequency @hsubox76 @firebase/jssdk-global-approvers
 
 # Database Code
 packages/database @maneesht @jsdt @firebase/jssdk-global-approvers

.github/workflows/health-metrics-pull-request.yml

@@ -1,6 +1,9 @@
 name: Health Metrics
 
-on: [push, pull_request]
+on:
+  push:
+    branches: ['**']
+  pull_request:
 
 env:
   GITHUB_PULL_REQUEST_NUMBER: ${{ github.event.pull_request.number }}

.github/workflows/release-pr.yml

@@ -10,6 +10,7 @@ jobs:
   release:
     name: Create Release PR
     runs-on: ubuntu-latest
+    if: ${{ !startsWith(github.event.head_commit.message, 'Version Packages (#') }}
     steps:
       - name: Checkout Repo
         uses: actions/checkout@master

.github/workflows/release-prod.yml

@@ -21,6 +21,7 @@ jobs:
         # Release script requires git history and tags.
         fetch-depth: 0
         ref: release
+        token: ${{ secrets.OSS_BOT_GITHUB_TOKEN }}
     - name: Yarn install
       run: yarn
     - name: Publish to NPM
@@ -31,7 +32,6 @@ jobs:
       # TODO: Make these flags defaults in the release script.
       run: yarn release --releaseType Production --ci --skipTests --skipReinstall --ignoreUnstaged
       env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         NPM_TOKEN_ANALYTICS: ${{secrets.NPM_TOKEN_ANALYTICS}}
         NPM_TOKEN_ANALYTICS_INTEROP_TYPES: ${{secrets.NPM_TOKEN_ANALYTICS_INTEROP_TYPES}}
         NPM_TOKEN_ANALYTICS_TYPES: ${{secrets.NPM_TOKEN_ANALYTICS_TYPES}}

.github/workflows/test-all.yml

@@ -1,6 +1,9 @@
 name: Test All Packages
 
-on: push
+on:
+  push:
+    branches: ['**']
+
 env:
   # make chromedriver detect installed Chrome version and download the corresponding driver
   DETECT_CHROMEDRIVER_VERSION: true

common/api-review/analytics.api.md

@@ -21,6 +21,20 @@ export interface AnalyticsSettings {
     config?: GtagConfigParams | EventParams;
 }
 
+// @public
+export interface ConsentSettings {
+    // (undocumented)
+    [key: string]: unknown;
+    ad_storage?: ConsentStatusString;
+    analytics_storage?: ConsentStatusString;
+    functionality_storage?: ConsentStatusString;
+    personalization_storage?: ConsentStatusString;
+    security_storage?: ConsentStatusString;
+}
+
+// @public
+export type ConsentStatusString = 'granted' | 'denied';
+
 // @public
 export interface ControlParams {
     // (undocumented)
@@ -388,9 +402,15 @@ export interface Promotion {
 // @public
 export function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enabled: boolean): void;
 
+// @public
+export function setConsent(consentSettings: ConsentSettings): void;
+
 // @public @deprecated
 export function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;
 
+// @public
+export function setDefaultEventParameters(customParams: CustomParams): void;
+
 // @public
 export function settings(options: SettingsOptions): void;
 

common/api-review/functions.api.md

@@ -24,7 +24,10 @@ export interface FunctionsError extends FirebaseError {
 }
 
 // @public
-export type FunctionsErrorCode = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
+export type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
+
+// @public
+export type FunctionsErrorCodeCore = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
 
 // @public
 export function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

common/api-review/util.api.md

@@ -346,6 +346,11 @@ export function ordinal(i: number): string;
 // @public (undocumented)
 export type PartialObserver<T> = Partial<Observer<T>>;
 
+// Warning: (ae-internal-missing-underscore) The name "promiseWithTimeout" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export function promiseWithTimeout<T>(promise: Promise<T>, timeInMS?: number): Promise<T>;
+
 // Warning: (ae-missing-release-tag) "querystring" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public

package.json

@@ -136,7 +136,6 @@
     "mocha": "9.2.2",
     "mz": "2.7.0",
     "npm-run-all": "4.1.5",
-    "npm-run-path": "4.0.1",
     "nyc": "15.1.0",
     "ora": "5.4.1",
     "prettier": "2.6.2",

packages/analytics/src/api.test.ts

@@ -19,15 +19,27 @@ import { expect } from 'chai';
 import { SinonStub, stub } from 'sinon';
 import '../testing/setup';
 import { getFullApp } from '../testing/get-fake-firebase-services';
-import { getAnalytics, initializeAnalytics } from './api';
+import {
+  getAnalytics,
+  initializeAnalytics,
+  setConsent,
+  setDefaultEventParameters
+} from './api';
 import { FirebaseApp, deleteApp } from '@firebase/app';
 import { AnalyticsError } from './errors';
 import * as init from './initialize-analytics';
 const fakeAppParams = { appId: 'abcdefgh12345:23405', apiKey: 'AAbbCCdd12345' };
+import * as factory from './factory';
+import {
+  defaultConsentSettingsForInit,
+  defaultEventParametersForInit
+} from './functions';
+import { ConsentSettings } from './public-types';
 
 describe('FirebaseAnalytics API tests', () => {
   let initStub: SinonStub = stub();
   let app: FirebaseApp;
+  const wrappedGtag: SinonStub = stub();
 
   beforeEach(() => {
     initStub = stub(init, '_initializeAnalytics').resolves(
@@ -94,4 +106,52 @@ describe('FirebaseAnalytics API tests', () => {
     const analyticsInstance = initializeAnalytics(app);
     expect(getAnalytics(app)).to.equal(analyticsInstance);
   });
+  it('setDefaultEventParameters() updates defaultEventParametersForInit if gtag does not exist ', () => {
+    const eventParametersForInit = {
+      'github_user': 'dwyfrequency',
+      'company': 'google'
+    };
+    app = getFullApp(fakeAppParams);
+    setDefaultEventParameters(eventParametersForInit);
+    expect(defaultEventParametersForInit).to.deep.equal(eventParametersForInit);
+  });
+  it('setDefaultEventParameters() calls gtag set if wrappedGtagFunction exists', () => {
+    const eventParametersForInit = {
+      'github_user': 'dwyfrequency',
+      'company': 'google'
+    };
+    stub(factory, 'wrappedGtagFunction').get(() => wrappedGtag);
+    app = getFullApp(fakeAppParams);
+    setDefaultEventParameters(eventParametersForInit);
+    expect(wrappedGtag).to.have.been.calledWithExactly(
+      'set',
+      eventParametersForInit
+    );
+  });
+  it('setConsent() updates defaultConsentSettingsForInit if gtag does not exist ', () => {
+    const consentParametersForInit: ConsentSettings = {
+      'analytics_storage': 'granted',
+      'functionality_storage': 'denied'
+    };
+    stub(factory, 'wrappedGtagFunction').get(() => undefined);
+    app = getFullApp(fakeAppParams);
+    setConsent(consentParametersForInit);
+    expect(defaultConsentSettingsForInit).to.deep.equal(
+      consentParametersForInit
+    );
+  });
+  it('setConsent() calls gtag consent "update" if wrappedGtagFunction exists', () => {
+    const consentParametersForInit: ConsentSettings = {
+      'analytics_storage': 'granted',
+      'functionality_storage': 'denied'
+    };
+    stub(factory, 'wrappedGtagFunction').get(() => wrappedGtag);
+    app = getFullApp(fakeAppParams);
+    setConsent(consentParametersForInit);
+    expect(wrappedGtag).to.have.been.calledWithExactly(
+      'consent',
+      'update',
+      consentParametersForInit
+    );
+  });
 });

packages/analytics/src/api.ts

@@ -22,6 +22,7 @@ import {
   Analytics,
   AnalyticsCallOptions,
   AnalyticsSettings,
+  ConsentSettings,
   CustomParams,
   EventNameString,
   EventParams
@@ -35,7 +36,7 @@ import {
   getModularInstance,
   deepEqual
 } from '@firebase/util';
-import { ANALYTICS_TYPE } from './constants';
+import { ANALYTICS_TYPE, GtagCommand } from './constants';
 import {
   AnalyticsService,
   initializationPromisesMap,
@@ -47,7 +48,9 @@ import {
   setCurrentScreen as internalSetCurrentScreen,
   setUserId as internalSetUserId,
   setUserProperties as internalSetUserProperties,
-  setAnalyticsCollectionEnabled as internalSetAnalyticsCollectionEnabled
+  setAnalyticsCollectionEnabled as internalSetAnalyticsCollectionEnabled,
+  _setConsentDefaultForInit,
+  _setDefaultEventParametersForInit
 } from './functions';
 import { ERROR_FACTORY, AnalyticsError } from './errors';
 
@@ -224,6 +227,23 @@ export function setAnalyticsCollectionEnabled(
     enabled
   ).catch(e => logger.error(e));
 }
+
+/**
+ * Adds data that will be set on every event logged from the SDK, including automatic ones.
+ * With gtag's "set" command, the values passed persist on the current page and are passed with
+ * all subsequent events.
+ * @public
+ * @param customParams - Any custom params the user may pass to gtag.js.
+ */
+export function setDefaultEventParameters(customParams: CustomParams): void {
+  // Check if reference to existing gtag function on window object exists
+  if (wrappedGtagFunction) {
+    wrappedGtagFunction(GtagCommand.SET, customParams);
+  } else {
+    _setDefaultEventParametersForInit(customParams);
+  }
+}
+
 /**
  * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
@@ -716,3 +736,21 @@ export function logEvent(
  * @public
  */
 export type CustomEventName<T> = T extends EventNameString ? never : T;
+
+/**
+ * Sets the applicable end user consent state for this web app across all gtag references once
+ * Firebase Analytics is initialized.
+ *
+ * Use the {@link ConsentSettings} to specify individual consent type values. By default consent
+ * types are set to "granted".
+ * @public
+ * @param consentSettings - Maps the applicable end user consent state for gtag.js.
+ */
+export function setConsent(consentSettings: ConsentSettings): void {
+  // Check if reference to existing gtag function on window object exists
+  if (wrappedGtagFunction) {
+    wrappedGtagFunction(GtagCommand.CONSENT, 'update', consentSettings);
+  } else {
+    _setConsentDefaultForInit(consentSettings);
+  }
+}

packages/analytics/src/constants.ts

@@ -34,5 +34,6 @@ export const GTAG_URL = 'https://www.googletagmanager.com/gtag/js';
 export const enum GtagCommand {
   EVENT = 'event',
   SET = 'set',
-  CONFIG = 'config'
+  CONFIG = 'config',
+  CONSENT = 'consent'
 }

packages/analytics/src/functions.test.ts

@@ -23,9 +23,14 @@ import {
   logEvent,
   setUserId,
   setUserProperties,
-  setAnalyticsCollectionEnabled
+  setAnalyticsCollectionEnabled,
+  defaultEventParametersForInit,
+  _setDefaultEventParametersForInit,
+  _setConsentDefaultForInit,
+  defaultConsentSettingsForInit
 } from './functions';
 import { GtagCommand } from './constants';
+import { ConsentSettings } from './public-types';
 
 const fakeMeasurementId = 'abcd-efgh-ijkl';
 const fakeInitializationPromise = Promise.resolve(fakeMeasurementId);
@@ -170,4 +175,46 @@ describe('FirebaseAnalytics methods', () => {
     expect(window[`ga-disable-${fakeMeasurementId}`]).to.be.true;
     delete window[`ga-disable-${fakeMeasurementId}`];
   });
+  it('_setDefaultEventParametersForInit() stores individual params correctly', async () => {
+    const eventParametersForInit = {
+      'github_user': 'dwyfrequency',
+      'company': 'google'
+    };
+    _setDefaultEventParametersForInit(eventParametersForInit);
+    expect(defaultEventParametersForInit).to.deep.equal(eventParametersForInit);
+  });
+  it('_setDefaultEventParametersForInit() replaces previous params with new params', async () => {
+    const eventParametersForInit = {
+      'github_user': 'dwyfrequency',
+      'company': 'google'
+    };
+    const additionalParams = { 'food': 'sushi' };
+    _setDefaultEventParametersForInit(eventParametersForInit);
+    _setDefaultEventParametersForInit(additionalParams);
+    expect(defaultEventParametersForInit).to.deep.equal({
+      ...additionalParams
+    });
+  });
+  it('_setConsentDefaultForInit() stores individual params correctly', async () => {
+    const consentParametersForInit: ConsentSettings = {
+      'analytics_storage': 'granted',
+      'functionality_storage': 'denied'
+    };
+    _setConsentDefaultForInit(consentParametersForInit);
+    expect(defaultConsentSettingsForInit).to.deep.equal(
+      consentParametersForInit
+    );
+  });
+  it('_setConsentDefaultForInit() replaces previous params with new params', async () => {
+    const consentParametersForInit: ConsentSettings = {
+      'analytics_storage': 'granted',
+      'functionality_storage': 'denied'
+    };
+    const additionalParams = { 'wait_for_update': 500 };
+    _setConsentDefaultForInit(consentParametersForInit);
+    _setConsentDefaultForInit(additionalParams);
+    expect(defaultConsentSettingsForInit).to.deep.equal({
+      ...additionalParams
+    });
+  });
 });