[Enterprise Search] Small test helper for expected async errors by cee-chen · Pull Request #88422 · elastic/kibana

cee-chen · 2021-01-15T01:02:08Z

Summary

Follow up to this conversation we had here: #88250 (comment)

Byron made an excellent point that the try/catch boilerplate around expected errors isn't super intuitive and is confusing at first glance (especially the comment, probably). I thought it would help us to DRY out a very small helper which serves a few purposes:

Handles silencing expected errors so we don't see them in test results
Prevents us from writing expect()s within catch, which as we've already discussed previously can lead to false positive test results
Optionally returns the thrown error to assert on (we're not doing so currently in any tests, but I think it'll potentially be helpful in the future!)

Let me know what y'all think! Just IMO, 50+ deleted lines is worth 💪

Checklist

Unit or functional tests were updated or added to match the most common scenarios

- Also hopefully a bit more descriptive on what's happening

…to use new helper

cee-chen · 2021-01-15T01:04:45Z

Requesting a review from @scottybollinger since I'm touching WS tests

cee-chen · 2021-01-15T01:04:50Z

x-pack/plugins/enterprise_search/public/applications/__mocks__/index.ts

 export { rerender } from './enzyme_rerender.mock';
 // Note: shallow_useeffect must be imported directly as a file
+
+export { expectedAsyncError } from './expected_async_error';


Just btw, I know I'm getting a little loosey-goosey here with what should go into the __mocks__ folder, especially since this is definitely strictly a test helper and not a mock 😅 I'm definitely happy to revisit at some point if we just want a generic test helper folder, or if we want to split this up later at some point

I'm not concerned about it.

cee-chen · 2021-01-15T03:02:08Z

FYI: I have 2 more Jest test related PRs coming after this. 1 that simplifies importing/mocking logic action/values from other logic files, and 1 final general cleanup PR. HOTYB!

kibanamachine · 2021-01-15T03:18:49Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: ab80312

Metrics [docs]

✅ unchanged

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

JasonStoltz · 2021-01-15T14:34:41Z

x-pack/plugins/enterprise_search/public/applications/__mocks__/expected_async_error.ts

+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export const expectedAsyncError = async (promise: Promise<unknown>) => {


I like this a lot. I was imagining it'd have to be something more complex, but this is laser focused.

Awesome! We can definitely extend it in the future if we need to is my thought, but maybe we won't have to.

scottybollinger

LGTM!

cee-chen · 2021-01-15T17:26:02Z

Thanks y'all! Another PR coming here shortly 🎉

…) (#88492) * Add small helper to reduce boilerplate on async tests expected to throw - Also hopefully a bit more descriptive on what's happening * Update all test files using the previous try/catch do nothing blocks to use new helper # Conflicts: # x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/add_source_logic.test.ts

See elastic#88422

* Initial copy/paste of component tree Only does linting changes and lodash import * Replace withRouter HOC with hooks Use useLocation and no longer pass around history, using the KibanaLogic navigateToUrl method instead * Migrate LicenseCallout component * Update paths Also change name of component to OauthApplication as the default import was named that before * Remove conditional and passed in flash messages This is no longer needed with the Kibana syntax. Flash messages are set globally and only render when present. * Replace removed ConfirmModal In Kibana, we use the Eui components directly * Use internal tools for determining license * Fix a bunch of type issues * Remove telemetry settings section We no longer control telemetry in Workplace Search. It is handled by Kibana itself * Add SettingsSubNav component * Add route and update nav * Remove legacy AppView and sidenav * Clear flash messages globally * Remove global name change method call The global org name is not used anywhere outside of this section so we no longer need to update the global organization object as it is re-fetched when this section is entered. Previously, we displayed the org name in the sidebar but that has been removed in Kibana * Refactor saveUpdatedConfig We recently split out the logic from SourceLogic to the new AddSourceLogic and in settings, we were calling the saveSourceConfig method from the SourceLogic (now in AddSourceLogic) file and passing a callback that set the flash messages from that component’s state. Now, we set the flash messages globally and no longer need to have a saveUpdatedConfig method in the logic file, but can call it directly in the component and the flash messages will be set globally. * Update logic file to use global flash messages * Update server routes * Replace Rails http with kibana http * Fix subnav * Update routes to use consistent syntax We use this method across both Enterprise Search products in Kibana * Shorten nav item copy This would be the only place in the sidebar with a nav item breaking to a second line. * Fix some random typos * Replace React Router Link with helper * Add i18n * Remove redundant clearing of flash messages This happens automatically now in the global flash messages logic; route changes trigger clearing of messages * Add unit tests for components * Add tests for router * Store oauthApplication in mock for reuse * Add tests for SettingsLogic * Fix typo * Remove unncessary imports Copied from this PR: #88525 * Refactor to use new helpers when mocking See #88494 * Update logic test to use error helper See #88422 * Fix type issue * Fix whitespace lint issue Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

cee-chen added 2 commits January 14, 2021 16:54

Add small helper to reduce boilerplate on async tests expected to throw

2c49668

- Also hopefully a bit more descriptive on what's happening

Update all test files using the previous try/catch do nothing blocks …

ab80312

…to use new helper

cee-chen added release_note:skip Skip the PR/issue when compiling release notes v7.12.0 labels Jan 15, 2021

cee-chen requested review from a team, JasonStoltz and byronhulcher January 15, 2021 01:02

cee-chen mentioned this pull request Jan 15, 2021

[App Search] Analytics - initial logic file & server API routes #88250

Merged

1 task

cee-chen requested a review from scottybollinger January 15, 2021 01:02

cee-chen commented Jan 15, 2021

View reviewed changes

JasonStoltz reviewed Jan 15, 2021

View reviewed changes

JasonStoltz approved these changes Jan 15, 2021

View reviewed changes

scottybollinger approved these changes Jan 15, 2021

View reviewed changes

cee-chen merged commit d2de5d0 into elastic:master Jan 15, 2021

cee-chen deleted the expected-async-errors branch January 15, 2021 17:26

cee-chen mentioned this pull request Jan 15, 2021

[7.x] [Enterprise Search] Small test helper for expected async errors (#88422) #88492

Merged

scottybollinger added a commit to scottybollinger/kibana that referenced this pull request Jan 15, 2021

Update logic test to use error helper

6cedfd7

See elastic#88422

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search] Small test helper for expected async errors#88422

[Enterprise Search] Small test helper for expected async errors#88422
cee-chen merged 2 commits intoelastic:masterfrom
cee-chen:expected-async-errors

cee-chen commented Jan 15, 2021 •

edited

Loading

Uh oh!

cee-chen commented Jan 15, 2021

Uh oh!

cee-chen Jan 15, 2021

Uh oh!

JasonStoltz Jan 15, 2021

Uh oh!

cee-chen commented Jan 15, 2021

Uh oh!

kibanamachine commented Jan 15, 2021

Uh oh!

JasonStoltz Jan 15, 2021

Uh oh!

cee-chen Jan 15, 2021

Uh oh!

scottybollinger left a comment

Uh oh!

cee-chen commented Jan 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

cee-chen commented Jan 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

cee-chen commented Jan 15, 2021

Uh oh!

cee-chen Jan 15, 2021

Choose a reason for hiding this comment

Uh oh!

JasonStoltz Jan 15, 2021

Choose a reason for hiding this comment

Uh oh!

cee-chen commented Jan 15, 2021

Uh oh!

kibanamachine commented Jan 15, 2021

💚 Build Succeeded

Metrics [docs]

Uh oh!

JasonStoltz Jan 15, 2021

Choose a reason for hiding this comment

Uh oh!

cee-chen Jan 15, 2021

Choose a reason for hiding this comment

Uh oh!

scottybollinger left a comment

Choose a reason for hiding this comment

Uh oh!

cee-chen commented Jan 15, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

cee-chen commented Jan 15, 2021 •

edited

Loading