Skip to content

Commit 139e1d9

Browse files
colerogersinlined
colerogers
and
inlined
authored
Enhance RTDB v2 Triggers (#1153)
* moving change into v2 core * moving Change to common and fixing imports * fix tsdoc * rexporting Change from v1&v2 * remove unused functions from Change namespace * fixing argument * rename interface to onValue* and rework Change Co-authored-by: Thomas Bouldin <inlined@users.noreply.github.com>
1 parent 96f9e86 commit 139e1d9

File tree

9 files changed

+353
-213
lines changed

9 files changed

+353
-213
lines changed

‎spec/common/change.spec.ts‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
// The MIT License (MIT)
2+
//
3+
// Copyright (c) 2022 Firebase
4+
//
5+
// Permission is hereby granted, free of charge, to any person obtaining a copy
6+
// of this software and associated documentation files (the "Software"), to deal
7+
// in the Software without restriction, including without limitation the rights
8+
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
// copies of the Software, and to permit persons to whom the Software is
10+
// furnished to do so, subject to the following conditions:
11+
//
12+
// The above copyright notice and this permission notice shall be included in all
13+
// copies or substantial portions of the Software.
14+
//
15+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
// SOFTWARE.
22+
23+
import { expect } from 'chai';
24+
import * as change from '../../src/common/change';
25+
26+
describe('Change', () => {
27+
describe('applyFieldMask', () => {
28+
const after = {
29+
foo: 'bar',
30+
num: 2,
31+
obj: {
32+
a: 1,
33+
b: 2,
34+
},
35+
};
36+
37+
it('should handle deleted values', () => {
38+
const sparseBefore = { baz: 'qux' };
39+
const fieldMask = 'baz';
40+
expect(
41+
change.applyFieldMask(sparseBefore, after, fieldMask)
42+
).to.deep.equal({
43+
foo: 'bar',
44+
num: 2,
45+
obj: {
46+
a: 1,
47+
b: 2,
48+
},
49+
baz: 'qux',
50+
});
51+
});
52+
53+
it('should handle created values', () => {
54+
const sparseBefore = {};
55+
const fieldMask = 'num,obj.a';
56+
expect(
57+
change.applyFieldMask(sparseBefore, after, fieldMask)
58+
).to.deep.equal({
59+
foo: 'bar',
60+
obj: {
61+
b: 2,
62+
},
63+
});
64+
});
65+
66+
it('should handle mutated values', () => {
67+
const sparseBefore = {
68+
num: 3,
69+
obj: {
70+
a: 3,
71+
},
72+
};
73+
const fieldMask = 'num,obj.a';
74+
expect(
75+
change.applyFieldMask(sparseBefore, after, fieldMask)
76+
).to.deep.equal({
77+
foo: 'bar',
78+
num: 3,
79+
obj: {
80+
a: 3,
81+
b: 2,
82+
},
83+
});
84+
});
85+
});
86+
87+
describe('fromJSON', () => {
88+
it('should create a Change object with a `before` and `after`', () => {
89+
const created = change.Change.fromJSON<any>({
90+
before: { foo: 'bar' },
91+
after: { foo: 'faz' },
92+
});
93+
expect(created instanceof change.Change).to.equal(true);
94+
expect(created.before).to.deep.equal({ foo: 'bar' });
95+
expect(created.after).to.deep.equal({ foo: 'faz' });
96+
});
97+
98+
it('should apply the customizer function to `before` and `after`', () => {
99+
function customizer<T>(input: any) {
100+
input.another = 'value';
101+
return input as T;
102+
}
103+
const created = change.Change.fromJSON<object>(
104+
{
105+
before: { foo: 'bar' },
106+
after: { foo: 'faz' },
107+
},
108+
customizer
109+
);
110+
expect(created.before).to.deep.equal({
111+
foo: 'bar',
112+
another: 'value',
113+
});
114+
expect(created.after).to.deep.equal({
115+
foo: 'faz',
116+
another: 'value',
117+
});
118+
});
119+
});
120+
});

‎spec/v1/cloud-functions.spec.ts‎

Lines changed: 0 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ import { expect } from 'chai';
2424
import * as _ from 'lodash';
2525

2626
import {
27-
Change,
2827
Event,
2928
EventContext,
3029
makeCloudFunction,
@@ -354,99 +353,3 @@ describe('makeAuth and makeAuthType', () => {
354353
});
355354
});
356355
});
357-
358-
describe('Change', () => {
359-
describe('applyFieldMask', () => {
360-
const after = {
361-
foo: 'bar',
362-
num: 2,
363-
obj: {
364-
a: 1,
365-
b: 2,
366-
},
367-
};
368-
369-
it('should handle deleted values', () => {
370-
const sparseBefore = { baz: 'qux' };
371-
const fieldMask = 'baz';
372-
expect(
373-
Change.applyFieldMask(sparseBefore, after, fieldMask)
374-
).to.deep.equal({
375-
foo: 'bar',
376-
num: 2,
377-
obj: {
378-
a: 1,
379-
b: 2,
380-
},
381-
baz: 'qux',
382-
});
383-
});
384-
385-
it('should handle created values', () => {
386-
const sparseBefore = {};
387-
const fieldMask = 'num,obj.a';
388-
expect(
389-
Change.applyFieldMask(sparseBefore, after, fieldMask)
390-
).to.deep.equal({
391-
foo: 'bar',
392-
obj: {
393-
b: 2,
394-
},
395-
});
396-
});
397-
398-
it('should handle mutated values', () => {
399-
const sparseBefore = {
400-
num: 3,
401-
obj: {
402-
a: 3,
403-
},
404-
};
405-
const fieldMask = 'num,obj.a';
406-
expect(
407-
Change.applyFieldMask(sparseBefore, after, fieldMask)
408-
).to.deep.equal({
409-
foo: 'bar',
410-
num: 3,
411-
obj: {
412-
a: 3,
413-
b: 2,
414-
},
415-
});
416-
});
417-
});
418-
419-
describe('fromJSON', () => {
420-
it('should create a Change object with a `before` and `after`', () => {
421-
const created = Change.fromJSON<any>({
422-
before: { foo: 'bar' },
423-
after: { foo: 'faz' },
424-
});
425-
expect(created instanceof Change).to.equal(true);
426-
expect(created.before).to.deep.equal({ foo: 'bar' });
427-
expect(created.after).to.deep.equal({ foo: 'faz' });
428-
});
429-
430-
it('should apply the customizer function to `before` and `after`', () => {
431-
function customizer<T>(input: any) {
432-
_.set(input, 'another', 'value');
433-
return input as T;
434-
}
435-
const created = Change.fromJSON<object>(
436-
{
437-
before: { foo: 'bar' },
438-
after: { foo: 'faz' },
439-
},
440-
customizer
441-
);
442-
expect(created.before).to.deep.equal({
443-
foo: 'bar',
444-
another: 'value',
445-
});
446-
expect(created.after).to.deep.equal({
447-
foo: 'faz',
448-
another: 'value',
449-
});
450-
});
451-
});
452-
});

‎spec/v2/providers/database.spec.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -363,9 +363,9 @@ describe('database', () => {
363363
});
364364
});
365365

366-
describe('onRefWritten', () => {
366+
describe('onValueWritten', () => {
367367
it('should create a function with a reference', () => {
368-
const func = database.onRefWritten('/foo/{bar}/', (event) => 2);
368+
const func = database.onValueWritten('/foo/{bar}/', (event) => 2);
369369

370370
expect(func.__endpoint).to.deep.equal({
371371
platform: 'gcfv2',
@@ -383,7 +383,7 @@ describe('database', () => {
383383
});
384384

385385
it('should create a function with opts', () => {
386-
const func = database.onRefWritten(
386+
const func = database.onValueWritten(
387387
{
388388
ref: '/foo/{path=**}/{bar}/',
389389
instance: 'my-instance',
@@ -414,9 +414,9 @@ describe('database', () => {
414414
});
415415
});
416416

417-
describe('onRefCreated', () => {
417+
describe('onValueCreated', () => {
418418
it('should create a function with a reference', () => {
419-
const func = database.onRefCreated('/foo/{bar}/', (event) => 2);
419+
const func = database.onValueCreated('/foo/{bar}/', (event) => 2);
420420

421421
expect(func.__endpoint).to.deep.equal({
422422
platform: 'gcfv2',
@@ -434,7 +434,7 @@ describe('database', () => {
434434
});
435435

436436
it('should create a function with opts', () => {
437-
const func = database.onRefCreated(
437+
const func = database.onValueCreated(
438438
{
439439
ref: '/foo/{path=**}/{bar}/',
440440
instance: 'my-instance',
@@ -465,9 +465,9 @@ describe('database', () => {
465465
});
466466
});
467467

468-
describe('onRefUpdated', () => {
468+
describe('onValueUpdated', () => {
469469
it('should create a function with a reference', () => {
470-
const func = database.onRefUpdated('/foo/{bar}/', (event) => 2);
470+
const func = database.onValueUpdated('/foo/{bar}/', (event) => 2);
471471

472472
expect(func.__endpoint).to.deep.equal({
473473
platform: 'gcfv2',
@@ -485,7 +485,7 @@ describe('database', () => {
485485
});
486486

487487
it('should create a function with opts', () => {
488-
const func = database.onRefUpdated(
488+
const func = database.onValueUpdated(
489489
{
490490
ref: '/foo/{path=**}/{bar}/',
491491
instance: 'my-instance',
@@ -516,9 +516,9 @@ describe('database', () => {
516516
});
517517
});
518518

519-
describe('onRefDeleted', () => {
519+
describe('onValueDeleted', () => {
520520
it('should create a function with a reference', () => {
521-
const func = database.onRefDeleted('/foo/{bar}/', (event) => 2);
521+
const func = database.onValueDeleted('/foo/{bar}/', (event) => 2);
522522

523523
expect(func.__endpoint).to.deep.equal({
524524
platform: 'gcfv2',
@@ -536,7 +536,7 @@ describe('database', () => {
536536
});
537537

538538
it('should create a function with opts', () => {
539-
const func = database.onRefDeleted(
539+
const func = database.onValueDeleted(
540540
{
541541
ref: '/foo/{path=**}/{bar}/',
542542
instance: 'my-instance',

0 commit comments

Comments
 (0)