Merge branch 'master' of github.com:firebase/firebase-js-sdk into markduckworth/or-queries

Author: MarkDuckworth

.changeset/kind-pots-admire.md

@@ -0,0 +1,6 @@
+---
+"@firebase/database": patch
+---
+
+Fix issue with how get results for filtered queries are added to cache.
+Fix issue with events not getting propagated to listeners by get.

.changeset/smart-crabs-warn.md

@@ -1,6 +1,9 @@
 name: Check Changeset
 
-on: pull_request
+on:
+  pull_request:
+    branches-ignore:
+      - release
 
 env:
   GITHUB_PULL_REQUEST_HEAD_SHA: ${{ github.event.pull_request.head.sha }}

.github/workflows/check-changeset.yml

@@ -3,31 +3,61 @@ name: Test Modified Packages
 on: pull_request
 
 jobs:
-  test:
-    name: Test Packages With Changed Files
+  test-chrome:
+    name: Test Packages With Changed Files in Chrome and Node
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout Repo
-      uses: actions/checkout@master
-      with:
-        # This makes Actions fetch all Git history so run-changed script can diff properly.
-        fetch-depth: 0
-    - name: Set up Node (14)
-      uses: actions/setup-node@v2
-      with:
-        node-version: 14.x
-    - name: install Chrome stable
-      run: |
-        sudo apt-get update
-        sudo apt-get install google-chrome-stable
-    - name: Bump Node memory limit
-      run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV
-    - name: Test setup and yarn install
-      run: |
-        cp config/ci.config.json config/project.json
-        yarn
-    - name: build
-      run: yarn build:changed core
-    - name: Run tests on changed packages
-      run: xvfb-run yarn test:changed core
+      - name: Checkout Repo
+        uses: actions/checkout@master
+        with:
+          # This makes Actions fetch all Git history so run-changed script can diff properly.
+          fetch-depth: 0
+      - name: Set up Node (14)
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+      - name: install Chrome stable
+        run: |
+          sudo apt-get update
+          sudo apt-get install google-chrome-stable
+      - name: Bump Node memory limit
+        run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV
+      - name: Test setup and yarn install
+        run: |
+          cp config/ci.config.json config/project.json
+          yarn
+      - name: build
+        run: yarn build:changed core
+      - name: Run tests on changed packages
+        run: xvfb-run yarn test:changed core
+
+  test-firefox:
+    name: Test Packages With Changed Files in Firefox
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+      - name: Set up Node (14)
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14.x
+      - name: install Firefox stable
+        run: |
+          sudo apt-get update
+          sudo apt-get install firefox
+      - name: Bump Node memory limit
+        run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV
+      - name: Test setup and yarn install
+        run: |
+          cp config/ci.config.json config/project.json
+          yarn
+      - name: build
+        run: yarn build:changed core
+      - name: Run tests on changed packages
+        run: xvfb-run yarn test:changed core
+        env:
+          BROWSERS: 'Firefox'

.github/workflows/test-changed.yml

@@ -93,4 +93,5 @@ tsdoc-metadata.json
 
 # generated html docs
 docs-*/
-docs/
+docs/
+toc/

.gitignore

@@ -60,7 +60,7 @@ const config = {
   // start these browsers
   // available browser launchers:
   // https://npmjs.org/browse/keyword/karma-launcher
-  browsers: ['ChromeHeadless'],
+  browsers: process.env?.BROWSERS?.split(',') ?? ['ChromeHeadless'],
 
   webpack: webpackTestConfig,
 

config/karma.base.js

@@ -8,8 +8,8 @@
     "test:debug": "karma start --browsers Chrome --auto-watch"
   },
   "dependencies": {
-    "@firebase/app": "0.7.29",
-    "@firebase/app-compat": "0.1.30",
+    "@firebase/app": "0.7.30",
+    "@firebase/app-compat": "0.1.31",
     "@firebase/analytics": "0.8.0",
     "@firebase/analytics-compat": "0.1.13",
     "@firebase/auth": "0.20.5",

integration/compat-interop/package.json

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

integration/firebase/package.json

@@ -15,8 +15,8 @@
     "test:memory:debug": "yarn build:memory; karma start --auto-watch --browsers Chrome"
   },
   "dependencies": {
-    "@firebase/app": "0.7.29",
-    "@firebase/firestore": "3.4.13"
+    "@firebase/app": "0.7.30",
+    "@firebase/firestore": "3.4.14"
   },
   "devDependencies": {
     "@types/mocha": "9.1.1",

integration/firestore/package.json

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

integration/messaging/package.json

@@ -24,7 +24,7 @@
     "@firebase/app-compat": "0.x"
   },
   "devDependencies": {
-    "@firebase/app-compat": "0.1.30",
+    "@firebase/app-compat": "0.1.31",
     "rollup": "2.72.1",
     "@rollup/plugin-json": "4.1.0",
     "rollup-plugin-typescript2": "0.31.2",

packages/analytics-compat/package.json

@@ -48,7 +48,7 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app": "0.7.29",
+    "@firebase/app": "0.7.30",
     "rollup": "2.72.1",
     "@rollup/plugin-commonjs": "21.1.0",
     "@rollup/plugin-json": "4.1.0",

packages/analytics/package.json

@@ -44,7 +44,7 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app-compat": "0.1.30",
+    "@firebase/app-compat": "0.1.31",
     "rollup": "2.72.1",
     "@rollup/plugin-commonjs": "21.1.0",
     "@rollup/plugin-json": "4.1.0",

packages/app-check-compat/package.json

@@ -45,7 +45,7 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@firebase/app": "0.7.29",
+    "@firebase/app": "0.7.30",
     "rollup": "2.72.1",
     "@rollup/plugin-commonjs": "21.1.0",
     "@rollup/plugin-json": "4.1.0",

packages/app-check/package.json

@@ -1,5 +1,12 @@
 # @firebase/app-compat
 
+## 0.1.31
+
+### Patch Changes
+
+- Updated dependencies [[`82a6add13`](https://github.com/firebase/firebase-js-sdk/commit/82a6add1354fe7e4ac1d444157ac027cdd41da6e)]:
+  - @firebase/app@0.7.30
+
 ## 0.1.30
 
 ### Patch Changes

packages/app-compat/CHANGELOG.md

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/app-compat",
-  "version": "0.1.30",
+  "version": "0.1.31",
   "description": "The primary entrypoint to the Firebase JS SDK",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",
@@ -40,7 +40,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@firebase/app": "0.7.29",
+    "@firebase/app": "0.7.30",
     "@firebase/util": "1.6.3",
     "@firebase/logger": "0.3.3",
     "@firebase/component": "0.5.17",

packages/app-compat/package.json

@@ -1,5 +1,11 @@
 # @firebase/app
 
+## 0.7.30
+
+### Patch Changes
+
+- [`82a6add13`](https://github.com/firebase/firebase-js-sdk/commit/82a6add1354fe7e4ac1d444157ac027cdd41da6e) [#6480](https://github.com/firebase/firebase-js-sdk/pull/6480) - Prevent core app from throwing if IndexedDB heartbeat functions throw.
+
 ## 0.7.29
 
 ### Patch Changes

packages/app/CHANGELOG.md

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/app",
-  "version": "0.7.29",
+  "version": "0.7.30",
   "description": "The primary entrypoint to the Firebase JS SDK",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",

packages/app/package.json

@@ -24,10 +24,10 @@ export const enum AppError {
   APP_DELETED = 'app-deleted',
   INVALID_APP_ARGUMENT = 'invalid-app-argument',
   INVALID_LOG_ARGUMENT = 'invalid-log-argument',
-  STORAGE_OPEN = 'storage-open',
-  STORAGE_GET = 'storage-get',
-  STORAGE_WRITE = 'storage-set',
-  STORAGE_DELETE = 'storage-delete'
+  IDB_OPEN = 'idb-open',
+  IDB_GET = 'idb-get',
+  IDB_WRITE = 'idb-set',
+  IDB_DELETE = 'idb-delete'
 }
 
 const ERRORS: ErrorMap<AppError> = {
@@ -43,14 +43,14 @@ const ERRORS: ErrorMap<AppError> = {
     'Firebase App instance.',
   [AppError.INVALID_LOG_ARGUMENT]:
     'First argument to `onLog` must be null or a function.',
-  [AppError.STORAGE_OPEN]:
-    'Error thrown when opening storage. Original error: {$originalErrorMessage}.',
-  [AppError.STORAGE_GET]:
-    'Error thrown when reading from storage. Original error: {$originalErrorMessage}.',
-  [AppError.STORAGE_WRITE]:
-    'Error thrown when writing to storage. Original error: {$originalErrorMessage}.',
-  [AppError.STORAGE_DELETE]:
-    'Error thrown when deleting from storage. Original error: {$originalErrorMessage}.'
+  [AppError.IDB_OPEN]:
+    'Error thrown when opening IndexedDB. Original error: {$originalErrorMessage}.',
+  [AppError.IDB_GET]:
+    'Error thrown when reading from IndexedDB. Original error: {$originalErrorMessage}.',
+  [AppError.IDB_WRITE]:
+    'Error thrown when writing to IndexedDB. Original error: {$originalErrorMessage}.',
+  [AppError.IDB_DELETE]:
+    'Error thrown when deleting from IndexedDB. Original error: {$originalErrorMessage}.'
 };
 
 interface ErrorParams {
@@ -59,10 +59,10 @@ interface ErrorParams {
   [AppError.DUPLICATE_APP]: { appName: string };
   [AppError.APP_DELETED]: { appName: string };
   [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 };
+  [AppError.IDB_OPEN]: { originalErrorMessage?: string };
+  [AppError.IDB_GET]: { originalErrorMessage?: string };
+  [AppError.IDB_WRITE]: { originalErrorMessage?: string };
+  [AppError.IDB_DELETE]: { originalErrorMessage?: string };
 }
 
 export const ERROR_FACTORY = new ErrorFactory<AppError, ErrorParams>(

packages/app/src/errors.ts

@@ -0,0 +1,77 @@
+/**
+ * @license
+ * Copyright 2022 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 { expect } from 'chai';
+import '../test/setup';
+import { match, stub } from 'sinon';
+import {
+  readHeartbeatsFromIndexedDB,
+  writeHeartbeatsToIndexedDB
+} from './indexeddb';
+import { FirebaseApp } from './public-types';
+import { AppError } from './errors';
+import { HeartbeatsInIndexedDB } from './types';
+
+/**
+ * Mostly testing failure cases. heartbeatService.test.ts tests read-write
+ * more extensively.
+ */
+
+describe('IndexedDB functions', () => {
+  it('readHeartbeatsFromIndexedDB warns if IndexedDB.open() throws', async () => {
+    const warnStub = stub(console, 'warn');
+    if (typeof window !== 'undefined') {
+      // Ensure that indexedDB.open() fails in browser. It will always fail in Node.
+      stub(window.indexedDB, 'open').throws(new Error('abcd'));
+      await readHeartbeatsFromIndexedDB({
+        name: 'testname',
+        options: { appId: 'test-app-id' }
+      } as FirebaseApp);
+      expect(warnStub).to.be.calledWith(match.any, match(AppError.IDB_GET));
+    } else {
+      await readHeartbeatsFromIndexedDB({
+        name: 'testname',
+        options: { appId: 'test-app-id' }
+      } as FirebaseApp);
+      expect(warnStub).to.be.calledWith(match.any, match(AppError.IDB_GET));
+    }
+  });
+  it('writeHeartbeatsToIndexedDB warns if IndexedDB.open() throws', async () => {
+    const warnStub = stub(console, 'warn');
+    if (typeof window !== 'undefined') {
+      // Ensure that indexedDB.open() fails in browser. It will always fail in Node.
+      stub(window.indexedDB, 'open').throws(new Error('abcd'));
+      await writeHeartbeatsToIndexedDB(
+        {
+          name: 'testname',
+          options: { appId: 'test-app-id' }
+        } as FirebaseApp,
+        {} as HeartbeatsInIndexedDB
+      );
+      expect(warnStub).to.be.calledWith(match.any, match(AppError.IDB_WRITE));
+    } else {
+      await writeHeartbeatsToIndexedDB(
+        {
+          name: 'testname',
+          options: { appId: 'test-app-id' }
+        } as FirebaseApp,
+        {} as HeartbeatsInIndexedDB
+      );
+      expect(warnStub).to.be.calledWith(match.any, match(AppError.IDB_WRITE));
+    }
+  });
+});