Uninstall default bottle plugins #1734
Merged
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
puremourning
approved these changes
Feb 13, 2024
There was a problem hiding this comment.
Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: 1 of 2 LGTMs obtained (waiting on @bstaletic)
bstaletic
force-pushed
the
bottle-plugin
branch
from
9c48476 to
e6b3a56
Compare
By default, bottle installs two plugins: `JSONPlugin` and `TemplatePlugin`. `TemplatePlugin` is always a no-op, because none of the routes we use (like `/ready`) have a template parameter. `JSONPlugin` could have been useful were it actually serializing all json messages. Instead it only deals with dictionaries. Ycmd has always had `ycmd.handlers._JsonResponse` and we will need to keep it that way. `_JsonResponse` makes `JSONPlugin` a no-op too, because, by the time we get to the `JSONPlugin.apply()` the response is always a str already. `Bottle.uninstall()` can be passed: 1. An instance of an installed plugins, to uninstall that one plugin. 2. A type, to uninstall all plugins of that type. 3. `True`, to uninstall all plugins. Since we are uninstalling all default plugins, we can just do `handlers.app.uninstall( True )` and then install the plugins we care about - `ycmd.HmacPlugin` and `ycmd.WatchdogPlugin`.
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #1734 +/- ##
=======================================
Coverage 95.44% 95.44%
=======================================
Files 83 83
Lines 8166 8167 +1
Branches 163 163
=======================================
+ Hits 7794 7795 +1
Misses 322 322
Partials 50 50 |
|
Thanks for sending a PR! |
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.
By default, bottle installs two plugins:
JSONPluginandTemplatePlugin.TemplatePluginis always a no-op, because none of the routes we use (like/ready) have a template parameter.JSONPlugincould have been useful were it actually serializing all json messages. Instead it only deals with dictionaries. Ycmd has always hadycmd.handlers._JsonResponseand we will need to keep it that way._JsonResponsemakesJSONPlugina no-op too, because, by the time we get to theJSONPlugin.apply()the response is always a str already.Bottle.uninstall()can be passed:True, to uninstall all plugins.Since we are uninstalling all default plugins, we can just do
handlers.app.uninstall( True )and then install the plugins we care about -ycmd.HmacPluginandycmd.WatchdogPlugin.This change is