Fix #859 Improve the way to handle authorize fn errors in built-in re…

…ceivers
slackapi · Aug 26, 2021 · 11f7c9e · 11f7c9e
1 parent bcca0ee
commit 11f7c9e
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git a/src/App.ts b/src/App.ts
@@ -48,7 +48,7 @@ import {
   RespondArguments,
 } from './types';
 import { IncomingEventType, getTypeAndConversation, assertNever } from './helpers';
-import { CodedError, asCodedError, AppInitializationError, MultipleListenerError } from './errors';
+import { CodedError, asCodedError, AppInitializationError, MultipleListenerError, ErrorCode } from './errors';
 // eslint-disable-next-line import/order
 import allSettled = require('promise.allsettled'); // eslint-disable-line @typescript-eslint/no-require-imports
 // eslint-disable-next-line @typescript-eslint/no-require-imports
@@ -677,7 +677,7 @@ export default class App {
       }
     } catch (error) {
       this.logger.warn('Authorization of incoming event did not succeed. No listeners will be called.');
-      error.code = 'slack_bolt_authorization_error';
+      error.code = ErrorCode.AuthorizationError;
       return this.handleError(error);
     }
 
@@ -874,7 +874,7 @@ const tokenUsage =
   'should be initialized with oauth installer or authorize.';
 
 function defaultErrorHandler(logger: Logger): ErrorHandler {
-  return (error) => {
+  return (error: CodedError) => {
     logger.error(error);
 
     return Promise.reject(error);

diff --git a/src/receivers/ExpressReceiver.ts b/src/receivers/ExpressReceiver.ts
@@ -11,7 +11,13 @@ import tsscmp from 'tsscmp';
 import { Logger, ConsoleLogger, LogLevel } from '@slack/logger';
 import { InstallProvider, CallbackOptions, InstallProviderOptions, InstallURLOptions } from '@slack/oauth';
 import App from '../App';
-import { ReceiverAuthenticityError, ReceiverMultipleAckError, ReceiverInconsistentStateError } from '../errors';
+import {
+  ReceiverAuthenticityError,
+  ReceiverMultipleAckError,
+  ReceiverInconsistentStateError,
+  ErrorCode,
+  CodedError,
+} from '../errors';
 import { AnyMiddlewareArgs, Receiver, ReceiverEvent } from '../types';
 import { renderHtmlForInstallPath } from './render-html-for-install-path';
 
@@ -213,6 +219,16 @@ export default class ExpressReceiver implements Receiver {
         this.logger.debug('stored response sent');
       }
     } catch (err) {
+      if ('code' in err) {
+        // CodedError has code: string
+        const errorCode = (err as CodedError).code;
+        if (errorCode === ErrorCode.AuthorizationError) {
+          // authorize function threw an exception, which means there is no valid installation data
+          res.status(401).send();
+          isAcknowledged = true;
+          return;
+        }
+      }
       res.status(500).send();
       throw err;
     }

diff --git a/src/receivers/HTTPReceiver.ts b/src/receivers/HTTPReceiver.ts
@@ -15,6 +15,7 @@ import {
   ReceiverInconsistentStateError,
   HTTPReceiverDeferredRequestError,
   ErrorCode,
+  CodedError,
 } from '../errors';
 
 export interface HTTPReceiverOptions {
@@ -370,6 +371,17 @@ export default class HTTPReceiver implements Receiver {
           this.logger.debug('stored response sent');
         }
       } catch (err) {
+        if ('code' in err) {
+          // CodedError has code: string
+          const errorCode = (err as CodedError).code;
+          if (errorCode === ErrorCode.AuthorizationError) {
+            // authorize function threw an exception, which means there is no valid installation data
+            res.writeHead(401);
+            res.end();
+            isAcknowledged = true;
+            return;
+          }
+        }
         this.logger.error('An unhandled error occurred while Bolt processed an event');
         this.logger.debug(`Error details: ${err}, storedResponse: ${storedResponse}`);
         res.writeHead(500);