feat(apps): handle status webhook events from github

Process and store statuses from github pull requests.

Author: josephperrott

apps/functions/githubWebhook/BUILD.bazel

@@ -12,6 +12,7 @@ ts_library(
     ],
     deps = [
         ":webhooks",
+        "@npm//@octokit/webhooks-types",
         "@npm//firebase-admin",
         "@npm//firebase-functions",
     ],
@@ -21,6 +22,7 @@ ts_library(
     name = "webhooks",
     srcs = [
         "pull-request.ts",
+        "status.ts",
     ],
     deps = [
         "//apps/shared/models:server",

apps/functions/githubWebhook/index.ts

@@ -1,6 +1,8 @@
 import * as functions from 'firebase-functions';
 import * as admin from 'firebase-admin';
 import {handlePullRequestEvent} from './pull-request';
+import {handleStatusEvent} from './status';
+import {StatusEvent} from '@octokit/webhooks-types';
 
 admin.initializeApp({...functions.firebaseConfig()});
 
@@ -30,5 +32,15 @@ export const githubWebhook = functions
       return;
     }
 
+    if (request.get('X-GitHub-Event') === 'status') {
+      const statusEvent = request.body as StatusEvent;
+      await handleStatusEvent(statusEvent);
+      response.send(
+        `Handled status update for status for commit ${statusEvent.sha} with the context ${statusEvent.context}`,
+      );
+      response.end();
+      return;
+    }
+
     response.end();
   });

apps/functions/githubWebhook/status.ts

@@ -0,0 +1,20 @@
+import {StatusEvent} from '@octokit/webhooks-types';
+import {firestore} from 'firebase-admin';
+// TODO(josephperrott): Remove usage of FirestoreReference and fromFirestoreReference.
+import {
+  Status,
+  FirestoreReference,
+  fromFirestoreReference,
+} from '../../shared/models/server-models';
+
+export async function handleStatusEvent(event: StatusEvent) {
+  const {getFirestoreRefForGithubModel, fromGithub} = Status.getGithubHelpers();
+  /** The pull request model for the pull request status data. */
+  const status = fromGithub(event);
+  /** FirestoreReference for the pull request status. */
+  const firestoreRef = getFirestoreRefForGithubModel(event) as FirestoreReference<Status>;
+  /** The Firestore document reference for the pull request status. */
+  const docRef = firestore().doc(fromFirestoreReference(firestoreRef));
+
+  await docRef.set(Status.getConverter().toFirestore(status));
+}

apps/shared/models/server-models.ts

@@ -50,7 +50,7 @@ function forServer<
   /**
    * Gets the model referenced by the provided FirestoreReference.
    */
-  model.prototype.getByReference = function (ref: FirestoreReference<TBase>) {
+  model.prototype.getByReference = async function (ref: FirestoreReference<TBase>) {
     return firestore().doc(fromFirestoreReference(ref)).withConverter(converter);
   };
 
@@ -64,9 +64,7 @@ function forServer<
           return new model(staticModel.githubHelpers.fromGithub(githubModel));
         },
         getFirestoreRefForGithubModel(githubModel: GithubModel) {
-          return firestore().doc(
-            fromFirestoreReference(staticModel.githubHelpers.buildRefString(githubModel)),
-          );
+          return fromFirestoreReference(staticModel.githubHelpers.buildRefString(githubModel));
         },
       };
     };

apps/shared/models/status.ts

@@ -14,7 +14,9 @@ export class Status extends GithubBaseModel<FirestoreStatus> {
 
   static override githubHelpers: GithubHelperFunctions<Status, StatusEvent, FirestoreStatus> = {
     buildRefString(model: StatusEvent) {
-      return toFirestoreReference(`githubCommit/${model.sha}/status/${model.context}`);
+      return toFirestoreReference(
+        `githubCommit/${model.sha}/status/${model.context.replace(/[:/\s]/g, '_')}`,
+      );
     },
     fromGithub(model: StatusEvent) {
       return {