Skip to content

Add testing support for 2nd gen firestore triggers #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 15, 2023
Merged

Add testing support for 2nd gen firestore triggers #200

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c5a9aca
firestore onDocumentCreated trigger
blidd-google Mar 17, 2023
1d9e8b4
on doc updated, written, deleted & unit tests
blidd-google Mar 20, 2023
e2ecfa1
on doc written unit tests
blidd-google Mar 20, 2023
23c5662
cleanup
blidd-google Mar 20, 2023
b17dbdd
don't overwrite user's mocked before/after data if they didn't mock t…
blidd-google Mar 21, 2023
2154638
add comments and changelog
blidd-google Mar 21, 2023
d9b8115
update functions sdk dep
blidd-google Apr 14, 2023
9347c17
fix formatting
blidd-google Apr 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
967 changes: 669 additions & 298 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"@types/mocha": "^5.2.7",
"chai": "^4.2.0",
"firebase-admin": "^10.1.0",
"firebase-functions": "^4.0.0-rc.0",
"firebase-functions": "file:../firebase-functions",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

woah that was the fastest PR review of all time!! will do

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should be good to grab v 4.3.0 now

"firebase-tools": "^8.9.2",
"mocha": "^6.2.2",
"prettier": "^1.19.1",
Expand All @@ -57,7 +57,7 @@
},
"peerDependencies": {
"firebase-admin": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
"firebase-functions": "^4.0.0",
"firebase-functions": "file:../firebase-functions",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here - 4.3.0

"jest": ">=28.0.0"
},
"engines": {
Expand Down
280 changes: 262 additions & 18 deletions spec/v2.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,12 @@ import {
testLab,
eventarc,
https,
firestore,
} from 'firebase-functions/v2';
import { defineString } from 'firebase-functions/params';
import { makeDataSnapshot } from '../src/providers/database';
import { makeDocumentSnapshot } from '../src/providers/firestore';
import {inspect } from 'util';

describe('v2', () => {
describe('#wrapV2', () => {
Expand Down Expand Up @@ -460,6 +463,265 @@ describe('v2', () => {
});
});

describe('firestore', () => {
describe('should resolve document path', () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: remove the "should resolve" ("document path")

it('should resolve default document path', () => {
const cloudFn = firestore.onDocumentCreated('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const cloudEvent = cloudFnWrap().cloudEvent;
expect(cloudEvent.document).equal('foo/bar/baz');
});

it('should resolve default document given StringParam', () => {
process.env.doc_path = 'foo/StringParam/baz';
const cloudFn = firestore.onDocumentCreated('', handler);
cloudFn.__endpoint.eventTrigger.eventFilterPathPatterns.document = defineString(
'doc_path'
);
const cloudFnWrap = wrapV2(cloudFn);
const cloudEvent = cloudFnWrap().cloudEvent;
expect(cloudEvent.document).equal('foo/StringParam/baz');
});

it('should resolve using params', () => {
const cloudFn = firestore.onDocumentCreated('users/{user}', handler);
const cloudFnWrap = wrapV2(cloudFn);
const partial = {
params: {
user: '123',
}
};
const cloudEvent = cloudFnWrap(partial).cloudEvent;
expect(cloudEvent.document).equal('users/123');
});

it('should resolve with undefined string if variable is missing', () => {
const cloudFn = firestore.onDocumentCreated('users/{user}', handler);
const cloudFnWrap = wrapV2(cloudFn);
const partial = {
params: {},
};
const cloudEvent = cloudFnWrap(partial).cloudEvent;
expect(cloudEvent.document).equal('users/undefined');
});
});

describe('document options', () => {
it('resolves default document options correctly', () => {
const cloudFn = firestore.onDocumentCreated('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const cloudEvent = cloudFnWrap().cloudEvent;
expect(cloudEvent.document).equal('foo/bar/baz');
expect(cloudEvent.database).equal('(default)');
expect(cloudEvent.namespace).equal('(default)');
});

it('reads custom DocumentOptions correctly', () => {
const documentOptions = {
document: 'foo/bar/baz',
database: 'custom-database',
namespace: 'custom-namespace'
};
const cloudFn = firestore.onDocumentCreated(documentOptions, handler);
const cloudFnWrap = wrapV2(cloudFn);
const cloudEvent = cloudFnWrap().cloudEvent;
expect(cloudEvent.document).equal(documentOptions.document);
expect(cloudEvent.database).equal(documentOptions.database);
expect(cloudEvent.namespace).equal(documentOptions.namespace);
});
});

describe('firestore.onDocumentCreated', () => {
it('should update CloudEvent appropriately', () => {
const cloudFn = firestore.onDocumentCreated('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const cloudEvent = cloudFnWrap().cloudEvent;

expect(cloudEvent).deep.equal({
id: cloudEvent.id,
time: cloudEvent.time,
specversion: '1.0',
type: 'google.cloud.firestore.document.v1.created',
source: '',

data: cloudEvent.data,
location: 'us-central1',
project: 'testproject',
database: '(default)',
namespace: '(default)',
document: 'foo/bar/baz',
params: {},
});
});

it('should use overridden data', () => {
const cloudFn = firestore.onDocumentCreated('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const docData = { foo: 'bar' };
const data = makeDocumentSnapshot(docData, 'foo/bar/baz');
const cloudEvent = cloudFnWrap({ data }).cloudEvent;
expect(cloudEvent.data.data()).deep.equal(docData);
});

it('should accept json data', () => {
const cloudFn = firestore.onDocumentCreated('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const docData = { foo: 'bar' };
const cloudEvent = cloudFnWrap({ data: docData }).cloudEvent;
expect(cloudEvent.data.data()).deep.equal(docData);
});
});

describe('firestore.onDocumentDeleted()', () => {
it('should update CloudEvent appropriately', () => {
const cloudFn = firestore.onDocumentDeleted('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const cloudEvent = cloudFnWrap().cloudEvent;

expect(cloudEvent).deep.equal({
id: cloudEvent.id,
time: cloudEvent.time,
specversion: '1.0',
type: 'google.cloud.firestore.document.v1.deleted',
source: '',

data: cloudEvent.data,
location: 'us-central1',
project: 'testproject',
database: '(default)',
namespace: '(default)',
document: 'foo/bar/baz',
params: {},
});
});

it('should use overridden data', () => {
const cloudFn = firestore.onDocumentDeleted('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const docData = { foo: 'bar' };
const data = makeDocumentSnapshot(docData, 'foo/bar/baz');
const cloudEvent = cloudFnWrap({ data }).cloudEvent;
expect(cloudEvent.data.data()).deep.equal(docData);
});

it('should accept json data', () => {
const cloudFn = firestore.onDocumentDeleted('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const docData = { foo: 'bar' };
const cloudEvent = cloudFnWrap({ data: docData }).cloudEvent;
expect(cloudEvent.data.data()).deep.equal(docData);
});
});

describe('firestore.onDocumentUpdated', () => {
it('should update CloudEvent appropriately', () => {
const cloudFn = firestore.onDocumentUpdated('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const cloudEvent = cloudFnWrap().cloudEvent;

expect(cloudEvent).deep.equal({
id: cloudEvent.id,
time: cloudEvent.time,
specversion: '1.0',
type: 'google.cloud.firestore.document.v1.updated',
source: '',

data: cloudEvent.data,
location: 'us-central1',
project: 'testproject',
database: '(default)',
namespace: '(default)',
document: 'foo/bar/baz',
params: {},
});
});

it('should use overridden data', () => {
const cloudFn = firestore.onDocumentUpdated('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);

const afterDataVal = { snapshot: 'after' };
const after = makeDocumentSnapshot(afterDataVal, 'foo/bar/baz');

const beforeDataVal = { snapshot: 'before' };
const before = makeDocumentSnapshot(beforeDataVal, 'foo/bar/baz');

const data = { before, after };
const cloudEvent = cloudFnWrap({ data }).cloudEvent;

expect(cloudEvent.data.before.data()).deep.equal(beforeDataVal);
expect(cloudEvent.data.after.data()).deep.equal(afterDataVal);
});

it('should accept json data', () => {
const cloudFn = firestore.onDocumentUpdated('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const afterDataVal = { snapshot: 'after' };
const beforeDataVal = { snapshot: 'before' };

const data = { before: beforeDataVal, after: afterDataVal };
const cloudEvent = cloudFnWrap({ data }).cloudEvent;

expect(cloudEvent.data.before.data()).deep.equal(beforeDataVal);
expect(cloudEvent.data.after.data()).deep.equal(afterDataVal);
});
});

describe('firestore.onDocumentWritten', () => {
it('should update CloudEvent appropriately', () => {
const cloudFn = firestore.onDocumentWritten('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const cloudEvent = cloudFnWrap().cloudEvent;

expect(cloudEvent).deep.equal({
id: cloudEvent.id,
time: cloudEvent.time,
specversion: '1.0',
type: 'google.cloud.firestore.document.v1.written',
source: '',

data: cloudEvent.data,
location: 'us-central1',
project: 'testproject',
database: '(default)',
namespace: '(default)',
document: 'foo/bar/baz',
params: {},
});
});

it('should use overridden data', () => {
const cloudFn = firestore.onDocumentWritten('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);

const afterDataVal = { snapshot: 'after' };
const after = makeDocumentSnapshot(afterDataVal, 'foo/bar/baz');

const beforeDataVal = { snapshot: 'before' };
const before = makeDocumentSnapshot(beforeDataVal, 'foo/bar/baz');

const data = { before, after };
const cloudEvent = cloudFnWrap({ data }).cloudEvent;

expect(cloudEvent.data.before.data()).deep.equal(beforeDataVal);
expect(cloudEvent.data.after.data()).deep.equal(afterDataVal);
});

it('should accept json data', () => {
const cloudFn = firestore.onDocumentWritten('foo/bar/baz', handler);
const cloudFnWrap = wrapV2(cloudFn);
const afterDataVal = { snapshot: 'after' };
const beforeDataVal = { snapshot: 'before' };

const data = { before: beforeDataVal, after: afterDataVal };
const cloudEvent = cloudFnWrap({ data }).cloudEvent;

expect(cloudEvent.data.before.data()).deep.equal(beforeDataVal);
expect(cloudEvent.data.after.data()).deep.equal(afterDataVal);
});
});
});

describe('database', () => {
describe('ref', () => {
it('should resolve default ref', () => {
Expand Down Expand Up @@ -488,24 +750,6 @@ describe('v2', () => {
expect(cloudEvent.ref).equal('foo/StringParam/baz');
});

it.skip('should resolve default ref given TernaryExpression', () => {
const ref1 = defineString('rtdb_ref_1');
process.env.rtdb_ref_1 = 'foo/StringParam/1';
const ref2 = defineString('rtdb_ref_2');
process.env.rtdb_ref_2 = 'foo/StringParam/2';
const referenceOptions = {
ref: '',
instance: 'instance-1',
};
const cloudFn = database.onValueCreated(referenceOptions, handler);
cloudFn.__endpoint.eventTrigger.eventFilterPathPatterns.ref = ref1
.equals('aa')
.then('rtdb_ref_1', 'rtdb_ref_2');
const cloudFnWrap = wrapV2(cloudFn);
const cloudEvent = cloudFnWrap().cloudEvent;
expect(cloudEvent.ref).equal('rtdb_ref_2');
});

it('should resolve using params', () => {
const referenceOptions = {
ref: 'users/{user}',
Expand Down
9 changes: 8 additions & 1 deletion src/cloudevent/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
database,
pubsub,
} from 'firebase-functions/v2';
import { DocumentSnapshot, QueryDocumentSnapshot } from 'firebase-admin/firestore';
import { LIST_OF_MOCK_CLOUD_EVENT_PARTIALS } from './mocks/partials';
import { DeepPartial } from './types';
import { Change } from 'firebase-functions';
Expand Down Expand Up @@ -41,7 +42,13 @@ export function generateMockCloudEvent<EventType extends CloudEvent<unknown>>(
return null;
}

const IMMUTABLE_DATA_TYPES = [database.DataSnapshot, Change, pubsub.Message];
const IMMUTABLE_DATA_TYPES = [
database.DataSnapshot,
DocumentSnapshot,
QueryDocumentSnapshot,
Change,
pubsub.Message
];

function mergeCloudEvents<EventType extends CloudEvent<unknown>>(
generatedCloudEvent: EventType,
Expand Down
19 changes: 2 additions & 17 deletions src/cloudevent/mocks/database/helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
exampleDataSnapshot,
exampleDataSnapshotChange,
} from '../../../providers/database';
import { resolveStringExpression, getBaseCloudEvent } from '../helpers';
import { resolveStringExpression, getBaseCloudEvent, extractRef } from '../helpers';
import { Change } from 'firebase-functions';
import { makeDataSnapshot } from '../../../providers/database';

Expand Down Expand Up @@ -144,19 +144,4 @@ export function getCommonDatabaseFields(
};
}

function extractRef(rawRef: string, params: Record<string, string>) {
const refSegments = rawRef.split('/');

return refSegments
.map((segment) => {
if (segment.startsWith('{') && segment.endsWith('}')) {
const param = segment
.slice(1, -1)
.replace('=**', '')
.replace('=*', '');
return params[param] || 'undefined';
}
return segment;
})
.join('/');
}

15 changes: 15 additions & 0 deletions src/cloudevent/mocks/firestore/firestore-on-document-created.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { MockCloudEventAbstractFactory } from "../../types";
import { CloudEvent, CloudFunction, firestore } from "firebase-functions/v2";
import { getEventType } from "../helpers";
import { QueryDocumentSnapshot } from "firebase-admin/firestore";
import { getDocumentSnapshotCloudEvent } from "./helpers";

export const firestoreOnDocumentCreated: MockCloudEventAbstractFactory<firestore.FirestoreEvent<QueryDocumentSnapshot>> = {
generateMock: getDocumentSnapshotCloudEvent,
match(cloudFunction: CloudFunction<CloudEvent<unknown>>): boolean {
return (
getEventType(cloudFunction) === 'google.cloud.firestore.document.v1.created'
);
}
}

Loading