refactor: switch from Fetch API to Axios (#1520)

* refactor: switch from Fetch API to Axios

* fix: remove unwanted changes

* fix: rewrite error handling for Axios and remove IPv4 first setting

* style: run prettier

* style: run prettier

* fix: add back custom proxy agent

* fix: add back custom proxy agent

* fix: correct rebase issue

* fix: resolve review comments

server/lib/notifications/agents/discord.ts

@@ -4,6 +4,7 @@ import { User } from '@server/entity/User';
 import type { NotificationAgentDiscord } from '@server/lib/settings';
 import { getSettings, NotificationAgentKey } from '@server/lib/settings';
 import logger from '@server/logger';
+import axios from 'axios';
 import {
   hasNotificationType,
   Notification,
@@ -297,39 +298,23 @@ class DiscordAgent
         userMentions.push(`<@&${settings.options.webhookRoleId}>`);
       }
 
-      const response = await fetch(settings.options.webhookUrl, {
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/json',
-        },
-        body: JSON.stringify({
-          username: settings.options.botUsername
-            ? settings.options.botUsername
-            : getSettings().main.applicationTitle,
-          avatar_url: settings.options.botAvatarUrl,
-          embeds: [this.buildEmbed(type, payload)],
-          content: userMentions.join(' '),
-        } as DiscordWebhookPayload),
-      });
-      if (!response.ok) {
-        throw new Error(response.statusText, { cause: response });
-      }
+      await axios.post(settings.options.webhookUrl, {
+        username: settings.options.botUsername
+          ? settings.options.botUsername
+          : getSettings().main.applicationTitle,
+        avatar_url: settings.options.botAvatarUrl,
+        embeds: [this.buildEmbed(type, payload)],
+        content: userMentions.join(' '),
+      } as DiscordWebhookPayload);
 
       return true;
     } catch (e) {
-      let errorData;
-      try {
-        errorData = await e.cause?.text();
-        errorData = JSON.parse(errorData);
-      } catch {
-        /* empty */
-      }
       logger.error('Error sending Discord notification', {
         label: 'Notifications',
         type: Notification[type],
         subject: payload.subject,
         errorMessage: e.message,
-        response: errorData,
+        response: e?.response?.data,
       });
 
       return false;

server/lib/notifications/agents/gotify.ts

@@ -2,6 +2,7 @@ import { IssueStatus, IssueTypeName } from '@server/constants/issue';
 import type { NotificationAgentGotify } from '@server/lib/settings';
 import { getSettings } from '@server/lib/settings';
 import logger from '@server/logger';
+import axios from 'axios';
 import { hasNotificationType, Notification } from '..';
 import type { NotificationAgent, NotificationPayload } from './agent';
 import { BaseAgent } from './agent';
@@ -139,32 +140,16 @@ class GotifyAgent
       const endpoint = `${settings.options.url}/message?token=${settings.options.token}`;
       const notificationPayload = this.getNotificationPayload(type, payload);
 
-      const response = await fetch(endpoint, {
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/json',
-        },
-        body: JSON.stringify(notificationPayload),
-      });
-      if (!response.ok) {
-        throw new Error(response.statusText, { cause: response });
-      }
+      await axios.post(endpoint, notificationPayload);
 
       return true;
     } catch (e) {
-      let errorData;
-      try {
-        errorData = await e.cause?.text();
-        errorData = JSON.parse(errorData);
-      } catch {
-        /* empty */
-      }
       logger.error('Error sending Gotify notification', {
         label: 'Notifications',
         type: Notification[type],
         subject: payload.subject,
         errorMessage: e.message,
-        response: errorData,
+        response: e?.response?.data,
       });
 
       return false;

server/lib/notifications/agents/lunasea.ts

@@ -3,6 +3,7 @@ import { MediaStatus } from '@server/constants/media';
 import type { NotificationAgentLunaSea } from '@server/lib/settings';
 import { getSettings } from '@server/lib/settings';
 import logger from '@server/logger';
+import axios from 'axios';
 import { hasNotificationType, Notification } from '..';
 import type { NotificationAgent, NotificationPayload } from './agent';
 import { BaseAgent } from './agent';
@@ -100,39 +101,28 @@ class LunaSeaAgent
     });
 
     try {
-      const response = await fetch(settings.options.webhookUrl, {
-        method: 'POST',
-        headers: settings.options.profileName
+      await axios.post(
+        settings.options.webhookUrl,
+        this.buildPayload(type, payload),
+        settings.options.profileName
           ? {
-              'Content-Type': 'application/json',
+              headers: {
+                Authorization: `Basic ${Buffer.from(
+                  `${settings.options.profileName}:`
+                ).toString('base64')}`,
+              },
             }
-          : {
-              'Content-Type': 'application/json',
-              Authorization: `Basic ${Buffer.from(
-                `${settings.options.profileName}:`
-              ).toString('base64')}`,
-            },
-        body: JSON.stringify(this.buildPayload(type, payload)),
-      });
-      if (!response.ok) {
-        throw new Error(response.statusText, { cause: response });
-      }
+          : undefined
+      );
 
       return true;
     } catch (e) {
-      let errorData;
-      try {
-        errorData = await e.cause?.text();
-        errorData = JSON.parse(errorData);
-      } catch {
-        /* empty */
-      }
       logger.error('Error sending LunaSea notification', {
         label: 'Notifications',
         type: Notification[type],
         subject: payload.subject,
         errorMessage: e.message,
-        response: errorData,
+        response: e?.response?.data,
       });
 
       return false;

server/lib/notifications/agents/pushbullet.ts

@@ -5,6 +5,7 @@ import { User } from '@server/entity/User';
 import type { NotificationAgentPushbullet } from '@server/lib/settings';
 import { getSettings, NotificationAgentKey } from '@server/lib/settings';
 import logger from '@server/logger';
+import axios from 'axios';
 import {
   hasNotificationType,
   Notification,
@@ -122,34 +123,22 @@ class PushbulletAgent
       });
 
       try {
-        const response = await fetch(endpoint, {
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/json',
-            'Access-Token': settings.options.accessToken,
-          },
-          body: JSON.stringify({
-            ...notificationPayload,
-            channel_tag: settings.options.channelTag,
-          }),
-        });
-        if (!response.ok) {
-          throw new Error(response.statusText, { cause: response });
-        }
+        await axios.post(
+          endpoint,
+          { ...notificationPayload, channel_tag: settings.options.channelTag },
+          {
+            headers: {
+              'Access-Token': settings.options.accessToken,
+            },
+          }
+        );
       } catch (e) {
-        let errorData;
-        try {
-          errorData = await e.cause?.text();
-          errorData = JSON.parse(errorData);
-        } catch {
-          /* empty */
-        }
         logger.error('Error sending Pushbullet notification', {
           label: 'Notifications',
           type: Notification[type],
           subject: payload.subject,
           errorMessage: e.message,
-          response: errorData,
+          response: e.response?.data,
         });
 
         return false;
@@ -174,32 +163,19 @@ class PushbulletAgent
         });
 
         try {
-          const response = await fetch(endpoint, {
-            method: 'POST',
+          await axios.post(endpoint, notificationPayload, {
             headers: {
-              'Content-Type': 'application/json',
               'Access-Token': payload.notifyUser.settings.pushbulletAccessToken,
             },
-            body: JSON.stringify(notificationPayload),
           });
-          if (!response.ok) {
-            throw new Error(response.statusText, { cause: response });
-          }
         } catch (e) {
-          let errorData;
-          try {
-            errorData = await e.cause?.text();
-            errorData = JSON.parse(errorData);
-          } catch {
-            /* empty */
-          }
           logger.error('Error sending Pushbullet notification', {
             label: 'Notifications',
             recipient: payload.notifyUser.displayName,
             type: Notification[type],
             subject: payload.subject,
             errorMessage: e.message,
-            response: errorData,
+            response: e.response?.data,
           });
 
           return false;
@@ -235,32 +211,19 @@ class PushbulletAgent
               });
 
               try {
-                const response = await fetch(endpoint, {
-                  method: 'POST',
+                await axios.post(endpoint, notificationPayload, {
                   headers: {
-                    'Content-Type': 'application/json',
                     'Access-Token': user.settings.pushbulletAccessToken,
                   },
-                  body: JSON.stringify(notificationPayload),
                 });
-                if (!response.ok) {
-                  throw new Error(response.statusText, { cause: response });
-                }
               } catch (e) {
-                let errorData;
-                try {
-                  errorData = await e.cause?.text();
-                  errorData = JSON.parse(errorData);
-                } catch {
-                  /* empty */
-                }
                 logger.error('Error sending Pushbullet notification', {
                   label: 'Notifications',
                   recipient: user.displayName,
                   type: Notification[type],
                   subject: payload.subject,
                   errorMessage: e.message,
-                  response: errorData,
+                  response: e.response?.data,
                 });
 
                 return false;

server/lib/notifications/agents/pushover.ts

@@ -5,6 +5,7 @@ import { User } from '@server/entity/User';
 import type { NotificationAgentPushover } from '@server/lib/settings';
 import { getSettings, NotificationAgentKey } from '@server/lib/settings';
 import logger from '@server/logger';
+import axios from 'axios';
 import {
   hasNotificationType,
   Notification,
@@ -51,15 +52,12 @@ class PushoverAgent
     imageUrl: string
   ): Promise<Partial<PushoverImagePayload>> {
     try {
-      const response = await fetch(imageUrl);
-      if (!response.ok) {
-        throw new Error(response.statusText, { cause: response });
-      }
-      const arrayBuffer = await response.arrayBuffer();
-      const base64 = Buffer.from(arrayBuffer).toString('base64');
+      const response = await axios.get(imageUrl, {
+        responseType: 'arraybuffer',
+      });
+      const base64 = Buffer.from(response.data, 'binary').toString('base64');
       const contentType = (
-        response.headers.get('Content-Type') ||
-        response.headers.get('content-type')
+        response.headers['Content-Type'] || response.headers['content-type']
       )?.toString();
 
       return {
@@ -67,17 +65,10 @@ class PushoverAgent
         attachment_type: contentType,
       };
     } catch (e) {
-      let errorData;
-      try {
-        errorData = await e.cause?.text();
-        errorData = JSON.parse(errorData);
-      } catch {
-        /* empty */
-      }
       logger.error('Error getting image payload', {
         label: 'Notifications',
         errorMessage: e.message,
-        response: errorData,
+        response: e?.response?.data,
       });
       return {};
     }
@@ -210,35 +201,19 @@ class PushoverAgent
       });
 
       try {
-        const response = await fetch(endpoint, {
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/json',
-          },
-          body: JSON.stringify({
-            ...notificationPayload,
-            token: settings.options.accessToken,
-            user: settings.options.userToken,
-            sound: settings.options.sound,
-          } as PushoverPayload),
-        });
-        if (!response.ok) {
-          throw new Error(response.statusText, { cause: response });
-        }
+        await axios.post(endpoint, {
+          ...notificationPayload,
+          token: settings.options.accessToken,
+          user: settings.options.userToken,
+          sound: settings.options.sound,
+        } as PushoverPayload);
       } catch (e) {
-        let errorData;
-        try {
-          errorData = await e.cause?.text();
-          errorData = JSON.parse(errorData);
-        } catch {
-          /* empty */
-        }
         logger.error('Error sending Pushover notification', {
           label: 'Notifications',
           type: Notification[type],
           subject: payload.subject,
           errorMessage: e.message,
-          response: errorData,
+          response: e.response?.data,
         });
 
         return false;
@@ -266,36 +241,20 @@ class PushoverAgent
         });
 
         try {
-          const response = await fetch(endpoint, {
-            method: 'POST',
-            headers: {
-              'Content-Type': 'application/json',
-            },
-            body: JSON.stringify({
-              ...notificationPayload,
-              token: payload.notifyUser.settings.pushoverApplicationToken,
-              user: payload.notifyUser.settings.pushoverUserKey,
-              sound: payload.notifyUser.settings.pushoverSound,
-            } as PushoverPayload),
-          });
-          if (!response.ok) {
-            throw new Error(response.statusText, { cause: response });
-          }
+          await axios.post(endpoint, {
+            ...notificationPayload,
+            token: payload.notifyUser.settings.pushoverApplicationToken,
+            user: payload.notifyUser.settings.pushoverUserKey,
+            sound: payload.notifyUser.settings.pushoverSound,
+          } as PushoverPayload);
         } catch (e) {
-          let errorData;
-          try {
-            errorData = await e.cause?.text();
-            errorData = JSON.parse(errorData);
-          } catch {
-            /* empty */
-          }
           logger.error('Error sending Pushover notification', {
             label: 'Notifications',
             recipient: payload.notifyUser.displayName,
             type: Notification[type],
             subject: payload.subject,
             errorMessage: e.message,
-            response: errorData,
+            response: e.response?.data,
           });
 
           return false;
@@ -332,35 +291,19 @@ class PushoverAgent
               });
 
               try {
-                const response = await fetch(endpoint, {
-                  method: 'POST',
-                  headers: {
-                    'Content-Type': 'application/json',
-                  },
-                  body: JSON.stringify({
-                    ...notificationPayload,
-                    token: user.settings.pushoverApplicationToken,
-                    user: user.settings.pushoverUserKey,
-                  } as PushoverPayload),
-                });
-                if (!response.ok) {
-                  throw new Error(response.statusText, { cause: response });
-                }
+                await axios.post(endpoint, {
+                  ...notificationPayload,
+                  token: user.settings.pushoverApplicationToken,
+                  user: user.settings.pushoverUserKey,
+                } as PushoverPayload);
               } catch (e) {
-                let errorData;
-                try {
-                  errorData = await e.cause?.text();
-                  errorData = JSON.parse(errorData);
-                } catch {
-                  /* empty */
-                }
                 logger.error('Error sending Pushover notification', {
                   label: 'Notifications',
                   recipient: user.displayName,
                   type: Notification[type],
                   subject: payload.subject,
                   errorMessage: e.message,
-                  response: errorData,
+                  response: e.response?.data,
                 });
 
                 return false;

server/lib/notifications/agents/slack.ts

@@ -2,6 +2,7 @@ import { IssueStatus, IssueTypeName } from '@server/constants/issue';
 import type { NotificationAgentSlack } from '@server/lib/settings';
 import { getSettings } from '@server/lib/settings';
 import logger from '@server/logger';
+import axios from 'axios';
 import { hasNotificationType, Notification } from '..';
 import type { NotificationAgent, NotificationPayload } from './agent';
 import { BaseAgent } from './agent';
@@ -237,32 +238,19 @@ class SlackAgent
       subject: payload.subject,
     });
     try {
-      const response = await fetch(settings.options.webhookUrl, {
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/json',
-        },
-        body: JSON.stringify(this.buildEmbed(type, payload)),
-      });
-      if (!response.ok) {
-        throw new Error(response.statusText, { cause: response });
-      }
+      await axios.post(
+        settings.options.webhookUrl,
+        this.buildEmbed(type, payload)
+      );
 
       return true;
     } catch (e) {
-      let errorData;
-      try {
-        errorData = await e.cause?.text();
-        errorData = JSON.parse(errorData);
-      } catch {
-        /* empty */
-      }
       logger.error('Error sending Slack notification', {
         label: 'Notifications',
         type: Notification[type],
         subject: payload.subject,
         errorMessage: e.message,
-        response: errorData,
+        response: e?.response?.data,
       });
 
       return false;

server/lib/notifications/agents/telegram.ts

@@ -5,6 +5,7 @@ import { User } from '@server/entity/User';
 import type { NotificationAgentTelegram } from '@server/lib/settings';
 import { getSettings, NotificationAgentKey } from '@server/lib/settings';
 import logger from '@server/logger';
+import axios from 'axios';
 import {
   hasNotificationType,
   Notification,
@@ -176,35 +177,19 @@ class TelegramAgent
       });
 
       try {
-        const response = await fetch(endpoint, {
-          method: 'POST',
-          headers: {
-            'Content-Type': 'application/json',
-          },
-          body: JSON.stringify({
-            ...notificationPayload,
-            chat_id: settings.options.chatId,
-            message_thread_id: settings.options.messageThreadId,
-            disable_notification: !!settings.options.sendSilently,
-          } as TelegramMessagePayload | TelegramPhotoPayload),
-        });
-        if (!response.ok) {
-          throw new Error(response.statusText, { cause: response });
-        }
+        await axios.post(endpoint, {
+          ...notificationPayload,
+          chat_id: settings.options.chatId,
+          message_thread_id: settings.options.messageThreadId,
+          disable_notification: !!settings.options.sendSilently,
+        } as TelegramMessagePayload | TelegramPhotoPayload);
       } catch (e) {
-        let errorData;
-        try {
-          errorData = await e.cause?.text();
-          errorData = JSON.parse(errorData);
-        } catch {
-          /* empty */
-        }
         logger.error('Error sending Telegram notification', {
           label: 'Notifications',
           type: Notification[type],
           subject: payload.subject,
           errorMessage: e.message,
-          response: errorData,
+          response: e?.response?.data,
         });
 
         return false;
@@ -228,38 +213,22 @@ class TelegramAgent
         });
 
         try {
-          const response = await fetch(endpoint, {
-            method: 'POST',
-            headers: {
-              'Content-Type': 'application/json',
-            },
-            body: JSON.stringify({
-              ...notificationPayload,
-              chat_id: payload.notifyUser.settings.telegramChatId,
-              message_thread_id:
-                payload.notifyUser.settings.telegramMessageThreadId,
-              disable_notification:
-                !!payload.notifyUser.settings.telegramSendSilently,
-            } as TelegramMessagePayload | TelegramPhotoPayload),
-          });
-          if (!response.ok) {
-            throw new Error(response.statusText, { cause: response });
-          }
+          await axios.post(endpoint, {
+            ...notificationPayload,
+            chat_id: payload.notifyUser.settings.telegramChatId,
+            message_thread_id:
+              payload.notifyUser.settings.telegramMessageThreadId,
+            disable_notification:
+              !!payload.notifyUser.settings.telegramSendSilently,
+          } as TelegramMessagePayload | TelegramPhotoPayload);
         } catch (e) {
-          let errorData;
-          try {
-            errorData = await e.cause?.text();
-            errorData = JSON.parse(errorData);
-          } catch {
-            /* empty */
-          }
           logger.error('Error sending Telegram notification', {
             label: 'Notifications',
             recipient: payload.notifyUser.displayName,
             type: Notification[type],
             subject: payload.subject,
             errorMessage: e.message,
-            response: errorData,
+            response: e?.response?.data,
           });
 
           return false;
@@ -293,36 +262,20 @@ class TelegramAgent
               });
 
               try {
-                const response = await fetch(endpoint, {
-                  method: 'POST',
-                  headers: {
-                    'Content-Type': 'application/json',
-                  },
-                  body: JSON.stringify({
-                    ...notificationPayload,
-                    chat_id: user.settings.telegramChatId,
-                    message_thread_id: user.settings.telegramMessageThreadId,
-                    disable_notification: !!user.settings?.telegramSendSilently,
-                  } as TelegramMessagePayload | TelegramPhotoPayload),
-                });
-                if (!response.ok) {
-                  throw new Error(response.statusText, { cause: response });
-                }
+                await axios.post(endpoint, {
+                  ...notificationPayload,
+                  chat_id: user.settings.telegramChatId,
+                  message_thread_id: user.settings.telegramMessageThreadId,
+                  disable_notification: !!user.settings?.telegramSendSilently,
+                } as TelegramMessagePayload | TelegramPhotoPayload);
               } catch (e) {
-                let errorData;
-                try {
-                  errorData = await e.cause?.text();
-                  errorData = JSON.parse(errorData);
-                } catch {
-                  /* empty */
-                }
                 logger.error('Error sending Telegram notification', {
                   label: 'Notifications',
                   recipient: user.displayName,
                   type: Notification[type],
                   subject: payload.subject,
                   errorMessage: e.message,
-                  response: errorData,
+                  response: e?.response?.data,
                 });
 
                 return false;

server/lib/notifications/agents/webhook.ts

@@ -3,6 +3,7 @@ import { MediaStatus } from '@server/constants/media';
 import type { NotificationAgentWebhook } from '@server/lib/settings';
 import { getSettings } from '@server/lib/settings';
 import logger from '@server/logger';
+import axios from 'axios';
 import { get } from 'lodash';
 import { hasNotificationType, Notification } from '..';
 import type { NotificationAgent, NotificationPayload } from './agent';
@@ -177,35 +178,26 @@ class WebhookAgent
     });
 
     try {
-      const response = await fetch(settings.options.webhookUrl, {
-        method: 'POST',
-        headers: {
-          'Content-Type': 'application/json',
-          ...(settings.options.authHeader
-            ? { Authorization: settings.options.authHeader }
-            : {}),
-        },
-        body: JSON.stringify(this.buildPayload(type, payload)),
-      });
-      if (!response.ok) {
-        throw new Error(response.statusText, { cause: response });
-      }
+      await axios.post(
+        settings.options.webhookUrl,
+        this.buildPayload(type, payload),
+        settings.options.authHeader
+          ? {
+              headers: {
+                Authorization: settings.options.authHeader,
+              },
+            }
+          : undefined
+      );
 
       return true;
     } catch (e) {
-      let errorData;
-      try {
-        errorData = await e.cause?.text();
-        errorData = JSON.parse(errorData);
-      } catch {
-        /* empty */
-      }
       logger.error('Error sending webhook notification', {
         label: 'Notifications',
         type: Notification[type],
         subject: payload.subject,
         errorMessage: e.message,
-        response: errorData,
+        response: e?.response?.data,
       });
 
       return false;