Skip to content

Commit 89e03fd

Browse files
morganchen12morganchen12
authored
Add OR query snippets (#326)
* add simpler snippet * consts * add OR snippets * run snippets * fix web snippet * fix broken array-in snippets * fix old actions deps * update dev deps * update firestore deps * use node 20 and 22 * try hoisting * verbose log * downgrade rimraf * remove pnpm * fix build, grossly * migrate to new eslint config * add missing installations compile * add compile to scripts * skip scripts * fix and run snippets * add 22.x back
1 parent 467eaa1 commit 89e03fd

File tree

20 files changed

+216
-45
lines changed

20 files changed

+216
-45
lines changed

‎.eslintrc.json‎

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

‎.github/workflows/test.yml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,16 @@ jobs:
1313
strategy:
1414
matrix:
1515
node-version:
16-
- 14.x
16+
- 20.x
17+
- 22.x
1718
steps:
18-
- uses: actions/checkout@v1
19-
- uses: actions/setup-node@v1
19+
- uses: actions/checkout@v5
20+
- uses: actions/setup-node@v6
2021
with:
2122
node-version: ${{ matrix.node-version }}
2223

2324
- name: Cache npm
24-
uses: actions/cache@v1
25+
uses: actions/cache@v4
2526
with:
2627
path: ~/.npm
2728
key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package.json') }}

‎.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,3 @@ tsconfig.json
55
dist/
66
.DS_Store
77
.idea
8-
pnpm-lock.yaml

‎eslint.config.js‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
import { defineConfig } from "eslint/config";
3+
import js from "@eslint/js";
4+
5+
export default defineConfig([
6+
js.configs.recommended,
7+
{
8+
rules: {
9+
"no-unused-vars": "off",
10+
"no-undef": "off",
11+
"no-redeclare": "off"
12+
},
13+
},
14+
]);

‎firestore-next/package.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
},
77
"license": "Apache-2.0",
88
"dependencies": {
9-
"firebase": "^10.0.0",
10-
"geofire-common": "^5.1.0"
9+
"firebase": "^12.4.0",
10+
"geofire-common": "^6.0.0"
1111
},
1212
"devDependencies": {
13-
"@types/chai": "^4.2.12",
14-
"@types/mocha": "^8.0.3",
15-
"chai": "^4.2.0",
16-
"mocha": "^8.1.3"
13+
"@types/chai": "^5.2.3",
14+
"@types/mocha": "^10.0.10",
15+
"chai": "^6.2.0",
16+
"mocha": "^11.7.4"
1717
}
1818
}

‎firestore-next/test.firestore.js‎

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// [SNIPPETS_SEPARATION enabled]
33

44
const { expect } = require('chai');
5+
import { or } from "firebase/firestore";
56

67
// [START city_custom_object]
78
class City {
@@ -892,7 +893,7 @@ describe("firestore", () => {
892893
const { query, where } = require("firebase/firestore");
893894

894895
const q = query(citiesRef,
895-
where('regions', 'array-contains-any', ['west_coast', 'east_coast']));
896+
where('regions', 'array-contains-any', [['west_coast'], ['east_coast']]));
896897
// [END array_contains_any_filter]
897898
});
898899

@@ -1102,6 +1103,77 @@ describe("firestore", () => {
11021103
limit(25));
11031104
// [END paginate]
11041105
});
1106+
1107+
it("should handle OR queries", async () => {
1108+
const { collection, query, where, and } = require("firebase/firestore");
1109+
// [START or_query]
1110+
const q = query(collection(db, "cities"), and(
1111+
where('state', '==', 'CA'),
1112+
or(
1113+
where('capital', '==', true),
1114+
where('population', '>=', 1000000)
1115+
)
1116+
));
1117+
// [END or_query]
1118+
});
1119+
1120+
it("should allow for 30 or fewer disjunctions", async () => {
1121+
const { collection, query, where, and } = require("firebase/firestore");
1122+
const collectionRef = collection(db, "cities");
1123+
// [START one_disjunction]
1124+
query(collectionRef, where("a", "==", 1));
1125+
// [END one_disjunction]
1126+
1127+
// [START two_disjunctions]
1128+
query(collectionRef, or( where("a", "==", 1), where("b", "==", 2) ));
1129+
// [END two_disjunctions]
1130+
1131+
// [START four_disjunctions]
1132+
query(collectionRef,
1133+
or( and( where("a", "==", 1), where("c", "==", 3) ),
1134+
and( where("a", "==", 1), where("d", "==", 4) ),
1135+
and( where("b", "==", 2), where("c", "==", 3) ),
1136+
and( where("b", "==", 2), where("d", "==", 4) )
1137+
)
1138+
);
1139+
// [END four_disjunctions]
1140+
1141+
// [START four_disjunctions_compact]
1142+
query(collectionRef,
1143+
and( or( where("a", "==", 1), where("b", "==", 2) ),
1144+
or( where("c", "==", 3), where("d", "==", 4) )
1145+
)
1146+
);
1147+
// [END four_disjunctions_compact]
1148+
1149+
expect(() => {
1150+
// [START 50_disjunctions]
1151+
query(collectionRef,
1152+
and( where("a", "in", [1, 2, 3, 4, 5]),
1153+
where("b", "in", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
1154+
)
1155+
);
1156+
// [END 50_disjunctions]
1157+
}).to.throw;
1158+
1159+
// [START 20_disjunctions]
1160+
query(collectionRef,
1161+
or( where("a", "in", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]),
1162+
where("b", "in", [1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
1163+
)
1164+
);
1165+
// [END 20_disjunctions]
1166+
1167+
// [START 10_disjunctions]
1168+
query(collectionRef,
1169+
and( where("a", "in", [1, 2, 3, 4, 5]),
1170+
or( where("b", "==", 2),
1171+
where("c", "==", 3)
1172+
)
1173+
)
1174+
);
1175+
// [END 10_disjunctions]
1176+
});
11051177
});
11061178

11071179
describe('collectionGroup(landmarks)', () => {

‎firestore-next/test.solution-geoqueries.js‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ async function addHash(done) {
2929
done();
3030
}
3131

32+
// tsc complains `center` can have more or fewer than 2 elements, but
33+
// since this is a js file there's no way of more accurately specifying
34+
// `center`'s type.
3235
async function queryHashes(done) {
3336
// [START fs_geo_query_hashes]
3437
const { collection, query, orderBy, startAt, endAt, getDocs } = require('firebase/firestore');
@@ -40,6 +43,7 @@ async function queryHashes(done) {
4043
// Each item in 'bounds' represents a startAt/endAt pair. We have to issue
4144
// a separate query for each pair. There can be up to 9 pairs of bounds
4245
// depending on overlap, but in most cases there are 4.
46+
// @ts-ignore
4347
const bounds = geofire.geohashQueryBounds(center, radiusInM);
4448
const promises = [];
4549
for (const b of bounds) {
@@ -63,6 +67,7 @@ async function queryHashes(done) {
6367

6468
// We have to filter out a few false positives due to GeoHash
6569
// accuracy, but most will match
70+
// @ts-ignore
6671
const distanceInKm = geofire.distanceBetween([lat, lng], center);
6772
const distanceInM = distanceInKm * 1000;
6873
if (distanceInM <= radiusInM) {

‎firestore/test.firestore.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -877,7 +877,7 @@ describe("firestore", () => {
877877
const citiesRef = db.collection('cities');
878878
// [START array_contains_any_filter]
879879
citiesRef.where('regions', 'array-contains-any',
880-
['west_coast', 'east_coast']);
880+
[['west_coast'], ['east_coast']]);
881881
// [END array_contains_any_filter]
882882
});
883883

‎installations/package.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
22
"name": "installations",
33
"version": "1.0.0",
4-
"scripts": {},
4+
"scripts": {
5+
"compile": "echo 'Installations build temporarily disabled'"
6+
},
57
"license": "Apache 2.0",
68
"dependencies": {
79
"firebase": "^8.10.0"

‎package.json‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
{
22
"name": "snippets-web",
33
"version": "1.0.0",
4+
"type": "module",
45
"scripts": {
5-
"snippets": "rimraf snippets && ts-node scripts/separate-snippets.ts",
6+
"snippets": "rimraf snippets && node --loader ts-node/esm scripts/separate-snippets.ts",
67
"lint": "git ls-files | grep -v 'snippets/' | grep '.js$' | xargs npx eslint",
78
"format": "npm run lint -- --fix",
8-
"bootstrap": "pnpm recursive install",
9-
"compile": "pnpm recursive run compile --workspace-concurrency=4"
9+
"bootstrap": "find . -type f -name package.json -not -path '*/node_modules/*' -exec bash -c 'cd $(dirname {}) && npm install' \\;",
10+
"compile": "bash scripts/compile.sh"
1011
},
1112
"license": "Apache-2.0",
1213
"devDependencies": {
13-
"@types/node": "^16.7.10",
14-
"eslint": "^7.32.0",
15-
"pnpm": "^6.14.6",
16-
"rimraf": "^3.0.2",
17-
"ts-node": "^10.2.1",
18-
"typescript": "^4.4.2"
14+
"@eslint/js": "^9.38.0",
15+
"@types/node": "^24.9.1",
16+
"eslint": "^9.38.0",
17+
"rimraf": "^5.0.10",
18+
"ts-node": "^10.9.2",
19+
"typescript": "^5.9.0"
1920
}
2021
}

0 commit comments

Comments
 (0)