Support callback for defaults

[astorije]

Hi there!

All the examples of the .defaults() function that I could find are pretty straightforward, for example:

export const graphql = baseGraphql.defaults({
  headers: { authorization: 'token 1234' },
});

However, there are cases where some defaults are not available during the initial importing of modules, for examples if they are loaded from somewhere (i.e. async, e.g. from disk or another API) or if they require additional checking/validation.

Essentially, it would be great if we could do something like this:

export const graphql = baseGraphql.defaults(async () => {
  const oAuthToken = await getOAuthToken();
  return { headers: { authorization: `token ${oAuthToken}` } };
});

The underlying type of defaults would be:

defaults: (newDefaults: RequestParameters | (() => Promise<RequestParameters>)) => graphql;

In the meantime, we could probably get away with something like the following, but TypeScript types are getting in the way and I don't want to end up with something too hacky just to be able to use .defaults:

// This does not work
export const graphql: typeof baseGraphql = async (...args) => {
  const oAuthToken = await getOAuthToken();

  const graphqlWithAuth = baseGraphql.defaults({
    headers: { authorization: `token ${oAuthToken}` },
  });

  return graphqlWithAuth(...args);
};

[gr2m]

I don't think it's necessary. If you really need a defaults callback then you can use https://github.com/octokit/core.js which does support it.

For your particular case you can set request.hook, which is described in https://github.com/octokit/request.js/#request

That's how @octokit/core is hooking into the request lifecycle when using octokit.request()/octokit.graphql(), too.

[astorije]

Hi @gr2m, thanks for the response!

Do you think you could provide some guidance on how to accomplish that?

That's where I'm at right now and needless to say it's not working + those TS types are definitely wrong...

import { withCustomRequest } from '@octokit/graphql';
import { request } from '@octokit/request';

const myRequest = request.defaults({
  request: {
    async hook(req: any, options: any) {
      const oAuthToken = await getOAuthToken();

      req.headers = { authorization: `token ${oAuthToken}` };

      return req(options);
    },
  },
});

const graphql = withCustomRequest(myRequest);

Thanks!

[gr2m]

try this

-      req.headers = { authorization: `token ${oAuthToken}` };
+      options.headers.authorization = `token ${oAuthToken}`

[astorije]

I'll try that, thank you! Do you happen to know how I can type this properly? It seemed like some types were not exported for that.

[astorije]

Alright, so the following works beautifully:

export const graphql = withCustomRequest(
  request.defaults({
    request: {
      async hook(req: any, options: any) {
        const oAuthToken = await getOAuthToken();

        if (!options.headers) {
          options.headers = {};
        }

        options.headers.authorization = `token ${oAuthToken}`;

        return req(options);
      },
    },
  }),
);

Regarding the types:

• Is req the same type as request? If so that's RequestInterface<object> but it doesn't seem to be exported anywhere
• It seems like the type of options is RequestParameters which is only exported in @octokit/graphql/dist-types/types, not top-level

Any chance hook could get typed in the library, so TypeScript can infer the type of the callback and the arguments automatically without having to type those by hand?

[astorije]

So in case anyone needs this, in the end I went with the following, until I can figure out the types a little better 😕 :

export const graphql = withCustomRequest(
  request.defaults({
    request: {
      async hook(
        req: (options: { headers?: Record<string, string> }) => typeof request,
        options: { headers?: Record<string, string> },
      ) {
        const oAuthToken = await getOAuthToken();

        if (!options.headers) {
          options.headers = {};
        }

        options.headers.authorization = `token ${oAuthToken}`;

        return req(options);
      },
    },
  }),
);

I also tried the following with @octokit/core but couldn't get it to work, and options is not typed (options is of type Function | OctokitOptions which doesn't help tsc), so out-of-luck on that front:

import { Octokit } from '@octokit/core';

const OctokitWithAuth = Octokit.defaults(
  async (options: { headers?: Record<string, string> }) => {
    const oAuthToken = await getOAuthToken();

    return {
      ...options,
      headers: {
        ...options.headers,
        authorization: `token ${oAuthToken}`,
      },
    };
  },
);

const { graphql } = new OctokitWithAuth();

export { graphql };

It seems like the header doesn't get picked up at all, the requests would not get authenticated.

[astorije]

@gr2m, if you have any suggestions, I'll take 'em 😅