graphile / graphile/crystal

Add headers and onEditHeaders to Ruru object

Open
#2,184 1 comment 0 reactions 0 assignees View on GitHub
💅 enhancement 🙏 help-wanted
Dominant language
TypeScript
Stars
12.9k
Forks
625
Avg merge
5h 23m
Merged PRs (30d)
24

Description

### Feature description

Ruru supports programmatically setting and reading the query and variables UI panes: https://github.com/graphile/crystal/blob/0f7fe2060c1d2ad50a76a1620ccc827c05bb03af/grafast/ruru-components/src/interfaces.ts#L47-L65

But it'd be nice if it also let you read/write the headers pane too.

### Motivating example

Like you showed on Discord, you can write a grafserv plugin that sets the query and variables from ruru url: https://github.com/graphile/crystal/blob/fbb1b314dd90dfbc06b368c328932478bcca2a55/postgraphile/postgraphile/graphile.config.ts#L110-L166

I'd like to also be able to set the headers too. That would let me create clickable query links that also set `{"Authorization": "Bearer {token}"}` so that I can easily run authenticated queries without having to paste the auth token myself for debugging.

Of course, the plugin would look something like this:

```js
const url = new URL(document.URL)
const params = new URLSearchParams(url.hash.slice(1));

const query = params.get("query");
const variables = params.get("variables");
const headers = params.get("headers"); // yay

if (query) {
RURU_CONFIG.query = query
}
if (variables) {
RURU_CONFIG.variables = variables
}
if (headers) {
RURU_CONFIG.headers = headers // yay
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.