Skip to content

fix: honor passing bolt logger in default web client installation #1272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WilliamBergamin merged 4 commits into from
Mar 18, 2025
Merged

fix: honor passing bolt logger in default web client installation #1272

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4e880dc
feat: honor passing the Bolt logger in default WebClient instantiation
WilliamBergamin Mar 13, 2025
1ba23f0
Merge branch 'main' into honnor-passing-bolt-logger-in-default-web-cl…
WilliamBergamin Mar 14, 2025
d6aea71
Make it almost work
WilliamBergamin Mar 14, 2025
4173845
Update requirements.txt
WilliamBergamin Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
feat: honor passing the Bolt logger in default WebClient instantiation
  • Loading branch information
@WilliamBergamin
WilliamBergamin committed Mar 13, 2025
commit 4e880dcf968794322be07015295a5ddb29a2d360
1 change: 1 addition & 0 deletions slack_bolt/app/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1381,6 +1381,7 @@ def _init_context(self, req: BoltRequest):
proxy=self._client.proxy,
headers=self._client.headers,
team_id=req.context.team_id,
logger=self._client.logger,
retry_handlers=self._client.retry_handlers.copy() if self._client.retry_handlers is not None else None,
)
req.context["client"] = client_per_request
Expand Down
1 change: 1 addition & 0 deletions slack_bolt/app/async_app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1413,6 +1413,7 @@ def _init_context(self, req: AsyncBoltRequest):
trust_env_in_session=self._async_client.trust_env_in_session,
headers=self._async_client.headers,
team_id=req.context.team_id,
logger=self._async_client.logger,
retry_handlers=(
self._async_client.retry_handlers.copy() if self._async_client.retry_handlers is not None else None
),
Expand Down
70 changes: 66 additions & 4 deletions tests/scenario_tests/test_web_client_customization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import json
import logging
from time import time
from urllib.parse import quote

Expand All @@ -21,10 +22,8 @@ class TestWebClientCustomization:
signing_secret = "secret"
mock_api_server_base_url = "http://localhost:8888"
signature_verifier = SignatureVerifier(signing_secret)
web_client = WebClient(
token=valid_token,
base_url=mock_api_server_base_url,
)
test_logger = logging.getLogger("test.logger")
web_client = WebClient(token=valid_token, base_url=mock_api_server_base_url)

def setup_method(self):
self.old_os_env = remove_os_env_temporarily()
Expand Down Expand Up @@ -69,6 +68,69 @@ def listener(ack, client):
assert response.body == ""
assert_auth_test_count(self, 1)

def test_default_app_web_client_logger_is_app_logger(self):
app = App(token=self.valid_token, signing_secret=self.signing_secret, token_verification_enabled=False)
app.client.base_url = self.mock_api_server_base_url

assert app.client.logger == app.logger

def test_default_web_client_uses_bolt_framework_logger(self):
app = App(token=self.valid_token, signing_secret=self.signing_secret, token_verification_enabled=False)
app.client.base_url = self.mock_api_server_base_url

@app.action("a")
def listener(ack, client: WebClient):
assert client.logger == app.logger
ack()

request = self.build_valid_request()
response = app.dispatch(request)
assert response.status == 200
assert response.body == ""
assert_auth_test_count(self, 1)

def test_default_web_client_uses_bolt_app_custom_logger(self):
app = App(
token=self.valid_token,
signing_secret=self.signing_secret,
token_verification_enabled=False,
logger=self.test_logger,
)
app.client.base_url = self.mock_api_server_base_url

assert app.client.logger == app.logger

@app.action("a")
def listener(ack, client: WebClient):
assert client.logger == app.logger
assert client.logger == self.test_logger
ack()

request = self.build_valid_request()
response = app.dispatch(request)
assert response.status == 200
assert response.body == ""
assert_auth_test_count(self, 1)

def test_custom_web_client_logger_is_used_instead_of_bolt_app_logger(self):

@zimeg zimeg Mar 17, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 Awesome checks!

web_client = WebClient(token=self.valid_token, base_url=self.mock_api_server_base_url, logger=self.test_logger)
app = App(
client=web_client,
signing_secret=self.signing_secret,
)

@app.action("a")
def listener(ack, client: WebClient):
assert client.logger == self.test_logger
assert app.logger != self.test_logger
ack()

request = self.build_valid_request()
response = app.dispatch(request)
assert response.status == 200
assert response.body == ""
assert_auth_test_count(self, 1)


block_actions_body = {
"type": "block_actions",
Expand Down
67 changes: 67 additions & 0 deletions tests/scenario_tests_async/test_web_client_customization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import json
import logging
import os
from time import time
from urllib.parse import quote
Expand All @@ -23,6 +24,7 @@ class TestWebClientCustomization:
signing_secret = "secret"
mock_api_server_base_url = "http://localhost:8888"
signature_verifier = SignatureVerifier(signing_secret)
test_logger = logging.getLogger("test.logger")
web_client = AsyncWebClient(
token=valid_token,
base_url=mock_api_server_base_url,
Expand Down Expand Up @@ -87,6 +89,71 @@ async def listener(ack, client):
assert response.body == ""
await assert_auth_test_count_async(self, 1)

def test_default_app_web_client_logger_is_app_logger(self):
app = AsyncApp(token=self.valid_token, signing_secret=self.signing_secret)
app.client.base_url = self.mock_api_server_base_url

assert app.client.logger == app.logger

@pytest.mark.asyncio
async def test_default_web_client_uses_bolt_framework_logger(self):
app = AsyncApp(token=self.valid_token, signing_secret=self.signing_secret)
app.client.base_url = self.mock_api_server_base_url

@app.action("a")
async def listener(ack, client: AsyncWebClient):
assert client.logger == app.logger
await ack()

request = self.build_valid_request()
response = await app.async_dispatch(request)
assert response.status == 200
assert response.body == ""
await assert_auth_test_count_async(self, 1)

@pytest.mark.asyncio
async def test_default_web_client_uses_bolt_app_custom_logger(self):
app = AsyncApp(
token=self.valid_token,
signing_secret=self.signing_secret,
logger=self.test_logger,
)
app.client.base_url = self.mock_api_server_base_url

assert app.client.logger == app.logger

@app.action("a")
async def listener(ack, client: AsyncWebClient):
assert client.logger == app.logger
assert client.logger == self.test_logger
await ack()

request = self.build_valid_request()
response = await app.async_dispatch(request)
assert response.status == 200
assert response.body == ""
await assert_auth_test_count_async(self, 1)

@pytest.mark.asyncio
async def test_custom_web_client_logger_is_used_instead_of_bolt_app_logger(self):
web_client = AsyncWebClient(token=self.valid_token, base_url=self.mock_api_server_base_url, logger=self.test_logger)
app = AsyncApp(
client=web_client,
signing_secret=self.signing_secret,
)

@app.action("a")
async def listener(ack, client: AsyncWebClient):
assert client.logger == self.test_logger
assert app.logger != self.test_logger
await ack()

request = self.build_valid_request()
response = await app.async_dispatch(request)
assert response.status == 200
assert response.body == ""
await assert_auth_test_count_async(self, 1)


block_actions_body = {
"type": "block_actions",
Expand Down