Run Knip on 4.0 branch #12291

phryneas · 2025-01-22T14:27:58Z

This runs knip --fix on the 4.0 branch.

Some of these solutions might need more discussions:

Knip removed all type exports that were not accessible through our official exports. Right now, these can technically be imported from by importing them from our dist folder, but they would become inaccessible if we added an exports field.

We need to make a per-case decision on each of those if we either export them from an official entrypoint or stop exporting them.
We should probably err more on the side of "export them via official entry point", as otherwise libraries and library-like code reliant on these types might break upon build with the declarations: true tsconfig flag.

changeset-bot · 2025-01-22T14:28:02Z

🦋 Changeset detected

Latest commit: be729ad

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	Patch

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-01-22T14:28:45Z

⚠️ 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: d9fa6bbc8eb275de032746c8

pkg-pr-new · 2025-01-22T14:37:29Z

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

commit: be729ad

pkg-pr-new · 2025-01-22T14:37:30Z

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

commit: 7717fe7

github-actions · 2025-01-22T14:37:55Z

size-limit report 📦

Path	Size
dist/apollo-client.min.cjs	33.45 KB (-0.05% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs"	41.42 KB (-0.03% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production)	38.76 KB (-0.05% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js"	36.17 KB (-0.03% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production)	33.58 KB (-0.03% 🔽)
import { ApolloProvider } from "dist/react/index.js"	1.26 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production)	1.24 KB (0%)
import { useQuery } from "dist/react/index.js"	5.12 KB (-0.02% 🔽)
import { useQuery } from "dist/react/index.js" (production)	4.21 KB (+0.03% 🔺)
import { useLazyQuery } from "dist/react/index.js"	5.61 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production)	4.68 KB (+0.05% 🔺)
import { useMutation } from "dist/react/index.js"	3.62 KB (0%)
import { useMutation } from "dist/react/index.js" (production)	2.84 KB (0%)
import { useSubscription } from "dist/react/index.js"	4.43 KB (+0.05% 🔺)
import { useSubscription } from "dist/react/index.js" (production)	3.48 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js"	5.51 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production)	4.17 KB (+0.05% 🔺)
import { useBackgroundQuery } from "dist/react/index.js"	5.01 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production)	3.66 KB (0%)
import { useLoadableQuery } from "dist/react/index.js"	5.09 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production)	3.74 KB (+0.03% 🔺)
import { useReadQuery } from "dist/react/index.js"	3.41 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production)	3.35 KB (+0.03% 🔺)
import { useFragment } from "dist/react/index.js"	2.37 KB (+0.09% 🔺)
import { useFragment } from "dist/react/index.js" (production)	2.31 KB (0%)

phryneas · 2025-01-22T14:38:02Z

src/react/context/ApolloContext.ts

-/**
- * @deprecated This function has no "resetting" effect since Apollo Client 3.4.12,
- * and will be removed in the next major version of Apollo Client.
- * If you want to get the Apollo Context, use `getApolloContext` instead.
- */
-export const resetApolloContext = getApolloContext;


This was already deprecated and knip complained (rightfully so) that it's a re-export of the same thing with two names - seemed like a good time to delete it.

netlify · 2025-01-22T14:38:41Z

✅ Deploy Preview for apollo-client-docs ready!

Name	Link
🔨 Latest commit	`be729ad`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-client-docs/deploys/67978a286b0d74000863f6bc
😎 Deploy Preview	https://deploy-preview-12291--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-01-22T14:38:48Z

package.json

@@ -100,7 +101,6 @@
    "graphql-tag": "^2.12.6",
    "optimism": "^0.18.0",
    "rehackt": "^0.1.0",
-    "response-iterator": "^0.2.6",


This is an actual dependency that we apparently never referenced, since the relevant parts seem to be inlined in our code.

Good catch. Should we do this on the main branch as well?

Good idea, that package pulls in quite a lot of other dependencies.

phryneas · 2025-01-22T14:39:41Z

package.json

@@ -118,7 +118,11 @@
    "@graphql-tools/merge": "9.0.4",
    "@graphql-tools/schema": "10.0.4",
    "@graphql-tools/utils": "10.5.0",
+    "@jest/expect-utils": "29.7.0",


Knip pointed out a bunch of devDependencies that we actually never directly installed, but referenced in our code, so those were added.

Also, some that we never referenced, so they were removed.

phryneas · 2025-01-22T14:40:34Z

src/react/hooks/internal/index.ts

@@ -1,6 +1,5 @@
 // These hooks are used internally and are not exported publicly by the library
 export { useDeepMemo } from "./useDeepMemo.js";
-export { useIsomorphicLayoutEffect } from "./useIsomorphicLayoutEffect.js";


We reference this via a direct import from internal/useIsomorphicLayoutEffect.js everywhere, so this re-export was apparently never used.

Should we update those direct imports instead? I'm ok with either, but seems odd to only have one of these hooks referenced directly while the others are imported from this barrel file.

I think we were doing this with a reason - a circular import issue or something.

jerelmiller · 2025-01-22T15:30:22Z

src/cache/inmemory/helpers.ts

@@ -31,7 +31,7 @@ import {

 export const { hasOwnProperty: hasOwn } = Object.prototype;

-export function isNullish(value: any): value is null | undefined {
+function isNullish(value: any): value is null | undefined {


Should we just replace usages of this function with value == null since that does the same thing? I believe that is the one "blessed" usage of ==.

Sounds great.

e3e470d

jerelmiller · 2025-01-22T15:31:56Z

src/link/http/parseAndCheckHttpResponse.ts

@@ -133,7 +133,7 @@ export function parseHeaders(headerText: string): Record<string, string> {
  return headersInit;
 }

-export function parseJsonBody<T>(response: Response, bodyText: string): T {
+function parseJsonBody<T>(response: Response, bodyText: string): T {


I know parseAndCheckHttpResponse is surprisingly popular among 3rd party links. We should probably check a few to see if these are ever used. We may want to keep these exports (or at least call them out in the changelog if we don't)

It will go away the second we add an exports field as it will become impossible to import from non-official entry points.
If we want to keep it, we need to start exporting it from an official entry point - I'd be totally open to that.

On second look, this looks like an implementation detail of parseAndCheckHttpResponse - even we don't use it outside of this file, so I'd just remove the export until someone complains.

~~I am adding parseAndCheckHttpResponse as an export from link/http though~~, (We already do) as it's at least used in https://github.com/jaydenseric/apollo-upload-client/blob/5e6d5c17861fbd9e2d84c8517fc29d5321be4cfc/createUploadLink.mjs#L5 - we need to remember to PR them an import change when we release 4.0.

Definitely one of those modules we'll need to call out well in the changelog. I think there are a few 3rd party link implementations that use this function.

phryneas · 2025-01-24T11:55:56Z

src/core/ApolloClient.ts

@@ -42,7 +42,7 @@ export interface DefaultOptions {
  mutate?: Partial<MutationOptions<any, any, any>>;
 }

-export interface DevtoolsOptions {
+interface DevtoolsOptions {


Do you think we should export this from @apollo/client?

I think we are probably ok to leave it not exported for now. Generally I'd expect the config to be passed to the constructor 99% of the time so I can't imagine too many people are needing this.

…rapping library might use

phryneas · 2025-01-24T12:17:05Z

I've added an integration test that shows some level of "writing a wrapping library". It's not erroring now, but I imagine it will start erroring once we add an exports field, so this will be good to have.

phryneas · 2025-01-24T12:17:42Z

Generally, I'd suggest we get this merged as-is right now and we'll see if there are any problems down the road - we can always add more exports later.

jerelmiller · 2025-01-24T16:17:06Z

src/core/watchQueryOptions.ts

@@ -207,7 +207,7 @@ export interface SubscriptionOptions<
  extensions?: Record<string, any>;
 }

-export interface MutationBaseOptions<
+interface MutationBaseOptions<


This will likely disappear once we flatten out our types and localize some of these with their respective hooks, etc. Totally ok with this change.

jerelmiller · 2025-01-24T16:20:36Z

src/testing/core/mocking/mockFetch.ts

The things you find hiding in the codebase sometimes 🤯

jerelmiller

Good stuff! Thanks for getting this integrated.

phryneas · 2025-01-27T13:30:16Z

I'll get this merged - if we get user feedback that they need type X, we can always add it back, but this seems like a good clean start.

phryneas added 6 commits January 22, 2025 14:11

knip experiment

51d0dea

some more config

06e30a9

run knip --fix once

6ea7041

more configuration, fix issues

55a58cb

Remove deprecated resetApolloContext export

135ccaf

add another exlusion

9cdbec0

phryneas requested a review from jerelmiller January 22, 2025 14:28

phryneas added 2 commits January 22, 2025 15:29

run prettier

b3a5aa7

some cleanup

7717fe7

phryneas commented Jan 22, 2025

View reviewed changes

phryneas added 3 commits January 22, 2025 15:41

api-extractor

5006bc2

config adjustments

53639aa

add CI job

afd5ac4

jerelmiller reviewed Jan 22, 2025

View reviewed changes

remove isNullish

e3e470d

phryneas mentioned this pull request Jan 22, 2025

Remove unused dependency response-iterator #12292

Merged

phryneas commented Jan 24, 2025

View reviewed changes

phryneas added 2 commits January 24, 2025 12:59

add a small integration test showing various re-export situations a w…

7bb1a5a

…rapping library might use

prettier

c33850d

phryneas requested a review from jerelmiller January 24, 2025 12:17

jerelmiller reviewed Jan 24, 2025

View reviewed changes

src/testing/core/mocking/mockFetch.ts Outdated

Copy link

Member

jerelmiller Jan 24, 2025 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The things you find hiding in the codebase sometimes 🤯

jerelmiller approved these changes Jan 24, 2025

View reviewed changes

Merge remote-tracking branch 'origin/release-4.0' into pr/knip

be729ad

phryneas merged commit ae5d06a into release-4.0 Jan 27, 2025
48 checks passed

github-actions bot mentioned this pull request Jan 27, 2025

Version Packages (alpha) #12221

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Run Knip on 4.0 branch #12291

Run Knip on 4.0 branch #12291

phryneas commented Jan 22, 2025

changeset-bot bot commented Jan 22, 2025 •

edited

Loading

svc-apollo-docs commented Jan 22, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 22, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025 •

edited

Loading

phryneas Jan 22, 2025

netlify bot commented Jan 22, 2025 •

edited

Loading

phryneas Jan 22, 2025

jerelmiller Jan 22, 2025

phryneas Jan 22, 2025

phryneas Jan 22, 2025

phryneas Jan 22, 2025

jerelmiller Jan 24, 2025

phryneas Jan 24, 2025

jerelmiller Jan 22, 2025

phryneas Jan 22, 2025

jerelmiller Jan 22, 2025 •

edited

Loading

phryneas Jan 22, 2025

phryneas Jan 24, 2025 •

edited

Loading

jerelmiller Jan 24, 2025

phryneas Jan 24, 2025

jerelmiller Jan 24, 2025

phryneas commented Jan 24, 2025

phryneas commented Jan 24, 2025

jerelmiller Jan 24, 2025

jerelmiller Jan 24, 2025 •

edited

Loading

jerelmiller left a comment

phryneas commented Jan 27, 2025

Run Knip on 4.0 branch #12291

Run Knip on 4.0 branch #12291

Conversation

phryneas commented Jan 22, 2025

changeset-bot bot commented Jan 22, 2025 • edited Loading

🦋 Changeset detected

svc-apollo-docs commented Jan 22, 2025 • edited Loading

⚠️ Docs preview not attached to branch

pkg-pr-new bot commented Jan 22, 2025 • edited Loading

pkg-pr-new bot commented Jan 22, 2025

github-actions bot commented Jan 22, 2025 • edited Loading

size-limit report 📦

Choose a reason for hiding this comment

netlify bot commented Jan 22, 2025 • edited Loading

✅ Deploy Preview for apollo-client-docs ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerelmiller Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phryneas Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phryneas commented Jan 24, 2025

phryneas commented Jan 24, 2025

Choose a reason for hiding this comment

jerelmiller Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

jerelmiller left a comment

Choose a reason for hiding this comment

phryneas commented Jan 27, 2025

changeset-bot bot commented Jan 22, 2025 •

edited

Loading

svc-apollo-docs commented Jan 22, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 22, 2025 •

edited

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

netlify bot commented Jan 22, 2025 •

edited

Loading

jerelmiller Jan 22, 2025 •

edited

Loading

phryneas Jan 24, 2025 •

edited

Loading

jerelmiller Jan 24, 2025 •

edited

Loading