tests: add tests to ensure web client is copyable #1682
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🤔 looks like the test builds are "failing" / not running with the message |
hello-ashleyintech
approved these changes
Apr 2, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #1682 +/- ##
==========================================
- Coverage 85.36% 85.33% -0.04%
==========================================
Files 113 113
Lines 12808 12808
==========================================
- Hits 10934 10930 -4
- Misses 1874 1878 +4 ☔ View full report in Codecov by Sentry. |
zimeg
approved these changes
Apr 2, 2025
|
|
||
|
|
||
| class TestWebClientLogger(unittest.TestCase): | ||
| test_logger: logging.Logger | ||
|
|
||
| def setUp(self): | ||
| self.test_logger = logging.Logger("test-logger") | ||
| self.test_logger = logging.getLogger("test-logger") |
There was a problem hiding this comment.
WebClientloggers must be initialized with logging.getLogger since all calls to this function with a given name return the same logger instance.
This is a great TIL!
| token="xoxb-api_test", | ||
| logger=self.test_logger, | ||
| ) | ||
| client_copy = create_copy(client) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Following slackapi/bolt-python#1284 it was found that passing specific instances of Loggers into the
WebClientmay make it not copyable. When using Bolt for python in a lazy listener configuration the entireRequestincluding theWebClientgets copied. It is important that theloggerin theWebClientis copiable in order to maintain this behavior.WebClientloggers must be initialized with logging.getLogger since all calls to this function with a given name return the same logger instance. This means that logger instances never need to be passed between different parts of an application, and make them copiable.This PR introduces a unit test that ensure the
WebClientwith a custom logger remains copyable.Testing
Run the unit tests
Category
/docs(Documents)/tutorial(PythOnBoardingBot tutorial)tests/integration_tests(Automated tests for this library)Requirements
python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.