Skip to content

Commit ea699fa

Browse files
schmidt-sebastianschmidt-sebastian
authored
Share Integration Tests between firestore-exp and the main SDK (#3374)
1 parent a875bbe commit ea699fa

38 files changed

+911
-925
lines changed

‎.changeset/smooth-shirts-teach.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

‎integration/firestore/firebase_export.ts

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/**
2+
* @license
3+
* Copyright 2020 Google LLC
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
import * as firebase from 'firebase/app';
19+
import 'firebase/firestore';
20+
21+
// This file replaces "packages/firestore/test/integration/util/firebase_export"
22+
// and depends on the minified sources.
23+
24+
let appCount = 0;
25+
26+
export function newTestFirestore(
27+
projectId: string,
28+
nameOrApp?: string | firebase.app.App,
29+
settings?: firebase.firestore.Settings
30+
): firebase.firestore.Firestore {
31+
if (nameOrApp === undefined) {
32+
nameOrApp = 'test-app-' + appCount++;
33+
}
34+
const app =
35+
typeof nameOrApp === 'string'
36+
? firebase.initializeApp({ apiKey: 'fake-api-key', projectId }, nameOrApp)
37+
: nameOrApp;
38+
39+
const firestore = firebase.firestore(app);
40+
if (settings) {
41+
firestore.settings(settings);
42+
}
43+
return firestore;
44+
}
45+
46+
export function usesFunctionalApi(): false {
47+
return false;
48+
}
49+
50+
const Firestore = firebase.firestore.Firestore;
51+
const FieldPath = firebase.firestore.FieldPath;
52+
const Timestamp = firebase.firestore.Timestamp;
53+
const GeoPoint = firebase.firestore.GeoPoint;
54+
const FieldValue = firebase.firestore.FieldValue;
55+
const Blob = firebase.firestore.Blob;
56+
57+
export { Firestore, FieldValue, FieldPath, Timestamp, Blob, GeoPoint };

‎integration/firestore/firebase_export_memory.ts

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/**
2+
* @license
3+
* Copyright 2020 Google LLC
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
import * as firebase from 'firebase/app';
19+
import 'firebase/firestore/memory';
20+
21+
// This file replaces "packages/firestore/test/integration/util/firebase_export"
22+
// and depends on the minified sources.
23+
24+
let appCount = 0;
25+
26+
export function newTestFirestore(
27+
projectId: string,
28+
nameOrApp?: string | firebase.app.App,
29+
settings?: firebase.firestore.Settings
30+
): firebase.firestore.Firestore {
31+
if (nameOrApp === undefined) {
32+
nameOrApp = 'test-app-' + appCount++;
33+
}
34+
const app =
35+
typeof nameOrApp === 'string'
36+
? firebase.initializeApp({ apiKey: 'fake-api-key', projectId }, nameOrApp)
37+
: nameOrApp;
38+
39+
const firestore = firebase.firestore(app);
40+
if (settings) {
41+
firestore.settings(settings);
42+
}
43+
return firestore;
44+
}
45+
46+
export function usesFunctionalApi(): false {
47+
return false;
48+
}
49+
50+
const Firestore = firebase.firestore.Firestore;
51+
const FieldPath = firebase.firestore.FieldPath;
52+
const Timestamp = firebase.firestore.Timestamp;
53+
const GeoPoint = firebase.firestore.GeoPoint;
54+
const FieldValue = firebase.firestore.FieldValue;
55+
const Blob = firebase.firestore.Blob;
56+
57+
export { Firestore, FieldValue, FieldPath, Timestamp, Blob, GeoPoint };

‎integration/firestore/gulpfile.js

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,6 @@ function copyTests() {
3838
* Therefore these tests and helpers cannot have any src/ dependencies.
3939
*/
4040
const testBase = resolve(__dirname, '../../packages/firestore/test');
41-
const firebaseAppSdk = 'firebase/app/dist/index.esm.js';
42-
const firebaseFirestoreSdk = resolve(
43-
__dirname,
44-
isPersistenceEnabled()
45-
? '../../packages/firestore/dist/index.esm.js'
46-
: '../../packages/firestore/dist/index.memory.esm.js'
47-
);
4841
return gulp
4942
.src(
5043
[
@@ -63,21 +56,24 @@ function copyTests() {
6356
* This regex is designed to match the following statement used in our
6457
* firestore integration test suites:
6558
*
66-
* import firebase from '../../util/firebase_export';
59+
* import * as firebaseExport from '../../util/firebase_export';
6760
*
6861
* It will handle variations in whitespace, single/double quote
6962
* differences, as well as different paths to a valid firebase_export
7063
*/
71-
/import\s+firebase\s+from\s+('|")[^\1]+firebase_export\1;?/,
72-
`import firebase from '${firebaseAppSdk}';
73-
import '${firebaseFirestoreSdk}';
74-
64+
/import\s+\* as firebaseExport\s+from\s+('|")[^\1]+firebase_export\1;?/,
65+
`import * as firebaseExport from '${resolve(
66+
__dirname,
67+
isPersistenceEnabled()
68+
? './firebase_export'
69+
: './firebase_export_memory'
70+
)}';
71+
7572
if (typeof process === 'undefined') {
7673
process = { env: { INCLUDE_FIRESTORE_PERSISTENCE: '${isPersistenceEnabled()}' } } as any;
7774
} else {
7875
process.env.INCLUDE_FIRESTORE_PERSISTENCE = '${isPersistenceEnabled()}';
79-
}
80-
`
76+
}`
8177
)
8278
)
8379
.pipe(

‎integration/firestore/package.json

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
{
22
"name": "firebase-firestore-integration-test",
33
"version": "1.0.1",
4-
"private": true,
4+
"private": true,
55
"scripts": {
6-
"build:deps": "cd ../../packages/firestore ; yarn build",
6+
"build:deps": "lerna run --scope @firebase/'{app,firestore}' --include-dependencies build",
77
"build:persistence": "INCLUDE_FIRESTORE_PERSISTENCE=true gulp compile-tests",
88
"build:memory": "INCLUDE_FIRESTORE_PERSISTENCE=false gulp compile-tests",
99
"test": "yarn build:memory; karma start --single-run; yarn build:persistence; karma start --single-run;",
1010
"test:ci": "node ../../scripts/run_tests_in_ci.js",
1111
"test:persistence": " yarn build:persistence; karma start --single-run",
12+
"test:persistence:debug:": "yarn build:persistence; karma start --auto-watch --browsers Chrome",
1213
"test:memory": "yarn build:memory; karma start --single-run",
13-
"test:debug:persistence": "yarn build:deps; yarn build:persistence; karma start --auto-watch --browsers Chrome",
14-
"test:debug:memory": "yarn build:deps; yarn build:memory; karma start --single-run"
14+
"test:memory:debug": "yarn build:memory; karma start --auto-watch --browsers Chrome"
15+
},
16+
"peerDependencies": {
17+
"@firebase/app": "0.x",
18+
"@firebase/firestore": "0.x"
1519
},
1620
"devDependencies": {
1721
"@types/mocha": "7.0.2",

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

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

Lines changed: 20 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/firestore/exp/src/api/database.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ export function disableNetwork(
291291
export function terminate(
292292
firestore: firestore.FirebaseFirestore
293293
): Promise<void> {
294-
_removeServiceInstance(firestore.app, 'firestore/lite');
294+
_removeServiceInstance(firestore.app, 'firestore-exp');
295295
const firestoreImpl = cast(firestore, Firestore);
296296
return firestoreImpl._terminate();
297297
}

‎packages/firestore/exp/src/api/snapshot.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,11 @@ export class DocumentSnapshot<T = firestore.DocumentData>
8383
/* timestampsInSnapshots= */ true,
8484
options.serverTimestamps || DEFAULT_SERVER_TIMESTAMP_BEHAVIOR,
8585
key =>
86-
new DocumentReference(this._firestore, key, /* converter= */ null)
86+
new DocumentReference(
87+
this._firestore,
88+
key.path,
89+
/* converter= */ null
90+
)
8791
);
8892
return userDataWriter.convertValue(this._document.toProto()) as T;
8993
}
@@ -102,7 +106,8 @@ export class DocumentSnapshot<T = firestore.DocumentData>
102106
this._firestoreImpl._databaseId,
103107
/* timestampsInSnapshots= */ true,
104108
options.serverTimestamps || DEFAULT_SERVER_TIMESTAMP_BEHAVIOR,
105-
key => new DocumentReference(this._firestore, key, this._converter)
109+
key =>
110+
new DocumentReference(this._firestore, key.path, this._converter)
106111
);
107112
return userDataWriter.convertValue(value);
108113
}

‎packages/firestore/exp/test/deps/verify_dependencies.test.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ import * as dependencies from './dependencies.json';
2424
import * as pkg from '../../package.json';
2525
import { forEach } from '../../../src/util/obj';
2626

27-
describe('Dependencies', () => {
27+
// TODO(firestoreexp): Enable once the dependencies are stable
28+
// eslint-disable-next-line no-restricted-properties
29+
describe.skip('Dependencies', () => {
2830
forEach(dependencies, (api, { dependencies }) => {
2931
it(api, () => {
3032
return extractDependencies(api, resolve('exp', pkg.main)).then(

‎packages/firestore/exp/test/helpers.ts

Lines changed: 0 additions & 77 deletions
This file was deleted.

0 commit comments

Comments
 (0)