skip ssl import if not available
#3078
Open
Conversation
This file contains 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
`utils.py` has support for detecting whether the `ssl` module is available, and we can use this to omit SSL-specific funcionality while still providing other features (e.g. unencrypted connections). Prior to this patch, the `connection.py` modules both triggered an `ImportError` due to unconditional imports of the `ssl` module. Now, we check `utils.SSL_AVAILABLE` prior to attempting the import and only raise an error later if (and only if) the application requests an encrypted connection. This helps support platforms such as `wasm32-wasi` where the `ssl` module is not built by default. Signed-off-by: Joel Dice <joel.dice@fermyon.com>
Codecov ReportAttention:
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #3078 +/- ##
==========================================
- Coverage 91.84% 91.83% -0.01%
==========================================
Files 128 128
Lines 33232 33283 +51
==========================================
+ Hits 30523 30567 +44
- Misses 2709 2716 +7 ☔ View full report in Codecov by Sentry. |
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.
Pull Request check-list
Please make sure to review and check all of these items:
NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.
Description of change
utils.pyhas support for detecting whether thesslmodule is available, and we can use this to omit SSL-specific funcionality while still providing other features (e.g. unencrypted connections).Prior to this patch, the
connection.pymodules both triggered anImportErrordue to unconditional imports of thesslmodule. Now, we checkutils.SSL_AVAILABLEprior to attempting the import and only raise an error later if (and only if) the application requests an encrypted connection. This helps support platforms such aswasm32-wasiwhere thesslmodule is not built by default.Ideally, this would be tested in CI using a Python built without
sslsupport. I'm not sure how feasible that is, though; I'm open to guidance on that aspect.