[Security Solution] Investigation guide - insights in markdown #145240
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import type { Plugin } from 'unified'; | ||
| import React, { useContext } from 'react'; | ||
| import type { RemarkTokenizer } from '@elastic/eui'; | ||
| import { EuiSpacer, EuiCodeBlock, EuiLoadingSpinner, EuiIcon } from '@elastic/eui'; | ||
| import type { EuiMarkdownEditorUiPluginEditorProps } from '@elastic/eui/src/components/markdown_editor/markdown_types'; | ||
| import { i18n } from '@kbn/i18n'; | ||
| import { useAppToasts } from '../../../../hooks/use_app_toasts'; | ||
| import { useInsightQuery } from './use_insight_query'; | ||
| import { useInsightDataProviders } from './use_insight_data_providers'; | ||
| import { BasicAlertDataContext } from '../../../event_details/investigation_guide_view'; | ||
| import { InvestigateInTimelineButton } from '../../../event_details/table/investigate_in_timeline_button'; | ||
|
|
||
| interface InsightComponentProps { | ||
| label?: string; | ||
| description?: string; | ||
| providers?: string; | ||
| } | ||
|
|
||
| export const parser: Plugin = function () { | ||
| const Parser = this.Parser; | ||
| const tokenizers = Parser.prototype.inlineTokenizers; | ||
| const methods = Parser.prototype.inlineMethods; | ||
| const insightPrefix = '!{insight'; | ||
|
|
||
| const tokenizeInsight: RemarkTokenizer = function (eat, value, silent) { | ||
| if (value.startsWith(insightPrefix) === false) { | ||
| return false; | ||
| } | ||
|
|
||
| const nextChar = value[insightPrefix.length]; | ||
| if (nextChar !== '{' && nextChar !== '}') return false; | ||
| if (silent) { | ||
| return true; | ||
| } | ||
|
|
||
| // is there a configuration? | ||
| const hasConfiguration = nextChar === '{'; | ||
|
|
||
| let configuration: InsightComponentProps = {}; | ||
| if (hasConfiguration) { | ||
| let configurationString = ''; | ||
| let openObjects = 0; | ||
|
|
||
| for (let i = insightPrefix.length; i < value.length; i++) { | ||
| const char = value[i]; | ||
| if (char === '{') { | ||
| openObjects++; | ||
| configurationString += char; | ||
| } else if (char === '}') { | ||
| openObjects--; | ||
| if (openObjects === -1) { | ||
| break; | ||
| } | ||
| configurationString += char; | ||
| } else { | ||
| configurationString += char; | ||
| } | ||
| } | ||
|
|
||
| try { | ||
| configuration = JSON.parse(configurationString); | ||
| return eat(value)({ | ||
| type: 'insight', | ||
| ...configuration, | ||
| providers: JSON.stringify(configuration.providers), | ||
| }); | ||
| } catch (err) { | ||
| const now = eat.now(); | ||
| this.file.fail( | ||
| i18n.translate('xpack.securitySolution.markdownEditor.plugins.insightConfigError', { | ||
| values: { err }, | ||
| defaultMessage: 'Unable to parse insight JSON configuration: {err}', | ||
| }), | ||
| { | ||
| line: now.line, | ||
| column: now.column + insightPrefix.length, | ||
| } | ||
| ); | ||
| } | ||
| } | ||
| return false; | ||
| }; | ||
| tokenizeInsight.locator = (value: string, fromIndex: number) => { | ||
| return value.indexOf(insightPrefix, fromIndex); | ||
| }; | ||
| tokenizers.insight = tokenizeInsight; | ||
| methods.splice(methods.indexOf('text'), 0, 'insight'); | ||
| }; | ||
|
|
||
| // receives the configuration from the parser and renders | ||
| const InsightComponent = ({ label, description, providers }: InsightComponentProps) => { | ||
| const { addError } = useAppToasts(); | ||
| let parsedProviders = []; | ||
| try { | ||
| if (providers !== undefined) { | ||
|
There was a problem hiding this comment. providers can never be null? There was a problem hiding this comment. shouldn't be, but if they are, we just pass an empty array for data providers, and the button will render but show 0 |
||
| parsedProviders = JSON.parse(providers); | ||
| } | ||
| } catch (err) { | ||
| addError(err, { | ||
| title: i18n.translate('xpack.securitySolution.markdownEditor.plugins.insightProviderError', { | ||
| defaultMessage: 'Unable to parse insight provider configuration', | ||
| }), | ||
| }); | ||
| } | ||
| const { data: alertData } = useContext(BasicAlertDataContext); | ||
| const dataProviders = useInsightDataProviders({ | ||
| providers: parsedProviders, | ||
| alertData, | ||
| }); | ||
| const { totalCount, isQueryLoading, oldestTimestamp } = useInsightQuery({ | ||
| dataProviders, | ||
| }); | ||
| if (isQueryLoading) { | ||
| return <EuiLoadingSpinner size="l" />; | ||
| } else { | ||
| return ( | ||
| <InvestigateInTimelineButton | ||
| asEmptyButton={false} | ||
| dataProviders={dataProviders} | ||
| timeRange={oldestTimestamp} | ||
| keepDataView={true} | ||
| data-test-subj="insight-investigate-in-timeline-button" | ||
| > | ||
| <EuiIcon type="timeline" /> | ||
| {` ${label} (${totalCount}) - ${description}`} | ||
| </InvestigateInTimelineButton> | ||
| ); | ||
| } | ||
| }; | ||
|
|
||
| export { InsightComponent as renderer }; | ||
|
|
||
| const InsightEditorComponent = ({ | ||
| node, | ||
|
There was a problem hiding this comment. These props aren't used |
||
| onSave, | ||
| onCancel, | ||
| }: EuiMarkdownEditorUiPluginEditorProps<InsightComponentProps>) => { | ||
| return ( | ||
| <form> | ||
| <input type="text" /> | ||
| </form> | ||
| ); | ||
| }; | ||
|
|
||
| export const plugin = { | ||
| name: 'insight', | ||
| button: { | ||
| label: 'Insights', | ||
| iconType: 'timeline', | ||
| }, | ||
| helpText: ( | ||
| <div> | ||
| <EuiCodeBlock language="md" fontSize="l" paddingSize="s" isCopyable> | ||
| {'!{insight{options}}'} | ||
| </EuiCodeBlock> | ||
| <EuiSpacer size="s" /> | ||
| </div> | ||
| ), | ||
| editor: InsightEditorComponent, | ||
| }; | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it always to the current time? and should
timerangebefrominstead?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ya agree this was weirdly done by me, forgot to go back and change it. updated now so that timerange is passed as a prop or not at all. For the now, I think oldest timestamp -> now is as inclusive as we can be, since a value has to be supplied, not sure what else we could use.