Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to configure a name for the client for use with devtools #11936

Merged
merged 7 commits into from
Jul 9, 2024

Conversation

jerelmiller
Copy link
Member

This PR adds the ability to specify a name for a client instance for use with devtools. This will be useful for the multiple clients feature to be able to more easily identify each client. Without this functionality, a randomly generated ID will be shown instead. Adding a name makes this more human-friendly.

As such, I've modified the way devtools is configured with the client by deprecating connectToDevtools and added a new devtools option:

new ApolloClient({
  devtools: {
    enabled: true,
    name: 'Apollo Client 1',
  }
})

This is fully backwards compatible with connectToDevtools and will set enabled to true if the connectToDevtools option is set. Structuring the config this way enables us to add additional functionality and configuration for the devtools in future versions without having to get creative with naming.


This PR is missing updates to docs which will follow if we decide we like this change.

Copy link

changeset-bot bot commented Jul 8, 2024

🦋 Changeset detected

Latest commit: 7a72e3f

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 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

Copy link
Contributor

github-actions bot commented Jul 8, 2024

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 39.17 KB (+0.11% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 47.9 KB (+0.09% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 45.44 KB (+0.09% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 34.31 KB (+0.1% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 32.17 KB (+0.12% 🔺)
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.23 KB (0%)
import { useQuery } from "dist/react/index.js" (production) 4.31 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 5.71 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.79 KB (0%)
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.4 KB (0%)
import { useSubscription } from "dist/react/index.js" (production) 3.45 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 5.49 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production) 4.15 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 4.99 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.64 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" 5.07 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production) 3.72 KB (0%)
import { useReadQuery } from "dist/react/index.js" 3.39 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 3.33 KB (0%)
import { useFragment } from "dist/react/index.js" 2.32 KB (0%)
import { useFragment } from "dist/react/index.js" (production) 2.27 KB (0%)

Copy link

netlify bot commented Jul 8, 2024

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit d78c241
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/668c77b5fa6dd50008c39294
😎 Deploy Preview https://deploy-preview-11936--apollo-client-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

netlify bot commented Jul 8, 2024

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit 7a72e3f
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/668d44475dd3410008254e2e
😎 Deploy Preview https://deploy-preview-11936--apollo-client-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

src/core/ApolloClient.ts Outdated Show resolved Hide resolved
Copy link
Member

@phryneas phryneas left a comment

Choose a reason for hiding this comment

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

Love the new option! :)

@jerelmiller jerelmiller force-pushed the jerel/devtools-name branch from a83ccf2 to e7631ca Compare July 9, 2024 14:05
@jerelmiller jerelmiller force-pushed the jerel/devtools-name branch from e7631ca to 882ff84 Compare July 9, 2024 14:06
@jerelmiller jerelmiller merged commit 1b23337 into release-3.11 Jul 9, 2024
41 of 42 checks passed
@jerelmiller jerelmiller deleted the jerel/devtools-name branch July 9, 2024 14:16
@github-actions github-actions bot mentioned this pull request Jul 9, 2024
@github-actions github-actions bot mentioned this pull request Jul 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants