Improve the error message in the case where AuthorizeResult is not found (#476)

Author: seratch

slack_bolt/authorization/async_authorize.py

@@ -16,6 +16,9 @@
 
 
 class AsyncAuthorize:
+    """This provides authorize function that returns AuthorizeResult
+    for an incoming request from Slack."""
+
     def __init__(self):
         pass
 
@@ -31,6 +34,10 @@ async def __call__(
 
 
 class AsyncCallableAuthorize(AsyncAuthorize):
+    """When you pass the authorize argument in AsyncApp constructor,
+    This authorize implementation will be used.
+    """
+
     def __init__(
         self, *, logger: Logger, func: Callable[..., Awaitable[AuthorizeResult]]
     ):
@@ -93,6 +100,11 @@ async def __call__(
 
 
 class AsyncInstallationStoreAuthorize(AsyncAuthorize):
+    """If you use the OAuth flow settings, this authorize implementation will be used.
+    As long as your own InstallationStore (or the built-in ones) works as you expect,
+    you can expect that the authorize layer should work for you without any customization.
+    """
+
     authorize_result_cache: Dict[str, AuthorizeResult]
     find_installation_available: Optional[bool]
     find_bot_available: Optional[bool]

slack_bolt/authorization/authorize.py

@@ -1,5 +1,4 @@
 import inspect
-import os
 from logging import Logger
 from typing import Optional, Callable, Dict, Any
 
@@ -16,6 +15,9 @@
 
 
 class Authorize:
+    """This provides authorize function that returns AuthorizeResult
+    for an incoming request from Slack."""
+
     def __init__(self):
         pass
 
@@ -31,6 +33,10 @@ def __call__(
 
 
 class CallableAuthorize(Authorize):
+    """When you pass the authorize argument in AsyncApp constructor,
+    This authorize implementation will be used.
+    """
+
     def __init__(
         self,
         *,
@@ -96,6 +102,11 @@ def __call__(
 
 
 class InstallationStoreAuthorize(Authorize):
+    """If you use the OAuth flow settings, this authorize implementation will be used.
+    As long as your own InstallationStore (or the built-in ones) works as you expect,
+    you can expect that the authorize layer should work for you without any customization.
+    """
+
     authorize_result_cache: Dict[str, AuthorizeResult]
     bot_only: bool
     find_installation_available: bool

slack_bolt/middleware/authorization/async_multi_teams_authorization.py

@@ -62,8 +62,13 @@ async def async_process(
                 req.context.client.token = token
                 return await next()
             else:
-                # Just in case
-                self.logger.error("auth.test API call result is unexpectedly None")
+                # This situation can arise if:
+                # * A developer installed the app from the "Install to Workspace" button in Slack app config page
+                # * The InstallationStore failed to save or deleted the installation for this workspace
+                self.logger.error(
+                    "Although the app should be installed into this workspace, "
+                    "the AuthorizeResult (returned value from authorize) for it was not found."
+                )
                 return _build_error_response()
 
         except SlackApiError as e:

slack_bolt/middleware/authorization/multi_teams_authorization.py

@@ -67,8 +67,13 @@ def process(
                 req.context.client.token = token
                 return next()
             else:
-                # Just in case
-                self.logger.error("auth.test API call result is unexpectedly None")
+                # This situation can arise if:
+                # * A developer installed the app from the "Install to Workspace" button in Slack app config page
+                # * The InstallationStore failed to save or deleted the installation for this workspace
+                self.logger.error(
+                    "Although the app should be installed into this workspace, "
+                    "the AuthorizeResult (returned value from authorize) for it was not found."
+                )
                 return _build_error_response()
 
         except SlackApiError as e: