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

fix display of objects in the documentation error page #11261

Merged
merged 3 commits into from
Oct 2, 2023
Merged

Conversation

phryneas
Copy link
Member

@phryneas phryneas commented Sep 29, 2023

Fixes #11260

Before this, objects were not displayed correctly in error messages.

Before
image

After
image

Checklist:

  • If this PR contains changes to the library itself (not necessary for e.g. docs updates), please include a changeset (see CONTRIBUTING.md)
  • If this PR is a new feature, please reference an issue where a consensus about the design was reached (not necessary for small changes)
  • Make sure all of the significant new logic is covered by tests

@phryneas phryneas requested a review from a team as a code owner September 29, 2023 10:19
@changeset-bot
Copy link

changeset-bot bot commented Sep 29, 2023

⚠️ No Changeset found

Latest commit: e4dcd36

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Sep 29, 2023

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 37.08 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 43.42 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 41.97 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 32.5 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 31.26 KB (0%)
import { ApolloProvider } from "dist/react/index.js" 1.21 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production) 1.2 KB (0%)
import { useQuery } from "dist/react/index.js" 4.27 KB (0%)
import { useQuery } from "dist/react/index.js" (production) 4.08 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 4.58 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.4 KB (0%)
import { useMutation } from "dist/react/index.js" 2.52 KB (0%)
import { useMutation } from "dist/react/index.js" (production) 2.51 KB (0%)
import { useSubscription } from "dist/react/index.js" 2.24 KB (0%)
import { useSubscription } from "dist/react/index.js" (production) 2.2 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 4.59 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production) 4.02 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 4.1 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.52 KB (0%)
import { useReadQuery } from "dist/react/index.js" 2.96 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 2.91 KB (0%)
import { useFragment } from "dist/react/index.js" 2.08 KB (0%)
import { useFragment } from "dist/react/index.js" (production) 2.03 KB (0%)

@netlify
Copy link

netlify bot commented Sep 29, 2023

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit 9def317
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/6516a713db0d04000874ec04
😎 Deploy Preview https://deploy-preview-11261--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.

@JonasDoe
Copy link
Contributor

Sry for more spam in here, another note:

import { loadErrorMessages, loadDevMessages } from "@apollo/client/dev";

if (__DEV__) {  // Adds messages only in a dev environment
  loadDevMessages();
  loadErrorMessages();
}

will suffer from the same issue. So in my case (in the referenced issue), the console log will is just look like "Missing field 'chatChannel' while writing result %o". I've already found out why the error was thrown at my end, though, so just as a general remark in the unlikely case it's at a different place to fix.

@phryneas
Copy link
Member Author

@JonasDoe yeah that's a different fix, we'll have to ship a new Apollo Client version for that. Thanks for the heads-up, I'll see that I get to that on monday!

@phryneas phryneas merged commit 3a3ee44 into main Oct 2, 2023
8 checks passed
@phryneas phryneas deleted the pr/fix-11260 branch October 2, 2023 10:24
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error message not displayed properly (encoding issue)
3 participants