Merge branch 'colerogers.alerts' into colerogers.billing

Author: colerogers

spec/v2/providers/alerts/alerts.spec.ts

@@ -1,19 +1,11 @@
 import { expect } from 'chai';
-import { CloudEvent, CloudFunction } from '../../../../src/v2/core';
 import * as options from '../../../../src/v2/options';
 import * as alerts from '../../../../src/v2/providers/alerts';
 import { FULL_ENDPOINT, FULL_OPTIONS } from '../helpers';
 
 const ALERT_TYPE = 'new-alert-type';
 const APPID = '123456789';
 
-function getMockFunction(): CloudFunction<alerts.FirebaseAlertData<String>> {
- const func = (raw: CloudEvent<unknown>) => 42;
- func.run = (event: CloudEvent<alerts.FirebaseAlertData<String>>) => 42;
- func.__endpoint = {};
- return func;
-}
-
 describe('alerts', () => {
  describe('onAlertPublished', () => {
  it('should create the function without opts', () => {
@@ -75,11 +67,7 @@ describe('alerts', () => {
  });
 
  it('should define the endpoint without appId and opts', () => {
- const func = getMockFunction();
-
- func.__endpoint = alerts.getEndpointAnnotation({}, ALERT_TYPE);
-
- expect(func.__endpoint).to.deep.equal({
+ expect(alerts.getEndpointAnnotation({}, ALERT_TYPE)).to.deep.equal({
  platform: 'gcfv2',
  labels: {},
  eventTrigger: {
@@ -93,14 +81,9 @@ describe('alerts', () => {
  });
 
  it('should define a complex endpoint without appId', () => {
- const func = getMockFunction();
-
- func.__endpoint = alerts.getEndpointAnnotation(
- { ...FULL_OPTIONS },
- ALERT_TYPE
- );
-
- expect(func.__endpoint).to.deep.equal({
+ expect(
+ alerts.getEndpointAnnotation({ ...FULL_OPTIONS }, ALERT_TYPE)
+ ).to.deep.equal({
  ...FULL_ENDPOINT,
  eventTrigger: {
  eventType: alerts.eventType,
@@ -113,15 +96,9 @@ describe('alerts', () => {
  });
 
  it('should define a complex endpoint', () => {
- const func = getMockFunction();
-
- func.__endpoint = alerts.getEndpointAnnotation(
- { ...FULL_OPTIONS },
- ALERT_TYPE,
- APPID
- );
-
- expect(func.__endpoint).to.deep.equal({
+ expect(
+ alerts.getEndpointAnnotation({ ...FULL_OPTIONS }, ALERT_TYPE, APPID)
+ ).to.deep.equal({
  ...FULL_ENDPOINT,
  eventTrigger: {
  eventType: alerts.eventType,
@@ -144,15 +121,10 @@ describe('alerts', () => {
  region: 'us-west1',
  minInstances: 3,
  };
- const func = getMockFunction();
-
- func.__endpoint = alerts.getEndpointAnnotation(
- specificOpts,
- ALERT_TYPE,
- APPID
- );
 
- expect(func.__endpoint).to.deep.equal({
+ expect(
+ alerts.getEndpointAnnotation(specificOpts, ALERT_TYPE, APPID)
+ ).to.deep.equal({
  platform: 'gcfv2',
  labels: {},
  concurrency: 20,

src/v2/providers/alerts/alerts.ts

@@ -3,7 +3,7 @@ import { CloudEvent, CloudFunction } from '../../core';
 import * as options from '../../options';
 
 /**
- * The data object that is emitted from Firebase Alerts inside the CloudEvent
+ * The CloudEvent data emitted by Firebase Alerts.
  */
 export interface FirebaseAlertData<T = any> {
  createTime: string;
@@ -16,7 +16,7 @@ interface WithAlertTypeAndApp {
  appId?: string;
 }
 /**
- * A custom CloudEvent for Firebase Alerts with custom extension attributes defined
+ * A custom CloudEvent for Firebase Alerts (with custom extension attributes).
  */
 export type AlertEvent<T> = CloudEvent<
  FirebaseAlertData<T>,
@@ -26,7 +26,7 @@ export type AlertEvent<T> = CloudEvent<
 /** @internal */
 export const eventType = 'firebase.firebasealerts.alerts.v1.published';
 
-/** The underlying alert type of the Firebase Alerts provider */
+/** The underlying alert type of the Firebase Alerts provider. */
 export type AlertType =
  | 'crashlytics.newFatalIssue'
  | 'crashlytics.newNonfatalIssue'
@@ -40,17 +40,17 @@ export type AlertType =
  | string;
 
 /**
- * Configuration for Firebase Alert functions
+ * Configuration for Firebase Alert functions.
  */
 export interface FirebaseAlertOptions extends options.EventHandlerOptions {
  alertType: AlertType;
  appId?: string;
 }
 
 /**
- * Declares a function that can handle Firebase Alerts from CloudEvents
- * @param alertTypeOrOpts the alert type or Firebase Alert function configuration
- * @param handler a function that can handle the Firebase Alert inside a CloudEvent
+ * Declares a function that can handle Firebase Alerts from CloudEvents.
+ * @param alertTypeOrOpts the alert type or Firebase Alert function configuration.
+ * @param handler a function that can handle the Firebase Alert inside a CloudEvent.
  */
 export function onAlertPublished<T extends { ['@type']: string } = any>(
  alertTypeOrOpts: AlertType | FirebaseAlertOptions,
@@ -72,7 +72,7 @@ export function onAlertPublished<T extends { ['@type']: string } = any>(
 
 /**
  * @internal
- * Helper function for getting the endpoint annotation used in alert handling functions
+ * Helper function for getting the endpoint annotation used in alert handling functions.
  */
 export function getEndpointAnnotation(
  opts: options.EventHandlerOptions,
@@ -105,7 +105,7 @@ export function getEndpointAnnotation(
 
 /**
  * @internal
- * Helper function to parse the function opts, alert type, and appId
+ * Helper function to parse the function opts, alert type, and appId.
  */
 export function getOptsAndAlertTypeAndApp(
  alertTypeOrOpts: AlertType | FirebaseAlertOptions