feat: script API route configuration options

[Blckbrry-Pi]

Resolves OGBE-3

[Blckbrry-Pi]

• feat: script API route configuration options #266 👈
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @Blckbrry-Pi and the rest of your teammates on Graphite

[linear]

OGBE-3 Allow serving scripts with raw HTTP request/response on API endpoint

[MasterPtato]

Does this add the chosen method and input data to the generated openapi spec anywhere?

[Blckbrry-Pi]

Does this add the chosen method and input data to the generated openapi spec anywhere?

Is there a reason we need to clone the request here? I could imagine this being expensive for requests with large payloads

It does not, thank you for reminding me to fix that!

[NathanFlurry]

the idea of where this is going is good, but i don't think it's quite the right approach

if we're exposing raw rest api endpoints, we should give full control.

we should let have access to the arbritrary request and return an arbitrary response themselves. tbd on how to impelment those types; i think we'll just type it as the DOM request type and pass whatever vanilla object we have to the request (wether it's a cloudflare request or http server request).

in terms of actually running it, i think we need to split this out from scripts and make it a separate script-like file. basically:

files:

• api/login_callback.ts
• api/login_link.ts

in the module.yaml:

api:
  login_callback:
    method: GET
    path: /a/b/{param}

tbd on what route matching we use, but we do need to be able to support wildcards (e.g. for serving dynamic http files).

so it needs to:

• validate there is no conflict in paths
• implement a very basic router
• pass a raw Request and accept a raw Response

this should end up looking sort of similar to Cloudflare workers in the sense of getitng a raw req & res: https://developers.cloudflare.com/workers/runtime-apis/request/

example use cases:

• oauth callbacks
• webhooks
• serving static webpages (we'll be hosting the admin portal this way)

[NathanFlurry]

this needs a test module in the tests/basic/ too

[NathanFlurry]

see comment on thread.

also waiting on resolution of naming of api -> ? in the thread on slack.