feat(sanity): allow Actions API enablement based on Studio version semver constraint #6993
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 ↗︎
1 Skipped Deployment
|
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
|
juice49
force-pushed
the
feat/sdx-1421/actions-feature-version-constraint
branch
from
be002ba
to
3c5cc31
Compare
|
No changes to documentation |
|
Component Testing Report Updated Jul 8, 2024 10:21 PM (UTC)
|
juice49
force-pushed
the
feat/sdx-1421/actions-feature-version-constraint
branch
from
392ec17
to
3c5efbe
Compare
juice49
force-pushed
the
feat/sdx-1421/actions-feature-version-constraint
branch
from
3c5efbe
to
e6fb0df
Compare
rexxars
requested review from
a team,
bjoerge,
binoy14,
ricokahler and
cngonzalez
and removed request for
rexxars,
a team and
bjoerge
cngonzalez
previously approved these changes
Jul 2, 2024
…test cases This commit also removes the `__internal_serverDocumentActions` override from the E2E Studio. Actions API enablement can now be controlled dynamically using the `mockActionsFeatureToggle` helper.
juice49
force-pushed
the
feat/sdx-1421/actions-feature-version-constraint
branch
from
0e94b1a
to
af9ed2e
Compare
cngonzalez
approved these changes
Jul 8, 2024
|
@cngonzalez It is. Thank you! |
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
This change allows us to dynamically enable the Actions API based on the Studio version (post this release) from the Actions API. The API response now includes a
compatibleStudioVersionsproperty specifying a semver range that indicates the compatible Studio versions. If the feature toggle is enabled, Studio will first confirm it satisfies the semver constraint before enabling the gated functionality.The feature toggle will never be acknowledged by existing Studio releases.
To briefly outline how this works in Studio:
actionsproperty as falsey, meaning they will never enable Actions API usage based on this feature toggle.enabledistrueand the Studio version satisfies the semver constraint specified incompatibleStudioVersions.What to review
The resolution of the Actions API feature toggle (
packages/sanity/src/core/store/_legacy/document/document-pair/utils/fetchFeatureToggle.ts).Testing
packages/sanity/src/core/store/_legacy/document/document-pair/utils/fetchFeatureToggle.test.ts.test/e2e/tests/document-actions/fetchFeatureToggle.spec.ts.To manually test, find the
GETrequest fordata/actionsin your dev tools and override the response body like so:{ "enabled": true, "compatibleStudioVersions": ">= 3" }After reloading the page, you should find the Actions API is being used.
Note: You must ensure the
__internal_serverDocumentActions.enabledoverride is not present in your Studio config. It short-circuits the feature toggle.