batch requests

[scottcorgan]

Define batch requests for a single endpoint through the proxy. The setting in superstatic.json would be the following:

{
  "proxy": {
    "api": {
      "origin": "https://api.github.com",
      "batch": {
        "/repos/repo1/:repo1/repo2/:repo2": {
          "repo1": "/repos/:repo1",
          "repo2": "/repos/:repo2"
        }
      }
    }
  }
}

Ultimately the user can still make normal proxy requests, but normal requests that match the batch route would be be considered a batch request and handled accordingly.

The above example would return the follow for the request /repos?repo=superstatic&repo2=divshot-cli in the response:

{
  repo1: {/* superstatic repo data */},
  repo2: {/* divshot-cli repo data */
}

[collin]

Rather than force the configuration to pre-suppose all possible batching, I think it makes more sense to supply a more generic batching endpoint:

/__/proxy/batch/api?value1=/repos/divshot/superstatic&value2=/repos/divshot/divshot-cli

{
  value1: {/* superstatic repo data */},
  value2: {/* divshot-cli repo data */}
}

[scottcorgan]

Nice. Any particular reason you put "batch" before "api"?

I was thinking:

/__/proxy/api/?batch=/repos/divshot/superstatic,/repos/divshot/divshot-cli

[collin]

It's before api to reduce ambiguity. with

/__/proxy/api/?batch=/repos/divshot/superstatic,/repos/divshot/divshot-cli

It is ambiguous whether you want to request a batch of urls, or have a request proxied to github that has a path of / and a query parameter of batch=[...]

[scottcorgan]

Makes sense. Do you think that would cause any issues if the batched urls contain query parameters themselves?

[collin]

That I'm not sure, seems like it could cause trouble if the urls coming in also have commas in them.

[collin]

We could require that batch parts that have commas in the url be escaped

escape(",")
=> "%2C"

Then we can just split the batch by ',' and unescape.

Most users wouldn't have to do the escaping as commas and urls are rare, but it would let us support it.