mirror of
https://github.com/fnproject/fn.git
synced 2022-10-28 21:29:17 +03:00
117 lines
3.3 KiB
Markdown
117 lines
3.3 KiB
Markdown
# Open Function Format
|
|
|
|
This document will describe the details of how a function works, inputs/outputs, etc.
|
|
|
|
## Input Formats
|
|
|
|
### STDIN and Environment Variables
|
|
|
|
While wanting to keep things simple, flexible and expandable, we decided to go back to the basics, using Unix input and output. Standard in is easy to use in any language and doesn't require anything extra. It also allows streaming input so we can do things like keeping a container running some time and stream requests into the container.
|
|
|
|
Configuration values, environment information and other things will be passed in through environment variables.
|
|
|
|
The goals of the input format are the following:
|
|
|
|
* Very easy to use and parse
|
|
* Streamable for increasing performance (more than one call per container execution)
|
|
* Ability to build higher level abstractions on top (ie: Lambda syntax compatible)
|
|
|
|
The format is still up for discussion and in order to move forward and remain flexible, it's likely we will just allow different input formats and the function creator can decide what they want, on a per function basis. Default being the simplest format to use.
|
|
|
|
TODO: Put common env vars here, that show up in all formats.
|
|
|
|
#### Default Input Format
|
|
|
|
The default format is simply the request body itself plus some environment variables. For instance, if someone were to post a JSON body, the unmodified body would be sent in via STDIN. The result comes via STDOUT. When task is done, pipes are closed and the container running the function is terminated.
|
|
|
|
Pros:
|
|
|
|
* Very simple to use
|
|
|
|
Cons:
|
|
|
|
* Not streamable
|
|
|
|
#### HTTP Input Format
|
|
|
|
`--format http`
|
|
|
|
HTTP format could be a good option as it is in very common use obviously, most languages have some semi-easy way to parse it, and it's streamable. The response will look like a HTTP response. The communication is still done via stdin/stdout, but these pipes are never closed unless the container is explicitly terminated. The basic format is:
|
|
|
|
Request:
|
|
|
|
```text
|
|
GET / HTTP/1.1
|
|
Content-Length: 5
|
|
|
|
world
|
|
```
|
|
|
|
Response:
|
|
|
|
```text
|
|
HTTP/1.1 200 OK
|
|
Content-Length: 11
|
|
|
|
hello world
|
|
```
|
|
|
|
The header keys and values would be populated with information about the function call such as the request URL and query parameters.
|
|
|
|
`Content-Length` is determined by the [Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.3) header, which is mandatory both for input and output. It is used by Functions to know when stop writing to STDIN and reading from STDOUT.
|
|
|
|
Pros:
|
|
|
|
* Streamable
|
|
* Common format
|
|
|
|
Cons:
|
|
|
|
* Requires a parsing library or fair amount of code to parse headers properly
|
|
* Double parsing - headers + body (if body is to be parsed, such as json)
|
|
|
|
#### JSON Input Format
|
|
|
|
`--format json`
|
|
|
|
An easy to parse JSON structure.
|
|
|
|
```json
|
|
{
|
|
"request_url": "http://....",
|
|
"call_id": "abc123",
|
|
"method": "GET",
|
|
"body": {
|
|
"some": "input"
|
|
}
|
|
}
|
|
{
|
|
"request_url":"http://....",
|
|
"call_id": "edf456",
|
|
"method": "GET",
|
|
"body": {
|
|
"other": "input"
|
|
}
|
|
}
|
|
```
|
|
|
|
Pros:
|
|
|
|
* Streamable
|
|
* Easy to parse
|
|
|
|
Cons:
|
|
|
|
* ???
|
|
|
|
## Output
|
|
|
|
### Output back to client
|
|
|
|
Typically JSON is the output format and is the default output, but any format can be used.
|
|
|
|
### Logging
|
|
|
|
Standard error is reserved for logging, like it was meant to be. Anything you output to STDERR will show up in the logs. And if you use a log
|
|
collector like logspout, you can collect those logs in a central location. See [logging](logging.md).
|