-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathparameter_queries.test.ts
818 lines (708 loc) · 33.5 KB
/
parameter_queries.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
import { describe, expect, test } from 'vitest';
import { ParameterLookup, SqlParameterQuery } from '../../src/index.js';
import { BASIC_SCHEMA, normalizeTokenParameters, PARSE_OPTIONS } from './util.js';
import { StaticSqlParameterQuery } from '../../src/StaticSqlParameterQuery.js';
describe('parameter queries', () => {
test('token_parameters IN query', function () {
const sql = 'SELECT id as group_id FROM groups WHERE token_parameters.user_id IN groups.user_ids';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'group1', user_ids: JSON.stringify(['user1', 'user2']) })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user1']),
bucket_parameters: [
{
group_id: 'group1'
}
]
},
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user2']),
bucket_parameters: [
{
group_id: 'group1'
}
]
}
]);
expect(
query.getLookups(
normalizeTokenParameters({
user_id: 'user1'
})
)
).toEqual([ParameterLookup.normalized('mybucket', '1', ['user1'])]);
});
test('IN token_parameters query', function () {
const sql = 'SELECT id as region_id FROM regions WHERE name IN token_parameters.region_names';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'region1', name: 'colorado' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['colorado']),
bucket_parameters: [
{
region_id: 'region1'
}
]
}
]);
expect(
query.getLookups(
normalizeTokenParameters({
region_names: JSON.stringify(['colorado', 'texas'])
})
)
).toEqual([
ParameterLookup.normalized('mybucket', '1', ['colorado']),
ParameterLookup.normalized('mybucket', '1', ['texas'])
]);
});
test('queried numeric parameters', () => {
const sql =
'SELECT users.int1, users.float1, users.float2 FROM users WHERE users.int1 = token_parameters.int1 AND users.float1 = token_parameters.float1 AND users.float2 = token_parameters.float2';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
// Note: We don't need to worry about numeric vs decimal types in the lookup - JSONB handles normalization for us.
expect(query.evaluateParameterRow({ int1: 314n, float1: 3.14, float2: 314 })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', [314n, 3.14, 314]),
bucket_parameters: [{ int1: 314n, float1: 3.14, float2: 314 }]
}
]);
// Similarly, we don't need to worry about the types here.
// This test just checks the current behavior.
expect(query.getLookups(normalizeTokenParameters({ int1: 314n, float1: 3.14, float2: 314 }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [314n, 3.14, 314n])
]);
// We _do_ need to care about the bucket string representation.
expect(
query.resolveBucketDescriptions([{ int1: 314, float1: 3.14, float2: 314 }], normalizeTokenParameters({}))
).toEqual([{ bucket: 'mybucket[314,3.14,314]', priority: 3 }]);
expect(
query.resolveBucketDescriptions([{ int1: 314n, float1: 3.14, float2: 314 }], normalizeTokenParameters({}))
).toEqual([{ bucket: 'mybucket[314,3.14,314]', priority: 3 }]);
});
test('plain token_parameter (baseline)', () => {
const sql = 'SELECT id from users WHERE filter_param = token_parameters.user_id';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'test_id', filter_param: 'test_param' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['test_param']),
bucket_parameters: [{ id: 'test_id' }]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'test' }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['test'])
]);
});
test('function on token_parameter', () => {
const sql = 'SELECT id from users WHERE filter_param = upper(token_parameters.user_id)';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'test_id', filter_param: 'test_param' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['test_param']),
bucket_parameters: [{ id: 'test_id' }]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'test' }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['TEST'])
]);
});
test('token parameter member operator', () => {
const sql = "SELECT id from users WHERE filter_param = token_parameters.some_param ->> 'description'";
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'test_id', filter_param: 'test_param' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['test_param']),
bucket_parameters: [{ id: 'test_id' }]
}
]);
expect(query.getLookups(normalizeTokenParameters({ some_param: { description: 'test_description' } }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['test_description'])
]);
});
test('token parameter and binary operator', () => {
const sql = 'SELECT id from users WHERE filter_param = token_parameters.some_param + 2';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.getLookups(normalizeTokenParameters({ some_param: 3 }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [5n])
]);
});
test('token parameter IS NULL as filter', () => {
const sql = 'SELECT id from users WHERE filter_param = (token_parameters.some_param IS NULL)';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.getLookups(normalizeTokenParameters({ some_param: null }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [1n])
]);
expect(query.getLookups(normalizeTokenParameters({ some_param: 'test' }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [0n])
]);
});
test('direct token parameter', () => {
const sql = 'SELECT FROM users WHERE token_parameters.some_param';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', [1n]),
bucket_parameters: [{}]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: null }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [0n])
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: 123 }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [1n])
]);
});
test('token parameter IS NULL', () => {
const sql = 'SELECT FROM users WHERE token_parameters.some_param IS NULL';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', [1n]),
bucket_parameters: [{}]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: null }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [1n])
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: 123 }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [0n])
]);
});
test('token parameter IS NOT NULL', () => {
const sql = 'SELECT FROM users WHERE token_parameters.some_param IS NOT NULL';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', [1n]),
bucket_parameters: [{}]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: null }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [0n])
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: 123 }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [1n])
]);
});
test('token parameter NOT', () => {
const sql = 'SELECT FROM users WHERE NOT token_parameters.is_admin';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', [1n]),
bucket_parameters: [{}]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', is_admin: false }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [1n])
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', is_admin: 123 }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [0n])
]);
});
test('row filter and token parameter IS NULL', () => {
const sql = 'SELECT FROM users WHERE users.id = token_parameters.user_id AND token_parameters.some_param IS NULL';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user1', 1n]),
bucket_parameters: [{}]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: null }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['user1', 1n])
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: 123 }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['user1', 0n])
]);
});
test('row filter and direct token parameter', () => {
const sql = 'SELECT FROM users WHERE users.id = token_parameters.user_id AND token_parameters.some_param';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user1', 1n]),
bucket_parameters: [{}]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: 123 }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['user1', 1n])
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', some_param: null }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['user1', 0n])
]);
});
test('cast', () => {
const sql = 'SELECT FROM users WHERE users.id = cast(token_parameters.user_id as text)';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1' }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['user1'])
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 123 }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['123'])
]);
});
test('IS NULL row filter', () => {
const sql = 'SELECT id FROM users WHERE role IS NULL';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1', role: null })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', []),
bucket_parameters: [{ id: 'user1' }]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1' }))).toEqual([
ParameterLookup.normalized('mybucket', '1', [])
]);
});
test('token filter (1)', () => {
// Also supported: token_parameters.is_admin = true
// Not supported: token_parameters.is_admin != false
// Support could be added later.
const sql = 'SELECT FROM users WHERE users.id = token_parameters.user_id AND token_parameters.is_admin';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user1', 1n]),
bucket_parameters: [{}]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', is_admin: true }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['user1', 1n])
]);
// Would not match any actual lookups
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', is_admin: false }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['user1', 0n])
]);
});
test('token filter (2)', () => {
const sql =
'SELECT users.id AS user_id, token_parameters.is_admin as is_admin FROM users WHERE users.id = token_parameters.user_id AND token_parameters.is_admin';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user1', 1n]),
bucket_parameters: [{ user_id: 'user1' }]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'user1', is_admin: true }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['user1', 1n])
]);
expect(
query.resolveBucketDescriptions(
[{ user_id: 'user1' }],
normalizeTokenParameters({ user_id: 'user1', is_admin: true })
)
).toEqual([{ bucket: 'mybucket["user1",1]', priority: 3 }]);
});
test('case-sensitive parameter queries (1)', () => {
const sql = 'SELECT users."userId" AS user_id FROM users WHERE users."userId" = token_parameters.user_id';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ userId: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user1']),
bucket_parameters: [{ user_id: 'user1' }]
}
]);
});
test('case-sensitive parameter queries (2)', () => {
// Note: This documents current behavior.
// This may change in the future - we should check against expected behavior for
// Postgres and/or SQLite.
const sql = 'SELECT users.userId AS user_id FROM users WHERE users.userId = token_parameters.user_id';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toMatchObject([
{ message: `Unquoted identifiers are converted to lower-case. Use "userId" instead.` },
{ message: `Unquoted identifiers are converted to lower-case. Use "userId" instead.` }
]);
query.id = '1';
expect(query.evaluateParameterRow({ userId: 'user1' })).toEqual([]);
expect(query.evaluateParameterRow({ userid: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user1']),
bucket_parameters: [{ user_id: 'user1' }]
}
]);
});
test('case-sensitive parameter queries (3)', () => {
const sql = 'SELECT user_id FROM users WHERE Users.user_id = token_parameters.user_id';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toMatchObject([
{ message: `Unquoted identifiers are converted to lower-case. Use "Users" instead.` }
]);
});
test('case-sensitive parameter queries (4)', () => {
const sql = 'SELECT Users.user_id FROM users WHERE user_id = token_parameters.user_id';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toMatchObject([
{ message: `Unquoted identifiers are converted to lower-case. Use "Users" instead.` }
]);
});
test('case-sensitive parameter queries (5)', () => {
const sql = 'SELECT user_id FROM Users WHERE user_id = token_parameters.user_id';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toMatchObject([
{ message: `Unquoted identifiers are converted to lower-case. Use "Users" instead.` }
]);
});
test('case-sensitive parameter queries (6)', () => {
const sql = 'SELECT userId FROM users';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toMatchObject([
{ message: `Unquoted identifiers are converted to lower-case. Use "userId" instead.` }
]);
});
test('case-sensitive parameter queries (7)', () => {
const sql = 'SELECT user_id as userId FROM users';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toMatchObject([
{ message: `Unquoted identifiers are converted to lower-case. Use "userId" instead.` }
]);
});
test('dynamic global parameter query', () => {
const sql = "SELECT workspaces.id AS workspace_id FROM workspaces WHERE visibility = 'public'";
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'workspace1', visibility: 'public' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', []),
bucket_parameters: [{ workspace_id: 'workspace1' }]
}
]);
expect(query.evaluateParameterRow({ id: 'workspace1', visibility: 'private' })).toEqual([]);
});
test('multiple different functions on token_parameter with AND', () => {
// This is treated as two separate lookup index values
const sql =
'SELECT id from users WHERE filter_param = upper(token_parameters.user_id) AND filter_param = lower(token_parameters.user_id)';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'test_id', filter_param: 'test_param' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['test_param', 'test_param']),
bucket_parameters: [{ id: 'test_id' }]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'test' }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['TEST', 'test'])
]);
});
test('multiple same functions on token_parameter with OR', () => {
// This is treated as the same index lookup value, can use OR with the two clauses
const sql =
'SELECT id from users WHERE filter_param1 = upper(token_parameters.user_id) OR filter_param2 = upper(token_parameters.user_id)';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'test_id', filter_param1: 'test1', filter_param2: 'test2' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['test1']),
bucket_parameters: [{ id: 'test_id' }]
},
{
lookup: ParameterLookup.normalized('mybucket', '1', ['test2']),
bucket_parameters: [{ id: 'test_id' }]
}
]);
expect(query.getLookups(normalizeTokenParameters({ user_id: 'test' }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['TEST'])
]);
});
test('request.parameters()', function () {
const sql = "SELECT FROM posts WHERE category = request.parameters() ->> 'category_id'";
const query = SqlParameterQuery.fromSql('mybucket', sql, {
accept_potentially_dangerous_queries: true,
...PARSE_OPTIONS
}) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'group1', category: 'red' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['red']),
bucket_parameters: [{}]
}
]);
expect(query.getLookups(normalizeTokenParameters({}, { category_id: 'red' }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['red'])
]);
});
test('nested request.parameters() (1)', function () {
const sql = "SELECT FROM posts WHERE category = request.parameters() -> 'details' ->> 'category'";
const query = SqlParameterQuery.fromSql('mybucket', sql, {
accept_potentially_dangerous_queries: true,
...PARSE_OPTIONS
}) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.getLookups(normalizeTokenParameters({}, { details: { category: 'red' } }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['red'])
]);
});
test('nested request.parameters() (2)', function () {
const sql = "SELECT FROM posts WHERE category = request.parameters() ->> 'details.category'";
const query = SqlParameterQuery.fromSql('mybucket', sql, {
accept_potentially_dangerous_queries: true,
...PARSE_OPTIONS
}) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.getLookups(normalizeTokenParameters({}, { details: { category: 'red' } }))).toEqual([
ParameterLookup.normalized('mybucket', '1', ['red'])
]);
});
test('IN request.parameters()', function () {
// Can use -> or ->> here
const sql = "SELECT id as region_id FROM regions WHERE name IN request.parameters() -> 'region_names'";
const query = SqlParameterQuery.fromSql('mybucket', sql, {
accept_potentially_dangerous_queries: true,
...PARSE_OPTIONS
}) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'region1', name: 'colorado' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['colorado']),
bucket_parameters: [
{
region_id: 'region1'
}
]
}
]);
expect(
query.getLookups(
normalizeTokenParameters(
{},
{
region_names: ['colorado', 'texas']
}
)
)
).toEqual([
ParameterLookup.normalized('mybucket', '1', ['colorado']),
ParameterLookup.normalized('mybucket', '1', ['texas'])
]);
});
test('user_parameters in SELECT', function () {
const sql = 'SELECT id, user_parameters.other_id as other_id FROM users WHERE id = token_parameters.user_id';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user1']),
bucket_parameters: [{ id: 'user1' }]
}
]);
const requestParams = normalizeTokenParameters({ user_id: 'user1' }, { other_id: 'red' });
expect(query.getLookups(requestParams)).toEqual([ParameterLookup.normalized('mybucket', '1', ['user1'])]);
});
test('request.parameters() in SELECT', function () {
const sql =
"SELECT id, request.parameters() ->> 'other_id' as other_id FROM users WHERE id = token_parameters.user_id";
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
expect(query.evaluateParameterRow({ id: 'user1' })).toEqual([
{
lookup: ParameterLookup.normalized('mybucket', '1', ['user1']),
bucket_parameters: [{ id: 'user1' }]
}
]);
const requestParams = normalizeTokenParameters({ user_id: 'user1' }, { other_id: 'red' });
expect(query.getLookups(requestParams)).toEqual([ParameterLookup.normalized('mybucket', '1', ['user1'])]);
});
test('request.jwt()', function () {
const sql = "SELECT FROM users WHERE id = request.jwt() ->> 'sub'";
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
const requestParams = normalizeTokenParameters({ user_id: 'user1' });
expect(query.getLookups(requestParams)).toEqual([ParameterLookup.normalized('mybucket', '1', ['user1'])]);
});
test('request.user_id()', function () {
const sql = 'SELECT FROM users WHERE id = request.user_id()';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
query.id = '1';
const requestParams = normalizeTokenParameters({ user_id: 'user1' });
expect(query.getLookups(requestParams)).toEqual([ParameterLookup.normalized('mybucket', '1', ['user1'])]);
});
test('invalid OR in parameter queries', () => {
// Supporting this case is more tricky. We can do this by effectively denormalizing the OR clause
// into separate queries, but it's a significant change. For now, developers should do that manually.
const sql =
"SELECT workspaces.id AS workspace_id FROM workspaces WHERE workspaces.user_id = token_parameters.user_id OR visibility = 'public'";
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors[0].message).toMatch(/must use the same parameters/);
});
test('invalid OR in parameter queries (2)', () => {
const sql =
'SELECT id from users WHERE filter_param = upper(token_parameters.user_id) OR filter_param = lower(token_parameters.user_id)';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors[0].message).toMatch(/must use the same parameters/);
});
test('invalid parameter match clause (1)', () => {
const sql = 'SELECT FROM users WHERE (id = token_parameters.user_id) = false';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors[0].message).toMatch(/Parameter match clauses cannot be used here/);
});
test('invalid parameter match clause (2)', () => {
const sql = 'SELECT FROM users WHERE NOT (id = token_parameters.user_id)';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors[0].message).toMatch(/Parameter match clauses cannot be used here/);
});
test('invalid parameter match clause (3)', () => {
// May be supported in the future
const sql = 'SELECT FROM users WHERE token_parameters.start_at < users.created_at';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors[0].message).toMatch(/Cannot use table values and parameters in the same clauses/);
});
test('invalid parameter match clause (4)', () => {
const sql = 'SELECT FROM users WHERE json_extract(users.description, token_parameters.path)';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors[0].message).toMatch(/Cannot use table values and parameters in the same clauses/);
});
test('invalid parameter match clause (5)', () => {
const sql = 'SELECT (user_parameters.role = posts.roles) as r FROM posts';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors[0].message).toMatch(/Parameter match expression is not allowed here/);
});
test('invalid function schema', () => {
const sql = 'SELECT FROM users WHERE something.length(users.id) = 0';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors[0].message).toMatch(/Function 'something.length' is not defined/);
});
test('validate columns', () => {
const schema = BASIC_SCHEMA;
const q1 = SqlParameterQuery.fromSql('q4', 'SELECT id FROM assets WHERE owner_id = token_parameters.user_id', {
...PARSE_OPTIONS,
schema
});
expect(q1.errors).toMatchObject([]);
const q2 = SqlParameterQuery.fromSql(
'q5',
'SELECT id as asset_id FROM assets WHERE other_id = token_parameters.user_id',
{ ...PARSE_OPTIONS, schema }
);
expect(q2.errors).toMatchObject([
{
message: 'Column not found: other_id',
type: 'warning'
}
]);
});
describe('dangerous queries', function () {
function testDangerousQuery(sql: string) {
test(sql, function () {
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toMatchObject([
{
message:
"Potentially dangerous query based on parameters set by the client. The client can send any value for these parameters so it's not a good place to do authorization."
}
]);
expect(query.usesDangerousRequestParameters).toEqual(true);
});
}
function testSafeQuery(sql: string) {
test(sql, function () {
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
expect(query.usesDangerousRequestParameters).toEqual(false);
});
}
testSafeQuery('SELECT id as user_id FROM users WHERE users.user_id = request.user_id()');
testSafeQuery(
"SELECT request.jwt() ->> 'org_id' as org_id, id as project_id FROM projects WHERE id = request.parameters() ->> 'project_id'"
);
testSafeQuery(
"SELECT id as project_id FROM projects WHERE org_id = request.jwt() ->> 'org_id' AND id = request.parameters() ->> 'project_id'"
);
testSafeQuery('SELECT id as category_id FROM categories');
// Can be considered dangerous, but tricky to implement with the current parsing structure
testSafeQuery(
"SELECT id as project_id FROM projects WHERE id = request.parameters() ->> 'project_id' AND request.jwt() ->> 'role' = 'authenticated'"
);
testDangerousQuery("SELECT id as project_id FROM projects WHERE id = request.parameters() ->> 'project_id'");
testDangerousQuery("SELECT id as category_id, request.parameters() ->> 'project_id' as project_id FROM categories");
// Can be safe, but better to opt in
testDangerousQuery("SELECT id as category_id FROM categories WHERE request.parameters() ->> 'include_categories'");
});
describe('bucket priorities', () => {
test('valid definition', function () {
const sql = 'SELECT id as group_id, 1 AS _priority FROM groups WHERE token_parameters.user_id IN groups.user_ids';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toEqual([]);
expect(Object.entries(query.lookup_extractors)).toHaveLength(1);
expect(Object.entries(query.parameter_extractors)).toHaveLength(0);
expect(query.bucket_parameters).toEqual(['group_id']);
expect(query.priority).toBe(1);
});
test('valid definition, static query', function () {
const sql = 'SELECT token_parameters.user_id, 0 AS _priority';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as StaticSqlParameterQuery;
expect(query.errors).toEqual([]);
expect(Object.entries(query.parameter_extractors)).toHaveLength(1);
expect(query.bucket_parameters).toEqual(['user_id']);
expect(query.priority).toBe(0);
});
test('invalid dynamic query', function () {
const sql = 'SELECT LENGTH(assets.name) AS _priority FROM assets';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as SqlParameterQuery;
expect(query.errors).toMatchObject([{ message: 'Priority must be a simple integer literal' }]);
});
test('invalid literal type', function () {
const sql = "SELECT 'very fast please' AS _priority";
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as StaticSqlParameterQuery;
expect(query.errors).toMatchObject([{ message: 'Priority must be a simple integer literal' }]);
});
test('invalid literal value', function () {
const sql = 'SELECT 15 AS _priority';
const query = SqlParameterQuery.fromSql('mybucket', sql, PARSE_OPTIONS) as StaticSqlParameterQuery;
expect(query.errors).toMatchObject([
{ message: 'Invalid value for priority, must be between 0 and 3 (inclusive).' }
]);
});
});
});