feat: add dev command #83
Conversation
cyclimse
force-pushed
the
feat/add-dev-command
branch
from
46196a4 to
f454967
Compare
cyclimse
force-pushed
the
feat/add-dev-command
branch
from
edb93c7 to
c2f62d2
Compare
| app.Serverless = local_app.ServerlessLocal | ||
| scw_serverless.Serverless = local_app.ServerlessLocal |
There was a problem hiding this comment.
This is of course very hacky but it's hard to find a better way as:
- the instantiation of the Serverless class is done in the client's code
- the binding to the handlers is done via decorators, and thus already done when we import a global instance (via loader.load_app_instance) so we need to "act" before that
My first approach was to add a handler parameter to the functions which would store the python handler as an object. This doesn't work well with multiprocessing (can't pickle a Python function) and I don't like it (may introduce side effects when deploying). Ideally, local testing should not modify the deploy command.
The second approach could have been a global Python variable LOCAL_TESTING=False that changes the behavior of the Serverless class. But this results in some conditionals imports as we do not want to import the local testing framework in app.py to avoid packaging issues when deploying.
So finally we override the class directly with a derived class. This is not ideal but it's quite clean compared to those alternatives.
There was a problem hiding this comment.
Hmm yes, a bit of black magic but it works for now 🧙
README.md
Outdated
| @@ -59,6 +59,12 @@ def hello_world(event, context): | |||
| The configuration is done by passing arguments to the decorator. | |||
| To view which arguments are supported, head over to this [documentation](https://serverless-api-framework-python.readthedocs.io/) page. | |||
|
|
|||
| Before deploying, you can run your function locally with the dev command: | |||
There was a problem hiding this comment.
I think this deserves its own subsection, it's really cool!
There was a problem hiding this comment.
Thanks
| app.Serverless = local_app.ServerlessLocal | ||
| scw_serverless.Serverless = local_app.ServerlessLocal |
There was a problem hiding this comment.
Hmm yes, a bit of black magic but it works for now 🧙
Summary
What's changed?
This adds a "dev" command to the CLI that relies on the Python local testing framework the run the function handlers on a local Flask instance.
Why do we need this?
Makes it easier to do local testing before deploying a function.
How have you tested it?
Works with the examples.
Checklist
Details