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

Release 3.9.0 #11220

Merged
merged 110 commits into from
Jan 30, 2024
Merged

Release 3.9.0 #11220

merged 110 commits into from
Jan 30, 2024

Conversation

benjamn
Copy link
Member

@benjamn benjamn commented Sep 15, 2023

Like the Release 3.8.0 PR, this PR will serve to collect significant new features, deprecation warnings, and minor breaking changes that we intend to release in @apollo/[email protected].

If you want to test these changes, run

npm i @apollo/[email protected]

in your application, where the n in -alpha.n comes from the most recent commit message like

Bump @apollo/client npm version to 3.9.0-alpha.n.

Until v3.9.0 is released, we can continue merging smaller changes into main and releasing them, without worrying about larger changes on the release-3.9 branch.

benjamn and others added 9 commits September 13, 2023 16:46
Most of these test tweaks are reasonable improvements necessitated by
fixing a bug that allowed queries to receive raw network results with
extraneous fields when the results were incomplete. Now, the extraneous
fields are no longer delivered, since they were not requested.

The test I removed completely does not make sense, and was only passing
previously because of the mock link running out of results.
…-markResult-result.data-mutation

Prevent `QueryInfo#markResult` mutation of `result.data` and
return cache data consistently whether complete or incomplete.
@benjamn benjamn added this to the Release 3.9 milestone Sep 15, 2023
@changeset-bot
Copy link

changeset-bot bot commented Sep 15, 2023

🦋 Changeset detected

Latest commit: 2c836af

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

@github-actions
Copy link
Contributor

github-actions bot commented Sep 15, 2023

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 38.23 KB (+3.22% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 46.03 KB (+5.84% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 43.58 KB (+3.79% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 33.96 KB (+4.42% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 31.88 KB (+2.12% 🔺)
import { ApolloProvider } from "dist/react/index.js" 1.23 KB (+1.37% 🔺)
import { ApolloProvider } from "dist/react/index.js" (production) 1.22 KB (+1.22% 🔺)
import { useQuery } from "dist/react/index.js" 5.2 KB (+21.7% 🔺)
import { useQuery } from "dist/react/index.js" (production) 4.27 KB (+4.52% 🔺)
import { useLazyQuery } from "dist/react/index.js" 5.5 KB (+20.3% 🔺)
import { useLazyQuery } from "dist/react/index.js" (production) 4.58 KB (+4.23% 🔺)
import { useMutation } from "dist/react/index.js" 3.51 KB (+37.52% 🔺)
import { useMutation } from "dist/react/index.js" (production) 2.73 KB (+7.83% 🔺)
import { useSubscription } from "dist/react/index.js" 3.19 KB (+43.13% 🔺)
import { useSubscription } from "dist/react/index.js" (production) 2.38 KB (+8.8% 🔺)
import { useSuspenseQuery } from "dist/react/index.js" 5.28 KB (+14.53% 🔺)
import { useSuspenseQuery } from "dist/react/index.js" (production) 3.94 KB (-2.68% 🔽)
import { useBackgroundQuery } from "dist/react/index.js" 4.75 KB (+15.2% 🔺)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.4 KB (-4.32% 🔽)
import { useReadQuery } from "dist/react/index.js" 3.04 KB (+1.44% 🔺)
import { useReadQuery } from "dist/react/index.js" (production) 2.98 KB (+1.57% 🔺)
import { useFragment } from "dist/react/index.js" 2.18 KB (+0.82% 🔺)
import { useFragment } from "dist/react/index.js" (production) 2.13 KB (+0.88% 🔺)
import { useLoadableQuery } from "dist/react/index.js" 4.97 KB (+100% 🔺)
import { useLoadableQuery } from "dist/react/index.js" (production) 3.63 KB (+100% 🔺)

Since this directory's contents are managed by the `changeset` tool, it
seems like running the files through Prettier will only lead to
formatting churn, as seen here:
https://app.circleci.com/pipelines/github/apollographql/apollo-client/21435/workflows/0d888903-9898-4c83-bab2-7146b7c3897e/jobs/111306
@netlify
Copy link

netlify bot commented Sep 15, 2023

Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit cae1475
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/65b945640843440008edc73e
😎 Deploy Preview https://deploy-preview-11220--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.

@benjamn
Copy link
Member Author

benjamn commented Sep 15, 2023

@phryneas Want to take a look at upgrading the version of typescript used by the API Extractor? I believe the checks succeed with only warnings, but the process exits with a nonzero status code, presumably because of the TS version warnings (CI log).

@alessbell
Copy link
Contributor

@benjamn it looks like API extractor needed to be run locally and the updated markdown output committed.

I merged release-3.9 and ran it over on #6701 so my commit includes the update to the markResult return value: 4ba85c0

github-actions bot and others added 9 commits September 19, 2023 07:54
* Version Packages (alpha)

* chore: remove unreleased changeset from main

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Alessia Bellisario <[email protected]>
* Version Packages (alpha)

* chore: update CHANGELOG.md

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Alessia Bellisario <[email protected]>
@alessbell alessbell removed the auto-cleanup 🤖 label Jan 12, 2024
@alessbell
Copy link
Contributor

Housekeeping note: auto-cleanup fails on protected branches so I've removed the label for now.

jerelmiller and others added 7 commits January 18, 2024 11:25
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Add doc comment for `headers` property on ApolloClient

* Update src/core/ApolloClient.ts

---------

Co-authored-by: Lenz Weber-Tronic <[email protected]>
… components (#11381)

* move some docs to comments

* remove comments

* fix missing space

* add api_doc

* tweak in file generation

* build from docs branch

* switch docs branch back to `main`

* bump CI

* Enum & PropertyDetails

* WIP - see current state of `hooks.mdx`

* completely remove `query-options` and `query-result` mdx

* useMutation

* handle subscription docs

* better function signature

* more hooks

* fix up import

* chores

* formatting

* suppress tsdoc warning

* api explorer nitpicks

* support for @deprecated

* use prerendered markdown in comments
to prevent client-side parsing

* add propTypes

* apply prettier

* fixup

* also display interface details for slightly complex types

* heading styling, do not use h6

* since everywhere, styling, `link` defaults

* add grouping, create documentation interface

* `MutationOptionsDocumentation` interface

* api reports

* subscription options

* api repots

* prettier

* fix some references

* cleanup

* fix up SubHeading links

* don't add prefix to parameter properties

* allow property deep linking

* prettier

* more cleanup

* also add result documentation

* more doccomment work

* fixup

* add missing import

* fixup

* remove `result` property (it's not a function)

* Revert "remove `result` property (it's not a function)"

This reverts commit 57c8526.

* functions adjustments
only show parameters section if there are parameters
only show results if result is not `void` or user-specified

* move heading out of example children

* Update docs/shared/ApiDoc/EnumDetails.js

Co-authored-by: Jerel Miller <[email protected]>

* remove obsolete props

* address top padding for "smaller" headings

* review feedback

* fixup codeblock

* move `SourceLink` out of `Heading`

* throw an error if both `as` and `headingLevel` are specified in `Heading`

* move jsx

* always link headings

* move headings out of table components

* review comment

* Update docs/shared/ApiDoc/Tuple.js

Co-authored-by: Jerel Miller <[email protected]>

* nit :)

* more updates

* fix link

---------

Co-authored-by: Jerel Miller <[email protected]>
@jerelmiller jerelmiller marked this pull request as ready for review January 30, 2024 18:47
@jerelmiller jerelmiller requested review from a team as code owners January 30, 2024 18:47
@github-actions github-actions bot added the auto-cleanup 🤖 label Jan 30, 2024
@alessbell alessbell merged commit 91dadd5 into main Jan 30, 2024
36 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 1, 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.

9 participants