(core) - Deprecate the "operationName" property and move to "kind" #1045
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 41bc6c8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 packages
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 |
kitten
reviewed
Oct 7, 2020
kitten
reviewed
Oct 7, 2020
kitten
reviewed
Oct 7, 2020
kitten
reviewed
Oct 7, 2020
JoviDeCroock
approved these changes
Oct 7, 2020
kitten
approved these changes
Oct 7, 2020
|
Let's figure out when we want to release this 🤔 I don't expect anyone to have any major issues with this change, since it won't be breaking unless someone does something absolutely weird, but it's worth double checking. |
|
Update: I loaded the sandbox as a quick smoke test and it all seems to work fine but it is triggering the warning, which is odd. https://codesandbox.io/s/urql-issue-template-client-forked-nsrde |
The addMetadata utility was definitely kept in the wrong place since it concerns operations. `makeOperation` has been updated to fill out the context if it isn't passed which may become convenient in a couple of places, instead setting it to the `operation.context`.
kitten
changed the title
kitten
force-pushed
the
rfc/1005-operation-kind
branch
from
f452a19
to
41bc6c8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1005
Summary
It's currently tricky to differentiate between the urql-specific
Operation.operationNameproperty, and the more generalOperationDefinitionNode.name.valueproperty. This PR deprecates the "operationName" property in favor of "kind", issues a warning the first time the deprecated property is accessed, and updates all exchanges.Set of changes
packages/core/src/utils/deprecation.ts- a utility for issuing deprecation warnings only once.packages/core/src/utils/operation.tswithmakeOperation- a utility for creating Operation objects with a getter/setter for theoperationNameproperty that issues a deprecation warning.packages/core/src/client.tsto usemakeOperationand move property references from "operationName" to "kind".cache,dedup,fallback,fetch,ssr, andsubscriptionexchanges to move references from "operationName" to "kind".exchangespackages.