add clientSetup codemod
#12851
Merged
add clientSetup codemod
#12851
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 0b00e09 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
size-limit report 📦
|
commit: |
✅ Docs preview readyThe preview is ready to be viewed. View the preview File Changes 32 new, 64 changed, 7 removedBuild ID: 65226bf5d5f9206282bf39b3 URL: https://www.apollographql.com/docs/deploy-preview/65226bf5d5f9206282bf39b3 |
phryneas
changed the title
apolloClientInitialization codemodclientSetup codemod
phryneas
commented
Aug 20, 2025
| } | ||
| const enabledStepNames = | ||
| Array.isArray(options.apolloClientInitialization) ? | ||
| options.apolloClientInitialization |
Member
Author
There was a problem hiding this comment.
This option is only meant for our tests to enable individual codemods, not for end users, that would get too granular.
phryneas
commented
Aug 20, 2025
Comment on lines
+102
to
+118
| /* | ||
| Start: Inserted by Apollo Client 3->4 migration codemod. | ||
| Copy the contents of this block into a \`.d.ts\` file in your project | ||
| to enable data masking types. | ||
| */ | ||
| import "@apollo/client"; | ||
| import { GraphQLCodegenDataMasking } from "@apollo/client/masking"; | ||
| declare module "@apollo/client" { | ||
| export interface TypeOverrides extends GraphQLCodegenDataMasking.TypeOverrides {} | ||
| } | ||
| /* | ||
| End: Inserted by Apollo Client 3->4 migration codemod. | ||
| */ |
Member
Author
There was a problem hiding this comment.
This is inserted at the end of the file if dataMasking: true is detected in the options and it is a .ts/.tsx file.
The dataMasking: true gets an additional comment like
/*
Inserted by Apollo Client 3->4 migration codemod.
Keep this comment here if you intend to run the codemod again,
to avoid changes from being reapplied.
Delete this comment once you are done with the migration.
@apollo/client-codemod-migrate-3-to-4 applied
*/
dataMasking: true,and as long as at least
/* @apollo/client-codemod-migrate-3-to-4 applied */
dataMasking: true,stays in place, this will not be added to the file a second time when rerunning the codemod, even if the user deletes the block or moves it out into a separate file as instructed.
phryneas
commented
Aug 20, 2025
Comment on lines
+121
to
+138
| /* | ||
| Start: Inserted by Apollo Client 3->4 migration codemod. | ||
| Copy the contents of this block into a \`.d.ts\` file in your project to enable correct response types in your custom links. | ||
| If you do not use the \`@defer\` directive in your application, you can safely remove this block. | ||
| */ | ||
| import "@apollo/client"; | ||
| import { Defer20220824Handler } from "@apollo/client/incremental"; | ||
| declare module "@apollo/client" { | ||
| export interface TypeOverrides extends Defer20220824Handler.TypeOverrides {} | ||
| } | ||
| /* | ||
| End: Inserted by Apollo Client 3->4 migration codemod. | ||
| */" | ||
| `); |
Member
Author
There was a problem hiding this comment.
This is added at the end of the file if incrementalHandler was not present in the options previously and it is a .ts/.tsx file.
phryneas
commented
Aug 20, 2025
Comment on lines
+94
to
+99
| /* | ||
| Inserted by Apollo Client 3->4 migration codemod. | ||
| If you are not using the \`@defer\` directive in your application, | ||
| you can safely remove this option. | ||
| */ | ||
| incrementalHandler: new Defer20220824Handler() |
Member
Author
There was a problem hiding this comment.
This will be added if no incrementalHandler option is found.
phryneas
commented
Aug 20, 2025
Comment on lines
+482
to
+487
| /* | ||
| Inserted by Apollo Client 3->4 migration codemod. | ||
| If you are not using the \`@client\` directive in your application, | ||
| you can safely remove this option. | ||
| */ | ||
| localState: new LocalState({}) |
Member
Author
There was a problem hiding this comment.
If no resolvers option is found, a localState option will be added anyways, but then it has this preceding comment telling the user to delete it if they don't use @client directives.
That seemed preferrable to me over users missing out on getting it added by the codemod.
phryneas
commented
Aug 20, 2025
Comment on lines
+26
to
+30
| uri: "/graphql", | ||
| credentials: "include", | ||
| headers: { | ||
| "x-custom-header": "value", | ||
| }, |
phryneas
commented
Aug 20, 2025
| cache: new InMemoryCache(), | ||
| ssrForceFetchDelay: 50, | ||
| ssrMode: true, | ||
| connectToDevTools: true, |
Member
Author
There was a problem hiding this comment.
renamed to devTools.enabled
phryneas
commented
Aug 20, 2025
| defaultOptions: {}, | ||
| defaultContext: {}, | ||
| assumeImmutableResults: true, | ||
| resolvers: myResolvers, |
phryneas
commented
Aug 20, 2025
Comment on lines
+40
to
+41
| typeDefs: mySchema, | ||
| fragmentMatcher: () => true, |
phryneas
commented
Aug 20, 2025
Comment on lines
+42
to
+43
| name: "my-client", | ||
| version: "1.0.0", |
Member
Author
There was a problem hiding this comment.
moving into clientAwareness
jerelmiller
reviewed
Aug 20, 2025
jerelmiller
reviewed
Aug 20, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.