Add support for Crashlytics-triggered functions (#147)

Author: laurenzlong

spec/index.spec.ts

@@ -40,3 +40,4 @@ import './providers/firestore.spec';
 import './providers/https.spec';
 import './providers/pubsub.spec';
 import './providers/storage.spec';
+import './providers/crashlytics.spec';

spec/providers/crashlytics.spec.ts

@@ -0,0 +1,77 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2017 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+import * as crashlytics from '../../src/providers/crashlytics';
+import { config } from '../../src/index';
+import { apps as appsNamespace } from '../../src/apps';
+import { expect } from 'chai';
+import { fakeConfig } from '../support/helpers';
+
+describe('Crashlytics Functions', () => {
+  before(() => {
+    config.singleton = fakeConfig();
+    appsNamespace.init(config.singleton);
+    process.env.GCLOUD_PROJECT = 'project1';
+  });
+
+  after(() => {
+    delete appsNamespace.singleton;
+    delete config.singleton;
+    delete process.env.GCLOUD_PROJECT;
+  });
+
+  describe('#onNewDetected', () => {
+    it('should return a TriggerDefinition with appropriate values', () => {
+      const cloudFunction = crashlytics.issue().onNewDetected((event) => null);
+      expect(cloudFunction.__trigger).to.deep.equal({
+        eventTrigger: {
+          eventType: 'providers/firebase.crashlytics/eventTypes/issue.new',
+          resource: 'projects/project1',
+        },
+      });
+    });
+  });
+
+  describe('#onRegressed', () => {
+    it('should return a TriggerDefinition with appropriate values', () => {
+      const cloudFunction = crashlytics.issue().onRegressed((event) => null);
+      expect(cloudFunction.__trigger).to.deep.equal({
+        eventTrigger: {
+          eventType: 'providers/firebase.crashlytics/eventTypes/issue.regressed',
+          resource: 'projects/project1',
+        },
+      });
+    });
+  });
+
+  describe('#onVelocityAlert', () => {
+    it('should return a TriggerDefinition with appropriate values', () => {
+      const cloudFunction = crashlytics.issue().onVelocityAlert((event) => null);
+      expect(cloudFunction.__trigger).to.deep.equal({
+        eventTrigger: {
+          eventType: 'providers/firebase.crashlytics/eventTypes/issue.velocityAlert',
+          resource: 'projects/project1',
+        },
+      });
+    });
+  });
+});

src/index.ts

@@ -23,12 +23,13 @@
 // Providers:
 import * as analytics from './providers/analytics';
 import * as auth from './providers/auth';
+import * as crashlytics from './providers/crashlytics';
 import * as database from './providers/database';
 import * as firestore from './providers/firestore';
 import * as https from './providers/https';
 import * as pubsub from './providers/pubsub';
 import * as storage from './providers/storage';
-export { analytics, auth, database, firestore, https, pubsub, storage };
+export { analytics, auth, crashlytics, database, firestore, https, pubsub, storage };
 
 // Exported root types:
 export * from './config';

src/providers/crashlytics.ts

@@ -0,0 +1,121 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2017 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+import { makeCloudFunction, CloudFunction, Event } from '../cloud-functions';
+
+/** @internal */
+export const provider = 'firebase.crashlytics';
+
+/** 
+ * Handle events related to Crashlytics issues. An issue in Crashlytics is an 
+ * aggregation of crashes which have a shared root cause.
+ */
+export function issue() {
+  return new IssueBuilder('projects/' + process.env.GCLOUD_PROJECT);
+}
+
+/** Builder used to create Cloud Functions for Crashlytics issue events. */
+export class IssueBuilder {
+  /** @internal */
+  constructor(private resource: string) { }
+
+  /** Handle Crashlytics New Issue events. */
+  onNewDetected(handler: (event: Event<Issue>) => PromiseLike<any> | any
+    ): CloudFunction<Issue> {
+    return makeCloudFunction({
+      provider, handler,
+      resource: this.resource,
+      eventType: 'issue.new',
+    });
+  }
+
+  /** Handle Crashlytics Regressed Issue events. */
+  onRegressed(handler: (event: Event<Issue>) => PromiseLike<any> | any
+  ): CloudFunction<Issue> {
+    return makeCloudFunction({
+      provider, handler,
+      resource: this.resource,
+      eventType: 'issue.regressed',
+    });
+  }
+
+  /** Handle Crashlytics Velocity Alert events. */
+  onVelocityAlert(handler: (event: Event<Issue>) => PromiseLike<any> | any
+  ): CloudFunction<Issue> {
+    return makeCloudFunction({
+      provider, handler,
+      resource: this.resource,
+      eventType: 'issue.velocityAlert',
+    });
+  }
+}
+
+/**
+ * Interface representing a Crashlytics issue event that was logged for a specific issue.
+ */
+export class Issue {
+  /** Fabric Issue ID. */
+  issueId: string;
+
+  /** Issue title. */
+  issueTitle: string;
+
+  /** App information. */
+  appInfo: AppInfo;
+
+  /** When the issue was created (ISO8601 time stamp). */
+  createTime: string;
+
+  /** When the issue was resolved, if the issue has been resolved (ISO8601 time stamp). */
+  resolvedTime?: string;
+
+  /** Contains details about the velocity alert, if this event was triggered by a velocity alert. */
+  velocityAlert?: VelocityAlert;
+}
+
+export class VelocityAlert {
+  /** The percentage of sessions which have been impacted by this issue. Example: .04 */
+  crashPercentage: number;
+
+  /** The number of crashes that this issue has caused. */
+  crashes: number;
+}
+
+/**
+ * Interface representing the application where this issue occurred.
+ */
+export interface AppInfo {
+  /** The app's name. Example: "My Awesome App". */
+  appName: string;
+
+  /** The app's platform. Examples: "android", "ios". */
+  appPlatform: string;
+
+  /** Unique application identifier within an app store, either the Android package name or the iOS bundle id. */
+  appId: string;
+
+  /**
+   *  The latest app version which is affected by the issue.
+   *  Examples: "1.0", "4.3.1.1.213361", "2.3 (1824253)", "v1.8b22p6".
+   */
+  latestAppVersion: string;
+}