major(core|persisted): use GET for queries by default (#3789)

Author: JoviDeCroock

.changeset/giant-pets-buy.md

@@ -0,0 +1,9 @@
+---
+'@urql/exchange-persisted': major
+'@urql/core': major
+---
+
+By default leverage GET for queries where the query-string + variables comes down to less than 2048 characters.
+When upgrading it's important to see whether your server supports `GET`, if it doesn't ideally adding support for it
+or alternatively setting `preferGetMethod` in the `createClient` method as well as `preferGetForPersistedQueries` for
+the persisted exchange to `false`.

exchanges/persisted/src/persistedExchange.ts

@@ -44,7 +44,7 @@ export interface PersistedExchangeOptions {
    * GET requests are frequently used to make GraphQL requests more
    * cacheable on CDNs.
    *
-   * @defaultValue `undefined` - disabled
+   * @defaultValue `within-url-limit` - Use GET requests for persisted queries within the URL limit.
    */
   preferGetForPersistedQueries?: OperationContext['preferGetMethod'];
   /** Enforces non-automatic persisted queries by ignoring APQ errors.
@@ -137,7 +137,8 @@ export const persistedExchange =
   ({ forward }) => {
     if (!options) options = {};
 
-    const preferGetForPersistedQueries = options.preferGetForPersistedQueries;
+    const preferGetForPersistedQueries =
+      options.preferGetForPersistedQueries || 'within-url-limit';
     const enforcePersistedQueries = !!options.enforcePersistedQueries;
     const hashFn = options.generateHash || hash;
     const enableForMutation = !!options.enableForMutation;

packages/core/src/client.test.ts

@@ -148,7 +148,7 @@ describe('promisified methods', () => {
       fetchOptions: undefined,
       fetch: undefined,
       suspense: false,
-      preferGetMethod: undefined,
+      preferGetMethod: 'within-url-limit',
     });
     expect(queryResult).toHaveProperty('then');
   });
@@ -174,7 +174,7 @@ describe('promisified methods', () => {
       fetchOptions: undefined,
       fetch: undefined,
       suspense: false,
-      preferGetMethod: undefined,
+      preferGetMethod: 'within-url-limit',
     });
     expect(mutationResult).toHaveProperty('then');
   });

packages/core/src/client.ts

@@ -549,7 +549,7 @@ export const Client: new (opts: ClientOptions) => Client = function Client(
     fetchSubscriptions: opts.fetchSubscriptions,
     fetchOptions: opts.fetchOptions,
     fetch: opts.fetch,
-    preferGetMethod: opts.preferGetMethod,
+    preferGetMethod: opts.preferGetMethod || 'within-url-limit',
     requestPolicy: opts.requestPolicy || 'cache-first',
   };