Merge main into release

google-oss-bot · web-flow · commit 1f63aa4362de · 2024-10-08T07:01:33.000-07:00
diff --git a/.changeset/four-pillows-fetch.md b/.changeset/four-pillows-fetch.md
@@ -0,0 +1,5 @@
+---
+'@firebase/messaging': patch
+---
+
+The logging endpoint has been updated to ensure proper logging of WebPush entries. This resolves an issue where BigQuery logs were missing WebPush data. The payload structure has also been updated in alignment with the latest logging requirements as specified in go/firelog.
diff --git a/.github/ISSUE_TEMPLATE/bug_report_v2.yaml b/.github/ISSUE_TEMPLATE/bug_report_v2.yaml
@@ -63,6 +63,7 @@ body:
         - Auth
         - Component
         - Database
+        - DataConnect
         - Firestore
         - Functions
         - Installations
diff --git a/.github/workflows/test-changed-auth.yml b/.github/workflows/test-changed-auth.yml
@@ -102,3 +102,28 @@ jobs:
         run: xvfb-run yarn test:changed auth
         env:
           BROWSERS: 'Firefox'
+
+  test-webkit:
+    name: Test Auth on Webkit if Changed
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Node (20)
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+      - name: Test setup and yarn install
+        run: |
+          cp config/ci.config.json config/project.json
+          yarn
+          npx playwright install webkit
+      - name: build
+        run: yarn build:changed auth
+      - name: Run tests on changed packages
+        run: yarn test:changed auth
+        env:
+          BROWSERS: 'WebkitHeadless'
diff --git a/.github/workflows/test-changed-firestore.yml b/.github/workflows/test-changed-firestore.yml
@@ -231,6 +231,62 @@ jobs:
           BROWSERS: 'Firefox'
           EXPERIMENTAL_MODE: true
 
+  compat-test-webkit:
+    name: Test Firestore Compatible on Webkit
+    runs-on: macos-latest
+    needs: build
+    if: ${{ needs.build.outputs.changed == 'true'}}
+    steps:
+      - name: Set up Node (20)
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+      - name: Download build archive
+        uses: actions/download-artifact@v3
+        with:
+          name: build.tar.gz
+      - name: Unzip build artifact
+        run: tar xf build.tar.gz
+      - name: Test setup
+        run: |
+          cp config/ci.config.json config/project.json
+          npx playwright install webkit
+      - name: Run compat tests
+        run: cd packages/firestore-compat && yarn run test:ci
+        env:
+          BROWSERS: 'WebkitHeadless'
+
+  test-webkit:
+    name: Test Firestore on Webkit
+    strategy:
+      matrix:
+        # TODO (dlarocque): Add test:travis once the browser tests are isolated
+        # Exclude test:travis for now, since it includes node tests, which are failing for
+        # some reason.
+        test-name: ["test:browser", "test:lite:browser", "test:browser:prod:nameddb", "test:lite:browser:nameddb"]
+    runs-on: macos-latest
+    needs: build
+    if: ${{ needs.build.outputs.changed == 'true'}}
+    steps:
+      - name: Download build archive
+        uses: actions/download-artifact@v3
+        with:
+          name: build.tar.gz
+      - name: Unzip build artifact
+        run: tar xf build.tar.gz
+      - name: Set up Node (20)
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+      - name: Test setup
+        run: |
+          cp config/ci.config.json config/project.json
+          npx playwright install webkit
+      - name: Run tests
+        run: cd packages/firestore && yarn run ${{ matrix.test-name }}
+        env:
+          BROWSERS: 'WebkitHeadless'
+          EXPERIMENTAL_MODE: true
   # A job that fails if any required job in the test matrix fails,
   # to be used as a required check for merging.
   check-required-tests:
@@ -241,4 +297,4 @@ jobs:
     steps:
       - name: Check test matrix
         if: needs.build.result == 'failure' || needs.test-chrome.result == 'failure' || needs.compat-test-chrome.result == 'failure'
-        run: exit 1
+        run: exit 1
diff --git a/.github/workflows/test-changed.yml b/.github/workflows/test-changed.yml
@@ -78,3 +78,29 @@ jobs:
         run: xvfb-run yarn test:changed core
         env:
           BROWSERS: 'Firefox'
+          
+          
+  test-webkit:
+    name: Test Packages With Changed Files in Webkit
+    runs-on: macos-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Node (20)
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+      - name: Test setup and yarn install
+        run: |
+          cp config/ci.config.json config/project.json
+          yarn
+          npx playwright install webkit
+      - name: build
+        run: yarn build:changed core
+      - name: Run tests on changed packages
+        run: yarn test:changed core
+        env:
+          BROWSERS: 'WebkitHeadless'
diff --git a/config/karma.base.js b/config/karma.base.js
@@ -20,6 +20,33 @@ const path = require('path');
 const webpackTestConfig = require('./webpack.test');
 const { argv } = require('yargs');
 
+function determineBrowsers() {
+  const supportedBrowsers = ['ChromeHeadless', 'WebkitHeadless', 'Firefox'];
+
+  if (process.env.BROWSERS) {
+    const browsers = process.env.BROWSERS.split(',');
+
+    const validBrowsers = browsers.filter(browser =>
+      supportedBrowsers.includes(browser)
+    );
+    if (validBrowsers.length === 0) {
+      console.error(
+        `The \'BROWSER\' environment variable was set, but no supported browsers were listed. The supported browsers are ${JSON.stringify(
+          supportedBrowsers
+        )}.`
+      );
+      return [];
+    } else {
+      return validBrowsers;
+    }
+  } else {
+    console.log(
+      "The 'BROWSER' environment variable is undefined. Defaulting to 'ChromeHeadless'."
+    );
+    return ['ChromeHeadless'];
+  }
+}
+
 const config = {
   // disable watcher
   autoWatch: false,
@@ -57,10 +84,11 @@ const config = {
   // changes
   autoWatch: false,
 
-  // start these browsers
-  // available browser launchers:
-  // https://npmjs.org/browse/keyword/karma-launcher
-  browsers: process.env?.BROWSERS?.split(',') ?? ['ChromeHeadless'],
+  // Browsers to launch for testing
+  // To use a custom set of browsers, define the BROWSERS environment variable as a comma-seperated list.
+  // Supported browsers are 'ChromeHeadless', 'WebkitHeadless', and 'Firefox'.
+  // See: https://karma-runner.github.io/6.4/config/browsers.html
+  browsers: determineBrowsers(),
 
   webpack: webpackTestConfig,
 
diff --git a/package.json b/package.json
@@ -120,10 +120,10 @@
     "karma-firefox-launcher": "2.1.3",
     "karma-mocha": "2.0.1",
     "karma-mocha-reporter": "2.2.5",
-    "karma-safari-launcher": "1.0.0",
     "karma-sourcemap-loader": "0.4.0",
     "karma-spec-reporter": "0.0.36",
     "karma-summary-reporter": "3.1.1",
+    "karma-webkit-launcher": "2.6.0",
     "karma-webpack": "5.0.0",
     "lcov-result-merger": "3.3.0",
     "lerna": "4.0.0",
@@ -139,6 +139,7 @@
     "nyc": "15.1.0",
     "ora": "5.4.1",
     "patch-package": "7.0.2",
+    "playwright": "1.46.1",
     "postinstall-postinstall": "2.1.0",
     "prettier": "2.8.7",
     "protractor": "5.4.2",
diff --git a/packages/analytics/testing/get-fake-firebase-services.ts b/packages/analytics/testing/get-fake-firebase-services.ts
@@ -15,7 +15,12 @@
  * limitations under the License.
  */
 
-import { FirebaseApp, initializeApp, _registerComponent } from '@firebase/app';
+import {
+  FirebaseApp,
+  initializeApp,
+  _registerComponent,
+  _addOrOverwriteComponent
+} from '@firebase/app';
 import { Component, ComponentType } from '@firebase/component';
 import { _FirebaseInstallationsInternal } from '@firebase/installations';
 import { AnalyticsService } from '../src/factory';
@@ -78,5 +83,18 @@ export function getFullApp(fakeAppParams?: {
     )
   );
   const app = initializeApp({ ...fakeConfig, ...fakeAppParams });
+  _addOrOverwriteComponent(
+    app,
+    //@ts-ignore
+    new Component(
+      'heartbeat',
+      () => {
+        return {
+          triggerHeartbeat: () => {}
+        } as any;
+      },
+      ComponentType.PUBLIC
+    )
+  );
   return app;
 }
diff --git a/packages/messaging/src/helpers/logToFirelog.test.ts b/packages/messaging/src/helpers/logToFirelog.test.ts
@@ -31,10 +31,7 @@ import { MessagingService } from '../messaging-service';
 import { Stub } from '../testing/sinon-types';
 import { getFakeMessagingService } from '../testing/fakes/messaging-service';
 
-const FIRELOG_ENDPOINT = LogModule._mergeStrings(
-  'hts/frbslgigp.ogepscmv/ieo/eaylg',
-  'tp:/ieaeogn-agolai.o/1frlglgc/o'
-);
+const LOG_ENDPOINT = 'https://play.google.com/log?format=json_proto3';
 
 const FCM_TRANSPORT_KEY = LogModule._mergeStrings(
   'AzSCbw63g1R0nCw85jG8',
@@ -68,7 +65,7 @@ describe('logToFirelog', () => {
 
       // assert
       expect(fetchStub).to.be.calledOnceWith(
-        FIRELOG_ENDPOINT.concat('?key=', FCM_TRANSPORT_KEY),
+        LOG_ENDPOINT.concat('&key=', FCM_TRANSPORT_KEY),
         {
           method: 'POST',
           body: JSON.stringify(LogModule._createLogRequest([getFakeLogEvent()]))
diff --git a/packages/messaging/src/helpers/logToFirelog.ts b/packages/messaging/src/helpers/logToFirelog.ts
@@ -36,10 +36,7 @@ import {
 import { MessagePayloadInternal } from '../interfaces/internal-message-payload';
 import { MessagingService } from '../messaging-service';
 
-const FIRELOG_ENDPOINT = _mergeStrings(
-  'hts/frbslgigp.ogepscmv/ieo/eaylg',
-  'tp:/ieaeogn-agolai.o/1frlglgc/o'
-);
+const LOG_ENDPOINT = 'https://play.google.com/log?format=json_proto3';
 
 const FCM_TRANSPORT_KEY = _mergeStrings(
   'AzSCbw63g1R0nCw85jG8',
@@ -97,7 +94,7 @@ export async function _dispatchLogEvents(
     do {
       try {
         response = await fetch(
-          FIRELOG_ENDPOINT.concat('?key=', FCM_TRANSPORT_KEY),
+          LOG_ENDPOINT.concat('&key=', FCM_TRANSPORT_KEY),
           {
             method: 'POST',
             body: JSON.stringify(logRequest)
@@ -216,7 +213,9 @@ function createAndEnqueueLogEvent(
 
   /* eslint-disable camelcase */
   logEvent.event_time_ms = Math.floor(Date.now()).toString();
-  logEvent.source_extension_json_proto3 = JSON.stringify(fcmEvent);
+  logEvent.source_extension_json_proto3 = JSON.stringify({
+    messaging_client_event: fcmEvent
+  });
 
   if (!!productId) {
     logEvent.compliance_data = buildComplianceData(productId);
diff --git a/repo-scripts/prune-dts/tests/resolves-generics-through-inheritance.output.d.ts b/repo-scripts/prune-dts/tests/resolves-generics-through-inheritance.output.d.ts
diff --git a/scripts/ci-test/testConfig.ts b/scripts/ci-test/testConfig.ts
@@ -28,11 +28,25 @@ export interface TestConfig {
   alwaysIncludePackages?: string[];
 }
 
+// These tests are flaky on WebkitHeadless for some reason, so skip them.
+// TODO (dlarocque): Fix the flakes and remove this
+const ignoredWebkitCoreTests = process.env?.BROWSERS?.includes('WebkitHeadless')
+  ? [
+      '@firebase/app-check',
+      '@firebase/installations',
+      '@firebase/storage',
+      '@firebase/storage-compat',
+      '@firebase/database',
+      '@firebase/database-compat'
+    ]
+  : [];
+
 export const testConfig: {
   [key: string]: TestConfig | undefined;
 } = {
   'core': {
     'ignorePackages': [
+      ...ignoredWebkitCoreTests,
       '@firebase/firestore',
       '@firebase/firestore-compat',
       'firebase-firestore-integration-test',
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@firebase/messaging': patch
 +---
++
 +The logging endpoint has been updated to ensure proper logging of WebPush entries. This resolves an issue where BigQuery logs were missing WebPush data. The payload structure has also been updated in alignment with the latest logging requirements as specified in go/firelog.