add a `removals` codemod by phryneas · Pull Request #12838 · apollographql/apollo-client

phryneas · 2025-08-11T15:04:35Z

No description provided.

changeset-bot · 2025-08-11T15:04:39Z

🦋 Changeset detected

Latest commit: 898d51f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@apollo/client-codemod-migrate-3-to-4	Minor

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

pkg-pr-new · 2025-08-11T15:06:14Z

npm i https://pkg.pr.new/apollographql/apollo-client/@apollo/client@12838

commit: 898d51f

github-actions · 2025-08-11T15:06:35Z

size-limit report 📦

Path	Size
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (CJS)	42.83 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production) (CJS)	37.74 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client"	32.83 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production)	27 KB (0%)
import { ApolloProvider } from "@apollo/client/react"	5.9 KB (0%)
import { ApolloProvider } from "@apollo/client/react" (production)	971 B (0%)
import { useQuery } from "@apollo/client/react"	7.21 KB (0%)
import { useQuery } from "@apollo/client/react" (production)	2.23 KB (0%)
import { useLazyQuery } from "@apollo/client/react"	7.1 KB (0%)
import { useLazyQuery } from "@apollo/client/react" (production)	2.13 KB (0%)
import { useMutation } from "@apollo/client/react"	6.45 KB (0%)
import { useMutation } from "@apollo/client/react" (production)	1.48 KB (0%)
import { useSubscription } from "@apollo/client/react"	6.77 KB (0%)
import { useSubscription } from "@apollo/client/react" (production)	1.79 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react"	8.57 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react" (production)	3.63 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react"	8.33 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react" (production)	3.38 KB (0%)
import { useLoadableQuery } from "@apollo/client/react"	8.28 KB (0%)
import { useLoadableQuery } from "@apollo/client/react" (production)	3.36 KB (0%)
import { useReadQuery } from "@apollo/client/react"	6.59 KB (0%)
import { useReadQuery } from "@apollo/client/react" (production)	1.63 KB (0%)
import { useFragment } from "@apollo/client/react"	6.66 KB (0%)
import { useFragment } from "@apollo/client/react" (production)	1.69 KB (0%)

apollo-librarian · 2025-08-11T15:08:19Z

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

26 new, 66 changed, 5 removed

+ (developer-tools)/react/(latest)/api/link/apollo-link-base-batch-http.mdx
+ (developer-tools)/react/(latest)/api/link/apollo-link-base-http.mdx
+ (developer-tools)/react/(latest)/api/link/apollo-link-batch.mdx
+ (developer-tools)/react/(latest)/api/link/apollo-link-client-awareness.mdx
+ (developer-tools)/react/(latest)/api/link/apollo-link.mdx
+ (developer-tools)/react/(latest)/api/react/ApolloProvider.mdx
+ (developer-tools)/react/(latest)/api/react/skipToken.mdx
+ (developer-tools)/react/(latest)/api/react/useApolloClient.mdx
+ (developer-tools)/react/(latest)/api/react/useBackgroundQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useFragment.mdx
+ (developer-tools)/react/(latest)/api/react/useLazyQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useLoadableQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useMutation.mdx
+ (developer-tools)/react/(latest)/api/react/useQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useQueryRefHandlers.mdx
+ (developer-tools)/react/(latest)/api/react/useReactiveVar.mdx
+ (developer-tools)/react/(latest)/api/react/useReadQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useSubscription.mdx
+ (developer-tools)/react/(latest)/api/react/useSuspenseQuery.mdx
+ (developer-tools)/react/(latest)/api/errors/CombinedGraphQLErrors.mdx
+ (developer-tools)/react/(latest)/api/errors/CombinedProtocolErrors.mdx
+ (developer-tools)/react/(latest)/api/errors/LinkError.mdx
+ (developer-tools)/react/(latest)/api/errors/LocalStateError.mdx
+ (developer-tools)/react/(latest)/api/errors/ServerError.mdx
+ (developer-tools)/react/(latest)/api/errors/ServerParseError.mdx
+ (developer-tools)/react/(latest)/api/errors/UnconventionalError.mdx
* (developer-tools)/react/(latest)/get-started.mdx
* (developer-tools)/react/(latest)/index.mdx
* (developer-tools)/react/(latest)/why-apollo.mdx
* (developer-tools)/react/(latest)/api/cache/InMemoryCache.mdx
* (developer-tools)/react/(latest)/api/core/ApolloClient.mdx
* (developer-tools)/react/(latest)/api/core/ObservableQuery.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-batch-http.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-context.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-error.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-http.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-remove-typename.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-retry.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-schema.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-subscriptions.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-ws.mdx
* (developer-tools)/react/(latest)/api/link/community-links.mdx
* (developer-tools)/react/(latest)/api/link/introduction.mdx
* (developer-tools)/react/(latest)/api/link/persisted-queries.mdx
* (developer-tools)/react/(latest)/api/react/hooks.mdx
* (developer-tools)/react/(latest)/api/react/preloading.mdx
* (developer-tools)/react/(latest)/api/react/ssr.mdx
* (developer-tools)/react/(latest)/api/react/testing.mdx
* (developer-tools)/react/(latest)/caching/advanced-topics.mdx
* (developer-tools)/react/(latest)/caching/cache-configuration.mdx
* (developer-tools)/react/(latest)/caching/cache-field-behavior.mdx
* (developer-tools)/react/(latest)/caching/cache-interaction.mdx
* (developer-tools)/react/(latest)/caching/garbage-collection.mdx
* (developer-tools)/react/(latest)/caching/memory-management.mdx
* (developer-tools)/react/(latest)/caching/overview.mdx
* (developer-tools)/react/(latest)/data/defer.mdx
* (developer-tools)/react/(latest)/data/directives.mdx
* (developer-tools)/react/(latest)/data/document-transforms.mdx
* (developer-tools)/react/(latest)/data/error-handling.mdx
* (developer-tools)/react/(latest)/data/file-uploads.mdx
* (developer-tools)/react/(latest)/data/fragments.mdx
* (developer-tools)/react/(latest)/data/mutations.mdx
* (developer-tools)/react/(latest)/data/operation-best-practices.mdx
* (developer-tools)/react/(latest)/data/queries.mdx
* (developer-tools)/react/(latest)/data/refetching.mdx
* (developer-tools)/react/(latest)/data/subscriptions.mdx
* (developer-tools)/react/(latest)/data/suspense.mdx
* (developer-tools)/react/(latest)/development-testing/client-schema-mocking.mdx
* (developer-tools)/react/(latest)/development-testing/developer-tooling.mdx
* (developer-tools)/react/(latest)/development-testing/schema-driven-testing.mdx
* (developer-tools)/react/(latest)/development-testing/static-typing.mdx
* (developer-tools)/react/(latest)/development-testing/testing.mdx
* (developer-tools)/react/(latest)/integrations/integrations.mdx
* (developer-tools)/react/(latest)/integrations/react-native.mdx
* (developer-tools)/react/(latest)/integrations/webpack.mdx
* (developer-tools)/react/(latest)/local-state/local-resolvers.mdx
* (developer-tools)/react/(latest)/local-state/local-state-management.mdx
* (developer-tools)/react/(latest)/local-state/managing-state-with-field-policies.mdx
* (developer-tools)/react/(latest)/local-state/reactive-variables.mdx
* (developer-tools)/react/(latest)/migrating/apollo-client-3-migration.mdx
* (developer-tools)/react/(latest)/networking/advanced-http-networking.mdx
* (developer-tools)/react/(latest)/networking/authentication.mdx
* (developer-tools)/react/(latest)/networking/basic-http-networking.mdx
* (developer-tools)/react/(latest)/pagination/core-api.mdx
* (developer-tools)/react/(latest)/pagination/cursor-based.mdx
* (developer-tools)/react/(latest)/pagination/key-args.mdx
* (developer-tools)/react/(latest)/pagination/offset-based.mdx
* (developer-tools)/react/(latest)/performance/babel.mdx
* (developer-tools)/react/(latest)/performance/optimistic-ui.mdx
* (developer-tools)/react/(latest)/performance/performance.mdx
* (developer-tools)/react/(latest)/performance/server-side-rendering.mdx
* (developer-tools)/react/(latest)/_sidebar.yaml
- (developer-tools)/react/(latest)/api/link/apollo-link-rest.mdx
- (developer-tools)/react/(latest)/api/react/components.mdx
- (developer-tools)/react/(latest)/api/react/hoc.mdx
- (developer-tools)/react/(latest)/local-state/client-side-schema.mdx
- (developer-tools)/react/(latest)/migrating/hooks-migration.mdx

Build ID: 731b5e09c43e02ff1a5f0784
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/731b5e09c43e02ff1a5f0784

jerelmiller

Let's connect and bike shed on the entrypoint name, but I love this PR!

jerelmiller · 2025-08-14T14:55:24Z

      "default": "./src/utilities/environment/index.ts"
-    }
+    },
+    "./zz_removals": "./src/zz_removals.ts"


I love every part of this PR except this name 😆. What about something like v4-migration?

Yeah I hate it too, I just wanted it to be alphabetically sorted to the end so users don't accidentally use it.
If we don't plan for entrypoints starting with w, x, y, or z, v4-migration sounds great!

jerelmiller · 2025-08-14T14:57:41Z

+ * docblocks will explain the removal and suggest alternatives.
+ */
+
+export declare namespace Removals {


Note for the upgrade guide: we will probably want to mention that any non-type exported from this entrypoint will cause runtime errors.

add a removals codemod

f6bd94d

phryneas force-pushed the pr/removals-codemod branch from f9d37d0 to 6265da5 Compare August 11, 2025 15:15

phryneas added 3 commits August 11, 2025 17:57

more removal annotations

f910f52

document most removals

a16b2aa

rename to zz_removals, clean up

c8ea359

phryneas force-pushed the pr/removals-codemod branch from 69f4806 to 56e2502 Compare August 12, 2025 09:20

declare classes as classes

7a3c8ca

phryneas force-pushed the pr/removals-codemod branch from 4c80e90 to 5944a3e Compare August 13, 2025 09:03

jerelmiller approved these changes Aug 14, 2025

View reviewed changes

github-actions Bot added the auto-cleanup 🤖 label Aug 14, 2025

phryneas and others added 2 commits August 14, 2025 18:20

zz-removals -> v4-migration

5128961

Clean up Prettier, Size-limit, and Api-Extractor

898d51f

jerelmiller approved these changes Aug 14, 2025

View reviewed changes

phryneas force-pushed the pr/removals-codemod branch from 642973d to 898d51f Compare August 15, 2025 08:17

phryneas changed the base branch from pr/update-import-codemod to release-4.0 August 15, 2025 08:20

phryneas merged commit b005561 into release-4.0 Aug 15, 2025
37 checks passed

jerelmiller mentioned this pull request Aug 15, 2025

Adds changeset for #12838 #12844

Merged

jerelmiller added a commit that referenced this pull request Aug 15, 2025

Adds changeset for #12838 (#12844)

18a0cad

jerelmiller deleted the pr/removals-codemod branch August 15, 2025 20:30

jerelmiller mentioned this pull request Aug 15, 2025

Version Packages (rc) #12845

Merged

github-actions Bot locked as resolved and limited conversation to collaborators Sep 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

add a `removals` codemod - #12838

add a `removals` codemod#12838
phryneas merged 7 commits into
release-4.0from
pr/removals-codemod

phryneas commented Aug 11, 2025

Uh oh!

changeset-bot Bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

apollo-librarian Bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

jerelmiller left a comment

Uh oh!

jerelmiller Aug 14, 2025

Uh oh!

phryneas Aug 14, 2025

Uh oh!

jerelmiller Aug 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

phryneas commented Aug 11, 2025

Uh oh!

changeset-bot Bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

pkg-pr-new Bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

apollo-librarian Bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Docs preview ready

Uh oh!

jerelmiller left a comment

Choose a reason for hiding this comment

Uh oh!

jerelmiller Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

phryneas Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

jerelmiller Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

changeset-bot Bot commented Aug 11, 2025 •

edited

Loading

pkg-pr-new Bot commented Aug 11, 2025 •

edited

Loading

github-actions Bot commented Aug 11, 2025 •

edited

Loading

apollo-librarian Bot commented Aug 11, 2025 •

edited

Loading