Merge branch 'master' into setConsent

Author: dwyfrequency

.changeset/nervous-starfishes-crash.md

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

.changeset/rotten-tables-brush.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

.changeset/sharp-rules-enjoy.md

@@ -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 }}

.changeset/silly-panthers-mix.md

@@ -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

.changeset/tame-rice-peel.md

@@ -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}}

.changeset/witty-windows-unite.md

@@ -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

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

@@ -413,6 +413,9 @@ 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;
 

.github/workflows/release-pr.yml

@@ -8,20 +8,20 @@
     "test:debug": "karma start --browsers Chrome --auto-watch"
   },
   "dependencies": {
-    "@firebase/app": "0.7.26",
-    "@firebase/app-compat": "0.1.27",
-    "@firebase/analytics": "0.7.10",
-    "@firebase/analytics-compat": "0.1.11",
-    "@firebase/auth": "0.20.3",
-    "@firebase/auth-compat": "0.2.16",
-    "@firebase/functions": "0.8.2",
-    "@firebase/functions-compat": "0.2.2",
-    "@firebase/messaging": "0.9.14",
-    "@firebase/messaging-compat": "0.1.14",
-    "@firebase/performance": "0.5.10",
-    "@firebase/performance-compat": "0.1.10",
-    "@firebase/remote-config": "0.3.9",
-    "@firebase/remote-config-compat": "0.1.10"
+    "@firebase/app": "0.7.27",
+    "@firebase/app-compat": "0.1.28",
+    "@firebase/analytics": "0.7.11",
+    "@firebase/analytics-compat": "0.1.12",
+    "@firebase/auth": "0.20.4",
+    "@firebase/auth-compat": "0.2.17",
+    "@firebase/functions": "0.8.3",
+    "@firebase/functions-compat": "0.2.3",
+    "@firebase/messaging": "0.9.15",
+    "@firebase/messaging-compat": "0.1.15",
+    "@firebase/performance": "0.5.11",
+    "@firebase/performance-compat": "0.1.11",
+    "@firebase/remote-config": "0.3.10",
+    "@firebase/remote-config-compat": "0.1.11"
   },
   "devDependencies": {
     "typescript": "4.2.2"

.github/workflows/release-prod.yml

@@ -7,7 +7,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test"
   },
   "devDependencies": {
-    "firebase": "9.8.3",
+    "firebase": "9.8.4",
     "@types/chai": "4.3.1",
     "@types/mocha": "9.1.1",
     "chai": "4.3.6",

.github/workflows/test-all.yml

@@ -15,8 +15,8 @@
     "test:memory:debug": "yarn build:memory; karma start --auto-watch --browsers Chrome"
   },
   "dependencies": {
-    "@firebase/app": "0.7.26",
-    "@firebase/firestore": "3.4.10"
+    "@firebase/app": "0.7.27",
+    "@firebase/firestore": "3.4.11"
   },
   "devDependencies": {
     "@types/mocha": "9.1.1",

common/api-review/analytics.api.md

@@ -9,7 +9,7 @@
     "test:manual": "mocha --exit"
   },
   "devDependencies": {
-    "firebase": "9.8.3",
+    "firebase": "9.8.4",
     "chai": "4.3.6",
     "chromedriver": "98.0.1",
     "express": "4.18.1",

integration/compat-interop/package.json

@@ -1,5 +1,14 @@
 # @firebase/analytics-compat
 
+## 0.1.12
+
+### Patch Changes
+
+- Updated dependencies [[`835f1d46a`](https://github.com/firebase/firebase-js-sdk/commit/835f1d46a6780535bc660ef7dc23293350d5fe43), [`efe2000fc`](https://github.com/firebase/firebase-js-sdk/commit/efe2000fc499e2c85c4e5e0fef6741ff3bad2eb0)]:
+  - @firebase/analytics@0.7.11
+  - @firebase/util@1.6.2
+  - @firebase/component@0.5.16
+
 ## 0.1.11
 
 ### Patch Changes

integration/firebase/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/analytics-compat",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "description": "",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",
@@ -24,7 +24,7 @@
     "@firebase/app-compat": "0.x"
   },
   "devDependencies": {
-    "@firebase/app-compat": "0.1.27",
+    "@firebase/app-compat": "0.1.28",
     "rollup": "2.72.1",
     "@rollup/plugin-json": "4.1.0",
     "rollup-plugin-typescript2": "0.31.2",
@@ -53,10 +53,10 @@
   },
   "typings": "dist/src/index.d.ts",
   "dependencies": {
-    "@firebase/component": "0.5.15",
-    "@firebase/analytics": "0.7.10",
+    "@firebase/component": "0.5.16",
+    "@firebase/analytics": "0.7.11",
     "@firebase/analytics-types": "0.7.0",
-    "@firebase/util": "1.6.1",
+    "@firebase/util": "1.6.2",
     "tslib": "^2.1.0"
   },
   "nyc": {

integration/firestore/package.json

@@ -1,5 +1,16 @@
 # @firebase/analytics
 
+## 0.7.11
+
+### Patch Changes
+
+- [`835f1d46a`](https://github.com/firebase/firebase-js-sdk/commit/835f1d46a6780535bc660ef7dc23293350d5fe43) [#6357](https://github.com/firebase/firebase-js-sdk/pull/6357) - Fix typo in GtagConfigParams
+
+- Updated dependencies [[`efe2000fc`](https://github.com/firebase/firebase-js-sdk/commit/efe2000fc499e2c85c4e5e0fef6741ff3bad2eb0)]:
+  - @firebase/util@1.6.2
+  - @firebase/component@0.5.16
+  - @firebase/installations@0.5.11
+
 ## 0.7.10
 
 ### Patch Changes

integration/messaging/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/analytics",
-  "version": "0.7.10",
+  "version": "0.7.11",
   "description": "A analytics package for new firebase packages",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",
@@ -40,15 +40,15 @@
     "@firebase/app": "0.x"
   },
   "dependencies": {
-    "@firebase/installations": "0.5.10",
+    "@firebase/installations": "0.5.11",
     "@firebase/logger": "0.3.3",
-    "@firebase/util": "1.6.1",
-    "@firebase/component": "0.5.15",
+    "@firebase/util": "1.6.2",
+    "@firebase/component": "0.5.16",
     "tslib": "^2.1.0"
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app": "0.7.26",
+    "@firebase/app": "0.7.27",
     "rollup": "2.72.1",
     "@rollup/plugin-commonjs": "21.1.0",
     "@rollup/plugin-json": "4.1.0",

packages/analytics-compat/CHANGELOG.md

@@ -19,15 +19,22 @@ 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,
+  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 { defaultEventParametersForInit } from './functions';
 
 describe('FirebaseAnalytics API tests', () => {
   let initStub: SinonStub = stub();
   let app: FirebaseApp;
+  const wrappedGtag: SinonStub = stub();
 
   beforeEach(() => {
     initStub = stub(init, '_initializeAnalytics').resolves(
@@ -94,4 +101,26 @@ 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
+    );
+  });
 });

packages/analytics-compat/package.json

@@ -49,7 +49,8 @@ import {
   setUserId as internalSetUserId,
   setUserProperties as internalSetUserProperties,
   setAnalyticsCollectionEnabled as internalSetAnalyticsCollectionEnabled,
-  _setConsentDefaultForInit
+  _setConsentDefaultForInit,
+  _setDefaultEventParametersForInit
 } from './functions';
 import { ERROR_FACTORY, AnalyticsError } from './errors';
 
@@ -226,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

packages/analytics/CHANGELOG.md

@@ -23,7 +23,9 @@ import {
   logEvent,
   setUserId,
   setUserProperties,
-  setAnalyticsCollectionEnabled
+  setAnalyticsCollectionEnabled,
+  defaultEventParametersForInit,
+  _setDefaultEventParametersForInit
 } from './functions';
 import { GtagCommand } from './constants';
 
@@ -170,4 +172,24 @@ 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
+    });
+  });
 });

packages/analytics/package.json

@@ -24,6 +24,12 @@ import {
 } from './public-types';
 import { Gtag } from './types';
 import { GtagCommand } from './constants';
+
+/**
+ * Event parameters to set on 'gtag' during initialization.
+ */
+export let defaultEventParametersForInit: CustomParams | undefined;
+
 /**
  * Logs an analytics event through the Firebase SDK.
  *
@@ -160,3 +166,15 @@ export function _setConsentDefaultForInit(
 ): void {
   defaultConsentSettingsForInit = consentSettings;
 }
+
+/**
+ * Sets the variable `defaultEventParametersForInit` for use in the initialization of
+ * analytics.
+ *
+ * @param customParams Any custom params the user may pass to gtag.js.
+ */
+export function _setDefaultEventParametersForInit(
+  customParams?: CustomParams
+): void {
+  defaultEventParametersForInit = customParams;
+}