Currently, @urql/exchange-persisted's options.preferGetForPersistedQueries doesn't allow for persistedOperation.context.preferGetMethod to be set to true or 'within-url-limit', and instead sets persistedOperation.context.preferGetMethod to 'force' when options.preferGetForPersistedQueries is true. This leads to broken GET requests when queries become massive.
Another issue was that although the TSDocs suggest that the default value of options.preferGetForPersistedQueries is true, this wasn't reflected in the logic.
Set of changes
In @urql/exchange-persisted:
The type of options.preferGetForPersistedQueries has changed from boolean | undefined to match the value of the Client's preferGetMethod option, which includes 'force' and 'within-url-limit'.
Sets a default value of options.preferGetForPersistedQueries (to true) to match the TSDocs.
When options.preferGetForPersistedQueries is true, we no longer set operation.context.preferGetMethod to 'force'. Instead, operation.context.preferGetMethod is set to true.
This extends to all values of options.preferGetForPersistedQueries. The value set there will be the value set in operation.context.preferGetMethod.
Removes a check on the value of preferGetForPersistedQueries before setting persistedOperation.context.preferGetMethod. This allows persistedOperation.context.preferGetMethod to be set to false if options.preferGetForPersistedQueries is set to false.
Adds unit tests to validate the changes described here.
Summary
This PR aims to resolve https://github.com/urql-graphql/urql/issues/3185.
Currently,
@urql/exchange-persisted'soptions.preferGetForPersistedQueriesdoesn't allow forpersistedOperation.context.preferGetMethodto be set totrueor'within-url-limit', and instead setspersistedOperation.context.preferGetMethodto'force'whenoptions.preferGetForPersistedQueriesistrue. This leads to broken GET requests when queries become massive.Another issue was that although the TSDocs suggest that the default value of
options.preferGetForPersistedQueriesistrue, this wasn't reflected in the logic.Set of changes
In
@urql/exchange-persisted:options.preferGetForPersistedQuerieshas changed fromboolean | undefinedto match the value of the Client'spreferGetMethodoption, which includes'force'and'within-url-limit'.options.preferGetForPersistedQueries(totrue) to match the TSDocs.options.preferGetForPersistedQueriesistrue, we no longer setoperation.context.preferGetMethodto'force'. Instead,operation.context.preferGetMethodis set totrue.options.preferGetForPersistedQueries. The value set there will be the value set inoperation.context.preferGetMethod.preferGetForPersistedQueriesbefore settingpersistedOperation.context.preferGetMethod. This allowspersistedOperation.context.preferGetMethodto be set tofalseifoptions.preferGetForPersistedQueriesis set tofalse.