[Guided onboarding] Update header button logic #144634

yuliacech · 2022-11-04T16:51:05Z

Summary

This PR introduces a new state to the guided onboarding plugin. The state keeps track of the creationDate and of the overall status of the plugin. The creation date allows us to detect an "active" period during which the header button will be displayed more prominently in the header. Currently, the active period is set to 30 days. During this time, if the user has not started any guide or skipped the guide on the landing page, the header button will be displayed and when clicked, redirect the user to the landing page to start/continue a guide. The button is hidden when the user completed a guide or they quit before completion.
Also this PR adds a check for Cloud deployments and prevents the code from sending any API requests when not on Cloud, because guided onboarding is disabled on prem.

Screenshot

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios

…-fix'

alisonelizabeth

Nice work @yuliacech! Just took an initial glance through, as I know you are still working on a few things. This approach makes sense to me overall. Did not test locally yet. I will take another pass tomorrow.

alisonelizabeth · 2022-11-10T00:00:53Z

src/plugins/guided_onboarding/public/components/guide_button.tsx

+  // https://github.com/elastic/kibana/issues/139799, https://github.com/elastic/kibana/issues/139798
+
+  // if there is no active guide
+  if (!pluginState || !pluginState.activeGuide || !pluginState.activeGuide.isActive) {


Do we need the isActive flag anymore since the plugin state provides the activeGuide? In other words, would the activeGuide ever not be active? 🤔

I thought about that too, but I think we still need the flag isActive because guides are a separate saved object type and we keep all guides with their states in there. The only way to know which is the active guide is by querying the flag. Alternatively, we could keep an ID of the active guide in the plugin state SO, but I think the query works pretty well and is an already "tested" approach.

alisonelizabeth · 2022-11-10T00:04:44Z

src/plugins/guided_onboarding/public/components/guide_panel.test.tsx


-      await updateComponentWithState(component, mockInProgressTestGuideState, false);
+      describe('when not in active period', () => {


Does it make sense to add a test that the button is still visible if a guide is in progress and not in the active period?

alisonelizabeth · 2022-11-10T00:07:48Z

src/plugins/guided_onboarding/public/components/guide_panel.tsx

      const { id, status } = step;

      if (status === 'ready_to_complete') {
-        return await api.completeGuideStep(guideState?.guideId, id);
+        return await api.completeGuideStep(pluginState!.activeGuide!.guideId!, id);


[nit] Maybe extract this on L91 since it's used in a few places:

const guideId = pluginState!.activeGuide!.guideId!

alisonelizabeth · 2022-11-10T00:14:40Z

src/plugins/guided_onboarding/server/helpers/guide_state_utils.test.ts

@@ -0,0 +1,35 @@
+/*


Should this file be renamed plugin_state_utils.test.ts?

alisonelizabeth · 2022-11-10T00:15:14Z

src/plugins/guided_onboarding/server/helpers/plugin_state_utils.ts

+} from '../saved_objects';
+
+// hard code the duration to 30 days for now
+const activePeriodDurationInMilliseconds = 30 * 24 * 60 * 60 * 1000;


Should we open up a separate issue to make this configurable?

alisonelizabeth · 2022-11-10T00:22:14Z

src/plugins/guided_onboarding/common/types.ts

+ * Side Public License, v 1.
+ */
+
+import { GuideState } from '@kbn/guided-onboarding';


Can you remind me again why GuideState lives in a package and not in the plugin?

We needed GuideState in the Home plugin and then moved some of the code from the Home plugin into a package, so the types have to be in the package too.

…-ref HEAD~1..HEAD --fix'

elasticmachine · 2022-11-10T16:20:19Z

Pinging @elastic/platform-onboarding (Team:Journey/Onboarding)

jbudz

limits.yml

net diff is 1kb, update_limits is padding 15kb.

alisonelizabeth

Thanks for addressing my feedback! Verified changes locally and everything worked as expected.

I have one question about the "quit" behavior - my memory is a little fuzzy 😅, but I thought the button would be hidden in the scenario where the user quit a guide. Can you confirm with design? I'm OK to merge as-is and follow up later if necessary.

TinaHeiligers

LGTM in CI green

alisonelizabeth · 2022-11-14T19:38:02Z

@elasticmachine merge upstream

stephmilovic · 2022-11-14T20:48:07Z

@elasticmachine merge upstream

stephmilovic · 2022-11-14T22:50:32Z

@elasticmachine merge upstream

kibana-ci · 2022-11-14T23:50:11Z

💚 Build Succeeded

Buildkite Build
Commit: 3d8df84

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`guidedOnboarding`	37	43	+6

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`home`	158.0KB	158.0KB	+52.0B

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`guidedOnboarding`	1	3	+2

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`guidedOnboarding`	26.2KB	27.4KB	+1.2KB

Unknown metric groups

API count

id	before	after	diff
`guidedOnboarding`	37	43	+6

ESLint disabled in files

id	before	after	diff
`osquery`	1	2	+1

ESLint disabled line counts

id	before	after	diff
`enterpriseSearch`	19	21	+2
`fleet`	59	65	+6
`osquery`	108	113	+5
`securitySolution`	441	447	+6
total			+19

Total ESLint disabled count

id	before	after	diff
`enterpriseSearch`	20	22	+2
`fleet`	67	73	+6
`osquery`	109	115	+6
`securitySolution`	518	524	+6
total			+20

History

💔 Build #87748 failed 08a1cfc
💔 Build #87714 failed c6cc2ce
💔 Build #87675 failed 112e132
💚 Build #87481 succeeded a2ec2c7
💔 Build #87436 failed 85020ed

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

* main: (65 commits) Migrate server-side `Root` and `Server` to packages (elastic#144990) [Discover] Handle no data views state for `esQuery` alert (elastic#145052) [ML] Allow updates for number of allocations and priority for trained model deployments (elastic#144704) [api-docs] 2022-11-15 Daily api_docs build (elastic#145203) [Security solution] remove guided onboarding feature flag (elastic#144247) [DOCS] Automate final case APIs (elastic#145007) [Enterprise Search] Name and description flyout for connectors (elastic#143827) [Guided onboarding] Update header button logic (elastic#144634) [Lens] Multi metric partition charts (elastic#143966) [Dashboard] [Controls] Add unmapped runtime field support to options list (elastic#144947) [Security Solution] Add Task Metric Collection to New Tasks (elastic#145181) [TriggersActionsUi] disable jest config in CI (elastic#145186) [TableListView] Enhance tag filtering (elastic#142108) [Cloud Posture] Compliance by CIS section table (elastic#145114) [8.6][Session View] Fix hidden alert flyout in session view (elastic#145141) [customIntegrations] async load all components (elastic#145166) Fix time for logs smoke tests in integration test (elastic#145130) [RAM] Update rule status (elastic#140882) Update babel (main) (elastic#145060) [Actionable Observability] Add context.alertDetailsUrl variable to action connector template for APM rule types (elastic#144791) ...

yuliacech added release_note:skip Skip the PR/issue when compiling release notes Team:Journey/Onboarding Platform Journey Onboarding team labels Nov 4, 2022

yuliacech force-pushed the guided_onboarding/8.6_button_logic branch 2 times, most recently from 59ae0d3 to f6be0a0 Compare November 8, 2022 15:49

[Guided onboarding] Smashed commits for easier merge/conflict resolution

5165618

yuliacech force-pushed the guided_onboarding/8.6_button_logic branch from f6be0a0 to 5165618 Compare November 8, 2022 15:52

yuliacech and others added 15 commits November 8, 2022 20:00

[Guided onboarding] Integrate guideState into new pluginState

807c518

Merge branch 'main' into guided_onboarding/8.6_button_logic

f18c1b5

[Guided onboarding] Update the API

ae6f4aa

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

f532cf3

…-fix'

[Guided onboarding] More updates and test fixes

7f21014

[Guided onboarding] More fixes

de23465

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

bbd3358

…-fix'

[Guided onboarding] Fix jest tests

310f0e2

[Guided onboarding] Delete console

f6d091a

[Guided onboarding] Delete disabled status

c4c03aa

[Guided onboarding] Fix test description

066b1d3

[Guided onboarding] Put back todo about loading and error state

353fbf9

[Guided onboarding] Update the comments

715bffb

[Guided onboarding] Fix

0a93c9d

[Guided onboarding] Remove console

d3f9364

alisonelizabeth reviewed Nov 10, 2022

View reviewed changes

yuliacech and others added 3 commits November 10, 2022 12:19

Merge branch 'main' into guided_onboarding/8.6_button_logic

0589000

[Guided onboarding] Update api service mocks

88feb35

[Guided onboarding] Update api integration tests

d4b5f25

yuliacech mentioned this pull request Nov 10, 2022

[Guided onboarding] Make the duration of the "active" period configurable #144997

Open

yuliacech and others added 3 commits November 10, 2022 16:52

[Guided onboarding] Address CR comments

53a37f7

[CI] Auto-commit changed files from 'node scripts/precommit_hook.js -…

ce9e63a

…-ref HEAD~1..HEAD --fix'

[Guided onboarding] Fix

730cd42

yuliacech marked this pull request as ready for review November 10, 2022 16:20

yuliacech requested a review from alisonelizabeth November 10, 2022 16:20

yuliacech changed the title ~~[Guided onboarding] (WIP) Update header button logic~~ [Guided onboarding] Update header button logic Nov 10, 2022

[Guided onboarding] Update the limits and copy on the button

8608783

yuliacech requested a review from a team as a code owner November 10, 2022 16:49

[Guided onboarding] Fix SO tests

3a3cd5d

yuliacech requested a review from a team as a code owner November 10, 2022 17:39

stephmilovic mentioned this pull request Nov 10, 2022

[Security solution] remove guided onboarding feature flag #144247

Merged

jbudz approved these changes Nov 10, 2022

View reviewed changes

alisonelizabeth approved these changes Nov 10, 2022

View reviewed changes

yuliacech and others added 4 commits November 14, 2022 11:13

Merge branch 'main' into guided_onboarding/8.6_button_logic

17f9ac4

[Guided onboarding] Update the SO jest test snapshot

4ffe756

[Guided onboarding] Fix api unit tests

85020ed

[Guided onboarding] Fix jest tests

a2ec2c7

yuliacech enabled auto-merge (squash) November 14, 2022 13:57

[Guided onboarding] Hide the button when the user quits a guide

112e132

TinaHeiligers approved these changes Nov 14, 2022

View reviewed changes

Merge branch 'main' into guided_onboarding/8.6_button_logic

c6cc2ce

Merge branch 'main' into guided_onboarding/8.6_button_logic

08a1cfc

Merge branch 'main' into guided_onboarding/8.6_button_logic

3d8df84

yuliacech merged commit 879b101 into elastic:main Nov 14, 2022

kibanamachine added v8.6.0 backport:skip This commit does not require backporting labels Nov 14, 2022

tsullivan mentioned this pull request Nov 15, 2022

Clicking home menu button shows blank page #144653

Closed

yuliacech deleted the guided_onboarding/8.6_button_logic branch November 22, 2022 09:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Guided onboarding] Update header button logic #144634

[Guided onboarding] Update header button logic #144634

yuliacech commented Nov 4, 2022 •

edited

Loading

alisonelizabeth left a comment

alisonelizabeth Nov 10, 2022

yuliacech Nov 10, 2022 •

edited

Loading

alisonelizabeth Nov 10, 2022

alisonelizabeth Nov 10, 2022 •

edited

Loading

alisonelizabeth Nov 10, 2022

alisonelizabeth Nov 10, 2022

alisonelizabeth Nov 10, 2022 •

edited

Loading

yuliacech Nov 10, 2022

elasticmachine commented Nov 10, 2022

jbudz left a comment

alisonelizabeth left a comment

TinaHeiligers left a comment •

edited

Loading

alisonelizabeth commented Nov 14, 2022

stephmilovic commented Nov 14, 2022

stephmilovic commented Nov 14, 2022

kibana-ci commented Nov 14, 2022

API count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count


		await updateComponentWithState(component, mockInProgressTestGuideState, false);
		describe('when not in active period', () => {

[Guided onboarding] Update header button logic #144634

[Guided onboarding] Update header button logic #144634

Conversation

yuliacech commented Nov 4, 2022 • edited Loading

Summary

Screenshot

Checklist

alisonelizabeth left a comment

Choose a reason for hiding this comment

alisonelizabeth Nov 10, 2022

Choose a reason for hiding this comment

yuliacech Nov 10, 2022 • edited Loading

Choose a reason for hiding this comment

alisonelizabeth Nov 10, 2022

Choose a reason for hiding this comment

alisonelizabeth Nov 10, 2022 • edited Loading

Choose a reason for hiding this comment

alisonelizabeth Nov 10, 2022

Choose a reason for hiding this comment

alisonelizabeth Nov 10, 2022

Choose a reason for hiding this comment

alisonelizabeth Nov 10, 2022 • edited Loading

Choose a reason for hiding this comment

yuliacech Nov 10, 2022

Choose a reason for hiding this comment

elasticmachine commented Nov 10, 2022

jbudz left a comment

Choose a reason for hiding this comment

alisonelizabeth left a comment

Choose a reason for hiding this comment

TinaHeiligers left a comment • edited Loading

Choose a reason for hiding this comment

alisonelizabeth commented Nov 14, 2022

stephmilovic commented Nov 14, 2022

stephmilovic commented Nov 14, 2022

kibana-ci commented Nov 14, 2022

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

History

yuliacech commented Nov 4, 2022 •

edited

Loading

yuliacech Nov 10, 2022 •

edited

Loading

alisonelizabeth Nov 10, 2022 •

edited

Loading

alisonelizabeth Nov 10, 2022 •

edited

Loading

TinaHeiligers left a comment •

edited

Loading