Skip to content
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

Jump to bottom

Fix optional data field for firestore #1370

Merged
merged 2 commits into from
Mar 28, 2023
Merged

Fix optional data field for firestore #1370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5733efc
fix optional data field
colerogers Mar 27, 2023
f0ba6af
Merge remote-tracking branch 'origin/master' into colerogers.firestor…
colerogers Mar 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/v2/core.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export interface CloudEvent<T> {
time: string;

/** Information about this specific event. */
data?: T;
data: T;
}

/**
Expand Down
76 changes: 41 additions & 35 deletions src/v2/providers/firestore.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export interface RawFirestoreData {
}

/** @internal */
export interface RawFirestoreEvent extends CloudEvent<Uint8Array | RawFirestoreData> {
export interface RawFirestoreEvent extends CloudEvent<Uint8Array | RawFirestoreData | undefined> {
location: string;
project: string;
database: string;
Expand Down Expand Up @@ -119,9 +119,9 @@ export interface DocumentOptions<Document extends string = string> extends Event
export function onDocumentWritten<Document extends string>(
document: Document,
handler: (
event: FirestoreEvent<Change<DocumentSnapshot>, ParamsOf<Document>>
event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<Change<DocumentSnapshot>, ParamsOf<Document>>>;
): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

/**
* Event handler which triggers when a document is created, updated, or deleted in Firestore.
Expand All @@ -132,9 +132,9 @@ export function onDocumentWritten<Document extends string>(
export function onDocumentWritten<Document extends string>(
opts: DocumentOptions<Document>,
handler: (
event: FirestoreEvent<Change<DocumentSnapshot>, ParamsOf<Document>>
event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<Change<DocumentSnapshot>, ParamsOf<Document>>>;
): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

/**
* Event handler which triggers when a document is created, updated, or deleted in Firestore.
Expand All @@ -145,9 +145,9 @@ export function onDocumentWritten<Document extends string>(
export function onDocumentWritten<Document extends string>(
documentOrOpts: Document | DocumentOptions<Document>,
handler: (
event: FirestoreEvent<Change<DocumentSnapshot>, ParamsOf<Document>>
event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<Change<DocumentSnapshot>, ParamsOf<Document>>> {
): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>> {
return onChangedOperation(writtenEventType, documentOrOpts, handler);
}

Expand All @@ -159,8 +159,10 @@ export function onDocumentWritten<Document extends string>(
*/
export function onDocumentCreated<Document extends string>(
document: Document,
handler: (event: FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>>;
handler: (
event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

/**
* Event handler which triggers when a document is created in Firestore.
Expand All @@ -170,8 +172,10 @@ export function onDocumentCreated<Document extends string>(
*/
export function onDocumentCreated<Document extends string>(
opts: DocumentOptions<Document>,
handler: (event: FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>>;
handler: (
event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

/**
* Event handler which triggers when a document is created in Firestore.
Expand All @@ -181,8 +185,10 @@ export function onDocumentCreated<Document extends string>(
*/
export function onDocumentCreated<Document extends string>(
documentOrOpts: Document | DocumentOptions<Document>,
handler: (event: FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>> {
handler: (
event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>> {
return onOperation(createdEventType, documentOrOpts, handler);
}

Expand All @@ -195,9 +201,9 @@ export function onDocumentCreated<Document extends string>(
export function onDocumentUpdated<Document extends string>(
document: Document,
handler: (
event: FirestoreEvent<Change<QueryDocumentSnapshot>, ParamsOf<Document>>
event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot>, ParamsOf<Document>>>;
): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
/**
* Event handler which triggers when a document is updated in Firestore.
*
Expand All @@ -207,9 +213,9 @@ export function onDocumentUpdated<Document extends string>(
export function onDocumentUpdated<Document extends string>(
opts: DocumentOptions<Document>,
handler: (
event: FirestoreEvent<Change<QueryDocumentSnapshot>, ParamsOf<Document>>
event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot>, ParamsOf<Document>>>;
): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

/**
* Event handler which triggers when a document is updated in Firestore.
Expand All @@ -220,9 +226,9 @@ export function onDocumentUpdated<Document extends string>(
export function onDocumentUpdated<Document extends string>(
documentOrOpts: Document | DocumentOptions<Document>,
handler: (
event: FirestoreEvent<Change<QueryDocumentSnapshot>, ParamsOf<Document>>
event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot>, ParamsOf<Document>>> {
): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>> {
return onChangedOperation(updatedEventType, documentOrOpts, handler);
}

Expand All @@ -234,8 +240,10 @@ export function onDocumentUpdated<Document extends string>(
*/
export function onDocumentDeleted<Document extends string>(
document: Document,
handler: (event: FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>>;
handler: (
event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

/**
* Event handler which triggers when a document is deleted in Firestore.
Expand All @@ -245,8 +253,10 @@ export function onDocumentDeleted<Document extends string>(
*/
export function onDocumentDeleted<Document extends string>(
opts: DocumentOptions<Document>,
handler: (event: FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>>;
handler: (
event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

/**
* Event handler which triggers when a document is deleted in Firestore.
Expand All @@ -256,8 +266,10 @@ export function onDocumentDeleted<Document extends string>(
*/
export function onDocumentDeleted<Document extends string>(
documentOrOpts: Document | DocumentOptions<Document>,
handler: (event: FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot, ParamsOf<Document>>> {
handler: (
event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>
) => any | Promise<any>
): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>> {
return onOperation(deletedEventType, documentOrOpts, handler);
}

Expand Down Expand Up @@ -345,20 +357,17 @@ export function makeFirestoreEvent<Params>(
eventType: string,
event: RawFirestoreEvent,
params: Params
): FirestoreEvent<QueryDocumentSnapshot, Params> {
): FirestoreEvent<QueryDocumentSnapshot | undefined, Params> {
const data = event.data
? eventType === createdEventType
? createSnapshot(event)
: createBeforeSnapshot(event)
: undefined;
const firestoreEvent: FirestoreEvent<QueryDocumentSnapshot, Params> = {
const firestoreEvent: FirestoreEvent<QueryDocumentSnapshot | undefined, Params> = {
...event,
params,
data,
};
if (firestoreEvent.data === undefined) {
delete (firestoreEvent as any).data;
}
delete (firestoreEvent as any).datacontenttype;
delete (firestoreEvent as any).dataschema;
return firestoreEvent;
Expand All @@ -368,18 +377,15 @@ export function makeFirestoreEvent<Params>(
export function makeChangedFirestoreEvent<Params>(
event: RawFirestoreEvent,
params: Params
): FirestoreEvent<Change<QueryDocumentSnapshot>, Params> {
): FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, Params> {
const data = event.data
? Change.fromObjects(createBeforeSnapshot(event), createSnapshot(event))
: undefined;
const firestoreEvent: FirestoreEvent<Change<QueryDocumentSnapshot>, Params> = {
const firestoreEvent: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, Params> = {
...event,
params,
data,
};
if (firestoreEvent.data === undefined) {
delete (firestoreEvent as any).data;
}
delete (firestoreEvent as any).datacontenttype;
delete (firestoreEvent as any).dataschema;
return firestoreEvent;
Expand Down