remove `react/context|hooks|parser` entry points, remove `parser` utils completely #12513

phryneas · 2025-04-02T17:00:10Z

…

changeset-bot · 2025-04-02T17:00:15Z

🦋 Changeset detected

Latest commit: 19ef2c9

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	Major

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

svc-apollo-docs · 2025-04-02T17:00:55Z

⚠️ Docs preview not attached to branch

The preview was not built because the PR's base branch release-4.0 is not in the list of sources.

An Apollo team member can comment one of the following commands to dictate which branch to attach the preview to:

!docs set-base-branch version-2.6
!docs set-base-branch main

Build ID: 730ad61b0e9297ceae71e415

pkg-pr-new · 2025-04-02T17:01:30Z

npm i https://pkg.pr.new/@apollo/client@12513

commit: 69636a3

github-actions · 2025-04-02T17:02:01Z

size-limit report 📦

Path	Size
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (CJS)	41.82 KB (-0.32% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production) (CJS)	37.46 KB (+0.09% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client"	31.97 KB (-0.67% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production)	27.1 KB (+0.09% 🔺)
import { ApolloProvider } from "@apollo/client/react"	5.03 KB (-4.4% 🔽)
import { ApolloProvider } from "@apollo/client/react" (production)	962 B (-0.42% 🔽)
import { useQuery } from "@apollo/client/react"	6.31 KB (-11.1% 🔽)
import { useQuery } from "@apollo/client/react" (production)	2.2 KB (-20.42% 🔽)
import { useLazyQuery } from "@apollo/client/react"	6.26 KB (-3.89% 🔽)
import { useLazyQuery } from "@apollo/client/react" (production)	2.17 KB (-0.14% 🔽)
import { useMutation } from "@apollo/client/react"	5.63 KB (-12.78% 🔽)
import { useMutation } from "@apollo/client/react" (production)	1.53 KB (-27.69% 🔽)
import { useSubscription } from "@apollo/client/react"	5.92 KB (-12.07% 🔽)
import { useSubscription } from "@apollo/client/react" (production)	1.82 KB (-24.33% 🔽)
import { useSuspenseQuery } from "@apollo/client/react"	7.68 KB (-7.55% 🔽)
import { useSuspenseQuery } from "@apollo/client/react" (production)	3.58 KB (-10.55% 🔽)
import { useBackgroundQuery } from "@apollo/client/react"	7.49 KB (-8.12% 🔽)
import { useBackgroundQuery } from "@apollo/client/react" (production)	3.42 KB (-11.01% 🔽)
import { useLoadableQuery } from "@apollo/client/react"	7.51 KB (-7.92% 🔽)
import { useLoadableQuery } from "@apollo/client/react" (production)	3.44 KB (-10.98% 🔽)
import { useReadQuery } from "@apollo/client/react"	5.71 KB (-3.81% 🔽)
import { useReadQuery } from "@apollo/client/react" (production)	1.61 KB (-0.31% 🔽)
import { useFragment } from "@apollo/client/react"	5.76 KB (-3.93% 🔽)
import { useFragment } from "@apollo/client/react" (production)	1.68 KB (-0.12% 🔽)

…tType` to `utilities`

netlify · 2025-04-02T20:37:56Z

✅ Deploy Preview for apollo-client-docs ready!

Name	Link
🔨 Latest commit	`69636a3`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-client-docs/deploys/67ee4ef4a5e80e0008442aef
😎 Deploy Preview	https://deploy-preview-12513--apollo-client-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

phryneas · 2025-04-03T08:08:04Z

src/react/parser/index.ts

-  invariant(
-    !!document && !!document.kind,
-    `Argument of %s passed to parser was not a valid GraphQL ` +
-      `DocumentNode. You may need to use 'graphql-tag' or another method ` +
-      `to convert your operation into a document`,
-    document
-  );


Covered by

apollo-client/src/utilities/graphql/getFromAST.ts

Lines 21 to 25 in ca9089b

invariant(

doc && doc.kind === "Document",

`Expecting a parsed GraphQL document. Perhaps you need to wrap the query \

string in a "gql" tag? http://docs.apollostack.com/apollo-client/core.html#gql`

);

phryneas · 2025-04-03T08:10:08Z

src/react/parser/index.ts

-  invariant(
-    queries.length + mutations.length + subscriptions.length <= 1,
-    `react-apollo only supports a query, subscription, or a mutation per HOC. ` +
-      `%s had %s queries, %s ` +
-      `subscriptions and %s mutations. ` +
-      `You can use 'compose' to join multiple operation types to a component`,
-    document,
-    queries.length,
-    subscriptions.length,
-    mutations.length
-  );


Covered by

apollo-client/src/utilities/graphql/getFromAST.ts

Lines 39 to 43 in ca9089b

invariant(

operations.length <= 1,

`Ambiguous GraphQL document: contains %s operations`,

operations.length

);

phryneas · 2025-04-03T08:10:48Z

src/react/parser/index.ts

-  invariant(
-    definitions.length === 1,
-    `react-apollo only supports one definition per HOC. %s had ` +
-      `%s definitions. ` +
-      `You can use 'compose' to join multiple operation types to a component`,
-    document,
-    definitions.length
-  );


Also covered by

apollo-client/src/utilities/graphql/getFromAST.ts

Lines 39 to 43 in ca9089b

invariant(

operations.length <= 1,

`Ambiguous GraphQL document: contains %s operations`,

operations.length

);

phryneas · 2025-04-03T08:33:33Z

src/react/parser/index.ts

-  invariant(
-    operation.type === type,
-    `Running a %s requires a graphql ` + `%s, but a %s was used instead.`,
-    requiredOperationName,
-    requiredOperationName,
-    usedOperationName
-  );


Added a new optional check here:

apollo-client/src/utilities/graphql/getFromAST.ts

Line 49 in 9c3d2ee

if (expectedType) {

phryneas · 2025-04-03T08:34:30Z

src/react/hooks/useMutation.ts

  >
 ): useMutation.ResultTuple<TData, TVariables, TContext, TCache> {
  const client = useApolloClient(options?.client);
-  verifyDocumentType(mutation, DocumentType.Mutation);


These checks all moved into QueryManager, and since they now are not executed on every render, but only if an operation is started, they also don't need caching.

phryneas · 2025-04-03T08:36:59Z

src/__tests__/__snapshots__/exports.ts.snap

-  "operationName",
-  "parser",
-  "useApolloClient",
-  "useBackgroundQuery",
-  "useFragment",
-  "useLazyQuery",


This diff is not really nice, it looks like "removed" here and then merges in a removed entry point with the same exports further down.

phryneas · 2025-04-03T08:41:45Z

src/core/QueryManager.ts


 const { hasOwnProperty } = Object.prototype;

-// TODO(brian): A hack until this issue is resolved (https://github.com/graphql/graphql-js/issues/3356)


This means we have to drop GraphQL 15 compat, which we probably should do anyways.

phryneas · 2025-04-03T08:48:48Z

src/react/context/ApolloConsumer.tsx

+declare namespace ApolloConsumer {
+  export interface Props {
+    children: (client: ApolloClient) => ReactTypes.ReactNode;
+  }


This was previously exported from /react/context, but not from /react. I don't want to add more noise to /react, and this keeps it available for use from the outside.

Same for ApolloProvider.

Should this be called out in the changelog?

Tbh., I don't think anyone ever used those - it would probably be more noise than it would be worth.

jerelmiller · 2025-04-03T15:45:11Z

src/utilities/caching/__tests__/getMemoryInternals.ts

 } from "@apollo/client/core";
 import { createPersistedQueryLink } from "@apollo/client/link/persisted-queries";
 import { removeTypenameFromVariables } from "@apollo/client/link/remove-typename";
-// importing react so the `parser` cache initializes


nice to see this gone 🎉

jerelmiller · 2025-04-03T15:46:22Z

src/utilities/graphql/getFromAST.ts


 // Checks the document for errors and throws an exception if there is an error.
-export function checkDocument(doc: DocumentNode) {
+export function checkDocument(


This would be a good candidate to move to utilities/internal. Adding this as a reminder to do in #12194

jerelmiller

Looks great!

jerelmiller force-pushed the pr/use-more-offical-exports-in-tests branch from 40999b8 to d176cbd Compare April 2, 2025 20:17

Base automatically changed from pr/use-more-offical-exports-in-tests to release-4.0 April 2, 2025 20:31

phryneas added 6 commits April 2, 2025 14:31

remove react/context|hooks|parser entry points, move `verifyDocumen…

06aedd0

…tType` to `utilities`

verifyDocumentType: remove parser cache

b6313a9

call verifyDocumentType from QueryManager, not in the hooks

52e88a2

dead code

89e8344

cleanup

386c604

fix build

d3dc528

jerelmiller force-pushed the pr/remove-some-react-entrypoints branch from 98ade11 to d3dc528 Compare April 2, 2025 20:36

phryneas added 3 commits April 3, 2025 09:48

linter fixup

f276087

format

a576770

update snapshot

ca9089b

phryneas commented Apr 3, 2025

View reviewed changes

use checkDocument instead of verifyDocumentType

9c3d2ee

phryneas changed the title ~~remove react/context|hooks|parser entry points, move verifyDocumentType to utilities~~ remove react/context|hooks|parser entry points, remove parser utils completely Apr 3, 2025

phryneas commented Apr 3, 2025

View reviewed changes

phryneas added 2 commits April 3, 2025 10:38

remove import

5fa99bd

api-extractor

9c083d3

phryneas commented Apr 3, 2025

View reviewed changes

phryneas added 2 commits April 3, 2025 10:43

update size-limits

8e78835

move props into namespace

ad863f4

phryneas commented Apr 3, 2025

View reviewed changes

phryneas added 3 commits April 3, 2025 10:49

api-extractor

cfba9a9

changesets

19ef2c9

Merge branch 'release-4.0' into pr/remove-some-react-entrypoints

69636a3

phryneas marked this pull request as ready for review April 3, 2025 09:03

phryneas requested a review from jerelmiller April 3, 2025 09:03

jerelmiller reviewed Apr 3, 2025

View reviewed changes

jerelmiller approved these changes Apr 3, 2025

View reviewed changes

github-actions bot added the auto-cleanup 🤖 label Apr 3, 2025

phryneas merged commit 9c3207c into release-4.0 Apr 3, 2025
57 checks passed

github-actions bot mentioned this pull request Apr 3, 2025

Version Packages (alpha) #12521

Merged

phryneas deleted the pr/remove-some-react-entrypoints branch April 3, 2025 15:50

github-actions bot locked as resolved and limited conversation to collaborators May 4, 2025

	invariant(
	doc && doc.kind === "Document",
	`Expecting a parsed GraphQL document. Perhaps you need to wrap the query \
	string in a "gql" tag? http://docs.apollostack.com/apollo-client/core.html#gql`
	);

	invariant(
	operations.length <= 1,
	`Ambiguous GraphQL document: contains %s operations`,
	operations.length
	);


		const { hasOwnProperty } = Object.prototype;

		// TODO(brian): A hack until this issue is resolved (https://github.com/graphql/graphql-js/issues/3356)

remove react/context|hooks|parser entry points, remove parser utils completely #12513

remove react/context|hooks|parser entry points, remove parser utils completely #12513

Uh oh!

Conversation

phryneas commented Apr 2, 2025

Uh oh!

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

Uh oh!

🦋 Changeset detected

Uh oh!

svc-apollo-docs commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ Docs preview not attached to branch

Uh oh!

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

Uh oh!

Uh oh!

github-actions bot commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

netlify bot commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for apollo-client-docs ready!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phryneas Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jerelmiller Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jerelmiller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

remove `react/context|hooks|parser` entry points, remove `parser` utils completely #12513

remove `react/context|hooks|parser` entry points, remove `parser` utils completely #12513

changeset-bot bot commented Apr 2, 2025 •

edited

Loading

svc-apollo-docs commented Apr 2, 2025 •

edited

Loading

pkg-pr-new bot commented Apr 2, 2025 •

edited

Loading

github-actions bot commented Apr 2, 2025 •

edited

Loading

netlify bot commented Apr 2, 2025 •

edited

Loading

phryneas Apr 3, 2025 •

edited

Loading

jerelmiller Apr 3, 2025 •

edited

Loading