feat: add hawk-worker-webhook service and update package.json

Author: Dobrunia

docker-compose.dev.yml

@@ -158,6 +158,18 @@ services:
       - ./:/usr/src/app
       - workers-deps:/usr/src/app/node_modules
 
+  hawk-worker-webhook:
+    build:
+      dockerfile: "dev.Dockerfile"
+      context: .
+    env_file:
+      - .env
+    restart: unless-stopped
+    entrypoint: yarn run-webhook
+    volumes:
+      - ./:/usr/src/app
+      - workers-deps:/usr/src/app/node_modules
+
 volumes:
   workers-deps:
 

package.json

@@ -1,7 +1,7 @@
 {
     "name": "hawk.workers",
     "private": true,
-    "version": "0.1.2",
+    "version": "0.1.3",
     "description": "Hawk workers",
     "repository": "git@github.com:codex-team/hawk.workers.git",
     "license": "BUSL-1.1",
@@ -49,13 +49,14 @@
         "run-email": "yarn worker hawk-worker-email",
         "run-telegram": "yarn worker hawk-worker-telegram",
         "run-limiter": "yarn worker hawk-worker-limiter",
-        "run-task-manager": "yarn worker hawk-worker-task-manager"
+        "run-task-manager": "yarn worker hawk-worker-task-manager",
+        "run-webhook": "yarn worker hawk-worker-webhook"
     },
     "dependencies": {
         "@babel/parser": "^7.26.9",
         "@babel/traverse": "7.26.9",
         "@hawk.so/nodejs": "^3.1.1",
-        "@hawk.so/types": "^0.5.7",
+        "@hawk.so/types": "^0.5.9",
         "@types/amqplib": "^0.8.2",
         "@types/jest": "^29.5.14",
         "@types/mongodb": "^3.5.15",

workers/notifier/types/channel.ts

@@ -6,6 +6,7 @@ export enum ChannelType {
   Telegram = 'telegram',
   Slack = 'slack',
   Loop = 'loop',
+  Webhook = 'webhook',
 }
 
 /**

workers/webhook/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "hawk-worker-webhook",
+  "version": "1.0.0",
+  "description": "Webhook sender worker — delivers event notifications as JSON POST requests",
+  "main": "src/index.ts",
+  "license": "MIT",
+  "workerType": "sender/webhook",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

workers/webhook/src/deliverer.ts

@@ -0,0 +1,53 @@
+import { createLogger, format, Logger, transports } from 'winston';
+import { WebhookPayload } from '../types/template';
+
+/**
+ * Deliverer sends JSON POST requests to external webhook endpoints
+ */
+export default class WebhookDeliverer {
+  /**
+   * Logger module
+   * (default level='info')
+   */
+  private logger: Logger = createLogger({
+    level: process.env.LOG_LEVEL || 'info',
+    transports: [
+      new transports.Console({
+        format: format.combine(
+          format.timestamp(),
+          format.colorize(),
+          format.simple(),
+          format.printf((msg) => `${msg.timestamp} - ${msg.level}: ${msg.message}`)
+        ),
+      }),
+    ],
+  });
+
+  /**
+   * Sends JSON payload to the webhook endpoint via HTTP POST
+   *
+   * @param endpoint - URL to POST to
+   * @param payload - JSON body to send
+   */
+  public async deliver(endpoint: string, payload: WebhookPayload): Promise<void> {
+    const body = JSON.stringify(payload);
+
+    try {
+      const response = await fetch(endpoint, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          'User-Agent': 'Hawk-Webhook/1.0',
+        },
+        body,
+        signal: AbortSignal.timeout(10_000),
+      });
+
+      if (!response.ok) {
+        this.logger.log('error', `Webhook delivery failed: ${response.status} ${response.statusText} for ${endpoint}`);
+      }
+    } catch (e) {
+      this.logger.log('error', `Can't deliver webhook to ${endpoint}: `, e);
+    }
+  }
+}

workers/webhook/src/index.ts

@@ -0,0 +1,24 @@
+import * as pkg from './../package.json';
+import WebhookProvider from './provider';
+import SenderWorker from 'hawk-worker-sender/src';
+import { ChannelType } from 'hawk-worker-notifier/types/channel';
+
+/**
+ * Worker to send webhook notifications
+ */
+export default class WebhookSenderWorker extends SenderWorker {
+  /**
+   * Worker type
+   */
+  public readonly type: string = pkg.workerType;
+
+  /**
+   * Webhook channel type
+   */
+  protected channelType = ChannelType.Webhook;
+
+  /**
+   * Webhook provider
+   */
+  protected provider = new WebhookProvider();
+}

workers/webhook/src/provider.ts

@@ -0,0 +1,41 @@
+import NotificationsProvider from 'hawk-worker-sender/src/provider';
+import { Notification, EventsTemplateVariables } from 'hawk-worker-sender/types/template-variables';
+import templates from './templates';
+import { WebhookPayload } from '../types/template';
+import WebhookDeliverer from './deliverer';
+
+/**
+ * This class provides a 'send' method that renders and sends a webhook notification
+ */
+export default class WebhookProvider extends NotificationsProvider {
+  /**
+   * Class with the 'deliver' method for sending HTTP POST requests
+   */
+  private readonly deliverer: WebhookDeliverer;
+
+  constructor() {
+    super();
+
+    this.deliverer = new WebhookDeliverer();
+  }
+
+  /**
+   * Send webhook notification to recipient
+   *
+   * @param to - recipient endpoint URL
+   * @param notification - notification with payload and type
+   */
+  public async send(to: string, notification: Notification): Promise<void> {
+    let template: (tplData: EventsTemplateVariables) => WebhookPayload;
+
+    switch (notification.type) {
+      case 'event': template = templates.EventTpl; break;
+      case 'several-events': template = templates.SeveralEventsTpl; break;
+      default: return;
+    }
+
+    const payload = template(notification.payload as EventsTemplateVariables);
+
+    await this.deliverer.deliver(to, payload);
+  }
+}

workers/webhook/src/templates/event.ts

@@ -0,0 +1,38 @@
+import type { EventsTemplateVariables, TemplateEventData } from 'hawk-worker-sender/types/template-variables';
+import { WebhookPayload } from '../../types/template';
+
+/**
+ * Builds webhook JSON payload for a single event notification
+ *
+ * @param tplData - event template data
+ */
+export default function render(tplData: EventsTemplateVariables): WebhookPayload {
+  const eventInfo = tplData.events[0] as TemplateEventData;
+  const event = eventInfo.event;
+  const eventURL = tplData.host + '/project/' + tplData.project._id + '/event/' + event._id + '/';
+
+  let location: string | null = null;
+
+  if (event.payload.backtrace && event.payload.backtrace.length > 0 && event.payload.backtrace[0].file) {
+    location = event.payload.backtrace[0].file;
+  }
+
+  return {
+    type: 'event',
+    project: {
+      id: tplData.project._id.toString(),
+      name: tplData.project.name,
+    },
+    events: [
+      {
+        id: event._id.toString(),
+        title: event.payload.title,
+        newCount: eventInfo.newCount,
+        totalCount: event.totalCount,
+        url: eventURL,
+        location,
+        daysRepeated: eventInfo.daysRepeated,
+      },
+    ],
+  };
+}

workers/webhook/src/templates/index.ts

@@ -0,0 +1,7 @@
+import EventTpl from './event';
+import SeveralEventsTpl from './several-events';
+
+export default {
+  EventTpl,
+  SeveralEventsTpl,
+};

workers/webhook/src/templates/several-events.ts

@@ -0,0 +1,40 @@
+import type { EventsTemplateVariables } from 'hawk-worker-sender/types/template-variables';
+import { WebhookPayload } from '../../types/template';
+
+/**
+ * Builds webhook JSON payload for a several-events notification
+ *
+ * @param tplData - event template data
+ */
+export default function render(tplData: EventsTemplateVariables): WebhookPayload {
+  const projectUrl = tplData.host + '/project/' + tplData.project._id;
+
+  return {
+    type: 'several-events',
+    project: {
+      id: tplData.project._id.toString(),
+      name: tplData.project.name,
+      url: projectUrl,
+    },
+    events: tplData.events.map(({ event, newCount, daysRepeated }) => {
+      const eventURL = tplData.host + '/project/' + tplData.project._id + '/event/' + event._id + '/';
+
+      let location: string | null = null;
+
+      if (event.payload.backtrace && event.payload.backtrace.length > 0 && event.payload.backtrace[0].file) {
+        location = event.payload.backtrace[0].file;
+      }
+
+      return {
+        id: event._id.toString(),
+        title: event.payload.title,
+        newCount,
+        totalCount: event.totalCount,
+        url: eventURL,
+        location,
+        daysRepeated,
+      };
+    }),
+    period: tplData.period,
+  };
+}