[FAI-7161] Add getWebhookEvent to faros client for use by Hermes lamb…

…da worker (#158)

src/client.ts

@@ -22,7 +22,8 @@ import {
   Phantom,
   SecretName,
   UpdateAccount,
-  WebhookEventStatus,
+  UpdateWebhookEventStatus,
+  WebhookEvent,
 } from './types';
 import {Utils} from './utils';
 
@@ -434,7 +435,9 @@ export class FarosClient {
     };
   }
 
-  async updateWebhookEventStatus(status: WebhookEventStatus): Promise<void> {
+  async updateWebhookEventStatus(
+    status: UpdateWebhookEventStatus
+  ): Promise<void> {
     try {
       await this.api.patch(
         `/webhooks/${status.webhookId}/events/${status.eventId}`,
@@ -451,4 +454,28 @@ export class FarosClient {
       );
     }
   }
+
+  async getWebhookEvent(
+    webhookId: string,
+    eventId: string
+  ): Promise<WebhookEvent> {
+    try {
+      const response = await this.api.get(
+        `/webhooks/${webhookId}/events/${eventId}`
+      );
+      let event = response.data;
+      event = {
+        ...event,
+        createdAt: event.createdAt ? new Date(event.createdAt) : undefined,
+        receivedAt: new Date(event.receivedAt),
+        updatedAt: new Date(event.updatedAt),
+      };
+      return event as WebhookEvent;
+    } catch (err: any) {
+      throw wrapApiError(
+        err,
+        `unable to retrieve event: ${eventId} for webhook: ${webhookId}`
+      );
+    }
+  }
 }

src/types.ts

@@ -82,9 +82,27 @@ export interface Model {
   dataSchema: any;
 }
 
-export interface WebhookEventStatus {
+export interface UpdateWebhookEventStatus {
   webhookId: string;
   eventId: string;
   status: string;
   error?: string;
 }
+
+export interface WebhookEvent {
+  id: string;
+  name: string;
+  webhookId: string;
+  event: any;
+  status: WebhookEventStatus;
+  error?: string;
+  createdAt?: Date;
+  receivedAt: Date;
+  updatedAt: Date;
+}
+
+export enum WebhookEventStatus {
+  Pending = 'Pending',
+  Ok = 'OK',
+  Error = 'Error',
+}

test/client.test.ts

@@ -2,7 +2,7 @@ import nock from 'nock';
 
 import {FarosClient, FarosClientConfig, Schema} from '../src';
 import {GRAPH_VERSION_HEADER} from '../src/client';
-import {Phantom} from '../src/types';
+import {Phantom, WebhookEvent, WebhookEventStatus} from '../src/types';
 
 const apiUrl = 'https://test.faros.ai';
 const clientConfig = {url: apiUrl, apiKey: 'test-key'};
@@ -481,4 +481,33 @@ describe('client', () => {
     });
     mock.done();
   });
+
+  test('get webhook event', async () => {
+    const webhookId = 'testWebhookId';
+    const eventId = 'testEventId';
+    const now = new Date();
+    const mockReplyEvent: WebhookEvent = {
+      id: eventId,
+      webhookId,
+      event: {
+        eventType: 'push',
+        commit: {
+          sha: '0xdeadbeef'
+        }
+      },
+      name: 'push',
+      status: WebhookEventStatus.Pending,
+      createdAt: now,
+      receivedAt: now,
+      updatedAt: now,
+    };
+
+    const mock = nock(apiUrl)
+      .get(`/webhooks/${webhookId}/events/${eventId}`)
+      .reply(200, mockReplyEvent);
+
+    const event = await client.getWebhookEvent(webhookId, eventId);
+    expect(event).toEqual(mockReplyEvent);
+    mock.done();
+  });
 });