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

Docs: E2E tests for Source block update fix #22835

Merged
merged 30 commits into from
Jun 5, 2023

Conversation

chakAs3
Copy link
Contributor

@chakAs3 chakAs3 commented May 30, 2023

Closes #

What I did

this an e2e to for sourceSnippet should faild if the source is not changing back to previous value

should be merged after #22807

How to test

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@chakAs3 chakAs3 self-assigned this May 30, 2023
@chakAs3 chakAs3 requested a review from shilman May 30, 2023 06:48
@chakAs3 chakAs3 added addon: docs run e2e extended test suite Run the e2e extended test suite in CircleCI workflows bug labels May 30, 2023
@chakAs3
Copy link
Contributor Author

chakAs3 commented May 30, 2023

So @shilman, you can see it is failing now on next branch.
to reproduce it is easy: toggle the source on Button story and change the label to => Button1 then => Button => Button1 , keep switching between these 2 labels, the snippet will never update

@tmeasday
Copy link
Member

tmeasday commented Jun 1, 2023

Thanks for the repro @chakAs3 very helpful!

@chakAs3 chakAs3 requested a review from a team as a code owner June 2, 2023 21:53
@shilman shilman changed the title SourceBlock(E2E-test) add test check if value changes back to previous Docs: E2E tests for Source block update fix Jun 5, 2023
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, with caveats discussed in #22807 and comment to the code that I've added. Thanks so much @chakAs3 and @tmeasday for working this out. 🙏

@shilman shilman merged commit 2d4f09a into next Jun 5, 2023
@shilman shilman deleted the chaks/add-e2e-test-to-addon-docs branch June 5, 2023 11:48
@shilman shilman added patch:yes Bugfix & documentation PR that need to be picked to main branch patch:done Patch/release PRs already cherry-picked to main/release branch labels Jun 5, 2023
shilman added a commit that referenced this pull request Jun 5, 2023
…n-docs

Docs: E2E tests for Source block update fix
@shilman shilman mentioned this pull request Jun 5, 2023
Copy link
Contributor Author

@chakAs3 chakAs3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shilman I need to look deeper into the Block implementation, it seems an easy task, but I'm not aware of the reasons behind tell implementation.
In my opinion, The block should be only responsible for how the snippet will be rendered ( layout, design aspect+ show/hide/copy actions ). the Optimisation should be done in the decorator level. which is the case I guess at least for Vue, we only fire the RERENDRED_SNIPPET event if the args are changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs bug patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch run e2e extended test suite Run the e2e extended test suite in CircleCI workflows
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants