Merge remote-tracking branch 'origin/master' into fz/storage-list

Author: fredzqm

packages/firebase/package.json

@@ -38,14 +38,16 @@
   "react-native": "dist/index.rn.cjs.js",
   "dependencies": {
     "@firebase/app": "0.4.1",
+    "@firebase/app-types": "0.4.0",
     "@firebase/auth": "0.11.2",
     "@firebase/database": "0.4.1",
     "@firebase/firestore": "1.3.1",
     "@firebase/functions": "0.4.7",
     "@firebase/messaging": "0.3.20",
     "@firebase/polyfill": "0.3.14",
     "@firebase/storage": "0.2.16",
-    "@firebase/performance": "0.2.2"
+    "@firebase/performance": "0.2.2",
+    "@firebase/util": "0.2.15"
   },
   "devDependencies": {
     "git-rev-sync": "1.12.0",

packages/firestore/package.json

@@ -31,8 +31,8 @@
     "@firebase/firestore-types": "1.3.0",
     "@firebase/logger": "0.1.14",
     "@firebase/webchannel-wrapper": "0.2.20",
+    "@grpc/grpc-js": "0.4.0",
     "@grpc/proto-loader": "^0.5.0",
-    "grpc": "1.20.3",
     "tslib": "1.9.3"
   },
   "peerDependencies": {

packages/firestore/src/platform/platform.ts

@@ -20,6 +20,7 @@ import { ProtoByteString } from '../core/types';
 import { Connection } from '../remote/connection';
 import { JsonProtoSerializer } from '../remote/serializer';
 import { fail } from '../util/assert';
+import { ConnectivityMonitor } from './../remote/connectivity_monitor';
 
 /**
  * Provides a common interface to load anything platform dependent, e.g.
@@ -31,6 +32,7 @@ import { fail } from '../util/assert';
 // use in our client.
 export interface Platform {
   loadConnection(databaseInfo: DatabaseInfo): Promise<Connection>;
+  newConnectivityMonitor(): ConnectivityMonitor;
   newSerializer(databaseId: DatabaseId): JsonProtoSerializer;
 
   /** Formats an object as a JSON string, suitable for logging. */

packages/firestore/src/platform_browser/browser_connectivity_monitor.ts

@@ -0,0 +1,67 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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 { debug } from '../util/log';
+import {
+  ConnectivityMonitor,
+  ConnectivityMonitorCallback,
+  NetworkStatus
+} from './../remote/connectivity_monitor';
+
+const LOG_TAG = 'ConnectivityMonitor';
+
+/**
+ * Browser implementation of ConnectivityMonitor.
+ */
+export class BrowserConnectivityMonitor implements ConnectivityMonitor {
+  private readonly networkAvailableListener = () => this.onNetworkAvailable();
+  private readonly networkUnavailableListener = () =>
+    this.onNetworkUnavailable();
+  private callbacks: ConnectivityMonitorCallback[] = [];
+
+  constructor() {
+    this.configureNetworkMonitoring();
+  }
+
+  addCallback(callback: (status: NetworkStatus) => void): void {
+    this.callbacks.push(callback);
+  }
+
+  shutdown(): void {
+    window.removeEventListener('online', this.networkAvailableListener);
+    window.removeEventListener('offline', this.networkUnavailableListener);
+  }
+
+  private configureNetworkMonitoring(): void {
+    window.addEventListener('online', this.networkAvailableListener);
+    window.addEventListener('offline', this.networkUnavailableListener);
+  }
+
+  private onNetworkAvailable(): void {
+    debug(LOG_TAG, 'Network connectivity changed: AVAILABLE');
+    for (const callback of this.callbacks) {
+      callback(NetworkStatus.AVAILABLE);
+    }
+  }
+
+  private onNetworkUnavailable(): void {
+    debug(LOG_TAG, 'Network connectivity changed: UNAVAILABLE');
+    for (const callback of this.callbacks) {
+      callback(NetworkStatus.UNAVAILABLE);
+    }
+  }
+}

packages/firestore/src/platform_browser/browser_platform.ts

@@ -19,7 +19,9 @@ import { DatabaseId, DatabaseInfo } from '../core/database_info';
 import { Platform } from '../platform/platform';
 import { Connection } from '../remote/connection';
 import { JsonProtoSerializer } from '../remote/serializer';
+import { ConnectivityMonitor } from './../remote/connectivity_monitor';
 
+import { BrowserConnectivityMonitor } from './browser_connectivity_monitor';
 import { WebChannelConnection } from './webchannel_connection';
 
 export class BrowserPlatform implements Platform {
@@ -43,6 +45,10 @@ export class BrowserPlatform implements Platform {
     return Promise.resolve(new WebChannelConnection(databaseInfo));
   }
 
+  newConnectivityMonitor(): ConnectivityMonitor {
+    return new BrowserConnectivityMonitor();
+  }
+
   newSerializer(databaseId: DatabaseId): JsonProtoSerializer {
     return new JsonProtoSerializer(databaseId, { useProto3Json: true });
   }

packages/firestore/src/platform_node/grpc_connection.ts

@@ -15,12 +15,12 @@
  * limitations under the License.
  */
 
-import * as grpc from 'grpc';
+import * as grpc from '@grpc/grpc-js';
 
 import firebase from '@firebase/app';
 const SDK_VERSION = firebase.SDK_VERSION;
 
-const grpcVersion = require('grpc/package.json').version;
+const grpcVersion = require('@grpc/grpc-js/package.json').version;
 
 import { Token } from '../api/credentials';
 import { DatabaseInfo } from '../core/database_info';

packages/firestore/src/platform_node/load_protos.ts

@@ -15,8 +15,8 @@
  * limitations under the License.
  */
 
+import * as grpc from '@grpc/grpc-js';
 import * as protoLoader from '@grpc/proto-loader';
-import * as grpc from 'grpc';
 import * as path from 'path';
 import * as ProtobufJS from 'protobufjs';
 

packages/firestore/src/platform_node/node_platform.ts

@@ -22,6 +22,8 @@ import { Platform } from '../platform/platform';
 import { Connection } from '../remote/connection';
 import { JsonProtoSerializer } from '../remote/serializer';
 import { Code, FirestoreError } from '../util/error';
+import { ConnectivityMonitor } from './../remote/connectivity_monitor';
+import { NoopConnectivityMonitor } from './../remote/connectivity_monitor_noop';
 
 import { GrpcConnection } from './grpc_connection';
 import { loadProtos } from './load_protos';
@@ -46,6 +48,10 @@ export class NodePlatform implements Platform {
     return Promise.resolve(new GrpcConnection(protos, databaseInfo));
   }
 
+  newConnectivityMonitor(): ConnectivityMonitor {
+    return new NoopConnectivityMonitor();
+  }
+
   newSerializer(partitionId: DatabaseId): JsonProtoSerializer {
     return new JsonProtoSerializer(partitionId, { useProto3Json: false });
   }

packages/firestore/src/remote/connectivity_monitor.ts

@@ -0,0 +1,51 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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.
+ */
+
+/**
+ * The set of network states is deliberately simplified -- we only care about
+ * states such that transition between them should break currently
+ * established connections.
+ */
+export const enum NetworkStatus {
+  AVAILABLE,
+  UNAVAILABLE
+}
+
+export type ConnectivityMonitorCallback = (status: NetworkStatus) => void;
+
+/**
+ * A base class for monitoring changes in network connectivity; it is expected
+ * that each platform will have its own system-dependent implementation.
+ */
+export interface ConnectivityMonitor {
+  /**
+   * Adds a callback to be called when connectivity changes.
+   *
+   * Callbacks are not made on the initial state of connectivity, since this
+   * monitor is primarily used for resetting backoff in the remote store when
+   * connectivity changes. As such, the initial connectivity state is
+   * irrelevant here.
+   */
+  addCallback(callback: ConnectivityMonitorCallback): void;
+
+  /**
+   * Stops monitoring connectivity. After this call completes, no further
+   * callbacks will be triggered. After shutdown() is called, no further calls
+   * are allowed on this instance.
+   */
+  shutdown(): void;
+}

packages/firestore/src/remote/connectivity_monitor_noop.ts

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright 2019 Google Inc.
+ *
+ * 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 { ConnectivityMonitor, NetworkStatus } from './connectivity_monitor';
+
+export class NoopConnectivityMonitor implements ConnectivityMonitor {
+  addCallback(callback: (status: NetworkStatus) => void): void {
+    // No-op.
+  }
+
+  shutdown(): void {
+    // No-op.
+  }
+}

packages/firestore/test/util/test_platform.ts

@@ -21,6 +21,8 @@ import { Platform } from '../../src/platform/platform';
 import { Connection } from '../../src/remote/connection';
 import { JsonProtoSerializer } from '../../src/remote/serializer';
 import { assert, fail } from '../../src/util/assert';
+import { ConnectivityMonitor } from './../../src/remote/connectivity_monitor';
+import { NoopConnectivityMonitor } from './../../src/remote/connectivity_monitor_noop';
 
 /**
  * `Window` fake that implements the event and storage API that is used by
@@ -245,6 +247,10 @@ export class TestPlatform implements Platform {
     return this.basePlatform.loadConnection(databaseInfo);
   }
 
+  newConnectivityMonitor(): ConnectivityMonitor {
+    return new NoopConnectivityMonitor();
+  }
+
   newSerializer(databaseId: DatabaseId): JsonProtoSerializer {
     return this.basePlatform.newSerializer(databaseId);
   }

packages/testing/src/api/index.ts

@@ -20,19 +20,21 @@ import * as request from 'request';
 import { base64 } from '@firebase/util';
 import { setLogLevel, LogLevel } from '@firebase/logger';
 import * as grpc from 'grpc';
+import * as protoLoader from '@grpc/proto-loader';
 import { resolve } from 'path';
-import * as fs from 'fs';
 
 export { database, firestore } from 'firebase';
 
-const PROTO_ROOT = {
-  root: resolve(
-    __dirname,
-    process.env.FIRESTORE_EMULATOR_PROTO_ROOT || '../protos'
-  ),
-  file: 'google/firestore/emulator/v1/firestore_emulator.proto'
-};
-const PROTOS = grpc.load(PROTO_ROOT, /* format = */ 'proto');
+const PROTO_ROOT = resolve(
+  __dirname,
+  process.env.FIRESTORE_EMULATOR_PROTO_ROOT || '../protos'
+);
+const PROTO_FILE = resolve(
+  PROTO_ROOT,
+  'google/firestore/emulator/v1/firestore_emulator.proto'
+);
+const PKG_DEF = protoLoader.loadSync(PROTO_FILE, { includeDirs: [PROTO_ROOT] });
+const PROTOS = grpc.loadPackageDefinition(PKG_DEF);
 const EMULATOR = PROTOS['google']['firestore']['emulator']['v1'];
 
 /** If this environment variable is set, use it for the database emulator's address. */
@@ -202,13 +204,7 @@ export function loadFirestoreRules(
 
   let client = new EMULATOR.FirestoreEmulator(
     FIRESTORE_ADDRESS,
-    grpc.credentials.createInsecure(),
-    {
-      // Cap how much backoff gRPC will perform. This is testing code, so
-      // efficiency is less important than responsiveness.
-      'grpc.initial_reconnect_backoff_ms': 100,
-      'grpc.max_reconnect_backoff_ms': 100
-    }
+    grpc.credentials.createInsecure()
   );
   return new Promise((resolve, reject) => {
     client.setSecurityRules(

yarn.lock

@@ -893,6 +893,13 @@
     through2 "^2.0.0"
     xdg-basedir "^3.0.0"
 
+"@grpc/[email protected]":
+  version "0.4.0"
+  resolved "https://registry.npmjs.org/@grpc/grpc-js/-/grpc-js-0.4.0.tgz#b20a6abf1346ce7fd696a042f83d10c94e143881"
+  integrity sha512-UbGDPnstJamJrSiHzCSwSavIX260IfLOZLRJYDqRKJA/jmVZa3hPMWDjhFrcCKDq2MLc/O/nauFED3r4khcZrA==
+  dependencies:
+    semver "^6.0.0"
+
 "@grpc/proto-loader@^0.5.0":
   version "0.5.0"
   resolved "https://registry.npmjs.org/@grpc/proto-loader/-/proto-loader-0.5.0.tgz#6d21930530db6089ed68a90f10a22b76fdc3387d"
@@ -6901,17 +6908,6 @@ [email protected]:
     node-pre-gyp "^0.13.0"
     protobufjs "^5.0.3"
 
-[email protected]:
-  version "1.20.3"
-  resolved "https://registry.npmjs.org/grpc/-/grpc-1.20.3.tgz#a74d36718f1e89c4a64f2fb9441199c3c8f78978"
-  integrity sha512-GsEsi0NVj6usS/xor8pF/xDbDiwZQR59aZl5NUZ59Sy2bdPQFZ3UePr5wevZjHboirRCIQCKRI1cCgvSWUe2ag==
-  dependencies:
-    lodash.camelcase "^4.3.0"
-    lodash.clone "^4.5.0"
-    nan "^2.13.2"
-    node-pre-gyp "^0.13.0"
-    protobufjs "^5.0.3"
-
 gtoken@^1.2.1, gtoken@^1.2.3:
   version "1.2.3"
   resolved "https://registry.npmjs.org/gtoken/-/gtoken-1.2.3.tgz#5509571b8afd4322e124cf66cf68115284c476d8"