[Security Solution] Set onboarding page to open "add integration" step when being used as an empty prompt #175296
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
angorayc
changed the title
This was referenced Jan 23, 2024
angorayc
added a commit
that referenced
this pull request
Jan 24, 2024
…174867) ## Summary #174742 This PR move the get_started component from `security_solution_serverless` plugin to `security_solution` plugin, so we can share the same UI between ESS and serverless. Parameters are set via `x-pack/plugins/security_solution/public/contract_get_started_page.ts` 1. productTypes - set by serverless only 2. projectsUrl - set by serverless only (when running serverless locally, this value is empty) 3. projectFeaturesUrl - set by serverless only (when running serverless locally, this value is empty) 4. availableSteps - set by both serverless and ESS (ESS doesn't contain `create your first project` step) Known issue: #175296 --- #### Serverless: 6 steps in total + the first step is finished by default  #### ESS: 5 steps in total  ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <[email protected]>
angorayc
changed the title
angorayc
force-pushed
the
empty-prompt
branch
from
1bcdf85 to
dec4be8
Compare
angorayc
added
Team:Threat Hunting
|
buildkite test this |
|
Pinging @elastic/security-threat-hunting (Team:Threat Hunting) |
|
Pinging @elastic/security-solution (Team: SecuritySolution) |
|
Pinging @elastic/security-threat-hunting-explore (Team:Threat Hunting:Explore) |
angorayc
added
release_note:skip
semd
reviewed
Jan 25, 2024
Comment on lines
+16
to
+17
| const OnBoarding = useMemo(() => getOnboardingComponent(), []); | ||
| return <OnBoarding indicesExist={indicesExist} defaultExpandedStep={defaultExpandedStep} />; |
There was a problem hiding this comment.
Do we need this getOnboardingComponent function now that we have the component? Couldn't we just return the lazy component itself from the index.tsx and render it directly here? 🤔
There was a problem hiding this comment.
You are right @semd , we don't need this anymore. I've removed it in https://github.com/elastic/kibana/pull/175719/files#diff-10832002bc5dfd1354f367e187c839c6e69e7155931e0bf2ab2db4e1fb6afba4
|
Reopened as I think we still need this before the design of new empty prompt is ready. |
💚 Build Succeeded
Metrics [docs]Async chunks
History
To update your PR or re-run it, just comment with: cc @angorayc |
CoenWarmer
pushed a commit
to CoenWarmer/kibana
that referenced
this pull request
Feb 15, 2024
…lastic#174867) ## Summary elastic#174742 This PR move the get_started component from `security_solution_serverless` plugin to `security_solution` plugin, so we can share the same UI between ESS and serverless. Parameters are set via `x-pack/plugins/security_solution/public/contract_get_started_page.ts` 1. productTypes - set by serverless only 2. projectsUrl - set by serverless only (when running serverless locally, this value is empty) 3. projectFeaturesUrl - set by serverless only (when running serverless locally, this value is empty) 4. availableSteps - set by both serverless and ESS (ESS doesn't contain `create your first project` step) Known issue: elastic#175296 --- #### Serverless: 6 steps in total + the first step is finished by default  #### ESS: 5 steps in total  ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Since this PR #174867, we've been sharing the onboarding page between serverless and ESS Kibana.
However when the onboarding component being used as an empty prompt, it still expands the step according to local storage. This user experience is not great, so I am adding
defaultExpandedStepprop to the onboarding component, so it can expand the specified step by default. By doing this, we can expandAddIntegrationStepswhen it is rendered as an empty prompt.Screen.Recording.2024-01-23.at.20.20.40.mov
Add
defaultExpandedStepprop, so it can expand the specific step.Scenario 1. Used as empty prompt
It should be redirected to the onboarding page and expand the
defaultExpandedStep(It should beAddIntegrationStepsexpanded by default when being used as an empty prompt).Scenario 2. Landing on the
Landing pagee.g.: /app/security/get_startedIt should expand the last visited step according to local storage. If never visited before, all the steps are collapsed.
Scenario 3. Landing on the
Landing pagewith hash e.g.: /app/security/get_started#add_integrationsIt should expand the step specified in the hash
Checklist
Delete any items that are not applicable to this PR.