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

Remove unnecessary and flaky snapshot test from ResponsiveBlockControl #26372

Merged
merged 1 commit into from
Nov 3, 2020

Conversation

sarayourfriend
Copy link
Contributor

@sarayourfriend sarayourfriend commented Oct 21, 2020

Description

See #26078 (comment) for the original discussion. This test does not appear to add value to the test suite, especially when we're already explicitly testing many parts of the rendered component.

Here's another example PR where this test fails for no good reason: #26369

Types of changes

Updating a test.

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

Blocks #26369

@github-actions
Copy link

github-actions bot commented Oct 21, 2020

Size Change: 0 B

Total Size: 1.21 MB

ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.78 kB 0 B
build/api-fetch/index.js 3.45 kB 0 B
build/autop/index.js 2.84 kB 0 B
build/blob/index.js 665 B 0 B
build/block-directory/index.js 8.72 kB 0 B
build/block-directory/style-rtl.css 943 B 0 B
build/block-directory/style.css 942 B 0 B
build/block-editor/index.js 130 kB 0 B
build/block-editor/style-rtl.css 11.1 kB 0 B
build/block-editor/style.css 11.1 kB 0 B
build/block-library/editor-rtl.css 9.02 kB 0 B
build/block-library/editor.css 9.02 kB 0 B
build/block-library/index.js 146 kB 0 B
build/block-library/style-rtl.css 7.84 kB 0 B
build/block-library/style.css 7.85 kB 0 B
build/block-library/theme-rtl.css 837 B 0 B
build/block-library/theme.css 838 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 48.1 kB 0 B
build/components/index.js 172 kB 0 B
build/components/style-rtl.css 15.2 kB 0 B
build/components/style.css 15.2 kB 0 B
build/compose/index.js 9.81 kB 0 B
build/core-data/index.js 12.5 kB 0 B
build/data-controls/index.js 772 B 0 B
build/data/index.js 8.77 kB 0 B
build/date/index.js 31.8 kB 0 B
build/deprecated/index.js 768 B 0 B
build/dom-ready/index.js 571 B 0 B
build/dom/index.js 4.46 kB 0 B
build/edit-navigation/index.js 11.2 kB 0 B
build/edit-navigation/style-rtl.css 881 B 0 B
build/edit-navigation/style.css 885 B 0 B
build/edit-post/index.js 306 kB 0 B
build/edit-post/style-rtl.css 6.41 kB 0 B
build/edit-post/style.css 6.39 kB 0 B
build/edit-site/index.js 22.4 kB 0 B
build/edit-site/style-rtl.css 3.88 kB 0 B
build/edit-site/style.css 3.88 kB 0 B
build/edit-widgets/index.js 26.4 kB 0 B
build/edit-widgets/style-rtl.css 3.13 kB 0 B
build/edit-widgets/style.css 3.13 kB 0 B
build/editor/editor-styles-rtl.css 480 B 0 B
build/editor/editor-styles.css 482 B 0 B
build/editor/index.js 43.1 kB 0 B
build/editor/style-rtl.css 3.85 kB 0 B
build/editor/style.css 3.85 kB 0 B
build/element/index.js 4.65 kB 0 B
build/escape-html/index.js 735 B 0 B
build/format-library/index.js 7.7 kB 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 623 B 0 B
build/i18n/index.js 3.57 kB 0 B
build/is-shallow-equal/index.js 712 B 0 B
build/keyboard-shortcuts/index.js 2.52 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.11 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/media-utils/index.js 5.34 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.42 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.43 kB 0 B
build/priority-queue/index.js 791 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/reusable-blocks/index.js 3.06 kB 0 B
build/rich-text/index.js 13.2 kB 0 B
build/server-side-render/index.js 2.77 kB 0 B
build/shortcode/index.js 1.69 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.84 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.22 kB 0 B

compressed-size-action

@ItsJonQ
Copy link

ItsJonQ commented Oct 21, 2020

I'm 👍 with this change. I've experienced several rounds of this particular snapshot needing updating in the past. I've never worked with this particular component before. I'm curious to hear the thoughts from those who have.

@sarayourfriend sarayourfriend force-pushed the refactor/remove-flaky-snapshot-test branch from ed99142 to f3436ad Compare October 27, 2020 15:11
@sarayourfriend
Copy link
Contributor Author

@getdave Do you have any insight into this test? Do you think it's okay or bad to remove the snapshot given that we're already testing for a lot of the output explicitly in the same test?

@sirreal
Copy link
Member

sirreal commented Oct 30, 2020

I looked around a bit and there appears to be an official solution for component snapshots with emotion: jest-emotion.

If the plan is to continue using emotion it's probably worth getting that set up and working well.

@getdave
Copy link
Contributor

getdave commented Nov 3, 2020

@getdave Do you have any insight into this test? Do you think it's okay or bad to remove the snapshot given that we're already testing for a lot of the output explicitly in the same test?

I'd say you're ok to remove the snapshot. I'm no longer a fan of them anyway and feel they add little or no value here.

Thanks for fixing.

@sarayourfriend sarayourfriend force-pushed the refactor/remove-flaky-snapshot-test branch from f3436ad to 46e320b Compare November 3, 2020 14:49
Copy link
Member

@sirreal sirreal left a comment

Choose a reason for hiding this comment

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

It seems folks agree to remove this. I'll repeat the following as a desirable direction generally:

I looked around a bit and there appears to be an official solution for component snapshots with emotion: jest-emotion.

If the plan is to continue using emotion it's probably worth getting that set up and working well.

@sarayourfriend
Copy link
Contributor Author

sarayourfriend commented Nov 3, 2020

@sirreal We already use jest-emotion:

snapshotSerializers: [ 'enzyme-to-json/serializer', 'jest-emotion' ],

@ItsJonQ Is there something similar to jest-emotion for G2?

@sarayourfriend sarayourfriend merged commit 90a70fd into master Nov 3, 2020
@sarayourfriend sarayourfriend deleted the refactor/remove-flaky-snapshot-test branch November 3, 2020 16:04
@github-actions github-actions bot added this to the Gutenberg 9.4 milestone Nov 3, 2020
@ItsJonQ
Copy link

ItsJonQ commented Nov 4, 2020

@ItsJonQ Is there something similar to jest-emotion for G2?

@saramarcondes Funny enough.. I haven't run into the same flakey issues in G2 as I have in Gutenberg.

G2 also uses Emotion, Jest, and Snapshots 🤔
(G2 doesn't use jest-emotion though)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants