Pass scoped context to tutorial providers when building tutorials by nreese · Pull Request #22260 · elastic/kibana

nreese · 2018-08-22T17:01:09Z

Part of the solution to Support for Kibana Spaces in Beats modules.

Talked through a solution with @elastic/kibana-security. The conversation revolved around providing a way for plugins to decorate tutorials by registering a contextFactory. The contextFactory is a function that is called with the request and returns an object of properties.
tutorialSpecProvider will now be called with an additional parameter, context, which contains the output of all registered contextFactories merged into a single object. tutorialSpecProvider can use the context object and its properties to conditionally modify the generated tutorial spec.

In the cases of spaces, the spaces plugin will decorate tutorials with a contextFactory that returns the spaceId. So when the tutorialSpecProvider is called, if spaces plugin is running and the request is within a space, then the context will include { spaceId: "value"}

@ycombinator @ruflin @elastic/kibana-sharing @alexfrancoeur

elasticmachine · 2018-08-22T19:10:26Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

nreese · 2018-08-22T19:38:33Z

flaky visualize test

fail: "visualize app data table with index without time filter "after all" hook"
19:08:35              │      [GET http://localhost:9515/session/2f5693819948083ed1f3978b0ad5dd23/url] connect ECONNREFUSED 127.0.0.1:9515

nreese · 2018-08-22T19:38:40Z

jenkins, test this

elasticmachine · 2018-08-22T21:28:23Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

ruflin · 2018-08-23T09:49:58Z

For my understanding: After this PR is merged the space plugin still needs to be modified to register the contextFactory?

kobelb · 2018-08-23T10:43:36Z

For my understanding: After this PR is merged the space plugin still needs to be modified to register the contextFactory?

That's correct, this is focused on the architecture to allow the plugins to register additional information that can be used within the tutorials.

kobelb · 2018-08-23T10:53:11Z

src/ui/tutorials_mixin.js

-    return _.cloneDeep(tutorials);
+  server.decorate('server', 'getTutorials', (request) => {
+    const initialContext = {};
+    const scopedContext = scopedTutorialContextFactoryies.reduce((accumulatedContext, contextFactory) => {


nit: the plural of factory is factories.

kobelb · 2018-08-23T10:53:45Z

src/ui/tutorials_mixin.js

+  server.decorate('server', 'getTutorials', (request) => {
+    const initialContext = {};
+    const scopedContext = scopedTutorialContextFactoryies.reduce((accumulatedContext, contextFactory) => {
+      return { ...accumulatedContext, ...contextFactory(request) };


Should we throw an error if we have two context factories try to set the same values?

I have no preference.

I don't have a strong preference either way, so LGTM!

kobelb

LGTM

elasticmachine · 2018-08-23T14:50:14Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

ycombinator · 2018-08-29T22:38:51Z

jenkins, test this pretty please with sugar on top

elasticmachine · 2018-08-30T00:01:18Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…IdInTutorials

elasticmachine · 2018-09-05T20:50:40Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…astic#22260) * Pass scoped context to tutorial providers when building tutorials * only generated scoped context one time * spelling

…2260) (#22743) * Pass scoped context to tutorial providers when building tutorials * only generated scoped context one time * spelling

…8764) ## Summary This PR migrates the first batch of test files from Enzyme to React Testing Library (RTL) as part of the effort to remove Enzyme dependencies from the Kibana codebase. Addresses #22260 ### Migration Details **Enzyme → RTL API Changes:** - Replaced `shallow()` / `mount()` with RTL's `render()` - Replaced `shallowWithIntl` / `mountWithIntl` with `renderWithI18n` - Replaced `.find()` with `screen.getByTestId()` / `screen.getByLabelText()` - Replaced `.simulate()` with `userEvent` interactions - Removed `wrapper.update()` calls (unnecessary in RTL) - Removed Enzyme type imports (`ShallowWrapper`, `ReactWrapper`) **Modern Testing Patterns:** - Added Jest modern fake timers setup (`jest.useFakeTimers()`) - Configured `userEvent.setup({ advanceTimers: jest.advanceTimersByTime })` - Replaced `waitFor()` polling with direct assertions using timer control - Implemented "Start → Flush → Await" pattern for async operations with internal timers - Added proper `act()` wrapping for state-changing operations - All tests now use async/await for user interactions **TypeScript Fixes:** - Fixed context provider type issues in `landing.test.tsx` - Ensured all required `AppDependencies` props are provided - Removed unused imports and fixed linting issues **Snapshot Updates:** - Updated all snapshots to reflect RTL's rendering output format ## Testing - ✅ All migrated tests pass locally - ✅ Zero console warnings (verified with `NODE_ENV=development`) - ✅ TypeScript compilation successful - ✅ ESLint passes with no errors - ✅ Snapshots updated and validated ## Performance Improvements Tests are now faster and more deterministic: - No polling with `waitFor()` - direct assertions with timer control - Fake timers eliminate real-time waiting - More reliable in CI environments ## Checklist - [x] Removed all Enzyme dependencies from test files - [x] Added modern fake timer setup - [x] Configured userEvent with timer advancement - [x] Replaced waitFor() with timer control - [x] All tests pass with zero warnings - [x] TypeScript compiles without errors - [x] ESLint passes - [x] Snapshots updated - [x] Helper files migrated where needed ## Next Steps This is the first batch. Subsequent batches will continue migrating the remaining test files listed in issue #222608. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

…stic#238764) ## Summary This PR migrates the first batch of test files from Enzyme to React Testing Library (RTL) as part of the effort to remove Enzyme dependencies from the Kibana codebase. Addresses elastic#22260 ### Migration Details **Enzyme → RTL API Changes:** - Replaced `shallow()` / `mount()` with RTL's `render()` - Replaced `shallowWithIntl` / `mountWithIntl` with `renderWithI18n` - Replaced `.find()` with `screen.getByTestId()` / `screen.getByLabelText()` - Replaced `.simulate()` with `userEvent` interactions - Removed `wrapper.update()` calls (unnecessary in RTL) - Removed Enzyme type imports (`ShallowWrapper`, `ReactWrapper`) **Modern Testing Patterns:** - Added Jest modern fake timers setup (`jest.useFakeTimers()`) - Configured `userEvent.setup({ advanceTimers: jest.advanceTimersByTime })` - Replaced `waitFor()` polling with direct assertions using timer control - Implemented "Start → Flush → Await" pattern for async operations with internal timers - Added proper `act()` wrapping for state-changing operations - All tests now use async/await for user interactions **TypeScript Fixes:** - Fixed context provider type issues in `landing.test.tsx` - Ensured all required `AppDependencies` props are provided - Removed unused imports and fixed linting issues **Snapshot Updates:** - Updated all snapshots to reflect RTL's rendering output format ## Testing - ✅ All migrated tests pass locally - ✅ Zero console warnings (verified with `NODE_ENV=development`) - ✅ TypeScript compilation successful - ✅ ESLint passes with no errors - ✅ Snapshots updated and validated ## Performance Improvements Tests are now faster and more deterministic: - No polling with `waitFor()` - direct assertions with timer control - Fake timers eliminate real-time waiting - More reliable in CI environments ## Checklist - [x] Removed all Enzyme dependencies from test files - [x] Added modern fake timer setup - [x] Configured userEvent with timer advancement - [x] Replaced waitFor() with timer control - [x] All tests pass with zero warnings - [x] TypeScript compiles without errors - [x] ESLint passes - [x] Snapshots updated - [x] Helper files migrated where needed ## Next Steps This is the first batch. Subsequent batches will continue migrating the remaining test files listed in issue elastic#222608. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

Pass scoped context to tutorial providers when building tutorials

3556f89

nreese added Feature:Add Data Add Data and sample data feature on Home :Sharing v7.0.0 v6.5.0 labels Aug 22, 2018

nreese mentioned this pull request Aug 22, 2018

Support for Kibana Spaces in Beats modules elastic/beats#7942

Closed

only generated scoped context one time

7a36733

kobelb reviewed Aug 23, 2018

View reviewed changes

spelling

c5e7564

kobelb approved these changes Aug 23, 2018

View reviewed changes

Merge branch 'master' of https://github.com/elastic/kibana into space…

e7588c7

…IdInTutorials

nreese merged commit b26e2b4 into elastic:master Sep 5, 2018

nreese mentioned this pull request Sep 5, 2018

[6.x] Pass scoped context to tutorial providers when building tutorials (#22260) #22743

Merged

nreese added a commit that referenced this pull request Sep 5, 2018

Pass scoped context to tutorial providers when building tutorials (#2…

2f0cf25

…2260) (#22743) * Pass scoped context to tutorial providers when building tutorials * only generated scoped context one time * spelling

legrego mentioned this pull request Sep 6, 2018

[Spaces] - Register tutorial context factory #22760

Merged

kapral18 mentioned this pull request Oct 14, 2025

[Management][Es Ui Shared][Kbn Management] Migrate Enzyme to RTL #238764

Merged

9 tasks

Comments

Conversation

nreese commented Aug 22, 2018

Uh oh!

elasticmachine commented Aug 22, 2018

💔 Build Failed

Uh oh!

nreese commented Aug 22, 2018

Uh oh!

nreese commented Aug 22, 2018

Uh oh!

elasticmachine commented Aug 22, 2018

💔 Build Failed

Uh oh!

ruflin commented Aug 23, 2018

Uh oh!

kobelb commented Aug 23, 2018

Uh oh!

kobelb Aug 23, 2018

Choose a reason for hiding this comment

Uh oh!

kobelb Aug 23, 2018

Choose a reason for hiding this comment

Uh oh!

nreese Aug 23, 2018

Choose a reason for hiding this comment

Uh oh!

kobelb Aug 23, 2018

Choose a reason for hiding this comment

Uh oh!

kobelb left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Aug 23, 2018

💔 Build Failed

Uh oh!

ycombinator commented Aug 29, 2018

Uh oh!

elasticmachine commented Aug 30, 2018

💔 Build Failed

Uh oh!

elasticmachine commented Sep 5, 2018

💚 Build Succeeded

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants