From 47b0c6167086013aa3009f6b4772632392bcc87d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nuno=20G=C3=B3is?= <github@nunogois.com>
Date: Thu, 27 Jun 2024 09:14:37 +0100
Subject: [PATCH] chore: better debug logs in slack app (#7467)

Should improve the readability of our Slack App integration logs.
---
 src/lib/addons/slack-app.test.ts | 8 +++++---
 src/lib/addons/slack-app.ts      | 8 +++++---
 2 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/src/lib/addons/slack-app.test.ts b/src/lib/addons/slack-app.test.ts
index 943373fb32..32110a3b7d 100644
--- a/src/lib/addons/slack-app.test.ts
+++ b/src/lib/addons/slack-app.test.ts
@@ -38,7 +38,9 @@ describe('SlackAppAddon', () => {
     const getLogger = jest.fn(() => loggerMock);
     const mockError = {
         code: ErrorCode.PlatformError,
-        data: 'Platform error message',
+        data: {
+            error: 'Platform error message',
+        },
     };
 
     const event: IEvent = {
@@ -150,7 +152,7 @@ describe('SlackAppAddon', () => {
         });
 
         expect(loggerMock.warn).toHaveBeenCalledWith(
-            `Error handling event ${event.type}. A platform error occurred: Platform error message`,
+            `Error handling event ${event.type}. A platform error occurred: ${JSON.stringify(mockError.data)}`,
             expect.any(Object),
         );
     });
@@ -178,7 +180,7 @@ describe('SlackAppAddon', () => {
 
         expect(postMessage).toHaveBeenCalledTimes(3);
         expect(loggerMock.warn).toHaveBeenCalledWith(
-            `Error handling event ${FEATURE_ENVIRONMENT_ENABLED}. A platform error occurred: Platform error message`,
+            `Error handling event ${FEATURE_ENVIRONMENT_ENABLED}. A platform error occurred: ${JSON.stringify(mockError.data)}`,
             expect.any(Object),
         );
         expect(loggerMock.info).toHaveBeenCalledWith(
diff --git a/src/lib/addons/slack-app.ts b/src/lib/addons/slack-app.ts
index 6d92077bd0..ce95e4bf11 100644
--- a/src/lib/addons/slack-app.ts
+++ b/src/lib/addons/slack-app.ts
@@ -67,7 +67,9 @@ export default class SlackAppAddon extends Addon {
                 );
                 return;
             }
-            this.logger.debug(`Found candidate channels: ${eventChannels}.`);
+            this.logger.debug(
+                `Found candidate channels: ${JSON.stringify(eventChannels)}.`,
+            );
 
             if (!this.slackClient || this.accessToken !== accessToken) {
                 const client = new WebClient(accessToken);
@@ -162,13 +164,13 @@ export default class SlackAppAddon extends Addon {
         if (error.code === ErrorCode.PlatformError) {
             const { data } = error as WebAPIPlatformError;
             this.logger.warn(
-                `Error handling event ${event.type}. A platform error occurred: ${data}`,
+                `Error handling event ${event.type}. A platform error occurred: ${JSON.stringify(data)}`,
                 error,
             );
         } else if (error.code === ErrorCode.RequestError) {
             const { original } = error as WebAPIRequestError;
             this.logger.warn(
-                `Error handling event ${event.type}. A request error occurred: ${original}`,
+                `Error handling event ${event.type}. A request error occurred: ${JSON.stringify(original)}`,
                 error,
             );
         } else if (error.code === ErrorCode.RateLimitedError) {