@urql/exchange-auth

An exchange for managing authentication in urql

@urql/exchange-auth is an exchange for the urql GraphQL client which helps handle auth headers and token refresh

Quick Start Guide

First install @urql/exchange-auth alongside urql:

1yarn add @urql/exchange-auth
2# or
3npm install --save @urql/exchange-auth

You'll then need to add the authExchange, that this package exposes to your urql Client

1import { createClient, cacheExchange, fetchExchange } from 'urql';
2import { makeOperation } from '@urql/core';
3import { authExchange } from '@urql/exchange-auth';
4
5const client = createClient({
6  url: 'http://localhost:1234/graphql',
7  exchanges: [
8    cacheExchange,
9    authExchange(async utils => {
10      // called on initial launch,
11      // fetch the auth state from storage (local storage, async storage etc)
12      let token = localStorage.getItem('token');
13      let refreshToken = localStorage.getItem('refreshToken');
14
15      return {
16        addAuthToOperation(operation) {
17          if (token) {
18            return utils.appendHeaders(operation, {
19              Authorization: `Bearer ${token}`,
20            });
21          }
22          return operation;
23        },
24        willAuthError(_operation) {
25          // e.g. check for expiration, existence of auth etc
26          return !token;
27        },
28        didAuthError(error, _operation) {
29          // check if the error was an auth error
30          // this can be implemented in various ways, e.g. 401 or a special error code
31          return error.graphQLErrors.some(e => e.extensions?.code === 'FORBIDDEN');
32        },
33        async refreshAuth() {
34          // called when auth error has occurred
35          // we should refresh the token with a GraphQL mutation or a fetch call,
36          // depending on what the API supports
37          const result = await mutate(refreshMutation, {
38            token: authState?.refreshToken,
39          });
40
41          if (result.data?.refreshLogin) {
42            // save the new tokens in storage for next restart
43            token = result.data.refreshLogin.token;
44            refreshToken = result.data.refreshLogin.refreshToken;
45            localStorage.setItem('token', token);
46            localStorage.setItem('refreshToken', refreshToken);
47          } else {
48            // otherwise, if refresh fails, log clear storage and log out
49            localStorage.clear();
50            logout();
51          }
52        },
53      };
54    }),
55    fetchExchange,
56  ],
57});

Handling Errors via the errorExchange

Handling the logout logic in refreshAuth is the easiest way to get started, but it means the errors will always get swallowed by the authExchange. If you want to handle errors globally, this can be done using the mapExchange:

1import { mapExchange } from 'urql';
2
3// this needs to be placed ABOVE the authExchange in the exchanges array, otherwise the auth error
4// will show up hear before the auth exchange has had the chance to handle it
5mapExchange({
6  onError(error) {
7    // we only get an auth error here when the auth exchange had attempted to refresh auth and
8    // getting an auth error again for the second time
9    const isAuthError = error.graphQLErrors.some(
10      e => e.extensions?.code === 'FORBIDDEN',
11    );
12    if (isAuthError) {
13      // clear storage, log the user out etc
14    }
15  }
16}),