Share Integration Tests between firestore-exp and the main SDK

Author: schmidt-sebastian

integration/firestore/firebase_export.ts

@@ -0,0 +1,56 @@
+/**
+ * @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 firebase from 'firebase';
+
+// This file replaces "packages/firestore/test/integration/util/firebase_export"
+// and depends on the minified sources.
+
+let appCount = 0;
+
+export function newTestFirestore(
+  projectId: string,
+  nameOrApp?: string | firebase.app.App,
+  settings?: firebase.firestore.Settings
+): firebase.firestore.Firestore {
+  if (nameOrApp === undefined) {
+    nameOrApp = 'test-app-' + appCount++;
+  }
+  const app =
+    typeof nameOrApp === 'string'
+      ? firebase.initializeApp({ apiKey: 'fake-api-key', projectId }, nameOrApp)
+      : nameOrApp;
+
+  const firestore = firebase.firestore(app);
+  if (settings) {
+    firestore.settings(settings);
+  }
+  return firestore;
+}
+
+export function usesModularApi(): false {
+  return false;
+}
+
+const Firestore = firebase.firestore.Firestore;
+const FieldPath = firebase.firestore.FieldPath;
+const Timestamp = firebase.firestore.Timestamp;
+const GeoPoint = firebase.firestore.GeoPoint;
+const FieldValue = firebase.firestore.FieldValue;
+const Blob = firebase.firestore.Blob;
+
+export { Firestore, FieldValue, FieldPath, Timestamp, Blob, GeoPoint };

integration/firestore/gulpfile.js

@@ -48,6 +48,7 @@ function copyTests() {
   return gulp
     .src(
       [
+        'firebase_export.ts',
         testBase + '/integration/api/*.ts',
         testBase + '/integration/util/events_accumulator.ts',
         testBase + '/integration/util/helpers.ts',
@@ -63,21 +64,29 @@ function copyTests() {
          * This regex is designed to match the following statement used in our
          * firestore integration test suites:
          *
-         * import firebase from '../../util/firebase_export';
+         * import * as firebaseExport from '../../util/firebase_export';
          *
          * It will handle variations in whitespace, single/double quote
          * differences, as well as different paths to a valid firebase_export
          */
-        /import\s+firebase\s+from\s+('|")[^\1]+firebase_export\1;?/,
-        `import firebase from '${firebaseAppSdk}';
-         import '${firebaseFirestoreSdk}';
-         
+        /import\s+\* as firebaseExport\s+from\s+('|")[^\1]+firebase_export\1;?/,
+        `import * as firebaseExport from '${resolve(
+          __dirname,
+          './firebase_export'
+        )}';
+        
          if (typeof process === 'undefined') {
            process = { env: { INCLUDE_FIRESTORE_PERSISTENCE: '${isPersistenceEnabled()}' } } as any;
          } else {
            process.env.INCLUDE_FIRESTORE_PERSISTENCE = '${isPersistenceEnabled()}';
-         }
-         `
+         }`
+      )
+    )
+    .pipe(
+      replace(
+        'import * as firebase from "firebase";',
+        `import firebase from '${firebaseAppSdk}';
+         import '${firebaseFirestoreSdk}';`
       )
     )
     .pipe(

integration/integration/firestore/firebase_export.ts

@@ -0,0 +1,46 @@
+import firebase from 'firebase/app/dist/index.esm.js';
+         import '/Users/mrschmidt/GitHub/firebase/firebase-js-sdk/packages/firestore/dist/index.memory.esm.js';
+import * as exp from "../../packages/firestore/exp/test/shim";
+
+let appCount = 0;
+
+export function newTestFirestore(
+  projectId: string,
+  nameOrApp?: string | firebase.app.App,
+  settings?: firebase.firestore.Settings
+): firebase.firestore.Firestore {
+ if (nameOrApp === undefined) {
+   nameOrApp = 'test-app-' + appCount++;
+ }
+ const app =
+   typeof nameOrApp === 'string'
+     ? firebase.initializeApp({ apiKey: 'fake-api-key', projectId }, nameOrApp)
+     : nameOrApp;
+
+ const firestore = firebase.firestore(app);
+ if (settings) {
+   firestore.settings(settings);
+ }
+ return firestore;
+}
+
+export function usesModularApi() : false {
+  return false;
+}
+
+const Firestore =  firebase.firestore.Firestore;
+const FieldPath = firebase.firestore.FieldPath;
+const Timestamp = firebase.firestore.Timestamp;
+const GeoPoint = firebase.firestore.GeoPoint;
+const FieldValue = firebase.firestore.FieldValue;
+const Blob = firebase.firestore.Blob;
+
+export {
+  Firestore,
+  FieldValue,
+  FieldPath,
+  Timestamp,
+  Blob,
+  GeoPoint
+};
+

packages/firestore/.idea/runConfigurations/firestore_exp_Tests__Emulator__.xml

@@ -289,7 +289,7 @@ export function disableNetwork(
 export function terminate(
   firestore: firestore.FirebaseFirestore
 ): Promise<void> {
-  _removeServiceInstance(firestore.app, 'firestore/lite');
+  _removeServiceInstance(firestore.app, 'firestore-exp');
   const firestoreImpl = cast(firestore, Firestore);
   return firestoreImpl._terminate();
 }

packages/firestore/.idea/runConfigurations/firestore_exp_Tests__Emulator_w__Mock_Persistence_.xml

@@ -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.
+ */
+
+import '../../test/integration/api/array_transforms.test';

packages/firestore/exp/src/api/database.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.
+ */
+
+import '../../test/integration/api/batch_writes.test';

packages/firestore/exp/test/array_transforms.test.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.
+ */
+
+import '../../test/integration/api/cursor.test';

packages/firestore/exp/test/batch_writes.test.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.
+ */
+
+import '../../test/integration/api/database.test';