Refresh session on 401 for graphQL requests

[catlee]

WHY are these changes introduced?

When running shopify theme dev for long periods of time, the session can timeout and needs to be refreshed. The client will receive 401 errors from the server until the session is refreshed.

We've fixed this for REST calls in #4790.

This PR does the same for graphQL calls.

Fixes #4897

WHAT is this pull request doing?

@karreiro and I decided the best way to approach this was to extend the functionality of retryAwareRequest so that when a 401 error occurs, and an unauthorizedHandler is provided, then we call the unauthorizedHandler and retry the request.

Further up the stack in the graphQL code, we use the session's refresh function as the unauthorizedHandler.

Checklist

• I've considered possible cross-platform impacts (Mac, Linux, Windows)
• I've considered possible documentation changes

[github-actions]

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

• Some seemingly private modules might be re-exported through public modules.
• If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/private/node/api.d.ts

@@ -12,7 +12,7 @@ export declare function simpleRequestWithDebugLog<T extends {
 export declare function retryAwareRequest<T extends {
     headers: Headers;
     status: number;
-}>({ request, url }: RequestOptions<T>, errorHandler?: (error: unknown, requestId: string | undefined) => unknown, retryOptions?: {
+}>({ request, url }: RequestOptions<T>, errorHandler?: (error: unknown, requestId: string | undefined) => unknown, unauthorizedHandler?: () => Promise<void>, retryOptions?: {
     limitRetriesTo?: number;
     defaultDelayMs?: number;
     scheduleDelay: (fn: () => void, delay: number) => void;

packages/cli-kit/dist/public/node/api/graphql.d.ts

@@ -21,12 +21,14 @@ interface GraphQLRequestBaseOptions<TResult> {
 export type GraphQLRequestOptions<T> = GraphQLRequestBaseOptions<T> & {
     query: RequestDocument;
     variables?: Variables;
+    unauthorizedHandler?: () => Promise<void>;
 };
 export type GraphQLRequestDocOptions<TResult, TVariables> = GraphQLRequestBaseOptions<TResult> & {
     query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{
         [key: string]: never;
     }>>;
     variables?: TVariables;
+    unauthorizedHandler?: () => Promise<void>;
 };
 export interface GraphQLResponseOptions<T> {
     handleErrors?: boolean;

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟡	Statements	75.33% (-0.1% 🔻)	8740/11603
🟡	Branches	70.63% (-0.08% 🔻)	4269/6044
🟡	Functions	75.03% (-0.07% 🔻)	2287/3048
🟡	Lines	75.88% (-0.1% 🔻)	8263/10889

Show files with reduced coverage 🔻

St.❔	File	Statements	Branches	Functions	Lines
🟢	... / app-event-watcher.ts	93.83% (-1.23% 🔻)	86.49% (-2.7% 🔻)	90.48%	98.61%
🟡	... / api.ts	65.91% (-1.18% 🔻)	45.76% (+1.76% 🔼)	77.78%	65.88% (-1.22% 🔻)
🟢	... / admin.ts	80% (-1.4% 🔻)	50%	90.91%	81.82% (-1.52% 🔻)
🔴	... / api.ts	51.13% (-6.77% 🔻)	46.97% (-4.55% 🔻)	48.39% (-6.45% 🔻)	52% (-7.2% 🔻)
🔴	... / factories.ts	42.11% (-5.26% 🔻)	33.33% (-6.67% 🔻)	60%	50% (-6.25% 🔻)

Test suite run success

1968 tests passing in 892 suites.

Report generated by 🧪jest coverage report action from 80ec997

[github-actions]

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run "pnpm changeset add" to track your changes and include them in the next release CHANGELOG.

[lukeh-shopify]

This is a cool approach, thank you for taking this on 😅

[karreiro]

Thank you, @catlee! LGTM and works as expected too :)