Change context parameter in handlers to be not optional (#232)

Author: merlinnot

integration_test/functions/src/testing.ts

@@ -2,7 +2,7 @@ import * as firebase from 'firebase-admin';
 import * as _ from 'lodash';
 import { EventContext } from 'firebase-functions';
 
-export type TestCase<T> = (data: T, context?: EventContext) => any
+export type TestCase<T> = (data: T, context: EventContext) => any
 export type TestCaseMap<T> = { [key: string]: TestCase<T> };
 
 export class TestSuite<T> {
@@ -19,7 +19,7 @@ export class TestSuite<T> {
     return this;
   }
 
-  run(testId: string, data: T, context?: EventContext): Promise<void> {
+  run(testId: string, data: T, context: EventContext): Promise<void> {
     let running: Array<Promise<any>> = [];
     for (let testName in this.tests) {
       if (!this.tests.hasOwnProperty(testName)) { continue; }

src/cloud-functions.ts

@@ -165,7 +165,7 @@ export interface TriggerAnnotated {
 
 /** A Runnable has a `run` method which directly invokes the user-defined function - useful for unit testing. */
 export interface Runnable<T> {
-  run: (data: T, context?: EventContext) => PromiseLike<any> | any;
+  run: (data: T, context: EventContext) => PromiseLike<any> | any;
 }
 
 /**
@@ -189,7 +189,7 @@ export interface MakeCloudFunctionArgs<EventData> {
   triggerResource: () => string;
   service: string;
   dataConstructor?: (raw: Event | LegacyEvent) => EventData;
-  handler: (data: EventData, context?: EventContext) => PromiseLike<any> | any;
+  handler: (data: EventData, context: EventContext) => PromiseLike<any> | any;
   before?: (raw: Event | LegacyEvent) => void;
   after?: (raw: Event | LegacyEvent) => void;
   legacyEventType?: string;

src/providers/analytics.ts

@@ -66,7 +66,7 @@ export class AnalyticsEventBuilder {
    *   Cloud Function you can export.
    */
   onLog(
-    handler: (event: AnalyticsEvent, context?: EventContext) => PromiseLike<any> | any): CloudFunction<AnalyticsEvent> {
+    handler: (event: AnalyticsEvent, context: EventContext) => PromiseLike<any> | any): CloudFunction<AnalyticsEvent> {
     const dataConstructor = (raw: Event) => {
       return new AnalyticsEvent(raw.data);
     };

src/providers/auth.ts

@@ -62,17 +62,17 @@ export class UserBuilder {
   constructor(private triggerResource: () => string) { }
 
   /** Respond to the creation of a Firebase Auth user. */
-  onCreate(handler: (user: UserRecord, context?: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord> {
+  onCreate(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord> {
     return this.onOperation(handler, 'user.create');
   }
 
   /** Respond to the deletion of a Firebase Auth user. */
-  onDelete(handler: (user: UserRecord, context?: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord> {
+  onDelete(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord> {
     return this.onOperation(handler, 'user.delete');
   }
 
   private onOperation(
-    handler: (user: UserRecord, context?: EventContext) => PromiseLike<any> | any,
+    handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any,
     eventType: string
   ): CloudFunction<UserRecord> {
     return makeCloudFunction({

src/providers/crashlytics.ts

@@ -51,22 +51,22 @@ export class IssueBuilder {
   }
 
   /** Handle Crashlytics New Issue events. */
-  onNew(handler: (issue: Issue, context?: EventContext) => PromiseLike<any> | any): CloudFunction<Issue> {
+  onNew(handler: (issue: Issue, context: EventContext) => PromiseLike<any> | any): CloudFunction<Issue> {
     return this.onEvent(handler, 'issue.new');
   }
 
   /** Handle Crashlytics Regressed Issue events. */
-  onRegressed(handler: (issue: Issue, context?: EventContext) => PromiseLike<any> | any): CloudFunction<Issue> {
+  onRegressed(handler: (issue: Issue, context: EventContext) => PromiseLike<any> | any): CloudFunction<Issue> {
     return this.onEvent(handler, 'issue.regressed');
   }
 
   /** Handle Crashlytics Velocity Alert events. */
-  onVelocityAlert(handler: (issue: Issue, context?: EventContext) => PromiseLike<any> | any): CloudFunction<Issue> {
+  onVelocityAlert(handler: (issue: Issue, context: EventContext) => PromiseLike<any> | any): CloudFunction<Issue> {
     return this.onEvent(handler, 'issue.velocityAlert');
   }
 
   private onEvent(
-    handler: (issue: Issue, context?: EventContext) => PromiseLike<any> | any,
+    handler: (issue: Issue, context: EventContext) => PromiseLike<any> | any,
     eventType: string
   ): CloudFunction<Issue> {
     return makeCloudFunction({

src/providers/database.ts

@@ -103,23 +103,23 @@ export class RefBuilder {
   /** Respond to any write that affects a ref. */
   onWrite(handler: (
     change: Change<DataSnapshot>,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<Change<DataSnapshot>> {
     return this.onOperation(handler, 'ref.write', this.changeConstructor);
   }
 
   /** Respond to update on a ref. */
   onUpdate(handler: (
     change: Change<DataSnapshot>,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<Change<DataSnapshot>> {
     return this.onOperation(handler, 'ref.update', this.changeConstructor);
   }
 
   /** Respond to new data on a ref. */
   onCreate(handler: (
     snapshot: DataSnapshot,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<DataSnapshot> {
     let dataConstructor = (raw: LegacyEvent) => {
       let [dbInstance, path] = resourceToInstanceAndPath(raw.resource);
@@ -136,7 +136,7 @@ export class RefBuilder {
   /** Respond to all data being deleted from a ref. */
   onDelete(handler: (
     snapshot: DataSnapshot,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<DataSnapshot> {
     let dataConstructor = (raw: LegacyEvent) => {
       let [dbInstance, path] = resourceToInstanceAndPath(raw.resource);
@@ -151,7 +151,7 @@ export class RefBuilder {
   }
 
   private onOperation<T>(
-    handler: (data: T, context?: EventContext) => PromiseLike<any> | any,
+    handler: (data: T, context: EventContext) => PromiseLike<any> | any,
     eventType: string,
     dataConstructor: (raw: Event | LegacyEvent) => any): CloudFunction<T> {
 

src/providers/firestore.ts

@@ -136,37 +136,37 @@ export class DocumentBuilder {
   /** Respond to all document writes (creates, updates, or deletes). */
   onWrite(handler: (
     change: Change<DocumentSnapshot>,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<Change<DocumentSnapshot>> {
     return this.onOperation(handler, 'document.write', changeConstructor);
   };
 
   /** Respond only to document updates. */
   onUpdate(handler: (
     change: Change<DocumentSnapshot>,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<Change<DocumentSnapshot>> {
     return this.onOperation(handler, 'document.update', changeConstructor);
   }
 
   /** Respond only to document creations. */
   onCreate(handler: (
     snapshot: DocumentSnapshot,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<DocumentSnapshot> {
     return this.onOperation(handler, 'document.create', snapshotConstructor);
   }
 
   /** Respond only to document deletions. */
   onDelete(handler: (
     snapshot: DocumentSnapshot,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<DocumentSnapshot> {
     return this.onOperation(handler, 'document.delete', beforeSnapshotConstructor);
   }
 
   private onOperation<T>(
-    handler: (data: T, context?: EventContext) => PromiseLike<any> | any,
+    handler: (data: T, context: EventContext) => PromiseLike<any> | any,
     eventType: string,
     dataConstructor: (raw: Event | LegacyEvent) => any): CloudFunction<T> {
     return makeCloudFunction({

src/providers/pubsub.ts

@@ -48,7 +48,7 @@ export class TopicBuilder {
   constructor(private triggerResource: () => string) { }
 
   /** Handle a Pub/Sub message that was published to a Cloud Pub/Sub topic */
-  onPublish(handler: (message: Message, context?: EventContext) => PromiseLike<any> | any): CloudFunction<Message> {
+  onPublish(handler: (message: Message, context: EventContext) => PromiseLike<any> | any): CloudFunction<Message> {
     return makeCloudFunction({
       handler,
       provider,

src/providers/storage.ts

@@ -75,37 +75,37 @@ export class ObjectBuilder {
   /** Respond to archiving of an object, this is only for buckets that enabled object versioning. */
   onArchive(handler: (
     object: ObjectMetadata,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<ObjectMetadata> {
     return this.onOperation(handler, 'object.archive');
   }
 
   /** Respond to the deletion of an object (not to archiving, if object versioning is enabled). */
   onDelete(handler: (
     object: ObjectMetadata,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<ObjectMetadata> {
     return this.onOperation(handler, 'object.delete');
   }
 
   /** Respond to the successful creation of an object. */
   onFinalize(handler: (
     object: ObjectMetadata,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<ObjectMetadata> {
     return this.onOperation(handler, 'object.finalize');
   }
 
   /** Respond to metadata updates of existing objects. */
   onMetadataUpdate(handler: (
     object: ObjectMetadata,
-    context?: EventContext) => PromiseLike<any> | any,
+    context: EventContext) => PromiseLike<any> | any,
   ): CloudFunction<ObjectMetadata> {
     return this.onOperation(handler, 'object.metadataUpdate');
   }
 
   private onOperation(
-    handler: (object: ObjectMetadata, context?: EventContext) => PromiseLike<any> | any,
+    handler: (object: ObjectMetadata, context: EventContext) => PromiseLike<any> | any,
     eventType: string): CloudFunction<ObjectMetadata> {
     return makeCloudFunction({
       handler,