Improve the warning message in App/AsyncApp constructor #256

Author: seratch

slack_bolt/app/app.py

@@ -44,6 +44,7 @@
     error_authorize_conflicts,
     warning_bot_only_conflicts,
     debug_return_listener_middleware_response,
+    info_default_oauth_settings_loaded,
 )
 from slack_bolt.middleware import (
     Middleware,
@@ -174,7 +175,11 @@ def __init__(
             # initialize with the default settings
             oauth_settings = OAuthSettings()
 
-        if oauth_flow:
+            if oauth_flow is None and installation_store is None:
+                # show info-level log for avoiding confusions
+                self._framework_logger.info(info_default_oauth_settings_loaded())
+
+        if oauth_flow is not None:
             self._oauth_flow = oauth_flow
             installation_store = select_consistent_installation_store(
                 client_id=self._oauth_flow.client_id,

slack_bolt/app/async_app.py

@@ -45,6 +45,7 @@
     error_oauth_flow_invalid_type_async,
     warning_bot_only_conflicts,
     debug_return_listener_middleware_response,
+    info_default_oauth_settings_loaded,
 )
 from slack_bolt.lazy_listener.asyncio_runner import AsyncioLazyListenerRunner
 from slack_bolt.listener.async_listener import AsyncListener, AsyncCustomListener
@@ -184,6 +185,10 @@ def __init__(
             # initialize with the default settings
             oauth_settings = AsyncOAuthSettings()
 
+            if oauth_flow is None and installation_store is None:
+                # show info-level log for avoiding confusions
+                self._framework_logger.info(info_default_oauth_settings_loaded())
+
         if oauth_flow:
             if not isinstance(oauth_flow, AsyncOAuthFlow):
                 raise BoltError(error_oauth_flow_invalid_type_async())

slack_bolt/logger/messages.py

@@ -69,7 +69,8 @@ def warning_client_prioritized_and_token_skipped() -> str:
 
 def warning_token_skipped() -> str:
     return (
-        "As you gave `installation_store`/`authorize` as well, `token` will be unused."
+        "As either `installation_store` or `authorize` is enabled, "
+        "`token` (or SLACK_BOT_TOKEN env variable) will be unused."
     )
 
 
@@ -104,6 +105,16 @@ def warning_skip_uncommon_arg_name(arg_name: str) -> str:
 # -------------------------------
 
 
+def info_default_oauth_settings_loaded() -> str:
+    return (
+        "As you've set SLACK_CLIENT_ID and SLACK_CLIENT_SECRET env variables, "
+        "Bolt enabled file-based InstallationStore/OAuthStateStore for you. "
+        "Note that the file based ones are for local development. "
+        "If you want to use a different datastore, set oauth_settings argument in App constructor. "
+        "Refer to https://slack.dev/bolt-python/concepts#authenticating-oauth for more details."
+    )
+
+
 # -------------------------------
 # Debug
 # -------------------------------