refactor: send webhooks with the @slack/webhook package (#630)

Author: zimeg

.changeset/webhook-trigger-sdk.md

@@ -0,0 +1,5 @@
+---
+"@slack/slack-github-action": patch
+---
+
+refactor: send webhooks with the [`@slack/webhook`](https://docs.slack.dev/tools/node-slack-sdk/webhook) package

package-lock.json

@@ -46,8 +46,7 @@
     "@actions/github": "^9.1.1",
     "@slack/logger": "^4.0.1",
     "@slack/web-api": "^7.16.0",
-    "axios": "^1.18.1",
-    "axios-retry": "^4.5.0",
+    "@slack/webhook": "^7.2.0",
     "flat": "^6.0.1",
     "https-proxy-agent": "^9.0.0",
     "js-yaml": "^5.2.0",

package.json

@@ -1,6 +1,5 @@
-import os from "node:os";
 import webapi from "@slack/web-api";
-import axios from "axios";
+import webhook from "@slack/webhook";
 import packageJson from "../package.json" with { type: "json" };
 import Content from "./content.js";
 import SlackError from "./errors.js";
@@ -60,11 +59,6 @@ export default class Config {
    */
   inputs;
 
-  /**
-   * @type {import("axios").AxiosStatic} - The axios client.
-   */
-  axios;
-
   /**
    * @type {Content} - The parsed payload data to send.
    */
@@ -87,6 +81,11 @@ export default class Config {
    */
   webapi;
 
+  /**
+   * @type {import("@slack/webhook")} - Slack webhook client.
+   */
+  webhook;
+
   /**
    * Gather values from the job inputs and use defaults or error for the missing
    * ones.
@@ -98,10 +97,10 @@ export default class Config {
    * @param {import("@actions/core")} core - GitHub Actions core utilities.
    */
   constructor(core) {
-    this.axios = axios;
     this.core = core;
     this.logger = new Logger(core).logger;
     this.webapi = webapi;
+    this.webhook = webhook;
     this.inputs = {
       api: core.getInput("api"),
       errors: core.getBooleanInput("errors"),
@@ -137,11 +136,10 @@ export default class Config {
       name: packageJson.name,
       version: packageJson.version,
     });
-    this.axios.defaults.headers.common["User-Agent"] =
-      `${packageJson.name.replace("/", ":")}/${packageJson.version} ` +
-      `axios/${this.axios.VERSION} ` +
-      `node/${process.version.replace("v", "")} ` +
-      `${os.platform()}/${os.release()}`;
+    this.webhook.addAppMetadata({
+      name: packageJson.name,
+      version: packageJson.version,
+    });
   }
 
   /**