feat(core): only use vX client if strictly necessary
#8466
Merged
+315
−184
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
pedrobonamin
requested review from
bjoerge and
juice49
and removed request for
cngonzalez
pedrobonamin
force-pushed
the
corel-client-vx
branch
from
fd5b824 to
80b3ba0
Compare
|
No changes to documentation |
|
Component Testing Report Updated Feb 3, 2025 1:29 PM (UTC) ❌ Failed Tests (2) -- expand for details
|
⚡️ Editor Performance ReportUpdated Mon, 03 Feb 2025 13:31:00 GMT
Detailed information🏠 Reference resultThe performance result of
🧪 Experiment resultThe performance result of this branch
📚 Glossary
|
pedrobonamin
force-pushed
the
corel-client-vx
branch
from
80b3ba0 to
bf68b2d
Compare
bjoerge
approved these changes
Feb 3, 2025
| options: { | ||
| // how to insert new document ids. Defaults to `sorted` | ||
| insert?: 'sorted' | 'prepend' | 'append' | ||
| } = {}, |
There was a problem hiding this comment.
thoughts on making apiVersion part of options here?
| apiVersion: 'vX', | ||
| }) | ||
| .fetch<SanityDocumentLike[]>(query, params, options) | ||
| const apiVersion = isReleasePerspective(options?.perspective as string | string[] | undefined) |
There was a problem hiding this comment.
Nice way of feature-detecting what version to use!
There was a problem hiding this comment.
Maybe add a //todo: remove once releases is opt-out?
| @@ -20,7 +20,7 @@ export const publish: OperationImpl<[], DisabledReason> = { | |||
| throw new Error('cannot execute "publish" when draft is missing') | |||
| } | |||
|
|
|||
| return actionsApiClient(client).observable.action( | |||
| return actionsApiClient(client, idPair).observable.action( | |||
There was a problem hiding this comment.
I think we should make a note to remove these added params after backend APIs stabilize
There was a problem hiding this comment.
Added a TODO, thanks!
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.
Description
In the initial implementation of content releases we modified the default studio client to use
vXthis was needed because all the new functions and versions documents checks are only available invXfor now.Now, we are aiming to merge this to
nextin the coming week, given that we don't want to use thevXclient everywhere because of the risk this involves we are adding this changes in which the client will usevXonly if it is strictly necessary.This will be when a user is doing actions over a
versiondocument or is using anything inside the releases plugin.This PR has been divided in logical pieces and will probably be easier to review commit per commit.
Changes in
presentationtoolI've added the checks where I noticed that we are using perspectives and could lead to errors if the client is not using the releases client (vX for now) in this commit
I've left out the following files, which I think don't require this.
What to review
Testing
vXclient should only be used when a perspective is defined or when operating in a version document.This can be verified by opening a document in
draftand doing edits, the changes should be done using the 2024 client.If you switch to a
versionnow the client should usevXThe same with search.
Notes for release