Initial webservice #1
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
added 8 commits
June 2, 2019 21:26
Set up a small sanic app with two routes:
1. A status route that returns 200 and the text representation ('OK')
2. A stub for the notebook convert endpoint. Right now it returns static HTML. Later it will return the result of a notebook->html conversion
Import the nbconvert library and programmatically perform the request json -> html conversion I tested this manually using a few notebooks, including tables and images. output was visually equivalent in the browser to nbconvert on command line, and to Calhoun
Update route decorators to shorthand versions Update handler names to match Calhoun, as these get picked up as default route names
Added some information regarding the project description, choice of framework, and background. Will add configuration and deployment once I've worked on those features.
In Calhoun, the service this is based on, the /api/convert endpoint is authorized via a call to the SAM authorization service that powers Terra. I'm not entirely sure this is necessary- the user is only getting access to a reformated version of data they are sending in. Perhaps checking that the user is registered is a way of protecting from automated DOS attacks. Perhaps it was done to avoid changes to the security boundary for compliance. I will follow up here. For now, I am calling the same authorization service endpoint. Added basic call to the SAM authorization service. I don't love the elifs for handling the response out of SAM. Better error handling TBD Also TBD is parameterizing the SAM root from config. Updated readme
More effectively handling scenarios where the user is unauthorized, not enabled in Terra, otherwise Forbidden, or there is a problem contacting the SAM authorization service.
Passing in SAM_ROOT from a config file, to facilitate different environments. Simplified error handling in authorization functions to make use of Sanic's built in exception handling
Authorization methods are only meant to be called by the 'authorized' decorator.
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.
This is a large PR representing the bulk of the work setting up the service, including the routing, authentication, and notebook conversion. The readme has info on the choice of web framework.
There is still some housekeeping to be done- adding docstrings to the utility methods and creating API documentation.
I also need to create the app configuration for deploying the service on Google App Engine.