Merge

Author: schmidt-sebastian

packages/firebase/src/index.rn.ts

@@ -20,7 +20,10 @@ import { name, version } from '../package.json';
 
 import '../auth';
 import '../database';
+// TODO(b/158625454): Storage doesn't actually work by default in RN (it uses
+//  `atob`). We should provide a RN build that works out of the box.
 import '../storage';
+import '../firestore';
 
 firebase.registerVersion(name, version, 'rn');
 

packages/firestore/index.node.memory.ts

@@ -34,7 +34,7 @@ export function registerFirestore(instance: FirebaseNamespace): void {
     instance,
     (app, auth) => new Firestore(app, auth, new MemoryComponentProvider())
   );
-  instance.registerVersion(name, version);
+  instance.registerVersion(name, version, 'node');
 }
 
 registerFirestore(firebase);

packages/firestore/index.rn.memory.ts

@@ -0,0 +1,41 @@
+/**
+ * @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 firebase from '@firebase/app';
+import { FirebaseNamespace } from '@firebase/app-types';
+
+import { Firestore } from './src/api/database';
+import { MemoryComponentProvider } from './src/core/component_provider';
+import { configureForFirebase } from './src/platform/config';
+
+import './register-module';
+
+import { name, version } from './package.json';
+
+/**
+ * Registers the memory-only Firestore build for ReactNative with the components
+ * framework.
+ */
+export function registerFirestore(instance: FirebaseNamespace): void {
+  configureForFirebase(
+    instance,
+    (app, auth) => new Firestore(app, auth, new MemoryComponentProvider())
+  );
+  instance.registerVersion(name, version, 'rn');
+}
+
+registerFirestore(firebase);

packages/firestore/index.rn.ts

@@ -0,0 +1,39 @@
+/**
+ * @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 firebase from '@firebase/app';
+import { FirebaseNamespace } from '@firebase/app-types';
+
+import { Firestore } from './src/api/database';
+import { IndexedDbComponentProvider } from './src/core/component_provider';
+import { configureForFirebase } from './src/platform/config';
+
+import './register-module';
+import { name, version } from './package.json';
+
+/**
+ * Registers the main Firestore ReactNative build with the components framework.
+ * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
+ */
+export function registerFirestore(instance: FirebaseNamespace): void {
+  configureForFirebase(
+    instance,
+    (app, auth) => new Firestore(app, auth, new IndexedDbComponentProvider())
+  );
+  instance.registerVersion(name, version, 'rn');
+}
+
+registerFirestore(firebase);

packages/firestore/memory/package.json

@@ -3,6 +3,7 @@
   "description": "A memory-only build of the Cloud Firestore JS SDK.",
   "main": "../dist/index.memory.node.cjs.js",
   "main-esm2017": "../dist/index.memory.node.esm2017.js",
+  "react-native": "../dist/index.memory.rn.esm2017.js",
   "browser": "../dist/index.memory.cjs.js",
   "module": "../dist/index.memory.esm.js",
   "esm2017": "../dist/index.memory.esm2017.js",

packages/firestore/package.json

@@ -41,6 +41,7 @@
   },
   "main": "dist/index.node.cjs.js",
   "main-esm2017": "dist/index.node.esm2017.js",
+  "react-native": "dist/index.rn.esm2017.js",
   "browser": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "esm2017": "dist/index.esm2017.js",
@@ -56,7 +57,7 @@
     "@firebase/logger": "0.2.5",
     "@firebase/util": "0.2.48",
     "@firebase/webchannel-wrapper": "0.2.41",
-    "@grpc/grpc-js": "0.8.1",
+    "@grpc/grpc-js": "^1.0.0",
     "@grpc/proto-loader": "^0.5.0",
     "tslib": "^1.11.1"
   },

packages/firestore/rollup.config.es2017.js

@@ -32,7 +32,8 @@ import {
   firestoreTransformers,
   manglePrivatePropertiesOptions,
   resolveNodeExterns,
-  resolveBrowserExterns
+  resolveBrowserExterns,
+  generateAliasConfig
 } from './rollup.shared';
 
 // Firestore is released in a number of different build configurations:
@@ -62,22 +63,7 @@ import {
 // MARK: Browser builds
 
 const browserBuildPlugins = [
-  alias({
-    entries: [
-      {
-        find: /(.*)\/platform\/platform(.*)/,
-        replacement: '$1/platform_browser/browser_platform$2'
-      },
-      {
-        find: /(.*)\/platform\/random_bytes(.*)/,
-        replacement: '$1/platform_browser/browser_random_bytes$2'
-      },
-      {
-        find: /(.*)\/platform\/format_json(.*)/,
-        replacement: '$1/platform_browser/browser_format_json$2'
-      }
-    ]
-  }),
+  alias(generateAliasConfig('browser')),
   typescriptPlugin({
     typescript,
     tsconfigOverride: {
@@ -117,25 +103,40 @@ const browserBuilds = [
   }
 ];
 
+const reactNativeBuildPlugins = [
+  alias(generateAliasConfig('rn')),
+  ...browserBuildPlugins.slice(1)
+];
+
+const reactNativeBuilds = [
+  // Persistence build
+  {
+    input: 'index.rn.ts',
+    output: {
+      file: pkg['react-native'],
+      format: 'es',
+      sourcemap: true
+    },
+    plugins: reactNativeBuildPlugins,
+    external: resolveBrowserExterns
+  },
+  // Memory-only build
+  {
+    input: 'index.rn.memory.ts',
+    output: {
+      file: path.resolve('./memory', memoryPkg['react-native']),
+      format: 'es',
+      sourcemap: true
+    },
+    plugins: reactNativeBuildPlugins,
+    external: resolveBrowserExterns
+  }
+];
+
 // MARK: Node builds
 
 const nodeBuildPlugins = [
-  alias({
-    entries: [
-      {
-        find: /(.*)\/platform\/platform(.*)/,
-        replacement: '$1/platform_node/node_platform$2'
-      },
-      {
-        find: /(.*)\/platform\/random_bytes(.*)/,
-        replacement: '$1/platform_node/node_random_bytes$2'
-      },
-      {
-        find: /(.*)\/platform\/format_json(.*)/,
-        replacement: '$1/platform_node/node_format_json$2'
-      }
-    ]
-  }),
+  alias(generateAliasConfig('node')),
   typescriptPlugin({
     typescript,
     tsconfigOverride: {
@@ -178,4 +179,4 @@ const nodeBuilds = [
   }
 ];
 
-export default [...browserBuilds, ...nodeBuilds];
+export default [...browserBuilds, ...reactNativeBuilds, ...nodeBuilds];

packages/firestore/rollup.config.lite.js

@@ -20,28 +20,13 @@ import alias from '@rollup/plugin-alias';
 import typescriptPlugin from 'rollup-plugin-typescript2';
 import typescript from 'typescript';
 
-import { resolveNodeExterns } from './rollup.shared';
+import { resolveNodeExterns, generateAliasConfig } from './rollup.shared';
 
 import pkg from './lite/package.json';
 import path from 'path';
 
 const defaultPlugins = [
-  alias({
-    entries: [
-      {
-        find: /(.*)\/platform\/platform(.*)/,
-        replacement: '$1/platform_node/node_platform$2'
-      },
-      {
-        find: /(.*)\/platform\/random_bytes(.*)/,
-        replacement: '$1/platform_node/node_random_bytes$2'
-      },
-      {
-        find: /(.*)\/platform\/format_json(.*)/,
-        replacement: '$1/platform_node/node_format_json$2'
-      }
-    ]
-  }),
+  alias(generateAliasConfig('node')),
   typescriptPlugin({
     typescript,
     tsconfigOverride: {

packages/firestore/rollup.shared.js

@@ -24,6 +24,30 @@ import { removeAsserts } from './scripts/remove-asserts';
 
 import pkg from './package.json';
 
+/**
+ * Returns an replacement configuration for `@rollup/plugin-alias` that replaces
+ * references to platform-specific files with those of the provided target
+ * platform.
+ */
+export function generateAliasConfig(platform) {
+  return {
+    entries: [
+      {
+        find: /(.*)\/platform\/platform(.*)/,
+        replacement: `$1/platform_${platform}/${platform}_platform$2`
+      },
+      {
+        find: /(.*)\/platform\/random_bytes(.*)/,
+        replacement: `$1/platform_${platform}/${platform}_random_bytes$2`
+      },
+      {
+        find: /(.*)\/platform\/format_json(.*)/,
+        replacement: `$1/platform_${platform}/${platform}_format_json$2`
+      }
+    ]
+  };
+}
+
 const browserDeps = Object.keys(
   Object.assign({}, pkg.peerDependencies, pkg.dependencies)
 );

packages/firestore/src/platform_browser/browser_platform.ts

@@ -22,10 +22,10 @@ import { ConnectivityMonitor } from '../remote/connectivity_monitor';
 import { NoopConnectivityMonitor } from '../remote/connectivity_monitor_noop';
 import { BrowserConnectivityMonitor } from './browser_connectivity_monitor';
 import { WebChannelConnection } from './webchannel_connection';
-import { debugAssert } from '../util/assert';
 
 // Implements the Platform API for browsers and some browser-like environments
-// (including ReactNative).
+// (including ReactNative, which has its own platform implementation that reuses
+// most of these methods).
 // The exports in this class must match the exports in ../platform/platform as
 // are bundled with the browser build during the Rollup build.
 

packages/firestore/src/platform_rn/rn_format_json.ts

@@ -0,0 +1,18 @@
+/**
+ * @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.
+ */
+
+export { formatJSON } from '../platform_browser/browser_format_json';

packages/firestore/src/platform_rn/rn_platform.ts

@@ -0,0 +1,45 @@
+/**
+ * @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 { base64 } from '@firebase/util';
+
+export {
+  loadConnection,
+  newConnectivityMonitor,
+  newSerializer,
+  getWindow,
+  getDocument
+} from '../platform_browser/browser_platform';
+
+/** Converts a Base64 encoded string to a binary string. */
+export function decodeBase64(encoded: string): string {
+  // WebSafe uses a different URL-encoding safe alphabet that doesn't match
+  // the encoding used on the backend.
+  return base64.decodeString(encoded, /* webSafe =*/ false);
+}
+
+/** Converts a binary string to a Base64 encoded string. */
+export function encodeBase64(raw: string): string {
+  // WebSafe uses a different URL-encoding safe alphabet that doesn't match
+  // the encoding used on the backend.
+  return base64.encodeString(raw, /* webSafe =*/ false);
+}
+
+/** True if and only if the Base64 conversion functions are available. */
+export function isBase64Available(): boolean {
+  return true;
+}

packages/firestore/src/platform_rn/rn_random_bytes.ts

@@ -0,0 +1,18 @@
+/**
+ * @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.
+ */
+
+export { randomBytes } from '../platform_browser/browser_random_bytes';