Add "debug mode" #190
Merged
Add "debug mode" #190
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
Codecov Report
@@ Coverage Diff @@
## master #190 +/- ##
==========================================
+ Coverage 86.67% 86.74% +0.07%
==========================================
Files 39 39
Lines 1853 1863 +10
==========================================
+ Hits 1606 1616 +10
Misses 247 247
Continue to review full report at Codecov.
|
CasperWA
force-pushed
the
close_130_add_debug_flag
branch
3 times, most recently
from
7f93d1d
to
666afe9
Compare
Traceback is only shown in the top-level meta response if in debug mode.
Also, use the log-level debug for uvicorn if in debug mode. Co-Authored-By: Matthew Evans <me388@cam.ac.uk>
CasperWA
force-pushed
the
close_130_add_debug_flag
branch
from
0b42026
to
34dad03
Compare
Merged
CasperWA
added a commit
that referenced
this pull request
Mar 6, 2020
Up to v0.6.0. **New features**: - GitHub Action validator that runs `optimade_validator` for a locally running OPTiMaDe server (#191, @CasperWA, tested by @ml-evs) - Support filter queries for `HAS ALL`, `HAS ANY` and `HAS ONLY` and value lists on MongoDB backends (#173, @ml-evs) Note: `OPERATOR` use in value lists are still _not_ supported. - Debug mode. Start the server in debug mode to enable `debug` log-level in `uvicorn` and get a full Python traceback in the JSON response (#190, @CasperWA) - Add testing of mandatory `filter` queries to `optimade_validator` (#205, @ml-evs) **Updates**: - Allow Cross-Origin requests from anywhere (`*`), i.e., enable CORS for both servers (#194, @CasperWA) - Updates to models (correct misspelling, more transparent model class naming, streamline models with respect to python class inheritance, update field descriptions) (#195, @CasperWA) - API change: Rename `optimade.models.toplevel.py` to `optimade.models.responses.py` (#195, @CasperWA) - Update dependencies to newest versions (as of 02.03.2020) (#202, #196, @CasperWA) - Move imports from `starlette` to `fastapi`, where possible (#202, @ml-evs) - Remove custom middleware to redirect slashed URLs in favor of `starlette` implementation (#202, @ml-evs) - CI tests are now performed with a real MongoDB in the backend. CI tests are also performed with a `mongomock` backend for the tests in `server/test_middleware.py`, `server/test_server_validation.py`, and `server/test_config.py` (#196, @ml-evs, additional testing by @CasperWA ) - Remove `/optimade` from base URLs. This was especially important for the OpenAPI schema (#201, #216, @CasperWA, @ml-evs) - Check integrity of query part of the raw URL using a custom middleware (#209, @CasperWA) - New `optimade/server/exceptions.py` to contain custom `HttpException`s, moved `BadRequest` here (#209, @CasperWA) - Pattern and regex testing for `data.available_api_versions` parts in `/info` endpoint and fix tests for the same (#211, @CasperWA) - Restructure import of test data for regular server (#212, @shyamd) **Bug fixes**: - New retrieval URL for Materials-Consortia's list of providers (#187, @CasperWA) - Skip local `HAS ONLY` tests with a `mongomock` backend, since v3.19.0 does not support these (#206, @ml-evs) - Resource ID's can now contain slashes (`/`) (#183, @ml-evs, @CasperWA) - Remove _valid_ version part of base URL in `meta.query.representation` (#201, @CasperWA)
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.
Closes #130
I have attempted to add a "debug" mode to the server.
At the moment it only toggles whether a Python traceback should be added under the toplevel
metaresponse if an error occurs.It is implemented so it can be activated if
debugis added when running the server, e.g.:or
To start the regular or index server in debug mode, respectively.
The debug mode can also be run "always" by setting the environment variable DEBUG to 1, i.e.
export DEBUG=1.I've added some tests. Currently I've put them in
test_config.py, but the main part of them should be moved to a futuretest_exception_handlers.pyor even better, their own file completely.It was more difficult than expected to make sure the debug mode was set properly for the test clients,
so I needed to circumvent the "standard" setup of inheriting fromSetClient, and instead use the utility functions to create the clients directly. This also means the test time has increased significantly for a very small test. This may be more justified in the future if more debug tests are added, to make sure other things are properly toggled according to the debug mode. But at the moment its a bit overkill - but it was the only way I could figure out to do the tests.Edit: I have made
CONFIG.debugtogglable, i.e., one can now set it on the go - this is quite useful for the tests - but I originally wanted it not to be settable, since at no time would you change it while the server is running.