Merge

Author: schmidt-sebastian

.github/workflows/test-all.yml

@@ -25,6 +25,8 @@ jobs:
       run: yarn build
     - name: Run unit tests
       run: xvfb-run yarn test:ci
+      env:
+        FCM_TEST_PROJECT_SERVER_KEY: $${{secrets.FCM_TEST_PROJECT_SERVER_KEY}}
     - name: Generate coverage file
       run: yarn ci:coverage
     - name: Run coverage

.github/workflows/test-changed.yml

@@ -28,3 +28,5 @@ jobs:
       run: yarn build
     - name: Run tests on changed packages
       run: xvfb-run yarn test:changed
+      env:
+        FCM_TEST_PROJECT_SERVER_KEY: $${{secrets.FCM_TEST_PROJECT_SERVER_KEY}}  

common/api-review/app-types-exp.api.md

@@ -53,6 +53,13 @@ export interface FirebaseOptions {
   storageBucket?: string;
 }
 
+// @internal (undocumented)
+export interface _FirebaseService {
+  // (undocumented)
+  app: FirebaseApp;
+   delete(): Promise<void>;
+}
+
 // @public (undocumented)
 export interface PlatformLoggerService {
   // (undocumented)

config/karma.saucelabs.js

@@ -49,6 +49,14 @@ const packageConfigs = {
   messaging: {
     // Messaging currently only supports these browsers.
     browsers: ['Chrome_Windows', 'Firefox_Windows', 'Edge_Windows']
+  },
+  firestore: {
+    browsers: [
+      'Chrome_Windows',
+      'Firefox_Windows',
+      'Edge_Windows',
+      'Safari_macOS'
+    ]
   }
 };
 
@@ -170,7 +178,8 @@ module.exports = function(config) {
       'packages/polyfill/index.ts': ['webpack', 'sourcemap'],
       '**/test/**/*.ts': ['webpack', 'sourcemap'],
       '**/*.test.ts': ['webpack', 'sourcemap'],
-      'packages/firestore/test/**/bootstrap.ts': ['webpack', 'babel'],
+      // Restore when ready to run Firestore unit tests in IE.
+      // 'packages/firestore/test/**/bootstrap.ts': ['webpack', 'babel'],
       'integration/**/namespace.*': ['webpack', 'babel', 'sourcemap']
     },
 

integration/browserify/package.json

@@ -8,7 +8,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "@babel/core": "7.9.6",

integration/firebase-typings/package.json

@@ -7,7 +7,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "typescript": "3.8.3"

integration/messaging/package.json

@@ -8,7 +8,7 @@
     "test:manual": "mocha --exit"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "chai": "4.2.0",

integration/typescript/package.json

@@ -7,7 +7,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "@babel/core": "7.9.6",

integration/webpack/package.json

@@ -8,7 +8,7 @@
     "test:ci": "node ../../scripts/run_tests_in_ci.js"
   },
   "dependencies": {
-    "firebase": "7.14.5"
+    "firebase": "7.14.6"
   },
   "devDependencies": {
     "@babel/core": "7.9.6",

package.json

@@ -40,7 +40,6 @@
     "test:changed": "node scripts/run_changed.js",
     "test:setup": "node tools/config.js",
     "test:saucelabs": "node scripts/run_saucelabs.js",
-    "test:saucelabs:single": "karma start config/karma.saucelabs.js --single-run",
     "docgen:js": "node scripts/docgen/generate-docs.js --api js",
     "docgen:node": "node scripts/docgen/generate-docs.js --api node",
     "docgen": "yarn docgen:js; yarn docgen:node",

packages-exp/app-types-exp/index.d.ts

@@ -104,6 +104,18 @@ export interface PlatformLoggerService {
   getPlatformInfoString(): string;
 }
 
+/**
+ * @internal
+ */
+export interface _FirebaseService {
+  app: FirebaseApp;
+  /**
+   * Delete the service and free it's resources - called from
+   * {@link @firebase/app-exp#deleteApp | deleteApp()}
+   */
+  delete(): Promise<void>;
+}
+
 declare module '@firebase/component' {
   interface NameServiceMapping {
     'app-exp': FirebaseApp;

packages/firebase/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase",
-  "version": "7.14.5",
+  "version": "7.14.6",
   "description": "Firebase JavaScript library for web and Node.js",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "license": "Apache-2.0",
@@ -49,13 +49,13 @@
     "@firebase/app-types": "0.6.1",
     "@firebase/auth": "0.14.6",
     "@firebase/database": "0.6.3",
-    "@firebase/firestore": "1.14.5",
+    "@firebase/firestore": "1.14.6",
     "@firebase/functions": "0.4.44",
     "@firebase/installations": "0.4.10",
     "@firebase/messaging": "0.6.16",
     "@firebase/polyfill": "0.3.36",
     "@firebase/storage": "0.3.34",
-    "@firebase/performance": "0.3.4",
+    "@firebase/performance": "0.3.5",
     "@firebase/remote-config": "0.1.21",
     "@firebase/analytics": "0.3.5",
     "@firebase/util": "0.2.47"

packages/firestore-types/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/firestore-types",
-  "version": "1.10.2",
+  "version": "1.10.3",
   "description": "@firebase/firestore Types",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "license": "Apache-2.0",

packages/firestore/.eslintrc.js

@@ -1,3 +1,20 @@
+/**
+ * @license
+ * Copyright 2020 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.
+ */
+
 module.exports = {
   extends: '../../config/.eslintrc.js',
   parserOptions: {
@@ -35,6 +52,13 @@ module.exports = {
       rules: {
         '@typescript-eslint/no-explicit-any': 'error'
       }
+    },
+    // TODO(firestorelite): Remove this exception when app-exp is published
+    {
+      files: ['lite/**/*.ts'],
+      rules: {
+        'import/no-extraneous-dependencies': 'off'
+      }
     }
   ]
 };

packages/firestore/exp/index.d.ts

@@ -327,7 +327,7 @@ export function getQueryFromServer<T>(
 export function addDoc<T>(
   reference: CollectionReference<T>,
   data: T
-): Promise<DocumentSnapshot<T>>;
+): Promise<DocumentReference<T>>;
 export function setDoc<T>(
   reference: DocumentReference<T>,
   data: T

packages/firestore/karma.conf.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-const karma = require('karma');
-const path = require('path');
 const karmaBase = require('../../config/karma.base');
 const { argv } = require('yargs');
 

packages/firestore/lite/index.d.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { FirebaseApp } from '@firebase/app-types';
+import { FirebaseApp } from '@firebase/app-types-exp';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 

packages/firestore/lite/index.node.ts

@@ -0,0 +1,46 @@
+/**
+ * @license
+ * Copyright 2020 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 { registerVersion, _registerComponent } from '@firebase/app-exp';
+import { Firestore } from './src/api/database';
+import { version } from '../package.json';
+import { Component, ComponentType } from '@firebase/component';
+
+export {
+  Firestore,
+  initializeFirestore,
+  getFirestore
+} from './src/api/database';
+
+export function registerFirestore(): void {
+  _registerComponent(
+    new Component(
+      'firestore/lite',
+      container => {
+        const app = container.getProvider('app-exp').getImmediate()!;
+        return ((app, auth) => new Firestore(app, auth))(
+          app,
+          container.getProvider('auth-internal')
+        );
+      },
+      ComponentType.PUBLIC
+    )
+  );
+  registerVersion('firestore-lite', version, 'node');
+}
+
+registerFirestore();

packages/firestore/lite/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@firebase/firestore/lite",
+  "description": "A lite version of the Firestore SDK",
+  "main": "../dist/lite/index.node.cjs.js",
+  "private": true
+}

packages/firestore/lite/src/api/database.ts

@@ -0,0 +1,100 @@
+/**
+ * @license
+ * Copyright 2020 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 * as firestore from '../../';
+
+import { _getProvider } from '@firebase/app-exp';
+import { FirebaseApp } from '@firebase/app-types-exp';
+import { Provider } from '@firebase/component';
+
+import { Code, FirestoreError } from '../../../src/util/error';
+import { DatabaseId } from '../../../src/core/database_info';
+import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import {
+  CredentialsProvider,
+  FirebaseCredentialsProvider
+} from '../../../src/api/credentials';
+
+// TODO(firestorelite): Depend on FirebaseService once #3112 is merged
+
+/**
+ * The root reference to the Firestore Lite database.
+ */
+export class Firestore implements firestore.FirebaseFirestore {
+  readonly _databaseId: DatabaseId;
+  private readonly _firebaseApp: FirebaseApp;
+  private readonly _credentials: CredentialsProvider;
+  private _settings?: firestore.Settings;
+
+  constructor(
+    app: FirebaseApp,
+    authProvider: Provider<FirebaseAuthInternalName>
+  ) {
+    this._firebaseApp = app;
+    this._databaseId = Firestore.databaseIdFromApp(app);
+    this._credentials = new FirebaseCredentialsProvider(authProvider);
+  }
+
+  get app(): FirebaseApp {
+    return this._firebaseApp;
+  }
+
+  _configureClient(settings: firestore.Settings): void {
+    if (this._settings) {
+      throw new FirestoreError(
+        Code.FAILED_PRECONDITION,
+        'Firestore has already been started and its settings can no longer ' +
+          'be changed. initializeFirestore() cannot be called after calling ' +
+          'getFirestore().'
+      );
+    }
+    this._settings = settings;
+  }
+
+  _ensureClientConfigured(): void {
+    if (!this._settings) {
+      this._settings = {};
+    }
+  }
+
+  private static databaseIdFromApp(app: FirebaseApp): DatabaseId {
+    if (!Object.prototype.hasOwnProperty.apply(app.options, ['projectId'])) {
+      throw new FirestoreError(
+        Code.INVALID_ARGUMENT,
+        '"projectId" not provided in firebase.initializeApp.'
+      );
+    }
+
+    return new DatabaseId(app.options.projectId!);
+  }
+}
+
+export function initializeFirestore(
+  app: FirebaseApp,
+  settings: firestore.Settings
+): Firestore {
+  const firestore = _getProvider(
+    app,
+    'firestore/lite'
+  ).getImmediate() as Firestore;
+  firestore._configureClient(settings);
+  return firestore;
+}
+
+export function getFirestore(app: FirebaseApp): Firestore {
+  return _getProvider(app, 'firestore/lite').getImmediate() as Firestore;
+}