jackson/npm/src/directory-sync/scim/WebhookEventsLogger.ts

import { randomUUID } from 'crypto';

import type {
  Directory,
  DatabaseStore,
  WebhookEventLog,
  DirectorySyncEvent,
  PaginationParams,
} from '../../typings';
import { Base } from './Base';
import { webhookEventTTL } from '../utils';

type GetAllParams = PaginationParams & {
  directoryId?: string;
};

/**
 * @swagger
 * definitions:
 *    Event:
 *      type: object
 *      example:
 *        {
 *           "id": "id1",
 *           "webhook_endpoint": "https://example.com/webhook",
 *           "created_at": "2024-03-05T17:06:26.074Z",
 *           "status_code": 200,
 *           "delivered": true,
 *           "payload": {
 *             "directory_id": "58b5cd9dfaa39d47eb8f5f88631f9a629a232016",
 *             "event": "user.created",
 *             "tenant": "boxyhq",
 *             "product": "jackson",
 *             "data": {
 *               "id": "038e767b-9bc6-4dbd-975e-fbc38a8e7d82",
 *               "first_name": "Deepak",
 *               "last_name": "Prabhakara",
 *               "email": "deepak@boxyhq.com",
 *               "active": true,
 *               "raw": {
 *                 "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
 *                 "userName": "deepak@boxyhq.com",
 *                 "name": {
 *                   "givenName": "Deepak",
 *                   "familyName": "Prabhakara"
 *                 },
 *                 "emails": [
 *                   {
 *                    "primary": true,
 *                     "value": "deepak@boxyhq.com",
 *                     "type": "work"
 *                   }
 *                ],
 *                 "title": "CEO",
 *                 "displayName": "Deepak Prabhakara",
 *                 "locale": "en-US",
 *                 "externalId": "00u1ldzzogFkXFmvT5d7",
 *                 "groups": [],
 *                 "active": true,
 *                 "id": "038e767b-9bc6-4dbd-975e-fbc38a8e7d82"
 *               }
 *             }
 *           }
 *        }
 */
export class WebhookEventsLogger extends Base {
  constructor({ db }: { db: DatabaseStore }) {
    super({ db });
  }

  public async log(directory: Directory, event: DirectorySyncEvent | DirectorySyncEvent[], status: number) {
    const id = randomUUID();

    const log: WebhookEventLog = {
      id,
      payload: event,
      webhook_endpoint: directory.webhook.endpoint,
      created_at: new Date(),
      status_code: status,
      delivered: status === 200,
    };

    await this.eventStore().put(id, log, {
      name: 'directoryId',
      value: directory.id,
    });

    return log;
  }

  public async get(id: string): Promise<WebhookEventLog> {
    return await this.eventStore().get(id);
  }

  /**
   * @swagger
   * /api/v1/dsync/events:
   *   get:
   *     summary: Get event logs for a directory
   *     parameters:
   *       - $ref: '#/parameters/directoryId'
   *       - $ref: '#/parameters/pageOffset'
   *       - $ref: '#/parameters/pageLimit'
   *       - $ref: '#/parameters/pageToken'
   *     tags:
   *       - Directory Sync
   *     produces:
   *       - application/json
   *     responses:
   *       200:
   *         description: Success
   *         content:
   *           application/json:
   *              schema:
   *                type: object
   *                properties:
   *                  data:
   *                    type: array
   *                    items:
   *                      $ref: '#/definitions/Event'
   *                  pageToken:
   *                    type: string
   *                    description: token for pagination
   */
  // Get the event logs for a directory paginated
  public async getAll(params: GetAllParams = {}) {
    const { pageOffset, pageLimit, directoryId } = params;

    let eventLogs: WebhookEventLog[] = [];

    if (directoryId) {
      const index = {
        name: 'directoryId',
        value: directoryId,
      };

      eventLogs = (await this.eventStore().getByIndex(index, pageOffset, pageLimit)).data;
    } else {
      eventLogs = (await this.eventStore().getAll(pageOffset, pageLimit)).data;
    }

    return eventLogs;
  }

  public async delete(id: string) {
    await this.eventStore().delete(id);
  }

  // Delete all event logs for a directory
  async deleteAll(directoryId: string) {
    const index = {
      name: 'directoryId',
      value: directoryId,
    };

    // eslint-disable-next-line no-constant-condition
    while (true) {
      const { data: events } = await this.eventStore().getByIndex(index, 0, this.bulkDeleteBatchSize);

      if (!events || events.length === 0) {
        break;
      }

      await this.eventStore().deleteMany(events.map((event) => event.id));
    }
  }

  // Get the store for the events
  private eventStore() {
    return this.store('logs', webhookEventTTL);
  }
}