Add default to CallbackOptions handler args

seratch · seratch · commit 31599be6a5fb · 2020-11-03T06:41:08.000+09:00
diff --git a/examples/oauth_app_settings.py b/examples/oauth_app_settings.py
@@ -18,7 +18,10 @@
 
 
 def success(args: SuccessArgs) -> BoltResponse:
-    return BoltResponse(status=200, body="Thanks!")
+    # Do anything here ...
+    # Call the default handler to return HTTP response
+    return args.default.success(args)
+    # return BoltResponse(status=200, body="Thanks!")
 
 
 def failure(args: FailureArgs) -> BoltResponse:
diff --git a/slack_bolt/oauth/async_callback_options.py b/slack_bolt/oauth/async_callback_options.py
@@ -17,16 +17,19 @@ def __init__(  # type: ignore
         request: AsyncBoltRequest,
         installation: Installation,
         settings: "AsyncOAuthSettings",
+        default: "AsyncCallbackOptions",
     ):
         """The arguments for a success function.
 
         :param request: The request.
         :param installation: The installation data.
         :param settings: The settings for OAuth flow.
+        :param default: The default AsyncCallbackOptions.
         """
         self.request = request
         self.installation = installation
         self.settings = settings
+        self.default = default
 
 
 class AsyncFailureArgs:
@@ -38,6 +41,7 @@ def __init__(  # type: ignore
         error: Optional[Exception] = None,
         suggested_status_code: int,
         settings: "AsyncOAuthSettings",
+        default: "AsyncCallbackOptions",
     ):
         """The arguments for a failure function.
 
@@ -46,12 +50,14 @@ def __init__(  # type: ignore
         :param error: An exception if exists.
         :param suggested_status_code: The recommended HTTP status code for the failure.
         :param settings: The settings for OAuth flow.
+        :param default: The default AsyncCallbackOptions.
         """
         self.request = request
         self.reason = reason
         self.error = error
         self.suggested_status_code = suggested_status_code
         self.settings = settings
+        self.default = default
 
 
 class AsyncCallbackOptions:
diff --git a/slack_bolt/oauth/async_oauth_flow.py b/slack_bolt/oauth/async_oauth_flow.py
@@ -69,12 +69,13 @@ def __init__(
         self.install_path = self.settings.install_path
         self.redirect_uri_path = self.settings.redirect_uri_path
 
+        self.default_callback_options = DefaultAsyncCallbackOptions(
+            logger=logger,
+            state_utils=self.settings.state_utils,
+            redirect_uri_page_renderer=self.settings.redirect_uri_page_renderer,
+        )
         if settings.callback_options is None:
-            settings.callback_options = DefaultAsyncCallbackOptions(
-                logger=logger,
-                state_utils=self.settings.state_utils,
-                redirect_uri_page_renderer=self.settings.redirect_uri_page_renderer,
-            )
+            settings.callback_options = self.default_callback_options
         self.success_handler = settings.callback_options.success
         self.failure_handler = settings.callback_options.failure
 
@@ -186,6 +187,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:
                     reason=error,  # type: ignore
                     suggested_status_code=200,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -198,6 +200,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:
                     reason="invalid_browser",
                     suggested_status_code=400,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -209,6 +212,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:
                     reason="invalid_state",
                     suggested_status_code=401,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -221,6 +225,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:
                     reason="missing_code",
                     suggested_status_code=401,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -233,6 +238,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:
                     reason="invalid_code",
                     suggested_status_code=401,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -247,13 +253,17 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:
                     error=err,
                     suggested_status_code=500,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
         # display a successful completion page to the end-user
         return await self.success_handler(
             AsyncSuccessArgs(
-                request=request, installation=installation, settings=self.settings,
+                request=request,
+                installation=installation,
+                settings=self.settings,
+                default=self.default_callback_options,
             )
         )
 
diff --git a/slack_bolt/oauth/callback_options.py b/slack_bolt/oauth/callback_options.py
@@ -17,16 +17,19 @@ def __init__(  # type: ignore
         request: BoltRequest,
         installation: Installation,
         settings: "OAuthSettings",
+        default: "CallbackOptions",
     ):
         """The arguments for a success function.
 
         :param request: The request.
         :param installation: The installation data.
         :param settings: The settings for OAuth flow.
+        :param default: The default CallbackOptions.
         """
         self.request = request
         self.installation = installation
         self.settings = settings
+        self.default = default
 
 
 class FailureArgs:
@@ -38,6 +41,7 @@ def __init__(  # type: ignore
         error: Optional[Exception] = None,
         suggested_status_code: int,
         settings: "OAuthSettings",
+        default: "CallbackOptions",
     ):
         """The arguments for a failure function.
 
@@ -46,12 +50,14 @@ def __init__(  # type: ignore
         :param error: An exception if exists.
         :param suggested_status_code: The recommended HTTP status code for the failure.
         :param settings: The settings for OAuth flow.
+        :param default: The default CallbackOptions.
         """
         self.request = request
         self.reason = reason
         self.error = error
         self.suggested_status_code = suggested_status_code
         self.settings = settings
+        self.default = default
 
 
 class CallbackOptions:
diff --git a/slack_bolt/oauth/oauth_flow.py b/slack_bolt/oauth/oauth_flow.py
@@ -69,12 +69,13 @@ def __init__(
         self.install_path = self.settings.install_path
         self.redirect_uri_path = self.settings.redirect_uri_path
 
+        self.default_callback_options = DefaultCallbackOptions(
+            logger=logger,
+            state_utils=self.settings.state_utils,
+            redirect_uri_page_renderer=self.settings.redirect_uri_page_renderer,
+        )
         if settings.callback_options is None:
-            settings.callback_options = DefaultCallbackOptions(
-                logger=logger,
-                state_utils=self.settings.state_utils,
-                redirect_uri_page_renderer=self.settings.redirect_uri_page_renderer,
-            )
+            settings.callback_options = self.default_callback_options
         self.success_handler = settings.callback_options.success
         self.failure_handler = settings.callback_options.failure
 
@@ -186,6 +187,7 @@ def handle_callback(self, request: BoltRequest) -> BoltResponse:
                     reason=error,
                     suggested_status_code=200,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -198,6 +200,7 @@ def handle_callback(self, request: BoltRequest) -> BoltResponse:
                     reason="invalid_browser",
                     suggested_status_code=400,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -209,6 +212,7 @@ def handle_callback(self, request: BoltRequest) -> BoltResponse:
                     reason="invalid_state",
                     suggested_status_code=401,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -221,6 +225,7 @@ def handle_callback(self, request: BoltRequest) -> BoltResponse:
                     reason="missing_code",
                     suggested_status_code=401,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -233,6 +238,7 @@ def handle_callback(self, request: BoltRequest) -> BoltResponse:
                     reason="invalid_code",
                     suggested_status_code=401,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
@@ -247,13 +253,17 @@ def handle_callback(self, request: BoltRequest) -> BoltResponse:
                     error=err,
                     suggested_status_code=500,
                     settings=self.settings,
+                    default=self.default_callback_options,
                 )
             )
 
         # display a successful completion page to the end-user
         return self.success_handler(
             SuccessArgs(
-                request=request, installation=installation, settings=self.settings,
+                request=request,
+                installation=installation,
+                settings=self.settings,
+                default=self.default_callback_options,
             )
         )
 

Original file line number	Diff line number	Diff line change
`@@ -69,12 +69,13 @@ def __init__(`
`69`	`69`	`self.install_path = self.settings.install_path`
`70`	`70`	`self.redirect_uri_path = self.settings.redirect_uri_path`
`71`	`71`
	`72`	`+ self.default_callback_options = DefaultAsyncCallbackOptions(`
	`73`	`+ logger=logger,`
	`74`	`+ state_utils=self.settings.state_utils,`
	`75`	`+ redirect_uri_page_renderer=self.settings.redirect_uri_page_renderer,`
	`76`	`+ )`
`72`	`77`	`if settings.callback_options is None:`
`73`		`- settings.callback_options = DefaultAsyncCallbackOptions(`
`74`		`- logger=logger,`
`75`		`- state_utils=self.settings.state_utils,`
`76`		`- redirect_uri_page_renderer=self.settings.redirect_uri_page_renderer,`
`77`		`- )`
	`78`	`+ settings.callback_options = self.default_callback_options`
`78`	`79`	`self.success_handler = settings.callback_options.success`
`79`	`80`	`self.failure_handler = settings.callback_options.failure`
`80`	`81`
`@@ -186,6 +187,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:`
`186`	`187`	`reason=error, # type: ignore`
`187`	`188`	`suggested_status_code=200,`
`188`	`189`	`settings=self.settings,`
	`190`	`+ default=self.default_callback_options,`
`189`	`191`	`)`
`190`	`192`	`)`
`191`	`193`
`@@ -198,6 +200,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:`
`198`	`200`	`reason="invalid_browser",`
`199`	`201`	`suggested_status_code=400,`
`200`	`202`	`settings=self.settings,`
	`203`	`+ default=self.default_callback_options,`
`201`	`204`	`)`
`202`	`205`	`)`
`203`	`206`
`@@ -209,6 +212,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:`
`209`	`212`	`reason="invalid_state",`
`210`	`213`	`suggested_status_code=401,`
`211`	`214`	`settings=self.settings,`
	`215`	`+ default=self.default_callback_options,`
`212`	`216`	`)`
`213`	`217`	`)`
`214`	`218`
`@@ -221,6 +225,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:`
`221`	`225`	`reason="missing_code",`
`222`	`226`	`suggested_status_code=401,`
`223`	`227`	`settings=self.settings,`
	`228`	`+ default=self.default_callback_options,`
`224`	`229`	`)`
`225`	`230`	`)`
`226`	`231`
`@@ -233,6 +238,7 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:`
`233`	`238`	`reason="invalid_code",`
`234`	`239`	`suggested_status_code=401,`
`235`	`240`	`settings=self.settings,`
	`241`	`+ default=self.default_callback_options,`
`236`	`242`	`)`
`237`	`243`	`)`
`238`	`244`
`@@ -247,13 +253,17 @@ async def handle_callback(self, request: AsyncBoltRequest) -> BoltResponse:`
`247`	`253`	`error=err,`
`248`	`254`	`suggested_status_code=500,`
`249`	`255`	`settings=self.settings,`
	`256`	`+ default=self.default_callback_options,`
`250`	`257`	`)`
`251`	`258`	`)`
`252`	`259`
`253`	`260`	`# display a successful completion page to the end-user`
`254`	`261`	`return await self.success_handler(`
`255`	`262`	`AsyncSuccessArgs(`
`256`		`- request=request, installation=installation, settings=self.settings,`
	`263`	`+ request=request,`
	`264`	`+ installation=installation,`
	`265`	`+ settings=self.settings,`
	`266`	`+ default=self.default_callback_options,`
`257`	`267`	`)`
`258`	`268`	`)`
`259`	`269`