Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support multipart/form-data and json #18

Open
dschulten opened this issue Apr 13, 2019 · 3 comments
Open

Support multipart/form-data and json #18

dschulten opened this issue Apr 13, 2019 · 3 comments

Comments

@dschulten
Copy link

dschulten commented Apr 13, 2019

The python3-http templates use an Event abstraction which represents the incoming request.
Currently the Event only holds the request.data as body, which is the body as byte array.

Suggestion: Leverage Flask's support for multipart/form-data, application/json (and x-www-form-urlencoded) by adding the following attributes to the Event object:

  1. request.files and request.form - they are needed for multipart/form-data requests.
    The request.files attribute is an ImmutableMultiDict of FileStorage (which is a file-ish ducktype) where every entry is a list of files.
    The request.form is an ImmutableMultiDict of strings which represent the textual multiparts which have no filename in their content-disposition (or the values of an x-www-form-urlencoded body).
    We already preserve ImmutableMultiDict in Event.query, so it seems straightforward to add files and form, too
  2. request.get_json() - it only gets filled when the request is of Content-Type: application/json
class Event:
    def __init__(self):
        self.body = request.get_data()
        self.json = request.get_json()
        self.form = request.form
        self.files = request.files
        self.headers = request.headers
        self.method = request.method
        self.query = request.args
        self.path = request.path

The format_body method also needs to be adjusted so that it uses Flask's support for file responses if the handler returns a file.

return send_file(fout, 'application/pdf')

This gives us the ability to upload files to such functions and download the function result (would also enable us to have uploads in the OpenFaaS Dashboard). Depending on Flask's implementation this also gives us support for large files.

I am preparing a PR for the python3-http template, and I could do likewise for the IRequest in the Java Template.

Please let me know if you approve of the general idea.

@Jeff-Lowrey
Copy link

@dschulten Hi - this is great! I haven't look at it yet, but it is something that I needed for one of my functions. . I've done some hackery, but a clean and reusable solution is better.

@mrhatbirb
Copy link

is there a reason why this was not merged? I feel like the edit is pretty straightforward - just adding some properties to the Event class. Came here to send a PR for it, but seeing that the issue is two years old makes me think that it will be ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants