Open Runtimes V3

[Meldiron]

Open Runtimes V3 ⚡

Description

• Ensure brand. Slug should be open-runtimes, verbose should be Open Runtimes, and there is no shorthand (no opr). openruntimes should not be used.
• req and res params removed, context introduced
• context.req contains all information about http request
• context.res lets you configure all information about http request
• res.json() is now context.res.json(). same for res.send() -> context.res.send(). New ones introduced.empty() and .redirect()
• context.log() and context.error() lets you reliably log. Native support (likeconsole.log in Node) was removed
• req.variables removed, system variables should be used instead (in Node, process.env.MY_VAR)
• req.payload renamed to context.req.body. Body is automatically parsed now to JSON if there is JSON content-type header. In future we plan to support more types such as XML, URL-encoded or Form Data bodies.
• Function now has to return. Instead of res.json(), now we do return context.res.json()
• Missing response now responds with 204 instead of causing timeout error
• Auth header renamed from x-internal-challenge to x-open-runtimes-secret
• env variables renamed from INTERNAL_RUNTIME_KEY and INTERNAL_RUNTIME_ENTRYPOINT to OPEN_RUNTIMES_SECRET and OPEN_RUNTIMES_ENTRYPOINT
• Logs race condition issues are now solved
• MUCH better tests coverage
• Removed automatic wrappers from Java, Kotlin, C++ and .NET

Development

Runtimes:

• Node: Feat: Node v3 #130 (+ tests)
• Python: Feat: v3 python #137
• Deno: Feat: v3 Deno #138
• PHP: Feat: v3 PHP #139
• Ruby: Feat: v3 Ruby #140
• Dart: Feat: v3 Dart #141
• Java: Feat: v3 Java #142
• Kotlin: Feat: v3 Kotlin #143
• Dotnet: Feat: v3 .NET #144
• C++: Feat: v3 C++ #145
• Swift: Feat: v3 Swift #147

Other:

• Install & build commands
• .open-runtimes
• folder consistent naming
• Safe timeouts

Tests coverage:

Make sure to remove all outdated tests. If everything passes, all is ready for release

• Logging to logs
• Logging to error
• Rrequest headers
• Request headers MUST be ommiting x-openruntimes- ones
• Request URL (url, path, query, queryString, host, scheme, port)
• Request method
• Request body empty
• Request body plaintext
• Request body JSON (automatic parsing)
• Internal challenge 500
• Exception thrown
• Double response
• No response
• Empty response
• Redirect response
• JSON response
• Text response
• Emoji response
• Headers response
• env variables
• Old tests, if relevant
• Library test
• Empty JSON body test
• Empty secret header test
• object/array log test
• Exception trace test (filename)

Docs:

• Ensure OPR is no longer used (and internal)
• Update main readme

Post-release:

• Update open runtimes / examples
• Update appwrite / starters
• Apply V3 changes to all versions

[eldadfux]

@Meldiron great stuff! This is a game changing PR!