diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 78c40c61b04ec..c212a02c5391b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -471,6 +471,7 @@ src/plugins/newsfeed @elastic/kibana-core test/common/plugins/newsfeed @elastic/kibana-core x-pack/plugins/notifications @elastic/appex-sharedux packages/kbn-object-versioning @elastic/appex-sharedux +x-pack/packages/observability/alert_details @elastic/actionable-observability x-pack/test/cases_api_integration/common/plugins/observability @elastic/response-ops x-pack/plugins/observability @elastic/actionable-observability x-pack/test/security_api_integration/plugins/oidc_provider @elastic/kibana-security diff --git a/.i18nrc.json b/.i18nrc.json index d1eddd2f56d5c..352fb2db82edb 100644 --- a/.i18nrc.json +++ b/.i18nrc.json @@ -18,6 +18,7 @@ "controls": "src/plugins/controls", "data": "src/plugins/data", "ecsDataQualityDashboard": "x-pack/packages/kbn-ecs-data-quality-dashboard", + "observabilityAlertDetails": "x-pack/packages/observability/alert_details", "dataViews": "src/plugins/data_views", "devTools": "src/plugins/dev_tools", "discover": "src/plugins/discover", diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 3abcc87ee5b80..848b8aa784b5e 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github description: API docs for the actions plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] --- import actionsObj from './actions.devdocs.json'; diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index e26f898115d7e..6aeb9cd5e6f64 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github description: API docs for the advancedSettings plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] --- import advancedSettingsObj from './advanced_settings.devdocs.json'; diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index 06d3d7db2badc..ec9b52e903375 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops title: "aiops" image: https://source.unsplash.com/400x175/?github description: API docs for the aiops plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] --- import aiopsObj from './aiops.devdocs.json'; diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index dbb486d2a4a3d..c0b64fbbc74e5 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github description: API docs for the alerting plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] --- import alertingObj from './alerting.devdocs.json'; diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 8d48039c676ce..5e5dd7c9d5dac 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github description: API docs for the apm plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] --- import apmObj from './apm.devdocs.json'; diff --git a/api_docs/asset_manager.mdx b/api_docs/asset_manager.mdx index 2b561999d8cb7..48439e2f4bc9a 100644 --- a/api_docs/asset_manager.mdx +++ b/api_docs/asset_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager title: "assetManager" image: https://source.unsplash.com/400x175/?github description: API docs for the assetManager plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager'] --- import assetManagerObj from './asset_manager.devdocs.json'; diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index ed5952e6733df..ee82dec905cb3 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github description: API docs for the banners plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] --- import bannersObj from './banners.devdocs.json'; diff --git a/api_docs/bfetch.devdocs.json b/api_docs/bfetch.devdocs.json index e4920b57c5d7b..a8de64ac0bb06 100644 --- a/api_docs/bfetch.devdocs.json +++ b/api_docs/bfetch.devdocs.json @@ -846,7 +846,7 @@ "tags": [], "label": "flush", "description": [ - "\nCall `.onflush` method and clear buffer." + "\nCall `.onFlush` method and clear buffer." ], "signature": [ "() => void" @@ -856,6 +856,24 @@ "trackAdoption": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "bfetch", + "id": "def-common.ItemBuffer.flushAsync", + "type": "Function", + "tags": [], + "label": "flushAsync", + "description": [ + "\nSame as `.flush()` but asynchronous, and returns a promise, which\nrejects if `.onFlush` throws." + ], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -991,6 +1009,22 @@ "trackAdoption": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "bfetch", + "id": "def-common.TimedItemBuffer.flushAsync", + "type": "Function", + "tags": [], + "label": "flushAsync", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "src/plugins/bfetch/common/buffer/timed_item_buffer.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1525,7 +1559,7 @@ "\nCallback that is called every time buffer is flushed. It receives a single\nargument which is a list of all buffered items. If `.flush()` is called\nwhen buffer is empty, `.onflush` is called with empty array." ], "signature": [ - "(items: Item[]) => void" + "(items: Item[]) => void | Promise" ], "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "deprecated": false, diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index c45a5e8db1ba4..5432739f41862 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github description: API docs for the bfetch plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] --- import bfetchObj from './bfetch.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 89 | 1 | 74 | 2 | +| 91 | 1 | 75 | 2 | ## Client diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index e68788f18f80d..3073869d8587c 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github description: API docs for the canvas plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] --- import canvasObj from './canvas.devdocs.json'; diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json index d296b38bd3375..3e59b79ad242b 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -874,7 +874,23 @@ "CaseSeverity", " | undefined; assignees?: string | string[] | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string | string[] | undefined; from?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string | string[] | undefined; rootSearchFields?: string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<", "Cases", - ">; getCasesStatus: (query: { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ countOpenCases: number; countInProgressCases: number; countClosedCases: number; }>; getCasesMetrics: (query: { features: string[]; } & { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ mttr?: number | null | undefined; }>; }; }" + ">; getCasesStatus: (query: { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ countOpenCases: number; countInProgressCases: number; countClosedCases: number; }>; getCasesMetrics: (query: { features: string[]; } & { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ mttr?: number | null | undefined; }>; bulkGet: (params: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CasesBulkGetRequestCertainFields", + "text": "CasesBulkGetRequestCertainFields" + }, + ", signal?: AbortSignal | undefined) => Promise<", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CasesBulkGetResponseCertainFields", + "text": "CasesBulkGetResponseCertainFields" + }, + ">; }; }" ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false, diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 1a60e66aef014..e537edb0d30be 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github description: API docs for the cases plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] --- import casesObj from './cases.devdocs.json'; diff --git a/api_docs/charts.devdocs.json b/api_docs/charts.devdocs.json index 95753867fedab..14d6098c42f3d 100644 --- a/api_docs/charts.devdocs.json +++ b/api_docs/charts.devdocs.json @@ -3370,6 +3370,57 @@ } ], "misc": [ + { + "parentPluginId": "charts", + "id": "def-common.AllowedSettingsOverrides", + "type": "Type", + "tags": [], + "label": "AllowedSettingsOverrides", + "description": [], + "signature": [ + "{ settings?: { tooltip?: ", + "TooltipSettings", + " | undefined; debug?: boolean | undefined; theme?: ", + "MakeOverridesSerializable", + "<", + "RecursivePartial", + "<", + "Theme", + "> | ", + "RecursivePartial", + "<", + "Theme", + ">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ", + "Position", + " | ", + "LegendPositionConfig", + " | undefined; rotation?: ", + "Rotation", + " | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", + "Rendering", + " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", + "MakeOverridesSerializable", + "<", + "ExternalPointerEventsSettings", + " | undefined>; pointBuffer?: ", + "MarkBuffer", + " | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ", + "PointerUpdateTrigger", + " | undefined; brushAxis?: ", + "BrushAxis", + " | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; xDomain?: ", + "MakeOverridesSerializable", + "<", + "CustomXDomain", + " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", + "LegendStrategy", + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; } | undefined; }" + ], + "path": "src/plugins/charts/common/static/overrides/settings.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "charts", "id": "def-common.COLOR_MAPPING_SETTING", diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index 4ef3b4378e352..34612af93b5e8 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github description: API docs for the charts plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] --- import chartsObj from './charts.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 270 | 16 | 255 | 9 | +| 271 | 16 | 256 | 10 | ## Client diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index 0d457a99208da..bc3597f36c448 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github description: API docs for the cloud plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] --- import cloudObj from './cloud.devdocs.json'; diff --git a/api_docs/cloud_chat.mdx b/api_docs/cloud_chat.mdx index fda0e6249dd3d..1d20b0a5dd6b1 100644 --- a/api_docs/cloud_chat.mdx +++ b/api_docs/cloud_chat.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat title: "cloudChat" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudChat plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat'] --- import cloudChatObj from './cloud_chat.devdocs.json'; diff --git a/api_docs/cloud_data_migration.mdx b/api_docs/cloud_data_migration.mdx index 0f2b3f0d61684..50bfec0a5425b 100644 --- a/api_docs/cloud_data_migration.mdx +++ b/api_docs/cloud_data_migration.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration title: "cloudDataMigration" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudDataMigration plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration'] --- import cloudDataMigrationObj from './cloud_data_migration.devdocs.json'; diff --git a/api_docs/cloud_defend.mdx b/api_docs/cloud_defend.mdx index 068d4e7b250d1..12176e7b36656 100644 --- a/api_docs/cloud_defend.mdx +++ b/api_docs/cloud_defend.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend title: "cloudDefend" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudDefend plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend'] --- import cloudDefendObj from './cloud_defend.devdocs.json'; diff --git a/api_docs/cloud_experiments.mdx b/api_docs/cloud_experiments.mdx index 805f45df01d84..d84bbc77b1f55 100644 --- a/api_docs/cloud_experiments.mdx +++ b/api_docs/cloud_experiments.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments title: "cloudExperiments" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudExperiments plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments'] --- import cloudExperimentsObj from './cloud_experiments.devdocs.json'; diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index f9e4593145c35..3c04821989c04 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudSecurityPosture plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] --- import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json'; diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 60ba601960d3a..63a8d4344f659 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github description: API docs for the console plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] --- import consoleObj from './console.devdocs.json'; diff --git a/api_docs/content_management.devdocs.json b/api_docs/content_management.devdocs.json index 8e1c319c19919..69a49d0e79b17 100644 --- a/api_docs/content_management.devdocs.json +++ b/api_docs/content_management.devdocs.json @@ -59,7 +59,7 @@ "section": "def-common.SearchIn", "text": "SearchIn" }, - " = ", + " = ", { "pluginId": "contentManagement", "scope": "common", @@ -67,7 +67,7 @@ "section": "def-common.SearchIn", "text": "SearchIn" }, - ", O = unknown>(_input: I) => { queryKey: readonly [string, \"search\", unknown]; queryFn: () => Promise; }; }" + ", O = unknown>(_input: I) => { queryKey: readonly [string, \"search\", unknown, object | undefined]; queryFn: () => Promise; }; }" ], "path": "src/plugins/content_management/public/content_client/content_client.tsx", "deprecated": false, @@ -95,7 +95,7 @@ "label": "crudClientProvider", "description": [], "signature": [ - "(contentType: string) => ", + "(contentType?: string | undefined) => ", { "pluginId": "contentManagement", "scope": "public", @@ -363,7 +363,7 @@ "section": "def-common.SearchIn", "text": "SearchIn" }, - ", O = unknown>(input: I) => Promise" + ", O = unknown>(input: I) => Promise" ], "path": "src/plugins/content_management/public/content_client/content_client.tsx", "deprecated": false, @@ -403,7 +403,7 @@ "section": "def-common.SearchIn", "text": "SearchIn" }, - ", O = unknown>(input: I) => ", + ", O = unknown>(input: I) => ", "Observable", "<", "QueryObserverResult", @@ -430,6 +430,52 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "contentManagement", + "id": "def-public.ContentClient.mSearch", + "type": "Function", + "tags": [], + "label": "mSearch", + "description": [], + "signature": [ + "(input: ", + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.MSearchIn", + "text": "MSearchIn" + }, + ") => Promise<{ hits: T[]; pagination: { total: number; cursor?: string | undefined; }; }>" + ], + "path": "src/plugins/content_management/public/content_client/content_client.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "contentManagement", + "id": "def-public.ContentClient.mSearch.$1", + "type": "Object", + "tags": [], + "label": "input", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.MSearchIn", + "text": "MSearchIn" + } + ], + "path": "src/plugins/content_management/public/content_client/content_client.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -684,7 +730,7 @@ "section": "def-common.SearchIn", "text": "SearchIn" }, - " = ", + " = ", { "pluginId": "contentManagement", "scope": "common", @@ -692,7 +738,7 @@ "section": "def-common.SearchIn", "text": "SearchIn" }, - ", O = unknown>(input: I, queryOptions?: ", + ", O = unknown>(input: I, queryOptions?: ", { "pluginId": "contentManagement", "scope": "public", @@ -1005,7 +1051,7 @@ "section": "def-common.SearchIn", "text": "SearchIn" }, - ") => Promise" + ") => Promise" ], "path": "src/plugins/content_management/public/crud_client/crud_client.ts", "deprecated": false, @@ -1026,7 +1072,53 @@ "section": "def-common.SearchIn", "text": "SearchIn" }, - "" + "" + ], + "path": "src/plugins/content_management/public/crud_client/crud_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "contentManagement", + "id": "def-public.CrudClient.mSearch", + "type": "Function", + "tags": [], + "label": "mSearch", + "description": [], + "signature": [ + "((input: ", + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.MSearchIn", + "text": "MSearchIn" + }, + ") => Promise) | undefined" + ], + "path": "src/plugins/content_management/public/crud_client/crud_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "contentManagement", + "id": "def-public.CrudClient.mSearch.$1", + "type": "Object", + "tags": [], + "label": "input", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.MSearchIn", + "text": "MSearchIn" + } ], "path": "src/plugins/content_management/public/crud_client/crud_client.ts", "deprecated": false, @@ -1159,6 +1251,16 @@ "tags": [], "label": "ContentStorage", "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "server", + "docId": "kibContentManagementPluginApi", + "section": "def-server.ContentStorage", + "text": "ContentStorage" + }, + "" + ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, "trackAdoption": false, @@ -1181,7 +1283,7 @@ "section": "def-server.StorageContext", "text": "StorageContext" }, - ", id: string, options: unknown) => Promise" + ", id: string, options?: object | undefined) => Promise<{ item: T; } | { item: T; meta: any; }>" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, @@ -1226,17 +1328,17 @@ { "parentPluginId": "contentManagement", "id": "def-server.ContentStorage.get.$3", - "type": "Unknown", + "type": "Uncategorized", "tags": [], "label": "options", "description": [], "signature": [ - "unknown" + "object | undefined" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -1259,7 +1361,7 @@ "section": "def-server.StorageContext", "text": "StorageContext" }, - ", ids: string[], options: unknown) => Promise" + ", ids: string[], options?: object | undefined) => Promise<{ hits: ({ item: T; } | { item: T; meta: any; })[]; }>" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, @@ -1304,17 +1406,17 @@ { "parentPluginId": "contentManagement", "id": "def-server.ContentStorage.bulkGet.$3", - "type": "Unknown", + "type": "Uncategorized", "tags": [], "label": "options", "description": [], "signature": [ - "unknown" + "object | undefined" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -1337,7 +1439,7 @@ "section": "def-server.StorageContext", "text": "StorageContext" }, - ", data: object, options: unknown) => Promise" + ", data: object, options?: object | undefined) => Promise<{ item: T; } | { item: T; meta: any; }>" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, @@ -1382,17 +1484,17 @@ { "parentPluginId": "contentManagement", "id": "def-server.ContentStorage.create.$3", - "type": "Unknown", + "type": "Uncategorized", "tags": [], "label": "options", "description": [], "signature": [ - "unknown" + "object | undefined" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -1415,7 +1517,7 @@ "section": "def-server.StorageContext", "text": "StorageContext" }, - ", id: string, data: object, options: unknown) => Promise" + ", id: string, data: object, options?: object | undefined) => Promise<{ item: U; } | { item: U; meta: any; }>" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, @@ -1475,17 +1577,17 @@ { "parentPluginId": "contentManagement", "id": "def-server.ContentStorage.update.$4", - "type": "Unknown", + "type": "Uncategorized", "tags": [], "label": "options", "description": [], "signature": [ - "unknown" + "object | undefined" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -1508,7 +1610,15 @@ "section": "def-server.StorageContext", "text": "StorageContext" }, - ", id: string, options: unknown) => Promise" + ", id: string, options?: object | undefined) => Promise<", + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.DeleteResult", + "text": "DeleteResult" + }, + ">" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, @@ -1553,17 +1663,17 @@ { "parentPluginId": "contentManagement", "id": "def-server.ContentStorage.delete.$3", - "type": "Unknown", + "type": "Uncategorized", "tags": [], "label": "options", "description": [], "signature": [ - "unknown" + "object | undefined" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -1586,7 +1696,15 @@ "section": "def-server.StorageContext", "text": "StorageContext" }, - ", query: object, options: unknown) => Promise" + ", query: ", + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchQuery", + "text": "SearchQuery" + }, + ", options?: object | undefined) => Promise<{ hits: T[]; pagination: { total: number; cursor?: string | undefined; }; }>" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, @@ -1616,12 +1734,18 @@ { "parentPluginId": "contentManagement", "id": "def-server.ContentStorage.search.$2", - "type": "Uncategorized", + "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ - "object" + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchQuery", + "text": "SearchQuery" + } ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, @@ -1631,20 +1755,37 @@ { "parentPluginId": "contentManagement", "id": "def-server.ContentStorage.search.$3", - "type": "Unknown", + "type": "Uncategorized", "tags": [], "label": "options", "description": [], "signature": [ - "unknown" + "object | undefined" ], "path": "src/plugins/content_management/server/core/types.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] + }, + { + "parentPluginId": "contentManagement", + "id": "def-server.ContentStorage.mSearch", + "type": "Object", + "tags": [], + "label": "mSearch", + "description": [ + "\nOpt-in to multi-type search.\nCan only be supported if the content type is backed by a saved object since `mSearch` is using the `savedObjects.find` API." + ], + "signature": [ + "MSearchConfig", + " | undefined" + ], + "path": "src/plugins/content_management/server/core/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -2022,6 +2163,31 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.DeleteResult", + "type": "Interface", + "tags": [], + "label": "DeleteResult", + "description": [], + "path": "src/plugins/content_management/common/rpc/delete.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "contentManagement", + "id": "def-common.DeleteResult.success", + "type": "boolean", + "tags": [], + "label": "success", + "description": [], + "path": "src/plugins/content_management/common/rpc/delete.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "contentManagement", "id": "def-common.GetIn", @@ -2099,6 +2265,106 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.MSearchIn", + "type": "Interface", + "tags": [], + "label": "MSearchIn", + "description": [], + "path": "src/plugins/content_management/common/rpc/msearch.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "contentManagement", + "id": "def-common.MSearchIn.contentTypes", + "type": "Array", + "tags": [], + "label": "contentTypes", + "description": [], + "signature": [ + "{ contentTypeId: string; version?: number | undefined; }[]" + ], + "path": "src/plugins/content_management/common/rpc/msearch.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.MSearchIn.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchQuery", + "text": "SearchQuery" + } + ], + "path": "src/plugins/content_management/common/rpc/msearch.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.MSearchOut", + "type": "Interface", + "tags": [], + "label": "MSearchOut", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.MSearchOut", + "text": "MSearchOut" + }, + "" + ], + "path": "src/plugins/content_management/common/rpc/msearch.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "contentManagement", + "id": "def-common.MSearchOut.contentTypes", + "type": "Array", + "tags": [], + "label": "contentTypes", + "description": [], + "signature": [ + "{ contentTypeId: string; version?: number | undefined; }[]" + ], + "path": "src/plugins/content_management/common/rpc/msearch.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.MSearchOut.result", + "type": "Object", + "tags": [], + "label": "result", + "description": [], + "signature": [ + "{ hits: T[]; pagination: { total: number; cursor?: string | undefined; }; }" + ], + "path": "src/plugins/content_management/common/rpc/msearch.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "contentManagement", "id": "def-common.ProcedureSchemas", @@ -2172,7 +2438,7 @@ "section": "def-common.SearchIn", "text": "SearchIn" }, - "" + "" ], "path": "src/plugins/content_management/common/rpc/search.ts", "deprecated": false, @@ -2195,12 +2461,18 @@ { "parentPluginId": "contentManagement", "id": "def-common.SearchIn.query", - "type": "Uncategorized", + "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ - "Query" + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchQuery", + "text": "SearchQuery" + } ], "path": "src/plugins/content_management/common/rpc/search.ts", "deprecated": false, @@ -2237,6 +2509,84 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.SearchQuery", + "type": "Interface", + "tags": [], + "label": "SearchQuery", + "description": [], + "path": "src/plugins/content_management/common/rpc/search.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "contentManagement", + "id": "def-common.SearchQuery.text", + "type": "string", + "tags": [], + "label": "text", + "description": [ + "The text to search for" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/content_management/common/rpc/search.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.SearchQuery.tags", + "type": "Object", + "tags": [], + "label": "tags", + "description": [ + "List of tags id to include and exclude" + ], + "signature": [ + "{ included?: string[] | undefined; excluded?: string[] | undefined; } | undefined" + ], + "path": "src/plugins/content_management/common/rpc/search.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.SearchQuery.limit", + "type": "number", + "tags": [], + "label": "limit", + "description": [ + "The number of result to return" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/content_management/common/rpc/search.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.SearchQuery.cursor", + "type": "string", + "tags": [], + "label": "cursor", + "description": [ + "The cursor for this query. Can be a page number or a cursor" + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/content_management/common/rpc/search.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "contentManagement", "id": "def-common.UpdateIn", @@ -2346,6 +2696,91 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "contentManagement", + "id": "def-common.BulkGetResult", + "type": "Type", + "tags": [], + "label": "BulkGetResult", + "description": [], + "signature": [ + "ResultMeta extends void ? { hits: ", + "ItemResult", + "[]; } : { hits: ", + "ItemResult", + "[]; meta: ResultMeta; }" + ], + "path": "src/plugins/content_management/common/rpc/bulk_get.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.CreateResult", + "type": "Type", + "tags": [], + "label": "CreateResult", + "description": [], + "signature": [ + "M extends void ? { item: T; } : { item: T; meta: M; }" + ], + "path": "src/plugins/content_management/common/rpc/create.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.GetResult", + "type": "Type", + "tags": [], + "label": "GetResult", + "description": [], + "signature": [ + "M extends void ? { item: T; } : { item: T; meta: M; }" + ], + "path": "src/plugins/content_management/common/rpc/get.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.MSearchQuery", + "type": "Type", + "tags": [], + "label": "MSearchQuery", + "description": [], + "signature": [ + { + "pluginId": "contentManagement", + "scope": "common", + "docId": "kibContentManagementPluginApi", + "section": "def-common.SearchQuery", + "text": "SearchQuery" + } + ], + "path": "src/plugins/content_management/common/rpc/msearch.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.MSearchResult", + "type": "Type", + "tags": [], + "label": "MSearchResult", + "description": [], + "signature": [ + "{ hits: T[]; pagination: { total: number; cursor?: string | undefined; }; }" + ], + "path": "src/plugins/content_management/common/rpc/msearch.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "contentManagement", "id": "def-common.PLUGIN_ID", @@ -2369,12 +2804,42 @@ "label": "ProcedureName", "description": [], "signature": [ - "\"create\" | \"update\" | \"get\" | \"delete\" | \"search\" | \"bulkGet\"" + "\"create\" | \"update\" | \"get\" | \"delete\" | \"search\" | \"bulkGet\" | \"mSearch\"" ], "path": "src/plugins/content_management/common/rpc/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.SearchResult", + "type": "Type", + "tags": [], + "label": "SearchResult", + "description": [], + "signature": [ + "M extends void ? { hits: T[]; pagination: { total: number; cursor?: string | undefined; }; } : { hits: T[]; pagination: { total: number; cursor?: string | undefined; }; meta: M; }" + ], + "path": "src/plugins/content_management/common/rpc/search.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "contentManagement", + "id": "def-common.UpdateResult", + "type": "Type", + "tags": [], + "label": "UpdateResult", + "description": [], + "signature": [ + "M extends void ? { item: T; } : { item: T; meta: M; }" + ], + "path": "src/plugins/content_management/common/rpc/update.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false } ], "objects": [] diff --git a/api_docs/content_management.mdx b/api_docs/content_management.mdx index cfd738c4dc907..1e15d0329ca53 100644 --- a/api_docs/content_management.mdx +++ b/api_docs/content_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement title: "contentManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the contentManagement plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement'] --- import contentManagementObj from './content_management.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 118 | 0 | 104 | 4 | +| 143 | 0 | 124 | 6 | ## Client diff --git a/api_docs/controls.devdocs.json b/api_docs/controls.devdocs.json index 9b8b0ed06703b..ad5df876690bd 100644 --- a/api_docs/controls.devdocs.json +++ b/api_docs/controls.devdocs.json @@ -2190,9 +2190,15 @@ "label": "isFieldCompatible", "description": [], "signature": [ - "(dataControlField: ", - "DataControlField", - ") => void" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + ") => boolean" ], "path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx", "deprecated": false, @@ -2203,10 +2209,16 @@ "id": "def-public.OptionsListEmbeddableFactory.isFieldCompatible.$1", "type": "Object", "tags": [], - "label": "dataControlField", + "label": "field", "description": [], "signature": [ - "DataControlField" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } ], "path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx", "deprecated": false, @@ -3164,9 +3176,15 @@ "label": "isFieldCompatible", "description": [], "signature": [ - "(dataControlField: ", - "DataControlField", - ") => void" + "(field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + ") => boolean" ], "path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx", "deprecated": false, @@ -3177,10 +3195,16 @@ "id": "def-public.RangeSliderEmbeddableFactory.isFieldCompatible.$1", "type": "Object", "tags": [], - "label": "dataControlField", + "label": "field", "description": [], "signature": [ - "DataControlField" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } ], "path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx", "deprecated": false, @@ -4110,7 +4134,55 @@ "section": "def-public.IEditableControlFactory", "text": "IEditableControlFactory" }, - "" + " extends Pick<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any>, unknown>, \"type\">" ], "path": "src/plugins/controls/public/types.ts", "deprecated": false, @@ -4249,9 +4321,15 @@ "label": "isFieldCompatible", "description": [], "signature": [ - "((dataControlField: ", - "DataControlField", - ") => void) | undefined" + "((field: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + ") => boolean) | undefined" ], "path": "src/plugins/controls/public/types.ts", "deprecated": false, @@ -4262,10 +4340,16 @@ "id": "def-public.IEditableControlFactory.isFieldCompatible.$1", "type": "Object", "tags": [], - "label": "dataControlField", + "label": "field", "description": [], "signature": [ - "DataControlField" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + } ], "path": "src/plugins/controls/public/types.ts", "deprecated": false, diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 84ea741f88949..da9ae3a7a9af8 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github description: API docs for the controls plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] --- import controlsObj from './controls.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 273 | 0 | 269 | 11 | +| 273 | 0 | 269 | 10 | ## Client diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index 2677caabae542..18a3244fe7fc6 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github description: API docs for the customIntegrations plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] --- import customIntegrationsObj from './custom_integrations.devdocs.json'; diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 70d842f8c591f..d49c16e86b62a 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the dashboard plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] --- import dashboardObj from './dashboard.devdocs.json'; diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 699e6e3835aa5..6708ca80950bd 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the dashboardEnhanced plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] --- import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json'; diff --git a/api_docs/data.mdx b/api_docs/data.mdx index 52dbe172c379f..03da95f0410a5 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github description: API docs for the data plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] --- import dataObj from './data.devdocs.json'; diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index e217585a8360e..4b2da7e74aeb0 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github description: API docs for the data.query plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] --- import dataQueryObj from './data_query.devdocs.json'; diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 42af45cfe83e6..40669c0f3c6da 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github description: API docs for the data.search plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] --- import dataSearchObj from './data_search.devdocs.json'; diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 7a48f85c1cb5e..7c0e4eef3a53e 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewEditor plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] --- import dataViewEditorObj from './data_view_editor.devdocs.json'; diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index a58fe66d8e4a4..62732f983c692 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewFieldEditor plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] --- import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json'; diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index 76e9bb8c19498..6dce4803c9e85 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewManagement plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] --- import dataViewManagementObj from './data_view_management.devdocs.json'; diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index 00357ba183fe9..a654c6bb57be5 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViews plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] --- import dataViewsObj from './data_views.devdocs.json'; diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 25c8e21440555..4d5e97772bf86 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github description: API docs for the dataVisualizer plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] --- import dataVisualizerObj from './data_visualizer.devdocs.json'; diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index 90b0e9c87a7af..c575fbee67cc8 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 89256f40a31cf..c34a9e6c41315 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index 0ffb371cc92bc..cd562203170d8 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team description: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index bef5e98650f6a..04af9994e8afb 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github description: API docs for the devTools plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] --- import devToolsObj from './dev_tools.devdocs.json'; diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index e12ff6d6c9a1f..639224802b7ab 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github description: API docs for the discover plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] --- import discoverObj from './discover.devdocs.json'; diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 206a5d41087cd..82f271e12bb17 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the discoverEnhanced plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] --- import discoverEnhancedObj from './discover_enhanced.devdocs.json'; diff --git a/api_docs/ecs_data_quality_dashboard.mdx b/api_docs/ecs_data_quality_dashboard.mdx index adfafeaf96bd6..635feab46cf85 100644 --- a/api_docs/ecs_data_quality_dashboard.mdx +++ b/api_docs/ecs_data_quality_dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard title: "ecsDataQualityDashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the ecsDataQualityDashboard plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard'] --- import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 288097d291a93..a0f77be1e833e 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github description: API docs for the embeddable plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] --- import embeddableObj from './embeddable.devdocs.json'; diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index a2fc118ffd25c..ce620201f29c9 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the embeddableEnhanced plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] --- import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json'; diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index 347e3beaf7996..0f3fe4b6438e6 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github description: API docs for the encryptedSavedObjects plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] --- import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json'; diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index cae4dd3d86be5..8a90c38e641eb 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the enterpriseSearch plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] --- import enterpriseSearchObj from './enterprise_search.devdocs.json'; diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index a030a9d4a52f7..89b39777865a3 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github description: API docs for the esUiShared plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] --- import esUiSharedObj from './es_ui_shared.devdocs.json'; diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index 2ea349ebf7fa4..29c304f324e1d 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github description: API docs for the eventAnnotation plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] --- import eventAnnotationObj from './event_annotation.devdocs.json'; diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index e2c5d79848358..adb96b79760b5 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github description: API docs for the eventLog plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] --- import eventLogObj from './event_log.devdocs.json'; diff --git a/api_docs/exploratory_view.mdx b/api_docs/exploratory_view.mdx index e3cc82f1bdd2f..03878a061edc5 100644 --- a/api_docs/exploratory_view.mdx +++ b/api_docs/exploratory_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView title: "exploratoryView" image: https://source.unsplash.com/400x175/?github description: API docs for the exploratoryView plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView'] --- import exploratoryViewObj from './exploratory_view.devdocs.json'; diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index a99bf312c41f3..bd8c1593a9f35 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionError plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] --- import expressionErrorObj from './expression_error.devdocs.json'; diff --git a/api_docs/expression_gauge.devdocs.json b/api_docs/expression_gauge.devdocs.json index c7d1cad58dfd9..82fdab5547877 100644 --- a/api_docs/expression_gauge.devdocs.json +++ b/api_docs/expression_gauge.devdocs.json @@ -893,6 +893,49 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "expressionGauge", + "id": "def-common.AllowedGaugeOverrides", + "type": "Type", + "tags": [], + "label": "AllowedGaugeOverrides", + "description": [], + "signature": [ + "{ gauge?: { id: string; subtype: ", + "GoalSubtype", + "; target?: number | undefined; bands?: number | number[] | undefined; ticks?: number | number[] | undefined; domain: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "GoalDomainRange", + ">; base?: number | undefined; actual?: number | undefined; bandFillColor?: \"ignore\" | undefined; tickValueFormatter?: \"ignore\" | undefined; labelMajor?: string | ", + "GoalLabelAccessor", + " | undefined; labelMinor?: string | ", + "GoalLabelAccessor", + " | undefined; centralMajor?: string | ", + "GoalLabelAccessor", + " | undefined; centralMinor?: string | ", + "GoalLabelAccessor", + " | undefined; angleStart?: number | undefined; angleEnd?: number | undefined; bandLabels?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "; tooltipValueFormatter?: \"ignore\" | undefined; } | undefined; }" + ], + "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "expressionGauge", "id": "def-common.EXPRESSION_GAUGE_NAME", @@ -1160,7 +1203,71 @@ "section": "def-public.PersistedState", "text": "PersistedState" }, - "; }" + "; overrides?: (Partial; base?: number | undefined; actual?: number | undefined; bandFillColor?: \"ignore\" | undefined; tickValueFormatter?: \"ignore\" | undefined; labelMajor?: string | ", + "GoalLabelAccessor", + " | undefined; labelMinor?: string | ", + "GoalLabelAccessor", + " | undefined; centralMajor?: string | ", + "GoalLabelAccessor", + " | undefined; centralMinor?: string | ", + "GoalLabelAccessor", + " | undefined; angleStart?: number | undefined; angleEnd?: number | undefined; bandLabels?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "; tooltipValueFormatter?: \"ignore\" | undefined; }>> & Partial | ", + "RecursivePartial", + "<", + "Theme", + ">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ", + "Position", + " | ", + "LegendPositionConfig", + " | undefined; rotation?: ", + "Rotation", + " | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", + "Rendering", + " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", + "MakeOverridesSerializable", + "<", + "ExternalPointerEventsSettings", + " | undefined>; pointBuffer?: ", + "MarkBuffer", + " | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ", + "PointerUpdateTrigger", + " | undefined; brushAxis?: ", + "BrushAxis", + " | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; xDomain?: ", + "MakeOverridesSerializable", + "<", + "CustomXDomain", + " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", + "LegendStrategy", + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>>) | undefined; }" ], "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", "deprecated": false, diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 7cb7dc05fe265..9390033f0209b 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionGauge plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] --- import expressionGaugeObj from './expression_gauge.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 58 | 0 | 58 | 2 | +| 59 | 0 | 59 | 2 | ## Client diff --git a/api_docs/expression_heatmap.devdocs.json b/api_docs/expression_heatmap.devdocs.json index 75f69c2db4313..747b9bef44b61 100644 --- a/api_docs/expression_heatmap.devdocs.json +++ b/api_docs/expression_heatmap.devdocs.json @@ -484,6 +484,56 @@ "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_functions.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "expressionHeatmap", + "id": "def-common.HeatmapExpressionProps.overrides", + "type": "Object", + "tags": [], + "label": "overrides", + "description": [], + "signature": [ + "Partial | ", + "RecursivePartial", + "<", + "Theme", + ">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ", + "Position", + " | ", + "LegendPositionConfig", + " | undefined; rotation?: ", + "Rotation", + " | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", + "Rendering", + " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", + "MakeOverridesSerializable", + "<", + "ExternalPointerEventsSettings", + " | undefined>; pointBuffer?: ", + "MarkBuffer", + " | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ", + "PointerUpdateTrigger", + " | undefined; brushAxis?: ", + "BrushAxis", + " | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; xDomain?: ", + "MakeOverridesSerializable", + "<", + "CustomXDomain", + " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", + "LegendStrategy", + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> | undefined" + ], + "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_functions.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index 26c8b8c7991b9..729ec4b13a28e 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionHeatmap plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] --- import expressionHeatmapObj from './expression_heatmap.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 111 | 14 | 107 | 2 | +| 112 | 14 | 108 | 2 | ## Common diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index a977530750155..5587dd50824c6 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionImage plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] --- import expressionImageObj from './expression_image.devdocs.json'; diff --git a/api_docs/expression_legacy_metric_vis.mdx b/api_docs/expression_legacy_metric_vis.mdx index 4946363199cc5..eac1d6ac4e303 100644 --- a/api_docs/expression_legacy_metric_vis.mdx +++ b/api_docs/expression_legacy_metric_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis title: "expressionLegacyMetricVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionLegacyMetricVis plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis'] --- import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json'; diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 2af0d944d2260..3a363b9d2db87 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionMetric plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] --- import expressionMetricObj from './expression_metric.devdocs.json'; diff --git a/api_docs/expression_metric_vis.devdocs.json b/api_docs/expression_metric_vis.devdocs.json index 7845ea8dd77b6..db45a89b9b00b 100644 --- a/api_docs/expression_metric_vis.devdocs.json +++ b/api_docs/expression_metric_vis.devdocs.json @@ -462,6 +462,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "expressionMetricVis", + "id": "def-common.MetricArguments.icon", + "type": "string", + "tags": [], + "label": "icon", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "expressionMetricVis", "id": "def-common.MetricArguments.palette", @@ -680,6 +694,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "expressionMetricVis", + "id": "def-common.MetricVisParam.icon", + "type": "string", + "tags": [], + "label": "icon", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "expressionMetricVis", "id": "def-common.MetricVisParam.palette", @@ -831,6 +859,56 @@ "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "expressionMetricVis", + "id": "def-common.MetricVisRenderConfig.overrides", + "type": "Object", + "tags": [], + "label": "overrides", + "description": [], + "signature": [ + "Partial | ", + "RecursivePartial", + "<", + "Theme", + ">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ", + "Position", + " | ", + "LegendPositionConfig", + " | undefined; rotation?: ", + "Rotation", + " | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", + "Rendering", + " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", + "MakeOverridesSerializable", + "<", + "ExternalPointerEventsSettings", + " | undefined>; pointBuffer?: ", + "MarkBuffer", + " | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ", + "PointerUpdateTrigger", + " | undefined; brushAxis?: ", + "BrushAxis", + " | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; xDomain?: ", + "MakeOverridesSerializable", + "<", + "CustomXDomain", + " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", + "LegendStrategy", + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> | undefined" + ], + "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -928,6 +1006,21 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "expressionMetricVis", + "id": "def-common.AvailableMetricIcon", + "type": "Type", + "tags": [], + "label": "AvailableMetricIcon", + "description": [], + "signature": [ + "\"alert\" | \"temperature\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"compute\" | \"editorComment\" | \"empty\" | \"flag\" | \"globe\" | \"heart\" | \"mapMarker\" | \"pin\" | \"sortDown\" | \"sortUp\" | \"starEmpty\" | \"tag\"" + ], + "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "expressionMetricVis", "id": "def-common.EXPRESSION_METRIC_NAME", diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index a3edf63962937..b6c49e572f1ca 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionMetricVis plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] --- import expressionMetricVisObj from './expression_metric_vis.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 63 | 0 | 63 | 2 | +| 67 | 0 | 67 | 2 | ## Client diff --git a/api_docs/expression_partition_vis.devdocs.json b/api_docs/expression_partition_vis.devdocs.json index 24853354f0e91..908097245f11f 100644 --- a/api_docs/expression_partition_vis.devdocs.json +++ b/api_docs/expression_partition_vis.devdocs.json @@ -1068,6 +1068,31 @@ } ], "misc": [ + { + "parentPluginId": "expressionPartitionVis", + "id": "def-common.AllowedPartitionOverrides", + "type": "Type", + "tags": [], + "label": "AllowedPartitionOverrides", + "description": [], + "signature": [ + "{ partition?: { animation?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<{ duration: number; } | undefined>; valueGetter?: ", + "ValueGetter", + " | undefined; fillOutside?: boolean | undefined; radiusOutside?: number | undefined; fillRectangleWidth?: number | undefined; fillRectangleHeight?: number | undefined; topGroove?: number | undefined; percentFormatter?: \"ignore\" | undefined; clockwiseSectors?: boolean | undefined; maxRowCount?: number | undefined; specialFirstInnermostSector?: boolean | undefined; smallMultiples?: string | undefined; drilldown?: boolean | undefined; } | undefined; }" + ], + "path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "expressionPartitionVis", "id": "def-common.ExpressionValuePartitionLabels", @@ -1154,7 +1179,7 @@ "text": "ExpressionValueRender" }, "<", - "RenderValue", + "PartitionChartProps", ">, ", { "pluginId": "expressions", @@ -1335,7 +1360,7 @@ "text": "ExpressionValueRender" }, "<", - "RenderValue", + "PartitionChartProps", ">, ", { "pluginId": "expressions", @@ -1452,7 +1477,7 @@ "text": "ExpressionValueRender" }, "<", - "RenderValue", + "PartitionChartProps", ">, ", { "pluginId": "expressions", @@ -1539,7 +1564,7 @@ "text": "ExpressionValueRender" }, "<", - "RenderValue", + "PartitionChartProps", ">, ", { "pluginId": "expressions", diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index 18c46baef8a5b..fa4e6c911d6d9 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionPartitionVis plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] --- import expressionPartitionVisObj from './expression_partition_vis.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 72 | 0 | 72 | 2 | +| 73 | 0 | 73 | 2 | ## Client diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index a5b4c7112e212..ebc74e5b3b17f 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionRepeatImage plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] --- import expressionRepeatImageObj from './expression_repeat_image.devdocs.json'; diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index b027930dd0399..b0be5f93f6f26 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionRevealImage plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] --- import expressionRevealImageObj from './expression_reveal_image.devdocs.json'; diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index 618fd28f652c2..2895f63ae2675 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionShape plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] --- import expressionShapeObj from './expression_shape.devdocs.json'; diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index c5134ff100f93..b4424c9de2b88 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionTagcloud plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] --- import expressionTagcloudObj from './expression_tagcloud.devdocs.json'; diff --git a/api_docs/expression_x_y.devdocs.json b/api_docs/expression_x_y.devdocs.json index 81301b9f25a67..ea819b254bf64 100644 --- a/api_docs/expression_x_y.devdocs.json +++ b/api_docs/expression_x_y.devdocs.json @@ -1858,6 +1858,90 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYChartProps.overrides", + "type": "CompoundType", + "tags": [], + "label": "overrides", + "description": [], + "signature": [ + "(Partial> | undefined>; gridLine?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + " | undefined>; ticks?: number | undefined; domain?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "YDomainRange", + " | undefined>; position?: ", + "Position", + " | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; }>> & Partial | ", + "RecursivePartial", + "<", + "Theme", + ">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ", + "Position", + " | ", + "LegendPositionConfig", + " | undefined; rotation?: ", + "Rotation", + " | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", + "Rendering", + " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", + "MakeOverridesSerializable", + "<", + "ExternalPointerEventsSettings", + " | undefined>; pointBuffer?: ", + "MarkBuffer", + " | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ", + "PointerUpdateTrigger", + " | undefined; brushAxis?: ", + "BrushAxis", + " | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; xDomain?: ", + "MakeOverridesSerializable", + "<", + "CustomXDomain", + " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", + "LegendStrategy", + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>>) | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -2014,6 +2098,123 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "expressionXY", + "id": "def-common.AllowedXYOverrides", + "type": "Type", + "tags": [], + "label": "AllowedXYOverrides", + "description": [], + "signature": [ + "{ axisX?: { children?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; title?: string | undefined; style?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "RecursivePartial", + "> | undefined>; gridLine?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + " | undefined>; ticks?: number | undefined; domain?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "YDomainRange", + " | undefined>; position?: ", + "Position", + " | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; } | undefined; axisLeft?: { children?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; title?: string | undefined; style?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "RecursivePartial", + "> | undefined>; gridLine?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + " | undefined>; ticks?: number | undefined; domain?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "YDomainRange", + " | undefined>; position?: ", + "Position", + " | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; } | undefined; axisRight?: { children?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; title?: string | undefined; style?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "RecursivePartial", + "> | undefined>; gridLine?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + " | undefined>; ticks?: number | undefined; domain?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "YDomainRange", + " | undefined>; position?: ", + "Position", + " | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; } | undefined; }" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "expressionXY", "id": "def-common.AvailableReferenceLineIcon", diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index 9d829c8314f98..a806877f15bd3 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionXY plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] --- import expressionXYObj from './expression_x_y.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 171 | 0 | 161 | 13 | +| 173 | 0 | 163 | 13 | ## Client diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index bcee6c857fc09..1c34beb37e136 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github description: API docs for the expressions plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] --- import expressionsObj from './expressions.devdocs.json'; diff --git a/api_docs/features.mdx b/api_docs/features.mdx index f09eb5445b45f..d040015ff96d1 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github description: API docs for the features plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] --- import featuresObj from './features.devdocs.json'; diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 65a29b9f1f38e..baa68381458c1 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github description: API docs for the fieldFormats plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] --- import fieldFormatsObj from './field_formats.devdocs.json'; diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index 06081d622cc35..6c9f0bf3ea599 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github description: API docs for the fileUpload plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] --- import fileUploadObj from './file_upload.devdocs.json'; diff --git a/api_docs/files.mdx b/api_docs/files.mdx index 296280f28ca76..63c02806f2430 100644 --- a/api_docs/files.mdx +++ b/api_docs/files.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files title: "files" image: https://source.unsplash.com/400x175/?github description: API docs for the files plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files'] --- import filesObj from './files.devdocs.json'; diff --git a/api_docs/files_management.mdx b/api_docs/files_management.mdx index 8cbdebed626f2..3157425861bca 100644 --- a/api_docs/files_management.mdx +++ b/api_docs/files_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement title: "filesManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the filesManagement plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement'] --- import filesManagementObj from './files_management.devdocs.json'; diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index d103c94f749ff..6fa654269031a 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github description: API docs for the fleet plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] --- import fleetObj from './fleet.devdocs.json'; diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index b94e1fe921b15..a9a9a2f1ad8fe 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the globalSearch plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] --- import globalSearchObj from './global_search.devdocs.json'; diff --git a/api_docs/guided_onboarding.mdx b/api_docs/guided_onboarding.mdx index ef678f4bad1e9..c69fdd5f4f751 100644 --- a/api_docs/guided_onboarding.mdx +++ b/api_docs/guided_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding title: "guidedOnboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the guidedOnboarding plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding'] --- import guidedOnboardingObj from './guided_onboarding.devdocs.json'; diff --git a/api_docs/home.mdx b/api_docs/home.mdx index 6744ee9cf8f8c..e3a96a36a150d 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github description: API docs for the home plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] --- import homeObj from './home.devdocs.json'; diff --git a/api_docs/image_embeddable.mdx b/api_docs/image_embeddable.mdx index 5414387b268c3..efe684a3b7744 100644 --- a/api_docs/image_embeddable.mdx +++ b/api_docs/image_embeddable.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable title: "imageEmbeddable" image: https://source.unsplash.com/400x175/?github description: API docs for the imageEmbeddable plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable'] --- import imageEmbeddableObj from './image_embeddable.devdocs.json'; diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 74159305ec79c..cbe2976a10786 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the indexLifecycleManagement plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] --- import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json'; diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index c4a0a3aa12cfe..fb05b454c60a1 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the indexManagement plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] --- import indexManagementObj from './index_management.devdocs.json'; diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 2392616f2d32d..8b2c3016a2a1d 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github description: API docs for the infra plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] --- import infraObj from './infra.devdocs.json'; diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 58c40d6c0878c..0d3ebce305916 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github description: API docs for the inspector plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] --- import inspectorObj from './inspector.devdocs.json'; diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index d8f6358ef98d1..5e39f60ec790d 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github description: API docs for the interactiveSetup plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] --- import interactiveSetupObj from './interactive_setup.devdocs.json'; diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index 8ec5dc9b0ec27..971adbe954978 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ace plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] --- import kbnAceObj from './kbn_ace.devdocs.json'; diff --git a/api_docs/kbn_aiops_components.mdx b/api_docs/kbn_aiops_components.mdx index f9d2507e94b10..883ec22b62ecc 100644 --- a/api_docs/kbn_aiops_components.mdx +++ b/api_docs/kbn_aiops_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components title: "@kbn/aiops-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-components plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components'] --- import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json'; diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 095d5dc2929fe..d5156ef1dfa47 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils title: "@kbn/aiops-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] --- import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json'; diff --git a/api_docs/kbn_alerting_state_types.mdx b/api_docs/kbn_alerting_state_types.mdx index 06814e88b0ff0..cfcfd63c5903a 100644 --- a/api_docs/kbn_alerting_state_types.mdx +++ b/api_docs/kbn_alerting_state_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types title: "@kbn/alerting-state-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerting-state-types plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types'] --- import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json'; diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index d341c4ad9613d..4ed01f2ac17f6 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] --- import kbnAlertsObj from './kbn_alerts.devdocs.json'; diff --git a/api_docs/kbn_alerts_as_data_utils.mdx b/api_docs/kbn_alerts_as_data_utils.mdx index 7ebc775edbdb0..6738bb3393997 100644 --- a/api_docs/kbn_alerts_as_data_utils.mdx +++ b/api_docs/kbn_alerts_as_data_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils title: "@kbn/alerts-as-data-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts-as-data-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils'] --- import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json'; diff --git a/api_docs/kbn_alerts_ui_shared.mdx b/api_docs/kbn_alerts_ui_shared.mdx index cea8f8c0f6362..5beb81abb784f 100644 --- a/api_docs/kbn_alerts_ui_shared.mdx +++ b/api_docs/kbn_alerts_ui_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared title: "@kbn/alerts-ui-shared" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts-ui-shared plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared'] --- import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json'; diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index c540e46fcbfaa..982befb1c08d0 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] --- import kbnAnalyticsObj from './kbn_analytics.devdocs.json'; diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index 21bfd198efc5d..801d80c3d8908 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-client plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] --- import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index 0b914d4c046cd..2ad9ea5587949 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser title: "@kbn/analytics-shippers-elastic-v3-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] --- import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index 0f84bf974254d..751253421124e 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common title: "@kbn/analytics-shippers-elastic-v3-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] --- import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index 2c25db21660ad..838be4d52e561 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server title: "@kbn/analytics-shippers-elastic-v3-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server'] --- import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index faef33cae8b99..701bec22ac819 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] --- import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_gainsight.mdx b/api_docs/kbn_analytics_shippers_gainsight.mdx index a60309ae42a99..5ee64b8d1c4c5 100644 --- a/api_docs/kbn_analytics_shippers_gainsight.mdx +++ b/api_docs/kbn_analytics_shippers_gainsight.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-gainsight title: "@kbn/analytics-shippers-gainsight" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-gainsight plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-gainsight'] --- import kbnAnalyticsShippersGainsightObj from './kbn_analytics_shippers_gainsight.devdocs.json'; diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index 83dbd34c4f7b4..d6c30903dc4ab 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-config-loader plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] --- import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace.mdx b/api_docs/kbn_apm_synthtrace.mdx index afb690013311b..a8a3bf5cca707 100644 --- a/api_docs/kbn_apm_synthtrace.mdx +++ b/api_docs/kbn_apm_synthtrace.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace title: "@kbn/apm-synthtrace" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-synthtrace plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace'] --- import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace_client.mdx b/api_docs/kbn_apm_synthtrace_client.mdx index 8302daccc85ee..499ba225b7da2 100644 --- a/api_docs/kbn_apm_synthtrace_client.mdx +++ b/api_docs/kbn_apm_synthtrace_client.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace-client title: "@kbn/apm-synthtrace-client" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-synthtrace-client plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace-client'] --- import kbnApmSynthtraceClientObj from './kbn_apm_synthtrace_client.devdocs.json'; diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index 393a03b633e93..5e1bf87718325 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] --- import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json'; diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index e81022afdab07..b24b37bfbe66f 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/axe-config plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] --- import kbnAxeConfigObj from './kbn_axe_config.devdocs.json'; diff --git a/api_docs/kbn_cases_components.mdx b/api_docs/kbn_cases_components.mdx index add8e5555b001..afb5a10f0ca80 100644 --- a/api_docs/kbn_cases_components.mdx +++ b/api_docs/kbn_cases_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cases-components title: "@kbn/cases-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cases-components plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cases-components'] --- import kbnCasesComponentsObj from './kbn_cases_components.devdocs.json'; diff --git a/api_docs/kbn_cell_actions.mdx b/api_docs/kbn_cell_actions.mdx index ec13f022b8256..7b5761c72815d 100644 --- a/api_docs/kbn_cell_actions.mdx +++ b/api_docs/kbn_cell_actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cell-actions title: "@kbn/cell-actions" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cell-actions plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cell-actions'] --- import kbnCellActionsObj from './kbn_cell_actions.devdocs.json'; diff --git a/api_docs/kbn_chart_expressions_common.devdocs.json b/api_docs/kbn_chart_expressions_common.devdocs.json index 28f0f297c20f9..9d8b175df8cb8 100644 --- a/api_docs/kbn_chart_expressions_common.devdocs.json +++ b/api_docs/kbn_chart_expressions_common.devdocs.json @@ -114,11 +114,106 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/chart-expressions-common", + "id": "def-common.getOverridesFor", + "type": "Function", + "tags": [], + "label": "getOverridesFor", + "description": [ + "\nGet an override specification and returns a props object to use directly with the Component" + ], + "signature": [ + "(overrides: O | undefined, componentName: K) => { [k: string]: unknown; }" + ], + "path": "src/plugins/chart_expressions/common/utils.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/chart-expressions-common", + "id": "def-common.getOverridesFor.$1", + "type": "Uncategorized", + "tags": [], + "label": "overrides", + "description": [ + "Overrides object" + ], + "signature": [ + "O | undefined" + ], + "path": "src/plugins/chart_expressions/common/utils.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/chart-expressions-common", + "id": "def-common.getOverridesFor.$2", + "type": "Uncategorized", + "tags": [], + "label": "componentName", + "description": [ + "name of the Component to look for (i.e. \"settings\", \"axisX\")" + ], + "signature": [ + "K" + ], + "path": "src/plugins/chart_expressions/common/utils.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "an props object to use directly with the component" + ], + "initialIsOpen": false } ], "interfaces": [], "enums": [], - "misc": [], + "misc": [ + { + "parentPluginId": "@kbn/chart-expressions-common", + "id": "def-common.MakeOverridesSerializable", + "type": "Type", + "tags": [], + "label": "MakeOverridesSerializable", + "description": [], + "signature": [ + "{ [KeyType in keyof T]: NonNullable extends Function ? \"ignore\" : NonNullable extends React.ReactElement> | React.ReactChildren ? never : NonNullable extends object ? ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + " : NonNullable; }" + ], + "path": "src/plugins/chart_expressions/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/chart-expressions-common", + "id": "def-common.Simplify", + "type": "Type", + "tags": [], + "label": "Simplify", + "description": [], + "signature": [ + "{ [KeyType in keyof T]: T[KeyType]; }" + ], + "path": "src/plugins/chart_expressions/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_chart_expressions_common.mdx b/api_docs/kbn_chart_expressions_common.mdx index 92509769772ab..74181d90b2242 100644 --- a/api_docs/kbn_chart_expressions_common.mdx +++ b/api_docs/kbn_chart_expressions_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-expressions-common title: "@kbn/chart-expressions-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/chart-expressions-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-expressions-common'] --- import kbnChartExpressionsCommonObj from './kbn_chart_expressions_common.devdocs.json'; @@ -21,10 +21,13 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 4 | 0 | 4 | 0 | +| 9 | 0 | 6 | 0 | ## Common ### Functions +### Consts, variables and types + + diff --git a/api_docs/kbn_chart_icons.mdx b/api_docs/kbn_chart_icons.mdx index 4ba5704534768..cc6ec3accc40d 100644 --- a/api_docs/kbn_chart_icons.mdx +++ b/api_docs/kbn_chart_icons.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-icons title: "@kbn/chart-icons" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/chart-icons plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-icons'] --- import kbnChartIconsObj from './kbn_chart_icons.devdocs.json'; diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index 9a4a90d10515c..7089e1cda06d4 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-core plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] --- import kbnCiStatsCoreObj from './kbn_ci_stats_core.devdocs.json'; diff --git a/api_docs/kbn_ci_stats_performance_metrics.mdx b/api_docs/kbn_ci_stats_performance_metrics.mdx index 67d37bb741eb8..f8bab73911ea4 100644 --- a/api_docs/kbn_ci_stats_performance_metrics.mdx +++ b/api_docs/kbn_ci_stats_performance_metrics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics title: "@kbn/ci-stats-performance-metrics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-performance-metrics plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics'] --- import kbnCiStatsPerformanceMetricsObj from './kbn_ci_stats_performance_metrics.devdocs.json'; diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index 8456b0989bb2a..5aad76e2d3309 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-reporter plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] --- import kbnCiStatsReporterObj from './kbn_ci_stats_reporter.devdocs.json'; diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index aedaafb31c9a3..394c9575567f0 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cli-dev-mode plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] --- import kbnCliDevModeObj from './kbn_cli_dev_mode.devdocs.json'; diff --git a/api_docs/kbn_code_editor.mdx b/api_docs/kbn_code_editor.mdx index f8c05e95de897..6683519a7d035 100644 --- a/api_docs/kbn_code_editor.mdx +++ b/api_docs/kbn_code_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor title: "@kbn/code-editor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-editor plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor'] --- import kbnCodeEditorObj from './kbn_code_editor.devdocs.json'; diff --git a/api_docs/kbn_code_editor_mocks.mdx b/api_docs/kbn_code_editor_mocks.mdx index c24a4e6593298..3dc7d102b6c7b 100644 --- a/api_docs/kbn_code_editor_mocks.mdx +++ b/api_docs/kbn_code_editor_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor-mocks title: "@kbn/code-editor-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-editor-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor-mocks'] --- import kbnCodeEditorMocksObj from './kbn_code_editor_mocks.devdocs.json'; diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index d4b247a11f3db..271afec6e2642 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/coloring plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] --- import kbnColoringObj from './kbn_coloring.devdocs.json'; diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index dbca386a7e102..7d5b37282fa65 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] --- import kbnConfigObj from './kbn_config.devdocs.json'; diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index 2cd965202d5f8..3695af802ef47 100644 --- a/api_docs/kbn_config_mocks.mdx +++ b/api_docs/kbn_config_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks title: "@kbn/config-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks'] --- import kbnConfigMocksObj from './kbn_config_mocks.devdocs.json'; diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index 903766c805f02..17231cfad2681 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config-schema plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] --- import kbnConfigSchemaObj from './kbn_config_schema.devdocs.json'; diff --git a/api_docs/kbn_content_management_content_editor.mdx b/api_docs/kbn_content_management_content_editor.mdx index b10a98882db5e..cc0065a5787ad 100644 --- a/api_docs/kbn_content_management_content_editor.mdx +++ b/api_docs/kbn_content_management_content_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-content-editor title: "@kbn/content-management-content-editor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-content-editor plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-content-editor'] --- import kbnContentManagementContentEditorObj from './kbn_content_management_content_editor.devdocs.json'; diff --git a/api_docs/kbn_content_management_table_list.mdx b/api_docs/kbn_content_management_table_list.mdx index 8717457db2f3f..cc329319b9660 100644 --- a/api_docs/kbn_content_management_table_list.mdx +++ b/api_docs/kbn_content_management_table_list.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list title: "@kbn/content-management-table-list" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-table-list plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list'] --- import kbnContentManagementTableListObj from './kbn_content_management_table_list.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index fa61994052083..f72deb1a91a77 100644 --- a/api_docs/kbn_core_analytics_browser.mdx +++ b/api_docs/kbn_core_analytics_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser title: "@kbn/core-analytics-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser'] --- import kbnCoreAnalyticsBrowserObj from './kbn_core_analytics_browser.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser_internal.mdx b/api_docs/kbn_core_analytics_browser_internal.mdx index 635931c528f83..499f2c1392788 100644 --- a/api_docs/kbn_core_analytics_browser_internal.mdx +++ b/api_docs/kbn_core_analytics_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal title: "@kbn/core-analytics-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal'] --- import kbnCoreAnalyticsBrowserInternalObj from './kbn_core_analytics_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser_mocks.mdx b/api_docs/kbn_core_analytics_browser_mocks.mdx index 7bceae736717b..86846f7f4a78e 100644 --- a/api_docs/kbn_core_analytics_browser_mocks.mdx +++ b/api_docs/kbn_core_analytics_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks title: "@kbn/core-analytics-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks'] --- import kbnCoreAnalyticsBrowserMocksObj from './kbn_core_analytics_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_server.mdx b/api_docs/kbn_core_analytics_server.mdx index 6817e1887c3f6..2baf9c42da4ba 100644 --- a/api_docs/kbn_core_analytics_server.mdx +++ b/api_docs/kbn_core_analytics_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server title: "@kbn/core-analytics-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server'] --- import kbnCoreAnalyticsServerObj from './kbn_core_analytics_server.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_server_internal.mdx b/api_docs/kbn_core_analytics_server_internal.mdx index c8486ca7248fa..d33f210f2d191 100644 --- a/api_docs/kbn_core_analytics_server_internal.mdx +++ b/api_docs/kbn_core_analytics_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal title: "@kbn/core-analytics-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-internal'] --- import kbnCoreAnalyticsServerInternalObj from './kbn_core_analytics_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_server_mocks.mdx b/api_docs/kbn_core_analytics_server_mocks.mdx index 4c396e4c45eb5..b5cf32ffee2f7 100644 --- a/api_docs/kbn_core_analytics_server_mocks.mdx +++ b/api_docs/kbn_core_analytics_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-mocks title: "@kbn/core-analytics-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-mocks'] --- import kbnCoreAnalyticsServerMocksObj from './kbn_core_analytics_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser.mdx b/api_docs/kbn_core_application_browser.mdx index 72b15211bc532..1848004bf8b02 100644 --- a/api_docs/kbn_core_application_browser.mdx +++ b/api_docs/kbn_core_application_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser title: "@kbn/core-application-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser'] --- import kbnCoreApplicationBrowserObj from './kbn_core_application_browser.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser_internal.mdx b/api_docs/kbn_core_application_browser_internal.mdx index 0c52c71bf3dc4..830b72b441b19 100644 --- a/api_docs/kbn_core_application_browser_internal.mdx +++ b/api_docs/kbn_core_application_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-internal title: "@kbn/core-application-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser-internal'] --- import kbnCoreApplicationBrowserInternalObj from './kbn_core_application_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser_mocks.mdx b/api_docs/kbn_core_application_browser_mocks.mdx index a3b6df139cea4..8d6bcd3ef5454 100644 --- a/api_docs/kbn_core_application_browser_mocks.mdx +++ b/api_docs/kbn_core_application_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-mocks title: "@kbn/core-application-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser-mocks'] --- import kbnCoreApplicationBrowserMocksObj from './kbn_core_application_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_application_common.mdx b/api_docs/kbn_core_application_common.mdx index abcadb67c27bb..1c23c7c967976 100644 --- a/api_docs/kbn_core_application_common.mdx +++ b/api_docs/kbn_core_application_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-common title: "@kbn/core-application-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-common'] --- import kbnCoreApplicationCommonObj from './kbn_core_application_common.devdocs.json'; diff --git a/api_docs/kbn_core_apps_browser_internal.mdx b/api_docs/kbn_core_apps_browser_internal.mdx index 9f7e515bb1b0a..97361c419f019 100644 --- a/api_docs/kbn_core_apps_browser_internal.mdx +++ b/api_docs/kbn_core_apps_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-internal title: "@kbn/core-apps-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-internal'] --- import kbnCoreAppsBrowserInternalObj from './kbn_core_apps_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_apps_browser_mocks.mdx b/api_docs/kbn_core_apps_browser_mocks.mdx index 5b07cb69835e0..06c62fe7d5c7a 100644 --- a/api_docs/kbn_core_apps_browser_mocks.mdx +++ b/api_docs/kbn_core_apps_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-mocks title: "@kbn/core-apps-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-mocks'] --- import kbnCoreAppsBrowserMocksObj from './kbn_core_apps_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_apps_server_internal.mdx b/api_docs/kbn_core_apps_server_internal.mdx index a45d8523d09bf..6686171b0fc44 100644 --- a/api_docs/kbn_core_apps_server_internal.mdx +++ b/api_docs/kbn_core_apps_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-server-internal title: "@kbn/core-apps-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-server-internal'] --- import kbnCoreAppsServerInternalObj from './kbn_core_apps_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx index acc402f483d77..5022d8a91de42 100644 --- a/api_docs/kbn_core_base_browser_mocks.mdx +++ b/api_docs/kbn_core_base_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks title: "@kbn/core-base-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-browser-mocks'] --- import kbnCoreBaseBrowserMocksObj from './kbn_core_base_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx index cd00277497c18..9b1a309fe1db6 100644 --- a/api_docs/kbn_core_base_common.mdx +++ b/api_docs/kbn_core_base_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common title: "@kbn/core-base-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common'] --- import kbnCoreBaseCommonObj from './kbn_core_base_common.devdocs.json'; diff --git a/api_docs/kbn_core_base_server_internal.mdx b/api_docs/kbn_core_base_server_internal.mdx index 9ce875e81e471..efc9de950e039 100644 --- a/api_docs/kbn_core_base_server_internal.mdx +++ b/api_docs/kbn_core_base_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-internal title: "@kbn/core-base-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-internal'] --- import kbnCoreBaseServerInternalObj from './kbn_core_base_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_base_server_mocks.mdx b/api_docs/kbn_core_base_server_mocks.mdx index 24d545fa31afd..13210f1ea6391 100644 --- a/api_docs/kbn_core_base_server_mocks.mdx +++ b/api_docs/kbn_core_base_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks title: "@kbn/core-base-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-mocks'] --- import kbnCoreBaseServerMocksObj from './kbn_core_base_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_browser_mocks.mdx b/api_docs/kbn_core_capabilities_browser_mocks.mdx index fadb3ef19d49a..1435c1623068d 100644 --- a/api_docs/kbn_core_capabilities_browser_mocks.mdx +++ b/api_docs/kbn_core_capabilities_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-browser-mocks title: "@kbn/core-capabilities-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-browser-mocks'] --- import kbnCoreCapabilitiesBrowserMocksObj from './kbn_core_capabilities_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_common.mdx b/api_docs/kbn_core_capabilities_common.mdx index d9a2be96a1080..ca096c207eeb8 100644 --- a/api_docs/kbn_core_capabilities_common.mdx +++ b/api_docs/kbn_core_capabilities_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-common title: "@kbn/core-capabilities-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-common'] --- import kbnCoreCapabilitiesCommonObj from './kbn_core_capabilities_common.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_server.mdx b/api_docs/kbn_core_capabilities_server.mdx index d2971d7633f4a..c7c98456b2d2d 100644 --- a/api_docs/kbn_core_capabilities_server.mdx +++ b/api_docs/kbn_core_capabilities_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server title: "@kbn/core-capabilities-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server'] --- import kbnCoreCapabilitiesServerObj from './kbn_core_capabilities_server.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_server_mocks.mdx b/api_docs/kbn_core_capabilities_server_mocks.mdx index 24b662b643206..383c011cdfb29 100644 --- a/api_docs/kbn_core_capabilities_server_mocks.mdx +++ b/api_docs/kbn_core_capabilities_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server-mocks title: "@kbn/core-capabilities-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server-mocks'] --- import kbnCoreCapabilitiesServerMocksObj from './kbn_core_capabilities_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_chrome_browser.mdx b/api_docs/kbn_core_chrome_browser.mdx index d92e81b1a7041..6a8b000ed88e8 100644 --- a/api_docs/kbn_core_chrome_browser.mdx +++ b/api_docs/kbn_core_chrome_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser title: "@kbn/core-chrome-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-chrome-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser'] --- import kbnCoreChromeBrowserObj from './kbn_core_chrome_browser.devdocs.json'; diff --git a/api_docs/kbn_core_chrome_browser_mocks.mdx b/api_docs/kbn_core_chrome_browser_mocks.mdx index 7d379a9346846..cd7a6e94f7636 100644 --- a/api_docs/kbn_core_chrome_browser_mocks.mdx +++ b/api_docs/kbn_core_chrome_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser-mocks title: "@kbn/core-chrome-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-chrome-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser-mocks'] --- import kbnCoreChromeBrowserMocksObj from './kbn_core_chrome_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_config_server_internal.mdx b/api_docs/kbn_core_config_server_internal.mdx index 811ff68c31a38..538994ace09ad 100644 --- a/api_docs/kbn_core_config_server_internal.mdx +++ b/api_docs/kbn_core_config_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-config-server-internal title: "@kbn/core-config-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-config-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-config-server-internal'] --- import kbnCoreConfigServerInternalObj from './kbn_core_config_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_browser.mdx b/api_docs/kbn_core_custom_branding_browser.mdx index 73d4129106478..455e68bfc7061 100644 --- a/api_docs/kbn_core_custom_branding_browser.mdx +++ b/api_docs/kbn_core_custom_branding_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser title: "@kbn/core-custom-branding-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser'] --- import kbnCoreCustomBrandingBrowserObj from './kbn_core_custom_branding_browser.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_browser_internal.mdx b/api_docs/kbn_core_custom_branding_browser_internal.mdx index f7ad818e9f251..f7faab4b4b82b 100644 --- a/api_docs/kbn_core_custom_branding_browser_internal.mdx +++ b/api_docs/kbn_core_custom_branding_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-internal title: "@kbn/core-custom-branding-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser-internal'] --- import kbnCoreCustomBrandingBrowserInternalObj from './kbn_core_custom_branding_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_browser_mocks.mdx b/api_docs/kbn_core_custom_branding_browser_mocks.mdx index 20bb989b0b7c1..f0391da41f8df 100644 --- a/api_docs/kbn_core_custom_branding_browser_mocks.mdx +++ b/api_docs/kbn_core_custom_branding_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-mocks title: "@kbn/core-custom-branding-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser-mocks'] --- import kbnCoreCustomBrandingBrowserMocksObj from './kbn_core_custom_branding_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_common.mdx b/api_docs/kbn_core_custom_branding_common.mdx index e21aa06bce9e2..b59d1b9d30311 100644 --- a/api_docs/kbn_core_custom_branding_common.mdx +++ b/api_docs/kbn_core_custom_branding_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-common title: "@kbn/core-custom-branding-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-common'] --- import kbnCoreCustomBrandingCommonObj from './kbn_core_custom_branding_common.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server.mdx b/api_docs/kbn_core_custom_branding_server.mdx index b071339c13c52..149ed20bf51d0 100644 --- a/api_docs/kbn_core_custom_branding_server.mdx +++ b/api_docs/kbn_core_custom_branding_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server title: "@kbn/core-custom-branding-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server'] --- import kbnCoreCustomBrandingServerObj from './kbn_core_custom_branding_server.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server_internal.mdx b/api_docs/kbn_core_custom_branding_server_internal.mdx index f53a99a5a7459..b5f8e199d5b11 100644 --- a/api_docs/kbn_core_custom_branding_server_internal.mdx +++ b/api_docs/kbn_core_custom_branding_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-internal title: "@kbn/core-custom-branding-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server-internal'] --- import kbnCoreCustomBrandingServerInternalObj from './kbn_core_custom_branding_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server_mocks.mdx b/api_docs/kbn_core_custom_branding_server_mocks.mdx index 5bb7eb60f51a2..67b0357bb879d 100644 --- a/api_docs/kbn_core_custom_branding_server_mocks.mdx +++ b/api_docs/kbn_core_custom_branding_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-mocks title: "@kbn/core-custom-branding-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server-mocks'] --- import kbnCoreCustomBrandingServerMocksObj from './kbn_core_custom_branding_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_browser.mdx b/api_docs/kbn_core_deprecations_browser.mdx index 0217fba374f4d..9a8ce1da1fe9d 100644 --- a/api_docs/kbn_core_deprecations_browser.mdx +++ b/api_docs/kbn_core_deprecations_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser title: "@kbn/core-deprecations-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser'] --- import kbnCoreDeprecationsBrowserObj from './kbn_core_deprecations_browser.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_browser_internal.mdx b/api_docs/kbn_core_deprecations_browser_internal.mdx index 3bc4df0f4c7dd..240ebf7dcdeb8 100644 --- a/api_docs/kbn_core_deprecations_browser_internal.mdx +++ b/api_docs/kbn_core_deprecations_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-internal title: "@kbn/core-deprecations-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-internal'] --- import kbnCoreDeprecationsBrowserInternalObj from './kbn_core_deprecations_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_browser_mocks.mdx b/api_docs/kbn_core_deprecations_browser_mocks.mdx index ce4cd6fe0d1fd..5e52026347cbd 100644 --- a/api_docs/kbn_core_deprecations_browser_mocks.mdx +++ b/api_docs/kbn_core_deprecations_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-mocks title: "@kbn/core-deprecations-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-mocks'] --- import kbnCoreDeprecationsBrowserMocksObj from './kbn_core_deprecations_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_common.mdx b/api_docs/kbn_core_deprecations_common.mdx index 818d5e1858781..4607a2f2d35f0 100644 --- a/api_docs/kbn_core_deprecations_common.mdx +++ b/api_docs/kbn_core_deprecations_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-common title: "@kbn/core-deprecations-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-common'] --- import kbnCoreDeprecationsCommonObj from './kbn_core_deprecations_common.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_server.mdx b/api_docs/kbn_core_deprecations_server.mdx index 44ebc86bd5e71..d538ba33838be 100644 --- a/api_docs/kbn_core_deprecations_server.mdx +++ b/api_docs/kbn_core_deprecations_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server title: "@kbn/core-deprecations-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server'] --- import kbnCoreDeprecationsServerObj from './kbn_core_deprecations_server.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_server_internal.mdx b/api_docs/kbn_core_deprecations_server_internal.mdx index 6d1a7e1e67021..2c2fbb3acb458 100644 --- a/api_docs/kbn_core_deprecations_server_internal.mdx +++ b/api_docs/kbn_core_deprecations_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-internal title: "@kbn/core-deprecations-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server-internal'] --- import kbnCoreDeprecationsServerInternalObj from './kbn_core_deprecations_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_server_mocks.mdx b/api_docs/kbn_core_deprecations_server_mocks.mdx index 66b9cda4e6ca0..be4e59bf942b3 100644 --- a/api_docs/kbn_core_deprecations_server_mocks.mdx +++ b/api_docs/kbn_core_deprecations_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-mocks title: "@kbn/core-deprecations-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server-mocks'] --- import kbnCoreDeprecationsServerMocksObj from './kbn_core_deprecations_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_browser.mdx b/api_docs/kbn_core_doc_links_browser.mdx index 23e557619577a..4f691478c8c75 100644 --- a/api_docs/kbn_core_doc_links_browser.mdx +++ b/api_docs/kbn_core_doc_links_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser title: "@kbn/core-doc-links-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser'] --- import kbnCoreDocLinksBrowserObj from './kbn_core_doc_links_browser.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index f2a5751eeff2b..be55b48fb8076 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.mdx +++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser-mocks title: "@kbn/core-doc-links-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser-mocks'] --- import kbnCoreDocLinksBrowserMocksObj from './kbn_core_doc_links_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_server.mdx b/api_docs/kbn_core_doc_links_server.mdx index 4305dced64e24..a3b39c889738c 100644 --- a/api_docs/kbn_core_doc_links_server.mdx +++ b/api_docs/kbn_core_doc_links_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server title: "@kbn/core-doc-links-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server'] --- import kbnCoreDocLinksServerObj from './kbn_core_doc_links_server.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_server_mocks.mdx b/api_docs/kbn_core_doc_links_server_mocks.mdx index 429b2807253f1..c643ffdd05cc0 100644 --- a/api_docs/kbn_core_doc_links_server_mocks.mdx +++ b/api_docs/kbn_core_doc_links_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server-mocks title: "@kbn/core-doc-links-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server-mocks'] --- import kbnCoreDocLinksServerMocksObj from './kbn_core_doc_links_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx index 34ba6a1c4d8cd..6fd1d4dfc52da 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-internal title: "@kbn/core-elasticsearch-client-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-client-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-internal'] --- import kbnCoreElasticsearchClientServerInternalObj from './kbn_core_elasticsearch_client_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx index c1677dd03d325..906a37469b4de 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-mocks title: "@kbn/core-elasticsearch-client-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-client-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-mocks'] --- import kbnCoreElasticsearchClientServerMocksObj from './kbn_core_elasticsearch_client_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server.mdx b/api_docs/kbn_core_elasticsearch_server.mdx index 773aecc080496..edc773f197683 100644 --- a/api_docs/kbn_core_elasticsearch_server.mdx +++ b/api_docs/kbn_core_elasticsearch_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server title: "@kbn/core-elasticsearch-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server'] --- import kbnCoreElasticsearchServerObj from './kbn_core_elasticsearch_server.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server_internal.mdx b/api_docs/kbn_core_elasticsearch_server_internal.mdx index 092482ed95488..a5d146a61f5d7 100644 --- a/api_docs/kbn_core_elasticsearch_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-internal title: "@kbn/core-elasticsearch-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-internal'] --- import kbnCoreElasticsearchServerInternalObj from './kbn_core_elasticsearch_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_server_mocks.mdx index f411f496665e8..649efd9ad5161 100644 --- a/api_docs/kbn_core_elasticsearch_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-mocks title: "@kbn/core-elasticsearch-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-mocks'] --- import kbnCoreElasticsearchServerMocksObj from './kbn_core_elasticsearch_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_environment_server_internal.mdx b/api_docs/kbn_core_environment_server_internal.mdx index 8a6228c80defd..5fa47364da065 100644 --- a/api_docs/kbn_core_environment_server_internal.mdx +++ b/api_docs/kbn_core_environment_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-internal title: "@kbn/core-environment-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-environment-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-internal'] --- import kbnCoreEnvironmentServerInternalObj from './kbn_core_environment_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_environment_server_mocks.mdx b/api_docs/kbn_core_environment_server_mocks.mdx index 9c5f8e12ffa3c..719a1b79f47c2 100644 --- a/api_docs/kbn_core_environment_server_mocks.mdx +++ b/api_docs/kbn_core_environment_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-mocks title: "@kbn/core-environment-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-environment-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-mocks'] --- import kbnCoreEnvironmentServerMocksObj from './kbn_core_environment_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_browser.mdx b/api_docs/kbn_core_execution_context_browser.mdx index 59afb731e5bf4..cd19567f25beb 100644 --- a/api_docs/kbn_core_execution_context_browser.mdx +++ b/api_docs/kbn_core_execution_context_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser title: "@kbn/core-execution-context-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser'] --- import kbnCoreExecutionContextBrowserObj from './kbn_core_execution_context_browser.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_browser_internal.mdx b/api_docs/kbn_core_execution_context_browser_internal.mdx index d2f3214f2f080..ca921ac355579 100644 --- a/api_docs/kbn_core_execution_context_browser_internal.mdx +++ b/api_docs/kbn_core_execution_context_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-internal title: "@kbn/core-execution-context-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-internal'] --- import kbnCoreExecutionContextBrowserInternalObj from './kbn_core_execution_context_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_browser_mocks.mdx b/api_docs/kbn_core_execution_context_browser_mocks.mdx index 53578f7fb369c..9aa8bb27110e0 100644 --- a/api_docs/kbn_core_execution_context_browser_mocks.mdx +++ b/api_docs/kbn_core_execution_context_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-mocks title: "@kbn/core-execution-context-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-mocks'] --- import kbnCoreExecutionContextBrowserMocksObj from './kbn_core_execution_context_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_common.mdx b/api_docs/kbn_core_execution_context_common.mdx index b9baccb340651..6b38e33a090e6 100644 --- a/api_docs/kbn_core_execution_context_common.mdx +++ b/api_docs/kbn_core_execution_context_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-common title: "@kbn/core-execution-context-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-common'] --- import kbnCoreExecutionContextCommonObj from './kbn_core_execution_context_common.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_server.mdx b/api_docs/kbn_core_execution_context_server.mdx index b89285b791712..1402f3cd93ece 100644 --- a/api_docs/kbn_core_execution_context_server.mdx +++ b/api_docs/kbn_core_execution_context_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server title: "@kbn/core-execution-context-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server'] --- import kbnCoreExecutionContextServerObj from './kbn_core_execution_context_server.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_server_internal.mdx b/api_docs/kbn_core_execution_context_server_internal.mdx index 3faa3e24ef295..84bf41cbddde6 100644 --- a/api_docs/kbn_core_execution_context_server_internal.mdx +++ b/api_docs/kbn_core_execution_context_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-internal title: "@kbn/core-execution-context-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-internal'] --- import kbnCoreExecutionContextServerInternalObj from './kbn_core_execution_context_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_server_mocks.mdx b/api_docs/kbn_core_execution_context_server_mocks.mdx index d5033782cd0a6..6defebc46f5ac 100644 --- a/api_docs/kbn_core_execution_context_server_mocks.mdx +++ b/api_docs/kbn_core_execution_context_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-mocks title: "@kbn/core-execution-context-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-mocks'] --- import kbnCoreExecutionContextServerMocksObj from './kbn_core_execution_context_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_fatal_errors_browser.mdx b/api_docs/kbn_core_fatal_errors_browser.mdx index 1c07613a8bdf3..615e29ae4cd3e 100644 --- a/api_docs/kbn_core_fatal_errors_browser.mdx +++ b/api_docs/kbn_core_fatal_errors_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser title: "@kbn/core-fatal-errors-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-fatal-errors-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser'] --- import kbnCoreFatalErrorsBrowserObj from './kbn_core_fatal_errors_browser.devdocs.json'; diff --git a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx index 5a03a3b4afad5..01d1b9d54eb2b 100644 --- a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx +++ b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser-mocks title: "@kbn/core-fatal-errors-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-fatal-errors-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser-mocks'] --- import kbnCoreFatalErrorsBrowserMocksObj from './kbn_core_fatal_errors_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser.mdx b/api_docs/kbn_core_http_browser.mdx index 934d9c1849710..33124c52e5a23 100644 --- a/api_docs/kbn_core_http_browser.mdx +++ b/api_docs/kbn_core_http_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser title: "@kbn/core-http-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser'] --- import kbnCoreHttpBrowserObj from './kbn_core_http_browser.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser_internal.mdx b/api_docs/kbn_core_http_browser_internal.mdx index 96044cd73c1aa..20b85408ab50d 100644 --- a/api_docs/kbn_core_http_browser_internal.mdx +++ b/api_docs/kbn_core_http_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-internal title: "@kbn/core-http-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-internal'] --- import kbnCoreHttpBrowserInternalObj from './kbn_core_http_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser_mocks.mdx b/api_docs/kbn_core_http_browser_mocks.mdx index 3aa256e7ea2ed..40b8f6544b9d1 100644 --- a/api_docs/kbn_core_http_browser_mocks.mdx +++ b/api_docs/kbn_core_http_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-mocks title: "@kbn/core-http-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-mocks'] --- import kbnCoreHttpBrowserMocksObj from './kbn_core_http_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_common.mdx b/api_docs/kbn_core_http_common.mdx index 609384e15a228..c254f9c5e54f5 100644 --- a/api_docs/kbn_core_http_common.mdx +++ b/api_docs/kbn_core_http_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-common title: "@kbn/core-http-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-common'] --- import kbnCoreHttpCommonObj from './kbn_core_http_common.devdocs.json'; diff --git a/api_docs/kbn_core_http_context_server_mocks.mdx b/api_docs/kbn_core_http_context_server_mocks.mdx index e873aaacadbf7..b38d5ca7caf10 100644 --- a/api_docs/kbn_core_http_context_server_mocks.mdx +++ b/api_docs/kbn_core_http_context_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-context-server-mocks title: "@kbn/core-http-context-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-context-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-context-server-mocks'] --- import kbnCoreHttpContextServerMocksObj from './kbn_core_http_context_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_request_handler_context_server.mdx b/api_docs/kbn_core_http_request_handler_context_server.mdx index 93b0b533c2ee9..113f86c484459 100644 --- a/api_docs/kbn_core_http_request_handler_context_server.mdx +++ b/api_docs/kbn_core_http_request_handler_context_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-request-handler-context-server title: "@kbn/core-http-request-handler-context-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-request-handler-context-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-request-handler-context-server'] --- import kbnCoreHttpRequestHandlerContextServerObj from './kbn_core_http_request_handler_context_server.devdocs.json'; diff --git a/api_docs/kbn_core_http_resources_server.mdx b/api_docs/kbn_core_http_resources_server.mdx index 9ee7c0fb1eda8..14d7bf7f6edca 100644 --- a/api_docs/kbn_core_http_resources_server.mdx +++ b/api_docs/kbn_core_http_resources_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server title: "@kbn/core-http-resources-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server'] --- import kbnCoreHttpResourcesServerObj from './kbn_core_http_resources_server.devdocs.json'; diff --git a/api_docs/kbn_core_http_resources_server_internal.mdx b/api_docs/kbn_core_http_resources_server_internal.mdx index ac079a700e78f..e922cdb314b49 100644 --- a/api_docs/kbn_core_http_resources_server_internal.mdx +++ b/api_docs/kbn_core_http_resources_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-internal title: "@kbn/core-http-resources-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server-internal'] --- import kbnCoreHttpResourcesServerInternalObj from './kbn_core_http_resources_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_resources_server_mocks.mdx b/api_docs/kbn_core_http_resources_server_mocks.mdx index a321f2450adae..2c372baed8215 100644 --- a/api_docs/kbn_core_http_resources_server_mocks.mdx +++ b/api_docs/kbn_core_http_resources_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-mocks title: "@kbn/core-http-resources-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server-mocks'] --- import kbnCoreHttpResourcesServerMocksObj from './kbn_core_http_resources_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_router_server_internal.mdx b/api_docs/kbn_core_http_router_server_internal.mdx index 1f493034952d6..4112e653e502e 100644 --- a/api_docs/kbn_core_http_router_server_internal.mdx +++ b/api_docs/kbn_core_http_router_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-internal title: "@kbn/core-http-router-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-router-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-internal'] --- import kbnCoreHttpRouterServerInternalObj from './kbn_core_http_router_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_router_server_mocks.mdx b/api_docs/kbn_core_http_router_server_mocks.mdx index f254c6c599c37..5f4982567691e 100644 --- a/api_docs/kbn_core_http_router_server_mocks.mdx +++ b/api_docs/kbn_core_http_router_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-mocks title: "@kbn/core-http-router-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-router-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-mocks'] --- import kbnCoreHttpRouterServerMocksObj from './kbn_core_http_router_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_server.mdx b/api_docs/kbn_core_http_server.mdx index f0269d9e404fa..a9d61ae52a0af 100644 --- a/api_docs/kbn_core_http_server.mdx +++ b/api_docs/kbn_core_http_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server title: "@kbn/core-http-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server'] --- import kbnCoreHttpServerObj from './kbn_core_http_server.devdocs.json'; diff --git a/api_docs/kbn_core_http_server_internal.mdx b/api_docs/kbn_core_http_server_internal.mdx index fcd13a8827ad1..b7d6ef17a0d4d 100644 --- a/api_docs/kbn_core_http_server_internal.mdx +++ b/api_docs/kbn_core_http_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-internal title: "@kbn/core-http-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-internal'] --- import kbnCoreHttpServerInternalObj from './kbn_core_http_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_server_mocks.mdx b/api_docs/kbn_core_http_server_mocks.mdx index 726b0f0fb588c..9e279a134428d 100644 --- a/api_docs/kbn_core_http_server_mocks.mdx +++ b/api_docs/kbn_core_http_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-mocks title: "@kbn/core-http-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-mocks'] --- import kbnCoreHttpServerMocksObj from './kbn_core_http_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_browser.mdx b/api_docs/kbn_core_i18n_browser.mdx index 327d65ddf85db..c33ae3d6fb5b8 100644 --- a/api_docs/kbn_core_i18n_browser.mdx +++ b/api_docs/kbn_core_i18n_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser title: "@kbn/core-i18n-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser'] --- import kbnCoreI18nBrowserObj from './kbn_core_i18n_browser.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_browser_mocks.mdx b/api_docs/kbn_core_i18n_browser_mocks.mdx index 476cea875073e..30c6e320e6bf3 100644 --- a/api_docs/kbn_core_i18n_browser_mocks.mdx +++ b/api_docs/kbn_core_i18n_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser-mocks title: "@kbn/core-i18n-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser-mocks'] --- import kbnCoreI18nBrowserMocksObj from './kbn_core_i18n_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_server.mdx b/api_docs/kbn_core_i18n_server.mdx index f61efd76d3392..cce983a6af353 100644 --- a/api_docs/kbn_core_i18n_server.mdx +++ b/api_docs/kbn_core_i18n_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server title: "@kbn/core-i18n-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server'] --- import kbnCoreI18nServerObj from './kbn_core_i18n_server.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_server_internal.mdx b/api_docs/kbn_core_i18n_server_internal.mdx index 79e29e9633c89..2d313e55bf52d 100644 --- a/api_docs/kbn_core_i18n_server_internal.mdx +++ b/api_docs/kbn_core_i18n_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-internal title: "@kbn/core-i18n-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-internal'] --- import kbnCoreI18nServerInternalObj from './kbn_core_i18n_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_server_mocks.mdx b/api_docs/kbn_core_i18n_server_mocks.mdx index 59c8e5c1dfa00..77784fbe0e330 100644 --- a/api_docs/kbn_core_i18n_server_mocks.mdx +++ b/api_docs/kbn_core_i18n_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-mocks title: "@kbn/core-i18n-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-mocks'] --- import kbnCoreI18nServerMocksObj from './kbn_core_i18n_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx index eb0a63b436dd4..b625cf457a1dc 100644 --- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks title: "@kbn/core-injected-metadata-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-injected-metadata-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks'] --- import kbnCoreInjectedMetadataBrowserMocksObj from './kbn_core_injected_metadata_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_integrations_browser_internal.mdx b/api_docs/kbn_core_integrations_browser_internal.mdx index 0a4384b90555a..246ee8f0b7efd 100644 --- a/api_docs/kbn_core_integrations_browser_internal.mdx +++ b/api_docs/kbn_core_integrations_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-internal title: "@kbn/core-integrations-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-integrations-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-internal'] --- import kbnCoreIntegrationsBrowserInternalObj from './kbn_core_integrations_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_integrations_browser_mocks.mdx b/api_docs/kbn_core_integrations_browser_mocks.mdx index 56e8a3d41fc3c..079713bf202fe 100644 --- a/api_docs/kbn_core_integrations_browser_mocks.mdx +++ b/api_docs/kbn_core_integrations_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-mocks title: "@kbn/core-integrations-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-integrations-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-mocks'] --- import kbnCoreIntegrationsBrowserMocksObj from './kbn_core_integrations_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_browser.mdx b/api_docs/kbn_core_lifecycle_browser.mdx index edd6a854351bc..eaa84305138ad 100644 --- a/api_docs/kbn_core_lifecycle_browser.mdx +++ b/api_docs/kbn_core_lifecycle_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser title: "@kbn/core-lifecycle-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-browser'] --- import kbnCoreLifecycleBrowserObj from './kbn_core_lifecycle_browser.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_browser_mocks.mdx b/api_docs/kbn_core_lifecycle_browser_mocks.mdx index e3cb302e31c5f..e69240a71e986 100644 --- a/api_docs/kbn_core_lifecycle_browser_mocks.mdx +++ b/api_docs/kbn_core_lifecycle_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser-mocks title: "@kbn/core-lifecycle-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-browser-mocks'] --- import kbnCoreLifecycleBrowserMocksObj from './kbn_core_lifecycle_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_server.mdx b/api_docs/kbn_core_lifecycle_server.mdx index 1ebf9555e7761..0ce89a03b77ed 100644 --- a/api_docs/kbn_core_lifecycle_server.mdx +++ b/api_docs/kbn_core_lifecycle_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server title: "@kbn/core-lifecycle-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-server'] --- import kbnCoreLifecycleServerObj from './kbn_core_lifecycle_server.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_server_mocks.mdx b/api_docs/kbn_core_lifecycle_server_mocks.mdx index e9abfb1a8b4b9..f2ecfc13431c4 100644 --- a/api_docs/kbn_core_lifecycle_server_mocks.mdx +++ b/api_docs/kbn_core_lifecycle_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server-mocks title: "@kbn/core-lifecycle-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-server-mocks'] --- import kbnCoreLifecycleServerMocksObj from './kbn_core_lifecycle_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_logging_browser_mocks.mdx b/api_docs/kbn_core_logging_browser_mocks.mdx index b1b7669dd8044..bb352edd04fb7 100644 --- a/api_docs/kbn_core_logging_browser_mocks.mdx +++ b/api_docs/kbn_core_logging_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-browser-mocks title: "@kbn/core-logging-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-browser-mocks'] --- import kbnCoreLoggingBrowserMocksObj from './kbn_core_logging_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_logging_common_internal.mdx b/api_docs/kbn_core_logging_common_internal.mdx index 748d7e2f72a18..645f6a00c4636 100644 --- a/api_docs/kbn_core_logging_common_internal.mdx +++ b/api_docs/kbn_core_logging_common_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-common-internal title: "@kbn/core-logging-common-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-common-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-common-internal'] --- import kbnCoreLoggingCommonInternalObj from './kbn_core_logging_common_internal.devdocs.json'; diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx index 30a043d80450c..3129ba4f090c1 100644 --- a/api_docs/kbn_core_logging_server.mdx +++ b/api_docs/kbn_core_logging_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server title: "@kbn/core-logging-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server'] --- import kbnCoreLoggingServerObj from './kbn_core_logging_server.devdocs.json'; diff --git a/api_docs/kbn_core_logging_server_internal.devdocs.json b/api_docs/kbn_core_logging_server_internal.devdocs.json index a47e3929b5f8e..e3d83140a2819 100644 --- a/api_docs/kbn_core_logging_server_internal.devdocs.json +++ b/api_docs/kbn_core_logging_server_internal.devdocs.json @@ -135,7 +135,7 @@ "section": "def-common.Type", "text": "Type" }, - " | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }> | Readonly<{} & { type: \"file\"; fileName: string; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }> | Readonly<{} & { type: \"rewrite\"; policy: Readonly<{} & { type: \"meta\"; mode: \"update\" | \"remove\"; properties: Readonly<{ value?: string | number | boolean | null | undefined; } & { path: string; }>[]; }>; appenders: string[]; }> | Readonly<{} & { type: \"rolling-file\"; policy: Readonly<{} & { type: \"size-limit\"; size: ", + " | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }> | Readonly<{} & { type: \"file\"; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; fileName: string; }> | Readonly<{} & { type: \"rewrite\"; policy: Readonly<{} & { type: \"meta\"; mode: \"update\" | \"remove\"; properties: Readonly<{ value?: string | number | boolean | null | undefined; } & { path: string; }>[]; }>; appenders: string[]; }> | Readonly<{} & { type: \"rolling-file\"; policy: Readonly<{} & { type: \"size-limit\"; size: ", { "pluginId": "@kbn/config-schema", "scope": "common", @@ -151,7 +151,7 @@ "section": "def-common.NumericRollingStrategyConfig", "text": "NumericRollingStrategyConfig" }, - "; fileName: string; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; }>>" + "; layout: Readonly<{} & { type: \"json\"; }> | Readonly<{ pattern?: string | undefined; highlight?: boolean | undefined; } & { type: \"pattern\"; }>; fileName: string; }>>" ], "path": "packages/core/logging/core-logging-server-internal/src/appenders/appenders.ts", "deprecated": false, diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx index 42da3005fc30f..5663a4d37da48 100644 --- a/api_docs/kbn_core_logging_server_internal.mdx +++ b/api_docs/kbn_core_logging_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-internal title: "@kbn/core-logging-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-internal'] --- import kbnCoreLoggingServerInternalObj from './kbn_core_logging_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_logging_server_mocks.mdx b/api_docs/kbn_core_logging_server_mocks.mdx index a611f7047c54a..5a97206b36176 100644 --- a/api_docs/kbn_core_logging_server_mocks.mdx +++ b/api_docs/kbn_core_logging_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks title: "@kbn/core-logging-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-mocks'] --- import kbnCoreLoggingServerMocksObj from './kbn_core_logging_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_collectors_server_internal.mdx b/api_docs/kbn_core_metrics_collectors_server_internal.mdx index 4122ace9b3a8e..54537707447a0 100644 --- a/api_docs/kbn_core_metrics_collectors_server_internal.mdx +++ b/api_docs/kbn_core_metrics_collectors_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-internal title: "@kbn/core-metrics-collectors-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-collectors-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-internal'] --- import kbnCoreMetricsCollectorsServerInternalObj from './kbn_core_metrics_collectors_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx index 12ce14809d716..41aedc11a6347 100644 --- a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx +++ b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-mocks title: "@kbn/core-metrics-collectors-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-collectors-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-mocks'] --- import kbnCoreMetricsCollectorsServerMocksObj from './kbn_core_metrics_collectors_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_server.mdx b/api_docs/kbn_core_metrics_server.mdx index 07ad821625781..29be86ad95b1a 100644 --- a/api_docs/kbn_core_metrics_server.mdx +++ b/api_docs/kbn_core_metrics_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server title: "@kbn/core-metrics-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server'] --- import kbnCoreMetricsServerObj from './kbn_core_metrics_server.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_server_internal.mdx b/api_docs/kbn_core_metrics_server_internal.mdx index 538bff647d6a9..23a74e11395eb 100644 --- a/api_docs/kbn_core_metrics_server_internal.mdx +++ b/api_docs/kbn_core_metrics_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-internal title: "@kbn/core-metrics-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-internal'] --- import kbnCoreMetricsServerInternalObj from './kbn_core_metrics_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_server_mocks.mdx b/api_docs/kbn_core_metrics_server_mocks.mdx index 61815b04b0e01..f67f9d8264cce 100644 --- a/api_docs/kbn_core_metrics_server_mocks.mdx +++ b/api_docs/kbn_core_metrics_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-mocks title: "@kbn/core-metrics-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-mocks'] --- import kbnCoreMetricsServerMocksObj from './kbn_core_metrics_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_mount_utils_browser.mdx b/api_docs/kbn_core_mount_utils_browser.mdx index 345e4ebf4fecd..8b5885e1c368c 100644 --- a/api_docs/kbn_core_mount_utils_browser.mdx +++ b/api_docs/kbn_core_mount_utils_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-mount-utils-browser title: "@kbn/core-mount-utils-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-mount-utils-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-mount-utils-browser'] --- import kbnCoreMountUtilsBrowserObj from './kbn_core_mount_utils_browser.devdocs.json'; diff --git a/api_docs/kbn_core_node_server.mdx b/api_docs/kbn_core_node_server.mdx index 38ea9126631c5..e2c41ccf99263 100644 --- a/api_docs/kbn_core_node_server.mdx +++ b/api_docs/kbn_core_node_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server title: "@kbn/core-node-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server'] --- import kbnCoreNodeServerObj from './kbn_core_node_server.devdocs.json'; diff --git a/api_docs/kbn_core_node_server_internal.mdx b/api_docs/kbn_core_node_server_internal.mdx index f7be78c01f1be..f8b73ddd21b4a 100644 --- a/api_docs/kbn_core_node_server_internal.mdx +++ b/api_docs/kbn_core_node_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-internal title: "@kbn/core-node-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-internal'] --- import kbnCoreNodeServerInternalObj from './kbn_core_node_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_node_server_mocks.mdx b/api_docs/kbn_core_node_server_mocks.mdx index 13e9d8c245f4a..8707aa6ab05b8 100644 --- a/api_docs/kbn_core_node_server_mocks.mdx +++ b/api_docs/kbn_core_node_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-mocks title: "@kbn/core-node-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-mocks'] --- import kbnCoreNodeServerMocksObj from './kbn_core_node_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_notifications_browser.mdx b/api_docs/kbn_core_notifications_browser.mdx index 00c89755f9e85..57ec2b4ccedda 100644 --- a/api_docs/kbn_core_notifications_browser.mdx +++ b/api_docs/kbn_core_notifications_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser title: "@kbn/core-notifications-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser'] --- import kbnCoreNotificationsBrowserObj from './kbn_core_notifications_browser.devdocs.json'; diff --git a/api_docs/kbn_core_notifications_browser_internal.mdx b/api_docs/kbn_core_notifications_browser_internal.mdx index 2c39ee78be8a4..fd0ac61f06fa5 100644 --- a/api_docs/kbn_core_notifications_browser_internal.mdx +++ b/api_docs/kbn_core_notifications_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-internal title: "@kbn/core-notifications-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser-internal'] --- import kbnCoreNotificationsBrowserInternalObj from './kbn_core_notifications_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_notifications_browser_mocks.mdx b/api_docs/kbn_core_notifications_browser_mocks.mdx index 7c97cabf13a37..9cb8825c8f6cc 100644 --- a/api_docs/kbn_core_notifications_browser_mocks.mdx +++ b/api_docs/kbn_core_notifications_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-mocks title: "@kbn/core-notifications-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser-mocks'] --- import kbnCoreNotificationsBrowserMocksObj from './kbn_core_notifications_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_overlays_browser.mdx b/api_docs/kbn_core_overlays_browser.mdx index 378a66e2a2b63..8c8288369bb8c 100644 --- a/api_docs/kbn_core_overlays_browser.mdx +++ b/api_docs/kbn_core_overlays_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser title: "@kbn/core-overlays-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser'] --- import kbnCoreOverlaysBrowserObj from './kbn_core_overlays_browser.devdocs.json'; diff --git a/api_docs/kbn_core_overlays_browser_internal.mdx b/api_docs/kbn_core_overlays_browser_internal.mdx index ffba5b2b425b2..5013d489cce61 100644 --- a/api_docs/kbn_core_overlays_browser_internal.mdx +++ b/api_docs/kbn_core_overlays_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-internal title: "@kbn/core-overlays-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser-internal'] --- import kbnCoreOverlaysBrowserInternalObj from './kbn_core_overlays_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_overlays_browser_mocks.mdx b/api_docs/kbn_core_overlays_browser_mocks.mdx index 84cbe8217888e..6bf6a9362ef33 100644 --- a/api_docs/kbn_core_overlays_browser_mocks.mdx +++ b/api_docs/kbn_core_overlays_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-mocks title: "@kbn/core-overlays-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser-mocks'] --- import kbnCoreOverlaysBrowserMocksObj from './kbn_core_overlays_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_browser.mdx b/api_docs/kbn_core_plugins_browser.mdx index 38b0f17ed8b34..7fb0fe05886aa 100644 --- a/api_docs/kbn_core_plugins_browser.mdx +++ b/api_docs/kbn_core_plugins_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser title: "@kbn/core-plugins-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-browser'] --- import kbnCorePluginsBrowserObj from './kbn_core_plugins_browser.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_browser_mocks.mdx b/api_docs/kbn_core_plugins_browser_mocks.mdx index 6aff28a1abcfc..e7d62f8b84a7e 100644 --- a/api_docs/kbn_core_plugins_browser_mocks.mdx +++ b/api_docs/kbn_core_plugins_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser-mocks title: "@kbn/core-plugins-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-browser-mocks'] --- import kbnCorePluginsBrowserMocksObj from './kbn_core_plugins_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_server.mdx b/api_docs/kbn_core_plugins_server.mdx index 1e6976aa338f6..bc84b995fc986 100644 --- a/api_docs/kbn_core_plugins_server.mdx +++ b/api_docs/kbn_core_plugins_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server title: "@kbn/core-plugins-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-server'] --- import kbnCorePluginsServerObj from './kbn_core_plugins_server.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_server_mocks.mdx b/api_docs/kbn_core_plugins_server_mocks.mdx index ec656229cea4a..6bd6a09b5fbac 100644 --- a/api_docs/kbn_core_plugins_server_mocks.mdx +++ b/api_docs/kbn_core_plugins_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server-mocks title: "@kbn/core-plugins-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-server-mocks'] --- import kbnCorePluginsServerMocksObj from './kbn_core_plugins_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_preboot_server.mdx b/api_docs/kbn_core_preboot_server.mdx index 14599d19eb28d..e70dee405695c 100644 --- a/api_docs/kbn_core_preboot_server.mdx +++ b/api_docs/kbn_core_preboot_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server title: "@kbn/core-preboot-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-preboot-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server'] --- import kbnCorePrebootServerObj from './kbn_core_preboot_server.devdocs.json'; diff --git a/api_docs/kbn_core_preboot_server_mocks.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx index 53e1533e5ed62..c8626d9505b14 100644 --- a/api_docs/kbn_core_preboot_server_mocks.mdx +++ b/api_docs/kbn_core_preboot_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server-mocks title: "@kbn/core-preboot-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-preboot-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server-mocks'] --- import kbnCorePrebootServerMocksObj from './kbn_core_preboot_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_rendering_browser_mocks.mdx b/api_docs/kbn_core_rendering_browser_mocks.mdx index 5681288db7b8b..cbb13c4585b64 100644 --- a/api_docs/kbn_core_rendering_browser_mocks.mdx +++ b/api_docs/kbn_core_rendering_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-browser-mocks title: "@kbn/core-rendering-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-browser-mocks'] --- import kbnCoreRenderingBrowserMocksObj from './kbn_core_rendering_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_rendering_server_internal.mdx b/api_docs/kbn_core_rendering_server_internal.mdx index 39ac384fece9d..4ea379d98b6e2 100644 --- a/api_docs/kbn_core_rendering_server_internal.mdx +++ b/api_docs/kbn_core_rendering_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-internal title: "@kbn/core-rendering-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-server-internal'] --- import kbnCoreRenderingServerInternalObj from './kbn_core_rendering_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_rendering_server_mocks.mdx b/api_docs/kbn_core_rendering_server_mocks.mdx index 4c56fcd00e39e..cf63868d5655d 100644 --- a/api_docs/kbn_core_rendering_server_mocks.mdx +++ b/api_docs/kbn_core_rendering_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-mocks title: "@kbn/core-rendering-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-server-mocks'] --- import kbnCoreRenderingServerMocksObj from './kbn_core_rendering_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_root_server_internal.mdx b/api_docs/kbn_core_root_server_internal.mdx index 38c07023d4931..a65c4fe888768 100644 --- a/api_docs/kbn_core_root_server_internal.mdx +++ b/api_docs/kbn_core_root_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-root-server-internal title: "@kbn/core-root-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-root-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-root-server-internal'] --- import kbnCoreRootServerInternalObj from './kbn_core_root_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_browser.mdx b/api_docs/kbn_core_saved_objects_api_browser.mdx index fb0ecbc2c2163..db5eb3119c07e 100644 --- a/api_docs/kbn_core_saved_objects_api_browser.mdx +++ b/api_docs/kbn_core_saved_objects_api_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-browser title: "@kbn/core-saved-objects-api-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-browser'] --- import kbnCoreSavedObjectsApiBrowserObj from './kbn_core_saved_objects_api_browser.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_server.mdx b/api_docs/kbn_core_saved_objects_api_server.mdx index 2248cb191448b..fe8f10992629b 100644 --- a/api_docs/kbn_core_saved_objects_api_server.mdx +++ b/api_docs/kbn_core_saved_objects_api_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server title: "@kbn/core-saved-objects-api-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server'] --- import kbnCoreSavedObjectsApiServerObj from './kbn_core_saved_objects_api_server.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_server_internal.mdx b/api_docs/kbn_core_saved_objects_api_server_internal.mdx index 37c963079e0ea..139b204b6ed9d 100644 --- a/api_docs/kbn_core_saved_objects_api_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_api_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server-internal title: "@kbn/core-saved-objects-api-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server-internal'] --- import kbnCoreSavedObjectsApiServerInternalObj from './kbn_core_saved_objects_api_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_server_mocks.mdx b/api_docs/kbn_core_saved_objects_api_server_mocks.mdx index 8385e9d23d369..890acd6c4effd 100644 --- a/api_docs/kbn_core_saved_objects_api_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_api_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server-mocks title: "@kbn/core-saved-objects-api-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server-mocks'] --- import kbnCoreSavedObjectsApiServerMocksObj from './kbn_core_saved_objects_api_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_base_server_internal.mdx b/api_docs/kbn_core_saved_objects_base_server_internal.mdx index c555c3ef6bcd1..6c71247ec6ba2 100644 --- a/api_docs/kbn_core_saved_objects_base_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_base_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-internal title: "@kbn/core-saved-objects-base-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-base-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-base-server-internal'] --- import kbnCoreSavedObjectsBaseServerInternalObj from './kbn_core_saved_objects_base_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_base_server_mocks.mdx b/api_docs/kbn_core_saved_objects_base_server_mocks.mdx index 3d82abfa44693..c5d6b258124fb 100644 --- a/api_docs/kbn_core_saved_objects_base_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_base_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-mocks title: "@kbn/core-saved-objects-base-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-base-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-base-server-mocks'] --- import kbnCoreSavedObjectsBaseServerMocksObj from './kbn_core_saved_objects_base_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser.mdx b/api_docs/kbn_core_saved_objects_browser.mdx index 95be0c1cfc744..7a142c61bb615 100644 --- a/api_docs/kbn_core_saved_objects_browser.mdx +++ b/api_docs/kbn_core_saved_objects_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser title: "@kbn/core-saved-objects-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser'] --- import kbnCoreSavedObjectsBrowserObj from './kbn_core_saved_objects_browser.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser_internal.mdx b/api_docs/kbn_core_saved_objects_browser_internal.mdx index b606205795c61..c4db6dcd3ede6 100644 --- a/api_docs/kbn_core_saved_objects_browser_internal.mdx +++ b/api_docs/kbn_core_saved_objects_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-internal title: "@kbn/core-saved-objects-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-internal'] --- import kbnCoreSavedObjectsBrowserInternalObj from './kbn_core_saved_objects_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser_mocks.mdx b/api_docs/kbn_core_saved_objects_browser_mocks.mdx index ce8f6862b8b33..7c8dda26cf365 100644 --- a/api_docs/kbn_core_saved_objects_browser_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-mocks title: "@kbn/core-saved-objects-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-mocks'] --- import kbnCoreSavedObjectsBrowserMocksObj from './kbn_core_saved_objects_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_common.mdx b/api_docs/kbn_core_saved_objects_common.mdx index 75a8b539f9c23..2fbbc45ff9d7e 100644 --- a/api_docs/kbn_core_saved_objects_common.mdx +++ b/api_docs/kbn_core_saved_objects_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-common title: "@kbn/core-saved-objects-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-common'] --- import kbnCoreSavedObjectsCommonObj from './kbn_core_saved_objects_common.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx b/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx index ef83a995966eb..7b2c3b93566b2 100644 --- a/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-internal title: "@kbn/core-saved-objects-import-export-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-import-export-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-import-export-server-internal'] --- import kbnCoreSavedObjectsImportExportServerInternalObj from './kbn_core_saved_objects_import_export_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx b/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx index 4a155f87d08f9..56384225e841b 100644 --- a/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-mocks title: "@kbn/core-saved-objects-import-export-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-import-export-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-import-export-server-mocks'] --- import kbnCoreSavedObjectsImportExportServerMocksObj from './kbn_core_saved_objects_import_export_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx index ecae616f54838..14ce25a62bad1 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-internal title: "@kbn/core-saved-objects-migration-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-migration-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-internal'] --- import kbnCoreSavedObjectsMigrationServerInternalObj from './kbn_core_saved_objects_migration_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx index 3ec8515bf0ac3..7eb3f99d3b94a 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-mocks title: "@kbn/core-saved-objects-migration-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-migration-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-mocks'] --- import kbnCoreSavedObjectsMigrationServerMocksObj from './kbn_core_saved_objects_migration_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server.mdx b/api_docs/kbn_core_saved_objects_server.mdx index 3b35a69633b9b..6f12bfa198e93 100644 --- a/api_docs/kbn_core_saved_objects_server.mdx +++ b/api_docs/kbn_core_saved_objects_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server title: "@kbn/core-saved-objects-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server'] --- import kbnCoreSavedObjectsServerObj from './kbn_core_saved_objects_server.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server_internal.mdx b/api_docs/kbn_core_saved_objects_server_internal.mdx index 6aac2389233f2..cb3a242b66fa5 100644 --- a/api_docs/kbn_core_saved_objects_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-internal title: "@kbn/core-saved-objects-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server-internal'] --- import kbnCoreSavedObjectsServerInternalObj from './kbn_core_saved_objects_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server_mocks.mdx b/api_docs/kbn_core_saved_objects_server_mocks.mdx index f54cab320c278..5e1a7e84aca1b 100644 --- a/api_docs/kbn_core_saved_objects_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-mocks title: "@kbn/core-saved-objects-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server-mocks'] --- import kbnCoreSavedObjectsServerMocksObj from './kbn_core_saved_objects_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_utils_server.mdx b/api_docs/kbn_core_saved_objects_utils_server.mdx index febdea03b7ed4..e6e989d373dfe 100644 --- a/api_docs/kbn_core_saved_objects_utils_server.mdx +++ b/api_docs/kbn_core_saved_objects_utils_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-utils-server title: "@kbn/core-saved-objects-utils-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-utils-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-utils-server'] --- import kbnCoreSavedObjectsUtilsServerObj from './kbn_core_saved_objects_utils_server.devdocs.json'; diff --git a/api_docs/kbn_core_status_common.mdx b/api_docs/kbn_core_status_common.mdx index 2c8bdcd9b83b5..da7bf7dbc6112 100644 --- a/api_docs/kbn_core_status_common.mdx +++ b/api_docs/kbn_core_status_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common title: "@kbn/core-status-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common'] --- import kbnCoreStatusCommonObj from './kbn_core_status_common.devdocs.json'; diff --git a/api_docs/kbn_core_status_common_internal.mdx b/api_docs/kbn_core_status_common_internal.mdx index 46e7f60c1b5f9..a1af0929c95f4 100644 --- a/api_docs/kbn_core_status_common_internal.mdx +++ b/api_docs/kbn_core_status_common_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common-internal title: "@kbn/core-status-common-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-common-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common-internal'] --- import kbnCoreStatusCommonInternalObj from './kbn_core_status_common_internal.devdocs.json'; diff --git a/api_docs/kbn_core_status_server.mdx b/api_docs/kbn_core_status_server.mdx index 621d1db37f8d4..42920b5864884 100644 --- a/api_docs/kbn_core_status_server.mdx +++ b/api_docs/kbn_core_status_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server title: "@kbn/core-status-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server'] --- import kbnCoreStatusServerObj from './kbn_core_status_server.devdocs.json'; diff --git a/api_docs/kbn_core_status_server_internal.mdx b/api_docs/kbn_core_status_server_internal.mdx index b6db50a722b82..93337c5869127 100644 --- a/api_docs/kbn_core_status_server_internal.mdx +++ b/api_docs/kbn_core_status_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-internal title: "@kbn/core-status-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-internal'] --- import kbnCoreStatusServerInternalObj from './kbn_core_status_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_status_server_mocks.mdx b/api_docs/kbn_core_status_server_mocks.mdx index 82a80b38a2c58..fb3a626a96a36 100644 --- a/api_docs/kbn_core_status_server_mocks.mdx +++ b/api_docs/kbn_core_status_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-mocks title: "@kbn/core-status-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-mocks'] --- import kbnCoreStatusServerMocksObj from './kbn_core_status_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx index ca4120cfcca1f..b4b29e4c7ff81 100644 --- a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx +++ b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-deprecations-getters title: "@kbn/core-test-helpers-deprecations-getters" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-deprecations-getters plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-deprecations-getters'] --- import kbnCoreTestHelpersDeprecationsGettersObj from './kbn_core_test_helpers_deprecations_getters.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx index 5c222d1a0f138..67b2d3ae0762d 100644 --- a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx +++ b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-http-setup-browser title: "@kbn/core-test-helpers-http-setup-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-http-setup-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-http-setup-browser'] --- import kbnCoreTestHelpersHttpSetupBrowserObj from './kbn_core_test_helpers_http_setup_browser.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_kbn_server.mdx b/api_docs/kbn_core_test_helpers_kbn_server.mdx index c0f314b647da3..ea4be485744fa 100644 --- a/api_docs/kbn_core_test_helpers_kbn_server.mdx +++ b/api_docs/kbn_core_test_helpers_kbn_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-kbn-server title: "@kbn/core-test-helpers-kbn-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-kbn-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-kbn-server'] --- import kbnCoreTestHelpersKbnServerObj from './kbn_core_test_helpers_kbn_server.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx index c170f0b3f2ba9..9b1b080e3c29c 100644 --- a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx +++ b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-so-type-serializer title: "@kbn/core-test-helpers-so-type-serializer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-so-type-serializer plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-so-type-serializer'] --- import kbnCoreTestHelpersSoTypeSerializerObj from './kbn_core_test_helpers_so_type_serializer.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_test_utils.mdx b/api_docs/kbn_core_test_helpers_test_utils.mdx index b8160fe494268..170303b0297ec 100644 --- a/api_docs/kbn_core_test_helpers_test_utils.mdx +++ b/api_docs/kbn_core_test_helpers_test_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-test-utils title: "@kbn/core-test-helpers-test-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-test-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-test-utils'] --- import kbnCoreTestHelpersTestUtilsObj from './kbn_core_test_helpers_test_utils.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx index ead5a02b605a6..6cecd9e23e8a1 100644 --- a/api_docs/kbn_core_theme_browser.mdx +++ b/api_docs/kbn_core_theme_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser title: "@kbn/core-theme-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser'] --- import kbnCoreThemeBrowserObj from './kbn_core_theme_browser.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser_internal.mdx b/api_docs/kbn_core_theme_browser_internal.mdx index 514e29700e631..a698d8417e02c 100644 --- a/api_docs/kbn_core_theme_browser_internal.mdx +++ b/api_docs/kbn_core_theme_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-internal title: "@kbn/core-theme-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-internal'] --- import kbnCoreThemeBrowserInternalObj from './kbn_core_theme_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index 510f3bf73d277..1a75b3c835b7c 100644 --- a/api_docs/kbn_core_theme_browser_mocks.mdx +++ b/api_docs/kbn_core_theme_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks title: "@kbn/core-theme-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-mocks'] --- import kbnCoreThemeBrowserMocksObj from './kbn_core_theme_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_browser.mdx b/api_docs/kbn_core_ui_settings_browser.mdx index 0ace1aa881e3d..e15bd667f5712 100644 --- a/api_docs/kbn_core_ui_settings_browser.mdx +++ b/api_docs/kbn_core_ui_settings_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser title: "@kbn/core-ui-settings-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser'] --- import kbnCoreUiSettingsBrowserObj from './kbn_core_ui_settings_browser.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_browser_internal.mdx b/api_docs/kbn_core_ui_settings_browser_internal.mdx index d59a3671a342e..cf961199ec1d2 100644 --- a/api_docs/kbn_core_ui_settings_browser_internal.mdx +++ b/api_docs/kbn_core_ui_settings_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-internal title: "@kbn/core-ui-settings-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-internal'] --- import kbnCoreUiSettingsBrowserInternalObj from './kbn_core_ui_settings_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_browser_mocks.mdx b/api_docs/kbn_core_ui_settings_browser_mocks.mdx index b4914e7ad41c7..c4c838d005cf7 100644 --- a/api_docs/kbn_core_ui_settings_browser_mocks.mdx +++ b/api_docs/kbn_core_ui_settings_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-mocks title: "@kbn/core-ui-settings-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-mocks'] --- import kbnCoreUiSettingsBrowserMocksObj from './kbn_core_ui_settings_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_common.mdx b/api_docs/kbn_core_ui_settings_common.mdx index f50deef449a98..81a7c287ba0de 100644 --- a/api_docs/kbn_core_ui_settings_common.mdx +++ b/api_docs/kbn_core_ui_settings_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-common title: "@kbn/core-ui-settings-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-common plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-common'] --- import kbnCoreUiSettingsCommonObj from './kbn_core_ui_settings_common.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server.mdx b/api_docs/kbn_core_ui_settings_server.mdx index e62eed9dafe29..9514641626c0d 100644 --- a/api_docs/kbn_core_ui_settings_server.mdx +++ b/api_docs/kbn_core_ui_settings_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server title: "@kbn/core-ui-settings-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server'] --- import kbnCoreUiSettingsServerObj from './kbn_core_ui_settings_server.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server_internal.mdx b/api_docs/kbn_core_ui_settings_server_internal.mdx index cc783dcfc68a6..98c9ad170d8b4 100644 --- a/api_docs/kbn_core_ui_settings_server_internal.mdx +++ b/api_docs/kbn_core_ui_settings_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-internal title: "@kbn/core-ui-settings-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-internal'] --- import kbnCoreUiSettingsServerInternalObj from './kbn_core_ui_settings_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server_mocks.mdx b/api_docs/kbn_core_ui_settings_server_mocks.mdx index 45d22f98bdc3b..680304898c938 100644 --- a/api_docs/kbn_core_ui_settings_server_mocks.mdx +++ b/api_docs/kbn_core_ui_settings_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-mocks title: "@kbn/core-ui-settings-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-mocks'] --- import kbnCoreUiSettingsServerMocksObj from './kbn_core_ui_settings_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server.mdx b/api_docs/kbn_core_usage_data_server.mdx index e172d076a54b0..3e74a7912d5a8 100644 --- a/api_docs/kbn_core_usage_data_server.mdx +++ b/api_docs/kbn_core_usage_data_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server title: "@kbn/core-usage-data-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server'] --- import kbnCoreUsageDataServerObj from './kbn_core_usage_data_server.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server_internal.mdx b/api_docs/kbn_core_usage_data_server_internal.mdx index b6a899405a3d6..767415b0cc357 100644 --- a/api_docs/kbn_core_usage_data_server_internal.mdx +++ b/api_docs/kbn_core_usage_data_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-internal title: "@kbn/core-usage-data-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server-internal plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-internal'] --- import kbnCoreUsageDataServerInternalObj from './kbn_core_usage_data_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server_mocks.mdx b/api_docs/kbn_core_usage_data_server_mocks.mdx index b626cb12367a7..edeffb60f645e 100644 --- a/api_docs/kbn_core_usage_data_server_mocks.mdx +++ b/api_docs/kbn_core_usage_data_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-mocks title: "@kbn/core-usage-data-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-mocks'] --- import kbnCoreUsageDataServerMocksObj from './kbn_core_usage_data_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index e7e52c7eeca63..2f1eed5ae9051 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/crypto plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] --- import kbnCryptoObj from './kbn_crypto.devdocs.json'; diff --git a/api_docs/kbn_crypto_browser.mdx b/api_docs/kbn_crypto_browser.mdx index b0dbcb5a96ce7..ec7019b8c92a1 100644 --- a/api_docs/kbn_crypto_browser.mdx +++ b/api_docs/kbn_crypto_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto-browser title: "@kbn/crypto-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/crypto-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-browser'] --- import kbnCryptoBrowserObj from './kbn_crypto_browser.devdocs.json'; diff --git a/api_docs/kbn_cypress_config.mdx b/api_docs/kbn_cypress_config.mdx index b9a158f9ef1e7..52ef4acdc22bb 100644 --- a/api_docs/kbn_cypress_config.mdx +++ b/api_docs/kbn_cypress_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cypress-config title: "@kbn/cypress-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cypress-config plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cypress-config'] --- import kbnCypressConfigObj from './kbn_cypress_config.devdocs.json'; diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index 3c1200d6d8bdb..6697c9515a270 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/datemath plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] --- import kbnDatemathObj from './kbn_datemath.devdocs.json'; diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index 58f0496f0f564..ac694474078ee 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-cli-errors plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] --- import kbnDevCliErrorsObj from './kbn_dev_cli_errors.devdocs.json'; diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index b4a3f3a6eb702..8fbff8b591fd8 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-cli-runner plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] --- import kbnDevCliRunnerObj from './kbn_dev_cli_runner.devdocs.json'; diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx index bad9aedfdb218..5d74d4b6a691f 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-proc-runner plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] --- import kbnDevProcRunnerObj from './kbn_dev_proc_runner.devdocs.json'; diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 10fa65db35754..327aa06962d36 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] --- import kbnDevUtilsObj from './kbn_dev_utils.devdocs.json'; diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 9d2dcf6be329b..92059ef22d27e 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/doc-links plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] --- import kbnDocLinksObj from './kbn_doc_links.devdocs.json'; diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 94ab0bd02fb15..c9980088baa90 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/docs-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] --- import kbnDocsUtilsObj from './kbn_docs_utils.devdocs.json'; diff --git a/api_docs/kbn_dom_drag_drop.mdx b/api_docs/kbn_dom_drag_drop.mdx index f0fa9ecbb53ec..5e7ea66b9b604 100644 --- a/api_docs/kbn_dom_drag_drop.mdx +++ b/api_docs/kbn_dom_drag_drop.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dom-drag-drop title: "@kbn/dom-drag-drop" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dom-drag-drop plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dom-drag-drop'] --- import kbnDomDragDropObj from './kbn_dom_drag_drop.devdocs.json'; diff --git a/api_docs/kbn_ebt_tools.mdx b/api_docs/kbn_ebt_tools.mdx index d578aef101b1c..65f014f817137 100644 --- a/api_docs/kbn_ebt_tools.mdx +++ b/api_docs/kbn_ebt_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ebt-tools title: "@kbn/ebt-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ebt-tools plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ebt-tools'] --- import kbnEbtToolsObj from './kbn_ebt_tools.devdocs.json'; diff --git a/api_docs/kbn_ecs.mdx b/api_docs/kbn_ecs.mdx index 8c43e2942ff4d..b63a88754ae5f 100644 --- a/api_docs/kbn_ecs.mdx +++ b/api_docs/kbn_ecs.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ecs title: "@kbn/ecs" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ecs plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ecs'] --- import kbnEcsObj from './kbn_ecs.devdocs.json'; diff --git a/api_docs/kbn_ecs_data_quality_dashboard.mdx b/api_docs/kbn_ecs_data_quality_dashboard.mdx index deda325599f0b..4b920cc381dd0 100644 --- a/api_docs/kbn_ecs_data_quality_dashboard.mdx +++ b/api_docs/kbn_ecs_data_quality_dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ecs-data-quality-dashboard title: "@kbn/ecs-data-quality-dashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ecs-data-quality-dashboard plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ecs-data-quality-dashboard'] --- import kbnEcsDataQualityDashboardObj from './kbn_ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/kbn_es.mdx b/api_docs/kbn_es.mdx index 9c2f7622bfe85..328b940e2d8a6 100644 --- a/api_docs/kbn_es.mdx +++ b/api_docs/kbn_es.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es title: "@kbn/es" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es'] --- import kbnEsObj from './kbn_es.devdocs.json'; diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index 37c57e3b8a2f4..30e8d9f81b498 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-archiver plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] --- import kbnEsArchiverObj from './kbn_es_archiver.devdocs.json'; diff --git a/api_docs/kbn_es_errors.mdx b/api_docs/kbn_es_errors.mdx index bfd442a7235b2..b3905d4eb40b1 100644 --- a/api_docs/kbn_es_errors.mdx +++ b/api_docs/kbn_es_errors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-errors title: "@kbn/es-errors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-errors plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-errors'] --- import kbnEsErrorsObj from './kbn_es_errors.devdocs.json'; diff --git a/api_docs/kbn_es_query.devdocs.json b/api_docs/kbn_es_query.devdocs.json index 15f5ca2dcacdb..84a193f3eb7b8 100644 --- a/api_docs/kbn_es_query.devdocs.json +++ b/api_docs/kbn_es_query.devdocs.json @@ -4241,6 +4241,8 @@ "FilterMetaParams", " | undefined; length: number; toString(): string; toLocaleString(): string; pop(): boolean | undefined; push(...items: boolean[]): number; concat(...items: ConcatArray[]): boolean[]; concat(...items: (boolean | ConcatArray)[]): boolean[]; join(separator?: string | undefined): string; reverse(): boolean[]; shift(): boolean | undefined; slice(start?: number | undefined, end?: number | undefined): boolean[]; sort(compareFn?: ((a: boolean, b: boolean) => number) | undefined): boolean[]; splice(start: number, deleteCount?: number | undefined): boolean[]; splice(start: number, deleteCount: number, ...items: boolean[]): boolean[]; unshift(...items: boolean[]): number; indexOf(searchElement: boolean, fromIndex?: number | undefined): number; lastIndexOf(searchElement: boolean, fromIndex?: number | undefined): number; every(predicate: (value: boolean, index: number, array: boolean[]) => value is S, thisArg?: any): this is S[]; every(predicate: (value: boolean, index: number, array: boolean[]) => unknown, thisArg?: any): boolean; some(predicate: (value: boolean, index: number, array: boolean[]) => unknown, thisArg?: any): boolean; forEach(callbackfn: (value: boolean, index: number, array: boolean[]) => void, thisArg?: any): void; map(callbackfn: (value: boolean, index: number, array: boolean[]) => U, thisArg?: any): U[]; filter(predicate: (value: boolean, index: number, array: boolean[]) => value is S, thisArg?: any): S[]; filter(predicate: (value: boolean, index: number, array: boolean[]) => unknown, thisArg?: any): boolean[]; reduce(callbackfn: (previousValue: boolean, currentValue: boolean, currentIndex: number, array: boolean[]) => boolean): boolean; reduce(callbackfn: (previousValue: boolean, currentValue: boolean, currentIndex: number, array: boolean[]) => boolean, initialValue: boolean): boolean; reduce(callbackfn: (previousValue: U, currentValue: boolean, currentIndex: number, array: boolean[]) => U, initialValue: U): U; reduceRight(callbackfn: (previousValue: boolean, currentValue: boolean, currentIndex: number, array: boolean[]) => boolean): boolean; reduceRight(callbackfn: (previousValue: boolean, currentValue: boolean, currentIndex: number, array: boolean[]) => boolean, initialValue: boolean): boolean; reduceRight(callbackfn: (previousValue: U, currentValue: boolean, currentIndex: number, array: boolean[]) => U, initialValue: U): U; find(predicate: (this: void, value: boolean, index: number, obj: boolean[]) => value is S, thisArg?: any): S | undefined; find(predicate: (value: boolean, index: number, obj: boolean[]) => unknown, thisArg?: any): boolean | undefined; findIndex(predicate: (value: boolean, index: number, obj: boolean[]) => unknown, thisArg?: any): number; fill(value: boolean, start?: number | undefined, end?: number | undefined): boolean[]; copyWithin(target: number, start: number, end?: number | undefined): boolean[]; entries(): IterableIterator<[number, boolean]>; keys(): IterableIterator; values(): IterableIterator; includes(searchElement: boolean, fromIndex?: number | undefined): boolean; flatMap(callback: (this: This, value: boolean, index: number, array: boolean[]) => U | readonly U[], thisArg?: This | undefined): U[]; flat(this: A, depth?: D | undefined): FlatArray[]; [Symbol.iterator](): IterableIterator; [Symbol.unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }; at(index: number): boolean | undefined; } | { query: ", "FilterMetaParams", + " | undefined; from?: string | number | undefined; to?: string | number | undefined; gt?: string | number | undefined; lt?: string | number | undefined; gte?: string | number | undefined; lte?: string | number | undefined; format?: string | undefined; } | { query: ", + "FilterMetaParams", " | undefined; length: number; toString(): string; toLocaleString(): string; pop(): number | undefined; push(...items: number[]): number; concat(...items: ConcatArray[]): number[]; concat(...items: (number | ConcatArray)[]): number[]; join(separator?: string | undefined): string; reverse(): number[]; shift(): number | undefined; slice(start?: number | undefined, end?: number | undefined): number[]; sort(compareFn?: ((a: number, b: number) => number) | undefined): number[]; splice(start: number, deleteCount?: number | undefined): number[]; splice(start: number, deleteCount: number, ...items: number[]): number[]; unshift(...items: number[]): number; indexOf(searchElement: number, fromIndex?: number | undefined): number; lastIndexOf(searchElement: number, fromIndex?: number | undefined): number; every(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): this is S[]; every(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; some(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean; forEach(callbackfn: (value: number, index: number, array: number[]) => void, thisArg?: any): void; map(callbackfn: (value: number, index: number, array: number[]) => U, thisArg?: any): U[]; filter(predicate: (value: number, index: number, array: number[]) => value is S, thisArg?: any): S[]; filter(predicate: (value: number, index: number, array: number[]) => unknown, thisArg?: any): number[]; reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; reduce(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number; reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number; reduceRight(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U; find(predicate: (this: void, value: number, index: number, obj: number[]) => value is S, thisArg?: any): S | undefined; find(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number | undefined; findIndex(predicate: (value: number, index: number, obj: number[]) => unknown, thisArg?: any): number; fill(value: number, start?: number | undefined, end?: number | undefined): number[]; copyWithin(target: number, start: number, end?: number | undefined): number[]; entries(): IterableIterator<[number, number]>; keys(): IterableIterator; values(): IterableIterator; includes(searchElement: number, fromIndex?: number | undefined): boolean; flatMap(callback: (this: This, value: number, index: number, array: number[]) => U | readonly U[], thisArg?: This | undefined): U[]; flat(this: A, depth?: D | undefined): FlatArray[]; [Symbol.iterator](): IterableIterator; [Symbol.unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }; at(index: number): number | undefined; } | { query: ", "FilterMetaParams", " | undefined; $state?: { store: ", @@ -4915,8 +4917,6 @@ }, ") | undefined; value?: string | undefined; field?: string | undefined; formattedValue?: string | undefined; } | { query: ", "FilterMetaParams", - " | undefined; from?: string | number | undefined; to?: string | number | undefined; gt?: string | number | undefined; lt?: string | number | undefined; gte?: string | number | undefined; lte?: string | number | undefined; format?: string | undefined; } | { query: ", - "FilterMetaParams", " | undefined; alias?: string | null | undefined; disabled?: boolean | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; group?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: (", "FilterMetaParams", " & ", @@ -6580,6 +6580,75 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.nodeBuilder.range", + "type": "Function", + "tags": [], + "label": "range", + "description": [], + "signature": [ + "(fieldName: string, operator: \"gt\" | \"gte\" | \"lt\" | \"lte\", value: string | number) => ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.FunctionTypeBuildNode", + "text": "FunctionTypeBuildNode" + } + ], + "path": "packages/kbn-es-query/src/kuery/node_types/node_builder.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.nodeBuilder.range.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-es-query/src/kuery/node_types/node_builder.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.nodeBuilder.range.$2", + "type": "CompoundType", + "tags": [], + "label": "operator", + "description": [], + "signature": [ + "\"gt\" | \"gte\" | \"lt\" | \"lte\"" + ], + "path": "packages/kbn-es-query/src/kuery/node_types/node_builder.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.nodeBuilder.range.$3", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string | number" + ], + "path": "packages/kbn-es-query/src/kuery/node_types/node_builder.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index e1d4080508383..b4f3957f73abd 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-query plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] --- import kbnEsQueryObj from './kbn_es_query.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 251 | 1 | 193 | 15 | +| 255 | 1 | 197 | 15 | ## Common diff --git a/api_docs/kbn_es_types.mdx b/api_docs/kbn_es_types.mdx index dddec260174fd..526f2ef2ce39f 100644 --- a/api_docs/kbn_es_types.mdx +++ b/api_docs/kbn_es_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-types title: "@kbn/es-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-types plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-types'] --- import kbnEsTypesObj from './kbn_es_types.devdocs.json'; diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index 3a25d32f1961e..6479955dc3dc8 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/eslint-plugin-imports plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] --- import kbnEslintPluginImportsObj from './kbn_eslint_plugin_imports.devdocs.json'; diff --git a/api_docs/kbn_expandable_flyout.devdocs.json b/api_docs/kbn_expandable_flyout.devdocs.json index 9658f381fd343..1590d2e5ac52d 100644 --- a/api_docs/kbn_expandable_flyout.devdocs.json +++ b/api_docs/kbn_expandable_flyout.devdocs.json @@ -26,7 +26,7 @@ "tags": [], "label": "ExpandableFlyout", "description": [ - "\nExpandable flyout UI React component.\nDisplays 3 sections (right, left, preview) depending on the panels in the context." + "\nExpandable flyout UI React component.\nDisplays 3 sections (right, left, preview) depending on the panels in the context.\n\nThe behavior expects that the left and preview sections should only be displayed is a right section\nis already rendered." ], "signature": [ "{ ({ registeredPanels, handleOnFlyoutClosed, ...flyoutProps }: React.PropsWithChildren<", diff --git a/api_docs/kbn_expandable_flyout.mdx b/api_docs/kbn_expandable_flyout.mdx index 4f4d8cc9574fc..5256a652f17b6 100644 --- a/api_docs/kbn_expandable_flyout.mdx +++ b/api_docs/kbn_expandable_flyout.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-expandable-flyout title: "@kbn/expandable-flyout" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/expandable-flyout plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/expandable-flyout'] --- import kbnExpandableFlyoutObj from './kbn_expandable_flyout.devdocs.json'; diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index 3a92dc6c0f584..d2c48ab739fa7 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/field-types plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] --- import kbnFieldTypesObj from './kbn_field_types.devdocs.json'; diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index ecb34812c84af..a238b4efadf48 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/find-used-node-modules plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] --- import kbnFindUsedNodeModulesObj from './kbn_find_used_node_modules.devdocs.json'; diff --git a/api_docs/kbn_ftr_common_functional_services.mdx b/api_docs/kbn_ftr_common_functional_services.mdx index 37844647671d9..1a7b17a879fd5 100644 --- a/api_docs/kbn_ftr_common_functional_services.mdx +++ b/api_docs/kbn_ftr_common_functional_services.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ftr-common-functional-services title: "@kbn/ftr-common-functional-services" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ftr-common-functional-services plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ftr-common-functional-services'] --- import kbnFtrCommonFunctionalServicesObj from './kbn_ftr_common_functional_services.devdocs.json'; diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index 5450e6f81149b..3a860c570fa7b 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] --- import kbnGenerateObj from './kbn_generate.devdocs.json'; diff --git a/api_docs/kbn_guided_onboarding.devdocs.json b/api_docs/kbn_guided_onboarding.devdocs.json index 41b2b81986fe2..ec142f58f5b6c 100644 --- a/api_docs/kbn_guided_onboarding.devdocs.json +++ b/api_docs/kbn_guided_onboarding.devdocs.json @@ -62,7 +62,9 @@ "label": "GuideFilters", "description": [], "signature": [ - "({ activeFilter, setActiveFilter }: GuideFiltersProps) => JSX.Element" + "({ activeFilter, setActiveFilter, application }: ", + "GuideFiltersProps", + ") => JSX.Element" ], "path": "packages/kbn-guided-onboarding/src/components/landing_page/guide_filters.tsx", "deprecated": false, @@ -73,7 +75,7 @@ "id": "def-common.GuideFilters.$1", "type": "Object", "tags": [], - "label": "{ activeFilter, setActiveFilter }", + "label": "{ activeFilter, setActiveFilter, application }", "description": [], "signature": [ "GuideFiltersProps" diff --git a/api_docs/kbn_guided_onboarding.mdx b/api_docs/kbn_guided_onboarding.mdx index e6dee2cfba7fc..8805c59032516 100644 --- a/api_docs/kbn_guided_onboarding.mdx +++ b/api_docs/kbn_guided_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-guided-onboarding title: "@kbn/guided-onboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/guided-onboarding plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/guided-onboarding'] --- import kbnGuidedOnboardingObj from './kbn_guided_onboarding.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/pla | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 52 | 0 | 50 | 2 | +| 52 | 0 | 50 | 3 | ## Common diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index cfca5b3e6658d..76f707a31b612 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/handlebars plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] --- import kbnHandlebarsObj from './kbn_handlebars.devdocs.json'; diff --git a/api_docs/kbn_hapi_mocks.mdx b/api_docs/kbn_hapi_mocks.mdx index c897e0905d794..f0887920be21a 100644 --- a/api_docs/kbn_hapi_mocks.mdx +++ b/api_docs/kbn_hapi_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-hapi-mocks title: "@kbn/hapi-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/hapi-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/hapi-mocks'] --- import kbnHapiMocksObj from './kbn_hapi_mocks.devdocs.json'; diff --git a/api_docs/kbn_health_gateway_server.mdx b/api_docs/kbn_health_gateway_server.mdx index 1dbe0f25402cc..b3b7a83c5b58e 100644 --- a/api_docs/kbn_health_gateway_server.mdx +++ b/api_docs/kbn_health_gateway_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-health-gateway-server title: "@kbn/health-gateway-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/health-gateway-server plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/health-gateway-server'] --- import kbnHealthGatewayServerObj from './kbn_health_gateway_server.devdocs.json'; diff --git a/api_docs/kbn_home_sample_data_card.mdx b/api_docs/kbn_home_sample_data_card.mdx index 36ae196ca3eec..3ee38222d43e0 100644 --- a/api_docs/kbn_home_sample_data_card.mdx +++ b/api_docs/kbn_home_sample_data_card.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-card title: "@kbn/home-sample-data-card" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/home-sample-data-card plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-card'] --- import kbnHomeSampleDataCardObj from './kbn_home_sample_data_card.devdocs.json'; diff --git a/api_docs/kbn_home_sample_data_tab.mdx b/api_docs/kbn_home_sample_data_tab.mdx index 4b0aca6890c43..1f948ff0bdd79 100644 --- a/api_docs/kbn_home_sample_data_tab.mdx +++ b/api_docs/kbn_home_sample_data_tab.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-tab title: "@kbn/home-sample-data-tab" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/home-sample-data-tab plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-tab'] --- import kbnHomeSampleDataTabObj from './kbn_home_sample_data_tab.devdocs.json'; diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index e878823ee7f63..865d8400cabad 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/i18n plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] --- import kbnI18nObj from './kbn_i18n.devdocs.json'; diff --git a/api_docs/kbn_i18n_react.mdx b/api_docs/kbn_i18n_react.mdx index 9986325b26826..8449cf399aec5 100644 --- a/api_docs/kbn_i18n_react.mdx +++ b/api_docs/kbn_i18n_react.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n-react title: "@kbn/i18n-react" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/i18n-react plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n-react'] --- import kbnI18nReactObj from './kbn_i18n_react.devdocs.json'; diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index b0d7ce6828675..1d3273f13a359 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/import-resolver plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] --- import kbnImportResolverObj from './kbn_import_resolver.devdocs.json'; diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index cfe6899bf32c7..3e053f4445df0 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/interpreter plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] --- import kbnInterpreterObj from './kbn_interpreter.devdocs.json'; diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index cee38be50e8d8..0e14c42b991ae 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/io-ts-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] --- import kbnIoTsUtilsObj from './kbn_io_ts_utils.devdocs.json'; diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index 6f106fc73c53d..31631dbb0844d 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/jest-serializers plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] --- import kbnJestSerializersObj from './kbn_jest_serializers.devdocs.json'; diff --git a/api_docs/kbn_journeys.mdx b/api_docs/kbn_journeys.mdx index 8c4efb6871a7c..c03df965b7934 100644 --- a/api_docs/kbn_journeys.mdx +++ b/api_docs/kbn_journeys.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-journeys title: "@kbn/journeys" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/journeys plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/journeys'] --- import kbnJourneysObj from './kbn_journeys.devdocs.json'; diff --git a/api_docs/kbn_json_ast.mdx b/api_docs/kbn_json_ast.mdx index 1ee97d4b92020..21f63edd28c18 100644 --- a/api_docs/kbn_json_ast.mdx +++ b/api_docs/kbn_json_ast.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-json-ast title: "@kbn/json-ast" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/json-ast plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/json-ast'] --- import kbnJsonAstObj from './kbn_json_ast.devdocs.json'; diff --git a/api_docs/kbn_kibana_manifest_schema.mdx b/api_docs/kbn_kibana_manifest_schema.mdx index 650605c702e6e..104c8ae655762 100644 --- a/api_docs/kbn_kibana_manifest_schema.mdx +++ b/api_docs/kbn_kibana_manifest_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-manifest-schema title: "@kbn/kibana-manifest-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/kibana-manifest-schema plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-manifest-schema'] --- import kbnKibanaManifestSchemaObj from './kbn_kibana_manifest_schema.devdocs.json'; diff --git a/api_docs/kbn_language_documentation_popover.mdx b/api_docs/kbn_language_documentation_popover.mdx index 8cfd4297c048c..351c4399ed6d4 100644 --- a/api_docs/kbn_language_documentation_popover.mdx +++ b/api_docs/kbn_language_documentation_popover.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-language-documentation-popover title: "@kbn/language-documentation-popover" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/language-documentation-popover plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/language-documentation-popover'] --- import kbnLanguageDocumentationPopoverObj from './kbn_language_documentation_popover.devdocs.json'; diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index a1094c90c6de5..b624e9a79b351 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/logging plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] --- import kbnLoggingObj from './kbn_logging.devdocs.json'; diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index 12c92349a7b49..a0ee23cb73274 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/logging-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] --- import kbnLoggingMocksObj from './kbn_logging_mocks.devdocs.json'; diff --git a/api_docs/kbn_managed_vscode_config.mdx b/api_docs/kbn_managed_vscode_config.mdx index f01d29f665a05..9a48e7a1a6d88 100644 --- a/api_docs/kbn_managed_vscode_config.mdx +++ b/api_docs/kbn_managed_vscode_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-managed-vscode-config title: "@kbn/managed-vscode-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/managed-vscode-config plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/managed-vscode-config'] --- import kbnManagedVscodeConfigObj from './kbn_managed_vscode_config.devdocs.json'; diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 0ce25bd159eda..96acfb95fb4e6 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/mapbox-gl plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] --- import kbnMapboxGlObj from './kbn_mapbox_gl.devdocs.json'; diff --git a/api_docs/kbn_ml_agg_utils.devdocs.json b/api_docs/kbn_ml_agg_utils.devdocs.json index 29a46d1fc64a1..66853f1a777b1 100644 --- a/api_docs/kbn_ml_agg_utils.devdocs.json +++ b/api_docs/kbn_ml_agg_utils.devdocs.json @@ -514,6 +514,114 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-common.isCounterTimeSeriesMetric", + "type": "Function", + "tags": [], + "label": "isCounterTimeSeriesMetric", + "description": [ + "\nCheck if DataViewField is a 'counter' time series metric field" + ], + "signature": [ + "(field?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined) => boolean" + ], + "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-common.isCounterTimeSeriesMetric.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [ + "optional DataViewField" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "a boolean" + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-common.isGaugeTimeSeriesMetric", + "type": "Function", + "tags": [], + "label": "isGaugeTimeSeriesMetric", + "description": [ + "\nCheck if DataViewField is a 'gauge' time series metric field" + ], + "signature": [ + "(field?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined) => boolean" + ], + "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-common.isGaugeTimeSeriesMetric.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [ + "optional DataViewField" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewField", + "text": "DataViewField" + }, + " | undefined" + ], + "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "a boolean" + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.numberValidator", @@ -1430,7 +1538,22 @@ "initialIsOpen": false } ], - "enums": [], + "enums": [ + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-common.TIME_SERIES_METRIC_TYPES", + "type": "Enum", + "tags": [], + "label": "TIME_SERIES_METRIC_TYPES", + "description": [ + "\nAll available types for time series metric fields" + ], + "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], "misc": [ { "parentPluginId": "@kbn/ml-agg-utils", diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx index 83f35f27f4668..3dd15e856743f 100644 --- a/api_docs/kbn_ml_agg_utils.mdx +++ b/api_docs/kbn_ml_agg_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-agg-utils title: "@kbn/ml-agg-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-agg-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-agg-utils'] --- import kbnMlAggUtilsObj from './kbn_ml_agg_utils.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questi | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 87 | 2 | 63 | 0 | +| 92 | 2 | 63 | 0 | ## Common @@ -31,6 +31,9 @@ Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questi ### Interfaces +### Enums + + ### Consts, variables and types diff --git a/api_docs/kbn_ml_date_picker.mdx b/api_docs/kbn_ml_date_picker.mdx index d823c3dc459d3..f2a025ef917a4 100644 --- a/api_docs/kbn_ml_date_picker.mdx +++ b/api_docs/kbn_ml_date_picker.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-date-picker title: "@kbn/ml-date-picker" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-date-picker plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-date-picker'] --- import kbnMlDatePickerObj from './kbn_ml_date_picker.devdocs.json'; diff --git a/api_docs/kbn_ml_is_defined.mdx b/api_docs/kbn_ml_is_defined.mdx index ffbed456fb730..0537024697052 100644 --- a/api_docs/kbn_ml_is_defined.mdx +++ b/api_docs/kbn_ml_is_defined.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-defined title: "@kbn/ml-is-defined" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-is-defined plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-defined'] --- import kbnMlIsDefinedObj from './kbn_ml_is_defined.devdocs.json'; diff --git a/api_docs/kbn_ml_is_populated_object.mdx b/api_docs/kbn_ml_is_populated_object.mdx index f223d8f395883..53ad9f8a70238 100644 --- a/api_docs/kbn_ml_is_populated_object.mdx +++ b/api_docs/kbn_ml_is_populated_object.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-populated-object title: "@kbn/ml-is-populated-object" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-is-populated-object plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-populated-object'] --- import kbnMlIsPopulatedObjectObj from './kbn_ml_is_populated_object.devdocs.json'; diff --git a/api_docs/kbn_ml_local_storage.mdx b/api_docs/kbn_ml_local_storage.mdx index 132db76cdb3ff..8d856cbc86e5a 100644 --- a/api_docs/kbn_ml_local_storage.mdx +++ b/api_docs/kbn_ml_local_storage.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-local-storage title: "@kbn/ml-local-storage" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-local-storage plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-local-storage'] --- import kbnMlLocalStorageObj from './kbn_ml_local_storage.devdocs.json'; diff --git a/api_docs/kbn_ml_nested_property.mdx b/api_docs/kbn_ml_nested_property.mdx index 4a973314890ec..5dde64d3bee21 100644 --- a/api_docs/kbn_ml_nested_property.mdx +++ b/api_docs/kbn_ml_nested_property.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-nested-property title: "@kbn/ml-nested-property" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-nested-property plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-nested-property'] --- import kbnMlNestedPropertyObj from './kbn_ml_nested_property.devdocs.json'; diff --git a/api_docs/kbn_ml_query_utils.mdx b/api_docs/kbn_ml_query_utils.mdx index 1d92e8079012d..eb89062df4831 100644 --- a/api_docs/kbn_ml_query_utils.mdx +++ b/api_docs/kbn_ml_query_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-query-utils title: "@kbn/ml-query-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-query-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-query-utils'] --- import kbnMlQueryUtilsObj from './kbn_ml_query_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_route_utils.mdx b/api_docs/kbn_ml_route_utils.mdx index b60cff3650333..f5136e9600eb5 100644 --- a/api_docs/kbn_ml_route_utils.mdx +++ b/api_docs/kbn_ml_route_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-route-utils title: "@kbn/ml-route-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-route-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-route-utils'] --- import kbnMlRouteUtilsObj from './kbn_ml_route_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx index c0ed7721f1a68..8ad39399a1914 100644 --- a/api_docs/kbn_ml_string_hash.mdx +++ b/api_docs/kbn_ml_string_hash.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-string-hash title: "@kbn/ml-string-hash" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-string-hash plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-string-hash'] --- import kbnMlStringHashObj from './kbn_ml_string_hash.devdocs.json'; diff --git a/api_docs/kbn_ml_trained_models_utils.mdx b/api_docs/kbn_ml_trained_models_utils.mdx index cbf65b41171f4..8eb1061441f49 100644 --- a/api_docs/kbn_ml_trained_models_utils.mdx +++ b/api_docs/kbn_ml_trained_models_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-trained-models-utils title: "@kbn/ml-trained-models-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-trained-models-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-trained-models-utils'] --- import kbnMlTrainedModelsUtilsObj from './kbn_ml_trained_models_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_url_state.mdx b/api_docs/kbn_ml_url_state.mdx index 9b465f212789f..055c6d13da098 100644 --- a/api_docs/kbn_ml_url_state.mdx +++ b/api_docs/kbn_ml_url_state.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-url-state title: "@kbn/ml-url-state" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-url-state plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-url-state'] --- import kbnMlUrlStateObj from './kbn_ml_url_state.devdocs.json'; diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index 346cc871f2645..f9bc2fc47b7dd 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/monaco plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] --- import kbnMonacoObj from './kbn_monaco.devdocs.json'; diff --git a/api_docs/kbn_object_versioning.devdocs.json b/api_docs/kbn_object_versioning.devdocs.json index 0a448f8b89991..72a1ca0e87465 100644 --- a/api_docs/kbn_object_versioning.devdocs.json +++ b/api_docs/kbn_object_versioning.devdocs.json @@ -197,7 +197,7 @@ "\nInitiate a transform for a specific request version. After we initiate the transforms\nfor a specific version we can then pass different `ObjectMigrationDefinition` to the provided\nhandler to start up/down transforming different object based on this request version.\n" ], "signature": [ - "(requestVersion: number) => (migrationDefinition: ", + "(requestVersion: number) => (migrationDefinition: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -213,7 +213,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "" + "" ], "path": "packages/kbn-object-versioning/lib/object_transform.ts", "deprecated": false, @@ -260,7 +260,7 @@ "id": "def-common.ObjectMigrationDefinition.Unnamed", "type": "IndexSignature", "tags": [], - "label": "[version: number]: VersionableObject", + "label": "[version: number]: VersionableObject", "description": [], "signature": [ "[version: number]: ", @@ -271,7 +271,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - "" + "" ], "path": "packages/kbn-object-versioning/lib/types.ts", "deprecated": false, @@ -295,7 +295,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "" + "" ], "path": "packages/kbn-object-versioning/lib/types.ts", "deprecated": false, @@ -309,7 +309,7 @@ "label": "up", "description": [], "signature": [ - "(obj: Current, version?: number | \"latest\" | undefined, options?: { validate?: boolean | undefined; } | undefined) => ", + "(obj: UpIn, version?: number | \"latest\" | undefined, options?: { validate?: boolean | undefined; } | undefined) => ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -317,7 +317,7 @@ "section": "def-common.TransformReturn", "text": "TransformReturn" }, - "" + "" ], "path": "packages/kbn-object-versioning/lib/types.ts", "deprecated": false, @@ -331,7 +331,7 @@ "label": "obj", "description": [], "signature": [ - "Current" + "UpIn" ], "path": "packages/kbn-object-versioning/lib/types.ts", "deprecated": false, @@ -393,7 +393,7 @@ "label": "down", "description": [], "signature": [ - "(obj: Current, version?: number | \"latest\" | undefined, options?: { validate?: boolean | undefined; } | undefined) => ", + "(obj: DownIn, version?: number | \"latest\" | undefined, options?: { validate?: boolean | undefined; } | undefined) => ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -401,7 +401,7 @@ "section": "def-common.TransformReturn", "text": "TransformReturn" }, - "" + "" ], "path": "packages/kbn-object-versioning/lib/types.ts", "deprecated": false, @@ -415,7 +415,7 @@ "label": "obj", "description": [], "signature": [ - "Current" + "DownIn" ], "path": "packages/kbn-object-versioning/lib/types.ts", "deprecated": false, @@ -589,7 +589,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; out?: { result?: ", + " | undefined; } | undefined; out?: { result?: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -597,7 +597,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; } | undefined" + " | undefined; } | undefined; } | undefined" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -619,7 +619,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; out?: { result?: ", + " | undefined; } | undefined; out?: { result?: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -627,7 +627,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; } | undefined" + " | undefined; } | undefined; } | undefined" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -649,7 +649,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; options?: ", + " | undefined; options?: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -657,7 +657,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; out?: { result?: ", + " | undefined; } | undefined; out?: { result?: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -665,7 +665,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; } | undefined" + " | undefined; } | undefined; } | undefined" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -687,7 +687,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; options?: ", + " | undefined; options?: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -695,7 +695,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; out?: { result?: ", + " | undefined; } | undefined; out?: { result?: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -703,7 +703,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; } | undefined" + " | undefined; } | undefined; } | undefined" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -725,7 +725,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; out?: { result?: ", + " | undefined; } | undefined; out?: { result?: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -733,7 +733,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; } | undefined" + " | undefined; } | undefined; } | undefined" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -747,15 +747,7 @@ "label": "search", "description": [], "signature": [ - "{ in?: { query?: ", - { - "pluginId": "@kbn/object-versioning", - "scope": "common", - "docId": "kibKbnObjectVersioningPluginApi", - "section": "def-common.VersionableObject", - "text": "VersionableObject" - }, - " | undefined; options?: ", + "{ in?: { options?: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -763,7 +755,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; out?: { result?: ", + " | undefined; } | undefined; out?: { result?: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -771,7 +763,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - " | undefined; } | undefined; } | undefined" + " | undefined; } | undefined; } | undefined" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -807,7 +799,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; out: { result: ", + "; }; out: { result: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -815,7 +807,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; }" + "; }; }" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -837,7 +829,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; out: { result: ", + "; }; out: { result: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -845,7 +837,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; }" + "; }; }" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -867,7 +859,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; options: ", + "; options: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -875,7 +867,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; out: { result: ", + "; }; out: { result: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -883,7 +875,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; }" + "; }; }" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -905,7 +897,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; options: ", + "; options: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -913,7 +905,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; out: { result: ", + "; }; out: { result: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -921,7 +913,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; }" + "; }; }" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -943,7 +935,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; out: { result: ", + "; }; out: { result: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -951,7 +943,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; }" + "; }; }" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -965,15 +957,7 @@ "label": "search", "description": [], "signature": [ - "{ in: { query: ", - { - "pluginId": "@kbn/object-versioning", - "scope": "common", - "docId": "kibKbnObjectVersioningPluginApi", - "section": "def-common.ObjectTransforms", - "text": "ObjectTransforms" - }, - "; options: ", + "{ in: { options: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -981,7 +965,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; out: { result: ", + "; }; out: { result: ", { "pluginId": "@kbn/object-versioning", "scope": "common", @@ -989,7 +973,7 @@ "section": "def-common.ObjectTransforms", "text": "ObjectTransforms" }, - "; }; }" + "; }; }" ], "path": "packages/kbn-object-versioning/lib/content_management_types.ts", "deprecated": false, @@ -1013,7 +997,7 @@ "section": "def-common.VersionableObject", "text": "VersionableObject" }, - "" + "" ], "path": "packages/kbn-object-versioning/lib/types.ts", "deprecated": false, @@ -1055,7 +1039,7 @@ "section": "def-common.ObjectTransform", "text": "ObjectTransform" }, - " | undefined" + " | undefined" ], "path": "packages/kbn-object-versioning/lib/types.ts", "deprecated": false, @@ -1076,7 +1060,7 @@ "section": "def-common.ObjectTransform", "text": "ObjectTransform" }, - " | undefined" + " | undefined" ], "path": "packages/kbn-object-versioning/lib/types.ts", "deprecated": false, diff --git a/api_docs/kbn_object_versioning.mdx b/api_docs/kbn_object_versioning.mdx index 3ab87768c663a..5f6bfd4def967 100644 --- a/api_docs/kbn_object_versioning.mdx +++ b/api_docs/kbn_object_versioning.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-object-versioning title: "@kbn/object-versioning" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/object-versioning plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/object-versioning'] --- import kbnObjectVersioningObj from './kbn_object_versioning.devdocs.json'; diff --git a/api_docs/kbn_observability_alert_details.devdocs.json b/api_docs/kbn_observability_alert_details.devdocs.json new file mode 100644 index 0000000000000..a7f16d862b6d7 --- /dev/null +++ b/api_docs/kbn_observability_alert_details.devdocs.json @@ -0,0 +1,143 @@ +{ + "id": "@kbn/observability-alert-details", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/observability-alert-details", + "id": "def-common.AlertActiveTimeRangeAnnotation", + "type": "Function", + "tags": [], + "label": "AlertActiveTimeRangeAnnotation", + "description": [], + "signature": [ + "({ alertStart, alertEnd, color, id }: Props) => JSX.Element" + ], + "path": "x-pack/packages/observability/alert_details/src/components/alert_active_time_range_annotation.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/observability-alert-details", + "id": "def-common.AlertActiveTimeRangeAnnotation.$1", + "type": "Object", + "tags": [], + "label": "{ alertStart, alertEnd, color, id }", + "description": [], + "signature": [ + "Props" + ], + "path": "x-pack/packages/observability/alert_details/src/components/alert_active_time_range_annotation.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/observability-alert-details", + "id": "def-common.AlertAnnotation", + "type": "Function", + "tags": [], + "label": "AlertAnnotation", + "description": [], + "signature": [ + "({ alertStart, color, dateFormat, id }: Props) => JSX.Element" + ], + "path": "x-pack/packages/observability/alert_details/src/components/alert_annotation.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/observability-alert-details", + "id": "def-common.AlertAnnotation.$1", + "type": "Object", + "tags": [], + "label": "{ alertStart, color, dateFormat, id }", + "description": [], + "signature": [ + "Props" + ], + "path": "x-pack/packages/observability/alert_details/src/components/alert_annotation.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/observability-alert-details", + "id": "def-common.getPaddedAlertTimeRange", + "type": "Function", + "tags": [], + "label": "getPaddedAlertTimeRange", + "description": [], + "signature": [ + "(alertStart: string, alertEnd?: string | undefined) => ", + "TimeRange" + ], + "path": "x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/observability-alert-details", + "id": "def-common.getPaddedAlertTimeRange.$1", + "type": "string", + "tags": [], + "label": "alertStart", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/observability-alert-details", + "id": "def-common.getPaddedAlertTimeRange.$2", + "type": "string", + "tags": [], + "label": "alertEnd", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_observability_alert_details.mdx b/api_docs/kbn_observability_alert_details.mdx new file mode 100644 index 0000000000000..4a5484c1d225c --- /dev/null +++ b/api_docs/kbn_observability_alert_details.mdx @@ -0,0 +1,30 @@ +--- +#### +#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system. +#### Reach out in #docs-engineering for more info. +#### +id: kibKbnObservabilityAlertDetailsPluginApi +slug: /kibana-dev-docs/api/kbn-observability-alert-details +title: "@kbn/observability-alert-details" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/observability-alert-details plugin +date: 2023-04-10 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-alert-details'] +--- +import kbnObservabilityAlertDetailsObj from './kbn_observability_alert_details.devdocs.json'; + + + +Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 7 | 0 | 7 | 1 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 123e9514378cb..4cf8828a56dc6 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/optimizer plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] --- import kbnOptimizerObj from './kbn_optimizer.devdocs.json'; diff --git a/api_docs/kbn_optimizer_webpack_helpers.mdx b/api_docs/kbn_optimizer_webpack_helpers.mdx index a9558836ebceb..b89ec718a590e 100644 --- a/api_docs/kbn_optimizer_webpack_helpers.mdx +++ b/api_docs/kbn_optimizer_webpack_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers title: "@kbn/optimizer-webpack-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/optimizer-webpack-helpers plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer-webpack-helpers'] --- import kbnOptimizerWebpackHelpersObj from './kbn_optimizer_webpack_helpers.devdocs.json'; diff --git a/api_docs/kbn_osquery_io_ts_types.mdx b/api_docs/kbn_osquery_io_ts_types.mdx index 790b95ef62920..9a47a64a5fa83 100644 --- a/api_docs/kbn_osquery_io_ts_types.mdx +++ b/api_docs/kbn_osquery_io_ts_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-osquery-io-ts-types title: "@kbn/osquery-io-ts-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/osquery-io-ts-types plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/osquery-io-ts-types'] --- import kbnOsqueryIoTsTypesObj from './kbn_osquery_io_ts_types.devdocs.json'; diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index a45e2cb8ba428..64681bef13804 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] --- import kbnPerformanceTestingDatasetExtractorObj from './kbn_performance_testing_dataset_extractor.devdocs.json'; diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index ad08d92f254f7..4a1c2c10742a9 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/plugin-generator plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] --- import kbnPluginGeneratorObj from './kbn_plugin_generator.devdocs.json'; diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index fe49933a5e492..660117f3b9c53 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/plugin-helpers plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] --- import kbnPluginHelpersObj from './kbn_plugin_helpers.devdocs.json'; diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index ca814cbf91440..b14427112834f 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-field plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] --- import kbnReactFieldObj from './kbn_react_field.devdocs.json'; diff --git a/api_docs/kbn_repo_file_maps.mdx b/api_docs/kbn_repo_file_maps.mdx index f8cbbacb07e7d..254d043185c33 100644 --- a/api_docs/kbn_repo_file_maps.mdx +++ b/api_docs/kbn_repo_file_maps.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-file-maps title: "@kbn/repo-file-maps" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-file-maps plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-file-maps'] --- import kbnRepoFileMapsObj from './kbn_repo_file_maps.devdocs.json'; diff --git a/api_docs/kbn_repo_linter.mdx b/api_docs/kbn_repo_linter.mdx index 248852169f687..900337e05a018 100644 --- a/api_docs/kbn_repo_linter.mdx +++ b/api_docs/kbn_repo_linter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-linter title: "@kbn/repo-linter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-linter plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-linter'] --- import kbnRepoLinterObj from './kbn_repo_linter.devdocs.json'; diff --git a/api_docs/kbn_repo_path.mdx b/api_docs/kbn_repo_path.mdx index 0e27d3fcb0da9..4ba3693133794 100644 --- a/api_docs/kbn_repo_path.mdx +++ b/api_docs/kbn_repo_path.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-path title: "@kbn/repo-path" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-path plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-path'] --- import kbnRepoPathObj from './kbn_repo_path.devdocs.json'; diff --git a/api_docs/kbn_repo_source_classifier.mdx b/api_docs/kbn_repo_source_classifier.mdx index adcf5bba68728..e41168225e8fc 100644 --- a/api_docs/kbn_repo_source_classifier.mdx +++ b/api_docs/kbn_repo_source_classifier.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-source-classifier title: "@kbn/repo-source-classifier" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-source-classifier plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-source-classifier'] --- import kbnRepoSourceClassifierObj from './kbn_repo_source_classifier.devdocs.json'; diff --git a/api_docs/kbn_rison.mdx b/api_docs/kbn_rison.mdx index 6c3c10a497ab3..7d6e96bd8c822 100644 --- a/api_docs/kbn_rison.mdx +++ b/api_docs/kbn_rison.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rison title: "@kbn/rison" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rison plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rison'] --- import kbnRisonObj from './kbn_rison.devdocs.json'; diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 1d378bd2b282f..8fead9f6daead 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rule-data-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] --- import kbnRuleDataUtilsObj from './kbn_rule_data_utils.devdocs.json'; diff --git a/api_docs/kbn_security_solution_side_nav.mdx b/api_docs/kbn_security_solution_side_nav.mdx index 8106d532d822f..57310262bb5bb 100644 --- a/api_docs/kbn_security_solution_side_nav.mdx +++ b/api_docs/kbn_security_solution_side_nav.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-side-nav title: "@kbn/security-solution-side-nav" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-side-nav plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-side-nav'] --- import kbnSecuritySolutionSideNavObj from './kbn_security_solution_side_nav.devdocs.json'; diff --git a/api_docs/kbn_security_solution_storybook_config.mdx b/api_docs/kbn_security_solution_storybook_config.mdx index 4742833b2a8a0..80dce83d7a198 100644 --- a/api_docs/kbn_security_solution_storybook_config.mdx +++ b/api_docs/kbn_security_solution_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-storybook-config title: "@kbn/security-solution-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-storybook-config plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-storybook-config'] --- import kbnSecuritySolutionStorybookConfigObj from './kbn_security_solution_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index 58d30a293cd25..e3fc36ac7e15c 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] --- import kbnSecuritysolutionAutocompleteObj from './kbn_securitysolution_autocomplete.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_ecs.mdx b/api_docs/kbn_securitysolution_ecs.mdx index 21e4e9f34fa33..4c8f75a3a2184 100644 --- a/api_docs/kbn_securitysolution_ecs.mdx +++ b/api_docs/kbn_securitysolution_ecs.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-ecs title: "@kbn/securitysolution-ecs" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-ecs plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-ecs'] --- import kbnSecuritysolutionEcsObj from './kbn_securitysolution_ecs.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_es_utils.devdocs.json b/api_docs/kbn_securitysolution_es_utils.devdocs.json index 34dafefba3cab..19baa142ff863 100644 --- a/api_docs/kbn_securitysolution_es_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_es_utils.devdocs.json @@ -136,7 +136,7 @@ "signature": [ "(esClient: ", "ElasticsearchClient", - ", pattern: string, maxAttempts?: number) => Promise" + ", pattern: string, specifyAlias?: boolean, maxAttempts?: number) => Promise" ], "path": "packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts", "deprecated": false, @@ -175,6 +175,21 @@ { "parentPluginId": "@kbn/securitysolution-es-utils", "id": "def-common.deleteAllIndex.$3", + "type": "boolean", + "tags": [], + "label": "specifyAlias", + "description": [], + "signature": [ + "boolean" + ], + "path": "packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-common.deleteAllIndex.$4", "type": "number", "tags": [], "label": "maxAttempts", diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 63613f6466395..427ebccfb704f 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-es-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] --- import kbnSecuritysolutionEsUtilsObj from './kbn_securitysolution_es_utils.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/security-solution-platform](https://github.com/orgs/elastic/te | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 67 | 0 | 61 | 1 | +| 68 | 0 | 62 | 1 | ## Common diff --git a/api_docs/kbn_securitysolution_exception_list_components.mdx b/api_docs/kbn_securitysolution_exception_list_components.mdx index 7616e91aa670c..abe5e1c5238d0 100644 --- a/api_docs/kbn_securitysolution_exception_list_components.mdx +++ b/api_docs/kbn_securitysolution_exception_list_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-exception-list-components title: "@kbn/securitysolution-exception-list-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-exception-list-components plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-exception-list-components'] --- import kbnSecuritysolutionExceptionListComponentsObj from './kbn_securitysolution_exception_list_components.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_grouping.mdx b/api_docs/kbn_securitysolution_grouping.mdx index b73dea43983e3..6bfa377660e4d 100644 --- a/api_docs/kbn_securitysolution_grouping.mdx +++ b/api_docs/kbn_securitysolution_grouping.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-grouping title: "@kbn/securitysolution-grouping" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-grouping plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-grouping'] --- import kbnSecuritysolutionGroupingObj from './kbn_securitysolution_grouping.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 6be8b96d28af8..ba8be2f4afd2b 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] --- import kbnSecuritysolutionHookUtilsObj from './kbn_securitysolution_hook_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index 9de5e6b0030eb..8c444af249b48 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] --- import kbnSecuritysolutionIoTsAlertingTypesObj from './kbn_securitysolution_io_ts_alerting_types.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index 5637ae088f726..a9de2ac6b0ff9 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] --- import kbnSecuritysolutionIoTsListTypesObj from './kbn_securitysolution_io_ts_list_types.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index d513d0d441ed6..2095af63fef5d 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] --- import kbnSecuritysolutionIoTsTypesObj from './kbn_securitysolution_io_ts_types.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 63a3b6e74a026..2eb8d55552c45 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] --- import kbnSecuritysolutionIoTsUtilsObj from './kbn_securitysolution_io_ts_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index 6ed048c919ea1..4480c2b22dd3b 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-api plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] --- import kbnSecuritysolutionListApiObj from './kbn_securitysolution_list_api.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index dd6699658b525..d98a8436a766b 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-constants plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] --- import kbnSecuritysolutionListConstantsObj from './kbn_securitysolution_list_constants.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index 4b2451fcb9ccd..53cb71480e53c 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] --- import kbnSecuritysolutionListHooksObj from './kbn_securitysolution_list_hooks.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index 586f9cab9f4cc..e266802a0c3d8 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] --- import kbnSecuritysolutionListUtilsObj from './kbn_securitysolution_list_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 5e073cfc288a3..3edf96af9468a 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-rules plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] --- import kbnSecuritysolutionRulesObj from './kbn_securitysolution_rules.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index 7419d9b4c6972..e6c9f802b8b7c 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-t-grid plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] --- import kbnSecuritysolutionTGridObj from './kbn_securitysolution_t_grid.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index a5205c1519e21..202e07a00a857 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] --- import kbnSecuritysolutionUtilsObj from './kbn_securitysolution_utils.devdocs.json'; diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index 150bca56ad952..1f552b5aca2c9 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/server-http-tools plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] --- import kbnServerHttpToolsObj from './kbn_server_http_tools.devdocs.json'; diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index b0be3f7ec20d0..7208cef935f14 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/server-route-repository plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] --- import kbnServerRouteRepositoryObj from './kbn_server_route_repository.devdocs.json'; diff --git a/api_docs/kbn_shared_svg.mdx b/api_docs/kbn_shared_svg.mdx index dda8c7d110647..c2cc835cb1924 100644 --- a/api_docs/kbn_shared_svg.mdx +++ b/api_docs/kbn_shared_svg.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-svg title: "@kbn/shared-svg" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-svg plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-svg'] --- import kbnSharedSvgObj from './kbn_shared_svg.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_avatar_solution.mdx b/api_docs/kbn_shared_ux_avatar_solution.mdx index 4ee7805ad9a5c..63330f0ff6574 100644 --- a/api_docs/kbn_shared_ux_avatar_solution.mdx +++ b/api_docs/kbn_shared_ux_avatar_solution.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-avatar-solution title: "@kbn/shared-ux-avatar-solution" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-avatar-solution plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-avatar-solution'] --- import kbnSharedUxAvatarSolutionObj from './kbn_shared_ux_avatar_solution.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx b/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx index 99d5dceafd324..2114b58630d85 100644 --- a/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx +++ b/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-avatar-user-profile-components title: "@kbn/shared-ux-avatar-user-profile-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-avatar-user-profile-components plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-avatar-user-profile-components'] --- import kbnSharedUxAvatarUserProfileComponentsObj from './kbn_shared_ux_avatar_user_profile_components.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx index 4b6230398f498..2f7642a5c6ce3 100644 --- a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx +++ b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen title: "@kbn/shared-ux-button-exit-full-screen" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-exit-full-screen plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen'] --- import kbnSharedUxButtonExitFullScreenObj from './kbn_shared_ux_button_exit_full_screen.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx index 427fffd3f5f61..200a2c993d3b0 100644 --- a/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx +++ b/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen-mocks title: "@kbn/shared-ux-button-exit-full-screen-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-exit-full-screen-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen-mocks'] --- import kbnSharedUxButtonExitFullScreenMocksObj from './kbn_shared_ux_button_exit_full_screen_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx index d913228889d79..3aa428e1a74a9 100644 --- a/api_docs/kbn_shared_ux_button_toolbar.mdx +++ b/api_docs/kbn_shared_ux_button_toolbar.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-toolbar title: "@kbn/shared-ux-button-toolbar" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-toolbar plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar'] --- import kbnSharedUxButtonToolbarObj from './kbn_shared_ux_button_toolbar.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx index 2656264450b5f..c118417b287c3 100644 --- a/api_docs/kbn_shared_ux_card_no_data.mdx +++ b/api_docs/kbn_shared_ux_card_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data title: "@kbn/shared-ux-card-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-card-no-data plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data'] --- import kbnSharedUxCardNoDataObj from './kbn_shared_ux_card_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_card_no_data_mocks.mdx b/api_docs/kbn_shared_ux_card_no_data_mocks.mdx index f6f4bd9f7ea6b..f147e0cacfa3d 100644 --- a/api_docs/kbn_shared_ux_card_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_card_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data-mocks title: "@kbn/shared-ux-card-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-card-no-data-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data-mocks'] --- import kbnSharedUxCardNoDataMocksObj from './kbn_shared_ux_card_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_context.mdx b/api_docs/kbn_shared_ux_file_context.mdx index c037a1ecd38ea..8847452d7df1f 100644 --- a/api_docs/kbn_shared_ux_file_context.mdx +++ b/api_docs/kbn_shared_ux_file_context.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-context title: "@kbn/shared-ux-file-context" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-context plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-context'] --- import kbnSharedUxFileContextObj from './kbn_shared_ux_file_context.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_image.mdx b/api_docs/kbn_shared_ux_file_image.mdx index cd5723667da60..9eb76c5950b6a 100644 --- a/api_docs/kbn_shared_ux_file_image.mdx +++ b/api_docs/kbn_shared_ux_file_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image title: "@kbn/shared-ux-file-image" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-image plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-image'] --- import kbnSharedUxFileImageObj from './kbn_shared_ux_file_image.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_image_mocks.mdx b/api_docs/kbn_shared_ux_file_image_mocks.mdx index bebe2701494da..a2c8fb2c470b4 100644 --- a/api_docs/kbn_shared_ux_file_image_mocks.mdx +++ b/api_docs/kbn_shared_ux_file_image_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image-mocks title: "@kbn/shared-ux-file-image-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-image-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-image-mocks'] --- import kbnSharedUxFileImageMocksObj from './kbn_shared_ux_file_image_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_mocks.mdx b/api_docs/kbn_shared_ux_file_mocks.mdx index 57489edb17c28..c82adf72d8413 100644 --- a/api_docs/kbn_shared_ux_file_mocks.mdx +++ b/api_docs/kbn_shared_ux_file_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-mocks title: "@kbn/shared-ux-file-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-mocks'] --- import kbnSharedUxFileMocksObj from './kbn_shared_ux_file_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_picker.mdx b/api_docs/kbn_shared_ux_file_picker.mdx index a19bf1b202994..49c33cfd3b33a 100644 --- a/api_docs/kbn_shared_ux_file_picker.mdx +++ b/api_docs/kbn_shared_ux_file_picker.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-picker title: "@kbn/shared-ux-file-picker" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-picker plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-picker'] --- import kbnSharedUxFilePickerObj from './kbn_shared_ux_file_picker.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_types.mdx b/api_docs/kbn_shared_ux_file_types.mdx index aca5b7b33b53d..4c5eeb9d1d351 100644 --- a/api_docs/kbn_shared_ux_file_types.mdx +++ b/api_docs/kbn_shared_ux_file_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-types title: "@kbn/shared-ux-file-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-types plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-types'] --- import kbnSharedUxFileTypesObj from './kbn_shared_ux_file_types.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_upload.mdx b/api_docs/kbn_shared_ux_file_upload.mdx index dc21d9c827c40..c1bfb0590cf4b 100644 --- a/api_docs/kbn_shared_ux_file_upload.mdx +++ b/api_docs/kbn_shared_ux_file_upload.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-upload title: "@kbn/shared-ux-file-upload" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-upload plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-upload'] --- import kbnSharedUxFileUploadObj from './kbn_shared_ux_file_upload.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_util.mdx b/api_docs/kbn_shared_ux_file_util.mdx index 372f46b11e376..f9054c2dfe239 100644 --- a/api_docs/kbn_shared_ux_file_util.mdx +++ b/api_docs/kbn_shared_ux_file_util.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-util title: "@kbn/shared-ux-file-util" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-util plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-util'] --- import kbnSharedUxFileUtilObj from './kbn_shared_ux_file_util.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_link_redirect_app.mdx b/api_docs/kbn_shared_ux_link_redirect_app.mdx index 352014035db22..73b5d7bc0aec1 100644 --- a/api_docs/kbn_shared_ux_link_redirect_app.mdx +++ b/api_docs/kbn_shared_ux_link_redirect_app.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app title: "@kbn/shared-ux-link-redirect-app" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-link-redirect-app plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-link-redirect-app'] --- import kbnSharedUxLinkRedirectAppObj from './kbn_shared_ux_link_redirect_app.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx index ba5336cefd8a5..c65d64333c212 100644 --- a/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx +++ b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app-mocks title: "@kbn/shared-ux-link-redirect-app-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-link-redirect-app-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-link-redirect-app-mocks'] --- import kbnSharedUxLinkRedirectAppMocksObj from './kbn_shared_ux_link_redirect_app_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_markdown.mdx b/api_docs/kbn_shared_ux_markdown.mdx index 94a20a82027fa..0e49c67c2da03 100644 --- a/api_docs/kbn_shared_ux_markdown.mdx +++ b/api_docs/kbn_shared_ux_markdown.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown title: "@kbn/shared-ux-markdown" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-markdown plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-markdown'] --- import kbnSharedUxMarkdownObj from './kbn_shared_ux_markdown.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_markdown_mocks.mdx b/api_docs/kbn_shared_ux_markdown_mocks.mdx index 49a462f1f6990..d87e59b0213fd 100644 --- a/api_docs/kbn_shared_ux_markdown_mocks.mdx +++ b/api_docs/kbn_shared_ux_markdown_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown-mocks title: "@kbn/shared-ux-markdown-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-markdown-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-markdown-mocks'] --- import kbnSharedUxMarkdownMocksObj from './kbn_shared_ux_markdown_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx index a9e5381f91480..7f9d7fa9acdad 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data title: "@kbn/shared-ux-page-analytics-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data'] --- import kbnSharedUxPageAnalyticsNoDataObj from './kbn_shared_ux_page_analytics_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx index c193c6e2b5637..3984ee12d4d06 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data-mocks title: "@kbn/shared-ux-page-analytics-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-analytics-no-data-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data-mocks'] --- import kbnSharedUxPageAnalyticsNoDataMocksObj from './kbn_shared_ux_page_analytics_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx index 38269572b4a63..d5e7c92a62945 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data title: "@kbn/shared-ux-page-kibana-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-no-data plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data'] --- import kbnSharedUxPageKibanaNoDataObj from './kbn_shared_ux_page_kibana_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx index fcf4ee60d9f4e..8ccede5ae9a0d 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data-mocks title: "@kbn/shared-ux-page-kibana-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-no-data-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data-mocks'] --- import kbnSharedUxPageKibanaNoDataMocksObj from './kbn_shared_ux_page_kibana_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_template.mdx b/api_docs/kbn_shared_ux_page_kibana_template.mdx index 524b42e5e689b..cf1589d731af5 100644 --- a/api_docs/kbn_shared_ux_page_kibana_template.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_template.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template title: "@kbn/shared-ux-page-kibana-template" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-template plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-template'] --- import kbnSharedUxPageKibanaTemplateObj from './kbn_shared_ux_page_kibana_template.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx b/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx index 5321e4dcb73de..3550d5a96a020 100644 --- a/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template-mocks title: "@kbn/shared-ux-page-kibana-template-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-template-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-template-mocks'] --- import kbnSharedUxPageKibanaTemplateMocksObj from './kbn_shared_ux_page_kibana_template_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data.mdx b/api_docs/kbn_shared_ux_page_no_data.mdx index d660b047418b8..0236995257261 100644 --- a/api_docs/kbn_shared_ux_page_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data title: "@kbn/shared-ux-page-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data'] --- import kbnSharedUxPageNoDataObj from './kbn_shared_ux_page_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data_config.mdx b/api_docs/kbn_shared_ux_page_no_data_config.mdx index a89d1dab32a89..133843655e01f 100644 --- a/api_docs/kbn_shared_ux_page_no_data_config.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config title: "@kbn/shared-ux-page-no-data-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-config plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-config'] --- import kbnSharedUxPageNoDataConfigObj from './kbn_shared_ux_page_no_data_config.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx b/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx index 4d6e7558d71e8..0ff857095adcb 100644 --- a/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config-mocks title: "@kbn/shared-ux-page-no-data-config-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-config-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-config-mocks'] --- import kbnSharedUxPageNoDataConfigMocksObj from './kbn_shared_ux_page_no_data_config_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_no_data_mocks.mdx index 5f9e7f3bd4d44..38a989eecda5e 100644 --- a/api_docs/kbn_shared_ux_page_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-mocks title: "@kbn/shared-ux-page-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-mocks'] --- import kbnSharedUxPageNoDataMocksObj from './kbn_shared_ux_page_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_solution_nav.mdx b/api_docs/kbn_shared_ux_page_solution_nav.mdx index a8b991a2e71fd..e9fc57ef297ec 100644 --- a/api_docs/kbn_shared_ux_page_solution_nav.mdx +++ b/api_docs/kbn_shared_ux_page_solution_nav.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-solution-nav title: "@kbn/shared-ux-page-solution-nav" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-solution-nav plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-solution-nav'] --- import kbnSharedUxPageSolutionNavObj from './kbn_shared_ux_page_solution_nav.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx index 871b853d1f16f..75f823f2fdbbb 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views title: "@kbn/shared-ux-prompt-no-data-views" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-no-data-views plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views'] --- import kbnSharedUxPromptNoDataViewsObj from './kbn_shared_ux_prompt_no_data_views.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx index 81d949d667441..5cd3e60e40c95 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views-mocks title: "@kbn/shared-ux-prompt-no-data-views-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-no-data-views-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views-mocks'] --- import kbnSharedUxPromptNoDataViewsMocksObj from './kbn_shared_ux_prompt_no_data_views_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_prompt_not_found.mdx b/api_docs/kbn_shared_ux_prompt_not_found.mdx index 69480b545ae88..49cfc3a78d951 100644 --- a/api_docs/kbn_shared_ux_prompt_not_found.mdx +++ b/api_docs/kbn_shared_ux_prompt_not_found.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-not-found title: "@kbn/shared-ux-prompt-not-found" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-not-found plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-not-found'] --- import kbnSharedUxPromptNotFoundObj from './kbn_shared_ux_prompt_not_found.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_router.mdx b/api_docs/kbn_shared_ux_router.mdx index 5efb536c8de7b..682edb64335ef 100644 --- a/api_docs/kbn_shared_ux_router.mdx +++ b/api_docs/kbn_shared_ux_router.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router title: "@kbn/shared-ux-router" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-router plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router'] --- import kbnSharedUxRouterObj from './kbn_shared_ux_router.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_router_mocks.mdx b/api_docs/kbn_shared_ux_router_mocks.mdx index 4b17ecfc3442c..a922ce225ced1 100644 --- a/api_docs/kbn_shared_ux_router_mocks.mdx +++ b/api_docs/kbn_shared_ux_router_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router-mocks title: "@kbn/shared-ux-router-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-router-mocks plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router-mocks'] --- import kbnSharedUxRouterMocksObj from './kbn_shared_ux_router_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_storybook_config.mdx b/api_docs/kbn_shared_ux_storybook_config.mdx index e422d068414f1..55ce42597452b 100644 --- a/api_docs/kbn_shared_ux_storybook_config.mdx +++ b/api_docs/kbn_shared_ux_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-config title: "@kbn/shared-ux-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-storybook-config plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook-config'] --- import kbnSharedUxStorybookConfigObj from './kbn_shared_ux_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_storybook_mock.mdx b/api_docs/kbn_shared_ux_storybook_mock.mdx index 62d0b8974ec03..bc14cf5247021 100644 --- a/api_docs/kbn_shared_ux_storybook_mock.mdx +++ b/api_docs/kbn_shared_ux_storybook_mock.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-mock title: "@kbn/shared-ux-storybook-mock" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-storybook-mock plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook-mock'] --- import kbnSharedUxStorybookMockObj from './kbn_shared_ux_storybook_mock.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index 5cdcb62210935..4c109c2caad65 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-utility plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] --- import kbnSharedUxUtilityObj from './kbn_shared_ux_utility.devdocs.json'; diff --git a/api_docs/kbn_slo_schema.mdx b/api_docs/kbn_slo_schema.mdx index 541545d979eaa..b70df70e1345c 100644 --- a/api_docs/kbn_slo_schema.mdx +++ b/api_docs/kbn_slo_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-slo-schema title: "@kbn/slo-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/slo-schema plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/slo-schema'] --- import kbnSloSchemaObj from './kbn_slo_schema.devdocs.json'; diff --git a/api_docs/kbn_some_dev_log.mdx b/api_docs/kbn_some_dev_log.mdx index b0c031b8f4337..a143fe55225b7 100644 --- a/api_docs/kbn_some_dev_log.mdx +++ b/api_docs/kbn_some_dev_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-some-dev-log title: "@kbn/some-dev-log" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/some-dev-log plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/some-dev-log'] --- import kbnSomeDevLogObj from './kbn_some_dev_log.devdocs.json'; diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index 867c019b15bb6..44f8fd9f006c6 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/std plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] --- import kbnStdObj from './kbn_std.devdocs.json'; diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index 312d73e3e865c..50663330e3fd9 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/stdio-dev-helpers plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] --- import kbnStdioDevHelpersObj from './kbn_stdio_dev_helpers.devdocs.json'; diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index 9b94a19f8cd45..66e6510ca0cc7 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/storybook plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] --- import kbnStorybookObj from './kbn_storybook.devdocs.json'; diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index 71c1d56f7e104..719446cfac94c 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/telemetry-tools plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] --- import kbnTelemetryToolsObj from './kbn_telemetry_tools.devdocs.json'; diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index d1372767875c2..9ca3d831dadcc 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] --- import kbnTestObj from './kbn_test.devdocs.json'; diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index a1af043e7f0dd..c7b7a53fdb660 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test-jest-helpers plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] --- import kbnTestJestHelpersObj from './kbn_test_jest_helpers.devdocs.json'; diff --git a/api_docs/kbn_test_subj_selector.mdx b/api_docs/kbn_test_subj_selector.mdx index 924085cd098b7..d5f3989f38cbc 100644 --- a/api_docs/kbn_test_subj_selector.mdx +++ b/api_docs/kbn_test_subj_selector.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-subj-selector title: "@kbn/test-subj-selector" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test-subj-selector plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-subj-selector'] --- import kbnTestSubjSelectorObj from './kbn_test_subj_selector.devdocs.json'; diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index 727966ffdff8c..fc6bf4d66562b 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/tooling-log plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] --- import kbnToolingLogObj from './kbn_tooling_log.devdocs.json'; diff --git a/api_docs/kbn_ts_projects.mdx b/api_docs/kbn_ts_projects.mdx index 8f0f9f06ba3ec..af35b89754155 100644 --- a/api_docs/kbn_ts_projects.mdx +++ b/api_docs/kbn_ts_projects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ts-projects title: "@kbn/ts-projects" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ts-projects plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ts-projects'] --- import kbnTsProjectsObj from './kbn_ts_projects.devdocs.json'; diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index 68e7ee6fe69eb..241306bc27c7a 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/typed-react-router-config plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] --- import kbnTypedReactRouterConfigObj from './kbn_typed_react_router_config.devdocs.json'; diff --git a/api_docs/kbn_ui_actions_browser.mdx b/api_docs/kbn_ui_actions_browser.mdx index 91fb0c62bce05..7c39a4754f7c2 100644 --- a/api_docs/kbn_ui_actions_browser.mdx +++ b/api_docs/kbn_ui_actions_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-actions-browser title: "@kbn/ui-actions-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-actions-browser plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-actions-browser'] --- import kbnUiActionsBrowserObj from './kbn_ui_actions_browser.devdocs.json'; diff --git a/api_docs/kbn_ui_shared_deps_src.mdx b/api_docs/kbn_ui_shared_deps_src.mdx index 55127c49cb7ec..77cde55bf7799 100644 --- a/api_docs/kbn_ui_shared_deps_src.mdx +++ b/api_docs/kbn_ui_shared_deps_src.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-shared-deps-src title: "@kbn/ui-shared-deps-src" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-shared-deps-src plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-shared-deps-src'] --- import kbnUiSharedDepsSrcObj from './kbn_ui_shared_deps_src.devdocs.json'; diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index bf27420f12c88..0d3d41e06aed8 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-theme plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] --- import kbnUiThemeObj from './kbn_ui_theme.devdocs.json'; diff --git a/api_docs/kbn_user_profile_components.mdx b/api_docs/kbn_user_profile_components.mdx index a55dfef2dc2a4..abc04b7d373ba 100644 --- a/api_docs/kbn_user_profile_components.mdx +++ b/api_docs/kbn_user_profile_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-user-profile-components title: "@kbn/user-profile-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/user-profile-components plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/user-profile-components'] --- import kbnUserProfileComponentsObj from './kbn_user_profile_components.devdocs.json'; diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index 9832ba915be19..85605a0127522 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utility-types plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] --- import kbnUtilityTypesObj from './kbn_utility_types.devdocs.json'; diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index eab60af49fb79..1167ecfb2d1a7 100644 --- a/api_docs/kbn_utility_types_jest.mdx +++ b/api_docs/kbn_utility_types_jest.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest title: "@kbn/utility-types-jest" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utility-types-jest plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest'] --- import kbnUtilityTypesJestObj from './kbn_utility_types_jest.devdocs.json'; diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 124fc59809db8..b5d7e464f6867 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] --- import kbnUtilsObj from './kbn_utils.devdocs.json'; diff --git a/api_docs/kbn_yarn_lock_validator.mdx b/api_docs/kbn_yarn_lock_validator.mdx index 5d46d6d1eaf57..0073d03e1f54c 100644 --- a/api_docs/kbn_yarn_lock_validator.mdx +++ b/api_docs/kbn_yarn_lock_validator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-yarn-lock-validator title: "@kbn/yarn-lock-validator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/yarn-lock-validator plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/yarn-lock-validator'] --- import kbnYarnLockValidatorObj from './kbn_yarn_lock_validator.devdocs.json'; diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index ef8a96fc1c750..ab2e7b8404955 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaOverview plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] --- import kibanaOverviewObj from './kibana_overview.devdocs.json'; diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index fd8fe0137bedc..1fb58fa721f05 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaReact plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] --- import kibanaReactObj from './kibana_react.devdocs.json'; diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index 54f8422cc630a..3d0e23e907778 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaUtils plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] --- import kibanaUtilsObj from './kibana_utils.devdocs.json'; diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx index 32fd71d61230a..21f9bfb53f7a6 100644 --- a/api_docs/kubernetes_security.mdx +++ b/api_docs/kubernetes_security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity title: "kubernetesSecurity" image: https://source.unsplash.com/400x175/?github description: API docs for the kubernetesSecurity plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] --- import kubernetesSecurityObj from './kubernetes_security.devdocs.json'; diff --git a/api_docs/lens.devdocs.json b/api_docs/lens.devdocs.json index 6fc60d58d7d01..4e7a2c648a02e 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -3385,6 +3385,314 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState", + "type": "Interface", + "tags": [], + "label": "MetricVisualizationState", + "description": [], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.layerId", + "type": "string", + "tags": [], + "label": "layerId", + "description": [], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.layerType", + "type": "CompoundType", + "tags": [], + "label": "layerType", + "description": [], + "signature": [ + "\"data\" | \"annotations\" | \"metricTrendline\" | \"referenceLine\"" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.metricAccessor", + "type": "string", + "tags": [], + "label": "metricAccessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.secondaryMetricAccessor", + "type": "string", + "tags": [], + "label": "secondaryMetricAccessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.maxAccessor", + "type": "string", + "tags": [], + "label": "maxAccessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.breakdownByAccessor", + "type": "string", + "tags": [], + "label": "breakdownByAccessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.collapseFn", + "type": "CompoundType", + "tags": [], + "label": "collapseFn", + "description": [], + "signature": [ + "\"min\" | \"max\" | \"sum\" | \"avg\" | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.subtitle", + "type": "string", + "tags": [], + "label": "subtitle", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.secondaryPrefix", + "type": "string", + "tags": [], + "label": "secondaryPrefix", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.progressDirection", + "type": "CompoundType", + "tags": [], + "label": "progressDirection", + "description": [], + "signature": [ + "LayoutDirection", + " | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.showBar", + "type": "CompoundType", + "tags": [], + "label": "showBar", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.color", + "type": "string", + "tags": [], + "label": "color", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.palette", + "type": "Object", + "tags": [], + "label": "palette", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteOutput", + "text": "PaletteOutput" + }, + "<", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.CustomPaletteParams", + "text": "CustomPaletteParams" + }, + "> | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.maxCols", + "type": "number", + "tags": [], + "label": "maxCols", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.trendlineLayerId", + "type": "string", + "tags": [], + "label": "trendlineLayerId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.trendlineLayerType", + "type": "CompoundType", + "tags": [], + "label": "trendlineLayerType", + "description": [], + "signature": [ + "LayerType", + " | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.trendlineTimeAccessor", + "type": "string", + "tags": [], + "label": "trendlineTimeAccessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.trendlineMetricAccessor", + "type": "string", + "tags": [], + "label": "trendlineMetricAccessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.trendlineSecondaryMetricAccessor", + "type": "string", + "tags": [], + "label": "trendlineSecondaryMetricAccessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.MetricVisualizationState.trendlineBreakdownByAccessor", + "type": "string", + "tags": [], + "label": "trendlineBreakdownByAccessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/visualizations/metric/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "lens", "id": "def-public.OperationMetadata", @@ -3446,7 +3754,7 @@ "\nordinal: Each name is a unique value, but the names are in sorted order, like \"Top values\"\ninterval: Histogram data, like date or number histograms\nratio: Most number data is rendered as a ratio that includes 0" ], "signature": [ - "\"interval\" | \"ordinal\" | \"ratio\" | undefined" + "\"interval\" | \"ratio\" | \"ordinal\" | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3606,7 +3914,7 @@ "label": "shape", "description": [], "signature": [ - "\"pie\" | \"donut\" | \"treemap\" | \"mosaic\" | \"waffle\"" + "\"treemap\" | \"mosaic\" | \"waffle\" | \"pie\" | \"donut\"" ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false, @@ -4286,6 +4594,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "lens", + "id": "def-public.Suggestion.incomplete", + "type": "CompoundType", + "tags": [], + "label": "incomplete", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "lens", "id": "def-public.Suggestion.changeType", @@ -7336,6 +7658,22 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "lens", + "id": "def-public.VisualizationSuggestion.incomplete", + "type": "CompoundType", + "tags": [], + "label": "incomplete", + "description": [ + "\nFlag indicating whether this suggestion is incomplete" + ], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "lens", "id": "def-public.VisualizationSuggestion.title", @@ -7925,6 +8263,90 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYChartProps.overrides", + "type": "CompoundType", + "tags": [], + "label": "overrides", + "description": [], + "signature": [ + "(Partial> | undefined>; gridLine?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + " | undefined>; ticks?: number | undefined; domain?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "YDomainRange", + " | undefined>; position?: ", + "Position", + " | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; }>> & Partial | ", + "RecursivePartial", + "<", + "Theme", + ">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ", + "Position", + " | ", + "LegendPositionConfig", + " | undefined; rotation?: ", + "Rotation", + " | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", + "Rendering", + " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", + "MakeOverridesSerializable", + "<", + "ExternalPointerEventsSettings", + " | undefined>; pointBuffer?: ", + "MarkBuffer", + " | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ", + "PointerUpdateTrigger", + " | undefined; brushAxis?: ", + "BrushAxis", + " | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; xDomain?: ", + "MakeOverridesSerializable", + "<", + "CustomXDomain", + " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", + "LegendStrategy", + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>>) | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -9391,7 +9813,7 @@ "section": "def-common.DataView", "text": "DataView" }, - ") => ", + ", excludedVisualizations?: string[] | undefined) => ", { "pluginId": "lens", "scope": "public", @@ -9456,6 +9878,20 @@ "path": "x-pack/plugins/lens/public/plugin.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "lens", + "id": "def-public.LensSuggestionsApi.$3", + "type": "Array", + "tags": [], + "label": "excludedVisualizations", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/lens/public/plugin.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -9773,7 +10209,7 @@ "signature": [ "Omit<", "LensByValueInput", - ", \"attributes\"> & { attributes: LensAttributes<\"lnsXY\", ", + ", \"attributes\" | \"overrides\"> & { attributes: LensAttributes<\"lnsXY\", ", { "pluginId": "lens", "scope": "public", @@ -9783,6 +10219,22 @@ }, "> | LensAttributes<\"lnsPie\", ", "PieVisualizationState", + "> | LensAttributes<\"lnsHeatmap\", ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.HeatmapVisualizationState", + "text": "HeatmapVisualizationState" + }, + "> | LensAttributes<\"lnsGauge\", ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.GaugeVisualizationState", + "text": "GaugeVisualizationState" + }, "> | LensAttributes<\"lnsDatatable\", ", { "pluginId": "lens", @@ -9800,24 +10252,122 @@ "text": "LegacyMetricState" }, "> | LensAttributes<\"lnsMetric\", ", - "MetricVisualizationState", - "> | LensAttributes<\"lnsHeatmap\", ", { "pluginId": "lens", "scope": "public", "docId": "kibLensPluginApi", - "section": "def-public.HeatmapVisualizationState", - "text": "HeatmapVisualizationState" + "section": "def-public.MetricVisualizationState", + "text": "MetricVisualizationState" }, - "> | LensAttributes<\"lnsGauge\", ", + "> | LensAttributes; overrides?: Partial | ", + "RecursivePartial", + "<", + "Theme", + ">[] | undefined>; showLegend?: boolean | undefined; legendPosition?: ", + "Position", + " | ", + "LegendPositionConfig", + " | undefined; rotation?: ", + "Rotation", + " | undefined; ariaLabelHeadingLevel?: \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"p\" | undefined; ariaUseDefaultSummary?: boolean | undefined; flatLegend?: boolean | undefined; legendMaxDepth?: number | undefined; legendSize?: number | undefined; showLegendExtra?: boolean | undefined; rendering?: ", + "Rendering", + " | undefined; animateData?: boolean | undefined; externalPointerEvents?: ", + "MakeOverridesSerializable", + "<", + "ExternalPointerEventsSettings", + " | undefined>; pointBuffer?: ", + "MarkBuffer", + " | undefined; resizeDebounce?: number | undefined; pointerUpdateTrigger?: ", + "PointerUpdateTrigger", + " | undefined; brushAxis?: ", + "BrushAxis", + " | undefined; minBrushDelta?: number | undefined; allowBrushingLastHistogramBin?: boolean | undefined; ariaLabel?: string | undefined; xDomain?: ", + "MakeOverridesSerializable", + "<", + "CustomXDomain", + " | undefined>; ariaDescription?: string | undefined; ariaDescribedBy?: string | undefined; ariaLabelledBy?: string | undefined; ariaTableCaption?: string | undefined; legendAction?: \"ignore\" | undefined; legendStrategy?: ", + "LegendStrategy", + " | undefined; onLegendItemClick?: \"ignore\" | undefined; customLegend?: \"ignore\" | undefined; onLegendItemMinusClick?: \"ignore\" | undefined; onLegendItemOut?: \"ignore\" | undefined; onLegendItemOver?: \"ignore\" | undefined; onLegendItemPlusClick?: \"ignore\" | undefined; debugState?: boolean | undefined; onProjectionClick?: \"ignore\" | undefined; onElementClick?: \"ignore\" | undefined; onElementOver?: \"ignore\" | undefined; onElementOut?: \"ignore\" | undefined; onBrushEnd?: \"ignore\" | undefined; onProjectionAreaChange?: \"ignore\" | undefined; onAnnotationClick?: \"ignore\" | undefined; pointerUpdateDebounce?: number | undefined; roundHistogramBrushValues?: boolean | undefined; noResults?: React.ReactChild | React.ComponentType<{}> | undefined; legendSort?: \"ignore\" | undefined; }>> | Partial; base?: number | undefined; actual?: number | undefined; bandFillColor?: \"ignore\" | undefined; tickValueFormatter?: \"ignore\" | undefined; labelMajor?: string | ", + "GoalLabelAccessor", + " | undefined; labelMinor?: string | ", + "GoalLabelAccessor", + " | undefined; centralMajor?: string | ", + "GoalLabelAccessor", + " | undefined; centralMinor?: string | ", + "GoalLabelAccessor", + " | undefined; angleStart?: number | undefined; angleEnd?: number | undefined; bandLabels?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "; tooltipValueFormatter?: \"ignore\" | undefined; }>> | Partial | LensAttributes; }" + "<{ duration: number; } | undefined>; valueGetter?: ", + "ValueGetter", + " | undefined; fillOutside?: boolean | undefined; radiusOutside?: number | undefined; fillRectangleWidth?: number | undefined; fillRectangleHeight?: number | undefined; topGroove?: number | undefined; percentFormatter?: \"ignore\" | undefined; clockwiseSectors?: boolean | undefined; maxRowCount?: number | undefined; specialFirstInnermostSector?: boolean | undefined; smallMultiples?: string | undefined; drilldown?: boolean | undefined; }>> | Partial> | undefined>; gridLine?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + " | undefined>; ticks?: number | undefined; domain?: ", + { + "pluginId": "@kbn/chart-expressions-common", + "scope": "common", + "docId": "kibKbnChartExpressionsCommonPluginApi", + "section": "def-common.MakeOverridesSerializable", + "text": "MakeOverridesSerializable" + }, + "<", + "YDomainRange", + " | undefined>; position?: ", + "Position", + " | undefined; hide?: boolean | undefined; showOverlappingTicks?: boolean | undefined; showOverlappingLabels?: boolean | undefined; timeAxisLayerCount?: number | undefined; integersOnly?: boolean | undefined; tickFormat?: \"ignore\" | undefined; showGridLines?: boolean | undefined; labelFormat?: \"ignore\" | undefined; showDuplicatedTicks?: boolean | undefined; }>> | undefined; }" ], "path": "x-pack/plugins/lens/public/embeddable/embeddable_component.tsx", "deprecated": false, diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 3544a036c8277..0775d607be3db 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github description: API docs for the lens plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] --- import lensObj from './lens.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 583 | 0 | 489 | 54 | +| 608 | 0 | 513 | 53 | ## Client diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index 8ed82b1f2c63a..9f422aa3ca8d9 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github description: API docs for the licenseApiGuard plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] --- import licenseApiGuardObj from './license_api_guard.devdocs.json'; diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index f89c819af2112..4df3895c176a7 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the licenseManagement plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] --- import licenseManagementObj from './license_management.devdocs.json'; diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index fa67e0252401e..219f9cd49a508 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github description: API docs for the licensing plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] --- import licensingObj from './licensing.devdocs.json'; diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index f1a2db9597e9a..38ec86afc02be 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github description: API docs for the lists plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] --- import listsObj from './lists.devdocs.json'; diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 32c1e283fdae0..75ee1220e266e 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github description: API docs for the management plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] --- import managementObj from './management.devdocs.json'; diff --git a/api_docs/maps.devdocs.json b/api_docs/maps.devdocs.json index e9c24b6aa53b5..327c896765d86 100644 --- a/api_docs/maps.devdocs.json +++ b/api_docs/maps.devdocs.json @@ -4020,7 +4020,9 @@ "section": "def-public.RenderWizardArguments", "text": "RenderWizardArguments" }, - "): React.ReactElement>; prerequisiteSteps?: { id: string; label: string; }[] | undefined; disabledReason?: string | undefined; getIsDisabled?: (() => boolean | Promise) | undefined; isBeta?: boolean | undefined; checkVisibility?: (() => Promise) | undefined; showFeatureEditTools?: boolean | undefined; }" + "): React.ReactElement>; prerequisiteSteps?: ", + "LayerWizardStep", + "[] | undefined; disabledReason?: string | undefined; getIsDisabled?: (() => boolean | Promise) | undefined; isBeta?: boolean | undefined; checkVisibility?: (() => Promise) | undefined; showFeatureEditTools?: boolean | undefined; }" ], "path": "x-pack/plugins/maps/public/classes/layers/wizards/layer_wizard_registry.ts", "deprecated": false, diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 577184c9addc2..e715688c00523 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github description: API docs for the maps plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] --- import mapsObj from './maps.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 269 | 0 | 268 | 28 | +| 269 | 0 | 268 | 29 | ## Client diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index d6ff46fd13558..fba1132b2edd0 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github description: API docs for the mapsEms plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] --- import mapsEmsObj from './maps_ems.devdocs.json'; diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index 19e1dd2de51ec..e9c6fe4b2e552 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github description: API docs for the ml plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] --- import mlObj from './ml.devdocs.json'; diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 73367f718b8b9..7dd722375b3c7 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github description: API docs for the monitoring plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] --- import monitoringObj from './monitoring.devdocs.json'; diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index 7f0602cc80a60..b5e1ea8afcf5e 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github description: API docs for the monitoringCollection plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] --- import monitoringCollectionObj from './monitoring_collection.devdocs.json'; diff --git a/api_docs/navigation.devdocs.json b/api_docs/navigation.devdocs.json index 0791c0351a0a2..d854e225bfb95 100644 --- a/api_docs/navigation.devdocs.json +++ b/api_docs/navigation.devdocs.json @@ -705,9 +705,7 @@ "section": "def-public.TopNavMenuData", "text": "TopNavMenuData" }, - "[] | undefined; badges?: (", - "EuiBadgeProps", - " & { badgeText: string; })[] | undefined; showSearchBar?: boolean | undefined; showQueryInput?: boolean | undefined; showDatePicker?: boolean | undefined; showFilterBar?: boolean | undefined; unifiedSearch?: ", + "[] | undefined; badges?: Badge[] | undefined; showSearchBar?: boolean | undefined; showQueryInput?: boolean | undefined; showDatePicker?: boolean | undefined; showFilterBar?: boolean | undefined; unifiedSearch?: ", { "pluginId": "unifiedSearch", "scope": "public", diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index cfc4a51f660db..6b9811176f519 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the navigation plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] --- import navigationObj from './navigation.devdocs.json'; diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index 9f0a43e5748ab..d8577b91aebf8 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github description: API docs for the newsfeed plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] --- import newsfeedObj from './newsfeed.devdocs.json'; diff --git a/api_docs/notifications.mdx b/api_docs/notifications.mdx index 4a89a6c7d316c..a07b04be09c1f 100644 --- a/api_docs/notifications.mdx +++ b/api_docs/notifications.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/notifications title: "notifications" image: https://source.unsplash.com/400x175/?github description: API docs for the notifications plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'notifications'] --- import notificationsObj from './notifications.devdocs.json'; diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index a10732d93cd08..67240e093be4e 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github description: API docs for the observability plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] --- import observabilityObj from './observability.devdocs.json'; diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index 69f038be707c3..ed4c47044f6b4 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github description: API docs for the osquery plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] --- import osqueryObj from './osquery.devdocs.json'; diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 094db57c17218..464a63914fa99 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -7,7 +7,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory description: Directory of public APIs available through plugins or packages. -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -15,13 +15,13 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 586 | 482 | 38 | +| 587 | 483 | 38 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 68587 | 524 | 59245 | 1319 | +| 68664 | 525 | 59318 | 1323 | ## Plugin Directory @@ -34,10 +34,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 42 | 0 | 42 | 108 | | | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | Asset manager plugin for entity assets (inventory, topology, etc) | 3 | 0 | 3 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 9 | 0 | 9 | 0 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 89 | 1 | 74 | 2 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 91 | 1 | 75 | 2 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Canvas application to Kibana | 9 | 0 | 8 | 3 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 96 | 0 | 79 | 31 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 270 | 16 | 255 | 9 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 271 | 16 | 256 | 10 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 41 | 0 | 11 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Chat available on Elastic Cloud deployments for quicker assistance. | 1 | 0 | 0 | 0 | | | [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) | Static migration page where self-managed users can see text/copy about migrating to Elastic Cloud | 8 | 1 | 8 | 1 | @@ -48,8 +48,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | cloudLinks | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Adds the links to the Elastic Cloud console | 0 | 0 | 0 | 0 | | | [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic/teams/kibana-cloud-security-posture) | The cloud security posture plugin | 17 | 0 | 2 | 2 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 13 | 0 | 13 | 1 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Content management app | 118 | 0 | 104 | 4 | -| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 273 | 0 | 269 | 11 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Content management app | 143 | 0 | 124 | 6 | +| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 273 | 0 | 269 | 10 | | crossClusterReplication | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | customBranding | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Enables customization of Kibana | 0 | 0 | 0 | 0 | | | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 271 | 0 | 252 | 1 | @@ -74,18 +74,18 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 116 | 0 | 116 | 11 | | | [@elastic/uptime](https://github.com/orgs/elastic/teams/uptime) | - | 352 | 4 | 349 | 22 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'error' renderer to expressions | 17 | 0 | 15 | 2 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Gauge plugin adds a `gauge` renderer and function to the expression plugin. The renderer will display the `gauge` chart. | 58 | 0 | 58 | 2 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. | 111 | 14 | 107 | 2 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Gauge plugin adds a `gauge` renderer and function to the expression plugin. The renderer will display the `gauge` chart. | 59 | 0 | 59 | 2 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. | 112 | 14 | 108 | 2 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'image' function and renderer to expressions | 26 | 0 | 26 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Adds a `metric` renderer and function to the expression plugin. The renderer will display the `legacy metric` chart. | 51 | 0 | 51 | 2 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'metric' function and renderer to expressions | 32 | 0 | 27 | 0 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. | 63 | 0 | 63 | 2 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Partition Visualization plugin adds a `partitionVis` renderer and `pieVis`, `mosaicVis`, `treemapVis`, `waffleVis` functions to the expression plugin. The renderer will display the `pie`, `waffle`, `treemap` and `mosaic` charts. | 72 | 0 | 72 | 2 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. | 67 | 0 | 67 | 2 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Partition Visualization plugin adds a `partitionVis` renderer and `pieVis`, `mosaicVis`, `treemapVis`, `waffleVis` functions to the expression plugin. The renderer will display the `pie`, `waffle`, `treemap` and `mosaic` charts. | 73 | 0 | 73 | 2 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'repeatImage' function and renderer to expressions | 32 | 0 | 32 | 0 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'revealImage' function and renderer to expressions | 14 | 0 | 14 | 3 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'shape' function and renderer to expressions | 148 | 0 | 146 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart. | 5 | 0 | 5 | 0 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 171 | 0 | 161 | 13 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 173 | 0 | 163 | 13 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Adds expression runtime to Kibana | 2205 | 74 | 1746 | 5 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 235 | 0 | 99 | 2 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Index pattern fields and ambiguous values formatters | 288 | 26 | 249 | 3 | @@ -114,14 +114,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | kibanaUsageCollection | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | | [@elastic/kibana-app-services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 609 | 3 | 416 | 9 | | | [@elastic/awp-viz](https://github.com/orgs/elastic/teams/awp-viz) | - | 3 | 0 | 3 | 1 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 583 | 0 | 489 | 54 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 608 | 0 | 513 | 53 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 8 | 0 | 8 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 10 | | | [@elastic/security-solution-platform](https://github.com/orgs/elastic/teams/security-solution-platform) | - | 210 | 0 | 94 | 51 | | logstash | [@elastic/logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 41 | 0 | 41 | 6 | -| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 269 | 0 | 268 | 28 | +| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 269 | 0 | 268 | 29 | | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 67 | 0 | 67 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 259 | 9 | 83 | 40 | | | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | - | 15 | 3 | 13 | 1 | @@ -132,7 +132,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 652 | 44 | 646 | 34 | | | [@elastic/security-defend-workflows](https://github.com/orgs/elastic/teams/security-defend-workflows) | - | 24 | 0 | 24 | 6 | | painlessLab | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | -| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 202 | 7 | 146 | 12 | +| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 207 | 8 | 151 | 12 | | | [@elastic/profiling-ui](https://github.com/orgs/elastic/teams/profiling-ui) | - | 15 | 2 | 15 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Reporting Services enables applications to feature reports that the user can automate with Watcher and download later. | 36 | 0 | 16 | 0 | @@ -149,7 +149,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-reporting-services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 27 | 0 | 8 | 4 | | searchprofiler | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 280 | 0 | 94 | 0 | -| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 118 | 0 | 77 | 28 | +| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 117 | 0 | 76 | 27 | | | [@elastic/awp-viz](https://github.com/orgs/elastic/teams/awp-viz) | - | 7 | 0 | 7 | 1 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds URL Service and sharing capabilities to Kibana | 118 | 0 | 59 | 10 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 22 | 1 | 22 | 1 | @@ -166,11 +166,11 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 257 | 1 | 214 | 20 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 4 | 0 | 4 | 1 | | translations | [@elastic/kibana-localization](https://github.com/orgs/elastic/teams/kibana-localization) | - | 0 | 0 | 0 | 0 | -| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 535 | 10 | 506 | 49 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 536 | 10 | 507 | 49 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds UI Actions service to Kibana | 134 | 2 | 92 | 9 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Extends UI Actions plugin with more functionality | 206 | 0 | 140 | 9 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Contains functionality for the field list which can be integrated into apps | 276 | 0 | 250 | 7 | -| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | The `unifiedHistogram` plugin provides UI components to create a layout including a resizable histogram and a main display. | 64 | 0 | 24 | 1 | +| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | The `unifiedHistogram` plugin provides UI components to create a layout including a resizable histogram and a main display. | 52 | 0 | 23 | 2 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 135 | 2 | 100 | 20 | | upgradeAssistant | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | urlDrilldown | [@elastic/kibana-app-services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds drilldown implementations to Kibana | 0 | 0 | 0 | 0 | @@ -218,7 +218,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-qa](https://github.com/orgs/elastic/teams/kibana-qa) | - | 12 | 0 | 12 | 0 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 19 | 0 | 17 | 0 | | | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 57 | 1 | 42 | 2 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 4 | 0 | 4 | 0 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 9 | 0 | 6 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 76 | 0 | 76 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 7 | 0 | 2 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 3 | 0 | 3 | 0 | @@ -404,7 +404,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 4 | 0 | 4 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 27 | 0 | 14 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 3 | 0 | -| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 251 | 1 | 193 | 15 | +| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 255 | 1 | 197 | 15 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 12 | 0 | 12 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 1 | 0 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 13 | 0 | 4 | 3 | @@ -412,7 +412,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 0 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 29 | 0 | 29 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 1 | 0 | 0 | 0 | -| | [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) | - | 52 | 0 | 50 | 2 | +| | [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) | - | 52 | 0 | 50 | 3 | | | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | - | 33 | 3 | 24 | 6 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 3 | 0 | 3 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 1 | 0 | 1 | 0 | @@ -432,7 +432,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 8 | 0 | 8 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 6 | 0 | 1 | 1 | | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 534 | 1 | 1 | 0 | -| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 87 | 2 | 63 | 0 | +| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 92 | 2 | 63 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 52 | 0 | 4 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 2 | 0 | 0 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 3 | 0 | 2 | 0 | @@ -445,6 +445,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 31 | 1 | 24 | 1 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 71 | 0 | 69 | 3 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 53 | 1 | 48 | 0 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 7 | 0 | 7 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 45 | 0 | 45 | 10 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 51 | 5 | 34 | 0 | | | [@elastic/security-asset-management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 62 | 0 | 62 | 0 | @@ -462,7 +463,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 2 | 0 | 0 | 0 | | | [@elastic/security-solution-platform](https://github.com/orgs/elastic/teams/security-solution-platform) | - | 56 | 1 | 41 | 1 | | | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 341 | 1 | 337 | 32 | -| | [@elastic/security-solution-platform](https://github.com/orgs/elastic/teams/security-solution-platform) | - | 67 | 0 | 61 | 1 | +| | [@elastic/security-solution-platform](https://github.com/orgs/elastic/teams/security-solution-platform) | - | 68 | 0 | 62 | 1 | | | [@elastic/security-solution-platform](https://github.com/orgs/elastic/teams/security-solution-platform) | - | 104 | 0 | 93 | 1 | | | [@elastic/security-threat-hunting-explore](https://github.com/orgs/elastic/teams/security-threat-hunting-explore) | - | 20 | 0 | 15 | 4 | | | [@elastic/security-solution-platform](https://github.com/orgs/elastic/teams/security-solution-platform) | - | 15 | 0 | 7 | 0 | diff --git a/api_docs/presentation_util.devdocs.json b/api_docs/presentation_util.devdocs.json index 837d9358e1291..f042a9523bd8d 100644 --- a/api_docs/presentation_util.devdocs.json +++ b/api_docs/presentation_util.devdocs.json @@ -732,9 +732,9 @@ }, "[]; selectedDataViewId?: string | undefined; trigger: ", "DataViewTriggerProps", - "; onChangeDataViewId: (newId: string) => void; selectableProps?: ", + "; onChangeDataViewId: (newId: string) => void; selectableProps?: Partial<", "EuiSelectableProps", - "<{}> | undefined; }> & { readonly _result: ({ dataViews, selectedDataViewId, onChangeDataViewId, trigger, selectableProps, }: { dataViews: ", + "<{}>> | undefined; }> & { readonly _result: ({ dataViews, selectedDataViewId, onChangeDataViewId, trigger, selectableProps, }: { dataViews: ", { "pluginId": "dataViews", "scope": "common", @@ -744,9 +744,9 @@ }, "[]; selectedDataViewId?: string | undefined; trigger: ", "DataViewTriggerProps", - "; onChangeDataViewId: (newId: string) => void; selectableProps?: ", + "; onChangeDataViewId: (newId: string) => void; selectableProps?: Partial<", "EuiSelectableProps", - "<{}> | undefined; }) => JSX.Element; }" + "<{}>> | undefined; }) => JSX.Element; }" ], "path": "src/plugins/presentation_util/public/components/index.tsx", "deprecated": false, @@ -830,7 +830,7 @@ "signature": [ "React.ExoticComponent<", "FieldPickerProps", - "> & { readonly _result: ({ dataView, onSelectField, filterPredicate, selectedFieldName, }: ", + "> & { readonly _result: ({ dataView, onSelectField, filterPredicate, selectedFieldName, selectableProps, }: ", "FieldPickerProps", ") => JSX.Element; }" ], @@ -3024,6 +3024,39 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "presentationUtil", + "id": "def-common.isValidHttpUrl", + "type": "Function", + "tags": [], + "label": "isValidHttpUrl", + "description": [], + "signature": [ + "(str: string) => boolean" + ], + "path": "src/plugins/presentation_util/common/lib/utils/httpurl.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "presentationUtil", + "id": "def-common.isValidHttpUrl.$1", + "type": "string", + "tags": [], + "label": "str", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/presentation_util/common/lib/utils/httpurl.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "presentationUtil", "id": "def-common.isValidUrl", @@ -3105,6 +3138,54 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "presentationUtil", + "id": "def-common.resolveFromArgs", + "type": "Function", + "tags": [], + "label": "resolveFromArgs", + "description": [], + "signature": [ + "(args: any, defaultDataurl?: string | null) => string" + ], + "path": "src/plugins/presentation_util/common/lib/utils/resolve_dataurl.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "presentationUtil", + "id": "def-common.resolveFromArgs.$1", + "type": "Any", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/presentation_util/common/lib/utils/resolve_dataurl.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "presentationUtil", + "id": "def-common.resolveFromArgs.$2", + "type": "CompoundType", + "tags": [], + "label": "defaultDataurl", + "description": [], + "signature": [ + "string | null" + ], + "path": "src/plugins/presentation_util/common/lib/utils/resolve_dataurl.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "presentationUtil", "id": "def-common.resolveWithMissingImage", diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index a68234d6beb36..d0c9b2b1c83fc 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github description: API docs for the presentationUtil plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] --- import presentationUtilObj from './presentation_util.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 202 | 7 | 146 | 12 | +| 207 | 8 | 151 | 12 | ## Client diff --git a/api_docs/profiling.mdx b/api_docs/profiling.mdx index b19dd8d798e74..caf2549b8c18f 100644 --- a/api_docs/profiling.mdx +++ b/api_docs/profiling.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/profiling title: "profiling" image: https://source.unsplash.com/400x175/?github description: API docs for the profiling plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'profiling'] --- import profilingObj from './profiling.devdocs.json'; diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 2221292212fdb..2bd8610cb4fe8 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github description: API docs for the remoteClusters plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] --- import remoteClustersObj from './remote_clusters.devdocs.json'; diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index 90b6e923b90ae..c10f7a55139b7 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github description: API docs for the reporting plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] --- import reportingObj from './reporting.devdocs.json'; diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index 03e0c87ffa529..6296641a91293 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github description: API docs for the rollup plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] --- import rollupObj from './rollup.devdocs.json'; diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index e3ae2cf93ee37..475577ff2e3c0 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github description: API docs for the ruleRegistry plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] --- import ruleRegistryObj from './rule_registry.devdocs.json'; diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index c19b0d68e75cc..fb5f606689b40 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github description: API docs for the runtimeFields plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] --- import runtimeFieldsObj from './runtime_fields.devdocs.json'; diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index 36744ebc3def7..de72be14c718b 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjects plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] --- import savedObjectsObj from './saved_objects.devdocs.json'; diff --git a/api_docs/saved_objects_finder.mdx b/api_docs/saved_objects_finder.mdx index 35b601525391d..ab0b017a407bc 100644 --- a/api_docs/saved_objects_finder.mdx +++ b/api_docs/saved_objects_finder.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsFinder title: "savedObjectsFinder" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsFinder plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsFinder'] --- import savedObjectsFinderObj from './saved_objects_finder.devdocs.json'; diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 55ea116add1c9..c7d787d43abda 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsManagement plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] --- import savedObjectsManagementObj from './saved_objects_management.devdocs.json'; diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index 58108600bb0c4..6b04b5bde2fc8 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsTagging plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] --- import savedObjectsTaggingObj from './saved_objects_tagging.devdocs.json'; diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index faeeef22875d7..5f6ce56703402 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsTaggingOss plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] --- import savedObjectsTaggingOssObj from './saved_objects_tagging_oss.devdocs.json'; diff --git a/api_docs/saved_search.mdx b/api_docs/saved_search.mdx index 8d5295fec3f2e..8974c3be6aecf 100644 --- a/api_docs/saved_search.mdx +++ b/api_docs/saved_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedSearch title: "savedSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the savedSearch plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedSearch'] --- import savedSearchObj from './saved_search.devdocs.json'; diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 98224cde3fa58..7ee5eebff3352 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github description: API docs for the screenshotMode plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] --- import screenshotModeObj from './screenshot_mode.devdocs.json'; diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index 16d8fec1130ae..fe5835a4d697a 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github description: API docs for the screenshotting plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] --- import screenshottingObj from './screenshotting.devdocs.json'; diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 0865ced1c4bbf..e5ed38c5904f8 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github description: API docs for the security plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] --- import securityObj from './security.devdocs.json'; diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index 2671b393b725f..3c468e74d4b85 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -2023,20 +2023,6 @@ "trackAdoption": false, "children": [], "returnComment": [] - }, - { - "parentPluginId": "securitySolution", - "id": "def-server.SecuritySolutionApiRequestHandlerContext.getQueryRuleAdditionalOptions", - "type": "Object", - "tags": [], - "label": "getQueryRuleAdditionalOptions", - "description": [], - "signature": [ - "CreateQueryRuleAdditionalOptions" - ], - "path": "x-pack/plugins/security_solution/server/types.ts", - "deprecated": false, - "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index 26375d9dad571..a697105f4cc74 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github description: API docs for the securitySolution plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] --- import securitySolutionObj from './security_solution.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/secur | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 118 | 0 | 77 | 28 | +| 117 | 0 | 76 | 27 | ## Client diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index 8991e0b51f355..0e38db26aab6f 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github description: API docs for the sessionView plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] --- import sessionViewObj from './session_view.devdocs.json'; diff --git a/api_docs/share.mdx b/api_docs/share.mdx index ab5c3c2ad0716..5b391dc3f0b26 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github description: API docs for the share plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] --- import shareObj from './share.devdocs.json'; diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index a1bf3423aea02..0068126bcb080 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github description: API docs for the snapshotRestore plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] --- import snapshotRestoreObj from './snapshot_restore.devdocs.json'; diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index db91f6fac5b7f..ad9a1bc7c3aca 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github description: API docs for the spaces plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] --- import spacesObj from './spaces.devdocs.json'; diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index 72eeed7f50f36..ed07465265327 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github description: API docs for the stackAlerts plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] --- import stackAlertsObj from './stack_alerts.devdocs.json'; diff --git a/api_docs/stack_connectors.mdx b/api_docs/stack_connectors.mdx index 20056a6601358..3609a1e0070c8 100644 --- a/api_docs/stack_connectors.mdx +++ b/api_docs/stack_connectors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackConnectors title: "stackConnectors" image: https://source.unsplash.com/400x175/?github description: API docs for the stackConnectors plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackConnectors'] --- import stackConnectorsObj from './stack_connectors.devdocs.json'; diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index 37ef541304fed..b10748927bbe5 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github description: API docs for the taskManager plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] --- import taskManagerObj from './task_manager.devdocs.json'; diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index bb71dab2dc576..55c91e18fb19e 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetry plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] --- import telemetryObj from './telemetry.devdocs.json'; diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index d8a86fdbbd7ee..7dbf44cbf7f60 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryCollectionManager plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] --- import telemetryCollectionManagerObj from './telemetry_collection_manager.devdocs.json'; diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index 4c763bfcb405a..40b912eace8e5 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryCollectionXpack plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] --- import telemetryCollectionXpackObj from './telemetry_collection_xpack.devdocs.json'; diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index 6de0272625916..f58527004cd83 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryManagementSection plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] --- import telemetryManagementSectionObj from './telemetry_management_section.devdocs.json'; diff --git a/api_docs/threat_intelligence.mdx b/api_docs/threat_intelligence.mdx index c0c0c62aeef26..6a762249648e2 100644 --- a/api_docs/threat_intelligence.mdx +++ b/api_docs/threat_intelligence.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/threatIntelligence title: "threatIntelligence" image: https://source.unsplash.com/400x175/?github description: API docs for the threatIntelligence plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'threatIntelligence'] --- import threatIntelligenceObj from './threat_intelligence.devdocs.json'; diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 6759d5472d716..2a2c0a26dd5ec 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github description: API docs for the timelines plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] --- import timelinesObj from './timelines.devdocs.json'; diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index 9dd50f5d2045e..3dce6702bd568 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github description: API docs for the transform plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] --- import transformObj from './transform.devdocs.json'; diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index f9cf22039625e..5a52140b96c40 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -2680,7 +2680,7 @@ "label": "validNormalizedTypes", "description": [], "signature": [ - "string[]" + "(\"string\" | \"number\" | \"boolean\" | \"object\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"date\" | \"murmur3\" | \"date_range\" | \"ip_range\" | \"histogram\" | \"number_range\")[]" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "deprecated": false, @@ -5962,6 +5962,21 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ValidNormalizedTypes", + "type": "Type", + "tags": [], + "label": "ValidNormalizedTypes", + "description": [], + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"object\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"date\" | \"murmur3\" | \"date_range\" | \"ip_range\" | \"histogram\" | \"number_range\"" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false } ], "objects": [ @@ -6086,7 +6101,7 @@ "label": "validNormalizedTypes", "description": [], "signature": [ - "string[]" + "\"number\"[]" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "deprecated": false, @@ -6152,7 +6167,7 @@ "label": "validNormalizedTypes", "description": [], "signature": [ - "string[]" + "\"number\"[]" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "deprecated": false, @@ -6218,7 +6233,7 @@ "label": "validNormalizedTypes", "description": [], "signature": [ - "string[]" + "(\"date\" | \"number\")[]" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "deprecated": false, @@ -6284,7 +6299,7 @@ "label": "validNormalizedTypes", "description": [], "signature": [ - "string[]" + "(\"date\" | \"number\")[]" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "deprecated": false, diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index 8c5b5c00a6954..8b87eec8a64f6 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github description: API docs for the triggersActionsUi plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] --- import triggersActionsUiObj from './triggers_actions_ui.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 535 | 10 | 506 | 49 | +| 536 | 10 | 507 | 49 | ## Client diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index de366b20a8712..c2779a501524e 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github description: API docs for the uiActions plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] --- import uiActionsObj from './ui_actions.devdocs.json'; diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 2d2951bbf5c4d..5e0945850994b 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the uiActionsEnhanced plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] --- import uiActionsEnhancedObj from './ui_actions_enhanced.devdocs.json'; diff --git a/api_docs/unified_field_list.mdx b/api_docs/unified_field_list.mdx index 8f62ab7dcdccd..42aa1a731efb4 100644 --- a/api_docs/unified_field_list.mdx +++ b/api_docs/unified_field_list.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedFieldList title: "unifiedFieldList" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedFieldList plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedFieldList'] --- import unifiedFieldListObj from './unified_field_list.devdocs.json'; diff --git a/api_docs/unified_histogram.devdocs.json b/api_docs/unified_histogram.devdocs.json index f1cd83669244f..f88fd244420f4 100644 --- a/api_docs/unified_histogram.devdocs.json +++ b/api_docs/unified_histogram.devdocs.json @@ -439,18 +439,36 @@ "tags": [], "label": "UnifiedHistogramContainer", "description": [ - "\nA resizable layout component with two panels that renders a histogram with a hits\ncounter in the top panel, and a main display (data table, etc.) in the bottom panel.\nIf all context props are left undefined, the layout will render in a single panel\nmode including only the main display." + "\nA resizable layout component with two panels that renders a histogram with a hits\ncounter in the top panel, and a main display (data table, etc.) in the bottom panel." ], "signature": [ - "React.ForwardRefExoticComponent ", { "pluginId": "unifiedHistogram", "scope": "public", "docId": "kibUnifiedHistogramPluginApi", - "section": "def-public.UnifiedHistogramContainerProps", - "text": "UnifiedHistogramContainerProps" + "section": "def-public.UnifiedHistogramCreationOptions", + "text": "UnifiedHistogramCreationOptions" }, - " & React.RefAttributes<", + " | Promise<", + { + "pluginId": "unifiedHistogram", + "scope": "public", + "docId": "kibUnifiedHistogramPluginApi", + "section": "def-public.UnifiedHistogramCreationOptions", + "text": "UnifiedHistogramCreationOptions" + }, + ">) | undefined; searchSessionId?: string | undefined; requestAdapter?: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined; } & Pick<", + "UnifiedHistogramLayoutProps", + ", \"children\" | \"className\" | \"query\" | \"filters\" | \"columns\" | \"timeRange\" | \"services\" | \"dataView\" | \"relativeTimeRange\" | \"resizeRef\" | \"appendHitsCounter\"> & React.RefAttributes<", { "pluginId": "unifiedHistogram", "scope": "public", @@ -458,7 +476,7 @@ "section": "def-public.UnifiedHistogramApi", "text": "UnifiedHistogramApi" }, - ">, \"children\" | \"className\" | \"css\" | \"key\" | \"resizeRef\" | \"appendHitsCounter\"> & React.RefAttributes<{}>>" + ">>" ], "path": "src/plugins/unified_histogram/public/container/index.tsx", "deprecated": false, @@ -833,22 +851,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramState.columns", - "type": "Array", - "tags": [], - "label": "columns", - "description": [ - "\nThe current selected columns" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/unified_histogram/public/container/services/state_service.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "unifiedHistogram", "id": "def-public.UnifiedHistogramState.currentSuggestion", @@ -885,51 +887,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramState.dataView", - "type": "Object", - "tags": [], - "label": "dataView", - "description": [ - "\nThe current data view" - ], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "src/plugins/unified_histogram/public/container/services/state_service.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramState.filters", - "type": "Array", - "tags": [], - "label": "filters", - "description": [ - "\nThe current filters" - ], - "signature": [ - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.Filter", - "text": "Filter" - }, - "[]" - ], - "path": "src/plugins/unified_histogram/public/container/services/state_service.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "unifiedHistogram", "id": "def-public.UnifiedHistogramState.lensRequestAdapter", @@ -953,75 +910,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramState.query", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [ - "\nThe current query" - ], - "signature": [ - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - }, - " | ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.AggregateQuery", - "text": "AggregateQuery" - } - ], - "path": "src/plugins/unified_histogram/public/container/services/state_service.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramState.requestAdapter", - "type": "Object", - "tags": [], - "label": "requestAdapter", - "description": [ - "\nThe current request adapter used for non-Lens requests" - ], - "signature": [ - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.RequestAdapter", - "text": "RequestAdapter" - }, - " | undefined" - ], - "path": "src/plugins/unified_histogram/public/container/services/state_service.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramState.searchSessionId", - "type": "string", - "tags": [], - "label": "searchSessionId", - "description": [ - "\nThe current search session ID" - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/unified_histogram/public/container/services/state_service.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "unifiedHistogram", "id": "def-public.UnifiedHistogramState.timeInterval", @@ -1035,22 +923,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramState.timeRange", - "type": "Object", - "tags": [], - "label": "timeRange", - "description": [ - "\nThe current time range" - ], - "signature": [ - "{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }" - ], - "path": "src/plugins/unified_histogram/public/container/services/state_service.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "unifiedHistogram", "id": "def-public.UnifiedHistogramState.topPanelHeight", @@ -1162,7 +1034,7 @@ { "parentPluginId": "unifiedHistogram", "id": "def-public.UnifiedHistogramStateOptions.initialState", - "type": "CompoundType", + "type": "Object", "tags": [], "label": "initialState", "description": [ @@ -1177,15 +1049,7 @@ "section": "def-public.UnifiedHistogramState", "text": "UnifiedHistogramState" }, - "> & Pick<", - { - "pluginId": "unifiedHistogram", - "scope": "public", - "docId": "kibUnifiedHistogramPluginApi", - "section": "def-public.UnifiedHistogramState", - "text": "UnifiedHistogramState" - }, - ", \"dataView\">" + "> | undefined" ], "path": "src/plugins/unified_histogram/public/container/services/state_service.ts", "deprecated": false, @@ -1193,86 +1057,6 @@ } ], "initialIsOpen": false - }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramUninitializedApi", - "type": "Interface", - "tags": [], - "label": "UnifiedHistogramUninitializedApi", - "description": [ - "\nThe uninitialized API exposed by the container" - ], - "path": "src/plugins/unified_histogram/public/container/container.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramUninitializedApi.initialized", - "type": "boolean", - "tags": [], - "label": "initialized", - "description": [ - "\nWhether the container has been initialized" - ], - "signature": [ - "false" - ], - "path": "src/plugins/unified_histogram/public/container/container.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramUninitializedApi.initialize", - "type": "Function", - "tags": [], - "label": "initialize", - "description": [ - "\nInitialize the container" - ], - "signature": [ - "(options: ", - { - "pluginId": "unifiedHistogram", - "scope": "public", - "docId": "kibUnifiedHistogramPluginApi", - "section": "def-public.UnifiedHistogramInitializeOptions", - "text": "UnifiedHistogramInitializeOptions" - }, - ") => void" - ], - "path": "src/plugins/unified_histogram/public/container/container.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramUninitializedApi.initialize.$1", - "type": "CompoundType", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "unifiedHistogram", - "scope": "public", - "docId": "kibUnifiedHistogramPluginApi", - "section": "def-public.UnifiedHistogramInitializeOptions", - "text": "UnifiedHistogramInitializeOptions" - } - ], - "path": "src/plugins/unified_histogram/public/container/container.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false } ], "enums": [ @@ -1343,21 +1127,9 @@ "\nThe API exposed by the container" ], "signature": [ - { - "pluginId": "unifiedHistogram", - "scope": "public", - "docId": "kibUnifiedHistogramPluginApi", - "section": "def-public.UnifiedHistogramUninitializedApi", - "text": "UnifiedHistogramUninitializedApi" - }, - " | ", - { - "pluginId": "unifiedHistogram", - "scope": "public", - "docId": "kibUnifiedHistogramPluginApi", - "section": "def-public.UnifiedHistogramInitializedApi", - "text": "UnifiedHistogramInitializedApi" - } + "{ refetch: () => void; } & Pick<", + "UnifiedHistogramStateService", + ", \"state$\" | \"setChartHidden\" | \"setTopPanelHeight\" | \"setBreakdownField\" | \"setTimeInterval\" | \"setTotalHits\">" ], "path": "src/plugins/unified_histogram/public/container/container.tsx", "deprecated": false, @@ -1374,26 +1146,33 @@ "\nThe props exposed by the container" ], "signature": [ - "{ children?: React.ReactNode; className?: string | undefined; resizeRef: React.RefObject; appendHitsCounter?: React.ReactElement> | undefined; }" - ], - "path": "src/plugins/unified_histogram/public/container/container.tsx", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramInitializedApi", - "type": "Type", - "tags": [], - "label": "UnifiedHistogramInitializedApi", - "description": [ - "\nThe initialized API exposed by the container" - ], - "signature": [ - "{ initialized: true; refetch: () => void; } & Pick<", - "UnifiedHistogramStateService", - ", \"state$\" | \"setChartHidden\" | \"setTopPanelHeight\" | \"setBreakdownField\" | \"setColumns\" | \"setTimeInterval\" | \"setRequestParams\" | \"setTotalHits\">" + "{ getCreationOptions?: (() => ", + { + "pluginId": "unifiedHistogram", + "scope": "public", + "docId": "kibUnifiedHistogramPluginApi", + "section": "def-public.UnifiedHistogramCreationOptions", + "text": "UnifiedHistogramCreationOptions" + }, + " | Promise<", + { + "pluginId": "unifiedHistogram", + "scope": "public", + "docId": "kibUnifiedHistogramPluginApi", + "section": "def-public.UnifiedHistogramCreationOptions", + "text": "UnifiedHistogramCreationOptions" + }, + ">) | undefined; searchSessionId?: string | undefined; requestAdapter?: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.RequestAdapter", + "text": "RequestAdapter" + }, + " | undefined; } & Pick<", + "UnifiedHistogramLayoutProps", + ", \"children\" | \"className\" | \"query\" | \"filters\" | \"columns\" | \"timeRange\" | \"services\" | \"dataView\" | \"relativeTimeRange\" | \"resizeRef\" | \"appendHitsCounter\">" ], "path": "src/plugins/unified_histogram/public/container/container.tsx", "deprecated": false, @@ -1402,14 +1181,15 @@ }, { "parentPluginId": "unifiedHistogram", - "id": "def-public.UnifiedHistogramInitializeOptions", + "id": "def-public.UnifiedHistogramCreationOptions", "type": "Type", "tags": [], - "label": "UnifiedHistogramInitializeOptions", + "label": "UnifiedHistogramCreationOptions", "description": [ "\nThe options used to initialize the container" ], "signature": [ + "Omit<", { "pluginId": "unifiedHistogram", "scope": "public", @@ -1417,7 +1197,7 @@ "section": "def-public.UnifiedHistogramStateOptions", "text": "UnifiedHistogramStateOptions" }, - " & Omit" + ", \"services\"> & LayoutProps" ], "path": "src/plugins/unified_histogram/public/container/container.tsx", "deprecated": false, diff --git a/api_docs/unified_histogram.mdx b/api_docs/unified_histogram.mdx index 1e3ea621e4d91..e2520dc1db992 100644 --- a/api_docs/unified_histogram.mdx +++ b/api_docs/unified_histogram.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedHistogram title: "unifiedHistogram" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedHistogram plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedHistogram'] --- import unifiedHistogramObj from './unified_histogram.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 64 | 0 | 24 | 1 | +| 52 | 0 | 23 | 2 | ## Client diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 1fd23478cf723..7a45a445d9f3b 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedSearch plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] --- import unifiedSearchObj from './unified_search.devdocs.json'; diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index 2cf8697008871..e8cb25f97c5c0 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedSearch.autocomplete plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] --- import unifiedSearchAutocompleteObj from './unified_search_autocomplete.devdocs.json'; diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 88a912cb58a72..273b835eae43b 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github description: API docs for the urlForwarding plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] --- import urlForwardingObj from './url_forwarding.devdocs.json'; diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index c0c273ddc248f..477f4dfe1e637 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github description: API docs for the usageCollection plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] --- import usageCollectionObj from './usage_collection.devdocs.json'; diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index e63ccf130a0bf..2680b557f69d2 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github description: API docs for the ux plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] --- import uxObj from './ux.devdocs.json'; diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index ee75393aeb4b3..2e4429168326f 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the visDefaultEditor plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] --- import visDefaultEditorObj from './vis_default_editor.devdocs.json'; diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index 55c716ee4e9f7..1549503443c4b 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeGauge plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] --- import visTypeGaugeObj from './vis_type_gauge.devdocs.json'; diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index 0a9ecd48ddda3..85f166c9730bd 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeHeatmap plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] --- import visTypeHeatmapObj from './vis_type_heatmap.devdocs.json'; diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 0f2149f849f9f..60634ac575905 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypePie plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] --- import visTypePieObj from './vis_type_pie.devdocs.json'; diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index df5ea58a4556c..0602d95edbd2e 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTable plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] --- import visTypeTableObj from './vis_type_table.devdocs.json'; diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index 9ee98327dc838..ef7ff8ed8302d 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTimelion plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] --- import visTypeTimelionObj from './vis_type_timelion.devdocs.json'; diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index a9642fa47082c..732b7c1cbbba2 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTimeseries plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] --- import visTypeTimeseriesObj from './vis_type_timeseries.devdocs.json'; diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index 28ba5b3c889d5..e590c29d17dd7 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeVega plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] --- import visTypeVegaObj from './vis_type_vega.devdocs.json'; diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index cd2ec088eeaa0..7ec10de55deac 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeVislib plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] --- import visTypeVislibObj from './vis_type_vislib.devdocs.json'; diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index b61e0414fb621..0cf82e6b7bb8e 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeXy plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] --- import visTypeXyObj from './vis_type_xy.devdocs.json'; diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 12926f9cf2750..e29566167cad6 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -11023,7 +11023,7 @@ "label": "shape", "description": [], "signature": [ - "\"pie\" | \"donut\" | \"treemap\" | \"mosaic\" | \"waffle\"" + "\"treemap\" | \"mosaic\" | \"waffle\" | \"pie\" | \"donut\"" ], "path": "src/plugins/visualizations/common/convert_to_lens/types/configurations.ts", "deprecated": false, @@ -14620,7 +14620,7 @@ "label": "PartitionChartType", "description": [], "signature": [ - "\"pie\" | \"donut\" | \"treemap\" | \"mosaic\" | \"waffle\"" + "\"treemap\" | \"mosaic\" | \"waffle\" | \"pie\" | \"donut\"" ], "path": "src/plugins/visualizations/common/convert_to_lens/types/configurations.ts", "deprecated": false, diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index 2391838d02e6f..86823ed2d26fa 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github description: API docs for the visualizations plugin -date: 2023-04-04 +date: 2023-04-10 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] --- import visualizationsObj from './visualizations.devdocs.json'; diff --git a/docs/developer/plugin/plugin-tooling.asciidoc b/docs/developer/plugin/plugin-tooling.asciidoc index 0b33a585863a4..864d99f138585 100644 --- a/docs/developer/plugin/plugin-tooling.asciidoc +++ b/docs/developer/plugin/plugin-tooling.asciidoc @@ -43,8 +43,10 @@ It will output a`zip` archive in `kibana/plugins/my_plugin_name/build/` folder. See <>. === Run {kib} with your plugin in dev mode -Run `yarn start` in the {kib} root folder. Make sure {kib} found and bootstrapped your plugin: +If your plugin isn't server only and contains `ui` in order for Kibana to pick the browser bundles you need to run `yarn dev --watch` in the plugin root folder at a dedicated terminal. + +Then, in a second terminal, run `yarn start` at the {kib} root folder. Make sure {kib} found and bootstrapped your plugin by: ["source","shell"] ----------- -[info][plugins-system] Setting up […] plugins: […, myPluginName, …] +[INFO ][plugins-system.standard] Setting up […] plugins: […, myPluginName, …] ----------- diff --git a/docs/discover/save-search.asciidoc b/docs/discover/save-search.asciidoc index deede3cf2b922..10abef2e4a1bb 100644 --- a/docs/discover/save-search.asciidoc +++ b/docs/discover/save-search.asciidoc @@ -30,9 +30,21 @@ current view of *Discover*, including the columns and sort order in the document If the saved search is associated with a different {data-source} than is currently selected, opening the saved search changes the selected {data-source}. The query language used for the saved search is also automatically selected. -. To add your search results to a dashboard: -.. Open the main menu, then click *Dashboard*. -.. Open or create the dashboard, then click *Edit*. -.. Click *Add from library*. -.. From the *Types* dropdown, select *Saved search*. -.. Select the saved search that you want to visualize, then click *X* to close the list. + +[float] +=== Duplicate a search +. In **Discover**, open the search that you want to duplicate. +. In the toolbar, click *Save*. +. Give the search a new name. +. Turn on **Save as new search**. +. Click *Save*. + + +[float] +=== Add search results to a dashboard + +. Open the main menu, and then click *Dashboard*. +. Open or create the dashboard, then click *Edit*. +. Click *Add from library*. +. From the *Types* dropdown, select *Saved search*. +. Select the saved search that you want to visualize, then click *X* to close the list. diff --git a/docs/maps/asset-tracking-tutorial.asciidoc b/docs/maps/asset-tracking-tutorial.asciidoc index c87cdfde9ee68..56a486ba1e239 100644 --- a/docs/maps/asset-tracking-tutorial.asciidoc +++ b/docs/maps/asset-tracking-tutorial.asciidoc @@ -342,7 +342,7 @@ Create your map and set the theme for the default layer to dark mode. . Click *Create map*. . In the *Layers* list, click *Road map*, and then click *Edit layer settings*. . Open the *Tile service* dropdown, and select *Road map - dark*. -. Click *Save & close*. +. Click *Keep changes*. [float] ==== Step 2. Add a tracks layer @@ -355,12 +355,12 @@ Add a layer to show the bus routes for the last 15 minutes. . Define the tracks: .. Set *Entity* to *trimet.vehicleID*. .. Set *Sort* to *trimet.time*. -. Click *Add layer*. +. Click *Add and continue*. . In Layer settings: .. Set *Name* to *Buses*. .. Set *Opacity* to 80%. . Scroll to *Layer Style*, and set *Border color* to pink. -. Click *Save & close*. +. Click *Keep changes*. . In the *Layers* list, click *Buses*, and then click *Fit to data*. At this point, you have a map with lines that represent the routes of the buses as they move around the city. @@ -380,7 +380,7 @@ Add a layer that uses attributes in the data to set the style and orientation of .. Set *Documents per entity* to 1. .. Set *Sort field* to *trimet.time*. .. Set *Sort order* to *descending*. -. Click *Add layer*. +. Click *Add and continue*. . Scroll to *Layer Style*. .. Set *Symbol type* to *icon*. .. Set *Icon* to *arrow-es*. @@ -395,7 +395,7 @@ Add a layer that uses attributes in the data to set the style and orientation of + [role="screenshot"] image::maps/images/asset-tracking-tutorial/top_hits_layer_style.png[] -. Click *Save & close*. +. Click *Keep changes*. . Open the <>, and set *Refresh every* to 10 seconds, and click *Start*. Your map should automatically refresh every 10 seconds to show the latest bus positions and tracks. @@ -423,7 +423,7 @@ Add a layer for construction zones, which you will draw on the map. The construc . When you finish drawing the construction zones, click *Exit* under the layer name in the legend. . In *Layer settings*, set *Name* to *Construction zones*. . Scroll to *Layer Style*, and set *Fill color* to yellow. -. Click *Save & close*. +. Click *Keep changes*. . *Save* the map. .. Give the map a title. .. Under *Add to dashboard*, select *None*. diff --git a/docs/maps/geojson-upload.asciidoc b/docs/maps/geojson-upload.asciidoc index 15ef3471e58d7..f4208663078af 100644 --- a/docs/maps/geojson-upload.asciidoc +++ b/docs/maps/geojson-upload.asciidoc @@ -39,6 +39,6 @@ the Elasticsearch responses are shown on the *Layer add panel* and the indexed d appears on the map. The geospatial data on the map should be identical to the locally-previewed data, but now it's indexed data from Elasticsearch. -. To continue adding data to the map, click *Add layer*. +. To continue adding data to the map, click *Add and continue*. . In *Layer settings*, adjust any settings or <> as needed. -. Click *Save & close*. +. Click *Keep changes*. diff --git a/docs/maps/import-geospatial-data.asciidoc b/docs/maps/import-geospatial-data.asciidoc index 8ee54e5dba638..e84ba3c3cbd27 100644 --- a/docs/maps/import-geospatial-data.asciidoc +++ b/docs/maps/import-geospatial-data.asciidoc @@ -94,9 +94,7 @@ To open an existing index for drawing: . Select the data view that points to your index. A <> can point to one or more indices. For feature editing, the data view must point to a single index. -. Click *Add layer*. - -. Click *Save & close*. +. Click *Add and close*. . In the legend, click the layer name and select *Edit features*. diff --git a/docs/maps/indexing-geojson-data-tutorial.asciidoc b/docs/maps/indexing-geojson-data-tutorial.asciidoc index 50c32b98f0b4c..23e9a64ce5dd2 100644 --- a/docs/maps/indexing-geojson-data-tutorial.asciidoc +++ b/docs/maps/indexing-geojson-data-tutorial.asciidoc @@ -65,7 +65,7 @@ were successful. . Click *Add layer*. . In *Layer settings*, adjust settings and <> as needed. -. Click *Save & close*. +. Click *Keep changes*. . Once you've added all of the sample files, <>. + @@ -106,7 +106,7 @@ settings that you might want to change. Again the default looks good, but feel free to choose a different color range. -. When you're finished modifying settings, click *Save & close*. +. When you're finished modifying settings, click *Keep changes*. + With your new lightning heat map layer, your map should look like this: diff --git a/docs/maps/map-settings.asciidoc b/docs/maps/map-settings.asciidoc index 5f353f99da375..c0325b3f33bb3 100644 --- a/docs/maps/map-settings.asciidoc +++ b/docs/maps/map-settings.asciidoc @@ -3,7 +3,7 @@ == Configure map settings Maps offers settings that let you configure how a map is displayed. -To access these settings, click *Map settings* in the application toolbar. +To access these settings, click *Settings* in the application toolbar. [float] [[maps-settings-custom-icons]] diff --git a/docs/maps/maps-getting-started.asciidoc b/docs/maps/maps-getting-started.asciidoc index 317a9657f1965..39579d935275e 100644 --- a/docs/maps/maps-getting-started.asciidoc +++ b/docs/maps/maps-getting-started.asciidoc @@ -52,7 +52,7 @@ and lighter shades will symbolize countries with less traffic. ** **Data view** to **kibana_sample_data_logs** ** **Join field** to **geo.dest** -. Click **Add layer**. +. Click **Add and continue**. . In **Layer settings**, set: @@ -71,7 +71,7 @@ and lighter shades will symbolize countries with less traffic. ** Set **Border color** to white. ** Under **Label**, change **By value** to **Fixed**. -. Click **Save & close**. +. Click **Keep changes**. + Your map now looks like this: + @@ -97,7 +97,7 @@ The layer is only visible when users zoom in. . Set **Data view** to **kibana_sample_data_logs**. -. Click **Add layer**. +. Click **Add and continue**. . In **Layer settings**, set: ** **Name** to `Actual Requests` @@ -111,7 +111,7 @@ The layer is only visible when users zoom in. . In **Layer style**, set **Fill color** to **#2200FF**. -. Click **Save & close**. +. Click **Keep changes**. + Your map will look like this from zoom level 9 to 24: + @@ -130,7 +130,7 @@ grids with less bytes transferred. . Click **Add layer**, and select **Clusters**. . Set **Data view** to **kibana_sample_data_logs**. -. Click **Add layer**. +. Click **Add and continue**. . In **Layer settings**, set: ** **Name** to `Total Requests and Bytes` ** **Visibility** to the range [0, 9] @@ -142,7 +142,7 @@ grids with less bytes transferred. . In **Layer style**, change **Symbol size**: ** Set *By value* to *sum bytes*. ** Set the min size to 7 and the max size to 25 px. -. Click **Save & close** button. +. Click **Keep changes** button. + Your map will look like this between zoom levels 0 and 9: + diff --git a/docs/maps/reverse-geocoding-tutorial.asciidoc b/docs/maps/reverse-geocoding-tutorial.asciidoc index 059a7ec4e7b83..48151281fb07d 100644 --- a/docs/maps/reverse-geocoding-tutorial.asciidoc +++ b/docs/maps/reverse-geocoding-tutorial.asciidoc @@ -60,7 +60,7 @@ To get the CSA boundary data: .. Click *+ Add* to open the field select. .. Select *NAME*, *GEOID*, and *AFFGEOID*. .. Click *Add*. -. Click *Save & close*. +. Click *Keep changes*. Looking at the map, you get a sense of what constitutes a metro area in the eyes of the Census Bureau. @@ -169,9 +169,9 @@ Now that our web traffic contains CSA region identifiers, you'll visualize CSA r . For *Statistics source*: .. Set *Data view* to *Kibana Sample Data Logs*. .. Set *Join field* to *csa.GEOID.keyword*. -. Click *Add layer*. +. Click *Add and continue*. . Scroll to *Layer Style* and Set *Label* to *Fixed*. -. Click *Save & close*. +. Click *Keep changes*. . *Save* the map. .. Give the map a title. .. Under *Add to dashboard*, select *None*. diff --git a/docs/maps/vector-style-properties.asciidoc b/docs/maps/vector-style-properties.asciidoc index 431dbac6130e2..ab59a26743fe7 100644 --- a/docs/maps/vector-style-properties.asciidoc +++ b/docs/maps/vector-style-properties.asciidoc @@ -71,7 +71,7 @@ You can also use your own SVG icon to style Point features in your map. In **Lay Dynamic styling in **Elastic Maps** requires rendering SVG icons as PNGs using a https://en.wikipedia.org/wiki/Signed_distance_function[signed distance function]. As a result, sharp corners and intricate details may not render correctly. Modifying the settings under **Advanced Options** in the **Add custom icon** modal may improve rendering. -Manage your custom icons in <>. +Manage your custom icons in <>. [float] [[polygon-style-properties]] diff --git a/examples/content_management_examples/common/examples/todos/todos.ts b/examples/content_management_examples/common/examples/todos/todos.ts index 0371651c128f9..ff3ebbfac537d 100644 --- a/examples/content_management_examples/common/examples/todos/todos.ts +++ b/examples/content_management_examples/common/examples/todos/todos.ts @@ -6,13 +6,17 @@ * Side Public License, v 1. */ -import { schema } from '@kbn/config-schema'; import { CreateIn, + CreateResult, DeleteIn, + DeleteResult, GetIn, + GetResult, SearchIn, + SearchResult, UpdateIn, + UpdateResult, } from '@kbn/content-management-plugin/common'; export const TODO_CONTENT_ID = 'todos'; @@ -21,43 +25,18 @@ export interface Todo { title: string; completed: boolean; } -const todoSchema = schema.object({ - id: schema.string(), - title: schema.string(), - completed: schema.boolean(), -}); export type TodoCreateIn = CreateIn<'todos', { title: string }>; -export type TodoCreateOut = Todo; // TODO: Is this correct? -export const createInSchema = schema.object({ title: schema.string() }); -export const createOutSchema = todoSchema; +export type TodoCreateOut = CreateResult; export type TodoUpdateIn = UpdateIn<'todos', Partial>>; -export type TodoUpdateOut = Todo; -export const updateInSchema = schema.object({ - title: schema.maybe(schema.string()), - completed: schema.maybe(schema.boolean()), -}); -export const updateOutSchema = todoSchema; +export type TodoUpdateOut = UpdateResult; export type TodoDeleteIn = DeleteIn<'todos', { id: string }>; -export type TodoDeleteOut = void; +export type TodoDeleteOut = DeleteResult; export type TodoGetIn = GetIn<'todos'>; -export type TodoGetOut = Todo; -export const getOutSchema = todoSchema; +export type TodoGetOut = GetResult; export type TodoSearchIn = SearchIn<'todos', { filter?: 'todo' | 'completed' }>; -export interface TodoSearchOut { - hits: Todo[]; -} -export const searchInSchema = schema.object({ - filter: schema.maybe( - schema.oneOf([schema.literal('todo'), schema.literal('completed')], { - defaultValue: undefined, - }) - ), -}); -export const searchOutSchema = schema.object({ - hits: schema.arrayOf(todoSchema), -}); +export type TodoSearchOut = SearchResult; diff --git a/examples/content_management_examples/public/examples/todos/stories/todo.stories.tsx b/examples/content_management_examples/public/examples/todos/stories/todo.stories.tsx index 9a37ac2816f6c..8d458bc3e8cf7 100644 --- a/examples/content_management_examples/public/examples/todos/stories/todo.stories.tsx +++ b/examples/content_management_examples/public/examples/todos/stories/todo.stories.tsx @@ -24,7 +24,7 @@ const todosClient = new TodosClient(); const contentTypeRegistry = new ContentTypeRegistry(); contentTypeRegistry.register({ id: 'todos', version: { latest: 1 } }); -const contentClient = new ContentClient((contentType: string) => { +const contentClient = new ContentClient((contentType?: string) => { switch (contentType) { case 'todos': return todosClient; diff --git a/examples/content_management_examples/public/examples/todos/stories/todos_client.ts b/examples/content_management_examples/public/examples/todos/stories/todos_client.ts index 04d1f6fb990ed..f89ceac96bcd2 100644 --- a/examples/content_management_examples/public/examples/todos/stories/todos_client.ts +++ b/examples/content_management_examples/public/examples/todos/stories/todos_client.ts @@ -39,22 +39,40 @@ export class TodosClient implements CrudClient { completed: false, }; this.todos.push(todo); - return todo; + return { + item: todo, + }; } async delete(input: TodoDeleteIn): Promise { this.todos = this.todos.filter((todo) => todo.id !== input.id); + return { success: true }; } async get(input: TodoGetIn): Promise { - return this.todos.find((todo) => todo.id === input.id)!; + return { + item: this.todos.find((todo) => todo.id === input.id)!, + }; } async search(input: TodoSearchIn): Promise { - const filter = input.query.filter; - if (filter === 'todo') return { hits: this.todos.filter((t) => !t.completed) }; - if (filter === 'completed') return { hits: this.todos.filter((t) => t.completed) }; - return { hits: [...this.todos] }; + const filter = input.options?.filter; + let hits = [...this.todos]; + + if (filter === 'todo') { + hits = this.todos.filter((t) => !t.completed); + } + + if (filter === 'completed') { + hits = this.todos.filter((t) => t.completed); + } + + return { + hits, + pagination: { + total: hits.length, + }, + }; } async update(input: TodoUpdateIn): Promise { @@ -63,6 +81,10 @@ export class TodosClient implements CrudClient { if (todoToUpdate) { Object.assign(todoToUpdate, input.data); } - return { ...todoToUpdate }; + return { + item: { + ...todoToUpdate, + }, + }; } } diff --git a/examples/content_management_examples/public/examples/todos/todos.tsx b/examples/content_management_examples/public/examples/todos/todos.tsx index 5c3bcfd4880e9..7db98c1a5e3f9 100644 --- a/examples/content_management_examples/public/examples/todos/todos.tsx +++ b/examples/content_management_examples/public/examples/todos/todos.tsx @@ -37,10 +37,11 @@ import { const useCreateTodoMutation = () => useCreateContentMutation(); const useDeleteTodoMutation = () => useDeleteContentMutation(); const useUpdateTodoMutation = () => useUpdateContentMutation(); -const useSearchTodosQuery = ({ filter }: { filter: TodoSearchIn['query']['filter'] }) => +const useSearchTodosQuery = ({ options: { filter } = {} }: { options: TodoSearchIn['options'] }) => useSearchContentQuery({ contentTypeId: TODO_CONTENT_ID, - query: { filter }, + query: {}, + options: { filter }, }); type TodoFilter = 'all' | 'completed' | 'todo'; @@ -63,7 +64,7 @@ export const Todos = () => { const [filterIdSelected, setFilterIdSelected] = React.useState('all'); const { data, isError, error, isFetching, isLoading } = useSearchTodosQuery({ - filter: filterIdSelected === 'all' ? undefined : filterIdSelected, + options: { filter: filterIdSelected === 'all' ? undefined : filterIdSelected }, }); const createTodoMutation = useCreateTodoMutation(); diff --git a/examples/content_management_examples/server/examples/todos/todos.ts b/examples/content_management_examples/server/examples/todos/todos.ts index 6addc5ed50148..4a6d0fa0aee77 100644 --- a/examples/content_management_examples/server/examples/todos/todos.ts +++ b/examples/content_management_examples/server/examples/todos/todos.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import type { BulkGetResult } from '@kbn/content-management-plugin/common'; import { ContentStorage, StorageContext, @@ -39,7 +40,7 @@ export const registerTodoContentType = ({ }); }; -class TodosStorage implements ContentStorage { +class TodosStorage implements ContentStorage { private db: Map = new Map(); constructor() { @@ -58,11 +59,15 @@ class TodosStorage implements ContentStorage { } async get(ctx: StorageContext, id: string): Promise { - return this.db.get(id)!; + return { + item: this.db.get(id)!, + }; } - async bulkGet(ctx: StorageContext, ids: string[]): Promise { - return ids.map((id) => this.db.get(id)!); + async bulkGet(ctx: StorageContext, ids: string[]): Promise> { + return { + hits: ids.map((id) => ({ item: this.db.get(id)! })), + }; } async create(ctx: StorageContext, data: TodoCreateIn['data']): Promise { @@ -74,7 +79,9 @@ class TodosStorage implements ContentStorage { this.db.set(todo.id, todo); - return todo; + return { + item: todo, + }; } async update( @@ -94,17 +101,36 @@ class TodosStorage implements ContentStorage { this.db.set(id, updatedContent); - return updatedContent; + return { + item: updatedContent, + }; } async delete(ctx: StorageContext, id: string): Promise { this.db.delete(id); + return { success: true }; } - async search(ctx: StorageContext, query: TodoSearchIn['query']): Promise { - const hits = Array.from(this.db.values()); - if (query.filter === 'todo') return { hits: hits.filter((t) => !t.completed) }; - if (query.filter === 'completed') return { hits: hits.filter((t) => t.completed) }; - return { hits }; + async search( + ctx: StorageContext, + _: TodoSearchIn['query'], + options: TodoSearchIn['options'] + ): Promise { + let hits = Array.from(this.db.values()); + + if (options?.filter === 'todo') { + hits = hits.filter((t) => !t.completed); + } + + if (options?.filter === 'completed') { + hits = hits.filter((t) => t.completed); + } + + return { + hits, + pagination: { + total: hits.length, + }, + }; } } diff --git a/examples/content_management_examples/tsconfig.json b/examples/content_management_examples/tsconfig.json index 1e899345b0bf4..f383cd9d9b33e 100644 --- a/examples/content_management_examples/tsconfig.json +++ b/examples/content_management_examples/tsconfig.json @@ -17,7 +17,6 @@ "kbn_references": [ "@kbn/core", "@kbn/developer-examples-plugin", - "@kbn/config-schema", "@kbn/content-management-plugin", "@kbn/core-application-browser", ] diff --git a/fleet_packages.json b/fleet_packages.json index 0585444fd0048..ae7bdca17b4c6 100644 --- a/fleet_packages.json +++ b/fleet_packages.json @@ -24,17 +24,17 @@ [ { "name": "apm", - "version": "8.8.0-preview-1676887316", + "version": "8.8.0-preview-1680182372", "forceAlignStackVersion": true, "allowSyncToPrerelease": true }, { "name": "elastic_agent", - "version": "1.5.1" + "version": "1.7.0" }, { "name": "endpoint", - "version": "8.7.0" + "version": "8.7.1" }, { "name": "fleet_server", @@ -42,7 +42,7 @@ }, { "name": "synthetics", - "version": "0.11.5" + "version": "0.12.1" }, { "name": "security_detection_engine", diff --git a/nav-kibana-dev.docnav.json b/nav-kibana-dev.docnav.json index db5e8b3ef5055..237a5a1b94a9b 100644 --- a/nav-kibana-dev.docnav.json +++ b/nav-kibana-dev.docnav.json @@ -183,6 +183,9 @@ { "label": "Contributors Newsletters", "items": [ + { + "id": "kibMarch2023ContributorNewsletter" + }, { "id": "kibJanuary2023ContributorNewsletter" }, diff --git a/package.json b/package.json index 330c675618c4c..b4a7a8ac9632c 100644 --- a/package.json +++ b/package.json @@ -92,7 +92,7 @@ "@dnd-kit/utilities": "^2.0.0", "@elastic/apm-rum": "^5.12.0", "@elastic/apm-rum-react": "^1.4.2", - "@elastic/charts": "54.0.0", + "@elastic/charts": "55.0.0", "@elastic/datemath": "5.0.3", "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@8.6.0-canary.3", "@elastic/ems-client": "8.4.0", @@ -486,6 +486,7 @@ "@kbn/newsfeed-test-plugin": "link:test/common/plugins/newsfeed", "@kbn/notifications-plugin": "link:x-pack/plugins/notifications", "@kbn/object-versioning": "link:packages/kbn-object-versioning", + "@kbn/observability-alert-details": "link:x-pack/packages/observability/alert_details", "@kbn/observability-fixtures-plugin": "link:x-pack/test/cases_api_integration/common/plugins/observability", "@kbn/observability-plugin": "link:x-pack/plugins/observability", "@kbn/oidc-provider-plugin": "link:x-pack/test/security_api_integration/plugins/oidc_provider", @@ -719,6 +720,7 @@ "JSONStream": "1.3.5", "abort-controller": "^3.0.0", "adm-zip": "^0.5.9", + "ajv": "^8.11.0", "antlr4ts": "^0.5.0-alpha.3", "archiver": "^5.3.1", "async": "^3.2.3", @@ -1296,7 +1298,6 @@ "@yarnpkg/lockfile": "^1.1.0", "abab": "^2.0.4", "aggregate-error": "^3.1.0", - "ajv": "^8.11.0", "antlr4ts-cli": "^0.5.0-alpha.3", "apidoc-markdown": "^7.2.4", "argsplit": "^1.0.5", diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/es_errors.test.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/es_errors.test.ts index f0004851b1bf9..a68cc62e76c50 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/es_errors.test.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/es_errors.test.ts @@ -61,6 +61,14 @@ describe('isIncompatibleMappingExceptionError', () => { }) ).toEqual(true); }); + it('returns true for `document_parsing_exception` errors', () => { + expect( + isIncompatibleMappingException({ + type: 'document_parsing_exception', + reason: 'idk', + }) + ).toEqual(true); + }); it('returns false undefined', () => { expect(isIncompatibleMappingException(undefined)).toEqual(false); }); diff --git a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/es_errors.ts b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/es_errors.ts index 5b2001f06e510..c4eeebd7df216 100644 --- a/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/es_errors.ts +++ b/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/actions/es_errors.ts @@ -17,7 +17,8 @@ export const isWriteBlockException = (errorCause?: estypes.ErrorCause): boolean export const isIncompatibleMappingException = (errorCause?: estypes.ErrorCause): boolean => { return ( errorCause?.type === 'strict_dynamic_mapping_exception' || - errorCause?.type === 'mapper_parsing_exception' + errorCause?.type === 'mapper_parsing_exception' || + errorCause?.type === 'document_parsing_exception' ); }; diff --git a/packages/kbn-es-query/src/kuery/node_types/node_builder.test.ts b/packages/kbn-es-query/src/kuery/node_types/node_builder.test.ts index 141eb66b3ed58..46e21245bf333 100644 --- a/packages/kbn-es-query/src/kuery/node_types/node_builder.test.ts +++ b/packages/kbn-es-query/src/kuery/node_types/node_builder.test.ts @@ -277,4 +277,33 @@ describe('nodeBuilder', () => { `); }); }); + + describe('range method', () => { + const date = new Date(1679741259769); + const dateString = date.toISOString(); + + test('formats all range operators', () => { + const operators: Array<'gt' | 'gte' | 'lt' | 'lte'> = ['gt', 'gte', 'lt', 'lte']; + + for (const operator of operators) { + const nodes = nodeBuilder.range('foo', operator, dateString); + const query = toElasticsearchQuery(nodes); + + expect(query).toMatchObject({ + bool: { + minimum_should_match: 1, + should: [ + { + range: { + foo: { + [operator]: dateString, + }, + }, + }, + ], + }, + }); + } + }); + }); }); diff --git a/packages/kbn-es-query/src/kuery/node_types/node_builder.ts b/packages/kbn-es-query/src/kuery/node_types/node_builder.ts index a575bb2d75c67..948985c965378 100644 --- a/packages/kbn-es-query/src/kuery/node_types/node_builder.ts +++ b/packages/kbn-es-query/src/kuery/node_types/node_builder.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import type { RangeFilterParams } from '../../filters'; import { KueryNode, nodeTypes } from '../types'; export const nodeBuilder = { @@ -21,4 +22,15 @@ export const nodeBuilder = { and: (nodes: KueryNode[]): KueryNode => { return nodes.length > 1 ? nodeTypes.function.buildNode('and', nodes) : nodes[0]; }, + range: ( + fieldName: string, + operator: keyof Pick, + value: number | string + ) => { + return nodeTypes.function.buildNodeWithArgumentNodes('range', [ + nodeTypes.literal.buildNode(fieldName), + operator, + typeof value === 'string' ? nodeTypes.literal.buildNode(value) : value, + ]); + }, }; diff --git a/packages/kbn-expandable-flyout/README.md b/packages/kbn-expandable-flyout/README.md index 8d21caba73a21..8a9a201ff89af 100644 --- a/packages/kbn-expandable-flyout/README.md +++ b/packages/kbn-expandable-flyout/README.md @@ -61,6 +61,5 @@ A set of properties defining what's displayed in one of the flyout section. ## Future work -- currently the panels are aware of their width. This should be changed and the width of the left, right and preview sections should be handled by the flyout itself -- add the feature to save the flyout state (layout) to the url +- add the feature to save the flyout state (layout) to the url (https://github.com/elastic/security-team/issues/6119) - introduce the notion of scope to be able to handle more than one flyout per plugin?? \ No newline at end of file diff --git a/packages/kbn-expandable-flyout/src/components/left_section.tsx b/packages/kbn-expandable-flyout/src/components/left_section.tsx index ddf53efbad2b8..88326acb6476e 100644 --- a/packages/kbn-expandable-flyout/src/components/left_section.tsx +++ b/packages/kbn-expandable-flyout/src/components/left_section.tsx @@ -26,10 +26,8 @@ interface LeftSectionProps { */ export const LeftSection: React.FC = ({ component, width }: LeftSectionProps) => { return ( - - - {component} - + + {component} ); }; diff --git a/packages/kbn-expandable-flyout/src/components/preview_section.tsx b/packages/kbn-expandable-flyout/src/components/preview_section.tsx index e474d1204bf03..0c030293e8807 100644 --- a/packages/kbn-expandable-flyout/src/components/preview_section.tsx +++ b/packages/kbn-expandable-flyout/src/components/preview_section.tsx @@ -32,7 +32,7 @@ interface PreviewSectionProps { /** * Width used when rendering the panel */ - width: number | undefined; + width: number; /** * Display the back button in the header */ @@ -50,8 +50,7 @@ export const PreviewSection: React.FC = ({ }: PreviewSectionProps) => { const { euiTheme } = useEuiTheme(); const { closePreviewPanel, previousPreviewPanel } = useExpandableFlyoutContext(); - - const previewWith: string = width ? `${width}px` : '0px'; + const left = `${(1 - width) * 100}%`; const closeButton = ( @@ -91,7 +90,7 @@ export const PreviewSection: React.FC = ({ top: 0; bottom: 0; right: 0; - left: ${previewWith}; + left: ${left}; background-color: ${euiTheme.colors.shadow}; opacity: 0.5; `} @@ -102,7 +101,7 @@ export const PreviewSection: React.FC = ({ top: 0; bottom: 0; right: 0; - left: ${previewWith}; + left: ${left}; z-index: 1000; `} > diff --git a/packages/kbn-expandable-flyout/src/components/right_section.tsx b/packages/kbn-expandable-flyout/src/components/right_section.tsx index d018dd8721ee7..027f523a93050 100644 --- a/packages/kbn-expandable-flyout/src/components/right_section.tsx +++ b/packages/kbn-expandable-flyout/src/components/right_section.tsx @@ -29,10 +29,12 @@ export const RightSection: React.FC = ({ width, }: RightSectionProps) => { return ( - - - {component} - + + {component} ); }; diff --git a/packages/kbn-expandable-flyout/src/index.test.tsx b/packages/kbn-expandable-flyout/src/index.test.tsx index fd1d1990ffbad..2e30d5f307190 100644 --- a/packages/kbn-expandable-flyout/src/index.test.tsx +++ b/packages/kbn-expandable-flyout/src/index.test.tsx @@ -17,7 +17,6 @@ describe('ExpandableFlyout', () => { const registeredPanels: Panel[] = [ { key: 'key', - width: 500, component: () =>
{'component'}
, }, ]; diff --git a/packages/kbn-expandable-flyout/src/index.tsx b/packages/kbn-expandable-flyout/src/index.tsx index 80dd1d425f2a2..8dc44a87dab45 100644 --- a/packages/kbn-expandable-flyout/src/index.tsx +++ b/packages/kbn-expandable-flyout/src/index.tsx @@ -30,6 +30,9 @@ export interface ExpandableFlyoutProps extends EuiFlyoutProps { /** * Expandable flyout UI React component. * Displays 3 sections (right, left, preview) depending on the panels in the context. + * + * The behavior expects that the left and preview sections should only be displayed is a right section + * is already rendered. */ export const ExpandableFlyout: React.FC = ({ registeredPanels, @@ -67,7 +70,10 @@ export const ExpandableFlyout: React.FC = ({ return <>; } - const width: number = (leftSection?.width ?? 0) + (rightSection?.width ?? 0); + const flyoutWidth: string = leftSection && rightSection ? 'l' : 's'; + const rightSectionWidth: number = leftSection ? 0.4 : 1; + const leftSectionWidth: number = 0.6; + const previewSectionWidth: number = leftSection ? 0.4 : 1; return ( = ({ overflow-y: scroll; `} {...flyoutProps} - size={width} + size={flyoutWidth} ownFocus={false} onClose={onClose} > @@ -88,13 +94,13 @@ export const ExpandableFlyout: React.FC = ({ {leftSection && left ? ( ) : null} {rightSection && right ? ( ) : null} @@ -103,7 +109,7 @@ export const ExpandableFlyout: React.FC = ({ ) : null} diff --git a/packages/kbn-expandable-flyout/src/types.ts b/packages/kbn-expandable-flyout/src/types.ts index 2413fbb56ca7d..b27ac4afd6fc2 100644 --- a/packages/kbn-expandable-flyout/src/types.ts +++ b/packages/kbn-expandable-flyout/src/types.ts @@ -36,8 +36,4 @@ export interface Panel { * Component to be rendered */ component: (props: FlyoutPanel) => React.ReactElement; - /** - * Width used when rendering the panel - */ - width: number; // TODO remove this, see https://github.com/elastic/security-team/issues/6247 } diff --git a/packages/kbn-object-versioning/lib/content_management_services_schemas.ts b/packages/kbn-object-versioning/lib/content_management_services_schemas.ts index 4b87cc458b16a..90e8400689dc2 100644 --- a/packages/kbn-object-versioning/lib/content_management_services_schemas.ts +++ b/packages/kbn-object-versioning/lib/content_management_services_schemas.ts @@ -88,7 +88,6 @@ const searchSchemas = getOptionalInOutSchemas({ in: schema.maybe( schema.object( { - query: schema.maybe(versionableObjectSchema), options: schema.maybe(versionableObjectSchema), }, { unknowns: 'forbid' } diff --git a/packages/kbn-object-versioning/lib/content_management_services_versioning.test.ts b/packages/kbn-object-versioning/lib/content_management_services_versioning.test.ts index 1470dd70a765a..49b55b0da44fc 100644 --- a/packages/kbn-object-versioning/lib/content_management_services_versioning.test.ts +++ b/packages/kbn-object-versioning/lib/content_management_services_versioning.test.ts @@ -179,7 +179,6 @@ describe('CM services getTransforms()', () => { ...getVersionnableObjectTests('delete.in.options'), ...getVersionnableObjectTests('delete.out.result'), ...getVersionnableObjectTests('search.in.options'), - ...getVersionnableObjectTests('search.in.query'), ...getVersionnableObjectTests('search.out.result'), ].forEach(({ definitions, expected, ref, error = 'Invalid services definition.' }: any) => { test(`validate: ${ref}`, () => { @@ -239,7 +238,6 @@ describe('CM services getTransforms()', () => { 'update.out.result', 'delete.in.options', 'delete.out.result', - 'search.in.query', 'search.in.options', 'search.out.result', ].sort() diff --git a/packages/kbn-object-versioning/lib/content_management_services_versioning.ts b/packages/kbn-object-versioning/lib/content_management_services_versioning.ts index 72016a34684db..5655a094f5e42 100644 --- a/packages/kbn-object-versioning/lib/content_management_services_versioning.ts +++ b/packages/kbn-object-versioning/lib/content_management_services_versioning.ts @@ -32,7 +32,6 @@ const serviceObjectPaths = [ 'update.out.result', 'delete.in.options', 'delete.out.result', - 'search.in.query', 'search.in.options', 'search.out.result', ]; @@ -171,7 +170,6 @@ const getDefaultServiceTransforms = (): ServiceTransforms => ({ search: { in: { options: getDefaultTransforms(), - query: getDefaultTransforms(), }, out: { result: getDefaultTransforms(), diff --git a/packages/kbn-object-versioning/lib/content_management_types.ts b/packages/kbn-object-versioning/lib/content_management_types.ts index 004c77f8ff605..f6304d14752c7 100644 --- a/packages/kbn-object-versioning/lib/content_management_types.ts +++ b/packages/kbn-object-versioning/lib/content_management_types.ts @@ -11,53 +11,52 @@ import type { ObjectTransforms, Version, VersionableObject } from './types'; export interface ServicesDefinition { get?: { in?: { - options?: VersionableObject; + options?: VersionableObject; }; out?: { - result?: VersionableObject; + result?: VersionableObject; }; }; bulkGet?: { in?: { - options?: VersionableObject; + options?: VersionableObject; }; out?: { - result?: VersionableObject; + result?: VersionableObject; }; }; create?: { in?: { - data?: VersionableObject; - options?: VersionableObject; + data?: VersionableObject; + options?: VersionableObject; }; out?: { - result?: VersionableObject; + result?: VersionableObject; }; }; update?: { in?: { - data?: VersionableObject; - options?: VersionableObject; + data?: VersionableObject; + options?: VersionableObject; }; out?: { - result?: VersionableObject; + result?: VersionableObject; }; }; delete?: { in?: { - options?: VersionableObject; + options?: VersionableObject; }; out?: { - result?: VersionableObject; + result?: VersionableObject; }; }; search?: { in?: { - query?: VersionableObject; - options?: VersionableObject; + options?: VersionableObject; }; out?: { - result?: VersionableObject; + result?: VersionableObject; }; }; } @@ -107,7 +106,6 @@ export interface ServiceTransforms { }; search: { in: { - query: ObjectTransforms; options: ObjectTransforms; }; out: { diff --git a/packages/kbn-object-versioning/lib/object_transform.test.ts b/packages/kbn-object-versioning/lib/object_transform.test.ts index ee1880313b2b7..795b9582c5c1b 100644 --- a/packages/kbn-object-versioning/lib/object_transform.test.ts +++ b/packages/kbn-object-versioning/lib/object_transform.test.ts @@ -25,7 +25,7 @@ const v1Tv2Transform = jest.fn((v1: FooV1): FooV2 => { return { firstName, lastName }; }); -const fooDefV1: VersionableObject = { +const fooDefV1: VersionableObject = { schema: schema.object({ fullName: schema.string({ minLength: 1 }), }), @@ -43,7 +43,7 @@ const v2Tv1Transform = jest.fn((v2: FooV2): FooV1 => { }; }); -const fooDefV2: VersionableObject = { +const fooDefV2: VersionableObject = { schema: schema.object({ firstName: schema.string(), lastName: schema.string(), @@ -56,8 +56,10 @@ const fooMigrationDef: ObjectMigrationDefinition = { 2: fooDefV2, }; -const setup = (browserVersion: Version): ObjectTransforms => { - const transformsFactory = initTransform(browserVersion); +const setup = ( + browserVersion: Version +): ObjectTransforms => { + const transformsFactory = initTransform(browserVersion); return transformsFactory(fooMigrationDef); }; @@ -127,7 +129,12 @@ describe('object transform', () => { describe('down()', () => { test('it should down transform to a previous version', () => { - const fooTransforms = setup(1); + const fooTransforms = setup< + void, + void, + { firstName: string; lastName: string }, + { fullName: string } + >(1); const { value } = fooTransforms.down({ firstName: 'John', lastName: 'Snow' }); const expected = { fullName: 'John Snow' }; expect(value).toEqual(expected); diff --git a/packages/kbn-object-versioning/lib/object_transform.ts b/packages/kbn-object-versioning/lib/object_transform.ts index 266906a352a6f..9cc3e32e41366 100644 --- a/packages/kbn-object-versioning/lib/object_transform.ts +++ b/packages/kbn-object-versioning/lib/object_transform.ts @@ -45,15 +45,15 @@ const getVersionsMeta = (migrationDefinition: ObjectMigrationDefinition) => { * @param migrationDefinition The object migration definition * @returns An array of transform functions */ -const getTransformFns = ( +const getTransformFns = ( from: Version, to: Version, migrationDefinition: ObjectMigrationDefinition -): ObjectTransform[] => { - const fns: ObjectTransform[] = []; +): Array> => { + const fns: Array> = []; let i = from; - let fn: ObjectTransform | undefined; + let fn: ObjectTransform | undefined; if (to > from) { while (i <= to) { fn = migrationDefinition[i].up; @@ -96,8 +96,10 @@ const getTransformFns = ( * @returns A handler to pass an object migration definition */ export const initTransform = - (requestVersion: Version) => - (migrationDefinition: ObjectMigrationDefinition): ObjectTransforms => { + (requestVersion: Version) => + ( + migrationDefinition: ObjectMigrationDefinition + ): ObjectTransforms => { const { latestVersion } = getVersionsMeta(migrationDefinition); const getVersion = (v: Version | 'latest'): Version => (v === 'latest' ? latestVersion : v); @@ -143,9 +145,17 @@ export const initTransform = }; } - const fns = getTransformFns(requestVersion, targetVersion, migrationDefinition); + const fns = getTransformFns( + requestVersion, + targetVersion, + migrationDefinition + ); + + const value = fns.reduce((acc, fn) => { + const res = fn(acc as unknown as UpIn); + return res; + }, obj as unknown as UpOut); - const value = fns.reduce((acc, fn) => fn(acc), obj); return { value, error: null }; } catch (e) { return { @@ -179,10 +189,18 @@ export const initTransform = } } - const fns = getTransformFns(fromVersion, requestVersion, migrationDefinition); - const value = fns.reduce((acc, fn) => fn(acc), obj); + const fns = getTransformFns( + fromVersion, + requestVersion, + migrationDefinition + ); - return { value, error: null }; + const value = fns.reduce((acc, fn) => { + const res = fn(acc as unknown as DownIn); + return res; + }, obj as unknown as DownOut); + + return { value: value as any, error: null }; } catch (e) { return { value: null, diff --git a/packages/kbn-object-versioning/lib/types.ts b/packages/kbn-object-versioning/lib/types.ts index f177c3a282167..7bf3e8aefac7c 100644 --- a/packages/kbn-object-versioning/lib/types.ts +++ b/packages/kbn-object-versioning/lib/types.ts @@ -9,19 +9,24 @@ import type { Type, ValidationError } from '@kbn/config-schema'; export type Version = number; -export type ObjectTransform = (input: I) => O; +export type ObjectTransform = (input: I) => O; -export interface VersionableObject { +export interface VersionableObject< + UpIn = unknown, + UpOut = unknown, + DownIn = unknown, + DownOut = unknown +> { schema?: Type; - down?: ObjectTransform; - up?: ObjectTransform; + down?: ObjectTransform; + up?: ObjectTransform; } export interface ObjectMigrationDefinition { - [version: Version]: VersionableObject; + [version: Version]: VersionableObject; } -export type TransformReturn = +export type TransformReturn = | { value: T; error: null; @@ -31,22 +36,27 @@ export type TransformReturn = error: ValidationError | Error; }; -export interface ObjectTransforms { +export interface ObjectTransforms< + UpIn = unknown, + UpOut = unknown, + DownIn = unknown, + DownOut = unknown +> { up: ( - obj: Current, + obj: UpIn, version?: Version | 'latest', options?: { /** Validate the object _before_ up transform */ validate?: boolean; } - ) => TransformReturn; + ) => TransformReturn; down: ( - obj: Current, + obj: DownIn, version?: Version | 'latest', options?: { /** Validate the object _before_ down transform */ validate?: boolean; } - ) => TransformReturn; + ) => TransformReturn; validate: (obj: any, version?: Version) => ValidationError | null; } diff --git a/packages/kbn-optimizer/src/common/bundle.ts b/packages/kbn-optimizer/src/common/bundle.ts index c7a07928e1524..44c2ada5cf970 100644 --- a/packages/kbn-optimizer/src/common/bundle.ts +++ b/packages/kbn-optimizer/src/common/bundle.ts @@ -21,8 +21,8 @@ const VALID_BUNDLE_TYPES = ['plugin' as const, 'entry' as const]; const DEFAULT_IMPLICIT_BUNDLE_DEPS = ['core']; -const toStringArray = (input: any): string[] => - Array.isArray(input) && input.every((x) => typeof x === 'string') ? input : []; +const toStringArray = (input: any): string[] | null => + Array.isArray(input) && input.every((x) => typeof x === 'string') ? input : null; export interface BundleSpec { readonly type: typeof VALID_BUNDLE_TYPES[0]; @@ -164,19 +164,39 @@ export class Bundle { ); } - if (isObj(parsed) && isObj(parsed.plugin)) { - return { - explicit: [...toStringArray(parsed.plugin.requiredBundles)], - implicit: [ - ...DEFAULT_IMPLICIT_BUNDLE_DEPS, - ...toStringArray(parsed.plugin.requiredPlugins), - ], - }; + // TODO: remove once we improve the third party plugin build workflow + // This is only used to build legacy third party plugins in the @kbn/plugin-helpers + + if (!isObj(parsed)) { + throw new Error(`Expected [${this.manifestPath}] to be a jsonc parseable file`); + } + + const requiredBundles = isObj(parsed.plugin) + ? parsed.plugin.requiredBundles + : parsed.requiredBundles; + const requiredPlugins = isObj(parsed.plugin) + ? parsed.plugin.requiredPlugins + : parsed.requiredPlugins; + const requiredBundlesStringArray = toStringArray(requiredBundles); + const requiredPluginsStringArray = toStringArray(requiredPlugins); + // END-OF-TD: we just need to check for parse.plugin and not for legacy plugins manifest types + + if (!requiredBundlesStringArray && requiredBundles) { + throw new Error( + `Expected "requiredBundles" in manifest file [${this.manifestPath}] to be an array of strings` + ); } - throw new Error( - `Expected "requiredBundles" and "requiredPlugins" in manifest file [${this.manifestPath}] to be arrays of strings` - ); + if (!requiredPluginsStringArray && requiredPlugins) { + throw new Error( + `Expected "requiredPlugins" in manifest file [${this.manifestPath}] to be an array of strings` + ); + } + + return { + explicit: [...(requiredBundlesStringArray || [])], + implicit: [...DEFAULT_IMPLICIT_BUNDLE_DEPS, ...(requiredPluginsStringArray || [])], + }; } } diff --git a/packages/kbn-plugin-discovery/tsconfig.json b/packages/kbn-plugin-discovery/tsconfig.json deleted file mode 100644 index 03ae7bfe1cee1..0000000000000 --- a/packages/kbn-plugin-discovery/tsconfig.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "extends": "../../tsconfig.base.json", - "compilerOptions": { - "checkJs": true, - "outDir": "target/types", - "types": [ - "jest", - "node" - ] - }, - "include": [ - "**/*.js", - "**/*.ts", - ], - "exclude": [ - "target/**/*", - ] -} diff --git a/packages/kbn-plugin-generator/README.md b/packages/kbn-plugin-generator/README.md index 4603c9ed7b1ba..d9012ae158c31 100644 --- a/packages/kbn-plugin-generator/README.md +++ b/packages/kbn-plugin-generator/README.md @@ -51,7 +51,7 @@ yarn kbn bootstrap Generated plugins receive a handful of scripts that can be used during development. Those scripts are detailed in the [README.md](template/README.md) file in each newly generated plugin, and expose the scripts provided by the [Kibana plugin helpers](../kbn-plugin-helpers), but here is a quick reference in case you need it: -> ***NOTE:*** The following scripts should be run from the generated plugin. +> ***NOTE:*** The following scripts should be run from the generated plugin root folder. - `yarn kbn bootstrap` @@ -63,12 +63,16 @@ Generated plugins receive a handful of scripts that can be used during developme Build a distributable archive of your plugin. + - `yarn dev --watch` + + Builds and starts the watch mode of your ui browser side plugin so it can be picked up by Kibana in development. + To start kibana run the following command from Kibana root. - `yarn start` - Start kibana and it will automatically include this plugin. You can pass any arguments that you would normally send to `bin/kibana` + Start kibana and, if you had previously run in another terminal `yarn dev --watch` at the root of your plugin, it will automatically include this plugin. You can pass any arguments that you would normally send to `bin/kibana` ``` yarn start --elasticsearch.hosts http://localhost:9220 diff --git a/packages/kbn-plugin-generator/template/.eslintrc.js.ejs b/packages/kbn-plugin-generator/template/.eslintrc.js.ejs index 5a65d0cfb8e02..c7ec93d3d6dcc 100644 --- a/packages/kbn-plugin-generator/template/.eslintrc.js.ejs +++ b/packages/kbn-plugin-generator/template/.eslintrc.js.ejs @@ -1,3 +1,5 @@ +require('@kbn/babel-register').install(); + module.exports = { root: true, extends: [ diff --git a/packages/kbn-plugin-generator/template/README.md.ejs b/packages/kbn-plugin-generator/template/README.md.ejs index 5627b5d19c531..f81521e261664 100755 --- a/packages/kbn-plugin-generator/template/README.md.ejs +++ b/packages/kbn-plugin-generator/template/README.md.ejs @@ -16,5 +16,8 @@ See the [kibana contributing guide](https://github.com/elastic/kibana/blob/main/
yarn plugin-helpers build
Execute this to create a distributable version of this plugin that can be installed in Kibana
+ +
yarn plugin-helpers dev --watch
+
Execute this to build your plugin ui browser side so Kibana could pick up when started in development
<% } %> diff --git a/packages/kbn-plugin-generator/template/package.json.ejs b/packages/kbn-plugin-generator/template/package.json.ejs index ab234b1df2bc5..b8658ad78aa86 100644 --- a/packages/kbn-plugin-generator/template/package.json.ejs +++ b/packages/kbn-plugin-generator/template/package.json.ejs @@ -4,6 +4,7 @@ "private": true, "scripts": { "build": "yarn plugin-helpers build", + "dev": "yarn plugin-helpers dev", "plugin-helpers": "node ../../scripts/plugin_helpers", "kbn": "node ../../scripts/kbn" } diff --git a/packages/kbn-plugin-helpers/README.md b/packages/kbn-plugin-helpers/README.md index 05eb9f5998737..a50072db8ae8a 100644 --- a/packages/kbn-plugin-helpers/README.md +++ b/packages/kbn-plugin-helpers/README.md @@ -11,6 +11,7 @@ is already the case if you use the new `node scripts/generate_plugin` script. { "scripts" : { "build": "yarn plugin-helpers build", + "dev": "yarn plugin-helpers dev", "plugin-helpers": "node ../../scripts/plugin_helpers", "kbn": "node ../../scripts/kbn" } @@ -48,7 +49,15 @@ $ plugin-helpers help Options: --skip-archive Don't create the zip file, just create the build/kibana directory - --kibana-version, -v Kibana version that the + --kibana-version, -v Kibana version this plugin will be built for + + dev + Builds the current plugin ui browser side so it can be picked up by Kibana + during development. + + Options: + --dist, -d Outputs bundles in dist mode instead + --watch, -w Starts the watch mode Global options: @@ -92,7 +101,7 @@ Plugin code can be written in [TypeScript](http://www.typescriptlang.org/) if de ```js { // extend Kibana's tsconfig, or use your own settings - "extends": "../../kibana/tsconfig.json", + "extends": "../../tsconfig.json", // tell the TypeScript compiler where to find your source files "include": [ diff --git a/packages/kbn-plugin-helpers/src/cli.ts b/packages/kbn-plugin-helpers/src/cli.ts index 3115c014438a5..e089eaa75ee9d 100644 --- a/packages/kbn-plugin-helpers/src/cli.ts +++ b/packages/kbn-plugin-helpers/src/cli.ts @@ -14,7 +14,7 @@ import { createFlagError, createFailError } from '@kbn/dev-cli-errors'; import { findPluginDir } from './find_plugin_dir'; import { loadKibanaPlatformPlugin } from './load_kibana_platform_plugin'; import * as Tasks from './tasks'; -import { BuildContext } from './build_context'; +import { TaskContext } from './task_context'; import { resolveKibanaVersion } from './resolve_kibana_version'; import { loadConfig } from './config'; @@ -42,7 +42,7 @@ export function runCli() { }, help: ` --skip-archive Don't create the zip file, just create the build/kibana directory - --kibana-version, -v Kibana version that the + --kibana-version, -v Kibana version this plugin will be built for `, }, async run({ log, flags }) { @@ -56,7 +56,7 @@ export function runCli() { throw createFlagError('expected a single --skip-archive flag'); } - const found = await findPluginDir(); + const found = findPluginDir(); if (!found) { throw createFailError( `Unable to find Kibana Platform plugin in [${process.cwd()}] or any of its parent directories. Has it been migrated properly? Does it have a kibana.json file?` @@ -73,8 +73,10 @@ export function runCli() { const sourceDir = plugin.directory; const buildDir = Path.resolve(plugin.directory, 'build/kibana', plugin.manifest.id); - const context: BuildContext = { + const context: TaskContext = { log, + dev: false, + dist: true, plugin, config, sourceDir, @@ -93,5 +95,73 @@ export function runCli() { } }, }) + .command({ + name: 'dev', + description: ` + Builds the current plugin ui browser side so it can be picked up by Kibana + during development + + `, + flags: { + boolean: ['dist', 'watch'], + alias: { + d: 'dist', + w: 'watch', + }, + help: ` + --dist, -d Outputs bundles in dist mode instead + --watch, -w Starts the watch mode + `, + }, + async run({ log, flags }) { + const dist = flags.dist; + if (dist !== undefined && typeof dist !== 'boolean') { + throw createFlagError('expected a single --dist flag'); + } + + const watch = flags.watch; + if (watch !== undefined && typeof watch !== 'boolean') { + throw createFlagError('expected a single --watch flag'); + } + + const found = findPluginDir(); + if (!found) { + throw createFailError( + `Unable to find Kibana Platform plugin in [${process.cwd()}] or any of its parent directories. Has it been migrated properly? Does it have a kibana.json file?` + ); + } + + if (found.type === 'package') { + throw createFailError(`the plugin helpers do not currently support "package plugins"`); + } + + const plugin = loadKibanaPlatformPlugin(found.dir); + + if (!plugin.manifest.ui) { + log.info( + 'Your plugin is server only and there is no need to run a dev task in order to get it ready to test. Please just run `yarn start` at the Kibana root and your plugin will be started.' + ); + return; + } + + const config = await loadConfig(log, plugin); + const sourceDir = plugin.directory; + + const context: TaskContext = { + log, + dev: true, + dist, + watch, + plugin, + config, + sourceDir, + buildDir: '', + kibanaVersion: 'kibana', + }; + + await Tasks.initDev(context); + await Tasks.optimize(context); + }, + }) .execute(); } diff --git a/packages/kbn-plugin-helpers/src/integration_tests/build.test.ts b/packages/kbn-plugin-helpers/src/integration_tests/build.test.ts index 2a4b57e3bdfcc..bd13fd23c101f 100644 --- a/packages/kbn-plugin-helpers/src/integration_tests/build.test.ts +++ b/packages/kbn-plugin-helpers/src/integration_tests/build.test.ts @@ -70,6 +70,7 @@ it('builds a generated plugin into a viable archive', async () => { " info deleting the build and target directories info running @kbn/optimizer │ succ browser bundle created at plugins/foo_test_plugin/build/kibana/fooTestPlugin/target/public + │ info stopping @kbn/optimizer info copying assets from \`public/assets\` to build info copying server source into the build and converting with babel info running yarn to install dependencies diff --git a/packages/kbn-plugin-helpers/src/build_context.ts b/packages/kbn-plugin-helpers/src/task_context.ts similarity index 88% rename from packages/kbn-plugin-helpers/src/build_context.ts rename to packages/kbn-plugin-helpers/src/task_context.ts index 75ba365c8f4e1..4877bb549b254 100644 --- a/packages/kbn-plugin-helpers/src/build_context.ts +++ b/packages/kbn-plugin-helpers/src/task_context.ts @@ -11,8 +11,11 @@ import { ToolingLog } from '@kbn/tooling-log'; import { Plugin } from './load_kibana_platform_plugin'; import { Config } from './config'; -export interface BuildContext { +export interface TaskContext { log: ToolingLog; + dev: boolean; + dist?: boolean; + watch?: boolean; plugin: Plugin; config: Config; sourceDir: string; diff --git a/packages/kbn-plugin-helpers/src/tasks/clean.ts b/packages/kbn-plugin-helpers/src/tasks/clean.ts index f9d1a8d7e746e..78fc986550faa 100644 --- a/packages/kbn-plugin-helpers/src/tasks/clean.ts +++ b/packages/kbn-plugin-helpers/src/tasks/clean.ts @@ -11,11 +11,11 @@ import { promisify } from 'util'; import del from 'del'; -import { BuildContext } from '../build_context'; +import { TaskContext } from '../task_context'; const asyncMkdir = promisify(Fs.mkdir); -export async function initTargets({ log, sourceDir, buildDir }: BuildContext) { +export async function initTargets({ log, sourceDir, buildDir }: TaskContext) { log.info('deleting the build and target directories'); await del(['build', 'target'], { cwd: sourceDir, @@ -24,3 +24,10 @@ export async function initTargets({ log, sourceDir, buildDir }: BuildContext) { log.debug(`creating build output dir [${buildDir}]`); await asyncMkdir(buildDir, { recursive: true }); } + +export async function initDev({ log, sourceDir }: TaskContext) { + log.info('deleting the target folder'); + await del(['target'], { + cwd: sourceDir, + }); +} diff --git a/packages/kbn-plugin-helpers/src/tasks/create_archive.ts b/packages/kbn-plugin-helpers/src/tasks/create_archive.ts index f2660c9230bd8..5f2339d2a4ce1 100644 --- a/packages/kbn-plugin-helpers/src/tasks/create_archive.ts +++ b/packages/kbn-plugin-helpers/src/tasks/create_archive.ts @@ -14,11 +14,11 @@ import del from 'del'; import vfs from 'vinyl-fs'; import zip from 'gulp-zip'; -import { BuildContext } from '../build_context'; +import { TaskContext } from '../task_context'; const asyncPipeline = promisify(pipeline); -export async function createArchive({ kibanaVersion, plugin, log }: BuildContext) { +export async function createArchive({ kibanaVersion, plugin, log }: TaskContext) { const { manifest: { id }, directory, diff --git a/packages/kbn-plugin-helpers/src/tasks/optimize.ts b/packages/kbn-plugin-helpers/src/tasks/optimize.ts index 80a701a6005a5..3edc17e879656 100644 --- a/packages/kbn-plugin-helpers/src/tasks/optimize.ts +++ b/packages/kbn-plugin-helpers/src/tasks/optimize.ts @@ -12,37 +12,46 @@ import { fork } from 'child_process'; import * as Rx from 'rxjs'; import { REPO_ROOT } from '@kbn/repo-info'; -import { createFailError } from '@kbn/dev-cli-errors'; import { OptimizerConfig } from '@kbn/optimizer'; import { Bundle, BundleRemotes } from '@kbn/optimizer/src/common'; import { observeLines } from '@kbn/stdio-dev-helpers'; -import { BuildContext } from '../build_context'; +import { TaskContext } from '../task_context'; type WorkerMsg = { success: true; warnings: string } | { success: false; error: string }; -export async function optimize({ log, plugin, sourceDir, buildDir }: BuildContext) { +export async function optimize({ + log, + dev, + dist, + watch, + plugin, + sourceDir, + buildDir, +}: TaskContext) { if (!plugin.manifest.ui) { return; } - log.info('running @kbn/optimizer'); + log.info(`running @kbn/optimizer${!!watch ? ' in watch mode (use CTRL+C to quit)' : ''}`); await log.indent(2, async () => { const optimizerConfig = OptimizerConfig.create({ repoRoot: REPO_ROOT, examples: false, testPlugins: false, includeCoreBundle: true, - dist: true, + dist: !!dist, + watch: !!watch, }); const bundle = new Bundle({ id: plugin.manifest.id, contextDir: sourceDir, ignoreMetrics: true, - outputDir: Path.resolve(buildDir, 'target/public'), + outputDir: Path.resolve(dev ? sourceDir : buildDir, 'target/public'), sourceRoot: sourceDir, type: 'plugin', + manifestPath: Path.resolve(sourceDir, 'kibana.json'), remoteInfo: { pkgId: 'not-importable', targets: ['public', 'common'], @@ -58,56 +67,91 @@ export async function optimize({ log, plugin, sourceDir, buildDir }: BuildContex stdio: ['ignore', 'pipe', 'pipe', 'ipc'], }); - const result = await Rx.lastValueFrom( - Rx.race( - observeLines(proc.stdout!).pipe( - Rx.tap((line) => log.debug(line)), - Rx.ignoreElements() - ), - observeLines(proc.stderr!).pipe( - Rx.tap((line) => log.error(line)), - Rx.ignoreElements() - ), - Rx.defer(() => { - proc.send({ - workerConfig: worker, - bundles: JSON.stringify([bundle.toSpec()]), - bundleRemotes: remotes.toSpecJson(), - }); - - return Rx.merge( - Rx.fromEvent<[WorkerMsg]>(proc, 'message').pipe( - Rx.map((msg) => { - return msg[0]; - }) - ), - Rx.fromEvent(proc, 'error').pipe( - Rx.map((error) => { - throw error; - }) - ) - ).pipe( - Rx.take(1), - Rx.tap({ - complete() { - proc.kill('SIGKILL'); - }, - }) - ); - }) - ) + const rel = Path.relative(REPO_ROOT, bundle.outputDir); + + // Observe all events from child process + const eventObservable = Rx.merge( + observeLines(proc.stdout!).pipe(Rx.map((line) => ({ type: 'stdout', data: line }))), + observeLines(proc.stderr!).pipe(Rx.map((line) => ({ type: 'stderr', data: line }))), + Rx.fromEvent<[WorkerMsg]>(proc, 'message').pipe( + Rx.map((msg) => ({ type: 'message', data: msg[0] })) + ), + Rx.fromEvent(proc, 'error').pipe(Rx.map((error) => ({ type: 'error', data: error }))) ); - // cleanup unnecessary files - Fs.unlinkSync(Path.resolve(bundle.outputDir, '.kbn-optimizer-cache')); + const simpleOrWatchObservable = watch + ? eventObservable + : eventObservable.pipe( + Rx.take(1), + Rx.tap({ + complete() { + proc.kill('SIGKILL'); + }, + }) + ); - const rel = Path.relative(REPO_ROOT, bundle.outputDir); - if (!result.success) { - throw createFailError(`Optimizer failure: ${result.error}`); - } else if (result.warnings) { - log.warning(`browser bundle created at ${rel}, but with warnings:\n${result.warnings}`); - } else { - log.success(`browser bundle created at ${rel}`); + // Subscribe to eventObservable to log events + const eventSubscription = simpleOrWatchObservable.subscribe((event) => { + if (event.type === 'stdout') { + log.debug(event.data as string); + } else if (event.type === 'stderr') { + log.error(event.data as Error); + } else if (event.type === 'message') { + const result = event.data as WorkerMsg; + // Handle message event + if (!result.success) { + log.error(`Optimizer failure: ${result.error}`); + } else if (result.warnings) { + log.warning(`browser bundle created at ${rel}, but with warnings:\n${result.warnings}`); + } else { + log.success(`browser bundle created at ${rel}`); + } + } else if (event.type === 'error') { + log.error(event.data as Error); + } + }); + + // Send message to child process + proc.send({ + workerConfig: worker, + bundles: JSON.stringify([bundle.toSpec()]), + bundleRemotes: remotes.toSpecJson(), + }); + + // Cleanup fn definition + const cleanup = () => { + // Cleanup unnecessary files + try { + Fs.unlinkSync(Path.resolve(bundle.outputDir, '.kbn-optimizer-cache')); + } catch { + // no-op + } + + // Unsubscribe from eventObservable + eventSubscription.unsubscribe(); + + log.info('stopping @kbn/optimizer'); + }; + + // if watch mode just wait for the first event then cleanup and exit + if (!watch) { + // Wait for parent process to exit if not in watch mode + await new Promise((resolve) => { + proc.once('exit', () => { + cleanup(); + resolve(); + }); + }); + + return; } + + // Wait for parent process to exit if not in watch mode + await new Promise((resolve) => { + process.once('exit', () => { + cleanup(); + resolve(); + }); + }); }); } diff --git a/packages/kbn-plugin-helpers/src/tasks/optimize_worker.ts b/packages/kbn-plugin-helpers/src/tasks/optimize_worker.ts index 482647376735b..126d1d59397d8 100644 --- a/packages/kbn-plugin-helpers/src/tasks/optimize_worker.ts +++ b/packages/kbn-plugin-helpers/src/tasks/optimize_worker.ts @@ -26,26 +26,33 @@ process.on('message', (msg: any) => { const webpackConfig = getWebpackConfig(bundle, remotes, workerConfig); const compiler = webpack(webpackConfig); - compiler.run((error, stats) => { - if (error) { - send.call(process, { - success: false, - error: error.message, - }); - return; - } + compiler.watch( + { + // Example + aggregateTimeout: 300, + poll: undefined, + }, + (error, stats) => { + if (error) { + send.call(process, { + success: false, + error: error.message, + }); + return; + } + + if (stats.hasErrors()) { + send.call(process, { + success: false, + error: `Failed to compile with webpack:\n${stats.toString()}`, + }); + return; + } - if (stats.hasErrors()) { send.call(process, { - success: false, - error: `Failed to compile with webpack:\n${stats.toString()}`, + success: true, + warnings: stats.hasWarnings() ? stats.toString() : '', }); - return; } - - send.call(process, { - success: true, - warnings: stats.hasWarnings() ? stats.toString() : '', - }); - }); + ); }); diff --git a/packages/kbn-plugin-helpers/src/tasks/write_public_assets.ts b/packages/kbn-plugin-helpers/src/tasks/write_public_assets.ts index d1e397d4c4c3d..7fa6d157f4639 100644 --- a/packages/kbn-plugin-helpers/src/tasks/write_public_assets.ts +++ b/packages/kbn-plugin-helpers/src/tasks/write_public_assets.ts @@ -11,11 +11,11 @@ import { promisify } from 'util'; import vfs from 'vinyl-fs'; -import { BuildContext } from '../build_context'; +import { TaskContext } from '../task_context'; const asyncPipeline = promisify(pipeline); -export async function writePublicAssets({ log, plugin, sourceDir, buildDir }: BuildContext) { +export async function writePublicAssets({ log, plugin, sourceDir, buildDir }: TaskContext) { if (!plugin.manifest.ui) { return; } diff --git a/packages/kbn-plugin-helpers/src/tasks/write_server_files.ts b/packages/kbn-plugin-helpers/src/tasks/write_server_files.ts index 42816082b4bbe..2ba2686796487 100644 --- a/packages/kbn-plugin-helpers/src/tasks/write_server_files.ts +++ b/packages/kbn-plugin-helpers/src/tasks/write_server_files.ts @@ -13,7 +13,7 @@ import vfs from 'vinyl-fs'; import { transformFileStream } from '@kbn/dev-utils'; import { transformFileWithBabel } from './transform_file_with_babel'; -import { BuildContext } from '../build_context'; +import { TaskContext } from '../task_context'; const asyncPipeline = promisify(pipeline); @@ -24,7 +24,7 @@ export async function writeServerFiles({ sourceDir, buildDir, kibanaVersion, -}: BuildContext) { +}: TaskContext) { log.info('copying server source into the build and converting with babel'); // copy source files and apply some babel transformations in the process diff --git a/packages/kbn-plugin-helpers/src/tasks/yarn_install.ts b/packages/kbn-plugin-helpers/src/tasks/yarn_install.ts index c5c440f6bdeba..001f169becd07 100644 --- a/packages/kbn-plugin-helpers/src/tasks/yarn_install.ts +++ b/packages/kbn-plugin-helpers/src/tasks/yarn_install.ts @@ -11,11 +11,11 @@ import Path from 'path'; import execa from 'execa'; -import { BuildContext } from '../build_context'; +import { TaskContext } from '../task_context'; const winVersion = (path: string) => (process.platform === 'win32' ? `${path}.cmd` : path); -export async function yarnInstall({ log, buildDir, config }: BuildContext) { +export async function yarnInstall({ log, buildDir, config }: TaskContext) { const pkgJson = Path.resolve(buildDir, 'package.json'); if (config?.skipInstallDependencies || !Fs.existsSync(pkgJson)) { diff --git a/packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts b/packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts index 2ff93f668ea27..69aced93befd2 100644 --- a/packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts +++ b/packages/kbn-securitysolution-es-utils/src/delete_all_index/index.ts @@ -11,6 +11,7 @@ import type { ElasticsearchClient } from '../elasticsearch_client'; export const deleteAllIndex = async ( esClient: ElasticsearchClient, pattern: string, + specifyAlias: boolean = false, maxAttempts = 5 ): Promise => { for (let attempt = 1; ; attempt++) { @@ -22,9 +23,14 @@ export const deleteAllIndex = async ( // resolve pattern to concrete index names const { body: resp } = await esClient.indices.getAlias( - { - index: pattern, - }, + specifyAlias + ? { + name: pattern, + index: `${pattern}-*`, + } + : { + index: pattern, + }, { ignore: [404], meta: true } ); diff --git a/src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts b/src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts index caa6d371d50b2..d876484aa16af 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/group2/check_registered_types.test.ts @@ -108,7 +108,7 @@ describe('checking migration metadata changes on all registered SO types', () => "ingest-package-policies": "6dc1c9b80a8dc95fbc9c6d9b73dfc56a098eb440", "ingest_manager_settings": "fb75bff08a8de3435b23664b1191f9244a255701", "inventory-view": "6d47ef0b38166ecbd1c2fc7394599a4500db1ae4", - "kql-telemetry": "23ed96ff02cd69cbfaa22f313cae3a54c434db51", + "kql-telemetry": "92d6357aa3ce28727492f86a54783f802dc38893", "legacy-url-alias": "9b8cca3fbb2da46fd12823d3cd38fdf1c9f24bc8", "lens": "2f6a8231591e3d62a83506b19e165774d74588ea", "lens-ui-telemetry": "d6c4e330d170eefc6214dbf77a53de913fa3eebc", @@ -125,19 +125,19 @@ describe('checking migration metadata changes on all registered SO types', () => "query": "ec6000b775f06f81470df42d23f7a88cb31d64ba", "rules-settings": "9854495c3b54b16a6625fb250c35e5504da72266", "sample-data-telemetry": "c38daf1a49ed24f2a4fb091e6e1e833fccf19935", - "search": "01bc42d635e9ea0588741c4c7a2bbd3feb3ac5dc", + "search": "ed3a9b1681b57d69560909d51933fdf17576ea68", "search-session": "58a44d14ec991739166b2ec28d718001ab0f4b28", - "search-telemetry": "ab67ef721f294f28d5e10febbd20653347720188", + "search-telemetry": "1bbaf2db531b97fa04399440fa52d46e86d54dd8", "security-rule": "1ff82dfb2298c3caf6888fc3ef15c6bf7a628877", "security-solution-signals-migration": "c2db409c1857d330beb3d6fd188fa186f920302c", "siem-detection-engine-rule-actions": "123c130dc38120a470d8db9fed9a4cebd2046445", "siem-ui-timeline": "e9d6b3a9fd7af6dc502293c21cbdb309409f3996", "siem-ui-timeline-note": "13c9d4c142f96624a93a623c6d7cba7e1ae9b5a6", "siem-ui-timeline-pinned-event": "96a43d59b9e2fc11f12255a0cb47ef0a3d83af4c", - "slo": "ee0e16abebba5779c37277bc3fe8da1fe1207b7a", + "slo": "aefffabdb35d15a6c388634af2cee1fa59ede83c", "space": "7fc578a1f9f7708cb07479f03953d664ad9f1dae", "spaces-usage-stats": "084bd0f080f94fb5735d7f3cf12f13ec92f36bad", - "synthetics-monitor": "96cc312bfa597022f83dfb3b5d1501e27a73e8d5", + "synthetics-monitor": "7136a2669a65323c56da849f26c369cdeeb3b381", "synthetics-param": "9776c9b571d35f0d0397e8915e035ea1dc026db7", "synthetics-privates-locations": "7d032fc788905e32152029ae7ab3d6038c48ae44", "tag": "87f21f07df9cc37001b15a26e413c18f50d1fbfe", diff --git a/src/core/server/integration_tests/saved_objects/migrations/group3/actions/actions.test.ts b/src/core/server/integration_tests/saved_objects/migrations/group3/actions/actions.test.ts index 6dcb2e881bd54..e51e0ef12a89f 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/group3/actions/actions.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/group3/actions/actions.test.ts @@ -706,9 +706,7 @@ describe('migration actions', () => { // Reindex doesn't return any errors on it's own, so we have to test // together with waitForReindexTask - // - // FAILING ES PROMOTION: https://github.com/elastic/kibana/issues/154278 - describe.skip('reindex & waitForReindexTask', () => { + describe('reindex & waitForReindexTask', () => { it('resolves right when reindex succeeds without reindex script', async () => { const res = (await reindex({ client, @@ -1076,7 +1074,6 @@ describe('migration actions', () => { } `); }); - it('resolves left wait_for_task_completion_timeout when the task does not finish within the timeout', async () => { await waitForIndexStatus({ client, diff --git a/src/core/server/integration_tests/saved_objects/migrations/group3/default_search_fields.test.ts b/src/core/server/integration_tests/saved_objects/migrations/group3/default_search_fields.test.ts new file mode 100644 index 0000000000000..4101c22c23d50 --- /dev/null +++ b/src/core/server/integration_tests/saved_objects/migrations/group3/default_search_fields.test.ts @@ -0,0 +1,75 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { createRoot } from '@kbn/core-test-helpers-kbn-server'; + +describe('SO default search fields', () => { + let root: ReturnType; + + afterEach(() => { + try { + root?.shutdown(); + } catch (e) { + /* trap */ + } + }); + + interface InvalidMappingTuple { + type: string; + field: string; + } + + // identify / avoid scenarios of https://github.com/elastic/kibana/issues/130616 + it('make sure management types have the correct mappings for default search fields', async () => { + root = createRoot({}, { oss: false }); + await root.preboot(); + const setup = await root.setup(); + + const allTypes = setup.savedObjects.getTypeRegistry().getAllTypes(); + + const defaultSearchFields = [ + ...allTypes.reduce((fieldSet, type) => { + if (type.management?.defaultSearchField) { + fieldSet.add(type.management.defaultSearchField); + } + return fieldSet; + }, new Set()), + ]; + + const invalidMappings: InvalidMappingTuple[] = []; + + const managementTypes = setup.savedObjects + .getTypeRegistry() + .getImportableAndExportableTypes() + .filter((type) => type.management!.visibleInManagement ?? true); + + managementTypes.forEach((type) => { + const mappingProps = type.mappings.properties; + defaultSearchFields.forEach((searchField) => { + if (mappingProps[searchField]) { + const fieldDef = mappingProps[searchField]; + if (fieldDef.type !== 'text') { + invalidMappings.push({ + type: type.name, + field: searchField, + }); + } + } + }); + }); + + if (invalidMappings.length > 0) { + // `fail()` no longer exists... + expect( + `fields registered as defaultSearchField by any type must be registered as text. Invalid mappings found: ${JSON.stringify( + invalidMappings + )}` + ).toEqual(''); + } + }); +}); diff --git a/src/core/server/integration_tests/saved_objects/migrations/group3/skip_reindex.test.ts b/src/core/server/integration_tests/saved_objects/migrations/group3/skip_reindex.test.ts index d070ea1ecf9ac..3d383a603a53f 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/group3/skip_reindex.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/group3/skip_reindex.test.ts @@ -8,7 +8,6 @@ import { type TestElasticsearchUtils } from '@kbn/core-test-helpers-kbn-server'; import { ElasticsearchClient } from '@kbn/core-elasticsearch-server'; -import type { MigrationResult } from '@kbn/core-saved-objects-base-server-internal'; import { readLog, clearLog, @@ -19,13 +18,14 @@ import { getIdenticalMappingsMigrator, getIncompatibleMappingsMigrator, startElasticsearch, + KibanaMigratorTestKit, } from '../kibana_migrator_test_kit'; import { delay } from '../test_utils'; describe('when migrating to a new version', () => { let esServer: TestElasticsearchUtils['es']; let esClient: ElasticsearchClient; - let runMigrations: (rerun?: boolean | undefined) => Promise; + let migratorTestKitFactory: () => Promise; beforeAll(async () => { esServer = await startElasticsearch(); @@ -39,8 +39,9 @@ describe('when migrating to a new version', () => { describe('and the mappings remain the same', () => { it('the migrator skips reindexing', async () => { // we run the migrator with the same identic baseline types - runMigrations = (await getIdenticalMappingsMigrator()).runMigrations; - await runMigrations(); + migratorTestKitFactory = () => getIdenticalMappingsMigrator(); + const testKit = await migratorTestKitFactory(); + await testKit.runMigrations(); const logs = await readLog(); expect(logs).toMatch('INIT -> WAIT_FOR_YELLOW_SOURCE.'); @@ -67,8 +68,9 @@ describe('when migrating to a new version', () => { describe("and the mappings' changes are still compatible", () => { it('the migrator skips reindexing', async () => { // we run the migrator with altered, compatible mappings - runMigrations = (await getCompatibleMappingsMigrator()).runMigrations; - await runMigrations(); + migratorTestKitFactory = () => getCompatibleMappingsMigrator(); + const testKit = await migratorTestKitFactory(); + await testKit.runMigrations(); const logs = await readLog(); expect(logs).toMatch('INIT -> WAIT_FOR_YELLOW_SOURCE.'); @@ -94,9 +96,10 @@ describe('when migrating to a new version', () => { describe("and the mappings' changes are NOT compatible", () => { it('the migrator reindexes documents to a new index', async () => { - // we run the migrator with altered, compatible mappings - runMigrations = (await getIncompatibleMappingsMigrator()).runMigrations; - await runMigrations(); + // we run the migrator with incompatible mappings + migratorTestKitFactory = () => getIncompatibleMappingsMigrator(); + const testKit = await migratorTestKitFactory(); + await testKit.runMigrations(); const logs = await readLog(); expect(logs).toMatch('INIT -> WAIT_FOR_YELLOW_SOURCE.'); @@ -115,8 +118,9 @@ describe('when migrating to a new version', () => { afterEach(async () => { // we run the migrator again to ensure that the next time state is loaded everything still works as expected + const migratorTestKit = await migratorTestKitFactory(); await clearLog(); - await runMigrations(true); + await migratorTestKit.runMigrations(); const logs = await readLog(); expect(logs).toMatch('INIT -> WAIT_FOR_YELLOW_SOURCE.'); diff --git a/src/core/server/integration_tests/saved_objects/migrations/group3/type_registrations.test.ts b/src/core/server/integration_tests/saved_objects/migrations/group3/type_registrations.test.ts index 914c825597774..dbcdbf2f9928c 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/group3/type_registrations.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/group3/type_registrations.test.ts @@ -132,8 +132,18 @@ const previouslyRegisteredTypes = [ ].sort(); describe('SO type registrations', () => { + let root: ReturnType; + + afterEach(() => { + try { + root?.shutdown(); + } catch (e) { + /* trap */ + } + }); + it('does not remove types from registrations without updating excludeOnUpgradeQuery', async () => { - const root = createRoot({}, { oss: false }); + root = createRoot({}, { oss: false }); await root.preboot(); const setup = await root.setup(); const currentlyRegisteredTypes = setup.savedObjects diff --git a/src/core/server/integration_tests/saved_objects/migrations/kibana_migrator_test_kit.ts b/src/core/server/integration_tests/saved_objects/migrations/kibana_migrator_test_kit.ts index ebb8cb5c7a697..64da61be1f0d3 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/kibana_migrator_test_kit.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/kibana_migrator_test_kit.ts @@ -43,6 +43,7 @@ import type { ISavedObjectsRepository } from '@kbn/core-saved-objects-api-server import { getDocLinks, getDocLinksMeta } from '@kbn/doc-links'; import type { DocLinksServiceStart } from '@kbn/core-doc-links-server'; import { baselineDocuments, baselineTypes } from './kibana_migrator_test_kit.fixtures'; +import { delay } from './test_utils'; export const defaultLogFilePath = Path.join(__dirname, 'kibana_migrator_test_kit.log'); @@ -121,6 +122,7 @@ export const getKibanaMigratorTestKit = async ({ types = [], logFilePath = defaultLogFilePath, }: KibanaMigratorTestKitParams = {}): Promise => { + let hasRun = false; const loggingSystem = new LoggingSystem(); const loggerFactory = loggingSystem.asLoggerFactory(); @@ -147,9 +149,13 @@ export const getKibanaMigratorTestKit = async ({ kibanaBranch ); - const runMigrations = async (rerun?: boolean) => { + const runMigrations = async () => { + if (hasRun) { + throw new Error('The test kit migrator can only be run once. Please instantiate it again.'); + } + hasRun = true; migrator.prepareMigrations(); - const migrationResults = await migrator.runMigrations({ rerun }); + const migrationResults = await migrator.runMigrations(); await loggingSystem.stop(); return migrationResults; }; @@ -385,6 +391,7 @@ export const getIncompatibleMappingsMigrator = async ({ }; export const readLog = async (logFilePath: string = defaultLogFilePath): Promise => { + await delay(0.1); return await fs.readFile(logFilePath, 'utf-8'); }; diff --git a/src/dev/build/tasks/fetch_agent_versions_list.ts b/src/dev/build/tasks/fetch_agent_versions_list.ts index 560c52fad07ba..bc4143f5000da 100644 --- a/src/dev/build/tasks/fetch_agent_versions_list.ts +++ b/src/dev/build/tasks/fetch_agent_versions_list.ts @@ -19,22 +19,29 @@ const getAvailableVersions = async (log: ToolingLog) => { }; // Endpoint maintained by the web-team and hosted on the elastic website // See https://github.com/elastic/website-development/issues/9331 - const url = 'https://www.elastic.co/api/product_versions'; - try { - log.info('Fetching Elastic Agent versions list'); - const results = await fetch(url, options); + const url = 'https://www.elastic.co/content/product_versions'; + log.info('Fetching Elastic Agent versions list'); + const results = await fetch(url, options); + const rawBody = await results.text(); - const jsonBody = await results.json(); + try { + const jsonBody = JSON.parse(rawBody); const versions: string[] = (jsonBody.length ? jsonBody[0] : []) .filter((item: any) => item?.title?.includes('Elastic Agent')) .map((item: any) => item?.version_number); - log.info(`Retrieved available versions`); + log.info(`Retrieved available Elastic Agent versions`); return versions; } catch (error) { - log.warning(`Failed to fetch versions list`); - log.warning(error); + log.warning(`Failed to fetch Elastic Agent versions list`); + log.info(`Status: ${results.status}`); + log.info(rawBody); + if (process.env.BUILDKITE_PULL_REQUEST === 'true') { + log.warning(error); + } else { + throw new Error(error); + } } return []; }; @@ -47,8 +54,8 @@ export const FetchAgentVersionsList: Task = { const versionsList = await getAvailableVersions(log); const AGENT_VERSION_BUILD_FILE = 'x-pack/plugins/fleet/target/agent_versions_list.json'; - if (versionsList !== []) { - log.info(`Writing versions list to ${AGENT_VERSION_BUILD_FILE}`); + if (versionsList.length !== 0) { + log.info(`Writing Elastic Agent versions list to ${AGENT_VERSION_BUILD_FILE}`); await write( build.resolvePath(AGENT_VERSION_BUILD_FILE), JSON.stringify(versionsList, null, ' ') diff --git a/src/plugins/bfetch/common/buffer/item_buffer.ts b/src/plugins/bfetch/common/buffer/item_buffer.ts index ec3b9ea5747c4..df5960499cc6d 100644 --- a/src/plugins/bfetch/common/buffer/item_buffer.ts +++ b/src/plugins/bfetch/common/buffer/item_buffer.ts @@ -19,7 +19,7 @@ export interface ItemBufferParams { * argument which is a list of all buffered items. If `.flush()` is called * when buffer is empty, `.onflush` is called with empty array. */ - onFlush: (items: Item[]) => void; + onFlush: (items: Item[]) => void | Promise; } /** @@ -60,11 +60,19 @@ export class ItemBuffer { } /** - * Call `.onflush` method and clear buffer. + * Call `.onFlush` method and clear buffer. */ public flush() { + this.flushAsync().catch(() => {}); + } + + /** + * Same as `.flush()` but asynchronous, and returns a promise, which + * rejects if `.onFlush` throws. + */ + public async flushAsync(): Promise { let list; [list, this.list] = [this.list, []]; - this.params.onFlush(list); + await this.params.onFlush(list); } } diff --git a/src/plugins/bfetch/common/buffer/timed_item_buffer.ts b/src/plugins/bfetch/common/buffer/timed_item_buffer.ts index 62be3753a8d58..5c685e387d3fe 100644 --- a/src/plugins/bfetch/common/buffer/timed_item_buffer.ts +++ b/src/plugins/bfetch/common/buffer/timed_item_buffer.ts @@ -41,6 +41,11 @@ export class TimedItemBuffer extends ItemBuffer { super.flush(); } + public async flushAsync() { + clearTimeout(this.timer); + await super.flushAsync(); + } + private onTimeout = () => { this.flush(); }; diff --git a/src/plugins/chart_expressions/expression_heatmap/public/components/heatmap_component.tsx b/src/plugins/chart_expressions/expression_heatmap/public/components/heatmap_component.tsx index a9b4a2d227b27..8bae0d35e85c2 100644 --- a/src/plugins/chart_expressions/expression_heatmap/public/components/heatmap_component.tsx +++ b/src/plugins/chart_expressions/expression_heatmap/public/components/heatmap_component.tsx @@ -524,10 +524,6 @@ export const HeatmapComponent: FC = memo( chartTheme.axes?.gridLine?.horizontal?.stroke ?? '#D3DAE6', }, - cellHeight: { - max: 'fill', - min: 1, - }, }, cell: { maxWidth: 'fill', diff --git a/src/plugins/chart_expressions/expression_metric/common/constants.ts b/src/plugins/chart_expressions/expression_metric/common/constants.ts index 7e81bc1dddbda..39ac8eebaecdb 100644 --- a/src/plugins/chart_expressions/expression_metric/common/constants.ts +++ b/src/plugins/chart_expressions/expression_metric/common/constants.ts @@ -15,3 +15,24 @@ export const LabelPosition = { BOTTOM: 'bottom', TOP: 'top', } as const; + +export const AvailableMetricIcons = { + EMPTY: 'empty', + SORTUP: 'sortUp', + SORTDOWN: 'sortDown', + COMPUTE: 'compute', + ASTERISK: 'asterisk', + ALERT: 'alert', + BELL: 'bell', + BOLT: 'bolt', + BUG: 'bug', + EDITOR_COMMENT: 'editorComment', + FLAG: 'flag', + HEART: 'heart', + MAP_MARKER: 'mapMarker', + PIN: 'pin', + STAR_EMPTY: 'starEmpty', + TAG: 'tag', + GLOBE: 'globe', + TEMPERATURE: 'temperature', +} as const; diff --git a/src/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts b/src/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts index c5be73ab0b73c..d75bed1f00c34 100644 --- a/src/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts +++ b/src/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts @@ -84,6 +84,12 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ defaultMessage: 'Provides a static visualization color. Overridden by palette.', }), }, + icon: { + types: ['string'], + help: i18n.translate('expressionMetricVis.function.icon.help', { + defaultMessage: 'Provides a static visualization icon.', + }), + }, palette: { types: ['palette'], help: i18n.translate('expressionMetricVis.function.palette.help', { @@ -181,6 +187,7 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ subtitle: args.subtitle, secondaryPrefix: args.secondaryPrefix, color: args.color, + icon: args.icon, palette: args.palette?.params, progressDirection: args.progressDirection, maxCols: args.maxCols, diff --git a/src/plugins/chart_expressions/expression_metric/common/index.ts b/src/plugins/chart_expressions/expression_metric/common/index.ts index ae8f3b9fae7a2..d15b491f41873 100755 --- a/src/plugins/chart_expressions/expression_metric/common/index.ts +++ b/src/plugins/chart_expressions/expression_metric/common/index.ts @@ -19,6 +19,7 @@ export type { MetricVisParam, VisParams, MetricOptions, + AvailableMetricIcon, } from './types'; export { metricVisFunction } from './expression_functions'; diff --git a/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts index 2440ef597c0bd..f03dab2e81435 100644 --- a/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts +++ b/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts @@ -8,6 +8,7 @@ import type { PaletteOutput } from '@kbn/coloring'; import { LayoutDirection, MetricWTrend } from '@elastic/charts'; +import { $Values } from '@kbn/utility-types'; import { Datatable, ExpressionFunctionDefinition, @@ -16,7 +17,13 @@ import { import { ExpressionValueVisDimension, prepareLogTable } from '@kbn/visualizations-plugin/common'; import type { AllowedSettingsOverrides, CustomPaletteState } from '@kbn/charts-plugin/common'; import { VisParams, visType } from './expression_renderers'; -import { EXPRESSION_METRIC_NAME, EXPRESSION_METRIC_TRENDLINE_NAME } from '../constants'; +import { + EXPRESSION_METRIC_NAME, + EXPRESSION_METRIC_TRENDLINE_NAME, + AvailableMetricIcons, +} from '../constants'; + +export type AvailableMetricIcon = $Values; export interface MetricArguments { metric: ExpressionValueVisDimension | string; @@ -28,6 +35,7 @@ export interface MetricArguments { secondaryPrefix?: string; progressDirection: LayoutDirection; color?: string; + icon?: string; palette?: PaletteOutput; maxCols: number; minTiles?: number; diff --git a/src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts b/src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts index 48b4b4ce0f524..bbebb06bc8e7c 100644 --- a/src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts +++ b/src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts @@ -24,6 +24,7 @@ export interface MetricVisParam { subtitle?: string; secondaryPrefix?: string; color?: string; + icon?: string; palette?: CustomPaletteState; progressDirection: LayoutDirection; maxCols: number; diff --git a/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.test.tsx b/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.test.tsx index d10d1e39f3544..c4b130aa3e507 100644 --- a/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.test.tsx +++ b/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.test.tsx @@ -232,6 +232,7 @@ describe('MetricVisComponent', function () { metric: { progressDirection: 'vertical', maxCols: 5, + icon: 'empty', }, dimensions: { metric: basePriceColumnId, @@ -252,6 +253,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": [Function], "subtitle": undefined, "title": "Median products.base_price", "value": 28.984375, @@ -314,6 +316,7 @@ describe('MetricVisComponent', function () { secondary prefix 13.63 , + "icon": [Function], "subtitle": "subtitle", "title": "Median products.base_price", "value": 28.984375, @@ -360,6 +363,7 @@ describe('MetricVisComponent', function () { "color": "#f5f7fa", "domainMax": 28.984375, "extra": , + "icon": [Function], "progressBarDirection": "vertical", "subtitle": undefined, "title": "Median products.base_price", @@ -435,6 +439,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Friday", "value": 28.984375, @@ -443,6 +448,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Wednesday", "value": 28.984375, @@ -451,6 +457,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Saturday", "value": 25.984375, @@ -459,6 +466,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Sunday", "value": 25.784375, @@ -467,6 +475,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Thursday", "value": 25.348011363636363, @@ -595,6 +604,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Friday", "value": 28.984375, @@ -603,6 +613,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Wednesday", "value": 28.984375, @@ -611,6 +622,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Saturday", "value": 25.984375, @@ -619,6 +631,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Sunday", "value": 25.784375, @@ -627,6 +640,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Thursday", "value": 25.348011363636363, @@ -637,6 +651,7 @@ describe('MetricVisComponent', function () { Object { "color": "#f5f7fa", "extra": , + "icon": undefined, "subtitle": "Median products.base_price", "title": "Other", "value": 24.984375, @@ -678,6 +693,7 @@ describe('MetricVisComponent', function () { "color": "#f5f7fa", "domainMax": 28.984375, "extra": , + "icon": undefined, "progressBarDirection": "vertical", "subtitle": "Median products.base_price", "title": "Friday", @@ -688,6 +704,7 @@ describe('MetricVisComponent', function () { "color": "#f5f7fa", "domainMax": 28.984375, "extra": , + "icon": undefined, "progressBarDirection": "vertical", "subtitle": "Median products.base_price", "title": "Wednesday", @@ -698,6 +715,7 @@ describe('MetricVisComponent', function () { "color": "#f5f7fa", "domainMax": 25.984375, "extra": , + "icon": undefined, "progressBarDirection": "vertical", "subtitle": "Median products.base_price", "title": "Saturday", @@ -708,6 +726,7 @@ describe('MetricVisComponent', function () { "color": "#f5f7fa", "domainMax": 25.784375, "extra": , + "icon": undefined, "progressBarDirection": "vertical", "subtitle": "Median products.base_price", "title": "Sunday", @@ -718,6 +737,7 @@ describe('MetricVisComponent', function () { "color": "#f5f7fa", "domainMax": 25.348011363636363, "extra": , + "icon": undefined, "progressBarDirection": "vertical", "subtitle": "Median products.base_price", "title": "Thursday", @@ -730,6 +750,7 @@ describe('MetricVisComponent', function () { "color": "#f5f7fa", "domainMax": 24.984375, "extra": , + "icon": undefined, "progressBarDirection": "vertical", "subtitle": "Median products.base_price", "title": "Other", diff --git a/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.tsx b/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.tsx index 6bac88177bf50..d20cccb46617f 100644 --- a/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.tsx +++ b/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.tsx @@ -36,7 +36,7 @@ import type { FieldFormatConvertFunction } from '@kbn/field-formats-plugin/commo import { CUSTOM_PALETTE } from '@kbn/coloring'; import { css } from '@emotion/react'; import { euiThemeVars } from '@kbn/ui-theme'; -import { useResizeObserver, useEuiScrollBar } from '@elastic/eui'; +import { useResizeObserver, useEuiScrollBar, EuiIcon } from '@elastic/eui'; import { AllowedSettingsOverrides } from '@kbn/charts-plugin/common'; import { getOverridesFor } from '@kbn/chart-expressions-common'; import { DEFAULT_TRENDLINE_NAME } from '../../common/constants'; @@ -173,6 +173,11 @@ const buildFilterEvent = (rowIdx: number, columnIdx: number, table: Datatable) = }; }; +const getIcon = + (type: string) => + ({ width, height, color }: { width: number; height: number; color: string }) => + ; + export interface MetricVisComponentProps { data: Datatable; config: Pick; @@ -229,6 +234,7 @@ export const MetricVis = ({ valueFormatter: formatPrimaryMetric, title, subtitle, + icon: config.metric?.icon ? getIcon(config.metric?.icon) : undefined, extra: ( {secondaryPrefix} diff --git a/src/plugins/content_management/README.md b/src/plugins/content_management/README.md index 08bbe41c4f787..94eeb23a50d8f 100644 --- a/src/plugins/content_management/README.md +++ b/src/plugins/content_management/README.md @@ -1,3 +1,22 @@ # Content management The content management plugin provides functionality to manage content in Kibana. + + +## Testing + +Many parts of the Content Management service are implemented *in-memory*, hence it +is possible to test big chunks of the Content Management plugin using Jest +tests. + + +### Elasticsearch Integration tests + +Some functionality of the Content Management plugin can be tested using *Kibana +Integration Tests*, which execute tests against a real Elasticsearch instance. + +Run integrations tests with: + +``` +yarn test:jest_integration src/plugins/content_management +``` diff --git a/src/plugins/content_management/common/index.ts b/src/plugins/content_management/common/index.ts index 5cdb5ba06f4c7..998f4a56715f4 100644 --- a/src/plugins/content_management/common/index.ts +++ b/src/plugins/content_management/common/index.ts @@ -12,9 +12,20 @@ export type { ProcedureSchemas, ProcedureName, GetIn, + GetResult, BulkGetIn, + BulkGetResult, CreateIn, + CreateResult, UpdateIn, + UpdateResult, DeleteIn, + DeleteResult, SearchIn, + SearchQuery, + SearchResult, + MSearchIn, + MSearchQuery, + MSearchResult, + MSearchOut, } from './rpc'; diff --git a/src/plugins/content_management/common/rpc/bulk_get.ts b/src/plugins/content_management/common/rpc/bulk_get.ts index 06971c0e1c799..c9d313b4473ef 100644 --- a/src/plugins/content_management/common/rpc/bulk_get.ts +++ b/src/plugins/content_management/common/rpc/bulk_get.ts @@ -8,6 +8,7 @@ import { schema } from '@kbn/config-schema'; import type { Version } from '@kbn/object-versioning'; import { versionSchema } from './constants'; +import { GetResult, getResultSchema } from './get'; import type { ProcedureSchemas } from './types'; @@ -21,15 +22,27 @@ export const bulkGetSchemas: ProcedureSchemas = { }, { unknowns: 'forbid' } ), - out: schema.oneOf([ - schema.object({}, { unknowns: 'allow' }), - schema.arrayOf(schema.object({}, { unknowns: 'allow' })), - ]), + out: schema.object( + { + hits: schema.arrayOf(getResultSchema), + meta: schema.maybe(schema.object({}, { unknowns: 'allow' })), + }, + { unknowns: 'forbid' } + ), }; -export interface BulkGetIn { +export interface BulkGetIn { contentTypeId: T; ids: string[]; version?: Version; options?: Options; } + +export type BulkGetResult = ResultMeta extends void + ? { + hits: Array>; + } + : { + hits: Array>; + meta: ResultMeta; + }; diff --git a/src/plugins/content_management/common/rpc/common.ts b/src/plugins/content_management/common/rpc/common.ts new file mode 100644 index 0000000000000..e1313aa6b16ed --- /dev/null +++ b/src/plugins/content_management/common/rpc/common.ts @@ -0,0 +1,16 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import { schema } from '@kbn/config-schema'; + +export const itemResultSchema = schema.object( + { + item: schema.object({}, { unknowns: 'allow' }), + meta: schema.maybe(schema.object({}, { unknowns: 'allow' })), + }, + { unknowns: 'forbid' } +); diff --git a/src/plugins/content_management/common/rpc/constants.ts b/src/plugins/content_management/common/rpc/constants.ts index e88ab0f6df689..18df2fb7e22db 100644 --- a/src/plugins/content_management/common/rpc/constants.ts +++ b/src/plugins/content_management/common/rpc/constants.ts @@ -8,7 +8,15 @@ import { schema } from '@kbn/config-schema'; import { validateVersion } from '@kbn/object-versioning/lib/utils'; -export const procedureNames = ['get', 'bulkGet', 'create', 'update', 'delete', 'search'] as const; +export const procedureNames = [ + 'get', + 'bulkGet', + 'create', + 'update', + 'delete', + 'search', + 'mSearch', +] as const; export type ProcedureName = typeof procedureNames[number]; diff --git a/src/plugins/content_management/common/rpc/create.ts b/src/plugins/content_management/common/rpc/create.ts index 90d797603d16d..42c4e299a05c5 100644 --- a/src/plugins/content_management/common/rpc/create.ts +++ b/src/plugins/content_management/common/rpc/create.ts @@ -7,9 +7,10 @@ */ import { schema } from '@kbn/config-schema'; import type { Version } from '@kbn/object-versioning'; +import { itemResultSchema } from './common'; import { versionSchema } from './constants'; -import type { ProcedureSchemas } from './types'; +import type { ItemResult, ProcedureSchemas } from './types'; export const createSchemas: ProcedureSchemas = { in: schema.object( @@ -22,16 +23,24 @@ export const createSchemas: ProcedureSchemas = { }, { unknowns: 'forbid' } ), - out: schema.maybe(schema.object({}, { unknowns: 'allow' })), + out: schema.object( + { + contentTypeId: schema.string(), + result: itemResultSchema, + }, + { unknowns: 'forbid' } + ), }; export interface CreateIn< T extends string = string, Data extends object = object, - Options extends object = object + Options extends void | object = object > { contentTypeId: T; data: Data; version?: Version; options?: Options; } + +export type CreateResult = ItemResult; diff --git a/src/plugins/content_management/common/rpc/delete.ts b/src/plugins/content_management/common/rpc/delete.ts index 83f72b7e541c2..e9287e8964ccd 100644 --- a/src/plugins/content_management/common/rpc/delete.ts +++ b/src/plugins/content_management/common/rpc/delete.ts @@ -21,12 +21,27 @@ export const deleteSchemas: ProcedureSchemas = { }, { unknowns: 'forbid' } ), - out: schema.maybe(schema.object({}, { unknowns: 'allow' })), + out: schema.object( + { + contentTypeId: schema.string(), + result: schema.object( + { + success: schema.boolean(), + }, + { unknowns: 'forbid' } + ), + }, + { unknowns: 'forbid' } + ), }; -export interface DeleteIn { +export interface DeleteIn { contentTypeId: T; id: string; version?: Version; options?: Options; } + +export interface DeleteResult { + success: boolean; +} diff --git a/src/plugins/content_management/common/rpc/get.ts b/src/plugins/content_management/common/rpc/get.ts index 895e4a25de792..e00838afde988 100644 --- a/src/plugins/content_management/common/rpc/get.ts +++ b/src/plugins/content_management/common/rpc/get.ts @@ -7,9 +7,18 @@ */ import { schema } from '@kbn/config-schema'; import type { Version } from '@kbn/object-versioning'; +import { itemResultSchema } from './common'; import { versionSchema } from './constants'; -import type { ProcedureSchemas } from './types'; +import type { ItemResult, ProcedureSchemas } from './types'; + +export const getResultSchema = schema.object( + { + contentTypeId: schema.string(), + result: itemResultSchema, + }, + { unknowns: 'forbid' } +); export const getSchemas: ProcedureSchemas = { in: schema.object( @@ -21,13 +30,14 @@ export const getSchemas: ProcedureSchemas = { }, { unknowns: 'forbid' } ), - // --> "out" will be (optionally) specified by each storage layer - out: schema.maybe(schema.object({}, { unknowns: 'allow' })), + out: getResultSchema, }; -export interface GetIn { +export interface GetIn { id: string; contentTypeId: T; version?: Version; options?: Options; } + +export type GetResult = ItemResult; diff --git a/src/plugins/content_management/common/rpc/index.ts b/src/plugins/content_management/common/rpc/index.ts index d078d6dffbc60..3ab4e1919e748 100644 --- a/src/plugins/content_management/common/rpc/index.ts +++ b/src/plugins/content_management/common/rpc/index.ts @@ -9,11 +9,12 @@ export { schemas } from './rpc'; export { procedureNames } from './constants'; -export type { GetIn } from './get'; -export type { BulkGetIn } from './bulk_get'; -export type { CreateIn } from './create'; -export type { UpdateIn } from './update'; -export type { DeleteIn } from './delete'; -export type { SearchIn } from './search'; +export type { GetIn, GetResult } from './get'; +export type { BulkGetIn, BulkGetResult } from './bulk_get'; +export type { CreateIn, CreateResult } from './create'; +export type { UpdateIn, UpdateResult } from './update'; +export type { DeleteIn, DeleteResult } from './delete'; +export type { SearchIn, SearchQuery, SearchResult } from './search'; +export type { MSearchIn, MSearchQuery, MSearchOut, MSearchResult } from './msearch'; export type { ProcedureSchemas } from './types'; export type { ProcedureName } from './constants'; diff --git a/src/plugins/content_management/common/rpc/msearch.ts b/src/plugins/content_management/common/rpc/msearch.ts new file mode 100644 index 0000000000000..9ba1fc81c65bf --- /dev/null +++ b/src/plugins/content_management/common/rpc/msearch.ts @@ -0,0 +1,51 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import { schema } from '@kbn/config-schema'; +import type { Version } from '@kbn/object-versioning'; +import { versionSchema } from './constants'; +import { searchQuerySchema, searchResultSchema, SearchQuery, SearchResult } from './search'; + +import type { ProcedureSchemas } from './types'; + +export const mSearchSchemas: ProcedureSchemas = { + in: schema.object( + { + contentTypes: schema.arrayOf( + schema.object({ contentTypeId: schema.string(), version: versionSchema }), + { + minSize: 1, + } + ), + query: searchQuerySchema, + }, + { unknowns: 'forbid' } + ), + out: schema.object( + { + contentTypes: schema.arrayOf( + schema.object({ contentTypeId: schema.string(), version: versionSchema }) + ), + result: searchResultSchema, + }, + { unknowns: 'forbid' } + ), +}; + +export type MSearchQuery = SearchQuery; + +export interface MSearchIn { + contentTypes: Array<{ contentTypeId: string; version?: Version }>; + query: MSearchQuery; +} + +export type MSearchResult = SearchResult; + +export interface MSearchOut { + contentTypes: Array<{ contentTypeId: string; version?: Version }>; + result: MSearchResult; +} diff --git a/src/plugins/content_management/common/rpc/rpc.ts b/src/plugins/content_management/common/rpc/rpc.ts index 4b497d4e7cc25..0d9d472785a38 100644 --- a/src/plugins/content_management/common/rpc/rpc.ts +++ b/src/plugins/content_management/common/rpc/rpc.ts @@ -14,6 +14,7 @@ import { createSchemas } from './create'; import { updateSchemas } from './update'; import { deleteSchemas } from './delete'; import { searchSchemas } from './search'; +import { mSearchSchemas } from './msearch'; export const schemas: { [key in ProcedureName]: ProcedureSchemas; @@ -24,4 +25,5 @@ export const schemas: { update: updateSchemas, delete: deleteSchemas, search: searchSchemas, + mSearch: mSearchSchemas, }; diff --git a/src/plugins/content_management/common/rpc/search.ts b/src/plugins/content_management/common/rpc/search.ts index 05305b092f0ae..8958697df9c0b 100644 --- a/src/plugins/content_management/common/rpc/search.ts +++ b/src/plugins/content_management/common/rpc/search.ts @@ -11,30 +11,89 @@ import { versionSchema } from './constants'; import type { ProcedureSchemas } from './types'; +export const searchQuerySchema = schema.oneOf([ + schema.object( + { + text: schema.maybe(schema.string()), + tags: schema.maybe( + schema.object({ + included: schema.maybe(schema.arrayOf(schema.string())), + excluded: schema.maybe(schema.arrayOf(schema.string())), + }) + ), + limit: schema.maybe(schema.number()), + cursor: schema.maybe(schema.string()), + }, + { + unknowns: 'forbid', + } + ), +]); + +export const searchResultSchema = schema.object({ + hits: schema.arrayOf(schema.any()), + pagination: schema.object({ + total: schema.number(), + cursor: schema.maybe(schema.string()), + }), +}); + export const searchSchemas: ProcedureSchemas = { in: schema.object( { contentTypeId: schema.string(), version: versionSchema, - // --> "query" that can be executed will be defined by each content type - query: schema.recordOf(schema.string(), schema.any()), + query: searchQuerySchema, options: schema.maybe(schema.object({}, { unknowns: 'allow' })), }, { unknowns: 'forbid' } ), - out: schema.oneOf([ - schema.object({}, { unknowns: 'allow' }), - schema.arrayOf(schema.object({}, { unknowns: 'allow' })), - ]), + out: schema.object( + { + contentTypeId: schema.string(), + result: searchResultSchema, + meta: schema.maybe(schema.object({}, { unknowns: 'allow' })), + }, + { unknowns: 'forbid' } + ), }; -export interface SearchIn< - T extends string = string, - Query extends object = object, - Options extends object = object -> { +export interface SearchQuery { + /** The text to search for */ + text?: string; + /** List of tags id to include and exclude */ + tags?: { + included?: string[]; + excluded?: string[]; + }; + /** The number of result to return */ + limit?: number; + /** The cursor for this query. Can be a page number or a cursor */ + cursor?: string; +} + +export interface SearchIn { contentTypeId: T; - query: Query; + query: SearchQuery; version?: Version; options?: Options; } + +export type SearchResult = M extends void + ? { + hits: T[]; + pagination: { + total: number; + /** Page number or cursor */ + cursor?: string; + }; + } + : { + hits: T[]; + pagination: { + total: number; + /** Page number or cursor */ + cursor?: string; + }; + meta: M; + }; diff --git a/src/plugins/content_management/common/rpc/types.ts b/src/plugins/content_management/common/rpc/types.ts index 7c6ad6672dbcf..781ba7abc20cf 100644 --- a/src/plugins/content_management/common/rpc/types.ts +++ b/src/plugins/content_management/common/rpc/types.ts @@ -11,3 +11,12 @@ export interface ProcedureSchemas { in: Type | false; out?: Type | false; } + +export type ItemResult = M extends void + ? { + item: T; + } + : { + item: T; + meta: M; + }; diff --git a/src/plugins/content_management/common/rpc/update.ts b/src/plugins/content_management/common/rpc/update.ts index 8d1c74cf706f3..1b9afa15b636b 100644 --- a/src/plugins/content_management/common/rpc/update.ts +++ b/src/plugins/content_management/common/rpc/update.ts @@ -7,9 +7,10 @@ */ import { schema } from '@kbn/config-schema'; import type { Version } from '@kbn/object-versioning'; +import { itemResultSchema } from './common'; import { versionSchema } from './constants'; -import type { ProcedureSchemas } from './types'; +import type { ItemResult, ProcedureSchemas } from './types'; export const updateSchemas: ProcedureSchemas = { in: schema.object( @@ -23,13 +24,19 @@ export const updateSchemas: ProcedureSchemas = { }, { unknowns: 'forbid' } ), - out: schema.maybe(schema.object({}, { unknowns: 'allow' })), + out: schema.object( + { + contentTypeId: schema.string(), + result: itemResultSchema, + }, + { unknowns: 'forbid' } + ), }; export interface UpdateIn< T extends string = string, Data extends object = object, - Options extends object = object + Options extends void | object = object > { contentTypeId: T; id: string; @@ -37,3 +44,5 @@ export interface UpdateIn< version?: Version; options?: Options; } + +export type UpdateResult = ItemResult; diff --git a/src/plugins/content_management/docs/content_onboarding.md b/src/plugins/content_management/docs/content_onboarding.md new file mode 100644 index 0000000000000..843a8313a784f --- /dev/null +++ b/src/plugins/content_management/docs/content_onboarding.md @@ -0,0 +1,680 @@ +# Content management - onboarding + +This documentation lays down the steps to migrate away from the saved object public client by using the content management registries (public and server) and its public client. + +## High level arquitecture + +* New content is registered both in the browser and the server CM registries. +* When registring on the server, a storage instance is required. This storage instance exposes CRUD and search functionalities for the content (by calling the saved object client apis). +* In the browser, the `contentManagement` plugin exposes a client to call the storage instance methods on the server. + +With the above step: + * All Requests are cached in the browser + * Events are emitted on the server (`'getItemStart'`, `'getItemSuccess'`...) + * Content version is added to all HTTP request (to allow BWC implementation on the server) + +## Steps + +### 1. Add Kibana plugin dependency to the contentManagement plugin + +``` +// kibana.jsonc +{ + ... + "requiredPlugins": [ + ... + "contentManagement" + ] +} +``` + +### 2. Create the TS types + validation schema for the content + +To version the different objects that are sent to/returned by the storage instance methods we will create one folder for each new version of our content. This will help keep things tidy as our content evolves. +This is the folder structure that we are going to use: + +```js +- src/plugins//common/content_management + - index.ts + - latest.ts // export the types of the latest version + - types.ts // common types + - cm_services.ts // Map of Content management service definitions for each version + - v1 // folder for the version 1 of our content + - index.ts + - types.ts // types for "v1" + - cm_services.ts // Content management service definition for "v1" +``` + +#### 2.a. Types + +We create a "v1" folder and start exporting the different object types. + +```ts +// common/content_management/v1/types.ts +import type { + // Use the In/Out types from contentManagement to build yours + GetIn, + GetResult, + CreateIn, + CreateResult, + ... +} from '@kbn/content-management-plugin/common'; + +export type MapContentType = 'map'; + +export type MapAttributes = { + title: string; + description?: string; + ... +}; + +// Create a unique interface for your content +export interface MapItem { + id: string; + type: string; + version?: string; + // ... all other SO fields needed + attributes: T; +} + +// Expose the IN/OUT interface of all the objects used in your CRUD + Search +// Having clearly defined interfaces for what is sent (IN) and what is returned (OUT) will greatly help +// with BWC and building transforms function for our objects. + +export MapGetIn = GetIn; +export MapGetOut = GetResult; + +// All methods allow a last "Options" object to be passed +export interface CreateOptions { references?: Reference[]; } +export type MapCreateIn = CreateIn; +export type MapCreateOut = CreateResult; + +// ... follow the same pattern for all the CRUD + search methods +``` + +Once all the types have been defined we export them from the `latest.ts` file. + +```ts +// common/content_management/latest.ts +export * from './v1'; +``` + +And from the barrel file we explicitely export the types from `latest.ts` + +```ts +// common/content_management/index.ts +export type { + MapAttributes, + MapItem, + MapGetIn, + MapGetOut, + ... +} from './latest'; +``` + +#### 2.b. Content management services definition + +Now that we have the TS interfaces defined, let's create a content management services definition. This is where you will declare runtime validation schemas and `up()` and `down()` transform functions to convert your objects to previous/next version of your content. We won't add those just yet because we only have one version, but at the end of this doc we will see how to declare a new version of our content. + +```ts +// common/content_management/v1/cm_services.ts +import { schema } from '@kbn/config-schema'; +import type { ContentManagementServicesDefinition as ServicesDefinition } from '@kbn/object-versioning'; + +// We export the attributes object so we can extend it in future version +export const mapAttributesProperties = { + title: schema.string(), + description: schema.maybe(schema.string()), + ... +}; + +const mapAttributesSchema = schema.object( + mapAttributesProperties, + { unknowns: 'forbid' } +); + +// We export the mapItem object so we can extend it in future version +export const mapItemProperties = { + id: schema.string(), + type: schema.string(), + ... + attributes: mapAttributesSchema, +}; + +const mapItemSchema = schema.object( + mapItemProperties, + { unknowns: 'allow' } +); + +// The storage instance "get()" response. It corresponds to our MapGetOut interface above. +const getResultSchema = schema.object( + { + item: mapItemSchema, + meta: schema.object( + { + someOptionalMetaField: schema.maybe(schema.string()), // See "MapGetOut" above for this meta field + }, + { unknowns: 'forbid' } + ), + }, + { unknowns: 'forbid' } +); + +// Schema for the "CreateOptions" TS interface +const createOptionsSchema = schema.object({ + references: schema.maybe(referencesSchema), +}); + +// ... follow the same pattern for all your objects + +// Create a CM services definition +export const serviceDefinition: ServicesDefinition = { + get: { + out: { + result: { + schema: getResultSchema, + }, + }, + }, + create: { + in: { + options: { + schema: createOptionsSchema, + }, + data: { + // Schema to validate the data to be saved + schema: mapAttributesSchema, + }, + }, + out: { + result: { + schema: schema.object( + { + item: mapSavedObjectSchema, + }, + { unknowns: 'forbid' } + ), + }, + }, + }, + // ...other methods +}; +``` + +#### 2.c. Delcare a map of CM services definition + +We expose a map of all the versioned supported. Initially we'll have a single version but as our content evolves we will be adding more versions in this map. + +```ts +// common/content_management/cm_services.ts +import type { + ContentManagementServicesDefinition as ServicesDefinition, + Version, +} from '@kbn/object-versioning'; + +// We export the versionned service definition from this file and not the barrel to avoid adding +// the schemas in the "public" js bundle + +import { serviceDefinition as v1 } from './v1/cm_services'; + +export const cmServicesDefinition: { [version: Version]: ServicesDefinition } = { + 1: v1, +}; +``` + +### 3. Create a Storage instance for the content + +Once we have all our TS types defined and our CM ServicesDetinition map, we can create a `ContentStorage` class and its CRUD + search methods. + +```ts +/** + * Import the map of CM services definitions that we created earlier. + */ +import { cmServicesDefinition } from '../../common/content_management/cm_services'; + +/** + * It is a good practice to not directly exposes the SO document fields, specially the "attributes" object. + * Having a serializer function to convert the SavedObject to our own specific content (MapItem) guarantees + * that we won't leak any additional fields in our Response, even when the SO client adds new fields to its responses. + */ +function savedObjectToMapItem( + savedObject: SavedObject +): MapItem { + const { + id, + type, + updated_at: updatedAt, + created_at: createdAt, + attributes: { title, description, ... }, + references, + error, + namespaces, + } = savedObject; + + return { + id, + type, + updatedAt, + createdAt, + attributes: { + title, + description, + // other attributes. Ideally **not** stringified JSON + // but proper objects that can be versionned and transformed + ... + }, + references, + error, + namespaces, + }; +} + +export class MapsStorage implements ContentStorage { + // Every method receives a context object with content version information, the core request handler context + // (which contains the scoped SO client), utilities... + async get(ctx: StorageContext, id: string): Promise { + const { + requestHandlerContext, + utils: { getTransforms }, + version: { request: requestVersion }, + } = ctx; + const { savedObjects: { client: soClient } } = await requestHandlerContext.core; + + // Get the up/down transform for the CM services passing the requestVersion. + // All the "up()" calls will transform from the requestVersion to the "latest" declared in the registry + // All the "down()" calls will transform from the "latest" to the requestVersion. + // Important: calling "down()" or "up()" will **never** throw if no handler is declared. The object will simply be returned. + const transforms = getTransforms(cmServicesDefinition, requestVersion); + + // Call the SO client + const { + saved_object: savedObject, + alias_purpose: aliasPurpose, + alias_target_id: aliasTargetId, + outcome, + } = await soClient.resolve(SO_TYPE, id); + + const response: MapGetOut = { + item: savedObjectToMapItem(savedObject), + meta: { + aliasPurpose, + aliasTargetId, + outcome, + }, + }; + + // Validate DB response and DOWN transform to the request version + // Note: If the request version === latest version the object will be returned as is. + const { value, error: resultValidationError } = transforms.get.out.result.down< + MapGetOut, + MapGetOut + >(response); + + if (resultValidationError) { + throw Boom.badRequest(`Invalid response. ${resultValidationError.message}`); + } + + return value; + } + + async create( + ctx: StorageContext, + data: MapCreateIn['data'], + options: CreateOptions + ): Promise { + ... // same logic to initiate transforms, get the SO client.... + + // Validate input (data & options) & UP transform them to the latest version + const { value: dataToLatest, error: dataError } = transforms.create.in.data.up< + MapSavedObjectAttributes, + MapSavedObjectAttributes + >(data); + if (dataError) { + throw Boom.badRequest(`Invalid payload. ${dataError.message}`); + } + + const { value: optionsToLatest, error: optionsError } = + transforms.create.in.options.up(options); + if (optionsError) { + throw Boom.badRequest(`Invalid payload. ${optionsError.message}`); + } + + // At this stage: + // - the "data" and "options" object are valid + // - both are on the latest version + + // Save data in DB + const savedObject = await soClient.create( + SO_TYPE, + dataToLatest, + optionsToLatest + ); + + // Validate DB response and DOWN transform to the request version + const { value, error: resultError } = transforms.create.out.result.down< + MapCreateOut, + MapCreateOut + >({ + item: savedObjectToMapItem(savedObject), + }); + + if (resultError) { + throw Boom.badRequest(`Invalid payload. ${resultError.message}`); + } + + // value is valid for the client (browser) + return value; + } + + // ...same pattern for bulkGet(), update(), delete(), search +} +``` + +### 4. Register the content on the server + +Once the storage instance is ready we can register the content server side. + +Let's first create some constants... + +```ts +// common/content_management/constants.ts + +/** + * The latest version of our content. We'll increase it by 1 for each new version. + */ +export const LATEST_VERSION = 1; + +/** + * The contentType id. It does not have to be the same as the SO name but + * it's probably a good idea if they match. + */ +export const CONTENT_ID = 'map'; +``` + +```ts +// server/plugin.ts + +export class MapsPlugin implements Plugin { + ... + + setup(core: CoreSetup, plugins: SetupDeps) { + ... + + const { , contentManagement } = plugins; + ... + + contentManagement.register({ + id: CONTENT_ID, + storage: new MapsStorage(), // Instantiate our storage class + version: { + latest: LATEST_VERSION, + }, + }); + + ... + } + + ... +} +``` + +### 5. Register the content in the browser + +```ts +// public/plugin.ts + +import { CONTENT_ID, LATEST_VERSION } from '../common/content_management'; + +export class MapsPlugin implements Plugin +{ + ... + + public setup( + core: CoreSetup, + plugins: MapsPluginSetupDependencies + ): MapsSetupApi { + ... + + plugins.contentManagement.registry.register({ + id: CONTENT_ID, + version: { + latest: LATEST_VERSION, + }, + name: getAppTitle(), + }); + + ... + } + + ... +} +``` + +### 6. Expose a public client + +This step is optional but it is recommended. Indeed we could access the CM public client and call its api directly in our React app but that means that we would have to also pass everywhere the generics to type our payloads and responses. To avoid that we will build a maps client where each method is correctly typed. + +```ts +// public/content_management/maps_client.ts + +import type { SearchQuery } from '@kbn/content-management-plugin/common'; + +import type { MapGetIn, MapGetOut, MapCreateIn, MapCreateOut, ... } from '../../common/content_management'; +import { getContentManagement } from '../kibana_services'; + +const get = async (id: string) => { + return getContentManagement().client.get({ + contentTypeId: 'map', + id, + }); +}; + +const create = async ({ data, options }: Omit) => { + const res = await getContentManagement().client.create({ + contentTypeId: 'map', + data, + options, + }); + return res; +}; + +// ... same pattern for other methods + +export const mapsClient = { + get, + create, + ... +}; +``` + +We now have a client that we can use anywhere in our app that will call our storage instance on the server, automatically passing the browser version (requestVersion) for BWC support. + +```ts +import { mapsClient } from './content_management'; + +const { id } = await (savedObjectId + ? mapsClient.update({ id: savedObjectId, data: updatedAttributes, options: { references } }) + : mapsClient.create({ data: updatedAttributes, options: { references } })); +``` + +## BWC compatibility and Zero down time + +With serverless we need to support the case where the server is on a more recent version than the browser. On a newer version of our content a field might have been removed or renamed, the DB mapping updated and the server is now expecting object with a different contract than the previous version. The solution in CM to support this is to declare `up()` and `down()` transforms for our objects. + +### Example + +Let's imagine that the map `"title"` fields needs to be changed to `"name"`. We make the required changes in the mappings for the SO migrations and the "title" field is removed/renamed in the DB, the server is on "v2" and start accepting request from clients either on "v1" or on "v2". When creating a new map, the "v2" server expects the object to contain a "name" field, (and not "title" anymore). + +Create a "v2" folder for the new TS interfaces and CM services definition + +#### 1. Update the types + +```ts +// common/content_management/v2/types +import { MapItem as MapItemV1, CreateOptions } from '../v1'; + +export interface MapAttributes { + name: string; // --> changed "title" with "name" + description?: string; + ... +} + +// Export a new MapItem for "v2" +export type MapItem = MapItemV1; + +// Re-export all the types fro "v1" that have not changed +export { MapGetIn } from '../v1'; +export type MapGetOut = GetResult; + +export type MapCreateIn = CreateIn; + +// Re-export all other types, either explicitely either re-exporting the "v1" ones. +``` + +#### 2. Update `latest.ts` to point to the new version + +```ts +// common/content_management/latest.ts +export * from './v2'; +``` + +#### 3. Create a new cm services definition + +Note: Use `down()` transforms for objects that are returned ("out") to the client + +```ts +// common/content_management/v2/cm_services.ts + +import { + serviceDefinition as serviceDefinitionV1, + mapAttributesProperties as mapAttributesPropertiesV1, + mapItemProperties as mapItemPropertiesV1, + type MapGetOut as MapGetOutV1, // the "v1" one +} from '../v1'; +import { MapGetOut } from './types'; // the "v2" one + +const { title, ...mapAttributesPropertiesNoTitle } = mapAttributesPropertiesV1; +export const mapAttributesProperties = { + ...mapAttributesPropertiesNoTitle, + name: schema.string(), // "title" is now "name" +} + +const mapAttributesSchema = schema.object( + mapAttributesProperties, + { unknowns: 'forbid' } +); + +export const mapItemSchema = schema.object( + { + ...mapItemPropertiesV1, // nothing has changed except the "attributes" that we'll override below + attributes: mapAttributesSchema, + }, + { unknowns: 'allow' } +); + +const getResultSchema = schema.object( + { + item: mapItemSchema, + meta: schema.object( + { + someOptionalMetaField: schema.maybe(schema.string()), + }, + { unknowns: 'forbid' } + ), + }, + { unknowns: 'forbid' } +); + +// Create a CM services definition +export const serviceDefinition: ServicesDefinition = { + // 1. Merge previous definition + ...serviceDefinitionV1, + // 2. Override any service objects + get: { + out: { + result: { + schema: getResultSchema, + down: (result: MapGetOut): MapGetOutV1 => { + // Down transform the result to "v1" version + const { name, ...rest } = result.item; + return { + ...result, + item: { + ...rest, + title: name, + } + } + } + }, + }, + }, + create: { + in: { + ...serviceDefinitionV1.create.in, + data: { + schema: mapAttributesSchema, + }, + }, + out: { + result: { + schema: schema.object( + { + item: mapSavedObjectSchema, + }, + { unknowns: 'forbid' } + ), + }, + }, + }, + // ...other methods +}; +``` + +#### 4. Add the new CM services definition to the map + +```ts +// common/content_management/cm_services.ts +... + +import { serviceDefinition as v1 } from './v1/cm_services'; +import { serviceDefinition as v2 } from './v2/cm_services'; + +export const cmServicesDefinition: { [version: Version]: ServicesDefinition } = { + 1: v1, + 2: v2, +}; +``` + +#### 5. Update the "v1" services definition and add `up()` transforms + +Note: Use `up()` transforms for objects coming "in" (input parameters of the storage instance methods) + +```ts +// common/content_management/v1/cm_services.ts +import { type MapCreateIn as MapCreateInV2 } from '../v2'; // the "v2" one +import { MapCreateIn } from './types'; // the "v1" one + +export const serviceDefinition: ServicesDefinition = { + ... + create: { + in: { + ... + data: { + schema: mapAttributesSchema, + // We add this "up()" transform to make "v1" data work with the "v2" server + up: (data: MapCreateIn['data']): MapCreateInV2['data'] => { + const { title, ...rest } = data; + return { + ...rest, + name: title, // Change "title" to "name" + } + } + }, + }, + ... + }, + ... +}; +``` + +That is all that is required for BWC. As we have seen, once we have added inside our storage instance methods the logic to up/down transforms all the objects we don't need to change its logic when releasing a new version of the content. Everyting is handled inside the services definitions. diff --git a/src/plugins/content_management/jest.integration.config.js b/src/plugins/content_management/jest.integration.config.js new file mode 100644 index 0000000000000..19a8063326873 --- /dev/null +++ b/src/plugins/content_management/jest.integration.config.js @@ -0,0 +1,13 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_integration', + rootDir: '../../..', + roots: ['/src/plugins/content_management'], +}; diff --git a/src/plugins/content_management/public/content_client/content_client.test.ts b/src/plugins/content_management/public/content_client/content_client.test.ts index a654314fd1533..8fcd19f7865c9 100644 --- a/src/plugins/content_management/public/content_client/content_client.test.ts +++ b/src/plugins/content_management/public/content_client/content_client.test.ts @@ -10,7 +10,7 @@ import { lastValueFrom } from 'rxjs'; import { takeWhile, toArray } from 'rxjs/operators'; import { createCrudClientMock } from '../crud_client/crud_client.mock'; import { ContentClient } from './content_client'; -import type { GetIn, CreateIn, UpdateIn, DeleteIn, SearchIn } from '../../common'; +import type { GetIn, CreateIn, UpdateIn, DeleteIn, SearchIn, MSearchIn } from '../../common'; import { ContentTypeRegistry } from '../registry'; const setup = () => { @@ -182,3 +182,18 @@ describe('#search', () => { expect(loadedState.data).toEqual(output); }); }); + +describe('#mSearch', () => { + it('calls rpcClient.mSearch with input and returns output', async () => { + const { crudClient, contentClient } = setup(); + const input: MSearchIn = { contentTypes: [{ contentTypeId: 'testType' }], query: {} }; + const output = { hits: [{ id: 'test' }] }; + // @ts-ignore + crudClient.mSearch.mockResolvedValueOnce(output); + expect(await contentClient.mSearch(input)).toEqual(output); + expect(crudClient.mSearch).toBeCalledWith({ + contentTypes: [{ contentTypeId: 'testType', version: 3 }], // latest version added + query: {}, + }); + }); +}); diff --git a/src/plugins/content_management/public/content_client/content_client.tsx b/src/plugins/content_management/public/content_client/content_client.tsx index ae8240ccf5562..e1d148b74760a 100644 --- a/src/plugins/content_management/public/content_client/content_client.tsx +++ b/src/plugins/content_management/public/content_client/content_client.tsx @@ -11,7 +11,15 @@ import { validateVersion } from '@kbn/object-versioning/lib/utils'; import type { Version } from '@kbn/object-versioning'; import { createQueryObservable } from './query_observable'; import type { CrudClient } from '../crud_client'; -import type { CreateIn, GetIn, UpdateIn, DeleteIn, SearchIn } from '../../common'; +import type { + CreateIn, + GetIn, + UpdateIn, + DeleteIn, + SearchIn, + MSearchIn, + MSearchResult, +} from '../../common'; import type { ContentTypeRegistry } from '../registry'; export const queryKeyBuilder = { @@ -19,8 +27,8 @@ export const queryKeyBuilder = { item: (type: string, id: string) => { return [...queryKeyBuilder.all(type), id] as const; }, - search: (type: string, query: unknown) => { - return [...queryKeyBuilder.all(type), 'search', query] as const; + search: (type: string, query: unknown, options?: object) => { + return [...queryKeyBuilder.all(type), 'search', query, options] as const; }, }; @@ -73,7 +81,7 @@ const createQueryOptionBuilder = ({ const input = addVersion(_input, contentTypeRegistry); return { - queryKey: queryKeyBuilder.search(input.contentTypeId, input.query), + queryKey: queryKeyBuilder.search(input.contentTypeId, input.query, input.options), queryFn: () => crudClientProvider(input.contentTypeId).search(input) as Promise, }; }, @@ -85,7 +93,7 @@ export class ContentClient { readonly queryOptionBuilder: ReturnType; constructor( - private readonly crudClientProvider: (contentType: string) => CrudClient, + private readonly crudClientProvider: (contentType?: string) => CrudClient, private readonly contentTypeRegistry: ContentTypeRegistry ) { this.queryClient = new QueryClient(); @@ -133,4 +141,18 @@ export class ContentClient { this.queryOptionBuilder.search(addVersion(input, this.contentTypeRegistry)) ); } + + mSearch(input: MSearchIn): Promise> { + const crudClient = this.crudClientProvider(); + if (!crudClient.mSearch) { + throw new Error('mSearch is not supported by provided crud client'); + } + + return crudClient.mSearch({ + ...input, + contentTypes: input.contentTypes.map((contentType) => + addVersion(contentType, this.contentTypeRegistry) + ), + }) as Promise>; + } } diff --git a/src/plugins/content_management/public/crud_client/crud_client.mock.ts b/src/plugins/content_management/public/crud_client/crud_client.mock.ts index 2b2bead4ea462..d50ae23edcda6 100644 --- a/src/plugins/content_management/public/crud_client/crud_client.mock.ts +++ b/src/plugins/content_management/public/crud_client/crud_client.mock.ts @@ -15,6 +15,7 @@ export const createCrudClientMock = (): jest.Mocked => { update: jest.fn((input) => Promise.resolve({} as any)), delete: jest.fn((input) => Promise.resolve({} as any)), search: jest.fn((input) => Promise.resolve({ hits: [] } as any)), + mSearch: jest.fn((input) => Promise.resolve({ hits: [] } as any)), }; return mock; }; diff --git a/src/plugins/content_management/public/crud_client/crud_client.ts b/src/plugins/content_management/public/crud_client/crud_client.ts index 4976c7937dc4d..4f4bbadf00077 100644 --- a/src/plugins/content_management/public/crud_client/crud_client.ts +++ b/src/plugins/content_management/public/crud_client/crud_client.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import type { GetIn, CreateIn, UpdateIn, DeleteIn, SearchIn } from '../../common'; +import type { GetIn, CreateIn, UpdateIn, DeleteIn, SearchIn, MSearchIn } from '../../common'; export interface CrudClient { get(input: GetIn): Promise; @@ -14,4 +14,5 @@ export interface CrudClient { update(input: UpdateIn): Promise; delete(input: DeleteIn): Promise; search(input: SearchIn): Promise; + mSearch?(input: MSearchIn): Promise; } diff --git a/src/plugins/content_management/public/plugin.ts b/src/plugins/content_management/public/plugin.ts index 38b5bcb3283f5..9a20459fec2cb 100644 --- a/src/plugins/content_management/public/plugin.ts +++ b/src/plugins/content_management/public/plugin.ts @@ -43,10 +43,10 @@ export class ContentManagementPlugin public start(core: CoreStart, deps: StartDependencies) { const rpcClient = new RpcClient(core.http); - const contentClient = new ContentClient( - (contentType) => this.contentTypeRegistry.get(contentType)?.crud ?? rpcClient, - this.contentTypeRegistry - ); + const contentClient = new ContentClient((contentType) => { + if (!contentType) return rpcClient; + return this.contentTypeRegistry.get(contentType)?.crud ?? rpcClient; + }, this.contentTypeRegistry); return { client: contentClient, registry: { diff --git a/src/plugins/content_management/public/rpc_client/rpc_client.test.ts b/src/plugins/content_management/public/rpc_client/rpc_client.test.ts index c0d832919cf03..323f822ad885e 100644 --- a/src/plugins/content_management/public/rpc_client/rpc_client.test.ts +++ b/src/plugins/content_management/public/rpc_client/rpc_client.test.ts @@ -45,6 +45,7 @@ describe('RpcClient', () => { await rpcClient.update({ contentTypeId: 'foo', id: '123', data: {} }); await rpcClient.delete({ contentTypeId: 'foo', id: '123' }); await rpcClient.search({ contentTypeId: 'foo', query: {} }); + await rpcClient.mSearch({ contentTypes: [{ contentTypeId: 'foo' }], query: {} }); Object.values(proceduresSpys).forEach(({ name, spy }) => { expect(spy).toHaveBeenCalledWith(`${API_ENDPOINT}/${name}`, { body: expect.any(String) }); diff --git a/src/plugins/content_management/public/rpc_client/rpc_client.ts b/src/plugins/content_management/public/rpc_client/rpc_client.ts index 9ec27342d45f2..17ea6a1391a59 100644 --- a/src/plugins/content_management/public/rpc_client/rpc_client.ts +++ b/src/plugins/content_management/public/rpc_client/rpc_client.ts @@ -16,6 +16,9 @@ import type { DeleteIn, SearchIn, ProcedureName, + MSearchIn, + MSearchOut, + MSearchResult, } from '../../common'; import type { CrudClient } from '../crud_client/crud_client'; import type { @@ -30,28 +33,32 @@ import type { export class RpcClient implements CrudClient { constructor(private http: { post: HttpSetup['post'] }) {} - public get(input: I): Promise { - return this.sendMessage>('get', input).then((r) => r.item); + public get(input: I) { + return this.sendMessage>('get', input).then((r) => r.item); } - public bulkGet(input: I): Promise { - return this.sendMessage>('bulkGet', input).then((r) => r.items); + public bulkGet(input: I) { + return this.sendMessage>('bulkGet', input).then((r) => r.items); } - public create(input: I): Promise { - return this.sendMessage>('create', input).then((r) => r.result); + public create(input: I) { + return this.sendMessage>('create', input).then((r) => r.result); } - public update(input: I): Promise { - return this.sendMessage>('update', input).then((r) => r.result); + public update(input: I) { + return this.sendMessage>('update', input).then((r) => r.result); } - public delete(input: I): Promise { + public delete(input: I) { return this.sendMessage('delete', input).then((r) => r.result); } - public search(input: I): Promise { - return this.sendMessage('search', input).then((r) => r.result); + public search(input: I) { + return this.sendMessage>('search', input).then((r) => r.result); + } + + public mSearch(input: MSearchIn): Promise> { + return this.sendMessage>('mSearch', input).then((r) => r.result); } private sendMessage = async (name: ProcedureName, input: any): Promise => { diff --git a/src/plugins/content_management/server/core/core.test.ts b/src/plugins/content_management/server/core/core.test.ts index 220f33e009333..86e3797d2d92b 100644 --- a/src/plugins/content_management/server/core/core.test.ts +++ b/src/plugins/content_management/server/core/core.test.ts @@ -5,11 +5,12 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ + import { loggingSystemMock } from '@kbn/core/server/mocks'; import { Core } from './core'; -import { createMemoryStorage, FooContent } from './mocks'; +import { createMemoryStorage } from './mocks'; import { ContentRegistry } from './registry'; -import { ContentCrud } from './crud'; +import type { ContentCrud } from './crud'; import type { GetItemStart, GetItemSuccess, @@ -31,6 +32,8 @@ import type { SearchItemError, } from './event_types'; import { ContentTypeDefinition, StorageContext } from './types'; +import { until } from '../event_stream/tests/util'; +import { setupEventStreamService } from '../event_stream/tests/setup_event_stream_service'; const logger = loggingSystemMock.createLogger(); @@ -48,8 +51,13 @@ const setup = ({ registerFooType = false }: { registerFooType?: boolean } = {}) }, }; - const core = new Core({ logger }); + const eventStream = setupEventStreamService().service; + const core = new Core({ + logger, + eventStream, + }); const coreSetup = core.setup(); + const contentDefinition: ContentTypeDefinition = { id: FOO_CONTENT_ID, storage: createMemoryStorage(), @@ -76,6 +84,7 @@ const setup = ({ registerFooType = false }: { registerFooType?: boolean } = {}) fooContentCrud, cleanUp, eventBus: coreSetup.api.eventBus, + eventStream, }; }; @@ -156,7 +165,7 @@ describe('Content Core', () => { const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true }); const res = await fooContentCrud!.get(ctx, '1'); - expect(res.item).toBeUndefined(); + expect(res.item.item).toBeUndefined(); cleanUp(); }); @@ -168,8 +177,10 @@ describe('Content Core', () => { expect(res).toEqual({ contentTypeId: FOO_CONTENT_ID, item: { - // Options forwared in response - options: { foo: 'bar' }, + item: { + // Options forwared in response + options: { foo: 'bar' }, + }, }, }); @@ -180,7 +191,9 @@ describe('Content Core', () => { const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true }); const res = await fooContentCrud!.bulkGet(ctx, ['1', '2']); - expect(res.items).toEqual([]); + expect(res.items).toEqual({ + hits: [{ item: undefined }, { item: undefined }], + }); cleanUp(); }); @@ -194,14 +207,20 @@ describe('Content Core', () => { expect(res).toEqual({ contentTypeId: FOO_CONTENT_ID, - items: [ - { - options: { foo: 'bar' }, // Options forwared in response - }, - { - options: { foo: 'bar' }, // Options forwared in response - }, - ], + items: { + hits: [ + { + item: { + options: { foo: 'bar' }, // Options forwared in response + }, + }, + { + item: { + options: { foo: 'bar' }, // Options forwared in response + }, + }, + ], + }, }); cleanUp(); @@ -211,8 +230,8 @@ describe('Content Core', () => { const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true }); const res = await fooContentCrud!.get(ctx, '1234'); - expect(res.item).toBeUndefined(); - await fooContentCrud!.create, { id: string }>( + expect(res.item.item).toBeUndefined(); + await fooContentCrud!.create( ctx, { title: 'Hello' }, { id: '1234' } // We send this "id" option to specify the id of the content created @@ -220,8 +239,10 @@ describe('Content Core', () => { expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({ contentTypeId: FOO_CONTENT_ID, item: { - id: '1234', - title: 'Hello', + item: { + id: '1234', + title: 'Hello', + }, }, }); @@ -231,17 +252,15 @@ describe('Content Core', () => { test('update()', async () => { const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true }); - await fooContentCrud!.create, { id: string }>( - ctx, - { title: 'Hello' }, - { id: '1234' } - ); - await fooContentCrud!.update>(ctx, '1234', { title: 'changed' }); + await fooContentCrud!.create(ctx, { title: 'Hello' }, { id: '1234' }); + await fooContentCrud!.update(ctx, '1234', { title: 'changed' }); expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({ contentTypeId: FOO_CONTENT_ID, item: { - id: '1234', - title: 'changed', + item: { + id: '1234', + title: 'changed', + }, }, }); @@ -251,12 +270,8 @@ describe('Content Core', () => { test('update() - options are forwared to storage layer', async () => { const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true }); - await fooContentCrud!.create, { id: string }>( - ctx, - { title: 'Hello' }, - { id: '1234' } - ); - const res = await fooContentCrud!.update>( + await fooContentCrud!.create(ctx, { title: 'Hello' }, { id: '1234' }); + const res = await fooContentCrud!.update( ctx, '1234', { title: 'changed' }, @@ -266,18 +281,22 @@ describe('Content Core', () => { expect(res).toEqual({ contentTypeId: FOO_CONTENT_ID, result: { - id: '1234', - title: 'changed', - // Options forwared in response - options: { foo: 'bar' }, + item: { + id: '1234', + title: 'changed', + // Options forwared in response + options: { foo: 'bar' }, + }, }, }); expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({ contentTypeId: FOO_CONTENT_ID, item: { - id: '1234', - title: 'changed', + item: { + id: '1234', + title: 'changed', + }, }, }); @@ -287,19 +306,19 @@ describe('Content Core', () => { test('delete()', async () => { const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true }); - await fooContentCrud!.create, { id: string }>( - ctx, - { title: 'Hello' }, - { id: '1234' } - ); + await fooContentCrud!.create(ctx, { title: 'Hello' }, { id: '1234' }); expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({ contentTypeId: FOO_CONTENT_ID, - item: expect.any(Object), + item: { + item: expect.any(Object), + }, }); await fooContentCrud!.delete(ctx, '1234'); expect(fooContentCrud!.get(ctx, '1234')).resolves.toEqual({ contentTypeId: FOO_CONTENT_ID, - item: undefined, + item: { + item: undefined, + }, }); cleanUp(); @@ -308,15 +327,11 @@ describe('Content Core', () => { test('delete() - options are forwared to storage layer', async () => { const { fooContentCrud, ctx, cleanUp } = setup({ registerFooType: true }); - await fooContentCrud!.create, { id: string }>( - ctx, - { title: 'Hello' }, - { id: '1234' } - ); + await fooContentCrud!.create(ctx, { title: 'Hello' }, { id: '1234' }); const res = await fooContentCrud!.delete(ctx, '1234', { forwardInResponse: { foo: 'bar' }, }); - expect(res).toMatchObject({ result: { options: { foo: 'bar' } } }); + expect(res).toMatchObject({ result: { success: true, options: { foo: 'bar' } } }); cleanUp(); }); @@ -399,11 +414,7 @@ describe('Content Core', () => { register(contentDefinition); - await crud(FOO_CONTENT_ID).create, { id: string }>( - ctx, - { title: 'Hello' }, - { id: '1234' } - ); + await crud(FOO_CONTENT_ID).create(ctx, { title: 'Hello' }, { id: '1234' }); const listener = jest.fn(); @@ -431,7 +442,9 @@ describe('Content Core', () => { cleanUp(); }); - describe('crud operations should emit start|success|error events', () => { + // Skipping those tests for now. I will re-enable and fix them when doing + // https://github.com/elastic/kibana/issues/153258 + describe.skip('crud operations should emit start|success|error events', () => { test('get()', async () => { const { fooContentCrud, eventBus, ctx, cleanUp } = setup({ registerFooType: true, @@ -439,7 +452,7 @@ describe('Content Core', () => { const data = { title: 'Hello' }; - await fooContentCrud!.create, { id: string }>(ctx, data, { + await fooContentCrud!.create(ctx, data, { id: '1234', }); @@ -502,10 +515,10 @@ describe('Content Core', () => { const data = { title: 'Hello' }; - await fooContentCrud!.create, { id: string }>(ctx, data, { + await fooContentCrud!.create(ctx, data, { id: '1234', }); - await fooContentCrud!.create, { id: string }>(ctx, data, { + await fooContentCrud!.create(ctx, data, { id: '5678', }); @@ -579,13 +592,9 @@ describe('Content Core', () => { const listener = jest.fn(); const sub = eventBus.events$.subscribe(listener); - const promise = fooContentCrud!.create, { id: string }>( - ctx, - data, - { - id: '1234', - } - ); + const promise = fooContentCrud!.create(ctx, data, { + id: '1234', + }); const createItemStart: CreateItemStart = { type: 'createItemStart', @@ -615,7 +624,7 @@ describe('Content Core', () => { const errorMessage = 'Ohhh no!'; const reject = jest.fn(); await fooContentCrud! - .create, { id: string; errorToThrow: string }>(ctx, data, { + .create(ctx, data, { id: '1234', errorToThrow: errorMessage, }) @@ -642,7 +651,7 @@ describe('Content Core', () => { registerFooType: true, }); - await fooContentCrud!.create, { id: string }>( + await fooContentCrud!.create( ctx, { title: 'Hello' }, { @@ -714,7 +723,7 @@ describe('Content Core', () => { registerFooType: true, }); - await fooContentCrud!.create, { id: string }>( + await fooContentCrud!.create( ctx, { title: 'Hello' }, { @@ -780,14 +789,14 @@ describe('Content Core', () => { const myContent = { title: 'Hello' }; - await fooContentCrud!.create, { id: string }>(ctx, myContent, { + await fooContentCrud!.create(ctx, myContent, { id: '1234', }); const listener = jest.fn(); const sub = eventBus.events$.subscribe(listener); - const query = { title: 'Hell' }; + const query = { text: 'Hell' }; const promise = await fooContentCrud!.search(ctx, query, { someOptions: 'baz' }); @@ -839,6 +848,41 @@ describe('Content Core', () => { }); }); }); + + describe('eventStream', () => { + test('stores "delete" events', async () => { + const { fooContentCrud, ctx, eventStream } = setup({ registerFooType: true }); + + await fooContentCrud!.create(ctx, { title: 'Hello' }, { id: '1234' }); + await fooContentCrud!.delete(ctx, '1234'); + + const findEvent = async () => { + const tail = await eventStream.tail(); + + for (const event of tail) { + if ( + event.predicate[0] === 'delete' && + event.object && + event.object[0] === 'foo' && + event.object[1] === '1234' + ) { + return event; + } + } + + return null; + }; + + await until(async () => !!(await findEvent()), 100); + + const event = await findEvent(); + + expect(event).toMatchObject({ + predicate: ['delete'], + object: ['foo', '1234'], + }); + }); + }); }); }); }); diff --git a/src/plugins/content_management/server/core/core.ts b/src/plugins/content_management/server/core/core.ts index 2efc6546fa64e..8062e4ca23ea5 100644 --- a/src/plugins/content_management/server/core/core.ts +++ b/src/plugins/content_management/server/core/core.ts @@ -5,8 +5,9 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -import { Logger } from '@kbn/core/server'; +import { Logger } from '@kbn/core/server'; +import { EventStreamService } from '../event_stream'; import { ContentCrud } from './crud'; import { EventBus } from './event_bus'; import { ContentRegistry } from './registry'; @@ -20,11 +21,16 @@ export interface CoreApi { */ register: ContentRegistry['register']; /** Handler to retrieve a content crud instance */ - crud: (contentType: string) => ContentCrud; + crud: (contentType: string) => ContentCrud; /** Content management event bus */ eventBus: EventBus; } +export interface CoreInitializerContext { + logger: Logger; + eventStream: EventStreamService; +} + export interface CoreSetup { /** Content registry instance */ contentRegistry: ContentRegistry; @@ -36,7 +42,7 @@ export class Core { private contentRegistry: ContentRegistry; private eventBus: EventBus; - constructor({ logger }: { logger: Logger }) { + constructor(private readonly ctx: CoreInitializerContext) { const contentTypeValidator = (contentType: string) => this.contentRegistry?.isContentRegistered(contentType) ?? false; this.eventBus = new EventBus(contentTypeValidator); @@ -44,6 +50,8 @@ export class Core { } setup(): CoreSetup { + this.setupEventStream(); + return { contentRegistry: this.contentRegistry, api: { @@ -53,4 +61,16 @@ export class Core { }, }; } + + private setupEventStream() { + // TODO: This should be cleaned up and support added for all CRUD events. + this.eventBus.on('deleteItemSuccess', (event) => { + this.ctx.eventStream.addEvent({ + // TODO: add "subject" field to event + predicate: ['delete'], + // TODO: the `.contentId` should be easily available on most events. + object: [event.contentTypeId, (event as any).contentId], + }); + }); + } } diff --git a/src/plugins/content_management/server/core/crud.ts b/src/plugins/content_management/server/core/crud.ts index 1ac35769d0444..71fe8209bd8c6 100644 --- a/src/plugins/content_management/server/core/crud.ts +++ b/src/plugins/content_management/server/core/crud.ts @@ -5,47 +5,56 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ +import type { + GetResult, + BulkGetResult, + CreateResult, + UpdateResult, + DeleteResult, + SearchResult, + SearchQuery, +} from '../../common'; import type { EventBus } from './event_bus'; import type { ContentStorage, StorageContext } from './types'; -export interface GetResponse { +export interface GetResponse { contentTypeId: string; - item: T; + item: GetResult; } -export interface BulkGetResponse { +export interface BulkGetResponse { contentTypeId: string; - items: T; + items: BulkGetResult; } -export interface CreateItemResponse { +export interface CreateItemResponse { contentTypeId: string; - result: T; + result: CreateResult; } -export interface UpdateItemResponse { +export interface UpdateItemResponse { contentTypeId: string; - result: T; + result: UpdateResult; } -export interface DeleteItemResponse { +export interface DeleteItemResponse { contentTypeId: string; - result: T; + result: DeleteResult; } -export interface SearchResponse { +export interface SearchResponse { contentTypeId: string; - result: T; + result: SearchResult; } -export class ContentCrud implements ContentStorage { - private storage: ContentStorage; +export class ContentCrud { + private storage: ContentStorage; private eventBus: EventBus; public contentTypeId: string; constructor( contentTypeId: string, - contentStorage: ContentStorage, + contentStorage: ContentStorage, { eventBus, }: { @@ -57,11 +66,11 @@ export class ContentCrud implements ContentStorage { this.eventBus = eventBus; } - public async get( + public async get( ctx: StorageContext, contentId: string, - options?: Options - ): Promise> { + options?: object + ): Promise> { this.eventBus.emit({ type: 'getItemStart', contentId, @@ -94,11 +103,11 @@ export class ContentCrud implements ContentStorage { } } - public async bulkGet( + public async bulkGet( ctx: StorageContext, ids: string[], - options?: Options - ): Promise> { + options?: object + ): Promise> { this.eventBus.emit({ type: 'bulkGetItemStart', contentTypeId: this.contentTypeId, @@ -134,11 +143,11 @@ export class ContentCrud implements ContentStorage { } } - public async create( + public async create( ctx: StorageContext, - data: Data, - options?: Options - ): Promise> { + data: object, + options?: object + ): Promise> { this.eventBus.emit({ type: 'createItemStart', contentTypeId: this.contentTypeId, @@ -170,12 +179,12 @@ export class ContentCrud implements ContentStorage { } } - public async update( + public async update( ctx: StorageContext, id: string, - data: Data, - options?: Options - ): Promise> { + data: object, + options?: object + ): Promise> { this.eventBus.emit({ type: 'updateItemStart', contentId: id, @@ -210,11 +219,11 @@ export class ContentCrud implements ContentStorage { } } - public async delete( + public async delete( ctx: StorageContext, id: string, - options?: Options - ): Promise> { + options?: object + ): Promise { this.eventBus.emit({ type: 'deleteItemStart', contentId: id, @@ -246,11 +255,11 @@ export class ContentCrud implements ContentStorage { } } - public async search( + public async search( ctx: StorageContext, - query: Query, - options?: Options - ): Promise> { + query: SearchQuery, + options?: object + ): Promise> { this.eventBus.emit({ type: 'searchItemStart', contentTypeId: this.contentTypeId, diff --git a/src/plugins/content_management/server/core/event_types.ts b/src/plugins/content_management/server/core/event_types.ts index e1b6ebd67cf13..1c91c9961ff8e 100644 --- a/src/plugins/content_management/server/core/event_types.ts +++ b/src/plugins/content_management/server/core/event_types.ts @@ -5,15 +5,14 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -interface BaseEvent { +interface BaseEvent { type: T; contentTypeId: string; - options?: object; + options?: Options; } export interface GetItemStart extends BaseEvent<'getItemStart'> { contentId: string; - options?: object; } export interface GetItemSuccess extends BaseEvent<'getItemSuccess'> { @@ -28,7 +27,6 @@ export interface GetItemError extends BaseEvent<'getItemError'> { export interface BulkGetItemStart extends BaseEvent<'bulkGetItemStart'> { ids: string[]; - options?: object; } export interface BulkGetItemSuccess extends BaseEvent<'bulkGetItemSuccess'> { @@ -39,75 +37,62 @@ export interface BulkGetItemSuccess extends BaseEvent<'bulkGetItemSuccess'> { export interface BulkGetItemError extends BaseEvent<'bulkGetItemError'> { ids: string[]; error: unknown; - options?: object; } export interface CreateItemStart extends BaseEvent<'createItemStart'> { data: object; - options?: object; } export interface CreateItemSuccess extends BaseEvent<'createItemSuccess'> { data: object; - options?: object; } export interface CreateItemError extends BaseEvent<'createItemError'> { data: object; error: unknown; - options?: object; } export interface UpdateItemStart extends BaseEvent<'updateItemStart'> { contentId: string; data: object; - options?: object; } export interface UpdateItemSuccess extends BaseEvent<'updateItemSuccess'> { contentId: string; data: object; - options?: object; } export interface UpdateItemError extends BaseEvent<'updateItemError'> { contentId: string; data: object; error: unknown; - options?: object; } export interface DeleteItemStart extends BaseEvent<'deleteItemStart'> { contentId: string; - options?: object; } export interface DeleteItemSuccess extends BaseEvent<'deleteItemSuccess'> { contentId: string; - options?: object; } export interface DeleteItemError extends BaseEvent<'deleteItemError'> { contentId: string; error: unknown; - options?: object; } export interface SearchItemStart extends BaseEvent<'searchItemStart'> { query: object; - options?: object; } export interface SearchItemSuccess extends BaseEvent<'searchItemSuccess'> { query: object; data: unknown; - options?: object; } export interface SearchItemError extends BaseEvent<'searchItemError'> { query: object; error: unknown; - options?: object; } export type ContentEvent = diff --git a/src/plugins/content_management/server/core/mocks/in_memory_storage.ts b/src/plugins/content_management/server/core/mocks/in_memory_storage.ts index e08261bbc1cb1..fd3a7a125ce45 100644 --- a/src/plugins/content_management/server/core/mocks/in_memory_storage.ts +++ b/src/plugins/content_management/server/core/mocks/in_memory_storage.ts @@ -15,7 +15,7 @@ export interface FooContent { let idx = 0; -class InMemoryStorage implements ContentStorage { +class InMemoryStorage implements ContentStorage { private db: Map = new Map(); async get( @@ -31,11 +31,15 @@ class InMemoryStorage implements ContentStorage { if (forwardInResponse) { // We add this so we can test that options are passed down to the storage layer return { - ...(await this.db.get(id)), - options: forwardInResponse, + item: { + ...(await this.db.get(id)), + options: forwardInResponse, + }, }; } - return this.db.get(id); + return { + item: this.db.get(id), + }; } async bulkGet( @@ -48,16 +52,20 @@ class InMemoryStorage implements ContentStorage { throw new Error(errorToThrow); } - return ids.map((id) => - forwardInResponse ? { ...this.db.get(id), options: forwardInResponse } : this.db.get(id) - ); + return { + hits: ids.map((id) => + forwardInResponse + ? { item: { ...this.db.get(id), options: forwardInResponse } } + : { item: this.db.get(id) } + ), + }; } async create( ctx: StorageContext, data: Omit, { id: _id, errorToThrow }: { id?: string; errorToThrow?: string } = {} - ): Promise { + ) { // This allows us to test that proper error events are thrown when the storage layer op fails if (errorToThrow) { throw new Error(errorToThrow); @@ -73,7 +81,9 @@ class InMemoryStorage implements ContentStorage { this.db.set(id, content); - return content; + return { + item: content, + }; } async update( @@ -102,12 +112,16 @@ class InMemoryStorage implements ContentStorage { if (forwardInResponse) { // We add this so we can test that options are passed down to the storage layer return { - ...updatedContent, - options: forwardInResponse, + item: { + ...updatedContent, + options: forwardInResponse, + }, }; } - return updatedContent; + return { + item: updatedContent, + }; } async delete( @@ -122,7 +136,7 @@ class InMemoryStorage implements ContentStorage { if (!this.db.has(id)) { return { - status: 'error', + success: false, error: `Content do delete not found [${id}].`, }; } @@ -132,34 +146,47 @@ class InMemoryStorage implements ContentStorage { if (forwardInResponse) { // We add this so we can test that options are passed down to the storage layer return { - status: 'success', + success: true, options: forwardInResponse, }; } return { - status: 'success', + success: true, }; } async search( ctx: StorageContext, - query: { title: string }, + query: { text: string }, { errorToThrow }: { errorToThrow?: string } = {} - ): Promise { + ) { // This allows us to test that proper error events are thrown when the storage layer op fails if (errorToThrow) { throw new Error(errorToThrow); } - if (query.title.length < 2) { - return []; + if (query.text.length < 2) { + return { + hits: [], + pagination: { + total: 0, + cursor: '', + }, + }; } - const rgx = new RegExp(query.title); - return [...this.db.values()].filter(({ title }) => { + const rgx = new RegExp(query.text); + const hits = [...this.db.values()].filter(({ title }) => { return title.match(rgx); }); + return { + hits, + pagination: { + total: hits.length, + cursor: '', + }, + }; } } diff --git a/src/plugins/content_management/server/core/msearch.test.ts b/src/plugins/content_management/server/core/msearch.test.ts new file mode 100644 index 0000000000000..1c6597030f554 --- /dev/null +++ b/src/plugins/content_management/server/core/msearch.test.ts @@ -0,0 +1,163 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { EventBus } from './event_bus'; +import { MSearchService } from './msearch'; +import { ContentRegistry } from './registry'; +import { createMockedStorage } from './mocks'; +import { savedObjectsClientMock } from '@kbn/core-saved-objects-api-server-mocks'; +import { StorageContext } from '.'; + +const setup = () => { + const contentRegistry = new ContentRegistry(new EventBus()); + + contentRegistry.register({ + id: `foo`, + storage: { + ...createMockedStorage(), + mSearch: { + savedObjectType: 'foo-type', + toItemResult: (ctx, so) => ({ itemFoo: so }), + additionalSearchFields: ['special-foo-field'], + }, + }, + version: { + latest: 1, + }, + }); + + contentRegistry.register({ + id: `bar`, + storage: { + ...createMockedStorage(), + mSearch: { + savedObjectType: 'bar-type', + toItemResult: (ctx, so) => ({ itemBar: so }), + additionalSearchFields: ['special-bar-field'], + }, + }, + version: { + latest: 1, + }, + }); + + const savedObjectsClient = savedObjectsClientMock.create(); + const mSearchService = new MSearchService({ + getSavedObjectsClient: async () => savedObjectsClient, + contentRegistry, + }); + + return { mSearchService, savedObjectsClient, contentRegistry }; +}; + +const mockStorageContext = (ctx: Partial = {}): StorageContext => { + return { + requestHandlerContext: 'mockRequestHandlerContext' as any, + utils: 'mockUtils' as any, + version: { + latest: 1, + request: 1, + }, + ...ctx, + }; +}; + +test('should cross-content search using saved objects api', async () => { + const { savedObjectsClient, mSearchService } = setup(); + + const soResultFoo = { + id: 'fooid', + score: 0, + type: 'foo-type', + references: [], + attributes: { + title: 'foo', + }, + }; + + const soResultBar = { + id: 'barid', + score: 0, + type: 'bar-type', + references: [], + attributes: { + title: 'bar', + }, + }; + + savedObjectsClient.find.mockResolvedValueOnce({ + saved_objects: [soResultFoo, soResultBar], + total: 2, + page: 1, + per_page: 10, + }); + + const result = await mSearchService.search( + [ + { contentTypeId: 'foo', ctx: mockStorageContext() }, + { contentTypeId: 'bar', ctx: mockStorageContext() }, + ], + { + text: 'search text', + } + ); + + expect(savedObjectsClient.find).toHaveBeenCalledWith({ + defaultSearchOperator: 'AND', + search: 'search text', + searchFields: ['title^3', 'description', 'special-foo-field', 'special-bar-field'], + type: ['foo-type', 'bar-type'], + }); + + expect(result).toEqual({ + hits: [{ itemFoo: soResultFoo }, { itemBar: soResultBar }], + pagination: { + total: 2, + }, + }); +}); + +test('should error if content is not registered', async () => { + const { mSearchService } = setup(); + + await expect( + mSearchService.search( + [ + { contentTypeId: 'foo', ctx: mockStorageContext() }, + { contentTypeId: 'foo-fake', ctx: mockStorageContext() }, + ], + { + text: 'foo', + } + ) + ).rejects.toThrowErrorMatchingInlineSnapshot(`"Content [foo-fake] is not registered."`); +}); + +test('should error if content is registered, but no mSearch support', async () => { + const { mSearchService, contentRegistry } = setup(); + + contentRegistry.register({ + id: `foo2`, + storage: createMockedStorage(), + version: { + latest: 1, + }, + }); + + await expect( + mSearchService.search( + [ + { contentTypeId: 'foo', ctx: mockStorageContext() }, + { contentTypeId: 'foo2', ctx: mockStorageContext() }, + ], + { + text: 'foo', + } + ) + ).rejects.toThrowErrorMatchingInlineSnapshot(`"Content type foo2 does not support mSearch"`); +}); diff --git a/src/plugins/content_management/server/core/msearch.ts b/src/plugins/content_management/server/core/msearch.ts new file mode 100644 index 0000000000000..879a233c289f5 --- /dev/null +++ b/src/plugins/content_management/server/core/msearch.ts @@ -0,0 +1,84 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; +import type { MSearchResult, SearchQuery } from '../../common'; +import { ContentRegistry } from './registry'; +import { StorageContext } from './types'; + +export class MSearchService { + constructor( + private readonly deps: { + getSavedObjectsClient: () => Promise; + contentRegistry: ContentRegistry; + } + ) {} + + async search( + contentTypes: Array<{ contentTypeId: string; ctx: StorageContext }>, + query: SearchQuery + ): Promise { + // Map: contentTypeId -> StorageContext + const contentTypeToCtx = new Map(contentTypes.map((ct) => [ct.contentTypeId, ct.ctx])); + + // Map: contentTypeId -> MSearchConfig + const contentTypeToMSearchConfig = new Map( + contentTypes.map((ct) => { + const mSearchConfig = this.deps.contentRegistry.getDefinition(ct.contentTypeId).storage + .mSearch; + if (!mSearchConfig) { + throw new Error(`Content type ${ct.contentTypeId} does not support mSearch`); + } + return [ct.contentTypeId, mSearchConfig]; + }) + ); + + // Map: Saved object type -> [contentTypeId, MSearchConfig] + const soTypeToMSearchConfig = new Map( + Array.from(contentTypeToMSearchConfig.entries()).map(([ct, mSearchConfig]) => { + return [mSearchConfig.savedObjectType, [ct, mSearchConfig] as const]; + }) + ); + + const mSearchConfigs = Array.from(contentTypeToMSearchConfig.values()); + const soSearchTypes = mSearchConfigs.map((mSearchConfig) => mSearchConfig.savedObjectType); + + const additionalSearchFields = new Set(); + mSearchConfigs.forEach((mSearchConfig) => { + if (mSearchConfig.additionalSearchFields) { + mSearchConfig.additionalSearchFields.forEach((f) => additionalSearchFields.add(f)); + } + }); + + const savedObjectsClient = await this.deps.getSavedObjectsClient(); + const soResult = await savedObjectsClient.find({ + type: soSearchTypes, + search: query.text, + searchFields: [`title^3`, `description`, ...additionalSearchFields], + defaultSearchOperator: 'AND', + // TODO: tags + // TODO: pagination + // TODO: sort + }); + + const contentItemHits = soResult.saved_objects.map((savedObject) => { + const [ct, mSearchConfig] = soTypeToMSearchConfig.get(savedObject.type) ?? []; + if (!ct || !mSearchConfig) + throw new Error(`Saved object type ${savedObject.type} does not support mSearch`); + + return mSearchConfig.toItemResult(contentTypeToCtx.get(ct)!, savedObject); + }); + + return { + hits: contentItemHits, + pagination: { + total: soResult.total, + }, + }; + } +} diff --git a/src/plugins/content_management/server/core/registry.ts b/src/plugins/content_management/server/core/registry.ts index 6537dae320455..7d36fa20fad1a 100644 --- a/src/plugins/content_management/server/core/registry.ts +++ b/src/plugins/content_management/server/core/registry.ts @@ -10,6 +10,7 @@ import { validateVersion } from '@kbn/object-versioning/lib/utils'; import { ContentType } from './content_type'; import { EventBus } from './event_bus'; import type { ContentStorage, ContentTypeDefinition } from './types'; +import type { ContentCrud } from './crud'; export class ContentRegistry { private types = new Map(); @@ -22,7 +23,7 @@ export class ContentRegistry { * @param contentType The content type to register * @param config The content configuration */ - register(definition: ContentTypeDefinition) { + register = ContentStorage>(definition: ContentTypeDefinition) { if (this.types.has(definition.id)) { throw new Error(`Content [${definition.id}] is already registered`); } @@ -58,8 +59,8 @@ export class ContentRegistry { } /** Get the crud instance of a content type */ - getCrud(id: string) { - return this.getContentType(id).crud; + getCrud(id: string) { + return this.getContentType(id).crud as ContentCrud; } /** Helper to validate if a content type has been registered */ diff --git a/src/plugins/content_management/server/core/types.ts b/src/plugins/content_management/server/core/types.ts index 2489c6f3a3def..941281a6b4a6e 100644 --- a/src/plugins/content_management/server/core/types.ts +++ b/src/plugins/content_management/server/core/types.ts @@ -8,6 +8,17 @@ import type { RequestHandlerContext } from '@kbn/core-http-request-handler-context-server'; import type { ContentManagementGetTransformsFn, Version } from '@kbn/object-versioning'; +import type { SavedObjectsFindResult } from '@kbn/core-saved-objects-api-server'; + +import type { + GetResult, + BulkGetResult, + CreateResult, + UpdateResult, + DeleteResult, + SearchQuery, + SearchResult, +} from '../../common'; /** Context that is sent to all storage instance methods */ export interface StorageContext { @@ -21,24 +32,35 @@ export interface StorageContext { }; } -export interface ContentStorage { +export interface ContentStorage { /** Get a single item */ - get(ctx: StorageContext, id: string, options: unknown): Promise; + get(ctx: StorageContext, id: string, options?: object): Promise>; /** Get multiple items */ - bulkGet(ctx: StorageContext, ids: string[], options: unknown): Promise; + bulkGet(ctx: StorageContext, ids: string[], options?: object): Promise>; /** Create an item */ - create(ctx: StorageContext, data: object, options: unknown): Promise; + create(ctx: StorageContext, data: object, options?: object): Promise>; /** Update an item */ - update(ctx: StorageContext, id: string, data: object, options: unknown): Promise; + update( + ctx: StorageContext, + id: string, + data: object, + options?: object + ): Promise>; /** Delete an item */ - delete(ctx: StorageContext, id: string, options: unknown): Promise; + delete(ctx: StorageContext, id: string, options?: object): Promise; /** Search items */ - search(ctx: StorageContext, query: object, options: unknown): Promise; + search(ctx: StorageContext, query: SearchQuery, options?: object): Promise>; + + /** + * Opt-in to multi-type search. + * Can only be supported if the content type is backed by a saved object since `mSearch` is using the `savedObjects.find` API. + **/ + mSearch?: MSearchConfig; } export interface ContentTypeDefinition { @@ -50,3 +72,29 @@ export interface ContentTypeDefinition { + /** + * The saved object type that corresponds to this content type. + */ + savedObjectType: string; + + /** + * Mapper function that transforms the saved object into the content item result. + */ + toItemResult: ( + ctx: StorageContext, + savedObject: SavedObjectsFindResult + ) => T; + + /** + * Additional fields to search on. These fields will be added to the search query. + * By default, only `title` and `description` are searched. + */ + additionalSearchFields?: string[]; +} diff --git a/src/plugins/content_management/server/event_stream/README.md b/src/plugins/content_management/server/event_stream/README.md new file mode 100644 index 0000000000000..95eef47060503 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/README.md @@ -0,0 +1,50 @@ +# Event Stream + + +## The service + +On a high-level the Event Stream is exposed through the `EventStreamService` +class, which is the public interface to the Event Stream, it holds any necessary +state, and follows plugin life-cycle methods. + +The service also validates the events before they are stored. It also buffers +the events on write. Events are buffered for 250ms or up to 100 events before +they are flushed to the storage. + + +## The client + +On a lower level the actual event storage is defined in the `EventStreamClient` +interface. There are two `EventStreamClient` implementations: + +- `EsEventStreamClient` is the production implementation, which stores events + to the Elasticsearch. +- `MemoryEventStreamClient` is used for testing and could be used for demo + purposes. + + +### The `EsEventStreamClient` client + +`EsEventStreamClient` is used in production. It stores events in the +`.kibana-event-stream` data stream. The data stream and index template are +created during plugin initialization "start" life-cycle. + +The mappings define `meta` and `indexed` fields, which are reserved for future +schema extensions (so that new fields can be added without mapping changes). + +The mappings also define a transaction ID (`txID`) field, which can be used to +correlate multiple related events together or to store the transaction ID. + +Events are written to Elasticsearch using the `_bulk` request API. + + +## Testing + +The `MemoryEventStreamClient` can be used to simulate the Event Stream in Jest +unit test environment. Use `setupEventStreamService()` to spin up the service +in the test environment. + +The clients themselves can be tested using the `testEventStreamClient` test +suite, which should help with verifying that both implements work correctly. +The `EsEventStreamClient` it is tested using Kibana integration tests, but for +`MemoryEventStreamClient` it is tested as a Jest tests. diff --git a/src/plugins/content_management/server/event_stream/es/es_event_stream_client.ts b/src/plugins/content_management/server/event_stream/es/es_event_stream_client.ts new file mode 100644 index 0000000000000..749c6b2ad19ef --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/es_event_stream_client.ts @@ -0,0 +1,189 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { estypes } from '@elastic/elasticsearch'; +import { KueryNode, nodeBuilder, toElasticsearchQuery } from '@kbn/es-query'; +import type { EsClient, EsEventStreamEventDto } from './types'; +import type { + EventStreamClient, + EventStreamClientFilterOptions, + EventStreamClientFilterResult, + EventStreamEvent, + EventStreamLogger, +} from '../types'; +import { EsEventStreamNames } from './es_event_stream_names'; +import { EsEventStreamInitializer } from './init/es_event_stream_initializer'; +import { eventToDto, dtoToEvent } from './util'; + +export interface EsEventStreamClientDependencies { + baseName: string; + kibanaVersion: string; + logger: EventStreamLogger; + esClient: Promise; +} + +const sort: estypes.Sort = [ + { + // By default we always sort by event timestamp descending. + '@timestamp': { + order: 'desc', + }, + + // Tie breakers for events with the same timestamp. + subjectId: { + order: 'desc', + }, + objectId: { + order: 'desc', + }, + predicate: { + order: 'desc', + }, + }, +]; + +export class EsEventStreamClient implements EventStreamClient { + readonly #names: EsEventStreamNames; + + constructor(private readonly deps: EsEventStreamClientDependencies) { + this.#names = new EsEventStreamNames(deps.baseName); + } + + public async initialize(): Promise { + const initializer = new EsEventStreamInitializer({ + names: this.#names, + kibanaVersion: this.deps.kibanaVersion, + logger: this.deps.logger, + esClient: this.deps.esClient, + }); + await initializer.initialize(); + } + + public async writeEvents(events: EventStreamEvent[]): Promise { + if (events.length === 0) return; + + const esClient = await this.deps.esClient; + const operations: Array = []; + + for (const event of events) { + const dto = eventToDto(event); + + operations.push({ create: {} }, dto); + } + + const { errors } = await esClient.bulk( + { + index: this.#names.dataStream, + operations, + }, + { + maxRetries: 0, + } + ); + + if (errors) { + throw new Error('Some events failed to be indexed.'); + } + } + + public async tail(limit: number = 100): Promise { + return (await this.filter({ limit })).events; + } + + public async filter( + options: EventStreamClientFilterOptions + ): Promise { + const esClient = await this.deps.esClient; + const topLevelNodes: KueryNode[] = []; + + if (options.subject && options.subject.length) { + topLevelNodes.push( + nodeBuilder.or( + options.subject.map(([type, id]) => + !id + ? nodeBuilder.is('subjectType', type) + : nodeBuilder.and([ + nodeBuilder.is('subjectType', type), + nodeBuilder.is('subjectId', id), + ]) + ) + ) + ); + } + + if (options.object && options.object.length) { + topLevelNodes.push( + nodeBuilder.or( + options.object.map(([type, id]) => + !id + ? nodeBuilder.is('objectType', type) + : nodeBuilder.and([ + nodeBuilder.is('objectType', type), + nodeBuilder.is('objectId', id), + ]) + ) + ) + ); + } + + if (options.predicate && options.predicate.length) { + topLevelNodes.push( + nodeBuilder.or(options.predicate.map((type) => nodeBuilder.is('predicate', type))) + ); + } + + if (options.transaction && options.transaction.length) { + topLevelNodes.push( + nodeBuilder.or(options.transaction.map((id) => nodeBuilder.is('txId', id))) + ); + } + + if (options.from) { + const from = new Date(options.from).toISOString(); + const node = nodeBuilder.range('@timestamp', 'gte', from); + + topLevelNodes.push(node); + } + + if (options.to) { + const to = new Date(options.to).toISOString(); + const node = nodeBuilder.range('@timestamp', 'lte', to); + + topLevelNodes.push(node); + } + + const query = toElasticsearchQuery(nodeBuilder.and(topLevelNodes)); + const size = options.limit ?? 100; + const request: estypes.SearchRequest = { + index: this.#names.dataStream, + query, + sort, + size, + track_total_hits: false, + }; + + if (options.cursor) { + request.search_after = JSON.parse(options.cursor); + } + + const res = await esClient.search(request); + const events = res.hits.hits.map((hit) => dtoToEvent(hit._source!)); + const lastHit = res.hits.hits[res.hits.hits.length - 1]; + + let cursor: string = ''; + + if (events.length >= size && lastHit && lastHit.sort) { + cursor = JSON.stringify(lastHit.sort); + } + + return { + cursor, + events, + }; + } +} diff --git a/src/plugins/content_management/server/event_stream/es/es_event_stream_client_factory.ts b/src/plugins/content_management/server/event_stream/es/es_event_stream_client_factory.ts new file mode 100644 index 0000000000000..d43e1a8eee152 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/es_event_stream_client_factory.ts @@ -0,0 +1,35 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { CoreSetup } from '@kbn/core/server'; +import type { EventStreamClient, EventStreamClientFactory, EventStreamLogger } from '../types'; +import { EsEventStreamClient } from './es_event_stream_client'; + +export interface EsEventStreamClientFactoryDependencies { + /** + * The prefix used for index names. Usually `.kibana`, as Elasticsearch + * treats indices starting with the `.kibana*` prefix as a special indices + * that only Kibana should be allowed to access. + */ + baseName: string; + kibanaVersion: string; + logger: EventStreamLogger; +} + +export class EsEventStreamClientFactory implements EventStreamClientFactory { + constructor(private readonly deps: EsEventStreamClientFactoryDependencies) {} + + public create(core: CoreSetup): EventStreamClient { + const startServices = core.getStartServices(); + + return new EsEventStreamClient({ + ...this.deps, + esClient: startServices.then(([{ elasticsearch }]) => elasticsearch.client.asInternalUser), + }); + } +} diff --git a/src/plugins/content_management/server/event_stream/es/es_event_stream_names.ts b/src/plugins/content_management/server/event_stream/es/es_event_stream_names.ts new file mode 100644 index 0000000000000..1ede04fd21515 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/es_event_stream_names.ts @@ -0,0 +1,24 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export class EsEventStreamNames { + public readonly base: string; + public readonly dataStream: string; + public readonly indexPattern: string; + public readonly indexTemplate: string; + + constructor(baseName: string) { + const EVENT_STREAM_SUFFIX = `-event-stream`; + const dataStream = `${baseName}${EVENT_STREAM_SUFFIX}`; + + this.base = baseName; + this.dataStream = dataStream; + this.indexPattern = `${dataStream}*`; + this.indexTemplate = `${dataStream}-template`; + } +} diff --git a/src/plugins/content_management/server/event_stream/es/index.ts b/src/plugins/content_management/server/event_stream/es/index.ts new file mode 100644 index 0000000000000..6caddfdce93bb --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/index.ts @@ -0,0 +1,16 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { + EsEventStreamClient, + type EsEventStreamClientDependencies, +} from './es_event_stream_client'; +export { + EsEventStreamClientFactory, + type EsEventStreamClientFactoryDependencies, +} from './es_event_stream_client_factory'; diff --git a/src/plugins/content_management/server/event_stream/es/init/es_event_stream_initializer.ts b/src/plugins/content_management/server/event_stream/es/init/es_event_stream_initializer.ts new file mode 100644 index 0000000000000..9cd5d69d07191 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/init/es_event_stream_initializer.ts @@ -0,0 +1,127 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import pRetry from 'p-retry'; +import { errors } from '@elastic/elasticsearch'; +import type { EsClient } from '../types'; +import type { EsEventStreamNames } from '../es_event_stream_names'; +import type { EventStreamLogger } from '../../types'; +import { newIndexTemplateRequest } from './index_template'; + +export interface EsEventStreamInitializerDependencies { + names: EsEventStreamNames; + kibanaVersion: string; + logger: EventStreamLogger; + esClient: Promise; +} + +export class EsEventStreamInitializer { + constructor(private readonly deps: EsEventStreamInitializerDependencies) {} + + public async initialize(): Promise { + const createdIndexTemplate = await this.#retry( + this.createIndexTemplateIfNotExists, + 'createIndexTemplateIfNotExists' + ); + + if (createdIndexTemplate) { + await this.#retry(this.createDataStream, 'createDataStream'); + } + } + + /** + * Calls a function; retries calling it multiple times via p-retry, if it fails. + * Should retry on 2s, 4s, 8s, 16s. + * + * See: https://github.com/tim-kos/node-retry#retryoperationoptions + * + * @param fn Function to retry, if it fails. + */ + readonly #retry = async (fn: () => Promise, fnName: string): Promise => { + this.deps.logger.debug(`Event Stream initialization operation: ${fnName}`); + + return await pRetry(fn, { + minTimeout: 1000, + maxTimeout: 1000 * 60 * 3, + retries: 4, + factor: 2, + randomize: true, + onFailedAttempt: (err) => { + const message = + `Event Stream initialization operation failed and will be retried: ${fnName};` + + `${err.retriesLeft} more times; error: ${err.message}`; + + this.deps.logger.warn(message); + }, + }); + }; + + protected readonly createIndexTemplateIfNotExists = async (): Promise => { + const exists = await this.indexTemplateExists(); + if (exists) return false; + return await this.createIndexTemplate(); + }; + + protected async indexTemplateExists(): Promise { + try { + const esClient = await this.deps.esClient; + const name = this.deps.names.indexTemplate; + const exists = await esClient.indices.existsIndexTemplate({ name }); + + return !!exists; + } catch (err) { + throw new Error(`error checking existence of index template: ${err.message}`); + } + } + + protected async createIndexTemplate(): Promise { + try { + const esClient = await this.deps.esClient; + const { indexTemplate, indexPattern } = this.deps.names; + const request = newIndexTemplateRequest({ + name: indexTemplate, + indexPatterns: [indexPattern], + kibanaVersion: this.deps.kibanaVersion, + }); + + await esClient.indices.putIndexTemplate(request); + + return true; + } catch (err) { + // The error message doesn't have a type attribute we can look to guarantee it's due + // to the template already existing (only long message) so we'll check ourselves to see + // if the template now exists. This scenario would happen if you startup multiple Kibana + // instances at the same time. + const exists = await this.indexTemplateExists(); + + if (exists) return false; + + const error = new Error(`error creating index template: ${err.message}`); + Object.assign(error, { wrapped: err }); + throw error; + } + } + + protected readonly createDataStream = async (): Promise => { + const esClient = await this.deps.esClient; + const name = this.deps.names.dataStream; + + try { + await esClient.indices.createDataStream({ + name, + }); + } catch (error) { + const alreadyExists = + (error as errors.ResponseError)?.body?.error?.type === 'resource_already_exists_exception'; + + if (alreadyExists) return; + + throw error; + } + }; +} diff --git a/src/plugins/content_management/server/event_stream/es/init/index_template.ts b/src/plugins/content_management/server/event_stream/es/init/index_template.ts new file mode 100644 index 0000000000000..40a0535eebd44 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/init/index_template.ts @@ -0,0 +1,54 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { estypes } from '@elastic/elasticsearch'; +import { mappings } from './mappings'; + +export interface NewIndexTemplateRequestParams { + name: string; + indexPatterns: string[]; + kibanaVersion: string; +} + +export const newIndexTemplateRequest = ( + params: NewIndexTemplateRequestParams +): estypes.IndicesPutIndexTemplateRequest => { + const version = 1; + const { name, indexPatterns, kibanaVersion } = params; + + return { + name, + // This will create the template only if it doesn't exist. + create: true, + // This object is required to make it a data stream template. + data_stream: { + hidden: true, + }, + // Our own metadata to keep track of the template. + _meta: { + description: 'This data stream stores events for the Kibana content_management plugin.', + // Template version. + version, + // Kibana version when the template was created. + kibanaVersion, + }, + // Setting this to something higher than the default 0 will allow + // to define lower priority templates in the future. + priority: 50, + version, + index_patterns: indexPatterns, + template: { + settings: { + number_of_shards: 1, + auto_expand_replicas: '0-1', + 'index.hidden': true, + }, + mappings, + }, + }; +}; diff --git a/src/plugins/content_management/server/event_stream/es/init/mappings.ts b/src/plugins/content_management/server/event_stream/es/init/mappings.ts new file mode 100644 index 0000000000000..e63b826e0dc40 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/init/mappings.ts @@ -0,0 +1,88 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { estypes } from '@elastic/elasticsearch'; + +export const mappings: estypes.MappingTypeMapping = { + dynamic: false, + properties: { + /** + * Every document indexed to a data stream must contain a `@timestamp` + * field, mapped as a `date` or `date_nanos` field type. + */ + '@timestamp': { + type: 'date', + }, + + /** Subject is the content item who/which performed the event. */ + subjectType: { + type: 'keyword', + ignore_above: 256, + }, + subjectId: { + type: 'keyword', + ignore_above: 256, + }, + + /** Object is the content item on which the event was performed. */ + objectType: { + type: 'keyword', + ignore_above: 256, + }, + objectId: { + type: 'keyword', + ignore_above: 256, + }, + + /** The event type. */ + predicate: { + type: 'keyword', + ignore_above: 256, + }, + + /** Custom payload, may be be different per event type. */ + payload: { + type: 'object', + enabled: false, + dynamic: false, + }, + + /** + * Transaction ID which allows to trace the event back to the original + * request or to correlate multiple events. For example, one user action + * can result in multiple events, all of which will have the same `txId`. + */ + txId: { + type: 'keyword', + ignore_above: 256, + }, + + /** + * Reserved for future extensions. Event Stream client can add custom + * private fields here in the future if needed, without having to update + * the index template mappings. + */ + meta: { + type: 'object', + enabled: false, + dynamic: false, + }, + + /** + * Reserved for the future extensions, same as the `meta` field, but fields + * added to this object will be indexed. + * + * See dynamic field mapping rules: https://www.elastic.co/guide/en/elasticsearch/reference/current/dynamic-field-mapping.html + */ + indexed: { + type: 'object', + enabled: true, + dynamic: true, + }, + }, +}; diff --git a/src/plugins/content_management/server/event_stream/es/integration_tests/es_event_stream_client.test.ts b/src/plugins/content_management/server/event_stream/es/integration_tests/es_event_stream_client.test.ts new file mode 100644 index 0000000000000..35a16260684e3 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/integration_tests/es_event_stream_client.test.ts @@ -0,0 +1,82 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ElasticsearchClient } from '@kbn/core/server'; +import { + createTestServers, + type TestElasticsearchUtils, + type TestKibanaUtils, +} from '@kbn/core-test-helpers-kbn-server'; +import { EsEventStreamClient } from '../es_event_stream_client'; +import { EsEventStreamNames } from '../es_event_stream_names'; +import { EventStreamLoggerMock } from '../../tests/event_stream_logger_mock'; +import { testEventStreamClient } from '../../tests/test_event_stream_client'; + +describe('EsEventStreamClient', () => { + let manageES: TestElasticsearchUtils; + let manageKbn: TestKibanaUtils; + let esClient: ElasticsearchClient; + let resolveClient: (client: EsEventStreamClient) => void = () => {}; + const client: Promise = new Promise((resolve) => { + resolveClient = resolve; + }); + + const baseName = '.kibana-test'; + const names = new EsEventStreamNames(baseName); + + beforeAll(async () => { + const { startES, startKibana } = createTestServers({ adjustTimeout: jest.setTimeout }); + + manageES = await startES(); + manageKbn = await startKibana(); + esClient = manageKbn.coreStart.elasticsearch.client.asInternalUser; + resolveClient( + new EsEventStreamClient({ + baseName, + esClient: Promise.resolve(esClient), + kibanaVersion: '1.2.3', + logger: new EventStreamLoggerMock(), + }) + ); + }); + + afterAll(async () => { + await manageKbn.root.shutdown(); + await manageKbn.stop(); + await manageES.stop(); + }); + + it('can initialize the Event Stream', async () => { + const exists1 = await esClient.indices.existsIndexTemplate({ + name: names.indexTemplate, + }); + + expect(exists1).toBe(false); + + await (await client).initialize(); + + const exists2 = await esClient.indices.existsIndexTemplate({ + name: names.indexTemplate, + }); + + expect(exists2).toBe(true); + }); + + it('should return "resource_already_exists_exception" error when data stream already exists', async () => { + try { + await esClient.indices.createDataStream({ + name: names.dataStream, + }); + throw new Error('Not expected'); + } catch (error) { + expect(error.body.error.type).toBe('resource_already_exists_exception'); + } + }); + + testEventStreamClient(client); +}); diff --git a/src/plugins/content_management/server/event_stream/es/types.ts b/src/plugins/content_management/server/event_stream/es/types.ts new file mode 100644 index 0000000000000..e370f97c5ba71 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/types.ts @@ -0,0 +1,75 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Client } from '@elastic/elasticsearch'; + +export type EsClient = Omit< + Client, + 'connectionPool' | 'serializer' | 'extend' | 'close' | 'diagnostic' +>; + +/** + * Represents a single event as it is stored in Elasticsearch. + */ +export interface EsEventStreamEventDto { + /** + * Time when the event occurred. + */ + '@timestamp': string; + + /** + * Type of the subject. Subject is the content item who/which performed the + * event. + */ + subjectType?: string; + + /** + * ID of the subject. + */ + subjectId?: string; + + /** + * Type of the object. Object is the content item on which the event was + * performed. + */ + objectType?: string; + + /** + * ID of the object. + */ + objectId?: string; + + /** + * Specifies the event type. Such as `create`, `update`, `delete`, etc. + */ + predicate: string; + + /** + * Custom payload, maybe be different per event type. Provided by the + * event type originator. + */ + payload?: Record; + + /** + * Transaction ID which allows to trace the event back to the original + * request or to correlate multiple events. For example, one user action + * can result in multiple events, all of which will have the same `txId`. + */ + txId?: string; + + /** + * Reserved for future extensions. Custom metadata may be added here by the + * Event Stream implementation. + */ + meta?: Record; + + /** + * Reserved for future extensions. Same as `meta`, but indexed. + */ + indexed?: Record; +} diff --git a/src/plugins/content_management/server/event_stream/es/util.ts b/src/plugins/content_management/server/event_stream/es/util.ts new file mode 100644 index 0000000000000..b447a581bb53f --- /dev/null +++ b/src/plugins/content_management/server/event_stream/es/util.ts @@ -0,0 +1,72 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Mutable } from 'utility-types'; +import type { EventStreamEvent } from '../types'; +import type { EsEventStreamEventDto } from './types'; + +export const eventToDto = (event: EventStreamEvent): EsEventStreamEventDto => { + const { time, subject, predicate, object, transaction } = event; + + const dto: EsEventStreamEventDto = { + '@timestamp': new Date(time).toISOString(), + predicate: predicate[0], + }; + + if (subject) { + dto.subjectType = subject[0]; + dto.subjectId = subject[1]; + } + + if (predicate[1]) { + dto.payload = predicate[1]; + } + + if (object) { + dto.objectType = object[0]; + dto.objectId = object[1]; + } + + if (transaction) { + dto.txId = transaction; + } + + return dto; +}; + +export const dtoToEvent = (dto: EsEventStreamEventDto): EventStreamEvent => { + const { + '@timestamp': timestamp, + subjectType, + subjectId, + predicate, + payload, + objectId, + objectType, + txId, + } = dto; + + const event: Mutable = { + time: new Date(timestamp).getTime(), + predicate: payload ? [predicate, payload] : [predicate], + }; + + if (subjectType && subjectId) { + event.subject = [subjectType, subjectId]; + } + + if (objectType && objectId) { + event.object = [objectType, objectId]; + } + + if (txId) { + event.transaction = txId; + } + + return event; +}; diff --git a/src/plugins/content_management/server/event_stream/event_stream_service.test.ts b/src/plugins/content_management/server/event_stream/event_stream_service.test.ts new file mode 100644 index 0000000000000..59d00c3a69856 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/event_stream_service.test.ts @@ -0,0 +1,333 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { setupEventStreamService } from './tests/setup_event_stream_service'; + +const setup = setupEventStreamService; + +describe('EventStreamService', () => { + describe('.tail()', () => { + test('returns no events by default', async () => { + const { service } = setup(); + + service.flush(); + + const events = await service.tail(); + + expect(events).toStrictEqual([]); + }); + }); + + describe('validation', () => { + describe('event time', () => { + test('cannot be too far in the future', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + time: 4000000000000, + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + + test('cannot be too far in the past', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + time: 1, + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + + test('cannot be a float', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + time: Date.now() + 0.5, + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + + test('cannot be a string', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + time: String(Date.now()) as any, + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + }); + + describe('event subject', () => { + test('type cannot be empty', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + subject: ['', '123'], + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + + test('type cannot be too long', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + subject: [ + '0123456789012345678901234567890123456789012345678901234567890123456789', + '123', + ], + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + + test('ID cannot be too long', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + subject: [ + 'dashboard', + '012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789', + ], + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + + test('cannot be null', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + subject: null as any, + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + }); + + describe('event predicate', () => { + test('type cannot be missing', async () => { + const { service } = setup(); + expect(() => service.addEvents([{} as any])).toThrow(); + }); + + test('type cannot be null', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + predicate: null as any, + }, + ]) + ).toThrow(); + }); + + test('type cannot be a number', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + predicate: [123 as any], + }, + ]) + ).toThrow(); + }); + + test('type cannot be an empty string', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + predicate: [''], + }, + ]) + ).toThrow(); + }); + + test('cannot be a long string', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + predicate: ['0123456789012345678901234567890123456789012345678901234567890123456789'], + }, + ]) + ).toThrow(); + }); + + test('can be a short string', async () => { + const { service } = setup(); + service.addEvents([ + { + predicate: ['view'], + }, + ]); + }); + + test('can have attributes', async () => { + const { service } = setup(); + service.addEvents([ + { + predicate: [ + 'view', + { + foo: 'bar', + }, + ], + }, + ]); + }); + + test('attributes cannot be empty', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + predicate: ['view', {}], + }, + ]) + ).toThrow(); + }); + + test('attributes cannot be null', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + predicate: ['view', null as any], + }, + ]) + ).toThrow(); + }); + }); + + describe('event object', () => { + test('type cannot be empty', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + object: ['', '123'], + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + + test('type cannot be too long', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + object: [ + '0123456789012345678901234567890123456789012345678901234567890123456789', + '123', + ], + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + + test('ID cannot be too long', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + object: [ + 'dashboard', + '012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789', + ], + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + + test('cannot be null', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + object: null as any, + predicate: ['test'], + }, + ]) + ).toThrow(); + }); + }); + + describe('event transaction', () => { + test('can be missing', async () => { + const { service } = setup(); + service.addEvents([ + { + predicate: ['test'], + }, + ]); + }); + + test('cannot be empty', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + predicate: ['test'], + transaction: '', + }, + ]) + ).toThrow(); + }); + + test('cannot be too long', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + predicate: ['test'], + transaction: + '012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789', + }, + ]) + ).toThrow(); + }); + + test('cannot be an integer', async () => { + const { service } = setup(); + expect(() => + service.addEvents([ + { + predicate: ['test'], + transaction: 123 as any, + }, + ]) + ).toThrow(); + }); + }); + }); +}); diff --git a/src/plugins/content_management/server/event_stream/event_stream_service.ts b/src/plugins/content_management/server/event_stream/event_stream_service.ts new file mode 100644 index 0000000000000..d5be158c95bb0 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/event_stream_service.ts @@ -0,0 +1,168 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { CoreSetup } from '@kbn/core/server'; +import { TimedItemBuffer } from '@kbn/bfetch-plugin/common'; +import type { + EventStreamClient, + EventStreamClientFactory, + EventStreamClientFilterOptions, + EventStreamClientFilterResult, + EventStreamEvent, + EventStreamEventPartial, + EventStreamLogger, +} from './types'; +import { partialEventValidator } from './validation'; + +export interface EventStreamInitializerContext { + logger: EventStreamLogger; + clientFactory: EventStreamClientFactory; +} + +export interface EventStreamSetup { + core: CoreSetup; +} + +export class EventStreamService { + protected client?: EventStreamClient; + readonly #buffer: TimedItemBuffer; + + constructor(private readonly ctx: EventStreamInitializerContext) { + this.#buffer = new TimedItemBuffer({ + flushOnMaxItems: 100, + maxItemAge: 250, + onFlush: async (events: EventStreamEvent[]) => { + const { logger } = this.ctx; + + if (!this.client) { + logger.error('EventStreamClient is not initialized, events will not be written.'); + return; + } + + try { + await this.client.writeEvents(events); + } catch (error) { + logger.error('Failed to write events to Event Stream.'); + logger.error(error); + } + }, + }); + } + + /** Called during "setup" plugin life-cycle. */ + public setup({ core }: EventStreamSetup): void { + this.client = this.ctx.clientFactory.create(core); + } + + /** Called during "start" plugin life-cycle. */ + public start(): void { + const { logger } = this.ctx; + + if (!this.client) throw new Error('EventStreamClient not initialized.'); + + logger.debug('Initializing Event Stream.'); + this.client + .initialize() + .then(() => { + logger.debug('Event Stream was initialized.'); + }) + .catch((error) => { + logger.error('Failed to initialize Event Stream. Events will not be indexed.'); + logger.error(error); + }); + } + + /** Called during "stop" plugin life-cycle. */ + public async stop(): Promise { + await this.#buffer.flushAsync(); + } + + #getClient(): EventStreamClient { + if (!this.client) throw new Error('EventStreamClient not initialized.'); + return this.client; + } + + /** + * Validates a single event. Throws an error if the event is invalid. + * + * @param event A partial event to validate. + */ + protected validatePartialEvent(event: EventStreamEventPartial): void { + partialEventValidator(event); + if (partialEventValidator.errors) { + const error = partialEventValidator.errors[0]; + if (!error) throw new Error('Validation failed.'); + throw new Error(`Validation error at [path = ${error.instancePath}]: ${error.message}`); + } + } + + /** + * Queues an event to be written to the Event Stream. The event is appended to + * a buffer and written to the Event Stream periodically. + * + * Events are flushed once the buffer reaches 100 items or 250ms has passed, + * whichever comes first. To force a flush, call `.flush()`. + * + * @param event Event to add to the Event Stream. + */ + public addEvent(event: EventStreamEventPartial): void { + this.validatePartialEvent(event); + + const completeEvent: EventStreamEvent = { + ...event, + time: event.time || Date.now(), + }; + + this.#buffer.write(completeEvent); + } + + /** + * Same as `.addEvent()` but accepts an array of events. + * + * @param events Events to add to the Event Stream. + */ + public addEvents(events: EventStreamEventPartial[]): void { + for (const event of events) { + this.addEvent(event); + } + } + + /** + * Flushes the event buffer, writing all events to the Event Stream. + */ + public flush(): void { + this.#buffer.flush(); + } + + /** + * Read latest events from the Event Stream. + * + * @param limit Number of events to return. Defaults to 100. + * @returns Latest events from the Event Stream. + */ + public async tail(limit: number = 100): Promise { + const client = this.#getClient(); + + return await client.tail(limit); + } + + /** + * Retrieves events from the Event Stream which match the specified filter + * options. + * + * @param options Filtering options. + * @returns Paginated results of events matching the filter. + */ + public async filter( + options: EventStreamClientFilterOptions + ): Promise { + const client = this.#getClient(); + + return await client.filter(options); + } +} diff --git a/src/plugins/content_management/server/event_stream/index.ts b/src/plugins/content_management/server/event_stream/index.ts new file mode 100644 index 0000000000000..479f30fe2eeda --- /dev/null +++ b/src/plugins/content_management/server/event_stream/index.ts @@ -0,0 +1,11 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export * from './types'; +export * from './es'; +export { EventStreamService } from './event_stream_service'; diff --git a/src/plugins/content_management/server/event_stream/memory/index.ts b/src/plugins/content_management/server/event_stream/memory/index.ts new file mode 100644 index 0000000000000..7cef77935e74c --- /dev/null +++ b/src/plugins/content_management/server/event_stream/memory/index.ts @@ -0,0 +1,10 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { MemoryEventStreamClient } from './memory_event_stream_client'; +export { MemoryEventStreamClientFactory } from './memory_event_stream_client_factory'; diff --git a/src/plugins/content_management/server/event_stream/memory/memory_event_stream_client.test.ts b/src/plugins/content_management/server/event_stream/memory/memory_event_stream_client.test.ts new file mode 100644 index 0000000000000..5239139ac7cd9 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/memory/memory_event_stream_client.test.ts @@ -0,0 +1,16 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { MemoryEventStreamClient } from './memory_event_stream_client'; +import { testEventStreamClient } from '../tests/test_event_stream_client'; + +const client = new MemoryEventStreamClient(); + +describe('MemoryEventStreamClient', () => { + testEventStreamClient(Promise.resolve(client)); +}); diff --git a/src/plugins/content_management/server/event_stream/memory/memory_event_stream_client.ts b/src/plugins/content_management/server/event_stream/memory/memory_event_stream_client.ts new file mode 100644 index 0000000000000..ef5ba3352bd4a --- /dev/null +++ b/src/plugins/content_management/server/event_stream/memory/memory_event_stream_client.ts @@ -0,0 +1,123 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { + EventStreamClient, + EventStreamClientFilterOptions, + EventStreamClientFilterResult, + EventStreamEvent, +} from '../types'; +import { clone } from './util'; + +/** + * This is an in-memory implementation of the {@link EventStreamClient} + * interface (it does not persist events to Elasticsearch). It is useful for + * testing and demo purposes. + */ +export class MemoryEventStreamClient implements EventStreamClient { + #events: EventStreamEvent[] = []; + + public async initialize(): Promise {} + + public async writeEvents(events: EventStreamEvent[]): Promise { + for (const event of events) { + this.#events.push(clone(event)); + } + this.#events.sort((a, b) => b.time - a.time); + } + + public async tail(limit: number = 100): Promise { + const tail = this.#events.slice(0, limit); + + return tail.map(clone); + } + + public async filter( + options: EventStreamClientFilterOptions + ): Promise { + let events: EventStreamEvent[] = [...this.#events]; + + const { subject, object, predicate, transaction, from, to } = options; + + if (subject && subject.length) { + events = events.filter((event) => { + if (!event.subject) { + return false; + } + + return subject.some(([type, id]) => { + if (!id) return type === event.subject![0]; + return type === event.subject![0] && id === event.subject![1]; + }); + }); + } + + if (object && object.length) { + events = events.filter((event) => { + if (!event.object) { + return false; + } + + return object.some(([type, id]) => { + if (!id) return type === event.object![0]; + return type === event.object![0] && id === event.object![1]; + }); + }); + } + + if (predicate && predicate.length) { + events = events.filter((event) => { + if (!event.predicate) { + return false; + } + + return predicate.some((type) => { + if (type && type !== event.predicate![0]) { + return false; + } + + return true; + }); + }); + } + + if (transaction && transaction.length) { + events = events.filter((event) => { + return !event.transaction ? false : transaction.some((id) => event.transaction === id); + }); + } + + if (from) { + events = events.filter((event) => event.time >= from); + } + + if (to) { + events = events.filter((event) => event.time <= to); + } + + const size = options.limit ?? 100; + const offset = options.cursor ? JSON.parse(options.cursor) : 0; + + events = events.slice(offset); + + if (events.length > size) { + events = events.slice(0, size); + } + + let cursor: string = ''; + + if (events.length >= size) { + cursor = JSON.stringify(offset + size); + } + + return { + cursor, + events: events.map(clone), + }; + } +} diff --git a/src/plugins/content_management/server/event_stream/memory/memory_event_stream_client_factory.ts b/src/plugins/content_management/server/event_stream/memory/memory_event_stream_client_factory.ts new file mode 100644 index 0000000000000..7cf4ff8f44cf6 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/memory/memory_event_stream_client_factory.ts @@ -0,0 +1,16 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { EventStreamClient, EventStreamClientFactory } from '../types'; +import { MemoryEventStreamClient } from './memory_event_stream_client'; + +export class MemoryEventStreamClientFactory implements EventStreamClientFactory { + public create(): EventStreamClient { + return new MemoryEventStreamClient(); + } +} diff --git a/src/plugins/content_management/server/event_stream/memory/util.ts b/src/plugins/content_management/server/event_stream/memory/util.ts new file mode 100644 index 0000000000000..94fe3bf69b627 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/memory/util.ts @@ -0,0 +1,9 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export const clone = (x: unknown) => JSON.parse(JSON.stringify(x)); diff --git a/src/plugins/content_management/server/event_stream/tests/event_stream_logger_mock.ts b/src/plugins/content_management/server/event_stream/tests/event_stream_logger_mock.ts new file mode 100644 index 0000000000000..2adc4eadb6201 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/tests/event_stream_logger_mock.ts @@ -0,0 +1,16 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { EventStreamLogger } from '../types'; + +export class EventStreamLoggerMock implements EventStreamLogger { + public debug = jest.fn(); + public info = jest.fn(); + public warn = jest.fn(); + public error = jest.fn(); +} diff --git a/src/plugins/content_management/server/event_stream/tests/setup_event_stream_service.ts b/src/plugins/content_management/server/event_stream/tests/setup_event_stream_service.ts new file mode 100644 index 0000000000000..3fcb01224607e --- /dev/null +++ b/src/plugins/content_management/server/event_stream/tests/setup_event_stream_service.ts @@ -0,0 +1,31 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { type CoreSetup } from '@kbn/core/server'; +import { coreMock } from '@kbn/core/server/mocks'; +import { EventStreamService } from '../event_stream_service'; +import { EventStreamLoggerMock } from './event_stream_logger_mock'; +import { MemoryEventStreamClientFactory } from '../memory'; + +export const setupEventStreamService = (kibanaCoreSetup: CoreSetup = coreMock.createSetup()) => { + const logger = new EventStreamLoggerMock(); + const clientFactory = new MemoryEventStreamClientFactory(); + const service = new EventStreamService({ + logger, + clientFactory, + }); + + service.setup({ core: kibanaCoreSetup }); + service.start(); + + return { + logger, + clientFactory, + service, + }; +}; diff --git a/src/plugins/content_management/server/event_stream/tests/test_event_stream_client.ts b/src/plugins/content_management/server/event_stream/tests/test_event_stream_client.ts new file mode 100644 index 0000000000000..d01fe9bdeff4b --- /dev/null +++ b/src/plugins/content_management/server/event_stream/tests/test_event_stream_client.ts @@ -0,0 +1,410 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { until } from './util'; +import { EventStreamClient, EventStreamEvent } from '../types'; + +export const testEventStreamClient = (clientPromise: Promise) => { + let now = Date.now(); + const getTime = () => now++; + const items: EventStreamEvent[] = [ + { + predicate: ['test', { foo: 'bar' }], + time: getTime(), + }, + { + time: getTime(), + subject: ['user', '1'], + predicate: ['create', { foo: 'bar' }], + object: ['dashboard', '1'], + }, + { + time: getTime(), + subject: ['user', '2'], + predicate: ['view'], + object: ['map', 'xyz'], + }, + { + time: getTime(), + subject: ['user', '2'], + predicate: ['view'], + object: ['canvas', 'xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'], + }, + { + time: getTime(), + subject: ['user', '55'], + predicate: [ + 'share', + { + foo: 'bar', + baz: 'qux', + nested: { + value: 123, + }, + }, + ], + object: ['dashboard', '1'], + }, + { + time: getTime(), + subject: ['user', '1'], + predicate: ['view'], + object: ['map', 'xyz'], + }, + { + time: getTime(), + subject: ['user', '2'], + predicate: ['view'], + object: ['canvas', 'yyyy-yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy'], + }, + ]; + + describe('.writeEvents()', () => { + it('can write a single event', async () => { + const client = await clientPromise; + + await client.writeEvents([items[0]]); + + await until(async () => { + const events = await client.tail(); + return events.length === 1; + }, 100); + + const tail = await client.tail(); + + expect(tail).toMatchObject([items[0]]); + }); + + it('can write multiple events', async () => { + const client = await clientPromise; + const events: EventStreamEvent[] = [items[1], items[2], items[3]]; + + await client.writeEvents(events); + + await until(async () => { + const tail = await client.tail(); + return tail.length === 4; + }, 100); + + const tail = await client.tail(); + + expect(tail.slice(0, 3)).toMatchObject([events[2], events[1], events[0]]); + }); + }); + + describe('.tail()', () => { + it('can limit events to last 2', async () => { + const client = await clientPromise; + const events: EventStreamEvent[] = [items[4], items[5], items[6]]; + + await client.writeEvents(events); + + await until(async () => { + const tail = await client.tail(); + return tail.length === 7; + }, 100); + + const tail = await client.tail(2); + + expect(tail.length).toBe(2); + expect(tail).toMatchObject([events[2], events[1]]); + }); + }); + + describe('.filter()', () => { + it('can fetch all events, cursor is empty', async () => { + const result = await (await clientPromise).filter({}); + + // console.log(JSON.stringify(result, null, 2)); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(7); + expect(result.events).toMatchObject(items.slice(0, 7).sort((a, b) => b.time - a.time)); + }); + + it('can paginate through results', async () => { + const client = await clientPromise; + const result1 = await client.filter({ limit: 3, cursor: '' }); + const result2 = await client.filter({ limit: 3, cursor: result1.cursor }); + const result3 = await client.filter({ limit: 3, cursor: result2.cursor }); + + expect(!!result1.cursor).toBe(true); + expect(!!result2.cursor).toBe(true); + expect(!!result3.cursor).toBe(false); + + expect(result1.events.length).toBe(3); + expect(result2.events.length).toBe(3); + expect(result3.events.length).toBe(1); + }); + + it('can select all results but one, and then the last result', async () => { + const client = await clientPromise; + const result1 = await client.filter({ limit: 6, cursor: '' }); + const result2 = await client.filter({ limit: 106, cursor: result1.cursor }); + + expect(!!result1.cursor).toBe(true); + expect(!!result2.cursor).toBe(false); + expect(result1.events.length).toBe(6); + expect(result2.events.length).toBe(1); + expect(result2.events).toMatchObject([items[0]]); + }); + + it('can limit starting time range of results', async () => { + const client = await clientPromise; + const result = await client.filter({ + from: items[2].time, + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(5); + expect(result.events).toMatchObject(items.slice(2, 7).sort((a, b) => b.time - a.time)); + }); + + it('can limit ending time range of results', async () => { + const client = await clientPromise; + const result = await client.filter({ + to: items[2].time, + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(3); + expect(result.events).toMatchObject(items.slice(0, 3).sort((a, b) => b.time - a.time)); + }); + + it('can limit starting and ending time ranges of results', async () => { + const client = await clientPromise; + const result = await client.filter({ + from: items[3].time, + to: items[5].time, + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(3); + expect(result.events).toMatchObject(items.slice(3, 6).sort((a, b) => b.time - a.time)); + }); + + it('can filter results for a single subject', async () => { + const client = await clientPromise; + const result = await client.filter({ + subject: [['user', '55']], + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(1); + expect(result.events[0]).toStrictEqual({ + time: expect.any(Number), + subject: ['user', '55'], + predicate: [ + 'share', + { + foo: 'bar', + baz: 'qux', + nested: { + value: 123, + }, + }, + ], + object: ['dashboard', '1'], + }); + }); + + it('can filter results for multiple subjects', async () => { + const client = await clientPromise; + const result = await client.filter({ + subject: [ + ['user', '55'], + ['user', '1'], + ], + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(3); + expect(result.events).toMatchObject([items[5], items[4], items[1]]); + }); + + it('can filter results for a single object', async () => { + const client = await clientPromise; + const event = items[6]; + const result = await client.filter({ + object: [event.object!], + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(1); + expect(result.events[0]).toStrictEqual(event); + }); + + it('can filter results for a two objects', async () => { + const client = await clientPromise; + const result = await client.filter({ + object: [ + ['dashboard', '1'], + ['map', 'xyz'], + ], + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(4); + }); + + it('can filter results by predicate type', async () => { + const client = await clientPromise; + const result = await client.filter({ + predicate: ['view'], + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(4); + expect(result.events).toMatchObject([items[6], items[5], items[3], items[2]]); + }); + + it('can filter results by multiple predicates', async () => { + const client = await clientPromise; + const result = await client.filter({ + predicate: ['create', 'share'], + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(2); + expect(result.events).toMatchObject([items[4], items[1]]); + }); + + it('can combine multiple filters using AND clause', async () => { + const client = await clientPromise; + const result = await client.filter({ + subject: [['user', '1']], + object: [['dashboard', '1']], + from: items[0].time, + to: items[6].time, + }); + + expect(result.cursor).toBe(''); + expect(result.events.length).toBe(1); + expect(result.events[0]).toMatchObject(items[1]); + }); + }); + + describe('transactions', () => { + it('can associate multiple events with one transaction', async () => { + const client = await clientPromise; + const time = getTime(); + const transaction = 'my-transaction-id'; + const events: EventStreamEvent[] = [ + { + transaction, + time, + subject: ['user', '123'], + predicate: [ + 'tag', + { + use: ['foo', 'bar'], + disuse: ['baz'], + }, + ], + object: ['visualization', '666'], + }, + { + transaction, + time, + subject: ['visualization', '666'], + predicate: ['use'], + object: ['tag', 'foo'], + }, + { + transaction, + time, + subject: ['visualization', '666'], + predicate: ['use'], + object: ['tag', 'bar'], + }, + { + transaction, + time, + subject: ['visualization', '666'], + predicate: ['disuse'], + object: ['tag', 'baz'], + }, + ]; + + await client.writeEvents(events); + + const getEvents = async () => { + return await client.filter({ + transaction: [transaction], + }); + }; + + await until(async () => { + const result = await getEvents(); + return result.events.length === 4; + }, 100); + + const result = await getEvents(); + + expect(result.events.length).toBe(4); + expect( + result.events.some( + (event) => event.object![0] === 'visualization' && event.object![1] === '666' + ) + ).toBe(true); + expect( + result.events.some((event) => event.object![0] === 'tag' && event.object![1] === 'foo') + ).toBe(true); + expect( + result.events.some((event) => event.object![0] === 'tag' && event.object![1] === 'bar') + ).toBe(true); + expect( + result.events.some((event) => event.object![0] === 'tag' && event.object![1] === 'baz') + ).toBe(true); + }); + + it('can filter out two transactions', async () => { + const client = await clientPromise; + const events: EventStreamEvent[] = [ + { + transaction: 'tx-1', + time: getTime(), + subject: ['user', '123'], + predicate: ['do-something'], + object: ['map', '101'], + }, + { + transaction: 'tx-1', + time: getTime(), + subject: ['user', '123'], + predicate: ['do-something'], + object: ['canvas', '202'], + }, + { + transaction: 'tx-2', + time: getTime(), + subject: ['api-key', 'abc'], + predicate: ['do-something-else'], + object: ['map', '101'], + }, + ]; + + await client.writeEvents(events); + + const getEvents = async () => { + return await client.filter({ + transaction: ['tx-1', 'tx-2'], + }); + }; + + await until(async () => { + const result = await getEvents(); + return result.events.length === 3; + }, 100); + + const result = await getEvents(); + + expect(result.events.length).toBe(3); + }); + }); +}; diff --git a/src/plugins/content_management/server/event_stream/tests/util.ts b/src/plugins/content_management/server/event_stream/tests/util.ts new file mode 100644 index 0000000000000..91d7606f7d500 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/tests/util.ts @@ -0,0 +1,16 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export const tick = (ms: number = 1) => new Promise((r) => setTimeout(r, ms)); + +export const until = async (check: () => boolean | Promise, pollInterval: number = 1) => { + do { + if (await check()) return; + await tick(pollInterval); + } while (true); +}; diff --git a/src/plugins/content_management/server/event_stream/types.ts b/src/plugins/content_management/server/event_stream/types.ts new file mode 100644 index 0000000000000..0438fa27bc906 --- /dev/null +++ b/src/plugins/content_management/server/event_stream/types.ts @@ -0,0 +1,181 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { CoreSetup } from '@kbn/core/server'; +import type { Optional } from 'utility-types'; + +/** + * Represents a factory which can be used to create an Event Stream client. + */ +export interface EventStreamClientFactory { + /** + * Creates an Event Stream client. + * + * @param core The CoreSetup object provided by the Kibana platform. + */ + create(core: CoreSetup): EventStreamClient; +} + +/** + * Represents a storage layer for events. + */ +export interface EventStreamClient { + /** + * Initializes the Event Stream client. This method is run at the plugin's + * `setup` phase. It should be used to create any necessary resources. + */ + initialize(): Promise; + + /** + * Immediately writes one or more events to the Event Stream using a bulk + * request. + * + * @param events One or more events to write to the Event Stream. + */ + writeEvents: (events: EventStreamEvent[]) => Promise; + + /** + * Retrieves the most recent events from the Event Stream. + * + * @param limit The maximum number of events to return. If not specified, the + * default is 100. + */ + tail(limit?: number): Promise; + + /** + * Retrieves events from the Event Stream which match the specified filter + * options. + */ + filter: (options: EventStreamClientFilterOptions) => Promise; +} + +/** + * Represents the options which can be used to filter events from the Event + * Stream. Top level properties are joined by `AND` logic. For example, if + * `subject` and `predicate` are specified, only events which match both + * criteria will be returned. + */ +export interface EventStreamClientFilterOptions { + /** + * One or more subjects to filter by. Subjects are joined by `OR` logic. + */ + readonly subject?: Array; + + /** + * One or more predicates to filter by. Predicates are joined by `OR` logic. + */ + readonly predicate?: string[]; + + /** + * One or more objects to filter by. Objects are joined by `OR` logic. + */ + readonly object?: Array; + + /** + * One or more transaction IDs to filter by. Transactions are joined by `OR` + * logic. + */ + readonly transaction?: string[]; + + /** + * The starting time to filter by. Events which occurred after this time will + * be returned. If not specified, the default is the beginning of time. + */ + readonly from?: number; + + /** + * The ending time to filter by. Events which occurred before this time will + * be returned. If not specified, the default is the current time. + */ + readonly to?: number; + + /** + * The maximum number of events to return. If not specified, the default is + * 100. + */ + readonly limit?: number; + + /** + * A cursor which can be used to retrieve the next page of results. On the + * first call, this should be `undefined` or empty string. On subsequent + * calls, this should be the value of the `cursor` property returned by the + * previous call in the {@link EventStreamClientFilterResult} object. + */ + readonly cursor?: string; +} + +/** + * Represents the result of a `.filter()` operation. + */ +export interface EventStreamClientFilterResult { + /** + * A cursor which can be used to retrieve the next page of results. Should be + * treated as a opaque value. When empty, there are no more results. + */ + readonly cursor: string; + + /** + * The list of events which matched the filter. Sorted by time in descending + * order. + */ + readonly events: EventStreamEvent[]; +} + +/** + * Represents a single event in the Event Stream. Events can be thought of as + * "Semantic triples" (see https://en.wikipedia.org/wiki/Semantic_triple). + * Semantic triples have a subject, a predicate, and an object. In the context + * of the Event Stream, the subject is the content item who/which performed the + * event, the predicate is the event type (such as `create`, `update`, `delete`, + * etc.), and the object is the content item on which the action was performed. + */ +export interface EventStreamEvent { + /** + * Specifies who performed the event. The subject is a tuple of the type of + * the subject and the ID of the subject. + */ + readonly subject?: readonly [type: string, id: string]; + + /** + * Specifies the event type. Such as `create`, `update`, `delete`, etc. + * The predicate is a tuple of the type of the predicate and any attributes + * associated with the predicate. + */ + readonly predicate: readonly [type: string, attributes?: Record]; + + /** + * Specifies the content item on which the event was performed. The object is + * a tuple of the type of the object and the ID of the object. + */ + readonly object?: readonly [type: string, id: string]; + + /** + * Timestamp in milliseconds since the Unix Epoch when the event occurred. + */ + readonly time: number; + + /** + * Transaction ID, which allows to trace the event back to the original + * request. As well as to associate multiple events together. + */ + readonly transaction?: string; +} + +/** + * Represents a partial version of an EventStreamEvent, as it can be provided + * for ingestion. The `time` property is optional, as it will be set by the + * Event Stream if not provided. + */ +export type EventStreamEventPartial = Optional; + +import type { Logger } from '@kbn/core/server'; + +/** + * Logger interface used in the Event Stream. + */ +export type EventStreamLogger = Pick; diff --git a/src/plugins/content_management/server/event_stream/validation.ts b/src/plugins/content_management/server/event_stream/validation.ts new file mode 100644 index 0000000000000..19bc43061042d --- /dev/null +++ b/src/plugins/content_management/server/event_stream/validation.ts @@ -0,0 +1,96 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import Ajv from 'ajv/dist/2020'; + +const ajv = new Ajv({ + allErrors: false, + strict: false, + verbose: false, +}); + +const partialEventSchema = { + type: 'object', + required: ['predicate'], + additionalProperties: false, + properties: { + subject: { + type: 'array', + nullable: false, + minItems: 2, + maxItems: 2, + items: false, + prefixItems: [ + { + type: 'string', + minLength: 1, + maxLength: 64, + }, + { + type: 'string', + maxLength: 255, + }, + ], + }, + predicate: { + type: 'array', + minItems: 1, + maxItems: 2, + items: false, + nullable: false, + prefixItems: [ + { + type: 'string', + minLength: 1, + maxLength: 64, + }, + { + type: 'object', + additionalProperties: true, + minProperties: 1, + maxProperties: 255, + }, + ], + }, + object: { + type: 'array', + nullable: false, + minItems: 2, + maxItems: 2, + items: false, + prefixItems: [ + { + type: 'string', + minLength: 1, + maxLength: 64, + }, + { + type: 'string', + maxLength: 255, + }, + ], + }, + time: { + type: 'number', + nullable: false, + multipleOf: 1, + // Just some sane limits so the number doesn't escape too far into the + // future or past. + minimum: 1600000000000, // Sep 2020 + maximum: 2600000000000, // May 2052 + }, + transaction: { + type: 'string', + nullable: false, + minLength: 1, + maxLength: 255, + }, + }, +}; + +export const partialEventValidator = ajv.compile(partialEventSchema); diff --git a/src/plugins/content_management/server/plugin.test.ts b/src/plugins/content_management/server/plugin.test.ts index f67652da6d938..85e9459fa1909 100644 --- a/src/plugins/content_management/server/plugin.test.ts +++ b/src/plugins/content_management/server/plugin.test.ts @@ -6,11 +6,12 @@ * Side Public License, v 1. */ -import { loggingSystemMock, coreMock } from '@kbn/core/server/mocks'; +import { coreMock } from '@kbn/core/server/mocks'; import { ContentManagementPlugin } from './plugin'; import { IRouter } from '@kbn/core/server'; import type { ProcedureName } from '../common'; import { procedureNames } from '../common/rpc'; +import { MSearchService } from './core/msearch'; jest.mock('./core', () => ({ ...jest.requireActual('./core'), @@ -36,6 +37,7 @@ const mockCreate = jest.fn().mockResolvedValue('createMocked'); const mockUpdate = jest.fn().mockResolvedValue('updateMocked'); const mockDelete = jest.fn().mockResolvedValue('deleteMocked'); const mockSearch = jest.fn().mockResolvedValue('searchMocked'); +const mockMSearch = jest.fn().mockResolvedValue('mSearchMocked'); jest.mock('./rpc/procedures/all_procedures', () => { const mockedProcedure = (spyGetter: () => jest.Mock) => ({ @@ -54,6 +56,7 @@ jest.mock('./rpc/procedures/all_procedures', () => { update: mockedProcedure(() => mockUpdate), delete: mockedProcedure(() => mockDelete), search: mockedProcedure(() => mockSearch), + mSearch: mockedProcedure(() => mockMSearch), }; return { @@ -62,22 +65,29 @@ jest.mock('./rpc/procedures/all_procedures', () => { }); const setup = () => { - const logger = loggingSystemMock.create(); - const { http } = coreMock.createSetup(); + const coreSetup = coreMock.createSetup(); + const router: IRouter = coreSetup.http.createRouter(); + const http = { ...coreSetup.http, createRouter: () => router }; + const plugin = new ContentManagementPlugin(coreMock.createPluginInitializerContext()); - const router: IRouter = http.createRouter(); router.post = jest.fn(); - const plugin = new ContentManagementPlugin({ logger }); - - return { plugin, http: { createRouter: () => router }, router }; + return { + plugin, + http, + router, + coreSetup: { + ...coreSetup, + http, + }, + }; }; describe('ContentManagementPlugin', () => { describe('setup()', () => { test('should expose the core API', () => { - const { plugin, http } = setup(); - const api = plugin.setup({ http }); + const { plugin, coreSetup } = setup(); + const api = plugin.setup(coreSetup); expect(Object.keys(api).sort()).toEqual(['crud', 'eventBus', 'register']); expect(api.crud('')).toBe('mockedCrud'); @@ -87,8 +97,8 @@ describe('ContentManagementPlugin', () => { describe('RPC', () => { test('should create a single POST HTTP route on the router', () => { - const { plugin, http, router } = setup(); - plugin.setup({ http }); + const { plugin, coreSetup, router } = setup(); + plugin.setup(coreSetup); expect(router.post).toBeCalledTimes(1); const [routeConfig]: Parameters = (router.post as jest.Mock).mock.calls[0]; @@ -97,8 +107,8 @@ describe('ContentManagementPlugin', () => { }); test('should register all the procedures in the RPC service and the route handler must send to each procedure the core request context + the request body as input', async () => { - const { plugin, http, router } = setup(); - plugin.setup({ http }); + const { plugin, coreSetup, router } = setup(); + plugin.setup(coreSetup); const [_, handler]: Parameters = (router.post as jest.Mock).mock.calls[0]; @@ -130,17 +140,19 @@ describe('ContentManagementPlugin', () => { requestHandlerContext: mockedRequestHandlerContext, contentRegistry: 'mockedContentRegistry', getTransformsFactory: expect.any(Function), + mSearchService: expect.any(MSearchService), }; expect(mockGet).toHaveBeenCalledWith(context, input); expect(mockCreate).toHaveBeenCalledWith(context, input); expect(mockUpdate).toHaveBeenCalledWith(context, input); expect(mockDelete).toHaveBeenCalledWith(context, input); expect(mockSearch).toHaveBeenCalledWith(context, input); + expect(mockMSearch).toHaveBeenCalledWith(context, input); }); test('should return error in custom error format', async () => { - const { plugin, http, router } = setup(); - plugin.setup({ http }); + const { plugin, coreSetup, router } = setup(); + plugin.setup(coreSetup); const [_, handler]: Parameters = (router.post as jest.Mock).mock.calls[0]; diff --git a/src/plugins/content_management/server/plugin.ts b/src/plugins/content_management/server/plugin.ts index 56685c0564973..e70bb5da14a65 100755 --- a/src/plugins/content_management/server/plugin.ts +++ b/src/plugins/content_management/server/plugin.ts @@ -21,22 +21,37 @@ import { ContentManagementServerStart, SetupDependencies, } from './types'; +import { EventStreamService, EsEventStreamClientFactory } from './event_stream'; import { procedureNames } from '../common/rpc'; -type CreateRouterFn = CoreSetup['http']['createRouter']; - export class ContentManagementPlugin implements Plugin { private readonly logger: Logger; private readonly core: Core; + readonly #eventStream: EventStreamService; + + constructor(initializerContext: PluginInitializerContext) { + const kibanaVersion = initializerContext.env.packageInfo.version; - constructor(initializerContext: { logger: PluginInitializerContext['logger'] }) { this.logger = initializerContext.logger.get(); - this.core = new Core({ logger: this.logger }); + this.#eventStream = new EventStreamService({ + logger: this.logger, + clientFactory: new EsEventStreamClientFactory({ + baseName: '.kibana', + kibanaVersion, + logger: this.logger, + }), + }); + this.core = new Core({ + logger: this.logger, + eventStream: this.#eventStream, + }); } - public setup(core: { http: { createRouter: CreateRouterFn } }) { + public setup(core: CoreSetup) { + this.#eventStream.setup({ core }); + const { api: coreApi, contentRegistry } = this.core.setup(); const rpc = new RpcService(); @@ -54,6 +69,16 @@ export class ContentManagementPlugin } public start(core: CoreStart) { + this.#eventStream.start(); + return {}; } + + public async stop(): Promise { + try { + await this.#eventStream.stop(); + } catch (e) { + this.logger.error(`Error during event stream stop: ${e}`); + } + } } diff --git a/src/plugins/content_management/server/rpc/procedures/all_procedures.ts b/src/plugins/content_management/server/rpc/procedures/all_procedures.ts index 6b177debf11df..e0f065ce429d4 100644 --- a/src/plugins/content_management/server/rpc/procedures/all_procedures.ts +++ b/src/plugins/content_management/server/rpc/procedures/all_procedures.ts @@ -14,6 +14,7 @@ import { create } from './create'; import { update } from './update'; import { deleteProc } from './delete'; import { search } from './search'; +import { mSearch } from './msearch'; export const procedures: { [key in ProcedureName]: ProcedureDefinition } = { get, @@ -22,4 +23,5 @@ export const procedures: { [key in ProcedureName]: ProcedureDefinition bulkGet()', () => { test('should validate that the response is an object or an array of object', () => { let error = validate( { - any: 'object', + hits: [ + { + contentTypeId: '123', + result: { + item: { + any: 'object', + }, + meta: { + foo: 'bar', + }, + }, + }, + ], + meta: { + foo: 'bar', + }, }, outputSchema ); @@ -129,22 +144,20 @@ describe('RPC -> bulkGet()', () => { expect(error).toBe(null); error = validate( - [ - { - any: 'object', - }, - ], + { + hits: [ + { + contentTypeId: '123', + result: 123, + }, + ], + }, outputSchema ); - expect(error).toBe(null); - - error = validate(123, outputSchema); - expect(error?.message).toContain( - 'expected a plain object value, but found [number] instead.' + '[hits.0.result]: expected a plain object value, but found [number] instead.' ); - expect(error?.message).toContain('expected value of type [array] but got [number]'); }); }); @@ -173,7 +186,16 @@ describe('RPC -> bulkGet()', () => { test('should return the storage bulkGet() result', async () => { const { ctx, storage } = setup(); - const expected = ['Item1', 'Item2']; + const expected = { + hits: [ + { + item: 'Item1', + }, + { + item: 'Item2', + }, + ], + }; storage.bulkGet.mockResolvedValueOnce(expected); const result = await fn(ctx, { diff --git a/src/plugins/content_management/server/rpc/procedures/bulk_get.ts b/src/plugins/content_management/server/rpc/procedures/bulk_get.ts index 716a3baca90d5..ab43e956a9460 100644 --- a/src/plugins/content_management/server/rpc/procedures/bulk_get.ts +++ b/src/plugins/content_management/server/rpc/procedures/bulk_get.ts @@ -8,7 +8,7 @@ import { rpcSchemas } from '../../../common/schemas'; import type { BulkGetIn } from '../../../common'; -import type { StorageContext, ContentCrud } from '../../core'; +import type { StorageContext } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; import { BulkGetResponse } from '../../core/crud'; @@ -21,7 +21,7 @@ export const bulkGet: ProcedureDefinition, BulkGetRes const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD - const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); + const crudInstance = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, version: { diff --git a/src/plugins/content_management/server/rpc/procedures/create.test.ts b/src/plugins/content_management/server/rpc/procedures/create.test.ts index 6e92501b70c25..7d216fd0383e0 100644 --- a/src/plugins/content_management/server/rpc/procedures/create.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/create.test.ts @@ -108,16 +108,29 @@ describe('RPC -> create()', () => { test('should validate that the response is an object', () => { let error = validate( { - any: 'object', + contentTypeId: 'foo', + result: { + item: { + any: 'object', + }, + }, }, outputSchema ); expect(error).toBe(null); - error = validate(123, outputSchema); + error = validate( + { + contentTypeId: 'foo', + result: 123, + }, + outputSchema + ); - expect(error?.message).toBe('expected a plain object value, but found [number] instead.'); + expect(error?.message).toBe( + '[result]: expected a plain object value, but found [number] instead.' + ); }); }); @@ -146,7 +159,9 @@ describe('RPC -> create()', () => { test('should return the storage create() result', async () => { const { ctx, storage } = setup(); - const expected = 'CreateResult'; + const expected = { + item: 'CreateResult', + }; storage.create.mockResolvedValueOnce(expected); const result = await fn(ctx, { diff --git a/src/plugins/content_management/server/rpc/procedures/create.ts b/src/plugins/content_management/server/rpc/procedures/create.ts index e56b60477ae5a..eca10cfa59bb1 100644 --- a/src/plugins/content_management/server/rpc/procedures/create.ts +++ b/src/plugins/content_management/server/rpc/procedures/create.ts @@ -8,7 +8,7 @@ import { rpcSchemas } from '../../../common/schemas'; import type { CreateIn } from '../../../common'; -import type { StorageContext, ContentCrud } from '../../core'; +import type { StorageContext } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; import { validateRequestVersion } from './utils'; @@ -20,7 +20,7 @@ export const create: ProcedureDefinition> = { const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD - const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); + const crudInstance = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, version: { diff --git a/src/plugins/content_management/server/rpc/procedures/delete.test.ts b/src/plugins/content_management/server/rpc/procedures/delete.test.ts index 0d227be530453..bdf7dbe7b83ae 100644 --- a/src/plugins/content_management/server/rpc/procedures/delete.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/delete.test.ts @@ -104,7 +104,10 @@ describe('RPC -> delete()', () => { test('should validate that the response is an object', () => { let error = validate( { - any: 'object', + contentTypeId: 'foo', + result: { + success: true, + }, }, outputSchema ); @@ -142,7 +145,7 @@ describe('RPC -> delete()', () => { test('should return the storage delete() result', async () => { const { ctx, storage } = setup(); - const expected = 'DeleteResult'; + const expected = { success: true }; storage.delete.mockResolvedValueOnce(expected); const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, version: 1, id: '1234' }); diff --git a/src/plugins/content_management/server/rpc/procedures/delete.ts b/src/plugins/content_management/server/rpc/procedures/delete.ts index f01b85b51deec..d7cceaebd1556 100644 --- a/src/plugins/content_management/server/rpc/procedures/delete.ts +++ b/src/plugins/content_management/server/rpc/procedures/delete.ts @@ -7,7 +7,7 @@ */ import { rpcSchemas } from '../../../common/schemas'; import type { DeleteIn } from '../../../common'; -import type { StorageContext, ContentCrud } from '../../core'; +import type { StorageContext } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; import { validateRequestVersion } from './utils'; @@ -19,7 +19,7 @@ export const deleteProc: ProcedureDefinition> = { const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD - const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); + const crudInstance = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, version: { diff --git a/src/plugins/content_management/server/rpc/procedures/get.test.ts b/src/plugins/content_management/server/rpc/procedures/get.test.ts index e6934fb7123a0..b826e238ea26e 100644 --- a/src/plugins/content_management/server/rpc/procedures/get.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/get.test.ts @@ -104,16 +104,26 @@ describe('RPC -> get()', () => { test('should validate that the response is an object', () => { let error = validate( { - any: 'object', + contentTypeId: 'foo', + result: { + item: { + any: 'object', + }, + meta: { + foo: 'bar', + }, + }, }, outputSchema ); expect(error).toBe(null); - error = validate(123, outputSchema); + error = validate({ contentTypeId: '123', result: 123 }, outputSchema); - expect(error?.message).toBe('expected a plain object value, but found [number] instead.'); + expect(error?.message).toBe( + '[result]: expected a plain object value, but found [number] instead.' + ); }); }); @@ -142,7 +152,9 @@ describe('RPC -> get()', () => { test('should return the storage get() result', async () => { const { ctx, storage } = setup(); - const expected = 'GetResult'; + const expected = { + item: 'GetResult', + }; storage.get.mockResolvedValueOnce(expected); const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, id: '1234', version: 1 }); diff --git a/src/plugins/content_management/server/rpc/procedures/get.ts b/src/plugins/content_management/server/rpc/procedures/get.ts index 00ac0bf59a627..4d02aca5e5a6f 100644 --- a/src/plugins/content_management/server/rpc/procedures/get.ts +++ b/src/plugins/content_management/server/rpc/procedures/get.ts @@ -8,7 +8,7 @@ import { rpcSchemas } from '../../../common/schemas'; import type { GetIn } from '../../../common'; -import type { ContentCrud, StorageContext } from '../../core'; +import type { StorageContext } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; import { validateRequestVersion } from './utils'; @@ -20,7 +20,7 @@ export const get: ProcedureDefinition> = { const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD - const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); + const crudInstance = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, version: { diff --git a/src/plugins/content_management/server/rpc/procedures/msearch.test.ts b/src/plugins/content_management/server/rpc/procedures/msearch.test.ts new file mode 100644 index 0000000000000..95198376d4599 --- /dev/null +++ b/src/plugins/content_management/server/rpc/procedures/msearch.test.ts @@ -0,0 +1,218 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { validate } from '../../utils'; +import { ContentRegistry } from '../../core/registry'; +import { createMockedStorage } from '../../core/mocks'; +import { EventBus } from '../../core/event_bus'; +import { MSearchIn, MSearchQuery } from '../../../common'; +import { mSearch } from './msearch'; +import { getServiceObjectTransformFactory } from '../services_transforms_factory'; +import { MSearchService } from '../../core/msearch'; +import { savedObjectsClientMock } from '@kbn/core-saved-objects-api-server-mocks'; + +const { fn, schemas } = mSearch; + +const inputSchema = schemas?.in; +const outputSchema = schemas?.out; + +if (!inputSchema) { + throw new Error(`Input schema missing for [mSearch] procedure.`); +} + +if (!outputSchema) { + throw new Error(`Output schema missing for [mSearch] procedure.`); +} + +describe('RPC -> mSearch()', () => { + describe('Input/Output validation', () => { + const query: MSearchQuery = { text: 'hello' }; + const validInput: MSearchIn = { + contentTypes: [ + { contentTypeId: 'foo', version: 1 }, + { contentTypeId: 'bar', version: 2 }, + ], + query, + }; + + test('should validate contentTypes and query', () => { + [ + { input: validInput }, + { + input: { query }, // contentTypes missing + expectedError: '[contentTypes]: expected value of type [array] but got [undefined]', + }, + { + input: { ...validInput, contentTypes: [] }, // contentTypes is empty + expectedError: '[contentTypes]: array size is [0], but cannot be smaller than [1]', + }, + { + input: { ...validInput, contentTypes: [{ contentTypeId: 'foo' }] }, // contentTypes has no version + expectedError: + '[contentTypes.0.version]: expected value of type [number] but got [undefined]', + }, + { + input: { ...validInput, query: 123 }, // query is not an object + expectedError: '[query]: expected a plain object value, but found [number] instead.', + }, + { + input: { ...validInput, unknown: 'foo' }, + expectedError: '[unknown]: definition for this key is missing', + }, + ].forEach(({ input, expectedError }) => { + const error = validate(input, inputSchema); + if (!expectedError) { + try { + expect(error).toBe(null); + } catch (e) { + throw new Error(`Expected no error but got [{${error?.message}}].`); + } + } else { + expect(error?.message).toBe(expectedError); + } + }); + }); + + test('should validate the response format with "hits" and "pagination"', () => { + let error = validate( + { + contentTypes: validInput.contentTypes, + result: { + hits: [], + pagination: { + total: 0, + cursor: '', + }, + }, + }, + outputSchema + ); + + expect(error).toBe(null); + + error = validate(123, outputSchema); + + expect(error?.message).toContain( + 'expected a plain object value, but found [number] instead.' + ); + }); + }); + + describe('procedure', () => { + const setup = () => { + const contentRegistry = new ContentRegistry(new EventBus()); + const storage = createMockedStorage(); + storage.mSearch = { + savedObjectType: 'foo-type', + toItemResult: (ctx, so) => ({ item: so }), + }; + contentRegistry.register({ + id: `foo`, + storage, + version: { + latest: 2, + }, + }); + + const savedObjectsClient = savedObjectsClientMock.create(); + const mSearchService = new MSearchService({ + getSavedObjectsClient: async () => savedObjectsClient, + contentRegistry, + }); + + const mSearchSpy = jest.spyOn(mSearchService, 'search'); + + const requestHandlerContext = 'mockedRequestHandlerContext'; + const ctx: any = { + contentRegistry, + requestHandlerContext, + getTransformsFactory: getServiceObjectTransformFactory, + mSearchService, + }; + + return { ctx, storage, savedObjectsClient, mSearchSpy }; + }; + + test('should return so find result mapped through toItemResult', async () => { + const { ctx, savedObjectsClient, mSearchSpy } = setup(); + + const soResult = { + id: 'fooid', + score: 0, + type: 'foo-type', + references: [], + attributes: { + title: 'foo', + }, + }; + + savedObjectsClient.find.mockResolvedValueOnce({ + saved_objects: [soResult], + total: 1, + page: 1, + per_page: 10, + }); + + const result = await fn(ctx, { + contentTypes: [{ contentTypeId: 'foo', version: 1 }], + query: { text: 'Hello' }, + }); + + expect(result).toEqual({ + contentTypes: [{ contentTypeId: 'foo', version: 1 }], + result: { + hits: [{ item: soResult }], + pagination: { + total: 1, + }, + }, + }); + + expect(mSearchSpy).toHaveBeenCalledWith( + [ + { + contentTypeId: 'foo', + ctx: { + requestHandlerContext: ctx.requestHandlerContext, + version: { + request: 1, + latest: 2, // from the registry + }, + utils: { + getTransforms: expect.any(Function), + }, + }, + }, + ], + { text: 'Hello' } + ); + }); + + describe('validation', () => { + test('should validate that content type definition exist', () => { + const { ctx } = setup(); + expect(() => + fn(ctx, { + contentTypes: [{ contentTypeId: 'unknown', version: 1 }], + query: { text: 'Hello' }, + }) + ).rejects.toEqual(new Error('Content [unknown] is not registered.')); + }); + + test('should throw if the request version is higher than the registered version', () => { + const { ctx } = setup(); + expect(() => + fn(ctx, { + contentTypes: [{ contentTypeId: 'foo', version: 7 }], + query: { text: 'Hello' }, + }) + ).rejects.toEqual(new Error('Invalid version. Latest version is [2].')); + }); + }); + }); +}); diff --git a/src/plugins/content_management/server/rpc/procedures/msearch.ts b/src/plugins/content_management/server/rpc/procedures/msearch.ts new file mode 100644 index 0000000000000..754dd378291d8 --- /dev/null +++ b/src/plugins/content_management/server/rpc/procedures/msearch.ts @@ -0,0 +1,48 @@ +/* + * 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 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { rpcSchemas } from '../../../common/schemas'; +import type { MSearchIn, MSearchOut } from '../../../common'; +import type { StorageContext } from '../../core'; +import type { ProcedureDefinition } from '../rpc_service'; +import type { Context } from '../types'; +import { validateRequestVersion } from './utils'; + +export const mSearch: ProcedureDefinition = { + schemas: rpcSchemas.mSearch, + fn: async (ctx, { contentTypes: contentTypes, query }) => { + const contentTypesWithStorageContext = contentTypes.map( + ({ contentTypeId, version: _version }) => { + const contentDefinition = ctx.contentRegistry.getDefinition(contentTypeId); + const version = validateRequestVersion(_version, contentDefinition.version.latest); + const storageContext: StorageContext = { + requestHandlerContext: ctx.requestHandlerContext, + version: { + request: version, + latest: contentDefinition.version.latest, + }, + utils: { + getTransforms: ctx.getTransformsFactory(contentTypeId), + }, + }; + + return { + contentTypeId, + ctx: storageContext, + }; + } + ); + + const result = await ctx.mSearchService.search(contentTypesWithStorageContext, query); + + return { + contentTypes, + result, + }; + }, +}; diff --git a/src/plugins/content_management/server/rpc/procedures/search.test.ts b/src/plugins/content_management/server/rpc/procedures/search.test.ts index c96a9f304aa55..bd3a4ffd9fe06 100644 --- a/src/plugins/content_management/server/rpc/procedures/search.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/search.test.ts @@ -34,7 +34,7 @@ const FOO_CONTENT_ID = 'foo'; describe('RPC -> search()', () => { describe('Input/Output validation', () => { - const query = { title: 'hello' }; + const query = { text: 'hello' }; const validInput = { contentTypeId: 'foo', version: 1, query }; test('should validate that a contentTypeId and "query" object is passed', () => { @@ -57,11 +57,11 @@ describe('RPC -> search()', () => { }, { input: omit(validInput, 'query'), - expectedError: '[query]: expected value of type [object] but got [undefined]', + expectedError: '[query]: expected at least one defined value but got [undefined]', }, { input: { ...validInput, query: 123 }, // query is not an object - expectedError: '[query]: expected value of type [object] but got [number]', + expectedError: '[query]: expected a plain object value, but found [number] instead.', }, { input: { ...validInput, unknown: 'foo' }, @@ -69,7 +69,6 @@ describe('RPC -> search()', () => { }, ].forEach(({ input, expectedError }) => { const error = validate(input, inputSchema); - if (!expectedError) { try { expect(error).toBe(null); @@ -86,7 +85,7 @@ describe('RPC -> search()', () => { let error = validate( { contentTypeId: 'foo', - query: { title: 'hello' }, + query: { text: 'hello' }, version: 1, options: { any: 'object' }, }, @@ -99,7 +98,7 @@ describe('RPC -> search()', () => { { contentTypeId: 'foo', version: 1, - query: { title: 'hello' }, + query: { text: 'hello' }, options: 123, // Not an object }, inputSchema @@ -110,22 +109,21 @@ describe('RPC -> search()', () => { ); }); - test('should validate that the response is an object or an array of object', () => { + test('should validate the response format with "hits" and "pagination"', () => { let error = validate( { - any: 'object', - }, - outputSchema - ); - - expect(error).toBe(null); - - error = validate( - [ - { - any: 'object', + contentTypeId: 'foo', + result: { + hits: [], + pagination: { + total: 0, + cursor: '', + }, + }, + meta: { + foo: 'bar', }, - ], + }, outputSchema ); @@ -136,7 +134,6 @@ describe('RPC -> search()', () => { expect(error?.message).toContain( 'expected a plain object value, but found [number] instead.' ); - expect(error?.message).toContain('expected value of type [array] but got [number]'); }); }); @@ -165,13 +162,19 @@ describe('RPC -> search()', () => { test('should return the storage search() result', async () => { const { ctx, storage } = setup(); - const expected = 'SearchResult'; + const expected = { + hits: ['SearchResult'], + pagination: { + total: 1, + cursor: '', + }, + }; storage.search.mockResolvedValueOnce(expected); const result = await fn(ctx, { contentTypeId: FOO_CONTENT_ID, version: 1, // version in request - query: { title: 'Hello' }, + query: { text: 'Hello' }, }); expect(result).toEqual({ @@ -190,7 +193,7 @@ describe('RPC -> search()', () => { getTransforms: expect.any(Function), }, }, - { title: 'Hello' }, + { text: 'Hello' }, undefined ); }); @@ -199,7 +202,7 @@ describe('RPC -> search()', () => { test('should validate that content type definition exist', () => { const { ctx } = setup(); expect(() => - fn(ctx, { contentTypeId: 'unknown', query: { title: 'Hello' } }) + fn(ctx, { contentTypeId: 'unknown', query: { text: 'Hello' } }) ).rejects.toEqual(new Error('Content [unknown] is not registered.')); }); @@ -208,7 +211,7 @@ describe('RPC -> search()', () => { expect(() => fn(ctx, { contentTypeId: FOO_CONTENT_ID, - query: { title: 'Hello' }, + query: { text: 'Hello' }, version: 7, }) ).rejects.toEqual(new Error('Invalid version. Latest version is [2].')); @@ -218,7 +221,7 @@ describe('RPC -> search()', () => { describe('object versioning', () => { test('should expose a utility to transform and validate services objects', () => { const { ctx, storage } = setup(); - fn(ctx, { contentTypeId: FOO_CONTENT_ID, query: { title: 'Hello' }, version: 1 }); + fn(ctx, { contentTypeId: FOO_CONTENT_ID, query: { text: 'Hello' }, version: 1 }); const [[storageContext]] = storage.search.mock.calls; // getTransforms() utils should be available from context diff --git a/src/plugins/content_management/server/rpc/procedures/search.ts b/src/plugins/content_management/server/rpc/procedures/search.ts index 52e971ec041b2..4ed03daf3d82c 100644 --- a/src/plugins/content_management/server/rpc/procedures/search.ts +++ b/src/plugins/content_management/server/rpc/procedures/search.ts @@ -8,7 +8,7 @@ import { rpcSchemas } from '../../../common/schemas'; import type { SearchIn } from '../../../common'; -import type { StorageContext, ContentCrud } from '../../core'; +import type { StorageContext } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; import { validateRequestVersion } from './utils'; @@ -20,7 +20,7 @@ export const search: ProcedureDefinition> = { const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD - const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); + const crudInstance = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, version: { diff --git a/src/plugins/content_management/server/rpc/procedures/update.test.ts b/src/plugins/content_management/server/rpc/procedures/update.test.ts index ef00f2bbe1435..bf74572ec74d5 100644 --- a/src/plugins/content_management/server/rpc/procedures/update.test.ts +++ b/src/plugins/content_management/server/rpc/procedures/update.test.ts @@ -115,16 +115,29 @@ describe('RPC -> update()', () => { test('should validate that the response is an object', () => { let error = validate( { - any: 'object', + contentTypeId: 'foo', + result: { + item: { + any: 'object', + }, + }, }, outputSchema ); expect(error).toBe(null); - error = validate(123, outputSchema); + error = validate( + { + contentTypeId: 'foo', + result: 123, + }, + outputSchema + ); - expect(error?.message).toBe('expected a plain object value, but found [number] instead.'); + expect(error?.message).toBe( + '[result]: expected a plain object value, but found [number] instead.' + ); }); }); @@ -153,7 +166,9 @@ describe('RPC -> update()', () => { test('should return the storage update() result', async () => { const { ctx, storage } = setup(); - const expected = 'UpdateResult'; + const expected = { + item: 'UpdateResult', + }; storage.update.mockResolvedValueOnce(expected); const result = await fn(ctx, { diff --git a/src/plugins/content_management/server/rpc/procedures/update.ts b/src/plugins/content_management/server/rpc/procedures/update.ts index 104f6019b0866..ef080a37cf6a2 100644 --- a/src/plugins/content_management/server/rpc/procedures/update.ts +++ b/src/plugins/content_management/server/rpc/procedures/update.ts @@ -7,7 +7,7 @@ */ import { rpcSchemas } from '../../../common/schemas'; import type { UpdateIn } from '../../../common'; -import type { StorageContext, ContentCrud } from '../../core'; +import type { StorageContext } from '../../core'; import type { ProcedureDefinition } from '../rpc_service'; import type { Context } from '../types'; import { validateRequestVersion } from './utils'; @@ -19,7 +19,7 @@ export const update: ProcedureDefinition> = { const version = validateRequestVersion(_version, contentDefinition.version.latest); // Execute CRUD - const crudInstance: ContentCrud = ctx.contentRegistry.getCrud(contentTypeId); + const crudInstance = ctx.contentRegistry.getCrud(contentTypeId); const storageContext: StorageContext = { requestHandlerContext: ctx.requestHandlerContext, version: { diff --git a/src/plugins/content_management/server/rpc/routes/routes.ts b/src/plugins/content_management/server/rpc/routes/routes.ts index e89fbc6ae8953..392d01549f9ad 100644 --- a/src/plugins/content_management/server/rpc/routes/routes.ts +++ b/src/plugins/content_management/server/rpc/routes/routes.ts @@ -10,6 +10,7 @@ import type { IRouter } from '@kbn/core/server'; import { ProcedureName } from '../../../common'; import type { ContentRegistry } from '../../core'; +import { MSearchService } from '../../core/msearch'; import type { RpcService } from '../rpc_service'; import { getServiceObjectTransformFactory } from '../services_transforms_factory'; @@ -55,6 +56,11 @@ export function initRpcRoutes( contentRegistry, requestHandlerContext, getTransformsFactory: getServiceObjectTransformFactory, + mSearchService: new MSearchService({ + getSavedObjectsClient: async () => + (await requestHandlerContext.core).savedObjects.client, + contentRegistry, + }), }; const { name } = request.params as { name: ProcedureName }; diff --git a/src/plugins/content_management/server/rpc/types.ts b/src/plugins/content_management/server/rpc/types.ts index e12ae82f1691c..862ac56d67268 100644 --- a/src/plugins/content_management/server/rpc/types.ts +++ b/src/plugins/content_management/server/rpc/types.ts @@ -8,9 +8,11 @@ import type { RequestHandlerContext } from '@kbn/core-http-request-handler-context-server'; import type { ContentManagementGetTransformsFn } from '@kbn/object-versioning'; import type { ContentRegistry } from '../core'; +import type { MSearchService } from '../core/msearch'; export interface Context { contentRegistry: ContentRegistry; requestHandlerContext: RequestHandlerContext; getTransformsFactory: (contentTypeId: string) => ContentManagementGetTransformsFn; + mSearchService: MSearchService; } diff --git a/src/plugins/content_management/tsconfig.json b/src/plugins/content_management/tsconfig.json index 692aa3a03176e..5d306e1a21f4b 100644 --- a/src/plugins/content_management/tsconfig.json +++ b/src/plugins/content_management/tsconfig.json @@ -8,7 +8,12 @@ "@kbn/core", "@kbn/config-schema", "@kbn/core-http-request-handler-context-server", + "@kbn/es-query", + "@kbn/core-test-helpers-kbn-server", + "@kbn/bfetch-plugin", "@kbn/object-versioning", + "@kbn/core-saved-objects-api-server-mocks", + "@kbn/core-saved-objects-api-server", ], "exclude": [ "target/**/*", diff --git a/src/plugins/controls/public/control_group/editor/control_editor.tsx b/src/plugins/controls/public/control_group/editor/control_editor.tsx index 61f0c574d3f01..5cc94acaebcf1 100644 --- a/src/plugins/controls/public/control_group/editor/control_editor.tsx +++ b/src/plugins/controls/public/control_group/editor/control_editor.tsx @@ -16,6 +16,7 @@ import React, { useEffect, useState } from 'react'; import useMount from 'react-use/lib/useMount'; +import useAsync from 'react-use/lib/useAsync'; import { EuiFlyoutHeader, @@ -35,7 +36,7 @@ import { EuiSwitch, EuiTextColor, } from '@elastic/eui'; -import { DataViewListItem, DataView, DataViewField } from '@kbn/data-views-plugin/common'; +import { DataViewField } from '@kbn/data-views-plugin/common'; import { LazyDataViewPicker, LazyFieldPicker, @@ -46,7 +47,6 @@ import { ControlGroupStrings } from '../control_group_strings'; import { ControlEmbeddable, ControlWidth, - DataControlFieldRegistry, DataControlInput, IEditableControlFactory, } from '../../types'; @@ -71,12 +71,6 @@ interface EditControlProps { onTypeEditorChange: (partial: Partial) => void; } -interface ControlEditorState { - dataViewListItems: DataViewListItem[]; - selectedDataView?: DataView; - selectedField?: DataViewField; -} - const FieldPicker = withSuspense(LazyFieldPicker, null); const DataViewPicker = withSuspense(LazyDataViewPicker, null); @@ -104,10 +98,6 @@ export const ControlEditor = ({ const { useEmbeddableSelector: select } = useControlGroupContainerContext(); const editorConfig = select((state) => state.componentState.editorConfig); - const [state, setState] = useState({ - dataViewListItems: [], - }); - const [defaultTitle, setDefaultTitle] = useState(); const [currentTitle, setCurrentTitle] = useState(title ?? ''); const [currentWidth, setCurrentWidth] = useState(width); @@ -116,47 +106,54 @@ export const ControlEditor = ({ const [selectedField, setSelectedField] = useState( embeddable ? embeddable.getInput().fieldName : undefined ); - - const [fieldRegistry, setFieldRegistry] = useState(); - useEffect(() => { - (async () => { - if (state.selectedDataView?.id) { - setFieldRegistry(await getDataControlFieldRegistry(await get(state.selectedDataView.id))); - } - })(); - }, [state.selectedDataView?.id, get]); + const [selectedDataViewId, setSelectedDataViewId] = useState(); useMount(() => { let mounted = true; if (selectedField) setDefaultTitle(selectedField); (async () => { - const dataViewListItems = await getIdsWithTitle(); + if (!mounted) return; + const initialId = embeddable?.getInput().dataViewId ?? getRelevantDataViewId?.() ?? (await getDefaultId()); - let dataView: DataView | undefined; if (initialId) { onTypeEditorChange({ dataViewId: initialId }); - dataView = await get(initialId); + setSelectedDataViewId(initialId); } - if (!mounted) return; - setState((s) => ({ - ...s, - selectedDataView: dataView, - dataViewListItems, - })); })(); return () => { mounted = false; }; }); + const { loading: dataViewListLoading, value: dataViewListItems = [] } = useAsync(() => { + return getIdsWithTitle(); + }); + + const { + loading: dataViewLoading, + value: { selectedDataView, fieldRegistry } = { + selectedDataView: undefined, + fieldRegistry: undefined, + }, + } = useAsync(async () => { + if (!selectedDataViewId) { + return; + } + const dataView = await get(selectedDataViewId); + const registry = await getDataControlFieldRegistry(dataView); + return { + selectedDataView: dataView, + fieldRegistry: registry, + }; + }, [selectedDataViewId]); + useEffect( - () => setControlEditorValid(Boolean(selectedField) && Boolean(state.selectedDataView)), - [selectedField, setControlEditorValid, state.selectedDataView] + () => setControlEditorValid(Boolean(selectedField) && Boolean(selectedDataView)), + [selectedField, setControlEditorValid, selectedDataView] ); - const { selectedDataView: dataView } = state; const controlType = selectedField && fieldRegistry && fieldRegistry[selectedField].compatibleControlTypes[0]; const factory = controlType && getControlFactory(controlType); @@ -178,47 +175,44 @@ export const ControlEditor = ({ {!editorConfig?.hideDataViewSelector && ( { setLastUsedDataViewId?.(dataViewId); - if (dataViewId === dataView?.id) return; - + if (dataViewId === selectedDataViewId) return; onTypeEditorChange({ dataViewId }); setSelectedField(undefined); - get(dataViewId).then((newDataView) => { - setState((s) => ({ ...s, selectedDataView: newDataView })); - }); + setSelectedDataViewId(dataViewId); }} trigger={{ label: - state.selectedDataView?.getName() ?? + selectedDataView?.getName() ?? ControlGroupStrings.manageControl.getSelectDataViewMessage(), }} + selectableProps={{ isLoading: dataViewListLoading }} /> )} - {fieldRegistry && ( - - Boolean(fieldRegistry[field.name])} - selectedFieldName={selectedField} - dataView={dataView} - onSelectField={(field) => { - onTypeEditorChange({ - fieldName: field.name, - }); - const newDefaultTitle = field.displayName ?? field.name; - setDefaultTitle(newDefaultTitle); - setSelectedField(field.name); - if (!currentTitle || currentTitle === defaultTitle) { - setCurrentTitle(newDefaultTitle); - updateTitle(newDefaultTitle); - } - }} - /> - - )} + + Boolean(fieldRegistry?.[field.name])} + selectedFieldName={selectedField} + dataView={selectedDataView} + onSelectField={(field) => { + onTypeEditorChange({ + fieldName: field.name, + }); + const newDefaultTitle = field.displayName ?? field.name; + setDefaultTitle(newDefaultTitle); + setSelectedField(field.name); + if (!currentTitle || currentTitle === defaultTitle) { + setCurrentTitle(newDefaultTitle); + updateTitle(newDefaultTitle); + } + }} + selectableProps={{ isLoading: dataViewListLoading || dataViewLoading }} + /> + {factory ? ( @@ -284,7 +278,7 @@ export const ControlEditor = ({ )} diff --git a/src/plugins/controls/public/control_group/editor/data_control_editor_tools.ts b/src/plugins/controls/public/control_group/editor/data_control_editor_tools.ts index 8cfd3cebe5dac..19ca230c0f354 100644 --- a/src/plugins/controls/public/control_group/editor/data_control_editor_tools.ts +++ b/src/plugins/controls/public/control_group/editor/data_control_editor_tools.ts @@ -11,7 +11,7 @@ import { memoize } from 'lodash'; import { DataView } from '@kbn/data-views-plugin/common'; import { pluginServices } from '../../services'; -import { DataControlField, DataControlFieldRegistry, IEditableControlFactory } from '../../types'; +import { DataControlFieldRegistry, IEditableControlFactory } from '../../types'; export const getDataControlFieldRegistry = memoize( async (dataView: DataView) => { @@ -30,20 +30,19 @@ const loadFieldRegistryFromDataView = async ( const controlFactories = getControlTypes().map( (controlType) => getControlFactory(controlType) as IEditableControlFactory ); - const fieldRegistry: DataControlFieldRegistry = dataView.fields - .getAll() - .reduce((registry, field) => { - const test: DataControlField = { field, compatibleControlTypes: [] }; + const fieldRegistry: DataControlFieldRegistry = {}; + return new Promise((resolve) => { + for (const field of dataView.fields.getAll()) { + const compatibleControlTypes = []; for (const factory of controlFactories) { - if (factory.isFieldCompatible) { - factory.isFieldCompatible(test); + if (factory.isFieldCompatible && factory.isFieldCompatible(field)) { + compatibleControlTypes.push(factory.type); } } - if (test.compatibleControlTypes.length === 0) { - return { ...registry }; + if (compatibleControlTypes.length > 0) { + fieldRegistry[field.name] = { field, compatibleControlTypes }; } - return { ...registry, [field.name]: test }; - }, {}); - - return fieldRegistry; + } + resolve(fieldRegistry); + }); }; diff --git a/src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx b/src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx index 8465016ce4402..d970c309bb6a8 100644 --- a/src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx +++ b/src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx @@ -9,6 +9,7 @@ import deepEqual from 'fast-deep-equal'; import { i18n } from '@kbn/i18n'; +import { DataViewField } from '@kbn/data-views-plugin/common'; import { lazyLoadReduxEmbeddablePackage } from '@kbn/presentation-util-plugin/public'; import { EmbeddableFactoryDefinition, IContainer } from '@kbn/embeddable-plugin/public'; @@ -21,7 +22,7 @@ import { OPTIONS_LIST_CONTROL, } from '../../../common/options_list/types'; import { OptionsListEditorOptions } from '../components/options_list_editor_options'; -import { ControlEmbeddable, DataControlField, IEditableControlFactory } from '../../types'; +import { ControlEmbeddable, IEditableControlFactory } from '../../types'; export class OptionsListEmbeddableFactory implements EmbeddableFactoryDefinition, IEditableControlFactory @@ -57,15 +58,13 @@ export class OptionsListEmbeddableFactory return newInput; }; - public isFieldCompatible = (dataControlField: DataControlField) => { - if ( - !dataControlField.field.spec.scripted && - ((dataControlField.field.aggregatable && dataControlField.field.type === 'string') || - dataControlField.field.type === 'boolean' || - dataControlField.field.type === 'ip') - ) { - dataControlField.compatibleControlTypes.push(this.type); - } + public isFieldCompatible = (field: DataViewField) => { + return ( + !field.spec.scripted && + ((field.aggregatable && field.type === 'string') || + field.type === 'boolean' || + field.type === 'ip') + ); }; public controlEditorOptionsComponent = OptionsListEditorOptions; diff --git a/src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx b/src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx index 2a86d5c186fc2..b8cd0d9536b1e 100644 --- a/src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx +++ b/src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx @@ -10,6 +10,7 @@ import deepEqual from 'fast-deep-equal'; import { EmbeddableFactoryDefinition, IContainer } from '@kbn/embeddable-plugin/public'; import { lazyLoadReduxEmbeddablePackage } from '@kbn/presentation-util-plugin/public'; +import { DataViewField } from '@kbn/data-views-plugin/common'; import { i18n } from '@kbn/i18n'; import { @@ -20,7 +21,7 @@ import { RangeSliderEmbeddableInput, RANGE_SLIDER_CONTROL, } from '../../../common/range_slider/types'; -import { ControlEmbeddable, DataControlField, IEditableControlFactory } from '../../types'; +import { ControlEmbeddable, IEditableControlFactory } from '../../types'; export class RangeSliderEmbeddableFactory implements EmbeddableFactoryDefinition, IEditableControlFactory @@ -68,10 +69,8 @@ export class RangeSliderEmbeddableFactory return newInput; }; - public isFieldCompatible = (dataControlField: DataControlField) => { - if (dataControlField.field.aggregatable && dataControlField.field.type === 'number') { - dataControlField.compatibleControlTypes.push(this.type); - } + public isFieldCompatible = (field: DataViewField) => { + return field.aggregatable && field.type === 'number'; }; public inject = createRangeSliderInject(); diff --git a/src/plugins/controls/public/types.ts b/src/plugins/controls/public/types.ts index 6e26440c1410d..bdae4d983078c 100644 --- a/src/plugins/controls/public/types.ts +++ b/src/plugins/controls/public/types.ts @@ -49,13 +49,14 @@ export type ControlEmbeddable< /** * Control embeddable editor types */ -export interface IEditableControlFactory { +export interface IEditableControlFactory + extends Pick { controlEditorOptionsComponent?: (props: ControlEditorProps) => JSX.Element; presaveTransformFunction?: ( newState: Partial, embeddable?: ControlEmbeddable ) => Partial; - isFieldCompatible?: (dataControlField: DataControlField) => void; // reducer + isFieldCompatible?: (field: DataViewField) => boolean; } export interface ControlEditorProps { diff --git a/src/plugins/dashboard/public/dashboard_app/_dashboard_app_strings.ts b/src/plugins/dashboard/public/dashboard_app/_dashboard_app_strings.ts index c10646430494d..d34bc51343cd3 100644 --- a/src/plugins/dashboard/public/dashboard_app/_dashboard_app_strings.ts +++ b/src/plugins/dashboard/public/dashboard_app/_dashboard_app_strings.ts @@ -46,6 +46,11 @@ export const unsavedChangesBadgeStrings = { i18n.translate('dashboard.unsavedChangesBadge', { defaultMessage: 'Unsaved changes', }), + getUnsavedChangedBadgeToolTipContent: () => + i18n.translate('dashboard.unsavedChangesBadgeToolTipContent', { + defaultMessage: + ' You have unsaved changes in this dashboard. To remove this label, save the dashboard.', + }), }; export const leaveConfirmStrings = { diff --git a/src/plugins/dashboard/public/dashboard_app/top_nav/dashboard_top_nav.tsx b/src/plugins/dashboard/public/dashboard_app/top_nav/dashboard_top_nav.tsx index daa8ea63616cb..c2febc4750185 100644 --- a/src/plugins/dashboard/public/dashboard_app/top_nav/dashboard_top_nav.tsx +++ b/src/plugins/dashboard/public/dashboard_app/top_nav/dashboard_top_nav.tsx @@ -18,7 +18,7 @@ import { import { ViewMode } from '@kbn/embeddable-plugin/public'; import type { DataView } from '@kbn/data-views-plugin/public'; -import { EuiHorizontalRule } from '@elastic/eui'; +import { EuiHorizontalRule, EuiToolTipProps } from '@elastic/eui'; import { getDashboardTitle, leaveConfirmStrings, @@ -252,7 +252,12 @@ export function DashboardTopNav({ embedSettings, redirectTo }: DashboardTopNavPr { 'data-test-subj': 'dashboardUnsavedChangesBadge', badgeText: unsavedChangesBadgeStrings.getUnsavedChangedBadgeText(), - color: 'success', + title: '', + color: 'warning', + toolTipProps: { + content: unsavedChangesBadgeStrings.getUnsavedChangedBadgeToolTipContent(), + position: 'bottom', + } as EuiToolTipProps, }, ] : undefined diff --git a/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx b/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx index 4c351177113d9..95034247b8d91 100644 --- a/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx +++ b/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx @@ -311,14 +311,14 @@ export class DashboardContainer extends Container void; @@ -35,19 +36,13 @@ export const DiscoverHistogramLayout = ({ inspectorAdapters, ...mainContentProps }: DiscoverHistogramLayoutProps) => { - const commonProps = { - dataView, - stateContainer, - savedSearchData$: stateContainer.dataState.data$, - }; const searchSessionId = useObservable(stateContainer.searchSessionManager.searchSessionId$); - - const { hideChart, setUnifiedHistogramApi } = useDiscoverHistogram({ + const hideChart = useAppStateSelector((state) => state.hideChart); + const unifiedHistogramProps = useDiscoverHistogram({ + stateContainer, inspectorAdapters, - savedSearchFetch$: stateContainer.dataState.fetch$, - searchSessionId, + hideChart, isPlainRecord, - ...commonProps, }); // Initialized when the first search has been requested or @@ -58,7 +53,10 @@ export const DiscoverHistogramLayout = ({ return ( : undefined @@ -66,8 +64,9 @@ export const DiscoverHistogramLayout = ({ css={histogramLayoutCss} > { const renderUseDiscoverHistogram = async ({ stateContainer = getStateContainer(), - searchSessionId = '123', inspectorAdapters = { requests: new RequestAdapter() }, - totalHits$ = new BehaviorSubject({ - fetchStatus: FetchStatus.COMPLETE, - result: Number(esHits.length), - }) as DataTotalHits$, - main$ = new BehaviorSubject({ - fetchStatus: FetchStatus.COMPLETE, - recordRawType: RecordRawType.DOCUMENT, - foundDocuments: true, - }) as DataMain$, - savedSearchFetch$ = new Subject() as DataFetch$, - documents$ = new BehaviorSubject({ - fetchStatus: FetchStatus.COMPLETE, - result: esHits.map((esHit) => buildDataTableRecord(esHit, dataViewWithTimefieldMock)), - }) as DataDocuments$, + hideChart = false, isPlainRecord = false, }: { stateContainer?: DiscoverStateContainer; - searchSessionId?: string; inspectorAdapters?: InspectorAdapters; - totalHits$?: DataTotalHits$; - main$?: DataMain$; - savedSearchFetch$?: DataFetch$; - documents$?: DataDocuments$; + hideChart?: boolean; isPlainRecord?: boolean; } = {}) => { - const availableFields$ = new BehaviorSubject({ - fetchStatus: FetchStatus.COMPLETE, - fields: [] as string[], - }) as AvailableFields$; - - const savedSearchData$ = { - main$, - documents$, - totalHits$, - availableFields$, - }; - const initialProps = { stateContainer, - savedSearchData$, - savedSearchFetch$, - dataView: dataViewWithTimefieldMock, inspectorAdapters, - searchSessionId, + hideChart, isPlainRecord, }; @@ -170,32 +125,17 @@ describe('useDiscoverHistogram', () => { }; describe('initialization', () => { - it('should pass the expected parameters to initialize', async () => { + it('should return the expected parameters from getCreationOptions', async () => { const { hook } = await renderUseDiscoverHistogram(); - const api = createMockUnifiedHistogramApi(); - let params: UnifiedHistogramInitializeOptions | undefined; - api.initialize = jest.fn((p) => { - params = p; - }); - act(() => { - hook.result.current.setUnifiedHistogramApi(api); - }); - expect(api.initialize).toHaveBeenCalled(); + const params = hook.result.current.getCreationOptions(); expect(params?.localStorageKeyPrefix).toBe('discover'); expect(params?.disableAutoFetching).toBe(true); expect(Object.keys(params?.initialState ?? {})).toEqual([ - 'dataView', - 'query', - 'filters', - 'timeRange', 'chartHidden', 'timeInterval', - 'columns', 'breakdownField', - 'searchSessionId', 'totalHitsStatus', 'totalHitsResult', - 'requestAdapter', ]); }); }); @@ -206,12 +146,12 @@ describe('useDiscoverHistogram', () => { }); it('should subscribe to state changes', async () => { const { hook } = await renderUseDiscoverHistogram(); - const api = createMockUnifiedHistogramApi({ initialized: true }); + const api = createMockUnifiedHistogramApi(); jest.spyOn(api.state$, 'subscribe'); act(() => { - hook.result.current.setUnifiedHistogramApi(api); + hook.result.current.ref(api); }); - expect(api.state$.subscribe).toHaveBeenCalledTimes(4); + expect(api.state$.subscribe).toHaveBeenCalledTimes(3); }); it('should sync Unified Histogram state with the state container', async () => { @@ -225,12 +165,11 @@ describe('useDiscoverHistogram', () => { breakdownField: 'test', totalHitsStatus: UnifiedHistogramFetchStatus.loading, totalHitsResult: undefined, - dataView: dataViewWithTimefieldMock, } as unknown as UnifiedHistogramState; - const api = createMockUnifiedHistogramApi({ initialized: true }); + const api = createMockUnifiedHistogramApi(); api.state$ = new BehaviorSubject({ ...state, lensRequestAdapter }); act(() => { - hook.result.current.setUnifiedHistogramApi(api); + hook.result.current.ref(api); }); expect(inspectorAdapters.lensRequests).toBe(lensRequestAdapter); expect(stateContainer.appState.update).toHaveBeenCalledWith({ @@ -250,12 +189,11 @@ describe('useDiscoverHistogram', () => { breakdownField: containerState.breakdownField, totalHitsStatus: UnifiedHistogramFetchStatus.loading, totalHitsResult: undefined, - dataView: dataViewWithTimefieldMock, } as unknown as UnifiedHistogramState; - const api = createMockUnifiedHistogramApi({ initialized: true }); + const api = createMockUnifiedHistogramApi(); api.state$ = new BehaviorSubject(state); act(() => { - hook.result.current.setUnifiedHistogramApi(api); + hook.result.current.ref(api); }); expect(stateContainer.appState.update).not.toHaveBeenCalled(); }); @@ -263,11 +201,8 @@ describe('useDiscoverHistogram', () => { it('should sync the state container state with Unified Histogram', async () => { const stateContainer = getStateContainer(); const { hook } = await renderUseDiscoverHistogram({ stateContainer }); - const api = createMockUnifiedHistogramApi({ initialized: true }); + const api = createMockUnifiedHistogramApi(); let params: Partial = {}; - api.setRequestParams = jest.fn((p) => { - params = { ...params, ...p }; - }); api.setTotalHits = jest.fn((p) => { params = { ...params, ...p }; }); @@ -281,20 +216,13 @@ describe('useDiscoverHistogram', () => { params = { ...params, breakdownField }; }); act(() => { - hook.result.current.setUnifiedHistogramApi(api); + hook.result.current.ref(api); }); - expect(api.setRequestParams).toHaveBeenCalled(); expect(api.setTotalHits).toHaveBeenCalled(); expect(api.setChartHidden).toHaveBeenCalled(); expect(api.setTimeInterval).toHaveBeenCalled(); expect(api.setBreakdownField).toHaveBeenCalled(); expect(Object.keys(params ?? {})).toEqual([ - 'dataView', - 'query', - 'filters', - 'timeRange', - 'searchSessionId', - 'requestAdapter', 'totalHitsStatus', 'totalHitsResult', 'chartHidden', @@ -313,12 +241,11 @@ describe('useDiscoverHistogram', () => { breakdownField: containerState.breakdownField, totalHitsStatus: UnifiedHistogramFetchStatus.loading, totalHitsResult: undefined, - dataView: dataViewWithTimefieldMock, } as unknown as UnifiedHistogramState; - const api = createMockUnifiedHistogramApi({ initialized: true }); + const api = createMockUnifiedHistogramApi(); let params: Partial = {}; - api.setRequestParams = jest.fn((p) => { - params = { ...params, ...p }; + api.setChartHidden = jest.fn((chartHidden) => { + params = { ...params, chartHidden }; }); api.setTotalHits = jest.fn((p) => { params = { ...params, ...p }; @@ -326,20 +253,15 @@ describe('useDiscoverHistogram', () => { const subject$ = new BehaviorSubject(state); api.state$ = subject$; act(() => { - hook.result.current.setUnifiedHistogramApi(api); + hook.result.current.ref(api); }); expect(Object.keys(params ?? {})).toEqual([ - 'dataView', - 'query', - 'filters', - 'timeRange', - 'searchSessionId', - 'requestAdapter', 'totalHitsStatus', 'totalHitsResult', + 'chartHidden', ]); params = {}; - hook.rerender({ ...initialProps, searchSessionId: '321' }); + hook.rerender({ ...initialProps, hideChart: true }); act(() => { subject$.next({ ...state, @@ -347,28 +269,12 @@ describe('useDiscoverHistogram', () => { totalHitsResult: 100, }); }); - expect(Object.keys(params ?? {})).toEqual([ - 'dataView', - 'query', - 'filters', - 'timeRange', - 'searchSessionId', - 'requestAdapter', - ]); + expect(Object.keys(params ?? {})).toEqual(['chartHidden']); }); it('should update total hits when the total hits state changes', async () => { - const totalHits$ = new BehaviorSubject({ - fetchStatus: FetchStatus.LOADING, - result: undefined, - }) as DataTotalHits$; - const main$ = new BehaviorSubject({ - fetchStatus: FetchStatus.COMPLETE, - recordRawType: RecordRawType.DOCUMENT, - foundDocuments: true, - }) as DataMain$; const stateContainer = getStateContainer(); - const { hook } = await renderUseDiscoverHistogram({ stateContainer, totalHits$, main$ }); + const { hook } = await renderUseDiscoverHistogram({ stateContainer }); const containerState = stateContainer.appState.getState(); const state = { timeInterval: containerState.interval, @@ -376,22 +282,27 @@ describe('useDiscoverHistogram', () => { breakdownField: containerState.breakdownField, totalHitsStatus: UnifiedHistogramFetchStatus.loading, totalHitsResult: undefined, - dataView: dataViewWithTimefieldMock, } as unknown as UnifiedHistogramState; - const api = createMockUnifiedHistogramApi({ initialized: true }); + const api = createMockUnifiedHistogramApi(); api.state$ = new BehaviorSubject({ ...state, totalHitsStatus: UnifiedHistogramFetchStatus.complete, totalHitsResult: 100, }); + expect(stateContainer.dataState.data$.totalHits$.value).not.toEqual({ + fetchStatus: FetchStatus.COMPLETE, + result: 100, + recordRawType: stateContainer.dataState.data$.totalHits$.value.recordRawType, + }); act(() => { - hook.result.current.setUnifiedHistogramApi(api); + hook.result.current.ref(api); }); - expect(totalHits$.value).toEqual({ + expect(stateContainer.dataState.data$.totalHits$.value).toEqual({ fetchStatus: FetchStatus.COMPLETE, result: 100, + recordRawType: stateContainer.dataState.data$.totalHits$.value.recordRawType, }); - expect(mockCheckHitCount).toHaveBeenCalledWith(main$, 100); + expect(mockCheckHitCount).toHaveBeenCalledWith(stateContainer.dataState.data$.main$, 100); }); it('should not update total hits when the total hits state changes to an error', async () => { @@ -408,12 +319,8 @@ describe('useDiscoverHistogram', () => { }; mockData.query.getState = () => mockQueryState; - const totalHits$ = new BehaviorSubject({ - fetchStatus: FetchStatus.UNINITIALIZED, - result: undefined, - }) as DataTotalHits$; const stateContainer = getStateContainer(); - const { hook } = await renderUseDiscoverHistogram({ stateContainer, totalHits$ }); + const { hook } = await renderUseDiscoverHistogram({ stateContainer }); const containerState = stateContainer.appState.getState(); const error = new Error('test'); const state = { @@ -422,21 +329,26 @@ describe('useDiscoverHistogram', () => { breakdownField: containerState.breakdownField, totalHitsStatus: UnifiedHistogramFetchStatus.loading, totalHitsResult: undefined, - dataView: dataViewWithTimefieldMock, } as unknown as UnifiedHistogramState; - const api = createMockUnifiedHistogramApi({ initialized: true }); + const api = createMockUnifiedHistogramApi(); api.state$ = new BehaviorSubject({ ...state, totalHitsStatus: UnifiedHistogramFetchStatus.error, totalHitsResult: error, }); + expect(stateContainer.dataState.data$.totalHits$.value).not.toEqual({ + fetchStatus: FetchStatus.ERROR, + error, + recordRawType: stateContainer.dataState.data$.totalHits$.value.recordRawType, + }); act(() => { - hook.result.current.setUnifiedHistogramApi(api); + hook.result.current.ref(api); }); - expect(sendErrorTo).toHaveBeenCalledWith(totalHits$); - expect(totalHits$.value).toEqual({ + expect(sendErrorTo).toHaveBeenCalledWith(stateContainer.dataState.data$.totalHits$); + expect(stateContainer.dataState.data$.totalHits$.value).toEqual({ fetchStatus: FetchStatus.ERROR, error, + recordRawType: stateContainer.dataState.data$.totalHits$.value.recordRawType, }); expect(mockCheckHitCount).not.toHaveBeenCalled(); }); @@ -448,10 +360,12 @@ describe('useDiscoverHistogram', () => { reset: boolean; searchSessionId: string; }>(); - const { hook } = await renderUseDiscoverHistogram({ savedSearchFetch$ }); - const api = createMockUnifiedHistogramApi({ initialized: true }); + const stateContainer = getStateContainer(); + stateContainer.dataState.fetch$ = savedSearchFetch$; + const { hook } = await renderUseDiscoverHistogram({ stateContainer }); + const api = createMockUnifiedHistogramApi(); act(() => { - hook.result.current.setUnifiedHistogramApi(api); + hook.result.current.ref(api); }); expect(api.refetch).not.toHaveBeenCalled(); act(() => { @@ -461,21 +375,22 @@ describe('useDiscoverHistogram', () => { }); it('should skip the next refetch when hideChart changes from true to false', async () => { - const stateContainer = getStateContainer(); const savedSearchFetch$ = new Subject<{ reset: boolean; searchSessionId: string; }>(); - const { hook } = await renderUseDiscoverHistogram({ stateContainer, savedSearchFetch$ }); - const api = createMockUnifiedHistogramApi({ initialized: true }); + const stateContainer = getStateContainer(); + stateContainer.dataState.fetch$ = savedSearchFetch$; + const { hook, initialProps } = await renderUseDiscoverHistogram({ stateContainer }); + const api = createMockUnifiedHistogramApi(); act(() => { - hook.result.current.setUnifiedHistogramApi(api); + hook.result.current.ref(api); }); act(() => { - stateContainer.appState.update({ hideChart: true }); + hook.rerender({ ...initialProps, hideChart: true }); }); act(() => { - stateContainer.appState.update({ hideChart: false }); + hook.rerender({ ...initialProps, hideChart: false }); }); act(() => { savedSearchFetch$.next({ reset: false, searchSessionId: '1234' }); diff --git a/src/plugins/discover/public/application/main/components/layout/use_discover_histogram.ts b/src/plugins/discover/public/application/main/components/layout/use_discover_histogram.ts index 46d3ef314b337..50d3edefcd67c 100644 --- a/src/plugins/discover/public/application/main/components/layout/use_discover_histogram.ts +++ b/src/plugins/discover/public/application/main/components/layout/use_discover_histogram.ts @@ -6,17 +6,16 @@ * Side Public License, v 1. */ -import type { DataView } from '@kbn/data-views-plugin/common'; import { useQuerySubscriber } from '@kbn/unified-field-list-plugin/public'; import { UnifiedHistogramApi, UnifiedHistogramFetchStatus, - UnifiedHistogramInitializedApi, UnifiedHistogramState, } from '@kbn/unified-histogram-plugin/public'; import { isEqual } from 'lodash'; import { useCallback, useEffect, useRef, useMemo, useState } from 'react'; -import { distinctUntilChanged, filter, map, Observable, skip } from 'rxjs'; +import { distinctUntilChanged, filter, map, Observable } from 'rxjs'; +import useObservable from 'react-use/lib/useObservable'; import type { Suggestion } from '@kbn/lens-plugin/public'; import useLatest from 'react-use/lib/useLatest'; import { useDiscoverServices } from '../../../../hooks/use_discover_services'; @@ -24,97 +23,57 @@ import { getUiActions } from '../../../../kibana_services'; import { FetchStatus } from '../../../types'; import { useDataState } from '../../hooks/use_data_state'; import type { InspectorAdapters } from '../../hooks/use_inspector'; -import type { - DataDocuments$, - DataFetch$, - SavedSearchData, -} from '../../services/discover_data_state_container'; +import type { DataDocuments$ } from '../../services/discover_data_state_container'; import { checkHitCount, sendErrorTo } from '../../hooks/use_saved_search_messages'; import { useAppStateSelector } from '../../services/discover_app_state_container'; import type { DiscoverStateContainer } from '../../services/discover_state'; import { addLog } from '../../../../utils/add_log'; +import { useInternalStateSelector } from '../../services/discover_internal_state_container'; export interface UseDiscoverHistogramProps { stateContainer: DiscoverStateContainer; - savedSearchData$: SavedSearchData; - dataView: DataView; inspectorAdapters: InspectorAdapters; - savedSearchFetch$: DataFetch$; - searchSessionId: string | undefined; + hideChart: boolean | undefined; isPlainRecord: boolean; } export const useDiscoverHistogram = ({ stateContainer, - savedSearchData$, - dataView, inspectorAdapters, - savedSearchFetch$, - searchSessionId, + hideChart, isPlainRecord, }: UseDiscoverHistogramProps) => { const services = useDiscoverServices(); - const timefilter = services.data.query.timefilter.timefilter; + const savedSearchData$ = stateContainer.dataState.data$; /** * API initialization */ - const [unifiedHistogram, setUnifiedHistogram] = useState(); - - const setUnifiedHistogramApi = useCallback( - (api: UnifiedHistogramApi | null) => { - if (!api) { - return; - } + const [unifiedHistogram, ref] = useState(); - if (api.initialized) { - setUnifiedHistogram(api); - } else { - const { - hideChart: chartHidden, - interval: timeInterval, - breakdownField, - columns, - } = stateContainer.appState.getState(); - - const { fetchStatus: totalHitsStatus, result: totalHitsResult } = - savedSearchData$.totalHits$.getValue(); - - const { query, filters, time: timeRange } = services.data.query.getState(); - - api.initialize({ - services: { ...services, uiActions: getUiActions() }, - localStorageKeyPrefix: 'discover', - disableAutoFetching: true, - getRelativeTimeRange: timefilter.getTime, - initialState: { - dataView, - query, - filters, - timeRange, - chartHidden, - timeInterval, - columns, - breakdownField, - searchSessionId, - totalHitsStatus: totalHitsStatus.toString() as UnifiedHistogramFetchStatus, - totalHitsResult, - requestAdapter: inspectorAdapters.requests, - }, - }); - } - }, - [ - dataView, - inspectorAdapters.requests, - savedSearchData$.totalHits$, - searchSessionId, - services, - stateContainer.appState, - timefilter.getTime, - ] - ); + const getCreationOptions = useCallback(() => { + const { + hideChart: chartHidden, + interval: timeInterval, + breakdownField, + } = stateContainer.appState.getState(); + + const { fetchStatus: totalHitsStatus, result: totalHitsResult } = + savedSearchData$.totalHits$.getValue(); + + return { + localStorageKeyPrefix: 'discover', + disableAutoFetching: true, + initialState: { + chartHidden, + timeInterval, + breakdownField, + totalHitsStatus: totalHitsStatus.toString() as UnifiedHistogramFetchStatus, + totalHitsResult, + }, + }; + }, [savedSearchData$.totalHits$, stateContainer.appState]); /** * Sync Unified Histogram state with Discover state @@ -124,8 +83,12 @@ export const useDiscoverHistogram = ({ const subscription = createStateSyncObservable(unifiedHistogram?.state$)?.subscribe((state) => { inspectorAdapters.lensRequests = state.lensRequestAdapter; - const { hideChart, interval, breakdownField } = stateContainer.appState.getState(); - const oldState = { hideChart, interval, breakdownField }; + const appState = stateContainer.appState.getState(); + const oldState = { + hideChart: appState.hideChart, + interval: appState.interval, + breakdownField: appState.breakdownField, + }; const newState = { hideChart: state.chartHidden, interval: state.timeInterval, @@ -140,32 +103,7 @@ export const useDiscoverHistogram = ({ return () => { subscription?.unsubscribe(); }; - }, [inspectorAdapters, stateContainer, unifiedHistogram]); - - /** - * Update Unified Histgoram request params - */ - const { query, filters } = useQuerySubscriber({ data: services.data }); - const timeRange = timefilter.getAbsoluteTime(); - - useEffect(() => { - unifiedHistogram?.setRequestParams({ - dataView, - query, - filters, - timeRange, - searchSessionId, - requestAdapter: inspectorAdapters.requests, - }); - }, [ - dataView, - filters, - inspectorAdapters.requests, - query, - searchSessionId, - timeRange, - unifiedHistogram, - ]); + }, [inspectorAdapters, stateContainer.appState, unifiedHistogram?.state$]); /** * Override Unified Histgoram total hits with Discover partial results @@ -193,8 +131,6 @@ export const useDiscoverHistogram = ({ * Sync URL query params with Unified Histogram */ - const hideChart = useAppStateSelector((state) => state.hideChart); - useEffect(() => { if (typeof hideChart === 'boolean') { unifiedHistogram?.setChartHidden(hideChart); @@ -221,18 +157,15 @@ export const useDiscoverHistogram = ({ // Update the columns only when documents are fetched so the Lens suggestions // don't constantly change when the user modifies the table columns - useEffect(() => { - const subscription = createDocumentsFetchedObservable( - stateContainer.dataState.data$.documents$ - ).subscribe(({ textBasedQueryColumns }) => { - const columns = textBasedQueryColumns?.map(({ name }) => name) ?? []; - unifiedHistogram?.setColumns(columns); - }); + const columnsObservable = useMemo( + () => createColumnsObservable(savedSearchData$.documents$), + [savedSearchData$.documents$] + ); - return () => { - subscription.unsubscribe(); - }; - }, [stateContainer.appState, stateContainer.dataState.data$.documents$, unifiedHistogram]); + const columns = useObservable( + columnsObservable, + savedSearchData$.documents$.getValue().textBasedQueryColumns?.map(({ name }) => name) ?? [] + ); /** * Total hits @@ -284,10 +217,22 @@ export const useDiscoverHistogram = ({ unifiedHistogram?.state$, ]); + /** + * Request params + */ + const { query, filters } = useQuerySubscriber({ data: services.data }); + const timefilter = services.data.query.timefilter.timefilter; + const timeRange = timefilter.getAbsoluteTime(); + const relativeTimeRange = useObservable( + timefilter.getTimeUpdate$().pipe(map(() => timefilter.getTime())), + timefilter.getTime() + ); + /** * Data fetching */ + const savedSearchFetch$ = stateContainer.dataState.fetch$; const skipDiscoverRefetch = useRef(); const skipLensSuggestionRefetch = useRef(); const usingLensSuggestion = useLatest(isPlainRecord && !hideChart); @@ -343,20 +288,34 @@ export const useDiscoverHistogram = ({ // When the data view or query changes, which will trigger a current suggestion change, // skip the next refetch since we want to wait for the columns to update first, which // doesn't happen until after the documents are fetched + const dataViewId = useInternalStateSelector((state) => state.dataView?.id); + const skipFetchParams = useRef({ dataViewId, query }); + useEffect(() => { - const subscription = createSkipFetchObservable(unifiedHistogram?.state$)?.subscribe(() => { - if (usingLensSuggestion.current) { - skipLensSuggestionRefetch.current = true; - skipDiscoverRefetch.current = true; - } - }); + const newSkipFetchParams = { dataViewId, query }; - return () => { - subscription?.unsubscribe(); - }; - }, [unifiedHistogram?.state$, usingLensSuggestion]); + if (isEqual(skipFetchParams.current, newSkipFetchParams)) { + return; + } + + skipFetchParams.current = newSkipFetchParams; + + if (usingLensSuggestion.current) { + skipLensSuggestionRefetch.current = true; + skipDiscoverRefetch.current = true; + } + }, [dataViewId, query, usingLensSuggestion]); - return { hideChart, setUnifiedHistogramApi }; + return { + ref, + getCreationOptions, + services: { ...services, uiActions: getUiActions() }, + query, + filters, + timeRange, + relativeTimeRange, + columns, + }; }; const createStateSyncObservable = (state$?: Observable) => { @@ -376,10 +335,11 @@ const createStateSyncObservable = (state$?: Observable) = ); }; -const createDocumentsFetchedObservable = (documents$: DataDocuments$) => { +const createColumnsObservable = (documents$: DataDocuments$) => { return documents$.pipe( distinctUntilChanged((prev, curr) => prev.fetchStatus === curr.fetchStatus), - filter(({ fetchStatus }) => fetchStatus === FetchStatus.COMPLETE) + filter(({ fetchStatus }) => fetchStatus === FetchStatus.COMPLETE), + map(({ textBasedQueryColumns }) => textBasedQueryColumns?.map(({ name }) => name) ?? []) ); }; @@ -396,11 +356,3 @@ const createCurrentSuggestionObservable = (state$?: Observable) => { - return state$?.pipe( - map((state) => [state.dataView.id, state.query]), - distinctUntilChanged(isEqual), - skip(1) - ); -}; diff --git a/src/plugins/home/public/application/components/guided_onboarding/getting_started.tsx b/src/plugins/home/public/application/components/guided_onboarding/getting_started.tsx index e7e24fda9676a..e683b4f4e1bcc 100644 --- a/src/plugins/home/public/application/components/guided_onboarding/getting_started.tsx +++ b/src/plugins/home/public/application/components/guided_onboarding/getting_started.tsx @@ -205,7 +205,7 @@ export const GettingStarted = () => {

{title}

diff --git a/src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx b/src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx index 652ff58a5ab4a..191682818df3c 100644 --- a/src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx +++ b/src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx @@ -7,7 +7,14 @@ */ import React, { ReactElement } from 'react'; -import { EuiBadge, EuiBadgeGroup, EuiBadgeProps, EuiHeaderLinks } from '@elastic/eui'; +import { + EuiBadge, + EuiBadgeGroup, + EuiBadgeProps, + EuiHeaderLinks, + EuiToolTip, + EuiToolTipProps, +} from '@elastic/eui'; import classNames from 'classnames'; import { MountPoint } from '@kbn/core/public'; @@ -18,11 +25,16 @@ import { AggregateQuery, Query } from '@kbn/es-query'; import { TopNavMenuData } from './top_nav_menu_data'; import { TopNavMenuItem } from './top_nav_menu_item'; +type Badge = EuiBadgeProps & { + badgeText: string; + toolTipProps?: Partial; +}; + export type TopNavMenuProps = StatefulSearchBarProps & Omit, 'kibana' | 'intl' | 'timeHistory'> & { config?: TopNavMenuData[]; - badges?: Array; + badges?: Badge[]; showSearchBar?: boolean; showQueryInput?: boolean; showDatePicker?: boolean; @@ -69,18 +81,20 @@ export function TopNavMenu( return null; } + function createBadge({ badgeText, toolTipProps, ...badgeProps }: Badge, i: number): ReactElement { + const badge = ( + + {badgeText} + + ); + return toolTipProps ? {badge} : badge; + } + function renderBadges(): ReactElement | null { if (!badges || badges.length === 0) return null; return ( - {badges.map((badge: EuiBadgeProps & { badgeText: string }, i: number) => { - const { badgeText, ...badgeProps } = badge; - return ( - - {badgeText} - - ); - })} + {badges.map(createBadge)} ); } diff --git a/src/plugins/presentation_util/common/index.ts b/src/plugins/presentation_util/common/index.ts index f7ed4603d4acb..710292097d4cd 100644 --- a/src/plugins/presentation_util/common/index.ts +++ b/src/plugins/presentation_util/common/index.ts @@ -39,7 +39,9 @@ export { getElasticLogo, getElasticOutline, isValidUrl, + isValidHttpUrl, resolveWithMissingImage, + resolveFromArgs, encode, parseDataUrl, } from './lib'; diff --git a/src/plugins/presentation_util/public/components/data_view_picker/data_view_picker.tsx b/src/plugins/presentation_util/public/components/data_view_picker/data_view_picker.tsx index 756fc9c525bb1..fae805cd49ebc 100644 --- a/src/plugins/presentation_util/public/components/data_view_picker/data_view_picker.tsx +++ b/src/plugins/presentation_util/public/components/data_view_picker/data_view_picker.tsx @@ -31,7 +31,7 @@ export function DataViewPicker({ selectedDataViewId?: string; trigger: DataViewTriggerProps; onChangeDataViewId: (newId: string) => void; - selectableProps?: EuiSelectableProps; + selectableProps?: Partial; }) { const [isPopoverOpen, setPopoverIsOpen] = useState(false); @@ -61,58 +61,56 @@ export function DataViewPicker({ }; return ( - <> - setPopoverIsOpen(false)} - display="block" - panelPaddingSize="s" - ownFocus - panelClassName="presDataViewPicker__panel" + setPopoverIsOpen(false)} + display="block" + panelPaddingSize="s" + ownFocus + panelClassName="presDataViewPicker__panel" + > + + {i18n.translate('presentationUtil.dataViewPicker.changeDataViewTitle', { + defaultMessage: 'Data view', + })} + + + {...selectableProps} + searchable + singleSelection="always" + options={dataViews.map(({ name, id, title }) => ({ + key: id, + label: name ?? title, + value: id, + 'data-test-subj': `data-view-picker-${name ?? title}`, + checked: id === selectedDataViewId ? 'on' : undefined, + }))} + onChange={(choices) => { + const choice = choices.find(({ checked }) => checked) as unknown as { + value: string; + }; + onChangeDataViewId(choice.value); + setPopoverIsOpen(false); + }} + searchProps={{ + compressed: true, + ...(selectableProps ? selectableProps.searchProps : undefined), + }} > - - {i18n.translate('presentationUtil.dataViewPicker.changeDataViewTitle', { - defaultMessage: 'Data view', - })} - - - {...selectableProps} - searchable - singleSelection="always" - options={dataViews.map(({ name, id, title }) => ({ - key: id, - label: name ?? title, - value: id, - 'data-test-subj': `data-view-picker-${name ?? title}`, - checked: id === selectedDataViewId ? 'on' : undefined, - }))} - onChange={(choices) => { - const choice = choices.find(({ checked }) => checked) as unknown as { - value: string; - }; - onChangeDataViewId(choice.value); - setPopoverIsOpen(false); - }} - searchProps={{ - compressed: true, - ...(selectableProps ? selectableProps.searchProps : undefined), - }} - > - {(list, search) => ( - <> - {search} - {list} - - )} - - - + {(list, search) => ( + <> + {search} + {list} + + )} + + ); } diff --git a/src/plugins/presentation_util/public/components/field_picker/field_picker.scss b/src/plugins/presentation_util/public/components/field_picker/field_picker.scss index bbb3e8eb44be3..cb81739118249 100644 --- a/src/plugins/presentation_util/public/components/field_picker/field_picker.scss +++ b/src/plugins/presentation_util/public/components/field_picker/field_picker.scss @@ -1,4 +1,14 @@ .presFieldPickerFieldButtonActive { background-color: transparentize($euiColorPrimary, .9); +} + +.fieldPickerSelectable { + height: $euiSizeXXL * 9; // 40 * 9 = 360px + + &.fieldPickerSelectableLoading { + .euiSelectableMessage { + height: 100%; + } + } } \ No newline at end of file diff --git a/src/plugins/presentation_util/public/components/field_picker/field_picker.tsx b/src/plugins/presentation_util/public/components/field_picker/field_picker.tsx index 3d6a42d7211a8..20605d374d0fc 100644 --- a/src/plugins/presentation_util/public/components/field_picker/field_picker.tsx +++ b/src/plugins/presentation_util/public/components/field_picker/field_picker.tsx @@ -12,7 +12,13 @@ import React, { useEffect, useMemo, useState } from 'react'; import { i18n } from '@kbn/i18n'; import { FieldIcon } from '@kbn/react-field'; -import { EuiSelectable, EuiSelectableOption, EuiSpacer } from '@elastic/eui'; +import { + EuiFormRow, + EuiSelectable, + EuiSelectableOption, + EuiSelectableProps, + EuiSpacer, +} from '@elastic/eui'; import { DataView, DataViewField } from '@kbn/data-views-plugin/common'; import { FieldTypeFilter } from './field_type_filter'; @@ -24,6 +30,7 @@ export interface FieldPickerProps { selectedFieldName?: string; filterPredicate?: (f: DataViewField) => boolean; onSelectField?: (selectedField: DataViewField) => void; + selectableProps?: Partial; } export const FieldPicker = ({ @@ -31,6 +38,7 @@ export const FieldPicker = ({ onSelectField, filterPredicate, selectedFieldName, + selectableProps, }: FieldPickerProps) => { const [typesFilter, setTypesFilter] = useState([]); const [fieldSelectableOptions, setFieldSelectableOptions] = useState([]); @@ -82,15 +90,22 @@ export const FieldPicker = ({ ); const fieldTypeFilter = ( - setTypesFilter(types)} - fieldTypesValue={typesFilter} - availableFieldTypes={uniqueTypes} - /> + + setTypesFilter(types)} + fieldTypesValue={typesFilter} + availableFieldTypes={uniqueTypes} + buttonProps={{ disabled: Boolean(selectableProps?.isLoading) }} + /> + ); return ( {(list, search) => ( <> diff --git a/src/plugins/presentation_util/public/components/field_picker/field_type_filter.tsx b/src/plugins/presentation_util/public/components/field_picker/field_type_filter.tsx index bb27137ce16c8..a17739cf8ccbd 100644 --- a/src/plugins/presentation_util/public/components/field_picker/field_type_filter.tsx +++ b/src/plugins/presentation_util/public/components/field_picker/field_type_filter.tsx @@ -18,6 +18,7 @@ import { EuiOutsideClickDetector, EuiFilterButton, EuiPopoverTitle, + EuiFilterButtonProps, } from '@elastic/eui'; import { FieldIcon } from '@kbn/react-field'; import { FormattedMessage } from '@kbn/i18n-react'; @@ -27,14 +28,15 @@ import './field_type_filter.scss'; export interface Props { onFieldTypesChange: (value: string[]) => void; fieldTypesValue: string[]; - availableFieldTypes: string[]; + buttonProps?: Partial; } export function FieldTypeFilter({ onFieldTypesChange, fieldTypesValue, availableFieldTypes, + buttonProps, }: Props) { const [isPopoverOpen, setPopoverOpen] = useState(false); @@ -44,6 +46,7 @@ export function FieldTypeFilter({ const buttonContent = ( 0} @@ -61,7 +64,7 @@ export function FieldTypeFilter({ return ( {}} isDisabled={!isPopoverOpen}> - + ; refreshInterval?: RefreshInterval; rowsPerPage?: number; diff --git a/src/plugins/saved_search/public/services/saved_searches/saved_searches_utils.ts b/src/plugins/saved_search/public/services/saved_searches/saved_searches_utils.ts index 3a05572935281..fe15f630318c1 100644 --- a/src/plugins/saved_search/public/services/saved_searches/saved_searches_utils.ts +++ b/src/plugins/saved_search/public/services/saved_searches/saved_searches_utils.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ import { i18n } from '@kbn/i18n'; +import { pick } from 'lodash'; import type { SavedSearchAttributes } from '../../../common'; import { fromSavedSearchAttributes as fromSavedSearchAttributesCommon } from '../../../common'; import type { SavedSearch } from './types'; @@ -54,7 +55,7 @@ export const toSavedSearchAttributes = ( isTextBasedQuery: savedSearch.isTextBasedQuery ?? false, usesAdHocDataView: savedSearch.usesAdHocDataView, timeRestore: savedSearch.timeRestore ?? false, - timeRange: savedSearch.timeRange, + timeRange: savedSearch.timeRange ? pick(savedSearch.timeRange, ['from', 'to']) : undefined, refreshInterval: savedSearch.refreshInterval, rowsPerPage: savedSearch.rowsPerPage, breakdownField: savedSearch.breakdownField, diff --git a/src/plugins/saved_search/server/saved_objects/search.ts b/src/plugins/saved_search/server/saved_objects/search.ts index 83923df21480f..6995442737b36 100644 --- a/src/plugins/saved_search/server/saved_objects/search.ts +++ b/src/plugins/saved_search/server/saved_objects/search.ts @@ -6,8 +6,10 @@ * Side Public License, v 1. */ +import { schema } from '@kbn/config-schema'; import { SavedObjectsType } from '@kbn/core/server'; import { MigrateFunctionsObject } from '@kbn/kibana-utils-plugin/common'; +import { VIEW_MODE } from '../../common'; import { getAllMigrations } from './search_migrations'; export function getSavedSearchObjectType( @@ -33,44 +35,83 @@ export function getSavedSearchObjectType( }, }, mappings: { + dynamic: false, properties: { - columns: { type: 'keyword', index: false, doc_values: false }, - description: { type: 'text' }, - viewMode: { type: 'keyword', index: false, doc_values: false }, - hideChart: { type: 'boolean', index: false, doc_values: false }, - isTextBasedQuery: { type: 'boolean', index: false, doc_values: false }, - usesAdHocDataView: { type: 'boolean', index: false, doc_values: false }, - hideAggregatedPreview: { type: 'boolean', index: false, doc_values: false }, - hits: { type: 'integer', index: false, doc_values: false }, - kibanaSavedObjectMeta: { - properties: { - searchSourceJSON: { type: 'text', index: false }, - }, - }, - sort: { type: 'keyword', index: false, doc_values: false }, title: { type: 'text' }, - grid: { dynamic: false, properties: {} }, - version: { type: 'integer' }, - rowHeight: { type: 'text' }, - timeRestore: { type: 'boolean', index: false, doc_values: false }, - timeRange: { - dynamic: false, - properties: { - from: { type: 'keyword', index: false, doc_values: false }, - to: { type: 'keyword', index: false, doc_values: false }, - }, - }, - refreshInterval: { - dynamic: false, - properties: { - pause: { type: 'boolean', index: false, doc_values: false }, - value: { type: 'integer', index: false, doc_values: false }, - }, - }, - rowsPerPage: { type: 'integer', index: false, doc_values: false }, - breakdownField: { type: 'text' }, + description: { type: 'text' }, }, }, + schemas: { + '8.8.0': schema.object({ + // General + title: schema.string(), + description: schema.string({ defaultValue: '' }), + + // Data grid + columns: schema.arrayOf(schema.string(), { defaultValue: [] }), + sort: schema.oneOf( + [ + schema.arrayOf(schema.arrayOf(schema.string(), { minSize: 2, maxSize: 2 })), + schema.arrayOf(schema.string(), { minSize: 2, maxSize: 2 }), + ], + { defaultValue: [] } + ), + grid: schema.object( + { + columns: schema.maybe( + schema.recordOf( + schema.string(), + schema.object({ + width: schema.maybe(schema.number()), + }) + ) + ), + }, + { defaultValue: {} } + ), + rowHeight: schema.maybe(schema.number()), + rowsPerPage: schema.maybe(schema.number()), + + // Chart + hideChart: schema.boolean({ defaultValue: false }), + breakdownField: schema.maybe(schema.string()), + + // Search + kibanaSavedObjectMeta: schema.object({ + searchSourceJSON: schema.string(), + }), + isTextBasedQuery: schema.boolean({ defaultValue: false }), + usesAdHocDataView: schema.maybe(schema.boolean()), + + // Time + timeRestore: schema.maybe(schema.boolean()), + timeRange: schema.maybe( + schema.object({ + from: schema.string(), + to: schema.string(), + }) + ), + refreshInterval: schema.maybe( + schema.object({ + pause: schema.boolean(), + value: schema.number(), + }) + ), + + // Display + viewMode: schema.maybe( + schema.oneOf([ + schema.literal(VIEW_MODE.DOCUMENT_LEVEL), + schema.literal(VIEW_MODE.AGGREGATED_LEVEL), + ]) + ), + hideAggregatedPreview: schema.maybe(schema.boolean()), + + // Legacy + hits: schema.maybe(schema.number()), + version: schema.maybe(schema.number()), + }), + }, migrations: () => getAllMigrations(getSearchSourceMigrations()), }; } diff --git a/src/plugins/saved_search/tsconfig.json b/src/plugins/saved_search/tsconfig.json index 286b11f97c36e..cf6225bf1f223 100644 --- a/src/plugins/saved_search/tsconfig.json +++ b/src/plugins/saved_search/tsconfig.json @@ -16,6 +16,7 @@ "@kbn/spaces-plugin", "@kbn/saved-objects-tagging-oss-plugin", "@kbn/i18n", + "@kbn/config-schema", ], "exclude": [ "target/**/*", diff --git a/src/plugins/unified_field_list/common/utils/field_stats_utils.ts b/src/plugins/unified_field_list/common/utils/field_stats_utils.ts index ddda8de350e6b..aae9dcaa03692 100644 --- a/src/plugins/unified_field_list/common/utils/field_stats_utils.ts +++ b/src/plugins/unified_field_list/common/utils/field_stats_utils.ts @@ -145,7 +145,8 @@ function canProvideAggregatedStatsForField(field: DataViewField): boolean { field.type === 'geo_point' || field.type === 'geo_shape' || field.type === 'murmur3' || - field.type === 'attachment' + field.type === 'attachment' || + field.timeSeriesMetric === 'counter' ); } diff --git a/src/plugins/unified_histogram/README.md b/src/plugins/unified_histogram/README.md index 459eb88aa6610..229af7851d8a3 100755 --- a/src/plugins/unified_histogram/README.md +++ b/src/plugins/unified_histogram/README.md @@ -3,13 +3,68 @@ Unified Histogram is a UX Building Block including a layout with a resizable histogram and a main display. It manages its own state and data fetching, and can easily be dropped into pages with minimal setup. -## Example +## Basic Usage + +```tsx +// Import the container component +import { + UnifiedHistogramContainer, +} from '@kbn/unified-histogram-plugin/public'; + +// Import modules required for your application +import { + useServices, + useResizeRef, + useRequestParams, + MyLayout, + MyButton, +} from './my-modules'; + +const services = useServices(); +const resizeRef = useResizeRef(); +const { + dataView, + query, + filters, + timeRange, + relativeTimeRange, + searchSessionId, + requestAdapter, +} = useRequestParams(); + +return ( + } + > + + +); +``` + +## Advanced Usage ```tsx // Import the container component and API contract import { UnifiedHistogramContainer, - type UnifiedHistogramInitializedApi, + type UnifiedHistogramApi, } from '@kbn/unified-histogram-plugin/public'; // Import modules required for your application @@ -18,6 +73,7 @@ import { useResizeRef, useCallbacks, useRequestParams, + useStateParams, useManualRefetch, MyLayout, MyButton, @@ -26,75 +82,48 @@ import { const services = useServices(); const resizeRef = useResizeRef(); const { onChartHiddenChange, onLensRequestAdapterChange } = useCallbacks(); +const { chartHidden, breakdownField } = useStateParams(); const { dataView, query, filters, timeRange, + relativeTimeRange, searchSessionId, requestAdapter, } = useRequestParams(); // Use a state variable instead of a ref to preserve reactivity when the API is updated -const [unifiedHistogram, setUnifiedHistogram] = useState(); - -// Create a callback to set unifiedHistogram, and initialize it if needed -const setUnifiedHistogramApi = useCallback((api: UnifiedHistogramApi | null) => { - // Ignore if the ref is null - if (!api) { - return; - } - - if (api.initialized) { - // Update our local reference to the API - setUnifiedHistogram(api); - } else { - // Initialize if not yet initialized - api.initialize({ - // Pass the required services to Unified Histogram - services, - // Optionally provide a local storage key prefix to save parts of the state, - // such as the chart hidden state and top panel height, to local storage - localStorageKeyPrefix: 'myApp', - // By default Unified Histogram will automatically refetch based on certain - // state changes, such as chart hidden and request params, but this can be - // disabled in favour of manual fetching if preferred. Note that an initial - // request is always triggered when first initialized, and when the chart - // changes from hidden to visible, Lens will automatically trigger a refetch - // regardless of what this property is set to - disableAutoFetching: true, - // If passing an absolute time range, provide a function to get the relative range - getRelativeTimeRange: services.data.query.timefilter.timefilter.getTime, - // At minimum the initial state requires a data view, but additional - // parameters can be passed to further customize the state - initialState: { - dataView, - query, - filters, - timeRange, - searchSessionId, - requestAdapter, - }, - }); - } -}, [...]); +const [unifiedHistogram, setUnifiedHistogram] = useState(); + +const getCreationOptions = useCallback(() => ({ + // Optionally provide a local storage key prefix to save parts of the state, + // such as the chart hidden state and top panel height, to local storage + localStorageKeyPrefix: 'myApp', + // By default Unified Histogram will automatically refetch based on certain + // state changes, such as chart hidden and request params, but this can be + // disabled in favour of manual fetching if preferred. Note that an initial + // request is always triggered when first initialized, and when the chart + // changes from hidden to visible, Lens will automatically trigger a refetch + // regardless of what this property is set to + disableAutoFetching: true, + // Customize the initial state in order to override the defaults + initialState: { chartHidden, breakdownField }, +}), [...]); // Manually refetch if disableAutoFetching is true useManualRefetch(() => { unifiedHistogram?.refetch(); }); -// Update the Unified Histogram state when our request params change +// Update the Unified Histogram state when our state params change useEffect(() => { - unifiedHistogram?.setRequestParams({ - dataView, - query, - filters, - timeRange, - searchSessionId, - requestAdapter, - }); -}, [...]); + unifiedHistogram?.setChartHidden(chartHidden); +}, [chartHidden]); + +useEffect(() => { + unifiedHistogram?.setBreakdownField(breakdownField); +}, [breakdownField]); // Listen for state changes if your application requires it useEffect(() => { @@ -124,12 +153,18 @@ useEffect(() => { return ( } > diff --git a/src/plugins/unified_histogram/public/chart/chart.tsx b/src/plugins/unified_histogram/public/chart/chart.tsx index 038c7c696ddf8..3c959776df2a5 100644 --- a/src/plugins/unified_histogram/public/chart/chart.tsx +++ b/src/plugins/unified_histogram/public/chart/chart.tsx @@ -56,6 +56,7 @@ export interface ChartProps { currentSuggestion?: Suggestion; allSuggestions?: Suggestion[]; timeRange?: TimeRange; + relativeTimeRange?: TimeRange; request?: UnifiedHistogramRequestContext; hits?: UnifiedHistogramHitsContext; chart?: UnifiedHistogramChartContext; @@ -66,7 +67,6 @@ export interface ChartProps { disableTriggers?: LensEmbeddableInput['disableTriggers']; disabledActions?: LensEmbeddableInput['disabledActions']; input$?: UnifiedHistogramInput$; - getRelativeTimeRange?: () => TimeRange; onResetChartHeight?: () => void; onChartHiddenChange?: (chartHidden: boolean) => void; onTimeIntervalChange?: (timeInterval: string) => void; @@ -87,6 +87,7 @@ export function Chart({ query: originalQuery, filters: originalFilters, timeRange: originalTimeRange, + relativeTimeRange: originalRelativeTimeRange, request, hits, chart, @@ -100,7 +101,6 @@ export function Chart({ disableTriggers, disabledActions, input$: originalInput$, - getRelativeTimeRange: originalGetRelativeTimeRange, onResetChartHeight, onChartHiddenChange, onTimeIntervalChange, @@ -214,15 +214,10 @@ export function Chart({ ] ); - const getRelativeTimeRange = useMemo( - () => originalGetRelativeTimeRange ?? (() => relativeTimeRange), - [originalGetRelativeTimeRange, relativeTimeRange] - ); - const onEditVisualization = useEditVisualization({ services, dataView, - getRelativeTimeRange, + relativeTimeRange: originalRelativeTimeRange ?? relativeTimeRange, lensAttributes, }); diff --git a/src/plugins/unified_histogram/public/chart/hooks/use_edit_visualization.test.ts b/src/plugins/unified_histogram/public/chart/hooks/use_edit_visualization.test.ts index 1d92db77dc376..8bd9e9161c837 100644 --- a/src/plugins/unified_histogram/public/chart/hooks/use_edit_visualization.test.ts +++ b/src/plugins/unified_histogram/public/chart/hooks/use_edit_visualization.test.ts @@ -39,7 +39,7 @@ describe('useEditVisualization', () => { useEditVisualization({ services: unifiedHistogramServicesMock, dataView: dataViewWithTimefieldMock, - getRelativeTimeRange: () => relativeTimeRange, + relativeTimeRange, lensAttributes, }) ); @@ -59,7 +59,7 @@ describe('useEditVisualization', () => { useEditVisualization({ services: unifiedHistogramServicesMock, dataView: { ...dataViewWithTimefieldMock, id: undefined } as DataView, - getRelativeTimeRange: () => ({ from: 'now-15m', to: 'now' }), + relativeTimeRange: { from: 'now-15m', to: 'now' }, lensAttributes: {} as unknown as TypedLensByValueInput['attributes'], }) ); @@ -73,7 +73,7 @@ describe('useEditVisualization', () => { useEditVisualization({ services: unifiedHistogramServicesMock, dataView: dataViewMock, - getRelativeTimeRange: () => ({ from: 'now-15m', to: 'now' }), + relativeTimeRange: { from: 'now-15m', to: 'now' }, lensAttributes: {} as unknown as TypedLensByValueInput['attributes'], }) ); @@ -93,7 +93,7 @@ describe('useEditVisualization', () => { useEditVisualization({ services: unifiedHistogramServicesMock, dataView, - getRelativeTimeRange: () => ({ from: 'now-15m', to: 'now' }), + relativeTimeRange: { from: 'now-15m', to: 'now' }, lensAttributes: {} as unknown as TypedLensByValueInput['attributes'], }) ); @@ -107,7 +107,7 @@ describe('useEditVisualization', () => { useEditVisualization({ services: unifiedHistogramServicesMock, dataView: dataViewWithTimefieldMock, - getRelativeTimeRange: () => ({ from: 'now-15m', to: 'now' }), + relativeTimeRange: { from: 'now-15m', to: 'now' }, lensAttributes: {} as unknown as TypedLensByValueInput['attributes'], }) ); diff --git a/src/plugins/unified_histogram/public/chart/hooks/use_edit_visualization.ts b/src/plugins/unified_histogram/public/chart/hooks/use_edit_visualization.ts index ba72f5bc9264e..c1b1f899ae756 100644 --- a/src/plugins/unified_histogram/public/chart/hooks/use_edit_visualization.ts +++ b/src/plugins/unified_histogram/public/chart/hooks/use_edit_visualization.ts @@ -19,12 +19,12 @@ const visualizeFieldTrigger: typeof VISUALIZE_FIELD_TRIGGER = 'VISUALIZE_FIELD_T export const useEditVisualization = ({ services, dataView, - getRelativeTimeRange, + relativeTimeRange, lensAttributes, }: { services: UnifiedHistogramServices; dataView: DataView; - getRelativeTimeRange: () => TimeRange; + relativeTimeRange?: TimeRange; lensAttributes: TypedLensByValueInput['attributes']; }) => { const [canVisualize, setCanVisualize] = useState(false); @@ -53,11 +53,11 @@ export const useEditVisualization = ({ return () => { services.lens.navigateToPrefilledEditor({ id: '', - timeRange: getRelativeTimeRange(), + timeRange: relativeTimeRange, attributes: lensAttributes, }); }; - }, [canVisualize, getRelativeTimeRange, lensAttributes, services.lens]); + }, [canVisualize, lensAttributes, relativeTimeRange, services.lens]); useEffect(() => { checkCanVisualize().then(setCanVisualize); diff --git a/src/plugins/unified_histogram/public/container/container.test.tsx b/src/plugins/unified_histogram/public/container/container.test.tsx index 1745769528851..ea6ef95db55fa 100644 --- a/src/plugins/unified_histogram/public/container/container.test.tsx +++ b/src/plugins/unified_histogram/public/container/container.test.tsx @@ -10,79 +10,70 @@ import { RequestAdapter } from '@kbn/inspector-plugin/common'; import { mountWithIntl } from '@kbn/test-jest-helpers'; import React from 'react'; import { act } from 'react-dom/test-utils'; -import { UnifiedHistogramFetchStatus } from '../types'; +import { UnifiedHistogramLayout } from '../layout'; import { dataViewWithTimefieldMock } from '../__mocks__/data_view_with_timefield'; import { unifiedHistogramServicesMock } from '../__mocks__/services'; import { UnifiedHistogramApi, UnifiedHistogramContainer } from './container'; -import type { UnifiedHistogramState } from './services/state_service'; describe('UnifiedHistogramContainer', () => { - const initialState: UnifiedHistogramState = { - breakdownField: 'bytes', - chartHidden: false, - dataView: dataViewWithTimefieldMock, - filters: [], - lensRequestAdapter: new RequestAdapter(), - query: { language: 'kuery', query: '' }, - requestAdapter: new RequestAdapter(), - searchSessionId: '123', - timeInterval: 'auto', - timeRange: { from: 'now-15m', to: 'now' }, - topPanelHeight: 100, - totalHitsStatus: UnifiedHistogramFetchStatus.uninitialized, - totalHitsResult: undefined, - columns: [], - currentSuggestion: undefined, - }; - - it('should set ref', () => { + it('should initialize', async () => { let api: UnifiedHistogramApi | undefined; const setApi = (ref: UnifiedHistogramApi) => { api = ref; }; - mountWithIntl(); - expect(api).toBeDefined(); - }); - - it('should return null if not initialized', async () => { - const component = mountWithIntl(); - await new Promise((resolve) => setTimeout(resolve, 0)); - expect(component.update().isEmptyRender()).toBe(true); - }); - - it('should not return null if initialized', async () => { - const setApi = (api: UnifiedHistogramApi | null) => { - if (!api || api.initialized) { - return; - } - api?.initialize({ - services: unifiedHistogramServicesMock, - initialState, - }); - }; + const getCreationOptions = jest.fn(() => ({ initialState: { timeInterval: '42s' } })); const component = mountWithIntl( - + ); + expect(component.update().isEmptyRender()).toBe(true); await act(() => new Promise((resolve) => setTimeout(resolve, 0))); + component.update(); + expect(getCreationOptions).toHaveBeenCalled(); + expect(component.find(UnifiedHistogramLayout).prop('chart')?.timeInterval).toBe('42s'); expect(component.update().isEmptyRender()).toBe(false); + expect(api).toBeDefined(); }); - it('should update initialized property when initialized', async () => { + it('should trigger input$ when refetch is called', async () => { let api: UnifiedHistogramApi | undefined; const setApi = (ref: UnifiedHistogramApi) => { api = ref; }; - mountWithIntl(); - expect(api?.initialized).toBe(false); + const getCreationOptions = jest.fn(() => ({ disableAutoFetching: true })); + const component = mountWithIntl( + + ); + await act(() => new Promise((resolve) => setTimeout(resolve, 0))); + component.update(); + const input$ = component.find(UnifiedHistogramLayout).prop('input$'); + const inputSpy = jest.fn(); + input$?.subscribe(inputSpy); act(() => { - if (!api?.initialized) { - api?.initialize({ - services: unifiedHistogramServicesMock, - initialState, - }); - } + api?.refetch(); }); - await act(() => new Promise((resolve) => setTimeout(resolve, 0))); - expect(api?.initialized).toBe(true); + expect(inputSpy).toHaveBeenCalledTimes(1); + expect(inputSpy).toHaveBeenCalledWith({ type: 'refetch' }); }); }); diff --git a/src/plugins/unified_histogram/public/container/container.tsx b/src/plugins/unified_histogram/public/container/container.tsx index 3bfc7c5d69a57..0633e9d710966 100644 --- a/src/plugins/unified_histogram/public/container/container.tsx +++ b/src/plugins/unified_histogram/public/container/container.tsx @@ -6,12 +6,13 @@ * Side Public License, v 1. */ -import React, { forwardRef, useImperativeHandle, useMemo, useState } from 'react'; +import React, { forwardRef, useEffect, useImperativeHandle, useState } from 'react'; import { Subject } from 'rxjs'; import { pick } from 'lodash'; +import useMount from 'react-use/lib/useMount'; import { LensSuggestionsApi } from '@kbn/lens-plugin/public'; import { UnifiedHistogramLayout, UnifiedHistogramLayoutProps } from '../layout'; -import type { UnifiedHistogramInputMessage } from '../types'; +import type { UnifiedHistogramInputMessage, UnifiedHistogramRequestContext } from '../types'; import { createStateService, UnifiedHistogramStateOptions, @@ -19,61 +20,47 @@ import { } from './services/state_service'; import { useStateProps } from './hooks/use_state_props'; import { useStateSelector } from './utils/use_state_selector'; -import { - columnsSelector, - currentSuggestionSelector, - dataViewSelector, - filtersSelector, - querySelector, - timeRangeSelector, - topPanelHeightSelector, -} from './utils/state_selectors'; +import { topPanelHeightSelector, currentSuggestionSelector } from './utils/state_selectors'; type LayoutProps = Pick< UnifiedHistogramLayoutProps, - | 'services' - | 'disableAutoFetching' - | 'disableTriggers' - | 'disabledActions' - | 'getRelativeTimeRange' ->; - -/** - * The props exposed by the container - */ -export type UnifiedHistogramContainerProps = Pick< - UnifiedHistogramLayoutProps, - 'className' | 'resizeRef' | 'appendHitsCounter' | 'children' + 'disableAutoFetching' | 'disableTriggers' | 'disabledActions' >; /** * The options used to initialize the container */ -export type UnifiedHistogramInitializeOptions = UnifiedHistogramStateOptions & - Omit; +export type UnifiedHistogramCreationOptions = Omit & + LayoutProps; /** - * The uninitialized API exposed by the container + * The props exposed by the container */ -export interface UnifiedHistogramUninitializedApi { - /** - * Whether the container has been initialized - */ - initialized: false; - /** - * Initialize the container - */ - initialize: (options: UnifiedHistogramInitializeOptions) => void; -} +export type UnifiedHistogramContainerProps = { + getCreationOptions?: () => + | UnifiedHistogramCreationOptions + | Promise; + searchSessionId?: UnifiedHistogramRequestContext['searchSessionId']; + requestAdapter?: UnifiedHistogramRequestContext['adapter']; +} & Pick< + UnifiedHistogramLayoutProps, + | 'services' + | 'className' + | 'dataView' + | 'query' + | 'filters' + | 'timeRange' + | 'relativeTimeRange' + | 'columns' + | 'resizeRef' + | 'appendHitsCounter' + | 'children' +>; /** - * The initialized API exposed by the container + * The API exposed by the container */ -export type UnifiedHistogramInitializedApi = { - /** - * Whether the container has been initialized - */ - initialized: true; +export type UnifiedHistogramApi = { /** * Manually trigger a refetch of the data */ @@ -84,86 +71,69 @@ export type UnifiedHistogramInitializedApi = { | 'setChartHidden' | 'setTopPanelHeight' | 'setBreakdownField' - | 'setColumns' | 'setTimeInterval' - | 'setRequestParams' | 'setTotalHits' >; -/** - * The API exposed by the container - */ -export type UnifiedHistogramApi = UnifiedHistogramUninitializedApi | UnifiedHistogramInitializedApi; - export const UnifiedHistogramContainer = forwardRef< UnifiedHistogramApi, UnifiedHistogramContainerProps >((containerProps, ref) => { - const [initialized, setInitialized] = useState(false); const [layoutProps, setLayoutProps] = useState(); const [stateService, setStateService] = useState(); const [lensSuggestionsApi, setLensSuggestionsApi] = useState(); const [input$] = useState(() => new Subject()); - const api = useMemo( - () => ({ - initialized, - initialize: (options: UnifiedHistogramInitializeOptions) => { - const { - services, - disableAutoFetching, - disableTriggers, - disabledActions, - getRelativeTimeRange, - } = options; + const [api, setApi] = useState(); - // API helpers are loaded async from Lens - (async () => { - const apiHelper = await services.lens.stateHelperApi(); - setLensSuggestionsApi(() => apiHelper.suggestions); - })(); + // Expose the API to the parent component + useImperativeHandle(ref, () => api!, [api]); - setLayoutProps({ - services, - disableAutoFetching, - disableTriggers, - disabledActions, - getRelativeTimeRange, - }); - setStateService(createStateService(options)); - setInitialized(true); - }, + // Call for creation options once the container is mounted + useMount(async () => { + const { getCreationOptions, services } = containerProps; + const options = await getCreationOptions?.(); + const apiHelper = await services.lens.stateHelperApi(); + + setLayoutProps(pick(options, 'disableAutoFetching', 'disableTriggers', 'disabledActions')); + setStateService(createStateService({ services, ...options })); + setLensSuggestionsApi(() => apiHelper.suggestions); + }); + + // Initialize the API once the state service is available + useEffect(() => { + if (!stateService) { + return; + } + + setApi({ refetch: () => { input$.next({ type: 'refetch' }); }, ...pick( - stateService!, + stateService, 'state$', 'setChartHidden', 'setTopPanelHeight', 'setBreakdownField', - 'setColumns', 'setTimeInterval', - 'setRequestParams', 'setTotalHits' ), - }), - [initialized, input$, stateService] - ); - - // Expose the API to the parent component - useImperativeHandle(ref, () => api, [api]); + }); + }, [input$, stateService]); - const stateProps = useStateProps(stateService); - const dataView = useStateSelector(stateService?.state$, dataViewSelector); - const query = useStateSelector(stateService?.state$, querySelector); - const filters = useStateSelector(stateService?.state$, filtersSelector); - const timeRange = useStateSelector(stateService?.state$, timeRangeSelector); - const columns = useStateSelector(stateService?.state$, columnsSelector); + const { dataView, query, searchSessionId, requestAdapter } = containerProps; const currentSuggestion = useStateSelector(stateService?.state$, currentSuggestionSelector); const topPanelHeight = useStateSelector(stateService?.state$, topPanelHeightSelector); + const stateProps = useStateProps({ + stateService, + dataView, + query, + searchSessionId, + requestAdapter, + }); // Don't render anything until the container is initialized - if (!layoutProps || !dataView || !lensSuggestionsApi) { + if (!layoutProps || !lensSuggestionsApi || !api) { return null; } @@ -172,11 +142,6 @@ export const UnifiedHistogramContainer = forwardRef< {...containerProps} {...layoutProps} {...stateProps} - dataView={dataView} - query={query} - filters={filters} - timeRange={timeRange} - columns={columns} currentSuggestion={currentSuggestion} topPanelHeight={topPanelHeight} input$={input$} diff --git a/src/plugins/unified_histogram/public/container/hooks/use_state_props.test.ts b/src/plugins/unified_histogram/public/container/hooks/use_state_props.test.ts index fea0813119136..fcdd194410db0 100644 --- a/src/plugins/unified_histogram/public/container/hooks/use_state_props.test.ts +++ b/src/plugins/unified_histogram/public/container/hooks/use_state_props.test.ts @@ -27,18 +27,11 @@ describe('useStateProps', () => { const initialState: UnifiedHistogramState = { breakdownField: 'bytes', chartHidden: false, - dataView: dataViewWithTimefieldMock, - filters: [], lensRequestAdapter: new RequestAdapter(), - query: { language: 'kuery', query: '' }, - requestAdapter: new RequestAdapter(), - searchSessionId: '123', timeInterval: 'auto', - timeRange: { from: 'now-15m', to: 'now' }, topPanelHeight: 100, totalHitsStatus: UnifiedHistogramFetchStatus.uninitialized, totalHitsResult: undefined, - columns: [], currentSuggestion: undefined, }; @@ -51,7 +44,6 @@ describe('useStateProps', () => { jest.spyOn(stateService, 'setTopPanelHeight'); jest.spyOn(stateService, 'setBreakdownField'); jest.spyOn(stateService, 'setTimeInterval'); - jest.spyOn(stateService, 'setRequestParams'); jest.spyOn(stateService, 'setLensRequestAdapter'); jest.spyOn(stateService, 'setTotalHits'); jest.spyOn(stateService, 'setCurrentSuggestion'); @@ -60,7 +52,15 @@ describe('useStateProps', () => { it('should return the correct props', () => { const stateService = getStateService({ initialState }); - const { result } = renderHook(() => useStateProps(stateService)); + const { result } = renderHook(() => + useStateProps({ + stateService, + dataView: dataViewWithTimefieldMock, + query: { language: 'kuery', query: '' }, + requestAdapter: new RequestAdapter(), + searchSessionId: '123', + }) + ); expect(result.current).toMatchInlineSnapshot(` Object { "breakdown": Object { @@ -104,10 +104,16 @@ describe('useStateProps', () => { }); it('should return the correct props when an SQL query is used', () => { - const stateService = getStateService({ - initialState: { ...initialState, query: { sql: 'SELECT * FROM index' } }, - }); - const { result } = renderHook(() => useStateProps(stateService)); + const stateService = getStateService({ initialState }); + const { result } = renderHook(() => + useStateProps({ + stateService, + dataView: dataViewWithTimefieldMock, + query: { sql: 'SELECT * FROM index' }, + requestAdapter: new RequestAdapter(), + searchSessionId: '123', + }) + ); expect(result.current).toMatchInlineSnapshot(` Object { "breakdown": undefined, @@ -145,27 +151,37 @@ describe('useStateProps', () => { const stateService = getStateService({ initialState: { ...initialState, - query: { sql: 'SELECT * FROM index' }, currentSuggestion: currentSuggestionMock, }, }); - const { result } = renderHook(() => useStateProps(stateService)); + const { result } = renderHook(() => + useStateProps({ + stateService, + dataView: dataViewWithTimefieldMock, + query: { sql: 'SELECT * FROM index' }, + requestAdapter: new RequestAdapter(), + searchSessionId: '123', + }) + ); expect(result.current.chart).toStrictEqual({ hidden: false, timeInterval: 'auto' }); expect(result.current.breakdown).toBe(undefined); expect(result.current.isPlainRecord).toBe(true); }); it('should return the correct props when a rollup data view is used', () => { - const stateService = getStateService({ - initialState: { - ...initialState, + const stateService = getStateService({ initialState }); + const { result } = renderHook(() => + useStateProps({ + stateService, dataView: { ...dataViewWithTimefieldMock, type: DataViewType.ROLLUP, } as DataView, - }, - }); - const { result } = renderHook(() => useStateProps(stateService)); + query: { language: 'kuery', query: '' }, + requestAdapter: new RequestAdapter(), + searchSessionId: '123', + }) + ); expect(result.current).toMatchInlineSnapshot(` Object { "breakdown": undefined, @@ -197,10 +213,16 @@ describe('useStateProps', () => { }); it('should return the correct props when a non time based data view is used', () => { - const stateService = getStateService({ - initialState: { ...initialState, dataView: dataViewMock }, - }); - const { result } = renderHook(() => useStateProps(stateService)); + const stateService = getStateService({ initialState }); + const { result } = renderHook(() => + useStateProps({ + stateService, + dataView: dataViewMock, + query: { language: 'kuery', query: '' }, + requestAdapter: new RequestAdapter(), + searchSessionId: '123', + }) + ); expect(result.current).toMatchInlineSnapshot(` Object { "breakdown": undefined, @@ -233,7 +255,15 @@ describe('useStateProps', () => { it('should execute callbacks correctly', () => { const stateService = getStateService({ initialState }); - const { result } = renderHook(() => useStateProps(stateService)); + const { result } = renderHook(() => + useStateProps({ + stateService, + dataView: dataViewWithTimefieldMock, + query: { language: 'kuery', query: '' }, + requestAdapter: new RequestAdapter(), + searchSessionId: '123', + }) + ); const { onTopPanelHeightChange, onTimeIntervalChange, @@ -280,7 +310,15 @@ describe('useStateProps', () => { it('should clear lensRequestAdapter when chart is hidden', () => { const stateService = getStateService({ initialState }); - const hook = renderHook(() => useStateProps(stateService)); + const hook = renderHook(() => + useStateProps({ + stateService, + dataView: dataViewWithTimefieldMock, + query: { language: 'kuery', query: '' }, + requestAdapter: new RequestAdapter(), + searchSessionId: '123', + }) + ); (stateService.setLensRequestAdapter as jest.Mock).mockClear(); expect(stateService.setLensRequestAdapter).not.toHaveBeenCalled(); act(() => { @@ -292,13 +330,22 @@ describe('useStateProps', () => { it('should clear lensRequestAdapter when chart is undefined', () => { const stateService = getStateService({ initialState }); - const hook = renderHook(() => useStateProps(stateService)); + const initialProps = { + stateService, + dataView: dataViewWithTimefieldMock, + query: { language: 'kuery', query: '' }, + requestAdapter: new RequestAdapter(), + searchSessionId: '123', + }; + const hook = renderHook((props: Parameters[0]) => useStateProps(props), { + initialProps, + }); (stateService.setLensRequestAdapter as jest.Mock).mockClear(); expect(stateService.setLensRequestAdapter).not.toHaveBeenCalled(); - act(() => { - stateService.setRequestParams({ dataView: dataViewMock }); + hook.rerender({ + ...initialProps, + dataView: dataViewMock, }); - hook.rerender(); expect(stateService.setLensRequestAdapter).toHaveBeenLastCalledWith(undefined); }); }); diff --git a/src/plugins/unified_histogram/public/container/hooks/use_state_props.ts b/src/plugins/unified_histogram/public/container/hooks/use_state_props.ts index 8b63b6d91dd62..b9c4570cdecb9 100644 --- a/src/plugins/unified_histogram/public/container/hooks/use_state_props.ts +++ b/src/plugins/unified_histogram/public/container/hooks/use_state_props.ts @@ -6,31 +6,41 @@ * Side Public License, v 1. */ -import { DataViewField, DataViewType } from '@kbn/data-views-plugin/common'; -import { getAggregateQueryMode, isOfAggregateQueryType } from '@kbn/es-query'; +import { DataView, DataViewField, DataViewType } from '@kbn/data-views-plugin/common'; +import { + AggregateQuery, + getAggregateQueryMode, + isOfAggregateQueryType, + Query, +} from '@kbn/es-query'; +import type { RequestAdapter } from '@kbn/inspector-plugin/public'; import { useCallback, useEffect, useMemo } from 'react'; import { UnifiedHistogramChartLoadEvent, UnifiedHistogramFetchStatus } from '../../types'; import type { UnifiedHistogramStateService } from '../services/state_service'; import { breakdownFieldSelector, chartHiddenSelector, - dataViewSelector, - querySelector, - requestAdapterSelector, - searchSessionIdSelector, timeIntervalSelector, totalHitsResultSelector, totalHitsStatusSelector, } from '../utils/state_selectors'; import { useStateSelector } from '../utils/use_state_selector'; -export const useStateProps = (stateService: UnifiedHistogramStateService | undefined) => { +export const useStateProps = ({ + stateService, + dataView, + query, + searchSessionId, + requestAdapter, +}: { + stateService: UnifiedHistogramStateService | undefined; + dataView: DataView; + query: Query | AggregateQuery | undefined; + searchSessionId: string | undefined; + requestAdapter: RequestAdapter | undefined; +}) => { const breakdownField = useStateSelector(stateService?.state$, breakdownFieldSelector); const chartHidden = useStateSelector(stateService?.state$, chartHiddenSelector); - const dataView = useStateSelector(stateService?.state$, dataViewSelector); - const query = useStateSelector(stateService?.state$, querySelector); - const requestAdapter = useStateSelector(stateService?.state$, requestAdapterSelector); - const searchSessionId = useStateSelector(stateService?.state$, searchSessionIdSelector); const timeInterval = useStateSelector(stateService?.state$, timeIntervalSelector); const totalHitsResult = useStateSelector(stateService?.state$, totalHitsResultSelector); const totalHitsStatus = useStateSelector(stateService?.state$, totalHitsStatusSelector); diff --git a/src/plugins/unified_histogram/public/container/index.tsx b/src/plugins/unified_histogram/public/container/index.tsx index f692401c4fdbf..0110d8f099ae1 100644 --- a/src/plugins/unified_histogram/public/container/index.tsx +++ b/src/plugins/unified_histogram/public/container/index.tsx @@ -9,13 +9,12 @@ import { EuiDelayRender, EuiFlexGroup, EuiLoadingSpinner } from '@elastic/eui'; import { withSuspense } from '@kbn/shared-ux-utility'; import React, { lazy } from 'react'; +import type { UnifiedHistogramApi, UnifiedHistogramContainerProps } from './container'; export type { - UnifiedHistogramUninitializedApi, - UnifiedHistogramInitializedApi, UnifiedHistogramApi, UnifiedHistogramContainerProps, - UnifiedHistogramInitializeOptions, + UnifiedHistogramCreationOptions, } from './container'; export type { UnifiedHistogramState, UnifiedHistogramStateOptions } from './services/state_service'; export { @@ -32,10 +31,11 @@ const LazyUnifiedHistogramContainer = lazy(() => import('./container')); /** * A resizable layout component with two panels that renders a histogram with a hits * counter in the top panel, and a main display (data table, etc.) in the bottom panel. - * If all context props are left undefined, the layout will render in a single panel - * mode including only the main display. */ -export const UnifiedHistogramContainer = withSuspense( +export const UnifiedHistogramContainer = withSuspense< + UnifiedHistogramContainerProps, + UnifiedHistogramApi +>( LazyUnifiedHistogramContainer, { const initialState: UnifiedHistogramState = { breakdownField: 'bytes', chartHidden: false, - dataView: dataViewWithTimefieldMock, - filters: [], lensRequestAdapter: new RequestAdapter(), - query: { language: 'kuery', query: '' }, - requestAdapter: new RequestAdapter(), - searchSessionId: '123', timeInterval: 'auto', - timeRange: { from: 'now-15m', to: 'now' }, topPanelHeight: 100, totalHitsStatus: UnifiedHistogramFetchStatus.uninitialized, totalHitsResult: undefined, - columns: [], currentSuggestion: undefined, }; it('should initialize state with default values', () => { - const stateService = createStateService({ - services: unifiedHistogramServicesMock, - initialState: { - dataView: dataViewWithTimefieldMock, - }, - }); + const stateService = createStateService({ services: unifiedHistogramServicesMock }); let state: UnifiedHistogramState | undefined; stateService.state$.subscribe((s) => (state = s)); expect(state).toEqual({ breakdownField: undefined, chartHidden: false, - dataView: dataViewWithTimefieldMock, - filters: [], lensRequestAdapter: undefined, - query: unifiedHistogramServicesMock.data.query.queryString.getDefaultQuery(), - requestAdapter: undefined, - searchSessionId: undefined, timeInterval: 'auto', - timeRange: unifiedHistogramServicesMock.data.query.timefilter.timefilter.getTimeDefaults(), topPanelHeight: undefined, totalHitsResult: undefined, totalHitsStatus: UnifiedHistogramFetchStatus.uninitialized, - columns: [], currentSuggestion: undefined, allSuggestions: undefined, }); @@ -154,17 +132,6 @@ describe('UnifiedHistogramStateService', () => { stateService.setTimeInterval('test'); newState = { ...newState, timeInterval: 'test' }; expect(state).toEqual(newState); - const requestParams = { - dataView: dataViewMock, - filters: ['test'] as unknown as Filter[], - query: { language: 'kuery', query: 'test' }, - requestAdapter: undefined, - searchSessionId: '321', - timeRange: { from: 'now-30m', to: 'now' }, - }; - stateService.setRequestParams(requestParams); - newState = { ...newState, ...requestParams }; - expect(state).toEqual(newState); stateService.setLensRequestAdapter(undefined); newState = { ...newState, lensRequestAdapter: undefined }; expect(state).toEqual(newState); diff --git a/src/plugins/unified_histogram/public/container/services/state_service.ts b/src/plugins/unified_histogram/public/container/services/state_service.ts index 36f50ea8bd36e..01d1a7f0c3f60 100644 --- a/src/plugins/unified_histogram/public/container/services/state_service.ts +++ b/src/plugins/unified_histogram/public/container/services/state_service.ts @@ -6,8 +6,6 @@ * Side Public License, v 1. */ -import type { DataView } from '@kbn/data-views-plugin/common'; -import type { AggregateQuery, Filter, Query, TimeRange } from '@kbn/es-query'; import type { RequestAdapter } from '@kbn/inspector-plugin/common'; import type { Suggestion } from '@kbn/lens-plugin/public'; import { BehaviorSubject, Observable } from 'rxjs'; @@ -30,10 +28,6 @@ export interface UnifiedHistogramState { * The current field used for the breakdown */ breakdownField: string | undefined; - /** - * The current selected columns - */ - columns: string[] | undefined; /** * The current Lens suggestion */ @@ -42,38 +36,14 @@ export interface UnifiedHistogramState { * Whether or not the chart is hidden */ chartHidden: boolean; - /** - * The current data view - */ - dataView: DataView; - /** - * The current filters - */ - filters: Filter[]; /** * The current Lens request adapter */ lensRequestAdapter: RequestAdapter | undefined; - /** - * The current query - */ - query: Query | AggregateQuery; - /** - * The current request adapter used for non-Lens requests - */ - requestAdapter: RequestAdapter | undefined; - /** - * The current search session ID - */ - searchSessionId: string | undefined; /** * The current time interval of the chart */ timeInterval: string; - /** - * The current time range - */ - timeRange: TimeRange; /** * The current top panel height */ @@ -103,7 +73,7 @@ export interface UnifiedHistogramStateOptions { /** * The initial state of the container */ - initialState: Partial & Pick; + initialState?: Partial; } /** @@ -122,10 +92,6 @@ export interface UnifiedHistogramStateService { * Sets current Lens suggestion */ setCurrentSuggestion: (suggestion: Suggestion | undefined) => void; - /** - * Sets columns - */ - setColumns: (columns: string[] | undefined) => void; /** * Sets the current top panel height */ @@ -138,17 +104,6 @@ export interface UnifiedHistogramStateService { * Sets the current time interval */ setTimeInterval: (timeInterval: string) => void; - /** - * Sets the current request parameters - */ - setRequestParams: (requestParams: { - dataView?: DataView; - filters?: Filter[]; - query?: Query | AggregateQuery; - requestAdapter?: RequestAdapter | undefined; - searchSessionId?: string | undefined; - timeRange?: TimeRange; - }) => void; /** * Sets the current Lens request adapter */ @@ -177,18 +132,12 @@ export const createStateService = ( initialBreakdownField = getBreakdownField(services.storage, localStorageKeyPrefix); } - const state$ = new BehaviorSubject({ + const state$ = new BehaviorSubject({ breakdownField: initialBreakdownField, chartHidden: initialChartHidden, - columns: [], - filters: [], currentSuggestion: undefined, lensRequestAdapter: undefined, - query: services.data.query.queryString.getDefaultQuery(), - requestAdapter: undefined, - searchSessionId: undefined, timeInterval: 'auto', - timeRange: services.data.query.timefilter.timefilter.getTimeDefaults(), topPanelHeight: initialTopPanelHeight, totalHitsResult: undefined, totalHitsStatus: UnifiedHistogramFetchStatus.uninitialized, @@ -233,25 +182,10 @@ export const createStateService = ( updateState({ currentSuggestion: suggestion }); }, - setColumns: (columns: string[] | undefined) => { - updateState({ columns }); - }, - setTimeInterval: (timeInterval: string) => { updateState({ timeInterval }); }, - setRequestParams: (requestParams: { - dataView?: DataView; - filters?: Filter[]; - query?: Query | AggregateQuery; - requestAdapter?: RequestAdapter | undefined; - searchSessionId?: string | undefined; - timeRange?: TimeRange; - }) => { - updateState(requestParams); - }, - setLensRequestAdapter: (lensRequestAdapter: RequestAdapter | undefined) => { updateState({ lensRequestAdapter }); }, diff --git a/src/plugins/unified_histogram/public/container/utils/state_selectors.ts b/src/plugins/unified_histogram/public/container/utils/state_selectors.ts index 52980e3918295..d11fb1182cc45 100644 --- a/src/plugins/unified_histogram/public/container/utils/state_selectors.ts +++ b/src/plugins/unified_histogram/public/container/utils/state_selectors.ts @@ -9,15 +9,8 @@ import type { UnifiedHistogramState } from '../services/state_service'; export const breakdownFieldSelector = (state: UnifiedHistogramState) => state.breakdownField; -export const columnsSelector = (state: UnifiedHistogramState) => state.columns; export const chartHiddenSelector = (state: UnifiedHistogramState) => state.chartHidden; -export const dataViewSelector = (state: UnifiedHistogramState) => state.dataView; -export const filtersSelector = (state: UnifiedHistogramState) => state.filters; -export const querySelector = (state: UnifiedHistogramState) => state.query; -export const requestAdapterSelector = (state: UnifiedHistogramState) => state.requestAdapter; -export const searchSessionIdSelector = (state: UnifiedHistogramState) => state.searchSessionId; export const timeIntervalSelector = (state: UnifiedHistogramState) => state.timeInterval; -export const timeRangeSelector = (state: UnifiedHistogramState) => state.timeRange; export const topPanelHeightSelector = (state: UnifiedHistogramState) => state.topPanelHeight; export const totalHitsResultSelector = (state: UnifiedHistogramState) => state.totalHitsResult; export const totalHitsStatusSelector = (state: UnifiedHistogramState) => state.totalHitsStatus; diff --git a/src/plugins/unified_histogram/public/index.ts b/src/plugins/unified_histogram/public/index.ts index b183a5a1f8180..5b32836bfb258 100644 --- a/src/plugins/unified_histogram/public/index.ts +++ b/src/plugins/unified_histogram/public/index.ts @@ -9,11 +9,9 @@ import { UnifiedHistogramPublicPlugin } from './plugin'; export type { - UnifiedHistogramUninitializedApi, - UnifiedHistogramInitializedApi, UnifiedHistogramApi, UnifiedHistogramContainerProps, - UnifiedHistogramInitializeOptions, + UnifiedHistogramCreationOptions, UnifiedHistogramState, UnifiedHistogramStateOptions, } from './container'; diff --git a/src/plugins/unified_histogram/public/layout/layout.tsx b/src/plugins/unified_histogram/public/layout/layout.tsx index 89059a320fcf2..3c5b021e0b08d 100644 --- a/src/plugins/unified_histogram/public/layout/layout.tsx +++ b/src/plugins/unified_histogram/public/layout/layout.tsx @@ -61,6 +61,10 @@ export interface UnifiedHistogramLayoutProps extends PropsWithChildren * The current time range */ timeRange?: TimeRange; + /** + * The relative time range, used when timeRange is an absolute range (e.g. for edit visualization button) + */ + relativeTimeRange?: TimeRange; /** * The current columns */ @@ -113,10 +117,6 @@ export interface UnifiedHistogramLayoutProps extends PropsWithChildren * The Lens suggestions API */ lensSuggestionsApi: LensSuggestionsApi; - /** - * Callback to get the relative time range, useful when passing an absolute time range (e.g. for edit visualization button) - */ - getRelativeTimeRange?: () => TimeRange; /** * Callback to update the topPanelHeight prop when a resize is triggered */ @@ -165,6 +165,7 @@ export const UnifiedHistogramLayout = ({ currentSuggestion: originalSuggestion, isPlainRecord, timeRange, + relativeTimeRange, columns, request, hits, @@ -178,7 +179,6 @@ export const UnifiedHistogramLayout = ({ disabledActions, lensSuggestionsApi, input$, - getRelativeTimeRange, onTopPanelHeightChange, onChartHiddenChange, onTimeIntervalChange, @@ -250,6 +250,7 @@ export const UnifiedHistogramLayout = ({ query={query} filters={filters} timeRange={timeRange} + relativeTimeRange={relativeTimeRange} request={request} hits={hits} currentSuggestion={currentSuggestion} @@ -263,7 +264,6 @@ export const UnifiedHistogramLayout = ({ disableTriggers={disableTriggers} disabledActions={disabledActions} input$={input$} - getRelativeTimeRange={getRelativeTimeRange} onResetChartHeight={onResetChartHeight} onChartHiddenChange={onChartHiddenChange} onTimeIntervalChange={onTimeIntervalChange} diff --git a/src/plugins/unified_histogram/public/mocks.ts b/src/plugins/unified_histogram/public/mocks.ts index 9eb6463d34d1c..544d0ed4cfd6e 100644 --- a/src/plugins/unified_histogram/public/mocks.ts +++ b/src/plugins/unified_histogram/public/mocks.ts @@ -7,26 +7,15 @@ */ import { Observable } from 'rxjs'; -import type { UnifiedHistogramInitializedApi, UnifiedHistogramUninitializedApi } from './container'; +import type { UnifiedHistogramApi } from './container'; -export type MockUnifiedHistogramApi = Omit & - Omit & { initialized: boolean }; - -export const createMockUnifiedHistogramApi = ( - { initialized }: { initialized: boolean } = { initialized: false } -) => { - const api: MockUnifiedHistogramApi = { - initialized, - initialize: jest.fn(() => { - api.initialized = true; - }), +export const createMockUnifiedHistogramApi = () => { + const api: UnifiedHistogramApi = { state$: new Observable(), setChartHidden: jest.fn(), setTopPanelHeight: jest.fn(), setBreakdownField: jest.fn(), - setColumns: jest.fn(), setTimeInterval: jest.fn(), - setRequestParams: jest.fn(), setTotalHits: jest.fn(), refetch: jest.fn(), }; diff --git a/src/plugins/unified_search/public/filter_bar/filter_editor/filter_editor.tsx b/src/plugins/unified_search/public/filter_bar/filter_editor/filter_editor.tsx index ab33242992067..70586bdd39857 100644 --- a/src/plugins/unified_search/public/filter_bar/filter_editor/filter_editor.tsx +++ b/src/plugins/unified_search/public/filter_bar/filter_editor/filter_editor.tsx @@ -22,6 +22,7 @@ import { EuiToolTip, EuiBadge, withEuiTheme, + EuiTextColor, } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; import { @@ -30,6 +31,7 @@ import { buildCombinedFilter, buildCustomFilter, buildEmptyFilter, + FILTERS, filterToQueryDsl, getFilterParams, isCombinedFilter, @@ -104,6 +106,11 @@ export const strings = { i18n.translate('unifiedSearch.filter.filterEditor.queryDslAriaLabel', { defaultMessage: 'Elasticsearch Query DSL editor', }), + getSpatialFilterQueryDslHelpText: () => + i18n.translate('unifiedSearch.filter.filterEditor.spatialFilterQueryDslHelpText', { + defaultMessage: + 'Editing Elasticsearch Query DSL prevents filter geometry from displaying in map.', + }), }; interface QueryDslFilter { @@ -140,7 +147,7 @@ class FilterEditorComponent extends Component { selectedDataView: dataView, customLabel: props.filter.meta.alias || '', queryDsl: this.parseFilterToQueryDsl(props.filter), - isCustomEditorOpen: this.isUnknownFilterType(), + isCustomEditorOpen: this.isUnknownFilterType() || !!this.props.filter?.meta.isMultiIndex, localFilter: dataView ? merge({}, props.filter) : buildEmptyFilter(false), }; } @@ -160,6 +167,23 @@ class FilterEditorComponent extends Component { } public render() { + const toggleEditorFlexItem = this.props.filter?.meta.isMultiIndex ? null : ( + + + {this.state.isCustomEditorOpen ? ( + + ) : ( + + )} + + + ); return (
@@ -173,25 +197,7 @@ class FilterEditorComponent extends Component { - - - {this.state.isCustomEditorOpen ? ( - - ) : ( - - )} - - + {toggleEditorFlexItem} @@ -255,6 +261,11 @@ class FilterEditorComponent extends Component { } private renderIndexPatternInput() { + if (this.props.filter?.meta.isMultiIndex) { + // Don't render index pattern selector if filter supports multiple index patterns + return null; + } + if ( this.props.indexPatterns.length <= 1 && this.props.indexPatterns.find( @@ -266,7 +277,7 @@ class FilterEditorComponent extends Component { * and if the index pattern the filter was LOADED with is in the indexPatterns list. **/ - return ''; + return null; } const { selectedDataView } = this.state; return ( @@ -362,8 +373,14 @@ class FilterEditorComponent extends Component { } private renderCustomEditor() { + const helpText = + this.props.filter?.meta.type === FILTERS.SPATIAL_FILTER ? ( + {strings.getSpatialFilterQueryDslHelpText()} + ) : ( + '' + ); return ( - + { const alias = customLabel || null; const { $state, - meta: { disabled = false, negate = false }, + meta: { disabled = false }, } = this.props.filter; if (!$state || !$state.store || !selectedDataView) { @@ -516,12 +533,14 @@ class FilterEditorComponent extends Component { }, }; } else { + // for the combined filters created on the builder, negate should always be false, + // the global negation changes only from the exclude/inclue results panel item newFilter = buildCombinedFilter( BooleanRelation.AND, updatedFilters, selectedDataView, disabled, - negate, + false, alias, $state.store ); @@ -540,7 +559,18 @@ class FilterEditorComponent extends Component { } if (isCustomEditorOpen) { - const filter = this.getFilterFromQueryDsl(queryDsl); + const filter = + this.props.filter?.meta.type === FILTERS.CUSTOM || + // only convert non-custom filters to custom when DSL changes + queryDsl !== this.parseFilterToQueryDsl(this.props.filter) + ? this.getFilterFromQueryDsl(queryDsl) + : { + ...this.props.filter, + meta: { + ...(this.props.filter.meta ?? {}), + alias: customLabel || null, + }, + }; if (!filter) { return; } diff --git a/src/plugins/unified_search/public/search_bar/create_search_bar.tsx b/src/plugins/unified_search/public/search_bar/create_search_bar.tsx index 3224220d12ec1..0590f4c05bfb6 100644 --- a/src/plugins/unified_search/public/search_bar/create_search_bar.tsx +++ b/src/plugins/unified_search/public/search_bar/create_search_bar.tsx @@ -145,6 +145,9 @@ export function createSearchBar({ // Handle queries const onQuerySubmitRef = useRef(props.onQuerySubmit); + useEffect(() => { + onQuerySubmitRef.current = props.onQuerySubmit; + }, [props.onQuerySubmit]); // handle service state updates. // i.e. filters being added from a visualization directly to filterManager. const { filters } = useFilterManager({ diff --git a/test/functional/apps/context/_filters.ts b/test/functional/apps/context/_filters.ts index 6b1c52250be91..b3b8cc0a1fd62 100644 --- a/test/functional/apps/context/_filters.ts +++ b/test/functional/apps/context/_filters.ts @@ -22,8 +22,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const browser = getService('browser'); const PageObjects = getPageObjects(['common', 'context']); + const testSubjects = getService('testSubjects'); - describe('context filters', function contextSize() { + // FLAKY: https://github.com/elastic/kibana/issues/154387 + describe.skip('context filters', function contextSize() { beforeEach(async function () { await PageObjects.context.navigateTo(TEST_INDEX_PATTERN, TEST_ANCHOR_ID, { columns: TEST_COLUMN_NAMES, @@ -227,5 +229,22 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { expect(await filterBar.getFilterEditorPreview()).to.equal('extension: is one of png, jpeg'); }); + + it('should display the negated values correctly', async () => { + await filterBar.addFilter({ field: 'extension', operation: 'is not', value: 'png' }); + + await PageObjects.context.waitUntilContextLoadingHasFinished(); + expect(await filterBar.getFilterCount()).to.be(1); + const filterLabel = await filterBar.getFiltersLabel(); + expect(filterLabel[0]).to.be('NOT extension: png'); + + await filterBar.clickEditFilterById('0'); + await filterBar.addAndFilter('0'); + await filterBar.createFilter({ field: 'extension', operation: 'is', value: 'jpeg' }, '0.1'); + await testSubjects.clickWhenNotDisabled('saveFilter'); + + const filterLabelUpdated = await filterBar.getFiltersLabel(); + expect(filterLabelUpdated[0]).to.be('NOT extension: png AND extension: jpeg'); + }); }); } diff --git a/test/functional/apps/dashboard/group1/url_field_formatter.ts b/test/functional/apps/dashboard/group1/url_field_formatter.ts index 9cdebca739635..67924ce2d1c48 100644 --- a/test/functional/apps/dashboard/group1/url_field_formatter.ts +++ b/test/functional/apps/dashboard/group1/url_field_formatter.ts @@ -37,7 +37,8 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { expect(currentUrl).to.equal(fieldUrl); }; - describe('Changing field formatter to Url', () => { + // Failing: See https://github.com/elastic/kibana/issues/154367 + describe.skip('Changing field formatter to Url', () => { before(async function () { await security.testUser.setRoles(['kibana_admin', 'test_logstash_reader', 'animals']); await kibanaServer.savedObjects.cleanStandardList(); diff --git a/test/functional/apps/dashboard_elements/controls/control_group_chaining.ts b/test/functional/apps/dashboard_elements/controls/control_group_chaining.ts index 4fc9101ed67a5..d77e3862c2dad 100644 --- a/test/functional/apps/dashboard_elements/controls/control_group_chaining.ts +++ b/test/functional/apps/dashboard_elements/controls/control_group_chaining.ts @@ -26,7 +26,8 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { 'header', ]); - describe('Dashboard control group hierarchical chaining', () => { + // FLAKY: https://github.com/elastic/kibana/issues/154146 + describe.skip('Dashboard control group hierarchical chaining', () => { const newDocuments: Array<{ index: string; id: string }> = []; let controlIds: string[]; diff --git a/test/functional/apps/discover/group2/_data_grid_copy_to_clipboard.ts b/test/functional/apps/discover/group2/_data_grid_copy_to_clipboard.ts index fb759bc53099d..06fe279dbd534 100644 --- a/test/functional/apps/discover/group2/_data_grid_copy_to_clipboard.ts +++ b/test/functional/apps/discover/group2/_data_grid_copy_to_clipboard.ts @@ -64,7 +64,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { if (canReadClipboard) { const copiedSourceData = await browser.getClipboardValue(); - expect(copiedSourceData.startsWith('"_source"\n{"@message":["238.171.34.42')).to.be(true); + expect(copiedSourceData.startsWith('Document\n{"@message":["238.171.34.42')).to.be(true); expect(copiedSourceData.endsWith('}')).to.be(true); } @@ -89,7 +89,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { if (canReadClipboard) { const copiedSourceName = await browser.getClipboardValue(); - expect(copiedSourceName).to.be('"_source"'); + expect(copiedSourceName).to.be('Document'); } expect(await toasts.getToastCount()).to.be(1); diff --git a/test/functional/apps/discover/group2/index.ts b/test/functional/apps/discover/group2/index.ts index 54854a5243365..d6a0aeb9cd9ec 100644 --- a/test/functional/apps/discover/group2/index.ts +++ b/test/functional/apps/discover/group2/index.ts @@ -13,7 +13,7 @@ export default function ({ getService, loadTestFile }: FtrProviderContext) { describe('discover/group2', function () { before(async function () { - await browser.setWindowSize(1300, 800); + await browser.setWindowSize(1600, 1200); }); after(async function unloadMakelogs() { diff --git a/test/functional/page_objects/home_page.ts b/test/functional/page_objects/home_page.ts index a6a5e2e6bc9ea..ac942c70b5d90 100644 --- a/test/functional/page_objects/home_page.ts +++ b/test/functional/page_objects/home_page.ts @@ -57,7 +57,7 @@ export class HomePageObject extends FtrService { } async isGuidedOnboardingLandingDisplayed() { - return await this.testSubjects.isDisplayed('onboarding--landing-page'); + return await this.testSubjects.isDisplayed('guided-onboarding--landing-page'); } async isHomePageDisplayed() { diff --git a/test/functional/screenshots/baseline/area_chart.png b/test/functional/screenshots/baseline/area_chart.png index 5f3e3e7238dfd..b60760eb460d4 100644 Binary files a/test/functional/screenshots/baseline/area_chart.png and b/test/functional/screenshots/baseline/area_chart.png differ diff --git a/test/functional/services/combo_box.ts b/test/functional/services/combo_box.ts index 96d51cd24611a..c5536d9690ff7 100644 --- a/test/functional/services/combo_box.ts +++ b/test/functional/services/combo_box.ts @@ -323,4 +323,12 @@ export class ComboBoxService extends FtrService { const input = await comboBoxElement.findByTagName('input'); await input.clearValueWithKeyboard(); } + + public async isDisabled(comboBoxElement: WebElementWrapper): Promise { + this.log.debug(`comboBox.isDisabled`); + const toggleListButton = await comboBoxElement.findByTestSubject('comboBoxToggleListButton'); + const isDisabled = await toggleListButton.getAttribute('disabled'); + this.log.debug(`isDisabled:${isDisabled}`); + return isDisabled?.toLowerCase() === 'true'; + } } diff --git a/test/functional/services/filter_bar.ts b/test/functional/services/filter_bar.ts index a4e57e5bff2f8..0c44545cae1f4 100644 --- a/test/functional/services/filter_bar.ts +++ b/test/functional/services/filter_bar.ts @@ -208,7 +208,7 @@ export class FilterBarService extends FtrService { await addOrBtn.click(); } - private async addAndFilter(path: string) { + public async addAndFilter(path: string) { const filterForm = await this.testSubjects.find(`filter-${path}`); const addAndBtn = await filterForm.findByTestSubject('add-and-filter'); await addAndBtn.click(); @@ -273,7 +273,7 @@ export class FilterBarService extends FtrService { return 'filters' in filter && 'condition' in filter; } - private async createFilter(filter: Filter, path: string = '0'): Promise { + public async createFilter(filter: Filter, path: string = '0'): Promise { if (this.isFilterNode(filter)) { let startedAdding = false; for (const [index, f] of filter.filters.entries()) { @@ -302,9 +302,12 @@ export class FilterBarService extends FtrService { await this.createFilter(filter); + await this.testSubjects.scrollIntoView('saveFilter'); await this.testSubjects.clickWhenNotDisabled('saveFilter'); }); - await this.testSubjects.waitForDeleted('saveFilter'); + await this.retry.try(async () => { + await this.testSubjects.waitForDeleted('saveFilter'); + }); await this.header.awaitGlobalLoadingIndicatorHidden(); } diff --git a/test/functional/services/remote/webdriver.ts b/test/functional/services/remote/webdriver.ts index af2e1056e6867..636391f790f1e 100644 --- a/test/functional/services/remote/webdriver.ts +++ b/test/functional/services/remote/webdriver.ts @@ -99,9 +99,12 @@ function initChromiumOptions(browserType: Browsers, acceptInsecureCerts: boolean } if (headlessBrowser === '1') { + // Using the new headless mode (instead of `options.headless()`) + // See: https://www.selenium.dev/blog/2023/headless-is-going-away/ + options.addArguments('headless=new'); + // Use --disable-gpu to avoid an error from a missing Mesa library, as per // See: https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md - options.headless(); options.addArguments('disable-gpu'); } @@ -111,7 +114,11 @@ function initChromiumOptions(browserType: Browsers, acceptInsecureCerts: boolean if (remoteDebug === '1') { // Visit chrome://inspect in chrome to remotely view/debug - options.headless(); + + // Using the new headless mode (instead of `options.headless()`) + // See: https://www.selenium.dev/blog/2023/headless-is-going-away/ + options.addArguments('headless=new'); + options.addArguments('disable-gpu', 'remote-debugging-port=9222'); } diff --git a/tsconfig.base.json b/tsconfig.base.json index 769bfb2090307..313f478e28b46 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -936,6 +936,8 @@ "@kbn/notifications-plugin/*": ["x-pack/plugins/notifications/*"], "@kbn/object-versioning": ["packages/kbn-object-versioning"], "@kbn/object-versioning/*": ["packages/kbn-object-versioning/*"], + "@kbn/observability-alert-details": ["x-pack/packages/observability/alert_details"], + "@kbn/observability-alert-details/*": ["x-pack/packages/observability/alert_details/*"], "@kbn/observability-fixtures-plugin": ["x-pack/test/cases_api_integration/common/plugins/observability"], "@kbn/observability-fixtures-plugin/*": ["x-pack/test/cases_api_integration/common/plugins/observability/*"], "@kbn/observability-plugin": ["x-pack/plugins/observability"], diff --git a/x-pack/packages/ml/agg_utils/index.ts b/x-pack/packages/ml/agg_utils/index.ts index fe7c2575d09f7..fd92a7dbd2cc5 100644 --- a/x-pack/packages/ml/agg_utils/index.ts +++ b/x-pack/packages/ml/agg_utils/index.ts @@ -32,3 +32,8 @@ export type { FieldValuePair, } from './src/types'; export type { NumberValidationResult } from './src/validate_number'; +export { + TIME_SERIES_METRIC_TYPES, + isCounterTimeSeriesMetric, + isGaugeTimeSeriesMetric, +} from './src/time_series_metric_fields'; diff --git a/x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts b/x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts new file mode 100644 index 0000000000000..a881e02a2f907 --- /dev/null +++ b/x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts @@ -0,0 +1,34 @@ +/* + * 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 { DataViewField } from '@kbn/data-views-plugin/common'; + +/** + * All available types for time series metric fields + */ +export enum TIME_SERIES_METRIC_TYPES { + HISTOGRAM = 'histogram', + COUNTER = 'counter', + GAUGE = 'gauge', + SUMMARY = 'summary', +} + +/** + * Check if DataViewField is a 'counter' time series metric field + * @param field optional DataViewField + * @returns a boolean + */ +export const isCounterTimeSeriesMetric = (field?: DataViewField) => + field?.timeSeriesMetric === TIME_SERIES_METRIC_TYPES.COUNTER; + +/** + * Check if DataViewField is a 'gauge' time series metric field + * @param field optional DataViewField + * @returns a boolean + */ +export const isGaugeTimeSeriesMetric = (field?: DataViewField) => + field?.timeSeriesMetric === TIME_SERIES_METRIC_TYPES.GAUGE; diff --git a/x-pack/packages/ml/agg_utils/tsconfig.json b/x-pack/packages/ml/agg_utils/tsconfig.json index a7620df0a88d0..967848f2d3ddf 100644 --- a/x-pack/packages/ml/agg_utils/tsconfig.json +++ b/x-pack/packages/ml/agg_utils/tsconfig.json @@ -15,7 +15,8 @@ "@kbn/core-elasticsearch-server", "@kbn/field-types", "@kbn/ml-is-populated-object", - "@kbn/ml-string-hash" + "@kbn/ml-string-hash", + "@kbn/data-views-plugin" ], "exclude": [ "target/**/*", diff --git a/x-pack/packages/observability/alert_details/README.md b/x-pack/packages/observability/alert_details/README.md new file mode 100644 index 0000000000000..da80c94e08710 --- /dev/null +++ b/x-pack/packages/observability/alert_details/README.md @@ -0,0 +1,3 @@ +# @kbn/observability-alert-details + +Provides alert details related helpers and components diff --git a/x-pack/packages/observability/alert_details/index.ts b/x-pack/packages/observability/alert_details/index.ts new file mode 100644 index 0000000000000..794dd06922c7c --- /dev/null +++ b/x-pack/packages/observability/alert_details/index.ts @@ -0,0 +1,10 @@ +/* + * 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. + */ + +export { AlertAnnotation } from './src/components/alert_annotation'; +export { AlertActiveTimeRangeAnnotation } from './src/components/alert_active_time_range_annotation'; +export { getPaddedAlertTimeRange } from './src/helpers/get_padded_alert_time_range'; diff --git a/x-pack/packages/observability/alert_details/jest.config.js b/x-pack/packages/observability/alert_details/jest.config.js new file mode 100644 index 0000000000000..67483ee64642b --- /dev/null +++ b/x-pack/packages/observability/alert_details/jest.config.js @@ -0,0 +1,12 @@ +/* + * 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. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/x-pack/packages/observability/alert_details'], +}; diff --git a/x-pack/packages/observability/alert_details/kibana.jsonc b/x-pack/packages/observability/alert_details/kibana.jsonc new file mode 100644 index 0000000000000..e17a6f606dd89 --- /dev/null +++ b/x-pack/packages/observability/alert_details/kibana.jsonc @@ -0,0 +1,5 @@ +{ + "type": "shared-common", + "id": "@kbn/observability-alert-details", + "owner": "@elastic/actionable-observability" +} diff --git a/x-pack/packages/observability/alert_details/package.json b/x-pack/packages/observability/alert_details/package.json new file mode 100644 index 0000000000000..3baee7af3443e --- /dev/null +++ b/x-pack/packages/observability/alert_details/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/observability-alert-details", + "descriptio": "Helper and components related to alert details", + "author": "Actionable Observability", + "private": true, + "version": "1.0.0", + "license": "Elastic License 2.0" +} \ No newline at end of file diff --git a/x-pack/packages/observability/alert_details/src/components/alert_active_time_range_annotation.tsx b/x-pack/packages/observability/alert_details/src/components/alert_active_time_range_annotation.tsx new file mode 100644 index 0000000000000..9f1beb3c77669 --- /dev/null +++ b/x-pack/packages/observability/alert_details/src/components/alert_active_time_range_annotation.tsx @@ -0,0 +1,43 @@ +/* + * 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 React from 'react'; +import { RectAnnotation } from '@elastic/charts'; +import { i18n } from '@kbn/i18n'; + +interface Props { + alertStart: number; + alertEnd?: number; + color: string; + id: string; +} + +const RECT_ANNOTATION_TITLE = i18n.translate( + 'observabilityAlertDetails.alertActiveTimeRangeAnnotation.detailsTooltip', + { + defaultMessage: 'Active', + } +); + +export function AlertActiveTimeRangeAnnotation({ alertStart, alertEnd, color, id }: Props) { + return ( + + ); +} diff --git a/x-pack/packages/observability/alert_details/src/components/alert_annotation.tsx b/x-pack/packages/observability/alert_details/src/components/alert_annotation.tsx new file mode 100644 index 0000000000000..4579bc6976b9c --- /dev/null +++ b/x-pack/packages/observability/alert_details/src/components/alert_annotation.tsx @@ -0,0 +1,51 @@ +/* + * 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 React from 'react'; +import moment from 'moment'; +import { i18n } from '@kbn/i18n'; +import { AnnotationDomainType, LineAnnotation, Position } from '@elastic/charts'; +import { EuiIcon } from '@elastic/eui'; + +interface Props { + alertStart: number; + color: string; + dateFormat: string; + id: string; +} + +const ANNOTATION_TITLE = i18n.translate( + 'observabilityAlertDetails.alertAnnotation.detailsTooltip', + { + defaultMessage: 'Alert started', + } +); + +export function AlertAnnotation({ alertStart, color, dateFormat, id }: Props) { + return ( + } + markerPosition={Position.Top} + /> + ); +} diff --git a/x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.test.ts b/x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.test.ts new file mode 100644 index 0000000000000..cd05650db7a56 --- /dev/null +++ b/x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.test.ts @@ -0,0 +1,61 @@ +/* + * 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 { getPaddedAlertTimeRange } from './get_padded_alert_time_range'; + +describe('getPaddedAlertTimeRange', () => { + const mockedDate = '2023-03-28T09:22:32.660Z'; + const mockDate = jest + .spyOn(global.Date, 'now') + .mockImplementation(() => new Date(mockedDate).valueOf()); + + afterAll(() => mockDate.mockRestore()); + const testData: any[] = [ + // Description, Start, End, Output + [ + 'Duration 4 hour, time range will be extended it with 30 minutes from each side', + '2023-03-28T04:15:32.660Z', + '2023-03-28T08:15:32.660Z', + { from: '2023-03-28T03:45:32.660Z', to: '2023-03-28T08:45:32.660Z' }, + ], + [ + 'Duration 5 minutes, time range will be extended it with 20 minutes from each side', + '2023-03-28T08:22:33.660Z', + '2023-03-28T08:27:33.660Z', + { from: '2023-03-28T08:02:33.660Z', to: '2023-03-28T08:47:33.660Z' }, + ], + ]; + + it.each(testData)('%s', (_, start, end, output) => { + expect(getPaddedAlertTimeRange(start, end)).toEqual(output); + }); + + describe('active alert', () => { + it('without end time', () => { + // Duration 5 hours + const start = '2023-03-28T04:22:32.660Z'; + const output = { + // Time range is from 37.5 minutes (duration/8) before start + from: '2023-03-28T03:45:02.660Z', + to: mockedDate, + }; + expect(getPaddedAlertTimeRange(start)).toEqual(output); + }); + + it('with end time than 10 minutes before now', () => { + const start = '2023-03-28T05:17:32.660Z'; + // 5 minutes before now, duration 4 hours + const end = '2023-03-28T09:17:32.660Z'; + const output = { + // Time range is from 30 minutes (duration/8) before start + from: '2023-03-28T04:47:32.660Z', + to: mockedDate, + }; + expect(getPaddedAlertTimeRange(start, end)).toEqual(output); + }); + }); +}); diff --git a/x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.ts b/x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.ts new file mode 100644 index 0000000000000..9c7fc7ec9ecee --- /dev/null +++ b/x-pack/packages/observability/alert_details/src/helpers/get_padded_alert_time_range.ts @@ -0,0 +1,34 @@ +/* + * 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 moment from 'moment'; + +export interface TimeRange { + from?: string; + to?: string; + interval?: string; +} + +export const getPaddedAlertTimeRange = (alertStart: string, alertEnd?: string): TimeRange => { + const alertDuration = moment.duration(moment(alertEnd).diff(moment(alertStart))); + const now = moment().toISOString(); + const durationMs = + alertDuration.asMinutes() < 160 + ? moment.duration(20, 'minutes').asMilliseconds() + : alertDuration.asMilliseconds() / 8; + + const from = moment(alertStart).subtract(durationMs, 'millisecond').toISOString(); + const to = + alertEnd && moment(alertEnd).add(durationMs, 'millisecond').isBefore(now) + ? moment(alertEnd).add(durationMs, 'millisecond').toISOString() + : now; + + return { + from, + to, + }; +}; diff --git a/x-pack/packages/observability/alert_details/tsconfig.json b/x-pack/packages/observability/alert_details/tsconfig.json new file mode 100644 index 0000000000000..a912033557c36 --- /dev/null +++ b/x-pack/packages/observability/alert_details/tsconfig.json @@ -0,0 +1,21 @@ +{ + "extends": "../../../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types", + "types": [ + "jest", + "node", + "react" + ] + }, + "include": [ + "**/*.ts", + "**/*.tsx", + ], + "exclude": [ + "target/**/*" + ], + "kbn_references": [ + "@kbn/i18n" + ] +} diff --git a/x-pack/plugins/aiops/public/components/change_point_detection/change_point_detection_context.tsx b/x-pack/plugins/aiops/public/components/change_point_detection/change_point_detection_context.tsx index a30ef3cc4a997..772e9c2794da0 100644 --- a/x-pack/plugins/aiops/public/components/change_point_detection/change_point_detection_context.tsx +++ b/x-pack/plugins/aiops/public/components/change_point_detection/change_point_detection_context.tsx @@ -19,7 +19,6 @@ import { startWith } from 'rxjs'; import type { Filter, Query } from '@kbn/es-query'; import { usePageUrlState } from '@kbn/ml-url-state'; import { useTimefilter, useTimeRangeUpdates } from '@kbn/ml-date-picker'; -import moment from 'moment'; import { ES_FIELD_TYPES } from '@kbn/field-types'; import { DEFAULT_AGG_FUNCTION } from './constants'; import { useSplitFieldCardinality } from './use_split_field_cardinality'; @@ -238,8 +237,8 @@ export const ChangePointDetectionContextProvider: FC = ({ children }) => { mergedQuery.bool!.filter.push({ range: { [dataView.timeFieldName!]: { - from: moment(timeRange.from).valueOf(), - to: moment(timeRange.to).valueOf(), + from: timeRange.from, + to: timeRange.to, }, }, }); diff --git a/x-pack/plugins/alerting/server/config.test.ts b/x-pack/plugins/alerting/server/config.test.ts index 26ea818719b7e..7df579771a91c 100644 --- a/x-pack/plugins/alerting/server/config.test.ts +++ b/x-pack/plugins/alerting/server/config.test.ts @@ -13,7 +13,7 @@ describe('config validation', () => { expect(configSchema.validate(config)).toMatchInlineSnapshot(` Object { "cancelAlertsOnRuleTimeout": true, - "enableFrameworkAlerts": false, + "enableFrameworkAlerts": true, "healthCheck": Object { "interval": "60m", }, diff --git a/x-pack/plugins/alerting/server/config.ts b/x-pack/plugins/alerting/server/config.ts index f727cb98c0266..383143f527623 100644 --- a/x-pack/plugins/alerting/server/config.ts +++ b/x-pack/plugins/alerting/server/config.ts @@ -62,7 +62,7 @@ export const configSchema = schema.object({ maxEphemeralActionsPerAlert: schema.number({ defaultValue: DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT, }), - enableFrameworkAlerts: schema.boolean({ defaultValue: false }), + enableFrameworkAlerts: schema.boolean({ defaultValue: true }), cancelAlertsOnRuleTimeout: schema.boolean({ defaultValue: true }), rules: rulesSchema, }); diff --git a/x-pack/plugins/alerting/server/lib/is_rule_snoozed.test.ts b/x-pack/plugins/alerting/server/lib/is_rule_snoozed.test.ts index 21fe92a72a3dd..35ece5bd95c41 100644 --- a/x-pack/plugins/alerting/server/lib/is_rule_snoozed.test.ts +++ b/x-pack/plugins/alerting/server/lib/is_rule_snoozed.test.ts @@ -299,7 +299,7 @@ describe('isRuleSnoozed', () => { }, ]; - expect(isRuleSnoozed({ snoozeSchedule: snoozeScheduleA, muteAll: false })).toBe(false); + expect(isRuleSnoozed({ snoozeSchedule: snoozeScheduleA, muteAll: false })).toBe(true); const snoozeScheduleB = [ { duration: 60 * 1000, diff --git a/x-pack/plugins/alerting/server/lib/snooze/index.ts b/x-pack/plugins/alerting/server/lib/snooze/index.ts index 6c04be20ca97c..beb38a3f9650b 100644 --- a/x-pack/plugins/alerting/server/lib/snooze/index.ts +++ b/x-pack/plugins/alerting/server/lib/snooze/index.ts @@ -7,3 +7,4 @@ export { isSnoozeActive } from './is_snooze_active'; export { isSnoozeExpired } from './is_snooze_expired'; +export { utcToLocalUtc, localUtcToUtc } from './timezone_helpers'; diff --git a/x-pack/plugins/alerting/server/lib/snooze/is_snooze_active.test.ts b/x-pack/plugins/alerting/server/lib/snooze/is_snooze_active.test.ts new file mode 100644 index 0000000000000..d42824d6e840a --- /dev/null +++ b/x-pack/plugins/alerting/server/lib/snooze/is_snooze_active.test.ts @@ -0,0 +1,233 @@ +/* + * 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 moment from 'moment'; +import { RRule } from 'rrule'; +import sinon from 'sinon'; +import { RRuleRecord } from '../../types'; +import { isSnoozeActive } from './is_snooze_active'; + +let fakeTimer: sinon.SinonFakeTimers; + +describe('isSnoozeExpired', () => { + afterAll(() => fakeTimer.restore()); + + test('snooze is NOT active byweekday', () => { + // Set the current time as: + // - Feb 27 2023 08:15:00 GMT+0000 - Monday + fakeTimer = sinon.useFakeTimers(new Date('2023-02-27T06:15:00.000Z')); + + // Try to get snooze end time with: + // - Start date of: Feb 24 2023 23:00:00 GMT+0000 - Friday + // - End date of: Feb 27 2023 06:00:00 GMT+0000 - Monday + // - Which is obtained from start date + 2 days and 7 hours (198000000 ms) + const snoozeA = { + duration: 198000000, + rRule: { + byweekday: ['SA'], + tzid: 'Europe/Madrid', + freq: RRule.DAILY, + interval: 1, + dtstart: '2023-02-24T23:00:00.000Z', + } as RRuleRecord, + id: '9141dc1f-ed85-4656-91e4-119173105432', + }; + expect(isSnoozeActive(snoozeA)).toMatchInlineSnapshot(`null`); + fakeTimer.restore(); + }); + + test('snooze is active byweekday', () => { + // Set the current time as: + // - Feb 25 2023 08:15:00 GMT+0000 - Saturday + fakeTimer = sinon.useFakeTimers(new Date('2023-02-25T08:15:00.000Z')); + + // Try to get snooze end time with: + // - Start date of: Feb 24 2023 23:00:00 GMT+0000 - Friday + // - End date of: Feb 27 2023 06:00:00 GMT+0000 - Monday + // - Which is obtained from start date + 2 days and 7 hours (198000000 ms) + const snoozeA = { + duration: 198000000, + rRule: { + byweekday: ['SA'], + tzid: 'Europe/Madrid', + freq: RRule.DAILY, + interval: 1, + dtstart: '2023-02-24T23:00:00.000Z', + } as RRuleRecord, + id: '9141dc1f-ed85-4656-91e4-119173105432', + }; + expect(isSnoozeActive(snoozeA)).toMatchInlineSnapshot(` + Object { + "id": "9141dc1f-ed85-4656-91e4-119173105432", + "lastOccurrence": 2023-02-24T23:00:00.000Z, + "snoozeEndTime": 2023-02-27T06:00:00.000Z, + } + `); + fakeTimer.restore(); + }); + + test('snooze is NOT active in recurrence byweekday', () => { + // Set the current time as: + // - March 01 2023 08:15:00 GMT+0000 - Wednesday + fakeTimer = sinon.useFakeTimers(new Date('2023-03-01T08:15:00.000Z')); + + // Try to get snooze end time with: + // - Start date of: Feb 24 2023 23:00:00 GMT+0000 - Friday + // - End date of: Feb 27 2023 06:00:00 GMT+0000 - Monday + // - Which is obtained from start date + 2 days and 7 hours (198000000 ms) + const snoozeA = { + duration: 198000000, + rRule: { + byweekday: ['SA'], + tzid: 'Europe/Madrid', + freq: RRule.DAILY, + interval: 1, + dtstart: '2023-02-24T23:00:00.000Z', + } as RRuleRecord, + id: '9141dc1f-ed85-4656-91e4-119173105432', + }; + expect(isSnoozeActive(snoozeA)).toMatchInlineSnapshot(`null`); + fakeTimer.restore(); + }); + + test('snooze is active in recurrence byweekday', () => { + // Set the current time as: + // - March 04 2023 08:15:00 GMT+0000 - Saturday + fakeTimer = sinon.useFakeTimers(new Date('2023-03-04T08:15:00.000Z')); + + // Try to get snooze end time with: + // - Start date of: Feb 24 2023 23:00:00 GMT+0000 - Friday + // - End date of: Feb 27 2023 06:00:00 GMT+0000 - Monday + // - Which is obtained from start date + 2 days and 7 hours (198000000 ms) + const snoozeA = { + duration: 198000000, + rRule: { + byweekday: ['SA'], + tzid: 'Europe/Madrid', + freq: RRule.DAILY, + interval: 1, + dtstart: '2023-02-24T23:00:00.000Z', + } as RRuleRecord, + id: '9141dc1f-ed85-4656-91e4-119173105432', + }; + expect(isSnoozeActive(snoozeA)).toMatchInlineSnapshot(` + Object { + "id": "9141dc1f-ed85-4656-91e4-119173105432", + "lastOccurrence": 2023-03-04T00:00:00.000Z, + "snoozeEndTime": 2023-03-06T06:00:00.000Z, + } + `); + fakeTimer.restore(); + }); + + test('snooze is NOT active bymonth', () => { + // Set the current time as: + // - Feb 27 2023 08:15:00 GMT+0000 - Monday + fakeTimer = sinon.useFakeTimers(new Date('2023-02-09T08:15:00.000Z')); + + // Try to get snooze end time with: + // - Start date of: Jan 01 2023 00:00:00 GMT+0000 - Sunday + // - End date of: Jan 31 2023 06:00:00 GMT+0000 - Tuesday + // - Which is obtained from start date + 1 month (2629800000 ms) + const snoozeA = { + duration: moment('2023-01', 'YYYY-MM').daysInMonth() * 24 * 60 * 60 * 1000, // 1 month + rRule: { + freq: 0, + interval: 1, + bymonthday: [1], + bymonth: [1], + tzid: 'Europe/Madrid', + dtstart: '2023-01-01T00:00:00.000Z', + } as RRuleRecord, + id: '9141dc1f-ed85-4656-91e4-119173105432', + }; + expect(isSnoozeActive(snoozeA)).toMatchInlineSnapshot(`null`); + fakeTimer.restore(); + }); + + test('snooze is active bymonth', () => { + // Set the current time as: + // - Jan 25 2023 08:15:00 GMT+0000 - Saturday + fakeTimer = sinon.useFakeTimers(new Date('2023-01-25T08:15:00.000Z')); + + // Try to get snooze end time with: + // - Start date of: Jan 01 2023 00:00:00 GMT+0000 - Sunday + // - End date of: Jan 31 2023 06:00:00 GMT+0000 - Tuesday + // - Which is obtained from start date + 1 month (2629800000 ms) + const snoozeA = { + duration: moment('2023-01', 'YYYY-MM').daysInMonth() * 24 * 60 * 60 * 1000, + rRule: { + bymonthday: [1], + bymonth: [1], + tzid: 'Europe/Madrid', + freq: RRule.MONTHLY, + interval: 1, + dtstart: '2023-01-01T00:00:00.000Z', + } as RRuleRecord, + id: '9141dc1f-ed85-4656-91e4-119173105432', + }; + expect(isSnoozeActive(snoozeA)).toMatchInlineSnapshot(` + Object { + "id": "9141dc1f-ed85-4656-91e4-119173105432", + "lastOccurrence": 2023-01-01T00:00:00.000Z, + "snoozeEndTime": 2023-02-01T00:00:00.000Z, + } + `); + fakeTimer.restore(); + }); + + test('snooze is NOT active bymonth after the first month', () => { + // Set the current time as: + // - Feb 01 2023 00:00:00 GMT+0000 - Wednesday + fakeTimer = sinon.useFakeTimers(new Date('2023-02-01T00:00:00.000Z')); + + // Try to get snooze end time with: + // - Start date of: Jan 01 2023 00:00:00 GMT+0000 - Sunday + // - End date of: Jan 31 2023 06:00:00 GMT+0000 - Tuesday + // - Which is obtained from start date + 1 month (2629800000 ms) + const snoozeA = { + duration: moment('2023-01', 'YYYY-MM').daysInMonth() * 24 * 60 * 60 * 1000, + rRule: { + bymonthday: [1], + bymonth: [1], + tzid: 'Europe/Madrid', + freq: RRule.MONTHLY, + interval: 1, + dtstart: '2023-01-01T00:00:00.000Z', + } as RRuleRecord, + id: '9141dc1f-ed85-4656-91e4-119173105432', + }; + expect(isSnoozeActive(snoozeA)).toMatchInlineSnapshot(`null`); + fakeTimer.restore(); + }); + + // THIS is wrong, we need to do the same thing that we did for `byweekday` for + test('snooze is NOT active bymonth before the first month', () => { + // Set the current time as: + // - Dec 31 2022 23:00:00 GMT+0000 - Wednesday + fakeTimer = sinon.useFakeTimers(new Date('2022-12-31T21:00:00.000Z')); + + // Try to get snooze end time with: + // - Start date of: Jan 01 2023 00:00:00 GMT+0000 - Sunday + // - End date of: Jan 31 2023 06:00:00 GMT+0000 - Tuesday + // - Which is obtained from start date + 1 month (2629800000 ms) + const snoozeA = { + duration: moment('2023-01', 'YYYY-MM').daysInMonth() * 24 * 60 * 60 * 1000, + rRule: { + bymonthday: [1], + bymonth: [1], + tzid: 'Europe/Madrid', + freq: RRule.MONTHLY, + interval: 1, + dtstart: '2023-01-01T00:00:00.000Z', + } as RRuleRecord, + id: '9141dc1f-ed85-4656-91e4-119173105432', + }; + expect(isSnoozeActive(snoozeA)).toMatchInlineSnapshot(`null`); + fakeTimer.restore(); + }); +}); diff --git a/x-pack/plugins/alerting/server/lib/snooze/is_snooze_active.ts b/x-pack/plugins/alerting/server/lib/snooze/is_snooze_active.ts index e365c75df1bd0..e7081681cabff 100644 --- a/x-pack/plugins/alerting/server/lib/snooze/is_snooze_active.ts +++ b/x-pack/plugins/alerting/server/lib/snooze/is_snooze_active.ts @@ -7,6 +7,7 @@ import { RRule, ByWeekday, Weekday, rrulestr } from 'rrule'; import { RuleSnoozeSchedule } from '../../types'; +import { utcToLocalUtc, localUtcToUtc } from './timezone_helpers'; const MAX_TIMESTAMP = 8640000000000000; @@ -30,23 +31,32 @@ export function isSnoozeActive(snooze: RuleSnoozeSchedule) { }; // Check to see if now is during a recurrence of the snooze + + const { tzid, ...restRRule } = rRule; + const startDate = utcToLocalUtc(new Date(rRule.dtstart), tzid); + const nowDate = utcToLocalUtc(new Date(now), tzid); + try { const rRuleOptions = { - ...rRule, - dtstart: new Date(rRule.dtstart), - until: rRule.until ? new Date(rRule.until) : null, + ...restRRule, + dtstart: startDate, + until: rRule.until ? utcToLocalUtc(new Date(rRule.until), tzid) : null, wkst: rRule.wkst ? Weekday.fromStr(rRule.wkst) : null, byweekday: rRule.byweekday ? parseByWeekday(rRule.byweekday) : null, }; const recurrenceRule = new RRule(rRuleOptions); - const lastOccurrence = recurrenceRule.before(new Date(now), true); + const lastOccurrence = recurrenceRule.before(nowDate, true); if (!lastOccurrence) return null; // Check if the current recurrence has been skipped manually if (snooze.skipRecurrences?.includes(lastOccurrence.toISOString())) return null; const lastOccurrenceEndTime = lastOccurrence.getTime() + duration; - if (now < lastOccurrenceEndTime) - return { lastOccurrence, snoozeEndTime: new Date(lastOccurrenceEndTime), id }; + if (nowDate.getTime() < lastOccurrenceEndTime) + return { + lastOccurrence, + snoozeEndTime: localUtcToUtc(new Date(lastOccurrenceEndTime), tzid), + id, + }; } catch (e) { throw new Error(`Failed to process RRule ${rRule}: ${e}`); } diff --git a/x-pack/plugins/alerting/server/lib/snooze/timezone_helpers.ts b/x-pack/plugins/alerting/server/lib/snooze/timezone_helpers.ts new file mode 100644 index 0000000000000..e32e8623103bd --- /dev/null +++ b/x-pack/plugins/alerting/server/lib/snooze/timezone_helpers.ts @@ -0,0 +1,32 @@ +/* + * 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 moment from 'moment-timezone'; + +/** + * Converts the UTC date into the user's local time zone, but still in UTC. + * This must be done because rrule does not care about timezones, so for the result + * to be correct, we must ensure everything is timezone agnostic. + * + * example: 2023-03-29 08:00:00 CET -> 2023-03-29 08:00:00 UTC + */ +export const utcToLocalUtc = (date: Date, tz: string) => { + const localTime = moment(date).tz(tz); + const localTimeInUTC = moment(localTime).tz('UTC', true); + return localTimeInUTC.utc().toDate(); +}; + +/** + * Converts the local date in UTC back into actual UTC. After rrule does its thing, + * we would still like to keep everything in UTC in the business logic, hence why we + * need to convert everything back + * + * Example: 2023-03-29 08:00:00 UTC (from the utcToLocalUtc output) -> 2023-03-29 06:00:00 UTC (Real UTC) + */ +export const localUtcToUtc = (date: Date, tz: string) => { + const localTimeString = moment.utc(date).format('YYYY-MM-DD HH:mm:ss.SSS'); + return moment.tz(localTimeString, tz).utc().toDate(); +}; diff --git a/x-pack/plugins/apm/common/__snapshots__/apm_telemetry.test.ts.snap b/x-pack/plugins/apm/common/__snapshots__/apm_telemetry.test.ts.snap index 8a9559fc4f7b9..55bbf9d8b5fc1 100644 --- a/x-pack/plugins/apm/common/__snapshots__/apm_telemetry.test.ts.snap +++ b/x-pack/plugins/apm/common/__snapshots__/apm_telemetry.test.ts.snap @@ -76,6 +76,9 @@ exports[`APM telemetry helpers getApmTelemetry generates a JSON object with the "opentelemetry/ruby": { "type": "long" }, + "opentelemetry/rust": { + "type": "long" + }, "opentelemetry/swift": { "type": "long" }, diff --git a/x-pack/plugins/apm/common/agent_name.ts b/x-pack/plugins/apm/common/agent_name.ts index 4accb55055a55..21cecfcf348f7 100644 --- a/x-pack/plugins/apm/common/agent_name.ts +++ b/x-pack/plugins/apm/common/agent_name.ts @@ -27,6 +27,7 @@ export const OPEN_TELEMETRY_AGENT_NAMES: AgentName[] = [ 'opentelemetry/php', 'opentelemetry/python', 'opentelemetry/ruby', + 'opentelemetry/rust', 'opentelemetry/swift', 'opentelemetry/webjs', ]; diff --git a/x-pack/plugins/apm/public/components/shared/agent_icon/get_agent_icon.test.ts b/x-pack/plugins/apm/public/components/shared/agent_icon/get_agent_icon.test.ts index 66dace81b8eed..aac5fc19ca37b 100644 --- a/x-pack/plugins/apm/public/components/shared/agent_icon/get_agent_icon.test.ts +++ b/x-pack/plugins/apm/public/components/shared/agent_icon/get_agent_icon.test.ts @@ -14,7 +14,7 @@ const examples = { go: 'go', nodejs: 'nodejs', ocaml: 'ocaml', - 'opentelemetry/cpp': 'opentelemetry', + 'opentelemetry/cpp': 'cpp', 'opentelemetry/dotnet': 'dotnet', 'opentelemetry/erlang': 'erlang', 'opentelemetry/go': 'go', @@ -22,6 +22,7 @@ const examples = { 'opentelemetry/php': 'php', 'opentelemetry/python': 'python', 'opentelemetry/ruby': 'ruby', + 'opentelemetry/rust': 'rust', otlp: 'opentelemetry', php: 'php', python: 'python', diff --git a/x-pack/plugins/apm/public/components/shared/agent_icon/get_agent_icon.ts b/x-pack/plugins/apm/public/components/shared/agent_icon/get_agent_icon.ts index 1b5b782d727d0..9a775df78c4e3 100644 --- a/x-pack/plugins/apm/public/components/shared/agent_icon/get_agent_icon.ts +++ b/x-pack/plugins/apm/public/components/shared/agent_icon/get_agent_icon.ts @@ -14,8 +14,11 @@ import { } from '../../../../common/agent_name'; import { AgentName } from '../../../../typings/es_schemas/ui/fields/agent'; import defaultIcon from '../span_icon/icons/default.svg'; +import cppIcon from './icons/cpp.svg'; +import darkCppIcon from './icons/cpp_dark.svg'; import dotNetIcon from './icons/dot_net.svg'; import erlangIcon from './icons/erlang.svg'; +import darkErlangIcon from './icons/erlang_dark.svg'; import goIcon from './icons/go.svg'; import iosIcon from './icons/ios.svg'; import darkIosIcon from './icons/ios_dark.svg'; @@ -34,6 +37,7 @@ import darkRustIcon from './icons/rust_dark.svg'; import androidIcon from './icons/android.svg'; const agentIcons: { [key: string]: string } = { + cpp: cppIcon, dotnet: dotNetIcon, erlang: erlangIcon, go: goIcon, @@ -52,6 +56,8 @@ const agentIcons: { [key: string]: string } = { const darkAgentIcons: { [key: string]: string } = { ...agentIcons, + cpp: darkCppIcon, + erlang: darkErlangIcon, ios: darkIosIcon, php: darkPhpIcon, rum: darkRumJsIcon, diff --git a/x-pack/plugins/apm/public/components/shared/agent_icon/icons/cpp.svg b/x-pack/plugins/apm/public/components/shared/agent_icon/icons/cpp.svg new file mode 100644 index 0000000000000..57d5109d7c8d5 --- /dev/null +++ b/x-pack/plugins/apm/public/components/shared/agent_icon/icons/cpp.svg @@ -0,0 +1,14 @@ + + + + + \ No newline at end of file diff --git a/x-pack/plugins/apm/public/components/shared/agent_icon/icons/cpp_dark.svg b/x-pack/plugins/apm/public/components/shared/agent_icon/icons/cpp_dark.svg new file mode 100644 index 0000000000000..750e000bc60c7 --- /dev/null +++ b/x-pack/plugins/apm/public/components/shared/agent_icon/icons/cpp_dark.svg @@ -0,0 +1,14 @@ + + + + + \ No newline at end of file diff --git a/x-pack/plugins/apm/public/components/shared/agent_icon/icons/erlang_dark.svg b/x-pack/plugins/apm/public/components/shared/agent_icon/icons/erlang_dark.svg new file mode 100644 index 0000000000000..49e890157fd83 --- /dev/null +++ b/x-pack/plugins/apm/public/components/shared/agent_icon/icons/erlang_dark.svg @@ -0,0 +1 @@ + diff --git a/x-pack/plugins/apm/server/lib/apm_telemetry/schema.ts b/x-pack/plugins/apm/server/lib/apm_telemetry/schema.ts index 5156345dbafeb..3dacba9c68a07 100644 --- a/x-pack/plugins/apm/server/lib/apm_telemetry/schema.ts +++ b/x-pack/plugins/apm/server/lib/apm_telemetry/schema.ts @@ -99,6 +99,7 @@ const apmPerAgentSchema: Pick< 'opentelemetry/php': long, 'opentelemetry/python': long, 'opentelemetry/ruby': long, + 'opentelemetry/rust': long, 'opentelemetry/swift': long, 'opentelemetry/webjs': long, }, diff --git a/x-pack/plugins/apm/server/routes/agent_explorer/get_agent_url_repository.ts b/x-pack/plugins/apm/server/routes/agent_explorer/get_agent_url_repository.ts index 2ec8d5b66c4c5..64b18eff090c4 100644 --- a/x-pack/plugins/apm/server/routes/agent_explorer/get_agent_url_repository.ts +++ b/x-pack/plugins/apm/server/routes/agent_explorer/get_agent_url_repository.ts @@ -28,6 +28,7 @@ const agentsDocPageName: Partial> = { 'opentelemetry/php': 'php', 'opentelemetry/python': 'python', 'opentelemetry/ruby': 'ruby', + 'opentelemetry/rust': 'rust', 'opentelemetry/swift': 'swift', 'opentelemetry/webjs': 'js', }; diff --git a/x-pack/plugins/apm/typings/es_schemas/ui/fields/agent.ts b/x-pack/plugins/apm/typings/es_schemas/ui/fields/agent.ts index 2e29ba07d327f..4f19793004815 100644 --- a/x-pack/plugins/apm/typings/es_schemas/ui/fields/agent.ts +++ b/x-pack/plugins/apm/typings/es_schemas/ui/fields/agent.ts @@ -29,6 +29,7 @@ export type OpenTelemetryAgentName = | 'opentelemetry/php' | 'opentelemetry/python' | 'opentelemetry/ruby' + | 'opentelemetry/rust' | 'opentelemetry/swift' | 'opentelemetry/webjs'; diff --git a/x-pack/plugins/asset_manager/docs/index.md b/x-pack/plugins/asset_manager/docs/index.md index a6c3be63fba2d..8ed01ac575c9f 100644 --- a/x-pack/plugins/asset_manager/docs/index.md +++ b/x-pack/plugins/asset_manager/docs/index.md @@ -406,6 +406,638 @@ GET /assets?from=2023-03-25T17:44:44.000Z&to=2023-03-25T18:44:44.000Z&ean=k8s.no +### GET /assets/diff + +Returns assets found in the two time ranges, split by what occurs in only either or in both. + +#### Request + +| Option | Type | Required? | Default | Description | +| :--- | :--- | :--- | :--- | :--- | +| aFrom | RangeDate | Yes | N/A | Starting point for baseline date range to search for assets within | +| aTo | RangeDate | Yes | N/A | End point for baseline date range to search for assets within | +| bFrom | RangeDate | Yes | N/A | Starting point for comparison date range | +| bTo | RangeDate | Yes | N/A | End point for comparison date range | +| type | AssetType[] | No | all | Restrict results to one or more asset.type value | + +#### Responses + +
+ +Request where comparison range is missing assets that are found in the baseline range + +```curl +GET /assets/diff?aFrom=2022-02-07T00:00:00.000Z&aTo=2022-02-07T01:30:00.000Z&bFrom=2022-02-07T01:00:00.000Z&bTo=2022-02-07T02:00:00.000Z + +{ + "onlyInA": [ + { + "@timestamp": "2022-02-07T00:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200xrg1", + "asset.name": "k8s-pod-200xrg1-aws", + "asset.ean": "k8s.pod:pod-200xrg1", + "asset.parents": [ + "k8s.node:node-101" + ] + }, + { + "@timestamp": "2022-02-07T00:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200dfp2", + "asset.name": "k8s-pod-200dfp2-aws", + "asset.ean": "k8s.pod:pod-200dfp2", + "asset.parents": [ + "k8s.node:node-101" + ] + } + ], + "onlyInB": [], + "inBoth": [ + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.cluster", + "asset.id": "cluster-001", + "asset.name": "Cluster 001 (AWS EKS)", + "asset.ean": "k8s.cluster:cluster-001", + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.cluster", + "asset.id": "cluster-002", + "asset.name": "Cluster 002 (Azure AKS)", + "asset.ean": "k8s.cluster:cluster-002", + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 002 (Azure AKS)", + "orchestrator.cluster.id": "cluster-002", + "cloud.provider": "azure", + "cloud.region": "eu-west", + "cloud.service.name": "aks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.node", + "asset.id": "node-101", + "asset.name": "k8s-node-101-aws", + "asset.ean": "k8s.node:node-101", + "asset.parents": [ + "k8s.cluster:cluster-001" + ], + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.node", + "asset.id": "node-102", + "asset.name": "k8s-node-102-aws", + "asset.ean": "k8s.node:node-102", + "asset.parents": [ + "k8s.cluster:cluster-001" + ], + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.node", + "asset.id": "node-103", + "asset.name": "k8s-node-103-aws", + "asset.ean": "k8s.node:node-103", + "asset.parents": [ + "k8s.cluster:cluster-001" + ], + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200ohr5", + "asset.name": "k8s-pod-200ohr5-aws", + "asset.ean": "k8s.pod:pod-200ohr5", + "asset.parents": [ + "k8s.node:node-102" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200yyx6", + "asset.name": "k8s-pod-200yyx6-aws", + "asset.ean": "k8s.pod:pod-200yyx6", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200psd7", + "asset.name": "k8s-pod-200psd7-aws", + "asset.ean": "k8s.pod:pod-200psd7", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200wmc8", + "asset.name": "k8s-pod-200wmc8-aws", + "asset.ean": "k8s.pod:pod-200wmc8", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200ugg9", + "asset.name": "k8s-pod-200ugg9-aws", + "asset.ean": "k8s.pod:pod-200ugg9", + "asset.parents": [ + "k8s.node:node-103" + ] + } + ] +} +``` + +
+ +
+ +Request where baseline range is missing assets that are found in the comparison range + +```curl +GET /assets/diff?aFrom=2022-02-07T01:00:00.000Z&aTo=2022-02-07T01:30:00.000Z&bFrom=2022-02-07T01:00:00.000Z&bTo=2022-02-07T03:00:00.000Z + +{ + "onlyInA": [], + "onlyInB": [ + { + "@timestamp": "2022-02-07T03:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200wwc3", + "asset.name": "k8s-pod-200wwc3-aws", + "asset.ean": "k8s.pod:pod-200wwc3", + "asset.parents": [ + "k8s.node:node-101" + ] + }, + { + "@timestamp": "2022-02-07T03:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200naq4", + "asset.name": "k8s-pod-200naq4-aws", + "asset.ean": "k8s.pod:pod-200naq4", + "asset.parents": [ + "k8s.node:node-102" + ] + } + ], + "inBoth": [ + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.cluster", + "asset.id": "cluster-001", + "asset.name": "Cluster 001 (AWS EKS)", + "asset.ean": "k8s.cluster:cluster-001", + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.cluster", + "asset.id": "cluster-002", + "asset.name": "Cluster 002 (Azure AKS)", + "asset.ean": "k8s.cluster:cluster-002", + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 002 (Azure AKS)", + "orchestrator.cluster.id": "cluster-002", + "cloud.provider": "azure", + "cloud.region": "eu-west", + "cloud.service.name": "aks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.node", + "asset.id": "node-101", + "asset.name": "k8s-node-101-aws", + "asset.ean": "k8s.node:node-101", + "asset.parents": [ + "k8s.cluster:cluster-001" + ], + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.node", + "asset.id": "node-102", + "asset.name": "k8s-node-102-aws", + "asset.ean": "k8s.node:node-102", + "asset.parents": [ + "k8s.cluster:cluster-001" + ], + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.node", + "asset.id": "node-103", + "asset.name": "k8s-node-103-aws", + "asset.ean": "k8s.node:node-103", + "asset.parents": [ + "k8s.cluster:cluster-001" + ], + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200ohr5", + "asset.name": "k8s-pod-200ohr5-aws", + "asset.ean": "k8s.pod:pod-200ohr5", + "asset.parents": [ + "k8s.node:node-102" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200yyx6", + "asset.name": "k8s-pod-200yyx6-aws", + "asset.ean": "k8s.pod:pod-200yyx6", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200psd7", + "asset.name": "k8s-pod-200psd7-aws", + "asset.ean": "k8s.pod:pod-200psd7", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200wmc8", + "asset.name": "k8s-pod-200wmc8-aws", + "asset.ean": "k8s.pod:pod-200wmc8", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200ugg9", + "asset.name": "k8s-pod-200ugg9-aws", + "asset.ean": "k8s.pod:pod-200ugg9", + "asset.parents": [ + "k8s.node:node-103" + ] + } + ] +} +``` + +
+ +
+ +Request where each range is missing assets found in the other range + +```curl +GET /assets/diff?aFrom=2022-02-07T00:00:00.000Z&aTo=2022-02-07T01:30:00.000Z&bFrom=2022-02-07T01:00:00.000Z&bTo=2022-02-07T03:00:00.000Z + +{ + "onlyInA": [ + { + "@timestamp": "2022-02-07T00:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200xrg1", + "asset.name": "k8s-pod-200xrg1-aws", + "asset.ean": "k8s.pod:pod-200xrg1", + "asset.parents": [ + "k8s.node:node-101" + ] + }, + { + "@timestamp": "2022-02-07T00:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200dfp2", + "asset.name": "k8s-pod-200dfp2-aws", + "asset.ean": "k8s.pod:pod-200dfp2", + "asset.parents": [ + "k8s.node:node-101" + ] + } + ], + "onlyInB": [ + { + "@timestamp": "2022-02-07T03:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200wwc3", + "asset.name": "k8s-pod-200wwc3-aws", + "asset.ean": "k8s.pod:pod-200wwc3", + "asset.parents": [ + "k8s.node:node-101" + ] + }, + { + "@timestamp": "2022-02-07T03:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200naq4", + "asset.name": "k8s-pod-200naq4-aws", + "asset.ean": "k8s.pod:pod-200naq4", + "asset.parents": [ + "k8s.node:node-102" + ] + } + ], + "inBoth": [ + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.cluster", + "asset.id": "cluster-001", + "asset.name": "Cluster 001 (AWS EKS)", + "asset.ean": "k8s.cluster:cluster-001", + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.cluster", + "asset.id": "cluster-002", + "asset.name": "Cluster 002 (Azure AKS)", + "asset.ean": "k8s.cluster:cluster-002", + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 002 (Azure AKS)", + "orchestrator.cluster.id": "cluster-002", + "cloud.provider": "azure", + "cloud.region": "eu-west", + "cloud.service.name": "aks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.node", + "asset.id": "node-101", + "asset.name": "k8s-node-101-aws", + "asset.ean": "k8s.node:node-101", + "asset.parents": [ + "k8s.cluster:cluster-001" + ], + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.node", + "asset.id": "node-102", + "asset.name": "k8s-node-102-aws", + "asset.ean": "k8s.node:node-102", + "asset.parents": [ + "k8s.cluster:cluster-001" + ], + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.node", + "asset.id": "node-103", + "asset.name": "k8s-node-103-aws", + "asset.ean": "k8s.node:node-103", + "asset.parents": [ + "k8s.cluster:cluster-001" + ], + "orchestrator.type": "kubernetes", + "orchestrator.cluster.name": "Cluster 001 (AWS EKS)", + "orchestrator.cluster.id": "cluster-001", + "cloud.provider": "aws", + "cloud.region": "us-east-1", + "cloud.service.name": "eks" + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200ohr5", + "asset.name": "k8s-pod-200ohr5-aws", + "asset.ean": "k8s.pod:pod-200ohr5", + "asset.parents": [ + "k8s.node:node-102" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200yyx6", + "asset.name": "k8s-pod-200yyx6-aws", + "asset.ean": "k8s.pod:pod-200yyx6", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200psd7", + "asset.name": "k8s-pod-200psd7-aws", + "asset.ean": "k8s.pod:pod-200psd7", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200wmc8", + "asset.name": "k8s-pod-200wmc8-aws", + "asset.ean": "k8s.pod:pod-200wmc8", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200ugg9", + "asset.name": "k8s-pod-200ugg9-aws", + "asset.ean": "k8s.pod:pod-200ugg9", + "asset.parents": [ + "k8s.node:node-103" + ] + } + ] +} +``` + +
+ +
+ +Request where each range is missing assets found in the other range, but restricted by type + +```curl +GET /assets/diff?aFrom=2022-02-07T00:00:00.000Z&aTo=2022-02-07T01:30:00.000Z&bFrom=2022-02-07T01:00:00.000Z&bTo=2022-02-07T03:00:00.000Z&type=k8s.pod + +{ + "onlyInA": [ + { + "@timestamp": "2022-02-07T00:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200xrg1", + "asset.name": "k8s-pod-200xrg1-aws", + "asset.ean": "k8s.pod:pod-200xrg1", + "asset.parents": [ + "k8s.node:node-101" + ] + }, + { + "@timestamp": "2022-02-07T00:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200dfp2", + "asset.name": "k8s-pod-200dfp2-aws", + "asset.ean": "k8s.pod:pod-200dfp2", + "asset.parents": [ + "k8s.node:node-101" + ] + } + ], + "onlyInB": [ + { + "@timestamp": "2022-02-07T03:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200wwc3", + "asset.name": "k8s-pod-200wwc3-aws", + "asset.ean": "k8s.pod:pod-200wwc3", + "asset.parents": [ + "k8s.node:node-101" + ] + }, + { + "@timestamp": "2022-02-07T03:00:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200naq4", + "asset.name": "k8s-pod-200naq4-aws", + "asset.ean": "k8s.pod:pod-200naq4", + "asset.parents": [ + "k8s.node:node-102" + ] + } + ], + "inBoth": [ + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200ohr5", + "asset.name": "k8s-pod-200ohr5-aws", + "asset.ean": "k8s.pod:pod-200ohr5", + "asset.parents": [ + "k8s.node:node-102" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200yyx6", + "asset.name": "k8s-pod-200yyx6-aws", + "asset.ean": "k8s.pod:pod-200yyx6", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200psd7", + "asset.name": "k8s-pod-200psd7-aws", + "asset.ean": "k8s.pod:pod-200psd7", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200wmc8", + "asset.name": "k8s-pod-200wmc8-aws", + "asset.ean": "k8s.pod:pod-200wmc8", + "asset.parents": [ + "k8s.node:node-103" + ] + }, + { + "@timestamp": "2022-02-07T01:30:00.000Z", + "asset.type": "k8s.pod", + "asset.id": "pod-200ugg9", + "asset.name": "k8s-pod-200ugg9-aws", + "asset.ean": "k8s.pod:pod-200ugg9", + "asset.parents": [ + "k8s.node:node-103" + ] + } + ] +} +``` + +
+ #### GET /assets/sample Returns the list of pre-defined sample asset documents that would be indexed diff --git a/x-pack/plugins/asset_manager/server/routes/assets.ts b/x-pack/plugins/asset_manager/server/routes/assets.ts index 391cbb7c173de..d1b4d839913e4 100644 --- a/x-pack/plugins/asset_manager/server/routes/assets.ts +++ b/x-pack/plugins/asset_manager/server/routes/assets.ts @@ -7,6 +7,7 @@ import { schema } from '@kbn/config-schema'; import { RequestHandlerContext } from '@kbn/core/server'; +import { differenceBy, intersectionBy } from 'lodash'; import { debug } from '../../common/debug_log'; import { ASSET_MANAGER_API_BASE } from '../constants'; import { getAssets } from '../lib/get_assets'; @@ -56,4 +57,73 @@ export function assetsRoutes({ router }: SetupR } } ); + + // GET /assets/diff + const getAssetsDiffQueryOptions = schema.object({ + aFrom: schema.string(), + aTo: schema.string(), + bFrom: schema.string(), + bTo: schema.string(), + type: schema.maybe(schema.oneOf([schema.arrayOf(assetType), assetType])), + }); + router.get( + { + path: `${ASSET_MANAGER_API_BASE}/assets/diff`, + validate: { + query: getAssetsDiffQueryOptions, + }, + }, + async (context, req, res) => { + const { aFrom, aTo, bFrom, bTo, type } = req.query; + + if (new Date(aFrom) > new Date(aTo)) { + return res.badRequest({ + body: `Time range cannot move backwards in time. "aTo" (${aTo}) is before "aFrom" (${aFrom}).`, + }); + } + + if (new Date(bFrom) > new Date(bTo)) { + return res.badRequest({ + body: `Time range cannot move backwards in time. "bTo" (${bTo}) is before "bFrom" (${bFrom}).`, + }); + } + + const esClient = await getEsClientFromContext(context); + + try { + const resultsForA = await getAssets({ + esClient, + filters: { + from: aFrom, + to: aTo, + type, + }, + }); + + const resultsForB = await getAssets({ + esClient, + filters: { + from: bFrom, + to: bTo, + type, + }, + }); + + const onlyInA = differenceBy(resultsForA, resultsForB, 'asset.ean'); + const onlyInB = differenceBy(resultsForB, resultsForA, 'asset.ean'); + const inBoth = intersectionBy(resultsForA, resultsForB, 'asset.ean'); + + return res.ok({ + body: { + onlyInA, + onlyInB, + inBoth, + }, + }); + } catch (error: unknown) { + debug('error looking up asset records', error); + return res.customError({ statusCode: 500 }); + } + } + ); } diff --git a/x-pack/plugins/canvas/canvas_plugin_src/uis/arguments/image_upload/index.js b/x-pack/plugins/canvas/canvas_plugin_src/uis/arguments/image_upload/index.js index 8534257a95868..0ed55c9823383 100644 --- a/x-pack/plugins/canvas/canvas_plugin_src/uis/arguments/image_upload/index.js +++ b/x-pack/plugins/canvas/canvas_plugin_src/uis/arguments/image_upload/index.js @@ -14,7 +14,7 @@ import { getElasticOutline, isValidHttpUrl, resolveFromArgs, -} from '@kbn/presentation-util-plugin/public'; +} from '@kbn/presentation-util-plugin/common'; import { AssetPicker } from '../../../../public/components/asset_picker'; import { templateFromReactComponent } from '../../../../public/lib/template_from_react_component'; import { VALID_IMAGE_TYPES } from '../../../../common/lib/constants'; diff --git a/x-pack/plugins/canvas/public/components/workpad_header/workpad_header.component.tsx b/x-pack/plugins/canvas/public/components/workpad_header/workpad_header.component.tsx index ddac56a5a7731..d6988117d63b2 100644 --- a/x-pack/plugins/canvas/public/components/workpad_header/workpad_header.component.tsx +++ b/x-pack/plugins/canvas/public/components/workpad_header/workpad_header.component.tsx @@ -144,17 +144,17 @@ export const WorkpadHeader: FC = ({ { iconType: 'visText', label: elementStrings.markdown.displayName, - onClick: () => createElement('markdown'), + onClick: createElement('markdown'), }, { iconType: 'node', label: elementStrings.shape.displayName, - onClick: () => createElement('shape'), + onClick: createElement('shape'), }, { iconType: 'image', label: elementStrings.image.displayName, - onClick: () => createElement('image'), + onClick: createElement('image'), }, ]; diff --git a/x-pack/plugins/canvas/server/config.test.ts b/x-pack/plugins/canvas/server/config.test.ts new file mode 100644 index 0000000000000..4c66c718d1b2d --- /dev/null +++ b/x-pack/plugins/canvas/server/config.test.ts @@ -0,0 +1,53 @@ +/* + * 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. + */ + +jest.mock('crypto', () => ({ + randomBytes: jest.fn(), + constants: jest.requireActual('crypto').constants, +})); + +jest.mock('@kbn/utils', () => ({ + getLogsPath: () => '/mock/kibana/logs/path', +})); + +import { ConfigSchema } from './config'; + +describe('config schema', () => { + it('generates proper defaults', () => { + expect(ConfigSchema.validate({})).toMatchInlineSnapshot(` + Object { + "enabled": true, + } + `); + + expect(ConfigSchema.validate({}, { dev: false })).toMatchInlineSnapshot(` + Object { + "enabled": true, + } + `); + + expect(ConfigSchema.validate({}, { dev: true })).toMatchInlineSnapshot(` + Object { + "enabled": true, + } + `); + }); + + it('should throw error if spaces is disabled', () => { + expect(() => ConfigSchema.validate({ enabled: false })).toThrow( + '[enabled]: Canvas can only be disabled in development mode' + ); + + expect(() => ConfigSchema.validate({ enabled: false }, { dev: false })).toThrow( + '[enabled]: Canvas can only be disabled in development mode' + ); + }); + + it('should not throw error if spaces is disabled in development mode', () => { + expect(() => ConfigSchema.validate({ enabled: false }, { dev: true })).not.toThrow(); + }); +}); diff --git a/x-pack/plugins/canvas/server/config.ts b/x-pack/plugins/canvas/server/config.ts new file mode 100644 index 0000000000000..6cbcff6930d88 --- /dev/null +++ b/x-pack/plugins/canvas/server/config.ts @@ -0,0 +1,24 @@ +/* + * 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 { schema } from '@kbn/config-schema'; + +export const ConfigSchema = schema.object({ + enabled: schema.conditional( + schema.contextRef('dev'), + true, + schema.boolean({ defaultValue: true }), + schema.boolean({ + validate: (rawValue) => { + if (rawValue === false) { + return 'Canvas can only be disabled in development mode'; + } + }, + defaultValue: true, + }) + ), +}); diff --git a/x-pack/plugins/canvas/server/index.ts b/x-pack/plugins/canvas/server/index.ts index d6d375b7259ac..74c5810481e00 100644 --- a/x-pack/plugins/canvas/server/index.ts +++ b/x-pack/plugins/canvas/server/index.ts @@ -5,8 +5,13 @@ * 2.0. */ -import { PluginInitializerContext } from '@kbn/core/server'; +import { PluginConfigDescriptor, PluginInitializerContext } from '@kbn/core/server'; import { CanvasPlugin } from './plugin'; +import { ConfigSchema } from './config'; + +export const config: PluginConfigDescriptor = { + schema: ConfigSchema, +}; export const plugin = (initializerContext: PluginInitializerContext) => new CanvasPlugin(initializerContext); diff --git a/x-pack/plugins/canvas/server/plugin.ts b/x-pack/plugins/canvas/server/plugin.ts index 3fcea2b5694c5..ec5cb4969be19 100644 --- a/x-pack/plugins/canvas/server/plugin.ts +++ b/x-pack/plugins/canvas/server/plugin.ts @@ -45,6 +45,7 @@ interface PluginsStart { export class CanvasPlugin implements Plugin { private readonly logger: Logger; + constructor(public readonly initializerContext: PluginInitializerContext) { this.logger = initializerContext.logger.get(); } diff --git a/x-pack/plugins/cases/public/api/decoders.ts b/x-pack/plugins/cases/public/api/decoders.ts index 1022e0583f8dc..6402b2d56a342 100644 --- a/x-pack/plugins/cases/public/api/decoders.ts +++ b/x-pack/plugins/cases/public/api/decoders.ts @@ -15,10 +15,14 @@ import type { CasesFindResponse, CasesStatusResponse, CasesMetricsResponse, + CasesBulkGetResponseCertainFields, + CaseResponse, } from '../../common/api'; import { CasesFindResponseRt, CasesStatusResponseRt, + CasesResponseRt, + getTypeForCertainFieldsFromArray, CasesMetricsResponseRt, } from '../../common/api'; @@ -36,3 +40,13 @@ export const decodeCasesMetricsResponse = (metrics?: CasesMetricsResponse) => CasesMetricsResponseRt.decode(metrics), fold(throwErrors(createToasterPlainError), identity) ); + +export const decodeCasesBulkGetResponse = ( + res: CasesBulkGetResponseCertainFields, + fields?: string[] +) => { + const typeToDecode = getTypeForCertainFieldsFromArray(CasesResponseRt, fields); + pipe(typeToDecode.decode(res.cases), fold(throwErrors(createToasterPlainError), identity)); + + return res; +}; diff --git a/x-pack/plugins/cases/public/api/index.test.ts b/x-pack/plugins/cases/public/api/index.test.ts index 321a1db206846..c64a204183bed 100644 --- a/x-pack/plugins/cases/public/api/index.test.ts +++ b/x-pack/plugins/cases/public/api/index.test.ts @@ -6,8 +6,8 @@ */ import { httpServiceMock } from '@kbn/core/public/mocks'; -import { getCases, getCasesMetrics } from '.'; -import { allCases, allCasesSnake } from '../containers/mock'; +import { bulkGetCases, getCases, getCasesMetrics } from '.'; +import { allCases, allCasesSnake, casesSnake } from '../containers/mock'; describe('api', () => { beforeEach(() => { @@ -47,4 +47,31 @@ describe('api', () => { }); }); }); + + describe('bulkGetCases', () => { + const http = httpServiceMock.createStartContract({ basePath: '' }); + http.post.mockResolvedValue({ cases: [{ title: 'test' }], errors: [] }); + + it('should return the correct cases with a subset of fields', async () => { + expect(await bulkGetCases({ http, params: { ids: ['test'], fields: ['title'] } })).toEqual({ + cases: [{ title: 'test' }], + errors: [], + }); + }); + + it('should return the correct cases with all fields', async () => { + http.post.mockResolvedValueOnce({ cases: casesSnake, errors: [] }); + expect(await bulkGetCases({ http, params: { ids: ['test'] } })).toEqual({ + cases: casesSnake, + errors: [], + }); + }); + + it('should have been called with the correct path', async () => { + await bulkGetCases({ http, params: { ids: ['test'], fields: ['title'] } }); + expect(http.post).toHaveBeenCalledWith('/internal/cases/_bulk_get', { + body: '{"ids":["test"],"fields":["title"]}', + }); + }); + }); }); diff --git a/x-pack/plugins/cases/public/api/index.ts b/x-pack/plugins/cases/public/api/index.ts index 47cc0b6f108a8..c89b1ff94f9e9 100644 --- a/x-pack/plugins/cases/public/api/index.ts +++ b/x-pack/plugins/cases/public/api/index.ts @@ -7,8 +7,16 @@ import type { HttpStart } from '@kbn/core/public'; import type { Cases, CasesStatus, CasesMetrics } from '../../common/ui'; -import { CASE_FIND_URL, CASE_METRICS_URL, CASE_STATUS_URL } from '../../common/constants'; +import { + CASE_FIND_URL, + CASE_METRICS_URL, + CASE_STATUS_URL, + INTERNAL_BULK_GET_CASES_URL, +} from '../../common/constants'; import type { + CaseResponse, + CasesBulkGetRequestCertainFields, + CasesBulkGetResponseCertainFields, CasesFindRequest, CasesFindResponse, CasesMetricsRequest, @@ -18,6 +26,7 @@ import type { } from '../../common/api'; import { convertAllCasesToCamel, convertToCamelCase } from './utils'; import { + decodeCasesBulkGetResponse, decodeCasesFindResponse, decodeCasesMetricsResponse, decodeCasesStatusResponse, @@ -58,3 +67,21 @@ export const getCasesMetrics = async ({ const res = await http.get(CASE_METRICS_URL, { signal, query }); return convertToCamelCase(decodeCasesMetricsResponse(res)); }; + +export const bulkGetCases = async ({ + http, + signal, + params, +}: HTTPService & { params: CasesBulkGetRequestCertainFields }): Promise< + CasesBulkGetResponseCertainFields +> => { + const res = await http.post>( + INTERNAL_BULK_GET_CASES_URL, + { + body: JSON.stringify({ ...params }), + signal, + } + ); + + return decodeCasesBulkGetResponse(res, params.fields); +}; diff --git a/x-pack/plugins/cases/public/client/api/index.test.ts b/x-pack/plugins/cases/public/client/api/index.test.ts index dacea3350bd4a..f53de5eb20f18 100644 --- a/x-pack/plugins/cases/public/client/api/index.test.ts +++ b/x-pack/plugins/cases/public/client/api/index.test.ts @@ -7,7 +7,7 @@ import { httpServiceMock } from '@kbn/core/public/mocks'; import { createClientAPI } from '.'; -import { allCases, allCasesSnake } from '../../containers/mock'; +import { allCases, allCasesSnake, casesSnake } from '../../containers/mock'; describe('createClientAPI', () => { beforeEach(() => { @@ -80,5 +80,33 @@ describe('createClientAPI', () => { }); }); }); + + describe('bulkGet', () => { + const http = httpServiceMock.createStartContract({ basePath: '' }); + const api = createClientAPI({ http }); + http.post.mockResolvedValue({ cases: [{ title: 'test' }], errors: [] }); + + it('should return the correct cases with a subset of fields', async () => { + expect(await api.cases.bulkGet({ ids: ['test'], fields: ['title'] })).toEqual({ + cases: [{ title: 'test' }], + errors: [], + }); + }); + + it('should return the correct cases with all fields', async () => { + http.post.mockResolvedValueOnce({ cases: casesSnake, errors: [] }); + expect(await api.cases.bulkGet({ ids: ['test'], fields: ['title'] })).toEqual({ + cases: casesSnake, + errors: [], + }); + }); + + it('should have been called with the correct path', async () => { + await api.cases.bulkGet({ ids: ['test'], fields: ['title'] }); + expect(http.post).toHaveBeenCalledWith('/internal/cases/_bulk_get', { + body: '{"ids":["test"],"fields":["title"]}', + }); + }); + }); }); }); diff --git a/x-pack/plugins/cases/public/client/api/index.ts b/x-pack/plugins/cases/public/client/api/index.ts index 6d902940c2200..09a172121d08c 100644 --- a/x-pack/plugins/cases/public/client/api/index.ts +++ b/x-pack/plugins/cases/public/client/api/index.ts @@ -15,7 +15,7 @@ import type { } from '../../../common/api'; import { getCasesFromAlertsUrl } from '../../../common/api'; import type { Cases, CasesStatus, CasesMetrics } from '../../../common/ui'; -import { getCases, getCasesMetrics, getCasesStatus } from '../../api'; +import { bulkGetCases, getCases, getCasesMetrics, getCasesStatus } from '../../api'; import type { CasesUiStart } from '../../types'; export const createClientAPI = ({ http }: { http: HttpStart }): CasesUiStart['api'] => { @@ -32,6 +32,7 @@ export const createClientAPI = ({ http }: { http: HttpStart }): CasesUiStart['ap getCasesStatus({ http, query, signal }), getCasesMetrics: (query: CasesMetricsRequest, signal?: AbortSignal): Promise => getCasesMetrics({ http, signal, query }), + bulkGet: (params, signal?: AbortSignal) => bulkGetCases({ http, signal, params }), }, }; }; diff --git a/x-pack/plugins/cases/public/client/attachment_framework/types.ts b/x-pack/plugins/cases/public/client/attachment_framework/types.ts index ea5c046a37e7c..414b8a0086654 100644 --- a/x-pack/plugins/cases/public/client/attachment_framework/types.ts +++ b/x-pack/plugins/cases/public/client/attachment_framework/types.ts @@ -6,16 +6,24 @@ */ import type React from 'react'; -import type { EuiCommentProps, IconType } from '@elastic/eui'; +import type { EuiCommentProps, IconType, EuiButtonProps } from '@elastic/eui'; import type { CommentRequestExternalReferenceType, CommentRequestPersistableStateType, } from '../../../common/api'; import type { Case } from '../../containers/types'; +export interface AttachmentAction { + onClick: () => void; + iconType: string; + label: string; + color?: EuiButtonProps['color']; + isPrimary?: boolean; +} + export interface AttachmentViewObject { timelineAvatar?: EuiCommentProps['timelineAvatar']; - actions?: EuiCommentProps['actions']; + getActions?: (props: Props) => AttachmentAction[]; event?: EuiCommentProps['event']; children?: React.LazyExoticComponent>; } @@ -39,6 +47,7 @@ export interface AttachmentType { icon: IconType; displayName: string; getAttachmentViewObject: () => AttachmentViewObject; + getAttachmentRemovalObject?: (props: Props) => Pick, 'event'>; } export type ExternalReferenceAttachmentType = AttachmentType; diff --git a/x-pack/plugins/cases/public/components/user_actions/comment/comment.test.tsx b/x-pack/plugins/cases/public/components/user_actions/comment/comment.test.tsx index 92942caf936ac..db21c2f2100c6 100644 --- a/x-pack/plugins/cases/public/components/user_actions/comment/comment.test.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/comment/comment.test.tsx @@ -140,6 +140,69 @@ describe('createCommentUserActionBuilder', () => { expect(screen.getByText('removed attachment')).toBeInTheDocument(); }); + it('renders correctly when deleting an external reference attachment with getAttachmentRemovalObject defined', async () => { + const getAttachmentRemovalObject = jest.fn().mockReturnValue({ + event: 'removed my own attachment', + }); + + const externalReferenceAttachmentTypeRegistry = new ExternalReferenceAttachmentTypeRegistry(); + const attachment = getExternalReferenceAttachment(); + externalReferenceAttachmentTypeRegistry.register({ + ...attachment, + getAttachmentRemovalObject, + }); + + const userAction = getExternalReferenceUserAction({ action: Actions.delete }); + const builder = createCommentUserActionBuilder({ + ...builderArgs, + externalReferenceAttachmentTypeRegistry, + userAction, + caseData: { + ...builderArgs.caseData, + comments: [externalReferenceAttachment], + }, + }); + + const createdUserAction = builder.build(); + render( + + + + ); + + expect(screen.getByText('removed my own attachment')).toBeInTheDocument(); + expect(getAttachmentRemovalObject).toBeCalledWith({ + caseData: { + id: 'basic-case-id', + title: 'Another horrible breach!!', + }, + externalReferenceId: 'my-id', + externalReferenceMetadata: null, + }); + }); + + it('renders correctly when deleting an external reference attachment without getAttachmentRemovalObject defined', async () => { + const externalReferenceAttachmentTypeRegistry = new ExternalReferenceAttachmentTypeRegistry(); + const attachment = getExternalReferenceAttachment(); + externalReferenceAttachmentTypeRegistry.register(attachment); + + const userAction = getExternalReferenceUserAction({ action: Actions.delete }); + const builder = createCommentUserActionBuilder({ + ...builderArgs, + externalReferenceAttachmentTypeRegistry, + userAction, + }); + + const createdUserAction = builder.build(); + render( + + + + ); + + expect(screen.getByText('removed attachment')).toBeInTheDocument(); + }); + it('renders correctly when deleting a persistable state attachment', async () => { const userAction = getPersistableStateUserAction({ action: Actions.delete }); const builder = createCommentUserActionBuilder({ @@ -156,6 +219,71 @@ describe('createCommentUserActionBuilder', () => { expect(screen.getByText('removed attachment')).toBeInTheDocument(); }); + + it('renders correctly when deleting a persistable state attachment with getAttachmentRemovalObject defined', async () => { + const getAttachmentRemovalObject = jest.fn().mockReturnValue({ + event: 'removed my own attachment', + }); + + const persistableStateAttachmentTypeRegistry = new PersistableStateAttachmentTypeRegistry(); + const attachment = getPersistableStateAttachment(); + persistableStateAttachmentTypeRegistry.register({ + ...attachment, + getAttachmentRemovalObject, + }); + + const userAction = getPersistableStateUserAction({ action: Actions.delete }); + const builder = createCommentUserActionBuilder({ + ...builderArgs, + persistableStateAttachmentTypeRegistry, + userAction, + caseData: { + ...builderArgs.caseData, + comments: [persistableStateAttachment], + }, + }); + + const createdUserAction = builder.build(); + render( + + + + ); + + expect(screen.getByText('removed my own attachment')).toBeInTheDocument(); + expect(getAttachmentRemovalObject).toBeCalledWith({ + caseData: { + id: 'basic-case-id', + title: 'Another horrible breach!!', + }, + persistableStateAttachmentTypeId: '.test', + persistableStateAttachmentState: { + test_foo: 'foo', + }, + }); + }); + + it('renders correctly when deleting a persistable state attachment without getAttachmentRemovalObject defined', async () => { + const persistableStateAttachmentTypeRegistry = new PersistableStateAttachmentTypeRegistry(); + const attachment = getPersistableStateAttachment(); + persistableStateAttachmentTypeRegistry.register(attachment); + + const userAction = getPersistableStateUserAction({ action: Actions.delete }); + const builder = createCommentUserActionBuilder({ + ...builderArgs, + persistableStateAttachmentTypeRegistry, + userAction, + }); + + const createdUserAction = builder.build(); + render( + + + + ); + + expect(screen.getByText('removed attachment')).toBeInTheDocument(); + }); }); describe('user comments', () => { @@ -196,7 +324,7 @@ describe('createCommentUserActionBuilder', () => { ); - expect(result.getByText('Solve this fast!')).toBeInTheDocument(); + expect(screen.getByText('Solve this fast!')).toBeInTheDocument(); await deleteAttachment(result, 'trash', 'Delete'); @@ -219,20 +347,20 @@ describe('createCommentUserActionBuilder', () => { }); const createdUserAction = builder.build(); - const result = render( + render( ); - expect(result.getByText('Solve this fast!')).toBeInTheDocument(); - expect(result.getByTestId('property-actions-user-action')).toBeInTheDocument(); + expect(screen.getByText('Solve this fast!')).toBeInTheDocument(); + expect(screen.getByTestId('property-actions-user-action')).toBeInTheDocument(); - userEvent.click(result.getByTestId('property-actions-user-action-ellipses')); + userEvent.click(screen.getByTestId('property-actions-user-action-ellipses')); await waitForEuiPopoverOpen(); - expect(result.queryByTestId('property-actions-user-action-pencil')).toBeInTheDocument(); - userEvent.click(result.getByTestId('property-actions-user-action-pencil')); + expect(screen.queryByTestId('property-actions-user-action-pencil')).toBeInTheDocument(); + userEvent.click(screen.getByTestId('property-actions-user-action-pencil')); await waitFor(() => { expect(builderArgs.handleManageMarkdownEditId).toHaveBeenCalledWith('basic-comment-id'); @@ -250,20 +378,20 @@ describe('createCommentUserActionBuilder', () => { }); const createdUserAction = builder.build(); - const result = render( + render( ); - expect(result.getByText('Solve this fast!')).toBeInTheDocument(); - expect(result.getByTestId('property-actions-user-action')).toBeInTheDocument(); + expect(screen.getByText('Solve this fast!')).toBeInTheDocument(); + expect(screen.getByTestId('property-actions-user-action')).toBeInTheDocument(); - userEvent.click(result.getByTestId('property-actions-user-action-ellipses')); + userEvent.click(screen.getByTestId('property-actions-user-action-ellipses')); await waitForEuiPopoverOpen(); - expect(result.queryByTestId('property-actions-user-action-quote')).toBeInTheDocument(); - userEvent.click(result.getByTestId('property-actions-user-action-quote')); + expect(screen.queryByTestId('property-actions-user-action-quote')).toBeInTheDocument(); + userEvent.click(screen.getByTestId('property-actions-user-action-quote')); await waitFor(() => { expect(builderArgs.handleManageQuote).toHaveBeenCalledWith('Solve this fast!'); @@ -342,14 +470,14 @@ describe('createCommentUserActionBuilder', () => { }); const createdUserAction = builder.build(); - const result = render( + render( ); - expect(result.getByTestId('comment-action-show-alert-alert-action-id')).toBeInTheDocument(); - userEvent.click(result.getByTestId('comment-action-show-alert-alert-action-id')); + expect(screen.getByTestId('comment-action-show-alert-alert-action-id')).toBeInTheDocument(); + userEvent.click(screen.getByTestId('comment-action-show-alert-alert-action-id')); await waitFor(() => { expect(builderArgs.onShowAlertDetails).toHaveBeenCalledWith('alert-id-1', 'alert-index-1'); @@ -482,102 +610,253 @@ describe('createCommentUserActionBuilder', () => { expect(screen.getByText('I just isolated the host!')).toBeInTheDocument(); }); - describe('External references', () => { + describe('Attachment framework', () => { let appMockRender: AppMockRenderer; beforeEach(() => { appMockRender = createAppMockRenderer(); }); - it('renders correctly an external reference', async () => { - const externalReferenceAttachmentTypeRegistry = new ExternalReferenceAttachmentTypeRegistry(); - externalReferenceAttachmentTypeRegistry.register(getExternalReferenceAttachment()); - - const userAction = getExternalReferenceUserAction(); - const damagedRaccoon = userProfiles[0]; - const builder = createCommentUserActionBuilder({ - ...builderArgs, - externalReferenceAttachmentTypeRegistry, - caseData: { - ...builderArgs.caseData, - comments: [ - { - ...externalReferenceAttachment, - createdBy: { - username: damagedRaccoon.user.username, - fullName: damagedRaccoon.user.full_name, - email: damagedRaccoon.user.email, + describe('External references', () => { + it('renders correctly an external reference', async () => { + const externalReferenceAttachmentTypeRegistry = + new ExternalReferenceAttachmentTypeRegistry(); + externalReferenceAttachmentTypeRegistry.register(getExternalReferenceAttachment()); + + const userAction = getExternalReferenceUserAction(); + const damagedRaccoon = userProfiles[0]; + const builder = createCommentUserActionBuilder({ + ...builderArgs, + externalReferenceAttachmentTypeRegistry, + caseData: { + ...builderArgs.caseData, + comments: [ + { + ...externalReferenceAttachment, + createdBy: { + username: damagedRaccoon.user.username, + fullName: damagedRaccoon.user.full_name, + email: damagedRaccoon.user.email, + }, }, - }, - ], - }, - userAction, - }); + ], + }, + userAction, + }); - const createdUserAction = builder.build(); - const result = appMockRender.render(); + const createdUserAction = builder.build(); + appMockRender.render(); - expect(result.getByTestId('comment-externalReference-.test')).toBeInTheDocument(); - expect(result.getByTestId('copy-link-external-reference-comment-id')).toBeInTheDocument(); - expect(result.getByTestId('case-user-profile-avatar-damaged_raccoon')).toBeInTheDocument(); - expect(screen.getByText('added a chart')).toBeInTheDocument(); - }); + expect(screen.getByTestId('comment-externalReference-.test')).toBeInTheDocument(); + expect(screen.getByTestId('copy-link-external-reference-comment-id')).toBeInTheDocument(); + expect(screen.getByTestId('case-user-profile-avatar-damaged_raccoon')).toBeInTheDocument(); + expect(screen.getByText('added a chart')).toBeInTheDocument(); + }); - it('renders correctly if the reference is not registered', async () => { - const externalReferenceAttachmentTypeRegistry = new ExternalReferenceAttachmentTypeRegistry(); + it('renders correctly if the reference is not registered', async () => { + const externalReferenceAttachmentTypeRegistry = + new ExternalReferenceAttachmentTypeRegistry(); + + const userAction = getExternalReferenceUserAction(); + const builder = createCommentUserActionBuilder({ + ...builderArgs, + externalReferenceAttachmentTypeRegistry, + caseData: { + ...builderArgs.caseData, + comments: [externalReferenceAttachment], + }, + userAction, + }); - const userAction = getExternalReferenceUserAction(); - const builder = createCommentUserActionBuilder({ - ...builderArgs, - externalReferenceAttachmentTypeRegistry, - caseData: { - ...builderArgs.caseData, - comments: [externalReferenceAttachment], - }, - userAction, + const createdUserAction = builder.build(); + appMockRender.render(); + + expect(screen.getByTestId('comment-externalReference-not-found')).toBeInTheDocument(); + expect(screen.getByText('added an attachment of type')).toBeInTheDocument(); + expect(screen.getByText('Attachment type is not registered')).toBeInTheDocument(); }); - const createdUserAction = builder.build(); - const result = appMockRender.render(); + it('deletes the attachment correctly', async () => { + const externalReferenceAttachmentTypeRegistry = + new ExternalReferenceAttachmentTypeRegistry(); + externalReferenceAttachmentTypeRegistry.register(getExternalReferenceAttachment()); + + const userAction = getExternalReferenceUserAction(); + const builder = createCommentUserActionBuilder({ + ...builderArgs, + externalReferenceAttachmentTypeRegistry, + caseData: { + ...builderArgs.caseData, + comments: [externalReferenceAttachment], + }, + userAction, + }); + + const createdUserAction = builder.build(); + const result = appMockRender.render(); + + expect(screen.getByTestId('comment-externalReference-.test')).toBeInTheDocument(); + + await deleteAttachment(result, 'trash', 'Delete'); - expect(result.getByTestId('comment-externalReference-not-found')).toBeInTheDocument(); - expect(screen.getByText('added an attachment of type')).toBeInTheDocument(); - expect(screen.getByText('Attachment type is not registered')).toBeInTheDocument(); + await waitFor(() => { + expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith( + 'external-reference-comment-id', + 'Deleted attachment' + ); + }); + }); }); - it('renders correctly an external reference with actions', async () => { - const ActionsView = () => { - return <>{'Attachment actions'}; - }; + describe('Persistable state', () => { + it('renders correctly a persistable state attachment', async () => { + const MockComponent = jest.fn((props) => { + return ( +
+ ); + }); - const attachment = getExternalReferenceAttachment({ - actions: , + const SpyLazyFactory = jest.fn(() => { + return Promise.resolve().then(() => { + return { + default: React.memo(MockComponent), + }; + }); + }); + + const persistableStateAttachmentTypeRegistry = new PersistableStateAttachmentTypeRegistry(); + persistableStateAttachmentTypeRegistry.register( + getPersistableStateAttachment({ + children: React.lazy(SpyLazyFactory), + }) + ); + + const userAction = getPersistableStateUserAction(); + const attachment01 = { + ...persistableStateAttachment, + persistableStateAttachmentState: { test_foo: '01' }, + createdBy: { + username: userProfiles[0].user.username, + fullName: userProfiles[0].user.full_name, + email: userProfiles[0].user.email, + profileUid: userProfiles[0].uid, + }, + }; + const builder = createCommentUserActionBuilder({ + ...builderArgs, + persistableStateAttachmentTypeRegistry, + caseData: { + ...builderArgs.caseData, + comments: [attachment01], + }, + userAction, + }); + + const result = appMockRender.render(); + + await waitFor(() => { + expect(screen.getByTestId('attachment_01')).toBeInTheDocument(); + expect(MockComponent).toHaveBeenCalledTimes(1); + expect(SpyLazyFactory).toHaveBeenCalledTimes(1); + }); + + expect(screen.getByTestId('comment-persistableState-.test')).toBeInTheDocument(); + expect(screen.getByTestId('copy-link-persistable-state-comment-id')).toBeInTheDocument(); + expect(screen.getByTestId('case-user-profile-avatar-damaged_raccoon')).toBeInTheDocument(); + expect(screen.getByText('added an embeddable')).toBeInTheDocument(); + + result.unmount(); + + const attachment02 = { + ...persistableStateAttachment, + persistableStateAttachmentState: { test_foo: '02' }, + }; + const updateBuilder = createCommentUserActionBuilder({ + ...builderArgs, + persistableStateAttachmentTypeRegistry, + caseData: { + ...builderArgs.caseData, + comments: [attachment02], + }, + userAction, + }); + + const result2 = appMockRender.render(); + + await waitFor(() => { + expect(result2.getByTestId('attachment_02')).toBeInTheDocument(); + expect(MockComponent).toHaveBeenCalledTimes(2); + expect(SpyLazyFactory).toHaveBeenCalledTimes(1); + }); }); - const externalReferenceAttachmentTypeRegistry = new ExternalReferenceAttachmentTypeRegistry(); - externalReferenceAttachmentTypeRegistry.register(attachment); + it('renders correctly if the reference is not registered', async () => { + const persistableStateAttachmentTypeRegistry = new PersistableStateAttachmentTypeRegistry(); + + const userAction = getPersistableStateUserAction(); + const builder = createCommentUserActionBuilder({ + ...builderArgs, + persistableStateAttachmentTypeRegistry, + caseData: { + ...builderArgs.caseData, + comments: [persistableStateAttachment], + }, + userAction, + }); - const userAction = getExternalReferenceUserAction(); - const builder = createCommentUserActionBuilder({ - ...builderArgs, - externalReferenceAttachmentTypeRegistry, - caseData: { - ...builderArgs.caseData, - comments: [externalReferenceAttachment], - }, - userAction, + const createdUserAction = builder.build(); + appMockRender.render(); + + expect(screen.getByTestId('comment-persistableState-not-found')).toBeInTheDocument(); + expect(screen.getByText('added an attachment of type')).toBeInTheDocument(); + expect(screen.getByText('Attachment type is not registered')).toBeInTheDocument(); }); - const createdUserAction = builder.build(); - const result = appMockRender.render(); + it('deletes the attachment correctly', async () => { + const attachment = getPersistableStateAttachment(); + const persistableStateAttachmentTypeRegistry = new PersistableStateAttachmentTypeRegistry(); + persistableStateAttachmentTypeRegistry.register(attachment); + + const userAction = getPersistableStateUserAction(); + const builder = createCommentUserActionBuilder({ + ...builderArgs, + persistableStateAttachmentTypeRegistry, + caseData: { + ...builderArgs.caseData, + comments: [persistableStateAttachment], + }, + userAction, + }); + + const createdUserAction = builder.build(); + const result = appMockRender.render(); + + expect(screen.getByTestId('comment-persistableState-.test')).toBeInTheDocument(); - expect(result.getByTestId('comment-externalReference-.test')).toBeInTheDocument(); - expect(screen.getByText('Attachment actions')).toBeInTheDocument(); + await deleteAttachment(result, 'trash', 'Delete'); + + await waitFor(() => { + expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith( + 'persistable-state-comment-id', + 'Deleted attachment' + ); + }); + }); }); - it('deletes the attachment correctly', async () => { + it('shows correctly the visible primary actions', async () => { + const onClick = jest.fn(); + + const attachment = getExternalReferenceAttachment({ + getActions: () => [ + { label: 'My primary button', isPrimary: true, iconType: 'danger', onClick }, + { label: 'My primary 2 button', isPrimary: true, iconType: 'danger', onClick }, + { label: 'My primary 3 button', isPrimary: true, iconType: 'danger', onClick }, + ], + }); + const externalReferenceAttachmentTypeRegistry = new ExternalReferenceAttachmentTypeRegistry(); - externalReferenceAttachmentTypeRegistry.register(getExternalReferenceAttachment()); + externalReferenceAttachmentTypeRegistry.register(attachment); const userAction = getExternalReferenceUserAction(); const builder = createCommentUserActionBuilder({ @@ -591,207 +870,172 @@ describe('createCommentUserActionBuilder', () => { }); const createdUserAction = builder.build(); - const result = appMockRender.render(); + appMockRender.render(); - expect(result.getByTestId('comment-externalReference-.test')).toBeInTheDocument(); + expect(screen.getByTestId('comment-externalReference-.test')).toBeInTheDocument(); + expect(screen.getByLabelText('My primary button')).toBeInTheDocument(); + expect(screen.getByLabelText('My primary 2 button')).toBeInTheDocument(); + expect(screen.queryByLabelText('My primary 3 button')).not.toBeInTheDocument(); - await deleteAttachment(result, 'trash', 'Delete'); - - await waitFor(() => { - expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith( - 'external-reference-comment-id', - 'Deleted attachment' - ); + userEvent.click(screen.getByLabelText('My primary button'), undefined, { + skipPointerEventsCheck: true, }); - }); - }); - describe('Persistable state', () => { - let appMockRender: AppMockRenderer; + userEvent.click(screen.getByLabelText('My primary 2 button'), undefined, { + skipPointerEventsCheck: true, + }); - beforeEach(() => { - appMockRender = createAppMockRenderer(); + expect(onClick).toHaveBeenCalledTimes(2); }); - it('renders correctly a persistable state attachment', async () => { - const MockComponent = jest.fn((props) => { - return ( -
- ); - }); + it('shows correctly the non visible primary actions', async () => { + const onClick = jest.fn(); - const SpyLazyFactory = jest.fn(() => { - return Promise.resolve().then(() => { - return { - default: React.memo(MockComponent), - }; - }); + const attachment = getExternalReferenceAttachment({ + getActions: () => [ + { label: 'My primary button', isPrimary: true, iconType: 'danger', onClick }, + { label: 'My primary 2 button', isPrimary: true, iconType: 'danger', onClick }, + { label: 'My primary 3 button', isPrimary: true, iconType: 'danger', onClick }, + ], }); - const persistableStateAttachmentTypeRegistry = new PersistableStateAttachmentTypeRegistry(); - persistableStateAttachmentTypeRegistry.register( - getPersistableStateAttachment({ - children: React.lazy(SpyLazyFactory), - }) - ); + const externalReferenceAttachmentTypeRegistry = new ExternalReferenceAttachmentTypeRegistry(); + externalReferenceAttachmentTypeRegistry.register(attachment); - const userAction = getPersistableStateUserAction(); - const attachment01 = { - ...persistableStateAttachment, - persistableStateAttachmentState: { test_foo: '01' }, - createdBy: { - username: userProfiles[0].user.username, - fullName: userProfiles[0].user.full_name, - email: userProfiles[0].user.email, - profileUid: userProfiles[0].uid, - }, - }; + const userAction = getExternalReferenceUserAction(); const builder = createCommentUserActionBuilder({ ...builderArgs, - persistableStateAttachmentTypeRegistry, + externalReferenceAttachmentTypeRegistry, caseData: { ...builderArgs.caseData, - comments: [attachment01], + comments: [externalReferenceAttachment], }, userAction, }); - const result = appMockRender.render(); + const createdUserAction = builder.build(); + appMockRender.render(); - await waitFor(() => { - expect(result.getByTestId('attachment_01')).toBeInTheDocument(); - expect(MockComponent).toHaveBeenCalledTimes(1); - expect(SpyLazyFactory).toHaveBeenCalledTimes(1); - }); + expect(screen.getByTestId('comment-externalReference-.test')).toBeInTheDocument(); + expect(screen.getByLabelText('My primary button')).toBeInTheDocument(); + expect(screen.getByLabelText('My primary 2 button')).toBeInTheDocument(); + expect(screen.queryByLabelText('My primary 3 button')).not.toBeInTheDocument(); - expect(result.getByTestId('comment-persistableState-.test')).toBeInTheDocument(); - expect(result.getByTestId('copy-link-persistable-state-comment-id')).toBeInTheDocument(); - expect(result.getByTestId('case-user-profile-avatar-damaged_raccoon')).toBeInTheDocument(); - expect(screen.getByText('added an embeddable')).toBeInTheDocument(); + expect(screen.getByTestId('property-actions-user-action')).toBeInTheDocument(); + userEvent.click(screen.getByTestId('property-actions-user-action-ellipses')); + await waitForEuiPopoverOpen(); - result.unmount(); + expect(screen.getByText('My primary 3 button')).toBeInTheDocument(); - const attachment02 = { - ...persistableStateAttachment, - persistableStateAttachmentState: { test_foo: '02' }, - }; - const updateBuilder = createCommentUserActionBuilder({ - ...builderArgs, - persistableStateAttachmentTypeRegistry, - caseData: { - ...builderArgs.caseData, - comments: [attachment02], - }, - userAction, + userEvent.click(screen.getByText('My primary 3 button'), undefined, { + skipPointerEventsCheck: true, }); - const result2 = appMockRender.render(); + expect(onClick).toHaveBeenCalled(); + }); - await waitFor(() => { - expect(result2.getByTestId('attachment_02')).toBeInTheDocument(); - expect(MockComponent).toHaveBeenCalledTimes(2); - expect(SpyLazyFactory).toHaveBeenCalledTimes(1); + it('shows correctly the registered primary actions and non-primary actions', async () => { + const onClick = jest.fn(); + + const attachment = getExternalReferenceAttachment({ + getActions: () => [ + { label: 'My button', iconType: 'trash', onClick }, + { label: 'My button 2', iconType: 'download', onClick }, + { label: 'My primary button', isPrimary: true, iconType: 'danger', onClick }, + { label: 'My primary 2 button', isPrimary: true, iconType: 'danger', onClick }, + { label: 'My primary 3 button', isPrimary: true, iconType: 'danger', onClick }, + ], }); - }); - it('renders correctly if the reference is not registered', async () => { - const persistableStateAttachmentTypeRegistry = new PersistableStateAttachmentTypeRegistry(); + const externalReferenceAttachmentTypeRegistry = new ExternalReferenceAttachmentTypeRegistry(); + externalReferenceAttachmentTypeRegistry.register(attachment); - const userAction = getPersistableStateUserAction(); + const userAction = getExternalReferenceUserAction(); const builder = createCommentUserActionBuilder({ ...builderArgs, - persistableStateAttachmentTypeRegistry, + externalReferenceAttachmentTypeRegistry, caseData: { ...builderArgs.caseData, - comments: [persistableStateAttachment], + comments: [externalReferenceAttachment], }, userAction, }); const createdUserAction = builder.build(); - const result = appMockRender.render(); - - expect(result.getByTestId('comment-persistableState-not-found')).toBeInTheDocument(); - expect(screen.getByText('added an attachment of type')).toBeInTheDocument(); - expect(screen.getByText('Attachment type is not registered')).toBeInTheDocument(); - }); + appMockRender.render(); - it('renders correctly a persistable state with actions', async () => { - const ActionsView = () => { - return <>{'Attachment actions'}; - }; + expect(screen.getByTestId('comment-externalReference-.test')).toBeInTheDocument(); + expect(screen.getByLabelText('My primary button')).toBeInTheDocument(); + expect(screen.getByLabelText('My primary 2 button')).toBeInTheDocument(); + expect(screen.queryByLabelText('My primary 3 button')).not.toBeInTheDocument(); - const attachment = getPersistableStateAttachment({ - actions: , - }); + expect(screen.getByTestId('property-actions-user-action')).toBeInTheDocument(); + userEvent.click(screen.getByTestId('property-actions-user-action-ellipses')); + await waitForEuiPopoverOpen(); - const persistableStateAttachmentTypeRegistry = new PersistableStateAttachmentTypeRegistry(); - persistableStateAttachmentTypeRegistry.register(attachment); + expect(screen.getByText('My button')).toBeInTheDocument(); + expect(screen.getByText('My button 2')).toBeInTheDocument(); + expect(screen.getByText('My primary 3 button')).toBeInTheDocument(); - const userAction = getPersistableStateUserAction(); - const builder = createCommentUserActionBuilder({ - ...builderArgs, - persistableStateAttachmentTypeRegistry, - caseData: { - ...builderArgs.caseData, - comments: [persistableStateAttachment], - }, - userAction, + userEvent.click(screen.getByText('My button'), undefined, { skipPointerEventsCheck: true }); + userEvent.click(screen.getByText('My button 2'), undefined, { + skipPointerEventsCheck: true, }); - const createdUserAction = builder.build(); - const result = appMockRender.render(); - - expect(result.getByTestId('comment-persistableState-.test')).toBeInTheDocument(); - expect(screen.getByText('Attachment actions')).toBeInTheDocument(); + expect(onClick).toHaveBeenCalledTimes(2); }); - it('deletes the attachment correctly', async () => { - const attachment = getPersistableStateAttachment(); - const persistableStateAttachmentTypeRegistry = new PersistableStateAttachmentTypeRegistry(); - persistableStateAttachmentTypeRegistry.register(attachment); + it('divides correctly less than two primary actions', async () => { + const onClick = jest.fn(); - const userAction = getPersistableStateUserAction(); + const attachment = getExternalReferenceAttachment({ + getActions: () => [ + { label: 'My primary button', isPrimary: true, iconType: 'danger', onClick }, + ], + }); + + const externalReferenceAttachmentTypeRegistry = new ExternalReferenceAttachmentTypeRegistry(); + externalReferenceAttachmentTypeRegistry.register(attachment); + + const userAction = getExternalReferenceUserAction(); const builder = createCommentUserActionBuilder({ ...builderArgs, - persistableStateAttachmentTypeRegistry, + externalReferenceAttachmentTypeRegistry, caseData: { ...builderArgs.caseData, - comments: [persistableStateAttachment], + comments: [externalReferenceAttachment], }, userAction, }); const createdUserAction = builder.build(); - const result = appMockRender.render(); + appMockRender.render(); - expect(result.getByTestId('comment-persistableState-.test')).toBeInTheDocument(); - - await deleteAttachment(result, 'trash', 'Delete'); + expect(screen.getByTestId('comment-externalReference-.test')).toBeInTheDocument(); + expect(screen.getByLabelText('My primary button')).toBeInTheDocument(); - await waitFor(() => { - expect(builderArgs.handleDeleteComment).toHaveBeenCalledWith( - 'persistable-state-comment-id', - 'Deleted attachment' - ); + userEvent.click(screen.getByLabelText('My primary button'), undefined, { + skipPointerEventsCheck: true, }); + + expect(onClick).toHaveBeenCalled(); }); }); }); const deleteAttachment = async (result: RenderResult, deleteIcon: string, buttonLabel: string) => { - expect(result.getByTestId('property-actions-user-action')).toBeInTheDocument(); + expect(screen.getByTestId('property-actions-user-action')).toBeInTheDocument(); - userEvent.click(result.getByTestId('property-actions-user-action-ellipses')); + userEvent.click(screen.getByTestId('property-actions-user-action-ellipses')); await waitForEuiPopoverOpen(); - expect(result.queryByTestId(`property-actions-user-action-${deleteIcon}`)).toBeInTheDocument(); + expect(screen.queryByTestId(`property-actions-user-action-${deleteIcon}`)).toBeInTheDocument(); - userEvent.click(result.getByTestId(`property-actions-user-action-${deleteIcon}`)); + userEvent.click(screen.getByTestId(`property-actions-user-action-${deleteIcon}`)); await waitFor(() => { - expect(result.queryByTestId('property-actions-confirm-modal')).toBeInTheDocument(); + expect(screen.queryByTestId('property-actions-confirm-modal')).toBeInTheDocument(); }); - userEvent.click(result.getByText(buttonLabel)); + userEvent.click(screen.getByText(buttonLabel)); }; diff --git a/x-pack/plugins/cases/public/components/user_actions/comment/comment.tsx b/x-pack/plugins/cases/public/components/user_actions/comment/comment.tsx index c63f53f13bbe6..434a95cc69b1c 100644 --- a/x-pack/plugins/cases/public/components/user_actions/comment/comment.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/comment/comment.tsx @@ -7,6 +7,7 @@ import type { EuiCommentProps } from '@elastic/eui'; +import type { AttachmentTypeRegistry } from '../../../../common/registry'; import type { CommentUserAction } from '../../../../common/api'; import { Actions, CommentType } from '../../../../common/api'; import type { UserActionBuilder, UserActionBuilderArgs, UserActionResponse } from '../types'; @@ -18,9 +19,23 @@ import { createAlertAttachmentUserActionBuilder } from './alert'; import { createActionAttachmentUserActionBuilder } from './actions'; import { createExternalReferenceAttachmentUserActionBuilder } from './external_reference'; import { createPersistableStateAttachmentUserActionBuilder } from './persistable_state'; +import type { AttachmentType } from '../../../client/attachment_framework/types'; const getUpdateLabelTitle = () => `${i18n.EDITED_FIELD} ${i18n.COMMENT.toLowerCase()}`; -const getDeleteLabelTitle = (userAction: UserActionResponse) => { + +interface DeleteLabelTitle { + userAction: UserActionResponse; + caseData: UserActionBuilderArgs['caseData']; + externalReferenceAttachmentTypeRegistry: UserActionBuilderArgs['externalReferenceAttachmentTypeRegistry']; + persistableStateAttachmentTypeRegistry: UserActionBuilderArgs['persistableStateAttachmentTypeRegistry']; +} + +const getDeleteLabelTitle = ({ + userAction, + caseData, + externalReferenceAttachmentTypeRegistry, + persistableStateAttachmentTypeRegistry, +}: DeleteLabelTitle) => { const { comment } = userAction.payload; if (comment.type === CommentType.alert) { @@ -30,24 +45,90 @@ const getDeleteLabelTitle = (userAction: UserActionResponse) return `${i18n.REMOVED_FIELD} ${alertLabel}`; } - if ( - comment.type === CommentType.externalReference || - comment.type === CommentType.persistableState - ) { - return `${i18n.REMOVED_FIELD} ${i18n.ATTACHMENT.toLowerCase()}`; + if (comment.type === CommentType.externalReference) { + return getDeleteLabelFromRegistry({ + caseData, + registry: externalReferenceAttachmentTypeRegistry, + getId: () => comment.externalReferenceAttachmentTypeId, + getAttachmentProps: () => ({ + externalReferenceId: comment.externalReferenceId, + externalReferenceMetadata: comment.externalReferenceMetadata, + }), + }); + } + + if (comment.type === CommentType.persistableState) { + return getDeleteLabelFromRegistry({ + caseData, + registry: persistableStateAttachmentTypeRegistry, + getId: () => comment.persistableStateAttachmentTypeId, + getAttachmentProps: () => ({ + persistableStateAttachmentTypeId: comment.persistableStateAttachmentTypeId, + persistableStateAttachmentState: comment.persistableStateAttachmentState, + }), + }); } return `${i18n.REMOVED_FIELD} ${i18n.COMMENT.toLowerCase()}`; }; +interface GetDeleteLabelFromRegistryArgs { + caseData: UserActionBuilderArgs['caseData']; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + registry: AttachmentTypeRegistry>; + getId: () => string; + getAttachmentProps: () => object; +} + +const getDeleteLabelFromRegistry = ({ + caseData, + registry, + getId, + getAttachmentProps, +}: GetDeleteLabelFromRegistryArgs) => { + const registeredAttachmentCommonLabel = `${i18n.REMOVED_FIELD} ${i18n.ATTACHMENT.toLowerCase()}`; + const attachmentTypeId: string = getId(); + const isTypeRegistered = registry.has(attachmentTypeId); + + if (!isTypeRegistered) { + return registeredAttachmentCommonLabel; + } + + const props = { + ...getAttachmentProps(), + caseData: { id: caseData.id, title: caseData.title }, + }; + + const attachmentType = registry.get(attachmentTypeId); + const attachmentLabel = attachmentType.getAttachmentRemovalObject?.(props).event ?? null; + + return attachmentLabel != null ? attachmentLabel : registeredAttachmentCommonLabel; +}; + const getDeleteCommentUserAction = ({ userAction, userProfiles, + caseData, + externalReferenceAttachmentTypeRegistry, + persistableStateAttachmentTypeRegistry, handleOutlineComment, }: { userAction: UserActionResponse; -} & Pick): EuiCommentProps[] => { - const label = getDeleteLabelTitle(userAction); +} & Pick< + UserActionBuilderArgs, + | 'handleOutlineComment' + | 'userProfiles' + | 'externalReferenceAttachmentTypeRegistry' + | 'persistableStateAttachmentTypeRegistry' + | 'caseData' +>): EuiCommentProps[] => { + const label = getDeleteLabelTitle({ + userAction, + caseData, + externalReferenceAttachmentTypeRegistry, + persistableStateAttachmentTypeRegistry, + }); + const commonBuilder = createCommonUpdateUserActionBuilder({ userAction, userProfiles, @@ -193,8 +274,11 @@ export const createCommentUserActionBuilder: UserActionBuilder = ({ if (commentUserAction.action === Actions.delete) { return getDeleteCommentUserAction({ userAction: commentUserAction, + caseData, handleOutlineComment, userProfiles, + externalReferenceAttachmentTypeRegistry, + persistableStateAttachmentTypeRegistry, }); } diff --git a/x-pack/plugins/cases/public/components/user_actions/comment/registered_attachments.tsx b/x-pack/plugins/cases/public/components/user_actions/comment/registered_attachments.tsx index 732afcd988f49..714bfda9e3a99 100644 --- a/x-pack/plugins/cases/public/components/user_actions/comment/registered_attachments.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/comment/registered_attachments.tsx @@ -12,9 +12,9 @@ */ import React, { Suspense } from 'react'; -import { memoize } from 'lodash'; +import { memoize, partition } from 'lodash'; -import { EuiCallOut, EuiCode, EuiLoadingSpinner } from '@elastic/eui'; +import { EuiCallOut, EuiCode, EuiLoadingSpinner, EuiButtonIcon, EuiFlexItem } from '@elastic/eui'; import type { AttachmentType } from '../../../client/attachment_framework/types'; import type { AttachmentTypeRegistry } from '../../../../common/registry'; import type { CommentResponse } from '../../../../common/api'; @@ -116,6 +116,11 @@ export const createRegisteredAttachmentUserActionBuilder = < caseData: { id: caseData.id, title: caseData.title }, }; + const actions = attachmentViewObject.getActions?.(props) ?? []; + const [primaryActions, nonPrimaryActions] = partition(actions, 'isPrimary'); + const visiblePrimaryActions = primaryActions.slice(0, 2); + const nonVisiblePrimaryActions = primaryActions.slice(2, primaryActions.length); + return [ { username: ( @@ -128,10 +133,24 @@ export const createRegisteredAttachmentUserActionBuilder = < timelineAvatar: attachmentViewObject.timelineAvatar, actions: ( - {attachmentViewObject.actions} + {visiblePrimaryActions.map((action) => ( + + + + ))} handleDeleteComment(comment.id, DELETE_REGISTERED_ATTACHMENT)} + registeredAttachmentActions={[...nonVisiblePrimaryActions, ...nonPrimaryActions]} /> ), diff --git a/x-pack/plugins/cases/public/components/user_actions/content_toolbar.tsx b/x-pack/plugins/cases/public/components/user_actions/content_toolbar.tsx index e7d1dd7ba5eaa..7a0a0de03e18d 100644 --- a/x-pack/plugins/cases/public/components/user_actions/content_toolbar.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/content_toolbar.tsx @@ -21,7 +21,7 @@ const UserActionContentToolbarComponent: React.FC withCopyLinkAction = true, children, }) => ( - + {withCopyLinkAction ? ( diff --git a/x-pack/plugins/cases/public/components/user_actions/index.tsx b/x-pack/plugins/cases/public/components/user_actions/index.tsx index 2547e41340019..7b70b378cc22a 100644 --- a/x-pack/plugins/cases/public/components/user_actions/index.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/index.tsx @@ -30,11 +30,11 @@ const getIconsCss = (hasNextPage: boolean | undefined, euiTheme: EuiThemeCompute const customSize = hasNextPage ? { showMoreSectionSize: euiTheme.size.xxxl, - marginTopShowMoreSectionSize: euiTheme.size.xxl, - marginBottomShowMoreSectionSize: euiTheme.size.xxl, + marginTopShowMoreSectionSize: euiTheme.size.xxxl, + marginBottomShowMoreSectionSize: euiTheme.size.xxxl, } : { - showMoreSectionSize: euiTheme.size.s, + showMoreSectionSize: euiTheme.size.m, marginTopShowMoreSectionSize: euiTheme.size.m, marginBottomShowMoreSectionSize: euiTheme.size.m, }; diff --git a/x-pack/plugins/cases/public/components/user_actions/property_actions/registered_attachments_property_actions.test.tsx b/x-pack/plugins/cases/public/components/user_actions/property_actions/registered_attachments_property_actions.test.tsx index 9e391fa6e7042..583dd7d5be416 100644 --- a/x-pack/plugins/cases/public/components/user_actions/property_actions/registered_attachments_property_actions.test.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/property_actions/registered_attachments_property_actions.test.tsx @@ -22,6 +22,7 @@ describe('RegisteredAttachmentsPropertyActions', () => { const props = { isLoading: false, + registeredAttachmentActions: [], onDelete: jest.fn(), }; @@ -95,4 +96,21 @@ describe('RegisteredAttachmentsPropertyActions', () => { expect(result.getByTestId('property-actions-user-action')).toBeInTheDocument(); }); + + it('renders correctly registered attachments', async () => { + const onClick = jest.fn(); + const action = [{ label: 'My button', iconType: 'download', onClick }]; + + const result = appMock.render( + + ); + + expect(result.getByTestId('property-actions-user-action')).toBeInTheDocument(); + + userEvent.click(result.getByTestId('property-actions-user-action-ellipses')); + await waitForEuiPopoverOpen(); + + expect(result.getByTestId('property-actions-user-action-group').children.length).toBe(2); + expect(result.queryByTestId('property-actions-user-action-download')).toBeInTheDocument(); + }); }); diff --git a/x-pack/plugins/cases/public/components/user_actions/property_actions/registered_attachments_property_actions.tsx b/x-pack/plugins/cases/public/components/user_actions/property_actions/registered_attachments_property_actions.tsx index 8859d61c99ea5..d567298adc5fd 100644 --- a/x-pack/plugins/cases/public/components/user_actions/property_actions/registered_attachments_property_actions.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/property_actions/registered_attachments_property_actions.tsx @@ -6,6 +6,7 @@ */ import React, { useMemo } from 'react'; +import type { AttachmentAction } from '../../../client/attachment_framework/types'; import { useCasesContext } from '../../cases_context/use_cases_context'; import * as i18n from './translations'; import { UserActionPropertyActions } from './property_actions'; @@ -14,11 +15,13 @@ import { useDeletePropertyAction } from './use_delete_property_action'; interface Props { isLoading: boolean; + registeredAttachmentActions: AttachmentAction[]; onDelete: () => void; } const RegisteredAttachmentsPropertyActionsComponent: React.FC = ({ isLoading, + registeredAttachmentActions, onDelete, }) => { const { permissions } = useCasesContext(); @@ -40,8 +43,9 @@ const RegisteredAttachmentsPropertyActionsComponent: React.FC = ({ }, ] : []), + ...registeredAttachmentActions, ]; - }, [permissions.delete, onModalOpen]); + }, [permissions.delete, onModalOpen, registeredAttachmentActions]); return ( <> diff --git a/x-pack/plugins/cases/public/components/user_actions/show_more_button.tsx b/x-pack/plugins/cases/public/components/user_actions/show_more_button.tsx index 067650b9576b2..6efbde32f64db 100644 --- a/x-pack/plugins/cases/public/components/user_actions/show_more_button.tsx +++ b/x-pack/plugins/cases/public/components/user_actions/show_more_button.tsx @@ -30,8 +30,12 @@ export const ShowMoreButton = React.memo( css={css` display: flex; justify-content: center; - margin-block: ${euiTheme.size.xl}; - margin-inline-start: ${euiTheme.size.xxxl}; + position: relative; + margin-block: ${euiTheme.size.base}; + z-index: 1; + border-top: ${euiTheme.size.base} solid ${euiTheme.colors.emptyShade}; + border-bottom: ${euiTheme.size.base} solid ${euiTheme.colors.emptyShade}; + border-radius: 16px; `} > = { getRelatedCases: jest.fn(), - cases: { find: jest.fn(), getCasesMetrics: jest.fn(), getCasesStatus: jest.fn() }, + cases: { + find: jest.fn(), + getCasesMetrics: jest.fn(), + getCasesStatus: jest.fn(), + bulkGet: jest.fn(), + }, }; const uiMock: jest.Mocked = { diff --git a/x-pack/plugins/cases/public/types.ts b/x-pack/plugins/cases/public/types.ts index 7df2e8f950271..e2cb59095f849 100644 --- a/x-pack/plugins/cases/public/types.ts +++ b/x-pack/plugins/cases/public/types.ts @@ -25,6 +25,9 @@ import type { LicensingPluginStart } from '@kbn/licensing-plugin/public'; import type { FilesSetup, FilesStart } from '@kbn/files-plugin/public'; import type { SavedObjectsManagementPluginStart } from '@kbn/saved-objects-management-plugin/public'; import type { + CaseResponse, + CasesBulkGetRequestCertainFields, + CasesBulkGetResponseCertainFields, CasesByAlertId, CasesByAlertIDRequest, CasesFindRequest, @@ -102,6 +105,10 @@ export interface CasesUiStart { find: (query: CasesFindRequest, signal?: AbortSignal) => Promise; getCasesStatus: (query: CasesStatusRequest, signal?: AbortSignal) => Promise; getCasesMetrics: (query: CasesMetricsRequest, signal?: AbortSignal) => Promise; + bulkGet: ( + params: CasesBulkGetRequestCertainFields, + signal?: AbortSignal + ) => Promise>; }; }; ui: { diff --git a/x-pack/plugins/cases/server/client/attachments/delete.test.ts b/x-pack/plugins/cases/server/client/attachments/delete.test.ts index c74f621346728..d484515f4eeaf 100644 --- a/x-pack/plugins/cases/server/client/attachments/delete.test.ts +++ b/x-pack/plugins/cases/server/client/attachments/delete.test.ts @@ -7,40 +7,93 @@ import { mockCaseComments } from '../../mocks'; import { createCasesClientMockArgs } from '../mocks'; -import { deleteComment } from './delete'; +import { deleteComment, deleteAll } from './delete'; -describe('deleteComment', () => { - const clientArgs = createCasesClientMockArgs(); +describe('delete', () => { + describe('deleteComment', () => { + const clientArgs = createCasesClientMockArgs(); - beforeEach(() => { - jest.clearAllMocks(); - }); + beforeEach(() => { + jest.clearAllMocks(); + }); - describe('Alerts', () => { - const commentSO = mockCaseComments[0]; - const alertsSO = mockCaseComments[3]; - clientArgs.services.attachmentService.getter.get.mockResolvedValue(alertsSO); + describe('Alerts', () => { + const commentSO = mockCaseComments[0]; + const alertsSO = mockCaseComments[3]; + clientArgs.services.attachmentService.getter.get.mockResolvedValue(alertsSO); - it('delete alerts correctly', async () => { - await deleteComment({ caseID: 'mock-id-4', attachmentID: 'mock-comment-4' }, clientArgs); + it('delete alerts correctly', async () => { + await deleteComment({ caseID: 'mock-id-4', attachmentID: 'mock-comment-4' }, clientArgs); - expect(clientArgs.services.alertsService.ensureAlertsAuthorized).toHaveBeenCalledWith({ - alerts: [{ id: 'test-id', index: 'test-index' }], + expect(clientArgs.services.alertsService.ensureAlertsAuthorized).toHaveBeenCalledWith({ + alerts: [{ id: 'test-id', index: 'test-index' }], + }); + + expect(clientArgs.services.alertsService.removeCaseIdFromAlerts).toHaveBeenCalledWith({ + alerts: [{ id: 'test-id', index: 'test-index' }], + caseId: 'mock-id-4', + }); }); - expect(clientArgs.services.alertsService.removeCaseIdFromAlerts).toHaveBeenCalledWith({ - alerts: [{ id: 'test-id', index: 'test-index' }], - caseId: 'mock-id-4', + it('does not call the alert service when the attachment is not an alert', async () => { + clientArgs.services.attachmentService.getter.get.mockResolvedValue(commentSO); + await deleteComment({ caseID: 'mock-id-1', attachmentID: 'mock-comment-1' }, clientArgs); + + expect(clientArgs.services.alertsService.ensureAlertsAuthorized).not.toHaveBeenCalledWith(); + expect(clientArgs.services.alertsService.removeCaseIdFromAlerts).not.toHaveBeenCalledWith(); }); }); + }); + + describe('deleteAll', () => { + const clientArgs = createCasesClientMockArgs(); + const getAllCaseCommentsResponse = { + saved_objects: mockCaseComments.map((so) => ({ ...so, score: 0 })), + total: mockCaseComments.length, + page: 1, + per_page: mockCaseComments.length, + }; - it('does not call the alert service when the attachment is not an alert', async () => { - clientArgs.services.attachmentService.getter.get.mockResolvedValue(commentSO); - await deleteComment({ caseID: 'mock-id-1', attachmentID: 'mock-comment-1' }, clientArgs); + beforeEach(() => { + jest.clearAllMocks(); + }); - expect(clientArgs.services.alertsService.ensureAlertsAuthorized).not.toHaveBeenCalledWith(); + describe('Alerts', () => { + clientArgs.services.caseService.getAllCaseComments.mockResolvedValue( + getAllCaseCommentsResponse + ); - expect(clientArgs.services.alertsService.removeCaseIdFromAlerts).not.toHaveBeenCalledWith(); + it('delete alerts correctly', async () => { + await deleteAll({ caseID: 'mock-id-4' }, clientArgs); + + expect(clientArgs.services.alertsService.ensureAlertsAuthorized).toHaveBeenCalledWith({ + alerts: [ + { id: 'test-id', index: 'test-index' }, + { id: 'test-id-2', index: 'test-index-2' }, + { id: 'test-id-3', index: 'test-index-3' }, + ], + }); + + expect(clientArgs.services.alertsService.removeCaseIdFromAlerts).toHaveBeenCalledWith({ + alerts: [ + { id: 'test-id', index: 'test-index' }, + { id: 'test-id-2', index: 'test-index-2' }, + { id: 'test-id-3', index: 'test-index-3' }, + ], + caseId: 'mock-id-4', + }); + }); + + it('does not call the alert service when the attachment is not an alert', async () => { + clientArgs.services.caseService.getAllCaseComments.mockResolvedValue({ + ...getAllCaseCommentsResponse, + saved_objects: [{ ...mockCaseComments[0], score: 0 }], + }); + await deleteAll({ caseID: 'mock-id-1' }, clientArgs); + + expect(clientArgs.services.alertsService.ensureAlertsAuthorized).not.toHaveBeenCalledWith(); + expect(clientArgs.services.alertsService.removeCaseIdFromAlerts).not.toHaveBeenCalledWith(); + }); }); }); }); diff --git a/x-pack/plugins/cases/server/client/attachments/delete.ts b/x-pack/plugins/cases/server/client/attachments/delete.ts index 50291f6a684c2..07d3091e8d348 100644 --- a/x-pack/plugins/cases/server/client/attachments/delete.ts +++ b/x-pack/plugins/cases/server/client/attachments/delete.ts @@ -7,7 +7,7 @@ import Boom from '@hapi/boom'; -import type { CommentAttributes } from '../../../common/api'; +import type { CommentRequest, CommentRequestAlertType } from '../../../common/api'; import { Actions, ActionTypes } from '../../../common/api'; import { CASE_SAVED_OBJECT } from '../../../common/constants'; import { getAlertInfoFromComments, isCommentRequestTypeAlert } from '../../common/utils'; @@ -25,7 +25,7 @@ export async function deleteAll( ): Promise { const { user, - services: { caseService, attachmentService, userActionService }, + services: { caseService, attachmentService, userActionService, alertsService }, logger, authorization, } = clientArgs; @@ -61,6 +61,10 @@ export async function deleteAll( })), user, }); + + const attachments = comments.saved_objects.map((comment) => comment.attributes); + + await handleAlerts({ alertsService, attachments, caseId: caseID }); } catch (error) { throw createCaseError({ message: `Failed to delete all comments case id: ${caseID}: ${error}`, @@ -121,7 +125,7 @@ export async function deleteComment( owner: attachment.attributes.owner, }); - await handleAlerts({ alertsService, attachment: attachment.attributes, caseId: id }); + await handleAlerts({ alertsService, attachments: [attachment.attributes], caseId: id }); } catch (error) { throw createCaseError({ message: `Failed to delete comment: ${caseID} comment id: ${attachmentID}: ${error}`, @@ -133,16 +137,20 @@ export async function deleteComment( interface HandleAlertsArgs { alertsService: CasesClientArgs['services']['alertsService']; - attachment: CommentAttributes; + attachments: CommentRequest[]; caseId: string; } -const handleAlerts = async ({ alertsService, attachment, caseId }: HandleAlertsArgs) => { - if (!isCommentRequestTypeAlert(attachment)) { +const handleAlerts = async ({ alertsService, attachments, caseId }: HandleAlertsArgs) => { + const alertAttachments = attachments.filter((attachment): attachment is CommentRequestAlertType => + isCommentRequestTypeAlert(attachment) + ); + + if (alertAttachments.length === 0) { return; } - const alerts = getAlertInfoFromComments([attachment]); + const alerts = getAlertInfoFromComments(alertAttachments); await alertsService.ensureAlertsAuthorized({ alerts }); await alertsService.removeCaseIdFromAlerts({ alerts, caseId }); }; diff --git a/x-pack/plugins/cases/server/client/cases/client.ts b/x-pack/plugins/cases/server/client/cases/client.ts index 28f4662b1bc6d..bf3253fda6558 100644 --- a/x-pack/plugins/cases/server/client/cases/client.ts +++ b/x-pack/plugins/cases/server/client/cases/client.ts @@ -66,8 +66,8 @@ export interface CasesSubClient { * Retrieves multiple cases with the specified IDs. */ bulkGet( - params: CasesBulkGetRequestCertainFields - ): Promise>; + params: CasesBulkGetRequestCertainFields + ): Promise>; /** * Pushes a specific case to an external system. */ diff --git a/x-pack/plugins/cases/server/mocks.ts b/x-pack/plugins/cases/server/mocks.ts index 6a4d76cf035c8..823acef076fe3 100644 --- a/x-pack/plugins/cases/server/mocks.ts +++ b/x-pack/plugins/cases/server/mocks.ts @@ -370,8 +370,8 @@ export const mockCaseComments: Array> = [ id: 'mock-comment-6', attributes: { type: CommentType.alert, - index: 'test-index', - alertId: 'test-id', + index: 'test-index-3', + alertId: 'test-id-3', created_at: '2019-11-25T22:32:30.608Z', created_by: { full_name: 'elastic', diff --git a/x-pack/plugins/cloud_security_posture/public/components/compliance_score_bar.tsx b/x-pack/plugins/cloud_security_posture/public/components/compliance_score_bar.tsx index cc5a6de2a6c53..c598faf19ba78 100644 --- a/x-pack/plugins/cloud_security_posture/public/components/compliance_score_bar.tsx +++ b/x-pack/plugins/cloud_security_posture/public/components/compliance_score_bar.tsx @@ -22,22 +22,27 @@ export const ComplianceScoreBar = ({ const complianceScore = calculatePostureScore(totalPassed, totalFailed); return ( - - - + + )} - - - - {`${complianceScore.toFixed(0)}%`} - - + + + {`${complianceScore.toFixed(0)}%`} + + + ); }; diff --git a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/cloud_posture_score_chart.tsx b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/cloud_posture_score_chart.tsx index 81bd0f3f6052c..c1b86258a46c9 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/cloud_posture_score_chart.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/cloud_posture_score_chart.tsx @@ -164,7 +164,7 @@ export const CloudPostureScoreChart = ({ -  {`-`}  +  -  > = /> ), render: (complianceScore: FindingsByResourcePage['compliance_score'], data) => ( - +
+ +
), dataType: 'number', }, diff --git a/x-pack/plugins/cloud_security_posture/public/pages/configurations/layout/findings_distribution_bar.tsx b/x-pack/plugins/cloud_security_posture/public/pages/configurations/layout/findings_distribution_bar.tsx index 9db41a7786174..947a5d40e4f83 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/configurations/layout/findings_distribution_bar.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/configurations/layout/findings_distribution_bar.tsx @@ -19,6 +19,7 @@ import { FormattedMessage } from '@kbn/i18n-react'; import { i18n } from '@kbn/i18n'; import numeral from '@elastic/numeral'; import { RULE_FAILED, RULE_PASSED } from '../../../../common/constants'; +import { statusColors } from '../../../common/constants'; import type { Evaluation } from '../../../../common/types'; interface Props { @@ -78,7 +79,7 @@ const PassedFailedCounters = ({ passed, failed }: Pick
@@ -130,7 +131,7 @@ const DistributionBar: React.FC> = ({ /> { distributionOnClick(RULE_FAILED); }} diff --git a/x-pack/plugins/cloud_security_posture/public/pages/configurations/layout/findings_layout.tsx b/x-pack/plugins/cloud_security_posture/public/pages/configurations/layout/findings_layout.tsx index fecc0327b68ff..671cc7463c0b9 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/configurations/layout/findings_layout.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/configurations/layout/findings_layout.tsx @@ -81,7 +81,7 @@ const baseColumns = [ /> ), truncateText: true, - width: '150px', + width: '180px', sortable: true, render: (filename: string) => ( @@ -94,7 +94,7 @@ const baseColumns = [ name: i18n.translate('xpack.csp.findings.findingsTable.findingsTableColumn.resultColumnLabel', { defaultMessage: 'Result', }), - width: '120px', + width: '80px', sortable: true, render: (type: PropsOf['type']) => ( @@ -118,6 +118,7 @@ const baseColumns = [ ), sortable: true, truncateText: true, + width: '12%', render: (name: FindingsByResourcePage['resource.name']) => { if (!name) return; @@ -149,6 +150,7 @@ const baseColumns = [ defaultMessage: 'Rule Number', } ), + sortable: true, width: '120px', }, { @@ -174,6 +176,7 @@ const baseColumns = [ 'xpack.csp.findings.findingsTable.findingsTableColumn.ruleSectionColumnLabel', { defaultMessage: 'CIS Section' } ), + width: '150px', sortable: true, truncateText: true, render: (section: string) => ( diff --git a/x-pack/plugins/cloud_security_posture/public/pages/rules/rules_container.tsx b/x-pack/plugins/cloud_security_posture/public/pages/rules/rules_container.tsx index 6351071bc496f..17a47df18efd6 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/rules/rules_container.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/rules/rules_container.tsx @@ -96,6 +96,7 @@ export const RulesContainer = () => { search={(value) => setRulesQuery((currentQuery) => ({ ...currentQuery, search: value }))} searchValue={rulesQuery.search} totalRulesCount={rulesPageData.all_rules.length} + pageSize={rulesPageData.rules_page.length} isSearching={status === 'loading'} /> diff --git a/x-pack/plugins/cloud_security_posture/public/pages/rules/rules_table_header.tsx b/x-pack/plugins/cloud_security_posture/public/pages/rules/rules_table_header.tsx index 1385536c97dbf..0109915ff68c6 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/rules/rules_table_header.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/rules/rules_table_header.tsx @@ -5,19 +5,38 @@ * 2.0. */ import React, { useState } from 'react'; -import { EuiFieldSearch, EuiFlexItem } from '@elastic/eui'; +import { EuiFieldSearch, EuiFlexItem, EuiText, EuiSpacer } from '@elastic/eui'; import useDebounce from 'react-use/lib/useDebounce'; import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; interface RulesTableToolbarProps { search(value: string): void; totalRulesCount: number; searchValue: string; isSearching: boolean; + pageSize: number; } -export const RulesTableHeader = ({ search, searchValue, isSearching }: RulesTableToolbarProps) => ( - +interface RuleTableCount { + pageSize: number; + total: number; +} + +export const RulesTableHeader = ({ + search, + searchValue, + isSearching, + totalRulesCount, + pageSize, +}: RulesTableToolbarProps) => ( + ); const SEARCH_DEBOUNCE_MS = 300; @@ -26,23 +45,44 @@ const SearchField = ({ search, isSearching, searchValue, -}: Pick) => { + totalRulesCount, + pageSize, +}: Pick< + RulesTableToolbarProps, + 'isSearching' | 'searchValue' | 'search' | 'totalRulesCount' | 'pageSize' +>) => { const [localValue, setLocalValue] = useState(searchValue); useDebounce(() => search(localValue), SEARCH_DEBOUNCE_MS, [localValue]); return ( - - setLocalValue(e.target.value)} - style={{ minWidth: 150 }} - fullWidth - /> - +
+ + setLocalValue(e.target.value)} + style={{ minWidth: 150 }} + fullWidth + /> + + +
); }; + +const CurrentPageOfTotal = ({ pageSize, total }: RuleTableCount) => ( + + + + + + +); diff --git a/x-pack/plugins/data_visualizer/common/constants.ts b/x-pack/plugins/data_visualizer/common/constants.ts index c5aa71967f615..8a0c57c72ceda 100644 --- a/x-pack/plugins/data_visualizer/common/constants.ts +++ b/x-pack/plugins/data_visualizer/common/constants.ts @@ -7,7 +7,6 @@ import { i18n } from '@kbn/i18n'; import { KBN_FIELD_TYPES } from '@kbn/field-types'; -import type { DocLinksStart } from '@kbn/core/public'; export const APP_ID = 'data_visualizer'; export const UI_SETTING_MAX_FILE_SIZE = 'fileUpload:maxFileSize'; @@ -65,116 +64,3 @@ export const featureTitle = i18n.translate('xpack.dataVisualizer.title', { defaultMessage: 'Upload a file', }); export const featureId = `file_data_visualizer`; - -const UNKNOWN_FIELD_TYPE_DESC = i18n.translate( - 'xpack.dataVisualizer.index.fieldNameDescription.unknownField', - { - defaultMessage: 'Unknown field', - } -); - -export function getFieldTypeDescription(type: string, docLinks: DocLinksStart) { - switch (type) { - case SUPPORTED_FIELD_TYPES.BOOLEAN: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.booleanField', { - defaultMessage: 'True and false values', - }); - case SUPPORTED_FIELD_TYPES.CONFLICT: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.conflictField', { - defaultMessage: 'Field has values of different types. Resolve in Management > Data Views.', - }); - case SUPPORTED_FIELD_TYPES.DATE: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.dateField', { - defaultMessage: 'A date string or the number of seconds or milliseconds since 1/1/1970', - }); - case SUPPORTED_FIELD_TYPES.DATE_RANGE: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.dateRangeField', { - defaultMessage: 'Range of {dateFieldTypeLink} values. {viewSupportedDateFormatsLink}', - values: { - dateFieldTypeLink: - `` + - i18n.translate( - 'xpack.dataVisualizer.index.fieldNameDescription.dateRangeFieldLinkText', - { - defaultMessage: 'date', - } - ) + - '', - viewSupportedDateFormatsLink: - `` + - i18n.translate( - 'xpack.dataVisualizer.index.fieldNameDescription.viewSupportedDateFormatsLinkText', - { - defaultMessage: 'View supported date formats.', - } - ) + - '', - }, - }); - case SUPPORTED_FIELD_TYPES.GEO_POINT: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.geoPointField', { - defaultMessage: 'Latitude and longitude points', - }); - case SUPPORTED_FIELD_TYPES.GEO_SHAPE: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.geoShapeField', { - defaultMessage: 'Complex shapes such as polygons', - }); - case SUPPORTED_FIELD_TYPES.HISTOGRAM: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.histogramField', { - defaultMessage: 'Pre-aggregated numerical values in the form of a histogram', - }); - case SUPPORTED_FIELD_TYPES.IP: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.ipAddressField', { - defaultMessage: 'IPv4 and IPv6 addresses', - }); - case SUPPORTED_FIELD_TYPES.IP_RANGE: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.ipAddressRangeField', { - defaultMessage: 'Range of IP values supporting either IPv4 or IPv6 (or mixed) addresses', - }); - case SUPPORTED_FIELD_TYPES.MURMUR3: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.murmur3Field', { - defaultMessage: 'Field that computes and stores hashes of values', - }); - case SUPPORTED_FIELD_TYPES.NESTED: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.nestedField', { - defaultMessage: 'JSON object that preserves the relationship between its subfields', - }); - case SUPPORTED_FIELD_TYPES.NUMBER: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.numberField', { - defaultMessage: 'Long, integer, short, byte, double, and float values', - }); - case SUPPORTED_FIELD_TYPES.STRING: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.stringField', { - defaultMessage: 'Full text such as the body of an email or a product description', - }); - case SUPPORTED_FIELD_TYPES.TEXT: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.textField', { - defaultMessage: 'Full text such as the body of an email or a product description', - }); - case SUPPORTED_FIELD_TYPES.KEYWORD: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.keywordField', { - defaultMessage: - 'Structured content such as an ID, email address, hostname, status code, or tag', - }); - case SUPPORTED_FIELD_TYPES.VERSION: - return i18n.translate('xpack.dataVisualizer.index.fieldNameDescription.versionField', { - defaultMessage: 'Software versions. Supports {SemanticVersioningLink} precedence rules', - values: { - SemanticVersioningLink: - `` + - i18n.translate( - 'xpack.dataVisualizer.index.advancedSettings.discover.fieldNameDescription.versionFieldLinkText', - { - defaultMessage: 'Semantic Versioning', - } - ) + - '', - }, - }); - default: - return UNKNOWN_FIELD_TYPE_DESC; - } -} diff --git a/x-pack/plugins/data_visualizer/common/types/field_request_config.ts b/x-pack/plugins/data_visualizer/common/types/field_request_config.ts index d559d5d46f528..34a9f5d6036f2 100644 --- a/x-pack/plugins/data_visualizer/common/types/field_request_config.ts +++ b/x-pack/plugins/data_visualizer/common/types/field_request_config.ts @@ -18,6 +18,7 @@ export interface FieldRequestConfig { type: SupportedFieldType; cardinality: number; existsInDocs: boolean; + supportedAggs?: Set; } export interface DocumentCountBuckets { diff --git a/x-pack/plugins/data_visualizer/common/types/field_stats.ts b/x-pack/plugins/data_visualizer/common/types/field_stats.ts index 654114923eb2b..5f825c5299115 100644 --- a/x-pack/plugins/data_visualizer/common/types/field_stats.ts +++ b/x-pack/plugins/data_visualizer/common/types/field_stats.ts @@ -74,9 +74,9 @@ export const isIKibanaSearchResponse = (arg: unknown): arg is IKibanaSearchRespo export interface NumericFieldStats { fieldName: string; count?: number; - min: number; - max: number; - avg: number; + min?: number; + max?: number; + avg?: number; isTopValuesSampled: boolean; topValues: Bucket[]; topValuesSampleSize: number; @@ -211,6 +211,8 @@ export interface FieldStatsCommonRequestParams { samplingOption: SamplingOption; } +export type SupportedAggs = Set; + export interface OverallStatsSearchStrategyParams { sessionId?: string; earliest?: number; @@ -222,7 +224,10 @@ export interface OverallStatsSearchStrategyParams { index: string; timeFieldName?: string; runtimeFieldMap?: estypes.MappingRuntimeFields; - aggregatableFields: string[]; + aggregatableFields: Array<{ + name: string; + supportedAggs: SupportedAggs; + }>; nonAggregatableFields: string[]; fieldsToFetch?: string[]; browserSessionSeed: number; @@ -258,6 +263,7 @@ export interface Field { type: string; cardinality: number; safeFieldName: string; + supportedAggs?: Set; } export interface Aggs { diff --git a/x-pack/plugins/data_visualizer/common/types/field_vis_config.ts b/x-pack/plugins/data_visualizer/common/types/field_vis_config.ts index d7da635ad4b05..8d46ca6c2d3c1 100644 --- a/x-pack/plugins/data_visualizer/common/types/field_vis_config.ts +++ b/x-pack/plugins/data_visualizer/common/types/field_vis_config.ts @@ -5,6 +5,7 @@ * 2.0. */ +import type { SupportedAggs } from './field_stats'; import type { Percentile, SupportedFieldType, FieldVisStats } from '.'; export interface MetricFieldVisStats { avg?: number; @@ -27,16 +28,19 @@ export interface FieldVisConfig { existsInDocs: boolean; aggregatable: boolean; loading: boolean; + secondaryType: string; stats?: FieldVisStats; fieldFormat?: any; isUnsupportedType?: boolean; deletable?: boolean; + supportedAggs?: SupportedAggs; } export interface FileBasedFieldVisConfig { type: SupportedFieldType; fieldName?: string; displayName?: string; + secondaryType?: string; stats?: FieldVisStats; format?: string; } diff --git a/x-pack/plugins/data_visualizer/kibana.jsonc b/x-pack/plugins/data_visualizer/kibana.jsonc index f1fdb5ce38332..ffeef7793e921 100644 --- a/x-pack/plugins/data_visualizer/kibana.jsonc +++ b/x-pack/plugins/data_visualizer/kibana.jsonc @@ -34,6 +34,7 @@ "esUiShared", "fieldFormats", "uiActions", + "unifiedFieldList", "lens", "cloudChat", "savedSearch" diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts b/x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts index b053715090c7b..76281190cffcc 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts +++ b/x-pack/plugins/data_visualizer/public/application/common/components/field_data_row/action_menu/lens_utils.ts @@ -68,15 +68,24 @@ export function getNumberSettings(item: FieldVisConfig, defaultDataView: DataVie return { columns, layer }; } + const operationType = item.supportedAggs?.has('avg') ? 'average' : 'max'; + const operationLabel = + operationType === 'average' + ? i18n.translate('xpack.dataVisualizer.index.lensChart.averageOfLabel', { + defaultMessage: 'Average of {fieldName}', + values: { fieldName: item.fieldName }, + }) + : i18n.translate('xpack.dataVisualizer.index.lensChart.maximumOfLabel', { + defaultMessage: 'Maximum of {fieldName}', + values: { fieldName: item.fieldName }, + }); + const columns: Record = { col2: { dataType: 'number', isBucketed: false, - label: i18n.translate('xpack.dataVisualizer.index.lensChart.averageOfLabel', { - defaultMessage: 'Average of {fieldName}', - values: { fieldName: item.fieldName }, - }), - operationType: 'average', + label: operationLabel, + operationType, sourceField: item.fieldName!, }, col1: { diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/field_type_icon/field_type_icon.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/field_type_icon/field_type_icon.tsx index 1f77f0284803f..cdd27a4b45954 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/field_type_icon/field_type_icon.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/field_type_icon/field_type_icon.tsx @@ -9,18 +9,17 @@ import React, { FC } from 'react'; import { EuiToolTip } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { FieldIcon } from '@kbn/react-field'; -import { getJobTypeLabel } from '../../util/field_types_utils'; -import type { SupportedFieldType } from '../../../../../common/types'; +import { getFieldTypeName } from '@kbn/unified-field-list-plugin/public'; import './_index.scss'; interface FieldTypeIconProps { tooltipEnabled: boolean; - type: SupportedFieldType; + type: string; } export const FieldTypeIcon: FC = ({ tooltipEnabled = false, type }) => { const label = - getJobTypeLabel(type) ?? + getFieldTypeName(type) ?? i18n.translate('xpack.dataVisualizer.fieldTypeIcon.fieldTypeTooltip', { defaultMessage: '{type} type', values: { type }, diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/field_types_filter/field_types_filter.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/field_types_filter/field_types_filter.tsx index 290403796eb91..a1b6a76391a5e 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/field_types_filter/field_types_filter.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/field_types_filter/field_types_filter.tsx @@ -8,6 +8,7 @@ import React, { FC, useMemo } from 'react'; import { i18n } from '@kbn/i18n'; import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; +import { getFieldTypeName } from '@kbn/unified-field-list-plugin/public'; import { FieldTypesHelpPopover } from './field_types_help_popover'; import { MultiSelectPicker, Option } from '../multi_select_picker'; import type { @@ -15,7 +16,6 @@ import type { FileBasedUnknownFieldVisConfig, } from '../../../../../common/types/field_vis_config'; import { FieldTypeIcon } from '../field_type_icon'; -import { jobTypeLabels } from '../../util/field_types_utils'; interface Props { fields: Array; @@ -40,9 +40,8 @@ export const DataVisualizerFieldTypesFilter: FC = ({ const fieldTypesTracker = new Set(); const fieldTypes: Option[] = []; fields.forEach(({ type }) => { - if (type !== undefined && !fieldTypesTracker.has(type) && jobTypeLabels[type] !== undefined) { - const label = jobTypeLabels[type]; - + const label = getFieldTypeName(type); + if (type !== undefined && !fieldTypesTracker.has(type) && label !== undefined) { fieldTypesTracker.add(type); fieldTypes.push({ value: type, diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/field_types_filter/field_types_help_popover.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/field_types_filter/field_types_help_popover.tsx index 96246ceb45d98..bc2e816719f8b 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/field_types_filter/field_types_help_popover.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/field_types_filter/field_types_help_popover.tsx @@ -22,7 +22,7 @@ import React, { FC, useMemo, useState } from 'react'; import { i18n } from '@kbn/i18n'; import { FieldIcon } from '@kbn/react-field'; import { FormattedMessage } from '@kbn/i18n-react'; -import { getFieldTypeDescription } from '../../../../../common/constants'; +import { getFieldTypeDescription } from '@kbn/unified-field-list-plugin/public'; import { useDataVisualizerKibana } from '../../../kibana_context'; interface FieldTypeTableItem { @@ -49,9 +49,9 @@ export const FieldTypesHelpPopover: FC<{ fieldTypes.map((type, index) => ({ id: index, dataType: type, - description: getFieldTypeDescription(type, docLinks), + description: getFieldTypeDescription(type), })), - [fieldTypes, docLinks] + [fieldTypes] ); const columnsSidebar = [ diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/filter_fields.ts b/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/filter_fields.ts index 4ca65eec6635b..0a9307d43a0d7 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/filter_fields.ts +++ b/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/filter_fields.ts @@ -10,6 +10,11 @@ import { SUPPORTED_FIELD_TYPES } from '../../../../../common/constants'; interface CommonFieldConfig { type: string; fieldName?: string; + secondaryType?: string; +} + +export function matchFieldType(fieldType: string, config: T) { + return fieldType === config.secondaryType || fieldType === config.type; } export function filterFields( fields: T[], @@ -20,12 +25,12 @@ export function filterFields( if (visibleFieldTypes && visibleFieldTypes.length > 0) { items = items.filter( - (config) => visibleFieldTypes.findIndex((field) => field === config.type) > -1 + (config) => visibleFieldTypes.findIndex((fieldType) => matchFieldType(fieldType, config)) > -1 ); } if (visibleFieldNames && visibleFieldNames.length > 0) { items = items.filter((config) => { - return visibleFieldNames.findIndex((field) => field === config.fieldName) > -1; + return visibleFieldNames.findIndex((fieldName) => fieldName === config.fieldName) > -1; }); } diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/get_field_names.ts b/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/get_field_names.ts index 406379fca7340..3802aed67b980 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/get_field_names.ts +++ b/x-pack/plugins/data_visualizer/public/application/common/components/fields_stats_grid/get_field_names.ts @@ -10,6 +10,7 @@ import { ES_FIELD_TYPES } from '@kbn/field-types'; import type { FindFileStructureResponse } from '@kbn/file-upload-plugin/common'; import type { SupportedFieldType } from '../../../../../common/types'; import { SUPPORTED_FIELD_TYPES } from '../../../../../common/constants'; + export function getFieldNames(results: FindFileStructureResponse) { const { mappings, field_stats: fieldStats, column_names: columnNames } = results; diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/components/field_data_expanded_row/number_content.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/components/field_data_expanded_row/number_content.tsx index 1c54a591fd905..0a3594f316de5 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/components/field_data_expanded_row/number_content.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/components/field_data_expanded_row/number_content.tsx @@ -17,6 +17,7 @@ import { import { FormattedMessage } from '@kbn/i18n-react'; import { i18n } from '@kbn/i18n'; +import { isDefined } from '@kbn/ml-is-defined'; import type { FieldDataRowProps } from '../../types/field_data_row'; import { kibanaFieldFormat, numberAsOrdinal } from '../../../utils'; import { MetricDistributionChart, buildChartDataFromStats } from '../metric_distribution_chart'; @@ -58,16 +59,20 @@ export const NumberContent: FC = ({ config, onAddFilter }) => ), value: kibanaFieldFormat(min, fieldFormat), }, - { - function: 'median', - display: ( - - ), - value: kibanaFieldFormat(median, fieldFormat), - }, + ...(isDefined(median) + ? [ + { + function: 'median', + display: ( + + ), + value: kibanaFieldFormat(median, fieldFormat), + }, + ] + : []), { function: 'max', display: ( diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/data_visualizer_stats_table.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/data_visualizer_stats_table.tsx index 51c31dd3af21c..696c4b0cef011 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/data_visualizer_stats_table.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/stats_table/data_visualizer_stats_table.tsx @@ -193,8 +193,8 @@ export const DataVisualizerTable = ({ name: i18n.translate('xpack.dataVisualizer.dataGrid.typeColumnName', { defaultMessage: 'Type', }), - render: (fieldType: SupportedFieldType) => { - return ; + render: (fieldType: SupportedFieldType, item: DataVisualizerTableItem) => { + return ; }, width: dimensions.type, sortable: true, @@ -396,7 +396,7 @@ export const DataVisualizerTable = ({ boxShadow: `inset 0 0px 0, inset 0 -1px 0 ${euiTheme.border.color}`, }, '.euiTableRow > .euiTableRowCel': { - 'border-top': 0, + borderTop: 0, }, [useEuiMinBreakpoint('s')]: { '& .columnHeader__title': { diff --git a/x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx b/x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx index b007e9883beaf..6f964aea8c963 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx +++ b/x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx @@ -54,6 +54,7 @@ export const TopValues: FC = ({ stats, fieldFormat, barColor, compressed, if (stats === undefined || !stats.topValues) return null; const { topValues, fieldName, sampleCount } = stats; + if (topValues?.length === 0) return null; const totalDocuments = stats.totalDocuments ?? sampleCount ?? 0; const topValuesOtherCountPercent = 1 - (topValues ? topValues.reduce((acc, bucket) => acc + bucket.percent, 0) : 0); diff --git a/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.test.ts b/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.test.ts deleted file mode 100644 index 0f3ae62eae209..0000000000000 --- a/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.test.ts +++ /dev/null @@ -1,30 +0,0 @@ -/* - * 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 { SUPPORTED_FIELD_TYPES } from '../../../../common/constants'; -import { getJobTypeLabel, jobTypeLabels } from './field_types_utils'; - -describe('field type utils', () => { - describe('getJobTypeLabel: Getting a field type aria label by passing what it is stored in constants', () => { - test('should returns all SUPPORTED_FIELD_TYPES labels exactly as it is for each correct value', () => { - const keys = Object.keys(SUPPORTED_FIELD_TYPES); - const receivedLabels: Record = {}; - const testStorage = jobTypeLabels; - keys.forEach((key) => { - const constant = key as keyof typeof SUPPORTED_FIELD_TYPES; - receivedLabels[SUPPORTED_FIELD_TYPES[constant]] = getJobTypeLabel( - SUPPORTED_FIELD_TYPES[constant] - ); - }); - - expect(receivedLabels).toEqual(testStorage); - }); - test('should returns NULL as SUPPORTED_FIELD_TYPES does not contain such a keyword', () => { - expect(getJobTypeLabel('SUPPORTED_FIELD_TYPES')).toBe(null); - }); - }); -}); diff --git a/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts b/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts index 5afa3869abd88..dc37dc625fcc3 100644 --- a/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts +++ b/x-pack/plugins/data_visualizer/public/application/common/util/field_types_utils.ts @@ -5,116 +5,15 @@ * 2.0. */ -import { i18n } from '@kbn/i18n'; import { DataViewField } from '@kbn/data-views-plugin/public'; -import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from '@kbn/field-types'; -import type { SupportedFieldType } from '../../../../common/types'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; +import { getFieldType } from '@kbn/unified-field-list-plugin/public'; import { SUPPORTED_FIELD_TYPES } from '../../../../common/constants'; -export const getJobTypeLabel = (type: string) => { - return type in jobTypeLabels ? jobTypeLabels[type as keyof typeof jobTypeLabels] : null; -}; - -export const jobTypeLabels: Record = { - [SUPPORTED_FIELD_TYPES.BOOLEAN]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.booleanTypeLabel', - { - defaultMessage: 'Boolean', - } - ), - [SUPPORTED_FIELD_TYPES.CONFLICT]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.conflictTypeLabel', - { - defaultMessage: 'Conflict', - } - ), - [SUPPORTED_FIELD_TYPES.DATE]: i18n.translate('xpack.dataVisualizer.fieldTypeIcon.dateTypeLabel', { - defaultMessage: 'Date', - }), - [SUPPORTED_FIELD_TYPES.DATE_RANGE]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.dateRangeTypeLabel', - { - defaultMessage: 'Date range', - } - ), - [SUPPORTED_FIELD_TYPES.GEO_POINT]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.geoPointTypeLabel', - { - defaultMessage: 'Geo point', - } - ), - [SUPPORTED_FIELD_TYPES.GEO_SHAPE]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.geoShapeTypeLabel', - { - defaultMessage: 'Geo shape', - } - ), - [SUPPORTED_FIELD_TYPES.HISTOGRAM]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.histogramTypeLabel', - { - defaultMessage: 'Histogram', - } - ), - [SUPPORTED_FIELD_TYPES.IP]: i18n.translate('xpack.dataVisualizer.fieldTypeIcon.ipTypeLabel', { - defaultMessage: 'IP', - }), - [SUPPORTED_FIELD_TYPES.IP_RANGE]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.ipRangeTypeLabel', - { - defaultMessage: 'IP range', - } - ), - [SUPPORTED_FIELD_TYPES.MURMUR3]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.murmur3TypeLabel', - { - defaultMessage: 'Murmur3', - } - ), - [SUPPORTED_FIELD_TYPES.NESTED]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.numberTypeLabel', - { - defaultMessage: 'Number', - } - ), - [SUPPORTED_FIELD_TYPES.NUMBER]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.numberTypeLabel', - { - defaultMessage: 'Number', - } - ), - [SUPPORTED_FIELD_TYPES.STRING]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.stringTypeLabel', - { - defaultMessage: 'String', - } - ), - [SUPPORTED_FIELD_TYPES.TEXT]: i18n.translate('xpack.dataVisualizer.fieldTypeIcon.textTypeLabel', { - defaultMessage: 'Text', - }), - [SUPPORTED_FIELD_TYPES.KEYWORD]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.keywordTypeLabel', - { - defaultMessage: 'Keyword', - } - ), - [SUPPORTED_FIELD_TYPES.VERSION]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.versionTypeLabel', - { - defaultMessage: 'Version', - } - ), - [SUPPORTED_FIELD_TYPES.UNKNOWN]: i18n.translate( - 'xpack.dataVisualizer.fieldTypeIcon.unknownTypeLabel', - { - defaultMessage: 'Unknown', - } - ), -}; - // convert kibana types to ML Job types // this is needed because kibana types only have string and not text and keyword. // and we can't use ES_FIELD_TYPES because it has no NUMBER type -export function kbnTypeToJobType(field: DataViewField) { +export function kbnTypeToSupportedType(field: DataViewField) { // Return undefined if not one of the supported data visualizer field types. let type; @@ -126,32 +25,9 @@ export function kbnTypeToJobType(field: DataViewField) { type = SUPPORTED_FIELD_TYPES.VERSION; } break; - case KBN_FIELD_TYPES.NUMBER: - if (field.esTypes?.some((d) => d === ES_FIELD_TYPES.AGGREGATE_METRIC_DOUBLE)) { - break; - } - type = SUPPORTED_FIELD_TYPES.NUMBER; - break; - case KBN_FIELD_TYPES.DATE: - type = SUPPORTED_FIELD_TYPES.DATE; - break; - case KBN_FIELD_TYPES.IP: - type = SUPPORTED_FIELD_TYPES.IP; - break; - case KBN_FIELD_TYPES.BOOLEAN: - type = SUPPORTED_FIELD_TYPES.BOOLEAN; - break; - case KBN_FIELD_TYPES.GEO_POINT: - type = SUPPORTED_FIELD_TYPES.GEO_POINT; - break; - case KBN_FIELD_TYPES.GEO_SHAPE: - type = SUPPORTED_FIELD_TYPES.GEO_SHAPE; - break; - case KBN_FIELD_TYPES.HISTOGRAM: - type = SUPPORTED_FIELD_TYPES.HISTOGRAM; - break; default: + type = getFieldType(field); break; } diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx index 18695703fb87d..8ea4794ee548f 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx @@ -37,6 +37,7 @@ import { import { useStorage } from '@kbn/ml-local-storage'; import type { SavedSearch } from '@kbn/saved-search-plugin/public'; +import { kbnTypeToSupportedType } from '../../../common/util/field_types_utils'; import { useCurrentEuiTheme } from '../../../common/hooks/use_current_eui_theme'; import { DV_FROZEN_TIER_PREFERENCE, @@ -59,12 +60,10 @@ import { DataVisualizerIndexBasedPageUrlState, } from '../../types/index_data_visualizer_state'; import { SEARCH_QUERY_LANGUAGE, SearchQueryLanguage } from '../../types/combined_query'; -import type { SupportedFieldType } from '../../../../../common/types'; import { useDataVisualizerKibana } from '../../../kibana_context'; import { FieldCountPanel } from '../../../common/components/field_count_panel'; import { DocumentCountContent } from '../../../common/components/document_count_content'; import { OMIT_FIELDS } from '../../../../../common/constants'; -import { kbnTypeToJobType } from '../../../common/util/field_types_utils'; import { SearchPanel } from '../search_panel'; import { ActionsPanel } from '../actions_panel'; import { createMergedEsQuery } from '../../utils/saved_search_utils'; @@ -214,10 +213,10 @@ export const IndexDataVisualizerView: FC = (dataVi const fieldTypes = useMemo(() => { // Obtain the list of non metric field types which appear in the index pattern. - const indexedFieldTypes: SupportedFieldType[] = []; + const indexedFieldTypes: string[] = []; dataViewFields.forEach((field) => { if (!OMIT_FIELDS.includes(field.name) && field.scripted !== true) { - const dataVisualizerType: SupportedFieldType | undefined = kbnTypeToJobType(field); + const dataVisualizerType = kbnTypeToSupportedType(field); if (dataVisualizerType !== undefined && !indexedFieldTypes.includes(dataVisualizerType)) { indexedFieldTypes.push(dataVisualizerType); } diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/field_type_filter.tsx b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/field_type_filter.tsx index 697aecf2bb2f6..b7e1fe368629e 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/field_type_filter.tsx +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/field_type_filter.tsx @@ -9,22 +9,21 @@ import React, { FC, useMemo } from 'react'; import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { css } from '@emotion/react'; +import { getFieldTypeName } from '@kbn/unified-field-list-plugin/public'; import { useCurrentEuiTheme } from '../../../common/hooks/use_current_eui_theme'; import { FieldTypesHelpPopover } from '../../../common/components/field_types_filter/field_types_help_popover'; -import type { SupportedFieldType } from '../../../../../common/types'; import { FieldTypeIcon } from '../../../common/components/field_type_icon'; import { MultiSelectPicker, Option } from '../../../common/components/multi_select_picker'; -import { jobTypeLabels } from '../../../common/util/field_types_utils'; export const DataVisualizerFieldTypeFilter: FC<{ - indexedFieldTypes: SupportedFieldType[]; + indexedFieldTypes: string[]; setVisibleFieldTypes(q: string[]): void; visibleFieldTypes: string[]; }> = ({ indexedFieldTypes, setVisibleFieldTypes, visibleFieldTypes }) => { const euiTheme = useCurrentEuiTheme(); const options: Option[] = useMemo(() => { return indexedFieldTypes.map((indexedFieldName) => { - const label = jobTypeLabels[indexedFieldName] ?? ''; + const label = getFieldTypeName(indexedFieldName) ?? indexedFieldName; return { value: indexedFieldName, diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx index 9aeab958683e7..7a4b97f4bf5a5 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/search_panel/search_panel.tsx @@ -21,7 +21,6 @@ import { DataView, DataViewField } from '@kbn/data-views-plugin/public'; import { isDefined } from '@kbn/ml-is-defined'; import { DataVisualizerFieldNamesFilter } from './field_name_filter'; import { DataVisualizerFieldTypeFilter } from './field_type_filter'; -import type { SupportedFieldType } from '../../../../../common/types'; import { SearchQueryLanguage } from '../../types/combined_query'; import { useDataVisualizerKibana } from '../../../kibana_context'; import { createMergedEsQuery } from '../../utils/saved_search_utils'; @@ -33,7 +32,7 @@ interface Props { searchQuery: Query['query']; searchQueryLanguage: SearchQueryLanguage; overallStats: OverallStats; - indexedFieldTypes: SupportedFieldType[]; + indexedFieldTypes: string[]; setVisibleFieldTypes(q: string[]): void; visibleFieldTypes: string[]; setVisibleFieldNames(q: string[]): void; diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts index 596c6e7a39b1f..224cbd5208b8e 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_data_visualizer_grid_data.ts @@ -16,6 +16,7 @@ import seedrandom from 'seedrandom'; import type { SamplingOption } from '@kbn/discover-plugin/public/application/main/components/field_stats_table/field_stats_table'; import type { Dictionary } from '@kbn/ml-url-state'; import { mlTimefilterRefresh$, useTimefilter } from '@kbn/ml-date-picker'; +import { filterFields } from '../../common/components/fields_stats_grid/filter_fields'; import type { RandomSamplerOption } from '../constants/random_sampler'; import type { DataVisualizerIndexBasedAppState } from '../types/index_data_visualizer_state'; import { useDataVisualizerKibana } from '../../kibana_context'; @@ -24,12 +25,12 @@ import type { MetricFieldsStats } from '../../common/components/stats_table/comp import { TimeBuckets } from '../../../../common/services/time_buckets'; import type { FieldVisConfig } from '../../common/components/stats_table/types'; import { - SUPPORTED_FIELD_TYPES, NON_AGGREGATABLE_FIELD_TYPES, OMIT_FIELDS, + SUPPORTED_FIELD_TYPES, } from '../../../../common/constants'; import type { FieldRequestConfig, SupportedFieldType } from '../../../../common/types'; -import { kbnTypeToJobType } from '../../common/util/field_types_utils'; +import { kbnTypeToSupportedType } from '../../common/util/field_types_utils'; import { getActions } from '../../common/components/field_data_row/action_menu'; import type { DataVisualizerGridInput } from '../embeddables/grid_embeddable/grid_embeddable'; import { getDefaultPageState } from '../components/index_data_visualizer_view/index_data_visualizer_view'; @@ -37,6 +38,7 @@ import { useFieldStatsSearchStrategy } from './use_field_stats'; import { useOverallStats } from './use_overall_stats'; import type { OverallStatsSearchStrategyParams } from '../../../../common/types/field_stats'; import type { AggregatableField, NonAggregatableField } from '../types/overall_stats'; +import { getSupportedAggs } from '../utils/get_supported_aggs'; const defaults = getDefaultPageState(); @@ -196,7 +198,7 @@ export const useDataVisualizerGridData = ( const aggInterval = buckets.getInterval(); - const aggregatableFields: string[] = []; + const aggregatableFields: OverallStatsSearchStrategyParams['aggregatableFields'] = []; const nonAggregatableFields: string[] = []; const fields = currentDataView.fields; @@ -211,7 +213,7 @@ export const useDataVisualizerGridData = ( !NON_AGGREGATABLE_FIELD_TYPES.has(field.type) && !field.esTypes?.some((d) => d === ES_FIELD_TYPES.AGGREGATE_METRIC_DOUBLE) ) { - aggregatableFields.push(field.name); + aggregatableFields.push({ name: field.name, supportedAggs: getSupportedAggs(field) }); } else { nonAggregatableFields.push(field.name); } @@ -264,10 +266,8 @@ export const useDataVisualizerGridData = ( const existMetricFields = metricConfigs .map((config) => { return { - fieldName: config.fieldName, - type: config.type, - cardinality: config.stats?.cardinality ?? 0, - existsInDocs: config.existsInDocs, + ...config, + cardinality: config.stats?.cardinality, }; }) .filter((c) => c !== undefined) as FieldRequestConfig[]; @@ -277,10 +277,8 @@ export const useDataVisualizerGridData = ( const existNonMetricFields: FieldRequestConfig[] = nonMetricConfigs .map((config) => { return { - fieldName: config.fieldName, - type: config.type, - cardinality: config.stats?.cardinality ?? 0, - existsInDocs: config.existsInDocs, + ...config, + cardinality: config.stats?.cardinality, }; }) .filter((c) => c !== undefined) as FieldRequestConfig[]; @@ -371,9 +369,11 @@ export const useDataVisualizerGridData = ( ...fieldData, fieldFormat: currentDataView.getFormatterForField(field), type: SUPPORTED_FIELD_TYPES.NUMBER, + secondaryType: kbnTypeToSupportedType(field), loading: fieldData?.existsInDocs ?? true, aggregatable: true, deletable: field.runtimeField !== undefined, + supportedAggs: getSupportedAggs(field), }; if (field.displayName !== metricConfig.fieldName) { metricConfig.displayName = field.displayName; @@ -392,7 +392,7 @@ export const useDataVisualizerGridData = ( const createNonMetricCards = useCallback(() => { const allNonMetricFields = dataViewFields.filter((f) => { return ( - (f.type !== KBN_FIELD_TYPES.NUMBER || f.timeSeriesMetric === 'counter') && + f.type !== KBN_FIELD_TYPES.NUMBER && f.displayName !== undefined && isDisplayField(f.displayName) === true ); @@ -447,6 +447,7 @@ export const useDataVisualizerGridData = ( const fieldData = nonMetricFieldData.find((f) => f.fieldName === field.spec.name); const nonMetricConfig: Partial = { ...(fieldData ? fieldData : {}), + secondaryType: kbnTypeToSupportedType(field), fieldFormat: currentDataView.getFormatterForField(field), aggregatable: field.aggregatable, loading: fieldData?.existsInDocs ?? true, @@ -455,7 +456,7 @@ export const useDataVisualizerGridData = ( // Map the field type from the Kibana index pattern to the field type // used in the data visualizer. - const dataVisualizerType = kbnTypeToJobType(field); + const dataVisualizerType = kbnTypeToSupportedType(field) as SupportedFieldType; if (dataVisualizerType !== undefined) { nonMetricConfig.type = dataVisualizerType; } else { @@ -485,16 +486,12 @@ export const useDataVisualizerGridData = ( () => { const fieldStats = strategyResponse.fieldStats; let combinedConfigs = [...nonMetricConfigs, ...metricConfigs]; - if (visibleFieldTypes && visibleFieldTypes.length > 0) { - combinedConfigs = combinedConfigs.filter( - (config) => visibleFieldTypes.findIndex((field) => field === config.type) > -1 - ); - } - if (visibleFieldNames && visibleFieldNames.length > 0) { - combinedConfigs = combinedConfigs.filter( - (config) => visibleFieldNames.findIndex((field) => field === config.fieldName) > -1 - ); - } + + combinedConfigs = filterFields( + combinedConfigs, + visibleFieldNames, + visibleFieldTypes + ).filteredFields; if (fieldStats) { combinedConfigs = combinedConfigs.map((c) => { diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_field_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_field_stats.ts index 06e7725f25652..d04106c2b0932 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_field_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/hooks/use_field_stats.ts @@ -177,9 +177,7 @@ export function useFieldStatsSearchStrategy( const batches = createBatchedRequests( pageOfConfigs.map((config, idx) => ({ - fieldName: config.fieldName, - type: config.type, - cardinality: config.cardinality, + ...config, safeFieldName: getSafeAggregationName(config.fieldName, idx), })), 10 diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_fields_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_fields_stats.ts index a549e40704c0f..80d5b8e338b97 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_fields_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_fields_stats.ts @@ -7,8 +7,11 @@ import type { Observable } from 'rxjs'; import type { ISearchOptions } from '@kbn/data-plugin/common'; -import { ISearchStart } from '@kbn/data-plugin/public'; -import type { FieldStatsCommonRequestParams } from '../../../../../common/types/field_stats'; +import type { ISearchStart } from '@kbn/data-plugin/public'; +import type { + FieldStatsCommonRequestParams, + SupportedAggs, +} from '../../../../../common/types/field_stats'; import type { FieldStatsError } from '../../../../../common/types/field_stats'; import type { FieldStats } from '../../../../../common/types/field_stats'; import { SUPPORTED_FIELD_TYPES } from '../../../../../common/constants'; @@ -26,6 +29,7 @@ export const getFieldsStats = ( type: string; cardinality: number; safeFieldName: string; + supportedAggs?: SupportedAggs; }>, options: ISearchOptions ): Observable | undefined => { diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_numeric_field_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_numeric_field_stats.ts index 20143f5fc1581..b9dd55351781f 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_numeric_field_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/get_numeric_field_stats.ts @@ -58,35 +58,58 @@ export const getNumericFieldsStatsRequest = ( const aggs: Aggs = {}; fields.forEach((field, i) => { - const { safeFieldName } = field; + const { safeFieldName, supportedAggs } = field; - aggs[`${safeFieldName}_field_stats`] = { - filter: { exists: { field: field.fieldName } }, - aggs: { - actual_stats: { - stats: { field: field.fieldName }, - }, - }, - }; - aggs[`${safeFieldName}_percentiles`] = { - percentiles: { - field: field.fieldName, - percents, - keyed: false, - }, - }; + const include = !isDefined(supportedAggs); - const top = { - terms: { - field: field.fieldName, - size: 10, - order: { - _count: 'desc', + if (include || supportedAggs.has('stats')) { + aggs[`${safeFieldName}_field_stats`] = { + filter: { exists: { field: field.fieldName } }, + aggs: { + actual_stats: { + stats: { field: field.fieldName }, + }, }, - } as AggregationsTermsAggregation, - }; - - aggs[`${safeFieldName}_top`] = top; + }; + } + + if (include || (supportedAggs.has('min') && supportedAggs.has('max'))) { + aggs[`${safeFieldName}_min_max`] = { + filter: { exists: { field: field.fieldName } }, + aggs: { + min: { + min: { field: field.fieldName }, + }, + max: { + max: { field: field.fieldName }, + }, + }, + }; + } + + if (include || supportedAggs.has('percentiles')) { + aggs[`${safeFieldName}_percentiles`] = { + percentiles: { + field: field.fieldName, + percents, + keyed: false, + }, + }; + } + + if (include || supportedAggs.has('terms')) { + const top = { + terms: { + field: field.fieldName, + size: 10, + order: { + _count: 'desc', + }, + } as AggregationsTermsAggregation, + }; + + aggs[`${safeFieldName}_top`] = top; + } }); const searchBody = { @@ -102,6 +125,29 @@ export const getNumericFieldsStatsRequest = ( }; }; +const processStats = (safeFieldName: string, aggregations: object, aggsPath: string[]) => { + const fieldStatsResp = get( + aggregations, + [...aggsPath, `${safeFieldName}_field_stats`, 'actual_stats'], + undefined + ); + if (fieldStatsResp) { + return { + min: get(fieldStatsResp, 'min'), + max: get(fieldStatsResp, 'max'), + avg: get(fieldStatsResp, 'avg'), + }; + } + const minMaxResp = get(aggregations, [...aggsPath, `${safeFieldName}_min_max`], {}); + if (minMaxResp) { + return { + min: get(minMaxResp, ['min', 'value']), + max: get(minMaxResp, ['max', 'value']), + }; + } + return {}; +}; + export const fetchNumericFieldsStats = ( dataSearch: ISearchStart, params: FieldStatsCommonRequestParams, @@ -135,11 +181,6 @@ export const fetchNumericFieldsStats = ( [...aggsPath, `${safeFieldName}_field_stats`, 'doc_count'], 0 ); - const fieldStatsResp = get( - aggregations, - [...aggsPath, `${safeFieldName}_field_stats`, 'actual_stats'], - {} - ); const topAggsPath = [...aggsPath, `${safeFieldName}_top`]; if (samplerShardSize < 1 && field.cardinality >= SAMPLER_TOP_TERMS_THRESHOLD) { @@ -151,9 +192,7 @@ export const fetchNumericFieldsStats = ( const stats: NumericFieldStats = { fieldName: field.fieldName, - min: get(fieldStatsResp, 'min', 0), - max: get(fieldStatsResp, 'max', 0), - avg: get(fieldStatsResp, 'avg', 0), + ...processStats(safeFieldName, aggregations, aggsPath), isTopValuesSampled: isNormalSamplingOption(params.samplingOption) || (isDefined(params.samplingProbability) && params.samplingProbability < 1), @@ -168,15 +207,21 @@ export const fetchNumericFieldsStats = ( [...aggsPath, `${safeFieldName}_percentiles`, 'values'], [] ); - const medianPercentile: { value: number; key: number } | undefined = find(percentiles, { - key: 50, - }); - stats.median = medianPercentile !== undefined ? medianPercentile!.value : 0; - stats.distribution = processDistributionData( - percentiles, - PERCENTILE_SPACING, - stats.min - ); + + if (percentiles && isDefined(stats.min)) { + const medianPercentile: { value: number; key: number } | undefined = find( + percentiles, + { + key: 50, + } + ); + stats.median = medianPercentile !== undefined ? medianPercentile!.value : 0; + stats.distribution = processDistributionData( + percentiles, + PERCENTILE_SPACING, + stats.min + ); + } } batchStats.push(stats); diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts index c6643410b148e..c5344c780f713 100644 --- a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/search_strategy/requests/overall_stats.ts @@ -7,20 +7,24 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { get } from 'lodash'; -import { Query } from '@kbn/es-query'; +import type { Query } from '@kbn/es-query'; import type { IKibanaSearchResponse } from '@kbn/data-plugin/common'; import type { AggCardinality } from '@kbn/ml-agg-utils'; import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import { buildBaseFilterCriteria, getSafeAggregationName } from '@kbn/ml-query-utils'; import { buildAggregationWithSamplingOption } from './build_random_sampler_agg'; import { getDatafeedAggregations } from '../../../../../common/utils/datafeed_utils'; -import { AggregatableField, NonAggregatableField } from '../../types/overall_stats'; -import { Aggs, SamplingOption } from '../../../../../common/types/field_stats'; +import type { AggregatableField, NonAggregatableField } from '../../types/overall_stats'; +import type { + Aggs, + OverallStatsSearchStrategyParams, + SamplingOption, +} from '../../../../../common/types/field_stats'; export const checkAggregatableFieldsExistRequest = ( dataViewTitle: string, query: Query['query'], - aggregatableFields: string[], + aggregatableFields: OverallStatsSearchStrategyParams['aggregatableFields'], samplingOption: SamplingOption, timeFieldName: string | undefined, earliestMs?: number, @@ -45,23 +49,28 @@ export const checkAggregatableFieldsExistRequest = ( : {}), }; - aggregatableFields.forEach((field, i) => { + aggregatableFields.forEach(({ name: field, supportedAggs }, i) => { const safeFieldName = getSafeAggregationName(field, i); - aggs[`${safeFieldName}_count`] = { - filter: { exists: { field } }, - }; - let cardinalityField: AggCardinality; - if (datafeedConfig?.script_fields?.hasOwnProperty(field)) { - cardinalityField = aggs[`${safeFieldName}_cardinality`] = { - cardinality: { script: datafeedConfig?.script_fields[field].script }, - }; - } else { - cardinalityField = { - cardinality: { field }, + if (supportedAggs.has('count')) { + aggs[`${safeFieldName}_count`] = { + filter: { exists: { field } }, }; } - aggs[`${safeFieldName}_cardinality`] = cardinalityField; + + if (supportedAggs.has('cardinality')) { + let cardinalityField: AggCardinality; + if (datafeedConfig?.script_fields?.hasOwnProperty(field)) { + cardinalityField = aggs[`${safeFieldName}_cardinality`] = { + cardinality: { script: datafeedConfig?.script_fields[field].script }, + }; + } else { + cardinalityField = { + cardinality: { field }, + }; + } + aggs[`${safeFieldName}_cardinality`] = cardinalityField; + } }); const searchBody = { @@ -88,7 +97,7 @@ export const checkAggregatableFieldsExistRequest = ( }; export interface AggregatableFieldOverallStats extends IKibanaSearchResponse { - aggregatableFields: string[]; + aggregatableFields: OverallStatsSearchStrategyParams['aggregatableFields']; } export type NonAggregatableFieldOverallStats = IKibanaSearchResponse; @@ -107,7 +116,7 @@ export function isNonAggregatableFieldOverallStats( export const processAggregatableFieldsExistResponse = ( responses: AggregatableFieldOverallStats[] | undefined, - aggregatableFields: string[], + aggregatableFields: OverallStatsSearchStrategyParams['aggregatableFields'], datafeedConfig?: estypes.MlDatafeed ) => { const stats = { @@ -122,7 +131,7 @@ export const processAggregatableFieldsExistResponse = ( const aggsPath = ['sample']; const sampleCount = aggregations.sample.doc_count; - aggregatableFieldsChunk.forEach((field, i) => { + aggregatableFieldsChunk.forEach(({ name: field, supportedAggs }, i) => { const safeFieldName = getSafeAggregationName(field, i); // Sampler agg will yield doc_count that's bigger than the actual # of sampled records // because it uses the stored _doc_count if available @@ -132,11 +141,11 @@ export const processAggregatableFieldsExistResponse = ( const multiplier = count > sampleCount ? get(aggregations, [...aggsPath, 'probability'], 1) : 1; if (count > 0) { - const cardinality = get( - aggregations, - [...aggsPath, `${safeFieldName}_cardinality`, 'value'], - 0 - ); + const cardinality = get(aggregations, [ + ...aggsPath, + `${safeFieldName}_cardinality`, + 'value', + ]); stats.aggregatableExistsFields.push({ fieldName: field, existsInDocs: true, @@ -151,11 +160,11 @@ export const processAggregatableFieldsExistResponse = ( datafeedConfig?.script_fields?.hasOwnProperty(field) || datafeedConfig?.runtime_mappings?.hasOwnProperty(field) ) { - const cardinality = get( - aggregations, - [...aggsPath, `${safeFieldName}_cardinality`, 'value'], - 0 - ); + const cardinality = get(aggregations, [ + ...aggsPath, + `${safeFieldName}_cardinality`, + 'value', + ]); stats.aggregatableExistsFields.push({ fieldName: field, existsInDocs: true, diff --git a/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/get_supported_aggs.ts b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/get_supported_aggs.ts new file mode 100644 index 0000000000000..26c71a7101c7f --- /dev/null +++ b/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/utils/get_supported_aggs.ts @@ -0,0 +1,76 @@ +/* + * 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 { DataViewField } from '@kbn/data-views-plugin/common'; +import { isCounterTimeSeriesMetric, isGaugeTimeSeriesMetric } from '@kbn/ml-agg-utils'; + +/** + * Partial list of supported ES aggs that are used by Index data visualizer/Field stats + */ +const SUPPORTED_AGGS = { + COUNTER: new Set([ + 'count', + 'histogram', + 'variable_width_histogram', + 'rate', + 'min', + 'max', + 'top_metrics', + 'range', + ]), + GAUGE: new Set([ + 'count', + 'max', + 'top_metrics', + 'missing', + 'date_histogram', + 'sum', + 'rate', + 'boxplot', + 'value_count', + 'avg', + 'percentiles', + 'cardinality', + 'histogram', + 'variable_width_histogram', + 'frequent_item_sets', + 'min', + 'stats', + 'diversified_sampler', + 'percentile_ranks', + 'median_absolute_deviation', + 'multi_terms', + 'auto_date_histogram', + 'rare_terms', + 'range', + 'extended_stats', + 'date_range', + 'terms', + 'significant_terms', + ]), + AGGREGATABLE: new Set([ + 'count', + 'avg', + 'cardinality', + 'histogram', + 'percentiles', + 'stats', + 'terms', + ]), + DEFAULT: new Set(), +}; + +/** + * Temporarily add list of supported ES aggs until the PR below is merged + * https://github.com/elastic/elasticsearch/pull/93884 + */ +export const getSupportedAggs = (field: DataViewField) => { + if (isCounterTimeSeriesMetric(field)) return SUPPORTED_AGGS.COUNTER; + if (isGaugeTimeSeriesMetric(field)) return SUPPORTED_AGGS.GAUGE; + if (field.aggregatable) return SUPPORTED_AGGS.AGGREGATABLE; + return SUPPORTED_AGGS.DEFAULT; +}; diff --git a/x-pack/plugins/data_visualizer/tsconfig.json b/x-pack/plugins/data_visualizer/tsconfig.json index 7472c3910f7fe..3e9956d828a27 100644 --- a/x-pack/plugins/data_visualizer/tsconfig.json +++ b/x-pack/plugins/data_visualizer/tsconfig.json @@ -57,6 +57,7 @@ "@kbn/ml-is-defined", "@kbn/ml-query-utils", "@kbn/saved-search-plugin", + "@kbn/unified-field-list-plugin", ], "exclude": [ "target/**/*", diff --git a/x-pack/plugins/enterprise_search/common/ml_inference_pipeline/index.test.ts b/x-pack/plugins/enterprise_search/common/ml_inference_pipeline/index.test.ts index 4e02a9850391d..0d9a668b2a6f0 100644 --- a/x-pack/plugins/enterprise_search/common/ml_inference_pipeline/index.test.ts +++ b/x-pack/plugins/enterprise_search/common/ml_inference_pipeline/index.test.ts @@ -97,7 +97,7 @@ describe('getRemoveProcessorForInferenceType lib function', () => { }); describe('getSetProcessorForInferenceType lib function', () => { - const destinationField = 'dest'; + const targetField = 'dest'; it('should return expected value for TEXT_CLASSIFICATION', () => { const inferenceType = SUPPORTED_PYTORCH_TASKS.TEXT_CLASSIFICATION; @@ -105,12 +105,12 @@ describe('getSetProcessorForInferenceType lib function', () => { copy_from: 'ml.inference.dest.predicted_value', description: "Copy the predicted_value to 'dest' if the prediction_probability is greater than 0.5", - field: destinationField, + field: targetField, if: "ctx?.ml?.inference != null && ctx.ml.inference['dest'] != null && ctx.ml.inference['dest'].prediction_probability > 0.5", value: undefined, }; - expect(getSetProcessorForInferenceType(destinationField, inferenceType)).toEqual(expected); + expect(getSetProcessorForInferenceType(targetField, inferenceType)).toEqual(expected); }); it('should return expected value for TEXT_EMBEDDING', () => { @@ -119,18 +119,18 @@ describe('getSetProcessorForInferenceType lib function', () => { const expected: IngestSetProcessor = { copy_from: 'ml.inference.dest.predicted_value', description: "Copy the predicted_value to 'dest'", - field: destinationField, + field: targetField, if: "ctx?.ml?.inference != null && ctx.ml.inference['dest'] != null", value: undefined, }; - expect(getSetProcessorForInferenceType(destinationField, inferenceType)).toEqual(expected); + expect(getSetProcessorForInferenceType(targetField, inferenceType)).toEqual(expected); }); it('should return undefined for unknown inferenceType', () => { const inferenceType = 'wrongInferenceType'; - expect(getSetProcessorForInferenceType(destinationField, inferenceType)).toBeUndefined(); + expect(getSetProcessorForInferenceType(targetField, inferenceType)).toBeUndefined(); }); }); @@ -140,7 +140,7 @@ describe('generateMlInferencePipelineBody lib function', () => { processors: [ { remove: { - field: 'ml.inference.my-destination-field', + field: 'ml.inference.my-target-field', ignore_missing: true, }, }, @@ -165,7 +165,7 @@ describe('generateMlInferencePipelineBody lib function', () => { }, }, ], - target_field: 'ml.inference.my-destination-field', + target_field: 'ml.inference.my-target-field', }, }, { @@ -188,26 +188,24 @@ describe('generateMlInferencePipelineBody lib function', () => { it('should return something expected', () => { const actual: MlInferencePipeline = generateMlInferencePipelineBody({ description: 'my-description', - destinationField: 'my-destination-field', model: mockModel, pipelineName: 'my-pipeline', - sourceField: 'my-source-field', + fieldMappings: [{ sourceField: 'my-source-field', targetField: 'my-target-field' }], }); expect(actual).toEqual(expected); }); - it('should return something expected 2', () => { + it('should return something expected with specific processors', () => { const mockTextClassificationModel: MlTrainedModelConfig = { ...mockModel, ...{ inference_config: { text_classification: {} } }, }; const actual: MlInferencePipeline = generateMlInferencePipelineBody({ description: 'my-description', - destinationField: 'my-destination-field', model: mockTextClassificationModel, pipelineName: 'my-pipeline', - sourceField: 'my-source-field', + fieldMappings: [{ sourceField: 'my-source-field', targetField: 'my-target-field' }], }); expect(actual).toEqual( @@ -216,17 +214,17 @@ describe('generateMlInferencePipelineBody lib function', () => { processors: expect.arrayContaining([ expect.objectContaining({ remove: { - field: 'my-destination-field', + field: 'my-target-field', ignore_missing: true, }, }), expect.objectContaining({ set: { - copy_from: 'ml.inference.my-destination-field.predicted_value', + copy_from: 'ml.inference.my-target-field.predicted_value', description: - "Copy the predicted_value to 'my-destination-field' if the prediction_probability is greater than 0.5", - field: 'my-destination-field', - if: "ctx?.ml?.inference != null && ctx.ml.inference['my-destination-field'] != null && ctx.ml.inference['my-destination-field'].prediction_probability > 0.5", + "Copy the predicted_value to 'my-target-field' if the prediction_probability is greater than 0.5", + field: 'my-target-field', + if: "ctx?.ml?.inference != null && ctx.ml.inference['my-target-field'] != null && ctx.ml.inference['my-target-field'].prediction_probability > 0.5", }, }), ]), diff --git a/x-pack/plugins/enterprise_search/common/ml_inference_pipeline/index.ts b/x-pack/plugins/enterprise_search/common/ml_inference_pipeline/index.ts index 84f4b2bdb9deb..1520d3ea1fd8f 100644 --- a/x-pack/plugins/enterprise_search/common/ml_inference_pipeline/index.ts +++ b/x-pack/plugins/enterprise_search/common/ml_inference_pipeline/index.ts @@ -31,11 +31,15 @@ export const TEXT_EXPANSION_FRIENDLY_TYPE = 'ELSER'; export interface MlInferencePipelineParams { description?: string; - destinationField: string; + fieldMappings: FieldMapping[]; inferenceConfig?: InferencePipelineInferenceConfig; model: MlTrainedModelConfig; pipelineName: string; +} + +export interface FieldMapping { sourceField: string; + targetField: string; } /** @@ -45,26 +49,28 @@ export interface MlInferencePipelineParams { */ export const generateMlInferencePipelineBody = ({ description, - destinationField, + fieldMappings, inferenceConfig, model, pipelineName, - sourceField, }: MlInferencePipelineParams): MlInferencePipeline => { // if model returned no input field, insert a placeholder const modelInputField = model.input?.field_names?.length > 0 ? model.input.field_names[0] : 'MODEL_INPUT_FIELD'; + // For now this only works for a single field mapping + const sourceField = fieldMappings[0].sourceField; + const targetField = fieldMappings[0].targetField; const inferenceType = Object.keys(model.inference_config)[0]; - const remove = getRemoveProcessorForInferenceType(destinationField, inferenceType); - const set = getSetProcessorForInferenceType(destinationField, inferenceType); + const remove = getRemoveProcessorForInferenceType(targetField, inferenceType); + const set = getSetProcessorForInferenceType(targetField, inferenceType); return { description: description ?? '', processors: [ { remove: { - field: `ml.inference.${destinationField}`, + field: getMlInferencePrefixedFieldName(targetField), ignore_missing: true, }, }, @@ -90,7 +96,7 @@ export const generateMlInferencePipelineBody = ({ }, }, ], - target_field: `ml.inference.${destinationField}`, + target_field: getMlInferencePrefixedFieldName(targetField), }, }, { @@ -113,26 +119,24 @@ export const generateMlInferencePipelineBody = ({ }; export const getSetProcessorForInferenceType = ( - destinationField: string, + targetField: string, inferenceType: string ): IngestSetProcessor | undefined => { let set: IngestSetProcessor | undefined; - const prefixedDestinationField = `ml.inference.${destinationField}`; - if (inferenceType === SUPPORTED_PYTORCH_TASKS.TEXT_CLASSIFICATION) { set = { - copy_from: `${prefixedDestinationField}.predicted_value`, - description: `Copy the predicted_value to '${destinationField}' if the prediction_probability is greater than 0.5`, - field: destinationField, - if: `ctx?.ml?.inference != null && ctx.ml.inference['${destinationField}'] != null && ctx.ml.inference['${destinationField}'].prediction_probability > 0.5`, + copy_from: `${getMlInferencePrefixedFieldName(targetField)}.predicted_value`, + description: `Copy the predicted_value to '${targetField}' if the prediction_probability is greater than 0.5`, + field: targetField, + if: `ctx?.ml?.inference != null && ctx.ml.inference['${targetField}'] != null && ctx.ml.inference['${targetField}'].prediction_probability > 0.5`, value: undefined, }; } else if (inferenceType === SUPPORTED_PYTORCH_TASKS.TEXT_EMBEDDING) { set = { - copy_from: `${prefixedDestinationField}.predicted_value`, - description: `Copy the predicted_value to '${destinationField}'`, - field: destinationField, - if: `ctx?.ml?.inference != null && ctx.ml.inference['${destinationField}'] != null`, + copy_from: `${getMlInferencePrefixedFieldName(targetField)}.predicted_value`, + description: `Copy the predicted_value to '${targetField}'`, + field: targetField, + if: `ctx?.ml?.inference != null && ctx.ml.inference['${targetField}'] != null`, value: undefined, }; } @@ -141,7 +145,7 @@ export const getSetProcessorForInferenceType = ( }; export const getRemoveProcessorForInferenceType = ( - destinationField: string, + targetField: string, inferenceType: string ): IngestRemoveProcessor | undefined => { if ( @@ -149,7 +153,7 @@ export const getRemoveProcessorForInferenceType = ( inferenceType === SUPPORTED_PYTORCH_TASKS.TEXT_EMBEDDING ) { return { - field: destinationField, + field: targetField, ignore_missing: true, }; } @@ -226,3 +230,5 @@ export const parseModelStateFromStats = ( export const parseModelStateReasonFromStats = (trainedModelStats?: Partial) => trainedModelStats?.deployment_stats?.reason; + +export const getMlInferencePrefixedFieldName = (fieldName: string) => `ml.inference.${fieldName}`; diff --git a/x-pack/plugins/enterprise_search/common/types/connectors.ts b/x-pack/plugins/enterprise_search/common/types/connectors.ts index be05831daa85a..69b9a81295d78 100644 --- a/x-pack/plugins/enterprise_search/common/types/connectors.ts +++ b/x-pack/plugins/enterprise_search/common/types/connectors.ts @@ -149,6 +149,7 @@ export interface Connector { language: string | null; last_seen: string | null; last_sync_error: string | null; + last_sync_scheduled_at: string | null; last_sync_status: SyncStatus | null; last_synced: string | null; name: string; @@ -173,9 +174,9 @@ export interface ConnectorSyncJob { filtering: FilteringRules | FilteringRules[] | null; id: string; index_name: string; - language: string; + language: string | null; pipeline: IngestPipelineParams | null; - service_type: string; + service_type: string | null; }; created_at: string; deleted_document_count: number; @@ -183,12 +184,12 @@ export interface ConnectorSyncJob { id: string; indexed_document_count: number; indexed_document_volume: number; - last_seen: string; + last_seen: string | null; metadata: Record; - started_at: string; + started_at: string | null; status: SyncStatus; trigger_method: TriggerMethod; - worker_hostname: string; + worker_hostname: string | null; } export type ConnectorSyncJobDocument = Omit; diff --git a/x-pack/plugins/enterprise_search/common/types/engines.ts b/x-pack/plugins/enterprise_search/common/types/engines.ts index 7a484094a46d7..d668e729a67ec 100644 --- a/x-pack/plugins/enterprise_search/common/types/engines.ts +++ b/x-pack/plugins/enterprise_search/common/types/engines.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { FieldCapsResponse, HealthStatus } from '@elastic/elasticsearch/lib/api/types'; +import { HealthStatus } from '@elastic/elasticsearch/lib/api/types'; export interface EnterpriseSearchEnginesResponse { count: number; @@ -32,7 +32,6 @@ export interface EnterpriseSearchEngineIndex { } export interface EnterpriseSearchEngineFieldCapabilities { - field_capabilities: FieldCapsResponse; fields: SchemaField[]; name: string; updated_at_millis: number; @@ -47,7 +46,10 @@ export interface SchemaFieldIndex { } export interface SchemaField { + aggregatable: boolean; indices: SchemaFieldIndex[]; + metadata_field?: boolean; name: string; + searchable: boolean; type: string; } diff --git a/x-pack/plugins/enterprise_search/public/applications/analytics/components/add_analytics_collections/add_analytics_collection.tsx b/x-pack/plugins/enterprise_search/public/applications/analytics/components/add_analytics_collections/add_analytics_collection.tsx index ddf4077a3167c..82d27cf4a177b 100644 --- a/x-pack/plugins/enterprise_search/public/applications/analytics/components/add_analytics_collections/add_analytics_collection.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/analytics/components/add_analytics_collections/add_analytics_collection.tsx @@ -14,9 +14,13 @@ import { i18n } from '@kbn/i18n'; import { AddAnalyticsCollectionModal } from './add_analytics_collection_modal'; interface AddAnalyticsCollectionProps { + disabled?: boolean; render?: (onClick: () => void) => React.ReactNode; } -export const AddAnalyticsCollection: React.FC = ({ render }) => { +export const AddAnalyticsCollection: React.FC = ({ + render, + disabled, +}) => { const [isModalVisible, setIsModalVisible] = useState(false); const closeModal = () => setIsModalVisible(false); const showModal = () => setIsModalVisible(true); @@ -26,7 +30,7 @@ export const AddAnalyticsCollection: React.FC = ({ {render ? ( render(showModal) ) : ( - + {i18n.translate('xpack.enterpriseSearch.analytics.collections.create.buttonTitle', { defaultMessage: 'Create collection', })} diff --git a/x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_overview/analytics_overview.test.tsx b/x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_overview/analytics_overview.test.tsx index 6992769b1d197..1255843d7189a 100644 --- a/x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_overview/analytics_overview.test.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_overview/analytics_overview.test.tsx @@ -15,9 +15,12 @@ import { shallow } from 'enzyme'; import { AnalyticsCollection } from '../../../../../common/types/analytics'; +import { LicensingCallout } from '../../../enterprise_search_content/components/shared/licensing_callout/licensing_callout'; + import { AnalyticsCollectionTable } from './analytics_collection_table'; import { AnalyticsOverview } from './analytics_overview'; +import { AnalyticsOverviewEmptyPage } from './analytics_overview_empty_page'; const mockValues = { analyticsCollections: [ @@ -27,6 +30,8 @@ const mockValues = { }, ] as AnalyticsCollection[], hasNoAnalyticsCollections: false, + hasPlatinumLicense: true, + isCloud: false, }; const mockActions = { @@ -49,8 +54,8 @@ describe('AnalyticsOverview', () => { const wrapper = shallow(); expect(mockActions.fetchAnalyticsCollections).toHaveBeenCalled(); - expect(wrapper.find(AnalyticsCollectionTable)).toHaveLength(0); + expect(wrapper.find(AnalyticsOverviewEmptyPage)).toHaveLength(1); }); it('renders with Data', async () => { @@ -60,7 +65,34 @@ describe('AnalyticsOverview', () => { const wrapper = shallow(); expect(wrapper.find(AnalyticsCollectionTable)).toHaveLength(1); + expect(wrapper.find(LicensingCallout)).toHaveLength(0); expect(mockActions.fetchAnalyticsCollections).toHaveBeenCalled(); }); + + it('renders Platinum license callout when not Cloud or Platinum', async () => { + setMockValues({ + ...mockValues, + hasPlatinumLicense: false, + isCloud: false, + }); + setMockActions(mockActions); + const wrapper = shallow(); + + expect(wrapper.find(AnalyticsCollectionTable)).toHaveLength(0); + expect(wrapper.find(AnalyticsOverviewEmptyPage)).toHaveLength(0); + expect(wrapper.find(LicensingCallout)).toHaveLength(1); + }); + + it('Does not render Platinum license callout when Cloud', async () => { + setMockValues({ + ...mockValues, + hasPlatinumLicense: false, + isCloud: true, + }); + setMockActions(mockActions); + const wrapper = shallow(); + + expect(wrapper.find(LicensingCallout)).toHaveLength(0); + }); }); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_overview/analytics_overview.tsx b/x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_overview/analytics_overview.tsx index c62388f96f6d5..562f587023b27 100644 --- a/x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_overview/analytics_overview.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/analytics/components/analytics_overview/analytics_overview.tsx @@ -9,10 +9,16 @@ import React, { useEffect } from 'react'; import { useActions, useValues } from 'kea'; -import { EuiSpacer } from '@elastic/eui'; +import { EuiFlexItem, EuiSpacer } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; +import { + LicensingCallout, + LICENSING_FEATURE, +} from '../../../enterprise_search_content/components/shared/licensing_callout/licensing_callout'; +import { KibanaLogic } from '../../../shared/kibana'; +import { LicensingLogic } from '../../../shared/licensing'; import { AddAnalyticsCollection } from '../add_analytics_collections/add_analytics_collection'; import { EnterpriseSearchAnalyticsPageTemplate } from '../layout/page_template'; @@ -26,7 +32,13 @@ export const AnalyticsOverview: React.FC = () => { const { analyticsCollections, isLoading, hasNoAnalyticsCollections } = useValues(AnalyticsCollectionsLogic); + const { isCloud } = useValues(KibanaLogic); + const { hasPlatinumLicense } = useValues(LicensingLogic); + + const isGated = !isCloud && !hasPlatinumLicense; + useEffect(() => { + if (isGated) return; fetchAnalyticsCollections(); }, []); @@ -34,7 +46,7 @@ export const AnalyticsOverview: React.FC = () => { { pageTitle: i18n.translate('xpack.enterpriseSearch.analytics.collections.pageTitle', { defaultMessage: 'Behavioral Analytics', }), - rightSideItems: [], + rightSideItems: [], }} > - {hasNoAnalyticsCollections ? ( + {isGated ? ( + + + + ) : hasNoAnalyticsCollections ? ( <> diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/search_indices.mock.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/search_indices.mock.ts index 955cf219a8019..4db81ef3bbf0e 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/search_indices.mock.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/search_indices.mock.ts @@ -102,6 +102,7 @@ export const indices: ElasticsearchIndexWithIngestion[] = [ language: 'en', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: SyncStatus.COMPLETED, last_synced: null, name: 'connector', @@ -197,6 +198,7 @@ export const indices: ElasticsearchIndexWithIngestion[] = [ language: 'en', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: SyncStatus.COMPLETED, last_synced: null, name: 'crawler', diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/view_index.mock.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/view_index.mock.ts index 78ef10664abcb..8414a655a1106 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/view_index.mock.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/__mocks__/view_index.mock.ts @@ -112,6 +112,7 @@ export const connectorIndex: ConnectorViewIndex = { language: 'en', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: SyncStatus.COMPLETED, last_synced: null, name: 'connector', @@ -211,6 +212,7 @@ export const crawlerIndex: CrawlerViewIndex = { language: 'en', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: SyncStatus.COMPLETED, last_synced: null, name: 'crawler', diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_overview_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_overview_logic.test.ts index a3ad08c77584e..ebd7e90f7e188 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_overview_logic.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_overview_logic.test.ts @@ -282,35 +282,6 @@ describe('EngineOverviewLogic', () => { it('counts the fields from the field capabilities', () => { const fieldCapabilities = { created: '2023-02-07T19:16:43Z', - field_capabilities: { - fields: { - age: { - integer: { - aggregatable: true, - metadata_field: false, - searchable: true, - type: 'integer', - }, - }, - color: { - keyword: { - aggregatable: true, - metadata_field: false, - searchable: true, - type: 'keyword', - }, - }, - name: { - text: { - aggregatable: false, - metadata_field: false, - searchable: true, - type: 'text', - }, - }, - }, - indices: ['index-001', 'index-002'], - }, fields: [ { indices: [ @@ -364,77 +335,9 @@ describe('EngineOverviewLogic', () => { it('excludes metadata fields from the count', () => { const fieldCapabilities = { created: '2023-02-07T19:16:43Z', - field_capabilities: { - fields: { - _doc_count: { - integer: { - aggregatable: false, - metadata_field: true, - searchable: false, - type: 'integer', - }, - }, - _id: { - _id: { - aggregatable: false, - metadata_field: true, - searchable: true, - type: '_id', - }, - }, - _index: { - _index: { - aggregatable: true, - metadata_field: true, - searchable: true, - type: '_index', - }, - }, - _source: { - _source: { - aggregatable: false, - metadata_field: true, - searchable: false, - type: '_source', - }, - }, - _version: { - _version: { - aggregatable: true, - metadata_field: true, - searchable: false, - type: '_version', - }, - }, - age: { - integer: { - aggregatable: true, - metadata_field: false, - searchable: true, - type: 'integer', - }, - }, - color: { - keyword: { - aggregatable: true, - metadata_field: false, - searchable: true, - type: 'keyword', - }, - }, - name: { - text: { - aggregatable: false, - metadata_field: false, - searchable: true, - type: 'text', - }, - }, - }, - indices: ['index-001', 'index-002'], - }, fields: [ { + aggregatable: true, indices: [ { name: 'index-001', @@ -445,10 +348,13 @@ describe('EngineOverviewLogic', () => { type: 'integer', }, ], + metadata_field: true, name: '_doc_count', + searchable: true, type: 'integer', }, { + aggregatable: true, indices: [ { name: 'index-001', @@ -459,10 +365,13 @@ describe('EngineOverviewLogic', () => { type: '_id', }, ], + metadata_field: true, name: '_id', + searchable: true, type: '_id', }, { + aggregatable: true, indices: [ { name: 'index-001', @@ -473,10 +382,13 @@ describe('EngineOverviewLogic', () => { type: '_index', }, ], + metadata_field: true, name: '_index', + searchable: true, type: '_index', }, { + aggregatable: true, indices: [ { name: 'index-001', @@ -487,10 +399,13 @@ describe('EngineOverviewLogic', () => { type: '_source', }, ], + metadata_field: true, name: '_source', + searchable: true, type: '_source', }, { + aggregatable: true, indices: [ { name: 'index-001', @@ -501,10 +416,13 @@ describe('EngineOverviewLogic', () => { type: '_version', }, ], + metadata_field: true, name: '_version', + searchable: true, type: '_version', }, { + aggregatable: true, indices: [ { name: 'index-001', @@ -515,10 +433,13 @@ describe('EngineOverviewLogic', () => { type: 'integer', }, ], + metadata_field: false, name: 'age', + searchable: true, type: 'integer', }, { + aggregatable: true, indices: [ { name: 'index-001', @@ -529,10 +450,13 @@ describe('EngineOverviewLogic', () => { type: 'keyword', }, ], + metadata_field: false, name: 'color', + searchable: true, type: 'keyword', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -543,7 +467,9 @@ describe('EngineOverviewLogic', () => { type: 'text', }, ], + metadata_field: false, name: 'name', + searchable: true, type: 'text', }, ] as SchemaField[], diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_overview_logic.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_overview_logic.ts index c34089aab7518..7c6051194919a 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_overview_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_overview_logic.ts @@ -46,9 +46,7 @@ export const selectDocumentsCount = (indices: EngineOverviewValues['indices']) = export const selectFieldsCount = ( engineFieldCapabilitiesData: EngineOverviewValues['engineFieldCapabilitiesData'] ) => - Object.values(engineFieldCapabilitiesData?.field_capabilities?.fields ?? {}).filter( - (value) => !Object.values(value).some((field) => !!field.metadata_field) - ).length; + engineFieldCapabilitiesData?.fields?.filter(({ metadata_field: isMeta }) => !isMeta).length ?? 0; export const EngineOverviewLogic = kea>({ actions: {}, diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_search_preview/engine_search_preview_logic.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_search_preview/engine_search_preview_logic.ts index f202a24232b94..ec0291f61ff03 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_search_preview/engine_search_preview_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/engine/engine_search_preview/engine_search_preview_logic.ts @@ -77,17 +77,11 @@ export const EngineSearchPreviewLogic = kea< (data: EngineSearchPreviewValues['engineFieldCapabilitiesData']) => { if (!data) return {}; - const resultFields = Object.fromEntries( - Object.entries(data.field_capabilities.fields) - .filter(([, mappings]) => { - return Object.values(mappings).some(({ metadata_field: isMeta }) => !isMeta); - }) - .map(([key]) => { - return [key, { raw: {}, snippet: { fallback: true } }]; - }) + return Object.fromEntries( + data.fields + .filter(({ metadata_field: isMeta }) => !isMeta) + .map(({ name }) => [name, { raw: {}, snippet: { fallback: true } }]) ); - - return resultFields; }, ], searchableFields: [ @@ -96,14 +90,12 @@ export const EngineSearchPreviewLogic = kea< if (!data) return {}; const searchableFields = Object.fromEntries( - Object.entries(data.field_capabilities.fields) - .filter(([, mappings]) => - Object.entries(mappings).some( - ([type, { metadata_field: isMeta, searchable: isSearchable }]) => - type === 'text' && !isMeta && isSearchable - ) + data.fields + .filter( + ({ type, metadata_field: isMeta, searchable: isSearchable }) => + type === 'text' && !isMeta && isSearchable ) - .map(([key]) => [key, { weight: 1 }]) + .map(({ name }) => [name, { weight: 1 }]) ); return searchableFields; @@ -114,15 +106,9 @@ export const EngineSearchPreviewLogic = kea< (data: EngineSearchPreviewValues['engineFieldCapabilitiesData']) => { if (!data) return []; - return Object.entries(data.field_capabilities.fields) - .filter(([, mappings]) => - Object.entries(mappings).some( - ([, { metadata_field: isMeta, aggregatable }]) => - // Aggregatable are also _sortable_ - aggregatable && !isMeta - ) - ) - .map(([field]) => field) + return data.fields + .filter(({ metadata_field: isMeta, aggregatable }) => aggregatable && !isMeta) + .map(({ name }) => name) .sort(); }, ], diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/pipelines/ml_inference/ml_inference_logic.ts b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/pipelines/ml_inference/ml_inference_logic.ts index b61fa2a52ddf7..ed0e898618955 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/pipelines/ml_inference/ml_inference_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/pipelines/ml_inference/ml_inference_logic.ts @@ -386,11 +386,15 @@ export const MLInferenceLogic = kea< if (!model) return undefined; return generateMlInferencePipelineBody({ - destinationField: - configuration.destinationField || formatPipelineName(configuration.pipelineName), model, pipelineName: configuration.pipelineName, - sourceField: configuration.sourceField, + fieldMappings: [ + { + sourceField: configuration.sourceField, + targetField: + configuration.destinationField || formatPipelineName(configuration.pipelineName), + }, + ], inferenceConfig: configuration.inferenceConfig, }); }, diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/sync_jobs/sync_job_flyout.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/sync_jobs/sync_job_flyout.tsx index 95fbefa8c773b..b3257fa6455e8 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/sync_jobs/sync_job_flyout.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_index/sync_jobs/sync_job_flyout.tsx @@ -85,9 +85,9 @@ export const SyncJobFlyout: React.FC = ({ onClose, syncJob } canceledAt={syncJob.canceled_at ?? ''} cancelationRequestedAt={syncJob.cancelation_requested_at ?? ''} syncRequestedAt={syncJob.created_at} - syncStarted={syncJob.started_at} + syncStarted={syncJob.started_at ?? ''} completed={syncJob.completed_at ?? ''} - lastUpdated={syncJob.last_seen} + lastUpdated={syncJob.last_seen ?? ''} triggerMethod={syncJob.trigger_method} /> diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_indices/indices_table.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_indices/indices_table.tsx index c73f567f31edb..a6f953a2c6f5d 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_indices/indices_table.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_indices/indices_table.tsx @@ -16,8 +16,11 @@ import { EuiIcon, EuiText, } from '@elastic/eui'; + import { i18n } from '@kbn/i18n'; +import { NATIVE_CONNECTOR_DEFINITIONS } from '../../../../../common/connectors/native_connectors'; + import { Meta } from '../../../../../common/types'; import { healthColorsMap } from '../../../shared/constants/health_colors'; import { generateEncodedPath } from '../../../shared/encode_path_params'; @@ -26,8 +29,8 @@ import { EuiLinkTo } from '../../../shared/react_router_helpers'; import { EuiBadgeTo } from '../../../shared/react_router_helpers/eui_components'; import { convertMetaToPagination } from '../../../shared/table_pagination'; import { SEARCH_INDEX_PATH } from '../../routes'; -import { ElasticsearchViewIndex, IngestionMethod } from '../../types'; -import { ingestionMethodToText } from '../../utils/indices'; +import { ElasticsearchViewIndex } from '../../types'; +import { ingestionMethodToText, isConnectorIndex } from '../../utils/indices'; import { ingestionStatusToColor, ingestionStatusToText, @@ -64,8 +67,7 @@ export const IndicesTable: React.FC = ({ ), sortable: true, - truncateText: true, - width: '40%', + width: '33%', }, { field: 'health', @@ -80,7 +82,6 @@ export const IndicesTable: React.FC = ({ ), sortable: true, truncateText: true, - width: '10%', }, { field: 'count', @@ -89,21 +90,43 @@ export const IndicesTable: React.FC = ({ }), sortable: true, truncateText: true, - width: '10%', }, { - field: 'ingestionMethod', + name: i18n.translate( + 'xpack.enterpriseSearch.content.searchIndices.ingestionName.columnTitle', + { + defaultMessage: 'Ingestion name', + } + ), + render: (index: ElasticsearchViewIndex) => ( + + {(isConnectorIndex(index) && + index.connector.service_type && + NATIVE_CONNECTOR_DEFINITIONS[index.connector.service_type]?.name) ?? + '--'} + + ), + truncateText: true, + }, + { name: i18n.translate( 'xpack.enterpriseSearch.content.searchIndices.ingestionMethod.columnTitle', { defaultMessage: 'Ingestion method', } ), - render: (ingestionMethod: IngestionMethod) => ( - {ingestionMethodToText(ingestionMethod)} + render: (index: ElasticsearchViewIndex) => ( + + {isConnectorIndex(index) && index.connector.is_native + ? i18n.translate( + 'xpack.enterpriseSearch.content.searchIndices.ingestionmethod.nativeConnector', + { + defaultMessage: 'Native connector', + } + ) + : ingestionMethodToText(index.ingestionMethod)} + ), - truncateText: true, - width: '10%', }, { name: i18n.translate( @@ -124,7 +147,6 @@ export const IndicesTable: React.FC = ({ ); }, truncateText: true, - width: '15%', }, { actions: [ @@ -182,7 +204,6 @@ export const IndicesTable: React.FC = ({ name: i18n.translate('xpack.enterpriseSearch.content.searchIndices.actions.columnTitle', { defaultMessage: 'Actions', }), - width: '10%', }, ]; return ( diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_indices/search_indices.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_indices/search_indices.tsx index 7d328dec9887f..15d58360ff92f 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_indices/search_indices.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/search_indices/search_indices.tsx @@ -99,7 +99,7 @@ export const SearchIndices: React.FC = () => { {i18n.translate( 'xpack.enterpriseSearch.content.searchIndices.create.buttonTitle', { - defaultMessage: 'Create new index', + defaultMessage: 'Create a new index', } )} diff --git a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/shared/licensing_callout/licensing_callout.tsx b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/shared/licensing_callout/licensing_callout.tsx index 1bb423eb7efed..7ab3eebeae270 100644 --- a/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/shared/licensing_callout/licensing_callout.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/shared/licensing_callout/licensing_callout.tsx @@ -18,6 +18,7 @@ export enum LICENSING_FEATURE { INFERENCE = 'inference', PIPELINES = 'pipelines', SEARCH_APPLICATIONS = 'searchApplications', + ANALYTICS = 'analytics', } type ContentBlock = Record; @@ -59,6 +60,13 @@ export const LicensingCallout: React.FC<{ feature: LICENSING_FEATURE }> = ({ fea 'Search Applications require a Platinum license or higher and are not available to Standard license self-managed deployments. You need to upgrade to use this feature.', } ), + [LICENSING_FEATURE.ANALYTICS]: i18n.translate( + 'xpack.enterpriseSearch.content.licensingCallout.analytics.contentOne', + { + defaultMessage: + 'Behavioral Analytics require a Platinum license or higher and are not available to Standard license self-managed deployments. You need to upgrade to use this feature.', + } + ), }; const secondContentBlock: ContentBlock = { @@ -97,6 +105,13 @@ export const LicensingCallout: React.FC<{ feature: LICENSING_FEATURE }> = ({ fea "Did you know that Search Applications are available with a Standard Elastic Cloud license? Elastic Cloud gives you the flexibility to run where you want. Deploy our managed service on Google Cloud, Microsoft Azure, or Amazon Web Services and we'll handle the maintenance and upkeep for you.", } ), + [LICENSING_FEATURE.ANALYTICS]: i18n.translate( + 'xpack.enterpriseSearch.content.licensingCallout.analytics.contentTwo', + { + defaultMessage: + "Did you know that Behavioral Analytics are available with a Standard Elastic Cloud license? Elastic Cloud gives you the flexibility to run where you want. Deploy our managed service on Google Cloud, Microsoft Azure, or Amazon Web Services and we'll handle the maintenance and upkeep for you.", + } + ), }; return ( diff --git a/x-pack/plugins/enterprise_search/server/lib/connectors/add_connector.test.ts b/x-pack/plugins/enterprise_search/server/lib/connectors/add_connector.test.ts index d51db7398d146..0ba209c814f73 100644 --- a/x-pack/plugins/enterprise_search/server/lib/connectors/add_connector.test.ts +++ b/x-pack/plugins/enterprise_search/server/lib/connectors/add_connector.test.ts @@ -146,6 +146,7 @@ describe('addConnector lib function', () => { language: 'fr', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, name: 'index_name', @@ -328,6 +329,7 @@ describe('addConnector lib function', () => { language: null, last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, name: 'index_name', @@ -435,6 +437,7 @@ describe('addConnector lib function', () => { language: 'en', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, name: 'index_name', diff --git a/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.test.ts b/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.test.ts index 25956b271245a..f9dedfe069170 100644 --- a/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.test.ts +++ b/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.test.ts @@ -7,19 +7,19 @@ import { IScopedClusterClient } from '@kbn/core/server'; -import { CONNECTORS_INDEX } from '../..'; +import { CONNECTORS_INDEX, CONNECTORS_JOBS_INDEX } from '../..'; +import { SyncStatus, TriggerMethod } from '../../../common/types/connectors'; + import { ErrorCode } from '../../../common/types/error_codes'; import { startConnectorSync } from './start_sync'; -describe('addConnector lib function', () => { +describe('startSync lib function', () => { const mockClient = { asCurrentUser: { get: jest.fn(), index: jest.fn(), - indices: { - refresh: jest.fn(), - }, + update: jest.fn(), }, asInternalUser: {}, }; @@ -31,6 +31,7 @@ describe('addConnector lib function', () => { it('should start a sync', async () => { mockClient.asCurrentUser.get.mockImplementationOnce(() => { return Promise.resolve({ + _id: 'connectorId', _source: { api_key_id: null, configuration: {}, @@ -38,8 +39,10 @@ describe('addConnector lib function', () => { custom_scheduling: {}, error: null, index_name: 'index_name', + language: null, last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, scheduling: { enabled: true, interval: '1 2 3 4 5' }, @@ -57,26 +60,93 @@ describe('addConnector lib function', () => { ).resolves.toEqual({ _id: 'fakeId' }); expect(mockClient.asCurrentUser.index).toHaveBeenCalledWith({ document: { - api_key_id: null, - configuration: {}, - created_at: null, - custom_scheduling: {}, + cancelation_requested_at: null, + canceled_at: null, + completed_at: null, + connector: { + configuration: {}, + filtering: null, + id: 'connectorId', + index_name: 'index_name', + language: null, + pipeline: null, + service_type: null, + }, + created_at: expect.any(String), + deleted_document_count: 0, error: null, - index_name: 'index_name', + indexed_document_count: 0, + indexed_document_volume: 0, last_seen: null, - last_sync_error: null, - last_sync_status: null, - last_synced: null, - scheduling: { enabled: true, interval: '1 2 3 4 5' }, - service_type: null, - status: 'not connected', - sync_now: true, + metadata: {}, + started_at: null, + status: SyncStatus.PENDING, + trigger_method: TriggerMethod.ON_DEMAND, + worker_hostname: null, }, - id: 'connectorId', - index: CONNECTORS_INDEX, + index: CONNECTORS_JOBS_INDEX, }); - expect(mockClient.asCurrentUser.indices.refresh).toHaveBeenCalledWith({ - index: CONNECTORS_INDEX, + }); + it('should start a sync with service type, pipeline and nextSyncConfig', async () => { + mockClient.asCurrentUser.get.mockImplementationOnce(() => { + return Promise.resolve({ + _source: { + api_key_id: null, + configuration: { config: { label: 'label', value: 'haha' } }, + created_at: null, + custom_scheduling: {}, + error: null, + filtering: [{ active: 'filtering' }], + index_name: 'index_name', + language: 'nl', + last_seen: null, + last_sync_error: null, + last_sync_status: null, + last_synced: null, + pipeline: { name: 'pipeline' }, + scheduling: { enabled: true, interval: '1 2 3 4 5' }, + service_type: 'service_type', + status: 'not connected', + sync_now: false, + }, + index: CONNECTORS_INDEX, + }); + }); + mockClient.asCurrentUser.index.mockImplementation(() => ({ _id: 'fakeId' })); + + await expect( + startConnectorSync(mockClient as unknown as IScopedClusterClient, 'connectorId', 'syncConfig') + ).resolves.toEqual({ _id: 'fakeId' }); + expect(mockClient.asCurrentUser.index).toHaveBeenCalledWith({ + document: { + cancelation_requested_at: null, + canceled_at: null, + completed_at: null, + connector: { + configuration: { + config: { label: 'label', value: 'haha' }, + nextSyncConfig: { label: 'nextSyncConfig', value: 'syncConfig' }, + }, + filtering: 'filtering', + id: 'connectorId', + index_name: 'index_name', + language: 'nl', + pipeline: { name: 'pipeline' }, + service_type: 'service_type', + }, + created_at: expect.any(String), + deleted_document_count: 0, + error: null, + indexed_document_count: 0, + indexed_document_volume: 0, + last_seen: null, + metadata: {}, + started_at: null, + status: SyncStatus.PENDING, + trigger_method: TriggerMethod.ON_DEMAND, + worker_hostname: null, + }, + index: CONNECTORS_JOBS_INDEX, }); }); @@ -89,4 +159,52 @@ describe('addConnector lib function', () => { ).rejects.toEqual(new Error(ErrorCode.RESOURCE_NOT_FOUND)); expect(mockClient.asCurrentUser.index).not.toHaveBeenCalled(); }); + + it('should set sync_now for crawler and not index a sync job', async () => { + mockClient.asCurrentUser.get.mockImplementationOnce(() => { + return Promise.resolve({ + _primary_term: 1, + _seq_no: 10, + _source: { + api_key_id: null, + configuration: { config: { label: 'label', value: 'haha' } }, + created_at: null, + custom_scheduling: {}, + error: null, + filtering: [{ active: 'filtering' }], + index_name: 'index_name', + language: 'nl', + last_seen: null, + last_sync_error: null, + last_sync_status: null, + last_synced: null, + pipeline: { name: 'pipeline' }, + scheduling: { enabled: true, interval: '1 2 3 4 5' }, + service_type: 'elastic-crawler', + status: 'not connected', + sync_now: false, + }, + index: CONNECTORS_INDEX, + }); + }); + mockClient.asCurrentUser.update.mockImplementation(() => ({ _id: 'fakeId' })); + + await expect( + startConnectorSync(mockClient as unknown as IScopedClusterClient, 'connectorId', 'syncConfig') + ).resolves.toEqual({ _id: 'fakeId' }); + expect(mockClient.asCurrentUser.index).not.toHaveBeenCalled(); + expect(mockClient.asCurrentUser.update).toHaveBeenCalledWith({ + doc: { + configuration: { + config: { label: 'label', value: 'haha' }, + nextSyncConfig: { label: 'nextSyncConfig', value: 'syncConfig' }, + }, + sync_now: true, + }, + id: 'connectorId', + if_primary_term: 1, + if_seq_no: 10, + index: CONNECTORS_INDEX, + }); + }); }); diff --git a/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.ts b/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.ts index 68b9adf0aee79..ca1d3b19a2c3a 100644 --- a/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.ts +++ b/x-pack/plugins/enterprise_search/server/lib/connectors/start_sync.ts @@ -7,9 +7,16 @@ import { IScopedClusterClient } from '@kbn/core/server'; -import { CONNECTORS_INDEX } from '../..'; +import { CONNECTORS_INDEX, CONNECTORS_JOBS_INDEX } from '../..'; +import { ENTERPRISE_SEARCH_CONNECTOR_CRAWLER_SERVICE_TYPE } from '../../../common/constants'; -import { ConnectorDocument } from '../../../common/types/connectors'; +import { + ConnectorConfiguration, + ConnectorDocument, + ConnectorSyncJobDocument, + SyncStatus, + TriggerMethod, +} from '../../../common/types/connectors'; import { ErrorCode } from '../../../common/types/error_codes'; export const startConnectorSync = async ( @@ -23,21 +30,57 @@ export const startConnectorSync = async ( }); const connector = connectorResult._source; if (connector) { - if (nextSyncConfig) { - connector.configuration.nextSyncConfig = { label: 'nextSyncConfig', value: nextSyncConfig }; + const configuration: ConnectorConfiguration = nextSyncConfig + ? { + ...connector.configuration, + nextSyncConfig: { label: 'nextSyncConfig', value: nextSyncConfig }, + } + : connector.configuration; + const { filtering, index_name, language, pipeline, service_type } = connector; + + const now = new Date().toISOString(); + + if (connector.service_type === ENTERPRISE_SEARCH_CONNECTOR_CRAWLER_SERVICE_TYPE) { + return await client.asCurrentUser.update({ + doc: { + configuration, + sync_now: true, + }, + id: connectorId, + if_primary_term: connectorResult._primary_term, + if_seq_no: connectorResult._seq_no, + index: CONNECTORS_INDEX, + }); } - const result = await client.asCurrentUser.index({ + return await client.asCurrentUser.index({ document: { - ...connector, - sync_now: true, + cancelation_requested_at: null, + canceled_at: null, + completed_at: null, + connector: { + configuration, + filtering: filtering ? filtering[0]?.active ?? null : null, + id: connectorId, + index_name, + language, + pipeline: pipeline ?? null, + service_type, + }, + created_at: now, + deleted_document_count: 0, + error: null, + indexed_document_count: 0, + indexed_document_volume: 0, + last_seen: null, + metadata: {}, + started_at: null, + status: SyncStatus.PENDING, + trigger_method: TriggerMethod.ON_DEMAND, + worker_hostname: null, }, - id: connectorId, - index: CONNECTORS_INDEX, + index: CONNECTORS_JOBS_INDEX, }); - - await client.asCurrentUser.indices.refresh({ index: CONNECTORS_INDEX }); - return result; } else { throw new Error(ErrorCode.RESOURCE_NOT_FOUND); } diff --git a/x-pack/plugins/enterprise_search/server/lib/connectors/update_connector_scheduling.test.ts b/x-pack/plugins/enterprise_search/server/lib/connectors/update_connector_scheduling.test.ts index 2fa4c0954b245..9a66a71b26e9a 100644 --- a/x-pack/plugins/enterprise_search/server/lib/connectors/update_connector_scheduling.test.ts +++ b/x-pack/plugins/enterprise_search/server/lib/connectors/update_connector_scheduling.test.ts @@ -39,6 +39,7 @@ describe('addConnector lib function', () => { index_name: 'index_name', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, scheduling: { enabled: false, interval: '* * * * *' }, @@ -67,6 +68,7 @@ describe('addConnector lib function', () => { index_name: 'index_name', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, scheduling: { enabled: true, interval: '1 2 3 4 5' }, diff --git a/x-pack/plugins/enterprise_search/server/lib/crawler/post_connector.test.ts b/x-pack/plugins/enterprise_search/server/lib/crawler/post_connector.test.ts index 729b72e8f643d..95fa56e8ff6ba 100644 --- a/x-pack/plugins/enterprise_search/server/lib/crawler/post_connector.test.ts +++ b/x-pack/plugins/enterprise_search/server/lib/crawler/post_connector.test.ts @@ -92,6 +92,7 @@ describe('recreateConnectorDocument lib function', () => { language: '', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, name: 'indexName', diff --git a/x-pack/plugins/enterprise_search/server/lib/engines/field_capabilities.test.ts b/x-pack/plugins/enterprise_search/server/lib/engines/field_capabilities.test.ts index e0c82b00ecf68..d01c5bd9f0d79 100644 --- a/x-pack/plugins/enterprise_search/server/lib/engines/field_capabilities.test.ts +++ b/x-pack/plugins/enterprise_search/server/lib/engines/field_capabilities.test.ts @@ -48,16 +48,18 @@ describe('engines field_capabilities', () => { await expect( fetchEngineFieldCapabilities(mockClient as unknown as IScopedClusterClient, mockEngine) ).resolves.toEqual({ - field_capabilities: fieldCapsResponse, fields: [ { + aggregatable: false, indices: [ { name: 'index-001', type: 'text', }, ], + metadata_field: false, name: 'body', + searchable: true, type: 'text', }, ], @@ -99,23 +101,29 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', type: 'text', }, ], + metadata_field: false, name: 'body', + searchable: true, type: 'text', }, { + aggregatable: false, indices: [ { name: 'index-001', type: 'number', }, ], + metadata_field: false, name: 'views', + searchable: false, type: 'number', }, ]; @@ -145,23 +153,29 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', type: 'text', }, ], + metadata_field: false, name: 'body', + searchable: true, type: 'text', }, { + aggregatable: true, indices: [ { name: 'index-001', type: 'keyword', }, ], + metadata_field: false, name: 'body.keyword', + searchable: true, type: 'keyword', }, ]; @@ -199,33 +213,42 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', type: 'object', }, ], + metadata_field: false, name: 'name', + searchable: false, type: 'object', }, { + aggregatable: false, indices: [ { name: 'index-001', type: 'text', }, ], + metadata_field: false, name: 'name.first', + searchable: true, type: 'text', }, { + aggregatable: false, indices: [ { name: 'index-001', type: 'text', }, ], + metadata_field: false, name: 'name.last', + searchable: true, type: 'text', }, ]; @@ -263,33 +286,42 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', type: 'nested', }, ], + metadata_field: false, name: 'name', + searchable: false, type: 'nested', }, { + aggregatable: false, indices: [ { name: 'index-001', type: 'text', }, ], + metadata_field: false, name: 'name.first', + searchable: true, type: 'text', }, { + aggregatable: false, indices: [ { name: 'index-001', type: 'text', }, ], + metadata_field: false, name: 'name.last', + searchable: true, type: 'text', }, ]; @@ -319,6 +351,7 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', @@ -329,7 +362,9 @@ describe('engines field_capabilities', () => { type: 'unmapped', }, ], + metadata_field: false, name: 'body', + searchable: true, type: 'text', }, ]; @@ -391,6 +426,7 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', @@ -401,10 +437,13 @@ describe('engines field_capabilities', () => { type: 'object', }, ], + metadata_field: false, name: 'name', + searchable: true, type: 'conflict', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -415,10 +454,13 @@ describe('engines field_capabilities', () => { type: 'text', }, ], + metadata_field: false, name: 'name.first', + searchable: true, type: 'text', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -429,7 +471,9 @@ describe('engines field_capabilities', () => { type: 'text', }, ], + metadata_field: false, name: 'name.last', + searchable: true, type: 'text', }, ]; @@ -499,6 +543,7 @@ describe('engines field_capabilities', () => { const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', @@ -513,10 +558,13 @@ describe('engines field_capabilities', () => { type: 'keyword', }, ], + metadata_field: false, name: 'name', + searchable: true, type: 'conflict', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -531,10 +579,13 @@ describe('engines field_capabilities', () => { type: 'text', }, ], + metadata_field: false, name: 'name.first', + searchable: true, type: 'text', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -549,7 +600,9 @@ describe('engines field_capabilities', () => { type: 'unmapped', }, ], + metadata_field: false, name: 'name.last', + searchable: true, type: 'text', }, ]; @@ -634,6 +687,7 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', @@ -648,10 +702,13 @@ describe('engines field_capabilities', () => { type: 'text', }, ], + metadata_field: false, name: 'body', + searchable: true, type: 'text', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -666,10 +723,13 @@ describe('engines field_capabilities', () => { type: 'unmapped', }, ], + metadata_field: false, name: 'name', + searchable: true, type: 'conflict', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -684,10 +744,13 @@ describe('engines field_capabilities', () => { type: 'unmapped', }, ], + metadata_field: false, name: 'name.first', + searchable: true, type: 'text', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -702,7 +765,9 @@ describe('engines field_capabilities', () => { type: 'unmapped', }, ], + metadata_field: false, name: 'name.last', + searchable: true, type: 'text', }, ]; @@ -748,6 +813,7 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', @@ -758,10 +824,13 @@ describe('engines field_capabilities', () => { type: 'object', }, ], + metadata_field: false, name: 'name', + searchable: false, type: 'object', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -772,10 +841,13 @@ describe('engines field_capabilities', () => { type: 'text', }, ], + metadata_field: false, name: 'name.first', + searchable: true, type: 'text', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -786,7 +858,9 @@ describe('engines field_capabilities', () => { type: 'unmapped', }, ], + metadata_field: false, name: 'name.last', + searchable: true, type: 'text', }, ]; @@ -832,6 +906,7 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', @@ -842,10 +917,13 @@ describe('engines field_capabilities', () => { type: 'nested', }, ], + metadata_field: false, name: 'name', + searchable: false, type: 'nested', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -856,10 +934,13 @@ describe('engines field_capabilities', () => { type: 'text', }, ], + metadata_field: false, name: 'name.first', + searchable: true, type: 'text', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -870,7 +951,9 @@ describe('engines field_capabilities', () => { type: 'unmapped', }, ], + metadata_field: false, name: 'name.last', + searchable: true, type: 'text', }, ]; @@ -908,6 +991,7 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', @@ -918,10 +1002,13 @@ describe('engines field_capabilities', () => { type: 'text', }, ], + metadata_field: false, name: 'body', + searchable: true, type: 'text', }, { + aggregatable: true, indices: [ { name: 'index-001', @@ -932,7 +1019,9 @@ describe('engines field_capabilities', () => { type: 'unmapped', }, ], + metadata_field: false, name: 'body.keyword', + searchable: true, type: 'keyword', }, ]; @@ -970,6 +1059,7 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', @@ -980,10 +1070,13 @@ describe('engines field_capabilities', () => { type: 'object', }, ], + metadata_field: false, name: 'order', + searchable: false, type: 'object', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -994,7 +1087,9 @@ describe('engines field_capabilities', () => { type: 'number', }, ], + metadata_field: false, name: 'order.id', + searchable: true, type: 'conflict', }, ]; @@ -1032,6 +1127,7 @@ describe('engines field_capabilities', () => { }; const expectedFields: SchemaField[] = [ { + aggregatable: false, indices: [ { name: 'index-001', @@ -1042,10 +1138,13 @@ describe('engines field_capabilities', () => { type: 'nested', }, ], + metadata_field: false, name: 'order', + searchable: false, type: 'nested', }, { + aggregatable: false, indices: [ { name: 'index-001', @@ -1056,7 +1155,9 @@ describe('engines field_capabilities', () => { type: 'number', }, ], + metadata_field: false, name: 'order.id', + searchable: true, type: 'conflict', }, ]; diff --git a/x-pack/plugins/enterprise_search/server/lib/engines/field_capabilities.ts b/x-pack/plugins/enterprise_search/server/lib/engines/field_capabilities.ts index 9d7082ffbbd89..fd1fb28aa23ca 100644 --- a/x-pack/plugins/enterprise_search/server/lib/engines/field_capabilities.ts +++ b/x-pack/plugins/enterprise_search/server/lib/engines/field_capabilities.ts @@ -26,7 +26,6 @@ export const fetchEngineFieldCapabilities = async ( }); const fields = parseFieldsCapabilities(fieldCapabilities); return { - field_capabilities: fieldCapabilities, fields, name, updated_at_millis, @@ -72,10 +71,17 @@ export const parseFieldsCapabilities = (fieldCapsResponse: FieldCapsResponse): S type, })); + const searchable = Object.values(typesObject).some((t) => t.searchable); + const aggregatable = Object.values(typesObject).some((t) => t.aggregatable); + const metadataField = Object.values(typesObject).every((t) => t.metadata_field); + return { + aggregatable, indices: fieldIndices, name: fieldName, + searchable, type, + ...(metadataField === undefined ? {} : { metadata_field: metadataField }), }; }) .sort((a, b) => a.name.localeCompare(b.name)) as SchemaField[]; diff --git a/x-pack/plugins/enterprise_search/server/lib/pipelines/create_pipeline_definitions.ts b/x-pack/plugins/enterprise_search/server/lib/pipelines/create_pipeline_definitions.ts index 209d9d4787ea3..8655ee6959f85 100644 --- a/x-pack/plugins/enterprise_search/server/lib/pipelines/create_pipeline_definitions.ts +++ b/x-pack/plugins/enterprise_search/server/lib/pipelines/create_pipeline_definitions.ts @@ -245,14 +245,18 @@ export const formatMlPipelineBody = async ( inferenceConfig: InferencePipelineInferenceConfig | undefined, esClient: ElasticsearchClient ): Promise => { - // this will raise a 404 if model doesn't exist + // This will raise a 404 if model doesn't exist const models = await esClient.ml.getTrainedModels({ model_id: modelId }); const model = models.trained_model_configs[0]; return generateMlInferencePipelineBody({ - destinationField, inferenceConfig, model, pipelineName, - sourceField, + fieldMappings: [ + { + sourceField, + targetField: destinationField, + }, + ], }); }; diff --git a/x-pack/plugins/enterprise_search/server/utils/create_connector_document.test.ts b/x-pack/plugins/enterprise_search/server/utils/create_connector_document.test.ts index 62851572cf798..08e18e0907532 100644 --- a/x-pack/plugins/enterprise_search/server/utils/create_connector_document.test.ts +++ b/x-pack/plugins/enterprise_search/server/utils/create_connector_document.test.ts @@ -86,6 +86,7 @@ describe('createConnectorDocument', () => { language: 'fr', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, name: 'indexName', @@ -177,6 +178,7 @@ describe('createConnectorDocument', () => { language: 'fr', last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, name: 'indexName', diff --git a/x-pack/plugins/enterprise_search/server/utils/create_connector_document.ts b/x-pack/plugins/enterprise_search/server/utils/create_connector_document.ts index d4776e3941cee..507559b65440d 100644 --- a/x-pack/plugins/enterprise_search/server/utils/create_connector_document.ts +++ b/x-pack/plugins/enterprise_search/server/utils/create_connector_document.ts @@ -91,6 +91,7 @@ export function createConnectorDocument({ language, last_seen: null, last_sync_error: null, + last_sync_scheduled_at: null, last_sync_status: null, last_synced: null, name: indexName.startsWith('search-') ? indexName.substring(7) : indexName, diff --git a/x-pack/plugins/fleet/common/experimental_features.ts b/x-pack/plugins/fleet/common/experimental_features.ts index 638e48cae5ba4..67abb5dfca379 100644 --- a/x-pack/plugins/fleet/common/experimental_features.ts +++ b/x-pack/plugins/fleet/common/experimental_features.ts @@ -19,7 +19,7 @@ export const allowedExperimentalValues = Object.freeze({ experimentalDataStreamSettings: false, displayAgentMetrics: true, showIntegrationsSubcategories: true, - agentFqdnMode: false, + agentFqdnMode: true, showExperimentalShipperOptions: false, fleetServerStandalone: false, agentTamperProtectionEnabled: false, diff --git a/x-pack/plugins/fleet/common/types/models/agent.ts b/x-pack/plugins/fleet/common/types/models/agent.ts index 11f259e959102..304da5b3f6514 100644 --- a/x-pack/plugins/fleet/common/types/models/agent.ts +++ b/x-pack/plugins/fleet/common/types/models/agent.ts @@ -389,7 +389,10 @@ export interface FleetServerAgentAction { data?: { [k: string]: unknown; }; - total?: number; + + /** Trace id */ + traceparent?: string | null; + [k: string]: unknown; } diff --git a/x-pack/plugins/fleet/cypress/e2e/package_policy_pipelines_and_mappings_real.cy.ts b/x-pack/plugins/fleet/cypress/e2e/package_policy_pipelines_and_mappings_real.cy.ts new file mode 100644 index 0000000000000..3fed3fef1d94b --- /dev/null +++ b/x-pack/plugins/fleet/cypress/e2e/package_policy_pipelines_and_mappings_real.cy.ts @@ -0,0 +1,238 @@ +/* + * 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 { + ADD_INTEGRATION_POLICY_BTN, + CREATE_PACKAGE_POLICY_SAVE_BTN, + INTEGRATION_NAME_LINK, + POLICY_EDITOR, +} from '../screens/integrations'; +import { EXISTING_HOSTS_TAB } from '../screens/fleet'; +import { CONFIRM_MODAL } from '../screens/navigation'; +const INPUT_TEST_PACKAGE = 'input_package-1.0.0'; +const INTEGRATION_TEST_PACKAGE = 'logs_integration-1.0.0'; +const INTEGRATION_TEST_PACKAGE_NO_DATASET = 'logs_int_no_dataset-1.0.0'; + +describe('Input package create and edit package policy', () => { + const agentPolicyId = 'test-input-package-policy'; + const agentPolicyName = 'Test input package policy'; + const packagePolicyName = 'input-package-policy'; + const datasetName = 'inputpkgdataset'; + + function editPackagePolicyandShowAdvanced(pkg: string, pkgPolicyName: string) { + cy.visit(`/app/integrations/detail/${pkg}/policies`); + + cy.getBySel(INTEGRATION_NAME_LINK).contains(pkgPolicyName).click(); + + cy.get('button').contains('Change defaults').click(); + cy.get('[data-test-subj^="advancedStreamOptionsToggle"]').click(); + } + + before(() => { + cy.task('installTestPackage', INPUT_TEST_PACKAGE); + + cy.request({ + method: 'POST', + url: `/api/fleet/agent_policies`, + body: { + id: agentPolicyId, + name: agentPolicyName, + description: 'desc', + namespace: 'default', + monitoring_enabled: [], + }, + headers: { 'kbn-xsrf': 'cypress' }, + }); + }); + after(() => { + // delete agent policy + cy.request({ + method: 'POST', + url: `/api/fleet/agent_policies/delete`, + headers: { 'kbn-xsrf': 'cypress' }, + body: JSON.stringify({ + agentPolicyId, + }), + }); + cy.task('uninstallTestPackage', INPUT_TEST_PACKAGE); + }); + it('should successfully create a package policy', () => { + cy.visit(`/app/integrations/detail/${INPUT_TEST_PACKAGE}/overview`); + cy.getBySel(ADD_INTEGRATION_POLICY_BTN).click(); + + cy.getBySel(POLICY_EDITOR.POLICY_NAME_INPUT).click().clear().type(packagePolicyName); + cy.getBySel('multiTextInput-paths') + .find('[data-test-subj="multiTextInputRow-0"]') + .click() + .type('/var/log/test.log'); + + cy.getBySel('multiTextInput-tags') + .find('[data-test-subj="multiTextInputRow-0"]') + .click() + .type('tag1'); + + cy.getBySel(POLICY_EDITOR.DATASET_SELECT).click().type(datasetName); + + cy.getBySel(EXISTING_HOSTS_TAB).click(); + + cy.getBySel(POLICY_EDITOR.AGENT_POLICY_SELECT).click().get(`#${agentPolicyId}`).click(); + cy.wait(500); // wait for policy id to be set + cy.getBySel(CREATE_PACKAGE_POLICY_SAVE_BTN).click(); + + cy.getBySel(CONFIRM_MODAL.CANCEL_BUTTON).click(); + }); + + it('should show pipelines editor with link to pipeline', () => { + editPackagePolicyandShowAdvanced(INPUT_TEST_PACKAGE, packagePolicyName); + cy.getBySel(POLICY_EDITOR.INSPECT_PIPELINES_BTN).click(); + cy.getBySel(CONFIRM_MODAL.CONFIRM_BUTTON).click(); + cy.get('body').should('not.contain', 'Pipeline not found'); + cy.get('body').should('contain', '"managed_by": "fleet"'); + }); + it('should show mappings editor with link to create custom template', () => { + editPackagePolicyandShowAdvanced(INPUT_TEST_PACKAGE, packagePolicyName); + cy.getBySel(POLICY_EDITOR.EDIT_MAPPINGS_BTN).click(); + cy.getBySel(CONFIRM_MODAL.CONFIRM_BUTTON).click(); + cy.get('body').should('contain', `logs-${datasetName}@custom`); + }); +}); + +describe('Integration package with custom dataset create and edit package policy', () => { + const agentPolicyId = 'test-logs-integration-package-policy'; + const agentPolicyName = 'Test integration with custom dataset package policy'; + const packagePolicyName = 'logs-integration-package-policy'; + const datasetName = 'integrationpkgdataset'; + + before(() => { + cy.task('installTestPackage', INTEGRATION_TEST_PACKAGE); + + cy.request({ + method: 'POST', + url: `/api/fleet/agent_policies`, + body: { + id: agentPolicyId, + name: agentPolicyName, + description: 'desc', + namespace: 'default', + monitoring_enabled: [], + }, + headers: { 'kbn-xsrf': 'cypress' }, + }); + }); + after(() => { + // delete agent policy + cy.request({ + method: 'POST', + url: `/api/fleet/agent_policies/delete`, + headers: { 'kbn-xsrf': 'cypress' }, + body: JSON.stringify({ + agentPolicyId, + }), + }); + cy.task('uninstallTestPackage', INTEGRATION_TEST_PACKAGE); + }); + it('should successfully create a package policy', () => { + cy.visit(`/app/integrations/detail/${INTEGRATION_TEST_PACKAGE}/overview`); + cy.getBySel(ADD_INTEGRATION_POLICY_BTN).click(); + + cy.getBySel(POLICY_EDITOR.POLICY_NAME_INPUT).click().clear().type(packagePolicyName); + cy.getBySel('multiTextInput-log-file-path') + .find('[data-test-subj="multiTextInputRow-0"]') + .click() + .type('/var/log/test.log'); + + cy.getBySel('textInput-dataset-name').click().type(datasetName); + + cy.getBySel(EXISTING_HOSTS_TAB).click(); + + cy.getBySel(POLICY_EDITOR.AGENT_POLICY_SELECT).click().get(`#${agentPolicyId}`).click(); + cy.wait(500); // wait for policy id to be set + cy.getBySel(CREATE_PACKAGE_POLICY_SAVE_BTN).click(); + + cy.getBySel(CONFIRM_MODAL.CANCEL_BUTTON).click(); + }); + + it('should not show pipelines or mappings editor', () => { + cy.visit(`/app/integrations/detail/${INTEGRATION_TEST_PACKAGE}/policies`); + cy.getBySel(INTEGRATION_NAME_LINK).contains(packagePolicyName).click(); + cy.get('[data-test-subj^="advancedStreamOptionsToggle"]').click(); + + cy.getBySel(POLICY_EDITOR.INSPECT_PIPELINES_BTN).should('not.exist'); + cy.getBySel(POLICY_EDITOR.EDIT_MAPPINGS_BTN).should('not.exist'); + }); +}); + +describe('Integration package with fixed dataset create and edit package policy', () => { + const agentPolicyId = 'test-integration-package-policy'; + const agentPolicyName = 'Test integration package policy'; + const packagePolicyName = 'integration-package-policy'; + + before(() => { + cy.task('installTestPackage', INTEGRATION_TEST_PACKAGE_NO_DATASET); + + cy.request({ + method: 'POST', + url: `/api/fleet/agent_policies`, + body: { + id: agentPolicyId, + name: agentPolicyName, + description: 'desc', + namespace: 'default', + monitoring_enabled: [], + }, + headers: { 'kbn-xsrf': 'cypress' }, + }); + }); + after(() => { + // delete agent policy + cy.request({ + method: 'POST', + url: `/api/fleet/agent_policies/delete`, + headers: { 'kbn-xsrf': 'cypress' }, + body: JSON.stringify({ + agentPolicyId, + }), + }); + cy.task('uninstallTestPackage', INTEGRATION_TEST_PACKAGE_NO_DATASET); + }); + it('should successfully create a package policy', () => { + cy.visit(`/app/integrations/detail/${INTEGRATION_TEST_PACKAGE_NO_DATASET}/overview`); + cy.getBySel(ADD_INTEGRATION_POLICY_BTN).click(); + + cy.getBySel(POLICY_EDITOR.POLICY_NAME_INPUT).click().clear().type(packagePolicyName); + cy.getBySel('multiTextInput-log-file-path') + .find('[data-test-subj="multiTextInputRow-0"]') + .click() + .type('/var/log/test.log'); + + cy.getBySel(EXISTING_HOSTS_TAB).click(); + + cy.getBySel(POLICY_EDITOR.AGENT_POLICY_SELECT).click().get(`#${agentPolicyId}`).click(); + cy.wait(500); // wait for policy id to be set + cy.getBySel(CREATE_PACKAGE_POLICY_SAVE_BTN).click(); + + cy.getBySel(CONFIRM_MODAL.CANCEL_BUTTON).click(); + }); + + it('should show pipelines editor with link to pipeline', () => { + cy.visit(`/app/integrations/detail/${INTEGRATION_TEST_PACKAGE_NO_DATASET}/policies`); + cy.getBySel(INTEGRATION_NAME_LINK).contains(packagePolicyName).click(); + cy.get('[data-test-subj^="advancedStreamOptionsToggle"]').click(); + + cy.getBySel(POLICY_EDITOR.INSPECT_PIPELINES_BTN).click(); + cy.get('body').should('not.contain', 'Pipeline not found'); + cy.get('body').should('contain', '"managed_by": "fleet"'); + }); + it('should show mappings editor with link to create custom template', () => { + cy.visit(`/app/integrations/detail/${INTEGRATION_TEST_PACKAGE_NO_DATASET}/policies`); + cy.getBySel(INTEGRATION_NAME_LINK).contains(packagePolicyName).click(); + cy.get('[data-test-subj^="advancedStreamOptionsToggle"]').click(); + + cy.getBySel(POLICY_EDITOR.EDIT_MAPPINGS_BTN).click(); + cy.get('body').should('contain', `logs-logs_int_no_dataset.log@custom`); + }); +}); diff --git a/x-pack/plugins/fleet/cypress/e2e/package_policy_real.cy.ts b/x-pack/plugins/fleet/cypress/e2e/package_policy_real.cy.ts deleted file mode 100644 index 00d9c4547966f..0000000000000 --- a/x-pack/plugins/fleet/cypress/e2e/package_policy_real.cy.ts +++ /dev/null @@ -1,98 +0,0 @@ -/* - * 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 { - ADD_INTEGRATION_POLICY_BTN, - CREATE_PACKAGE_POLICY_SAVE_BTN, - INTEGRATION_NAME_LINK, - POLICY_EDITOR, -} from '../screens/integrations'; -import { EXISTING_HOSTS_TAB } from '../screens/fleet'; -import { CONFIRM_MODAL } from '../screens/navigation'; - -const TEST_PACKAGE = 'input_package-1.0.0'; -const agentPolicyId = 'test-input-package-policy'; -const agentPolicyName = 'Test input package policy'; -const inputPackagePolicyName = 'input-package-policy'; - -function editPackagePolicyandShowAdvanced() { - cy.visit(`/app/integrations/detail/${TEST_PACKAGE}/policies`); - - cy.getBySel(INTEGRATION_NAME_LINK).contains(inputPackagePolicyName).click(); - - cy.get('button').contains('Change defaults').click(); - cy.get('[data-test-subj^="advancedStreamOptionsToggle"]').click(); -} -describe('Input package create and edit package policy', () => { - before(() => { - cy.task('installTestPackage', TEST_PACKAGE); - - cy.request({ - method: 'POST', - url: `/api/fleet/agent_policies`, - body: { - id: agentPolicyId, - name: agentPolicyName, - description: 'desc', - namespace: 'default', - monitoring_enabled: [], - }, - headers: { 'kbn-xsrf': 'cypress' }, - }); - }); - after(() => { - // delete agent policy - cy.request({ - method: 'POST', - url: `/api/fleet/agent_policies/delete`, - headers: { 'kbn-xsrf': 'cypress' }, - body: JSON.stringify({ - agentPolicyId, - }), - }); - cy.task('uninstallTestPackage', TEST_PACKAGE); - }); - it('should successfully create a package policy', () => { - cy.visit(`/app/integrations/detail/${TEST_PACKAGE}/overview`); - cy.getBySel(ADD_INTEGRATION_POLICY_BTN).click(); - - cy.getBySel(POLICY_EDITOR.POLICY_NAME_INPUT).click().clear().type(inputPackagePolicyName); - cy.getBySel('multiTextInput-paths') - .find('[data-test-subj="multiTextInputRow-0"]') - .click() - .type('/var/log/test.log'); - - cy.getBySel('multiTextInput-tags') - .find('[data-test-subj="multiTextInputRow-0"]') - .click() - .type('tag1'); - - cy.getBySel(POLICY_EDITOR.DATASET_SELECT).click().type('testdataset'); - - cy.getBySel(EXISTING_HOSTS_TAB).click(); - - cy.getBySel(POLICY_EDITOR.AGENT_POLICY_SELECT).click().get(`#${agentPolicyId}`).click(); - cy.wait(500); // wait for policy id to be set - cy.getBySel(CREATE_PACKAGE_POLICY_SAVE_BTN).click(); - - cy.getBySel(CONFIRM_MODAL.CANCEL_BUTTON).click(); - }); - - it('should show pipelines editor with link to pipeline', () => { - editPackagePolicyandShowAdvanced(); - cy.getBySel(POLICY_EDITOR.INSPECT_PIPELINES_BTN).click(); - cy.getBySel(CONFIRM_MODAL.CONFIRM_BUTTON).click(); - cy.get('body').should('not.contain', 'Pipeline not found'); - cy.get('body').should('contain', '"managed_by": "fleet"'); - }); - it('should show mappings editor with link to create custom template', () => { - editPackagePolicyandShowAdvanced(); - cy.getBySel(POLICY_EDITOR.EDIT_MAPPINGS_BTN).click(); - cy.getBySel(CONFIRM_MODAL.CONFIRM_BUTTON).click(); - cy.get('body').should('contain', 'logs-testdataset@custom'); - }); -}); diff --git a/x-pack/plugins/fleet/cypress/packages/logs_int_no_dataset-1.0.0.zip b/x-pack/plugins/fleet/cypress/packages/logs_int_no_dataset-1.0.0.zip new file mode 100644 index 0000000000000..b341cffdcb0b4 Binary files /dev/null and b/x-pack/plugins/fleet/cypress/packages/logs_int_no_dataset-1.0.0.zip differ diff --git a/x-pack/plugins/fleet/cypress/packages/logs_integration-1.0.0.zip b/x-pack/plugins/fleet/cypress/packages/logs_integration-1.0.0.zip new file mode 100644 index 0000000000000..d4949cfe337c7 Binary files /dev/null and b/x-pack/plugins/fleet/cypress/packages/logs_integration-1.0.0.zip differ diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/components/agent_policy_advanced_fields/index.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/components/agent_policy_advanced_fields/index.tsx index 6409114839bc6..407352a69bebf 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/components/agent_policy_advanced_fields/index.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/components/agent_policy_advanced_fields/index.tsx @@ -42,7 +42,7 @@ import { AgentPolicyPackageBadge } from '../../../../components'; import { AgentPolicyDeleteProvider } from '../agent_policy_delete_provider'; import type { ValidationResults } from '../agent_policy_validation'; -import { ExperimentalFeaturesService, policyHasFleetServer } from '../../../../services'; +import { policyHasFleetServer } from '../../../../services'; import { useOutputOptions, @@ -66,7 +66,6 @@ export const AgentPolicyAdvancedOptionsContent: React.FunctionComponent = isEditing = false, onDelete = () => {}, }) => { - const { agentFqdnMode: agentFqdnModeEnabled } = ExperimentalFeaturesService.get(); const { docLinks } = useStartServices(); const config = useConfig(); const maxAgentPoliciesWithInactivityTimeout = @@ -558,66 +557,38 @@ export const AgentPolicyAdvancedOptionsContent: React.FunctionComponent = /> - {agentFqdnModeEnabled && ( - - -   - - - } - description={ + - } - > - - - - - - - - - - - - - - - - - - - ), - }, - { - id: 'fqdn', - label: ( +   + + + } + description={ + + } + > + + @@ -625,26 +596,52 @@ export const AgentPolicyAdvancedOptionsContent: React.FunctionComponent = - ), - }, - ]} - idSelected={agentPolicy.agent_features?.length ? 'fqdn' : 'hostname'} - onChange={(id: string) => { - updateAgentPolicy({ - agent_features: id === 'hostname' ? [] : [{ name: 'fqdn', enabled: true }], - }); - }} - name="radio group" - /> - - - )} + + + ), + }, + { + id: 'fqdn', + label: ( + + + + + + + + + + + + + + + ), + }, + ]} + idSelected={agentPolicy.agent_features?.length ? 'fqdn' : 'hostname'} + onChange={(id: string) => { + updateAgentPolicy({ + agent_features: id === 'hostname' ? [] : [{ name: 'fqdn', enabled: true }], + }); + }} + name="radio group" + /> + + {isEditing && 'id' in agentPolicy && !agentPolicy.is_managed ? ( ( const { exists: indexTemplateExists, isLoading: isLoadingIndexTemplate } = useIndexTemplateExists( getRegistryDataStreamAssetBaseName({ - dataset: customDatasetVarValue, + dataset: customDatasetVarValue || packageInputStream.data_stream.dataset, type: packageInputStream.data_stream.type, }), isPackagePolicyEdit diff --git a/x-pack/plugins/fleet/server/services/agents/actions.ts b/x-pack/plugins/fleet/server/services/agents/actions.ts index bc56b7e80e8af..8f39557697312 100644 --- a/x-pack/plugins/fleet/server/services/agents/actions.ts +++ b/x-pack/plugins/fleet/server/services/agents/actions.ts @@ -7,6 +7,7 @@ import { v4 as uuidv4 } from 'uuid'; import type { ElasticsearchClient, SavedObjectsClientContract } from '@kbn/core/server'; +import apm from 'elastic-apm-node'; import { appContextService } from '../app_context'; import type { @@ -50,6 +51,7 @@ export async function createAgentAction( minimum_execution_duration: newAgentAction.minimum_execution_duration, rollout_duration_seconds: newAgentAction.rollout_duration_seconds, total: newAgentAction.total, + traceparent: apm.currentTraceparent, }; await esClient.create({ @@ -98,6 +100,7 @@ export async function bulkCreateAgentActions( action_id: action.id, data: action.data, type: action.type, + traceparent: apm.currentTraceparent, }; return [ diff --git a/x-pack/plugins/fleet/server/services/audit_logging.ts b/x-pack/plugins/fleet/server/services/audit_logging.ts index a9549ade160d1..efadaedfb5463 100644 --- a/x-pack/plugins/fleet/server/services/audit_logging.ts +++ b/x-pack/plugins/fleet/server/services/audit_logging.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { AuditLogger } from '@kbn/security-plugin/server'; +import type { AuditEvent, AuditLogger } from '@kbn/security-plugin/server'; import { appContextService } from './app_context'; import { getRequestStore } from './request_store'; @@ -14,8 +14,12 @@ class AuditLoggingService { /** * Write a custom audit log record. If a current request is available, the log will include * user/session data. If not, an unscoped audit logger will be used. + * + * Note: all Fleet audit logs written via this method will have a `labels.application` value + * of `elastic/fleet`. Consumers aren't able to override this value, and a custom `labels.application` + * value provided as an argument will be overwritten. */ - public writeCustomAuditLog(...args: Parameters) { + public writeCustomAuditLog(args: AuditEvent) { const securitySetup = appContextService.getSecuritySetup(); let auditLogger: AuditLogger | undefined; @@ -27,7 +31,7 @@ class AuditLoggingService { auditLogger = securitySetup.audit.withoutRequest; } - auditLogger.log(...args); + auditLogger.log({ ...args, labels: { ...args.labels, application: 'elastic/fleet' } }); } /** diff --git a/x-pack/plugins/infra/common/utils/get_chart_group_names.ts b/x-pack/plugins/infra/common/utils/get_chart_group_names.ts new file mode 100644 index 0000000000000..5c1da04e12d55 --- /dev/null +++ b/x-pack/plugins/infra/common/utils/get_chart_group_names.ts @@ -0,0 +1,10 @@ +/* + * 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. + */ + +// It's simple function to be shared, but it is required on both sides server and frontend +// We need to get consistent group names when any changes occurs. +export const getChartGroupNames = (fields: string[]) => fields.join(', '); diff --git a/x-pack/plugins/infra/public/alerting/log_threshold/components/alert_details_app_section/index.tsx b/x-pack/plugins/infra/public/alerting/log_threshold/components/alert_details_app_section/index.tsx index 8158e2edb17e0..01fb690be4017 100644 --- a/x-pack/plugins/infra/public/alerting/log_threshold/components/alert_details_app_section/index.tsx +++ b/x-pack/plugins/infra/public/alerting/log_threshold/components/alert_details_app_section/index.tsx @@ -6,8 +6,10 @@ */ import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; import { ALERT_DURATION, ALERT_END } from '@kbn/rule-data-utils'; +import compact from 'lodash/compact'; import moment from 'moment'; import React from 'react'; +import { getChartGroupNames } from '../../../../../common/utils/get_chart_group_names'; import { type PartialCriterion } from '../../../../../common/alerting/logs/log_threshold'; import { CriterionPreview } from '../expression_editor/criterion_preview_chart'; import { AlertAnnotation } from './components/alert_annotation'; @@ -21,6 +23,25 @@ const AlertDetailsAppSection = ({ rule, alert }: AlertDetailsAppSectionProps) => .asMilliseconds(); const alertDurationMS = alert.fields[ALERT_DURATION]! / 1000; const TWENTY_TIMES_RULE_WINDOW_MS = 20 * ruleWindowSizeMS; + + /** + * The `CriterionPreview` chart shows all the series/data stacked when there is a GroupBy in the rule parameters. + * e.g., `host.name`, the chart will show stacks of data by hostname. + * We only need the chart to show the series that is related to the selected alert. + * The chart series are built based on the GroupBy in the rule params + * Each series have an id which is the just a joining of fields value of the GroupBy `getChartGroupNames` + * We filter down the series using this group name + */ + const alertFieldsFromGroupBy = compact( + rule.params.groupBy?.map((fieldNameGroupBy) => { + const field = Object.keys(alert.fields).find( + (alertFiledName) => alertFiledName === fieldNameGroupBy + ); + if (field) return alert.fields[field]; + }) + ); + const selectedSeries = getChartGroupNames(alertFieldsFromGroupBy); + /** * This is part or the requirements (RFC). * If the alert is less than 20 units of `FOR THE LAST ` then we should draw a time range of 20 units. @@ -52,6 +73,7 @@ const AlertDetailsAppSection = ({ rule, alert }: AlertDetailsAppSectionProps) => showThreshold={true} executionTimeRange={{ gte: rangeFrom, lte: rangeTo }} annotations={[]} + filterSeriesByGroupName={[selectedSeries]} /> ); diff --git a/x-pack/plugins/infra/public/alerting/log_threshold/components/alert_details_app_section/types.ts b/x-pack/plugins/infra/public/alerting/log_threshold/components/alert_details_app_section/types.ts index 8a4b23b630b7b..61a0859670549 100644 --- a/x-pack/plugins/infra/public/alerting/log_threshold/components/alert_details_app_section/types.ts +++ b/x-pack/plugins/infra/public/alerting/log_threshold/components/alert_details_app_section/types.ts @@ -11,5 +11,5 @@ import { PartialRuleParams } from '../../../../../common/alerting/logs/log_thres export interface AlertDetailsAppSectionProps { rule: Rule; - alert: TopAlert; + alert: TopAlert>; } diff --git a/x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion_preview_chart.tsx b/x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion_preview_chart.tsx index 849b029846fe3..e098afb83d72a 100644 --- a/x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion_preview_chart.tsx +++ b/x-pack/plugins/infra/public/alerting/log_threshold/components/expression_editor/criterion_preview_chart.tsx @@ -60,6 +60,7 @@ interface Props { showThreshold: boolean; executionTimeRange?: ExecutionTimeRange; annotations?: Array>; + filterSeriesByGroupName?: string[]; } export const CriterionPreview: React.FC = ({ @@ -69,6 +70,7 @@ export const CriterionPreview: React.FC = ({ showThreshold, executionTimeRange, annotations, + filterSeriesByGroupName, }) => { const chartAlertParams: GetLogAlertsChartPreviewDataAlertParamsSubset | null = useMemo(() => { const { field, comparator, value } = chartCriterion; @@ -114,6 +116,7 @@ export const CriterionPreview: React.FC = ({ showThreshold={showThreshold} executionTimeRange={executionTimeRange} annotations={annotations} + filterSeriesByGroupName={filterSeriesByGroupName} /> ); }; @@ -126,6 +129,7 @@ interface ChartProps { showThreshold: boolean; executionTimeRange?: ExecutionTimeRange; annotations?: Array>; + filterSeriesByGroupName?: string[]; } const CriterionPreviewChart: React.FC = ({ @@ -136,6 +140,7 @@ const CriterionPreviewChart: React.FC = ({ showThreshold, executionTimeRange, annotations, + filterSeriesByGroupName, }) => { const { uiSettings } = useKibana().services; const isDarkMode = uiSettings?.get('theme:darkMode') || false; @@ -184,7 +189,9 @@ const CriterionPreviewChart: React.FC = ({ if (!isGrouped) { return series; } - + if (filterSeriesByGroupName && filterSeriesByGroupName.length) { + return series.filter((item) => filterSeriesByGroupName.includes(item.id)); + } const sortedByMax = series.sort((a, b) => { const aMax = Math.max(...a.points.map((point) => point.value)); const bMax = Math.max(...b.points.map((point) => point.value)); @@ -192,7 +199,7 @@ const CriterionPreviewChart: React.FC = ({ }); const sortedSeries = (!isAbove && !isBelow) || isAbove ? sortedByMax : sortedByMax.reverse(); return sortedSeries.slice(0, GROUP_LIMIT); - }, [series, isGrouped, isAbove, isBelow]); + }, [isGrouped, filterSeriesByGroupName, series, isAbove, isBelow]); const barSeries = useMemo(() => { return filteredSeries.reduce>( diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/components/__snapshots__/alert_details_app_section.test.tsx.snap b/x-pack/plugins/infra/public/alerting/metric_threshold/components/__snapshots__/alert_details_app_section.test.tsx.snap new file mode 100644 index 0000000000000..9994945cd3290 --- /dev/null +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/components/__snapshots__/alert_details_app_section.test.tsx.snap @@ -0,0 +1,47 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`AlertDetailsAppSection should render annotations 1`] = ` +Array [ + Object { + "annotations": Array [ + , + , + ], + "chartType": "line", + "derivedIndexPattern": Object { + "fields": Array [], + "title": "metricbeat-*", + }, + "expression": Object { + "aggType": "count", + "comparator": ">", + "threshold": Array [ + 2000, + ], + "timeSize": 15, + "timeUnit": "m", + }, + "filterQuery": undefined, + "groupBy": Array [ + "host.hostname", + ], + "source": Object { + "id": "default", + }, + "timeRange": Object { + "from": "2023-03-28T10:43:13.802Z", + "to": "2023-03-29T13:14:09.581Z", + }, + }, + Object {}, +] +`; diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/components/alert_details_app_section.test.tsx b/x-pack/plugins/infra/public/alerting/metric_threshold/components/alert_details_app_section.test.tsx index 1070764f3c418..20f134633e04b 100644 --- a/x-pack/plugins/infra/public/alerting/metric_threshold/components/alert_details_app_section.test.tsx +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/components/alert_details_app_section.test.tsx @@ -5,13 +5,30 @@ * 2.0. */ -import { coreMock as mockCoreMock } from '@kbn/core/public/mocks'; import React from 'react'; +import { coreMock as mockCoreMock } from '@kbn/core/public/mocks'; import { __IntlProvider as IntlProvider } from '@kbn/i18n-react'; import { render } from '@testing-library/react'; import { QueryClient, QueryClientProvider } from '@tanstack/react-query'; -import { buildMetricThresholdRule } from '../mocks/metric_threshold_rule'; +import { + buildMetricThresholdAlert, + buildMetricThresholdRule, +} from '../mocks/metric_threshold_rule'; import { AlertDetailsAppSection } from './alert_details_app_section'; +import { ExpressionChart } from './expression_chart'; + +jest.mock('@kbn/observability-alert-details', () => ({ + AlertAnnotation: () => {}, + AlertActiveTimeRangeAnnotation: () => {}, + getPaddedAlertTimeRange: () => ({ + from: '2023-03-28T10:43:13.802Z', + to: '2023-03-29T13:14:09.581Z', + }), +})); + +jest.mock('./expression_chart', () => ({ + ExpressionChart: jest.fn(() =>
), +})); jest.mock('../../../hooks/use_kibana', () => ({ useKibanaContextForPlugin: () => ({ @@ -33,15 +50,27 @@ describe('AlertDetailsAppSection', () => { return render( - + ); }; - it('should render rule data correctly', async () => { + it('should render rule data', async () => { const result = renderComponent(); expect((await result.findByTestId('metricThresholdAppSection')).children.length).toBe(3); }); + + it('should render annotations', async () => { + const mockedExpressionChart = jest.fn(() =>
); + (ExpressionChart as jest.Mock).mockImplementation(mockedExpressionChart); + renderComponent(); + + expect(mockedExpressionChart).toHaveBeenCalledTimes(3); + expect(mockedExpressionChart.mock.calls[0]).toMatchSnapshot(); + }); }); diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/components/alert_details_app_section.tsx b/x-pack/plugins/infra/public/alerting/metric_threshold/components/alert_details_app_section.tsx index f465ce8be12ab..06602c9638865 100644 --- a/x-pack/plugins/infra/public/alerting/metric_threshold/components/alert_details_app_section.tsx +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/components/alert_details_app_section.tsx @@ -5,32 +5,69 @@ * 2.0. */ -import { EuiFlexGroup, EuiFlexItem, EuiPanel } from '@elastic/eui'; import React, { useMemo } from 'react'; +import moment from 'moment'; +import { EuiFlexGroup, EuiFlexItem, EuiPanel, useEuiTheme } from '@elastic/eui'; +import { TopAlert } from '@kbn/observability-plugin/public'; +import { ALERT_END, ALERT_START } from '@kbn/rule-data-utils'; import { Rule } from '@kbn/alerting-plugin/common'; +import { + AlertAnnotation, + getPaddedAlertTimeRange, + AlertActiveTimeRangeAnnotation, +} from '@kbn/observability-alert-details'; import { useSourceContext, withSourceProvider } from '../../../containers/metrics_source'; -import { MetricThresholdRuleTypeParams } from '..'; import { generateUniqueKey } from '../lib/generate_unique_key'; import { MetricsExplorerChartType } from '../../../pages/metrics/metrics_explorer/hooks/use_metrics_explorer_options'; +import { useKibanaContextForPlugin } from '../../../hooks/use_kibana'; +import { MetricThresholdRuleTypeParams } from '..'; import { ExpressionChart } from './expression_chart'; // TODO Use a generic props for app sections https://github.com/elastic/kibana/issues/152690 +export type MetricThresholdRule = Rule< + MetricThresholdRuleTypeParams & { + filterQueryText?: string; + groupBy?: string | string[]; + } +>; +export type MetricThresholdAlert = TopAlert; + +const DEFAULT_DATE_FORMAT = 'YYYY-MM-DD HH:mm'; +const ALERT_START_ANNOTATION_ID = 'alert_start_annotation'; +const ALERT_TIME_RANGE_ANNOTATION_ID = 'alert_time_range_annotation'; + interface AppSectionProps { - rule: Rule< - MetricThresholdRuleTypeParams & { - filterQueryText?: string; - groupBy?: string | string[]; - } - >; + rule: MetricThresholdRule; + alert: MetricThresholdAlert; } -export function AlertDetailsAppSection({ rule }: AppSectionProps) { +export function AlertDetailsAppSection({ alert, rule }: AppSectionProps) { + const { uiSettings } = useKibanaContextForPlugin().services; const { source, createDerivedIndexPattern } = useSourceContext(); + const { euiTheme } = useEuiTheme(); const derivedIndexPattern = useMemo( () => createDerivedIndexPattern(), [createDerivedIndexPattern] ); + const timeRange = getPaddedAlertTimeRange(alert.fields[ALERT_START]!, alert.fields[ALERT_END]); + const alertEnd = alert.fields[ALERT_END] ? moment(alert.fields[ALERT_END]).valueOf() : undefined; + const annotations = [ + , + , + ]; return !!rule.params.criteria ? ( @@ -44,6 +81,8 @@ export function AlertDetailsAppSection({ rule }: AppSectionProps) { filterQuery={rule.params.filterQueryText} groupBy={rule.params.groupBy} chartType={MetricsExplorerChartType.line} + timeRange={timeRange} + annotations={annotations} /> diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/components/custom_equation/metric_row_with_agg.tsx b/x-pack/plugins/infra/public/alerting/metric_threshold/components/custom_equation/metric_row_with_agg.tsx index 8a8b622e14751..8bfa3961b7fa2 100644 --- a/x-pack/plugins/infra/public/alerting/metric_threshold/components/custom_equation/metric_row_with_agg.tsx +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/components/custom_equation/metric_row_with_agg.tsx @@ -17,6 +17,7 @@ import { import React, { useMemo, useCallback } from 'react'; import { get } from 'lodash'; import { i18n } from '@kbn/i18n'; +import { ValidNormalizedTypes } from '@kbn/triggers-actions-ui-plugin/public'; import { Aggregators, CustomMetricAggTypes } from '../../../../../common/alerting/metrics'; import { MetricRowControls } from './metric_row_controls'; import { NormalizedFields, MetricRowBaseProps } from './types'; @@ -47,7 +48,9 @@ export const MetricRowWithAgg = ({ fields.reduce((acc, fieldValue) => { if ( aggType && - aggregationTypes[aggType].validNormalizedTypes.includes(fieldValue.normalizedType) + aggregationTypes[aggType].validNormalizedTypes.includes( + fieldValue.normalizedType as ValidNormalizedTypes + ) ) { acc.push({ label: fieldValue.name }); } diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.test.tsx b/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.test.tsx index be22d90cc2729..f2bb22485fe9c 100644 --- a/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.test.tsx +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.test.tsx @@ -5,10 +5,11 @@ * 2.0. */ +import React, { ReactElement } from 'react'; +import { act } from 'react-dom/test-utils'; +import { LineAnnotation, RectAnnotation } from '@elastic/charts'; import { DataViewBase } from '@kbn/es-query'; import { mountWithIntl, nextTick } from '@kbn/test-jest-helpers'; -import React from 'react'; -import { act } from 'react-dom/test-utils'; // We are using this inside a `jest.mock` call. Jest requires dynamic dependencies to be prefixed with `mock` import { coreMock as mockCoreMock } from '@kbn/core/public/mocks'; import { Aggregators, Comparator } from '../../../../common/alerting/metrics'; @@ -38,7 +39,12 @@ jest.mock('../hooks/use_metrics_explorer_chart_data', () => ({ })); describe('ExpressionChart', () => { - async function setup(expression: MetricExpression, filterQuery?: string, groupBy?: string) { + async function setup( + expression: MetricExpression, + filterQuery?: string, + groupBy?: string, + annotations?: Array> + ) { const derivedIndexPattern: DataViewBase = { title: 'metricbeat-*', fields: [], @@ -64,6 +70,7 @@ describe('ExpressionChart', () => { source={source} filterQuery={filterQuery} groupBy={groupBy} + annotations={annotations} /> ); diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.tsx b/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.tsx index 258d9164a8ea0..8dd7762feb6b9 100644 --- a/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.tsx +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression_chart.tsx @@ -5,8 +5,16 @@ * 2.0. */ -import React from 'react'; -import { Axis, Chart, niceTimeFormatter, Position, Settings } from '@elastic/charts'; +import React, { ReactElement } from 'react'; +import { + Axis, + Chart, + LineAnnotation, + niceTimeFormatter, + Position, + RectAnnotation, + Settings, +} from '@elastic/charts'; import { EuiText } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; import { DataViewBase } from '@kbn/es-query'; @@ -16,7 +24,7 @@ import { MetricsSourceConfiguration } from '../../../../common/metrics_sources'; import { Color } from '../../../../common/color_palette'; import { MetricsExplorerRow, MetricsExplorerAggregation } from '../../../../common/http_api'; import { MetricExplorerSeriesChart } from '../../../pages/metrics/metrics_explorer/components/series_chart'; -import { MetricExpression } from '../types'; +import { MetricExpression, TimeRange } from '../types'; import { MetricsExplorerChartType, MetricsExplorerOptionsMetric, @@ -44,6 +52,8 @@ interface Props { filterQuery?: string; groupBy?: string | string[]; chartType?: MetricsExplorerChartType; + timeRange?: TimeRange; + annotations?: Array>; } export const ExpressionChart: React.FC = ({ @@ -53,6 +63,8 @@ export const ExpressionChart: React.FC = ({ filterQuery, groupBy, chartType = MetricsExplorerChartType.bar, + timeRange, + annotations, }) => { const { uiSettings } = useKibanaContextForPlugin().services; @@ -61,7 +73,8 @@ export const ExpressionChart: React.FC = ({ derivedIndexPattern, source, filterQuery, - groupBy + groupBy, + timeRange ); if (isLoading) { @@ -158,6 +171,7 @@ export const ExpressionChart: React.FC = ({ domain={domain} /> )} + {annotations} { const { timeSize, timeUnit } = expression || { timeSize: 1, timeUnit: 'm' }; @@ -57,8 +60,8 @@ export const useMetricsExplorerChartData = ( ] ); const timestamps: MetricsExplorerTimestampsRT = useMemo(() => { - const from = `now-${(timeSize || 1) * 20}${timeUnit}`; - const to = 'now'; + const from = timeRange.from ?? `now-${(timeSize || 1) * 20}${timeUnit}`; + const to = timeRange.to ?? 'now'; const fromTimestamp = DateMath.parse(from)!.valueOf(); const toTimestamp = DateMath.parse(to, { roundUp: true })!.valueOf(); return { @@ -66,7 +69,7 @@ export const useMetricsExplorerChartData = ( fromTimestamp, toTimestamp, }; - }, [timeSize, timeUnit]); + }, [timeRange, timeSize, timeUnit]); return useMetricsExplorerData(options, source?.configuration, derivedIndexPattern, timestamps); }; diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/mocks/metric_threshold_rule.ts b/x-pack/plugins/infra/public/alerting/metric_threshold/mocks/metric_threshold_rule.ts index d1e79edef1f19..3f579a56ce7a3 100644 --- a/x-pack/plugins/infra/public/alerting/metric_threshold/mocks/metric_threshold_rule.ts +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/mocks/metric_threshold_rule.ts @@ -5,14 +5,13 @@ * 2.0. */ -import { Rule } from '@kbn/alerting-plugin/common'; import { v4 as uuidv4 } from 'uuid'; import { Aggregators, Comparator } from '../../../../common/alerting/metrics'; -import { MetricThresholdRuleTypeParams } from '..'; +import { MetricThresholdAlert, MetricThresholdRule } from '../components/alert_details_app_section'; export const buildMetricThresholdRule = ( - rule: Partial> = {} -): Rule => { + rule: Partial = {} +): MetricThresholdRule => { return { alertTypeId: 'metrics.alert.threshold', createdBy: 'admin', @@ -85,7 +84,7 @@ export const buildMetricThresholdRule = ( }, ], filterQuery: - '{"bool":{"filter":[{"bool":{"should":[{"term":{"host.hostname":{"value":"Maryams-MacBook-Pro.local"}}}],"minimum_should_match":1}},{"bool":{"should":[{"term":{"service.type":{"value":"system"}}}],"minimum_should_match":1}}]}}', + '{"bool":{"filter":[{"bool":{"should":[{"term":{"host.hostname":{"value":"Users-System.local"}}}],"minimum_should_match":1}},{"bool":{"should":[{"term":{"service.type":{"value":"system"}}}],"minimum_should_match":1}}]}}', groupBy: ['host.hostname'], }, monitoring: { @@ -120,3 +119,60 @@ export const buildMetricThresholdRule = ( ...rule, }; }; + +export const buildMetricThresholdAlert = ( + alert: Partial = {} +): MetricThresholdAlert => { + return { + link: '/app/metrics/explorer', + reason: 'system.cpu.user.pct reported no data in the last 1m for ', + fields: { + 'kibana.alert.rule.parameters': { + criteria: [ + { + aggType: 'avg', + comparator: '>', + threshold: [0.1], + timeSize: 1, + timeUnit: 'm', + metric: 'system.cpu.user.pct', + }, + ], + sourceId: 'default', + alertOnNoData: true, + alertOnGroupDisappear: true, + }, + 'kibana.alert.rule.category': 'Metric threshold', + 'kibana.alert.rule.consumer': 'alerts', + 'kibana.alert.rule.execution.uuid': '62dd07ef-ead9-4b1f-a415-7c83d03925f7', + 'kibana.alert.rule.name': 'One condition', + 'kibana.alert.rule.producer': 'infrastructure', + 'kibana.alert.rule.rule_type_id': 'metrics.alert.threshold', + 'kibana.alert.rule.uuid': '3a1ed8c0-c1a8-11ed-9249-ed6d75986bdc', + 'kibana.space_ids': ['default'], + 'kibana.alert.rule.tags': [], + '@timestamp': '2023-03-28T14:40:00.000Z', + 'kibana.alert.reason': 'system.cpu.user.pct reported no data in the last 1m for ', + 'kibana.alert.action_group': 'metrics.threshold.nodata', + tags: [], + 'kibana.alert.duration.us': 248391946000, + 'kibana.alert.time_range': { + gte: '2023-03-13T14:06:23.695Z', + }, + 'kibana.alert.instance.id': '*', + 'kibana.alert.start': '2023-03-28T13:40:00.000Z', + 'kibana.alert.uuid': '50faddcd-c0a0-4122-a068-c204f4a7ec87', + 'kibana.alert.status': 'active', + 'kibana.alert.workflow_status': 'open', + 'event.kind': 'signal', + 'event.action': 'active', + 'kibana.version': '8.8.0', + 'kibana.alert.flapping': false, + 'kibana.alert.rule.revision': 1, + }, + active: true, + start: 1678716383695, + lastUpdated: 1678964775641, + ...alert, + }; +}; diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/types.ts b/x-pack/plugins/infra/public/alerting/metric_threshold/types.ts index 2aecaf4f4febe..3f89afcbba88a 100644 --- a/x-pack/plugins/infra/public/alerting/metric_threshold/types.ts +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/types.ts @@ -58,6 +58,11 @@ export interface ExpressionChartRow { export type ExpressionChartSeries = ExpressionChartRow[][]; +export interface TimeRange { + from?: string; + to?: string; +} + export interface AlertParams { criteria: MetricExpression[]; groupBy?: string | string[]; diff --git a/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/flyout.tsx b/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/flyout.tsx index 5dadd7a5fb67b..98018550415c1 100644 --- a/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/flyout.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/flyout.tsx @@ -6,13 +6,26 @@ */ import React from 'react'; -import { EuiFlyout, EuiFlyoutHeader, EuiTitle, EuiFlyoutBody } from '@elastic/eui'; -import { EuiSpacer, EuiTabs, EuiTab } from '@elastic/eui'; +import { + EuiFlyout, + EuiFlyoutHeader, + EuiTitle, + EuiFlyoutBody, + EuiFlexGroup, + EuiFlexItem, + EuiTab, + EuiSpacer, + EuiTabs, + useEuiTheme, +} from '@elastic/eui'; +import { css } from '@emotion/react'; +import { useUnifiedSearchContext } from '../../hooks/use_unified_search'; +import { LinkToUptime } from './links/link_to_uptime'; +import { LinkToApmServices } from './links/link_to_apm_services'; import { useLazyRef } from '../../../../../hooks/use_lazy_ref'; import { metadataTab } from './metadata'; import type { InventoryItemType } from '../../../../../../common/inventory_models/types'; import type { HostNodeRow } from '../../hooks/use_hosts_table'; -import { useUnifiedSearchContext } from '../../hooks/use_unified_search'; import { processesTab } from './processes'; import { Metadata } from './metadata/metadata'; import { Processes } from './processes/processes'; @@ -28,6 +41,7 @@ const NODE_TYPE = 'host' as InventoryItemType; export const Flyout = ({ node, closeFlyout }: Props) => { const { getDateRangeAsTimestamp } = useUnifiedSearchContext(); + const { euiTheme } = useEuiTheme(); const currentTimeRange = { ...getDateRangeAsTimestamp(), @@ -57,9 +71,24 @@ export const Flyout = ({ node, closeFlyout }: Props) => { return ( - -

{node.name}

- + + + +

{node.name}

+ + + + + + + + + {tabEntries} diff --git a/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/links/link_to_apm_services.tsx b/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/links/link_to_apm_services.tsx new file mode 100644 index 0000000000000..18fc83004dc13 --- /dev/null +++ b/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/links/link_to_apm_services.tsx @@ -0,0 +1,52 @@ +/* + * 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 React from 'react'; +import { stringify } from 'querystring'; +import { encode } from '@kbn/rison'; +import { css } from '@emotion/react'; +import { RedirectAppLinks } from '@kbn/shared-ux-link-redirect-app'; +import { EuiIcon, EuiLink, useEuiTheme } from '@elastic/eui'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { useKibanaContextForPlugin } from '../../../../../../hooks/use_kibana'; + +interface LinkToApmServicesProps { + hostName: string; + apmField: string; +} + +export const LinkToApmServices = ({ hostName, apmField }: LinkToApmServicesProps) => { + const { services } = useKibanaContextForPlugin(); + const { http } = services; + const { euiTheme } = useEuiTheme(); + + const queryString = new URLSearchParams( + encode( + stringify({ + kuery: `${apmField}:"${hostName}"`, + }) + ) + ); + + const linkToApmServices = http.basePath.prepend(`/app/apm/services?${queryString}`); + + return ( + + + + + + + ); +}; diff --git a/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/links/link_to_uptime.tsx b/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/links/link_to_uptime.tsx new file mode 100644 index 0000000000000..02043eb21417d --- /dev/null +++ b/x-pack/plugins/infra/public/pages/metrics/hosts/components/host_details_flyout/links/link_to_uptime.tsx @@ -0,0 +1,47 @@ +/* + * 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 React from 'react'; +import { EuiLink, EuiIcon, useEuiTheme } from '@elastic/eui'; +import { css } from '@emotion/react'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { uptimeOverviewLocatorID } from '@kbn/observability-plugin/public'; +import { useKibanaContextForPlugin } from '../../../../../../hooks/use_kibana'; +import type { InventoryItemType } from '../../../../../../../common/inventory_models/types'; +import type { HostNodeRow } from '../../../hooks/use_hosts_table'; + +interface LinkTUptimeProps { + nodeType: InventoryItemType; + node: HostNodeRow; +} + +export const LinkToUptime = ({ nodeType, node }: LinkTUptimeProps) => { + const { share } = useKibanaContextForPlugin().services; + const { euiTheme } = useEuiTheme(); + + return ( + + share.url.locators + .get(uptimeOverviewLocatorID)! + .navigate({ [nodeType]: node.name, ip: node.ip }) + } + > + + + + ); +}; diff --git a/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_hosts_table.test.ts b/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_hosts_table.test.ts index 26622f57fd581..0085b9b923140 100644 --- a/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_hosts_table.test.ts +++ b/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_hosts_table.test.ts @@ -73,6 +73,7 @@ describe('useHostTable hook', () => { { name: 'host-0', os: '-', + ip: '', id: 'host-0-0', title: { cloudProvider: 'aws', @@ -103,6 +104,7 @@ describe('useHostTable hook', () => { { name: 'host-1', os: 'macOS', + ip: '243.86.94.22', id: 'host-1-1', title: { cloudProvider: null, diff --git a/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_hosts_table.tsx b/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_hosts_table.tsx index 5127c4f9251e8..a898c46316648 100644 --- a/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_hosts_table.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_hosts_table.tsx @@ -31,6 +31,7 @@ type HostMetrics = Record; export interface HostNodeRow extends HostMetrics { os?: string | null; + ip?: string | null; servicesOnHost?: number | null; title: { name: string; cloudProvider?: CloudProvider | null }; name: string; @@ -53,6 +54,7 @@ const buildItemsList = (nodes: SnapshotNode[]) => { id: `${name}-${index}`, name, os: path.at(-1)?.os ?? '-', + ip: path.at(-1)?.ip ?? '', title: { name, cloudProvider: path.at(-1)?.cloudProvider ?? null, diff --git a/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts b/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts index 7812b55e78b11..856575370dce5 100644 --- a/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts +++ b/x-pack/plugins/infra/server/lib/alerting/log_threshold/log_threshold_executor.ts @@ -27,6 +27,7 @@ import { addSpaceIdToPath } from '@kbn/spaces-plugin/common'; import { ParsedTechnicalFields } from '@kbn/rule-registry-plugin/common'; import { ParsedExperimentalFields } from '@kbn/rule-registry-plugin/common/parse_experimental_fields'; import { ecsFieldMap } from '@kbn/rule-registry-plugin/common/assets/field_maps/ecs_field_map'; +import { getChartGroupNames } from '../../../../common/utils/get_chart_group_names'; import { RuleParams, ruleParamsRT, @@ -484,7 +485,7 @@ const getReducedGroupByResults = ( ): ReducedGroupByResults => { const getGroupName = ( key: GroupedSearchQueryResponse['aggregations']['groups']['buckets'][0]['key'] - ) => Object.values(key).join(', '); + ) => getChartGroupNames(Object.values(key)); const reducedGroupByResults: ReducedGroupByResults = []; if (isOptimizedGroupedSearchQueryResponse(results)) { diff --git a/x-pack/plugins/infra/tsconfig.json b/x-pack/plugins/infra/tsconfig.json index 74d80b00d45e5..568a34ec452c9 100644 --- a/x-pack/plugins/infra/tsconfig.json +++ b/x-pack/plugins/infra/tsconfig.json @@ -59,6 +59,7 @@ "@kbn/shared-ux-prompt-not-found", "@kbn/shared-ux-router", "@kbn/shared-ux-link-redirect-app", + "@kbn/observability-alert-details", "@kbn/actions-plugin", "@kbn/ui-theme" ], diff --git a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/index.ts b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/index.ts index bf9ac7006e1c2..27f19e6c6cf9a 100644 --- a/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/index.ts +++ b/x-pack/plugins/ingest_pipelines/public/application/components/pipeline_editor/components/processor_form/processors/index.ts @@ -5,6 +5,8 @@ * 2.0. */ +// please try to keep this list sorted by module name (e.g. './bar' before './foo') + export { Append } from './append'; export { Bytes } from './bytes'; export { Circle } from './circle'; @@ -38,12 +40,12 @@ export { Rename } from './rename'; export { Script } from './script'; export { SetProcessor } from './set'; export { SetSecurityUser } from './set_security_user'; -export { Split } from './split'; export { Sort } from './sort'; +export { Split } from './split'; export { Trim } from './trim'; export { Uppercase } from './uppercase'; +export { UriParts } from './uri_parts'; export { UrlDecode } from './url_decode'; export { UserAgent } from './user_agent'; -export { UriParts } from './uri_parts'; export type { FormFieldsComponent } from './shared'; diff --git a/x-pack/plugins/lens/public/embeddable/embeddable.test.tsx b/x-pack/plugins/lens/public/embeddable/embeddable.test.tsx index 787c6766592ab..c127e9f1130d3 100644 --- a/x-pack/plugins/lens/public/embeddable/embeddable.test.tsx +++ b/x-pack/plugins/lens/public/embeddable/embeddable.test.tsx @@ -13,6 +13,7 @@ import { LensByReferenceInput, LensSavedObjectAttributes, LensUnwrapResult, + LensEmbeddableDeps, } from './embeddable'; import { ReactExpressionRendererProps } from '@kbn/expressions-plugin/public'; import { spacesPluginMock } from '@kbn/spaces-plugin/public/mocks'; @@ -149,49 +150,53 @@ describe('embeddable', () => { mountpoint.remove(); }); + function getEmbeddableProps(props: Partial = {}): LensEmbeddableDeps { + return { + timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, + attributeService, + data: dataMock, + uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, + inspector: inspectorPluginMock.createStartContract(), + expressionRenderer, + coreStart: {} as CoreStart, + basePath, + dataViews: { + get: (id: string) => Promise.resolve({ id, isTimeBased: () => false }), + } as unknown as DataViewsContract, + capabilities: { + canSaveDashboards: true, + canSaveVisualizations: true, + discover: {}, + navLinks: {}, + }, + getTrigger, + visualizationMap: defaultVisualizationMap, + datasourceMap: defaultDatasourceMap, + injectFilterReferences: jest.fn(mockInjectFilterReferences), + theme: themeServiceMock.createStartContract(), + documentToExpression: () => + Promise.resolve({ + ast: { + type: 'expression', + chain: [ + { type: 'function', function: 'my', arguments: {} }, + { type: 'function', function: 'expression', arguments: {} }, + ], + }, + indexPatterns: {}, + indexPatternRefs: [], + }), + ...props, + }; + } + it('should render expression once with expression renderer', async () => { - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - inspector: inspectorPluginMock.createStartContract(), - getTrigger, - theme: themeServiceMock.createStartContract(), - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, + const embeddable = new Embeddable(getEmbeddableProps(), { + timeRange: { + from: 'now-15m', + to: 'now', }, - { - timeRange: { - from: 'now-15m', - to: 'now', - }, - } as LensEmbeddableInput - ); + } as LensEmbeddableInput); embeddable.render(mountpoint); // wait one tick to give embeddable time to initialize @@ -203,48 +208,12 @@ describe('embeddable', () => { }); it('should not throw if render is called after destroy', async () => { - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - inspector: inspectorPluginMock.createStartContract(), - getTrigger, - theme: themeServiceMock.createStartContract(), - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, + const embeddable = new Embeddable(getEmbeddableProps(), { + timeRange: { + from: 'now-15m', + to: 'now', }, - { - timeRange: { - from: 'now-15m', - to: 'now', - }, - } as LensEmbeddableInput - ); + } as LensEmbeddableInput); let renderCalled = false; let renderThrew = false; // destroying completes output synchronously which might make a synchronous render call - this shouldn't throw @@ -263,48 +232,12 @@ describe('embeddable', () => { }); it('should render once even if reload is called before embeddable is fully initialized', async () => { - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - dataViews: {} as DataViewsContract, - inspector: inspectorPluginMock.createStartContract(), - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), + const embeddable = new Embeddable(getEmbeddableProps(), { + timeRange: { + from: 'now-15m', + to: 'now', }, - { - timeRange: { - from: 'now-15m', - to: 'now', - }, - } as LensEmbeddableInput - ); + } as LensEmbeddableInput); await embeddable.reload(); expect(expressionRenderer).toHaveBeenCalledTimes(0); embeddable.render(mountpoint); @@ -317,43 +250,7 @@ describe('embeddable', () => { }); it('should not render the visualization if any error arises', async () => { - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - {} as LensEmbeddableInput - ); + const embeddable = new Embeddable(getEmbeddableProps(), {} as LensEmbeddableInput); jest.spyOn(embeddable, 'getUserMessages').mockReturnValue([ { @@ -393,41 +290,10 @@ describe('embeddable', () => { <>getEmbeddableLegacyUrlConflict )); const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - inspector: inspectorPluginMock.createStartContract(), - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - dataViews: {} as DataViewsContract, + getEmbeddableProps({ spaces: spacesPluginStart, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, + attributeService, + }), {} as LensEmbeddableInput ); await embeddable.initializeSavedVis({} as LensEmbeddableInput); @@ -437,14 +303,50 @@ describe('embeddable', () => { }); it('should not render if timeRange prop is not passed when a referenced data view is time based', async () => { - attributeService = attributeServiceMockFromSavedVis({ - ...savedVis, - references: [ - { type: 'index-pattern', id: '123', name: 'abc' }, - { type: 'index-pattern', id: '123', name: 'def' }, - { type: 'index-pattern', id: '456', name: 'ghi' }, - ], - }); + const embeddable = new Embeddable( + getEmbeddableProps({ + attributeService: attributeServiceMockFromSavedVis({ + ...savedVis, + references: [ + { type: 'index-pattern', id: '123', name: 'abc' }, + { type: 'index-pattern', id: '123', name: 'def' }, + { type: 'index-pattern', id: '456', name: 'ghi' }, + ], + }), + dataViews: { + get: (id: string) => Promise.resolve({ id, isTimeBased: () => true }), + } as unknown as DataViewsContract, + }), + {} as LensEmbeddableInput + ); + await embeddable.initializeSavedVis({} as LensEmbeddableInput); + embeddable.render(mountpoint); + expect(expressionRenderer).toHaveBeenCalledTimes(0); + }); + + it('should initialize output with deduped list of index patterns', async () => { + const embeddable = new Embeddable( + getEmbeddableProps({ + attributeService: attributeServiceMockFromSavedVis({ + ...savedVis, + references: [ + { type: 'index-pattern', id: '123', name: 'abc' }, + { type: 'index-pattern', id: '123', name: 'def' }, + { type: 'index-pattern', id: '456', name: 'ghi' }, + ], + }), + }), + {} as LensEmbeddableInput + ); + + await embeddable.initializeSavedVis({} as LensEmbeddableInput); + const outputIndexPatterns = embeddable.getOutput().indexPatterns!; + expect(outputIndexPatterns.length).toEqual(2); + expect(outputIndexPatterns[0].id).toEqual('123'); + expect(outputIndexPatterns[1].id).toEqual('456'); + }); + + it('should re-render once on filter change', async () => { const embeddable = new Embeddable( { timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, @@ -455,9 +357,7 @@ describe('embeddable', () => { coreStart: {} as CoreStart, basePath, inspector: inspectorPluginMock.createStartContract(), - dataViews: { - get: (id: string) => Promise.resolve({ id, isTimeBased: jest.fn(() => true) }), - } as unknown as DataViewsContract, + dataViews: {} as DataViewsContract, capabilities: { canSaveDashboards: true, canSaveVisualizations: true, @@ -482,22 +382,23 @@ describe('embeddable', () => { indexPatternRefs: [], }), }, - {} as LensEmbeddableInput + { id: '123' } as LensEmbeddableInput ); - await embeddable.initializeSavedVis({} as LensEmbeddableInput); + await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); embeddable.render(mountpoint); - expect(expressionRenderer).toHaveBeenCalledTimes(0); - }); - it('should initialize output with deduped list of index patterns', async () => { - attributeService = attributeServiceMockFromSavedVis({ - ...savedVis, - references: [ - { type: 'index-pattern', id: '123', name: 'abc' }, - { type: 'index-pattern', id: '123', name: 'def' }, - { type: 'index-pattern', id: '456', name: 'ghi' }, - ], + expect(expressionRenderer).toHaveBeenCalledTimes(1); + + embeddable.updateInput({ + filters: [{ meta: { alias: 'test', negate: false, disabled: false } }], }); + + await new Promise((resolve) => setTimeout(resolve, 0)); + + expect(expressionRenderer).toHaveBeenCalledTimes(2); + }); + + it('should re-render once on search session change', async () => { const embeddable = new Embeddable( { timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, @@ -508,9 +409,7 @@ describe('embeddable', () => { coreStart: {} as CoreStart, basePath, inspector: inspectorPluginMock.createStartContract(), - dataViews: { - get: (id: string) => Promise.resolve({ id, isTimeBased: () => false }), - } as unknown as DataViewsContract, + dataViews: {} as DataViewsContract, capabilities: { canSaveDashboards: true, canSaveVisualizations: true, @@ -535,104 +434,7 @@ describe('embeddable', () => { indexPatternRefs: [], }), }, - {} as LensEmbeddableInput - ); - await embeddable.initializeSavedVis({} as LensEmbeddableInput); - const outputIndexPatterns = embeddable.getOutput().indexPatterns!; - expect(outputIndexPatterns.length).toEqual(2); - expect(outputIndexPatterns[0].id).toEqual('123'); - expect(outputIndexPatterns[1].id).toEqual('456'); - }); - - it('should re-render once on filter change', async () => { - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123' } as LensEmbeddableInput - ); - await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); - embeddable.render(mountpoint); - - expect(expressionRenderer).toHaveBeenCalledTimes(1); - - embeddable.updateInput({ - filters: [{ meta: { alias: 'test', negate: false, disabled: false } }], - }); - - await new Promise((resolve) => setTimeout(resolve, 0)); - - expect(expressionRenderer).toHaveBeenCalledTimes(2); - }); - - it('should re-render once on search session change', async () => { - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123', searchSessionId: 'firstSession' } as LensEmbeddableInput + { id: '123', searchSessionId: 'firstSession' } as LensEmbeddableInput ); await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); embeddable.render(mountpoint); @@ -659,43 +461,7 @@ describe('embeddable', () => { dynamicActions: {}, }, } as unknown as LensEmbeddableInput; - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123' } as LensEmbeddableInput - ); + const embeddable = new Embeddable(getEmbeddableProps(), { id: '123' } as LensEmbeddableInput); await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); embeddable.render(mountpoint); @@ -716,43 +482,7 @@ describe('embeddable', () => { }); it('should re-render when dynamic actions input changes', async () => { - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123' } as LensEmbeddableInput - ); + const embeddable = new Embeddable(getEmbeddableProps(), { id: '123' } as LensEmbeddableInput); await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); embeddable.render(mountpoint); @@ -780,43 +510,7 @@ describe('embeddable', () => { searchSessionId: 'searchSessionId', } as LensEmbeddableInput; - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - input - ); + const embeddable = new Embeddable(getEmbeddableProps(), input); await embeddable.initializeSavedVis(input); embeddable.render(mountpoint); @@ -845,43 +539,7 @@ describe('embeddable', () => { disableTriggers: true, } as LensEmbeddableInput; - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - input - ); + const embeddable = new Embeddable(getEmbeddableProps(), input); await embeddable.initializeSavedVis(input); embeddable.render(mountpoint); @@ -909,45 +567,11 @@ describe('embeddable', () => { }, references: [{ type: 'index-pattern', name: 'filter-0', id: 'my-index-pattern-id' }], }; - attributeService = attributeServiceMockFromSavedVis(newSavedVis); const input = { savedObjectId: '123', timeRange, query, filters } as LensEmbeddableInput; const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: { get: jest.fn() } as unknown as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, + getEmbeddableProps({ attributeService: attributeServiceMockFromSavedVis(newSavedVis) }), input ); await embeddable.initializeSavedVis(input); @@ -966,43 +590,7 @@ describe('embeddable', () => { }); it('should execute trigger on event from expression renderer', async () => { - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123' } as LensEmbeddableInput - ); + const embeddable = new Embeddable(getEmbeddableProps(), { id: '123' } as LensEmbeddableInput); await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); embeddable.render(mountpoint); @@ -1012,104 +600,37 @@ describe('embeddable', () => { onEvent({ name: 'brush', data: eventData }); expect(getTrigger).toHaveBeenCalledWith(VIS_EVENT_TO_TRIGGER.brush); - expect(trigger.exec).toHaveBeenCalledWith( - expect.objectContaining({ - data: { ...eventData, timeFieldName: undefined }, - embeddable: expect.anything(), - }) - ); - }); - - it('should execute trigger on row click event from expression renderer', async () => { - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123' } as LensEmbeddableInput - ); - await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); - embeddable.render(mountpoint); - - const onEvent = expressionRenderer.mock.calls[0][0].onEvent!; - - onEvent({ name: 'tableRowContextMenuClick', data: {} }); - - expect(getTrigger).toHaveBeenCalledWith(VIS_EVENT_TO_TRIGGER.tableRowContextMenuClick); - }); - - it('should not re-render if only change is in disabled filter', async () => { - const timeRange: TimeRange = { from: 'now-15d', to: 'now' }; - const query: Query = { language: 'kquery', query: '' }; - const filters: Filter[] = [{ meta: { alias: 'test', negate: false, disabled: true } }]; - - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123', timeRange, query, filters } as LensEmbeddableInput + expect(trigger.exec).toHaveBeenCalledWith( + expect.objectContaining({ + data: { ...eventData, timeFieldName: undefined }, + embeddable: expect.anything(), + }) ); + }); + + it('should execute trigger on row click event from expression renderer', async () => { + const embeddable = new Embeddable(getEmbeddableProps(), { id: '123' } as LensEmbeddableInput); + await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); + embeddable.render(mountpoint); + + const onEvent = expressionRenderer.mock.calls[0][0].onEvent!; + + onEvent({ name: 'tableRowContextMenuClick', data: {} }); + + expect(getTrigger).toHaveBeenCalledWith(VIS_EVENT_TO_TRIGGER.tableRowContextMenuClick); + }); + + it('should not re-render if only change is in disabled filter', async () => { + const timeRange: TimeRange = { from: 'now-15d', to: 'now' }; + const query: Query = { language: 'kquery', query: '' }; + const filters: Filter[] = [{ meta: { alias: 'test', negate: false, disabled: true } }]; + + const embeddable = new Embeddable(getEmbeddableProps(), { + id: '123', + timeRange, + query, + filters, + } as LensEmbeddableInput); await embeddable.initializeSavedVis({ id: '123', timeRange, @@ -1142,43 +663,10 @@ describe('embeddable', () => { return null; }); - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123', onLoad } as unknown as LensEmbeddableInput - ); + const embeddable = new Embeddable(getEmbeddableProps({ expressionRenderer }), { + id: '123', + onLoad, + } as unknown as LensEmbeddableInput); await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); embeddable.render(mountpoint); @@ -1226,43 +714,10 @@ describe('embeddable', () => { return null; }); - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123', onFilter } as unknown as LensEmbeddableInput - ); + const embeddable = new Embeddable(getEmbeddableProps({ expressionRenderer }), { + id: '123', + onFilter, + } as unknown as LensEmbeddableInput); await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); embeddable.render(mountpoint); @@ -1273,6 +728,33 @@ describe('embeddable', () => { expect(onFilter).toHaveBeenCalledTimes(1); }); + it('should prevent the onFilter trigger when calling preventDefault', async () => { + const onFilter = jest.fn(({ preventDefault }) => preventDefault()); + + expressionRenderer = jest.fn(({ onEvent }) => { + setTimeout(() => { + onEvent?.({ + name: 'filter', + data: { pings: false, table: { rows: [], columns: [] }, column: 0 }, + }); + }, 10); + + return null; + }); + + const embeddable = new Embeddable(getEmbeddableProps({ expressionRenderer }), { + id: '123', + onFilter, + } as unknown as LensEmbeddableInput); + + await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); + embeddable.render(mountpoint); + + await new Promise((resolve) => setTimeout(resolve, 20)); + + expect(getTrigger).not.toHaveBeenCalled(); + }); + it('should call onBrush event on brushing', async () => { const onBrushEnd = jest.fn(); @@ -1287,43 +769,10 @@ describe('embeddable', () => { return null; }); - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123', onBrushEnd } as unknown as LensEmbeddableInput - ); + const embeddable = new Embeddable(getEmbeddableProps({ expressionRenderer }), { + id: '123', + onBrushEnd, + } as unknown as LensEmbeddableInput); await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); embeddable.render(mountpoint); @@ -1334,6 +783,33 @@ describe('embeddable', () => { expect(onBrushEnd).toHaveBeenCalledTimes(1); }); + it('should prevent the onBrush trigger when calling preventDefault', async () => { + const onBrushEnd = jest.fn(({ preventDefault }) => preventDefault()); + + expressionRenderer = jest.fn(({ onEvent }) => { + setTimeout(() => { + onEvent?.({ + name: 'brush', + data: { range: [0, 1], table: { rows: [], columns: [] }, column: 0 }, + }); + }, 10); + + return null; + }); + + const embeddable = new Embeddable(getEmbeddableProps({ expressionRenderer }), { + id: '123', + onBrushEnd, + } as unknown as LensEmbeddableInput); + + await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); + embeddable.render(mountpoint); + + await new Promise((resolve) => setTimeout(resolve, 20)); + + expect(getTrigger).not.toHaveBeenCalled(); + }); + it('should call onTableRowClick event ', async () => { const onTableRowClick = jest.fn(); @@ -1345,53 +821,44 @@ describe('embeddable', () => { return null; }); - const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, - attributeService, - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - visualizationMap: defaultVisualizationMap, - datasourceMap: defaultDatasourceMap, - injectFilterReferences: jest.fn(mockInjectFilterReferences), - theme: themeServiceMock.createStartContract(), - documentToExpression: () => - Promise.resolve({ - ast: { - type: 'expression', - chain: [ - { type: 'function', function: 'my', arguments: {} }, - { type: 'function', function: 'expression', arguments: {} }, - ], - }, - indexPatterns: {}, - indexPatternRefs: [], - }), - }, - { id: '123', onTableRowClick } as unknown as LensEmbeddableInput - ); + const embeddable = new Embeddable(getEmbeddableProps({ expressionRenderer }), { + id: '123', + onTableRowClick, + } as unknown as LensEmbeddableInput); await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); embeddable.render(mountpoint); await new Promise((resolve) => setTimeout(resolve, 20)); - expect(onTableRowClick).toHaveBeenCalledWith({ name: 'test' }); + expect(onTableRowClick).toHaveBeenCalledWith(expect.objectContaining({ name: 'test' })); expect(onTableRowClick).toHaveBeenCalledTimes(1); }); + it('should prevent onTableRowClick trigger when calling preventDefault ', async () => { + const onTableRowClick = jest.fn(({ preventDefault }) => preventDefault()); + + expressionRenderer = jest.fn(({ onEvent }) => { + setTimeout(() => { + onEvent?.({ name: 'tableRowContextMenuClick', data: { name: 'test' } }); + }, 10); + + return null; + }); + + const embeddable = new Embeddable(getEmbeddableProps({ expressionRenderer }), { + id: '123', + onTableRowClick, + } as unknown as LensEmbeddableInput); + + await embeddable.initializeSavedVis({ id: '123' } as LensEmbeddableInput); + embeddable.render(mountpoint); + + await new Promise((resolve) => setTimeout(resolve, 20)); + + expect(getTrigger).not.toHaveBeenCalled(); + }); + it('handles edit actions ', async () => { const editedVisualizationState = { value: 'edited' }; const onEditActionMock = jest.fn().mockReturnValue(editedVisualizationState); @@ -1426,34 +893,16 @@ describe('embeddable', () => { }; const embeddable = new Embeddable( - { - timefilter: dataPluginMock.createSetupContract().query.timefilter.timefilter, + getEmbeddableProps({ attributeService: attributeServiceMockFromSavedVis(visDocument), - data: dataMock, - uiSettings: { get: () => undefined } as unknown as IUiSettingsClient, - expressionRenderer, - coreStart: {} as CoreStart, - basePath, - inspector: inspectorPluginMock.createStartContract(), - dataViews: {} as DataViewsContract, - capabilities: { - canSaveDashboards: true, - canSaveVisualizations: true, - discover: {}, - navLinks: {}, - }, - getTrigger, - theme: themeServiceMock.createStartContract(), - injectFilterReferences: jest.fn(mockInjectFilterReferences), visualizationMap: { [visDocument.visualizationType as string]: { onEditAction: onEditActionMock, initialize: () => {}, } as unknown as Visualization, }, - datasourceMap: defaultDatasourceMap, documentToExpression: documentToExpressionMock, - }, + }), { id: '123' } as unknown as LensEmbeddableInput ); diff --git a/x-pack/plugins/lens/public/embeddable/embeddable.tsx b/x-pack/plugins/lens/public/embeddable/embeddable.tsx index 519db972ca855..0f8594347a34b 100644 --- a/x-pack/plugins/lens/public/embeddable/embeddable.tsx +++ b/x-pack/plugins/lens/public/embeddable/embeddable.tsx @@ -138,6 +138,12 @@ export interface LensUnwrapResult { metaInfo?: LensUnwrapMetaInfo; } +interface PreventableEvent { + preventDefault(): void; +} + +export type Simplify = { [KeyType in keyof T]: T[KeyType] } & {}; + interface LensBaseEmbeddableInput extends EmbeddableInput { filters?: Filter[]; query?: Query; @@ -148,10 +154,14 @@ interface LensBaseEmbeddableInput extends EmbeddableInput { style?: React.CSSProperties; className?: string; noPadding?: boolean; - onBrushEnd?: (data: BrushTriggerEvent['data']) => void; + onBrushEnd?: (data: Simplify) => void; onLoad?: (isLoading: boolean, adapters?: Partial) => void; - onFilter?: (data: ClickTriggerEvent['data'] | MultiClickTriggerEvent['data']) => void; - onTableRowClick?: (data: LensTableRowContextMenuEvent['data']) => void; + onFilter?: ( + data: Simplify<(ClickTriggerEvent['data'] | MultiClickTriggerEvent['data']) & PreventableEvent> + ) => void; + onTableRowClick?: ( + data: Simplify + ) => void; } export type LensByValueInput = { @@ -1102,45 +1112,68 @@ export class Embeddable return; } if (isLensBrushEvent(event)) { - this.deps.getTrigger(VIS_EVENT_TO_TRIGGER[event.name]).exec({ - data: { - ...event.data, - timeFieldName: - event.data.timeFieldName || - inferTimeField(this.deps.data.datatableUtilities, event.data), - }, - embeddable: this, - }); - + let shouldExecuteDefaultTriggers = true; if (this.input.onBrushEnd) { - this.input.onBrushEnd(event.data); + this.input.onBrushEnd({ + ...event.data, + preventDefault: () => { + shouldExecuteDefaultTriggers = false; + }, + }); + } + if (shouldExecuteDefaultTriggers) { + this.deps.getTrigger(VIS_EVENT_TO_TRIGGER[event.name]).exec({ + data: { + ...event.data, + timeFieldName: + event.data.timeFieldName || + inferTimeField(this.deps.data.datatableUtilities, event.data), + }, + embeddable: this, + }); } } if (isLensFilterEvent(event) || isLensMultiFilterEvent(event)) { - this.deps.getTrigger(VIS_EVENT_TO_TRIGGER[event.name]).exec({ - data: { - ...event.data, - timeFieldName: - event.data.timeFieldName || - inferTimeField(this.deps.data.datatableUtilities, event.data), - }, - embeddable: this, - }); + let shouldExecuteDefaultTriggers = true; if (this.input.onFilter) { - this.input.onFilter(event.data); + this.input.onFilter({ + ...event.data, + preventDefault: () => { + shouldExecuteDefaultTriggers = false; + }, + }); + } + if (shouldExecuteDefaultTriggers) { + this.deps.getTrigger(VIS_EVENT_TO_TRIGGER[event.name]).exec({ + data: { + ...event.data, + timeFieldName: + event.data.timeFieldName || + inferTimeField(this.deps.data.datatableUtilities, event.data), + }, + embeddable: this, + }); } } if (isLensTableRowContextMenuClickEvent(event)) { - this.deps.getTrigger(VIS_EVENT_TO_TRIGGER[event.name]).exec( - { - data: event.data, - embeddable: this, - }, - true - ); + let shouldExecuteDefaultTriggers = true; if (this.input.onTableRowClick) { - this.input.onTableRowClick(event.data as unknown as LensTableRowContextMenuEvent['data']); + this.input.onTableRowClick({ + ...event.data, + preventDefault: () => { + shouldExecuteDefaultTriggers = false; + }, + }); + } + if (shouldExecuteDefaultTriggers) { + this.deps.getTrigger(VIS_EVENT_TO_TRIGGER[event.name]).exec( + { + data: event.data, + embeddable: this, + }, + true + ); } } diff --git a/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/shared/icon_select.tsx b/x-pack/plugins/lens/public/shared_components/icon_select/icon_select.tsx similarity index 100% rename from x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/shared/icon_select.tsx rename to x-pack/plugins/lens/public/shared_components/icon_select/icon_select.tsx diff --git a/x-pack/plugins/lens/public/shared_components/index.ts b/x-pack/plugins/lens/public/shared_components/index.ts index 1b2b9e52a1eee..95000c5c4248b 100644 --- a/x-pack/plugins/lens/public/shared_components/index.ts +++ b/x-pack/plugins/lens/public/shared_components/index.ts @@ -41,3 +41,4 @@ export { DimensionEditorSection } from './dimension_section'; export { FilterQueryInput } from './filter_query_input'; export * from './static_header'; export * from './vis_label'; +export { IconSelect } from './icon_select/icon_select'; diff --git a/x-pack/plugins/lens/public/visualizations/metric/dimension_editor.test.tsx b/x-pack/plugins/lens/public/visualizations/metric/dimension_editor.test.tsx index b45eef4ec379e..346b89666dc22 100644 --- a/x-pack/plugins/lens/public/visualizations/metric/dimension_editor.test.tsx +++ b/x-pack/plugins/lens/public/visualizations/metric/dimension_editor.test.tsx @@ -74,6 +74,7 @@ describe('dimension editor', () => { maxCols: 5, color: 'static-color', palette, + icon: 'tag', showBar: true, trendlineLayerId: 'second', trendlineLayerType: 'metricTrendline', diff --git a/x-pack/plugins/lens/public/visualizations/metric/dimension_editor.tsx b/x-pack/plugins/lens/public/visualizations/metric/dimension_editor.tsx index 6571e1bb2c7d6..a1180e0055eb2 100644 --- a/x-pack/plugins/lens/public/visualizations/metric/dimension_editor.tsx +++ b/x-pack/plugins/lens/public/visualizations/metric/dimension_editor.tsx @@ -38,6 +38,7 @@ import { applyPaletteParams, PalettePanelContainer, useDebouncedValue, + IconSelect, } from '../../shared_components'; import type { VisualizationDimensionEditorProps } from '../../types'; import { defaultNumberPaletteParams, defaultPercentagePaletteParams } from './palette_config'; @@ -49,6 +50,7 @@ import { } from './visualization'; import { CollapseSetting } from '../../shared_components/collapse_setting'; import { DebouncedInput } from '../../shared_components/debounced_input'; +import { iconsSet } from './icon_set'; export type SupportingVisType = 'none' | 'bar' | 'trendline'; @@ -381,6 +383,24 @@ function PrimaryMetricEditor(props: SubProps) { )} + + { + setState({ + ...state, + icon: newIcon, + }); + }} + /> + ); } diff --git a/x-pack/plugins/lens/public/visualizations/metric/icon_set.ts b/x-pack/plugins/lens/public/visualizations/metric/icon_set.ts new file mode 100644 index 0000000000000..c21e6809dd0b4 --- /dev/null +++ b/x-pack/plugins/lens/public/visualizations/metric/icon_set.ts @@ -0,0 +1,118 @@ +/* + * 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 { i18n } from '@kbn/i18n'; +import { AvailableMetricIcon } from '@kbn/expression-metric-vis-plugin/common'; +import { IconSet } from '../../shared_components/icon_select/icon_select'; + +export const iconsSet: IconSet = [ + { + value: 'empty', + label: i18n.translate('xpack.lens.metric.iconSelect.noIconLabel', { + defaultMessage: 'None', + }), + }, + { + value: 'sortUp', + label: i18n.translate('xpack.lens.metric.iconSelect.sortUpLabel', { + defaultMessage: 'Sort up', + }), + }, + { + value: 'sortDown', + label: i18n.translate('xpack.lens.metric.iconSelect.sortDownLabel', { + defaultMessage: 'Sort down', + }), + }, + { + value: 'compute', + label: i18n.translate('xpack.lens.metric.iconSelect.computeLabel', { + defaultMessage: 'Compute', + }), + }, + { + value: 'globe', + label: i18n.translate('xpack.lens.metric.iconSelect.globeLabel', { + defaultMessage: 'Globe', + }), + }, + { + value: 'temperature', + label: i18n.translate('xpack.lens.metric.iconSelect.temperatureLabel', { + defaultMessage: 'Temperature', + }), + }, + { + value: 'asterisk', + label: i18n.translate('xpack.lens.metric.iconSelect.asteriskIconLabel', { + defaultMessage: 'Asterisk', + }), + }, + { + value: 'alert', + label: i18n.translate('xpack.lens.metric.iconSelect.alertIconLabel', { + defaultMessage: 'Alert', + }), + }, + { + value: 'bell', + label: i18n.translate('xpack.lens.metric.iconSelect.bellIconLabel', { + defaultMessage: 'Bell', + }), + }, + { + value: 'bolt', + label: i18n.translate('xpack.lens.metric.iconSelect.boltIconLabel', { + defaultMessage: 'Bolt', + }), + }, + { + value: 'bug', + label: i18n.translate('xpack.lens.metric.iconSelect.bugIconLabel', { + defaultMessage: 'Bug', + }), + }, + + { + value: 'editorComment', + label: i18n.translate('xpack.lens.metric.iconSelect.commentIconLabel', { + defaultMessage: 'Comment', + }), + }, + { + value: 'flag', + label: i18n.translate('xpack.lens.metric.iconSelect.flagIconLabel', { + defaultMessage: 'Flag', + }), + }, + { + value: 'heart', + label: i18n.translate('xpack.lens.metric.iconSelect.heartLabel', { defaultMessage: 'Heart' }), + }, + { + value: 'mapMarker', + label: i18n.translate('xpack.lens.metric.iconSelect.mapMarkerLabel', { + defaultMessage: 'Map Marker', + }), + }, + { + value: 'pin', + label: i18n.translate('xpack.lens.metric.iconSelect.mapPinLabel', { + defaultMessage: 'Map Pin', + }), + }, + { + value: 'starEmpty', + label: i18n.translate('xpack.lens.metric.iconSelect.starLabel', { defaultMessage: 'Star' }), + }, + { + value: 'tag', + label: i18n.translate('xpack.lens.metric.iconSelect.tagIconLabel', { + defaultMessage: 'Tag', + }), + }, +]; diff --git a/x-pack/plugins/lens/public/visualizations/metric/to_expression.ts b/x-pack/plugins/lens/public/visualizations/metric/to_expression.ts index 1326f5369cbd2..b2367bb7c1fc8 100644 --- a/x-pack/plugins/lens/public/visualizations/metric/to_expression.ts +++ b/x-pack/plugins/lens/public/visualizations/metric/to_expression.ts @@ -143,6 +143,7 @@ export const toExpression = ( subtitle: state.subtitle ?? undefined, progressDirection: state.progressDirection as LayoutDirection, color: state.color || getDefaultColor(state), + icon: state.icon, palette: state.palette?.params ? [ paletteService diff --git a/x-pack/plugins/lens/public/visualizations/metric/toolbar.test.tsx b/x-pack/plugins/lens/public/visualizations/metric/toolbar.test.tsx index d40519037547b..81b2be0d66020 100644 --- a/x-pack/plugins/lens/public/visualizations/metric/toolbar.test.tsx +++ b/x-pack/plugins/lens/public/visualizations/metric/toolbar.test.tsx @@ -46,6 +46,7 @@ describe('metric toolbar', () => { progressDirection: 'vertical', maxCols: 5, color: 'static-color', + icon: 'compute', palette, showBar: true, trendlineLayerId: 'second', diff --git a/x-pack/plugins/lens/public/visualizations/metric/visualization.test.ts b/x-pack/plugins/lens/public/visualizations/metric/visualization.test.ts index 32f6ecf38ab8f..61bea94f43ed1 100644 --- a/x-pack/plugins/lens/public/visualizations/metric/visualization.test.ts +++ b/x-pack/plugins/lens/public/visualizations/metric/visualization.test.ts @@ -68,6 +68,7 @@ describe('metric visualization', () => { breakdownByAccessor: 'breakdown-col-id', collapseFn: 'sum', subtitle: 'subtitle', + icon: 'empty', secondaryPrefix: 'extra-text', progressDirection: 'vertical', maxCols: 5, @@ -303,6 +304,9 @@ describe('metric visualization', () => { "color": Array [ "static-color", ], + "icon": Array [ + "empty", + ], "inspectorTableId": Array [ "first", ], @@ -364,6 +368,9 @@ describe('metric visualization', () => { "color": Array [ "static-color", ], + "icon": Array [ + "empty", + ], "inspectorTableId": Array [ "first", ], @@ -746,6 +753,7 @@ describe('metric visualization', () => { it('clears a layer', () => { expect(visualization.clearLayer(fullState, 'some-id', 'indexPattern1')).toMatchInlineSnapshot(` Object { + "icon": "empty", "layerId": "first", "layerType": "data", } diff --git a/x-pack/plugins/lens/public/visualizations/metric/visualization.tsx b/x-pack/plugins/lens/public/visualizations/metric/visualization.tsx index a210b04a6e07c..b44f783cb83ef 100644 --- a/x-pack/plugins/lens/public/visualizations/metric/visualization.tsx +++ b/x-pack/plugins/lens/public/visualizations/metric/visualization.tsx @@ -61,6 +61,7 @@ export interface MetricVisualizationState { progressDirection?: LayoutDirection; showBar?: boolean; color?: string; + icon?: string; palette?: PaletteOutput; maxCols?: number; diff --git a/x-pack/plugins/lens/public/visualizations/xy/to_expression.ts b/x-pack/plugins/lens/public/visualizations/xy/to_expression.ts index 4e33e35371246..85bd512fa4480 100644 --- a/x-pack/plugins/lens/public/visualizations/xy/to_expression.ts +++ b/x-pack/plugins/lens/public/visualizations/xy/to_expression.ts @@ -49,7 +49,7 @@ import type { } from './types'; import type { OperationMetadata, DatasourcePublicAPI, DatasourceLayers } from '../../types'; import { getColumnToLabelMap } from './state_helpers'; -import { hasIcon } from './xy_config_panel/shared/icon_select'; +import { hasIcon } from '../../shared_components/icon_select/icon_select'; import { defaultReferenceLineColor } from './color_assignment'; import { getDefaultVisualValuesForLayer } from '../../shared_components/datasource_default_values'; import { diff --git a/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/annotations_config_panel/icon_set.ts b/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/annotations_config_panel/icon_set.ts index 45019dd204491..436bb84b92e7b 100644 --- a/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/annotations_config_panel/icon_set.ts +++ b/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/annotations_config_panel/icon_set.ts @@ -8,7 +8,7 @@ import { i18n } from '@kbn/i18n'; import { AvailableAnnotationIcon } from '@kbn/event-annotation-plugin/common'; import { IconTriangle, IconCircle } from '@kbn/chart-icons'; -import { IconSet } from '../shared/icon_select'; +import { IconSet } from '../../../../shared_components/icon_select/icon_select'; export const annotationsIconSet: IconSet = [ { diff --git a/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/reference_line_config_panel/icon_set.ts b/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/reference_line_config_panel/icon_set.ts index eda5d06cd3ef1..d64fde37ebd25 100644 --- a/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/reference_line_config_panel/icon_set.ts +++ b/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/reference_line_config_panel/icon_set.ts @@ -7,7 +7,7 @@ import { i18n } from '@kbn/i18n'; import { AvailableReferenceLineIcon } from '@kbn/expression-xy-plugin/common'; -import { IconSet } from '../shared/icon_select'; +import { IconSet } from '../../../../shared_components/icon_select/icon_select'; export const referenceLineIconsSet: IconSet = [ { diff --git a/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/shared/marker_decoration_settings.tsx b/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/shared/marker_decoration_settings.tsx index 4d70a99bc4192..8b7fba475dc2e 100644 --- a/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/shared/marker_decoration_settings.tsx +++ b/x-pack/plugins/lens/public/visualizations/xy/xy_config_panel/shared/marker_decoration_settings.tsx @@ -12,7 +12,11 @@ import { IconPosition } from '@kbn/expression-xy-plugin/common'; import { YAxisMode } from '../../types'; import { TooltipWrapper } from '../../../../shared_components'; -import { hasIcon, IconSelect, IconSet } from './icon_select'; +import { + hasIcon, + IconSelect, + IconSet, +} from '../../../../shared_components/icon_select/icon_select'; import { idPrefix } from '../dimension_editor'; interface LabelConfigurationOptions { diff --git a/x-pack/plugins/lens/readme.md b/x-pack/plugins/lens/readme.md index 9fec3f154fbf3..b3768ba0b2540 100644 --- a/x-pack/plugins/lens/readme.md +++ b/x-pack/plugins/lens/readme.md @@ -98,6 +98,22 @@ Filters and query `state.filters`/`state.query` define the visualization-global The `EmbeddableComponent` also takes a set of callbacks to react to user interactions with the embedded Lens visualization to integrate the visualization with the surrounding app: `onLoad`, `onBrushEnd`, `onFilter`, `onTableRowClick`. A common pattern is to keep state in the solution app which is updated within these callbacks - re-rendering the surrounding application will change the Lens attributes passed to the component which will re-render the visualization (including re-fetching data if necessary). +#### Preventing defaults + +In some scenarios it can be useful to customize the default behaviour and avoid the default Kibana triggers for a specific action, like add a filter on a bar chart/pie slice click. For this specific requirement the `data` object returned by the `onBrushEnd`, `onFilter`, `onTableRowClick` callbacks has a special `preventDefault()` function that will prevent other registered event triggers to execute: + +```tsx + { + // custom behaviour on "filter" event + ... + // now prevent to add a filter in Kibana + data.preventDefault(); + }} +/> +``` + ## Handling data views In most cases it makes sense to have a data view saved object to use the Lens embeddable. Use the data view service to find an existing data view for a given index pattern or create a new one if it doesn't exist yet: diff --git a/x-pack/plugins/maps/public/classes/layers/wizards/layer_wizard_registry.ts b/x-pack/plugins/maps/public/classes/layers/wizards/layer_wizard_registry.ts index 977b72c4a2aba..a5284fe0a5cbf 100644 --- a/x-pack/plugins/maps/public/classes/layers/wizards/layer_wizard_registry.ts +++ b/x-pack/plugins/maps/public/classes/layers/wizards/layer_wizard_registry.ts @@ -7,10 +7,23 @@ /* eslint-disable @typescript-eslint/consistent-type-definitions */ -import { ReactElement, FunctionComponent } from 'react'; +import { ReactElement, ReactNode, FunctionComponent } from 'react'; import type { LayerDescriptor } from '../../../../common/descriptor_types'; import { LAYER_WIZARD_CATEGORY } from '../../../../common/constants'; +export type RenderSecondaryActionButtonProps = { + isDisabled: boolean; + isLoading: boolean; + addLayersAndClose: () => void; +}; + +export type LayerWizardStep = { + id: string; + label: string; + nextButtonLabel?: string; + renderSecondaryActionButton?: (props: RenderSecondaryActionButtonProps) => ReactNode; +}; + export type LayerWizard = { id: string; title: string; @@ -24,7 +37,7 @@ export type LayerWizard = { description: string; icon: string | FunctionComponent; renderWizard(renderWizardArguments: RenderWizardArguments): ReactElement; - prerequisiteSteps?: Array<{ id: string; label: string }>; + prerequisiteSteps?: LayerWizardStep[]; disabledReason?: string; getIsDisabled?: () => Promise | boolean; isBeta?: boolean; diff --git a/x-pack/plugins/maps/public/components/ems_file_select.tsx b/x-pack/plugins/maps/public/components/ems_file_select.tsx index f2a409b8629b0..36f5b0c087516 100644 --- a/x-pack/plugins/maps/public/components/ems_file_select.tsx +++ b/x-pack/plugins/maps/public/components/ems_file_select.tsx @@ -98,7 +98,7 @@ export class EMSFileSelect extends Component { isClearable={false} singleSelection={true} isDisabled={this.state.emsFileOptions.length === 0} - data-test-subj="emsVectorComboBox" + data-test-subj="emsFileSelect" /> ); } diff --git a/x-pack/plugins/maps/public/connected_components/add_layer_panel/index.ts b/x-pack/plugins/maps/public/connected_components/add_layer_panel/index.ts index b790c0c1da5be..2bb6eaeadf156 100644 --- a/x-pack/plugins/maps/public/connected_components/add_layer_panel/index.ts +++ b/x-pack/plugins/maps/public/connected_components/add_layer_panel/index.ts @@ -39,7 +39,11 @@ function mapDispatchToProps(dispatch: ThunkDispatch { dispatch(addPreviewLayers(layerDescriptors)); }, - promotePreviewLayers: () => { + addLayersAndClose: () => { + dispatch(updateFlyout(FLYOUT_STATE.NONE)); + dispatch(promotePreviewLayers()); + }, + addLayersAndContinue: () => { dispatch(setFirstPreviewLayerToSelectedLayer()); dispatch(updateFlyout(FLYOUT_STATE.LAYER_PANEL)); dispatch(promotePreviewLayers()); diff --git a/x-pack/plugins/maps/public/connected_components/add_layer_panel/view.tsx b/x-pack/plugins/maps/public/connected_components/add_layer_panel/view.tsx index 578059b174454..0fd1100fba8c3 100644 --- a/x-pack/plugins/maps/public/connected_components/add_layer_panel/view.tsx +++ b/x-pack/plugins/maps/public/connected_components/add_layer_panel/view.tsx @@ -20,20 +20,36 @@ import { FormattedMessage } from '@kbn/i18n-react'; import { FlyoutBody } from './flyout_body'; import { LayerDescriptor } from '../../../common/descriptor_types'; import { LayerWizard } from '../../classes/layers'; -import { getWizardById } from '../../classes/layers/wizards/layer_wizard_registry'; +import { + type LayerWizardStep, + type RenderSecondaryActionButtonProps, + getWizardById, +} from '../../classes/layers/wizards/layer_wizard_registry'; export const ADD_LAYER_STEP_ID = 'ADD_LAYER_STEP_ID'; const ADD_LAYER_STEP_LABEL = i18n.translate('xpack.maps.addLayerPanel.addLayer', { defaultMessage: 'Add layer', }); -const SELECT_WIZARD_LABEL = ADD_LAYER_STEP_LABEL; +const ADD_LAYER_STEP_NEXT_BUTTON_LABEL = i18n.translate( + 'xpack.maps.addLayerPanel.addLayerNextButtonLabel', + { + defaultMessage: 'Add and continue', + } +); +const ADD_LAYER_STEP_SECONDARY_ACTION_BUTTON_LABEL = i18n.translate( + 'xpack.maps.addLayerPanel.addLayerSecondaryActionButtonLabel', + { + defaultMessage: 'Add and close', + } +); export interface Props { addPreviewLayers: (layerDescriptors: LayerDescriptor[]) => void; closeFlyout: () => void; hasPreviewLayers: boolean; isLoadingPreviewLayers: boolean; - promotePreviewLayers: () => void; + addLayersAndClose: () => void; + addLayersAndContinue: () => void; enableEditMode: () => void; autoOpenLayerWizardId: string; clearAutoOpenLayerWizardId: () => void; @@ -41,8 +57,8 @@ export interface Props { interface State { currentStepIndex: number; - currentStep: { id: string; label: string } | null; - layerSteps: Array<{ id: string; label: string }> | null; + currentStep: LayerWizardStep | null; + layerSteps: LayerWizardStep[] | null; layerWizard: LayerWizard | null; isNextStepBtnEnabled: boolean; isStepLoading: boolean; @@ -91,6 +107,22 @@ export class AddLayerPanel extends Component { { id: ADD_LAYER_STEP_ID, label: ADD_LAYER_STEP_LABEL, + nextButtonLabel: ADD_LAYER_STEP_NEXT_BUTTON_LABEL, + renderSecondaryActionButton: ({ + isDisabled, + isLoading, + addLayersAndClose, + }: RenderSecondaryActionButtonProps) => { + return ( + + {ADD_LAYER_STEP_SECONDARY_ACTION_BUTTON_LABEL} + + ); + }, }, ]; this.setState({ @@ -108,7 +140,7 @@ export class AddLayerPanel extends Component { if (this.state.layerSteps.length - 1 === this.state.currentStepIndex) { // last step - this.props.promotePreviewLayers(); + this.props.addLayersAndContinue(); if (this.state.layerWizard?.showFeatureEditTools) { this.props.enableEditMode(); } @@ -156,21 +188,40 @@ export class AddLayerPanel extends Component { isLoading = this.state.isStepLoading; } - return ( + const nextButton = ( - {this.state.currentStep.label} + {this.state.currentStep.nextButtonLabel + ? this.state.currentStep.nextButtonLabel + : this.state.currentStep.label} ); + + return this.state.currentStep.renderSecondaryActionButton ? ( + + + + {this.state.currentStep.renderSecondaryActionButton({ + isDisabled, + isLoading, + addLayersAndClose: this.props.addLayersAndClose, + })} + + {nextButton} + + + ) : ( + nextButton + ); } render() { @@ -178,7 +229,7 @@ export class AddLayerPanel extends Component { <> -

{this.state.currentStep ? this.state.currentStep.label : SELECT_WIZARD_LABEL}

+

{this.state.currentStep ? this.state.currentStep.label : ADD_LAYER_STEP_LABEL}

 @@ -200,7 +251,7 @@ export class AddLayerPanel extends Component { /> - + { }; render() { - const cancelButtonLabel = this.props.hasStateChanged ? ( - - ) : ( - - ); - const removeModal = this.props.selectedLayer && this.state.showRemoveModal ? ( { flush="left" data-test-subj="layerPanelCancelButton" > - {cancelButtonLabel} + {this.props.hasStateChanged ? panelStrings.discardChanges : panelStrings.close} @@ -93,10 +85,7 @@ export class FlyoutFooter extends Component { onClick={this.props.saveLayerEdits} fill > - + {panelStrings.keepChanges} diff --git a/x-pack/plugins/maps/public/connected_components/map_settings_panel/map_settings_panel.tsx b/x-pack/plugins/maps/public/connected_components/map_settings_panel/map_settings_panel.tsx index f4b360a985ced..14baf166ea4e1 100644 --- a/x-pack/plugins/maps/public/connected_components/map_settings_panel/map_settings_panel.tsx +++ b/x-pack/plugins/maps/public/connected_components/map_settings_panel/map_settings_panel.tsx @@ -16,13 +16,13 @@ import { EuiSpacer, EuiTitle, } from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { NavigationPanel } from './navigation_panel'; import { SpatialFiltersPanel } from './spatial_filters_panel'; import { DisplayPanel } from './display_panel'; import { CustomIconsPanel } from './custom_icons_panel'; import { CustomIcon, MapCenter, MapSettings } from '../../../common/descriptor_types'; +import { panelStrings } from '../panel_strings'; export interface Props { cancelChanges: () => void; @@ -49,24 +49,12 @@ export function MapSettingsPanel({ deleteCustomIcon, zoom, }: Props) { - // TODO move common text like Cancel and Close to common i18n translation - const closeBtnLabel = hasMapSettingsChanges - ? i18n.translate('xpack.maps.mapSettingsPanel.cancelLabel', { - defaultMessage: 'Cancel', - }) - : i18n.translate('xpack.maps.mapSettingsPanel.closeLabel', { - defaultMessage: 'Close', - }); - return (

- +

@@ -100,7 +88,7 @@ export function MapSettingsPanel({ flush="left" data-test-subj="layerPanelCancelButton" > - {closeBtnLabel} + {hasMapSettingsChanges ? panelStrings.discardChanges : panelStrings.close} @@ -114,10 +102,7 @@ export function MapSettingsPanel({ fill data-test-subj="mapSettingSubmitButton" > - + {panelStrings.keepChanges} diff --git a/x-pack/plugins/maps/public/connected_components/panel_strings.ts b/x-pack/plugins/maps/public/connected_components/panel_strings.ts new file mode 100644 index 0000000000000..f7f7278138e1e --- /dev/null +++ b/x-pack/plugins/maps/public/connected_components/panel_strings.ts @@ -0,0 +1,20 @@ +/* + * 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 { i18n } from '@kbn/i18n'; + +export const panelStrings = { + close: i18n.translate('xpack.maps.panel.closeLabel', { + defaultMessage: 'Close', + }), + discardChanges: i18n.translate('xpack.maps.panel.discardChangesLabel', { + defaultMessage: 'Discard changes', + }), + keepChanges: i18n.translate('xpack.maps.panel.keepChangesLabel', { + defaultMessage: 'Keep changes', + }), +}; diff --git a/x-pack/plugins/maps/public/routes/map_page/top_nav_config.tsx b/x-pack/plugins/maps/public/routes/map_page/top_nav_config.tsx index 917e411f9790c..2204d38483f49 100644 --- a/x-pack/plugins/maps/public/routes/map_page/top_nav_config.tsx +++ b/x-pack/plugins/maps/public/routes/map_page/top_nav_config.tsx @@ -58,7 +58,7 @@ export function getTopNavConfig({ { id: 'mapSettings', label: i18n.translate('xpack.maps.topNav.openSettingsButtonLabel', { - defaultMessage: `Map settings`, + defaultMessage: `Settings`, }), description: i18n.translate('xpack.maps.topNav.openSettingsDescription', { defaultMessage: `Open map settings`, diff --git a/x-pack/plugins/ml/public/application/components/data_grid/common.ts b/x-pack/plugins/ml/public/application/components/data_grid/common.ts index 560de1c7de81f..86587112f37d7 100644 --- a/x-pack/plugins/ml/public/application/components/data_grid/common.ts +++ b/x-pack/plugins/ml/public/application/components/data_grid/common.ts @@ -19,6 +19,7 @@ import type { DataView, DataViewField } from '@kbn/data-views-plugin/common'; import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from '@kbn/field-types'; import { getNestedProperty } from '@kbn/ml-nested-property'; +import { isCounterTimeSeriesMetric } from '@kbn/ml-agg-utils'; import { DEFAULT_RESULTS_FIELD } from '../../../../common/constants/data_frame_analytics'; import { extractErrorMessage } from '../../../../common/util/errors'; import { @@ -218,8 +219,9 @@ export const getDataGridSchemaFromKibanaFieldType = ( // Built-in values are ['boolean', 'currency', 'datetime', 'numeric', 'json'] // To fall back to the default string schema it needs to be undefined. let schema; + if (!field) return; - switch (field?.type) { + switch (field.type) { case KBN_FIELD_TYPES.BOOLEAN: schema = 'boolean'; break; @@ -239,7 +241,8 @@ export const getDataGridSchemaFromKibanaFieldType = ( } if ( - (schema === undefined && field?.aggregatable === false) || + (schema === undefined && field.aggregatable === false) || + isCounterTimeSeriesMetric(field) || (schema === 'numeric' && field?.esTypes?.some((d) => d === ES_FIELD_TYPES.AGGREGATE_METRIC_DOUBLE)) ) { diff --git a/x-pack/plugins/ml/public/application/explorer/swimlane_container.tsx b/x-pack/plugins/ml/public/application/explorer/swimlane_container.tsx index b211708c6f92f..a34c968eecfe4 100644 --- a/x-pack/plugins/ml/public/application/explorer/swimlane_container.tsx +++ b/x-pack/plugins/ml/public/application/explorer/swimlane_container.tsx @@ -291,10 +291,6 @@ export const SwimlaneContainer: FC = ({ }, heatmap: { grid: { - cellHeight: { - min: CELL_HEIGHT, - max: CELL_HEIGHT, - }, stroke: { width: BORDER_WIDTH, color: euiTheme.euiBorderColor, diff --git a/x-pack/plugins/ml/server/models/job_service/new_job_caps/field_service.ts b/x-pack/plugins/ml/server/models/job_service/new_job_caps/field_service.ts index ba3c0c9c0f759..815013da3cfd2 100644 --- a/x-pack/plugins/ml/server/models/job_service/new_job_caps/field_service.ts +++ b/x-pack/plugins/ml/server/models/job_service/new_job_caps/field_service.ts @@ -10,6 +10,7 @@ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import type { IScopedClusterClient } from '@kbn/core/server'; import { ES_FIELD_TYPES } from '@kbn/field-types'; import type { DataViewsService } from '@kbn/data-views-plugin/common'; +import { TIME_SERIES_METRIC_TYPES } from '@kbn/ml-agg-utils'; import type { Field, NewJobCaps, RollupFields } from '../../../../common/types/fields'; import { combineFieldsAndAggs } from '../../../../common/util/fields_utils'; import { rollupServiceProvider } from './rollup'; @@ -103,7 +104,7 @@ class FieldsService { } private isCounterField(field: estypes.FieldCapsFieldCapability) { - return field.time_series_metric === 'counter'; + return field.time_series_metric === TIME_SERIES_METRIC_TYPES.COUNTER; } // check to see whether the field is aggregatable // If it is a counter field from a time series data stream, we cannot currently diff --git a/x-pack/plugins/observability/public/pages/slos/components/badges/slo_active_alerts_badge.stories.tsx b/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_active_alerts_badge.stories.tsx similarity index 83% rename from x-pack/plugins/observability/public/pages/slos/components/badges/slo_active_alerts_badge.stories.tsx rename to x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_active_alerts_badge.stories.tsx index a70234c2b79dc..08fa152301d43 100644 --- a/x-pack/plugins/observability/public/pages/slos/components/badges/slo_active_alerts_badge.stories.tsx +++ b/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_active_alerts_badge.stories.tsx @@ -7,14 +7,14 @@ import React from 'react'; import { ComponentStory } from '@storybook/react'; - import { EuiFlexGroup } from '@elastic/eui'; -import { KibanaReactStorybookDecorator } from '../../../../utils/kibana_react.storybook_decorator'; + +import { KibanaReactStorybookDecorator } from '../../../utils/kibana_react.storybook_decorator'; import { SloActiveAlertsBadge as Component, Props } from './slo_active_alerts_badge'; export default { component: Component, - title: 'app/SLO/ListPage/Badges/SloActiveAlertsBadge', + title: 'app/SLO/Badges/SloActiveAlertsBadge', decorators: [KibanaReactStorybookDecorator], }; diff --git a/x-pack/plugins/observability/public/pages/slos/components/badges/slo_active_alerts_badge.tsx b/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_active_alerts_badge.tsx similarity index 81% rename from x-pack/plugins/observability/public/pages/slos/components/badges/slo_active_alerts_badge.tsx rename to x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_active_alerts_badge.tsx index e64d4b2b67fcc..218f1c8bd84c3 100644 --- a/x-pack/plugins/observability/public/pages/slos/components/badges/slo_active_alerts_badge.tsx +++ b/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_active_alerts_badge.tsx @@ -8,11 +8,11 @@ import { EuiBadge, EuiFlexItem } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import React from 'react'; -import { paths } from '../../../../config/paths'; -import { useKibana } from '../../../../utils/kibana_react'; +import { paths } from '../../../config/paths'; +import { useKibana } from '../../../utils/kibana_react'; -import { ActiveAlerts } from '../../../../hooks/slo/use_fetch_active_alerts'; -import { toAlertsPageQueryFilter } from '../../helpers/alerts_page_query_filter'; +import { ActiveAlerts } from '../../../hooks/slo/use_fetch_active_alerts'; +import { toAlertsPageQueryFilter } from '../../../pages/slos/helpers/alerts_page_query_filter'; export interface Props { activeAlerts?: ActiveAlerts; @@ -48,7 +48,7 @@ export function SloActiveAlertsBadge({ activeAlerts }: Props) { 'xpack.observability.slo.slo.activeAlertsBadge.ariaLabel', { defaultMessage: 'active alerts badge' } )} - data-test-subj="o11ySlosPageSloActiveAlertsBadge" + data-test-subj="o11ySloActiveAlertsBadge" > {i18n.translate('xpack.observability.slo.slo.activeAlertsBadge.label', { defaultMessage: '{count, plural, one {# alert} other {# alerts}}', diff --git a/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_status_badge.stories.tsx b/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_status_badge.stories.tsx index e8a76e8dc1118..a7acf522c0b46 100644 --- a/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_status_badge.stories.tsx +++ b/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_status_badge.stories.tsx @@ -7,8 +7,8 @@ import React from 'react'; import { ComponentStory } from '@storybook/react'; - import { EuiFlexGroup } from '@elastic/eui'; + import { KibanaReactStorybookDecorator } from '../../../utils/kibana_react.storybook_decorator'; import { SloStatusBadge as Component, SloStatusProps } from './slo_status_badge'; import { buildSlo } from '../../../data/slo/slo'; diff --git a/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_status_badge.tsx b/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_status_badge.tsx index ef6e931f76ff4..bf847ea5f3693 100644 --- a/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_status_badge.tsx +++ b/x-pack/plugins/observability/public/components/slo/slo_status_badge/slo_status_badge.tsx @@ -18,39 +18,37 @@ export function SloStatusBadge({ slo }: SloStatusProps) { return ( <> -
- {slo.summary.status === 'NO_DATA' && ( - - {i18n.translate('xpack.observability.slo.sloStatusBadge.noData', { - defaultMessage: 'No data', - })} - - )} + {slo.summary.status === 'NO_DATA' && ( + + {i18n.translate('xpack.observability.slo.sloStatusBadge.noData', { + defaultMessage: 'No data', + })} + + )} - {slo.summary.status === 'HEALTHY' && ( - - {i18n.translate('xpack.observability.slo.sloStatusBadge.healthy', { - defaultMessage: 'Healthy', - })} - - )} + {slo.summary.status === 'HEALTHY' && ( + + {i18n.translate('xpack.observability.slo.sloStatusBadge.healthy', { + defaultMessage: 'Healthy', + })} + + )} - {slo.summary.status === 'DEGRADING' && ( - - {i18n.translate('xpack.observability.slo.sloStatusBadge.degrading', { - defaultMessage: 'Degrading', - })} - - )} + {slo.summary.status === 'DEGRADING' && ( + + {i18n.translate('xpack.observability.slo.sloStatusBadge.degrading', { + defaultMessage: 'Degrading', + })} + + )} - {slo.summary.status === 'VIOLATED' && ( - - {i18n.translate('xpack.observability.slo.sloStatusBadge.violated', { - defaultMessage: 'Violated', - })} - - )} -
+ {slo.summary.status === 'VIOLATED' && ( + + {i18n.translate('xpack.observability.slo.sloStatusBadge.violated', { + defaultMessage: 'Violated', + })} + + )} {slo.summary.errorBudget.isEstimated && ( diff --git a/x-pack/plugins/observability/public/pages/alert_details/alert_details.tsx b/x-pack/plugins/observability/public/pages/alert_details/alert_details.tsx index fd93ef9eaad63..d994669fbc6b0 100644 --- a/x-pack/plugins/observability/public/pages/alert_details/alert_details.tsx +++ b/x-pack/plugins/observability/public/pages/alert_details/alert_details.tsx @@ -75,7 +75,7 @@ export function AlertDetails() { return ; } - // Redirect to the the 404 page when the user hit the page url directly in the browser while the feature flag is off. + // Redirect to the 404 page when the user hit the page url directly in the browser while the feature flag is off. if (alert && !isAlertDetailsEnabledPerApp(alert, config)) { return ; } diff --git a/x-pack/plugins/observability/public/pages/alert_details/components/page_title.stories.tsx b/x-pack/plugins/observability/public/pages/alert_details/components/page_title.stories.tsx index 4478a9ac0bc82..72c6e221cbb5a 100644 --- a/x-pack/plugins/observability/public/pages/alert_details/components/page_title.stories.tsx +++ b/x-pack/plugins/observability/public/pages/alert_details/components/page_title.stories.tsx @@ -8,6 +8,7 @@ import React from 'react'; import { ComponentStory } from '@storybook/react'; import { EuiPageTemplate } from '@elastic/eui'; +import { ALERT_RULE_CATEGORY } from '@kbn/rule-data-utils'; import { PageTitle as Component, PageTitleProps } from './page_title'; import { alert } from '../mock/alert'; @@ -34,5 +35,21 @@ const defaultProps = { export const PageTitle = Template.bind({}); PageTitle.args = defaultProps; + +export const PageTitleForAnomaly = Template.bind({}); +PageTitleForAnomaly.args = { + ...{ + alert: { + ...defaultProps.alert, + fields: { + ...defaultProps.alert.fields, + [ALERT_RULE_CATEGORY]: 'Anomaly', + }, + }, + }, +}; + export const PageTitleUsedWithinPageTemplate = TemplateWithPageTemplate.bind({}); -PageTitleUsedWithinPageTemplate.args = defaultProps; +PageTitleUsedWithinPageTemplate.args = { + ...defaultProps, +}; diff --git a/x-pack/plugins/observability/public/pages/alert_details/components/page_title.test.tsx b/x-pack/plugins/observability/public/pages/alert_details/components/page_title.test.tsx index 09a8d2439fcc8..d988be160c48a 100644 --- a/x-pack/plugins/observability/public/pages/alert_details/components/page_title.test.tsx +++ b/x-pack/plugins/observability/public/pages/alert_details/components/page_title.test.tsx @@ -8,6 +8,7 @@ import React from 'react'; import { render } from '@testing-library/react'; import { __IntlProvider as IntlProvider } from '@kbn/i18n-react'; +import { ALERT_RULE_CATEGORY } from '@kbn/rule-data-utils'; import { PageTitle, PageTitleProps } from './page_title'; import { alert } from '../mock/alert'; @@ -24,9 +25,48 @@ describe('Page Title', () => { ); }; - it('should display a title when it is passed', () => { - const { getByText } = renderComp(defaultProps); - expect(getByText(defaultProps.alert.reason)).toBeTruthy(); + it('should display Log threshold title', () => { + const { getByTestId } = renderComp(defaultProps); + + expect(getByTestId('page-title-container').children.item(0)?.textContent).toEqual( + 'Log threshold breached' + ); + }); + + it('should display Anomaly title', () => { + const props: PageTitleProps = { + alert: { + ...defaultProps.alert, + fields: { + ...defaultProps.alert.fields, + [ALERT_RULE_CATEGORY]: 'Anomaly', + }, + }, + }; + + const { getByTestId } = renderComp(props); + + expect(getByTestId('page-title-container').children.item(0)?.textContent).toEqual( + 'Anomaly detected' + ); + }); + + it('should display Inventory title', () => { + const props: PageTitleProps = { + alert: { + ...defaultProps.alert, + fields: { + ...defaultProps.alert.fields, + [ALERT_RULE_CATEGORY]: 'Inventory', + }, + }, + }; + + const { getByTestId } = renderComp(props); + + expect(getByTestId('page-title-container').children.item(0)?.textContent).toEqual( + 'Inventory threshold breached' + ); }); it('should display an active badge when active is true', async () => { diff --git a/x-pack/plugins/observability/public/pages/alert_details/components/page_title.tsx b/x-pack/plugins/observability/public/pages/alert_details/components/page_title.tsx index a602b79556e4a..41172644b9cf7 100644 --- a/x-pack/plugins/observability/public/pages/alert_details/components/page_title.tsx +++ b/x-pack/plugins/observability/public/pages/alert_details/components/page_title.tsx @@ -20,6 +20,7 @@ import { FormattedMessage } from '@kbn/i18n-react'; import { ALERT_DURATION, ALERT_FLAPPING, + ALERT_RULE_CATEGORY, ALERT_STATUS_ACTIVE, ALERT_STATUS_RECOVERED, TIMESTAMP, @@ -40,7 +41,13 @@ export function PageTitle({ alert }: PageTitleProps) { return (
- {alert.reason} + @@ -53,7 +60,7 @@ export function PageTitle({ alert }: PageTitleProps) { :  @@ -72,7 +79,7 @@ export function PageTitle({ alert }: PageTitleProps) { :  @@ -91,7 +98,7 @@ export function PageTitle({ alert }: PageTitleProps) { :  diff --git a/x-pack/plugins/observability/public/pages/slo_details/components/header_control.tsx b/x-pack/plugins/observability/public/pages/slo_details/components/header_control.tsx index 931b503caa1a5..79fe2d7d862ea 100644 --- a/x-pack/plugins/observability/public/pages/slo_details/components/header_control.tsx +++ b/x-pack/plugins/observability/public/pages/slo_details/components/header_control.tsx @@ -151,7 +151,7 @@ export function HeaderControl({ isLoading, slo }: Props) { ruleTypeId={SLO_BURN_RATE_RULE_ID} canChangeTrigger={false} onClose={onCloseRuleFlyout} - initialValues={{ name: `${slo.name} burn rate` }} + initialValues={{ name: `${slo.name} burn rate`, params: { sloId: slo.id } }} /> ) : null} diff --git a/x-pack/plugins/observability/public/pages/slo_details/components/header_title.tsx b/x-pack/plugins/observability/public/pages/slo_details/components/header_title.tsx index 44e31dac68949..4ce439f290fe7 100644 --- a/x-pack/plugins/observability/public/pages/slo_details/components/header_title.tsx +++ b/x-pack/plugins/observability/public/pages/slo_details/components/header_title.tsx @@ -9,7 +9,9 @@ import { EuiFlexGroup, EuiFlexItem, EuiLoadingSpinner } from '@elastic/eui'; import { SLOWithSummaryResponse } from '@kbn/slo-schema'; import React from 'react'; +import { useFetchActiveAlerts } from '../../../hooks/slo/use_fetch_active_alerts'; import { SloStatusBadge } from '../../../components/slo/slo_status_badge'; +import { SloActiveAlertsBadge } from '../../../components/slo/slo_status_badge/slo_active_alerts_badge'; export interface Props { slo: SLOWithSummaryResponse | undefined; @@ -18,6 +20,11 @@ export interface Props { export function HeaderTitle(props: Props) { const { isLoading, slo } = props; + + const { data: activeAlerts } = useFetchActiveAlerts({ + sloIds: !!slo ? [slo.id] : [], + }); + if (isLoading) { return ; } @@ -27,9 +34,12 @@ export function HeaderTitle(props: Props) { } return ( - + {slo.name} - + + + + ); } diff --git a/x-pack/plugins/observability/public/pages/slo_details/slo_details.test.tsx b/x-pack/plugins/observability/public/pages/slo_details/slo_details.test.tsx index 517a00b9cad70..a606edc900438 100644 --- a/x-pack/plugins/observability/public/pages/slo_details/slo_details.test.tsx +++ b/x-pack/plugins/observability/public/pages/slo_details/slo_details.test.tsx @@ -18,6 +18,7 @@ import { buildSlo } from '../../data/slo/slo'; import { paths } from '../../config/paths'; import { useFetchHistoricalSummary } from '../../hooks/slo/use_fetch_historical_summary'; import { useCapabilities } from '../../hooks/slo/use_capabilities'; +import { useFetchActiveAlerts } from '../../hooks/slo/use_fetch_active_alerts'; import { HEALTHY_STEP_DOWN_ROLLING_SLO, historicalSummaryData, @@ -33,6 +34,7 @@ jest.mock('react-router-dom', () => ({ jest.mock('../../utils/kibana_react'); jest.mock('../../hooks/use_breadcrumbs'); jest.mock('../../hooks/use_license'); +jest.mock('../../hooks/slo/use_fetch_active_alerts'); jest.mock('../../hooks/slo/use_fetch_slo_details'); jest.mock('../../hooks/slo/use_fetch_historical_summary'); jest.mock('../../hooks/slo/use_capabilities'); @@ -40,6 +42,7 @@ jest.mock('../../hooks/slo/use_capabilities'); const useKibanaMock = useKibana as jest.Mock; const useParamsMock = useParams as jest.Mock; const useLicenseMock = useLicense as jest.Mock; +const useFetchActiveAlertsMock = useFetchActiveAlerts as jest.Mock; const useFetchSloDetailsMock = useFetchSloDetails as jest.Mock; const useFetchHistoricalSummaryMock = useFetchHistoricalSummary as jest.Mock; const useCapabilitiesMock = useCapabilities as jest.Mock; @@ -82,6 +85,7 @@ describe('SLO Details Page', () => { isLoading: false, sloHistoricalSummaryResponse: historicalSummaryData, }); + useFetchActiveAlertsMock.mockReturnValue({ isLoading: false, data: {} }); }); describe('when the incorrect license is found', () => { @@ -154,6 +158,21 @@ describe('SLO Details Page', () => { expect(screen.queryAllByTestId('wideChartLoading').length).toBe(0); }); + it('renders the active alerts badge', async () => { + const slo = buildSlo(); + useLicenseMock.mockReturnValue({ hasAtLeast: () => true }); + useParamsMock.mockReturnValue(slo.id); + useFetchSloDetailsMock.mockReturnValue({ isLoading: false, slo }); + useFetchActiveAlertsMock.mockReturnValue({ + isLoading: false, + data: { [slo.id]: { count: 2, ruleIds: ['rule-1', 'rule-2'] } }, + }); + + render(); + + expect(screen.getByTestId('o11ySloActiveAlertsBadge')).toBeTruthy(); + }); + it("renders a 'Edit' button under actions menu", async () => { const slo = buildSlo(); useParamsMock.mockReturnValue(slo.id); diff --git a/x-pack/plugins/observability/public/pages/slos/components/badges/slo_badges.tsx b/x-pack/plugins/observability/public/pages/slos/components/badges/slo_badges.tsx index dacee509af089..93d0c70a6858c 100644 --- a/x-pack/plugins/observability/public/pages/slos/components/badges/slo_badges.tsx +++ b/x-pack/plugins/observability/public/pages/slos/components/badges/slo_badges.tsx @@ -13,7 +13,7 @@ import { SloIndicatorTypeBadge } from './slo_indicator_type_badge'; import { SloStatusBadge } from '../../../../components/slo/slo_status_badge'; import { SloTimeWindowBadge } from './slo_time_window_badge'; import type { ActiveAlerts } from '../../../../hooks/slo/use_fetch_active_alerts'; -import { SloActiveAlertsBadge } from './slo_active_alerts_badge'; +import { SloActiveAlertsBadge } from '../../../../components/slo/slo_status_badge/slo_active_alerts_badge'; export interface Props { slo: SLOWithSummaryResponse; diff --git a/x-pack/plugins/observability/server/saved_objects/slo.ts b/x-pack/plugins/observability/server/saved_objects/slo.ts index e2c8fe22336a8..1e6d108088b8e 100644 --- a/x-pack/plugins/observability/server/saved_objects/slo.ts +++ b/x-pack/plugins/observability/server/saved_objects/slo.ts @@ -20,7 +20,7 @@ export const slo: SavedObjectsType = { dynamic: false, properties: { id: { type: 'keyword' }, - name: { type: 'keyword' }, + name: { type: 'text' }, description: { type: 'text' }, indicator: { properties: { diff --git a/x-pack/plugins/osquery/public/actions/actions_table.tsx b/x-pack/plugins/osquery/public/actions/actions_table.tsx index 1f8fa8db5da1f..ef256d73946e3 100644 --- a/x-pack/plugins/osquery/public/actions/actions_table.tsx +++ b/x-pack/plugins/osquery/public/actions/actions_table.tsx @@ -23,7 +23,6 @@ import { useHistory } from 'react-router-dom'; import { removeMultilines } from '../../common/utils/build_query/remove_multilines'; import { useAllLiveQueries } from './use_all_live_queries'; import type { SearchHit } from '../../common/search_strategy'; -import { Direction } from '../../common/search_strategy'; import { useRouterNavigate, useKibana } from '../common/lib/kibana'; import { usePacks } from '../packs/use_packs'; @@ -63,8 +62,6 @@ const ActionsTableComponent = () => { const { data: actionsData } = useAllLiveQueries({ activePage: pageIndex, limit: pageSize, - direction: Direction.desc, - sortField: '@timestamp', filterQuery: { exists: { field: 'user_id', diff --git a/x-pack/plugins/osquery/public/actions/use_all_live_queries.ts b/x-pack/plugins/osquery/public/actions/use_all_live_queries.ts index 78a6514ce4a3a..2f540a3eaf09c 100644 --- a/x-pack/plugins/osquery/public/actions/use_all_live_queries.ts +++ b/x-pack/plugins/osquery/public/actions/use_all_live_queries.ts @@ -17,10 +17,10 @@ import { useErrorToast } from '../common/hooks/use_error_toast'; import { Direction } from '../../common/search_strategy'; export interface UseAllLiveQueriesConfig { - activePage: number; + activePage?: number; direction?: Direction; - limit: number; - sortField: string; + limit?: number; + sortField?: string; filterQuery?: ESTermQuery | ESExistsQuery | string; skip?: boolean; alertId?: string; @@ -30,10 +30,10 @@ export interface UseAllLiveQueriesConfig { const ACTIONS_QUERY_KEY = 'actions'; export const useAllLiveQueries = ({ - activePage, + activePage = 0, direction = Direction.desc, - limit, - sortField, + limit = 100, + sortField = '@timestamp', filterQuery, skip = false, alertId, diff --git a/x-pack/plugins/security_solution/common/endpoint/data_generators/endpoint_action_generator.ts b/x-pack/plugins/security_solution/common/endpoint/data_generators/endpoint_action_generator.ts index 9d91d2bc5e883..360becd415646 100644 --- a/x-pack/plugins/security_solution/common/endpoint/data_generators/endpoint_action_generator.ts +++ b/x-pack/plugins/security_solution/common/endpoint/data_generators/endpoint_action_generator.ts @@ -58,6 +58,7 @@ export class EndpointActionGenerator extends BaseDataGenerator { user: { id: this.randomUser(), }, + rule: undefined, }, overrides ); diff --git a/x-pack/plugins/security_solution/common/endpoint/data_loaders/setup_fleet_for_endpoint.ts b/x-pack/plugins/security_solution/common/endpoint/data_loaders/setup_fleet_for_endpoint.ts index 02372aa25b114..5aeb64e189728 100644 --- a/x-pack/plugins/security_solution/common/endpoint/data_loaders/setup_fleet_for_endpoint.ts +++ b/x-pack/plugins/security_solution/common/endpoint/data_loaders/setup_fleet_for_endpoint.ts @@ -64,6 +64,14 @@ export const setupFleetForEndpoint = async (kbnClient: KbnClient): Promise log.error(error); throw error; } + + // Install/upgrade the endpoint package + try { + await installOrUpgradeEndpointFleetPackage(kbnClient); + } catch (error) { + log.error(error); + throw error; + } }; /** diff --git a/x-pack/plugins/security_solution/common/endpoint/index_data.ts b/x-pack/plugins/security_solution/common/endpoint/index_data.ts index 24431871c09e6..77b3135c12353 100644 --- a/x-pack/plugins/security_solution/common/endpoint/index_data.ts +++ b/x-pack/plugins/security_solution/common/endpoint/index_data.ts @@ -62,8 +62,7 @@ export async function indexHostsAndAlerts( alertsPerHost: number, fleet: boolean, options: TreeOptions = {}, - DocGenerator: typeof EndpointDocGenerator = EndpointDocGenerator, - startTransform = true + DocGenerator: typeof EndpointDocGenerator = EndpointDocGenerator ): Promise { const random = seedrandom(seed); const epmEndpointPackage = await getEndpointPackageInfo(kbnClient); @@ -97,8 +96,11 @@ export async function indexHostsAndAlerts( // Keep a map of host applied policy ids (fake) to real ingest package configs (policy record) const realPolicies: Record = {}; - await waitForMetadataTransformsReady(client); - await stopMetadataTransforms(client); + const shouldWaitForEndpointMetadataDocs = fleet; + if (shouldWaitForEndpointMetadataDocs) { + await waitForMetadataTransformsReady(client); + await stopMetadataTransforms(client); + } for (let i = 0; i < numHosts; i++) { const generator = new DocGenerator(random); @@ -126,7 +128,7 @@ export async function indexHostsAndAlerts( }); } - if (startTransform) { + if (shouldWaitForEndpointMetadataDocs) { await startMetadataTransforms( client, response.agents.map((agent) => agent.id) diff --git a/x-pack/plugins/security_solution/common/endpoint/schema/actions.test.ts b/x-pack/plugins/security_solution/common/endpoint/schema/actions.test.ts index e9cab03724c36..5dc5059d21262 100644 --- a/x-pack/plugins/security_solution/common/endpoint/schema/actions.test.ts +++ b/x-pack/plugins/security_solution/common/endpoint/schema/actions.test.ts @@ -22,6 +22,68 @@ describe('actions schemas', () => { }).not.toThrow(); }); + it.each([true, false])('should accept withAutomatedActions param', (value) => { + expect(() => { + EndpointActionListRequestSchema.query.validate({ withAutomatedActions: value }); + }).not.toThrow(); + }); + + it('should require at least 1 alert ID', () => { + expect(() => { + EndpointActionListRequestSchema.query.validate({ alertId: [] }); + }).toThrow(); + }); + + it('should accept an alert ID if not in an array', () => { + expect(() => { + EndpointActionListRequestSchema.query.validate({ alertId: uuidv4() }); + }).not.toThrow(); + }); + + it('should not accept an alert ID if empty string', () => { + expect(() => { + EndpointActionListRequestSchema.query.validate({ alertId: '' }); + }).toThrow(); + }); + + it('should accept an alert ID in an array', () => { + expect(() => { + EndpointActionListRequestSchema.query.validate({ alertId: [uuidv4()] }); + }).not.toThrow(); + }); + + it('should not accept an alert ID if empty string in an array', () => { + expect(() => { + EndpointActionListRequestSchema.query.validate({ alertId: [''] }); + }).toThrow(); + }); + + it('should accept multiple alert IDs in an array', () => { + expect(() => { + EndpointActionListRequestSchema.query.validate({ + alertId: [uuidv4(), uuidv4(), uuidv4()], + }); + }).not.toThrow(); + }); + + it('should not accept multiple alert IDs in an array if one is an empty string', () => { + expect(() => { + EndpointActionListRequestSchema.query.validate({ + alertId: [uuidv4(), '', uuidv4()], + }); + }).toThrow(); + }); + + it('should not limit multiple alert IDs', () => { + expect(() => { + EndpointActionListRequestSchema.query.validate({ + agentIds: Array(255) + .fill(1) + .map(() => uuidv4()), + }); + }).not.toThrow(); + }); + it('should require at least 1 agent ID', () => { expect(() => { EndpointActionListRequestSchema.query.validate({ agentIds: [] }); // no agent_ids provided diff --git a/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts b/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts index c6fc2237f9934..a4ab7609d75c8 100644 --- a/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts +++ b/x-pack/plugins/security_solution/common/endpoint/schema/actions.ts @@ -151,6 +151,27 @@ export const EndpointActionListRequestSchema = { }), ]) ), + withAutomatedActions: schema.boolean({ defaultValue: true }), + alertId: schema.maybe( + schema.oneOf([ + schema.arrayOf(schema.string({ minLength: 1 }), { + minSize: 1, + validate: (alertIds) => { + if (alertIds.map((v) => v.trim()).some((v) => !v.length)) { + return 'alertIds cannot contain empty strings'; + } + }, + }), + schema.string({ + minLength: 1, + validate: (alertId) => { + if (!alertId.trim().length) { + return 'alertId cannot be an empty string'; + } + }, + }), + ]) + ), }), }; diff --git a/x-pack/plugins/security_solution/common/endpoint/types/actions.ts b/x-pack/plugins/security_solution/common/endpoint/types/actions.ts index 8b8ef1ed0dda6..58c07459de441 100644 --- a/x-pack/plugins/security_solution/common/endpoint/types/actions.ts +++ b/x-pack/plugins/security_solution/common/endpoint/types/actions.ts @@ -132,6 +132,10 @@ export interface LogsEndpointAction { user: { id: string; }; + rule?: { + id: string; + name: string; + }; } /** @@ -188,6 +192,7 @@ export interface EndpointActionData< comment?: string; parameters?: TParameters; output?: ActionResponseOutput; + alert_id?: string[]; } export interface FleetActionResponseData { @@ -375,6 +380,9 @@ export interface ActionDetails< comment?: string; /** parameters submitted with action */ parameters?: TParameters; + alertIds?: string[]; + ruleId?: string; + ruleName?: string; } export interface ActionDetailsApiResponse< diff --git a/x-pack/plugins/security_solution/common/endpoint/utils/transforms.ts b/x-pack/plugins/security_solution/common/endpoint/utils/transforms.ts index 32a36ee7c5593..5e604f2d15e4a 100644 --- a/x-pack/plugins/security_solution/common/endpoint/utils/transforms.ts +++ b/x-pack/plugins/security_solution/common/endpoint/utils/transforms.ts @@ -16,10 +16,7 @@ import { } from '../constants'; export async function waitForMetadataTransformsReady(esClient: Client): Promise { - await waitFor( - () => areMetadataTransformsReady(esClient), - 'failed while waiting for transform to start' - ); + await waitFor(() => areMetadataTransformsReady(esClient)); } export async function stopMetadataTransforms(esClient: Client): Promise { @@ -40,7 +37,7 @@ export async function stopMetadataTransforms(esClient: Client): Promise { export async function startMetadataTransforms( esClient: Client, // agentIds to wait for - agentIds?: string[] + agentIds: string[] ): Promise { const transformIds = await getMetadataTransformIds(esClient); const currentTransformId = transformIds.find((transformId) => @@ -50,7 +47,9 @@ export async function startMetadataTransforms( transformId.startsWith(METADATA_UNITED_TRANSFORM) ); if (!currentTransformId || !unitedTransformId) { - throw new Error('failed to start metadata transforms, transforms not found'); + // eslint-disable-next-line no-console + console.warn('metadata transforms not found, skipping transform start'); + return; } try { @@ -102,8 +101,8 @@ async function areMetadataTransformsReady(esClient: Client): Promise { ); } -async function waitForCurrentMetdataDocs(esClient: Client, agentIds?: string[]) { - const query = agentIds?.length +async function waitForCurrentMetdataDocs(esClient: Client, agentIds: string[]) { + const query = agentIds.length ? { bool: { filter: [ @@ -116,12 +115,9 @@ async function waitForCurrentMetdataDocs(esClient: Client, agentIds?: string[]) }, } : { - size: 1, - query: { - match_all: {}, - }, + match_all: {}, }; - const size = agentIds?.length ? agentIds.length : 1; + const size = agentIds.length ?? 1; await waitFor( async () => ( @@ -131,16 +127,14 @@ async function waitForCurrentMetdataDocs(esClient: Client, agentIds?: string[]) size, rest_total_hits_as_int: true, }) - ).hits.total === size, - 'failed while waiting for current metadata docs to populate' + ).hits.total === size ); } async function waitFor( cb: () => Promise, - errorMessage: string, interval: number = 20000, - maxAttempts = 5 + maxAttempts = 6 ): Promise { let attempts = 0; let isReady = false; @@ -151,7 +145,7 @@ async function waitFor( attempts++; if (attempts > maxAttempts) { - throw new Error(errorMessage); + return; } } } diff --git a/x-pack/plugins/security_solution/common/experimental_features.ts b/x-pack/plugins/security_solution/common/experimental_features.ts index 657cde434cb4f..c0020b822b760 100644 --- a/x-pack/plugins/security_solution/common/experimental_features.ts +++ b/x-pack/plugins/security_solution/common/experimental_features.ts @@ -71,7 +71,7 @@ export const allowedExperimentalValues = Object.freeze({ /** * Enables the automated endpoint response action in rule + alerts */ - endpointResponseActionsEnabled: true, + endpointResponseActionsEnabled: false, /** * Enables endpoint package level rbac diff --git a/x-pack/plugins/security_solution/cypress/e2e/data_sources/sourcerer.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/data_sources/sourcerer.cy.ts index d645b0ee96fbc..a6dfef7dc7fb8 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/data_sources/sourcerer.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/data_sources/sourcerer.cy.ts @@ -11,7 +11,6 @@ import { HOSTS_URL, TIMELINES_URL } from '../../urls/navigation'; import { addIndexToDefault, clickAlertCheckbox, - deleteAlertsIndex, deselectSourcererOptions, isDataViewSelection, isHostsStatValue, @@ -23,9 +22,9 @@ import { openAdvancedSettings, openDataViewSelection, openSourcerer, + refreshUntilAlertsIndexExists, resetSourcerer, saveSourcerer, - waitForAlertsIndexToExist, } from '../../tasks/sourcerer'; import { postDataView } from '../../tasks/common'; import { openTimelineUsingToggle } from '../../tasks/security_main'; @@ -46,7 +45,6 @@ const dataViews = ['auditbeat-*,fakebeat-*', 'auditbeat-*,*beat*,siem-read*,.kib describe('Sourcerer', () => { before(() => { esArchiverResetKibana(); - deleteAlertsIndex(); dataViews.forEach((dataView: string) => postDataView(dataView)); }); describe('permissions', () => { @@ -144,19 +142,13 @@ describe('Timeline scope', () => { visit(TIMELINES_URL); }); - it('correctly loads SIEM data view before and after signals index exists', () => { + it('correctly loads SIEM data view', () => { openTimelineUsingToggle(); openSourcerer('timeline'); isDataViewSelection(siemDataViewTitle); openAdvancedSettings(); isSourcererSelection(`auditbeat-*`); - isNotSourcererSelection(`${DEFAULT_ALERTS_INDEX}-default`); - isSourcererOptions( - [...DEFAULT_INDEX_PATTERN, `${DEFAULT_ALERTS_INDEX}-default`].filter( - (pattern) => pattern !== 'auditbeat-*' - ) - ); - waitForAlertsIndexToExist(); + isSourcererSelection(`${DEFAULT_ALERTS_INDEX}-default`); isSourcererOptions(DEFAULT_INDEX_PATTERN.filter((pattern) => pattern !== 'auditbeat-*')); isNotSourcererOption(`${DEFAULT_ALERTS_INDEX}-default`); }); @@ -211,7 +203,7 @@ describe('Timeline scope', () => { }); beforeEach(() => { visit(TIMELINES_URL); - waitForAlertsIndexToExist(); + refreshUntilAlertsIndexExists(); }); it('Modifies timeline to alerts only, and switches to different saved timeline without issue', function () { openTimelineById(this.timelineId).then(() => { diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/alerts_details.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/alerts_details.cy.ts index e218207e84db8..947f92d3ec4aa 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/alerts_details.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/alerts_details.cy.ts @@ -8,82 +8,137 @@ import { ALERT_FLYOUT, CELL_TEXT, + COPY_ALERT_FLYOUT_LINK, JSON_TEXT, + OVERVIEW_RULE, TABLE_CONTAINER, TABLE_ROWS, } from '../../screens/alerts_details'; - -import { expandFirstAlert } from '../../tasks/alerts'; -import { openJsonView, openTable } from '../../tasks/alerts_details'; +import { closeAlertFlyout, expandFirstAlert } from '../../tasks/alerts'; +import { filterBy, openJsonView, openTable } from '../../tasks/alerts_details'; import { createRule } from '../../tasks/api_calls/rules'; import { cleanKibana } from '../../tasks/common'; import { waitForAlertsToPopulate } from '../../tasks/create_new_rule'; import { esArchiverLoad, esArchiverUnload } from '../../tasks/es_archiver'; -import { login, visitWithoutDateRange } from '../../tasks/login'; - -import { getUnmappedRule } from '../../objects/rule'; - +import { login, visit, visitWithoutDateRange } from '../../tasks/login'; +import { getUnmappedRule, getNewRule } from '../../objects/rule'; import { ALERTS_URL } from '../../urls/navigation'; import { tablePageSelector } from '../../screens/table_pagination'; +import { ALERTS_COUNT } from '../../screens/alerts'; -describe('Alert details with unmapped fields', { testIsolation: false }, () => { - before(() => { - cleanKibana(); - esArchiverLoad('unmapped_fields'); - login(); - createRule(getUnmappedRule()); - visitWithoutDateRange(ALERTS_URL); - waitForAlertsToPopulate(); - expandFirstAlert(); - }); +describe('Alert details flyout', () => { + describe('With unmapped fields', { testIsolation: false }, () => { + before(() => { + cleanKibana(); + esArchiverLoad('unmapped_fields'); + login(); + createRule(getUnmappedRule()); + visitWithoutDateRange(ALERTS_URL); + waitForAlertsToPopulate(); + expandFirstAlert(); + }); - after(() => { - esArchiverUnload('unmapped_fields'); - }); + after(() => { + esArchiverUnload('unmapped_fields'); + }); - it('should display the unmapped field on the JSON view', () => { - const expectedUnmappedValue = 'This is the unmapped field'; + it('should display the unmapped field on the JSON view', () => { + const expectedUnmappedValue = 'This is the unmapped field'; - openJsonView(); + openJsonView(); - cy.get(JSON_TEXT).then((x) => { - const parsed = JSON.parse(x.text()); - expect(parsed.fields.unmapped[0]).to.equal(expectedUnmappedValue); + cy.get(JSON_TEXT).then((x) => { + const parsed = JSON.parse(x.text()); + expect(parsed.fields.unmapped[0]).to.equal(expectedUnmappedValue); + }); }); - }); - it('should displays the unmapped field on the table', () => { - const expectedUnmappedField = { - field: 'unmapped', - text: 'This is the unmapped field', - }; - - openTable(); - cy.get(ALERT_FLYOUT).find(tablePageSelector(6)).click({ force: true }); - cy.get(ALERT_FLYOUT) - .find(TABLE_ROWS) - .last() - .within(() => { - cy.get(CELL_TEXT).should('contain', expectedUnmappedField.field); - cy.get(CELL_TEXT).should('contain', expectedUnmappedField.text); - }); + it('should displays the unmapped field on the table', () => { + const expectedUnmappedField = { + field: 'unmapped', + text: 'This is the unmapped field', + }; + + openTable(); + cy.get(ALERT_FLYOUT).find(tablePageSelector(6)).click({ force: true }); + cy.get(ALERT_FLYOUT) + .find(TABLE_ROWS) + .last() + .within(() => { + cy.get(CELL_TEXT).should('contain', expectedUnmappedField.field); + cy.get(CELL_TEXT).should('contain', expectedUnmappedField.text); + }); + }); + + // This test makes sure that the table does not overflow horizontally + it('table should not scroll horizontally', () => { + openTable(); + + cy.get(ALERT_FLYOUT) + .find(TABLE_CONTAINER) + .within(($tableContainer) => { + expect($tableContainer[0].scrollLeft).to.equal(0); + + // Due to the introduction of pagination on the table, a slight horizontal overflow has been introduced. + // scroll ignores the `overflow-x:hidden` attribute and will still scroll the element if there is a hidden overflow + // Updated the below to < 5 to account for this and keep a test to make sure it doesn't grow + $tableContainer[0].scroll({ left: 1000 }); + + expect($tableContainer[0].scrollLeft).to.be.lessThan(5); + }); + }); }); - // This test makes sure that the table does not overflow horizontally - it('table should not scroll horizontally', () => { - openTable(); + describe('Url state management', { testIsolation: false }, () => { + const testRule = getNewRule(); + before(() => { + cleanKibana(); + login(); + createRule(testRule); + visit(ALERTS_URL); + waitForAlertsToPopulate(); + }); - cy.get(ALERT_FLYOUT) - .find(TABLE_CONTAINER) - .within(($tableContainer) => { - expect($tableContainer[0].scrollLeft).to.equal(0); + it('should store the flyout state in the url when it is opened', () => { + expandFirstAlert(); + cy.get(OVERVIEW_RULE).should('be.visible'); + cy.url().should('include', 'eventFlyout='); + }); - // Due to the introduction of pagination on the table, a slight horizontal overflow has been introduced. - // scroll ignores the `overflow-x:hidden` attribute and will still scroll the element if there is a hidden overflow - // Updated the below to < 5 to account for this and keep a test to make sure it doesn't grow - $tableContainer[0].scroll({ left: 1000 }); + it('should remove the flyout state from the url when it is closed', () => { + expandFirstAlert(); + cy.get(OVERVIEW_RULE).should('be.visible'); + closeAlertFlyout(); + cy.url().should('not.include', 'eventFlyout='); + }); - expect($tableContainer[0].scrollLeft).to.be.lessThan(5); + it('should open the alert flyout when the page is refreshed', () => { + expandFirstAlert(); + cy.get(OVERVIEW_RULE).should('be.visible'); + cy.reload(); + cy.get(OVERVIEW_RULE).should('be.visible'); + cy.get(OVERVIEW_RULE).then((field) => { + expect(field).to.contain(testRule.name); }); + }); + + it('should show the copy link button for the flyout', () => { + expandFirstAlert(); + cy.get(COPY_ALERT_FLYOUT_LINK).should('be.visible'); + }); + + it('should open the flyout given the custom url', () => { + expandFirstAlert(); + openTable(); + filterBy('_id'); + cy.get('[data-test-subj="formatted-field-_id"]') + .invoke('text') + .then((alertId) => { + cy.visit(`http://localhost:5620/app/security/alerts/${alertId}`); + cy.get('[data-test-subj="unifiedQueryInput"]').should('have.text', `_id: ${alertId}`); + cy.get(ALERTS_COUNT).should('have.text', '1 alert'); + cy.get(OVERVIEW_RULE).should('be.visible'); + }); + }); }); }); diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/expandable_flyout/alert_details_left_panel.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/expandable_flyout/alert_details_left_panel.cy.ts index 63a3527986b01..a5442b786040f 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/expandable_flyout/alert_details_left_panel.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/expandable_flyout/alert_details_left_panel.cy.ts @@ -8,7 +8,15 @@ import { DOCUMENT_DETAILS_FLYOUT_HISTORY_TAB, DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB, - DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CONTENT, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_BUTTON_GROUP, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_BUTTON, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_PREVALENCE_BUTTON, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CORRELATIONS_BUTTON, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_CONTENT, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_THREAT_INTELLIGENCE_CONTENT, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_PREVALENCE_CONTENT, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CORRELATIONS_CONTENT, DOCUMENT_DETAILS_FLYOUT_INVESTIGATIONS_TAB_CONTENT, DOCUMENT_DETAILS_FLYOUT_INVESTIGATIONS_TAB, DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB, @@ -28,6 +36,10 @@ import { openInvestigationsTab, openSessionView, openVisualizeTab, + openEntities, + openThreatIntelligence, + openPrevalence, + openCorrelations, } from '../../../tasks/document_expandable_flyout'; import { cleanKibana } from '../../../tasks/common'; import { login, visit } from '../../../tasks/login'; @@ -65,7 +77,7 @@ describe.skip('Alert details expandable flyout left panel', { testIsolation: fal cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_BUTTON_GROUP).should('be.visible'); openInsightsTab(); - cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CONTENT).should('be.visible'); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_BUTTON_GROUP).should('be.visible'); openInvestigationsTab(); cy.get(DOCUMENT_DETAILS_FLYOUT_INVESTIGATIONS_TAB_CONTENT).should('be.visible'); @@ -74,26 +86,67 @@ describe.skip('Alert details expandable flyout left panel', { testIsolation: fal cy.get(DOCUMENT_DETAILS_FLYOUT_HISTORY_TAB_CONTENT).should('be.visible'); }); - it('should display a button group with 2 button in the visualize tab', () => { - openVisualizeTab(); - cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_SESSION_VIEW_BUTTON) - .should('be.visible') - .and('have.text', 'Session View'); - cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_GRAPH_ANALYZER_BUTTON) - .should('be.visible') - .and('have.text', 'Analyzer Graph'); + describe('visualiza tab', () => { + it('should display a button group with 2 button in the visualize tab', () => { + openVisualizeTab(); + cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_SESSION_VIEW_BUTTON) + .should('be.visible') + .and('have.text', 'Session View'); + cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_GRAPH_ANALYZER_BUTTON) + .should('be.visible') + .and('have.text', 'Analyzer Graph'); + }); + + it('should display content when switching buttons', () => { + openVisualizeTab(); + openSessionView(); + cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_SESSION_VIEW_CONTENT) + .should('be.visible') + .and('have.text', 'Session view'); + + openGraphAnalyzer(); + cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_GRAPH_ANALYZER_CONTENT).should('be.visible'); + }); }); - it('should display content when switching buttons', () => { - openVisualizeTab(); - openSessionView(); - cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_SESSION_VIEW_CONTENT) - .should('be.visible') - .and('have.text', 'Session view'); + describe('insights tab', () => { + it('should display a button group with 4 button in the insights tab', () => { + openInsightsTab(); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_BUTTON) + .should('be.visible') + .and('have.text', 'Entities'); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON) + .should('be.visible') + .and('have.text', 'Threat Intelligence'); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_PREVALENCE_BUTTON) + .should('be.visible') + .and('have.text', 'Prevalence'); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CORRELATIONS_BUTTON) + .should('be.visible') + .and('have.text', 'Correlations'); + }); - openGraphAnalyzer(); - cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_GRAPH_ANALYZER_CONTENT) - .should('be.visible') - .and('have.text', 'Analyzer graph'); + it('should display content when switching buttons', () => { + openInsightsTab(); + openEntities(); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_CONTENT) + .should('be.visible') + .and('have.text', 'Entities'); + + openThreatIntelligence(); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_THREAT_INTELLIGENCE_CONTENT) + .should('be.visible') + .and('have.text', 'Threat Intelligence'); + + openPrevalence(); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_PREVALENCE_CONTENT) + .should('be.visible') + .and('have.text', 'Prevalence'); + + openCorrelations(); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CORRELATIONS_CONTENT) + .should('be.visible') + .and('have.text', 'Correlations'); + }); }); }); diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/expandable_flyout/alert_details_right_panel_overview_tab.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/expandable_flyout/alert_details_right_panel_overview_tab.cy.ts index 06242709b52cc..adb9d75dce78e 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/expandable_flyout/alert_details_right_panel_overview_tab.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/expandable_flyout/alert_details_right_panel_overview_tab.cy.ts @@ -12,9 +12,9 @@ import { DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_GO_TO_TABLE_LINK, DOCUMENT_DETAILS_FLYOUT_TABLE_TAB_CONTENT, DOCUMENT_DETAILS_FLYOUT_TABLE_TAB_EVENT_TYPE_ROW, - DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS, - DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON, DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_HEADER_TITLE, + DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INVESTIGATION_SECTION_HEADER, + DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INVESTIGATION_SECTION_CONTENT, DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_DESCRIPTION_SECTION_HEADER, DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_DESCRIPTION_SECTION_CONTENT, DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_REASON_TITLE, @@ -22,11 +22,19 @@ import { DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_DESCRIPTION_DETAILS, DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_DESCRIPTION_EXPAND_BUTTON, DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_REASON_DETAILS, + DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITIES_HEADER, + DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITIES_CONTENT, + DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITY_PANEL_HEADER, + DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITY_PANEL_CONTENT, + DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_VIEW_ALL_ENTITIES_BUTTON, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_CONTENT, } from '../../../screens/document_expandable_flyout'; import { expandFirstAlertExpandableFlyout, openOverviewTab, toggleOverviewTabDescriptionSection, + toggleOverviewTabInvestigationSection, + toggleOverviewTabInsightsSection, } from '../../../tasks/document_expandable_flyout'; import { cleanKibana } from '../../../tasks/common'; import { login, visit } from '../../../tasks/login'; @@ -89,11 +97,6 @@ describe.skip( .and('contain.text', rule.name); }); - it('should display mitre attack', () => { - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_MITRE_ATTACK_TITLE).should('be.visible'); - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_MITRE_ATTACK_DETAILS).should('be.visible'); - }); - it('should display mitre attack', () => { cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_MITRE_ATTACK_TITLE) .should('be.visible') @@ -112,45 +115,68 @@ describe.skip( describe('investigation section', () => { before(() => { toggleOverviewTabDescriptionSection(); + toggleOverviewTabInvestigationSection(); + }); + + it('should display description section header and content', () => { + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INVESTIGATION_SECTION_HEADER) + .should('be.visible') + .and('have.text', 'Investigation'); + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INVESTIGATION_SECTION_CONTENT).should( + 'be.visible' + ); }); it('should display highlighted fields', () => { - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS) - .scrollIntoView() - .within(() => { - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON) - .should('be.visible') - .click(); - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_HEADER_TITLE) - .should('be.visible') - .and('have.text', 'Highlighted fields'); - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_DETAILS).should( - 'be.visible' - ); - - // close highlighted fields to reset the view for next test - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON) - .should('be.visible') - .click(); - }); + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_HEADER_TITLE) + .should('be.visible') + .and('have.text', 'Highlighted fields'); + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_DETAILS).should( + 'be.visible' + ); }); + it('should navigate to table tab when clicking on highlighted fields view button', () => { - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS) - .scrollIntoView() - .within(() => { - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON) - .should('be.visible') - .click(); - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_GO_TO_TABLE_LINK) - .should('be.visible') - .click(); - }); + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_GO_TO_TABLE_LINK) + .should('be.visible') + .click(); // the table component is rendered within a dom element with overflow, so Cypress isn't finding it // this next line is a hack that scrolls to a specific element in the table // (in the middle of it vertically) to ensure Cypress finds it cy.get(DOCUMENT_DETAILS_FLYOUT_TABLE_TAB_EVENT_TYPE_ROW).scrollIntoView(); cy.get(DOCUMENT_DETAILS_FLYOUT_TABLE_TAB_CONTENT).should('be.visible'); + + // go back to Overview tab to reset view for next test + openOverviewTab(); + }); + }); + + describe('insights section', () => { + before(() => { + toggleOverviewTabDescriptionSection(); + toggleOverviewTabInsightsSection(); + }); + + it('should display entities section', () => { + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITIES_HEADER) + .scrollIntoView() + .should('be.visible') + .and('have.text', 'Entities'); + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITIES_CONTENT).should('be.visible'); + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITY_PANEL_HEADER).should( + 'be.visible' + ); + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITY_PANEL_CONTENT).should( + 'be.visible' + ); + }); + + it('should navigate to left panel, entities tab when view all entities is clicked', () => { + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_VIEW_ALL_ENTITIES_BUTTON) + .should('be.visible') + .click(); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_CONTENT).should('be.visible'); }); }); } diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/navigation.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/navigation.cy.ts index 60cf6c4f1195c..79267cb65a197 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/navigation.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/detection_alerts/navigation.cy.ts @@ -21,7 +21,9 @@ import { import { PAGE_TITLE } from '../../screens/common/page'; import { OPEN_ALERT_DETAILS_PAGE } from '../../screens/alerts_details'; -describe('Alert Details Page Navigation', () => { +// This is skipped as the details page POC will be removed in favor of the expanded alert flyout +// https://github.com/elastic/kibana/issues/154477 +describe.skip('Alert Details Page Navigation', () => { describe('navigating to alert details page', () => { const rule = getNewRule(); before(() => { diff --git a/x-pack/plugins/security_solution/cypress/screens/alerts_details.ts b/x-pack/plugins/security_solution/cypress/screens/alerts_details.ts index 23b15524305ed..74df1f1999373 100644 --- a/x-pack/plugins/security_solution/cypress/screens/alerts_details.ts +++ b/x-pack/plugins/security_solution/cypress/screens/alerts_details.ts @@ -83,3 +83,5 @@ export const INSIGHTS_INVESTIGATE_ANCESTRY_ALERTS_IN_TIMELINE_BUTTON = `[data-te export const ENRICHED_DATA_ROW = `[data-test-subj='EnrichedDataRow']`; export const OPEN_ALERT_DETAILS_PAGE = `[data-test-subj="open-alert-details-page"]`; + +export const COPY_ALERT_FLYOUT_LINK = `[data-test-subj="copy-alert-flyout-link"]`; diff --git a/x-pack/plugins/security_solution/cypress/screens/document_expandable_flyout.ts b/x-pack/plugins/security_solution/cypress/screens/document_expandable_flyout.ts index 6c567e109bb40..d74a7cf8678d3 100644 --- a/x-pack/plugins/security_solution/cypress/screens/document_expandable_flyout.ts +++ b/x-pack/plugins/security_solution/cypress/screens/document_expandable_flyout.ts @@ -8,11 +8,19 @@ import { ANALYZER_GRAPH_TEST_ID, SESSION_VIEW_TEST_ID, + ENTITIES_DETAILS_TEST_ID, + THREAT_INTELLIGENCE_DETAILS_TEST_ID, + PREVALENCE_DETAILS_TEST_ID, + CORRELATIONS_DETAILS_TEST_ID, } from '../../public/flyout/left/components/test_ids'; import { HISTORY_TAB_CONTENT_TEST_ID, - INSIGHTS_TAB_CONTENT_TEST_ID, INVESTIGATIONS_TAB_CONTENT_TEST_ID, + INSIGHTS_TAB_BUTTON_GROUP_TEST_ID, + INSIGHTS_TAB_ENTITIES_BUTTON_TEST_ID, + INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON_TEST_ID, + INSIGHTS_TAB_PREVALENCE_BUTTON_TEST_ID, + INSIGHTS_TAB_CORRELATIONS_BUTTON_TEST_ID, VISUALIZE_TAB_BUTTON_GROUP_TEST_ID, VISUALIZE_TAB_GRAPH_ANALYZER_BUTTON_TEST_ID, VISUALIZE_TAB_SESSION_VIEW_BUTTON_TEST_ID, @@ -49,12 +57,20 @@ import { HIGHLIGHTED_FIELDS_DETAILS_TEST_ID, HIGHLIGHTED_FIELDS_GO_TO_TABLE_LINK, HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON_TEST_ID, - HIGHLIGHTED_FIELDS_HEADER_TITLE_TEST_ID, HIGHLIGHTED_FIELDS_TEST_ID, + HIGHLIGHTED_FIELDS_TITLE_TEST_ID, + INVESTIGATION_SECTION_CONTENT_TEST_ID, + INVESTIGATION_SECTION_HEADER_TEST_ID, MITRE_ATTACK_DETAILS_TEST_ID, MITRE_ATTACK_TITLE_TEST_ID, REASON_DETAILS_TEST_ID, REASON_TITLE_TEST_ID, + INSIGHTS_HEADER_TEST_ID, + ENTITIES_HEADER_TEST_ID, + ENTITIES_CONTENT_TEST_ID, + ENTITY_PANEL_HEADER_TEST_ID, + ENTITY_PANEL_CONTENT_TEST_ID, + ENTITIES_VIEW_ALL_BUTTON_TEST_ID, } from '../../public/flyout/right/components/test_ids'; import { getClassSelector, getDataTestSubjectSelector } from '../helpers/common'; @@ -89,6 +105,14 @@ export const DOCUMENT_DETAILS_FLYOUT_INVESTIGATIONS_TAB = getDataTestSubjectSele INVESTIGATIONS_TAB_TEST_ID ); export const DOCUMENT_DETAILS_FLYOUT_HISTORY_TAB = getDataTestSubjectSelector(HISTORY_TAB_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_INVESTIGATIONS_TAB_CONTENT = getDataTestSubjectSelector( + INVESTIGATIONS_TAB_CONTENT_TEST_ID +); +export const DOCUMENT_DETAILS_FLYOUT_HISTORY_TAB_CONTENT = getDataTestSubjectSelector( + HISTORY_TAB_CONTENT_TEST_ID +); + +/* Left Section - Visualize tab */ export const DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_BUTTON_GROUP = getDataTestSubjectSelector( VISUALIZE_TAB_BUTTON_GROUP_TEST_ID ); @@ -101,14 +125,31 @@ export const DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_GRAPH_ANALYZER_BUTTON = getDataTestSubjectSelector(VISUALIZE_TAB_GRAPH_ANALYZER_BUTTON_TEST_ID); export const DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_GRAPH_ANALYZER_CONTENT = getDataTestSubjectSelector(ANALYZER_GRAPH_TEST_ID); -export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CONTENT = getDataTestSubjectSelector( - INSIGHTS_TAB_CONTENT_TEST_ID + +/* Left Section - Insights tab */ +export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_BUTTON_GROUP = getDataTestSubjectSelector( + INSIGHTS_TAB_BUTTON_GROUP_TEST_ID ); -export const DOCUMENT_DETAILS_FLYOUT_INVESTIGATIONS_TAB_CONTENT = getDataTestSubjectSelector( - INVESTIGATIONS_TAB_CONTENT_TEST_ID +export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_BUTTON = getDataTestSubjectSelector( + INSIGHTS_TAB_ENTITIES_BUTTON_TEST_ID ); -export const DOCUMENT_DETAILS_FLYOUT_HISTORY_TAB_CONTENT = getDataTestSubjectSelector( - HISTORY_TAB_CONTENT_TEST_ID +export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_CONTENT = + getDataTestSubjectSelector(ENTITIES_DETAILS_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON = + getDataTestSubjectSelector(INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_THREAT_INTELLIGENCE_CONTENT = + getDataTestSubjectSelector(THREAT_INTELLIGENCE_DETAILS_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_PREVALENCE_BUTTON = getDataTestSubjectSelector( + INSIGHTS_TAB_PREVALENCE_BUTTON_TEST_ID +); +export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_PREVALENCE_CONTENT = getDataTestSubjectSelector( + PREVALENCE_DETAILS_TEST_ID +); +export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CORRELATIONS_BUTTON = getDataTestSubjectSelector( + INSIGHTS_TAB_CORRELATIONS_BUTTON_TEST_ID +); +export const DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CORRELATIONS_CONTENT = getDataTestSubjectSelector( + CORRELATIONS_DETAILS_TEST_ID ); /* Overview tab */ @@ -154,13 +195,31 @@ export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS = getDataTe ); export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON = getDataTestSubjectSelector(HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INVESTIGATION_SECTION_HEADER = + getDataTestSubjectSelector(INVESTIGATION_SECTION_HEADER_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INVESTIGATION_SECTION_CONTENT = + getDataTestSubjectSelector(INVESTIGATION_SECTION_CONTENT_TEST_ID); + export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_HEADER_TITLE = - getDataTestSubjectSelector(HIGHLIGHTED_FIELDS_HEADER_TITLE_TEST_ID); + getDataTestSubjectSelector(HIGHLIGHTED_FIELDS_TITLE_TEST_ID); export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_DETAILS = getDataTestSubjectSelector(HIGHLIGHTED_FIELDS_DETAILS_TEST_ID); export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_HIGHLIGHTED_FIELDS_GO_TO_TABLE_LINK = getDataTestSubjectSelector(HIGHLIGHTED_FIELDS_GO_TO_TABLE_LINK); +export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_SECTION_HEADER = + getDataTestSubjectSelector(INSIGHTS_HEADER_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITIES_HEADER = + getDataTestSubjectSelector(ENTITIES_HEADER_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITIES_CONTENT = + getDataTestSubjectSelector(ENTITIES_CONTENT_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_VIEW_ALL_ENTITIES_BUTTON = + getDataTestSubjectSelector(ENTITIES_VIEW_ALL_BUTTON_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITY_PANEL_HEADER = + getDataTestSubjectSelector(ENTITY_PANEL_HEADER_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_ENTITY_PANEL_CONTENT = + getDataTestSubjectSelector(ENTITY_PANEL_CONTENT_TEST_ID); + /* Table tab */ export const DOCUMENT_DETAILS_FLYOUT_TABLE_TAB_FILTER = getClassSelector('euiFieldSearch'); diff --git a/x-pack/plugins/security_solution/cypress/tasks/document_expandable_flyout.ts b/x-pack/plugins/security_solution/cypress/tasks/document_expandable_flyout.ts index 7c25557fea42a..de3d6e911b96c 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/document_expandable_flyout.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/document_expandable_flyout.ts @@ -14,7 +14,9 @@ import { DOCUMENT_DETAILS_FLYOUT_INVESTIGATIONS_TAB, DOCUMENT_DETAILS_FLYOUT_JSON_TAB, DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB, + DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INVESTIGATION_SECTION_HEADER, DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_DESCRIPTION_SECTION_HEADER, + DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_SECTION_HEADER, DOCUMENT_DETAILS_FLYOUT_TABLE_TAB, DOCUMENT_DETAILS_FLYOUT_TABLE_TAB_CLEAR_FILTER, DOCUMENT_DETAILS_FLYOUT_TABLE_TAB_FILTER, @@ -25,6 +27,10 @@ import { DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB, DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_GRAPH_ANALYZER_BUTTON, DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_SESSION_VIEW_BUTTON, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_BUTTON, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_PREVALENCE_BUTTON, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CORRELATIONS_BUTTON, + DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON, } from '../screens/document_expandable_flyout'; import { EXPAND_ALERT_BTN } from '../screens/alerts'; import { getClassSelector } from '../helpers/common'; @@ -59,7 +65,17 @@ export const scrollWithinDocumentDetailsExpandableFlyoutRightSection = (x: numbe * Open the Overview tab in the document details expandable flyout right section */ export const openOverviewTab = () => - cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB).should('be.visible').click(); + cy.get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB).scrollIntoView().should('be.visible').click(); + +/** + * Toggle the Overview tab investigation section in the document details expandable flyout right section + */ +export const toggleOverviewTabInvestigationSection = () => + cy + .get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INVESTIGATION_SECTION_HEADER) + .scrollIntoView() + .should('be.visible') + .click(); /** * Toggle the Overview tab description section in the document details expandable flyout right section @@ -67,6 +83,17 @@ export const openOverviewTab = () => export const toggleOverviewTabDescriptionSection = () => cy .get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_DESCRIPTION_SECTION_HEADER) + .scrollIntoView() + .should('be.visible') + .click(); + +/** + * Toggle the Overview tab insights section in the document details expandable flyout right section + */ +export const toggleOverviewTabInsightsSection = () => + cy + .get(DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB_INSIGHTS_SECTION_HEADER) + .scrollIntoView() .should('be.visible') .click(); @@ -86,37 +113,83 @@ export const openJsonTab = () => * Open the Visualize tab in the document details expandable flyout left section */ export const openVisualizeTab = () => - cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB).should('be.visible').click(); + cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB).scrollIntoView().should('be.visible').click(); /** * Open the Session View under the Visualize tab in the document details expandable flyout left section */ export const openSessionView = () => - cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_SESSION_VIEW_BUTTON).should('be.visible').click(); + cy + .get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_SESSION_VIEW_BUTTON) + .scrollIntoView() + .should('be.visible') + .click(); /** * Open the Graph Analyzer under the Visuablize tab in the document details expandable flyout left section */ export const openGraphAnalyzer = () => - cy.get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_GRAPH_ANALYZER_BUTTON).should('be.visible').click(); + cy + .get(DOCUMENT_DETAILS_FLYOUT_VISUALIZE_TAB_GRAPH_ANALYZER_BUTTON) + .scrollIntoView() + .should('be.visible') + .click(); /** * Open the Insights tab in the document details expandable flyout left section */ export const openInsightsTab = () => - cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB).should('be.visible').click(); + cy.get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB).scrollIntoView().should('be.visible').click(); + +/** + * Open the Entities tab under the Insights tab in the document details expandable flyout left section + */ +export const openEntities = () => + cy + .get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_ENTITIES_BUTTON) + .scrollIntoView() + .should('be.visible') + .click(); +/** + * Open the Threat intelligence tab under the Insights tab in the document details expandable flyout left section + */ +export const openThreatIntelligence = () => + cy + .get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON) + .scrollIntoView() + .should('be.visible') + .click(); + +/** + * Open the Prevalence tab under the Visuablize tab in the document details expandable flyout left section + */ +export const openPrevalence = () => + cy + .get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_PREVALENCE_BUTTON) + .scrollIntoView() + .should('be.visible') + .click(); +/** + * Open the Correlations tab under the Visuablize tab in the document details expandable flyout left section + */ +export const openCorrelations = () => + cy + .get(DOCUMENT_DETAILS_FLYOUT_INSIGHTS_TAB_CORRELATIONS_BUTTON) + .scrollIntoView() + .should('be.visible') + .click(); /** * Open the Investigations tab in the document details expandable flyout left section */ export const openInvestigationsTab = () => - cy.get(DOCUMENT_DETAILS_FLYOUT_INVESTIGATIONS_TAB).should('be.visible').click(); + cy.get(DOCUMENT_DETAILS_FLYOUT_INVESTIGATIONS_TAB).scrollIntoView().should('be.visible').click(); /** * Open the History tab in the document details expandable flyout left section */ export const openHistoryTab = () => - cy.get(DOCUMENT_DETAILS_FLYOUT_HISTORY_TAB).should('be.visible').click(); + cy.get(DOCUMENT_DETAILS_FLYOUT_HISTORY_TAB).scrollIntoView().should('be.visible').click(); /** * Filter table under the Table tab in the alert details expandable flyout right section diff --git a/x-pack/plugins/security_solution/cypress/tasks/sourcerer.ts b/x-pack/plugins/security_solution/cypress/tasks/sourcerer.ts index f50e13544f2cd..752e3e9ba61cf 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/sourcerer.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/sourcerer.ts @@ -10,8 +10,6 @@ import { HOSTS_URL } from '../urls/navigation'; import { waitForPage } from './login'; import { openTimelineUsingToggle } from './security_main'; import { DEFAULT_ALERTS_INDEX } from '../../common/constants'; -import { createRule } from './api_calls/rules'; -import { getNewRule } from '../objects/rule'; export const openSourcerer = (sourcererScope?: string) => { if (sourcererScope != null && sourcererScope === 'timeline') { @@ -115,28 +113,7 @@ export const addIndexToDefault = (index: string) => { }); }; -export const deleteAlertsIndex = () => { - const alertsIndexUrl = `${Cypress.env( - 'ELASTICSEARCH_URL' - )}/.internal.alerts-security.alerts-default-000001`; - - cy.request({ - url: alertsIndexUrl, - method: 'GET', - headers: { 'kbn-xsrf': 'cypress-creds' }, - failOnStatusCode: false, - }).then((response) => { - if (response.status === 200) { - cy.request({ - url: alertsIndexUrl, - method: 'DELETE', - headers: { 'kbn-xsrf': 'cypress-creds' }, - }); - } - }); -}; - -const refreshUntilAlertsIndexExists = async () => { +export const refreshUntilAlertsIndexExists = async () => { cy.waitUntil( () => { cy.reload(); @@ -153,11 +130,6 @@ const refreshUntilAlertsIndexExists = async () => { ); }; -export const waitForAlertsIndexToExist = () => { - createRule(getNewRule({ rule_id: '1', max_signals: 100 })); - refreshUntilAlertsIndexExists(); -}; - export const deleteRuntimeField = (dataView: string, fieldName: string) => { const deleteRuntimeFieldPath = `/api/data_views/data_view/${dataView}/runtime_field/${fieldName}`; diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/endpoint_response_actions_tab.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/endpoint_response_actions_tab.tsx new file mode 100644 index 0000000000000..19328ec107891 --- /dev/null +++ b/x-pack/plugins/security_solution/public/common/components/event_details/endpoint_response_actions_tab.tsx @@ -0,0 +1,98 @@ +/* + * 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 React, { useMemo } from 'react'; +import styled from 'styled-components'; +import { EuiNotificationBadge, EuiSpacer } from '@elastic/eui'; +import { ActionsLogTable } from '../../../management/components/endpoint_response_actions_list/components/actions_log_table'; +import { useGetEndpointActionList } from '../../../management/hooks'; +import type { ExpandedEventFieldsObject, RawEventData } from './types'; +import { EventsViewType } from './event_details'; +import * as i18n from './translations'; + +import { expandDottedObject } from '../../../../common/utils/expand_dotted'; +import { useIsExperimentalFeatureEnabled } from '../../hooks/use_experimental_features'; +import { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas/response_actions'; + +const TabContentWrapper = styled.div` + height: 100%; + position: relative; +`; + +export const useEndpointResponseActionsTab = ({ + rawEventData, +}: { + rawEventData?: RawEventData; +}) => { + const responseActionsEnabled = useIsExperimentalFeatureEnabled('endpointResponseActionsEnabled'); + + const { + data: actionList, + isFetching, + isFetched, + } = useGetEndpointActionList( + { + alertId: [rawEventData?._id ?? ''], + withAutomatedActions: true, + }, + { retry: false, enabled: rawEventData && responseActionsEnabled } + ); + + const totalItemCount = useMemo(() => actionList?.total ?? 0, [actionList]); + + const expandedEventFieldsObject = rawEventData + ? (expandDottedObject(rawEventData.fields) as ExpandedEventFieldsObject) + : undefined; + + const responseActions = useMemo( + () => expandedEventFieldsObject?.kibana?.alert?.rule?.parameters?.[0].response_actions, + [expandedEventFieldsObject] + ); + + const endpointResponseActions = useMemo( + () => + responseActions?.filter( + (responseAction) => responseAction.action_type_id === RESPONSE_ACTION_TYPES.ENDPOINT + ), + [responseActions] + ); + + if (!endpointResponseActions?.length || !rawEventData || !responseActionsEnabled) { + return; + } + + return { + id: EventsViewType.endpointView, + 'data-test-subj': 'endpointViewTab', + name: i18n.ENDPOINT_VIEW, + append: ( + + {totalItemCount} + + ), + content: ( + <> + + + {isFetched && totalItemCount ? ( + null} + items={actionList?.data || []} + loading={isFetching} + onChange={() => null} + totalItemCount={totalItemCount} + queryParams={{ withAutomatedActions: true }} + showHostNames + /> + ) : null} + + + ), + }; +}; diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/event_details.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/event_details.tsx index 8e7619340df73..13bf589143fe6 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/event_details.tsx +++ b/x-pack/plugins/security_solution/public/common/components/event_details/event_details.tsx @@ -21,6 +21,8 @@ import styled from 'styled-components'; import { isEmpty } from 'lodash'; import type { EcsSecurityExtension as Ecs } from '@kbn/securitysolution-ecs'; +import type { RawEventData } from './types'; +import { useEndpointResponseActionsTab } from './endpoint_response_actions_tab'; import type { SearchHit } from '../../../../common/search_strategy'; import { getMitreComponentParts } from '../../../detections/mitre/get_mitre_threat_component'; import { GuidedOnboardingTourStep } from '../guided_onboarding_tour/tour_step'; @@ -30,7 +32,6 @@ import { getTourAnchor, SecurityStepId, } from '../guided_onboarding_tour/tour_config'; -import type { AlertRawEventData } from './osquery_tab'; import { useOsqueryTab } from './osquery_tab'; import { EventFieldsBrowser } from './event_fields_browser'; import { JsonView } from './json_view'; @@ -74,6 +75,7 @@ export enum EventsViewType { summaryView = 'summary-view', threatIntelView = 'threat-intel-view', osqueryView = 'osquery-results-view', + endpointView = 'endpoint-results-view', } interface Props { @@ -134,6 +136,7 @@ const RendererContainer = styled.div` const ThreatTacticContainer = styled(EuiFlexGroup)` flex-grow: 0; flex-wrap: nowrap; + & .euiFlexGroup { flex-wrap: nowrap; } @@ -425,15 +428,24 @@ const EventDetailsComponent: React.FC = ({ ); const osqueryTab = useOsqueryTab({ - rawEventData: rawEventData as AlertRawEventData, + rawEventData: rawEventData as RawEventData, ...(detailsEcsData !== null ? { ecsData: detailsEcsData } : {}), }); + const endpointResponseActionsTab = useEndpointResponseActionsTab({ + rawEventData: rawEventData as RawEventData, + }); + const tabs = useMemo(() => { - return [summaryTab, threatIntelTab, tableTab, jsonTab, osqueryTab].filter( - (tab: EventViewTab | undefined): tab is EventViewTab => !!tab - ); - }, [summaryTab, threatIntelTab, tableTab, jsonTab, osqueryTab]); + return [ + summaryTab, + threatIntelTab, + tableTab, + jsonTab, + osqueryTab, + endpointResponseActionsTab, + ].filter((tab: EventViewTab | undefined): tab is EventViewTab => !!tab); + }, [summaryTab, threatIntelTab, tableTab, jsonTab, osqueryTab, endpointResponseActionsTab]); const selectedTab = useMemo( () => tabs.find((tab) => tab.id === selectedTabId) ?? tabs[0], diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/osquery_tab.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/osquery_tab.tsx index 919d2881ff909..e82e42f78e2f6 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/osquery_tab.tsx +++ b/x-pack/plugins/security_solution/public/common/components/event_details/osquery_tab.tsx @@ -10,13 +10,14 @@ import React, { useMemo } from 'react'; import styled from 'styled-components'; import { FormattedMessage } from '@kbn/i18n-react'; import type { EcsSecurityExtension as Ecs } from '@kbn/securitysolution-ecs'; +import type { RawEventData } from './types'; import { PERMISSION_DENIED } from '../../../detection_engine/rule_response_actions/osquery/translations'; import { expandDottedObject } from '../../../../common/utils/expand_dotted'; import { useIsExperimentalFeatureEnabled } from '../../hooks/use_experimental_features'; import { useKibana } from '../../lib/kibana'; import { EventsViewType } from './event_details'; import * as i18n from './translations'; -import type { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas/response_actions'; +import { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas/response_actions'; const TabContentWrapper = styled.div` height: 100%; @@ -24,22 +25,11 @@ const TabContentWrapper = styled.div` `; type RuleParameters = Array<{ response_actions: Array<{ - action_type_id: RESPONSE_ACTION_TYPES.OSQUERY; + action_type_id: RESPONSE_ACTION_TYPES; params: Record; }>; }>; -export interface AlertRawEventData { - _id: string; - fields: { - ['agent.id']?: string[]; - ['kibana.alert.rule.parameters']: RuleParameters; - ['kibana.alert.rule.name']: string[]; - }; - - [key: string]: unknown; -} - interface ExpandedEventFieldsObject { agent?: { id: string[]; @@ -58,7 +48,7 @@ export const useOsqueryTab = ({ rawEventData, ecsData, }: { - rawEventData?: AlertRawEventData; + rawEventData?: RawEventData; ecsData?: Ecs; }) => { const { @@ -88,35 +78,39 @@ export const useOsqueryTab = ({ [] ); - if (!osquery || !rawEventData || !responseActionsEnabled || !ecsData) { - return; - } + const shouldEarlyReturn = !rawEventData || !responseActionsEnabled || !ecsData; + const alertId = rawEventData?._id ?? ''; + + const { OsqueryResults, fetchAllLiveQueries } = osquery; + + const { data: actionsData } = fetchAllLiveQueries({ + filterQuery: { term: { alert_ids: alertId } }, + alertId, + skip: shouldEarlyReturn, + }); - const expandedEventFieldsObject = expandDottedObject( - rawEventData.fields - ) as ExpandedEventFieldsObject; + const expandedEventFieldsObject = rawEventData + ? (expandDottedObject(rawEventData.fields) as ExpandedEventFieldsObject) + : undefined; const responseActions = expandedEventFieldsObject?.kibana?.alert?.rule?.parameters?.[0].response_actions; - if (!responseActions?.length) { + const osqueryResponseActions = useMemo( + () => + responseActions?.filter( + (responseAction) => responseAction.action_type_id === RESPONSE_ACTION_TYPES.OSQUERY + ), + [responseActions] + ); + + if (!osqueryResponseActions?.length || shouldEarlyReturn) { return; } - const { OsqueryResults, fetchAllLiveQueries } = osquery; - - const alertId = rawEventData._id; - - const { data: actionsData } = fetchAllLiveQueries({ - filterQuery: { term: { alert_ids: alertId } }, - activePage: 0, - limit: 100, - sortField: '@timestamp', - alertId, - }); const actionItems = actionsData?.data.items || []; - const ruleName = expandedEventFieldsObject.kibana?.alert?.rule?.name; + const ruleName = expandedEventFieldsObject?.kibana?.alert?.rule?.name; return { id: EventsViewType.osqueryView, diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/translations.ts b/x-pack/plugins/security_solution/public/common/components/event_details/translations.ts index a781de77369c2..a0fb58551deb5 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/translations.ts +++ b/x-pack/plugins/security_solution/public/common/components/event_details/translations.ts @@ -70,6 +70,10 @@ export const OSQUERY_VIEW = i18n.translate('xpack.securitySolution.eventDetails. defaultMessage: 'Osquery Results', }); +export const ENDPOINT_VIEW = i18n.translate('xpack.securitySolution.eventDetails.endpointView', { + defaultMessage: 'Endpoint Results', +}); + export const FIELD = i18n.translate('xpack.securitySolution.eventDetails.field', { defaultMessage: 'Field', }); diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/types.ts b/x-pack/plugins/security_solution/public/common/components/event_details/types.ts index bc76ce88aa2f6..b7e15eccc4bc9 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/types.ts +++ b/x-pack/plugins/security_solution/public/common/components/event_details/types.ts @@ -5,6 +5,8 @@ * 2.0. */ +import type { ParsedTechnicalFields } from '@kbn/rule-registry-plugin/common'; +import type { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas'; import type { BrowserField } from '../../containers/source'; import type { TimelineEventsDetailsItem } from '../../../../common/search_strategy'; @@ -36,3 +38,29 @@ export interface EventSummaryField { fieldType?: string; overrideField?: string; } + +export interface RawEventData { + fields: ParsedTechnicalFields; + _id: string; +} + +export interface ExpandedEventFieldsObject { + agent?: { + id: string[]; + }; + kibana: { + alert?: { + rule?: { + parameters: RuleParameters; + name: string[]; + }; + }; + }; +} + +type RuleParameters = Array<{ + response_actions: Array<{ + action_type_id: RESPONSE_ACTION_TYPES; + params: Record; + }>; +}>; diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/common/__snapshots__/event.test.ts.snap b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/common/__snapshots__/event.test.ts.snap deleted file mode 100644 index dbe4ca9818123..0000000000000 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/common/__snapshots__/event.test.ts.snap +++ /dev/null @@ -1,195 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`getEventsHistogramLensAttributes should render 1`] = ` -Object { - "description": "", - "references": Array [ - Object { - "id": "security-solution-my-test", - "name": "indexpattern-datasource-layer-0039eb0c-9a1a-4687-ae54-0f4e239bec75", - "type": "index-pattern", - }, - ], - "state": Object { - "datasourceStates": Object { - "formBased": Object { - "layers": Object { - "0039eb0c-9a1a-4687-ae54-0f4e239bec75": Object { - "columnOrder": Array [ - "34919782-4546-43a5-b668-06ac934d3acd", - "aac9d7d0-13a3-480a-892b-08207a787926", - "e09e0380-0740-4105-becc-0a4ca12e3944", - ], - "columns": Object { - "34919782-4546-43a5-b668-06ac934d3acd": Object { - "dataType": "string", - "isBucketed": true, - "label": "Top values of event.dataset", - "operationType": "terms", - "params": Object { - "missingBucket": false, - "orderBy": Object { - "columnId": "e09e0380-0740-4105-becc-0a4ca12e3944", - "type": "column", - }, - "orderDirection": "desc", - "otherBucket": true, - "parentFormat": Object { - "id": "terms", - }, - "size": 10, - }, - "scale": "ordinal", - "sourceField": "event.dataset", - }, - "aac9d7d0-13a3-480a-892b-08207a787926": Object { - "dataType": "date", - "isBucketed": true, - "label": "@timestamp", - "operationType": "date_histogram", - "params": Object { - "interval": "auto", - }, - "scale": "interval", - "sourceField": "@timestamp", - }, - "e09e0380-0740-4105-becc-0a4ca12e3944": Object { - "dataType": "number", - "isBucketed": false, - "label": "Count of records", - "operationType": "count", - "scale": "ratio", - "sourceField": "___records___", - }, - }, - "incompleteColumns": Object {}, - }, - }, - }, - }, - "filters": Array [ - Object { - "meta": Object { - "alias": null, - "disabled": false, - "key": "host.name", - "negate": false, - "params": Object { - "query": "mockHost", - }, - "type": "phrase", - }, - "query": Object { - "match_phrase": Object { - "host.name": "mockHost", - }, - }, - }, - Object { - "meta": Object { - "alias": "", - "disabled": false, - "key": "bool", - "negate": false, - "type": "custom", - "value": "{\\"query\\": {\\"bool\\": {\\"filter\\": [{\\"bool\\": {\\"should\\": [{\\"exists\\": {\\"field\\": \\"host.name\\"}}],\\"minimum_should_match\\": 1}}]}}}", - }, - "query": Object { - "bool": Object { - "minimum_should_match": 1, - "should": Array [ - Object { - "exists": Object { - "field": "host.name", - }, - }, - ], - }, - }, - }, - Object { - "meta": Object { - "alias": null, - "disabled": false, - "key": "_index", - "negate": false, - "params": Array [ - "auditbeat-mytest-*", - ], - "type": "phrases", - }, - "query": Object { - "bool": Object { - "minimum_should_match": 1, - "should": Array [ - Object { - "match_phrase": Object { - "_index": "auditbeat-mytest-*", - }, - }, - ], - }, - }, - }, - Object { - "meta": Object { - "alias": null, - "disabled": false, - "key": "host.id", - "negate": false, - "params": Object { - "query": "123", - }, - "type": "phrase", - }, - "query": Object { - "match_phrase": Object { - "host.id": "123", - }, - }, - }, - ], - "query": Object { - "language": "kql", - "query": "host.name: *", - }, - "visualization": Object { - "axisTitlesVisibilitySettings": Object { - "x": false, - "yLeft": false, - "yRight": true, - }, - "layers": Array [ - Object { - "accessors": Array [ - "e09e0380-0740-4105-becc-0a4ca12e3944", - ], - "layerId": "0039eb0c-9a1a-4687-ae54-0f4e239bec75", - "layerType": "data", - "position": "top", - "seriesType": "bar_stacked", - "showGridlines": false, - "splitAccessor": "34919782-4546-43a5-b668-06ac934d3acd", - "xAccessor": "aac9d7d0-13a3-480a-892b-08207a787926", - }, - ], - "legend": Object { - "isVisible": true, - "legendSize": "xlarge", - "position": "left", - }, - "preferredSeriesType": "bar_stacked", - "title": "Empty XY chart", - "valueLabels": "hide", - "yLeftExtent": Object { - "mode": "full", - }, - "yRightExtent": Object { - "mode": "full", - }, - }, - }, - "title": "Events", - "visualizationType": "lnsXY", -} -`; diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/common/event.test.ts b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/common/event.test.ts index a9a1c3951de5a..935e2a279d673 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/common/event.test.ts +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/common/event.test.ts @@ -6,6 +6,7 @@ */ import { renderHook } from '@testing-library/react-hooks'; +import { useRouteSpy } from '../../../../utils/route/use_route_spy'; import { wrapper } from '../../mocks'; import { useLensAttributes } from '../../use_lens_attributes'; @@ -35,7 +36,14 @@ jest.mock('../../../../utils/route/use_route_spy', () => ({ })); describe('getEventsHistogramLensAttributes', () => { - it('should render', () => { + it('should render query and filters for hosts events histogram', () => { + (useRouteSpy as jest.Mock).mockReturnValue([ + { + detailName: undefined, + pageName: 'hosts', + tabName: 'events', + }, + ]); const { result } = renderHook( () => useLensAttributes({ @@ -44,7 +52,432 @@ describe('getEventsHistogramLensAttributes', () => { }), { wrapper } ); + expect(result?.current?.state.query).toEqual( + expect.objectContaining({ + language: 'kql', + query: 'host.name: *', + }) + ); + + expect(result?.current?.state.filters[0]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + exists: { + field: 'host.name', + }, + }, + ], + }, + }, + }) + ); - expect(result?.current).toMatchSnapshot(); + expect(result?.current?.state.filters[1]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + match_phrase: { + _index: 'auditbeat-mytest-*', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[2]).toEqual( + expect.objectContaining({ + query: { + match_phrase: { + 'host.id': '123', + }, + }, + }) + ); + }); + + it('should render query and filters for host details events histogram', () => { + const { result } = renderHook( + () => + useLensAttributes({ + getLensAttributes: getEventsHistogramLensAttributes, + stackByField: 'event.dataset', + }), + { wrapper } + ); + + expect(result?.current?.state.query).toEqual( + expect.objectContaining({ + language: 'kql', + query: 'host.name: *', + }) + ); + + expect(result?.current?.state.filters[0]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + exists: { + field: 'host.name', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[1]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + match_phrase: { + _index: 'auditbeat-mytest-*', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[2]).toEqual( + expect.objectContaining({ + query: { + match_phrase: { + 'host.id': '123', + }, + }, + }) + ); + }); + + it('should render attributes for network events histogram', () => { + (useRouteSpy as jest.Mock).mockReturnValue([ + { + detailName: undefined, + pageName: 'network', + tabName: 'events', + }, + ]); + const { result } = renderHook( + () => + useLensAttributes({ + getLensAttributes: getEventsHistogramLensAttributes, + stackByField: 'event.dataset', + }), + { wrapper } + ); + expect(result?.current?.state.query).toEqual( + expect.objectContaining({ + language: 'kql', + query: 'host.name: *', + }) + ); + + expect(result?.current?.state.filters[0]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + exists: { + field: 'source.ip', + }, + }, + { + exists: { + field: 'destination.ip', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[1]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + match_phrase: { + _index: 'auditbeat-mytest-*', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[2]).toEqual( + expect.objectContaining({ + query: { + match_phrase: { + 'host.id': '123', + }, + }, + }) + ); + }); + + it('should render attributes for network details events histogram', () => { + (useRouteSpy as jest.Mock).mockReturnValue([ + { + detailName: 'mockIp', + pageName: 'network', + tabName: 'events', + }, + ]); + const { result } = renderHook( + () => + useLensAttributes({ + getLensAttributes: getEventsHistogramLensAttributes, + stackByField: 'event.dataset', + }), + { wrapper } + ); + + expect(result?.current?.state.query).toEqual( + expect.objectContaining({ + language: 'kql', + query: 'host.name: *', + }) + ); + + expect(result?.current?.state.filters[0]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + match_phrase: { + 'source.ip': 'mockIp', + }, + }, + { + match_phrase: { + 'destination.ip': 'mockIp', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[1]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + exists: { + field: 'source.ip', + }, + }, + { + exists: { + field: 'destination.ip', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[2]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + match_phrase: { + _index: 'auditbeat-mytest-*', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[3]).toEqual( + expect.objectContaining({ + query: { + match_phrase: { + 'host.id': '123', + }, + }, + }) + ); + }); + + it('should render attributes for users events histogram', () => { + (useRouteSpy as jest.Mock).mockReturnValue([ + { + detailName: undefined, + pageName: 'users', + tabName: 'events', + }, + ]); + const { result } = renderHook( + () => + useLensAttributes({ + getLensAttributes: getEventsHistogramLensAttributes, + stackByField: 'event.dataset', + }), + { wrapper } + ); + expect(result?.current?.state.query).toEqual( + expect.objectContaining({ + language: 'kql', + query: 'host.name: *', + }) + ); + + expect(result?.current?.state.filters[0]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + exists: { + field: 'user.name', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[1]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + match_phrase: { + _index: 'auditbeat-mytest-*', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[2]).toEqual( + expect.objectContaining({ + query: { + match_phrase: { + 'host.id': '123', + }, + }, + }) + ); + }); + it('should render attributes for user details events histogram', () => { + (useRouteSpy as jest.Mock).mockReturnValue([ + { + detailName: 'mockUser', + pageName: 'users', + tabName: 'events', + }, + ]); + const { result } = renderHook( + () => + useLensAttributes({ + getLensAttributes: getEventsHistogramLensAttributes, + stackByField: 'event.dataset', + }), + { wrapper } + ); + + expect(result?.current?.state.query).toEqual( + expect.objectContaining({ + language: 'kql', + query: 'host.name: *', + }) + ); + + expect(result?.current?.state.filters[0]).toEqual( + expect.objectContaining({ + query: { + match_phrase: { + 'user.name': 'mockUser', + }, + }, + }) + ); + + expect(result?.current?.state.filters[1]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + exists: { + field: 'user.name', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[2]).toEqual( + expect.objectContaining({ + query: { + bool: { + minimum_should_match: 1, + should: [ + { + match_phrase: { + _index: 'auditbeat-mytest-*', + }, + }, + ], + }, + }, + }) + ); + + expect(result?.current?.state.filters[3]).toEqual( + expect.objectContaining({ + query: { + match_phrase: { + 'host.id': '123', + }, + }, + }) + ); }); }); diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_total_users_area.test.ts.snap b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_total_users_area.test.ts.snap index 43bc6ff353a42..c1082249eaf09 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_total_users_area.test.ts.snap +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_total_users_area.test.ts.snap @@ -69,6 +69,28 @@ Object { }, }, }, + Object { + "meta": Object { + "alias": "", + "disabled": false, + "key": "bool", + "negate": false, + "type": "custom", + "value": "{\\"query\\": {\\"bool\\": {\\"filter\\": [{\\"bool\\": {\\"should\\": [{\\"exists\\": {\\"field\\": \\"user.name\\"}}],\\"minimum_should_match\\": 1}}]}}}", + }, + "query": Object { + "bool": Object { + "minimum_should_match": 1, + "should": Array [ + Object { + "exists": Object { + "field": "user.name", + }, + }, + ], + }, + }, + }, Object { "meta": Object { "alias": null, diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_total_users_metric.test.ts.snap b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_total_users_metric.test.ts.snap index 6e22cc1876d6f..af6054acba3bd 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_total_users_metric.test.ts.snap +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_total_users_metric.test.ts.snap @@ -56,6 +56,28 @@ Object { }, }, }, + Object { + "meta": Object { + "alias": "", + "disabled": false, + "key": "bool", + "negate": false, + "type": "custom", + "value": "{\\"query\\": {\\"bool\\": {\\"filter\\": [{\\"bool\\": {\\"should\\": [{\\"exists\\": {\\"field\\": \\"user.name\\"}}],\\"minimum_should_match\\": 1}}]}}}", + }, + "query": Object { + "bool": Object { + "minimum_should_match": 1, + "should": Array [ + Object { + "exists": Object { + "field": "user.name", + }, + }, + ], + }, + }, + }, Object { "meta": Object { "alias": null, diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentication_metric_failure.test.ts.snap b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentication_metric_failure.test.ts.snap index 587af046984d6..cd258182bfdcc 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentication_metric_failure.test.ts.snap +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentication_metric_failure.test.ts.snap @@ -85,6 +85,28 @@ Object { }, }, }, + Object { + "meta": Object { + "alias": "", + "disabled": false, + "key": "bool", + "negate": false, + "type": "custom", + "value": "{\\"query\\": {\\"bool\\": {\\"filter\\": [{\\"bool\\": {\\"should\\": [{\\"exists\\": {\\"field\\": \\"user.name\\"}}],\\"minimum_should_match\\": 1}}]}}}", + }, + "query": Object { + "bool": Object { + "minimum_should_match": 1, + "should": Array [ + Object { + "exists": Object { + "field": "user.name", + }, + }, + ], + }, + }, + }, Object { "meta": Object { "alias": null, diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_area.test.ts.snap b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_area.test.ts.snap index 9216cabe9f508..1aff234b94837 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_area.test.ts.snap +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_area.test.ts.snap @@ -136,6 +136,28 @@ Object { }, }, }, + Object { + "meta": Object { + "alias": "", + "disabled": false, + "key": "bool", + "negate": false, + "type": "custom", + "value": "{\\"query\\": {\\"bool\\": {\\"filter\\": [{\\"bool\\": {\\"should\\": [{\\"exists\\": {\\"field\\": \\"user.name\\"}}],\\"minimum_should_match\\": 1}}]}}}", + }, + "query": Object { + "bool": Object { + "minimum_should_match": 1, + "should": Array [ + Object { + "exists": Object { + "field": "user.name", + }, + }, + ], + }, + }, + }, Object { "meta": Object { "alias": null, diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_bar.test.ts.snap b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_bar.test.ts.snap index 5c814accf07c2..719fa4f10c326 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_bar.test.ts.snap +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_bar.test.ts.snap @@ -141,6 +141,28 @@ Object { }, }, }, + Object { + "meta": Object { + "alias": "", + "disabled": false, + "key": "bool", + "negate": false, + "type": "custom", + "value": "{\\"query\\": {\\"bool\\": {\\"filter\\": [{\\"bool\\": {\\"should\\": [{\\"exists\\": {\\"field\\": \\"user.name\\"}}],\\"minimum_should_match\\": 1}}]}}}", + }, + "query": Object { + "bool": Object { + "minimum_should_match": 1, + "should": Array [ + Object { + "exists": Object { + "field": "user.name", + }, + }, + ], + }, + }, + }, Object { "meta": Object { "alias": null, diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_metric_success.test.ts.snap b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_metric_success.test.ts.snap index cf82e144bbb09..446eeb48231cf 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_metric_success.test.ts.snap +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_attributes/users/__snapshots__/kpi_user_authentications_metric_success.test.ts.snap @@ -86,6 +86,28 @@ Object { }, }, }, + Object { + "meta": Object { + "alias": "", + "disabled": false, + "key": "bool", + "negate": false, + "type": "custom", + "value": "{\\"query\\": {\\"bool\\": {\\"filter\\": [{\\"bool\\": {\\"should\\": [{\\"exists\\": {\\"field\\": \\"user.name\\"}}],\\"minimum_should_match\\": 1}}]}}}", + }, + "query": Object { + "bool": Object { + "minimum_should_match": 1, + "should": Array [ + Object { + "exists": Object { + "field": "user.name", + }, + }, + ], + }, + }, + }, Object { "meta": Object { "alias": null, diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_embeddable.tsx b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_embeddable.tsx index 64ac28fb82d5b..4a955500fbee9 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_embeddable.tsx +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/lens_embeddable.tsx @@ -103,6 +103,7 @@ const LensEmbeddableComponent: React.FC = ({ title: '', }); const preferredSeriesType = (attributes?.state?.visualization as XYState)?.preferredSeriesType; + // Avoid hover actions button overlaps with its chart const addHoverActionsPadding = attributes?.visualizationType !== 'lnsLegacyMetric' && attributes?.visualizationType !== 'lnsPie'; @@ -181,6 +182,7 @@ const LensEmbeddableComponent: React.FC = ({ if (!Array.isArray(e.data) || preferredSeriesType !== 'area') { return; } + // Update timerange when clicking on a dot in an area chart const [{ query }] = await createFiltersFromValueClickAction({ data: e.data, negate: e.negate, diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/types.ts b/x-pack/plugins/security_solution/public/common/components/visualization_actions/types.ts index d323d0b7ccbfd..33f191744101b 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/types.ts +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/types.ts @@ -19,6 +19,16 @@ export type GetLensAttributes = ( alertsOptions?: ExtraOptions ) => LensAttributes; +export interface UseLensAttributesProps { + applyGlobalQueriesAndFilters?: boolean; + extraOptions?: ExtraOptions; + getLensAttributes?: GetLensAttributes; + lensAttributes?: LensAttributes | null; + scopeId?: SourcererScopeName; + stackByField?: string; + title?: string; +} + export interface VisualizationActionsProps { className?: string; extraActions?: Action[]; diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/use_lens_attributes.test.tsx b/x-pack/plugins/security_solution/public/common/components/visualization_actions/use_lens_attributes.test.tsx index 070bd87ad6d94..509aa73629d2d 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/use_lens_attributes.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/use_lens_attributes.test.tsx @@ -10,7 +10,7 @@ import { renderHook } from '@testing-library/react-hooks'; import { getExternalAlertLensAttributes } from './lens_attributes/common/external_alert'; import { useLensAttributes } from './use_lens_attributes'; import { - hostNameExistsFilter, + fieldNameExistsFilter, getDetailsPageFilter, getIndexFilters, sourceOrDestinationIpExistsFilter, @@ -70,7 +70,7 @@ describe('useLensAttributes', () => { expect(result?.current?.state.filters).toEqual([ ...getExternalAlertLensAttributes().state.filters, ...getDetailsPageFilter('hosts', 'mockHost'), - ...hostNameExistsFilter, + ...fieldNameExistsFilter('hosts'), ...getIndexFilters(['auditbeat-*']), ...filterFromSearchBar, ]); diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/use_lens_attributes.tsx b/x-pack/plugins/security_solution/public/common/components/visualization_actions/use_lens_attributes.tsx index 2cadf8129ce07..7276bb9d2e118 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/use_lens_attributes.tsx +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/use_lens_attributes.tsx @@ -7,20 +7,19 @@ import { useMemo } from 'react'; import { SecurityPageName } from '../../../../common/constants'; -import { HostsTableType } from '../../../explore/hosts/store/model'; import { NetworkRouteType } from '../../../explore/network/pages/navigation/types'; import { useSourcererDataView } from '../../containers/sourcerer'; import { useDeepEqualSelector } from '../../hooks/use_selector'; import { inputsSelectors } from '../../store'; import { SourcererScopeName } from '../../store/sourcerer/model'; import { useRouteSpy } from '../../utils/route/use_route_spy'; -import type { LensAttributes, GetLensAttributes, ExtraOptions } from './types'; +import type { LensAttributes, UseLensAttributesProps } from './types'; import { getDetailsPageFilter, sourceOrDestinationIpExistsFilter, - hostNameExistsFilter, getIndexFilters, getNetworkDetailsPageFilter, + fieldNameExistsFilter, } from './utils'; export const useLensAttributes = ({ @@ -31,15 +30,7 @@ export const useLensAttributes = ({ scopeId = SourcererScopeName.default, stackByField, title, -}: { - applyGlobalQueriesAndFilters?: boolean; - extraOptions?: ExtraOptions; - getLensAttributes?: GetLensAttributes; - lensAttributes?: LensAttributes | null; - scopeId?: SourcererScopeName; - stackByField?: string; - title?: string; -}): LensAttributes | null => { +}: UseLensAttributesProps): LensAttributes | null => { const { selectedPatterns, dataViewId, indicesExist } = useSourcererDataView(scopeId); const getGlobalQuerySelector = useMemo(() => inputsSelectors.globalQuerySelector(), []); const getGlobalFiltersQuerySelector = useMemo( @@ -51,12 +42,11 @@ export const useLensAttributes = ({ const [{ detailName, pageName, tabName }] = useRouteSpy(); const tabsFilters = useMemo(() => { - if (pageName === SecurityPageName.hosts && tabName === HostsTableType.events) { - return hostNameExistsFilter; - } - - if (pageName === SecurityPageName.network && tabName === NetworkRouteType.events) { - return sourceOrDestinationIpExistsFilter; + if (tabName === NetworkRouteType.events) { + if (pageName === SecurityPageName.network) { + return sourceOrDestinationIpExistsFilter; + } + return fieldNameExistsFilter(pageName); } return []; diff --git a/x-pack/plugins/security_solution/public/common/components/visualization_actions/utils.ts b/x-pack/plugins/security_solution/public/common/components/visualization_actions/utils.ts index 722ffd9cfe232..a934478218111 100644 --- a/x-pack/plugins/security_solution/public/common/components/visualization_actions/utils.ts +++ b/x-pack/plugins/security_solution/public/common/components/visualization_actions/utils.ts @@ -41,31 +41,36 @@ export const getDetailsPageFilter = (pageName: string, detailName?: string): Fil : []; }; -export const hostNameExistsFilter: Filter[] = [ - { - query: { - bool: { - should: [ - { - exists: { - field: 'host.name', +export const fieldNameExistsFilter = (pageName: string): Filter[] => { + const field = pageFilterFieldMap[pageName]; + + return field && pageName + ? [ + { + query: { + bool: { + should: [ + { + exists: { + field: `${field}.name`, + }, + }, + ], + minimum_should_match: 1, }, }, - ], - minimum_should_match: 1, - }, - }, - meta: { - alias: '', - disabled: false, - key: 'bool', - negate: false, - type: 'custom', - value: - '{"query": {"bool": {"filter": [{"bool": {"should": [{"exists": {"field": "host.name"}}],"minimum_should_match": 1}}]}}}', - }, - }, -]; + meta: { + alias: '', + disabled: false, + key: 'bool', + negate: false, + type: 'custom', + value: `{"query": {"bool": {"filter": [{"bool": {"should": [{"exists": {"field": "${field}.name"}}],"minimum_should_match": 1}}]}}}`, + }, + }, + ] + : []; +}; export const getNetworkDetailsPageFilter = (ipAddress?: string): Filter[] => ipAddress diff --git a/x-pack/plugins/security_solution/public/common/hooks/flyout/types.ts b/x-pack/plugins/security_solution/public/common/hooks/flyout/types.ts new file mode 100644 index 0000000000000..09fd6a25cc53e --- /dev/null +++ b/x-pack/plugins/security_solution/public/common/hooks/flyout/types.ts @@ -0,0 +1,10 @@ +/* + * 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 { ExpandedDetailType } from '../../../../common/types'; + +export type FlyoutUrlState = ExpandedDetailType; diff --git a/x-pack/plugins/security_solution/public/common/hooks/flyout/use_init_flyout_url_param.ts b/x-pack/plugins/security_solution/public/common/hooks/flyout/use_init_flyout_url_param.ts new file mode 100644 index 0000000000000..c07ff0569fb0d --- /dev/null +++ b/x-pack/plugins/security_solution/public/common/hooks/flyout/use_init_flyout_url_param.ts @@ -0,0 +1,61 @@ +/* + * 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 { useCallback, useEffect, useState } from 'react'; + +import { useDispatch } from 'react-redux'; + +import { TableId } from '../../../../common/types'; +import { useInitializeUrlParam } from '../../utils/global_query_string'; +import { URL_PARAM_KEY } from '../use_url_state'; +import type { FlyoutUrlState } from './types'; +import { dataTableActions, dataTableSelectors } from '../../store/data_table'; +import { useShallowEqualSelector } from '../use_selector'; +import { tableDefaults } from '../../store/data_table/defaults'; + +export const useInitFlyoutFromUrlParam = () => { + const [urlDetails, setUrlDetails] = useState(null); + const [hasLoadedUrlDetails, updateHasLoadedUrlDetails] = useState(false); + const dispatch = useDispatch(); + const getDataTable = dataTableSelectors.getTableByIdSelector(); + + // Only allow the alerts page for now to be saved in the url state. + // Allowing only one makes the transition to the expanded flyout much easier as well + const dataTableCurrent = useShallowEqualSelector( + (state) => getDataTable(state, TableId.alertsOnAlertsPage) ?? tableDefaults + ); + + const onInitialize = useCallback((initialState: FlyoutUrlState | null) => { + if (initialState != null && initialState.panelView) { + setUrlDetails(initialState); + } + }, []); + + const loadExpandedDetailFromUrl = useCallback(() => { + const { initialized, isLoading, totalCount } = dataTableCurrent; + const isTableLoaded = initialized && !isLoading && totalCount > 0; + if (urlDetails && isTableLoaded) { + updateHasLoadedUrlDetails(true); + dispatch( + dataTableActions.toggleDetailPanel({ + id: TableId.alertsOnAlertsPage, + ...urlDetails, + }) + ); + } + }, [dataTableCurrent, dispatch, urlDetails]); + + // The alert page creates a default dataTable slice in redux initially that is later overriden when data is retrieved + // We use the below to store the urlDetails on app load, and then set it when the table is done loading and has data + useEffect(() => { + if (!hasLoadedUrlDetails) { + loadExpandedDetailFromUrl(); + } + }, [hasLoadedUrlDetails, loadExpandedDetailFromUrl]); + + useInitializeUrlParam(URL_PARAM_KEY.eventFlyout, onInitialize); +}; diff --git a/x-pack/plugins/security_solution/public/common/hooks/flyout/use_sync_flyout_url_param.ts b/x-pack/plugins/security_solution/public/common/hooks/flyout/use_sync_flyout_url_param.ts new file mode 100644 index 0000000000000..95218a7f91b5e --- /dev/null +++ b/x-pack/plugins/security_solution/public/common/hooks/flyout/use_sync_flyout_url_param.ts @@ -0,0 +1,46 @@ +/* + * 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 { useEffect } from 'react'; +import { useLocation } from 'react-router-dom'; +import { useDispatch } from 'react-redux'; +import { ALERTS_PATH } from '../../../../common/constants'; +import { useUpdateUrlParam } from '../../utils/global_query_string'; +import { TableId } from '../../../../common/types'; +import { useShallowEqualSelector } from '../use_selector'; +import { URL_PARAM_KEY } from '../use_url_state'; +import { dataTableActions, dataTableSelectors } from '../../store/data_table'; +import { tableDefaults } from '../../store/data_table/defaults'; +import type { FlyoutUrlState } from './types'; + +export const useSyncFlyoutUrlParam = () => { + const updateUrlParam = useUpdateUrlParam(URL_PARAM_KEY.eventFlyout); + const { pathname } = useLocation(); + const dispatch = useDispatch(); + const getDataTable = dataTableSelectors.getTableByIdSelector(); + + // Only allow the alerts page for now to be saved in the url state + const { expandedDetail } = useShallowEqualSelector( + (state) => getDataTable(state, TableId.alertsOnAlertsPage) ?? tableDefaults + ); + + useEffect(() => { + const isOnAlertsPage = pathname === ALERTS_PATH; + if (isOnAlertsPage && expandedDetail != null && expandedDetail?.query) { + updateUrlParam(expandedDetail.query.panelView ? expandedDetail.query : null); + } else if (!isOnAlertsPage && expandedDetail?.query?.panelView) { + // Close the detail panel as it's stored in a top level redux store maintained across views + dispatch( + dataTableActions.toggleDetailPanel({ + id: TableId.alertsOnAlertsPage, + }) + ); + // Clear the reference from the url + updateUrlParam(null); + } + }, [dispatch, expandedDetail, pathname, updateUrlParam]); +}; diff --git a/x-pack/plugins/security_solution/public/common/hooks/use_url_state.ts b/x-pack/plugins/security_solution/public/common/hooks/use_url_state.ts index ff491d55c314a..a5230c9ac599f 100644 --- a/x-pack/plugins/security_solution/public/common/hooks/use_url_state.ts +++ b/x-pack/plugins/security_solution/public/common/hooks/use_url_state.ts @@ -12,6 +12,8 @@ import { useUpdateTimerangeOnPageChange } from './search_bar/use_update_timerang import { useInitTimelineFromUrlParam } from './timeline/use_init_timeline_url_param'; import { useSyncTimelineUrlParam } from './timeline/use_sync_timeline_url_param'; import { useQueryTimelineByIdOnUrlChange } from './timeline/use_query_timeline_by_id_on_url_change'; +import { useInitFlyoutFromUrlParam } from './flyout/use_init_flyout_url_param'; +import { useSyncFlyoutUrlParam } from './flyout/use_sync_flyout_url_param'; export const useUrlState = () => { useSyncGlobalQueryString(); @@ -21,10 +23,13 @@ export const useUrlState = () => { useInitTimelineFromUrlParam(); useSyncTimelineUrlParam(); useQueryTimelineByIdOnUrlChange(); + useInitFlyoutFromUrlParam(); + useSyncFlyoutUrlParam(); }; export enum URL_PARAM_KEY { appQuery = 'query', + eventFlyout = 'eventFlyout', filters = 'filters', savedQuery = 'savedQuery', sourcerer = 'sourcerer', diff --git a/x-pack/plugins/security_solution/public/common/lib/kibana/kibana_react.mock.ts b/x-pack/plugins/security_solution/public/common/lib/kibana/kibana_react.mock.ts index efa9ce4831be7..c2fb0c23c9b5b 100644 --- a/x-pack/plugins/security_solution/public/common/lib/kibana/kibana_react.mock.ts +++ b/x-pack/plugins/security_solution/public/common/lib/kibana/kibana_react.mock.ts @@ -172,6 +172,7 @@ export const createStartServicesMock = ( }, osquery: { OsqueryResults: jest.fn().mockReturnValue(null), + fetchAllLiveQueries: jest.fn().mockReturnValue({ data: { data: { items: [] } } }), }, triggersActionsUi, cloudExperiments, diff --git a/x-pack/plugins/security_solution/public/detections/pages/alerts/alert_details_redirect.tsx b/x-pack/plugins/security_solution/public/detections/pages/alerts/alert_details_redirect.tsx new file mode 100644 index 0000000000000..c44fcfdd7e509 --- /dev/null +++ b/x-pack/plugins/security_solution/public/detections/pages/alerts/alert_details_redirect.tsx @@ -0,0 +1,67 @@ +/* + * 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 React, { useMemo } from 'react'; +import { useSelector } from 'react-redux'; +import { Redirect, useLocation, useParams } from 'react-router-dom'; + +import moment from 'moment'; +import { encode } from '@kbn/rison'; +import { ALERTS_PATH, DEFAULT_ALERTS_INDEX } from '../../../../common/constants'; +import { URL_PARAM_KEY } from '../../../common/hooks/use_url_state'; +import { inputsSelectors } from '../../../common/store'; + +export const AlertDetailsRedirect = () => { + const { alertId } = useParams<{ alertId: string }>(); + const { search } = useLocation(); + const searchParams = new URLSearchParams(search); + const timestamp = searchParams.get('timestamp'); + // Although we use the 'default' space here when an index isn't provided or accidentally deleted + // It's a safe catch all as we reset the '.internal.alerts-*` indices with the correct space in the flyout + // Here: x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/helpers.tsx + const index = searchParams.get('index') ?? `.internal${DEFAULT_ALERTS_INDEX}-default`; + + const getInputSelector = useMemo(() => inputsSelectors.inputsSelector(), []); + const inputState = useSelector(getInputSelector); + const { linkTo: globalLinkTo, timerange: globalTimerange } = inputState.global; + const { linkTo: timelineLinkTo, timerange: timelineTimerange } = inputState.timeline; + + // Default to the existing global timerange if we don't get this query param for whatever reason + const fromTime = timestamp ?? globalTimerange.from; + // Add 1 millisecond to the alert timestamp as the alert table is non-inclusive of the end time + // So we have to extend slightly beyond the range of the timestamp of the given alert + const toTime = moment(timestamp ?? globalTimerange.to).add('1', 'millisecond'); + + const timerange = encode({ + global: { + [URL_PARAM_KEY.timerange]: { + kind: 'absolute', + from: fromTime, + to: toTime, + }, + linkTo: globalLinkTo, + }, + timeline: { + [URL_PARAM_KEY.timerange]: timelineTimerange, + linkTo: timelineLinkTo, + }, + }); + + const flyoutString = encode({ + panelView: 'eventDetail', + params: { + eventId: alertId, + indexName: index, + }, + }); + + const kqlAppQuery = encode({ language: 'kuery', query: `_id: ${alertId}` }); + + const url = `${ALERTS_PATH}?${URL_PARAM_KEY.appQuery}=${kqlAppQuery}&${URL_PARAM_KEY.timerange}=${timerange}&${URL_PARAM_KEY.eventFlyout}=${flyoutString}`; + + return ; +}; diff --git a/x-pack/plugins/security_solution/public/detections/pages/alerts/index.tsx b/x-pack/plugins/security_solution/public/detections/pages/alerts/index.tsx index 1cb4ee66e4f32..2d3a55c6b0cd4 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/alerts/index.tsx +++ b/x-pack/plugins/security_solution/public/detections/pages/alerts/index.tsx @@ -6,20 +6,17 @@ */ import React from 'react'; -import { Redirect, Switch } from 'react-router-dom'; +import { Switch } from 'react-router-dom'; import { Route } from '@kbn/shared-ux-router'; import { TrackApplicationView } from '@kbn/usage-collection-plugin/public'; -import { useIsExperimentalFeatureEnabled } from '../../../common/hooks/use_experimental_features'; import { ALERTS_PATH, SecurityPageName } from '../../../../common/constants'; import { NotFoundPage } from '../../../app/404'; import * as i18n from './translations'; import { DetectionEnginePage } from '../detection_engine/detection_engine'; import { SpyRoute } from '../../../common/utils/route/spy_routes'; import { useReadonlyHeader } from '../../../use_readonly_header'; -import { AlertDetailsPage } from '../alert_details'; -import { AlertDetailRouteType } from '../alert_details/types'; -import { getAlertDetailsTabUrl } from '../alert_details/utils/navigation'; +import { AlertDetailsRedirect } from './alert_details_redirect'; const AlertsRoute = () => ( @@ -28,40 +25,13 @@ const AlertsRoute = () => ( ); -const AlertDetailsRoute = () => ( - - - -); - const AlertsContainerComponent: React.FC = () => { useReadonlyHeader(i18n.READ_ONLY_BADGE_TOOLTIP); - const isAlertDetailsPageEnabled = useIsExperimentalFeatureEnabled('alertDetailsPageEnabled'); return ( - {isAlertDetailsPageEnabled && ( - <> - {/* Redirect to the summary page if only the detail name is provided */} - ( - - )} - /> - - - )} + {/* Redirect to the alerts page filtered for the given alert id */} + ); diff --git a/x-pack/plugins/security_solution/public/explore/hosts/pages/hosts.tsx b/x-pack/plugins/security_solution/public/explore/hosts/pages/hosts.tsx index 7450898501746..1476fc9ba01da 100644 --- a/x-pack/plugins/security_solution/public/explore/hosts/pages/hosts.tsx +++ b/x-pack/plugins/security_solution/public/explore/hosts/pages/hosts.tsx @@ -54,7 +54,7 @@ import { useDeepEqualSelector, useShallowEqualSelector } from '../../../common/h import { useInvalidFilterQuery } from '../../../common/hooks/use_invalid_filter_query'; import { ID } from '../containers/hosts'; import { LandingPageComponent } from '../../../common/components/landing_page'; -import { hostNameExistsFilter } from '../../../common/components/visualization_actions/utils'; +import { fieldNameExistsFilter } from '../../../common/components/visualization_actions/utils'; import { dataTableSelectors } from '../../../common/store/data_table'; import { useLicense } from '../../../common/hooks/use_license'; import { tableDefaults } from '../../../common/store/data_table/defaults'; @@ -97,6 +97,7 @@ const HostsComponent = () => { const { uiSettings } = useKibana().services; const { tabName } = useParams<{ tabName: string }>(); const tabsFilters: Filter[] = React.useMemo(() => { + const hostNameExistsFilter = fieldNameExistsFilter(SecurityPageName.hosts); if (tabName === HostsTableType.events) { return [...globalFilters, ...hostNameExistsFilter]; } diff --git a/x-pack/plugins/security_solution/public/explore/hosts/pages/hosts_tabs.tsx b/x-pack/plugins/security_solution/public/explore/hosts/pages/hosts_tabs.tsx index 9d693ab637661..3069394c002ac 100644 --- a/x-pack/plugins/security_solution/public/explore/hosts/pages/hosts_tabs.tsx +++ b/x-pack/plugins/security_solution/public/explore/hosts/pages/hosts_tabs.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React from 'react'; +import React, { useMemo } from 'react'; import { Switch } from 'react-router-dom'; import { Route } from '@kbn/shared-ux-router'; @@ -14,7 +14,7 @@ import { HostsTableType } from '../store/model'; import { AnomaliesQueryTabBody } from '../../../common/containers/anomalies/anomalies_query_tab_body'; import { AnomaliesHostTable } from '../../../common/components/ml/tables/anomalies_host_table'; import { EventsQueryTabBody } from '../../../common/components/events_tab'; -import { HOSTS_PATH } from '../../../../common/constants'; +import { HOSTS_PATH, SecurityPageName } from '../../../../common/constants'; import { HostsQueryTabBody, @@ -23,7 +23,7 @@ import { SessionsTabBody, } from './navigation'; import { TableId } from '../../../../common/types'; -import { hostNameExistsFilter } from '../../../common/components/visualization_actions/utils'; +import { fieldNameExistsFilter } from '../../../common/components/visualization_actions/utils'; export const HostsTabs = React.memo( ({ deleteQuery, filterQuery, from, indexNames, isInitializing, setQuery, to, type }) => { @@ -38,6 +38,8 @@ export const HostsTabs = React.memo( type, }; + const hostNameExistsFilter = useMemo(() => fieldNameExistsFilter(SecurityPageName.hosts), []); + return ( diff --git a/x-pack/plugins/security_solution/public/explore/hosts/pages/navigation/sessions_tab_body.tsx b/x-pack/plugins/security_solution/public/explore/hosts/pages/navigation/sessions_tab_body.tsx index 647ac95148b98..c08c123a7fdf6 100644 --- a/x-pack/plugins/security_solution/public/explore/hosts/pages/navigation/sessions_tab_body.tsx +++ b/x-pack/plugins/security_solution/public/explore/hosts/pages/navigation/sessions_tab_body.tsx @@ -7,17 +7,18 @@ import React, { useMemo } from 'react'; import { TableId } from '../../../../../common/types'; +import { SecurityPageName } from '../../../../app/types'; import { SessionsView } from '../../../../common/components/sessions_viewer'; -import { hostNameExistsFilter } from '../../../../common/components/visualization_actions/utils'; +import { fieldNameExistsFilter } from '../../../../common/components/visualization_actions/utils'; import { useLicense } from '../../../../common/hooks/use_license'; import type { AlertsComponentQueryProps } from './types'; export const SessionsTabBody = React.memo((alertsProps: AlertsComponentQueryProps) => { const { pageFilters, filterQuery, ...rest } = alertsProps; - const hostPageFilters = useMemo( - () => (pageFilters != null ? [...hostNameExistsFilter, ...pageFilters] : hostNameExistsFilter), - [pageFilters] - ); + const hostPageFilters = useMemo(() => { + const hostNameExistsFilter = fieldNameExistsFilter(SecurityPageName.hosts); + return pageFilters != null ? [...hostNameExistsFilter, ...pageFilters] : hostNameExistsFilter; + }, [pageFilters]); const isEnterprisePlus = useLicense().isEnterprise(); return isEnterprisePlus ? ( diff --git a/x-pack/plugins/security_solution/public/flyout/index.tsx b/x-pack/plugins/security_solution/public/flyout/index.tsx index dec91855c2628..c69deac1030e6 100644 --- a/x-pack/plugins/security_solution/public/flyout/index.tsx +++ b/x-pack/plugins/security_solution/public/flyout/index.tsx @@ -14,11 +14,6 @@ import type { LeftPanelProps } from './left'; import { LeftPanel, LeftPanelKey } from './left'; import { LeftPanelProvider } from './left/context'; -// TODO these should be replaced by a more dynamic solution -// see https://github.com/elastic/security-team/issues/6247 -export const RIGHT_SECTION_WIDTH = 500; -export const LEFT_SECTION_WIDTH = 1000; - /** * List of all panels that will be used within the document details expandable flyout. * This needs to be passed to the expandable flyout registeredPanels property. @@ -26,7 +21,6 @@ export const LEFT_SECTION_WIDTH = 1000; export const expandableFlyoutDocumentsPanels: ExpandableFlyoutProps['registeredPanels'] = [ { key: RightPanelKey, - width: RIGHT_SECTION_WIDTH, component: (props) => ( @@ -35,7 +29,6 @@ export const expandableFlyoutDocumentsPanels: ExpandableFlyoutProps['registeredP }, { key: LeftPanelKey, - width: LEFT_SECTION_WIDTH, component: (props) => ( diff --git a/x-pack/plugins/security_solution/public/flyout/left/components/correlations_details.tsx b/x-pack/plugins/security_solution/public/flyout/left/components/correlations_details.tsx new file mode 100644 index 0000000000000..e971980067183 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/left/components/correlations_details.tsx @@ -0,0 +1,21 @@ +/* + * 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 React from 'react'; +import { EuiText } from '@elastic/eui'; +import { CORRELATIONS_DETAILS_TEST_ID } from './test_ids'; + +export const CORRELATIONS_TAB_ID = 'correlations-details'; + +/** + * Correlations displayed in the document details expandable flyout left section under the Insights tab + */ +export const CorrelationsDetails: React.FC = () => { + return {'Correlations'}; +}; + +CorrelationsDetails.displayName = 'CorrelationsDetails'; diff --git a/x-pack/plugins/security_solution/public/flyout/left/components/entities_details.tsx b/x-pack/plugins/security_solution/public/flyout/left/components/entities_details.tsx new file mode 100644 index 0000000000000..2109eb145a9a8 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/left/components/entities_details.tsx @@ -0,0 +1,21 @@ +/* + * 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 React from 'react'; +import { EuiText } from '@elastic/eui'; +import { ENTITIES_DETAILS_TEST_ID } from './test_ids'; + +export const ENTITIES_TAB_ID = 'entities-details'; + +/** + * Entities displayed in the document details expandable flyout left section under the Insights tab + */ +export const EntitiesDetails: React.FC = () => { + return {'Entities'}; +}; + +EntitiesDetails.displayName = 'EntitiesDetails'; diff --git a/x-pack/plugins/security_solution/public/flyout/left/components/prevalence_details.tsx b/x-pack/plugins/security_solution/public/flyout/left/components/prevalence_details.tsx new file mode 100644 index 0000000000000..a653c500cf603 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/left/components/prevalence_details.tsx @@ -0,0 +1,21 @@ +/* + * 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 React from 'react'; +import { EuiText } from '@elastic/eui'; +import { PREVALENCE_DETAILS_TEST_ID } from './test_ids'; + +export const PREVALENCE_TAB_ID = 'prevalence-details'; + +/** + * Prevalence displayed in the document details expandable flyout left section under the Insights tab + */ +export const PrevalenceDetails: React.FC = () => { + return {'Prevalence'}; +}; + +PrevalenceDetails.displayName = 'PrevalenceDetails'; diff --git a/x-pack/plugins/security_solution/public/flyout/left/components/test_ids.ts b/x-pack/plugins/security_solution/public/flyout/left/components/test_ids.ts index 4adf5de724d3b..8b2804fae3e9f 100644 --- a/x-pack/plugins/security_solution/public/flyout/left/components/test_ids.ts +++ b/x-pack/plugins/security_solution/public/flyout/left/components/test_ids.ts @@ -9,3 +9,9 @@ export const ANALYZER_GRAPH_TEST_ID = 'securitySolutionDocumentDetailsFlyoutAnal export const ANALYZE_GRAPH_ERROR_TEST_ID = 'securitySolutionDocumentDetailsFlyoutAnalyzerGraphError'; export const SESSION_VIEW_TEST_ID = 'securitySolutionDocumentDetailsFlyoutSessionView'; +export const ENTITIES_DETAILS_TEST_ID = 'securitySolutionDocumentDetailsFlyoutEntitiesDetails'; +export const THREAT_INTELLIGENCE_DETAILS_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutThreatIntelligenceDetails'; +export const PREVALENCE_DETAILS_TEST_ID = 'securitySolutionDocumentDetailsFlyoutPrevalenceDetails'; +export const CORRELATIONS_DETAILS_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutCorrelationsDetails'; diff --git a/x-pack/plugins/security_solution/public/flyout/left/components/threat_intelligence_details.tsx b/x-pack/plugins/security_solution/public/flyout/left/components/threat_intelligence_details.tsx new file mode 100644 index 0000000000000..01ce8894defec --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/left/components/threat_intelligence_details.tsx @@ -0,0 +1,23 @@ +/* + * 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 React from 'react'; +import { EuiText } from '@elastic/eui'; +import { THREAT_INTELLIGENCE_DETAILS_TEST_ID } from './test_ids'; + +export const THREAT_INTELLIGENCE_TAB_ID = 'threat-intelligence-details'; + +/** + * Threat intelligence displayed in the document details expandable flyout left section under the Insights tab + */ +export const ThreatIntelligenceDetails: React.FC = () => { + return ( + {'Threat Intelligence'} + ); +}; + +ThreatIntelligenceDetails.displayName = 'ThreatIntelligenceDetails'; diff --git a/x-pack/plugins/security_solution/public/flyout/left/index.tsx b/x-pack/plugins/security_solution/public/flyout/left/index.tsx index 1d6ad44921938..63f13245c9bed 100644 --- a/x-pack/plugins/security_solution/public/flyout/left/index.tsx +++ b/x-pack/plugins/security_solution/public/flyout/left/index.tsx @@ -20,6 +20,8 @@ import { useLeftPanelContext } from './context'; export type LeftPanelPaths = 'visualize' | 'insights' | 'investigation' | 'history'; export const LeftPanelKey: LeftPanelProps['key'] = 'document-details-left'; +export const LeftPanelInsightsTabPath: LeftPanelProps['path'] = ['insights']; + export interface LeftPanelProps extends FlyoutPanel { key: 'document-details-left'; path?: LeftPanelPaths[]; diff --git a/x-pack/plugins/security_solution/public/flyout/left/tabs/insights_tab.tsx b/x-pack/plugins/security_solution/public/flyout/left/tabs/insights_tab.tsx index fa27f923931ed..0f96f4b99e772 100644 --- a/x-pack/plugins/security_solution/public/flyout/left/tabs/insights_tab.tsx +++ b/x-pack/plugins/security_solution/public/flyout/left/tabs/insights_tab.tsx @@ -5,16 +5,85 @@ * 2.0. */ -import type { FC } from 'react'; -import React, { memo } from 'react'; -import { EuiText } from '@elastic/eui'; -import { INSIGHTS_TAB_CONTENT_TEST_ID } from './test_ids'; +import React, { memo, useState } from 'react'; + +import { EuiButtonGroup, EuiSpacer } from '@elastic/eui'; +import type { EuiButtonGroupOptionProps } from '@elastic/eui/src/components/button/button_group/button_group'; +import { + INSIGHTS_TAB_BUTTON_GROUP_TEST_ID, + INSIGHTS_TAB_ENTITIES_BUTTON_TEST_ID, + INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON_TEST_ID, + INSIGHTS_TAB_PREVALENCE_BUTTON_TEST_ID, + INSIGHTS_TAB_CORRELATIONS_BUTTON_TEST_ID, +} from './test_ids'; + +import { + INSIGHTS_BUTTONGROUP_OPTIONS, + ENTITIES_BUTTON, + THREAT_INTELLIGENCE_BUTTON, + PREVALENCE_BUTTON, + CORRELATIONS_BUTTON, +} from './translations'; +import { ENTITIES_TAB_ID, EntitiesDetails } from '../components/entities_details'; +import { + THREAT_INTELLIGENCE_TAB_ID, + ThreatIntelligenceDetails, +} from '../components/threat_intelligence_details'; +import { PREVALENCE_TAB_ID, PrevalenceDetails } from '../components/prevalence_details'; +import { CORRELATIONS_TAB_ID, CorrelationsDetails } from '../components/correlations_details'; + +const insightsButtons: EuiButtonGroupOptionProps[] = [ + { + id: ENTITIES_TAB_ID, + label: ENTITIES_BUTTON, + 'data-test-subj': INSIGHTS_TAB_ENTITIES_BUTTON_TEST_ID, + }, + { + id: THREAT_INTELLIGENCE_TAB_ID, + label: THREAT_INTELLIGENCE_BUTTON, + 'data-test-subj': INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON_TEST_ID, + }, + { + id: PREVALENCE_TAB_ID, + label: PREVALENCE_BUTTON, + 'data-test-subj': INSIGHTS_TAB_PREVALENCE_BUTTON_TEST_ID, + }, + { + id: CORRELATIONS_TAB_ID, + label: CORRELATIONS_BUTTON, + 'data-test-subj': INSIGHTS_TAB_CORRELATIONS_BUTTON_TEST_ID, + }, +]; /** * Insights view displayed in the document details expandable flyout left section */ -export const InsightsTab: FC = memo(() => { - return {'Insights'}; +export const InsightsTab: React.FC = memo(() => { + const [activeInsightsId, setActiveInsightsId] = useState(ENTITIES_TAB_ID); + const onChangeCompressed = (optionId: string) => { + setActiveInsightsId(optionId); + }; + + return ( + <> + onChangeCompressed(id)} + buttonSize="compressed" + isFullWidth + data-test-subj={INSIGHTS_TAB_BUTTON_GROUP_TEST_ID} + /> + + {activeInsightsId === ENTITIES_TAB_ID && } + {activeInsightsId === THREAT_INTELLIGENCE_TAB_ID && } + {activeInsightsId === PREVALENCE_TAB_ID && } + {activeInsightsId === CORRELATIONS_TAB_ID && } + + ); }); InsightsTab.displayName = 'InsightsTab'; diff --git a/x-pack/plugins/security_solution/public/flyout/left/tabs/test_ids.ts b/x-pack/plugins/security_solution/public/flyout/left/tabs/test_ids.ts index 98c4dcc28fb4c..9c2e97cfdf1ca 100644 --- a/x-pack/plugins/security_solution/public/flyout/left/tabs/test_ids.ts +++ b/x-pack/plugins/security_solution/public/flyout/left/tabs/test_ids.ts @@ -11,8 +11,16 @@ export const VISUALIZE_TAB_SESSION_VIEW_BUTTON_TEST_ID = 'securitySolutionDocumentDetailsFlyoutVisualizeTabSessionViewButton'; export const VISUALIZE_TAB_GRAPH_ANALYZER_BUTTON_TEST_ID = 'securitySolutionDocumentDetailsFlyoutVisualizeTabGraphAnalyzerButton'; -export const INSIGHTS_TAB_CONTENT_TEST_ID = - 'securitySolutionDocumentDetailsFlyoutInsightsTabContent'; +export const INSIGHTS_TAB_BUTTON_GROUP_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutInsightsTabButtonGroup'; +export const INSIGHTS_TAB_ENTITIES_BUTTON_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutInsightsTabEntitiesButton'; +export const INSIGHTS_TAB_THREAT_INTELLIGENCE_BUTTON_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutInsightsTabThreatIntelligenceButton'; +export const INSIGHTS_TAB_PREVALENCE_BUTTON_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutInsightsTabPrevalenceButton'; +export const INSIGHTS_TAB_CORRELATIONS_BUTTON_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutInsightsTabCorrelationsButton'; export const INVESTIGATIONS_TAB_CONTENT_TEST_ID = 'securitySolutionDocumentDetailsFlyoutInvestigationsTabContent'; export const HISTORY_TAB_CONTENT_TEST_ID = 'securitySolutionDocumentDetailsFlyoutHistoryTabContent'; diff --git a/x-pack/plugins/security_solution/public/flyout/left/tabs/translations.ts b/x-pack/plugins/security_solution/public/flyout/left/tabs/translations.ts index 643bbb50a5a23..d77cd21e733d1 100644 --- a/x-pack/plugins/security_solution/public/flyout/left/tabs/translations.ts +++ b/x-pack/plugins/security_solution/public/flyout/left/tabs/translations.ts @@ -27,3 +27,38 @@ export const ANALYZER_GRAPH_BUTTON = i18n.translate( defaultMessage: 'Analyzer Graph', } ); + +export const INSIGHTS_BUTTONGROUP_OPTIONS = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.insightsOptions', + { + defaultMessage: 'Insights options', + } +); + +export const ENTITIES_BUTTON = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.entitiesButton', + { + defaultMessage: 'Entities', + } +); + +export const THREAT_INTELLIGENCE_BUTTON = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.threatIntelligenceButton', + { + defaultMessage: 'Threat Intelligence', + } +); + +export const PREVALENCE_BUTTON = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.prevalenceButton', + { + defaultMessage: 'Prevalence', + } +); + +export const CORRELATIONS_BUTTON = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.correlationsButton', + { + defaultMessage: 'Correlations', + } +); diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/description.stories.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/description.stories.tsx index 5588fcbc123bc..72f59d3173edd 100644 --- a/x-pack/plugins/security_solution/public/flyout/right/components/description.stories.tsx +++ b/x-pack/plugins/security_solution/public/flyout/right/components/description.stories.tsx @@ -8,13 +8,9 @@ import React from 'react'; import { css } from '@emotion/react'; import type { Story } from '@storybook/react'; -import { RIGHT_SECTION_WIDTH } from '../..'; import { Description } from './description'; import { RightPanelContext } from '../context'; -const PADDING = 24; -const WIDTH = RIGHT_SECTION_WIDTH - 2 * PADDING; - const ruleUuid = { category: 'kibana', field: 'kibana.alert.rule.uuid', @@ -46,7 +42,7 @@ export const RuleExpand: Story = () => {
@@ -64,7 +60,7 @@ export const RuleCollapse: Story = () => {
@@ -90,7 +86,7 @@ export const Document: Story = () => {
@@ -116,7 +112,7 @@ export const EmptyDescription: Story = () => {
@@ -131,7 +127,7 @@ export const Empty: Story = () => {
diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/entities_overview.test.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/entities_overview.test.tsx new file mode 100644 index 0000000000000..fc98b138879b7 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/entities_overview.test.tsx @@ -0,0 +1,116 @@ +/* + * 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 React from 'react'; +import { render } from '@testing-library/react'; +import { RightPanelContext } from '../context'; +import { + ENTITIES_HEADER_TEST_ID, + ENTITY_PANEL_TEST_ID, + ENTITIES_HOST_OVERVIEW_TEST_ID, + ENTITIES_USER_OVERVIEW_TEST_ID, +} from './test_ids'; +import { EntitiesOverview } from './entities_overview'; +import { TestProviders } from '../../../common/mock'; +import { mockGetFieldsData } from '../mocks/mock_context'; + +describe('', () => { + it('should render user and host by default', () => { + const contextValue = { + eventId: 'event id', + getFieldsData: mockGetFieldsData, + } as unknown as RightPanelContext; + + const { getByTestId, queryByText, getAllByTestId } = render( + + + + + + ); + expect(getByTestId(ENTITIES_HEADER_TEST_ID)).toHaveTextContent('Entities'); + expect(getAllByTestId(ENTITY_PANEL_TEST_ID)).toHaveLength(2); + expect(queryByText('user1')).toBeInTheDocument(); + expect(getByTestId(ENTITIES_USER_OVERVIEW_TEST_ID)).toBeInTheDocument(); + expect(queryByText('host1')).toBeInTheDocument(); + expect(getByTestId(ENTITIES_HOST_OVERVIEW_TEST_ID)).toBeInTheDocument(); + }); + + it('should only render user when host name is null', () => { + const contextValue = { + eventId: 'event id', + getFieldsData: (field: string) => (field === 'user.name' ? 'user1' : null), + } as unknown as RightPanelContext; + + const { queryByTestId, queryByText, getAllByTestId } = render( + + + + + + ); + + expect(queryByTestId(ENTITY_PANEL_TEST_ID)).toBeInTheDocument(); + expect(getAllByTestId(ENTITY_PANEL_TEST_ID)).toHaveLength(1); + expect(queryByText('user1')).toBeInTheDocument(); + expect(queryByTestId(ENTITIES_USER_OVERVIEW_TEST_ID)).toBeInTheDocument(); + }); + + it('should only render host when user name is null', () => { + const contextValue = { + eventId: 'event id', + getFieldsData: (field: string) => (field === 'host.name' ? 'host1' : null), + } as unknown as RightPanelContext; + + const { queryByTestId, queryByText, getAllByTestId } = render( + + + + + + ); + + expect(queryByTestId(ENTITY_PANEL_TEST_ID)).toBeInTheDocument(); + expect(getAllByTestId(ENTITY_PANEL_TEST_ID)).toHaveLength(1); + expect(queryByText('host1')).toBeInTheDocument(); + expect(queryByTestId(ENTITIES_HOST_OVERVIEW_TEST_ID)).toBeInTheDocument(); + }); + + it('should not render if both host name and user name are null/blank', () => { + const contextValue = { + eventId: 'event id', + getFieldsData: (field: string) => {}, + } as unknown as RightPanelContext; + + const { queryByTestId } = render( + + + + + + ); + + expect(queryByTestId(ENTITIES_HEADER_TEST_ID)).not.toBeInTheDocument(); + }); + + it('should not render if eventId is null', () => { + const contextValue = { + eventId: null, + getFieldsData: (field: string) => {}, + } as unknown as RightPanelContext; + + const { queryByTestId } = render( + + + + + + ); + + expect(queryByTestId(ENTITIES_HEADER_TEST_ID)).not.toBeInTheDocument(); + }); +}); diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/entities_overview.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/entities_overview.tsx new file mode 100644 index 0000000000000..9d42ddef6ddec --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/entities_overview.tsx @@ -0,0 +1,90 @@ +/* + * 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 React, { useCallback } from 'react'; +import { EuiFlexGroup, EuiFlexItem, EuiSpacer, EuiTitle, EuiButtonEmpty } from '@elastic/eui'; +import { useExpandableFlyoutContext } from '@kbn/expandable-flyout'; +import { useRightPanelContext } from '../context'; +import { + ENTITIES_HEADER_TEST_ID, + ENTITIES_CONTENT_TEST_ID, + ENTITIES_VIEW_ALL_BUTTON_TEST_ID, +} from './test_ids'; +import { ENTITIES_TITLE, ENTITIES_TEXT, VIEW_ALL } from './translations'; +import { EntityPanel } from './entity_panel'; +import { getField } from '../../shared/utils'; +import { HostEntityOverview } from './host_entity_overview'; +import { UserEntityOverview } from './user_entity_overview'; +import { LeftPanelKey, LeftPanelInsightsTabPath } from '../../left'; + +const USER_ICON = 'user'; +const HOST_ICON = 'storage'; + +/** + * Entities section under Insights section, overview tab. It contains a preview of host and user information. + */ +export const EntitiesOverview: React.FC = () => { + const { eventId, getFieldsData, indexName } = useRightPanelContext(); + const { openLeftPanel } = useExpandableFlyoutContext(); + const hostName = getField(getFieldsData('host.name')); + const userName = getField(getFieldsData('user.name')); + + const goToEntitiesTab = useCallback(() => { + openLeftPanel({ + id: LeftPanelKey, + path: LeftPanelInsightsTabPath, + params: { + id: eventId, + indexName, + }, + }); + }, [eventId, openLeftPanel, indexName]); + + if (!eventId || (!userName && !hostName)) { + return null; + } + + return ( + <> + +
{ENTITIES_TITLE}
+ + + + {userName && ( + + } + /> + + )} + {hostName && ( + + } + /> + + )} + + {VIEW_ALL(ENTITIES_TEXT)} + + + + ); +}; + +EntitiesOverview.displayName = 'EntitiesOverview'; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/entity_panel.stories.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/entity_panel.stories.tsx new file mode 100644 index 0000000000000..a8e7dcf73a152 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/entity_panel.stories.tsx @@ -0,0 +1,41 @@ +/* + * 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 React from 'react'; +import type { Story } from '@storybook/react'; +import { EntityPanel } from './entity_panel'; + +export default { + component: EntityPanel, + title: 'Flyout/EntityPanel', +}; + +const defaultProps = { + title: 'title', + iconType: 'storage', + content: 'test content', +}; + +export const Default: Story = () => { + return ; +}; + +export const Expandable: Story = () => { + return ; +}; + +export const ExpandableDefaultOpen: Story = () => { + return ; +}; + +export const EmptyDefault: Story = () => { + return ; +}; + +export const EmptyDefaultExpanded: Story = () => { + return ; +}; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/entity_panel.test.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/entity_panel.test.tsx new file mode 100644 index 0000000000000..0861c3682d555 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/entity_panel.test.tsx @@ -0,0 +1,112 @@ +/* + * 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 React from 'react'; +import { render } from '@testing-library/react'; +import { EntityPanel } from './entity_panel'; +import { + ENTITY_PANEL_TEST_ID, + ENTITY_PANEL_ICON_TEST_ID, + ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID, + ENTITY_PANEL_HEADER_TEST_ID, + ENTITY_PANEL_CONTENT_TEST_ID, +} from './test_ids'; + +const defaultProps = { + title: 'test', + iconType: 'storage', + content: 'test content', +}; + +describe('', () => { + describe('panel is not expandable by default', () => { + it('should render non-expandable panel by default', () => { + const { getByTestId, queryByTestId } = render(); + + expect(getByTestId(ENTITY_PANEL_TEST_ID)).toBeInTheDocument(); + expect(getByTestId(ENTITY_PANEL_HEADER_TEST_ID)).toHaveTextContent('test'); + expect(getByTestId(ENTITY_PANEL_CONTENT_TEST_ID)).toHaveTextContent('test content'); + + expect(queryByTestId(ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID)).not.toBeInTheDocument(); + expect(getByTestId(ENTITY_PANEL_ICON_TEST_ID).firstChild).toHaveAttribute( + 'data-euiicon-type', + 'storage' + ); + }); + + it('should not render content when content is null', () => { + const { queryByTestId } = render(); + + expect(queryByTestId(ENTITY_PANEL_CONTENT_TEST_ID)).not.toBeInTheDocument(); + expect(queryByTestId(ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID)).not.toBeInTheDocument(); + }); + }); + + describe('panel is expandable', () => { + it('should render panel with toggle and collapsed by default', () => { + const { getByTestId, queryByTestId } = render( + + ); + expect(getByTestId(ENTITY_PANEL_TEST_ID)).toBeInTheDocument(); + expect(getByTestId(ENTITY_PANEL_HEADER_TEST_ID)).toHaveTextContent('test'); + expect(queryByTestId(ENTITY_PANEL_CONTENT_TEST_ID)).not.toBeInTheDocument(); + }); + + it('click toggle button should expand the panel', () => { + const { getByTestId } = render(); + + const toggle = getByTestId(ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID); + expect(toggle.firstChild).toHaveAttribute('data-euiicon-type', 'arrowRight'); + toggle.click(); + + expect(getByTestId(ENTITY_PANEL_CONTENT_TEST_ID)).toHaveTextContent('test content'); + expect(toggle.firstChild).toHaveAttribute('data-euiicon-type', 'arrowDown'); + }); + + it('should not render toggle or content when content is null', () => { + const { queryByTestId } = render( + + ); + expect(queryByTestId(ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID)).not.toBeInTheDocument(); + expect(queryByTestId(ENTITY_PANEL_CONTENT_TEST_ID)).not.toBeInTheDocument(); + }); + }); + + describe('panel is expandable and expanded by default', () => { + it('should render header and content', () => { + const { getByTestId } = render( + + ); + expect(getByTestId(ENTITY_PANEL_TEST_ID)).toBeInTheDocument(); + expect(getByTestId(ENTITY_PANEL_HEADER_TEST_ID)).toHaveTextContent('test'); + expect(getByTestId(ENTITY_PANEL_CONTENT_TEST_ID)).toHaveTextContent('test content'); + expect(getByTestId(ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID)).toBeInTheDocument(); + }); + + it('click toggle button should collapse the panel', () => { + const { getByTestId, queryByTestId } = render( + + ); + + const toggle = getByTestId(ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID); + expect(toggle.firstChild).toHaveAttribute('data-euiicon-type', 'arrowDown'); + expect(getByTestId(ENTITY_PANEL_CONTENT_TEST_ID)).toBeInTheDocument(); + + toggle.click(); + expect(toggle.firstChild).toHaveAttribute('data-euiicon-type', 'arrowRight'); + expect(queryByTestId(ENTITY_PANEL_CONTENT_TEST_ID)).not.toBeInTheDocument(); + }); + + it('should not render content when content is null', () => { + const { queryByTestId } = render( + + ); + expect(queryByTestId(ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID)).not.toBeInTheDocument(); + expect(queryByTestId(ENTITY_PANEL_CONTENT_TEST_ID)).not.toBeInTheDocument(); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/entity_panel.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/entity_panel.tsx new file mode 100644 index 0000000000000..4321939a487c3 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/entity_panel.tsx @@ -0,0 +1,133 @@ +/* + * 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 React, { useMemo, useState, useCallback } from 'react'; +import { + EuiButtonIcon, + EuiSplitPanel, + EuiText, + EuiFlexGroup, + EuiFlexItem, + EuiTitle, + EuiPanel, +} from '@elastic/eui'; +import { + ENTITY_PANEL_TEST_ID, + ENTITY_PANEL_ICON_TEST_ID, + ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID, + ENTITY_PANEL_HEADER_TEST_ID, + ENTITY_PANEL_CONTENT_TEST_ID, +} from './test_ids'; + +export interface EntityPanelProps { + /** + * String value of the title to be displayed in the header of panel + */ + title: string; + /** + * Icon string for displaying the specified icon in the header + */ + iconType: string; + /** + * Content to show in the content section of the panel + */ + content?: string | React.ReactNode; + /** + * Boolean to determine the panel to be collapsable (with toggle) + */ + expandable?: boolean; + /** + * Boolean to allow the component to be expanded or collapsed on first render + */ + expanded?: boolean; +} + +/** + * Panel component to display user or host information. + */ +export const EntityPanel: React.FC = ({ + title, + iconType, + content, + expandable = false, + expanded = false, +}) => { + const [toggleStatus, setToggleStatus] = useState(expanded); + const toggleQuery = useCallback(() => { + setToggleStatus(!toggleStatus); + }, [setToggleStatus, toggleStatus]); + + const toggleIcon = useMemo( + () => ( + + + + ), + [toggleStatus, toggleQuery] + ); + + const icon = useMemo(() => { + return ( + + ); + }, [iconType]); + + const showContent = useMemo(() => { + if (!content) { + return false; + } + return !expandable || (expandable && toggleStatus); + }, [content, expandable, toggleStatus]); + + const panelHeader = useMemo(() => { + return ( + + {expandable && content && toggleIcon} + {icon} + + + {title} + + + + ); + }, [title, icon, content, toggleIcon, expandable]); + + return ( + + + {panelHeader} + + {showContent && ( + + {content} + + )} + + ); +}; + +EntityPanel.displayName = 'EntityPanel'; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.stories.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.stories.tsx index b0adfdfeb4d67..8b98a72cc90a4 100644 --- a/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.stories.tsx +++ b/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.stories.tsx @@ -19,27 +19,7 @@ export default { // TODO ideally we would want to have some data here, but we need to spent some time getting all the foundation items for storybook // (ReduxStoreProvider, CellActionsProvider...) similarly to how it was done for the TestProvidersComponent // see ticket https://github.com/elastic/security-team/issues/6223 -export const Expanded: Story = () => { - const flyoutContextValue = { - openRightPanel: () => window.alert('openRightPanel called'), - } as unknown as ExpandableFlyoutContext; - const panelContextValue = { - eventId: 'eventId', - indexName: 'indexName', - dataFormattedForFieldBrowser: [], - browserFields: {}, - } as unknown as RightPanelContext; - - return ( - - - - - - ); -}; - -export const Collapsed: Story = () => { +export const Default: Story = () => { const flyoutContextValue = { openRightPanel: () => window.alert('openRightPanel called'), } as unknown as ExpandableFlyoutContext; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.test.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.test.tsx index 4724b6f9a9c49..52a85b66a3108 100644 --- a/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.test.tsx +++ b/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.test.tsx @@ -8,75 +8,19 @@ import React from 'react'; import { render } from '@testing-library/react'; import { RightPanelContext } from '../context'; -import { - HIGHLIGHTED_FIELDS_DETAILS_TEST_ID, - HIGHLIGHTED_FIELDS_GO_TO_TABLE_LINK, - HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON_TEST_ID, - HIGHLIGHTED_FIELDS_HEADER_TITLE_TEST_ID, -} from './test_ids'; +import { HIGHLIGHTED_FIELDS_DETAILS_TEST_ID, HIGHLIGHTED_FIELDS_TITLE_TEST_ID } from './test_ids'; import { ExpandableFlyoutContext } from '@kbn/expandable-flyout/src/context'; import { HighlightedFields } from './highlighted_fields'; -import { RightPanelKey, RightPanelTableTabPath } from '..'; import { getMockTheme } from '../../../common/lib/kibana/kibana_react.mock'; import { ThemeProvider } from 'styled-components'; -const mockTheme = getMockTheme({ - eui: { - euiSizeL: '10px', - }, -}); - describe('', () => { - it('should render the component collapsed', () => { - const flyoutContextValue = { - openRightPanel: jest.fn(), - } as unknown as ExpandableFlyoutContext; - const panelContextValue = { - eventId: 'eventId', - indexName: 'indexName', - dataFormattedForFieldBrowser: [], - browserFields: {}, - } as unknown as RightPanelContext; - - const { getByTestId } = render( - - - - - - - - ); - - expect(getByTestId(HIGHLIGHTED_FIELDS_HEADER_TITLE_TEST_ID)).toBeInTheDocument(); - }); - - it('should render the component expanded', () => { - const flyoutContextValue = { - openRightPanel: jest.fn(), - } as unknown as ExpandableFlyoutContext; - const panelContextValue = { - eventId: 'eventId', - indexName: 'indexName', - dataFormattedForFieldBrowser: [], - browserFields: {}, - } as unknown as RightPanelContext; - - const { getByTestId } = render( - - - - - - - - ); - - expect(getByTestId(HIGHLIGHTED_FIELDS_HEADER_TITLE_TEST_ID)).toBeInTheDocument(); - expect(getByTestId(HIGHLIGHTED_FIELDS_DETAILS_TEST_ID)).toBeInTheDocument(); - }); - - it('should expand details when clicking on header', () => { + it('should render the component', () => { + const mockTheme = getMockTheme({ + eui: { + euiSizeL: '10px', + }, + }); const flyoutContextValue = { openRightPanel: jest.fn(), } as unknown as ExpandableFlyoutContext; @@ -97,43 +41,10 @@ describe('', () => { ); - getByTestId(HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON_TEST_ID).click(); + expect(getByTestId(HIGHLIGHTED_FIELDS_TITLE_TEST_ID)).toBeInTheDocument(); expect(getByTestId(HIGHLIGHTED_FIELDS_DETAILS_TEST_ID)).toBeInTheDocument(); }); - it('should navigate to table tab when clicking on the link button', () => { - const flyoutContextValue = { - openRightPanel: jest.fn(), - } as unknown as ExpandableFlyoutContext; - const panelContextValue = { - eventId: 'eventId', - indexName: 'indexName', - dataFormattedForFieldBrowser: [], - browserFields: {}, - } as unknown as RightPanelContext; - - const { getByTestId } = render( - - - - - - - - ); - - getByTestId(HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON_TEST_ID).click(); - getByTestId(HIGHLIGHTED_FIELDS_GO_TO_TABLE_LINK).click(); - expect(flyoutContextValue.openRightPanel).toHaveBeenCalledWith({ - id: RightPanelKey, - path: RightPanelTableTabPath, - params: { - id: panelContextValue.eventId, - indexName: panelContextValue.indexName, - }, - }); - }); - it('should render empty component if dataFormattedForFieldBrowser is null', () => { const flyoutContextValue = {} as unknown as ExpandableFlyoutContext; const panelContextValue = { diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.tsx index f8f7ed46f505f..1c0ee677d9e80 100644 --- a/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.tsx +++ b/x-pack/plugins/security_solution/public/flyout/right/components/highlighted_fields.tsx @@ -5,27 +5,17 @@ * 2.0. */ -import { EuiFlexGroup } from '@elastic/eui'; -import type { VFC } from 'react'; -import React, { useCallback, useState } from 'react'; +import type { FC } from 'react'; +import React, { useCallback } from 'react'; import { useExpandableFlyoutContext } from '@kbn/expandable-flyout'; -import { HIGHLIGHTED_FIELDS_TEST_ID } from './test_ids'; +import { EuiFlexGroup, EuiFlexItem, EuiPanel, EuiTitle } from '@elastic/eui'; +import { HIGHLIGHTED_FIELDS_DETAILS_TEST_ID, HIGHLIGHTED_FIELDS_TITLE_TEST_ID } from './test_ids'; import { AlertSummaryView } from '../../../common/components/event_details/alert_summary_view'; import { HIGHLIGHTED_FIELDS_TITLE } from './translations'; -import { HeaderSection } from '../../../common/components/header_section'; import { useRightPanelContext } from '../context'; import { RightPanelKey, RightPanelTableTabPath } from '..'; -export interface HighlightedFieldsProps { - /** - * Boolean to allow the component to be expanded or collapsed on first render - */ - expanded?: boolean; -} - -export const HighlightedFields: VFC = ({ expanded = false }) => { - const [isPanelExpanded, setIsPanelExpanded] = useState(expanded); - +export const HighlightedFields: FC = () => { const { openRightPanel } = useExpandableFlyoutContext(); const { eventId, indexName, dataFormattedForFieldBrowser, browserFields } = useRightPanelContext(); @@ -46,28 +36,26 @@ export const HighlightedFields: VFC = ({ expanded = fals } return ( - - - {isPanelExpanded && ( - - )} + + + +
{HIGHLIGHTED_FIELDS_TITLE}
+ + + + + + + ); }; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/host_entity_overview.test.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/host_entity_overview.test.tsx new file mode 100644 index 0000000000000..b3a6a1043c030 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/host_entity_overview.test.tsx @@ -0,0 +1,106 @@ +/* + * 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 React from 'react'; +import { render } from '@testing-library/react'; +import { TestProviders } from '../../../common/mock'; +import { HostEntityOverview } from './host_entity_overview'; +import { useRiskScore } from '../../../explore/containers/risk_score'; +import { useHostDetails } from '../../../explore/hosts/containers/hosts/details'; +import { + ENTITIES_HOST_OVERVIEW_IP_TEST_ID, + ENTITIES_HOST_OVERVIEW_RISK_LEVEL_TEST_ID, + TECHNICAL_PREVIEW_ICON_TEST_ID, +} from './test_ids'; + +const hostName = 'host'; +const ip = '10.200.000.000'; +const from = '2022-04-05T12:00:00.000Z'; +const to = '2022-04-08T12:00:00.;000Z'; +const selectedPatterns = 'alerts'; +const hostData = { host: { ip: [ip] } }; +const riskLevel = [{ host: { risk: { calculated_level: 'Medium' } } }]; + +const mockUseGlobalTime = jest.fn().mockReturnValue({ from, to }); +jest.mock('../../../common/containers/use_global_time', () => { + return { + useGlobalTime: (...props: unknown[]) => mockUseGlobalTime(...props), + }; +}); + +const mockUseSourcererDataView = jest.fn().mockReturnValue({ selectedPatterns }); +jest.mock('../../../common/containers/sourcerer', () => { + return { + useSourcererDataView: (...props: unknown[]) => mockUseSourcererDataView(...props), + }; +}); + +const mockUseHostDetails = useHostDetails as jest.Mock; +jest.mock('../../../explore/hosts/containers/hosts/details'); + +const mockUseRiskScore = useRiskScore as jest.Mock; +jest.mock('../../../explore/containers/risk_score'); + +describe('', () => { + describe('license is valid', () => { + it('should render ip addresses and host risk classification', () => { + mockUseHostDetails.mockReturnValue([false, { hostDetails: hostData }]); + mockUseRiskScore.mockReturnValue({ data: riskLevel, isLicenseValid: true }); + + const { getByTestId } = render( + + + + ); + + expect(getByTestId(ENTITIES_HOST_OVERVIEW_IP_TEST_ID)).toHaveTextContent(ip); + expect(getByTestId(TECHNICAL_PREVIEW_ICON_TEST_ID)).toBeInTheDocument(); + expect(getByTestId(ENTITIES_HOST_OVERVIEW_RISK_LEVEL_TEST_ID)).toHaveTextContent('Medium'); + }); + + it('should render correctly if returned data is null', () => { + mockUseHostDetails.mockReturnValue([false, { hostDetails: null }]); + mockUseRiskScore.mockReturnValue({ data: null, isLicenseValid: true }); + + const { getByTestId } = render( + + + + ); + expect(getByTestId(ENTITIES_HOST_OVERVIEW_IP_TEST_ID)).toHaveTextContent('—'); + expect(getByTestId(TECHNICAL_PREVIEW_ICON_TEST_ID)).toBeInTheDocument(); + expect(getByTestId(ENTITIES_HOST_OVERVIEW_RISK_LEVEL_TEST_ID)).toHaveTextContent('Unknown'); + }); + }); + + describe('license is not valid', () => { + it('should render ip but not host risk classification', () => { + mockUseHostDetails.mockReturnValue([false, { hostDetails: hostData }]); + mockUseRiskScore.mockReturnValue({ data: riskLevel, isLicenseValid: false }); + const { getByTestId, queryByTestId } = render( + + + + ); + + expect(getByTestId(ENTITIES_HOST_OVERVIEW_IP_TEST_ID)).toHaveTextContent(ip); + expect(queryByTestId(ENTITIES_HOST_OVERVIEW_RISK_LEVEL_TEST_ID)).not.toBeInTheDocument(); + }); + + it('should render correctly if returned data is null', () => { + mockUseHostDetails.mockReturnValue([false, { hostDetails: null }]); + mockUseRiskScore.mockReturnValue({ data: null, isLicenseValid: false }); + const { getByTestId, queryByTestId } = render( + + + + ); + + expect(getByTestId(ENTITIES_HOST_OVERVIEW_IP_TEST_ID)).toHaveTextContent('—'); + expect(queryByTestId(TECHNICAL_PREVIEW_ICON_TEST_ID)).not.toBeInTheDocument(); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/host_entity_overview.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/host_entity_overview.tsx new file mode 100644 index 0000000000000..c7b3484f19086 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/host_entity_overview.tsx @@ -0,0 +1,152 @@ +/* + * 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 React, { useMemo } from 'react'; +import { EuiFlexGroup, EuiFlexItem, EuiBetaBadge } from '@elastic/eui'; +import { getOr } from 'lodash/fp'; +import styled from 'styled-components'; +import type { DescriptionList } from '../../../../common/utility_types'; +import { + buildHostNamesFilter, + RiskScoreEntity, + RiskSeverity, +} from '../../../../common/search_strategy'; +import { DefaultFieldRenderer } from '../../../timelines/components/field_renderers/field_renderers'; +import { NetworkDetailsLink } from '../../../common/components/links'; +import { DescriptionListStyled } from '../../../common/components/page'; +import { OverviewDescriptionList } from '../../../common/components/overview_description_list'; +import { RiskScore } from '../../../explore/components/risk_score/severity/common'; +import { getEmptyTagValue } from '../../../common/components/empty_value'; +import { useSourcererDataView } from '../../../common/containers/sourcerer'; +import { useGlobalTime } from '../../../common/containers/use_global_time'; +import { useRiskScore } from '../../../explore/containers/risk_score'; +import { useHostDetails } from '../../../explore/hosts/containers/hosts/details'; +import * as i18n from '../../../overview/components/host_overview/translations'; +import { TECHNICAL_PREVIEW_TITLE, TECHNICAL_PREVIEW_MESSAGE } from './translations'; +import { + TECHNICAL_PREVIEW_ICON_TEST_ID, + ENTITIES_HOST_OVERVIEW_TEST_ID, + ENTITIES_HOST_OVERVIEW_IP_TEST_ID, + ENTITIES_HOST_OVERVIEW_RISK_LEVEL_TEST_ID, +} from './test_ids'; + +const StyledEuiBetaBadge = styled(EuiBetaBadge)` + margin-left: ${({ theme }) => theme.eui.euiSizeXS}; +`; +const CONTEXT_ID = `flyout-host-entity-overview`; + +export interface HostEntityOverviewProps { + /** + * Host name for looking up host related ip addresses and risk classification + */ + hostName: string; +} + +/** + * Host preview content for the entities preview in right flyout. It contains ip addresses and risk classification + */ +export const HostEntityOverview: React.FC = ({ hostName }) => { + const { from, to } = useGlobalTime(); + const { selectedPatterns } = useSourcererDataView(); + + const timerange = useMemo( + () => ({ + from, + to, + }), + [from, to] + ); + + const filterQuery = useMemo( + () => (hostName ? buildHostNamesFilter([hostName]) : undefined), + [hostName] + ); + + const { data: hostRisk, isLicenseValid } = useRiskScore({ + filterQuery, + riskEntity: RiskScoreEntity.host, + skip: hostName == null, + timerange, + }); + + const [_, { hostDetails }] = useHostDetails({ + hostName, + indexNames: selectedPatterns, + startDate: from, + endDate: to, + }); + + const [hostRiskLevel] = useMemo(() => { + const hostRiskData = hostRisk && hostRisk.length > 0 ? hostRisk[0] : undefined; + return [ + { + title: ( + <> + {i18n.HOST_RISK_CLASSIFICATION} + + + ), + description: ( + <> + {hostRiskData ? ( + + ) : ( + + )} + + ), + }, + ]; + }, [hostRisk]); + + const descriptionList: DescriptionList[] = useMemo( + () => [ + { + title: i18n.IP_ADDRESSES, + description: ( + (ip != null ? : getEmptyTagValue())} + /> + ), + }, + ], + [hostDetails] + ); + + return ( + + + + + + {isLicenseValid && ( + + )} + + + ); +}; + +HostEntityOverview.displayName = 'HostEntityOverview'; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/insights_section.stories.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/insights_section.stories.tsx new file mode 100644 index 0000000000000..953edc6d57f99 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/insights_section.stories.tsx @@ -0,0 +1,51 @@ +/* + * 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 React from 'react'; +import type { Story } from '@storybook/react'; +import { ExpandableFlyoutContext } from '@kbn/expandable-flyout/src/context'; +import { InsightsSection } from './insights_section'; +import { RightPanelContext } from '../context'; + +const flyoutContextValue = { + openLeftPanel: () => window.alert('openLeftPanel'), +} as unknown as ExpandableFlyoutContext; +const panelContextValue = { + getFieldsData: () => ({ + host: { + name: 'hostName', + }, + user: { + name: 'userName', + }, + }), +} as unknown as RightPanelContext; + +export default { + component: InsightsSection, + title: 'Flyout/InsightsSection', +}; + +export const Expand: Story = () => { + return ( + + + + + + ); +}; + +export const Collapse: Story = () => { + return ( + + + + + + ); +}; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/insights_section.test.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/insights_section.test.tsx new file mode 100644 index 0000000000000..3db91442ee94e --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/insights_section.test.tsx @@ -0,0 +1,64 @@ +/* + * 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 React from 'react'; +import { render } from '@testing-library/react'; +import { RightPanelContext } from '../context'; +import { INSIGHTS_HEADER_TEST_ID } from './test_ids'; +import { TestProviders } from '../../../common/mock'; +import { mockGetFieldsData } from '../mocks/mock_context'; +import { InsightsSection } from './insights_section'; + +const mockDispatch = jest.fn(); +jest.mock('react-redux', () => { + const original = jest.requireActual('react-redux'); + + return { + ...original, + useDispatch: () => mockDispatch, + }; +}); + +describe('', () => { + it('should render insights component', () => { + const contextValue = { + eventId: 'some_Id', + getFieldsData: mockGetFieldsData, + } as unknown as RightPanelContext; + + const wrapper = render( + + + + + + ); + + expect(wrapper.getByTestId(INSIGHTS_HEADER_TEST_ID)).toBeInTheDocument(); + expect(wrapper.getAllByRole('button')[0]).toHaveAttribute('aria-expanded', 'false'); + expect(wrapper.getAllByRole('button')[0]).not.toHaveAttribute('disabled'); + }); + + it('should render insights component as expanded when expanded is true', () => { + const contextValue = { + eventId: 'some_Id', + getFieldsData: mockGetFieldsData, + } as unknown as RightPanelContext; + + const wrapper = render( + + + + + + ); + + expect(wrapper.getByTestId(INSIGHTS_HEADER_TEST_ID)).toBeInTheDocument(); + expect(wrapper.getAllByRole('button')[0]).toHaveAttribute('aria-expanded', 'true'); + expect(wrapper.getAllByRole('button')[0]).not.toHaveAttribute('disabled'); + }); +}); diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/insights_section.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/insights_section.tsx new file mode 100644 index 0000000000000..8409676b610b0 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/insights_section.tsx @@ -0,0 +1,32 @@ +/* + * 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 React from 'react'; +import { INSIGHTS_TEST_ID } from './test_ids'; +import { INSIGHTS_TITLE } from './translations'; +import { EntitiesOverview } from './entities_overview'; +import { ExpandableSection } from './expandable_section'; + +export interface InsightsSectionProps { + /** + * Boolean to allow the component to be expanded or collapsed on first render + */ + expanded?: boolean; +} + +/** + * Insights section under overview tab. It contains entities, threat intelligence, prevalence and correlations. + */ +export const InsightsSection: React.FC = ({ expanded = false }) => { + return ( + + + + ); +}; + +InsightsSection.displayName = 'InsightsSection'; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/investigation_section.stories.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/investigation_section.stories.tsx new file mode 100644 index 0000000000000..e7e1bc59b579a --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/investigation_section.stories.tsx @@ -0,0 +1,44 @@ +/* + * 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 React from 'react'; +import type { Story } from '@storybook/react'; +import { ExpandableFlyoutContext } from '@kbn/expandable-flyout/src/context'; +import { InvestigationSection } from './investigation_section'; +import { mockDataFormattedForFieldBrowser, mockSearchHit } from '../mocks/mock_context'; +import { RightPanelContext } from '../context'; + +const flyoutContextValue = {} as unknown as ExpandableFlyoutContext; +const panelContextValue = { + dataFormattedForFieldBrowser: mockDataFormattedForFieldBrowser, + searchHit: mockSearchHit, +} as unknown as RightPanelContext; + +export default { + component: InvestigationSection, + title: 'Flyout/InvestigationSection', +}; + +export const Expand: Story = () => { + return ( + + + + + + ); +}; + +export const Collapse: Story = () => { + return ( + + + + + + ); +}; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/investigation_section.test.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/investigation_section.test.tsx new file mode 100644 index 0000000000000..308fca2d0a465 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/investigation_section.test.tsx @@ -0,0 +1,59 @@ +/* + * 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 React from 'react'; +import { render } from '@testing-library/react'; +import { + INVESTIGATION_SECTION_CONTENT_TEST_ID, + INVESTIGATION_SECTION_HEADER_TEST_ID, +} from './test_ids'; +import { RightPanelContext } from '../context'; +import { InvestigationSection } from './investigation_section'; +import { ExpandableFlyoutContext } from '@kbn/expandable-flyout/src/context'; + +const flyoutContextValue = {} as unknown as ExpandableFlyoutContext; +const panelContextValue = {} as unknown as RightPanelContext; + +describe('', () => { + it('should render the component collapsed', () => { + const { getByTestId } = render( + + + + + + ); + + expect(getByTestId(INVESTIGATION_SECTION_HEADER_TEST_ID)).toBeInTheDocument(); + }); + + it('should render the component expanded', () => { + const { getByTestId } = render( + + + + + + ); + + expect(getByTestId(INVESTIGATION_SECTION_HEADER_TEST_ID)).toBeInTheDocument(); + expect(getByTestId(INVESTIGATION_SECTION_CONTENT_TEST_ID)).toBeInTheDocument(); + }); + + it('should expand the component when clicking on the arrow on header', () => { + const { getByTestId } = render( + + + + + + ); + + getByTestId(INVESTIGATION_SECTION_HEADER_TEST_ID).click(); + expect(getByTestId(INVESTIGATION_SECTION_CONTENT_TEST_ID)).toBeInTheDocument(); + }); +}); diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/investigation_section.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/investigation_section.tsx new file mode 100644 index 0000000000000..8c28a2f80469a --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/investigation_section.tsx @@ -0,0 +1,37 @@ +/* + * 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 { VFC } from 'react'; +import React from 'react'; +import { ExpandableSection } from './expandable_section'; +import { HighlightedFields } from './highlighted_fields'; +import { INVESTIGATION_SECTION_TEST_ID } from './test_ids'; +import { INVESTIGATION_TITLE } from './translations'; + +export interface DescriptionSectionProps { + /** + * Boolean to allow the component to be expanded or collapsed on first render + */ + expanded?: boolean; +} + +/** + * Most top section of the overview tab. It contains the description, reason and mitre attack information (for a document of type alert). + */ +export const InvestigationSection: VFC = ({ expanded = false }) => { + return ( + + + + ); +}; + +InvestigationSection.displayName = 'InvestigationSection'; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/test_ids.ts b/x-pack/plugins/security_solution/public/flyout/right/components/test_ids.ts index 4a6ceabae57e3..65850272b2289 100644 --- a/x-pack/plugins/security_solution/public/flyout/right/components/test_ids.ts +++ b/x-pack/plugins/security_solution/public/flyout/right/components/test_ids.ts @@ -7,11 +7,23 @@ import { CONTENT_TEST_ID, HEADER_TEST_ID } from './expandable_section'; +/* Header */ + export const FLYOUT_HEADER_TITLE_TEST_ID = 'securitySolutionDocumentDetailsFlyoutHeaderTitle'; export const EXPAND_DETAILS_BUTTON_TEST_ID = 'securitySolutionDocumentDetailsFlyoutHeaderExpandDetailButton'; export const COLLAPSE_DETAILS_BUTTON_TEST_ID = 'securitySolutionDocumentDetailsFlyoutHeaderCollapseDetailButton'; +export const FLYOUT_HEADER_SEVERITY_TITLE_TEST_ID = + 'securitySolutionAlertDetailsFlyoutHeaderSeverityTitle'; +export const FLYOUT_HEADER_SEVERITY_VALUE_TEST_ID = 'severity'; +export const FLYOUT_HEADER_RISK_SCORE_TITLE_TEST_ID = + 'securitySolutionAlertDetailsFlyoutHeaderRiskScoreTitle'; +export const FLYOUT_HEADER_RISK_SCORE_VALUE_TEST_ID = + 'securitySolutionAlertDetailsFlyoutHeaderRiskScoreValue'; + +/* Description section */ + export const DESCRIPTION_SECTION_TEST_ID = 'securitySolutionDocumentDetailsFlyoutDescriptionSection'; export const DESCRIPTION_SECTION_HEADER_TEST_ID = DESCRIPTION_SECTION_TEST_ID + HEADER_TEST_ID; @@ -25,15 +37,46 @@ export const REASON_TITLE_TEST_ID = 'securitySolutionDocumentDetailsFlyoutReason export const REASON_DETAILS_TEST_ID = 'securitySolutionDocumentDetailsFlyoutReasonDetails'; export const MITRE_ATTACK_TITLE_TEST_ID = 'securitySolutionAlertDetailsFlyoutMitreAttackTitle'; export const MITRE_ATTACK_DETAILS_TEST_ID = 'securitySolutionAlertDetailsFlyoutMitreAttackDetails'; -export const FLYOUT_HEADER_SEVERITY_TITLE_TEST_ID = - 'securitySolutionAlertDetailsFlyoutHeaderSeverityTitle'; -export const FLYOUT_HEADER_SEVERITY_VALUE_TEST_ID = 'severity'; -export const FLYOUT_HEADER_RISK_SCORE_TITLE_TEST_ID = - 'securitySolutionAlertDetailsFlyoutHeaderRiskScoreTitle'; -export const FLYOUT_HEADER_RISK_SCORE_VALUE_TEST_ID = - 'securitySolutionAlertDetailsFlyoutHeaderRiskScoreValue'; + +/* Investigation section */ + +export const INVESTIGATION_SECTION_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutInvestigationSection'; +export const INVESTIGATION_SECTION_HEADER_TEST_ID = INVESTIGATION_SECTION_TEST_ID + HEADER_TEST_ID; +export const INVESTIGATION_SECTION_CONTENT_TEST_ID = + INVESTIGATION_SECTION_TEST_ID + CONTENT_TEST_ID; +export const HIGHLIGHTED_FIELDS_TITLE_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutHighlightedFieldsTitle'; +export const HIGHLIGHTED_FIELDS_DETAILS_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutHighlightedFieldsDetails'; export const HIGHLIGHTED_FIELDS_TEST_ID = 'securitySolutionDocumentDetailsFlyoutHighlightedFields'; export const HIGHLIGHTED_FIELDS_HEADER_EXPAND_ICON_TEST_ID = 'query-toggle-header'; -export const HIGHLIGHTED_FIELDS_HEADER_TITLE_TEST_ID = 'header-section-title'; -export const HIGHLIGHTED_FIELDS_DETAILS_TEST_ID = 'summary-view'; export const HIGHLIGHTED_FIELDS_GO_TO_TABLE_LINK = 'summary-view-go-to-table-link'; +export const INSIGHTS_TEST_ID = 'securitySolutionDocumentDetailsFlyoutInsights'; +export const INSIGHTS_HEADER_TEST_ID = 'securitySolutionDocumentDetailsFlyoutInsightsHeader'; +export const ENTITIES_HEADER_TEST_ID = 'securitySolutionDocumentDetailsFlyoutEntitiesHeader'; +export const ENTITIES_CONTENT_TEST_ID = 'securitySolutionDocumentDetailsFlyoutEntitiesContent'; +export const ENTITIES_VIEW_ALL_BUTTON_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntitiesViewAllButton'; +export const ENTITY_PANEL_TEST_ID = 'securitySolutionDocumentDetailsFlyoutEntityPanel'; +export const ENTITY_PANEL_ICON_TEST_ID = 'securitySolutionDocumentDetailsFlyoutEntityPanelTypeIcon'; +export const ENTITY_PANEL_TOGGLE_BUTTON_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntityPanelToggleButton'; +export const ENTITY_PANEL_HEADER_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntityPanelHeaderTitle'; +export const ENTITY_PANEL_CONTENT_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntityPanelContent'; +export const TECHNICAL_PREVIEW_ICON_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutTechnicalPreviewIcon'; +export const ENTITIES_USER_OVERVIEW_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntitiesUserOverview'; +export const ENTITIES_USER_OVERVIEW_IP_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntitiesUserOverviewIP'; +export const ENTITIES_USER_OVERVIEW_RISK_LEVEL_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntitiesUserOverviewRiskLevel'; +export const ENTITIES_HOST_OVERVIEW_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntitiesHostOverview'; +export const ENTITIES_HOST_OVERVIEW_IP_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntitiesHostOverviewIP'; +export const ENTITIES_HOST_OVERVIEW_RISK_LEVEL_TEST_ID = + 'securitySolutionDocumentDetailsFlyoutEntitiesHostOverviewRiskLevel'; diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/translations.ts b/x-pack/plugins/security_solution/public/flyout/right/components/translations.ts index 3d3a21b7faa0b..169299e895e24 100644 --- a/x-pack/plugins/security_solution/public/flyout/right/components/translations.ts +++ b/x-pack/plugins/security_solution/public/flyout/right/components/translations.ts @@ -7,6 +7,8 @@ import { i18n } from '@kbn/i18n'; +/* Header */ + export const EXPAND_DETAILS_BUTTON = i18n.translate( 'xpack.securitySolution.flyout.documentDetails.expandDetailButton', { defaultMessage: 'Expand alert details' } @@ -36,6 +38,8 @@ export const RISK_SCORE_TITLE = i18n.translate( } ); +/* Description section */ + export const DESCRIPTION_TITLE = i18n.translate( 'xpack.securitySolution.flyout.documentDetails.descriptionTitle', { @@ -83,7 +87,52 @@ export const DOCUMENT_REASON_TITLE = i18n.translate( } ); +/* Investigation section */ + +export const INVESTIGATION_TITLE = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.investigationSectionTitle', + { + defaultMessage: 'Investigation', + } +); + export const HIGHLIGHTED_FIELDS_TITLE = i18n.translate( 'xpack.securitySolution.flyout.documentDetails.highlightedFieldsTitle', { defaultMessage: 'Highlighted fields' } ); + +export const ENTITIES_TITLE = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.entitiesTitle', + { defaultMessage: 'Entities' } +); + +export const INSIGHTS_TITLE = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.insightsTitle', + { defaultMessage: 'Insights' } +); + +export const TECHNICAL_PREVIEW_TITLE = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.technicalPreviewTitle', + { defaultMessage: 'Technical Preview' } +); + +export const TECHNICAL_PREVIEW_MESSAGE = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.technicalPreviewMessage', + { + defaultMessage: + 'This functionality is in technical preview and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.', + } +); + +export const ENTITIES_TEXT = i18n.translate( + 'xpack.securitySolution.flyout.documentDetails.overviewTab.entitiesText', + { + defaultMessage: 'entities', + } +); + +export const VIEW_ALL = (text: string) => + i18n.translate('xpack.securitySolution.flyout.documentDetails.overviewTab.viewAllButton', { + values: { text }, + defaultMessage: 'View all {text}', + }); diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/user_entity_overview.test.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/user_entity_overview.test.tsx new file mode 100644 index 0000000000000..b868d1161a65b --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/user_entity_overview.test.tsx @@ -0,0 +1,106 @@ +/* + * 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 React from 'react'; +import { render } from '@testing-library/react'; +import { TestProviders } from '../../../common/mock'; +import { UserEntityOverview } from './user_entity_overview'; +import { useRiskScore } from '../../../explore/containers/risk_score'; +import { useUserDetails } from '../../../explore/users/containers/users/details'; +import { + ENTITIES_USER_OVERVIEW_IP_TEST_ID, + ENTITIES_USER_OVERVIEW_RISK_LEVEL_TEST_ID, + TECHNICAL_PREVIEW_ICON_TEST_ID, +} from './test_ids'; + +const userName = 'user'; +const ip = '10.200.000.000'; +const from = '2022-04-05T12:00:00.000Z'; +const to = '2022-04-08T12:00:00.;000Z'; +const selectedPatterns = 'alerts'; +const userData = { host: { ip: [ip] } }; +const riskLevel = [{ user: { risk: { calculated_level: 'Medium' } } }]; + +const mockUseGlobalTime = jest.fn().mockReturnValue({ from, to }); +jest.mock('../../../common/containers/use_global_time', () => { + return { + useGlobalTime: (...props: unknown[]) => mockUseGlobalTime(...props), + }; +}); + +const mockUseSourcererDataView = jest.fn().mockReturnValue({ selectedPatterns }); +jest.mock('../../../common/containers/sourcerer', () => { + return { + useSourcererDataView: (...props: unknown[]) => mockUseSourcererDataView(...props), + }; +}); + +const mockUseUserDetails = useUserDetails as jest.Mock; +jest.mock('../../../explore/users/containers/users/details'); + +const mockUseRiskScore = useRiskScore as jest.Mock; +jest.mock('../../../explore/containers/risk_score'); + +describe('', () => { + describe('license is valid', () => { + it('should render ip addresses and user risk classification', () => { + mockUseUserDetails.mockReturnValue([false, { userDetails: userData }]); + mockUseRiskScore.mockReturnValue({ data: riskLevel, isLicenseValid: true }); + + const { getByTestId } = render( + + + + ); + + expect(getByTestId(ENTITIES_USER_OVERVIEW_IP_TEST_ID)).toHaveTextContent(ip); + expect(getByTestId(TECHNICAL_PREVIEW_ICON_TEST_ID)).toBeInTheDocument(); + expect(getByTestId(ENTITIES_USER_OVERVIEW_RISK_LEVEL_TEST_ID)).toHaveTextContent('Medium'); + }); + + it('should render correctly if returned data is null', () => { + mockUseUserDetails.mockReturnValue([false, { userDetails: null }]); + mockUseRiskScore.mockReturnValue({ data: null, isLicenseValid: true }); + + const { getByTestId } = render( + + + + ); + expect(getByTestId(ENTITIES_USER_OVERVIEW_IP_TEST_ID)).toHaveTextContent('—'); + expect(getByTestId(TECHNICAL_PREVIEW_ICON_TEST_ID)).toBeInTheDocument(); + expect(getByTestId(ENTITIES_USER_OVERVIEW_RISK_LEVEL_TEST_ID)).toHaveTextContent('Unknown'); + }); + }); + + describe('license is not valid', () => { + it('should render ip but not user risk classification', () => { + mockUseUserDetails.mockReturnValue([false, { userDetails: userData }]); + mockUseRiskScore.mockReturnValue({ data: riskLevel, isLicenseValid: false }); + const { getByTestId, queryByTestId } = render( + + + + ); + + expect(getByTestId(ENTITIES_USER_OVERVIEW_IP_TEST_ID)).toHaveTextContent(ip); + expect(queryByTestId(ENTITIES_USER_OVERVIEW_RISK_LEVEL_TEST_ID)).not.toBeInTheDocument(); + }); + + it('should render correctly if returned data is null', () => { + mockUseUserDetails.mockReturnValue([false, { userDetails: null }]); + mockUseRiskScore.mockReturnValue({ data: null, isLicenseValid: false }); + const { getByTestId, queryByTestId } = render( + + + + ); + + expect(getByTestId(ENTITIES_USER_OVERVIEW_IP_TEST_ID)).toHaveTextContent('—'); + expect(queryByTestId(TECHNICAL_PREVIEW_ICON_TEST_ID)).not.toBeInTheDocument(); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/public/flyout/right/components/user_entity_overview.tsx b/x-pack/plugins/security_solution/public/flyout/right/components/user_entity_overview.tsx new file mode 100644 index 0000000000000..bf793a1d058ac --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/right/components/user_entity_overview.tsx @@ -0,0 +1,152 @@ +/* + * 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 React, { useMemo } from 'react'; +import { EuiFlexGroup, EuiFlexItem, EuiBetaBadge } from '@elastic/eui'; +import { getOr } from 'lodash/fp'; +import styled from 'styled-components'; +import type { DescriptionList } from '../../../../common/utility_types'; +import { + buildUserNamesFilter, + RiskScoreEntity, + RiskSeverity, +} from '../../../../common/search_strategy'; +import { DefaultFieldRenderer } from '../../../timelines/components/field_renderers/field_renderers'; +import { NetworkDetailsLink } from '../../../common/components/links'; +import { DescriptionListStyled } from '../../../common/components/page'; +import { OverviewDescriptionList } from '../../../common/components/overview_description_list'; +import { RiskScore } from '../../../explore/components/risk_score/severity/common'; +import { getEmptyTagValue } from '../../../common/components/empty_value'; +import { useSourcererDataView } from '../../../common/containers/sourcerer'; +import { useGlobalTime } from '../../../common/containers/use_global_time'; +import { useRiskScore } from '../../../explore/containers/risk_score'; +import { useUserDetails } from '../../../explore/users/containers/users/details'; +import * as i18n from '../../../overview/components/user_overview/translations'; +import { TECHNICAL_PREVIEW_TITLE, TECHNICAL_PREVIEW_MESSAGE } from './translations'; +import { + TECHNICAL_PREVIEW_ICON_TEST_ID, + ENTITIES_USER_OVERVIEW_TEST_ID, + ENTITIES_USER_OVERVIEW_IP_TEST_ID, + ENTITIES_USER_OVERVIEW_RISK_LEVEL_TEST_ID, +} from './test_ids'; + +const StyledEuiBetaBadge = styled(EuiBetaBadge)` + margin-left: ${({ theme }) => theme.eui.euiSizeXS}; +`; + +const CONTEXT_ID = `flyout-user-entity-overview`; + +export interface UserEntityOverviewProps { + /** + * User name for looking up user related ip addresses and risk classification + */ + userName: string; +} + +/** + * User preview content for the entities preview in right flyout. It contains ip addresses and risk classification + */ +export const UserEntityOverview: React.FC = ({ userName }) => { + const { from, to } = useGlobalTime(); + const { selectedPatterns } = useSourcererDataView(); + + const timerange = useMemo( + () => ({ + from, + to, + }), + [from, to] + ); + + const filterQuery = useMemo( + () => (userName ? buildUserNamesFilter([userName]) : undefined), + [userName] + ); + const [_, { userDetails: data }] = useUserDetails({ + endDate: to, + userName, + indexNames: selectedPatterns, + startDate: from, + }); + + const { data: userRisk, isLicenseValid } = useRiskScore({ + filterQuery, + riskEntity: RiskScoreEntity.user, + timerange, + }); + + const descriptionList: DescriptionList[] = useMemo( + () => [ + { + title: i18n.HOST_IP, + description: ( + (ip != null ? : getEmptyTagValue())} + /> + ), + }, + ], + [data] + ); + + const [userRiskLevel] = useMemo(() => { + const userRiskData = userRisk && userRisk.length > 0 ? userRisk[0] : undefined; + + return [ + { + title: ( + <> + {i18n.USER_RISK_CLASSIFICATION} + + + ), + + description: ( + <> + {userRiskData ? ( + + ) : ( + + )} + + ), + }, + ]; + }, [userRisk]); + + return ( + + + + + + {isLicenseValid && ( + + )} + + + ); +}; + +UserEntityOverview.displayName = 'UserEntityOverview'; diff --git a/x-pack/plugins/security_solution/public/flyout/right/mocks/mock_context.ts b/x-pack/plugins/security_solution/public/flyout/right/mocks/mock_context.ts index 6765589b668da..a4d01bda6bc21 100644 --- a/x-pack/plugins/security_solution/public/flyout/right/mocks/mock_context.ts +++ b/x-pack/plugins/security_solution/public/flyout/right/mocks/mock_context.ts @@ -18,6 +18,10 @@ export const mockGetFieldsData = (field: string): string[] => { return ['low']; case ALERT_RISK_SCORE: return ['0']; + case 'host.name': + return ['host1']; + case 'user.name': + return ['user1']; default: return []; } diff --git a/x-pack/plugins/security_solution/public/flyout/right/tabs/overview_tab.tsx b/x-pack/plugins/security_solution/public/flyout/right/tabs/overview_tab.tsx index d5da888c153fb..0c9e57f99d22f 100644 --- a/x-pack/plugins/security_solution/public/flyout/right/tabs/overview_tab.tsx +++ b/x-pack/plugins/security_solution/public/flyout/right/tabs/overview_tab.tsx @@ -7,9 +7,10 @@ import type { FC } from 'react'; import React, { memo } from 'react'; -import { EuiHorizontalRule, EuiPanel } from '@elastic/eui'; +import { EuiHorizontalRule } from '@elastic/eui'; +import { InvestigationSection } from '../components/investigation_section'; import { DescriptionSection } from '../components/description_section'; -import { HighlightedFields } from '../components/highlighted_fields'; +import { InsightsSection } from '../components/insights_section'; /** * Overview view displayed in the document details expandable flyout right section @@ -19,9 +20,9 @@ export const OverviewTab: FC = memo(() => { <> - - - + + + ); }); diff --git a/x-pack/plugins/security_solution/public/flyout/shared/utils.test.tsx b/x-pack/plugins/security_solution/public/flyout/shared/utils.test.tsx new file mode 100644 index 0000000000000..ef2a14728bae7 --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/shared/utils.test.tsx @@ -0,0 +1,30 @@ +/* + * 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 { getField } from './utils'; + +describe('test getField', () => { + it('should return the string value if field is a string', () => { + expect(getField('test string')).toBe('test string'); + }); + it('should return the first string value if field is a string array', () => { + expect(getField(['string1', 'string2', 'string3'])).toBe('string1'); + }); + + it('should return null if field is not string or string array', () => { + expect(getField(100)).toBe(null); + expect(getField([1, 2, 3])).toBe(null); + expect(getField({ test: 'test string' })).toBe(null); + expect(getField(null)).toBe(null); + }); + + it('should return fallback value if field is not string or string array and emptyValue is provided', () => { + expect(getField(100, '-')).toBe('-'); + expect(getField([1, 2, 3], '-')).toBe('-'); + expect(getField({ test: 'test string' }, '-')).toBe('-'); + expect(getField(null, '-')).toBe('-'); + }); +}); diff --git a/x-pack/plugins/security_solution/public/flyout/shared/utils.tsx b/x-pack/plugins/security_solution/public/flyout/shared/utils.tsx new file mode 100644 index 0000000000000..88f0c399d723d --- /dev/null +++ b/x-pack/plugins/security_solution/public/flyout/shared/utils.tsx @@ -0,0 +1,21 @@ +/* + * 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. + */ + +/** + * Helper function to retrieve a field's value (used in combination with the custom hook useGetFieldsData (https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/public/common/hooks/use_get_fields_data.ts) + * @param field type unknown or unknown[] + * @param emptyValue optional parameter to return if field is incorrect + * @return the field's value, or null/emptyValue + */ +export const getField = (field: unknown | unknown[], emptyValue?: string) => { + if (typeof field === 'string') { + return field; + } else if (Array.isArray(field) && field.length > 0 && typeof field[0] === 'string') { + return field[0]; + } + return emptyValue ?? null; +}; diff --git a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_filters.tsx b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_filters.tsx index 9215fd5fa3cee..e1f5ee2fb9383 100644 --- a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_filters.tsx +++ b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_filters.tsx @@ -10,6 +10,8 @@ import type { DurationRange, OnRefreshChangeProps, } from '@elastic/eui/src/components/date_picker/types'; +import { useIsExperimentalFeatureEnabled } from '../../../../common/hooks/use_experimental_features'; +import { ActionsLogWithRuleToggle } from './actions_log_with_rule_toggle'; import type { useGetEndpointActionList } from '../../../hooks'; import { type DateRangePickerValues, @@ -50,6 +52,9 @@ export const ActionsLogFilters = memo( 'data-test-subj'?: string; }) => { const getTestId = useTestIdGenerator(dataTestSubj); + const responseActionsEnabled = useIsExperimentalFeatureEnabled( + 'endpointResponseActionsEnabled' + ); const filters = useMemo(() => { return ( <> @@ -73,6 +78,9 @@ export const ActionsLogFilters = memo( onChangeFilterOptions={onChangeStatusesFilter} data-test-subj={dataTestSubj} /> + {responseActionsEnabled && ( + + )} ); }, [ @@ -81,6 +89,7 @@ export const ActionsLogFilters = memo( onChangeCommandsFilter, onChangeHostsFilter, onChangeStatusesFilter, + responseActionsEnabled, showHostsFilter, ]); diff --git a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_table.tsx b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_table.tsx index 51af5a943cc98..f89046154d1d3 100644 --- a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_table.tsx +++ b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_table.tsx @@ -6,7 +6,6 @@ */ import React, { memo, useCallback, useEffect, useMemo, useState } from 'react'; -import type { CriteriaWithPagination } from '@elastic/eui'; import { EuiI18nNumber, EuiAvatar, @@ -19,10 +18,14 @@ import { EuiText, EuiToolTip, type HorizontalAlignment, + type CriteriaWithPagination, } from '@elastic/eui'; import { euiStyled } from '@kbn/kibana-react-plugin/common'; import { FormattedMessage } from '@kbn/i18n-react'; +import { SecurityPageName } from '../../../../../common/constants'; +import { getRuleDetailsUrl } from '../../../../common/components/link_to'; +import { SecuritySolutionLinkAnchor } from '../../../../common/components/links'; import type { ActionListApiResponse } from '../../../../../common/endpoint/types'; import type { EndpointActionListRequestQuery } from '../../../../../common/endpoint/schema/actions'; import { FormattedDate } from '../../../../common/components/formatted_date'; @@ -98,24 +101,46 @@ const getResponseActionListTableColumns = ({ }, }, { - field: 'createdBy', name: TABLE_COLUMN_NAMES.user, width: !showHostNames ? '21%' : '14%', truncateText: true, - render: (userId: ActionListApiResponse['data'][number]['createdBy']) => { + render: ({ createdBy, ruleId }: ActionListApiResponse['data'][number]) => { + if (createdBy === 'unknown' && ruleId) { + return ( + + + + {UX_MESSAGES.triggeredByRule} + + + + ); + } return ( + } > - + - {userId} + {createdBy} diff --git a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_with_rule_toggle.tsx b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_with_rule_toggle.tsx new file mode 100644 index 0000000000000..84384024b380b --- /dev/null +++ b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/actions_log_with_rule_toggle.tsx @@ -0,0 +1,42 @@ +/* + * 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 { EuiFilterButton } from '@elastic/eui'; +import React, { useCallback } from 'react'; +import { useActionHistoryUrlParams } from './use_action_history_url_params'; +import { FILTER_NAMES } from '../translations'; + +interface ActionsLogWithRuleToggleProps { + isFlyout: boolean; + dataTestSubj?: string; +} + +export const ActionsLogWithRuleToggle = React.memo( + ({ isFlyout, dataTestSubj }: ActionsLogWithRuleToggleProps) => { + const { withAutomatedActions: withAutomatedActionsUrlParam, setUrlWithAutomatedActions } = + useActionHistoryUrlParams(); + + const onClick = useCallback(() => { + if (!isFlyout) { + // set and show `withAutomatedActions` URL param on history page + setUrlWithAutomatedActions(!withAutomatedActionsUrlParam); + } + }, [isFlyout, setUrlWithAutomatedActions, withAutomatedActionsUrlParam]); + + return ( + + {FILTER_NAMES.automated} + + ); + } +); + +ActionsLogWithRuleToggle.displayName = 'ActionsLogWithRuleToggle'; diff --git a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/use_action_history_url_params.ts b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/use_action_history_url_params.ts index b483ed8a132cc..3201aad1478d4 100644 --- a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/use_action_history_url_params.ts +++ b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/components/use_action_history_url_params.ts @@ -23,6 +23,7 @@ interface UrlParamsActionsLogFilters { endDate: string; users: string; withOutputs: string; + withAutomatedActions: boolean; } interface ActionsLogFiltersFromUrlParams { @@ -32,18 +33,27 @@ interface ActionsLogFiltersFromUrlParams { statuses?: ResponseActionStatus[]; startDate?: string; endDate?: string; + withAutomatedActions?: boolean; setUrlActionsFilters: (commands: UrlParamsActionsLogFilters['commands']) => void; setUrlDateRangeFilters: ({ startDate, endDate }: { startDate: string; endDate: string }) => void; setUrlHostsFilters: (agentIds: UrlParamsActionsLogFilters['hosts']) => void; setUrlStatusesFilters: (statuses: UrlParamsActionsLogFilters['statuses']) => void; setUrlUsersFilters: (users: UrlParamsActionsLogFilters['users']) => void; setUrlWithOutputs: (outputs: UrlParamsActionsLogFilters['withOutputs']) => void; + setUrlWithAutomatedActions: (outputs: UrlParamsActionsLogFilters['withAutomatedActions']) => void; users?: string[]; } type FiltersFromUrl = Pick< ActionsLogFiltersFromUrlParams, - 'commands' | 'hosts' | 'withOutputs' | 'statuses' | 'users' | 'startDate' | 'endDate' + | 'commands' + | 'hosts' + | 'withOutputs' + | 'statuses' + | 'users' + | 'startDate' + | 'endDate' + | 'withAutomatedActions' >; export const actionsLogFiltersFromUrlParams = ( @@ -57,6 +67,7 @@ export const actionsLogFiltersFromUrlParams = ( endDate: 'now', users: [], withOutputs: [], + withAutomatedActions: undefined, }; const urlCommands = urlParams.commands @@ -100,6 +111,7 @@ export const actionsLogFiltersFromUrlParams = ( actionsLogFilters.endDate = urlParams.endDate ? String(urlParams.endDate) : undefined; actionsLogFilters.users = urlUsers.length ? urlUsers : undefined; actionsLogFilters.withOutputs = urlWithOutputs.length ? urlWithOutputs : undefined; + actionsLogFilters.withAutomatedActions = urlParams.withAutomatedActions ? true : undefined; return actionsLogFilters; }; @@ -195,6 +207,19 @@ export const useActionHistoryUrlParams = (): ActionsLogFiltersFromUrlParams => { [history, location, toUrlParams, urlParams] ); + const setUrlWithAutomatedActions = useCallback( + (rule: boolean) => { + history.push({ + ...location, + search: toUrlParams({ + ...urlParams, + withAutomatedActions: rule ? 'true' : undefined, + }), + }); + }, + [history, location, toUrlParams, urlParams] + ); + useEffect(() => { setActionsLogFilters((prevState) => { return { @@ -212,5 +237,6 @@ export const useActionHistoryUrlParams = (): ActionsLogFiltersFromUrlParams => { setUrlWithOutputs, setUrlStatusesFilters, setUrlUsersFilters, + setUrlWithAutomatedActions, }; }; diff --git a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/response_actions_log.test.tsx b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/response_actions_log.test.tsx index 7a2bf278b811d..09f12c91934e2 100644 --- a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/response_actions_log.test.tsx +++ b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/response_actions_log.test.tsx @@ -289,6 +289,7 @@ describe.skip('Response actions history', () => { statuses: [], userIds: [], withOutputs: [], + withAutomatedActions: true, }, expect.anything() ); @@ -963,6 +964,7 @@ describe.skip('Response actions history', () => { statuses: ['failed', 'pending'], userIds: [], withOutputs: [], + withAutomatedActions: true, }, expect.anything() ); @@ -1164,6 +1166,7 @@ describe.skip('Response actions history', () => { statuses: [], userIds: [], withOutputs: [], + withAutomatedActions: true, }, expect.anything() ); diff --git a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/response_actions_log.tsx b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/response_actions_log.tsx index e94cc67c81bdc..eee4638ede8f2 100644 --- a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/response_actions_log.tsx +++ b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/response_actions_log.tsx @@ -53,6 +53,7 @@ export const ResponseActionsLog = memo< startDate: startDateFromUrl, endDate: endDateFromUrl, users: usersFromUrl, + withAutomatedActions: withAutomatedActionsFromUrl, withOutputs: withOutputsFromUrl, setUrlWithOutputs, } = useActionHistoryUrlParams(); @@ -70,6 +71,7 @@ export const ResponseActionsLog = memo< statuses: [], userIds: [], withOutputs: [], + withAutomatedActions: true, }); // update query state from URL params @@ -86,6 +88,7 @@ export const ResponseActionsLog = memo< : prevState.statuses, userIds: usersFromUrl?.length ? usersFromUrl : prevState.userIds, withOutputs: withOutputsFromUrl?.length ? withOutputsFromUrl : prevState.withOutputs, + withAutomatedActions: !!withAutomatedActionsFromUrl, })); } }, [ @@ -96,6 +99,7 @@ export const ResponseActionsLog = memo< setQueryParams, usersFromUrl, withOutputsFromUrl, + withAutomatedActionsFromUrl, ]); // date range picker state and handlers diff --git a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/translations.tsx b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/translations.tsx index fb5a00a3dba63..901d0c68b9040 100644 --- a/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/translations.tsx +++ b/x-pack/plugins/security_solution/public/management/components/endpoint_response_actions_list/translations.tsx @@ -93,6 +93,9 @@ export const TABLE_COLUMN_NAMES = Object.freeze({ status: i18n.translate('xpack.securitySolution.responseActionsList.list.status', { defaultMessage: 'Status', }), + rule: i18n.translate('xpack.securitySolution.responseActionsList.list.rule', { + defaultMessage: 'Rule', + }), }); export const UX_MESSAGES = Object.freeze({ @@ -164,6 +167,12 @@ export const UX_MESSAGES = Object.freeze({ records: totalItemCount, }, }), + triggeredByRule: i18n.translate( + 'xpack.securitySolution.responseActionsList.list.rule.triggeredByRule', + { + defaultMessage: 'Triggered by rule', + } + ), }); export const FILTER_NAMES = Object.freeze({ @@ -179,6 +188,9 @@ export const FILTER_NAMES = Object.freeze({ users: i18n.translate('xpack.securitySolution.responseActionsList.list.filter.users', { defaultMessage: 'Filter by username', }), + automated: i18n.translate('xpack.securitySolution.responseActionsList.list.filter.automated', { + defaultMessage: 'Automated', + }), }); export const ARIA_LABELS = Object.freeze({ diff --git a/x-pack/plugins/security_solution/public/management/cypress/tasks/run_endpoint_loader.ts b/x-pack/plugins/security_solution/public/management/cypress/tasks/run_endpoint_loader.ts index 22bd1e7dee6f5..c235128675f71 100644 --- a/x-pack/plugins/security_solution/public/management/cypress/tasks/run_endpoint_loader.ts +++ b/x-pack/plugins/security_solution/public/management/cypress/tasks/run_endpoint_loader.ts @@ -26,5 +26,5 @@ export const runEndpointLoaderScript = () => { // FIXME: remove use of cli script and use instead data loaders const script = `node scripts/endpoint/resolver_generator.js --node="${ES_URL.toString()}" --kibana="${KBN_URL.toString()}" --delete --numHosts=1 --numDocs=1 --fleet --withNewUser=santaEndpoint:changeme --anc=1 --gen=1 --ch=1 --related=1 --relAlerts=1`; - cy.exec(script, { env: { NODE_TLS_REJECT_UNAUTHORIZED: 1 } }); + cy.exec(script, { env: { NODE_TLS_REJECT_UNAUTHORIZED: 1 }, timeout: 180000 }); }; diff --git a/x-pack/plugins/security_solution/public/management/hooks/response_actions/use_get_endpoint_action_list.test.ts b/x-pack/plugins/security_solution/public/management/hooks/response_actions/use_get_endpoint_action_list.test.ts index f588f96949e5d..0296d83469ccf 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/response_actions/use_get_endpoint_action_list.test.ts +++ b/x-pack/plugins/security_solution/public/management/hooks/response_actions/use_get_endpoint_action_list.test.ts @@ -51,6 +51,7 @@ describe('useGetEndpointActionList hook', () => { pageSize: 20, startDate: 'now-5d', endDate: 'now', + withAutomatedActions: true, }) ); @@ -65,6 +66,7 @@ describe('useGetEndpointActionList hook', () => { pageSize: 20, startDate: 'now-5d', userIds: ['*elastic*', '*citsale*'], + withAutomatedActions: true, }, }); }); @@ -73,7 +75,7 @@ describe('useGetEndpointActionList hook', () => { await renderReactQueryHook( () => useGetEndpointActionList( - {}, + { withAutomatedActions: true }, { queryKey: ['1', '2'], enabled: false, diff --git a/x-pack/plugins/security_solution/public/management/hooks/response_actions/use_get_endpoint_action_list.ts b/x-pack/plugins/security_solution/public/management/hooks/response_actions/use_get_endpoint_action_list.ts index 546b1b5f42669..e4cd03987a5d0 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/response_actions/use_get_endpoint_action_list.ts +++ b/x-pack/plugins/security_solution/public/management/hooks/response_actions/use_get_endpoint_action_list.ts @@ -47,6 +47,8 @@ export const useGetEndpointActionList = ( statuses: query.statuses, userIds, withOutputs: query.withOutputs, + withAutomatedActions: query.withAutomatedActions, + alertId: query.alertId, }, }); }, diff --git a/x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx b/x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx index f61ee1bf1fb1c..34692b8cc12d3 100644 --- a/x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx +++ b/x-pack/plugins/security_solution/public/overview/components/event_counts/index.tsx @@ -18,9 +18,10 @@ import { convertToBuildEsQuery } from '../../../common/lib/kuery'; import type { GlobalTimeArgs } from '../../../common/containers/use_global_time'; import { useInvalidFilterQuery } from '../../../common/hooks/use_invalid_filter_query'; import { - hostNameExistsFilter, + fieldNameExistsFilter, sourceOrDestinationIpExistsFilter, } from '../../../common/components/visualization_actions/utils'; +import { SecurityPageName } from '../../../../common/constants'; interface Props extends Pick { filters: Filter[]; @@ -46,7 +47,7 @@ const EventCountsComponent: React.FC = ({ config: getEsQueryConfig(uiSettings), indexPattern, queries: [query], - filters: [...filters, ...hostNameExistsFilter], + filters: [...filters, ...fieldNameExistsFilter(SecurityPageName.hosts)], }), [filters, indexPattern, query, uiSettings] ); diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/expandable_event.tsx b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/expandable_event.tsx index f210710f7508e..6a371c46a640d 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/expandable_event.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/expandable_event.tsx @@ -8,12 +8,14 @@ import { isEmpty } from 'lodash/fp'; import { EuiButtonIcon, + EuiButtonEmpty, EuiTextColor, EuiLoadingContent, EuiTitle, EuiFlexGroup, EuiFlexItem, EuiSpacer, + EuiCopy, } from '@elastic/eui'; import React from 'react'; import styled from 'styled-components'; @@ -32,6 +34,7 @@ import type { TimelineEventsDetailsItem } from '../../../../../common/search_str import * as i18n from './translations'; import { PreferenceFormattedDate } from '../../../../common/components/formatted_date'; import { SecurityPageName } from '../../../../../common/constants'; +import { useGetAlertDetailsFlyoutLink } from './use_get_alert_details_flyout_link'; export type HandleOnEventClosed = () => void; interface Props { @@ -52,10 +55,11 @@ interface Props { interface ExpandableEventTitleProps { eventId: string; + eventIndex: string; isAlert: boolean; loading: boolean; ruleName?: string; - timestamp?: string; + timestamp: string; handleOnEventClosed?: HandleOnEventClosed; } @@ -76,12 +80,19 @@ const StyledEuiFlexItem = styled(EuiFlexItem)` `; export const ExpandableEventTitle = React.memo( - ({ eventId, isAlert, loading, handleOnEventClosed, ruleName, timestamp }) => { + ({ eventId, eventIndex, isAlert, loading, handleOnEventClosed, ruleName, timestamp }) => { const isAlertDetailsPageEnabled = useIsExperimentalFeatureEnabled('alertDetailsPageEnabled'); const { onClick } = useGetSecuritySolutionLinkProps()({ deepLinkId: SecurityPageName.alerts, path: eventId && isAlert ? getAlertDetailsUrl(eventId) : '', }); + + const alertDetailsLink = useGetAlertDetailsFlyoutLink({ + _id: eventId, + _index: eventIndex, + timestamp, + }); + return ( @@ -117,6 +128,19 @@ export const ExpandableEventTitle = React.memo( )} + {isAlert && ( + + {(copy) => ( + + {i18n.SHARE_ALERT} + + )} + + )} ); } diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/flyout/header.tsx b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/flyout/header.tsx index bc9af3fa85461..eac84c1853693 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/flyout/header.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/flyout/header.tsx @@ -13,6 +13,7 @@ import { BackToAlertDetailsLink } from './back_to_alert_details_link'; interface FlyoutHeaderComponentProps { eventId: string; + eventIndex: string; isAlert: boolean; isHostIsolationPanelOpen: boolean; isolateAction: 'isolateHost' | 'unisolateHost'; @@ -24,6 +25,7 @@ interface FlyoutHeaderComponentProps { const FlyoutHeaderContentComponent = ({ eventId, + eventIndex, isAlert, isHostIsolationPanelOpen, isolateAction, @@ -39,6 +41,7 @@ const FlyoutHeaderContentComponent = ({ ) : ( { { ); }, [ + alert.indexName, isAlert, alertId, isHostIsolationPanelOpen, diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/index.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/index.test.tsx index 555b1a2eb84fa..7c70328c8e5a9 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/index.test.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/index.test.tsx @@ -37,6 +37,15 @@ const ecsData: Ecs = { }, }; +const mockUseLocation = jest.fn().mockReturnValue({ pathname: '/test', search: '?' }); +jest.mock('react-router-dom', () => { + const original = jest.requireActual('react-router-dom'); + return { + ...original, + useLocation: () => mockUseLocation(), + }; +}); + jest.mock('../../../../../common/endpoint/service/host_isolation/utils', () => { return { isIsolationSupported: jest.fn().mockReturnValue(true), @@ -144,6 +153,7 @@ describe('event details panel component', () => { }, osquery: { OsqueryResults: jest.fn().mockReturnValue(null), + fetchAllLiveQueries: jest.fn().mockReturnValue({ data: { data: { items: [] } } }), }, }, }); diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/index.tsx b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/index.tsx index 29a1940413dad..059f4322d8970 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/index.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/index.tsx @@ -81,6 +81,7 @@ const EventDetailsPanelComponent: React.FC = ({ isFlyoutView || isHostIsolationPanelOpen ? ( = ({ ) : ( ), [ expandedEvent.eventId, + eventIndex, handleOnEventClosed, isAlert, isFlyoutView, diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/translations.ts b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/translations.ts index 39292052cf8d8..a40a9095ea111 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/translations.ts +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/translations.ts @@ -48,3 +48,10 @@ export const ALERT_DETAILS = i18n.translate( defaultMessage: 'Alert details', } ); + +export const SHARE_ALERT = i18n.translate( + 'xpack.securitySolution.timeline.expandableEvent.shareAlert', + { + defaultMessage: 'Share alert', + } +); diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/use_get_alert_details_flyout_link.ts b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/use_get_alert_details_flyout_link.ts new file mode 100644 index 0000000000000..1d2d1b5ea6213 --- /dev/null +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/event_details/use_get_alert_details_flyout_link.ts @@ -0,0 +1,32 @@ +/* + * 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 { useMemo } from 'react'; + +import { useAppUrl } from '../../../../common/lib/kibana/hooks'; +import { ALERTS_PATH } from '../../../../../common/constants'; + +export const useGetAlertDetailsFlyoutLink = ({ + _id, + _index, + timestamp, +}: { + _id: string; + _index: string; + timestamp: string; +}) => { + const { getAppUrl } = useAppUrl(); + // getAppUrl accounts for the users selected space + const alertDetailsLink = useMemo(() => { + const url = getAppUrl({ + path: `${ALERTS_PATH}/${_id}?index=${_index}×tamp=${timestamp}`, + }); + return `${window.location.origin}${url}`; + }, [_id, _index, getAppUrl, timestamp]); + + return alertDetailsLink; +}; diff --git a/x-pack/plugins/security_solution/public/timelines/components/side_panel/index.test.tsx b/x-pack/plugins/security_solution/public/timelines/components/side_panel/index.test.tsx index 685362d8f1de1..fd2da0c570f5f 100644 --- a/x-pack/plugins/security_solution/public/timelines/components/side_panel/index.test.tsx +++ b/x-pack/plugins/security_solution/public/timelines/components/side_panel/index.test.tsx @@ -29,6 +29,15 @@ jest.mock('../../../common/containers/use_search_strategy', () => ({ useSearchStrategy: jest.fn(), })); +const mockUseLocation = jest.fn().mockReturnValue({ pathname: '/test', search: '?' }); +jest.mock('react-router-dom', () => { + const original = jest.requireActual('react-router-dom'); + return { + ...original, + useLocation: () => mockUseLocation(), + }; +}); + describe('Details Panel Component', () => { const state: State = { ...mockGlobalState, diff --git a/x-pack/plugins/security_solution/public/types.ts b/x-pack/plugins/security_solution/public/types.ts index 2c7aa6340a5cf..f1450738e8d36 100644 --- a/x-pack/plugins/security_solution/public/types.ts +++ b/x-pack/plugins/security_solution/public/types.ts @@ -92,7 +92,7 @@ export interface StartPlugins { ml?: MlPluginStart; spaces?: SpacesPluginStart; dataViewFieldEditor: IndexPatternFieldEditorStart; - osquery?: OsqueryPluginStart; + osquery: OsqueryPluginStart; security: SecurityPluginStart; cloudDefend: CloudDefendPluginStart; cloudSecurityPosture: CspClientPluginStart; diff --git a/x-pack/plugins/security_solution/scripts/endpoint/agent_emulator/services/action_responder.ts b/x-pack/plugins/security_solution/scripts/endpoint/agent_emulator/services/action_responder.ts index c451198a27208..8b91273a7cae7 100644 --- a/x-pack/plugins/security_solution/scripts/endpoint/agent_emulator/services/action_responder.ts +++ b/x-pack/plugins/security_solution/scripts/endpoint/agent_emulator/services/action_responder.ts @@ -45,6 +45,7 @@ export class ActionResponderService extends BaseRunningService { const { data: actions } = await fetchEndpointActionList(kbnClient, { page: nextPage++, pageSize: 100, + withAutomatedActions: true, }); if (actions.length === 0) { diff --git a/x-pack/plugins/security_solution/scripts/endpoint/agent_emulator/services/endpoint_response_actions.ts b/x-pack/plugins/security_solution/scripts/endpoint/agent_emulator/services/endpoint_response_actions.ts index 5547f74bc0989..995aa73835fca 100644 --- a/x-pack/plugins/security_solution/scripts/endpoint/agent_emulator/services/endpoint_response_actions.ts +++ b/x-pack/plugins/security_solution/scripts/endpoint/agent_emulator/services/endpoint_response_actions.ts @@ -46,7 +46,7 @@ export const sleep = (ms: number = 1000) => new Promise((r) => setTimeout(r, ms) export const fetchEndpointActionList = async ( kbn: KbnClient, - options: EndpointActionListRequestQuery = {} + options: EndpointActionListRequestQuery = { withAutomatedActions: true } ): Promise => { try { return ( diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/list_handler.test.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/list_handler.test.ts index b9b67b2197b1d..2854f0cd6ef8d 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/list_handler.test.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/list_handler.test.ts @@ -96,21 +96,22 @@ describe('Action List Handler', () => { }); describe('Internals', () => { + const defaultParams = { pageSize: 10, page: 1, withAutomatedActions: true }; it('should return `notFound` when actions index does not exist', async () => { mockDoesLogsEndpointActionsIndexExist.mockResolvedValue(false); - await actionListHandler({ pageSize: 10, page: 1 }); + await actionListHandler(defaultParams); expect(mockResponse.notFound).toHaveBeenCalledWith({ body: 'index_not_found_exception', }); }); it('should return `ok` when actions index exists', async () => { - await actionListHandler({ pageSize: 10, page: 1 }); + await actionListHandler(defaultParams); expect(mockResponse.ok).toHaveBeenCalled(); }); it('should call `getActionListByStatus` when statuses filter values are provided', async () => { - await actionListHandler({ pageSize: 10, page: 1, statuses: ['failed', 'pending'] }); + await actionListHandler({ ...defaultParams, statuses: ['failed', 'pending'] }); expect(mockGetActionListByStatus).toBeCalledWith( expect.objectContaining({ statuses: ['failed', 'pending'] }) ); @@ -123,6 +124,7 @@ describe('Action List Handler', () => { commands: 'running-processes', statuses: 'failed', userIds: 'userX', + withAutomatedActions: true, }); expect(mockGetActionListByStatus).toBeCalledWith( expect.objectContaining({ @@ -137,8 +139,7 @@ describe('Action List Handler', () => { it('should call `getActionList` when statuses filter values are not provided', async () => { await actionListHandler({ - pageSize: 10, - page: 1, + ...defaultParams, commands: ['isolate', 'kill-process'], userIds: ['userX', 'userY'], }); @@ -152,8 +153,7 @@ describe('Action List Handler', () => { it('should correctly format the request when calling `getActionList`', async () => { await actionListHandler({ - page: 1, - pageSize: 10, + ...defaultParams, agentIds: 'agentX', commands: 'isolate', userIds: 'userX', diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/actions/list_handler.ts b/x-pack/plugins/security_solution/server/endpoint/routes/actions/list_handler.ts index 06496266cf6df..2b9c5b58735b4 100644 --- a/x-pack/plugins/security_solution/server/endpoint/routes/actions/list_handler.ts +++ b/x-pack/plugins/security_solution/server/endpoint/routes/actions/list_handler.ts @@ -57,6 +57,8 @@ export const actionListHandler = ( commands, statuses, withOutputs, + withAutomatedActions, + alertId, }, } = req; const esClient = (await context.core).elasticsearch.client.asInternalUser; @@ -74,6 +76,8 @@ export const actionListHandler = ( const requestParams = { withOutputs: formatStringIds(withOutputs), + alertId: formatStringIds(alertId), + withAutomatedActions, commands: formatCommandValues(commands), esClient, elasticAgentIds: formatStringIds(elasticAgentIds), @@ -85,7 +89,6 @@ export const actionListHandler = ( userIds: formatStringIds(userIds), logger, }; - // wrapper method to branch logic for // normal paged search via page, size // vs full search for status filters diff --git a/x-pack/plugins/security_solution/server/endpoint/services/actions/action_list.ts b/x-pack/plugins/security_solution/server/endpoint/services/actions/action_list.ts index f1e6b831cbbce..3ca6f56703e2e 100644 --- a/x-pack/plugins/security_solution/server/endpoint/services/actions/action_list.ts +++ b/x-pack/plugins/security_solution/server/endpoint/services/actions/action_list.ts @@ -37,6 +37,9 @@ interface OptionalFilterParams { unExpiredOnly?: boolean; /** list of action Ids that should have outputs */ withOutputs?: string[]; + /** Include automated response actions */ + withAutomatedActions?: boolean; + alertId?: string[]; } /** @@ -57,6 +60,7 @@ export const getActionListByStatus = async ({ statuses, userIds, unExpiredOnly = false, + withAutomatedActions, withOutputs, }: OptionalFilterParams & { statuses: ResponseActionStatus[]; @@ -79,6 +83,7 @@ export const getActionListByStatus = async ({ startDate, userIds, unExpiredOnly, + withAutomatedActions, withOutputs, }); @@ -118,6 +123,8 @@ export const getActionList = async ({ userIds, unExpiredOnly = false, withOutputs, + withAutomatedActions, + alertId, }: OptionalFilterParams & { esClient: ElasticsearchClient; logger: Logger; @@ -141,6 +148,8 @@ export const getActionList = async ({ userIds, unExpiredOnly, withOutputs, + withAutomatedActions, + alertId, }); return { @@ -176,6 +185,8 @@ const getActionDetailsList = async ({ userIds, unExpiredOnly, withOutputs, + withAutomatedActions, + alertId, }: GetActionDetailsListParam & { metadataService: EndpointMetadataService }): Promise<{ actionDetails: ActionListApiResponse['data']; totalRecords: number; @@ -197,6 +208,8 @@ const getActionDetailsList = async ({ size, userIds, unExpiredOnly, + withAutomatedActions, + alertId, }); actionRequests = _actionRequests; actionReqIds = actionIds; @@ -297,6 +310,9 @@ const getActionDetailsList = async ({ createdBy: action.createdBy, comment: action.comment, parameters: action.parameters, + alertIds: action.alertIds, + ruleId: action.ruleId, + ruleName: action.ruleName, }; return actionRecord; diff --git a/x-pack/plugins/security_solution/server/endpoint/services/actions/create/index.ts b/x-pack/plugins/security_solution/server/endpoint/services/actions/create/index.ts index 36507559ecbb3..76ffbbc08a3e0 100644 --- a/x-pack/plugins/security_solution/server/endpoint/services/actions/create/index.ts +++ b/x-pack/plugins/security_solution/server/endpoint/services/actions/create/index.ts @@ -59,6 +59,8 @@ export class ActionCreateService { payload: TypeOf & { command: ResponseActionsApiCommandNames; user?: ReturnType; + rule_id?: string; + rule_name?: string; }, casesClient?: CasesClient ): Promise { @@ -110,12 +112,16 @@ export class ActionCreateService { data: { command: payload.command, comment: payload.comment ?? undefined, + ...(payload.alert_ids ? { alert_id: payload.alert_ids } : {}), parameters: getActionParameters() ?? undefined, }, } as Omit, user: { id: payload.user ? payload.user.username : 'unknown', }, + ...(payload.rule_id && payload.rule_name + ? { rule: { id: payload.rule_id, name: payload.rule_name } } + : {}), }; // if .logs-endpoint.actions data stream exists diff --git a/x-pack/plugins/security_solution/server/endpoint/services/actions/utils.ts b/x-pack/plugins/security_solution/server/endpoint/services/actions/utils.ts index 17f8be8c8811f..312287e081559 100644 --- a/x-pack/plugins/security_solution/server/endpoint/services/actions/utils.ts +++ b/x-pack/plugins/security_solution/server/endpoint/services/actions/utils.ts @@ -58,6 +58,9 @@ interface NormalizedActionRequest { command: ResponseActionsApiCommandNames; comment?: string; parameters?: EndpointActionDataParameterTypes; + alertIds?: string[]; + ruleId?: string; + ruleName?: string; } /** @@ -83,6 +86,9 @@ export const mapToNormalizedActionRequest = ( id: actionRequest.EndpointActions.action_id, type, parameters: actionRequest.EndpointActions.data.parameters, + alertIds: actionRequest.EndpointActions.data.alert_id, + ruleId: actionRequest.rule?.id, + ruleName: actionRequest.rule?.name, }; } diff --git a/x-pack/plugins/security_solution/server/endpoint/utils/action_list_helpers.ts b/x-pack/plugins/security_solution/server/endpoint/utils/action_list_helpers.ts index ee0a2d6e6e2ca..ea0f648a44dc5 100644 --- a/x-pack/plugins/security_solution/server/endpoint/utils/action_list_helpers.ts +++ b/x-pack/plugins/security_solution/server/endpoint/utils/action_list_helpers.ts @@ -36,6 +36,8 @@ export const getActions = async ({ startDate, userIds, unExpiredOnly, + withAutomatedActions, + alertId, }: Omit): Promise<{ actionIds: string[]; actionRequests: TransportResult, unknown>; @@ -50,6 +52,10 @@ export const getActions = async ({ }); } + if (alertId?.length) { + additionalFilters.push({ terms: { 'data.alert_id': alertId } }); + } + if (elasticAgentIds?.length) { additionalFilters.push({ terms: { agents: elasticAgentIds } }); } @@ -75,6 +81,17 @@ export const getActions = async ({ }, ]; + const mustNot: SearchRequest = + withAutomatedActions === false + ? { + must_not: { + exists: { + field: 'data.alert_id', + }, + }, + } + : {}; + if (userIds?.length) { const userIdsKql = userIds.map((userId) => `user_id:${userId}`).join(' or '); const mustClause = toElasticsearchQuery(fromKueryExpression(userIdsKql)); @@ -87,7 +104,10 @@ export const getActions = async ({ from, body: { query: { - bool: { must }, + bool: { + must, + ...mustNot, + }, }, sort: [ { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts index ae76c0d128a98..bfda85063f2b9 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_context.ts @@ -106,7 +106,6 @@ const createSecuritySolutionRequestContextMock = ( ): jest.Mocked => { const core = clients.core; const kibanaRequest = requestMock.create(); - const licensing = licensingMock.createSetup(); return { core, @@ -136,10 +135,6 @@ const createSecuritySolutionRequestContextMock = ( // TODO: Mock EndpointInternalFleetServicesInterface and return the mocked object. throw new Error('Not implemented'); }), - getQueryRuleAdditionalOptions: { - licensing, - osqueryCreateAction: jest.fn(), - }, }; }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/index/delete_index_route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/index/delete_index_route.ts index ddaa497823604..ec9698cfe8bc0 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/index/delete_index_route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/index/delete_index_route.ts @@ -57,7 +57,7 @@ export const deleteIndexRoute = (router: SecuritySolutionPluginRouter) => { body: `index: "${index}" does not exist`, }); } else { - await deleteAllIndex(esClient, index); + await deleteAllIndex(esClient, index, true); const policyExists = await getPolicyExists(esClient, index); if (policyExists) { await deletePolicy(esClient, index); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts index 86477bfda3d08..d90fd562a9cc5 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts @@ -97,8 +97,6 @@ export const previewRulesRoute = async ( const searchSourceClient = await data.search.searchSource.asScoped(request); const savedObjectsClient = coreContext.savedObjects.client; const siemClient = (await context.securitySolution).getAppClient(); - const { getQueryRuleAdditionalOptions: queryRuleAdditionalOptions } = - await context.securitySolution; const timeframeEnd = request.body.timeframeEnd; let invocationCount = request.body.invocationCount; @@ -304,7 +302,6 @@ export const previewRulesRoute = async ( const queryAlertType = previewRuleTypeWrapper( createQueryAlertType({ ...ruleOptions, - ...queryRuleAdditionalOptions, id: QUERY_RULE_TYPE_ID, name: 'Custom Query Rule', }) @@ -329,7 +326,6 @@ export const previewRulesRoute = async ( const savedQueryAlertType = previewRuleTypeWrapper( createQueryAlertType({ ...ruleOptions, - ...queryRuleAdditionalOptions, id: SAVED_QUERY_RULE_TYPE_ID, name: 'Saved Query Rule', }) diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/endpoint_response_action.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/endpoint_response_action.ts new file mode 100644 index 0000000000000..133efd45dfa17 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/endpoint_response_action.ts @@ -0,0 +1,27 @@ +/* + * 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 { each } from 'lodash'; +import type { EndpointAppContextService } from '../../../endpoint/endpoint_app_context_services'; +import type { RuleResponseEndpointAction } from '../../../../common/detection_engine/rule_response_actions/schemas'; +import type { AlertsWithAgentType } from './types'; + +export const endpointResponseAction = ( + responseAction: RuleResponseEndpointAction, + endpointAppContextService: EndpointAppContextService, + { alertIds, agentIds, ruleId, ruleName }: AlertsWithAgentType +) => + each(agentIds, (agent) => + endpointAppContextService.getActionCreateService().createAction({ + endpoint_ids: [agent], + alert_ids: alertIds, + comment: responseAction.params.comment, + command: responseAction.params.command, + rule_id: ruleId, + rule_name: ruleName, + }) + ); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/osquery_response_action.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/osquery_response_action.ts new file mode 100644 index 0000000000000..3312c0b42b10f --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/osquery_response_action.ts @@ -0,0 +1,52 @@ +/* + * 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 { each, some } from 'lodash'; +import { containsDynamicQuery } from '@kbn/osquery-plugin/common/utils/replace_params_query'; +import type { SetupPlugins } from '../../../plugin_contract'; +import type { RuleResponseOsqueryAction } from '../../../../common/detection_engine/rule_response_actions/schemas'; +import type { AlertsWithAgentType } from './types'; + +export const osqueryResponseAction = ( + responseAction: RuleResponseOsqueryAction, + osqueryCreateAction: SetupPlugins['osquery']['osqueryCreateAction'], + { alerts, alertIds, agentIds }: AlertsWithAgentType +) => { + const temporaryQueries = responseAction.params.queries?.length + ? responseAction.params.queries + : [{ query: responseAction.params.query }]; + const containsDynamicQueries = some( + temporaryQueries, + (query) => query.query && containsDynamicQuery(query.query) + ); + + const { savedQueryId, packId, queries, ecsMapping, ...rest } = responseAction.params; + + if (!containsDynamicQueries) { + return osqueryCreateAction({ + ...rest, + queries, + ecs_mapping: ecsMapping, + saved_query_id: savedQueryId, + agent_ids: agentIds, + alert_ids: alertIds, + }); + } + each(alerts, (alert) => { + return osqueryCreateAction( + { + ...rest, + queries, + ecs_mapping: ecsMapping, + saved_query_id: savedQueryId, + agent_ids: alert.agent?.id ? [alert.agent.id] : [], + alert_ids: [(alert as unknown as { _id: string })._id], + }, + alert + ); + }); +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.test.ts index ce0dad15edb1d..d41e3a374ba75 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { scheduleNotificationResponseActions } from './schedule_notification_response_actions'; +import { getScheduleNotificationResponseActionsService } from './schedule_notification_response_actions'; import type { RuleResponseAction } from '../../../../common/detection_engine/rule_response_actions/schemas'; import { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas'; @@ -53,11 +53,16 @@ describe('ScheduleNotificationResponseActions', () => { saved_query_id: undefined, ecs_mapping: { testField: { field: 'testField', value: 'testValue' } }, }; + const osqueryActionMock = jest.fn(); + const endpointActionMock = jest.fn(); + + const scheduleNotificationResponseActions = getScheduleNotificationResponseActionsService({ + osqueryCreateAction: osqueryActionMock, + endpointAppContextService: endpointActionMock as never, + }); const simpleQuery = 'select * from uptime'; it('should handle osquery response actions with query', async () => { - const osqueryActionMock = jest.fn(); - const responseActions: RuleResponseAction[] = [ { actionTypeId: RESPONSE_ACTION_TYPES.OSQUERY, @@ -67,7 +72,7 @@ describe('ScheduleNotificationResponseActions', () => { }, }, ]; - scheduleNotificationResponseActions({ signals, responseActions }, osqueryActionMock); + scheduleNotificationResponseActions({ signals, responseActions }); expect(osqueryActionMock).toHaveBeenCalledWith({ ...defaultQueryResultParams, @@ -76,8 +81,6 @@ describe('ScheduleNotificationResponseActions', () => { // }); it('should handle osquery response actions with packs', async () => { - const osqueryActionMock = jest.fn(); - const responseActions: RuleResponseAction[] = [ { actionTypeId: RESPONSE_ACTION_TYPES.OSQUERY, @@ -94,7 +97,7 @@ describe('ScheduleNotificationResponseActions', () => { }, }, ]; - scheduleNotificationResponseActions({ signals, responseActions }, osqueryActionMock); + scheduleNotificationResponseActions({ signals, responseActions }); expect(osqueryActionMock).toHaveBeenCalledWith({ ...defaultPackResultParams, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.ts index cc04444dec34a..4fbcc0592ee69 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/schedule_notification_response_actions.ts @@ -5,83 +5,64 @@ * 2.0. */ -import { uniq, reduce, some, each } from 'lodash'; -import { containsDynamicQuery } from '@kbn/osquery-plugin/common/utils/replace_params_query'; +import { reduce, each, uniq } from 'lodash'; import type { ParsedTechnicalFields } from '@kbn/rule-registry-plugin/common'; -import type { RuleResponseAction } from '../../../../common/detection_engine/rule_response_actions/schemas'; -import { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas'; +import { ALERT_RULE_NAME, ALERT_RULE_UUID } from '@kbn/rule-data-utils'; +import type { EndpointAppContextService } from '../../../endpoint/endpoint_app_context_services'; import type { SetupPlugins } from '../../../plugin_contract'; +import { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas'; +import { osqueryResponseAction } from './osquery_response_action'; +import { endpointResponseAction } from './endpoint_response_action'; +import type { AlertsWithAgentType } from './types'; +import type { ScheduleNotificationActions } from '../rule_types/types'; type Alerts = Array; -interface ScheduleNotificationActions { - signals: unknown[]; - responseActions: RuleResponseAction[]; +interface ScheduleNotificationResponseActionsService { + endpointAppContextService: EndpointAppContextService; + osqueryCreateAction: SetupPlugins['osquery']['osqueryCreateAction']; } -interface AlertsWithAgentType { - alerts: Alerts; - agents: string[]; - alertIds: string[]; -} +export const getScheduleNotificationResponseActionsService = + ({ + osqueryCreateAction, + endpointAppContextService, + }: ScheduleNotificationResponseActionsService) => + ({ signals, responseActions, hasEnterpriseLicense }: ScheduleNotificationActions) => { + const filteredAlerts = (signals as Alerts).filter((alert) => alert.agent?.id); -export const scheduleNotificationResponseActions = ( - { signals, responseActions }: ScheduleNotificationActions, - osqueryCreateAction?: SetupPlugins['osquery']['osqueryCreateAction'] -) => { - const filteredAlerts = (signals as Alerts).filter((alert) => alert.agent?.id); + const { alerts, agentIds, alertIds }: AlertsWithAgentType = reduce( + filteredAlerts, + (acc, alert) => { + const agentId = alert.agent?.id; + if (agentId !== undefined) { + return { + alerts: [...acc.alerts, alert], + agentIds: uniq([...acc.agentIds, agentId]), + alertIds: [...acc.alertIds, (alert as unknown as { _id: string })._id], + }; + } + return acc; + }, + { alerts: [], agentIds: [], alertIds: [] } as AlertsWithAgentType + ); - const { alerts, agents, alertIds }: AlertsWithAgentType = reduce( - filteredAlerts, - (acc, alert) => { - const agentId = alert.agent?.id; - if (agentId !== undefined) { - return { - alerts: [...acc.alerts, alert], - agents: [...acc.agents, agentId], - alertIds: [...acc.alertIds, (alert as unknown as { _id: string })._id], - }; + each(responseActions, (responseAction) => { + if (responseAction.actionTypeId === RESPONSE_ACTION_TYPES.OSQUERY && osqueryCreateAction) { + osqueryResponseAction(responseAction, osqueryCreateAction, { + alerts, + alertIds, + agentIds, + }); } - return acc; - }, - { alerts: [], agents: [], alertIds: [] } as AlertsWithAgentType - ); - const agentIds = uniq(agents); - - each(responseActions, (responseAction) => { - if (responseAction.actionTypeId === RESPONSE_ACTION_TYPES.OSQUERY && osqueryCreateAction) { - const temporaryQueries = responseAction.params.queries?.length - ? responseAction.params.queries - : [{ query: responseAction.params.query }]; - const containsDynamicQueries = some( - temporaryQueries, - (query) => query.query && containsDynamicQuery(query.query) - ); - const { savedQueryId, packId, queries, ecsMapping, ...rest } = responseAction.params; - - if (!containsDynamicQueries) { - return osqueryCreateAction({ - ...rest, - queries, - ecs_mapping: ecsMapping, - saved_query_id: savedQueryId, - agent_ids: agentIds, - alert_ids: alertIds, + if (responseAction.actionTypeId === RESPONSE_ACTION_TYPES.ENDPOINT && hasEnterpriseLicense) { + endpointResponseAction(responseAction, endpointAppContextService, { + alerts, + alertIds, + agentIds, + ruleId: alerts[0][ALERT_RULE_UUID], + ruleName: alerts[0][ALERT_RULE_NAME], }); } - each(alerts, (alert) => { - return osqueryCreateAction( - { - ...rest, - queries, - ecs_mapping: ecsMapping, - saved_query_id: savedQueryId, - agent_ids: alert.agent?.id ? [alert.agent.id] : [], - alert_ids: [(alert as unknown as { _id: string })._id], - }, - alert - ); - }); - } - }); -}; + }); + }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/types.ts new file mode 100644 index 0000000000000..d63d390582827 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions/types.ts @@ -0,0 +1,20 @@ +/* + * 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 { ParsedTechnicalFields } from '@kbn/rule-registry-plugin/common'; + +export type Alerts = Array< + ParsedTechnicalFields & { agent?: { id: string }; process?: { pid: string } } +>; + +export interface AlertsWithAgentType { + alerts: Alerts; + agentIds: string[]; + alertIds: string[]; + ruleId?: string; + ruleName?: string; +} diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.test.ts index 4d6b3120488fa..d3f8e8b42b44e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.test.ts @@ -56,7 +56,7 @@ describe('Custom Query Alerts', () => { createQueryAlertType({ eventsTelemetry, licensing, - osqueryCreateAction: () => null, + scheduleNotificationResponseActionsService: () => null, experimentalFeatures: allowedExperimentalValues, logger, version: '1.0.0', @@ -104,7 +104,7 @@ describe('Custom Query Alerts', () => { createQueryAlertType({ eventsTelemetry, licensing, - osqueryCreateAction: () => null, + scheduleNotificationResponseActionsService: () => null, experimentalFeatures: allowedExperimentalValues, logger, version: '1.0.0', diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.ts index 2aa3a708c672a..1fde4b864ac9e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.ts @@ -27,7 +27,7 @@ export const createQueryAlertType = ( eventsTelemetry, experimentalFeatures, version, - osqueryCreateAction, + scheduleNotificationResponseActionsService, licensing, id, name, @@ -83,8 +83,8 @@ export const createQueryAlertType = ( version, spaceId, bucketHistory: state.suppressionGroupHistory, - osqueryCreateAction, licensing, + scheduleNotificationResponseActionsService, }); }, }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts index 32099bf836991..764103151bf24 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts @@ -22,9 +22,7 @@ import type { UnifiedQueryRuleParams } from '../../rule_schema'; import type { ExperimentalFeatures } from '../../../../../common/experimental_features'; import { buildReasonMessageForQueryAlert } from '../utils/reason_formatters'; import { withSecuritySpan } from '../../../../utils/with_security_span'; -import { scheduleNotificationResponseActions } from '../../rule_response_actions/schedule_notification_response_actions'; -import type { SetupPlugins } from '../../../../plugin_contract'; -import type { RunOpts } from '../types'; +import type { CreateQueryRuleAdditionalOptions, RunOpts } from '../types'; export const queryExecutor = async ({ runOpts, @@ -34,7 +32,7 @@ export const queryExecutor = async ({ version, spaceId, bucketHistory, - osqueryCreateAction, + scheduleNotificationResponseActionsService, licensing, }: { runOpts: RunOpts; @@ -44,7 +42,7 @@ export const queryExecutor = async ({ version: string; spaceId: string; bucketHistory?: BucketHistory[]; - osqueryCreateAction: SetupPlugins['osquery']['osqueryCreateAction']; + scheduleNotificationResponseActionsService?: CreateQueryRuleAdditionalOptions['scheduleNotificationResponseActionsService']; licensing: LicensingPluginSetup; }) => { const completeRule = runOpts.completeRule; @@ -64,6 +62,7 @@ export const queryExecutor = async ({ const license = await firstValueFrom(licensing.license$); const hasPlatinumLicense = license.hasAtLeast('platinum'); + const hasEnterpriseLicense = license.hasAtLeast('enterprise'); const result = ruleParams.alertSuppression?.groupBy != null && hasPlatinumLicense @@ -97,16 +96,17 @@ export const queryExecutor = async ({ state: {}, }; - if (hasPlatinumLicense) { - if (completeRule.ruleParams.responseActions?.length && result.createdSignalsCount) { - scheduleNotificationResponseActions( - { - signals: result.createdSignals, - responseActions: completeRule.ruleParams.responseActions, - }, - osqueryCreateAction - ); - } + if ( + hasPlatinumLicense && + completeRule.ruleParams.responseActions?.length && + result.createdSignalsCount && + scheduleNotificationResponseActionsService + ) { + scheduleNotificationResponseActionsService({ + signals: result.createdSignals, + responseActions: completeRule.ruleParams.responseActions, + hasEnterpriseLicense, + }); } return result; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts index 36ac78f2f74d5..0dee5eba79cc4 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts @@ -31,9 +31,10 @@ import type { } from '@kbn/rule-registry-plugin/server'; import type { EcsFieldMap } from '@kbn/rule-registry-plugin/common/assets/field_maps/ecs_field_map'; import type { TypeOfFieldMap } from '@kbn/rule-registry-plugin/common/field_map'; -import type { LicensingPluginSetup } from '@kbn/licensing-plugin/server'; import type { Filter } from '@kbn/es-query'; +import type { LicensingPluginSetup } from '@kbn/licensing-plugin/server'; +import type { RuleResponseAction } from '../../../../common/detection_engine/rule_response_actions/schemas'; import type { ConfigType } from '../../../config'; import type { SetupPlugins } from '../../../plugin'; import type { CompleteRule, RuleParams } from '../rule_schema'; @@ -150,11 +151,16 @@ export interface CreateRuleOptions { ml?: SetupPlugins['ml']; eventsTelemetry?: ITelemetryEventsSender | undefined; version: string; + licensing: LicensingPluginSetup; } +export interface ScheduleNotificationActions { + signals: unknown[]; + responseActions: RuleResponseAction[]; + hasEnterpriseLicense?: boolean; +} export interface CreateQueryRuleAdditionalOptions { - osqueryCreateAction: SetupPlugins['osquery']['osqueryCreateAction']; - licensing: LicensingPluginSetup; + scheduleNotificationResponseActionsService?: (params: ScheduleNotificationActions) => void; } export interface CreateQueryRuleOptions @@ -182,6 +188,7 @@ export interface RuleRangeTuple { */ export interface SignalSource { [key: string]: SearchTypes; + '@timestamp'?: string; signal?: { /** @@ -294,6 +301,7 @@ export interface SignalHit { '@timestamp': string; event: object; signal: Signal; + [key: string]: SearchTypes; } @@ -340,6 +348,7 @@ export type RuleServices = RuleExecutorServices< AlertInstanceContext, 'default' >; + export interface SearchAfterAndBulkCreateParams { tuple: { to: moment.Moment; diff --git a/x-pack/plugins/security_solution/server/plugin.ts b/x-pack/plugins/security_solution/server/plugin.ts index 3c19a6b6e4c92..2b6048c122f27 100644 --- a/x-pack/plugins/security_solution/server/plugin.ts +++ b/x-pack/plugins/security_solution/server/plugin.ts @@ -28,6 +28,7 @@ import { Dataset } from '@kbn/rule-registry-plugin/server'; import type { ListPluginSetup } from '@kbn/lists-plugin/server'; import type { ILicense } from '@kbn/licensing-plugin/server'; +import { getScheduleNotificationResponseActionsService } from './lib/detection_engine/rule_response_actions/schedule_notification_response_actions'; import { siemGuideId, siemGuideConfig } from '../common/guided_onboarding/siem_guide_config'; import { createEqlAlertType, @@ -166,11 +167,6 @@ export class Plugin implements ISecuritySolutionPlugin { const ruleExecutionLogService = createRuleExecutionLogService(config, logger, core, plugins); ruleExecutionLogService.registerEventLogProvider(); - const queryRuleAdditionalOptions: CreateQueryRuleAdditionalOptions = { - licensing: plugins.licensing, - osqueryCreateAction: plugins.osquery.osqueryCreateAction, - }; - const requestContextFactory = new RequestContextFactory({ config, logger, @@ -214,6 +210,7 @@ export class Plugin implements ISecuritySolutionPlugin { ml: plugins.ml, eventsTelemetry: this.telemetryEventsSender, version: pluginContext.env.packageInfo.version, + licensing: plugins.licensing, }; const ruleDataServiceOptions = { @@ -249,6 +246,13 @@ export class Plugin implements ISecuritySolutionPlugin { version: pluginContext.env.packageInfo.version, }; + const queryRuleAdditionalOptions: CreateQueryRuleAdditionalOptions = { + scheduleNotificationResponseActionsService: getScheduleNotificationResponseActionsService({ + endpointAppContextService: this.endpointAppContextService, + osqueryCreateAction: plugins.osquery.osqueryCreateAction, + }), + }; + const securityRuleTypeWrapper = createSecurityRuleTypeWrapper(securityRuleTypeOptions); plugins.alerting.registerType(securityRuleTypeWrapper(createEqlAlertType(ruleOptions))); diff --git a/x-pack/plugins/security_solution/server/request_context_factory.ts b/x-pack/plugins/security_solution/server/request_context_factory.ts index bead5d6088fd7..3bb125cf06914 100644 --- a/x-pack/plugins/security_solution/server/request_context_factory.ts +++ b/x-pack/plugins/security_solution/server/request_context_factory.ts @@ -57,7 +57,7 @@ export class RequestContextFactory implements IRequestContextFactory { ): Promise { const { options, appClientFactory } = this; const { config, core, plugins, endpointAppContextService, ruleExecutionLogService } = options; - const { lists, ruleRegistry, security, licensing, osquery } = plugins; + const { lists, ruleRegistry, security } = plugins; const [, startPlugins] = await core.getStartServices(); const frameworkRequest = await buildFrameworkRequest(context, security, request); @@ -115,11 +115,6 @@ export class RequestContextFactory implements IRequestContextFactory { }, getInternalFleetServices: memoize(() => endpointAppContextService.getInternalFleetServices()), - - getQueryRuleAdditionalOptions: { - licensing, - osqueryCreateAction: osquery.osqueryCreateAction, - }, }; } } diff --git a/x-pack/plugins/security_solution/server/types.ts b/x-pack/plugins/security_solution/server/types.ts index 20688329eb1b2..993d031dec440 100644 --- a/x-pack/plugins/security_solution/server/types.ts +++ b/x-pack/plugins/security_solution/server/types.ts @@ -19,7 +19,6 @@ import type { ListsApiRequestHandlerContext, ExceptionListClient } from '@kbn/li import type { IRuleDataService, AlertsClient } from '@kbn/rule-registry-plugin/server'; import type { Immutable } from '../common/endpoint/types'; -import type { CreateQueryRuleAdditionalOptions } from './lib/detection_engine/rule_types/types'; import { AppClient } from './client'; import type { ConfigType } from './config'; import type { IRuleExecutionLogForRoutes } from './lib/detection_engine/rule_monitoring'; @@ -41,7 +40,6 @@ export interface SecuritySolutionApiRequestHandlerContext { getRacClient: (req: KibanaRequest) => Promise; getExceptionListClient: () => ExceptionListClient | null; getInternalFleetServices: () => EndpointInternalFleetServicesInterface; - getQueryRuleAdditionalOptions: CreateQueryRuleAdditionalOptions; } export type SecuritySolutionRequestHandlerContext = CustomRequestHandlerContext<{ diff --git a/x-pack/plugins/snapshot_restore/__jest__/client_integration/repository_add.test.ts b/x-pack/plugins/snapshot_restore/__jest__/client_integration/repository_add.test.ts index 1bbb82760b3be..a741df028eb99 100644 --- a/x-pack/plugins/snapshot_restore/__jest__/client_integration/repository_add.test.ts +++ b/x-pack/plugins/snapshot_restore/__jest__/client_integration/repository_add.test.ts @@ -593,5 +593,46 @@ describe('', () => { }) ); }); + + test('should correctly set the onezone_ia storage class', async () => { + const { form, actions, component } = testBed; + + const s3Repository = getRepository({ + type: 's3', + settings: { + bucket: 'test_bucket', + storageClass: 'onezone_ia', + }, + }); + + // Fill step 1 required fields and go to step 2 + form.setInputValue('nameInput', s3Repository.name); + actions.selectRepositoryType(s3Repository.type); + actions.clickNextButton(); + + // Fill step 2 + form.setInputValue('bucketInput', s3Repository.settings.bucket); + form.setSelectValue('storageClassSelect', s3Repository.settings.storageClass); + + await act(async () => { + actions.clickSubmitButton(); + }); + + component.update(); + + expect(httpSetup.put).toHaveBeenLastCalledWith( + `${API_BASE_PATH}repositories`, + expect.objectContaining({ + body: JSON.stringify({ + name: s3Repository.name, + type: s3Repository.type, + settings: { + bucket: s3Repository.settings.bucket, + storageClass: s3Repository.settings.storageClass, + }, + }), + }) + ); + }); }); }); diff --git a/x-pack/plugins/snapshot_restore/public/application/components/repository_form/type_settings/s3_settings.tsx b/x-pack/plugins/snapshot_restore/public/application/components/repository_form/type_settings/s3_settings.tsx index 1ec83fd37cf5a..887d416f9e85e 100644 --- a/x-pack/plugins/snapshot_restore/public/application/components/repository_form/type_settings/s3_settings.tsx +++ b/x-pack/plugins/snapshot_restore/public/application/components/repository_form/type_settings/s3_settings.tsx @@ -76,6 +76,7 @@ export const S3Settings: React.FunctionComponent = ({ 'reduced_redundancy', 'standard_ia', 'intelligent_tiering', + 'onezone_ia', ].map((option) => ({ value: option, text: option, diff --git a/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts b/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts index 83aeed3269f3e..956dfa2af23b5 100644 --- a/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts +++ b/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts @@ -30,6 +30,19 @@ import { ConfigKey } from './monitor_management'; export const DEFAULT_NAMESPACE_STRING = 'default'; +export const ALLOWED_SCHEDULES_IN_MINUTES = [ + '1', + '3', + '5', + '10', + '15', + '20', + '30', + '60', + '120', + '240', +]; + export const DEFAULT_COMMON_FIELDS: CommonFields = { [ConfigKey.MONITOR_TYPE]: DataStream.HTTP, [ConfigKey.FORM_MONITOR_TYPE]: FormMonitorType.MULTISTEP, @@ -74,7 +87,6 @@ export const DEFAULT_BROWSER_SIMPLE_FIELDS: BrowserSimpleFields = { is_generated_script: false, file_name: '', }, - is_zip_url_tls_enabled: false, }, [ConfigKey.MONITOR_TYPE]: DataStream.BROWSER, [ConfigKey.PARAMS]: '', @@ -85,23 +97,10 @@ export const DEFAULT_BROWSER_SIMPLE_FIELDS: BrowserSimpleFields = { }, [ConfigKey.SOURCE_INLINE]: '', [ConfigKey.SOURCE_PROJECT_CONTENT]: '', - [ConfigKey.SOURCE_ZIP_URL]: '', - [ConfigKey.SOURCE_ZIP_USERNAME]: '', - [ConfigKey.SOURCE_ZIP_PASSWORD]: '', - [ConfigKey.SOURCE_ZIP_FOLDER]: '', - [ConfigKey.SOURCE_ZIP_PROXY_URL]: '', [ConfigKey.TEXT_ASSERTION]: '', [ConfigKey.URLS]: '', [ConfigKey.FORM_MONITOR_TYPE]: FormMonitorType.MULTISTEP, [ConfigKey.TIMEOUT]: null, - - // Deprecated, slated to be removed in a future version - [ConfigKey.ZIP_URL_TLS_CERTIFICATE_AUTHORITIES]: undefined, - [ConfigKey.ZIP_URL_TLS_CERTIFICATE]: undefined, - [ConfigKey.ZIP_URL_TLS_KEY]: undefined, - [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: undefined, - [ConfigKey.ZIP_URL_TLS_VERIFICATION_MODE]: undefined, - [ConfigKey.ZIP_URL_TLS_VERSION]: undefined, }; export const DEFAULT_HTTP_SIMPLE_FIELDS: HTTPSimpleFields = { diff --git a/x-pack/plugins/synthetics/common/constants/monitor_management.ts b/x-pack/plugins/synthetics/common/constants/monitor_management.ts index 78e1829356458..231acff2c6230 100644 --- a/x-pack/plugins/synthetics/common/constants/monitor_management.ts +++ b/x-pack/plugins/synthetics/common/constants/monitor_management.ts @@ -54,11 +54,6 @@ export enum ConfigKey { SCREENSHOTS = 'screenshots', SOURCE_PROJECT_CONTENT = 'source.project.content', SOURCE_INLINE = 'source.inline.script', - SOURCE_ZIP_URL = 'source.zip_url.url', - SOURCE_ZIP_USERNAME = 'source.zip_url.username', - SOURCE_ZIP_PASSWORD = 'source.zip_url.password', - SOURCE_ZIP_FOLDER = 'source.zip_url.folder', - SOURCE_ZIP_PROXY_URL = 'source.zip_url.proxy_url', PROJECT_ID = 'project_id', SYNTHETICS_ARGS = 'synthetics_args', TEXT_ASSERTION = 'playwright_text_assertion', @@ -78,12 +73,6 @@ export enum ConfigKey { URLS = 'urls', USERNAME = 'username', WAIT = 'wait', - ZIP_URL_TLS_CERTIFICATE_AUTHORITIES = 'source.zip_url.ssl.certificate_authorities', - ZIP_URL_TLS_CERTIFICATE = 'source.zip_url.ssl.certificate', - ZIP_URL_TLS_KEY = 'source.zip_url.ssl.key', - ZIP_URL_TLS_KEY_PASSPHRASE = 'source.zip_url.ssl.key_passphrase', - ZIP_URL_TLS_VERIFICATION_MODE = 'source.zip_url.ssl.verification_mode', - ZIP_URL_TLS_VERSION = 'source.zip_url.ssl.supported_protocols', MONITOR_QUERY_ID = 'id', } @@ -99,12 +88,22 @@ export const secretKeys = [ ConfigKey.RESPONSE_RECEIVE_CHECK, ConfigKey.SOURCE_INLINE, ConfigKey.SOURCE_PROJECT_CONTENT, - ConfigKey.SOURCE_ZIP_USERNAME, - ConfigKey.SOURCE_ZIP_PASSWORD, ConfigKey.SYNTHETICS_ARGS, ConfigKey.TLS_KEY, ConfigKey.TLS_KEY_PASSPHRASE, ConfigKey.USERNAME, - ConfigKey.ZIP_URL_TLS_KEY, - ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE, ] as const; + +export enum LegacyConfigKey { + SOURCE_ZIP_URL = 'source.zip_url.url', + SOURCE_ZIP_USERNAME = 'source.zip_url.username', + SOURCE_ZIP_PASSWORD = 'source.zip_url.password', + SOURCE_ZIP_FOLDER = 'source.zip_url.folder', + SOURCE_ZIP_PROXY_URL = 'source.zip_url.proxy_url', + ZIP_URL_TLS_CERTIFICATE_AUTHORITIES = 'source.zip_url.ssl.certificate_authorities', + ZIP_URL_TLS_CERTIFICATE = 'source.zip_url.ssl.certificate', + ZIP_URL_TLS_KEY = 'source.zip_url.ssl.key', + ZIP_URL_TLS_KEY_PASSPHRASE = 'source.zip_url.ssl.key_passphrase', + ZIP_URL_TLS_VERIFICATION_MODE = 'source.zip_url.ssl.verification_mode', + ZIP_URL_TLS_VERSION = 'source.zip_url.ssl.supported_protocols', +} diff --git a/x-pack/plugins/synthetics/common/formatters/browser/formatters.ts b/x-pack/plugins/synthetics/common/formatters/browser/formatters.ts index 9e9f7283ec38f..1ad7c055aecc3 100644 --- a/x-pack/plugins/synthetics/common/formatters/browser/formatters.ts +++ b/x-pack/plugins/synthetics/common/formatters/browser/formatters.ts @@ -11,9 +11,6 @@ import { arrayToJsonFormatter, objectToJsonFormatter, stringToJsonFormatter, - tlsArrayToYamlFormatter, - tlsValueToStringFormatter, - tlsValueToYamlFormatter, } from '../formatting_utils'; import { tlsFormatters } from '../tls/formatters'; @@ -35,20 +32,6 @@ const throttlingFormatter: Formatter = (fields) => { .join('/'); }; -export const deprecatedZipUrlFormatters = { - [ConfigKey.SOURCE_ZIP_URL]: null, - [ConfigKey.SOURCE_ZIP_USERNAME]: null, - [ConfigKey.SOURCE_ZIP_PASSWORD]: null, - [ConfigKey.SOURCE_ZIP_FOLDER]: null, - [ConfigKey.SOURCE_ZIP_PROXY_URL]: null, - [ConfigKey.ZIP_URL_TLS_CERTIFICATE_AUTHORITIES]: tlsValueToYamlFormatter, - [ConfigKey.ZIP_URL_TLS_CERTIFICATE]: tlsValueToYamlFormatter, - [ConfigKey.ZIP_URL_TLS_KEY]: tlsValueToYamlFormatter, - [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: tlsValueToStringFormatter, - [ConfigKey.ZIP_URL_TLS_VERIFICATION_MODE]: tlsValueToStringFormatter, - [ConfigKey.ZIP_URL_TLS_VERSION]: tlsArrayToYamlFormatter, -}; - export const browserFormatters: BrowserFormatMap = { [ConfigKey.SOURCE_PROJECT_CONTENT]: null, [ConfigKey.PARAMS]: null, @@ -68,7 +51,6 @@ export const browserFormatters: BrowserFormatMap = { [ConfigKey.JOURNEY_FILTERS_MATCH]: stringToJsonFormatter, [ConfigKey.JOURNEY_FILTERS_TAGS]: arrayToJsonFormatter, [ConfigKey.THROTTLING_CONFIG]: throttlingFormatter, - ...deprecatedZipUrlFormatters, ...commonFormatters, ...tlsFormatters, }; diff --git a/x-pack/plugins/synthetics/common/formatters/format_synthetics_policy.test.ts b/x-pack/plugins/synthetics/common/formatters/format_synthetics_policy.test.ts index 9eca4aa70b216..a03c54fc4f34e 100644 --- a/x-pack/plugins/synthetics/common/formatters/format_synthetics_policy.test.ts +++ b/x-pack/plugins/synthetics/common/formatters/format_synthetics_policy.test.ts @@ -333,7 +333,7 @@ describe('formatSyntheticsPolicy', () => { __ui: { type: 'yaml', value: - '{"script_source":{"is_generated_script":false,"file_name":""},"is_zip_url_tls_enabled":false,"is_tls_enabled":false}', + '{"script_source":{"is_generated_script":false,"file_name":""},"is_tls_enabled":false}', }, config_id: { type: 'text', @@ -411,44 +411,6 @@ describe('formatSyntheticsPolicy', () => { type: 'text', value: '', }, - 'source.zip_url.folder': { - type: 'text', - value: '', - }, - 'source.zip_url.password': { - type: 'password', - value: '', - }, - 'source.zip_url.proxy_url': { - type: 'text', - value: '', - }, - 'source.zip_url.ssl.certificate': { - type: 'yaml', - }, - 'source.zip_url.ssl.certificate_authorities': { - type: 'yaml', - }, - 'source.zip_url.ssl.key': { - type: 'yaml', - }, - 'source.zip_url.ssl.key_passphrase': { - type: 'text', - }, - 'source.zip_url.ssl.supported_protocols': { - type: 'yaml', - }, - 'source.zip_url.ssl.verification_mode': { - type: 'text', - }, - 'source.zip_url.url': { - type: 'text', - value: '', - }, - 'source.zip_url.username': { - type: 'text', - value: '', - }, synthetics_args: { type: 'text', value: null, @@ -918,39 +880,6 @@ describe('formatSyntheticsPolicy', () => { 'source.project.content': { type: 'text', }, - 'source.zip_url.folder': { - type: 'text', - }, - 'source.zip_url.password': { - type: 'password', - }, - 'source.zip_url.proxy_url': { - type: 'text', - }, - 'source.zip_url.ssl.certificate': { - type: 'yaml', - }, - 'source.zip_url.ssl.certificate_authorities': { - type: 'yaml', - }, - 'source.zip_url.ssl.key': { - type: 'yaml', - }, - 'source.zip_url.ssl.key_passphrase': { - type: 'text', - }, - 'source.zip_url.ssl.supported_protocols': { - type: 'yaml', - }, - 'source.zip_url.ssl.verification_mode': { - type: 'text', - }, - 'source.zip_url.url': { - type: 'text', - }, - 'source.zip_url.username': { - type: 'text', - }, synthetics_args: { type: 'text', }, @@ -1147,10 +1076,6 @@ const testNewPolicy = { 'service.name': { type: 'text' }, timeout: { type: 'text' }, tags: { type: 'yaml' }, - 'source.zip_url.url': { type: 'text' }, - 'source.zip_url.username': { type: 'text' }, - 'source.zip_url.folder': { type: 'text' }, - 'source.zip_url.password': { type: 'password' }, 'source.inline.script': { type: 'yaml' }, 'source.project.content': { type: 'text' }, params: { type: 'yaml' }, @@ -1161,13 +1086,6 @@ const testNewPolicy = { 'throttling.config': { type: 'text' }, 'filter_journeys.tags': { type: 'yaml' }, 'filter_journeys.match': { type: 'text' }, - 'source.zip_url.ssl.certificate_authorities': { type: 'yaml' }, - 'source.zip_url.ssl.certificate': { type: 'yaml' }, - 'source.zip_url.ssl.key': { type: 'yaml' }, - 'source.zip_url.ssl.key_passphrase': { type: 'text' }, - 'source.zip_url.ssl.verification_mode': { type: 'text' }, - 'source.zip_url.ssl.supported_protocols': { type: 'yaml' }, - 'source.zip_url.proxy_url': { type: 'text' }, location_name: { value: 'Fleet managed', type: 'text' }, id: { type: 'text' }, config_id: { type: 'text' }, @@ -1212,7 +1130,6 @@ const browserConfig: any = { playwright_options: '', __ui: { script_source: { is_generated_script: false, file_name: '' }, - is_zip_url_tls_enabled: false, is_tls_enabled: false, }, params: @@ -1221,11 +1138,6 @@ const browserConfig: any = { 'source.inline.script': 'step("Visit /users api route", async () => {\\n const response = await page.goto(\'https://nextjs-test-synthetics.vercel.app/api/users\');\\n expect(response.status()).toEqual(200);\\n});', 'source.project.content': '', - 'source.zip_url.url': '', - 'source.zip_url.username': '', - 'source.zip_url.password': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', playwright_text_assertion: '', urls: '', screenshots: 'on', diff --git a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_meta_data.ts b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_meta_data.ts index da3ce0fab6021..5ef3c448e7e84 100644 --- a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_meta_data.ts +++ b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_meta_data.ts @@ -14,7 +14,6 @@ const ScriptSourceCodec = t.interface({ export const MetadataCodec = t.partial({ is_tls_enabled: t.boolean, - is_zip_url_tls_enabled: t.boolean, script_source: ScriptSourceCodec, }); diff --git a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts index 5cb78f45e1fdd..2e639e360fd1a 100644 --- a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts +++ b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts @@ -48,23 +48,6 @@ export const TLSCodec = t.intersection([TLSFieldsCodec, TLSSensitiveFieldsCodec] export type TLSFields = t.TypeOf; -// ZipUrlTLSFields -export const ZipUrlTLSFieldsCodec = t.partial({ - [ConfigKey.ZIP_URL_TLS_CERTIFICATE_AUTHORITIES]: t.string, - [ConfigKey.ZIP_URL_TLS_CERTIFICATE]: t.string, - [ConfigKey.ZIP_URL_TLS_VERIFICATION_MODE]: VerificationModeCodec, - [ConfigKey.ZIP_URL_TLS_VERSION]: t.array(TLSVersionCodec), -}); - -export const ZipUrlTLSSensitiveFieldsCodec = t.partial({ - [ConfigKey.ZIP_URL_TLS_KEY]: t.string, - [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: t.string, -}); - -export const ZipUrlTLSCodec = t.intersection([ZipUrlTLSFieldsCodec, ZipUrlTLSSensitiveFieldsCodec]); - -export type ZipUrlTLSFields = t.TypeOf; - // CommonFields export const CommonFieldsCodec = t.intersection([ t.interface({ @@ -222,17 +205,12 @@ export const EncryptedBrowserSimpleFieldsCodec = t.intersection([ t.intersection([ t.interface({ [ConfigKey.METADATA]: MetadataCodec, - [ConfigKey.SOURCE_ZIP_URL]: t.string, - [ConfigKey.SOURCE_ZIP_FOLDER]: t.string, - [ConfigKey.SOURCE_ZIP_PROXY_URL]: t.string, }), t.partial({ [ConfigKey.PLAYWRIGHT_OPTIONS]: t.string, [ConfigKey.TEXT_ASSERTION]: t.string, }), ]), - ZipUrlTLSFieldsCodec, - ZipUrlTLSSensitiveFieldsCodec, CommonFieldsCodec, ]); @@ -240,13 +218,10 @@ export const BrowserSensitiveSimpleFieldsCodec = t.intersection([ t.interface({ [ConfigKey.SOURCE_INLINE]: t.string, [ConfigKey.SOURCE_PROJECT_CONTENT]: t.string, - [ConfigKey.SOURCE_ZIP_USERNAME]: t.string, - [ConfigKey.SOURCE_ZIP_PASSWORD]: t.string, [ConfigKey.PARAMS]: t.string, [ConfigKey.URLS]: t.union([t.string, t.null]), [ConfigKey.PORT]: t.union([t.number, t.null]), }), - ZipUrlTLSFieldsCodec, CommonFieldsCodec, ]); @@ -265,7 +240,6 @@ export const EncryptedBrowserAdvancedFieldsCodec = t.interface({ export const BrowserSimpleFieldsCodec = t.intersection([ EncryptedBrowserSimpleFieldsCodec, BrowserSensitiveSimpleFieldsCodec, - ZipUrlTLSSensitiveFieldsCodec, ]); export const BrowserSensitiveAdvancedFieldsCodec = t.interface({ diff --git a/x-pack/plugins/synthetics/e2e/journeys/synthetics/index.ts b/x-pack/plugins/synthetics/e2e/journeys/synthetics/index.ts index 1e182d06fefdc..bf4ecd526e911 100644 --- a/x-pack/plugins/synthetics/e2e/journeys/synthetics/index.ts +++ b/x-pack/plugins/synthetics/e2e/journeys/synthetics/index.ts @@ -20,8 +20,7 @@ export * from './detail_flyout'; export * from './alert_rules/default_status_alert.journey'; export * from './test_now_mode.journey'; export * from './data_retention.journey'; -// Additional flake skip along with https://github.com/elastic/kibana/pull/151936 -// export * from './monitor_details_page/monitor_summary.journey'; +export * from './monitor_details_page/monitor_summary.journey'; export * from './test_run_details.journey'; export * from './step_details.journey'; export * from './project_monitor_read_only.journey'; diff --git a/x-pack/plugins/synthetics/e2e/journeys/synthetics/overview_search.journey.ts b/x-pack/plugins/synthetics/e2e/journeys/synthetics/overview_search.journey.ts index cb9983e830406..49bacee80380e 100644 --- a/x-pack/plugins/synthetics/e2e/journeys/synthetics/overview_search.journey.ts +++ b/x-pack/plugins/synthetics/e2e/journeys/synthetics/overview_search.journey.ts @@ -68,32 +68,38 @@ journey('Overview Search', async ({ page, params }) => { await page.waitForSelector(`text=${elasticJourney}`); await page.waitForSelector(`text=${cnnJourney}`); await page.waitForSelector(`text=${googleJourney}`); - await page.focus('[data-test-subj="syntheticsOverviewSearchInput"]'); - await page.type('[data-test-subj="syntheticsOverviewSearchInput"]', 'Elastic', { delay: 300 }); - await page.waitForSelector(`text=${elasticJourney}`); - expect(await elastic.count()).toBe(1); - expect(await cnn.count()).toBe(0); - expect(await google.count()).toBe(0); - await page.click('[aria-label="Clear input"]'); - await page.type('[data-test-subj="syntheticsOverviewSearchInput"]', 'cnn', { delay: 300 }); - await page.waitForSelector(`text=${cnnJourney}`); - expect(await elastic.count()).toBe(0); - expect(await cnn.count()).toBe(1); - expect(await google.count()).toBe(0); - await page.click('[aria-label="Clear input"]'); - await page.type('[data-test-subj="syntheticsOverviewSearchInput"]', 'GOOGLE', { delay: 300 }); - await page.waitForSelector(`text=${googleJourney}`); - expect(await elastic.count()).toBe(0); - expect(await cnn.count()).toBe(0); - expect(await google.count()).toBe(1); - await page.click('[aria-label="Clear input"]'); - await page.type('[data-test-subj="syntheticsOverviewSearchInput"]', 'Journey', { delay: 300 }); - await page.waitForSelector(`text=${elasticJourney}`); - await page.waitForSelector(`text=${cnnJourney}`); - await page.waitForSelector(`text=${googleJourney}`); - expect(await elastic.count()).toBe(1); - expect(await cnn.count()).toBe(1); - expect(await google.count()).toBe(1); + await retry.tryForTime(60 * 1000, async () => { + await page.focus('[data-test-subj="syntheticsOverviewSearchInput"]'); + await page.type('[data-test-subj="syntheticsOverviewSearchInput"]', 'Elastic', { + delay: 300, + }); + await page.waitForSelector(`text=${elasticJourney}`); + expect(await elastic.count()).toBe(1); + expect(await cnn.count()).toBe(0); + expect(await google.count()).toBe(0); + await page.click('[aria-label="Clear input"]'); + await page.type('[data-test-subj="syntheticsOverviewSearchInput"]', 'cnn', { delay: 300 }); + await page.waitForSelector(`text=${cnnJourney}`); + expect(await elastic.count()).toBe(0); + expect(await cnn.count()).toBe(1); + expect(await google.count()).toBe(0); + await page.click('[aria-label="Clear input"]'); + await page.type('[data-test-subj="syntheticsOverviewSearchInput"]', 'GOOGLE', { delay: 300 }); + await page.waitForSelector(`text=${googleJourney}`); + expect(await elastic.count()).toBe(0); + expect(await cnn.count()).toBe(0); + expect(await google.count()).toBe(1); + await page.click('[aria-label="Clear input"]'); + await page.type('[data-test-subj="syntheticsOverviewSearchInput"]', 'Journey', { + delay: 300, + }); + await page.waitForSelector(`text=${elasticJourney}`); + await page.waitForSelector(`text=${cnnJourney}`); + await page.waitForSelector(`text=${googleJourney}`); + expect(await elastic.count()).toBe(1); + expect(await cnn.count()).toBe(1); + expect(await google.count()).toBe(1); + }); }); step('searches by tags', async () => { diff --git a/x-pack/plugins/synthetics/e2e/journeys/synthetics/services/add_monitor.ts b/x-pack/plugins/synthetics/e2e/journeys/synthetics/services/add_monitor.ts index 90a16752441ef..44053aa29ed26 100644 --- a/x-pack/plugins/synthetics/e2e/journeys/synthetics/services/add_monitor.ts +++ b/x-pack/plugins/synthetics/e2e/journeys/synthetics/services/add_monitor.ts @@ -117,18 +117,12 @@ export const testDataMonitor = { playwright_options: '', __ui: { script_source: { is_generated_script: false, file_name: '' }, - is_zip_url_tls_enabled: false, }, params: '', 'url.port': null, 'source.inline.script': "step('Go to https://www.google.com', async () => {\n await page.goto('https://www.google.com');\n expect(await page.isVisible('text=Data')).toBeTruthy();\n });", 'source.project.content': '', - 'source.zip_url.url': '', - 'source.zip_url.username': '', - 'source.zip_url.password': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', playwright_text_assertion: 'Data', urls: 'https://www.google.com', screenshots: 'on', diff --git a/x-pack/plugins/synthetics/e2e/tasks/import_monitors.ts b/x-pack/plugins/synthetics/e2e/tasks/import_monitors.ts index 2d28655da4e1b..f65d82a9933f4 100644 --- a/x-pack/plugins/synthetics/e2e/tasks/import_monitors.ts +++ b/x-pack/plugins/synthetics/e2e/tasks/import_monitors.ts @@ -35,7 +35,6 @@ export const importMonitors = async ({ playwright_options: '', __ui: { script_source: { is_generated_script: false, file_name: '' }, - is_zip_url_tls_enabled: false, is_tls_enabled: false, }, params: '', @@ -43,11 +42,6 @@ export const importMonitors = async ({ 'source.inline.script': "const username = 'diawar.khan.shewani+conduit@gmail.com';\nconst password = 'aNL2sTGRbNYauc8';\n// Goto https://demo.realworld.io/ and sign up for username and password\n\nconst articleTitle = 'Artile No. ' + Math.ceil(Math.random() * 1000);\n\nstep(\"Goto home page\", async () => {\n await page.goto('https://demo.realworld.io/');\n});\n\nstep(\"Goto login page\", async () => {\n await page.click('text=Sign in');\n});\n\nstep(\"Enter login credentials\", async () => {\n await page.fill('[placeholder=\"Email\"]', username);\n await page.fill('[placeholder=\"Password\"]', password);\n});\n\nstep(\"Sign in\", async () => {\n await page.click('button[type=submit]');\n});\n\nstep(\"Create article\", async () => {\n const articleSubject = 'Test article subject';\n const articleBody = 'This ariticle is created with **synthetics** for purely testing purposes.';\n\n await page.click('text=New Article');\n await page.fill('[placeholder=\"Article Title\"]', articleTitle);\n await page.fill('[placeholder=\"What\\'s this article about?\"]', articleSubject);\n await page.fill('textarea', articleBody);\n});\n\nstep(\"Publish article\", async () => {\n await page.click('text=Publish Article');\n await page.waitForNavigation();\n\n // Fail about 30% of random times\n const passFailText = Math.random() * 10 > 7 ? 'non-existent-text' : articleTitle ;\n await page.waitForSelector('text=' + articleTitle);\n});\n\nstep(\"Post 1st comment\", async() => {\n const firstCommentText = 'First comment!';\n await page.fill('[placeholder=\"Write a comment...\"]', firstCommentText);\n await page.click('text=Post Comment');\n await page.waitForSelector('text=' + firstCommentText);\n});", 'source.project.content': '', - 'source.zip_url.url': '', - 'source.zip_url.username': '', - 'source.zip_url.password': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', urls: '', screenshots: 'on', synthetics_args: [], diff --git a/x-pack/plugins/synthetics/e2e/tasks/uptime_monitor.ndjson b/x-pack/plugins/synthetics/e2e/tasks/uptime_monitor.ndjson index bb8acca240094..818bbfcefd579 100644 --- a/x-pack/plugins/synthetics/e2e/tasks/uptime_monitor.ndjson +++ b/x-pack/plugins/synthetics/e2e/tasks/uptime_monitor.ndjson @@ -1,2 +1,2 @@ -{"attributes":{"__ui":{"is_tls_enabled":false,"is_zip_url_tls_enabled":false},"check.request.method":"GET","check.response.status":[],"enabled":true,"locations":[{"geo":{"lat":41.25,"lon":-95.86},"id":"us_central","label":"US Central","url":"https://us-central.synthetics.elastic.dev"}],"max_redirects":"0","name":"Test Monitor","proxy_url":"","response.include_body":"on_error","response.include_headers":true,"schedule":{"number":"3","unit":"m"},"service.name":"","tags":[],"timeout":"16","type":"http","urls":"https://www.google.com", "secrets": "{}"},"coreMigrationVersion":"8.1.0","id":"832b9980-7fba-11ec-b360-25a79ce3f496","references":[],"sort":[1643319958480,20371],"type":"synthetics-monitor","updated_at":"2022-01-27T21:45:58.480Z","version":"WzExOTg3ODYsMl0="} +{"attributes":{"__ui":{"is_tls_enabled":false},"check.request.method":"GET","check.response.status":[],"enabled":true,"locations":[{"geo":{"lat":41.25,"lon":-95.86},"id":"us_central","label":"US Central","url":"https://us-central.synthetics.elastic.dev"}],"max_redirects":"0","name":"Test Monitor","proxy_url":"","response.include_body":"on_error","response.include_headers":true,"schedule":{"number":"3","unit":"m"},"service.name":"","tags":[],"timeout":"16","type":"http","urls":"https://www.google.com", "secrets": "{}"},"coreMigrationVersion":"8.1.0","id":"832b9980-7fba-11ec-b360-25a79ce3f496","references":[],"sort":[1643319958480,20371],"type":"synthetics-monitor","updated_at":"2022-01-27T21:45:58.480Z","version":"WzExOTg3ODYsMl0="} {"excludedObjects":[],"excludedObjectsCount":0,"exportedCount":2,"missingRefCount":0,"missingReferences":[]} diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/monitor_location_select.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/monitor_location_select.tsx index afbabe76db571..a4b70e0704b66 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/monitor_location_select.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/monitor_location_select.tsx @@ -79,6 +79,7 @@ export const MonitorLocationSelect = ({ closeLocationList(); onChange(location.id, location.label); }} + disabled={selectedLocation?.id === location.id} > {location.label} diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/page_loader.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/page_loader.tsx new file mode 100644 index 0000000000000..10ab9848c6c0b --- /dev/null +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/common/components/page_loader.tsx @@ -0,0 +1,32 @@ +/* + * 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 React from 'react'; + +import { EuiFlexGroup, EuiFlexItem, EuiTitle, EuiSpacer, EuiText } from '@elastic/eui'; + +export const PageLoader = ({ + title, + body, + icon, +}: { + title: React.ReactElement; + body?: React.ReactElement; + icon: React.ReactElement; +}) => { + return ( + + + {icon} + + {title} + + {body && {body}} + + + ); +}; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/defaults.test.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/defaults.test.tsx index 47c1ce7989ef0..70521c28983f7 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/defaults.test.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/defaults.test.tsx @@ -44,17 +44,6 @@ describe('defaults', () => { 'service.name': '', 'source.inline.script': testScript, 'source.project.content': '', - 'source.zip_url.folder': '', - 'source.zip_url.password': '', - 'source.zip_url.proxy_url': '', - 'source.zip_url.ssl.certificate': undefined, - 'source.zip_url.ssl.certificate_authorities': undefined, - 'source.zip_url.ssl.key': undefined, - 'source.zip_url.ssl.key_passphrase': undefined, - 'source.zip_url.ssl.supported_protocols': undefined, - 'source.zip_url.ssl.verification_mode': undefined, - 'source.zip_url.url': '', - 'source.zip_url.username': '', 'ssl.certificate': '', 'ssl.certificate_authorities': '', 'ssl.key': '', @@ -117,17 +106,6 @@ describe('defaults', () => { }, 'source.inline.script': 'testScript', 'source.project.content': '', - 'source.zip_url.folder': '', - 'source.zip_url.password': '', - 'source.zip_url.proxy_url': '', - 'source.zip_url.ssl.certificate': undefined, - 'source.zip_url.ssl.certificate_authorities': undefined, - 'source.zip_url.ssl.key': undefined, - 'source.zip_url.ssl.key_passphrase': undefined, - 'source.zip_url.ssl.supported_protocols': undefined, - 'source.zip_url.ssl.verification_mode': undefined, - 'source.zip_url.url': '', - 'source.zip_url.username': '', 'ssl.certificate': '', 'ssl.certificate_authorities': '', 'ssl.key': '', diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/field_config.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/field_config.tsx index 110ac698e22f7..934a895c47d34 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/field_config.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/field_config.tsx @@ -68,7 +68,11 @@ import { FieldMap, FormLocation, } from '../types'; -import { AlertConfigKey, DEFAULT_BROWSER_ADVANCED_FIELDS } from '../constants'; +import { + AlertConfigKey, + DEFAULT_BROWSER_ADVANCED_FIELDS, + ALLOWED_SCHEDULES_IN_MINUTES, +} from '../constants'; import { getDefaultFormFields } from './defaults'; import { validate, validateHeaders, WHOLE_NUMBERS_ONLY, FLOATS_ONLY } from './validation'; @@ -90,16 +94,10 @@ const getScheduleContent = (value: number) => { } }; -const getScheduleConfig = (schedules: number[]) => { - return schedules.map((value) => ({ - value: `${value}`, - text: getScheduleContent(value), - })); -}; - -const BROWSER_SCHEDULES = getScheduleConfig([3, 5, 10, 15, 30, 60, 120, 240]); - -const LIGHTWEIGHT_SCHEDULES = getScheduleConfig([1, 3, 5, 10, 15, 30, 60]); +const SCHEDULES = ALLOWED_SCHEDULES_IN_MINUTES.map((value) => ({ + value, + text: getScheduleContent(parseInt(value, 10)), +})); export const MONITOR_TYPE_CONFIG = { [FormMonitorType.MULTISTEP]: { @@ -378,12 +376,10 @@ export const FIELD = (readOnly?: boolean): FieldMap => ({ defaultMessage: 'How often do you want to run this test? Higher frequencies will increase your total cost.', }), - dependencies: [ConfigKey.MONITOR_TYPE], - props: ({ dependencies }): EuiSelectProps => { - const [monitorType] = dependencies; + props: (): EuiSelectProps => { return { 'data-test-subj': 'syntheticsMonitorConfigSchedule', - options: monitorType === DataStream.BROWSER ? BROWSER_SCHEDULES : LIGHTWEIGHT_SCHEDULES, + options: SCHEDULES, disabled: readOnly, }; }, diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/formatter.test.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/formatter.test.tsx index 6a457d601802b..6000b02cb7f87 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/formatter.test.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/formatter.test.tsx @@ -188,16 +188,10 @@ describe('format', () => { is_generated_script: false, file_name: '', }, - is_zip_url_tls_enabled: false, }, params: '', 'source.inline.script': '', 'source.project.content': '', - 'source.zip_url.url': '', - 'source.zip_url.username': '', - 'source.zip_url.password': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', playwright_text_assertion: '', urls: '', screenshots: 'on', @@ -276,17 +270,6 @@ describe('format', () => { 'service.name': '', 'source.inline.script': script, 'source.project.content': '', - 'source.zip_url.folder': '', - 'source.zip_url.password': '', - 'source.zip_url.proxy_url': '', - 'source.zip_url.ssl.certificate': undefined, - 'source.zip_url.ssl.certificate_authorities': undefined, - 'source.zip_url.ssl.key': undefined, - 'source.zip_url.ssl.key_passphrase': undefined, - 'source.zip_url.ssl.supported_protocols': undefined, - 'source.zip_url.ssl.verification_mode': undefined, - 'source.zip_url.url': '', - 'source.zip_url.username': '', 'ssl.certificate': '', 'ssl.certificate_authorities': '', 'ssl.key': '', diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/validation.test.ts b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/validation.test.ts index fa91bd457671d..4b4e524c9f3b0 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/validation.test.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/validation.test.ts @@ -49,10 +49,7 @@ describe('[Monitor Management] validation', () => { }); }); - describe.each([ - [ConfigKey.SOURCE_INLINE, 'step(() => {});'], - [ConfigKey.SOURCE_ZIP_URL, 'https://test.zip'], - ])('Browser', (configKey, value) => { + describe.each([[ConfigKey.SOURCE_INLINE, 'step(() => {});']])('Browser', (configKey, value) => { const browserProps: Partial = { ...commonPropsValid, [ConfigKey.MONITOR_TYPE]: DataStream.BROWSER, diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/validation.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/validation.tsx index 9f06395bf1a19..cc03228d755be 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/validation.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_add_edit/form/validation.tsx @@ -147,14 +147,7 @@ const validateThrottleValue = (speed: string | undefined, allowZero?: boolean) = const validateBrowser: ValidationLibrary = { ...validateCommon, - [ConfigKey.SOURCE_ZIP_URL]: ({ - [ConfigKey.SOURCE_ZIP_URL]: zipUrl, - [ConfigKey.SOURCE_INLINE]: inlineScript, - }) => !zipUrl && !inlineScript, - [ConfigKey.SOURCE_INLINE]: ({ - [ConfigKey.SOURCE_ZIP_URL]: zipUrl, - [ConfigKey.SOURCE_INLINE]: inlineScript, - }) => !zipUrl && !inlineScript, + [ConfigKey.SOURCE_INLINE]: ({ [ConfigKey.SOURCE_INLINE]: inlineScript }) => !inlineScript, [ConfigKey.DOWNLOAD_SPEED]: ({ [ConfigKey.DOWNLOAD_SPEED]: downloadSpeed }) => validateThrottleValue(downloadSpeed), [ConfigKey.UPLOAD_SPEED]: ({ [ConfigKey.UPLOAD_SPEED]: uploadSpeed }) => diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/hooks/use_monitor_latest_ping.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/hooks/use_monitor_latest_ping.tsx index 6ad6931694b38..77c4e813f654c 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/hooks/use_monitor_latest_ping.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/hooks/use_monitor_latest_ping.tsx @@ -28,7 +28,7 @@ export const useMonitorLatestPing = (params?: UseMonitorLatestPingParams) => { const monitorId = params?.monitorId ?? monitor?.id; const locationLabel = params?.locationLabel ?? location?.label; - const { data: latestPing, loading } = useSelector(selectLastRunMetadata); + const { data: latestPing, loading, loaded } = useSelector(selectLastRunMetadata); const latestPingId = latestPing?.monitor.id; @@ -46,16 +46,16 @@ export const useMonitorLatestPing = (params?: UseMonitorLatestPingParams) => { }, [dispatch, monitorId, locationLabel, isUpToDate, lastRefresh]); if (!monitorId || !locationLabel) { - return { loading, latestPing: undefined }; + return { loading, latestPing: undefined, loaded }; } if (!latestPing) { - return { loading, latestPing: undefined }; + return { loading, latestPing: undefined, loaded }; } if (!isIdSame || !isLocationSame) { - return { loading, latestPing: undefined }; + return { loading, latestPing: undefined, loaded }; } - return { loading, latestPing }; + return { loading, latestPing, loaded }; }; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_errors/monitor_errors.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_errors/monitor_errors.tsx index 04930af018152..2a8ac3cd3691e 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_errors/monitor_errors.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_errors/monitor_errors.tsx @@ -19,6 +19,7 @@ import { useMonitorDetailsPage } from '../use_monitor_details_page'; import { useMonitorErrors } from '../hooks/use_monitor_errors'; import { SyntheticsDatePicker } from '../../common/date_picker/synthetics_date_picker'; import { ErrorsTabContent } from './errors_tab_content'; +import { MonitorPendingWrapper } from '../monitor_pending_wrapper'; export const MonitorErrors = () => { const { errorStates, loading, data } = useMonitorErrors(); @@ -33,7 +34,7 @@ export const MonitorErrors = () => { } return ( - <> + {initialLoading && } @@ -41,7 +42,7 @@ export const MonitorErrors = () => {
- + ); }; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_history/monitor_history.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_history/monitor_history.tsx index 5dd0570cde7e3..4d9fb7bc6e0d9 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_history/monitor_history.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_history/monitor_history.tsx @@ -24,6 +24,7 @@ import { DurationSparklines } from '../monitor_summary/duration_sparklines'; import { MonitorCompleteSparklines } from '../monitor_summary/monitor_complete_sparklines'; import { MonitorStatusPanel } from '../monitor_status/monitor_status_panel'; import { useMonitorQueryId } from '../hooks/use_monitor_query_id'; +import { MonitorPendingWrapper } from '../monitor_pending_wrapper'; const STATS_WIDTH_SINGLE_COLUMN_THRESHOLD = 360; // ✨ determined by trial and error @@ -48,107 +49,109 @@ export const MonitorHistory = () => { } return ( - - - - - - - - {/* @ts-expect-error Current @elastic/eui has the wrong types for the ref */} - - -

{STATS_LABEL}

- - - - - - - - - - - - - - - - - - - - - - - - - - {monitorId && ( - + + + + + + + + {/* @ts-expect-error Current @elastic/eui has the wrong types for the ref */} + + +

{STATS_LABEL}

+ + + + + + + + + + + + + + + + + + + - )} - - - {monitorId && ( - - )} - - - - - - - - - - - - - - - - - - - - - - -

{DURATION_TREND_LABEL}

- - - - - - - - - - - - - + + + + + + + {monitorId && ( + + )} + + + {monitorId && ( + + )} + + + + + + + + + + + + + + + + + + + + + + +

{DURATION_TREND_LABEL}

+ + + + + + + + + + + + + + ); }; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_pending_wrapper.test.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_pending_wrapper.test.tsx new file mode 100644 index 0000000000000..531ef23c41159 --- /dev/null +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_pending_wrapper.test.tsx @@ -0,0 +1,115 @@ +/* + * 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 React from 'react'; +import { render } from '../../utils/testing/rtl_helpers'; +import { MonitorPendingWrapper } from './monitor_pending_wrapper'; +import * as selectedMonitorHooks from './hooks/use_selected_monitor'; +import * as locationHooks from './hooks/use_selected_location'; + +describe('MonitorPendingWrapper', () => { + const TestComponent = () => { + return
children
; + }; + + beforeEach(() => { + jest.clearAllMocks(); + jest.spyOn(selectedMonitorHooks, 'useSelectedMonitor').mockReturnValue({ + monitor: { + id: '4afd3980-0b72-11ed-9c10-b57918ea89d6', + }, + } as ReturnType); + jest.spyOn(locationHooks, 'useSelectedLocation').mockReturnValue({ + label: 'North America - US Central', + } as ReturnType); + }); + + it('displays loading when initial ping is loading', async () => { + const { getByText, queryByText, getByTestId } = render( + + + , + { + state: { + monitorDetails: { + lastRun: { + loaded: false, + loading: true, + data: undefined, + }, + }, + }, + } + ); + + // page is loading + expect(getByText(/Loading/)).toBeInTheDocument(); + expect(queryByText(/Initial test run pending/)).not.toBeInTheDocument(); + expect(getByTestId('syntheticsPendingWrapperChildren')).toHaveAttribute( + 'style', + 'display: none;' + ); + }); + + it('displays pending when latest ping is unavailable', async () => { + const { getByText, queryByText, getByTestId } = render( + + + , + { + state: { + monitorDetails: { + lastRun: { + loaded: true, + loading: false, + // overwrite default from + // merged properties for default + // mock state + // @ts-ignore + data: null, + }, + }, + }, + } + ); + + // page is loaded with pending run + expect(queryByText(/Loading/)).not.toBeInTheDocument(); + expect(getByTestId('syntheticsPendingWrapperChildren')).toHaveAttribute( + 'style', + 'display: none;' + ); + expect(getByText(/Initial test run pending/)).toBeInTheDocument(); + }); + + it('displays children when latestPing is available', async () => { + const { queryByText, getByTestId } = render( + + + , + { + state: { + monitorDetails: { + lastRun: { + loaded: true, + loading: false, + data: {}, + }, + }, + }, + } + ); + + // page is loaded with latest ping defined + expect(queryByText(/Loading/)).not.toBeInTheDocument(); + expect(queryByText(/Initial test run pending/)).not.toBeInTheDocument(); + expect(getByTestId('syntheticsPendingWrapperChildren')).not.toHaveAttribute( + 'style', + 'display: none;' + ); + }); +}); diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_pending_wrapper.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_pending_wrapper.tsx new file mode 100644 index 0000000000000..7ff27c67384e1 --- /dev/null +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_pending_wrapper.tsx @@ -0,0 +1,108 @@ +/* + * 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 React, { useEffect, useState, useMemo, useRef } from 'react'; +import { useHistory, useParams, useLocation } from 'react-router-dom'; +import { useDispatch } from 'react-redux'; +import { i18n } from '@kbn/i18n'; +import { EuiLoadingSpinner, EuiLoadingChart } from '@elastic/eui'; +import { PageLoader } from '../common/components/page_loader'; +import { resetMonitorLastRunAction } from '../../state'; +import { useMonitorLatestPing } from './hooks/use_monitor_latest_ping'; + +export const MonitorPendingWrapper: React.FC = ({ children }) => { + const dispatch = useDispatch(); + const history = useHistory(); + const currentLocation = useLocation(); + const locationRef = useRef(currentLocation); + const { monitorId } = useParams<{ monitorId: string }>(); + + const { latestPing, loaded: pingsLoaded } = useMonitorLatestPing(); + const [loaded, setLoaded] = useState(false); + const [hasPing, setHasPing] = useState(false); + + const unlisten = useMemo( + () => + history.listen((location) => { + const currentMonitorId = location.pathname.split('/')[2] || ''; + const hasDifferentSearch = locationRef.current.search !== location.search; + const hasDifferentId = currentMonitorId !== monitorId; + locationRef.current = location; + if (hasDifferentSearch || hasDifferentId) { + setLoaded(false); + setHasPing(false); + dispatch(resetMonitorLastRunAction()); + } + }), + [history, monitorId, dispatch] + ); + + useEffect(() => { + return function cleanup() { + unlisten(); + }; + }, [unlisten]); + + useEffect(() => { + if (pingsLoaded) { + setLoaded(true); + } + if (pingsLoaded && latestPing) { + setHasPing(true); + } + }, [pingsLoaded, latestPing, dispatch, unlisten]); + + return ( + <> + {!loaded ? ( + } + title={

{LOADING_TITLE}

} + body={

{LOADING_DESCRIPTION}

} + /> + ) : null} + {loaded && !hasPing ? ( + } + title={

{MONITOR_PENDING_HEADING}

} + body={

{MONITOR_PENDING_CONTENT}

} + /> + ) : null} +
+ {children} +
+ + ); +}; + +export const MONITOR_PENDING_HEADING = i18n.translate( + 'xpack.synthetics.monitorDetails.pending.heading', + { + defaultMessage: 'Initial test run pending...', + } +); + +export const MONITOR_PENDING_CONTENT = i18n.translate( + 'xpack.synthetics.monitorDetails.pending.content', + { + defaultMessage: 'This page will refresh when data becomes available.', + } +); + +export const LOADING_DESCRIPTION = i18n.translate( + 'xpack.synthetics.monitorDetails.loading.content', + { + defaultMessage: 'This will take just a second.', + } +); + +export const LOADING_TITLE = i18n.translate('xpack.synthetics.monitorDetails.loading.heading', { + defaultMessage: 'Loading monitor details', +}); diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_status/monitor_status_chart_theme.ts b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_status/monitor_status_chart_theme.ts index 022a928f2916c..3a24ab61b90ba 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_status/monitor_status_chart_theme.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_status/monitor_status_chart_theme.ts @@ -7,7 +7,6 @@ import { HeatmapStyle, RecursivePartial } from '@elastic/charts'; import { EuiThemeComputed } from '@elastic/eui'; -import { CHART_CELL_WIDTH } from './monitor_status_data'; export function getMonitorStatusChartTheme( euiTheme: EuiThemeComputed, @@ -15,16 +14,11 @@ export function getMonitorStatusChartTheme( ): RecursivePartial { return { grid: { - cellHeight: { - min: 20, - }, stroke: { width: 0, color: 'transparent', }, }, - maxRowHeight: 30, - maxColumnWidth: CHART_CELL_WIDTH, cell: { maxWidth: 'fill', maxHeight: 3, diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_summary/monitor_summary.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_summary/monitor_summary.tsx index ebaaee6e44e50..bd840fb92f718 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_summary/monitor_summary.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitor_details/monitor_summary/monitor_summary.tsx @@ -26,6 +26,7 @@ import { AvailabilitySparklines } from './availability_sparklines'; import { LastTestRun } from './last_test_run'; import { LAST_10_TEST_RUNS, TestRunsTable } from './test_runs_table'; import { MonitorErrorsCount } from './monitor_errors_count'; +import { MonitorPendingWrapper } from '../monitor_pending_wrapper'; export const MonitorSummary = () => { const { from, to } = useMonitorRangeFrom(); @@ -40,7 +41,7 @@ export const MonitorSummary = () => { } return ( - <> + @@ -138,7 +139,7 @@ export const MonitorSummary = () => { - + ); }; diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/loader/loader.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/loader/loader.tsx index b40fb64a39576..4ca7ec2a835e3 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/loader/loader.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics/components/monitors_page/management/loader/loader.tsx @@ -6,7 +6,8 @@ */ import React from 'react'; -import { EuiEmptyPrompt, EuiLoadingLogo, EuiSpacer } from '@elastic/eui'; +import { EuiEmptyPrompt, EuiLoadingSpinner, EuiSpacer } from '@elastic/eui'; +import { PageLoader } from '../../../common/components/page_loader'; interface Props { loading: boolean; @@ -40,12 +41,7 @@ export const Loader = ({ ) : null} {loading ? ( - } - title={

{loadingTitle}

} - data-test-subj="uptimeLoader" - /> + } title={

{loadingTitle}

} /> ) : null} ); diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_details/actions.ts b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_details/actions.ts index ae6e7ff8933f7..195c2b1fcb400 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_details/actions.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_details/actions.ts @@ -27,6 +27,8 @@ export const getMonitorLastRunAction = createAsyncAction< PingsResponse >('[MONITOR DETAILS] GET LAST RUN'); +export const resetMonitorLastRunAction = createAction('[MONITOR DETAILS] LAST RUN RESET'); + export const updateMonitorLastRunAction = createAction<{ data: Ping }>( '[MONITOR DETAILS] UPdATE LAST RUN' ); diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_details/index.ts b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_details/index.ts index ec1abe5401dc2..2cdd1eadcb27f 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_details/index.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/state/monitor_details/index.ts @@ -15,6 +15,7 @@ import { IHttpSerializedFetchError } from '../utils/http_error'; import { getMonitorLastRunAction, updateMonitorLastRunAction, + resetMonitorLastRunAction, getMonitorRecentPingsAction, setMonitorDetailsLocationAction, getMonitorAction, @@ -29,6 +30,7 @@ export interface MonitorDetailsState { lastRun: { data?: Ping; loading: boolean; + loaded: boolean; }; syntheticsMonitorLoading: boolean; syntheticsMonitor: EncryptedSyntheticsSavedMonitor | null; @@ -39,7 +41,7 @@ export interface MonitorDetailsState { const initialState: MonitorDetailsState = { pings: { total: 0, data: [], loading: false }, - lastRun: { loading: false }, + lastRun: { loading: false, loaded: false }, syntheticsMonitor: null, syntheticsMonitorLoading: false, syntheticsMonitorDispatchedAt: 0, @@ -54,12 +56,14 @@ export const monitorDetailsReducer = createReducer(initialState, (builder) => { }) .addCase(getMonitorLastRunAction.get, (state, action) => { state.lastRun.loading = true; + state.lastRun.loaded = false; if (checkIsStalePing(action.payload.monitorId, state.lastRun.data)) { state.lastRun.data = undefined; } }) .addCase(getMonitorLastRunAction.success, (state, action) => { state.lastRun.loading = false; + state.lastRun.loaded = true; state.lastRun.data = action.payload.pings[0]; }) .addCase(getMonitorLastRunAction.fail, (state, action) => { @@ -69,6 +73,9 @@ export const monitorDetailsReducer = createReducer(initialState, (builder) => { .addCase(updateMonitorLastRunAction, (state, action) => { state.lastRun.data = action.payload.data; }) + .addCase(resetMonitorLastRunAction, (state, action) => { + state.lastRun.loaded = false; + }) .addCase(getMonitorRecentPingsAction.get, (state, action) => { state.pings.loading = true; state.pings.data = state.pings.data.filter( diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/utils/testing/__mocks__/synthetics_store.mock.ts b/x-pack/plugins/synthetics/public/apps/synthetics/utils/testing/__mocks__/synthetics_store.mock.ts index 051f0731c62e6..d65c68f2843b9 100644 --- a/x-pack/plugins/synthetics/public/apps/synthetics/utils/testing/__mocks__/synthetics_store.mock.ts +++ b/x-pack/plugins/synthetics/public/apps/synthetics/utils/testing/__mocks__/synthetics_store.mock.ts @@ -175,6 +175,7 @@ function getMonitorDetailsMockSlice() { return { lastRun: { loading: false, + loaded: true, data: { summary: { up: 1, down: 0 }, agent: { @@ -416,7 +417,6 @@ function getMonitorDetailsMockSlice() { playwright_options: '', __ui: { script_source: { is_generated_script: false, file_name: '' }, - is_zip_url_tls_enabled: false, is_tls_enabled: false, }, params: '', @@ -424,11 +424,6 @@ function getMonitorDetailsMockSlice() { 'source.inline.script': "step('Goto one pixel image', async () => {\\n await page.goto('data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==');\\n});", 'source.project.content': '', - 'source.zip_url.url': '', - 'source.zip_url.username': '', - 'source.zip_url.password': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', urls: 'data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==', screenshots: 'on', synthetics_args: [], diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/donut_chart.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/donut_chart.test.tsx.snap index 58e01666035e8..5cc141d7c14fb 100644 --- a/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/donut_chart.test.tsx.snap +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/donut_chart.test.tsx.snap @@ -329,21 +329,11 @@ exports[`DonutChart component passes correct props without errors for valid prop "maxWidth": "fill", }, "grid": Object { - "cellHeight": Object { - "max": 30, - "min": 12, - }, - "cellWidth": Object { - "max": 30, - "min": 0, - }, "stroke": Object { "color": "gray", "width": 1, }, }, - "maxColumnWidth": 30, - "maxRowHeight": 30, "xAxisLabel": Object { "fontFamily": "Sans-Serif", "fontSize": 12, diff --git a/x-pack/plugins/synthetics/server/alert_rules/status_rule/status_rule_executor.test.ts b/x-pack/plugins/synthetics/server/alert_rules/status_rule/status_rule_executor.test.ts index d95883f78b7b1..367c27c4bca08 100644 --- a/x-pack/plugins/synthetics/server/alert_rules/status_rule/status_rule_executor.test.ts +++ b/x-pack/plugins/synthetics/server/alert_rules/status_rule/status_rule_executor.test.ts @@ -161,12 +161,8 @@ const testMonitors = [ playwright_options: '', __ui: { script_source: { is_generated_script: false, file_name: '' }, - is_zip_url_tls_enabled: false, }, 'url.port': null, - 'source.zip_url.url': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', playwright_text_assertion: '', urls: 'https://www.google.com', screenshots: 'on', diff --git a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.6.0.test.ts b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.6.0.test.ts index 68e3416174c8f..3f046a5ed3115 100644 --- a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.6.0.test.ts +++ b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.6.0.test.ts @@ -37,7 +37,7 @@ const monitor850UI = { origin: 'ui', journey_id: '', id: '', - __ui: { is_tls_enabled: false, is_zip_url_tls_enabled: false }, + __ui: { is_tls_enabled: false }, urls: 'https://elastic.co', max_redirects: '0', 'url.port': null, diff --git a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.6.0.ts b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.6.0.ts index 1302e3bc203b8..cce87ec58f649 100644 --- a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.6.0.ts +++ b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.6.0.ts @@ -7,7 +7,7 @@ import { EncryptedSavedObjectsPluginSetup } from '@kbn/encrypted-saved-objects-plugin/server'; import { SavedObjectUnsanitizedDoc } from '@kbn/core/server'; import { ConfigKey, SyntheticsMonitorWithSecrets } from '../../../../../../common/runtime_types'; -import { SYNTHETICS_MONITOR_ENCRYPTED_TYPE } from '../../synthetics_monitor'; +import { LEGACY_SYNTHETICS_MONITOR_ENCRYPTED_TYPE } from '../../synthetics_monitor'; export const migration860 = (encryptedSavedObjects: EncryptedSavedObjectsPluginSetup) => { return encryptedSavedObjects.createMigration< @@ -32,6 +32,6 @@ export const migration860 = (encryptedSavedObjects: EncryptedSavedObjectsPluginS }, }; }, - migratedType: SYNTHETICS_MONITOR_ENCRYPTED_TYPE, + migratedType: LEGACY_SYNTHETICS_MONITOR_ENCRYPTED_TYPE, }); }; diff --git a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.8.0.test.ts b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.8.0.test.ts new file mode 100644 index 0000000000000..229a45eae14c5 --- /dev/null +++ b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.8.0.test.ts @@ -0,0 +1,382 @@ +/* + * 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 { encryptedSavedObjectsMock } from '@kbn/encrypted-saved-objects-plugin/server/mocks'; +import { migration880 } from './8.8.0'; +import { migrationMocks } from '@kbn/core/server/mocks'; +import { ConfigKey, ScheduleUnit } from '../../../../../../common/runtime_types'; +import { ALLOWED_SCHEDULES_IN_MINUTES } from '../../../../../../common/constants/monitor_defaults'; +import { + browserUI, + browserProject, + browserUptimeUI, + tcpUptimeUI, + icmpUptimeUI, + httpUptimeUI, +} from './test_fixtures/8.7.0'; + +const context = migrationMocks.createContext(); +const encryptedSavedObjectsSetup = encryptedSavedObjectsMock.createSetup(); + +describe('Monitor migrations v8.7.0 -> v8.8.0', () => { + const testSchedules = [ + ['4', '3'], + ['7', '5'], + ['8', '10'], + ['9.5', '10'], + ['12', '10'], + ['13', '15'], + ['16', '15'], + ['18', '20'], + ['21', '20'], + ['25', '20'], + ['26', '30'], + ['31', '30'], + ['45', '30'], + ['46', '60'], + ['61', '60'], + ['90', '60'], + ['91', '120'], + ['121', '120'], + ['195', '240'], + ['600', '240'], + ]; + + beforeEach(() => { + jest.resetAllMocks(); + encryptedSavedObjectsSetup.createMigration.mockImplementation(({ migration }) => migration); + }); + + describe('config hash', () => { + it('sets config hash back to empty string', () => { + expect(browserProject.attributes[ConfigKey.CONFIG_HASH]).toBeTruthy(); + const actual = migration880(encryptedSavedObjectsSetup)(browserProject, context); + expect(actual.attributes[ConfigKey.CONFIG_HASH]).toEqual(''); + }); + }); + + describe('zip url deprecation', () => { + it('removes all top level zip url fields for synthetics UI monitor', () => { + expect( + Object.keys(browserUI.attributes).some((key: string) => key.includes('zip_url')) + ).toEqual(true); + const actual = migration880(encryptedSavedObjectsSetup)(browserUI, context); + expect(actual).toEqual({ + attributes: { + __ui: { + script_source: { + file_name: '', + is_generated_script: false, + }, + }, + alert: { + status: { + enabled: true, + }, + }, + config_id: '311cf324-2fc9-4453-9ba5-5e745fd81722', + enabled: true, + 'filter_journeys.match': '', + 'filter_journeys.tags': [], + form_monitor_type: 'multistep', + hash: '', + id: '311cf324-2fc9-4453-9ba5-5e745fd81722', + ignore_https_errors: false, + journey_id: '', + locations: [ + { + geo: { + lat: 41.25, + lon: -95.86, + }, + id: 'us_central', + isServiceManaged: true, + label: 'North America - US Central', + }, + ], + name: 'https://elastic.co', + namespace: 'default', + origin: 'ui', + playwright_options: '', + playwright_text_assertion: '', + project_id: '', + revision: 1, + schedule: { + number: '10', + unit: 'm', + }, + screenshots: 'on', + secrets: + '{"params":"","source.inline.script":"step(\'Go to https://elastic.co\', async () => {\\n await page.goto(\'https://elastic.co\');\\n});","source.project.content":"","synthetics_args":[],"ssl.key":"","ssl.key_passphrase":""}', + 'service.name': '', + 'ssl.certificate': '', + 'ssl.certificate_authorities': '', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + 'ssl.verification_mode': 'full', + tags: [], + 'throttling.config': '5d/3u/20l', + 'throttling.download_speed': '5', + 'throttling.is_enabled': true, + 'throttling.latency': '20', + 'throttling.upload_speed': '3', + timeout: null, + type: 'browser', + 'url.port': null, + urls: 'https://elastic.co', + }, + coreMigrationVersion: '8.8.0', + created_at: '2023-03-31T20:31:24.177Z', + id: '311cf324-2fc9-4453-9ba5-5e745fd81722', + references: [], + type: 'synthetics-monitor', + typeMigrationVersion: '8.6.0', + updated_at: '2023-03-31T20:31:24.177Z', + }); + expect(Object.keys(actual.attributes).some((key: string) => key.includes('zip_url'))).toEqual( + false + ); + }); + + it.each([browserUptimeUI, browserProject])( + 'removes all top level zip url fields for Uptime and Project monitors', + (testMonitor) => { + expect( + Object.keys(testMonitor.attributes).some((key: string) => key.includes('zip_url')) + ).toEqual(true); + const actual = migration880(encryptedSavedObjectsSetup)(testMonitor, context); + expect( + Object.keys(actual.attributes).some((key: string) => key.includes('zip_url')) + ).toEqual(false); + } + ); + + it('returns the original doc if an error occurs removing zip url fields', () => { + const invalidTestMonitor = { + ...browserUI, + attributes: { + ...browserUI.attributes, + name: null, + }, + }; + // @ts-ignore specificially testing monitors with invalid values + const actual = migration880(encryptedSavedObjectsSetup)(invalidTestMonitor, context); + expect(actual).toEqual(invalidTestMonitor); + }); + }); + + describe('schedule migration', () => { + it.each(testSchedules)( + 'handles migrating schedule with invalid schedules - browser', + (previous, migrated) => { + const testMonitorWithSchedule = { + ...browserUptimeUI, + attributes: { + ...browserUptimeUI.attributes, + [ConfigKey.SCHEDULE]: { + unit: ScheduleUnit.MINUTES, + number: previous, + }, + }, + }; + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes( + testMonitorWithSchedule.attributes[ConfigKey.SCHEDULE].number + ) + ).toBe(false); + const actual = migration880(encryptedSavedObjectsSetup)(testMonitorWithSchedule, context); + expect(actual.attributes[ConfigKey.SCHEDULE].number).toEqual(migrated); + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes(actual.attributes[ConfigKey.SCHEDULE].number) + ).toBe(true); + expect(actual.attributes[ConfigKey.SCHEDULE].unit).toEqual(ScheduleUnit.MINUTES); + } + ); + + it.each(ALLOWED_SCHEDULES_IN_MINUTES)( + 'handles migrating schedule with valid schedules - browser', + (validSchedule) => { + const testMonitorWithSchedule = { + ...browserUptimeUI, + attributes: { + ...browserUptimeUI.attributes, + [ConfigKey.SCHEDULE]: { + unit: ScheduleUnit.MINUTES, + number: validSchedule, + }, + }, + }; + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes( + testMonitorWithSchedule.attributes[ConfigKey.SCHEDULE].number + ) + ).toBe(true); + const actual = migration880(encryptedSavedObjectsSetup)(testMonitorWithSchedule, context); + expect(actual.attributes[ConfigKey.SCHEDULE].number).toEqual(validSchedule); + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes(actual.attributes[ConfigKey.SCHEDULE].number) + ).toBe(true); + expect(actual.attributes[ConfigKey.SCHEDULE].unit).toEqual(ScheduleUnit.MINUTES); + } + ); + + it.each(ALLOWED_SCHEDULES_IN_MINUTES)( + 'handles migrating schedule with valid schedules - http', + (validSchedule) => { + const testMonitorWithSchedule = { + ...httpUptimeUI, + attributes: { + ...httpUptimeUI.attributes, + [ConfigKey.SCHEDULE]: { + unit: ScheduleUnit.MINUTES, + number: validSchedule, + }, + }, + }; + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes( + testMonitorWithSchedule.attributes[ConfigKey.SCHEDULE].number + ) + ).toBe(true); + const actual = migration880(encryptedSavedObjectsSetup)(testMonitorWithSchedule, context); + expect(actual.attributes[ConfigKey.SCHEDULE].number).toEqual(validSchedule); + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes(actual.attributes[ConfigKey.SCHEDULE].number) + ).toBe(true); + expect(actual.attributes[ConfigKey.SCHEDULE].unit).toEqual(ScheduleUnit.MINUTES); + } + ); + + it.each(ALLOWED_SCHEDULES_IN_MINUTES)( + 'handles migrating schedule with valid schedules - tcp', + (validSchedule) => { + const testMonitorWithSchedule = { + ...tcpUptimeUI, + attributes: { + ...tcpUptimeUI.attributes, + [ConfigKey.SCHEDULE]: { + unit: ScheduleUnit.MINUTES, + number: validSchedule, + }, + }, + }; + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes( + testMonitorWithSchedule.attributes[ConfigKey.SCHEDULE].number + ) + ).toBe(true); + const actual = migration880(encryptedSavedObjectsSetup)(testMonitorWithSchedule, context); + expect(actual.attributes[ConfigKey.SCHEDULE].number).toEqual(validSchedule); + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes(actual.attributes[ConfigKey.SCHEDULE].number) + ).toBe(true); + expect(actual.attributes[ConfigKey.SCHEDULE].unit).toEqual(ScheduleUnit.MINUTES); + } + ); + + it.each(ALLOWED_SCHEDULES_IN_MINUTES)( + 'handles migrating schedule with valid schedules - icmp', + (validSchedule) => { + const testMonitorWithSchedule = { + ...icmpUptimeUI, + attributes: { + ...icmpUptimeUI.attributes, + [ConfigKey.SCHEDULE]: { + unit: ScheduleUnit.MINUTES, + number: validSchedule, + }, + }, + }; + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes( + testMonitorWithSchedule.attributes[ConfigKey.SCHEDULE].number + ) + ).toBe(true); + const actual = migration880(encryptedSavedObjectsSetup)(testMonitorWithSchedule, context); + expect(actual.attributes[ConfigKey.SCHEDULE].number).toEqual(validSchedule); + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes(actual.attributes[ConfigKey.SCHEDULE].number) + ).toBe(true); + expect(actual.attributes[ConfigKey.SCHEDULE].unit).toEqual(ScheduleUnit.MINUTES); + } + ); + + it.each(ALLOWED_SCHEDULES_IN_MINUTES)( + 'handles migrating schedule with valid schedules - project', + (validSchedule) => { + const testMonitorWithSchedule = { + ...browserProject, + attributes: { + ...browserProject.attributes, + [ConfigKey.SCHEDULE]: { + unit: ScheduleUnit.MINUTES, + number: validSchedule, + }, + }, + }; + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes( + testMonitorWithSchedule.attributes[ConfigKey.SCHEDULE].number + ) + ).toBe(true); + const actual = migration880(encryptedSavedObjectsSetup)(testMonitorWithSchedule, context); + expect(actual.attributes[ConfigKey.SCHEDULE].number).toEqual(validSchedule); + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes(actual.attributes[ConfigKey.SCHEDULE].number) + ).toBe(true); + expect(actual.attributes[ConfigKey.SCHEDULE].unit).toEqual(ScheduleUnit.MINUTES); + } + ); + + // handles invalid values stored in saved object + it.each([null, undefined, {}, []])( + 'handles migrating schedule with invalid values - browser', + (invalidSchedule) => { + const testMonitorWithSchedule = { + ...browserUptimeUI, + attributes: { + ...browserUptimeUI.attributes, + [ConfigKey.SCHEDULE]: { + unit: ScheduleUnit.MINUTES, + number: invalidSchedule, + }, + }, + }; + // @ts-ignore specificially testing monitors with invalid values for full coverage + const actual = migration880(encryptedSavedObjectsSetup)(testMonitorWithSchedule, context); + expect(actual.attributes[ConfigKey.SCHEDULE].number).toEqual('1'); + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes(actual.attributes[ConfigKey.SCHEDULE].number) + ).toBe(true); + expect(actual.attributes[ConfigKey.SCHEDULE].unit).toEqual(ScheduleUnit.MINUTES); + } + ); + + // handles invalid values stored in saved object + it.each([ + [5, '5'], + [4, '3'], + [2.5, '3'], + ])('handles migrating schedule numeric values - browser', (invalidSchedule, migrated) => { + const testMonitorWithSchedule = { + ...browserUptimeUI, + attributes: { + ...browserUptimeUI.attributes, + [ConfigKey.SCHEDULE]: { + unit: ScheduleUnit.MINUTES, + number: invalidSchedule, + }, + }, + }; + // @ts-ignore specificially testing monitors with invalid values for full coverage + const actual = migration880(encryptedSavedObjectsSetup)(testMonitorWithSchedule, context); + expect(actual.attributes[ConfigKey.SCHEDULE].number).toEqual(migrated); + expect( + ALLOWED_SCHEDULES_IN_MINUTES.includes(actual.attributes[ConfigKey.SCHEDULE].number) + ).toBe(true); + expect(actual.attributes[ConfigKey.SCHEDULE].unit).toEqual(ScheduleUnit.MINUTES); + }); + }); +}); diff --git a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.8.0.ts b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.8.0.ts new file mode 100644 index 0000000000000..bd15dae2d3c2c --- /dev/null +++ b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/8.8.0.ts @@ -0,0 +1,115 @@ +/* + * 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 { omit } from 'lodash'; +import { EncryptedSavedObjectsPluginSetup } from '@kbn/encrypted-saved-objects-plugin/server'; +import { SavedObjectUnsanitizedDoc } from '@kbn/core/server'; +import { + ConfigKey, + SyntheticsMonitorWithSecrets, + MonitorFields, + BrowserFields, + ScheduleUnit, +} from '../../../../../../common/runtime_types'; +import { ALLOWED_SCHEDULES_IN_MINUTES } from '../../../../../../common/constants/monitor_defaults'; +import { + LEGACY_SYNTHETICS_MONITOR_ENCRYPTED_TYPE, + SYNTHETICS_MONITOR_ENCRYPTED_TYPE, +} from '../../synthetics_monitor'; +import { validateMonitor } from '../../../../../routes/monitor_cruds/monitor_validation'; +import { + normalizeMonitorSecretAttributes, + formatSecrets, +} from '../../../../../synthetics_service/utils/secrets'; + +export const migration880 = (encryptedSavedObjects: EncryptedSavedObjectsPluginSetup) => { + return encryptedSavedObjects.createMigration< + SyntheticsMonitorWithSecrets, + SyntheticsMonitorWithSecrets + >({ + isMigrationNeededPredicate: function shouldBeMigrated( + doc + ): doc is SavedObjectUnsanitizedDoc { + return true; + }, + migration: ( + doc: SavedObjectUnsanitizedDoc, + logger + ): SavedObjectUnsanitizedDoc => { + let migrated = doc; + migrated = { + ...migrated, + attributes: { + ...migrated.attributes, + [ConfigKey.SCHEDULE]: { + number: getNearestSupportedSchedule(migrated.attributes[ConfigKey.SCHEDULE].number), + unit: ScheduleUnit.MINUTES, + }, + // when any action to change a project monitor configuration is taken + // outside of the synthetics agent cli, we should set the config hash back + // to an empty string so that the project monitors configuration + // will be updated on next push + [ConfigKey.CONFIG_HASH]: '', + }, + }; + if (migrated.attributes.type === 'browser') { + try { + const normalizedMonitorAttributes = normalizeMonitorSecretAttributes(migrated.attributes); + migrated = { + ...migrated, + attributes: omitZipUrlFields(normalizedMonitorAttributes as BrowserFields), + }; + } catch (e) { + logger.log.warn( + `Failed to remove ZIP URL fields from legacy Synthetics monitor: ${e.message}` + ); + return migrated; + } + } + return migrated; + }, + inputType: LEGACY_SYNTHETICS_MONITOR_ENCRYPTED_TYPE, + migratedType: SYNTHETICS_MONITOR_ENCRYPTED_TYPE, + }); +}; + +const getNearestSupportedSchedule = (currentSchedule: string): string => { + try { + const closest = ALLOWED_SCHEDULES_IN_MINUTES.reduce(function (prev, curr) { + const supportedSchedule = parseFloat(curr); + const currSchedule = parseFloat(currentSchedule); + const prevSupportedSchedule = parseFloat(prev); + return Math.abs(supportedSchedule - currSchedule) < + Math.abs(prevSupportedSchedule - currSchedule) + ? curr + : prev; + }); + + return closest; + } catch { + return ALLOWED_SCHEDULES_IN_MINUTES[0]; + } +}; + +const omitZipUrlFields = (fields: BrowserFields) => { + const metadata = fields[ConfigKey.METADATA]; + const updatedMetadata = omit(metadata || {}, 'is_zip_url_tls_enabled'); + // will return only fields that match the current type defs, which omit + // zip url fields + + const validationResult = validateMonitor({ + ...fields, + [ConfigKey.METADATA]: updatedMetadata, + } as MonitorFields); + + if (!validationResult.valid || !validationResult.decodedMonitor) { + throw new Error( + `Monitor is not valid: ${validationResult.reason}. ${validationResult.details}` + ); + } + + return formatSecrets(validationResult.decodedMonitor); +}; diff --git a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/index.ts b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/index.ts index bb26f51a603e6..b200e7b09b389 100644 --- a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/index.ts +++ b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/index.ts @@ -6,7 +6,9 @@ */ import { migration860 } from './8.6.0'; +import { migration880 } from './8.8.0'; export const monitorMigrations = { '8.6.0': migration860, + '8.8.0': migration880, }; diff --git a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/test_fixtures/8.7.0.ts b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/test_fixtures/8.7.0.ts new file mode 100644 index 0000000000000..75bc3d0452ba7 --- /dev/null +++ b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/migrations/monitors/test_fixtures/8.7.0.ts @@ -0,0 +1,659 @@ +/* + * 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 { SavedObjectUnsanitizedDoc } from '@kbn/core/server'; +import { SyntheticsMonitorWithSecrets } from '../../../../../../../common/runtime_types'; + +export const browserUI = { + type: 'synthetics-monitor', + id: '311cf324-2fc9-4453-9ba5-5e745fd81722', + attributes: { + type: 'browser', + form_monitor_type: 'multistep', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { unit: 'm', number: '10' }, + 'service.name': '', + config_id: '311cf324-2fc9-4453-9ba5-5e745fd81722', + tags: [], + timeout: null, + name: 'https://elastic.co', + locations: [ + { + id: 'us_central', + label: 'North America - US Central', + geo: { lat: 41.25, lon: -95.86 }, + isServiceManaged: true, + }, + ], + namespace: 'default', + origin: 'ui', + journey_id: '', + hash: '', + id: '311cf324-2fc9-4453-9ba5-5e745fd81722', + project_id: '', + playwright_options: '', + __ui: { + script_source: { is_generated_script: false, file_name: '' }, + is_zip_url_tls_enabled: false, + }, + 'url.port': null, + 'source.zip_url.url': '', + 'source.zip_url.folder': '', + 'source.zip_url.proxy_url': '', + playwright_text_assertion: '', + urls: 'https://elastic.co', + screenshots: 'on', + 'filter_journeys.match': '', + 'filter_journeys.tags': [], + ignore_https_errors: false, + 'throttling.is_enabled': true, + 'throttling.download_speed': '5', + 'throttling.upload_speed': '3', + 'throttling.latency': '20', + 'throttling.config': '5d/3u/20l', + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + revision: 1, + secrets: + '{"params":"","source.inline.script":"step(\'Go to https://elastic.co\', async () => {\\n await page.goto(\'https://elastic.co\');\\n});","source.project.content":"","source.zip_url.username":"","source.zip_url.password":"","synthetics_args":[],"ssl.key":"","ssl.key_passphrase":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:31:24.177Z', + created_at: '2023-03-31T20:31:24.177Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const browserSinglePageUI = { + type: 'synthetics-monitor', + id: '7a72e681-6033-444e-b402-bddbe4a9fc4e', + attributes: { + type: 'browser', + form_monitor_type: 'single', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { unit: 'm', number: '10' }, + 'service.name': '', + config_id: '7a72e681-6033-444e-b402-bddbe4a9fc4e', + tags: [], + timeout: null, + name: 'https://google.com', + locations: [{ label: 'North America - US Central', id: 'us_central', isServiceManaged: true }], + namespace: 'default', + origin: 'ui', + journey_id: '', + hash: '', + id: '7a72e681-6033-444e-b402-bddbe4a9fc4e', + project_id: '', + playwright_options: '', + __ui: { + script_source: { is_generated_script: false, file_name: '' }, + is_zip_url_tls_enabled: false, + }, + 'url.port': null, + 'source.zip_url.url': '', + 'source.zip_url.folder': '', + 'source.zip_url.proxy_url': '', + playwright_text_assertion: 'Google', + urls: 'https://google.com', + screenshots: 'on', + 'filter_journeys.match': '', + 'filter_journeys.tags': [], + ignore_https_errors: false, + 'throttling.is_enabled': true, + 'throttling.download_speed': '5', + 'throttling.upload_speed': '3', + 'throttling.latency': '20', + 'throttling.config': '5d/3u/20l', + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + revision: 1, + secrets: + '{"params":"","source.inline.script":"step(\'Go to https://google.com\', async () => {\\n await page.goto(\'https://google.com\');\\n expect(await page.isVisible(\'text=Google\')).toBeTruthy();\\n });","source.project.content":"","source.zip_url.username":"","source.zip_url.password":"","synthetics_args":[],"ssl.key":"","ssl.key_passphrase":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:32:01.498Z', + created_at: '2023-03-31T20:32:01.498Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const httpUI = { + type: 'synthetics-monitor', + id: '8f4ad634-205b-440b-80c6-27aa6ef57bba', + attributes: { + type: 'http', + form_monitor_type: 'http', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '3', unit: 'm' }, + 'service.name': '', + config_id: '8f4ad634-205b-440b-80c6-27aa6ef57bba', + tags: [], + timeout: '16', + name: 'https://github.com', + locations: [{ label: 'North America - US Central', id: 'us_central', isServiceManaged: true }], + namespace: 'default', + origin: 'ui', + journey_id: '', + hash: '', + id: '8f4ad634-205b-440b-80c6-27aa6ef57bba', + __ui: { is_tls_enabled: false }, + urls: 'https://github.com', + max_redirects: '0', + 'url.port': null, + proxy_url: '', + 'response.include_body': 'on_error', + 'response.include_headers': true, + 'check.response.status': [], + 'check.request.method': 'GET', + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + revision: 1, + secrets: + '{"password":"","check.request.body":{"type":"text","value":""},"check.request.headers":{},"check.response.body.negative":[],"check.response.body.positive":[],"check.response.headers":{},"ssl.key":"","ssl.key_passphrase":"","username":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:32:14.362Z', + created_at: '2023-03-31T20:32:14.362Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const tcpUI = { + type: 'synthetics-monitor', + id: 'b56a8fab-9a69-4435-b368-cc4fe6cdc6b0', + attributes: { + type: 'tcp', + form_monitor_type: 'tcp', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '3', unit: 'm' }, + 'service.name': '', + config_id: 'b56a8fab-9a69-4435-b368-cc4fe6cdc6b0', + tags: [], + timeout: '16', + name: 'smtp.gmail.com:587', + locations: [{ label: 'North America - US Central', id: 'us_central', isServiceManaged: true }], + namespace: 'default', + origin: 'ui', + journey_id: '', + hash: '', + id: 'b56a8fab-9a69-4435-b368-cc4fe6cdc6b0', + __ui: { is_tls_enabled: false }, + hosts: 'smtp.gmail.com:587', + urls: '', + 'url.port': null, + proxy_url: '', + proxy_use_local_resolver: false, + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + revision: 1, + secrets: '{"check.send":"","check.receive":"","ssl.key":"","ssl.key_passphrase":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:32:27.678Z', + created_at: '2023-03-31T20:32:27.678Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +const icmpUI = { + type: 'synthetics-monitor', + id: '1b625301-fe0b-46c0-9980-21347c58a6f8', + attributes: { + type: 'icmp', + form_monitor_type: 'icmp', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '3', unit: 'm' }, + 'service.name': '', + config_id: '1b625301-fe0b-46c0-9980-21347c58a6f8', + tags: [], + timeout: '16', + name: '1.1.1.1', + locations: [{ label: 'North America - US Central', id: 'us_central', isServiceManaged: true }], + namespace: 'default', + origin: 'ui', + journey_id: '', + hash: '', + id: '1b625301-fe0b-46c0-9980-21347c58a6f8', + hosts: '1.1.1.1', + wait: '1', + revision: 1, + secrets: '{}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:32:39.147Z', + created_at: '2023-03-31T20:32:39.147Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const browserUptimeUI = { + type: 'synthetics-monitor', + id: '9bf12063-271f-47b1-9121-db1d14a71bb3', + attributes: { + type: 'browser', + form_monitor_type: 'multistep', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '240', unit: 'm' }, + 'service.name': '', + config_id: '9bf12063-271f-47b1-9121-db1d14a71bb3', + tags: [], + timeout: null, + name: 'A browser monitor with an invalid schedule 600', + locations: [ + { + id: 'us_central', + label: 'North America - US Central', + geo: { lat: 41.25, lon: -95.86 }, + isServiceManaged: true, + }, + ], + namespace: 'default', + origin: 'ui', + journey_id: '', + hash: '', + id: '9bf12063-271f-47b1-9121-db1d14a71bb3', + project_id: '', + playwright_options: '', + __ui: { + script_source: { is_generated_script: false, file_name: '' }, + is_zip_url_tls_enabled: false, + is_tls_enabled: false, + }, + 'url.port': null, + 'source.zip_url.url': '', + 'source.zip_url.folder': '', + 'source.zip_url.proxy_url': '', + playwright_text_assertion: '', + urls: '', + screenshots: 'on', + 'filter_journeys.match': '', + 'filter_journeys.tags': [], + ignore_https_errors: false, + 'throttling.is_enabled': true, + 'throttling.download_speed': '5', + 'throttling.upload_speed': '3', + 'throttling.latency': '20', + 'throttling.config': '5d/3u/20l', + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + revision: 1, + secrets: + '{"params":"","source.inline.script":"lkjelre","source.project.content":"","source.zip_url.username":"","source.zip_url.password":"","synthetics_args":[],"ssl.key":"","ssl.key_passphrase":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:35:34.916Z', + created_at: '2023-03-31T20:35:34.916Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const tcpUptimeUI = { + type: 'synthetics-monitor', + id: '726d3f74-7760-4045-ad8d-87642403c721', + attributes: { + type: 'tcp', + form_monitor_type: 'tcp', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '8', unit: 'm' }, + 'service.name': '', + config_id: '726d3f74-7760-4045-ad8d-87642403c721', + tags: [], + timeout: '16', + name: 'TCP monitor with invalid schedule 8m', + locations: [ + { + id: 'us_central', + label: 'North America - US Central', + geo: { lat: 41.25, lon: -95.86 }, + isServiceManaged: true, + }, + ], + namespace: 'default', + origin: 'ui', + journey_id: '', + hash: '', + id: '726d3f74-7760-4045-ad8d-87642403c721', + __ui: { is_tls_enabled: false, is_zip_url_tls_enabled: false }, + hosts: 'localhost:5601', + urls: '', + 'url.port': null, + proxy_url: '', + proxy_use_local_resolver: false, + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + revision: 1, + secrets: '{"check.send":"","check.receive":"","ssl.key":"","ssl.key_passphrase":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:38:29.582Z', + created_at: '2023-03-31T20:38:29.582Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const httpUptimeUI = { + type: 'synthetics-monitor', + id: '35b2d765-4a62-4511-91c8-d5d52fdf4639', + attributes: { + type: 'http', + form_monitor_type: 'http', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '4', unit: 'm' }, + 'service.name': '', + config_id: '35b2d765-4a62-4511-91c8-d5d52fdf4639', + tags: [], + timeout: '16', + name: 'HTTP monitor with invalid schedule 4m', + locations: [ + { + id: 'us_central', + label: 'North America - US Central', + geo: { lat: 41.25, lon: -95.86 }, + isServiceManaged: true, + }, + ], + namespace: 'default', + origin: 'ui', + journey_id: '', + hash: '', + id: '35b2d765-4a62-4511-91c8-d5d52fdf4639', + __ui: { is_tls_enabled: false, is_zip_url_tls_enabled: false }, + urls: 'https://google.com', + max_redirects: '0', + 'url.port': null, + proxy_url: '', + 'response.include_body': 'on_error', + 'response.include_headers': true, + 'check.response.status': [], + 'check.request.method': 'GET', + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + revision: 1, + secrets: + '{"password":"","check.request.body":{"type":"text","value":""},"check.request.headers":{},"check.response.body.negative":[],"check.response.body.positive":[],"check.response.headers":{},"ssl.key":"","ssl.key_passphrase":"","username":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:37:24.093Z', + created_at: '2023-03-31T20:37:24.093Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const icmpUptimeUI = { + type: 'synthetics-monitor', + id: '28b14c99-4a39-475d-9545-21b35b35751d', + attributes: { + type: 'icmp', + form_monitor_type: 'icmp', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '11', unit: 'm' }, + 'service.name': '', + config_id: '28b14c99-4a39-475d-9545-21b35b35751d', + tags: [], + timeout: '16', + name: 'ICMP monitor with invalid schedule 11m', + locations: [ + { + geo: { lon: -95.86, lat: 41.25 }, + isServiceManaged: true, + id: 'us_central', + label: 'North America - US Central', + }, + ], + namespace: 'default', + origin: 'ui', + journey_id: '', + hash: '', + id: '28b14c99-4a39-475d-9545-21b35b35751d', + hosts: '1.1.1.1', + wait: '1', + revision: 2, + secrets: '{}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:40:28.889Z', + created_at: '2023-03-31T20:39:13.783Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const browserProject = { + type: 'synthetics-monitor', + id: 'ea123f46-eb02-4a8a-b3ce-53e645ce4aef', + attributes: { + type: 'browser', + form_monitor_type: 'multistep', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '10', unit: 'm' }, + 'service.name': '', + config_id: 'ea123f46-eb02-4a8a-b3ce-53e645ce4aef', + tags: [], + timeout: null, + name: 'addition and completion of single task', + locations: [ + { + id: 'us_central', + label: 'North America - US Central', + geo: { lat: 41.25, lon: -95.86 }, + isServiceManaged: true, + }, + ], + namespace: 'default', + origin: 'project', + journey_id: 'addition and completion of single task', + hash: '7a7cyPraVarTWfDHyqSgXBktTAcuwwWtcB+IGdNZF14=', + id: 'addition and completion of single task-test2-default', + project_id: 'test2', + playwright_options: '{"ignoreHTTPSErrors":true,"headless":true}', + __ui: { + script_source: { is_generated_script: false, file_name: '' }, + is_zip_url_tls_enabled: false, + }, + 'url.port': null, + 'source.zip_url.url': '', + 'source.zip_url.folder': '', + 'source.zip_url.proxy_url': '', + playwright_text_assertion: '', + urls: '', + screenshots: 'on', + 'filter_journeys.match': 'addition and completion of single task', + 'filter_journeys.tags': [], + ignore_https_errors: false, + 'throttling.is_enabled': true, + 'throttling.download_speed': '5', + 'throttling.upload_speed': '3', + 'throttling.latency': '20', + 'throttling.config': '5d/3u/20l', + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + original_space: 'default', + custom_heartbeat_id: 'addition and completion of single task-test2-default', + revision: 1, + secrets: + '{"params":"{\\"url\\":\\"https://elastic.github.io/synthetics-demo/\\"}","source.inline.script":"","source.project.content":"UEsDBBQACAAIAAAAIQAAAAAAAAAAAAAAAAAkAAAAam91cm5leXMvYWR2YW5jZWQtZXhhbXBsZS5qb3VybmV5LnRzpVVrb9pKEP2eX2H5XqlESsCQ0DatUt3wMDE1tDbYPKrqZrE3YDC2410epsp/v7PrB4aQKNL9wrI7M2fOnJldl0rC3F+FHo5ICdlr5FnYvsRbtAxcXEwsRUrO1igUnGXgh/RfEnl0hqljkYpwK4T4aeWEuCD+g11E4LS0t4vnX8/OSm9kuJxhN8AheTXDOxKwONdH9l0Q9CgOIKIQoCm+EFahey7cfhP+nAlCQbp4CV4k4H9eEF208qyZgIJAvBAQ2C2hkEUKAtoghwoMszj1qV9guF/B8gy/z3F+ZNt9RBaH+SmcvIvAA4Rzb+HvP2x5fjhFw/I9QgXHC1YUcuRIub6FqB8WRG4renhzSX3bFznJlH5so1GAC5zXS1sQYkIKYtOjOBSPC2SApIddbEEmSC+u3CI7u3QdIOU6fCPGvo+Ox9VgLOMqTugRYgozcaqMBxAhn+1Z+PZNoHhLb8VEHvFhT8yaYWsh+2FO/teTvtkEjiQ8Qnm8FR+SZB9AHoFVebIpSRlpyfmkRwramNDQj/4/zwToiOUbI+OiCXazkXmNaubtZK48cD9e2wDR2S27vwT2X764zq/yb/EgOOFWW1Hqe3scZw8y4abDKMt1oIcrUBJDzAFGkdsKB+MKcDN/jcPD0xxITvk3X5/8+3ZS8krqAY8E3FGHOlAV8mzgzeL51n8UiONNXcylhAek8EeIpQ1QiJYEmKQNiaulUF8fxpndoobvfYDxhxtNkMsuohBBQgFHmIisity7VsiDFtM3KPfwpA1N4Ln5+Hac8jkazJcuTMp3yeNNuTghXvprtlmuXOoEiTLkvdIwX9Dml8jfkDKExf8q2b8r8fe7xMnginCrm8iaFQo0/66/1C67tG/KwiBh9F9pQMzxWkyUK5X+EgjIZOEOfGBAFkNXb21E0RfYwswiNkWlOfG9rxNE8MfrC7zxp0q9XRkP2zs0uFkpc3/aiTbflfqdY1Vuytay61qR8lGRiYOWbF918bCzHg30ymhQnY8HGh0PZ7PJsEbGverT5MqMJkuzqnr6TnE2U2UZrO1hezUeuju1Ii/spbwaVcyFOjCvR4PyZtIyKGqZxGqZkRVVJStq2+od50RHw9oGDaoez19XPmmGXNN623aybrWFXLMl5dOPHa1pknytOdsrdjYxOsy32zUU0gPffm87h/1cbXZrmtEhfTgb9LY6nHnaHGKNrqTXN9csthclvrJb08wFw2l0JYWYMY4Ke1VtshhCdEmu6Sw32NSmWdOu2vUkB4/rNZjN/Kk2AcuQyAj8R9G2wWxqs8zwiQFnyOC1NeyFRn402xx7sOeo57lMFp2US2xjOIDdkzj3+Kxl13O1Pen1rcn0OPJlOrZ/wH/OWza5rR9jd2P/Gzj7nOouQ1070Jjz53HSlNnkpCfdw7zmMq3bBF8z2v4E289TdXcMje/7UZo31teAvEZvew9n92qjBtjNDeTnODx/ZSaz1ZA+p32mcf8V0t/jjVUZejJw63HMVlYbszrvY6vMVgqYAYsDPrHufa7bCnQbcs4s3uyk2ux1M5pEZ/MBcRrb81noKsymGxmnkGNLb3EKcpxctgbAqQ9rP997/ErvmXZGph3TnPvL9t4/mdtyvscxxr3J8pX39yCZlbSXToprg91Ke8JjeZ3RTSOdnWS+k7vGc3EeuJnxiHuZs42dOF9eT+NoxuB+t/X7WUPrbSSmpdHbbJjeHcDlukdsNmU5qy83S/F867Iqy/tZ5H0yn6C2Oe/FYRznyON2Zl1tdfm85jWLbXI9mZ8g04jlMJu8Vyr0G0lwlwd2PesT0y6eLV+LcjVC3TArMrxBSX3bHavLkt5ZH5vppL7k3YjfGNYX0+Dam/me9aBnh3Uld5P3OH7zkrtgZrPG3gLCbdZCIWNW2z7+oBY98dnfCbuptujhPCXcwLemc01sokWH/djr1Sln706kkLpzB9+V6mwyMHfsezWI2gF8f9aWpz9aV+7Kbs1cu+XO2bek7knfz/4DUEsHCBVHLjjcBQAAeA4AAFBLAQItAxQACAAIAAAAIQAVRy443AUAAHgOAAAkAAAAAAAAAAAAIACkgQAAAABqb3VybmV5cy9hZHZhbmNlZC1leGFtcGxlLmpvdXJuZXkudHNQSwUGAAAAAAEAAQBSAAAALgYAAAAA","source.zip_url.username":"","source.zip_url.password":"","synthetics_args":[],"ssl.key":"","ssl.key_passphrase":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:43:35.214Z', + created_at: '2023-03-31T20:43:35.214Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const httpProject = { + type: 'synthetics-monitor', + id: '316c0df8-56fc-428a-a477-7bf580f6cb4c', + attributes: { + type: 'http', + form_monitor_type: 'http', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '10', unit: 'm' }, + 'service.name': '', + config_id: '316c0df8-56fc-428a-a477-7bf580f6cb4c', + tags: ['org:elastics'], + timeout: '16', + name: 'facebook', + locations: [ + { + id: 'us_central', + label: 'North America - US Central', + geo: { lat: 41.25, lon: -95.86 }, + isServiceManaged: true, + }, + ], + namespace: 'default', + origin: 'project', + journey_id: 'an-id3', + hash: 'thcZtI5hzo94RiDoK1B+MEwIPIzJMINtuA042Y+yrDU=', + id: 'an-id3-test2-default', + __ui: { is_tls_enabled: false }, + urls: 'https://www.facebook.com', + max_redirects: '0', + 'url.port': null, + proxy_url: '', + 'response.include_body': 'on_error', + 'response.include_headers': true, + 'check.response.status': [], + 'check.request.method': 'GET', + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + project_id: 'test2', + original_space: 'default', + custom_heartbeat_id: 'an-id3-test2-default', + revision: 1, + secrets: + '{"password":"","check.request.body":{"type":"text","value":""},"check.request.headers":{"Content-Type":"text/plain"},"check.response.body.negative":[],"check.response.body.positive":[],"check.response.headers":{},"ssl.key":"","ssl.key_passphrase":"","username":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:43:35.214Z', + created_at: '2023-03-31T20:43:35.214Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const icmpProject = { + type: 'synthetics-monitor', + id: 'e21a30b5-6d40-4458-8cff-9003d7b83eb6', + attributes: { + type: 'icmp', + form_monitor_type: 'icmp', + enabled: true, + alert: { status: { enabled: true } }, + schedule: { number: '10', unit: 'm' }, + 'service.name': '', + config_id: 'e21a30b5-6d40-4458-8cff-9003d7b83eb6', + tags: ['service:dns', 'org:cloudflare'], + timeout: '16', + name: 'Cloudflare DNS', + locations: [ + { + id: 'us_central', + label: 'North America - US Central', + geo: { lat: 41.25, lon: -95.86 }, + isServiceManaged: true, + }, + ], + namespace: 'default', + origin: 'project', + journey_id: 'stuff', + hash: 'fZfJJOKGdjznBxHZLgLrWbkvUI/AH4SzFqweV/NnpIw=', + id: 'stuff-test2-default', + hosts: '${random_host}', + wait: '1', + project_id: 'test2', + original_space: 'default', + custom_heartbeat_id: 'stuff-test2-default', + revision: 1, + secrets: '{}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:43:35.214Z', + created_at: '2023-03-31T20:43:35.214Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; +export const tcpProject = { + type: 'synthetics-monitor', + id: '9f5d6206-9a1d-47fb-bd67-c7895b07f716', + attributes: { + type: 'tcp', + form_monitor_type: 'tcp', + enabled: true, + alert: { status: { enabled: false } }, + schedule: { number: '30', unit: 'm' }, + 'service.name': '', + config_id: '9f5d6206-9a1d-47fb-bd67-c7895b07f716', + tags: ['service:smtp', 'org:google'], + timeout: '16', + name: 'GMail SMTP', + locations: [ + { + geo: { lon: -95.86, lat: 41.25 }, + isServiceManaged: true, + id: 'us_central', + label: 'North America - US Central', + }, + ], + namespace: 'default', + origin: 'project', + journey_id: 'gmail-smtp', + hash: 'BoPnjeryNLnktKz+PeeHwHKzEnZaxHNJmAUjlOVKfRY=', + id: 'gmail-smtp-test2-default', + __ui: { is_tls_enabled: false }, + hosts: '${random_host}', + urls: '', + 'url.port': null, + proxy_url: '', + proxy_use_local_resolver: false, + 'ssl.certificate_authorities': '', + 'ssl.certificate': '', + 'ssl.verification_mode': 'full', + 'ssl.supported_protocols': ['TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + project_id: 'test2', + original_space: 'default', + custom_heartbeat_id: 'gmail-smtp-test2-default', + revision: 3, + secrets: '{"check.send":"","check.receive":"","ssl.key":"","ssl.key_passphrase":""}', + }, + references: [], + coreMigrationVersion: '8.8.0', + updated_at: '2023-03-31T20:47:15.781Z', + created_at: '2023-03-31T20:43:35.214Z', + typeMigrationVersion: '8.6.0', +} as SavedObjectUnsanitizedDoc; + +export const testMonitors = [ + browserUI, + browserSinglePageUI, + httpUI, + tcpUI, + icmpUI, + browserUptimeUI, + httpUptimeUI, + tcpUptimeUI, + icmpUptimeUI, + browserProject, + httpProject, + tcpProject, + icmpProject, +]; diff --git a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/synthetics_monitor.ts b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/synthetics_monitor.ts index 0a766e4a5833d..3d5ddecf188a5 100644 --- a/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/synthetics_monitor.ts +++ b/x-pack/plugins/synthetics/server/legacy_uptime/lib/saved_objects/synthetics_monitor.ts @@ -7,11 +7,31 @@ import { EncryptedSavedObjectsPluginSetup } from '@kbn/encrypted-saved-objects-plugin/server'; import { SavedObjectsType } from '@kbn/core/server'; import { i18n } from '@kbn/i18n'; -import { secretKeys } from '../../../../common/constants/monitor_management'; +import { + secretKeys, + ConfigKey, + LegacyConfigKey, +} from '../../../../common/constants/monitor_management'; import { monitorMigrations } from './migrations/monitors'; export const syntheticsMonitorType = 'synthetics-monitor'; +const legacyConfigKeys = Object.values(LegacyConfigKey); + +export const LEGACY_SYNTHETICS_MONITOR_ENCRYPTED_TYPE = { + type: syntheticsMonitorType, + attributesToEncrypt: new Set([ + 'secrets', + /* adding secretKeys to the list of attributes to encrypt ensures + * that secrets are never stored on the resulting saved object, + * even in the presence of developer error. + * + * In practice, all secrets should be stored as a single JSON + * payload on the `secrets` key. This ensures performant decryption. */ + ...secretKeys, + ]), +}; + export const SYNTHETICS_MONITOR_ENCRYPTED_TYPE = { type: syntheticsMonitorType, attributesToEncrypt: new Set([ @@ -24,6 +44,11 @@ export const SYNTHETICS_MONITOR_ENCRYPTED_TYPE = { * payload on the `secrets` key. This ensures performant decryption. */ ...secretKeys, ]), + attributesToExcludeFromAAD: new Set([ + ConfigKey.ALERT_CONFIG, + ConfigKey.METADATA, + ...legacyConfigKeys, + ]), }; export const getSyntheticsMonitorSavedObjectType = ( @@ -35,6 +60,7 @@ export const getSyntheticsMonitorSavedObjectType = ( namespaceType: 'single', migrations: { '8.6.0': monitorMigrations['8.6.0'](encryptedSavedObjects), + '8.8.0': monitorMigrations['8.8.0'](encryptedSavedObjects), }, mappings: { dynamic: false, diff --git a/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.test.ts b/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.test.ts index b927e1a37e21a..98188e88dc7ff 100644 --- a/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.test.ts +++ b/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.test.ts @@ -29,7 +29,6 @@ import { TLSFields, TLSVersion, VerificationMode, - ZipUrlTLSFields, } from '../../../common/runtime_types'; import { validateMonitor } from './monitor_validation'; @@ -46,7 +45,6 @@ describe('validateMonitor', () => { let testHTTPSimpleFields: HTTPSimpleFields; let testHTTPAdvancedFields: HTTPAdvancedFields; let testHTTPFields: HTTPFields; - let testZipUrlTLSFields: ZipUrlTLSFields; let testBrowserSimpleFields: BrowserSimpleFields; let testBrowserAdvancedFields: BrowserAdvancedFields; let testBrowserFields: BrowserFields; @@ -81,7 +79,6 @@ describe('validateMonitor', () => { }; testMetaData = { is_tls_enabled: false, - is_zip_url_tls_enabled: false, script_source: { is_generated_script: false, file_name: 'test-file.name', @@ -158,17 +155,7 @@ describe('validateMonitor', () => { [ConfigKey.MONITOR_TYPE]: DataStream.HTTP, }; - testZipUrlTLSFields = { - [ConfigKey.ZIP_URL_TLS_CERTIFICATE_AUTHORITIES]: 'test', - [ConfigKey.ZIP_URL_TLS_CERTIFICATE]: 'test', - [ConfigKey.ZIP_URL_TLS_KEY]: 'key', - [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: 'passphrase', - [ConfigKey.ZIP_URL_TLS_VERIFICATION_MODE]: VerificationMode.STRICT, - [ConfigKey.ZIP_URL_TLS_VERSION]: [TLSVersion.ONE_ONE, TLSVersion.ONE_TWO], - }; - testBrowserSimpleFields = { - ...testZipUrlTLSFields, ...testCommonFields, [ConfigKey.FORM_MONITOR_TYPE]: FormMonitorType.MULTISTEP, [ConfigKey.MONITOR_SOURCE_TYPE]: SourceType.PROJECT, @@ -177,11 +164,6 @@ describe('validateMonitor', () => { [ConfigKey.METADATA]: testMetaData, [ConfigKey.SOURCE_INLINE]: '', [ConfigKey.SOURCE_PROJECT_CONTENT]: '', - [ConfigKey.SOURCE_ZIP_URL]: '', - [ConfigKey.SOURCE_ZIP_FOLDER]: '', - [ConfigKey.SOURCE_ZIP_USERNAME]: 'test-username', - [ConfigKey.SOURCE_ZIP_PASSWORD]: 'password', - [ConfigKey.SOURCE_ZIP_PROXY_URL]: 'http://proxy-url.com', [ConfigKey.PARAMS]: '', [ConfigKey.URLS]: null, [ConfigKey.PORT]: null, @@ -209,7 +191,13 @@ describe('validateMonitor', () => { describe('should invalidate', () => { it(`when 'type' is null or undefined`, () => { - const testMonitor = { type: undefined } as unknown as MonitorFields; + const testMonitor = { + type: undefined, + schedule: { + unit: ScheduleUnit.MINUTES, + number: '3', + }, + } as unknown as MonitorFields; const result = validateMonitor(testMonitor); expect(result).toMatchObject({ valid: false, @@ -219,7 +207,13 @@ describe('validateMonitor', () => { }); it(`when 'type' is not an acceptable monitor type (DataStream)`, () => { - const monitor = { type: 'non-HTTP' } as unknown as MonitorFields; + const monitor = { + type: 'non-HTTP', + schedule: { + unit: ScheduleUnit.MINUTES, + number: '3', + }, + } as unknown as MonitorFields; const result = validateMonitor(monitor); expect(result).toMatchObject({ valid: false, @@ -227,6 +221,22 @@ describe('validateMonitor', () => { details: expect.stringMatching(/(?=.*invalid)(?=.*non-HTTP)(?=.*DataStream)/i), }); }); + + it(`when schedule is not valid`, () => { + const result = validateMonitor({ + ...testICMPFields, + schedule: { + number: '4', + unit: ScheduleUnit.MINUTES, + }, + } as unknown as MonitorFields); + expect(result).toMatchObject({ + valid: false, + reason: 'Monitor schedule is invalid', + details: + 'Invalid schedule 4 minutes supplied to monitor configuration. Please use a supported monitor schedule.', + }); + }); }); describe('should validate', () => { @@ -408,7 +418,6 @@ function getJsonPayload() { ' "timeout": "3m",' + ' "__ui": {' + ' "is_tls_enabled": false,' + - ' "is_zip_url_tls_enabled": false,' + ' "script_source": {' + ' "is_generated_script": false,' + ' "file_name": "test-file.name"' + diff --git a/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.ts b/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.ts index 77cd0fa23a7ce..4f091c5e7c417 100644 --- a/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.ts +++ b/x-pack/plugins/synthetics/server/routes/monitor_cruds/monitor_validation.ts @@ -23,6 +23,8 @@ import { SyntheticsMonitor, } from '../../../common/runtime_types'; +import { ALLOWED_SCHEDULES_IN_MINUTES } from '../../../common/constants/monitor_defaults'; + type MonitorCodecType = | typeof ICMPSimpleFieldsCodec | typeof TCPFieldsCodec @@ -52,6 +54,7 @@ export function validateMonitor(monitorFields: MonitorFields): ValidationResult const { [ConfigKey.MONITOR_TYPE]: monitorType } = monitorFields; const decodedType = DataStreamCodec.decode(monitorType); + if (isLeft(decodedType)) { return { valid: false, @@ -73,6 +76,17 @@ export function validateMonitor(monitorFields: MonitorFields): ValidationResult }; } + if (!ALLOWED_SCHEDULES_IN_MINUTES.includes(monitorFields[ConfigKey.SCHEDULE].number)) { + return { + valid: false, + reason: `Monitor schedule is invalid`, + details: `Invalid schedule ${ + monitorFields[ConfigKey.SCHEDULE].number + } minutes supplied to monitor configuration. Please use a supported monitor schedule.`, + payload: monitorFields, + }; + } + const ExactSyntheticsMonitorCodec = t.exact(SyntheticsMonitorCodec); const decodedMonitor = ExactSyntheticsMonitorCodec.decode(monitorFields); diff --git a/x-pack/plugins/synthetics/server/routes/telemetry/monitor_upgrade_sender.test.ts b/x-pack/plugins/synthetics/server/routes/telemetry/monitor_upgrade_sender.test.ts index 65ee31dbb08aa..6dc14565b6289 100644 --- a/x-pack/plugins/synthetics/server/routes/telemetry/monitor_upgrade_sender.test.ts +++ b/x-pack/plugins/synthetics/server/routes/telemetry/monitor_upgrade_sender.test.ts @@ -117,7 +117,6 @@ describe('monitor upgrade telemetry helpers', () => { [ConfigKey.MONITOR_SOURCE_TYPE, SourceType.PROJECT, 'project', false, false], [ConfigKey.SOURCE_INLINE, 'test', 'recorder', true, true], [ConfigKey.SOURCE_INLINE, 'test', 'inline', false, true], - [ConfigKey.SOURCE_ZIP_URL, 'test', 'zip', false, false], ])( 'handles formatting scriptType for browser monitors', (config, value, scriptType, isRecorder, isInlineScript) => { diff --git a/x-pack/plugins/synthetics/server/routes/telemetry/monitor_upgrade_sender.ts b/x-pack/plugins/synthetics/server/routes/telemetry/monitor_upgrade_sender.ts index d86792a7967c3..fcfce9d2c85a1 100644 --- a/x-pack/plugins/synthetics/server/routes/telemetry/monitor_upgrade_sender.ts +++ b/x-pack/plugins/synthetics/server/routes/telemetry/monitor_upgrade_sender.ts @@ -165,8 +165,6 @@ function getScriptType( isInlineScript: boolean ): MonitorUpdateEvent['scriptType'] | undefined { switch (true) { - case Boolean(attributes[ConfigKey.SOURCE_ZIP_URL]): - return 'zip'; case Boolean( isInlineScript && attributes[ConfigKey.METADATA]?.script_source?.is_generated_script ): diff --git a/x-pack/plugins/synthetics/server/synthetics_service/formatters/browser.ts b/x-pack/plugins/synthetics/server/synthetics_service/formatters/browser.ts index 1a5e090033ece..391556bb99649 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/formatters/browser.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/formatters/browser.ts @@ -36,13 +36,7 @@ const throttlingFormatter: Formatter = (fields) => { export const browserFormatters: BrowserFormatMap = { ...basicBrowserFormatters, [ConfigKey.METADATA]: objectFormatter, - [ConfigKey.ZIP_URL_TLS_VERSION]: arrayFormatter, [ConfigKey.SOURCE_INLINE]: null, - [ConfigKey.ZIP_URL_TLS_CERTIFICATE_AUTHORITIES]: null, - [ConfigKey.ZIP_URL_TLS_CERTIFICATE]: null, - [ConfigKey.ZIP_URL_TLS_KEY]: null, - [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: null, - [ConfigKey.ZIP_URL_TLS_VERIFICATION_MODE]: null, [ConfigKey.THROTTLING_CONFIG]: throttlingFormatter, [ConfigKey.JOURNEY_FILTERS_MATCH]: null, [ConfigKey.SYNTHETICS_ARGS]: arrayFormatter, diff --git a/x-pack/plugins/synthetics/server/synthetics_service/formatters/format_configs.test.ts b/x-pack/plugins/synthetics/server/synthetics_service/formatters/format_configs.test.ts index 139c9faa91854..eb2b40e324249 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/formatters/format_configs.test.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/formatters/format_configs.test.ts @@ -32,7 +32,7 @@ const testHTTPConfig: Partial = { timeout: '16', name: 'Test', locations: [], - __ui: { is_tls_enabled: false, is_zip_url_tls_enabled: false }, + __ui: { is_tls_enabled: false }, urls: 'https://www.google.com', max_redirects: '0', password: '3z9SBOQWW5F0UrdqLVFqlF6z', @@ -62,14 +62,8 @@ const testBrowserConfig: Partial = { locations: [], __ui: { script_source: { is_generated_script: false, file_name: '' }, - is_zip_url_tls_enabled: false, is_tls_enabled: false, }, - 'source.zip_url.url': '', - 'source.zip_url.username': '', - 'source.zip_url.password': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', 'source.inline.script': "step('Go to https://www.google.com/', async () => {\n await page.goto('https://www.google.com/');\n});", params: '{"a":"param"}', diff --git a/x-pack/plugins/synthetics/server/synthetics_service/private_location/synthetics_private_location.test.ts b/x-pack/plugins/synthetics/server/synthetics_service/private_location/synthetics_private_location.test.ts index 4d319c714a44b..5f1c74d5dfb05 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/private_location/synthetics_private_location.test.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/private_location/synthetics_private_location.test.ts @@ -198,7 +198,7 @@ describe('SyntheticsPrivateLocation', () => { __ui: { type: 'yaml', value: - '{"script_source":{"is_generated_script":false,"file_name":""},"is_zip_url_tls_enabled":false,"is_tls_enabled":true}', + '{"script_source":{"is_generated_script":false,"file_name":""},"is_tls_enabled":true}', }, config_id: { type: 'text', @@ -253,44 +253,6 @@ describe('SyntheticsPrivateLocation', () => { value: "\"step('Go to https://www.elastic.co/', async () => {\\n await page.goto('https://www.elastic.co/');\\n});\"", }, - 'source.zip_url.folder': { - type: 'text', - value: '', - }, - 'source.zip_url.password': { - type: 'password', - value: '', - }, - 'source.zip_url.proxy_url': { - type: 'text', - value: '', - }, - 'source.zip_url.ssl.certificate': { - type: 'yaml', - }, - 'source.zip_url.ssl.certificate_authorities': { - type: 'yaml', - }, - 'source.zip_url.ssl.key': { - type: 'yaml', - }, - 'source.zip_url.ssl.key_passphrase': { - type: 'text', - }, - 'source.zip_url.ssl.supported_protocols': { - type: 'yaml', - }, - 'source.zip_url.ssl.verification_mode': { - type: 'text', - }, - 'source.zip_url.url': { - type: 'text', - value: '', - }, - 'source.zip_url.username': { - type: 'text', - value: '', - }, synthetics_args: { type: 'text', value: null, @@ -336,7 +298,6 @@ const dummyBrowserConfig: Partial & { playwright_options: '', __ui: { script_source: { is_generated_script: false, file_name: '' }, - is_zip_url_tls_enabled: false, is_tls_enabled: true, }, params: '', @@ -344,11 +305,6 @@ const dummyBrowserConfig: Partial & { 'source.inline.script': "step('Go to https://www.elastic.co/', async () => {\n await page.goto('https://www.elastic.co/');\n});", 'source.project.content': '', - 'source.zip_url.url': '', - 'source.zip_url.username': '', - 'source.zip_url.password': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', urls: 'https://www.elastic.co/', screenshots: 'on', synthetics_args: [], diff --git a/x-pack/plugins/synthetics/server/synthetics_service/private_location/test_policy.ts b/x-pack/plugins/synthetics/server/synthetics_service/private_location/test_policy.ts index 597045ea45973..266d440e4df86 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/private_location/test_policy.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/private_location/test_policy.ts @@ -135,10 +135,6 @@ export const testMonitorPolicy = { 'service.name': { type: 'text' }, timeout: { type: 'text' }, tags: { type: 'yaml' }, - 'source.zip_url.url': { type: 'text' }, - 'source.zip_url.username': { type: 'text' }, - 'source.zip_url.folder': { type: 'text' }, - 'source.zip_url.password': { type: 'password' }, 'source.inline.script': { type: 'yaml' }, params: { type: 'yaml' }, screenshots: { type: 'text' }, @@ -147,13 +143,6 @@ export const testMonitorPolicy = { 'throttling.config': { type: 'text' }, 'filter_journeys.tags': { type: 'yaml' }, 'filter_journeys.match': { type: 'text' }, - 'source.zip_url.ssl.certificate_authorities': { type: 'yaml' }, - 'source.zip_url.ssl.certificate': { type: 'yaml' }, - 'source.zip_url.ssl.key': { type: 'yaml' }, - 'source.zip_url.ssl.key_passphrase': { type: 'text' }, - 'source.zip_url.ssl.verification_mode': { type: 'text' }, - 'source.zip_url.ssl.supported_protocols': { type: 'yaml' }, - 'source.zip_url.proxy_url': { type: 'text' }, location_name: { value: 'Fleet managed', type: 'text' }, config_id: { type: 'text' }, run_once: { value: false, type: 'bool' }, diff --git a/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/project_monitor_formatter.test.ts b/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/project_monitor_formatter.test.ts index f085c73be2ba1..800b8cfa0ac5e 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/project_monitor_formatter.test.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/project_monitor_formatter.test.ts @@ -445,7 +445,6 @@ const payloadData = [ { ...DEFAULT_FIELDS[DataStream.BROWSER], __ui: { - is_zip_url_tls_enabled: false, script_source: { file_name: '', is_generated_script: false, @@ -478,12 +477,6 @@ const payloadData = [ 'source.inline.script': '', 'source.project.content': 'UEsDBBQACAAIAAAAIQAAAAAAAAAAAAAAAAAQAAAAYmFzaWMuam91cm5leS50c2WQQU7DQAxF9znFV8QiUUOmXcCCUMQl2NdMnWbKJDMaO6Ilyt0JASQkNv9Z1teTZWNAIqwP5kU4iZGOug863u7uDXsSddbIddCOl0kMX6iPnsVoOAYxryTO1ucwpoGvtUrm+hiSYsLProIoxwp8iWwVM9oUeuTP/9V5k7UhofCscNhj2yx4xN2CzabElOHXWRxsx/YNroU69QwniImFB8Vui5vJzYcKxYRIJ66WTNQL5hL7p1WD9aYi9zQOtgPFGPNqecJ1sCj+tAB6J6erpj4FDcW3qh6TL5u1Mq/8yjn7BFBLBwhGDIWc4QAAAEkBAABQSwECLQMUAAgACAAAACEARgyFnOEAAABJAQAAEAAAAAAAAAAAACAApIEAAAAAYmFzaWMuam91cm5leS50c1BLBQYAAAAAAQABAD4AAAAfAQAAAAA=', - 'source.zip_url.folder': '', - 'source.zip_url.password': '', - 'source.zip_url.proxy_url': '', - 'source.zip_url.url': '', - 'source.zip_url.ssl.certificate': undefined, - 'source.zip_url.username': '', 'ssl.certificate': '', 'ssl.certificate_authorities': '', 'ssl.key': '', @@ -507,7 +500,6 @@ const payloadData = [ { ...DEFAULT_FIELDS[DataStream.BROWSER], __ui: { - is_zip_url_tls_enabled: false, script_source: { file_name: '', is_generated_script: false, @@ -540,11 +532,6 @@ const payloadData = [ 'source.inline.script': '', 'source.project.content': 'UEsDBBQACAAIAAAAIQAAAAAAAAAAAAAAAAAQAAAAYmFzaWMuam91cm5leS50c2WQQU7DQAxF9znFV8QiUUOmXcCCUMQl2NdMnWbKJDMaO6Ilyt0JASQkNv9Z1teTZWNAIqwP5kU4iZGOug863u7uDXsSddbIddCOl0kMX6iPnsVoOAYxryTO1ucwpoGvtUrm+hiSYsLProIoxwp8iWwVM9oUeuTP/9V5k7UhofCscNhj2yx4xN2CzabElOHXWRxsx/YNroU69QwniImFB8Vui5vJzYcKxYRIJ66WTNQL5hL7p1WD9aYi9zQOtgPFGPNqecJ1sCj+tAB6J6erpj4FDcW3qh6TL5u1Mq/8yjn7BFBLBwhGDIWc4QAAAEkBAABQSwECLQMUAAgACAAAACEARgyFnOEAAABJAQAAEAAAAAAAAAAAACAApIEAAAAAYmFzaWMuam91cm5leS50c1BLBQYAAAAAAQABAD4AAAAfAQAAAAA=', - 'source.zip_url.folder': '', - 'source.zip_url.password': '', - 'source.zip_url.proxy_url': '', - 'source.zip_url.url': '', - 'source.zip_url.username': '', 'ssl.certificate': '', 'ssl.certificate_authorities': '', 'ssl.key': '', diff --git a/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/project_monitor_formatter_legacy.test.ts b/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/project_monitor_formatter_legacy.test.ts index 6d449132b25d5..c284e18dac56d 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/project_monitor_formatter_legacy.test.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/project_monitor/project_monitor_formatter_legacy.test.ts @@ -514,7 +514,6 @@ const payloadData = [ { ...DEFAULT_FIELDS[DataStream.BROWSER], __ui: { - is_zip_url_tls_enabled: false, script_source: { file_name: '', is_generated_script: false, @@ -547,12 +546,6 @@ const payloadData = [ 'source.inline.script': '', 'source.project.content': 'UEsDBBQACAAIAAAAIQAAAAAAAAAAAAAAAAAQAAAAYmFzaWMuam91cm5leS50c2WQQU7DQAxF9znFV8QiUUOmXcCCUMQl2NdMnWbKJDMaO6Ilyt0JASQkNv9Z1teTZWNAIqwP5kU4iZGOug863u7uDXsSddbIddCOl0kMX6iPnsVoOAYxryTO1ucwpoGvtUrm+hiSYsLProIoxwp8iWwVM9oUeuTP/9V5k7UhofCscNhj2yx4xN2CzabElOHXWRxsx/YNroU69QwniImFB8Vui5vJzYcKxYRIJ66WTNQL5hL7p1WD9aYi9zQOtgPFGPNqecJ1sCj+tAB6J6erpj4FDcW3qh6TL5u1Mq/8yjn7BFBLBwhGDIWc4QAAAEkBAABQSwECLQMUAAgACAAAACEARgyFnOEAAABJAQAAEAAAAAAAAAAAACAApIEAAAAAYmFzaWMuam91cm5leS50c1BLBQYAAAAAAQABAD4AAAAfAQAAAAA=', - 'source.zip_url.folder': '', - 'source.zip_url.password': '', - 'source.zip_url.proxy_url': '', - 'source.zip_url.url': '', - 'source.zip_url.ssl.certificate': undefined, - 'source.zip_url.username': '', 'ssl.certificate': '', 'ssl.certificate_authorities': '', 'ssl.key': '', @@ -576,7 +569,6 @@ const payloadData = [ { ...DEFAULT_FIELDS[DataStream.BROWSER], __ui: { - is_zip_url_tls_enabled: false, script_source: { file_name: '', is_generated_script: false, @@ -609,11 +601,6 @@ const payloadData = [ 'source.inline.script': '', 'source.project.content': 'UEsDBBQACAAIAAAAIQAAAAAAAAAAAAAAAAAQAAAAYmFzaWMuam91cm5leS50c2WQQU7DQAxF9znFV8QiUUOmXcCCUMQl2NdMnWbKJDMaO6Ilyt0JASQkNv9Z1teTZWNAIqwP5kU4iZGOug863u7uDXsSddbIddCOl0kMX6iPnsVoOAYxryTO1ucwpoGvtUrm+hiSYsLProIoxwp8iWwVM9oUeuTP/9V5k7UhofCscNhj2yx4xN2CzabElOHXWRxsx/YNroU69QwniImFB8Vui5vJzYcKxYRIJ66WTNQL5hL7p1WD9aYi9zQOtgPFGPNqecJ1sCj+tAB6J6erpj4FDcW3qh6TL5u1Mq/8yjn7BFBLBwhGDIWc4QAAAEkBAABQSwECLQMUAAgACAAAACEARgyFnOEAAABJAQAAEAAAAAAAAAAAACAApIEAAAAAYmFzaWMuam91cm5leS50c1BLBQYAAAAAAQABAD4AAAAfAQAAAAA=', - 'source.zip_url.folder': '', - 'source.zip_url.password': '', - 'source.zip_url.proxy_url': '', - 'source.zip_url.url': '', - 'source.zip_url.username': '', 'ssl.certificate': '', 'ssl.certificate_authorities': '', 'ssl.key': '', diff --git a/x-pack/plugins/synthetics/server/synthetics_service/utils/secrets.ts b/x-pack/plugins/synthetics/server/synthetics_service/utils/secrets.ts index ed59f2043c9d7..d9a338e1767d9 100644 --- a/x-pack/plugins/synthetics/server/synthetics_service/utils/secrets.ts +++ b/x-pack/plugins/synthetics/server/synthetics_service/utils/secrets.ts @@ -27,15 +27,23 @@ export function formatSecrets(monitor: SyntheticsMonitor): SyntheticsMonitorWith export function normalizeSecrets( monitor: SavedObject ): SavedObject { - const defaultFields = DEFAULT_FIELDS[monitor.attributes[ConfigKey.MONITOR_TYPE]]; + const attributes = normalizeMonitorSecretAttributes(monitor.attributes); const normalizedMonitor = { ...monitor, - attributes: { - ...defaultFields, - ...monitor.attributes, - ...JSON.parse(monitor.attributes.secrets || ''), - }, + attributes, }; - delete normalizedMonitor.attributes.secrets; return normalizedMonitor; } + +export function normalizeMonitorSecretAttributes( + monitor: SyntheticsMonitorWithSecrets +): SyntheticsMonitor { + const defaultFields = DEFAULT_FIELDS[monitor[ConfigKey.MONITOR_TYPE]]; + const normalizedMonitorAttributes = { + ...defaultFields, + ...monitor, + ...JSON.parse(monitor.secrets || ''), + }; + delete normalizedMonitorAttributes.secrets; + return normalizedMonitorAttributes; +} diff --git a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json index a4c73bac176e8..517c52ed4fb71 100644 --- a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json +++ b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json @@ -2762,6 +2762,9 @@ "opentelemetry/ruby": { "type": "long" }, + "opentelemetry/rust": { + "type": "long" + }, "opentelemetry/swift": { "type": "long" }, diff --git a/x-pack/plugins/transform/common/privilege/has_privilege_factory.test.ts b/x-pack/plugins/transform/common/privilege/has_privilege_factory.test.ts new file mode 100644 index 0000000000000..c00e79220e5b0 --- /dev/null +++ b/x-pack/plugins/transform/common/privilege/has_privilege_factory.test.ts @@ -0,0 +1,159 @@ +/* + * 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 { extractMissingPrivileges, getPrivilegesAndCapabilities } from './has_privilege_factory'; + +describe('has_privilege_factory', () => { + const fullClusterPrivileges = { + 'cluster:admin/transform/preview': true, + 'cluster:admin/transform/put': true, + 'cluster:monitor/transform/get': true, + 'cluster:admin/transform/start': true, + 'cluster:admin/transform/delete': true, + 'cluster:admin/transform/reset': true, + 'cluster:admin/transform/stop': true, + 'cluster:admin/transform/start_task': true, + 'cluster:monitor/transform/stats/get': true, + }; + + const monitorOnlyClusterPrivileges = { + 'cluster:admin/transform/preview': false, + 'cluster:admin/transform/put': false, + 'cluster:admin/transform/start': false, + 'cluster:admin/transform/delete': false, + 'cluster:admin/transform/reset': false, + 'cluster:admin/transform/stop': false, + 'cluster:admin/transform/start_task': false, + 'cluster:monitor/transform/get': true, + 'cluster:monitor/transform/stats/get': true, + }; + const noClusterPrivileges = { + 'cluster:admin/transform/preview': false, + 'cluster:admin/transform/put': false, + 'cluster:admin/transform/start': false, + 'cluster:admin/transform/delete': false, + 'cluster:admin/transform/reset': false, + 'cluster:admin/transform/stop': false, + 'cluster:admin/transform/start_task': false, + 'cluster:monitor/transform/get': false, + 'cluster:monitor/transform/stats/get': false, + }; + + const monitorOnlyMissingPrivileges = Object.entries(monitorOnlyClusterPrivileges) + .filter(([, authorized]) => !authorized) + .map(([priv]) => priv); + + describe('extractMissingPrivileges', () => { + it('returns no missing privilege if provided both monitor and admin cluster privileges', () => { + expect(extractMissingPrivileges(fullClusterPrivileges)).toEqual([]); + }); + it('returns missing privilege if provided only monitor cluster privileges', () => { + expect(extractMissingPrivileges(monitorOnlyClusterPrivileges)).toEqual( + monitorOnlyMissingPrivileges + ); + }); + it('returns all missing privilege if provided no cluster privilege', () => { + const allPrivileges = Object.keys(noClusterPrivileges); + const extracted = extractMissingPrivileges(noClusterPrivileges); + expect(extracted).toEqual(allPrivileges); + }); + }); + + describe('getPrivilegesAndCapabilities', () => { + it('returns full capabilities if provided both monitor and admin cluster privileges', () => { + const fullCapabilities = { + canCreateTransform: true, + canCreateTransformAlerts: true, + canDeleteTransform: true, + canGetTransform: true, + canPreviewTransform: true, + canResetTransform: true, + canScheduleNowTransform: true, + canStartStopTransform: true, + canUseTransformAlerts: true, + }; + + expect(getPrivilegesAndCapabilities(fullClusterPrivileges, true, true)).toEqual({ + capabilities: fullCapabilities, + privileges: { hasAllPrivileges: true, missingPrivileges: { cluster: [], index: [] } }, + }); + expect(getPrivilegesAndCapabilities(fullClusterPrivileges, false, true)).toEqual({ + capabilities: fullCapabilities, + privileges: { + hasAllPrivileges: true, + missingPrivileges: { cluster: [], index: ['monitor'] }, + }, + }); + }); + it('returns view only capabilities if provided only monitor cluster privileges', () => { + const viewOnlyCapabilities = { + canCreateTransform: false, + canCreateTransformAlerts: false, + canDeleteTransform: false, + canGetTransform: true, + canPreviewTransform: false, + canResetTransform: false, + canScheduleNowTransform: false, + canStartStopTransform: false, + canUseTransformAlerts: true, + }; + + const { capabilities, privileges } = getPrivilegesAndCapabilities( + monitorOnlyClusterPrivileges, + true, + false + ); + expect(capabilities).toEqual(viewOnlyCapabilities); + expect(privileges).toEqual({ + hasAllPrivileges: false, + missingPrivileges: { + cluster: monitorOnlyMissingPrivileges, + index: [], + }, + }); + }); + it('returns no capabilities and all the missing privileges if no cluster privileges', () => { + const noCapabilities = { + canCreateTransform: false, + canCreateTransformAlerts: false, + canDeleteTransform: false, + canGetTransform: false, + canPreviewTransform: false, + canResetTransform: false, + canScheduleNowTransform: false, + canStartStopTransform: false, + canUseTransformAlerts: false, + }; + + const { capabilities, privileges } = getPrivilegesAndCapabilities( + noClusterPrivileges, + false, + false + ); + expect(capabilities).toEqual(noCapabilities); + expect(privileges).toEqual({ + hasAllPrivileges: false, + missingPrivileges: { + cluster: Object.keys(noClusterPrivileges), + index: ['monitor'], + }, + }); + }); + + it('returns canResetTransform:false if no cluster privilege for transform/reset', () => { + const { capabilities } = getPrivilegesAndCapabilities( + { + ...fullClusterPrivileges, + 'cluster:admin/transform/reset': false, + }, + false, + false + ); + expect(capabilities.canResetTransform).toEqual(false); + }); + }); +}); diff --git a/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts b/x-pack/plugins/transform/common/privilege/has_privilege_factory.ts similarity index 58% rename from x-pack/plugins/transform/public/app/lib/authorization/components/common.ts rename to x-pack/plugins/transform/common/privilege/has_privilege_factory.ts index e21633ef2de2c..f9afe59355c01 100644 --- a/x-pack/plugins/transform/public/app/lib/authorization/components/common.ts +++ b/x-pack/plugins/transform/common/privilege/has_privilege_factory.ts @@ -8,9 +8,11 @@ import { i18n } from '@kbn/i18n'; import { isPopulatedObject } from '@kbn/ml-is-populated-object'; -import { Privileges } from '../../../../../common/types/privileges'; +import { cloneDeep } from 'lodash'; +import { APP_INDEX_PRIVILEGES } from '../constants'; +import { Privileges } from '../types/privileges'; -export interface Capabilities { +export interface TransformCapabilities { canGetTransform: boolean; canDeleteTransform: boolean; canPreviewTransform: boolean; @@ -21,6 +23,19 @@ export interface Capabilities { canUseTransformAlerts: boolean; canResetTransform: boolean; } +export type Capabilities = { [k in keyof TransformCapabilities]: boolean }; + +export const INITIAL_CAPABILITIES = Object.freeze({ + canGetTransform: false, + canDeleteTransform: false, + canPreviewTransform: false, + canCreateTransform: false, + canScheduleNowTransform: false, + canStartStopTransform: false, + canCreateTransformAlerts: false, + canUseTransformAlerts: false, + canResetTransform: false, +}); export type Privilege = [string, string]; @@ -58,10 +73,69 @@ export const hasPrivilegeFactory = ); }; +export const extractMissingPrivileges = ( + privilegesObject: { [key: string]: boolean } = {} +): string[] => + Object.keys(privilegesObject).reduce((privileges: string[], privilegeName: string): string[] => { + if (!privilegesObject[privilegeName]) { + privileges.push(privilegeName); + } + return privileges; + }, []); + +export const getPrivilegesAndCapabilities = ( + clusterPrivileges: Record, + hasOneIndexWithAllPrivileges: boolean, + hasAllPrivileges: boolean +) => { + const privilegesResult: Privileges = { + hasAllPrivileges: true, + missingPrivileges: { + cluster: [], + index: [], + }, + }; + + // Find missing cluster privileges and set overall app privileges + privilegesResult.missingPrivileges.cluster = extractMissingPrivileges(clusterPrivileges); + privilegesResult.hasAllPrivileges = hasAllPrivileges; + + if (!hasOneIndexWithAllPrivileges) { + privilegesResult.missingPrivileges.index = [...APP_INDEX_PRIVILEGES]; + } + + const hasPrivilege = hasPrivilegeFactory(privilegesResult); + + const capabilities = cloneDeep(INITIAL_CAPABILITIES); + capabilities.canGetTransform = + hasPrivilege(['cluster', 'cluster:monitor/transform/get']) && + hasPrivilege(['cluster', 'cluster:monitor/transform/stats/get']); + + capabilities.canCreateTransform = hasPrivilege(['cluster', 'cluster:admin/transform/put']); + + capabilities.canDeleteTransform = hasPrivilege(['cluster', 'cluster:admin/transform/delete']); + + capabilities.canResetTransform = hasPrivilege(['cluster', 'cluster:admin/transform/reset']); + + capabilities.canPreviewTransform = hasPrivilege(['cluster', 'cluster:admin/transform/preview']); + + capabilities.canStartStopTransform = + hasPrivilege(['cluster', 'cluster:admin/transform/start']) && + hasPrivilege(['cluster', 'cluster:admin/transform/start_task']) && + hasPrivilege(['cluster', 'cluster:admin/transform/stop']); + + capabilities.canCreateTransformAlerts = capabilities.canCreateTransform; + + capabilities.canUseTransformAlerts = capabilities.canGetTransform; + + capabilities.canScheduleNowTransform = capabilities.canStartStopTransform; + + return { privileges: privilegesResult, capabilities }; +}; // create the text for button's tooltips if the user // doesn't have the permission to press that button export function createCapabilityFailureMessage( - capability: keyof Capabilities | 'noTransformNodes' + capability: keyof TransformCapabilities | 'noTransformNodes' ) { let message = ''; diff --git a/x-pack/plugins/transform/public/app/common/pivot_aggs.ts b/x-pack/plugins/transform/public/app/common/pivot_aggs.ts index f22b5fcb264cc..21c4e79ba5c05 100644 --- a/x-pack/plugins/transform/public/app/common/pivot_aggs.ts +++ b/x-pack/plugins/transform/public/app/common/pivot_aggs.ts @@ -10,6 +10,7 @@ import { FC } from 'react'; import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from '@kbn/field-types'; import { isPopulatedObject } from '@kbn/ml-is-populated-object'; +import { TIME_SERIES_METRIC_TYPES } from '@kbn/ml-agg-utils'; import type { AggName } from '../../../common/types/aggregations'; import type { Dictionary } from '../../../common/types/common'; import type { EsFieldName } from '../../../common/types/fields'; @@ -17,8 +18,8 @@ import type { PivotSupportedAggs } from '../../../common/types/pivot_aggs'; import { PIVOT_SUPPORTED_AGGS, PivotAgg } from '../../../common/types/pivot_aggs'; import { getAggFormConfig } from '../sections/create_transform/components/step_define/common/get_agg_form_config'; -import { PivotAggsConfigFilter } from '../sections/create_transform/components/step_define/common/filter_agg/types'; -import { PivotAggsConfigTopMetrics } from '../sections/create_transform/components/step_define/common/top_metrics_agg/types'; +import type { PivotAggsConfigFilter } from '../sections/create_transform/components/step_define/common/filter_agg/types'; +import type { PivotAggsConfigTopMetrics } from '../sections/create_transform/components/step_define/common/top_metrics_agg/types'; export function isPivotSupportedAggs(arg: unknown): arg is PivotSupportedAggs { return ( @@ -75,12 +76,18 @@ export const pivotAggsFieldSupport = { [KBN_FIELD_TYPES._SOURCE]: [PIVOT_SUPPORTED_AGGS.VALUE_COUNT, PIVOT_SUPPORTED_AGGS.FILTER], [KBN_FIELD_TYPES.UNKNOWN]: [PIVOT_SUPPORTED_AGGS.VALUE_COUNT, PIVOT_SUPPORTED_AGGS.FILTER], [KBN_FIELD_TYPES.CONFLICT]: [PIVOT_SUPPORTED_AGGS.VALUE_COUNT, PIVOT_SUPPORTED_AGGS.FILTER], + [TIME_SERIES_METRIC_TYPES.COUNTER]: [ + PIVOT_SUPPORTED_AGGS.MAX, + PIVOT_SUPPORTED_AGGS.MIN, + PIVOT_SUPPORTED_AGGS.TOP_METRICS, + ], }; export const TOP_METRICS_SORT_FIELD_TYPES = [ KBN_FIELD_TYPES.NUMBER, KBN_FIELD_TYPES.DATE, KBN_FIELD_TYPES.GEO_POINT, + TIME_SERIES_METRIC_TYPES.COUNTER, ]; export const SORT_DIRECTION = { diff --git a/x-pack/plugins/transform/public/app/lib/authorization/components/authorization_provider.tsx b/x-pack/plugins/transform/public/app/lib/authorization/components/authorization_provider.tsx index 6dbd6e5032276..65a3b2336a114 100644 --- a/x-pack/plugins/transform/public/app/lib/authorization/components/authorization_provider.tsx +++ b/x-pack/plugins/transform/public/app/lib/authorization/components/authorization_provider.tsx @@ -11,27 +11,18 @@ import { Privileges } from '../../../../../common/types/privileges'; import { useRequest } from '../../../hooks'; -import { hasPrivilegeFactory, Capabilities } from './common'; +import { + TransformCapabilities, + INITIAL_CAPABILITIES, +} from '../../../../../common/privilege/has_privilege_factory'; interface Authorization { isLoading: boolean; apiError: Error | null; privileges: Privileges; - capabilities: Capabilities; + capabilities: TransformCapabilities; } -const initialCapabilities: Capabilities = { - canGetTransform: false, - canDeleteTransform: false, - canPreviewTransform: false, - canCreateTransform: false, - canScheduleNowTransform: false, - canStartStopTransform: false, - canCreateTransformAlerts: false, - canUseTransformAlerts: false, - canResetTransform: false, -}; - const initialValue: Authorization = { isLoading: true, apiError: null, @@ -39,7 +30,7 @@ const initialValue: Authorization = { hasAllPrivileges: false, missingPrivileges: {}, }, - capabilities: initialCapabilities, + capabilities: INITIAL_CAPABILITIES, }; export const AuthorizationContext = createContext({ ...initialValue }); @@ -61,42 +52,11 @@ export const AuthorizationProvider = ({ privilegesEndpoint, children }: Props) = const value = { isLoading, - privileges: isLoading ? { ...initialValue.privileges } : privilegesData, - capabilities: { ...initialCapabilities }, + privileges: isLoading ? { ...initialValue.privileges } : privilegesData.privileges, + capabilities: isLoading ? { ...INITIAL_CAPABILITIES } : privilegesData.capabilities, apiError: error ? (error as Error) : null, }; - const hasPrivilege = hasPrivilegeFactory(value.privileges); - - value.capabilities.canGetTransform = - hasPrivilege(['cluster', 'cluster:monitor/transform/get']) && - hasPrivilege(['cluster', 'cluster:monitor/transform/stats/get']); - - value.capabilities.canCreateTransform = hasPrivilege(['cluster', 'cluster:admin/transform/put']); - - value.capabilities.canDeleteTransform = hasPrivilege([ - 'cluster', - 'cluster:admin/transform/delete', - ]); - - value.capabilities.canResetTransform = hasPrivilege(['cluster', 'cluster:admin/transform/reset']); - - value.capabilities.canPreviewTransform = hasPrivilege([ - 'cluster', - 'cluster:admin/transform/preview', - ]); - - value.capabilities.canStartStopTransform = - hasPrivilege(['cluster', 'cluster:admin/transform/start']) && - hasPrivilege(['cluster', 'cluster:admin/transform/start_task']) && - hasPrivilege(['cluster', 'cluster:admin/transform/stop']); - - value.capabilities.canCreateTransformAlerts = value.capabilities.canCreateTransform; - - value.capabilities.canUseTransformAlerts = value.capabilities.canGetTransform; - - value.capabilities.canScheduleNowTransform = value.capabilities.canStartStopTransform; - return ( {children} ); diff --git a/x-pack/plugins/transform/public/app/lib/authorization/components/index.ts b/x-pack/plugins/transform/public/app/lib/authorization/components/index.ts index edc2ec9188cd0..cb0f248efc165 100644 --- a/x-pack/plugins/transform/public/app/lib/authorization/components/index.ts +++ b/x-pack/plugins/transform/public/app/lib/authorization/components/index.ts @@ -5,7 +5,7 @@ * 2.0. */ -export { createCapabilityFailureMessage } from './common'; +export { createCapabilityFailureMessage } from '../../../../../common/privilege/has_privilege_factory'; export { AuthorizationProvider, AuthorizationContext } from './authorization_provider'; export { PrivilegesWrapper } from './with_privileges'; export { NotAuthorizedSection } from './not_authorized_section'; diff --git a/x-pack/plugins/transform/public/app/lib/authorization/components/with_privileges.tsx b/x-pack/plugins/transform/public/app/lib/authorization/components/with_privileges.tsx index 2bbcf84d4623c..2117591142b26 100644 --- a/x-pack/plugins/transform/public/app/lib/authorization/components/with_privileges.tsx +++ b/x-pack/plugins/transform/public/app/lib/authorization/components/with_privileges.tsx @@ -21,7 +21,11 @@ import { SectionLoading } from '../../../components'; import { AuthorizationContext } from './authorization_provider'; import { NotAuthorizedSection } from './not_authorized_section'; -import { hasPrivilegeFactory, toArray, Privilege } from './common'; +import { + hasPrivilegeFactory, + toArray, + Privilege, +} from '../../../../../common/privilege/has_privilege_factory'; interface Props { /** diff --git a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts index 6cbd7f6a7be6e..3ee8d20632ecf 100644 --- a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts +++ b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/get_pivot_dropdown_options.ts @@ -9,6 +9,7 @@ import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from '@kbn/field-types'; import { DataView } from '@kbn/data-views-plugin/public'; import { getNestedProperty } from '@kbn/ml-nested-property'; +import { isCounterTimeSeriesMetric, TIME_SERIES_METRIC_TYPES } from '@kbn/ml-agg-utils'; import { removeKeywordPostfix } from '../../../../../../../common/utils/field_utils'; import { isRuntimeMappings } from '../../../../../../../common/shared_imports'; @@ -81,7 +82,14 @@ export function getPivotDropdownOptions( // even when the TS interface is a non-optional `string`. typeof field.type !== 'undefined' ) - .map((field): Field => ({ name: field.name, type: field.type as KBN_FIELD_TYPES })); + .map( + (field): Field => ({ + name: field.name, + type: isCounterTimeSeriesMetric(field) + ? TIME_SERIES_METRIC_TYPES.COUNTER + : (field.type as KBN_FIELD_TYPES), + }) + ); // Support for runtime_mappings that are defined by queries let runtimeFields: Field[] = []; @@ -128,6 +136,7 @@ export function getPivotDropdownOptions( options: [], field: { id: rawFieldName, type: field.type as KBN_FIELD_TYPES & ES_FIELD_TYPES }, }; + const availableAggs: [] = getNestedProperty(pivotAggsFieldSupport, field.type); if (availableAggs !== undefined) { diff --git a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/types.ts b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/types.ts index 570247d443e4f..682001a937381 100644 --- a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/types.ts +++ b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/common/types.ts @@ -9,6 +9,7 @@ import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { isPopulatedObject } from '@kbn/ml-is-populated-object'; import type { TimeRange as TimeRangeMs } from '@kbn/ml-date-picker'; +import { TIME_SERIES_METRIC_TYPES } from '@kbn/ml-agg-utils'; import { EsFieldName } from '../../../../../../../common/types/fields'; import { @@ -34,7 +35,7 @@ export interface ErrorMessage { export interface Field { name: EsFieldName; - type: KBN_FIELD_TYPES; + type: KBN_FIELD_TYPES | TIME_SERIES_METRIC_TYPES.COUNTER; } type RuntimeType = typeof RUNTIME_FIELD_TYPES[number]; diff --git a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/hooks/use_latest_function_config.ts b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/hooks/use_latest_function_config.ts index eded0073e17e8..4344d96695a7f 100644 --- a/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/hooks/use_latest_function_config.ts +++ b/x-pack/plugins/transform/public/app/sections/create_transform/components/step_define/hooks/use_latest_function_config.ts @@ -9,6 +9,7 @@ import { useCallback, useMemo, useState } from 'react'; import { i18n } from '@kbn/i18n'; import { EuiComboBoxOptionOption } from '@elastic/eui'; import type { AggConfigs, FieldParamType } from '@kbn/data-plugin/common'; +import { isCounterTimeSeriesMetric } from '@kbn/ml-agg-utils'; import { LatestFunctionConfigUI } from '../../../../../../../common/types/transform'; import { StepDefineFormProps } from '../step_define_form'; import { StepDefineExposedState } from '../common'; @@ -62,7 +63,7 @@ function getOptions( : []; const uniqueKeyOptions: Array> = filteredDataViewFields - .filter((v) => !ignoreFieldNames.has(v.name)) + .filter((v) => !ignoreFieldNames.has(v.name) && !isCounterTimeSeriesMetric(v)) .map((v) => ({ label: v.displayName, value: v.name, diff --git a/x-pack/plugins/transform/server/capabilities.ts b/x-pack/plugins/transform/server/capabilities.ts new file mode 100644 index 0000000000000..73889a0808359 --- /dev/null +++ b/x-pack/plugins/transform/server/capabilities.ts @@ -0,0 +1,76 @@ +/* + * 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 { CoreSetup } from '@kbn/core-lifecycle-server'; +import { SecurityPluginSetup } from '@kbn/security-plugin/server'; +import { + getPrivilegesAndCapabilities, + INITIAL_CAPABILITIES, +} from '../common/privilege/has_privilege_factory'; +import { APP_CLUSTER_PRIVILEGES } from '../common/constants'; +import type { PluginStartDependencies } from './types'; + +export const TRANSFORM_PLUGIN_ID = 'transform' as const; + +export const setupCapabilities = ( + core: Pick, 'capabilities' | 'getStartServices'>, + securitySetup?: SecurityPluginSetup +) => { + core.capabilities.registerProvider(() => { + return { + transform: INITIAL_CAPABILITIES, + }; + }); + + core.capabilities.registerSwitcher(async (request, capabilities, useDefaultCapabilities) => { + if (useDefaultCapabilities) { + return {}; + } + + const isSecurityPluginEnabled = securitySetup?.license.isEnabled() ?? false; + const startServices = await core.getStartServices(); + const [, { security: securityStart }] = startServices; + + // If security is not enabled or not available, transform should have full permission + if (!isSecurityPluginEnabled || !securityStart) { + return { + transform: Object.keys(INITIAL_CAPABILITIES).reduce>((acc, p) => { + acc[p] = true; + return acc; + }, {}), + }; + } + + const checkPrivileges = securityStart.authz.checkPrivilegesDynamicallyWithRequest(request); + + const { hasAllRequested, privileges } = await checkPrivileges({ + elasticsearch: { + cluster: APP_CLUSTER_PRIVILEGES, + index: {}, + }, + }); + + const clusterPrivileges: Record = Array.isArray( + privileges?.elasticsearch?.cluster + ) + ? privileges.elasticsearch.cluster.reduce>((acc, p) => { + acc[p.privilege] = p.authorized; + return acc; + }, {}) + : {}; + + const hasOneIndexWithAllPrivileges = false; + + const transformCapabilities = getPrivilegesAndCapabilities( + clusterPrivileges, + hasOneIndexWithAllPrivileges, + hasAllRequested + ).capabilities; + + return { transform: transformCapabilities }; + }); +}; diff --git a/x-pack/plugins/transform/server/plugin.ts b/x-pack/plugins/transform/server/plugin.ts index b46d7441ee8a9..ab2bb0769e002 100644 --- a/x-pack/plugins/transform/server/plugin.ts +++ b/x-pack/plugins/transform/server/plugin.ts @@ -10,6 +10,7 @@ import { CoreSetup, CoreStart, Plugin, Logger, PluginInitializerContext } from ' import { LicenseType } from '@kbn/licensing-plugin/common/types'; +import { setupCapabilities } from './capabilities'; import { PluginSetupDependencies, PluginStartDependencies } from './types'; import { registerRoutes } from './routes'; import { License } from './services'; @@ -36,9 +37,13 @@ export class TransformServerPlugin implements Plugin<{}, void, any, any> { } setup( - { http, getStartServices, elasticsearch }: CoreSetup, - { licensing, features, alerting }: PluginSetupDependencies + coreSetup: CoreSetup, + { licensing, features, alerting, security: securitySetup }: PluginSetupDependencies ): {} { + const { http, getStartServices } = coreSetup; + + setupCapabilities(coreSetup, securitySetup); + features.registerElasticsearchFeature({ id: PLUGIN.id, management: { diff --git a/x-pack/plugins/transform/server/routes/api/privileges.ts b/x-pack/plugins/transform/server/routes/api/privileges.ts index bad077100c83a..0f078044c3c2a 100644 --- a/x-pack/plugins/transform/server/routes/api/privileges.ts +++ b/x-pack/plugins/transform/server/routes/api/privileges.ts @@ -5,10 +5,13 @@ * 2.0. */ +import type { IScopedClusterClient } from '@kbn/core/server'; +import type { SecurityHasPrivilegesResponse } from '@elastic/elasticsearch/lib/api/types'; +import { getPrivilegesAndCapabilities } from '../../../common/privilege/has_privilege_factory'; import { APP_CLUSTER_PRIVILEGES, APP_INDEX_PRIVILEGES } from '../../../common/constants'; -import { Privileges } from '../../../common/types/privileges'; +import type { Privileges } from '../../../common/types/privileges'; -import { RouteDependencies } from '../../types'; +import type { RouteDependencies } from '../../types'; import { addBasePath } from '..'; export function registerPrivilegesRoute({ router, license }: RouteDependencies) { @@ -28,50 +31,42 @@ export function registerPrivilegesRoute({ router, license }: RouteDependencies) return res.ok({ body: privilegesResult }); } - const esClient = (await ctx.core).elasticsearch.client; - // Get cluster privileges - const { has_all_requested: hasAllPrivileges, cluster } = - await esClient.asCurrentUser.security.hasPrivileges({ + const esClient: IScopedClusterClient = (await ctx.core).elasticsearch.client; + + const esClusterPrivilegesReq: Promise = + esClient.asCurrentUser.security.hasPrivileges({ body: { // @ts-expect-error SecurityClusterPrivilege doesn’t contain all the priviledges cluster: APP_CLUSTER_PRIVILEGES, }, }); + const [esClusterPrivileges, userPrivileges] = await Promise.all([ + // Get cluster privileges + esClusterPrivilegesReq, + // // Get all index privileges the user has + esClient.asCurrentUser.security.getUserPrivileges(), + ]); - // Find missing cluster privileges and set overall app privileges - privilegesResult.missingPrivileges.cluster = extractMissingPrivileges(cluster); - privilegesResult.hasAllPrivileges = hasAllPrivileges; - - // Get all index privileges the user has - const { indices } = await esClient.asCurrentUser.security.getUserPrivileges(); + const { has_all_requested: hasAllPrivileges, cluster } = esClusterPrivileges; + const { indices } = userPrivileges; // Check if they have all the required index privileges for at least one index - const oneIndexWithAllPrivileges = indices.find(({ privileges }: { privileges: string[] }) => { - if (privileges.includes('all')) { - return true; - } + const hasOneIndexWithAllPrivileges = + indices.find(({ privileges }: { privileges: string[] }) => { + if (privileges.includes('all')) { + return true; + } - const indexHasAllPrivileges = APP_INDEX_PRIVILEGES.every((privilege) => - privileges.includes(privilege) - ); + const indexHasAllPrivileges = APP_INDEX_PRIVILEGES.every((privilege) => + privileges.includes(privilege) + ); - return indexHasAllPrivileges; - }); + return indexHasAllPrivileges; + }) !== undefined; - // If they don't, return list of required index privileges - if (!oneIndexWithAllPrivileges) { - privilegesResult.missingPrivileges.index = [...APP_INDEX_PRIVILEGES]; - } - - return res.ok({ body: privilegesResult }); + return res.ok({ + body: getPrivilegesAndCapabilities(cluster, hasOneIndexWithAllPrivileges, hasAllPrivileges), + }); }) ); } - -const extractMissingPrivileges = (privilegesObject: { [key: string]: boolean } = {}): string[] => - Object.keys(privilegesObject).reduce((privileges: string[], privilegeName: string): string[] => { - if (!privilegesObject[privilegeName]) { - privileges.push(privilegeName); - } - return privileges; - }, []); diff --git a/x-pack/plugins/transform/server/types.ts b/x-pack/plugins/transform/server/types.ts index 9aa89e3bfebbf..012f819fce88f 100644 --- a/x-pack/plugins/transform/server/types.ts +++ b/x-pack/plugins/transform/server/types.ts @@ -5,24 +5,27 @@ * 2.0. */ -import { IRouter, CoreStart } from '@kbn/core/server'; -import { PluginStart as DataViewsServerPluginStart } from '@kbn/data-views-plugin/server'; -import { LicensingPluginSetup } from '@kbn/licensing-plugin/server'; -import { PluginSetupContract as FeaturesPluginSetup } from '@kbn/features-plugin/server'; +import type { IRouter, CoreStart } from '@kbn/core/server'; +import type { PluginStart as DataViewsServerPluginStart } from '@kbn/data-views-plugin/server'; +import type { LicensingPluginSetup } from '@kbn/licensing-plugin/server'; +import type { PluginSetupContract as FeaturesPluginSetup } from '@kbn/features-plugin/server'; import type { AlertingPlugin } from '@kbn/alerting-plugin/server'; -import { FieldFormatsSetup, FieldFormatsStart } from '@kbn/field-formats-plugin/server'; -import { License } from './services'; +import type { FieldFormatsSetup, FieldFormatsStart } from '@kbn/field-formats-plugin/server'; +import type { SecurityPluginSetup, SecurityPluginStart } from '@kbn/security-plugin/server'; +import type { License } from './services'; export interface PluginSetupDependencies { licensing: LicensingPluginSetup; features: FeaturesPluginSetup; alerting?: AlertingPlugin['setup']; fieldFormats: FieldFormatsSetup; + security?: SecurityPluginSetup; } export interface PluginStartDependencies { dataViews: DataViewsServerPluginStart; fieldFormats: FieldFormatsStart; + security?: SecurityPluginStart; } export interface RouteDependencies { diff --git a/x-pack/plugins/transform/tsconfig.json b/x-pack/plugins/transform/tsconfig.json index 59e89a7db6cc4..6be7c1581f949 100644 --- a/x-pack/plugins/transform/tsconfig.json +++ b/x-pack/plugins/transform/tsconfig.json @@ -56,7 +56,9 @@ "@kbn/shared-ux-router", "@kbn/saved-objects-management-plugin", "@kbn/saved-objects-finder-plugin", - "@kbn/ml-route-utils" + "@kbn/ml-route-utils", + "@kbn/core-lifecycle-server", + "@kbn/security-plugin" ], "exclude": [ "target/**/*", diff --git a/x-pack/plugins/translations/translations/fr-FR.json b/x-pack/plugins/translations/translations/fr-FR.json index 5bfe3d51872f4..751d0f97a6981 100644 --- a/x-pack/plugins/translations/translations/fr-FR.json +++ b/x-pack/plugins/translations/translations/fr-FR.json @@ -10816,8 +10816,6 @@ "xpack.dataVisualizer.index.dataLoader.internalServerErrorMessage": "Erreur lors du chargement des données dans l'index {index}. {message}. La requête a peut-être expiré. Essayez d'utiliser un échantillon d'une taille inférieure ou de réduire la plage temporelle.", "xpack.dataVisualizer.index.dataViewNotBasedOnTimeSeriesNotificationTitle": "La vue de données {dataViewTitle} n'est pas basée sur une série temporelle", "xpack.dataVisualizer.index.errorLoadingDataMessage": "Erreur lors du chargement des données dans l'index {index}. {message}.", - "xpack.dataVisualizer.index.fieldNameDescription.dateRangeField": "Plage de valeurs {dateFieldTypeLink}. {viewSupportedDateFormatsLink}", - "xpack.dataVisualizer.index.fieldNameDescription.versionField": "Versions des logiciels. Prend en charge les règles de priorité de {SemanticVersioningLink}", "xpack.dataVisualizer.index.lensChart.averageOfLabel": "Moyenne de {fieldName}", "xpack.dataVisualizer.index.lensChart.chartTitle": "Lens pour {fieldName}", "xpack.dataVisualizer.index.savedSearchErrorMessage": "Erreur lors de la récupération de la recherche enregistrée {savedSearchId}", @@ -10882,22 +10880,6 @@ "xpack.dataVisualizer.fieldStats.maxTitle": "max", "xpack.dataVisualizer.fieldStats.medianTitle": "médiane", "xpack.dataVisualizer.fieldStats.minTitle": "min", - "xpack.dataVisualizer.fieldTypeIcon.booleanTypeLabel": "Booléen", - "xpack.dataVisualizer.fieldTypeIcon.conflictTypeLabel": "Conflit", - "xpack.dataVisualizer.fieldTypeIcon.dateRangeTypeLabel": "Plage de dates", - "xpack.dataVisualizer.fieldTypeIcon.dateTypeLabel": "Date", - "xpack.dataVisualizer.fieldTypeIcon.geoPointTypeLabel": "Point géographique", - "xpack.dataVisualizer.fieldTypeIcon.geoShapeTypeLabel": "Forme géométrique", - "xpack.dataVisualizer.fieldTypeIcon.histogramTypeLabel": "Histogramme", - "xpack.dataVisualizer.fieldTypeIcon.ipRangeTypeLabel": "Plage d'IP", - "xpack.dataVisualizer.fieldTypeIcon.ipTypeLabel": "IP", - "xpack.dataVisualizer.fieldTypeIcon.keywordTypeLabel": "Mot-clé", - "xpack.dataVisualizer.fieldTypeIcon.murmur3TypeLabel": "Murmur3", - "xpack.dataVisualizer.fieldTypeIcon.numberTypeLabel": "Nombre", - "xpack.dataVisualizer.fieldTypeIcon.stringTypeLabel": "Chaîne", - "xpack.dataVisualizer.fieldTypeIcon.textTypeLabel": "Texte", - "xpack.dataVisualizer.fieldTypeIcon.unknownTypeLabel": "Inconnu", - "xpack.dataVisualizer.fieldTypeIcon.versionTypeLabel": "Version", "xpack.dataVisualizer.fieldTypeSelect": "Type du champ", "xpack.dataVisualizer.fieldTypesPopover.buttonAriaLabel": "Aide sur le type de filtre", "xpack.dataVisualizer.fieldTypesPopover.dataTypeColumnTitle": "Type de données", @@ -11041,7 +11023,6 @@ "xpack.dataVisualizer.index.actionsPanel.discoverAppTitle": "Découverte", "xpack.dataVisualizer.index.actionsPanel.exploreTitle": "Explorer vos données", "xpack.dataVisualizer.index.actionsPanel.viewIndexInDiscoverDescription": "Explorez les documents de votre index.", - "xpack.dataVisualizer.index.advancedSettings.discover.fieldNameDescription.versionFieldLinkText": "Gestion sémantique des versions", "xpack.dataVisualizer.index.components.grid.description": "Visualiser les données", "xpack.dataVisualizer.index.components.grid.displayName": "Grille du visualiseur de données", "xpack.dataVisualizer.index.dataGrid.actionsColumnLabel": "Actions", @@ -11062,23 +11043,6 @@ "xpack.dataVisualizer.index.embeddableErrorTitle": "Erreur lors du chargement de l'incorporable", "xpack.dataVisualizer.index.embeddableNoResultsMessage": "Résultat introuvable", "xpack.dataVisualizer.index.errorFetchingFieldStatisticsMessage": "Erreur lors de la récupération des statistiques de champ", - "xpack.dataVisualizer.index.fieldNameDescription.booleanField": "Valeurs vraies ou fausses", - "xpack.dataVisualizer.index.fieldNameDescription.conflictField": "Le champ possède des valeurs de différents types. Corrigez le problème dans Gestion > Vues de données.", - "xpack.dataVisualizer.index.fieldNameDescription.dateField": "Chaîne de date ou nombre de secondes ou de millisecondes depuis 1/1/1970", - "xpack.dataVisualizer.index.fieldNameDescription.dateRangeFieldLinkText": "date", - "xpack.dataVisualizer.index.fieldNameDescription.geoPointField": "Points de latitude et de longitude", - "xpack.dataVisualizer.index.fieldNameDescription.geoShapeField": "Formes complexes, telles que des polygones", - "xpack.dataVisualizer.index.fieldNameDescription.histogramField": "Valeurs numériques pré-agrégées sous forme d'histogramme", - "xpack.dataVisualizer.index.fieldNameDescription.ipAddressField": "Adresses IPv4 et IPv6", - "xpack.dataVisualizer.index.fieldNameDescription.ipAddressRangeField": "Plage de valeurs IP prenant en charge les adresses IPv4 ou IPv6 (ou les 2)", - "xpack.dataVisualizer.index.fieldNameDescription.keywordField": "Contenu structuré tel qu'un ID, une adresse e-mail, un nom d'hôte, un code de statut, ou une balise", - "xpack.dataVisualizer.index.fieldNameDescription.murmur3Field": "Champ qui calcule et stocke les hachages de valeurs", - "xpack.dataVisualizer.index.fieldNameDescription.nestedField": "Objet JSON qui conserve la relation entre ses sous-champs", - "xpack.dataVisualizer.index.fieldNameDescription.numberField": "Valeurs Long, Entier, Court, Octet, Double et Élément flottant", - "xpack.dataVisualizer.index.fieldNameDescription.stringField": "Texte intégral tel que le corps d'un e-mail ou la description d'un produit", - "xpack.dataVisualizer.index.fieldNameDescription.textField": "Texte intégral tel que le corps d'un e-mail ou la description d'un produit", - "xpack.dataVisualizer.index.fieldNameDescription.unknownField": "Champ inconnu", - "xpack.dataVisualizer.index.fieldNameDescription.viewSupportedDateFormatsLinkText": "Affichez les formats de date pris en charge.", "xpack.dataVisualizer.index.fieldNameSelect": "Nom du champ", "xpack.dataVisualizer.index.fieldTypeSelect": "Type du champ", "xpack.dataVisualizer.index.lensChart.countLabel": "Décompte", @@ -20636,10 +20600,7 @@ "xpack.maps.layerPanel.filterEditor.isLayerFilterNotApplied": "Le filtre de calque n'est pas appliqué lors de la modification des fonctionnalités", "xpack.maps.layerPanel.filterEditor.queryBarSubmitButtonLabel": "Définir le filtre", "xpack.maps.layerPanel.filterEditor.title": "Filtrage", - "xpack.maps.layerPanel.footer.cancelButtonLabel": "Annuler", - "xpack.maps.layerPanel.footer.closeButtonLabel": "Fermer", "xpack.maps.layerPanel.footer.removeLayerButtonLabel": "Retirer un calque", - "xpack.maps.layerPanel.footer.saveAndCloseButtonLabel": "Enregistrer et fermer", "xpack.maps.layerPanel.join.applyGlobalQueryCheckboxLabel": "Appliquer une recherche globale à la liaison", "xpack.maps.layerPanel.join.applyGlobalTimeCheckboxLabel": "Appliquer une heure globale à la liaison", "xpack.maps.layerPanel.join.deleteJoinAriaLabel": "Supprimer la liaison", @@ -20726,8 +20687,6 @@ "xpack.maps.mapSettingsPanel.autoFitToDataBoundsLabel": "Ajuster automatiquement la carte aux limites de données", "xpack.maps.mapSettingsPanel.backgroundColorLabel": "Couleur d'arrière-plan", "xpack.maps.mapSettingsPanel.browserLocationLabel": "Emplacement du navigateur", - "xpack.maps.mapSettingsPanel.cancelLabel": "Annuler", - "xpack.maps.mapSettingsPanel.closeLabel": "Fermer", "xpack.maps.mapSettingsPanel.customIcons.emptyState.description": "Ajoutez une icône personnalisée pouvant être utilisée dans les calques de cette carte.", "xpack.maps.mapSettingsPanel.customIconsAddIconButton": "Ajouter", "xpack.maps.mapSettingsPanel.customIconsTitle": "Icônes personnalisées", @@ -20737,7 +20696,6 @@ "xpack.maps.mapSettingsPanel.initialLatLabel": "Latitude initiale", "xpack.maps.mapSettingsPanel.initialLonLabel": "Longitude initiale", "xpack.maps.mapSettingsPanel.initialZoomLabel": "Zoom initial", - "xpack.maps.mapSettingsPanel.keepChangesButtonLabel": "Conserver les modifications", "xpack.maps.mapSettingsPanel.lastSavedLocationLabel": "Emplacement de la carte à l'enregistrement", "xpack.maps.mapSettingsPanel.navigationTitle": "Navigation", "xpack.maps.mapSettingsPanel.showScaleLabel": "Afficher l'échelle", @@ -25949,8 +25907,6 @@ "xpack.observability.page_header.addUptimeDataLink.label": "Accédez à un tutoriel sur l'ajout de données Uptime", "xpack.observability.page_header.addUXDataLink.label": "Accédez à un tutoriel sur l'ajout de données APM d'expérience utilisateur.", "xpack.observability.pageLayout.sideNavTitle": "Observabilité", - "xpack.observability.pages.alertDetails.alertSummary.duration": "Durée", - "xpack.observability.pages.alertDetails.alertSummary.lastStatusUpdate": "Dernière mise à jour du statut", "xpack.observability.profilingElasticsearchPlugin": "Utiliser le plug-in de profileur Elasticsearch", "xpack.observability.resources.documentation": "Documentation", "xpack.observability.resources.forum": "Forum de discussion", diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json index c521bce59c554..b395853501d98 100644 --- a/x-pack/plugins/translations/translations/ja-JP.json +++ b/x-pack/plugins/translations/translations/ja-JP.json @@ -10815,8 +10815,6 @@ "xpack.dataVisualizer.index.dataLoader.internalServerErrorMessage": "インデックス{index}のデータの読み込み中にエラーが発生。{message}。リクエストがタイムアウトした可能性があります。小さなサンプルサイズを使うか、時間範囲を狭めてみてください。", "xpack.dataVisualizer.index.dataViewNotBasedOnTimeSeriesNotificationTitle": "データビュー{dataViewTitle}は時系列に基づいていません", "xpack.dataVisualizer.index.errorLoadingDataMessage": "インデックス{index}のデータの読み込み中にエラーが発生。{message}。", - "xpack.dataVisualizer.index.fieldNameDescription.dateRangeField": "{dateFieldTypeLink}値の範囲。{viewSupportedDateFormatsLink}", - "xpack.dataVisualizer.index.fieldNameDescription.versionField": "ソフトウェアバージョン。{SemanticVersioningLink}事前ルールをサポートします", "xpack.dataVisualizer.index.lensChart.averageOfLabel": "{fieldName} の平均", "xpack.dataVisualizer.index.lensChart.chartTitle": "{fieldName}のLens", "xpack.dataVisualizer.index.savedSearchErrorMessage": "保存された検索{savedSearchId}の取得エラー", @@ -10881,22 +10879,6 @@ "xpack.dataVisualizer.fieldStats.maxTitle": "最高", "xpack.dataVisualizer.fieldStats.medianTitle": "中間", "xpack.dataVisualizer.fieldStats.minTitle": "分", - "xpack.dataVisualizer.fieldTypeIcon.booleanTypeLabel": "ブール", - "xpack.dataVisualizer.fieldTypeIcon.conflictTypeLabel": "競合", - "xpack.dataVisualizer.fieldTypeIcon.dateRangeTypeLabel": "日付範囲", - "xpack.dataVisualizer.fieldTypeIcon.dateTypeLabel": "日付", - "xpack.dataVisualizer.fieldTypeIcon.geoPointTypeLabel": "地理ポイント", - "xpack.dataVisualizer.fieldTypeIcon.geoShapeTypeLabel": "地理情報図形", - "xpack.dataVisualizer.fieldTypeIcon.histogramTypeLabel": "ヒストグラム", - "xpack.dataVisualizer.fieldTypeIcon.ipRangeTypeLabel": "IP範囲", - "xpack.dataVisualizer.fieldTypeIcon.ipTypeLabel": "IP", - "xpack.dataVisualizer.fieldTypeIcon.keywordTypeLabel": "キーワード", - "xpack.dataVisualizer.fieldTypeIcon.murmur3TypeLabel": "Murmur3", - "xpack.dataVisualizer.fieldTypeIcon.numberTypeLabel": "数字", - "xpack.dataVisualizer.fieldTypeIcon.stringTypeLabel": "文字列", - "xpack.dataVisualizer.fieldTypeIcon.textTypeLabel": "テキスト", - "xpack.dataVisualizer.fieldTypeIcon.unknownTypeLabel": "不明", - "xpack.dataVisualizer.fieldTypeIcon.versionTypeLabel": "バージョン", "xpack.dataVisualizer.fieldTypeSelect": "フィールド型", "xpack.dataVisualizer.fieldTypesPopover.buttonAriaLabel": "フィルタータイプのヘルプ", "xpack.dataVisualizer.fieldTypesPopover.dataTypeColumnTitle": "データ型", @@ -11040,7 +11022,6 @@ "xpack.dataVisualizer.index.actionsPanel.discoverAppTitle": "Discover", "xpack.dataVisualizer.index.actionsPanel.exploreTitle": "データの調査", "xpack.dataVisualizer.index.actionsPanel.viewIndexInDiscoverDescription": "インデックスのドキュメントを調査します。", - "xpack.dataVisualizer.index.advancedSettings.discover.fieldNameDescription.versionFieldLinkText": "セマンティックバージョニング", "xpack.dataVisualizer.index.components.grid.description": "データの可視化", "xpack.dataVisualizer.index.components.grid.displayName": "データビジュアライザーグリッド", "xpack.dataVisualizer.index.dataGrid.actionsColumnLabel": "アクション", @@ -11061,23 +11042,6 @@ "xpack.dataVisualizer.index.embeddableErrorTitle": "埋め込み可能オブジェクトの読み込みエラー", "xpack.dataVisualizer.index.embeddableNoResultsMessage": "結果が見つかりませんでした", "xpack.dataVisualizer.index.errorFetchingFieldStatisticsMessage": "フィールド統計情報の取得エラー", - "xpack.dataVisualizer.index.fieldNameDescription.booleanField": "TrueおよびFalse値", - "xpack.dataVisualizer.index.fieldNameDescription.conflictField": "フィールドには異なる型の値があります。［管理 > データビュー］で解決してください。", - "xpack.dataVisualizer.index.fieldNameDescription.dateField": "日付文字列、または1/1/1970以降の秒またはミリ秒の数値", - "xpack.dataVisualizer.index.fieldNameDescription.dateRangeFieldLinkText": "日付", - "xpack.dataVisualizer.index.fieldNameDescription.geoPointField": "緯度および経度点", - "xpack.dataVisualizer.index.fieldNameDescription.geoShapeField": "多角形などの複雑な図形", - "xpack.dataVisualizer.index.fieldNameDescription.histogramField": "ヒストグラムの形式の集計された数値", - "xpack.dataVisualizer.index.fieldNameDescription.ipAddressField": "IPv4およびIPv6アドレス", - "xpack.dataVisualizer.index.fieldNameDescription.ipAddressRangeField": "IPv4またはIPv6（または混合）のアドレスをサポートするIP値の範囲", - "xpack.dataVisualizer.index.fieldNameDescription.keywordField": "ID、電子メールアドレス、ホスト名、ステータスコード、タグなどの構造化されたコンテンツ", - "xpack.dataVisualizer.index.fieldNameDescription.murmur3Field": "値のハッシュタグを計算して格納するフィールド", - "xpack.dataVisualizer.index.fieldNameDescription.nestedField": "サブフィールド間の関係を保持するJSONオブジェクト", - "xpack.dataVisualizer.index.fieldNameDescription.numberField": "長整数、整数、短整数、バイト、倍精度浮動小数点数、浮動小数点数の値", - "xpack.dataVisualizer.index.fieldNameDescription.stringField": "電子メール本文や製品説明などの全文テキスト", - "xpack.dataVisualizer.index.fieldNameDescription.textField": "電子メール本文や製品説明などの全文テキスト", - "xpack.dataVisualizer.index.fieldNameDescription.unknownField": "不明なフィールド", - "xpack.dataVisualizer.index.fieldNameDescription.viewSupportedDateFormatsLinkText": "サポートされている日付形式を表示します。", "xpack.dataVisualizer.index.fieldNameSelect": "フィールド名", "xpack.dataVisualizer.index.fieldTypeSelect": "フィールド型", "xpack.dataVisualizer.index.lensChart.countLabel": "カウント", @@ -20636,10 +20600,7 @@ "xpack.maps.layerPanel.filterEditor.isLayerFilterNotApplied": "特徴量の編集中には、レイヤーフィルターは適用されません", "xpack.maps.layerPanel.filterEditor.queryBarSubmitButtonLabel": "フィルターを設定", "xpack.maps.layerPanel.filterEditor.title": "フィルタリング", - "xpack.maps.layerPanel.footer.cancelButtonLabel": "キャンセル", - "xpack.maps.layerPanel.footer.closeButtonLabel": "閉じる", "xpack.maps.layerPanel.footer.removeLayerButtonLabel": "レイヤーを削除", - "xpack.maps.layerPanel.footer.saveAndCloseButtonLabel": "保存して閉じる", "xpack.maps.layerPanel.join.applyGlobalQueryCheckboxLabel": "グローバル検索を結合に適用", "xpack.maps.layerPanel.join.applyGlobalTimeCheckboxLabel": "結合するグローバル時刻を適用", "xpack.maps.layerPanel.join.deleteJoinAriaLabel": "ジョブの削除", @@ -20726,8 +20687,6 @@ "xpack.maps.mapSettingsPanel.autoFitToDataBoundsLabel": "自動的にマップをデータ境界に合わせる", "xpack.maps.mapSettingsPanel.backgroundColorLabel": "背景色", "xpack.maps.mapSettingsPanel.browserLocationLabel": "ブラウザーの位置情報", - "xpack.maps.mapSettingsPanel.cancelLabel": "キャンセル", - "xpack.maps.mapSettingsPanel.closeLabel": "閉じる", "xpack.maps.mapSettingsPanel.customIcons.emptyState.description": "このマップのレイヤーで使用できるカスタムアイコンを追加します。", "xpack.maps.mapSettingsPanel.customIconsAddIconButton": "追加", "xpack.maps.mapSettingsPanel.customIconsTitle": "カスタムアイコン", @@ -20737,7 +20696,6 @@ "xpack.maps.mapSettingsPanel.initialLatLabel": "緯度初期値", "xpack.maps.mapSettingsPanel.initialLonLabel": "経度初期値", "xpack.maps.mapSettingsPanel.initialZoomLabel": "ズーム初期値", - "xpack.maps.mapSettingsPanel.keepChangesButtonLabel": "変更を保持", "xpack.maps.mapSettingsPanel.lastSavedLocationLabel": "保存時のマップ位置情報", "xpack.maps.mapSettingsPanel.navigationTitle": "ナビゲーション", "xpack.maps.mapSettingsPanel.showScaleLabel": "縮尺を表示", @@ -25930,8 +25888,6 @@ "xpack.observability.page_header.addUptimeDataLink.label": "アップタイムデータの追加に関するチュートリアルに移動", "xpack.observability.page_header.addUXDataLink.label": "ユーザーエクスペリエンスAPMデータの追加に関するチュートリアルに移動", "xpack.observability.pageLayout.sideNavTitle": "Observability", - "xpack.observability.pages.alertDetails.alertSummary.duration": "期間", - "xpack.observability.pages.alertDetails.alertSummary.lastStatusUpdate": "前回のステータス更新", "xpack.observability.profilingElasticsearchPlugin": "Elasticsearchプロファイラープラグインを使用", "xpack.observability.resources.documentation": "ドキュメント", "xpack.observability.resources.forum": "ディスカッションフォーラム", diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json index 0f1e4bfbc2a8d..4d688bf73539c 100644 --- a/x-pack/plugins/translations/translations/zh-CN.json +++ b/x-pack/plugins/translations/translations/zh-CN.json @@ -10816,8 +10816,6 @@ "xpack.dataVisualizer.index.dataLoader.internalServerErrorMessage": "加载索引 {index} 中的数据时出错。{message}。请求可能已超时。请尝试使用较小的样例大小或缩小时间范围。", "xpack.dataVisualizer.index.dataViewNotBasedOnTimeSeriesNotificationTitle": "数据视图 {dataViewTitle} 并非基于时间序列", "xpack.dataVisualizer.index.errorLoadingDataMessage": "加载索引 {index} 中的数据时出错。{message}。", - "xpack.dataVisualizer.index.fieldNameDescription.dateRangeField": "{dateFieldTypeLink} 值的范围。{viewSupportedDateFormatsLink}", - "xpack.dataVisualizer.index.fieldNameDescription.versionField": "软件版本。支持 {SemanticVersioningLink} 优先规则", "xpack.dataVisualizer.index.lensChart.averageOfLabel": "{fieldName} 的平均值", "xpack.dataVisualizer.index.lensChart.chartTitle": "{fieldName} 的 Lens", "xpack.dataVisualizer.index.savedSearchErrorMessage": "检索已保存搜索 {savedSearchId} 时出错", @@ -10882,22 +10880,6 @@ "xpack.dataVisualizer.fieldStats.maxTitle": "最大值", "xpack.dataVisualizer.fieldStats.medianTitle": "中值", "xpack.dataVisualizer.fieldStats.minTitle": "最小值", - "xpack.dataVisualizer.fieldTypeIcon.booleanTypeLabel": "布尔型", - "xpack.dataVisualizer.fieldTypeIcon.conflictTypeLabel": "冲突", - "xpack.dataVisualizer.fieldTypeIcon.dateRangeTypeLabel": "日期范围", - "xpack.dataVisualizer.fieldTypeIcon.dateTypeLabel": "日期", - "xpack.dataVisualizer.fieldTypeIcon.geoPointTypeLabel": "地理点", - "xpack.dataVisualizer.fieldTypeIcon.geoShapeTypeLabel": "几何形状", - "xpack.dataVisualizer.fieldTypeIcon.histogramTypeLabel": "直方图", - "xpack.dataVisualizer.fieldTypeIcon.ipRangeTypeLabel": "IP 范围", - "xpack.dataVisualizer.fieldTypeIcon.ipTypeLabel": "IP", - "xpack.dataVisualizer.fieldTypeIcon.keywordTypeLabel": "关键字", - "xpack.dataVisualizer.fieldTypeIcon.murmur3TypeLabel": "Murmur3", - "xpack.dataVisualizer.fieldTypeIcon.numberTypeLabel": "数字", - "xpack.dataVisualizer.fieldTypeIcon.stringTypeLabel": "字符串", - "xpack.dataVisualizer.fieldTypeIcon.textTypeLabel": "文本", - "xpack.dataVisualizer.fieldTypeIcon.unknownTypeLabel": "未知", - "xpack.dataVisualizer.fieldTypeIcon.versionTypeLabel": "版本", "xpack.dataVisualizer.fieldTypeSelect": "字段类型", "xpack.dataVisualizer.fieldTypesPopover.buttonAriaLabel": "筛选类型帮助", "xpack.dataVisualizer.fieldTypesPopover.dataTypeColumnTitle": "数据类型", @@ -11041,7 +11023,6 @@ "xpack.dataVisualizer.index.actionsPanel.discoverAppTitle": "Discover", "xpack.dataVisualizer.index.actionsPanel.exploreTitle": "浏览您的数据", "xpack.dataVisualizer.index.actionsPanel.viewIndexInDiscoverDescription": "浏览您的索引中的文档。", - "xpack.dataVisualizer.index.advancedSettings.discover.fieldNameDescription.versionFieldLinkText": "语义版本控制", "xpack.dataVisualizer.index.components.grid.description": "可视化数据", "xpack.dataVisualizer.index.components.grid.displayName": "数据可视化工具网格", "xpack.dataVisualizer.index.dataGrid.actionsColumnLabel": "操作", @@ -11062,23 +11043,6 @@ "xpack.dataVisualizer.index.embeddableErrorTitle": "加载可嵌入对象时出错", "xpack.dataVisualizer.index.embeddableNoResultsMessage": "找不到结果", "xpack.dataVisualizer.index.errorFetchingFieldStatisticsMessage": "提取字段统计信息时出错", - "xpack.dataVisualizer.index.fieldNameDescription.booleanField": "True 和 False 值", - "xpack.dataVisualizer.index.fieldNameDescription.conflictField": "字体具有不同类型的值。在“管理”>“数据视图”中解析。", - "xpack.dataVisualizer.index.fieldNameDescription.dateField": "日期字符串或 1/1/1970 以来的秒数或毫秒数", - "xpack.dataVisualizer.index.fieldNameDescription.dateRangeFieldLinkText": "日期", - "xpack.dataVisualizer.index.fieldNameDescription.geoPointField": "纬度和经度点", - "xpack.dataVisualizer.index.fieldNameDescription.geoShapeField": "复杂形状，如多边形", - "xpack.dataVisualizer.index.fieldNameDescription.histogramField": "直方图形式的预聚合数字值", - "xpack.dataVisualizer.index.fieldNameDescription.ipAddressField": "IPv4 和 IPv6 地址", - "xpack.dataVisualizer.index.fieldNameDescription.ipAddressRangeField": "支持 IPv4 或 IPv6（或混合）地址的 IP 值的范围", - "xpack.dataVisualizer.index.fieldNameDescription.keywordField": "结构化内容，如 ID、电子邮件地址、主机名、状态代码或标签", - "xpack.dataVisualizer.index.fieldNameDescription.murmur3Field": "计算和存储值哈希的字段", - "xpack.dataVisualizer.index.fieldNameDescription.nestedField": "保留其子字段之间关系的 JSON 对象", - "xpack.dataVisualizer.index.fieldNameDescription.numberField": "长整型、整数、短整型、字节、双精度和浮点值", - "xpack.dataVisualizer.index.fieldNameDescription.stringField": "全文本，如电子邮件正文或产品描述", - "xpack.dataVisualizer.index.fieldNameDescription.textField": "全文本，如电子邮件正文或产品描述", - "xpack.dataVisualizer.index.fieldNameDescription.unknownField": "未知字段", - "xpack.dataVisualizer.index.fieldNameDescription.viewSupportedDateFormatsLinkText": "查看支持的日期格式。", "xpack.dataVisualizer.index.fieldNameSelect": "字段名称", "xpack.dataVisualizer.index.fieldTypeSelect": "字段类型", "xpack.dataVisualizer.index.lensChart.countLabel": "计数", @@ -20636,10 +20600,7 @@ "xpack.maps.layerPanel.filterEditor.isLayerFilterNotApplied": "编辑特征时不会应用图层筛选", "xpack.maps.layerPanel.filterEditor.queryBarSubmitButtonLabel": "设置筛选", "xpack.maps.layerPanel.filterEditor.title": "筛选", - "xpack.maps.layerPanel.footer.cancelButtonLabel": "取消", - "xpack.maps.layerPanel.footer.closeButtonLabel": "关闭", "xpack.maps.layerPanel.footer.removeLayerButtonLabel": "移除图层", - "xpack.maps.layerPanel.footer.saveAndCloseButtonLabel": "保存并关闭", "xpack.maps.layerPanel.join.applyGlobalQueryCheckboxLabel": "应用全局搜索到联接", "xpack.maps.layerPanel.join.applyGlobalTimeCheckboxLabel": "应用全局时间到联接", "xpack.maps.layerPanel.join.deleteJoinAriaLabel": "删除联接", @@ -20726,8 +20687,6 @@ "xpack.maps.mapSettingsPanel.autoFitToDataBoundsLabel": "使地图自动适应数据边界", "xpack.maps.mapSettingsPanel.backgroundColorLabel": "背景色", "xpack.maps.mapSettingsPanel.browserLocationLabel": "浏览器位置", - "xpack.maps.mapSettingsPanel.cancelLabel": "取消", - "xpack.maps.mapSettingsPanel.closeLabel": "关闭", "xpack.maps.mapSettingsPanel.customIcons.emptyState.description": "添加可用在此地图的图层中的定制图标。", "xpack.maps.mapSettingsPanel.customIconsAddIconButton": "添加", "xpack.maps.mapSettingsPanel.customIconsTitle": "定制图标", @@ -20737,7 +20696,6 @@ "xpack.maps.mapSettingsPanel.initialLatLabel": "初始纬度", "xpack.maps.mapSettingsPanel.initialLonLabel": "初始经度", "xpack.maps.mapSettingsPanel.initialZoomLabel": "初始缩放", - "xpack.maps.mapSettingsPanel.keepChangesButtonLabel": "保留更改", "xpack.maps.mapSettingsPanel.lastSavedLocationLabel": "保存时的地图位置", "xpack.maps.mapSettingsPanel.navigationTitle": "导航", "xpack.maps.mapSettingsPanel.showScaleLabel": "显示比例", @@ -25946,8 +25904,6 @@ "xpack.observability.page_header.addUptimeDataLink.label": "导航到有关如何添加 Uptime 数据的教程", "xpack.observability.page_header.addUXDataLink.label": "导航到有关如何添加用户体验 APM 数据的教程", "xpack.observability.pageLayout.sideNavTitle": "Observability", - "xpack.observability.pages.alertDetails.alertSummary.duration": "持续时间", - "xpack.observability.pages.alertDetails.alertSummary.lastStatusUpdate": "上次状态更新", "xpack.observability.profilingElasticsearchPlugin": "使用 Elasticsearch 分析器插件", "xpack.observability.resources.documentation": "文档", "xpack.observability.resources.forum": "讨论论坛", diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/alert_summary_widget.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/alert_summary_widget.test.tsx index 17eb584a982c1..a04fe6ed70eb8 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/alert_summary_widget.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/alert_summary_widget.test.tsx @@ -12,6 +12,10 @@ import { AlertSummaryWidget } from './alert_summary_widget'; import { AlertSummaryWidgetProps } from './types'; import { mockedAlertSummaryTimeRange, mockedChartProps } from '../../mock/alert_summary_widget'; import { useLoadAlertSummary } from '../../hooks/use_load_alert_summary'; +import { + ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ, + TOTAL_ALERT_COUNT_DATA_TEST_SUBJ, +} from './components/constants'; jest.mock('@kbn/kibana-react-plugin/public/ui_settings/use_ui_setting', () => ({ useUiSetting: jest.fn().mockImplementation(() => true), @@ -66,8 +70,12 @@ describe('AlertSummaryWidget', () => { it('should render counts and title correctly', async () => { const alertSummaryWidget = renderComponent(); - expect(alertSummaryWidget.queryByTestId('activeAlertsCount')).toHaveTextContent('1'); - expect(alertSummaryWidget.queryByTestId('totalAlertsCount')).toHaveTextContent('8'); + expect(alertSummaryWidget.queryByTestId(ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '1' + ); + expect(alertSummaryWidget.queryByTestId(TOTAL_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '8' + ); expect(alertSummaryWidget.queryByTestId(TITLE_DATA_TEST_SUBJ)).toBeTruthy(); }); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/active_alert_counts.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/active_alert_counts.tsx index 0d72f0d4033bb..53b8990b0f698 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/active_alert_counts.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/active_alert_counts.tsx @@ -8,7 +8,11 @@ import React from 'react'; import numeral from '@elastic/numeral'; import { EuiIcon, EuiText, useEuiTheme } from '@elastic/eui'; -import { ACTIVE_NOW_LABEL, ALERT_COUNT_FORMAT } from './constants'; +import { + ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ, + ACTIVE_NOW_LABEL, + ALERT_COUNT_FORMAT, +} from './constants'; interface Props { activeAlertCount: number; @@ -22,7 +26,7 @@ export const ActiveAlertCounts = ({ activeAlertCount }: Props) => { -

+

{numeral(activeAlertCount).format(ALERT_COUNT_FORMAT)} {!!activeAlertCount && ( <> diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/alert_summary_widget_compact.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/alert_summary_widget_compact.test.tsx index 2dee4c3dcb705..58abc8299677b 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/alert_summary_widget_compact.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/alert_summary_widget_compact.test.tsx @@ -13,6 +13,7 @@ import { } from './alert_summary_widget_compact'; import { render } from '@testing-library/react'; import { mockedAlertSummaryResponse, mockedChartProps } from '../../../mock/alert_summary_widget'; +import { ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ, TOTAL_ALERT_COUNT_DATA_TEST_SUBJ } from './constants'; describe('AlertSummaryWidgetCompact', () => { const renderComponent = (props: Partial = {}) => @@ -36,8 +37,12 @@ describe('AlertSummaryWidgetCompact', () => { it('should render counts correctly', async () => { const alertSummaryWidget = renderComponent(); - expect(alertSummaryWidget.queryByTestId('activeAlertsCount')).toHaveTextContent('2'); - expect(alertSummaryWidget.queryByTestId('totalAlertsCount')).toHaveTextContent('22'); + expect(alertSummaryWidget.queryByTestId(ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '2' + ); + expect(alertSummaryWidget.queryByTestId(TOTAL_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '22' + ); }); it('should render higher counts correctly', async () => { @@ -45,7 +50,11 @@ describe('AlertSummaryWidgetCompact', () => { activeAlertCount: 2000, }); - expect(alertSummaryWidget.queryByTestId('activeAlertsCount')).toHaveTextContent('2k'); - expect(alertSummaryWidget.queryByTestId('totalAlertsCount')).toHaveTextContent('2.02k'); + expect(alertSummaryWidget.queryByTestId(ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '2k' + ); + expect(alertSummaryWidget.queryByTestId(TOTAL_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '2.02k' + ); }); }); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/alert_summary_widget_full_size.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/alert_summary_widget_full_size.test.tsx index 3dca2312274e3..ecdbd906fc156 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/alert_summary_widget_full_size.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/alert_summary_widget_full_size.test.tsx @@ -6,13 +6,14 @@ */ import React from 'react'; +import { render } from '@testing-library/react'; import { __IntlProvider as IntlProvider } from '@kbn/i18n-react'; +import { mockedAlertSummaryResponse, mockedChartProps } from '../../../mock/alert_summary_widget'; import { AlertSummaryWidgetFullSize, AlertSummaryWidgetFullSizeProps, } from './alert_summary_widget_full_size'; -import { render } from '@testing-library/react'; -import { mockedAlertSummaryResponse, mockedChartProps } from '../../../mock/alert_summary_widget'; +import { ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ, TOTAL_ALERT_COUNT_DATA_TEST_SUBJ } from './constants'; describe('AlertSummaryWidgetFullSize', () => { const renderComponent = (props: Partial = {}) => @@ -35,8 +36,12 @@ describe('AlertSummaryWidgetFullSize', () => { it('should render counts correctly', async () => { const alertSummaryWidget = renderComponent(); - expect(alertSummaryWidget.queryByTestId('activeAlertsCount')).toHaveTextContent('2'); - expect(alertSummaryWidget.queryByTestId('totalAlertsCount')).toHaveTextContent('22'); + expect(alertSummaryWidget.queryByTestId(ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '2' + ); + expect(alertSummaryWidget.queryByTestId(TOTAL_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '22' + ); }); it('should render higher counts correctly', async () => { @@ -44,7 +49,11 @@ describe('AlertSummaryWidgetFullSize', () => { activeAlertCount: 2000, }); - expect(alertSummaryWidget.queryByTestId('activeAlertsCount')).toHaveTextContent('2k'); - expect(alertSummaryWidget.queryByTestId('totalAlertsCount')).toHaveTextContent('2.02k'); + expect(alertSummaryWidget.queryByTestId(ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '2k' + ); + expect(alertSummaryWidget.queryByTestId(TOTAL_ALERT_COUNT_DATA_TEST_SUBJ)).toHaveTextContent( + '2.02k' + ); }); }); diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/all_alert_counts.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/all_alert_counts.tsx index 041d3a355814d..a29dfbeaf135b 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/all_alert_counts.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/all_alert_counts.tsx @@ -8,7 +8,12 @@ import React from 'react'; import numeral from '@elastic/numeral'; import { EuiText } from '@elastic/eui'; -import { ALERT_COUNT_FORMAT, ALERTS_LABEL, ALL_ALERT_COLOR } from './constants'; +import { + ALERT_COUNT_FORMAT, + ALERTS_LABEL, + ALL_ALERT_COLOR, + TOTAL_ALERT_COUNT_DATA_TEST_SUBJ, +} from './constants'; interface Props { count: number; @@ -18,7 +23,9 @@ export const AllAlertCounts = ({ count }: Props) => { return ( <> -

{numeral(count).format(ALERT_COUNT_FORMAT)}

+

+ {numeral(count).format(ALERT_COUNT_FORMAT)} +

{ALERTS_LABEL} diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/constants.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/constants.tsx index fba6db3ca713f..7f4aa84e563c3 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/constants.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/alert_summary_widget/components/constants.tsx @@ -12,6 +12,9 @@ import React from 'react'; export const TOOLTIP_DATE_FORMAT = 'YYYY-MM-DD HH:mm'; export const ALERT_COUNT_FORMAT = '0.[00]a'; +export const ACTIVE_ALERT_COUNT_DATA_TEST_SUBJ = 'activeAlertCount'; +export const TOTAL_ALERT_COUNT_DATA_TEST_SUBJ = 'totalAlertCount'; + const visColors = euiPaletteColorBlind(); export const ALL_ALERT_COLOR = visColors[1]; diff --git a/x-pack/plugins/triggers_actions_ui/public/common/expression_items/of.tsx b/x-pack/plugins/triggers_actions_ui/public/common/expression_items/of.tsx index e5958a835bac4..ffdbe320b0e52 100644 --- a/x-pack/plugins/triggers_actions_ui/public/common/expression_items/of.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/common/expression_items/of.tsx @@ -17,7 +17,7 @@ import { EuiComboBox, } from '@elastic/eui'; import { builtInAggregationTypes } from '../constants'; -import { AggregationType, FieldOption } from '../types'; +import { AggregationType, FieldOption, ValidNormalizedTypes } from '../types'; import { IErrorObject } from '../../types'; import { ClosablePopoverTitle } from './components'; import './of.scss'; @@ -76,7 +76,11 @@ export const OfExpression = ({ const availableFieldOptions: OfFieldOption[] = fields.reduce( (esFieldOptions: OfFieldOption[], field: FieldOption) => { - if (aggregationTypes[aggType].validNormalizedTypes.includes(field.normalizedType)) { + if ( + aggregationTypes[aggType].validNormalizedTypes.includes( + field.normalizedType as ValidNormalizedTypes + ) + ) { esFieldOptions.push({ label: field.name, }); diff --git a/x-pack/plugins/triggers_actions_ui/public/common/index.ts b/x-pack/plugins/triggers_actions_ui/public/common/index.ts index 8c9e6a6645a48..4cf4f8c855d4e 100644 --- a/x-pack/plugins/triggers_actions_ui/public/common/index.ts +++ b/x-pack/plugins/triggers_actions_ui/public/common/index.ts @@ -25,7 +25,14 @@ export { connectorDeprecatedMessage, deprecatedMessage } from './connectors_sele export type { IOption } from './index_controls'; export { getFields, getIndexOptions, firstFieldOption } from './index_controls'; export { getTimeFieldOptions, useKibana } from './lib'; -export type { Comparator, AggregationType, GroupByType, RuleStatus, FieldOption } from './types'; +export type { + Comparator, + AggregationType, + GroupByType, + RuleStatus, + FieldOption, + ValidNormalizedTypes, +} from './types'; export { BUCKET_SELECTOR_FIELD, buildAggregation, diff --git a/x-pack/plugins/triggers_actions_ui/public/common/types.ts b/x-pack/plugins/triggers_actions_ui/public/common/types.ts index dca32f32547ee..2bf6d601ff476 100644 --- a/x-pack/plugins/triggers_actions_ui/public/common/types.ts +++ b/x-pack/plugins/triggers_actions_ui/public/common/types.ts @@ -5,17 +5,29 @@ * 2.0. */ +import { KBN_FIELD_TYPES } from '@kbn/field-types'; + export interface Comparator { text: string; value: string; requiredValues: number; } +export type ValidNormalizedTypes = `${Exclude< + KBN_FIELD_TYPES, + | KBN_FIELD_TYPES.UNKNOWN + | KBN_FIELD_TYPES.MISSING + | KBN_FIELD_TYPES._SOURCE + | KBN_FIELD_TYPES.ATTACHMENT + | KBN_FIELD_TYPES.CONFLICT + | KBN_FIELD_TYPES.NESTED +>}`; + export interface AggregationType { text: string; fieldRequired: boolean; value: string; - validNormalizedTypes: string[]; + validNormalizedTypes: ValidNormalizedTypes[]; } export interface GroupByType { diff --git a/x-pack/plugins/triggers_actions_ui/public/index.ts b/x-pack/plugins/triggers_actions_ui/public/index.ts index 43bc6535df87a..d3cf89286ad96 100644 --- a/x-pack/plugins/triggers_actions_ui/public/index.ts +++ b/x-pack/plugins/triggers_actions_ui/public/index.ts @@ -100,7 +100,7 @@ export function plugin(context: PluginInitializerContext) { } export { useKibana } from './common'; -export type { AggregationType, Comparator } from './common'; +export type { AggregationType, Comparator, ValidNormalizedTypes } from './common'; export { WhenExpression, diff --git a/x-pack/plugins/triggers_actions_ui/tsconfig.json b/x-pack/plugins/triggers_actions_ui/tsconfig.json index 3394c7100fba6..1df56579e7291 100644 --- a/x-pack/plugins/triggers_actions_ui/tsconfig.json +++ b/x-pack/plugins/triggers_actions_ui/tsconfig.json @@ -49,6 +49,7 @@ "@kbn/alerts-ui-shared", "@kbn/safer-lodash-set", "@kbn/cases-components", + "@kbn/field-types", "@kbn/ecs", "@kbn/alerts-as-data-utils" ], diff --git a/x-pack/plugins/upgrade_assistant/server/routes/node_disk_space.test.ts b/x-pack/plugins/upgrade_assistant/server/routes/node_disk_space.test.ts index e300033f800ba..315c2537afa15 100644 --- a/x-pack/plugins/upgrade_assistant/server/routes/node_disk_space.test.ts +++ b/x-pack/plugins/upgrade_assistant/server/routes/node_disk_space.test.ts @@ -113,7 +113,7 @@ describe('Disk space API', () => { .getSettings as jest.Mock ).mockResolvedValue({ defaults: {}, - transient: { 'cluster.routing.allocation.disk.watermark.low': '80%' }, + transient: { 'cluster.routing.allocation.disk.watermark.low': '79%' }, persistent: { 'cluster.routing.allocation.disk.watermark.low': '85%' }, }); @@ -128,7 +128,7 @@ describe('Disk space API', () => { nodeName: 'node_name', nodeId: '1YOaoS9lTNOiTxR1uzSgRA', available: '20%', - lowDiskWatermarkSetting: '80%', + lowDiskWatermarkSetting: '79%', }, ]); }); @@ -186,7 +186,7 @@ describe('Disk space API', () => { .getSettings as jest.Mock ).mockResolvedValue({ defaults: { - 'cluster.routing.allocation.disk.watermark.low': '10%', + 'cluster.routing.allocation.disk.watermark.low': '85%', }, transient: {}, persistent: {}, diff --git a/x-pack/plugins/upgrade_assistant/server/routes/node_disk_space.ts b/x-pack/plugins/upgrade_assistant/server/routes/node_disk_space.ts index 3707bee0f1395..5f275be8b5d73 100644 --- a/x-pack/plugins/upgrade_assistant/server/routes/node_disk_space.ts +++ b/x-pack/plugins/upgrade_assistant/server/routes/node_disk_space.ts @@ -88,9 +88,10 @@ export function registerNodeDiskSpaceRoute({ router, lib: { handleEsError } }: R const rawLowDiskWatermarkPercentageValue = Number( lowDiskWatermarkSetting!.replace('%', '') ); + // ES interprets this setting as a threshold for used disk space; we want free disk space + const freeDiskSpaceAllocated = 100 - rawLowDiskWatermarkPercentageValue; - // If the percentage available is < the low disk watermark setting, mark node as having low disk space - if (percentageAvailable < rawLowDiskWatermarkPercentageValue) { + if (percentageAvailable < freeDiskSpaceAllocated) { nodesWithLowDiskSpace.push({ nodeId, nodeName: node.name || nodeId, diff --git a/x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx b/x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx index 6ed203a65b86e..00c4c2be6d3e0 100644 --- a/x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx +++ b/x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx @@ -9,6 +9,7 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; import { EuiFlexGroup, EuiTitle, EuiFlexItem } from '@elastic/eui'; import type { NoDataConfig } from '@kbn/shared-ux-page-kibana-template'; +import { EuiSpacer } from '@elastic/eui'; import { WebApplicationSelect } from './panels/web_application_select'; import { UserPercentile } from './user_percentile'; import { useBreakpoints } from '../../../hooks/use_breakpoints'; @@ -86,6 +87,7 @@ function PageHeader() { + diff --git a/x-pack/plugins/ux/public/components/app/rum_dashboard/ux_overview_fetchers.ts b/x-pack/plugins/ux/public/components/app/rum_dashboard/ux_overview_fetchers.ts index c7c05dd93d4eb..e67a78cf8760e 100644 --- a/x-pack/plugins/ux/public/components/app/rum_dashboard/ux_overview_fetchers.ts +++ b/x-pack/plugins/ux/public/components/app/rum_dashboard/ux_overview_fetchers.ts @@ -109,17 +109,23 @@ async function esQuery( dataStartPlugin: DataPublicPluginStart, query: IKibanaSearchRequest & { params: { index?: string } } ) { - return new Promise>((resolve, reject) => { - const search$ = dataStartPlugin.search.search(query).subscribe({ - next: (result) => { - if (isCompleteResponse(result)) { - resolve(result.rawResponse as any); - search$.unsubscribe(); - } - }, - error: (err) => { - reject(err); - }, - }); - }); + return new Promise>( + (resolve, reject) => { + const search$ = dataStartPlugin.search + .search(query, { + legacyHitsTotal: false, + }) + .subscribe({ + next: (result) => { + if (isCompleteResponse(result)) { + resolve(result.rawResponse as any); + search$.unsubscribe(); + } + }, + error: (err) => { + reject(err); + }, + }); + } + ); } diff --git a/x-pack/plugins/ux/public/services/data/core_web_vitals_query.ts b/x-pack/plugins/ux/public/services/data/core_web_vitals_query.ts index 75970a99cba03..5636755a314bb 100644 --- a/x-pack/plugins/ux/public/services/data/core_web_vitals_query.ts +++ b/x-pack/plugins/ux/public/services/data/core_web_vitals_query.ts @@ -31,7 +31,11 @@ const getRanksPercentages = (ranks?: Record) => { }; export function transformCoreWebVitalsResponse( - response?: ESSearchResponse>, + response?: ESSearchResponse< + T, + ReturnType, + { restTotalHitsAsInt: false } + >, percentile = PERCENTILE_DEFAULT ): UXMetrics | undefined { if (!response) return response; diff --git a/x-pack/plugins/ux/public/services/data/has_rum_data_query.ts b/x-pack/plugins/ux/public/services/data/has_rum_data_query.ts index 91710cecf0c88..487c67c17b9ef 100644 --- a/x-pack/plugins/ux/public/services/data/has_rum_data_query.ts +++ b/x-pack/plugins/ux/public/services/data/has_rum_data_query.ts @@ -16,7 +16,11 @@ import { TRANSACTION_PAGE_LOAD } from '../../../common/transaction_types'; import { rangeQuery } from './range_query'; export function formatHasRumResult( - esResult: ESSearchResponse>, + esResult: ESSearchResponse< + T, + ReturnType, + { restTotalHitsAsInt: false } + >, indices?: string ) { if (!esResult) return esResult; diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/alerting/alerts.ts b/x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/alerting/alerts.ts index d817b0b262805..7b5f41f4448d2 100644 --- a/x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/alerting/alerts.ts +++ b/x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/alerting/alerts.ts @@ -47,7 +47,7 @@ export default function alertTests({ getService }: FtrProviderContext) { after(async () => { await esTestIndexTool.destroy(); await es.indices.delete({ index: authorizationIndex }); - await es.indices.delete({ index: alertAsDataIndex }); + await es.deleteByQuery({ index: alertAsDataIndex, query: { match_all: {} } }); }); for (const scenario of UserAtSpaceScenarios) { diff --git a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/group1/aggregate.ts b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/group1/aggregate.ts index 52d3907eb88d0..24accca387f47 100644 --- a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/group1/aggregate.ts +++ b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/group1/aggregate.ts @@ -14,7 +14,8 @@ import { FtrProviderContext } from '../../../../common/ftr_provider_context'; export default function createAggregateTests({ getService }: FtrProviderContext) { const supertest = getService('supertest'); - describe('aggregate', () => { + // Failing: See https://github.com/elastic/kibana/issues/150772 + describe.skip('aggregate', () => { const objectRemover = new ObjectRemover(supertest); afterEach(() => objectRemover.removeAll()); diff --git a/x-pack/test/api_integration/apis/asset_manager/tests/assets.ts b/x-pack/test/api_integration/apis/asset_manager/tests/assets.ts index c3f0a7e8f3668..d99fdf9a9746b 100644 --- a/x-pack/test/api_integration/apis/asset_manager/tests/assets.ts +++ b/x-pack/test/api_integration/apis/asset_manager/tests/assets.ts @@ -11,6 +11,7 @@ import { FtrProviderContext } from '../../../ftr_provider_context'; import { createSampleAssets, deleteSampleAssets, viewSampleAssetDocs } from '../helpers'; const ASSETS_ENDPOINT = '/api/asset-manager/assets'; +const DIFF_ENDPOINT = ASSETS_ENDPOINT + '/diff'; export default function ({ getService }: FtrProviderContext) { const supertest = getService('supertest'); @@ -179,5 +180,137 @@ export default function ({ getService }: FtrProviderContext) { expect(getResponse.body.results).to.eql(targetAssets); }); }); + + describe('GET /assets/diff', () => { + it('should reject requests that do not include the two time ranges to compare', async () => { + const timestamp = new Date().toISOString(); + + let getResponse = await supertest.get(DIFF_ENDPOINT).expect(400); + expect(getResponse.body.message).to.equal( + '[request query.aFrom]: expected value of type [string] but got [undefined]' + ); + + getResponse = await supertest.get(DIFF_ENDPOINT).query({ aFrom: timestamp }).expect(400); + expect(getResponse.body.message).to.equal( + '[request query.aTo]: expected value of type [string] but got [undefined]' + ); + + getResponse = await supertest + .get(DIFF_ENDPOINT) + .query({ aFrom: timestamp, aTo: timestamp }) + .expect(400); + expect(getResponse.body.message).to.equal( + '[request query.bFrom]: expected value of type [string] but got [undefined]' + ); + + getResponse = await supertest + .get(DIFF_ENDPOINT) + .query({ aFrom: timestamp, aTo: timestamp, bFrom: timestamp }) + .expect(400); + expect(getResponse.body.message).to.equal( + '[request query.bTo]: expected value of type [string] but got [undefined]' + ); + + await supertest + .get(DIFF_ENDPOINT) + .query({ aFrom: timestamp, aTo: timestamp, bFrom: timestamp, bTo: timestamp }) + .expect(200); + }); + + it('should reject requests where either time range is moving backwards in time', async () => { + const now = new Date(); + const isoNow = now.toISOString(); + const oneHourAgo = new Date(now.getTime() - 1000 * 60 * 60 * 1).toISOString(); + + let getResponse = await supertest + .get(DIFF_ENDPOINT) + .query({ + aFrom: isoNow, + aTo: oneHourAgo, + bFrom: isoNow, + bTo: isoNow, + }) + .expect(400); + expect(getResponse.body.message).to.equal( + `Time range cannot move backwards in time. "aTo" (${oneHourAgo}) is before "aFrom" (${isoNow}).` + ); + + getResponse = await supertest + .get(DIFF_ENDPOINT) + .query({ + aFrom: isoNow, + aTo: isoNow, + bFrom: isoNow, + bTo: oneHourAgo, + }) + .expect(400); + expect(getResponse.body.message).to.equal( + `Time range cannot move backwards in time. "bTo" (${oneHourAgo}) is before "bFrom" (${isoNow}).` + ); + + await supertest + .get(DIFF_ENDPOINT) + .query({ + aFrom: oneHourAgo, + aTo: isoNow, + bFrom: oneHourAgo, + bTo: isoNow, + }) + .expect(200); + }); + + it('should return the difference in assets present between two time ranges', async () => { + const onlyInA = sampleAssetDocs.slice(0, 2); + const onlyInB = sampleAssetDocs.slice(sampleAssetDocs.length - 2); + const inBoth = sampleAssetDocs.slice(2, sampleAssetDocs.length - 2); + const now = new Date(); + const oneHourAgo = new Date(now.getTime() - 1000 * 60 * 60 * 1); + const twoHoursAgo = new Date(now.getTime() - 1000 * 60 * 60 * 2); + await createSampleAssets(supertest, { + baseDateTime: twoHoursAgo.toISOString(), + excludeEans: inBoth.concat(onlyInB).map((asset) => asset['asset.ean']), + }); + await createSampleAssets(supertest, { + baseDateTime: oneHourAgo.toISOString(), + excludeEans: onlyInA.concat(onlyInB).map((asset) => asset['asset.ean']), + }); + await createSampleAssets(supertest, { + excludeEans: inBoth.concat(onlyInA).map((asset) => asset['asset.ean']), + }); + + const twoHoursAndTenMinuesAgo = new Date(now.getTime() - 1000 * 60 * 130 * 1); + const fiftyMinuesAgo = new Date(now.getTime() - 1000 * 60 * 50 * 1); + const seventyMinuesAgo = new Date(now.getTime() - 1000 * 60 * 70 * 1); + const tenMinutesAfterNow = new Date(now.getTime() + 1000 * 60 * 10); + + const getResponse = await supertest + .get(DIFF_ENDPOINT) + .query({ + aFrom: twoHoursAndTenMinuesAgo, + aTo: fiftyMinuesAgo, + bFrom: seventyMinuesAgo, + bTo: tenMinutesAfterNow, + }) + .expect(200); + + expect(getResponse.body).to.have.property('onlyInA'); + expect(getResponse.body).to.have.property('onlyInB'); + expect(getResponse.body).to.have.property('inBoth'); + + getResponse.body.onlyInA.forEach((asset: any) => { + delete asset['@timestamp']; + }); + getResponse.body.onlyInB.forEach((asset: any) => { + delete asset['@timestamp']; + }); + getResponse.body.inBoth.forEach((asset: any) => { + delete asset['@timestamp']; + }); + + expect(getResponse.body.onlyInA).to.eql(onlyInA); + expect(getResponse.body.onlyInB).to.eql(onlyInB); + expect(getResponse.body.inBoth).to.eql(inBoth); + }); + }); }); } diff --git a/x-pack/test/api_integration/apis/maps/maps_telemetry.ts b/x-pack/test/api_integration/apis/maps/maps_telemetry.ts index 1d63f8872776f..c953aff7000c5 100644 --- a/x-pack/test/api_integration/apis/maps/maps_telemetry.ts +++ b/x-pack/test/api_integration/apis/maps/maps_telemetry.ts @@ -30,8 +30,8 @@ export default function ({ getService }: FtrProviderContext) { return fieldStat.name === 'geo_point'; } ); - expect(geoPointFieldStats.count).to.be(7); - expect(geoPointFieldStats.index_count).to.be(6); + expect(geoPointFieldStats.count).to.be(39); + expect(geoPointFieldStats.index_count).to.be(10); const geoShapeFieldStats = apiResponse.cluster_stats.indices.mappings.field_types.find( (fieldStat: estypes.ClusterStatsFieldTypes) => { diff --git a/x-pack/test/api_integration/apis/security/index_fields.ts b/x-pack/test/api_integration/apis/security/index_fields.ts index 621a183182348..8fc9c36accd69 100644 --- a/x-pack/test/api_integration/apis/security/index_fields.ts +++ b/x-pack/test/api_integration/apis/security/index_fields.ts @@ -33,7 +33,7 @@ export default function ({ getService }: FtrProviderContext) { 'type', 'visualization.title', 'dashboard.title', - 'search.columns', + 'search.title', 'space.name', ]; diff --git a/x-pack/test/api_integration/apis/synthetics/add_monitor_project.ts b/x-pack/test/api_integration/apis/synthetics/add_monitor_project.ts index 4bc005c46596c..2dc99487a138e 100644 --- a/x-pack/test/api_integration/apis/synthetics/add_monitor_project.ts +++ b/x-pack/test/api_integration/apis/synthetics/add_monitor_project.ts @@ -144,7 +144,6 @@ export default function ({ getService }: FtrProviderContext) { expect(decryptedCreatedMonitor.body.attributes).to.eql({ __ui: { - is_zip_url_tls_enabled: false, script_source: { file_name: '', is_generated_script: false, @@ -189,11 +188,6 @@ export default function ({ getService }: FtrProviderContext) { }, screenshots: 'on', 'service.name': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', - 'source.zip_url.url': '', - 'source.zip_url.password': '', - 'source.zip_url.username': '', synthetics_args: [], tags: [], 'throttling.config': '5d/3u/20l', diff --git a/x-pack/test/api_integration/apis/synthetics/add_monitor_project_legacy.ts b/x-pack/test/api_integration/apis/synthetics/add_monitor_project_legacy.ts index ff0c1bbf0f9a1..b9b3d567c44aa 100644 --- a/x-pack/test/api_integration/apis/synthetics/add_monitor_project_legacy.ts +++ b/x-pack/test/api_integration/apis/synthetics/add_monitor_project_legacy.ts @@ -129,7 +129,6 @@ export default function ({ getService }: FtrProviderContext) { expect(decryptedCreatedMonitor.body.attributes).to.eql({ __ui: { - is_zip_url_tls_enabled: false, script_source: { file_name: '', is_generated_script: false, @@ -174,11 +173,6 @@ export default function ({ getService }: FtrProviderContext) { }, screenshots: 'on', 'service.name': '', - 'source.zip_url.folder': '', - 'source.zip_url.proxy_url': '', - 'source.zip_url.url': '', - 'source.zip_url.password': '', - 'source.zip_url.username': '', synthetics_args: [], tags: [], 'throttling.config': '5d/3u/20l', diff --git a/x-pack/test/api_integration/apis/synthetics/sample_data/test_browser_policy.ts b/x-pack/test/api_integration/apis/synthetics/sample_data/test_browser_policy.ts index f5acb0eef3f8c..0cebf231cf787 100644 --- a/x-pack/test/api_integration/apis/synthetics/sample_data/test_browser_policy.ts +++ b/x-pack/test/api_integration/apis/synthetics/sample_data/test_browser_policy.ts @@ -160,7 +160,7 @@ export const getTestBrowserSyntheticsPolicy = ({ vars: { __ui: { value: - '{"script_source":{"is_generated_script":false,"file_name":""},"is_zip_url_tls_enabled":false,"is_tls_enabled":false}', + '{"script_source":{"is_generated_script":false,"file_name":""},"is_tls_enabled":false}', type: 'yaml', }, enabled: { value: true, type: 'bool' }, @@ -170,10 +170,10 @@ export const getTestBrowserSyntheticsPolicy = ({ 'service.name': { value: '', type: 'text' }, timeout: { value: '16s', type: 'text' }, tags: { value: '["cookie-test","browser"]', type: 'yaml' }, - 'source.zip_url.url': { value: '', type: 'text' }, - 'source.zip_url.username': { value: '', type: 'text' }, - 'source.zip_url.folder': { value: '', type: 'text' }, - 'source.zip_url.password': { value: '', type: 'password' }, + 'source.zip_url.url': { type: 'text' }, + 'source.zip_url.username': { type: 'text' }, + 'source.zip_url.folder': { type: 'text' }, + 'source.zip_url.password': { type: 'password' }, 'source.inline.script': { value: '"step(\\"Visit /users api route\\", async () => {\\\\n const response = await page.goto(\'https://nextjs-test-synthetics.vercel.app/api/users\');\\\\n expect(response.status()).toEqual(200);\\\\n});"', @@ -188,13 +188,13 @@ export const getTestBrowserSyntheticsPolicy = ({ 'throttling.config': { value: '5d/3u/20l', type: 'text' }, 'filter_journeys.tags': { value: null, type: 'yaml' }, 'filter_journeys.match': { value: null, type: 'text' }, - 'source.zip_url.ssl.certificate_authorities': { value: null, type: 'yaml' }, - 'source.zip_url.ssl.certificate': { value: null, type: 'yaml' }, - 'source.zip_url.ssl.key': { value: null, type: 'yaml' }, - 'source.zip_url.ssl.key_passphrase': { value: null, type: 'text' }, - 'source.zip_url.ssl.verification_mode': { value: null, type: 'text' }, - 'source.zip_url.ssl.supported_protocols': { value: null, type: 'yaml' }, - 'source.zip_url.proxy_url': { value: '', type: 'text' }, + 'source.zip_url.ssl.certificate_authorities': { type: 'yaml' }, + 'source.zip_url.ssl.certificate': { type: 'yaml' }, + 'source.zip_url.ssl.key': { type: 'yaml' }, + 'source.zip_url.ssl.key_passphrase': { type: 'text' }, + 'source.zip_url.ssl.verification_mode': { type: 'text' }, + 'source.zip_url.ssl.supported_protocols': { type: 'yaml' }, + 'source.zip_url.proxy_url': { type: 'text' }, location_name: { value: 'Test private location 0', type: 'text' }, id: { value: id, type: 'text' }, config_id: { value: id, type: 'text' }, @@ -207,7 +207,6 @@ export const getTestBrowserSyntheticsPolicy = ({ compiled_stream: { __ui: { script_source: { is_generated_script: false, file_name: '' }, - is_zip_url_tls_enabled: false, is_tls_enabled: false, }, type: 'browser', diff --git a/x-pack/test/api_integration/apis/synthetics/sample_data/test_project_monitor_policy.ts b/x-pack/test/api_integration/apis/synthetics/sample_data/test_project_monitor_policy.ts index c2a433c602820..cd5ea22451b92 100644 --- a/x-pack/test/api_integration/apis/synthetics/sample_data/test_project_monitor_policy.ts +++ b/x-pack/test/api_integration/apis/synthetics/sample_data/test_project_monitor_policy.ts @@ -185,8 +185,7 @@ export const getTestProjectSyntheticsPolicy = ( }, vars: { __ui: { - value: - '{"script_source":{"is_generated_script":false,"file_name":""},"is_zip_url_tls_enabled":false}', + value: '{"script_source":{"is_generated_script":false,"file_name":""}}', type: 'yaml', }, enabled: { value: true, type: 'bool' }, @@ -196,10 +195,10 @@ export const getTestProjectSyntheticsPolicy = ( 'service.name': { value: '', type: 'text' }, timeout: { value: null, type: 'text' }, tags: { value: null, type: 'yaml' }, - 'source.zip_url.url': { value: '', type: 'text' }, - 'source.zip_url.username': { value: '', type: 'text' }, - 'source.zip_url.folder': { value: '', type: 'text' }, - 'source.zip_url.password': { value: '', type: 'password' }, + 'source.zip_url.url': { type: 'text' }, + 'source.zip_url.username': { type: 'text' }, + 'source.zip_url.folder': { type: 'text' }, + 'source.zip_url.password': { type: 'password' }, 'source.inline.script': { value: null, type: 'yaml' }, 'source.project.content': { value: @@ -217,13 +216,13 @@ export const getTestProjectSyntheticsPolicy = ( 'throttling.config': { value: '5d/3u/20l', type: 'text' }, 'filter_journeys.tags': { value: null, type: 'yaml' }, 'filter_journeys.match': { value: '"check if title is present"', type: 'text' }, - 'source.zip_url.ssl.certificate_authorities': { value: null, type: 'yaml' }, - 'source.zip_url.ssl.certificate': { value: null, type: 'yaml' }, - 'source.zip_url.ssl.key': { value: null, type: 'yaml' }, - 'source.zip_url.ssl.key_passphrase': { value: null, type: 'text' }, - 'source.zip_url.ssl.verification_mode': { value: null, type: 'text' }, - 'source.zip_url.ssl.supported_protocols': { value: null, type: 'yaml' }, - 'source.zip_url.proxy_url': { value: '', type: 'text' }, + 'source.zip_url.ssl.certificate_authorities': { type: 'yaml' }, + 'source.zip_url.ssl.certificate': { type: 'yaml' }, + 'source.zip_url.ssl.key': { type: 'yaml' }, + 'source.zip_url.ssl.key_passphrase': { type: 'text' }, + 'source.zip_url.ssl.verification_mode': { type: 'text' }, + 'source.zip_url.ssl.supported_protocols': { type: 'yaml' }, + 'source.zip_url.proxy_url': { type: 'text' }, location_name: { value: 'Test private location 0', type: 'text' }, id: { value: id, type: 'text' }, config_id: { value: configId, type: 'text' }, @@ -237,7 +236,6 @@ export const getTestProjectSyntheticsPolicy = ( compiled_stream: { __ui: { script_source: { is_generated_script: false, file_name: '' }, - is_zip_url_tls_enabled: false, }, type: 'browser', name: 'check if title is present', diff --git a/x-pack/test/api_integration/apis/uptime/rest/fixtures/browser_monitor.json b/x-pack/test/api_integration/apis/uptime/rest/fixtures/browser_monitor.json index e8776fa1874b4..1a12efba9dc1c 100644 --- a/x-pack/test/api_integration/apis/uptime/rest/fixtures/browser_monitor.json +++ b/x-pack/test/api_integration/apis/uptime/rest/fixtures/browser_monitor.json @@ -21,14 +21,8 @@ "is_generated_script": false, "file_name": "" }, - "is_zip_url_tls_enabled": false, "is_tls_enabled": false }, - "source.zip_url.url": "", - "source.zip_url.username": "", - "source.zip_url.password": "", - "source.zip_url.folder": "", - "source.zip_url.proxy_url": "", "source.inline.script": "step(\"Visit /users api route\", async () => {\\n const response = await page.goto('https://nextjs-test-synthetics.vercel.app/api/users');\\n expect(response.status()).toEqual(200);\\n});", "source.project.content": "", "params": "", diff --git a/x-pack/test/api_integration/apis/uptime/rest/fixtures/tcp_monitor.json b/x-pack/test/api_integration/apis/uptime/rest/fixtures/tcp_monitor.json index 209ef89373736..c3664c5646b16 100644 --- a/x-pack/test/api_integration/apis/uptime/rest/fixtures/tcp_monitor.json +++ b/x-pack/test/api_integration/apis/uptime/rest/fixtures/tcp_monitor.json @@ -11,8 +11,7 @@ "tags": [], "timeout": "16", "__ui": { - "is_tls_enabled": true, - "is_zip_url_tls_enabled": false + "is_tls_enabled": true }, "hosts": "example-host:40", "urls": "example-host:40", diff --git a/x-pack/test/apm_api_integration/tests/alerts/error_count_threshold.spec.ts b/x-pack/test/apm_api_integration/tests/alerts/error_count_threshold.spec.ts index a19f1ef93503a..3edbabcf023f9 100644 --- a/x-pack/test/apm_api_integration/tests/alerts/error_count_threshold.spec.ts +++ b/x-pack/test/apm_api_integration/tests/alerts/error_count_threshold.spec.ts @@ -69,7 +69,8 @@ export default function ApiTest({ getService }: FtrProviderContext) { await synthtraceEsClient.clean(); await supertest.delete(`/api/alerting/rule/${ruleId}`).set('kbn-xsrf', 'foo'); await supertest.delete(`/api/actions/connector/${actionId}`).set('kbn-xsrf', 'foo'); - await esDeleteAllIndices(['.alerts*', INDEX_NAME]); + await esDeleteAllIndices(INDEX_NAME); + await es.deleteByQuery({ index: '.alerts*', query: { match_all: {} } }); await es.deleteByQuery({ index: '.kibana-event-log-*', query: { term: { 'kibana.alert.rule.consumer': 'apm' } }, diff --git a/x-pack/test/apm_api_integration/tests/service_groups/service_group_count/service_group_count.spec.ts b/x-pack/test/apm_api_integration/tests/service_groups/service_group_count/service_group_count.spec.ts index abae62f2012a6..d61ce2cdc975f 100644 --- a/x-pack/test/apm_api_integration/tests/service_groups/service_group_count/service_group_count.spec.ts +++ b/x-pack/test/apm_api_integration/tests/service_groups/service_group_count/service_group_count.spec.ts @@ -21,7 +21,6 @@ export default function ApiTest({ getService }: FtrProviderContext) { const apmApiClient = getService('apmApiClient'); const supertest = getService('supertest'); const synthtraceEsClient = getService('synthtraceEsClient'); - const esDeleteAllIndices = getService('esDeleteAllIndices'); const esClient = getService('es'); const log = getService('log'); const start = Date.now() - 24 * 60 * 60 * 1000; @@ -90,7 +89,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { after(async () => { await supertest.delete(`/api/alerting/rule/${ruleId}`).set('kbn-xsrf', 'true'); - await esDeleteAllIndices('.alerts*'); + await esClient.deleteByQuery({ index: '.alerts*', query: { match_all: {} } }); }); it('returns the correct number of alerts', async () => { diff --git a/x-pack/test/apm_api_integration/tests/services/service_alerts.spec.ts b/x-pack/test/apm_api_integration/tests/services/service_alerts.spec.ts index 35ee8da8ba39b..432ece830716c 100644 --- a/x-pack/test/apm_api_integration/tests/services/service_alerts.spec.ts +++ b/x-pack/test/apm_api_integration/tests/services/service_alerts.spec.ts @@ -16,7 +16,6 @@ export default function ServiceAlerts({ getService }: FtrProviderContext) { const apmApiClient = getService('apmApiClient'); const supertest = getService('supertest'); const synthtraceEsClient = getService('synthtraceEsClient'); - const esDeleteAllIndices = getService('esDeleteAllIndices'); const esClient = getService('es'); const log = getService('log'); const start = Date.now() - 24 * 60 * 60 * 1000; @@ -122,7 +121,7 @@ export default function ServiceAlerts({ getService }: FtrProviderContext) { after(async () => { await supertest.delete(`/api/alerting/rule/${ruleId}`).set('kbn-xsrf', 'true'); - await esDeleteAllIndices('.alerts*'); + await esClient.deleteByQuery({ index: '.alerts*', query: { match_all: {} } }); }); it('returns the correct number of alerts', async () => { diff --git a/x-pack/test/cases_api_integration/common/lib/alerts.ts b/x-pack/test/cases_api_integration/common/lib/alerts.ts index ff29579c91607..08da41280f9be 100644 --- a/x-pack/test/cases_api_integration/common/lib/alerts.ts +++ b/x-pack/test/cases_api_integration/common/lib/alerts.ts @@ -5,12 +5,15 @@ * 2.0. */ +import expect from '@kbn/expect'; import type SuperTest from 'supertest'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { ToolingLog } from '@kbn/tooling-log'; import { DETECTION_ENGINE_QUERY_SIGNALS_URL } from '@kbn/security-solution-plugin/common/constants'; import { DetectionAlert } from '@kbn/security-solution-plugin/common/detection_engine/schemas/alerts'; import { RiskEnrichmentFields } from '@kbn/security-solution-plugin/server/lib/detection_engine/rule_types/utils/enrichments/types'; +import { CommentType } from '@kbn/cases-plugin/common'; +import { ALERT_CASE_IDS } from '@kbn/rule-data-utils'; import { getRuleForSignalTesting, createRule, @@ -22,6 +25,9 @@ import { import { superUser } from './authentication/users'; import { User } from './authentication/types'; import { getSpaceUrlPrefix } from './api/helpers'; +import { createCase } from './api/case'; +import { createComment, deleteAllComments } from './api'; +import { postCaseReq } from './mock'; export const createSecuritySolutionAlerts = async ( supertest: SuperTest.SuperTest, @@ -74,3 +80,92 @@ export const getAlertById = async ({ return alert; }; + +export type Alerts = Array<{ _id: string; _index: string }>; + +export const createCaseAttachAlertAndDeleteAlert = async ({ + supertest, + totalCases, + indexOfCaseToDelete, + owner, + expectedHttpCode = 204, + deleteCommentAuth = { user: superUser, space: 'space1' }, + alerts, + getAlerts, +}: { + supertest: SuperTest.SuperTest; + totalCases: number; + indexOfCaseToDelete: number; + owner: string; + expectedHttpCode?: number; + deleteCommentAuth?: { user: User; space: string | null }; + alerts: Alerts; + getAlerts: (alerts: Alerts) => Promise>>; +}) => { + const cases = await Promise.all( + [...Array(totalCases).keys()].map((index) => + createCase( + supertest, + { + ...postCaseReq, + owner, + settings: { syncAlerts: false }, + }, + 200, + { user: superUser, space: 'space1' } + ) + ) + ); + + const updatedCases = []; + + for (const theCase of cases) { + const updatedCase = await createComment({ + supertest, + caseId: theCase.id, + params: { + alertId: alerts.map((alert) => alert._id), + index: alerts.map((alert) => alert._index), + rule: { + id: 'id', + name: 'name', + }, + owner, + type: CommentType.alert, + }, + auth: { user: superUser, space: 'space1' }, + }); + + updatedCases.push(updatedCase); + } + + const caseIds = updatedCases.map((theCase) => theCase.id); + + const updatedAlerts = await getAlerts(alerts); + + for (const alert of updatedAlerts) { + expect(alert[ALERT_CASE_IDS]).eql(caseIds); + } + + const caseToDelete = updatedCases[indexOfCaseToDelete]; + + await deleteAllComments({ + supertest, + caseId: caseToDelete.id, + expectedHttpCode, + auth: deleteCommentAuth, + }); + + const alertAfterDeletion = await getAlerts(alerts); + + const caseIdsWithoutRemovedCase = + expectedHttpCode === 204 + ? updatedCases + .filter((theCase) => theCase.id !== caseToDelete.id) + .map((theCase) => theCase.id) + : updatedCases.map((theCase) => theCase.id); + + for (const alert of alertAfterDeletion) { + expect(alert[ALERT_CASE_IDS]).eql(caseIdsWithoutRemovedCase); + } +}; diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/comments/delete_comment.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/comments/delete_comment.ts index b0c4d670855a3..317bd2797245b 100644 --- a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/comments/delete_comment.ts +++ b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/comments/delete_comment.ts @@ -6,9 +6,8 @@ */ import expect from '@kbn/expect'; -import { CommentType } from '@kbn/cases-plugin/common'; -import { ALERT_CASE_IDS } from '@kbn/rule-data-utils'; import { + createCaseAttachAlertAndDeleteAlert, createSecuritySolutionAlerts, getAlertById, getSecuritySolutionAlerts, @@ -19,7 +18,6 @@ import { deleteAllRules, } from '../../../../../detection_engine_api_integration/utils'; import { FtrProviderContext } from '../../../../common/ftr_provider_context'; -import { User } from '../../../../common/lib/authentication/types'; import { getPostCaseRequest, postCaseReq, postCommentUserReq } from '../../../../common/lib/mock'; import { @@ -30,7 +28,6 @@ import { createCase, createComment, deleteComment, - deleteAllComments, superUserSpace1Auth, } from '../../../../common/lib/api'; import { @@ -114,93 +111,6 @@ export default ({ getService }: FtrProviderContext): void => { describe('alerts', () => { type Alerts = Array<{ _id: string; _index: string }>; - const createCaseAttachAlertAndDeleteAlert = async ({ - totalCases, - indexOfCaseToDelete, - owner, - expectedHttpCode = 204, - deleteCommentAuth = { user: superUser, space: 'space1' }, - alerts, - getAlerts, - }: { - totalCases: number; - indexOfCaseToDelete: number; - owner: string; - expectedHttpCode?: number; - deleteCommentAuth?: { user: User; space: string | null }; - alerts: Alerts; - getAlerts: (alerts: Alerts) => Promise>>; - }) => { - const cases = await Promise.all( - [...Array(totalCases).keys()].map((index) => - createCase( - supertestWithoutAuth, - { - ...postCaseReq, - owner, - settings: { syncAlerts: false }, - }, - 200, - { user: superUser, space: 'space1' } - ) - ) - ); - - const updatedCases = []; - - for (const theCase of cases) { - const updatedCase = await createComment({ - supertest: supertestWithoutAuth, - caseId: theCase.id, - params: { - alertId: alerts.map((alert) => alert._id), - index: alerts.map((alert) => alert._index), - rule: { - id: 'id', - name: 'name', - }, - owner, - type: CommentType.alert, - }, - auth: { user: superUser, space: 'space1' }, - }); - - updatedCases.push(updatedCase); - } - - const caseIds = updatedCases.map((theCase) => theCase.id); - - const updatedAlerts = await getAlerts(alerts); - - for (const alert of updatedAlerts) { - expect(alert[ALERT_CASE_IDS]).eql(caseIds); - } - - const caseToDelete = updatedCases[indexOfCaseToDelete]; - const commentId = caseToDelete.comments![0].id; - - await deleteComment({ - supertest: supertestWithoutAuth, - caseId: caseToDelete.id, - commentId, - expectedHttpCode, - auth: deleteCommentAuth, - }); - - const alertAfterDeletion = await getAlerts(alerts); - - const caseIdsWithoutRemovedCase = - expectedHttpCode === 204 - ? updatedCases - .filter((theCase) => theCase.id !== caseToDelete.id) - .map((theCase) => theCase.id) - : updatedCases.map((theCase) => theCase.id); - - for (const alert of alertAfterDeletion) { - expect(alert[ALERT_CASE_IDS]).eql(caseIdsWithoutRemovedCase); - } - }; - describe('security_solution', () => { let alerts: Alerts = []; @@ -229,6 +139,7 @@ export default ({ getService }: FtrProviderContext): void => { it('removes a case from the alert schema when deleting an alert attachment', async () => { await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, totalCases: 1, indexOfCaseToDelete: 0, owner: 'securitySolutionFixture', @@ -239,6 +150,7 @@ export default ({ getService }: FtrProviderContext): void => { it('should remove only one case', async () => { await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, totalCases: 3, indexOfCaseToDelete: 1, owner: 'securitySolutionFixture', @@ -249,6 +161,7 @@ export default ({ getService }: FtrProviderContext): void => { it('should delete case ID from the alert schema when the user has write access to the indices and only read access to the siem solution', async () => { await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, totalCases: 1, indexOfCaseToDelete: 0, owner: 'securitySolutionFixture', @@ -261,6 +174,7 @@ export default ({ getService }: FtrProviderContext): void => { it('should NOT delete case ID from the alert schema when the user does NOT have access to the alert', async () => { await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, totalCases: 1, indexOfCaseToDelete: 0, owner: 'securitySolutionFixture', @@ -273,6 +187,7 @@ export default ({ getService }: FtrProviderContext): void => { it('should delete the case ID from the alert schema when the user has read access to the kibana feature but no read access to the ES index', async () => { await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, totalCases: 1, indexOfCaseToDelete: 0, owner: 'securitySolutionFixture', @@ -315,6 +230,7 @@ export default ({ getService }: FtrProviderContext): void => { it('removes a case from the alert schema when deleting an alert attachment', async () => { await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, totalCases: 1, indexOfCaseToDelete: 0, owner: 'observabilityFixture', @@ -325,6 +241,7 @@ export default ({ getService }: FtrProviderContext): void => { it('should remove only one case', async () => { await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, totalCases: 3, indexOfCaseToDelete: 1, owner: 'observabilityFixture', @@ -335,6 +252,7 @@ export default ({ getService }: FtrProviderContext): void => { it('should delete case ID from the alert schema when the user has read access only', async () => { await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, totalCases: 1, indexOfCaseToDelete: 0, expectedHttpCode: 204, @@ -347,6 +265,7 @@ export default ({ getService }: FtrProviderContext): void => { it('should NOT delete case ID from the alert schema when the user does NOT have access to the alert', async () => { await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, totalCases: 1, indexOfCaseToDelete: 0, expectedHttpCode: 403, @@ -387,35 +306,6 @@ export default ({ getService }: FtrProviderContext): void => { }); }); - it('should delete multiple comments from the appropriate owner', async () => { - const secCase = await createCase( - supertestWithoutAuth, - getPostCaseRequest({ owner: 'securitySolutionFixture' }), - 200, - { user: secOnly, space: 'space1' } - ); - - await createComment({ - supertest: supertestWithoutAuth, - caseId: secCase.id, - params: postCommentUserReq, - auth: { user: secOnly, space: 'space1' }, - }); - - await createComment({ - supertest: supertestWithoutAuth, - caseId: secCase.id, - params: postCommentUserReq, - auth: { user: secOnly, space: 'space1' }, - }); - - await deleteAllComments({ - supertest: supertestWithoutAuth, - caseId: secCase.id, - auth: { user: secOnly, space: 'space1' }, - }); - }); - it('should not delete a comment from a different owner', async () => { const secCase = await createCase( supertestWithoutAuth, @@ -438,13 +328,6 @@ export default ({ getService }: FtrProviderContext): void => { auth: { user: obsOnly, space: 'space1' }, expectedHttpCode: 403, }); - - await deleteAllComments({ - supertest: supertestWithoutAuth, - caseId: secCase.id, - auth: { user: obsOnly, space: 'space1' }, - expectedHttpCode: 403, - }); }); for (const user of [globalRead, secOnlyRead, obsOnlyRead, obsSecRead, noKibanaPrivileges]) { @@ -472,13 +355,6 @@ export default ({ getService }: FtrProviderContext): void => { auth: { user, space: 'space1' }, expectedHttpCode: 403, }); - - await deleteAllComments({ - supertest: supertestWithoutAuth, - caseId: postedCase.id, - auth: { user, space: 'space1' }, - expectedHttpCode: 403, - }); }); } @@ -504,13 +380,6 @@ export default ({ getService }: FtrProviderContext): void => { auth: { user: secOnly, space: 'space2' }, expectedHttpCode: 403, }); - - await deleteAllComments({ - supertest: supertestWithoutAuth, - caseId: postedCase.id, - auth: { user: secOnly, space: 'space2' }, - expectedHttpCode: 403, - }); }); it('should NOT delete a comment created in space2 by making a request to space1', async () => { @@ -535,13 +404,6 @@ export default ({ getService }: FtrProviderContext): void => { auth: { user: secOnly, space: 'space1' }, expectedHttpCode: 404, }); - - await deleteAllComments({ - supertest: supertestWithoutAuth, - caseId: postedCase.id, - auth: { user: secOnly, space: 'space1' }, - expectedHttpCode: 404, - }); }); }); }); diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/comments/delete_comments.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/comments/delete_comments.ts new file mode 100644 index 0000000000000..7ac1cc4f9de77 --- /dev/null +++ b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/comments/delete_comments.ts @@ -0,0 +1,495 @@ +/* + * 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 expect from '@kbn/expect'; +import { + Alerts, + createCaseAttachAlertAndDeleteAlert, + createSecuritySolutionAlerts, + getAlertById, + getSecuritySolutionAlerts, +} from '../../../../common/lib/alerts'; +import { + createSignalsIndex, + deleteSignalsIndex, + deleteAllRules, +} from '../../../../../detection_engine_api_integration/utils'; +import { FtrProviderContext } from '../../../../common/ftr_provider_context'; + +import { + getPostCaseRequest, + persistableStateAttachment, + postCaseReq, + postCommentActionsReleaseReq, + postCommentActionsReq, + postCommentAlertReq, + postCommentUserReq, + postExternalReferenceESReq, + postExternalReferenceSOReq, +} from '../../../../common/lib/mock'; +import { + deleteAllCaseItems, + deleteCasesByESQuery, + deleteCasesUserActions, + deleteComments, + createCase, + createComment, + deleteAllComments, + superUserSpace1Auth, + bulkCreateAttachments, + getAllComments, +} from '../../../../common/lib/api'; +import { + globalRead, + noKibanaPrivileges, + obsOnly, + obsOnlyRead, + obsOnlyReadAlerts, + obsSec, + obsSecRead, + secOnly, + secOnlyRead, + secOnlyReadAlerts, + secSolutionOnlyReadNoIndexAlerts, + superUser, +} from '../../../../common/lib/authentication/users'; + +// eslint-disable-next-line import/no-default-export +export default ({ getService }: FtrProviderContext): void => { + const supertest = getService('supertest'); + const es = getService('es'); + const esArchiver = getService('esArchiver'); + const log = getService('log'); + const supertestWithoutAuth = getService('supertestWithoutAuth'); + + describe('delete_comments', () => { + afterEach(async () => { + await deleteCasesByESQuery(es); + await deleteComments(es); + await deleteCasesUserActions(es); + }); + + describe('happy path', () => { + it('should delete all comments', async () => { + const postedCase = await createCase(supertest, postCaseReq); + + await createComment({ + supertest, + caseId: postedCase.id, + params: postCommentUserReq, + }); + + const comment = await deleteAllComments({ + supertest, + caseId: postedCase.id, + }); + + expect(comment).to.eql({}); + }); + }); + + describe('unhappy path', () => { + it('404s when comment belongs to different case', async () => { + const postedCase = await createCase(supertest, postCaseReq); + await createComment({ + supertest, + caseId: postedCase.id, + params: postCommentUserReq, + }); + + const error = (await deleteAllComments({ + supertest, + caseId: 'fake-id', + expectedHttpCode: 404, + })) as Error; + + expect(error.message).to.be('No comments found for fake-id.'); + }); + }); + + describe('alerts', () => { + describe('security_solution', () => { + let alerts: Alerts = []; + + const getAlerts = async (_alerts: Alerts) => { + await es.indices.refresh({ index: _alerts.map((alert) => alert._index) }); + const updatedAlerts = await getSecuritySolutionAlerts( + supertest, + alerts.map((alert) => alert._id) + ); + + return updatedAlerts.hits.hits.map((alert) => ({ ...alert._source })); + }; + + beforeEach(async () => { + await esArchiver.load('x-pack/test/functional/es_archives/auditbeat/hosts'); + await createSignalsIndex(supertest, log); + const signals = await createSecuritySolutionAlerts(supertest, log); + alerts = [signals.hits.hits[0], signals.hits.hits[1]]; + }); + + afterEach(async () => { + await deleteSignalsIndex(supertest, log); + await deleteAllRules(supertest, log); + await esArchiver.unload('x-pack/test/functional/es_archives/auditbeat/hosts'); + }); + + it('deletes alerts and comments', async () => { + const postedCase = await createCase(supertest, postCaseReq); + + await createComment({ + supertest, + caseId: postedCase.id, + params: postCommentUserReq, + }); + + await bulkCreateAttachments({ + supertest, + caseId: postedCase.id, + params: [ + { + ...postCommentAlertReq, + alertId: alerts[0]._id, + index: alerts[0]._index, + }, + { + ...postCommentAlertReq, + alertId: alerts[1]._id, + index: alerts[1]._index, + }, + postCommentUserReq, + postCommentActionsReq, + postCommentActionsReleaseReq, + postExternalReferenceESReq, + postExternalReferenceSOReq, + persistableStateAttachment, + ], + }); + + await deleteAllComments({ + supertest, + caseId: postedCase.id, + }); + + const comments = await getAllComments({ supertest, caseId: postedCase.id }); + expect(comments.length).to.eql(0); + }); + + it('removes a case from the alert schema when deleting all alert attachments', async () => { + await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, + totalCases: 1, + indexOfCaseToDelete: 0, + owner: 'securitySolutionFixture', + alerts, + getAlerts, + }); + }); + + it('should remove only one case', async () => { + await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, + totalCases: 3, + indexOfCaseToDelete: 1, + owner: 'securitySolutionFixture', + alerts, + getAlerts, + }); + }); + + it('should delete case ID from the alert schema when the user has write access to the indices and only read access to the siem solution', async () => { + await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, + totalCases: 1, + indexOfCaseToDelete: 0, + owner: 'securitySolutionFixture', + alerts, + getAlerts, + expectedHttpCode: 204, + deleteCommentAuth: { user: secOnlyReadAlerts, space: 'space1' }, + }); + }); + + it('should NOT delete case ID from the alert schema when the user does NOT have access to the alert', async () => { + await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, + totalCases: 1, + indexOfCaseToDelete: 0, + owner: 'securitySolutionFixture', + alerts, + getAlerts, + expectedHttpCode: 403, + deleteCommentAuth: { user: obsSec, space: 'space1' }, + }); + }); + + it('should delete the case ID from the alert schema when the user has read access to the kibana feature but no read access to the ES index', async () => { + await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, + totalCases: 1, + indexOfCaseToDelete: 0, + owner: 'securitySolutionFixture', + alerts, + getAlerts, + expectedHttpCode: 204, + deleteCommentAuth: { user: secSolutionOnlyReadNoIndexAlerts, space: 'space1' }, + }); + }); + }); + + describe('observability', () => { + const alerts = [ + { _id: 'NoxgpHkBqbdrfX07MqXV', _index: '.alerts-observability.apm.alerts' }, + { _id: 'space1alert', _index: '.alerts-observability.apm.alerts' }, + ]; + + const getAlerts = async (_alerts: Alerts) => { + const updatedAlerts = await Promise.all( + _alerts.map((alert) => + getAlertById({ + supertest: supertestWithoutAuth, + id: alert._id, + index: alert._index, + auth: { user: superUser, space: 'space1' }, + }) + ) + ); + + return updatedAlerts as Array>; + }; + + beforeEach(async () => { + await esArchiver.load('x-pack/test/functional/es_archives/rule_registry/alerts'); + }); + + afterEach(async () => { + await esArchiver.unload('x-pack/test/functional/es_archives/rule_registry/alerts'); + }); + + it('deletes alerts and comments', async () => { + const postedCase = await createCase(supertest, postCaseReq); + + await createComment({ + supertest, + caseId: postedCase.id, + params: postCommentUserReq, + }); + + await bulkCreateAttachments({ + supertest, + caseId: postedCase.id, + params: [ + { + ...postCommentAlertReq, + alertId: alerts[0]._id, + index: alerts[0]._index, + }, + { + ...postCommentAlertReq, + alertId: alerts[1]._id, + index: alerts[1]._index, + }, + postCommentUserReq, + postCommentActionsReq, + postCommentActionsReleaseReq, + postExternalReferenceESReq, + postExternalReferenceSOReq, + persistableStateAttachment, + ], + }); + + await deleteAllComments({ + supertest, + caseId: postedCase.id, + }); + + const comments = await getAllComments({ supertest, caseId: postedCase.id }); + expect(comments.length).to.eql(0); + }); + + it('removes a case from the alert schema when deleting all alert attachments', async () => { + await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, + totalCases: 1, + indexOfCaseToDelete: 0, + owner: 'observabilityFixture', + alerts, + getAlerts, + }); + }); + + it('should remove only one case', async () => { + await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, + totalCases: 3, + indexOfCaseToDelete: 1, + owner: 'observabilityFixture', + alerts, + getAlerts, + }); + }); + + it('should delete case ID from the alert schema when the user has read access only', async () => { + await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, + totalCases: 1, + indexOfCaseToDelete: 0, + expectedHttpCode: 204, + owner: 'observabilityFixture', + alerts, + getAlerts, + deleteCommentAuth: { user: obsOnlyReadAlerts, space: 'space1' }, + }); + }); + + it('should NOT delete case ID from the alert schema when the user does NOT have access to the alert', async () => { + await createCaseAttachAlertAndDeleteAlert({ + supertest: supertestWithoutAuth, + totalCases: 1, + indexOfCaseToDelete: 0, + expectedHttpCode: 403, + owner: 'observabilityFixture', + alerts, + getAlerts, + deleteCommentAuth: { user: obsSec, space: 'space1' }, + }); + }); + }); + }); + + describe('rbac', () => { + afterEach(async () => { + await deleteAllCaseItems(es); + }); + + it('should delete multiple comments from the appropriate owner', async () => { + const secCase = await createCase( + supertestWithoutAuth, + getPostCaseRequest({ owner: 'securitySolutionFixture' }), + 200, + { user: secOnly, space: 'space1' } + ); + + await createComment({ + supertest: supertestWithoutAuth, + caseId: secCase.id, + params: postCommentUserReq, + auth: { user: secOnly, space: 'space1' }, + }); + + await createComment({ + supertest: supertestWithoutAuth, + caseId: secCase.id, + params: postCommentUserReq, + auth: { user: secOnly, space: 'space1' }, + }); + + await deleteAllComments({ + supertest: supertestWithoutAuth, + caseId: secCase.id, + auth: { user: secOnly, space: 'space1' }, + }); + }); + + it('should not delete a comment from a different owner', async () => { + const secCase = await createCase( + supertestWithoutAuth, + getPostCaseRequest({ owner: 'securitySolutionFixture' }), + 200, + { user: secOnly, space: 'space1' } + ); + + await createComment({ + supertest: supertestWithoutAuth, + caseId: secCase.id, + params: postCommentUserReq, + auth: { user: secOnly, space: 'space1' }, + }); + + await deleteAllComments({ + supertest: supertestWithoutAuth, + caseId: secCase.id, + auth: { user: obsOnly, space: 'space1' }, + expectedHttpCode: 403, + }); + }); + + for (const user of [globalRead, secOnlyRead, obsOnlyRead, obsSecRead, noKibanaPrivileges]) { + it(`User ${ + user.username + } with role(s) ${user.roles.join()} - should NOT delete all comments`, async () => { + const postedCase = await createCase( + supertestWithoutAuth, + getPostCaseRequest({ owner: 'securitySolutionFixture' }), + 200, + superUserSpace1Auth + ); + + await createComment({ + supertest: supertestWithoutAuth, + caseId: postedCase.id, + params: postCommentUserReq, + auth: superUserSpace1Auth, + }); + + await deleteAllComments({ + supertest: supertestWithoutAuth, + caseId: postedCase.id, + auth: { user, space: 'space1' }, + expectedHttpCode: 403, + }); + }); + } + + it('should NOT delete a comment in a space with where the user does not have permissions', async () => { + const postedCase = await createCase( + supertestWithoutAuth, + getPostCaseRequest({ owner: 'securitySolutionFixture' }), + 200, + { user: superUser, space: 'space2' } + ); + + await createComment({ + supertest: supertestWithoutAuth, + caseId: postedCase.id, + params: postCommentUserReq, + auth: { user: superUser, space: 'space2' }, + }); + + await deleteAllComments({ + supertest: supertestWithoutAuth, + caseId: postedCase.id, + auth: { user: secOnly, space: 'space2' }, + expectedHttpCode: 403, + }); + }); + + it('should NOT delete a comment created in space2 by making a request to space1', async () => { + const postedCase = await createCase( + supertestWithoutAuth, + getPostCaseRequest({ owner: 'securitySolutionFixture' }), + 200, + { user: superUser, space: 'space2' } + ); + + await createComment({ + supertest: supertestWithoutAuth, + caseId: postedCase.id, + params: postCommentUserReq, + auth: { user: superUser, space: 'space2' }, + }); + + await deleteAllComments({ + supertest: supertestWithoutAuth, + caseId: postedCase.id, + auth: { user: secOnly, space: 'space1' }, + expectedHttpCode: 404, + }); + }); + }); + }); +}; diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts index 5da47becd8faf..f99b2e65e50d5 100644 --- a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts +++ b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts @@ -12,6 +12,7 @@ export default ({ loadTestFile }: FtrProviderContext): void => { describe('Common', function () { loadTestFile(require.resolve('./client/update_alert_status')); loadTestFile(require.resolve('./comments/delete_comment')); + loadTestFile(require.resolve('./comments/delete_comments')); loadTestFile(require.resolve('./comments/find_comments')); loadTestFile(require.resolve('./comments/get_comment')); loadTestFile(require.resolve('./comments/get_all_comments')); diff --git a/x-pack/test/detection_engine_api_integration/basic/tests/query_signals.ts b/x-pack/test/detection_engine_api_integration/basic/tests/query_signals.ts index 08d0be9d66d9c..fa0b6a7b119ea 100644 --- a/x-pack/test/detection_engine_api_integration/basic/tests/query_signals.ts +++ b/x-pack/test/detection_engine_api_integration/basic/tests/query_signals.ts @@ -22,23 +22,6 @@ export default ({ getService }: FtrProviderContext) => { describe('query_signals_route and find_alerts_route', () => { describe('validation checks', () => { - it('should not give errors when querying and the signals index does not exist yet', async () => { - const { body } = await supertest - .post(DETECTION_ENGINE_QUERY_SIGNALS_URL) - .set('kbn-xsrf', 'true') - .send(getSignalStatus()) - .expect(200); - - // remove any server generated items that are indeterministic - delete body.took; - - expect(body).to.eql({ - timed_out: false, - _shards: { total: 0, successful: 0, skipped: 0, failed: 0 }, - hits: { total: { value: 0, relation: 'eq' }, max_score: 0, hits: [] }, - }); - }); - // This fails and should be investigated or removed if it no longer applies it.skip('should not give errors when querying and the signals index does exist and is empty', async () => { await createSignalsIndex(supertest, log); @@ -144,23 +127,6 @@ export default ({ getService }: FtrProviderContext) => { describe('find_alerts_route', () => { describe('validation checks', () => { - it('should not give errors when querying and the signals index does not exist yet', async () => { - const { body } = await supertest - .post(ALERTS_AS_DATA_FIND_URL) - .set('kbn-xsrf', 'true') - .send({ ...getSignalStatus(), index: '.siem-signals-default' }) - .expect(200); - - // remove any server generated items that are indeterministic - delete body.took; - - expect(body).to.eql({ - timed_out: false, - _shards: { total: 0, successful: 0, skipped: 0, failed: 0 }, - hits: { total: { value: 0, relation: 'eq' }, max_score: 0, hits: [] }, - }); - }); - // This fails and should be investigated or removed if it no longer applies it.skip('should not give errors when querying and the signals index does exist and is empty', async () => { await createSignalsIndex(supertest, log); diff --git a/x-pack/test/detection_engine_api_integration/security_and_spaces/group10/finalize_signals_migrations.ts b/x-pack/test/detection_engine_api_integration/security_and_spaces/group10/finalize_signals_migrations.ts index 009d212649248..daaa946d39e7c 100644 --- a/x-pack/test/detection_engine_api_integration/security_and_spaces/group10/finalize_signals_migrations.ts +++ b/x-pack/test/detection_engine_api_integration/security_and_spaces/group10/finalize_signals_migrations.ts @@ -48,6 +48,19 @@ export default ({ getService }: FtrProviderContext): void => { const supertestWithoutAuth = getService('supertestWithoutAuth'); const log = getService('log'); + const getSignalsMigrationStatus = async (query: any) => { + const { body } = await supertest + .get(DETECTION_ENGINE_SIGNALS_MIGRATION_STATUS_URL) + .query(query) + .set('kbn-xsrf', 'true') + .expect(200); + + const filteredIndices = body.indices.filter( + (index: any) => index?.index !== '.internal.alerts-security.alerts-default-000001' + ); + return filteredIndices; + }; + describe('Finalizing signals migrations', () => { let legacySignalsIndexName: string; let outdatedSignalsIndexName: string; @@ -93,12 +106,9 @@ export default ({ getService }: FtrProviderContext): void => { }); it('replaces the original index alias with the migrated one', async () => { - const { body } = await supertest - .get(DETECTION_ENGINE_SIGNALS_MIGRATION_STATUS_URL) - .query({ from: '2020-10-10' }) - .set('kbn-xsrf', 'true') - .expect(200); - const statusResponses: StatusResponse[] = body.indices; + const statusResponses: StatusResponse[] = await getSignalsMigrationStatus({ + from: '2020-10-10', + }); const indicesBefore = statusResponses.map((index) => index.index); expect(indicesBefore).to.contain(createdMigration.index); @@ -170,17 +180,11 @@ export default ({ getService }: FtrProviderContext): void => { log ); - const { body: bodyAfter } = await supertest - .get(DETECTION_ENGINE_SIGNALS_MIGRATION_STATUS_URL) - .query({ from: '2020-10-10' }) - .set('kbn-xsrf', 'true') - .expect(200); - - const statusAfter: StatusResponse[] = bodyAfter.indices; - expect(statusAfter.map((s) => s.index)).to.eql([ + const indices = await getSignalsMigrationStatus({ from: '2020-10-10' }); + expect(indices.map((s: any) => s.index)).to.eql([ ...createdMigrations.map((c) => c.migration_index), ]); - expect(statusAfter.map((s) => s.is_outdated)).to.eql([false, false]); + expect(indices.map((s: any) => s.is_outdated)).to.eql([false, false]); }); // This fails and should be investigated or removed if it no longer applies diff --git a/x-pack/test/detection_engine_api_integration/security_and_spaces/group10/get_signals_migration_status.ts b/x-pack/test/detection_engine_api_integration/security_and_spaces/group10/get_signals_migration_status.ts index e5351b7e0f47b..89b7b6f6229b0 100644 --- a/x-pack/test/detection_engine_api_integration/security_and_spaces/group10/get_signals_migration_status.ts +++ b/x-pack/test/detection_engine_api_integration/security_and_spaces/group10/get_signals_migration_status.ts @@ -20,6 +20,19 @@ export default ({ getService }: FtrProviderContext): void => { const supertestWithoutAuth = getService('supertestWithoutAuth'); const log = getService('log'); + const getSignalsMigrationStatus = async (query: any) => { + const { body } = await supertest + .get(DETECTION_ENGINE_SIGNALS_MIGRATION_STATUS_URL) + .query(query) + .set('kbn-xsrf', 'true') + .expect(200); + + const filteredIndices = body.indices.filter( + (index: any) => index?.index !== '.internal.alerts-security.alerts-default-000001' + ); + return filteredIndices; + }; + describe('Signals migration status', () => { let legacySignalsIndexName: string; beforeEach(async () => { @@ -35,24 +48,12 @@ export default ({ getService }: FtrProviderContext): void => { }); it('returns no indexes if no signals exist in the specified range', async () => { - const { body } = await supertest - .get(DETECTION_ENGINE_SIGNALS_MIGRATION_STATUS_URL) - .query({ from: '2020-10-20' }) - .set('kbn-xsrf', 'true') - .expect(200); - - expect(body.indices).to.eql([]); + const indices = await getSignalsMigrationStatus({ from: '2020-10-20' }); + expect(indices).to.eql([]); }); it('includes an index if its signals are within the specified range', async () => { - const { - body: { indices }, - } = await supertest - .get(DETECTION_ENGINE_SIGNALS_MIGRATION_STATUS_URL) - .query({ from: '2020-10-10' }) - .set('kbn-xsrf', 'true') - .expect(200); - + const indices = await getSignalsMigrationStatus({ from: '2020-10-10' }); expect(indices).length(1); expect(indices[0].index).to.eql(legacySignalsIndexName); }); @@ -62,13 +63,8 @@ export default ({ getService }: FtrProviderContext): void => { await esArchiver.load('x-pack/test/functional/es_archives/signals/outdated_signals_index') ); - const { body } = await supertest - .get(DETECTION_ENGINE_SIGNALS_MIGRATION_STATUS_URL) - .query({ from: '2020-10-10' }) - .set('kbn-xsrf', 'true') - .expect(200); - - expect(body.indices).to.eql([ + const indices = await getSignalsMigrationStatus({ from: '2020-10-10' }); + expect(indices).to.eql([ { index: legacySignalsIndexName, is_outdated: true, diff --git a/x-pack/test/detection_engine_api_integration/security_and_spaces/rule_execution_logic/index.ts b/x-pack/test/detection_engine_api_integration/security_and_spaces/rule_execution_logic/index.ts index 0af37d5d28b93..a73bf7c22d28b 100644 --- a/x-pack/test/detection_engine_api_integration/security_and_spaces/rule_execution_logic/index.ts +++ b/x-pack/test/detection_engine_api_integration/security_and_spaces/rule_execution_logic/index.ts @@ -13,10 +13,11 @@ export default ({ loadTestFile }: FtrProviderContext): void => { loadTestFile(require.resolve('./eql')); loadTestFile(require.resolve('./machine_learning')); loadTestFile(require.resolve('./new_terms')); - loadTestFile(require.resolve('./query')); loadTestFile(require.resolve('./saved_query')); loadTestFile(require.resolve('./threat_match')); loadTestFile(require.resolve('./threshold')); loadTestFile(require.resolve('./non_ecs_fields')); + + loadTestFile(require.resolve('./query')); }); }; diff --git a/x-pack/test/detection_engine_api_integration/security_and_spaces/rule_execution_logic/query.ts b/x-pack/test/detection_engine_api_integration/security_and_spaces/rule_execution_logic/query.ts index 2f769a1a1168f..3eb2db9ff5155 100644 --- a/x-pack/test/detection_engine_api_integration/security_and_spaces/rule_execution_logic/query.ts +++ b/x-pack/test/detection_engine_api_integration/security_and_spaces/rule_execution_logic/query.ts @@ -71,6 +71,7 @@ export default ({ getService }: FtrProviderContext) => { const esArchiver = getService('esArchiver'); const es = getService('es'); const log = getService('log'); + const esDeleteAllIndices = getService('esDeleteAllIndices'); describe('Query type rules', () => { before(async () => { @@ -79,6 +80,10 @@ export default ({ getService }: FtrProviderContext) => { await esArchiver.load('x-pack/test/functional/es_archives/signals/severity_risk_overrides'); }); + afterEach(async () => { + await esDeleteAllIndices('.preview.alerts*'); + }); + after(async () => { await esArchiver.unload('x-pack/test/functional/es_archives/auditbeat/hosts'); await esArchiver.unload('x-pack/test/functional/es_archives/security_solution/alerts/8.1.0'); diff --git a/x-pack/test/fleet_api_integration/apis/epm/custom_ingest_pipeline.ts b/x-pack/test/fleet_api_integration/apis/epm/custom_ingest_pipeline.ts index 5022f47b414bd..06b5a245cd78c 100644 --- a/x-pack/test/fleet_api_integration/apis/epm/custom_ingest_pipeline.ts +++ b/x-pack/test/fleet_api_integration/apis/epm/custom_ingest_pipeline.ts @@ -19,6 +19,8 @@ export default function (providerContext: FtrProviderContext) { const supertest = getService('supertest'); const es = getService('es'); const esArchiver = getService('esArchiver'); + + // TODO: Use test package or move to input package version github.com/elastic/kibana/issues/154243 const LOG_INTEGRATION_VERSION = '1.1.2'; describe('custom ingest pipeline for fleet managed datastreams', () => { skipIfNoDockerRegistry(providerContext); @@ -59,8 +61,7 @@ export default function (providerContext: FtrProviderContext) { } }); - // FLAKY: https://github.com/elastic/kibana/issues/154227 - describe.skip('Without custom pipeline', () => { + describe('Without custom pipeline', () => { it('Should write doc correctly', async () => { const res = await es.index({ index: 'logs-log.log-test', diff --git a/x-pack/test/fleet_api_integration/apis/epm/final_pipeline.ts b/x-pack/test/fleet_api_integration/apis/epm/final_pipeline.ts index dff9c8fd6eeed..10990376d4cfa 100644 --- a/x-pack/test/fleet_api_integration/apis/epm/final_pipeline.ts +++ b/x-pack/test/fleet_api_integration/apis/epm/final_pipeline.ts @@ -14,6 +14,7 @@ const TEST_INDEX = 'logs-log.log-test'; const FINAL_PIPELINE_ID = '.fleet_final_pipeline-1'; +// TODO: Use test package or move to input package version github.com/elastic/kibana/issues/154243 const LOG_INTEGRATION_VERSION = '1.1.2'; const FINAL_PIPELINE_VERSION = 1; @@ -33,14 +34,7 @@ export default function (providerContext: FtrProviderContext) { .expect(201); } - // FLAKY: https://github.com/elastic/kibana/issues/154220 - // FLAKY: https://github.com/elastic/kibana/issues/154221 - // FLAKY: https://github.com/elastic/kibana/issues/154222 - // FLAKY: https://github.com/elastic/kibana/issues/154223 - // FLAKY: https://github.com/elastic/kibana/issues/154224 - // FLAKY: https://github.com/elastic/kibana/issues/154225 - // FLAKY: https://github.com/elastic/kibana/issues/154226 - describe.skip('fleet_final_pipeline', () => { + describe('fleet_final_pipeline', () => { skipIfNoDockerRegistry(providerContext); before(async () => { await esArchiver.load('x-pack/test/functional/es_archives/fleet/empty_fleet_server'); diff --git a/x-pack/test/functional/apps/dashboard/group3/drilldowns/dashboard_to_dashboard_drilldown.ts b/x-pack/test/functional/apps/dashboard/group3/drilldowns/dashboard_to_dashboard_drilldown.ts index e72eb8b624806..7cd8d5c8a455d 100644 --- a/x-pack/test/functional/apps/dashboard/group3/drilldowns/dashboard_to_dashboard_drilldown.ts +++ b/x-pack/test/functional/apps/dashboard/group3/drilldowns/dashboard_to_dashboard_drilldown.ts @@ -124,8 +124,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.dashboard.waitForRenderComplete(); }; - // Failing: See https://github.com/elastic/kibana/issues/154071 - describe.skip('Dashboard to dashboard drilldown', function () { + describe('Dashboard to dashboard drilldown', function () { describe('Create & use drilldowns', () => { before(async () => { log.debug('Dashboard Drilldowns:initTests'); diff --git a/x-pack/test/functional/apps/infra/hosts_view.ts b/x-pack/test/functional/apps/infra/hosts_view.ts index 86ac3ee90eeb5..9ef3909691172 100644 --- a/x-pack/test/functional/apps/infra/hosts_view.ts +++ b/x-pack/test/functional/apps/infra/hosts_view.ts @@ -160,6 +160,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { esArchiver.load('x-pack/test/functional/es_archives/infra/metrics_hosts_processes'), kibanaServer.savedObjects.cleanStandardList(), ]); + await browser.setWindowSize(1600, 1200); }); after(() => { @@ -243,6 +244,26 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { expect(metadataTab).to.contain('Metadata'); }); + it('should navigate to Uptime after click', async () => { + await pageObjects.infraHostsView.clickFlyoutUptimeLink(); + await pageObjects.infraHome.waitForLoading(); + const url = await browser.getCurrentUrl(); + expect(url).to.contain( + 'app/uptime/?search=host.name%3A%20%22Jennys-MBP.fritz.box%22%20OR%20host.ip%3A%20%22192.168.1.79%22' + ); + await browser.goBack(); + await pageObjects.infraHome.waitForLoading(); + }); + + it('should navigate to APM services after click', async () => { + await pageObjects.infraHostsView.clickFlyoutApmServicesLink(); + await pageObjects.infraHome.waitForLoading(); + const url = await browser.getCurrentUrl(); + expect(url).to.contain('app/apm/services?kuery=host.hostname%3A%22Jennys-MBP.fritz.box%22'); + await browser.goBack(); + await pageObjects.infraHome.waitForLoading(); + }); + describe('should render processes tab', async () => { const processTitles = [ 'Total processes', diff --git a/x-pack/test/functional/apps/lens/open_in_lens/tsvb/table.ts b/x-pack/test/functional/apps/lens/open_in_lens/tsvb/table.ts index 29884da19a1fa..9d3112fc59374 100644 --- a/x-pack/test/functional/apps/lens/open_in_lens/tsvb/table.ts +++ b/x-pack/test/functional/apps/lens/open_in_lens/tsvb/table.ts @@ -88,6 +88,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { await visualBuilder.setStaticValue(10); await header.waitUntilLoadingHasFinished(); await visualBuilder.clickSeriesOption(); + await header.waitUntilLoadingHasFinished(); await visualBuilder.setFieldForAggregateBy('bytes'); await visualBuilder.setFunctionForAggregateFunction('Sum'); await header.waitUntilLoadingHasFinished(); diff --git a/x-pack/test/functional/apps/maps/group1/blended_vector_layer.js b/x-pack/test/functional/apps/maps/group1/blended_vector_layer.js index 67e6d7f93a4cd..28a68edf0e75c 100644 --- a/x-pack/test/functional/apps/maps/group1/blended_vector_layer.js +++ b/x-pack/test/functional/apps/maps/group1/blended_vector_layer.js @@ -35,7 +35,7 @@ export default function ({ getPageObjects, getService }) { it('should request clusters when zoomed to larger regions showing lots of data', async () => { await PageObjects.maps.setView(20, -90, 2); const { rawResponse: response } = await PageObjects.maps.getResponse(); - expect(response.aggregations.gridSplit.buckets.length).to.equal(17); + expect(response.aggregations.gridSplit.buckets.length).to.equal(15); }); it('should request documents when query narrows data', async () => { diff --git a/x-pack/test/functional/apps/maps/group1/documents_source/search_hits.js b/x-pack/test/functional/apps/maps/group1/documents_source/search_hits.js index 75649a23f68bf..0273441f3543e 100644 --- a/x-pack/test/functional/apps/maps/group1/documents_source/search_hits.js +++ b/x-pack/test/functional/apps/maps/group1/documents_source/search_hits.js @@ -120,7 +120,7 @@ export default function ({ getPageObjects, getService }) { const { lat, lon, zoom } = await PageObjects.maps.getView(); expect(Math.round(lat)).to.equal(43); expect(Math.round(lon)).to.equal(-102); - expect(Math.round(zoom)).to.equal(5); + expect(Math.round(zoom)).to.equal(4); }); }); diff --git a/x-pack/test/functional/apps/maps/group2/es_geo_grid_source.js b/x-pack/test/functional/apps/maps/group2/es_geo_grid_source.js index f38d1928aab52..49c31f951d3d3 100644 --- a/x-pack/test/functional/apps/maps/group2/es_geo_grid_source.js +++ b/x-pack/test/functional/apps/maps/group2/es_geo_grid_source.js @@ -53,7 +53,7 @@ export default function ({ getPageObjects, getService }) { }); it('should not rerequest when pan changes do not move map view area outside of buffer', async () => { - await PageObjects.maps.setView(DATA_CENTER_LAT + 10, DATA_CENTER_LON + 10, 1); + await PageObjects.maps.setView(DATA_CENTER_LAT + 5, DATA_CENTER_LON + 5, 1); const afterTimestamp = await getRequestTimestamp(); expect(afterTimestamp).to.equal(beforeTimestamp); }); diff --git a/x-pack/test/functional/apps/maps/group4/lens/choropleth_chart.ts b/x-pack/test/functional/apps/maps/group4/lens/choropleth_chart.ts index 32b4b44310e66..ba7f50befe844 100644 --- a/x-pack/test/functional/apps/maps/group4/lens/choropleth_chart.ts +++ b/x-pack/test/functional/apps/maps/group4/lens/choropleth_chart.ts @@ -13,9 +13,13 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { const testSubjects = getService('testSubjects'); const filterBar = getService('filterBar'); - // Failing: See https://github.com/elastic/kibana/issues/154065 - // Failing: See https://github.com/elastic/kibana/issues/154064 - describe.skip('choropleth chart', () => { + // Test requires access to Elastic Maps Service + // Do not skip test if failure is "Test requires access to Elastic Maps Service (EMS). EMS is not available" + describe('choropleth chart', () => { + before('', async () => { + await PageObjects.maps.expectEmsToBeAvailable(); + }); + it('should allow creation of choropleth chart', async () => { await PageObjects.visualize.navigateToNewVisualization(); await PageObjects.visualize.clickVisType('lens'); diff --git a/x-pack/test/functional/apps/ml/data_visualizer/types.ts b/x-pack/test/functional/apps/ml/data_visualizer/types.ts index 1ee0a9d8b6d12..3c243be210860 100644 --- a/x-pack/test/functional/apps/ml/data_visualizer/types.ts +++ b/x-pack/test/functional/apps/ml/data_visualizer/types.ts @@ -7,7 +7,7 @@ import type { FieldVisConfig } from '@kbn/data-visualizer-plugin/public/application/common/components/stats_table/types'; -export interface MetricFieldVisConfig extends FieldVisConfig { +export interface MetricFieldVisConfig extends Omit { fieldName: string; statsMaxDecimalPlaces: number; docCountFormatted: string; @@ -16,7 +16,7 @@ export interface MetricFieldVisConfig extends FieldVisConfig { hasActionMenu?: boolean; } -export interface NonMetricFieldVisConfig extends FieldVisConfig { +export interface NonMetricFieldVisConfig extends Omit { fieldName: string; docCountFormatted: string; exampleCount: number; diff --git a/x-pack/test/functional/es_archives/observability/alerts/data.json.gz b/x-pack/test/functional/es_archives/observability/alerts/data.json.gz index 9576db4351bb2..72d24a0b36668 100644 Binary files a/x-pack/test/functional/es_archives/observability/alerts/data.json.gz and b/x-pack/test/functional/es_archives/observability/alerts/data.json.gz differ diff --git a/x-pack/test/functional/es_archives/rule_registry/alerts/data.json b/x-pack/test/functional/es_archives/rule_registry/alerts/data.json index ce709e126266f..ff401dda06314 100644 --- a/x-pack/test/functional/es_archives/rule_registry/alerts/data.json +++ b/x-pack/test/functional/es_archives/rule_registry/alerts/data.json @@ -128,7 +128,7 @@ { "type": "doc", "value": { - "index": ".alerts-observability.logs.alerts-default", + "index": ".alerts-observability.logs.alerts-000001", "id": "123456789XYZ", "source": { "event.kind": "signal", @@ -149,7 +149,7 @@ { "type": "doc", "value": { - "index": ".alerts-observability.logs.alerts-default", + "index": ".alerts-observability.logs.alerts-000001", "id": "space1alertLogs", "source": { "event.kind": "signal", diff --git a/x-pack/test/functional/es_archives/rule_registry/alerts/mappings.json b/x-pack/test/functional/es_archives/rule_registry/alerts/mappings.json index 16229e93e6255..77e129ffe6e0c 100644 --- a/x-pack/test/functional/es_archives/rule_registry/alerts/mappings.json +++ b/x-pack/test/functional/es_archives/rule_registry/alerts/mappings.json @@ -53,7 +53,7 @@ { "type": "index", "value": { - "index": ".alerts-observability.logs.alerts-default", + "index": ".alerts-observability.logs.alerts-000001", "mappings": { "properties": { "message": { diff --git a/x-pack/test/functional/es_archives/security_solution/alerts/8.1.0/mappings.json.gz b/x-pack/test/functional/es_archives/security_solution/alerts/8.1.0/mappings.json.gz index 27ba06da3ad3d..f50ef0418afd4 100644 Binary files a/x-pack/test/functional/es_archives/security_solution/alerts/8.1.0/mappings.json.gz and b/x-pack/test/functional/es_archives/security_solution/alerts/8.1.0/mappings.json.gz differ diff --git a/x-pack/test/functional/es_archives/session_view/alerts/mappings.json b/x-pack/test/functional/es_archives/session_view/alerts/mappings.json index ada228ec8e799..395b1ecf62803 100644 --- a/x-pack/test/functional/es_archives/session_view/alerts/mappings.json +++ b/x-pack/test/functional/es_archives/session_view/alerts/mappings.json @@ -3,7 +3,6 @@ "value": { "aliases": { ".alerts-security.alerts-default": { - "is_write_index": true }, ".siem-signals-default": { "is_write_index": false diff --git a/x-pack/test/functional/page_objects/gis_page.ts b/x-pack/test/functional/page_objects/gis_page.ts index 0f58aa3376600..d37667540e9d6 100644 --- a/x-pack/test/functional/page_objects/gis_page.ts +++ b/x-pack/test/functional/page_objects/gis_page.ts @@ -44,6 +44,26 @@ export class GisPageObject extends FtrService { this.basePath = basePath; } + async expectEmsToBeAvailable() { + this.log.debug(`expectEmsToBeAvailable`); + await this.openNewMap(); + await this.clickAddLayer(); + await this.testSubjects.click('emsBoundaries'); + try { + const emsFileElement = await this.testSubjects.find('emsFileSelect', 120000); // large timeout for EMS request + if (!emsFileElement) { + throw new Error('Unable to find EMS file select'); + } + const isDisabled = await this.comboBox.isDisabled(emsFileElement); + if (isDisabled) { + throw new Error('EMS file select is disabled'); + } + } catch (e) { + this.log.debug(`EMS is not available, error: ${e.message}`); + throw new Error('Test requires access to Elastic Maps Service (EMS). EMS is not available'); + } + } + async setAbsoluteRange(start: string, end: string) { await this.timePicker.setAbsoluteRange(start, end); await this.waitForLayersToLoad(); diff --git a/x-pack/test/functional/page_objects/infra_hosts_view.ts b/x-pack/test/functional/page_objects/infra_hosts_view.ts index d608a7a98a335..cc8582e43d08b 100644 --- a/x-pack/test/functional/page_objects/infra_hosts_view.ts +++ b/x-pack/test/functional/page_objects/infra_hosts_view.ts @@ -36,6 +36,14 @@ export function InfraHostsViewProvider({ getService }: FtrProviderContext) { return testSubjects.click('infraProcessRowButton'); }, + async clickFlyoutUptimeLink() { + return testSubjects.click('hostsView-flyout-uptime-link'); + }, + + async clickFlyoutApmServicesLink() { + return testSubjects.click('hostsView-flyout-apm-services-link'); + }, + async getHostsLandingPageDisabled() { const container = await testSubjects.find('hostView-no-enable-access'); const containerText = await container.getVisibleText(); diff --git a/x-pack/test/functional/screenshots/baseline/flights_map.png b/x-pack/test/functional/screenshots/baseline/flights_map.png index dd4f9f4809504..fa63492c31858 100644 Binary files a/x-pack/test/functional/screenshots/baseline/flights_map.png and b/x-pack/test/functional/screenshots/baseline/flights_map.png differ diff --git a/x-pack/test/functional/screenshots/baseline/web_logs_map.png b/x-pack/test/functional/screenshots/baseline/web_logs_map.png index c2cfaaf847030..77e84c339f3dc 100644 Binary files a/x-pack/test/functional/screenshots/baseline/web_logs_map.png and b/x-pack/test/functional/screenshots/baseline/web_logs_map.png differ diff --git a/x-pack/test/functional/services/observability/components/alert_summary_widget.ts b/x-pack/test/functional/services/observability/components/alert_summary_widget.ts index 72372c22b541d..61773786bca6e 100644 --- a/x-pack/test/functional/services/observability/components/alert_summary_widget.ts +++ b/x-pack/test/functional/services/observability/components/alert_summary_widget.ts @@ -11,6 +11,11 @@ const COMPACT_COMPONENT_SELECTOR = 'alertSummaryWidgetCompact'; const COMPACT_TIME_RANGE_TITLE_SELECTOR = 'timeRangeTitle'; const COMPACT_ACTIVE_ALERTS_SELECTOR = 'activeAlerts'; +const FULL_SIZE_COMPONENT_SELECTOR = 'alertSummaryWidgetFullSize'; + +const ACTIVE_ALERT_SELECTOR = 'activeAlertCount'; +const TOTAL_ALERT_SELECTOR = 'totalAlertCount'; + export function ObservabilityAlertSummaryWidgetProvider({ getService }: FtrProviderContext) { const testSubjects = getService('testSubjects'); @@ -30,10 +35,25 @@ export function ObservabilityAlertSummaryWidgetProvider({ getService }: FtrProvi return await testSubjects.find(COMPACT_COMPONENT_SELECTOR); }; + const getFullSizeComponentSelectorOrFail = async () => { + return await testSubjects.existOrFail(FULL_SIZE_COMPONENT_SELECTOR); + }; + + const getActiveAlertCount = async () => { + return (await testSubjects.find(ACTIVE_ALERT_SELECTOR)).getVisibleText(); + }; + + const getTotalAlertCount = async () => { + return (await testSubjects.find(TOTAL_ALERT_SELECTOR)).getVisibleText(); + }; + return { getCompactActiveAlertSelector, getCompactComponentSelectorOrFail, getCompactTimeRangeTitle, getCompactWidgetSelector, + getFullSizeComponentSelectorOrFail, + getActiveAlertCount, + getTotalAlertCount, }; } diff --git a/x-pack/test/functional_with_es_ssl/apps/cases/group2/attachment_framework.ts b/x-pack/test/functional_with_es_ssl/apps/cases/group2/attachment_framework.ts index bb8d4b7b86664..9b18dcbca8ebc 100644 --- a/x-pack/test/functional_with_es_ssl/apps/cases/group2/attachment_framework.ts +++ b/x-pack/test/functional_with_es_ssl/apps/cases/group2/attachment_framework.ts @@ -75,7 +75,7 @@ export default ({ getPageObject, getService }: FtrProviderContext) => { const validateAttachment = async (type: string, attachmentId?: string) => { await testSubjects.existOrFail(`comment-${type}-.test`); await testSubjects.existOrFail(`copy-link-${attachmentId}`); - await testSubjects.existOrFail('test-attachment-action'); + await testSubjects.existOrFail(`attachment-.test-${attachmentId}-arrowRight`); }; /** diff --git a/x-pack/test/functional_with_es_ssl/apps/discover_ml_uptime/discover/search_source_alert.ts b/x-pack/test/functional_with_es_ssl/apps/discover_ml_uptime/discover/search_source_alert.ts index c9384162fcec3..acccceb2f8b89 100644 --- a/x-pack/test/functional_with_es_ssl/apps/discover_ml_uptime/discover/search_source_alert.ts +++ b/x-pack/test/functional_with_es_ssl/apps/discover_ml_uptime/discover/search_source_alert.ts @@ -307,10 +307,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { expect(await titleElem.getAttribute('value')).to.equal(dataView); }; - // FLAKY: https://github.com/elastic/kibana/issues/152477 - // FLAKY: https://github.com/elastic/kibana/issues/152478 - // FLAKY: https://github.com/elastic/kibana/issues/152479 - describe.skip('Search source Alert', () => { + describe('Search source Alert', () => { before(async () => { await security.testUser.setRoles(['discover_alert']); diff --git a/x-pack/test/functional_with_es_ssl/plugins/cases/public/attachments/external_reference.tsx b/x-pack/test/functional_with_es_ssl/plugins/cases/public/attachments/external_reference.tsx index 76a4c8eabd0c7..dae5945a3d687 100644 --- a/x-pack/test/functional_with_es_ssl/plugins/cases/public/attachments/external_reference.tsx +++ b/x-pack/test/functional_with_es_ssl/plugins/cases/public/attachments/external_reference.tsx @@ -5,23 +5,11 @@ * 2.0. */ -import React, { lazy } from 'react'; -import { EuiButtonIcon } from '@elastic/eui'; +import { lazy } from 'react'; import { ExternalReferenceAttachmentType } from '@kbn/cases-plugin/public/client/attachment_framework/types'; const AttachmentContentLazy = lazy(() => import('./external_references_content')); -const AttachmentActions: React.FC = () => { - return ( - {}} - iconType="arrowRight" - aria-label="See attachment" - /> - ); -}; - export const getExternalReferenceAttachmentRegular = (): ExternalReferenceAttachmentType => ({ id: '.test', icon: 'casesApp', @@ -29,7 +17,9 @@ export const getExternalReferenceAttachmentRegular = (): ExternalReferenceAttach getAttachmentViewObject: () => ({ event: 'added a chart', timelineAvatar: 'casesApp', - actions: , + getActions: () => [ + { label: 'See attachment', onClick: () => {}, isPrimary: true, iconType: 'arrowRight' }, + ], children: AttachmentContentLazy, }), }); diff --git a/x-pack/test/functional_with_es_ssl/plugins/cases/public/attachments/persistable_state.tsx b/x-pack/test/functional_with_es_ssl/plugins/cases/public/attachments/persistable_state.tsx index e67c8c4c269fc..2159c9c7b551d 100644 --- a/x-pack/test/functional_with_es_ssl/plugins/cases/public/attachments/persistable_state.tsx +++ b/x-pack/test/functional_with_es_ssl/plugins/cases/public/attachments/persistable_state.tsx @@ -11,20 +11,8 @@ import { PersistableStateAttachmentType, PersistableStateAttachmentViewProps, } from '@kbn/cases-plugin/public/client/attachment_framework/types'; -import { EuiButtonIcon } from '@elastic/eui'; import { EmbeddableComponentProps, TypedLensByValueInput } from '@kbn/lens-plugin/public'; -const AttachmentActions: React.FC = () => { - return ( - {}} - iconType="arrowRight" - aria-label="See attachment" - /> - ); -}; - const getLazyComponent = ( EmbeddableComponent: React.ComponentType ): React.LazyExoticComponent> => @@ -61,7 +49,9 @@ export const getPersistableStateAttachmentRegular = ( getAttachmentViewObject: () => ({ event: 'added an embeddable', timelineAvatar: 'casesApp', - actions: , + getActions: () => [ + { label: 'See attachment', onClick: () => {}, isPrimary: true, iconType: 'arrowRight' }, + ], children: getLazyComponent(EmbeddableComponent), }), }); diff --git a/x-pack/test/observability_functional/apps/observability/index.ts b/x-pack/test/observability_functional/apps/observability/index.ts index e797d6812ed8d..67c00ef846a2c 100644 --- a/x-pack/test/observability_functional/apps/observability/index.ts +++ b/x-pack/test/observability_functional/apps/observability/index.ts @@ -12,6 +12,7 @@ export default function ({ loadTestFile }: FtrProviderContext) { loadTestFile(require.resolve('./pages/alerts')); loadTestFile(require.resolve('./pages/alerts/add_to_case')); loadTestFile(require.resolve('./pages/alerts/alert_status')); + loadTestFile(require.resolve('./pages/alerts/alert_summary_widget')); loadTestFile(require.resolve('./pages/alerts/pagination')); loadTestFile(require.resolve('./pages/alerts/rule_stats')); loadTestFile(require.resolve('./pages/alerts/state_synchronization')); diff --git a/x-pack/test/observability_functional/apps/observability/pages/alerts/alert_summary_widget.ts b/x-pack/test/observability_functional/apps/observability/pages/alerts/alert_summary_widget.ts new file mode 100644 index 0000000000000..718a3ac643cff --- /dev/null +++ b/x-pack/test/observability_functional/apps/observability/pages/alerts/alert_summary_widget.ts @@ -0,0 +1,45 @@ +/* + * 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 expect from '@kbn/expect'; +import { FtrProviderContext } from '../../../../ftr_provider_context'; + +const ALL_ALERTS = 40; +const ACTIVE_ALERTS = 10; + +export default ({ getService }: FtrProviderContext) => { + const esArchiver = getService('esArchiver'); + + describe('Alert summary widget >', function () { + this.tags('includeFirefox'); + + const observability = getService('observability'); + + before(async () => { + await esArchiver.load('x-pack/test/functional/es_archives/observability/alerts'); + await esArchiver.load('x-pack/test/functional/es_archives/infra/metrics_and_logs'); + await observability.alerts.common.navigateToTimeWithData(); + }); + + after(async () => { + await esArchiver.unload('x-pack/test/functional/es_archives/observability/alerts'); + await esArchiver.unload('x-pack/test/functional/es_archives/infra/metrics_and_logs'); + }); + + it('shows number of total and active alerts', async () => { + await observability.components.alertSummaryWidget.getFullSizeComponentSelectorOrFail(); + + const activeAlertCount = + await observability.components.alertSummaryWidget.getActiveAlertCount(); + const totalAlertCount = + await observability.components.alertSummaryWidget.getTotalAlertCount(); + + expect(activeAlertCount).to.be(`${ACTIVE_ALERTS} `); + expect(totalAlertCount).to.be(`${ALL_ALERTS}`); + }); + }); +}; diff --git a/x-pack/test/rule_registry/security_and_spaces/tests/basic/get_browser_fields_by_feature_id.ts b/x-pack/test/rule_registry/security_and_spaces/tests/basic/get_browser_fields_by_feature_id.ts index 50504efd75ac0..c32a2b21b54a3 100644 --- a/x-pack/test/rule_registry/security_and_spaces/tests/basic/get_browser_fields_by_feature_id.ts +++ b/x-pack/test/rule_registry/security_and_spaces/tests/basic/get_browser_fields_by_feature_id.ts @@ -56,7 +56,20 @@ export default ({ getService }: FtrProviderContext) => { 'logs', 'uptime', ]); - expect(Object.keys(browserFields)).to.eql(['base', 'event', 'kibana', 'message']); + expect(Object.keys(browserFields)).to.eql([ + 'base', + 'agent', + 'anomaly', + 'ecs', + 'error', + 'event', + 'kibana', + 'message', + 'monitor', + 'observer', + 'tls', + 'url', + ]); }); it(`${superUser.username} should NOT be able to get browser fields for siem featureId`, async () => { diff --git a/x-pack/test/rule_registry/spaces_only/tests/basic/bootstrap.ts b/x-pack/test/rule_registry/spaces_only/tests/basic/bootstrap.ts deleted file mode 100644 index ccae5189f6d30..0000000000000 --- a/x-pack/test/rule_registry/spaces_only/tests/basic/bootstrap.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* - * 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 expect from '@kbn/expect'; -import type { FtrProviderContext } from '../../../common/ftr_provider_context'; -import { obsOnlyRead } from '../../../common/lib/authentication/users'; -import { getAlertsTargetIndices } from '../../../common/lib/helpers'; - -// eslint-disable-next-line import/no-default-export -export default function registryRulesApiTest({ getService }: FtrProviderContext) { - const es = getService('es'); - - describe('Rule Registry API', () => { - describe('with read permissions', () => { - it('does not bootstrap the apm rule indices', async () => { - const { body: targetIndices } = await getAlertsTargetIndices( - getService, - obsOnlyRead, - 'space1' - ); - const errorOrUndefined = await es.indices - .get({ - index: targetIndices[0], - expand_wildcards: 'open', - allow_no_indices: false, - }) - .then(() => {}) - .catch((error) => { - return error.toString(); - }); - - expect(errorOrUndefined).not.to.be(undefined); - - expect(errorOrUndefined).to.contain('index_not_found_exception'); - }); - }); - }); -} diff --git a/x-pack/test/rule_registry/spaces_only/tests/basic/index.ts b/x-pack/test/rule_registry/spaces_only/tests/basic/index.ts index f47b4b6254ff2..01be475d18132 100644 --- a/x-pack/test/rule_registry/spaces_only/tests/basic/index.ts +++ b/x-pack/test/rule_registry/spaces_only/tests/basic/index.ts @@ -18,8 +18,5 @@ export default ({ loadTestFile, getService }: FtrProviderContext): void => { after(async () => { await deleteSpaces(getService); }); - - // Basic - loadTestFile(require.resolve('./bootstrap')); }); }; diff --git a/x-pack/test/rule_registry/spaces_only/tests/trial/create_rule.ts b/x-pack/test/rule_registry/spaces_only/tests/trial/create_rule.ts index 9a6f1dfa6e972..453ca383008d4 100644 --- a/x-pack/test/rule_registry/spaces_only/tests/trial/create_rule.ts +++ b/x-pack/test/rule_registry/spaces_only/tests/trial/create_rule.ts @@ -46,20 +46,6 @@ export default function registryRulesApiTest({ getService }: FtrProviderContext) describe('Rule Registry API', async () => { describe('with write permissions', () => { - it('does not bootstrap indices on plugin startup', async () => { - const { body: targetIndices } = await getAlertsTargetIndices(getService, obsOnly, SPACE_ID); - try { - const res = await es.indices.get({ - index: targetIndices[0], - expand_wildcards: 'open', - allow_no_indices: true, - }); - expect(res).to.be.empty(); - } catch (exc) { - expect(exc.statusCode).to.eql(404); - } - }); - describe('when creating a rule', () => { let createResponse: { alert: Rule; diff --git a/x-pack/test/security_solution_endpoint/services/endpoint.ts b/x-pack/test/security_solution_endpoint/services/endpoint.ts index 6262ae62f8f8f..277977acf95a3 100644 --- a/x-pack/test/security_solution_endpoint/services/endpoint.ts +++ b/x-pack/test/security_solution_endpoint/services/endpoint.ts @@ -116,7 +116,7 @@ export class EndpointTestResources extends FtrService { customIndexFn, } = options; - if (waitUntilTransformed) { + if (waitUntilTransformed && customIndexFn) { // need this before indexing docs so that the united transform doesn't // create a checkpoint with a timestamp after the doc timestamps await this.stopTransform(metadataTransformPrefix); @@ -139,15 +139,17 @@ export class EndpointTestResources extends FtrService { alertsPerHost, enableFleetIntegration, undefined, - CurrentKibanaVersionDocGenerator, - false + CurrentKibanaVersionDocGenerator ); - if (waitUntilTransformed) { + if (waitUntilTransformed && customIndexFn) { await this.startTransform(metadataTransformPrefix); const metadataIds = Array.from(new Set(indexedData.hosts.map((host) => host.agent.id))); await this.waitForEndpoints(metadataIds, waitTimeout); await this.startTransform(METADATA_UNITED_TRANSFORM); + } + + if (waitUntilTransformed) { const agentIds = Array.from(new Set(indexedData.agents.map((agent) => agent.agent!.id))); await this.waitForUnitedEndpoints(agentIds, waitTimeout); } diff --git a/yarn.lock b/yarn.lock index 75a526d5d80c5..4fe380b77943b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1460,10 +1460,10 @@ dependencies: object-hash "^1.3.0" -"@elastic/charts@54.0.0": - version "54.0.0" - resolved "https://registry.yarnpkg.com/@elastic/charts/-/charts-54.0.0.tgz#97e19c87c94d4282c12440e9d5703048232bc2b8" - integrity sha512-gyAgBrRKRg+QxaOluAy1tJXm3gv95IuZRL+/QMUR7tuAwqfD+Bi3eFUoqMhVJCRmhYJa2iDmLMjb7Mkb7HZJgw== +"@elastic/charts@55.0.0": + version "55.0.0" + resolved "https://registry.yarnpkg.com/@elastic/charts/-/charts-55.0.0.tgz#df9a4e9b0a84a613f103011d99f120cb528c4dc9" + integrity sha512-a4UIieTi04CPHxfwztDe36xoPFkp+I4tRPXWXobv/aG/zTd4AwruRyL981RiV2Tv8Mrc5jpCJFgfadNoPrL3pg== dependencies: "@popperjs/core" "^2.4.0" bezier-easing "^2.1.0" @@ -4609,6 +4609,10 @@ version "0.0.0" uid "" +"@kbn/observability-alert-details@link:x-pack/packages/observability/alert_details": + version "0.0.0" + uid "" + "@kbn/observability-fixtures-plugin@link:x-pack/test/cases_api_integration/common/plugins/observability": version "0.0.0" uid "" @@ -11115,7 +11119,7 @@ bonjour-service@^1.0.11: fast-deep-equal "^3.1.3" multicast-dns "^7.2.5" -boolbase@^1.0.0, boolbase@~1.0.0: +boolbase@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/boolbase/-/boolbase-1.0.0.tgz#68dff5fbe60c51eb37725ea9e3ed310dcc1e776e" integrity sha1-aN/1++YMUes3cl6p4+0xDcwed24= @@ -11793,29 +11797,30 @@ check-more-types@2.24.0, check-more-types@^2.24.0: resolved "https://registry.yarnpkg.com/check-more-types/-/check-more-types-2.24.0.tgz#1420ffb10fd444dcfc79b43891bbfffd32a84600" integrity sha1-FCD/sQ/URNz8ebQ4kbv//TKoRgA= -cheerio-select@^1.5.0: - version "1.5.0" - resolved "https://registry.yarnpkg.com/cheerio-select/-/cheerio-select-1.5.0.tgz#faf3daeb31b17c5e1a9dabcee288aaf8aafa5823" - integrity sha512-qocaHPv5ypefh6YNxvnbABM07KMxExbtbfuJoIie3iZXX1ERwYmJcIiRrr9H05ucQP1k28dav8rpdDgjQd8drg== +cheerio-select@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/cheerio-select/-/cheerio-select-2.1.0.tgz#4d8673286b8126ca2a8e42740d5e3c4884ae21b4" + integrity sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g== dependencies: - css-select "^4.1.3" - css-what "^5.0.1" - domelementtype "^2.2.0" - domhandler "^4.2.0" - domutils "^2.7.0" + boolbase "^1.0.0" + css-select "^5.1.0" + css-what "^6.1.0" + domelementtype "^2.3.0" + domhandler "^5.0.3" + domutils "^3.0.1" cheerio@^1.0.0-rc.10, cheerio@^1.0.0-rc.3: - version "1.0.0-rc.10" - resolved "https://registry.yarnpkg.com/cheerio/-/cheerio-1.0.0-rc.10.tgz#2ba3dcdfcc26e7956fc1f440e61d51c643379f3e" - integrity sha512-g0J0q/O6mW8z5zxQ3A8E8J1hUgp4SMOvEoW/x84OwyHKe/Zccz83PVT4y5Crcr530FV6NgmKI1qvGTKVl9XXVw== - dependencies: - cheerio-select "^1.5.0" - dom-serializer "^1.3.2" - domhandler "^4.2.0" - htmlparser2 "^6.1.0" - parse5 "^6.0.1" - parse5-htmlparser2-tree-adapter "^6.0.1" - tslib "^2.2.0" + version "1.0.0-rc.12" + resolved "https://registry.yarnpkg.com/cheerio/-/cheerio-1.0.0-rc.12.tgz#788bf7466506b1c6bf5fae51d24a2c4d62e47683" + integrity sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q== + dependencies: + cheerio-select "^2.1.0" + dom-serializer "^2.0.0" + domhandler "^5.0.3" + domutils "^3.0.1" + htmlparser2 "^8.0.1" + parse5 "^7.0.0" + parse5-htmlparser2-tree-adapter "^7.0.0" chokidar@3.5.3, chokidar@^2.1.2, chokidar@^2.1.8, chokidar@^3.4.0, chokidar@^3.4.1, chokidar@^3.4.2, chokidar@^3.5.3: version "3.5.3" @@ -12774,26 +12779,27 @@ css-loader@^3.4.2, css-loader@^3.6.0: schema-utils "^2.7.0" semver "^6.3.0" -css-select@^1.1.0: - version "1.2.0" - resolved "https://registry.yarnpkg.com/css-select/-/css-select-1.2.0.tgz#2b3a110539c5355f1cd8d314623e870b121ec858" - integrity sha1-KzoRBTnFNV8c2NMUYj6HCxIeyFg= +css-select@^4.1.3: + version "4.3.0" + resolved "https://registry.yarnpkg.com/css-select/-/css-select-4.3.0.tgz#db7129b2846662fd8628cfc496abb2b59e41529b" + integrity sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ== dependencies: - boolbase "~1.0.0" - css-what "2.1" - domutils "1.5.1" - nth-check "~1.0.1" + boolbase "^1.0.0" + css-what "^6.0.1" + domhandler "^4.3.1" + domutils "^2.8.0" + nth-check "^2.0.1" -css-select@^4.1.3: - version "4.1.3" - resolved "https://registry.yarnpkg.com/css-select/-/css-select-4.1.3.tgz#a70440f70317f2669118ad74ff105e65849c7067" - integrity sha512-gT3wBNd9Nj49rAbmtFHj1cljIAOLYSX1nZ8CB7TBO3INYckygm5B7LISU/szY//YmdiSLbJvDLOx9VnMVpMBxA== +css-select@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/css-select/-/css-select-5.1.0.tgz#b8ebd6554c3637ccc76688804ad3f6a6fdaea8a6" + integrity sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg== dependencies: boolbase "^1.0.0" - css-what "^5.0.0" - domhandler "^4.2.0" - domutils "^2.6.0" - nth-check "^2.0.0" + css-what "^6.1.0" + domhandler "^5.0.2" + domutils "^3.0.1" + nth-check "^2.0.1" css-to-react-native@^3.0.0: version "3.0.0" @@ -12812,15 +12818,10 @@ css-tree@^1.0.0-alpha.28, css-tree@^1.1.2, css-tree@^1.1.3: mdn-data "2.0.14" source-map "^0.6.1" -css-what@2.1: - version "2.1.3" - resolved "https://registry.yarnpkg.com/css-what/-/css-what-2.1.3.tgz#a6d7604573365fe74686c3f311c56513d88285f2" - integrity sha512-a+EPoD+uZiNfh+5fxw2nO9QwFa6nJe2Or35fGY6Ipw1R3R4AGz1d1TEZrCegvw2YTmZ0jXirGYlzxxpYSHwpEg== - -css-what@^5.0.0, css-what@^5.0.1: - version "5.1.0" - resolved "https://registry.yarnpkg.com/css-what/-/css-what-5.1.0.tgz#3f7b707aadf633baf62c2ceb8579b545bb40f7fe" - integrity sha512-arSMRWIIFY0hV8pIxZMEfmMI47Wj3R/aWpZDDxWYCPEiOMv6tfOrnpDtgxBYPEQD4V0Y/958+1TdC3iWTFcUPw== +css-what@^6.0.1, css-what@^6.1.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/css-what/-/css-what-6.1.0.tgz#fb5effcf76f1ddea2c81bdfaa4de44e79bac70f4" + integrity sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw== css.escape@^1.5.1: version "1.5.1" @@ -13922,7 +13923,7 @@ dom-accessibility-api@^0.5.6, dom-accessibility-api@^0.5.9: resolved "https://registry.yarnpkg.com/dom-accessibility-api/-/dom-accessibility-api-0.5.13.tgz#102ee5f25eacce09bdf1cfa5a298f86da473be4b" integrity sha512-R305kwb5CcMDIpSHUnLyIAp7SrSPBx6F0VfQFB3M75xVMHhXJJIdePYgbPPh1o57vCHNu5QztokWUPsLjWzFqw== -dom-converter@~0.2: +dom-converter@^0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/dom-converter/-/dom-converter-0.2.0.tgz#6721a9daee2e293682955b6afe416771627bb768" integrity sha512-gd3ypIPfOMr9h5jIKq8E3sHOTCjeirnl0WK5ZdS1AW0Odt0b1PaWaHdJ4Qk4klv+YB9aJBS7mESXjFoDQPu6DA== @@ -13937,15 +13938,7 @@ dom-helpers@^5.0.1, dom-helpers@^5.1.3: "@babel/runtime" "^7.8.7" csstype "^2.6.7" -dom-serializer@0: - version "0.2.1" - resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-0.2.1.tgz#13650c850daffea35d8b626a4cfc4d3a17643fdb" - integrity sha512-sK3ujri04WyjwQXVoK4PU3y8ula1stq10GJZpqHIUgoGZdsGzAGu65BnU3d08aTVSvO7mGPZUc0wTEDL+qGE0Q== - dependencies: - domelementtype "^2.0.1" - entities "^2.0.0" - -dom-serializer@^1.0.1, dom-serializer@^1.3.2: +dom-serializer@^1.0.1: version "1.3.2" resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-1.3.2.tgz#6206437d32ceefaec7161803230c7a20bc1b4d91" integrity sha512-5c54Bk5Dw4qAxNOI1pFEizPSjVsx5+bpJKmL2kPn8JhBUq2q09tTCa3mjijun2NfK78NMouDYNMBkOrPZiS+ig== @@ -13954,6 +13947,15 @@ dom-serializer@^1.0.1, dom-serializer@^1.3.2: domhandler "^4.2.0" entities "^2.0.0" +dom-serializer@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/dom-serializer/-/dom-serializer-2.0.0.tgz#e41b802e1eedf9f6cae183ce5e622d789d7d8e53" + integrity sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg== + dependencies: + domelementtype "^2.3.0" + domhandler "^5.0.2" + entities "^4.2.0" + dom-walk@^0.1.0: version "0.1.1" resolved "https://registry.yarnpkg.com/dom-walk/-/dom-walk-0.1.1.tgz#672226dc74c8f799ad35307df936aba11acd6018" @@ -13964,16 +13966,16 @@ domain-browser@^1.1.1: resolved "https://registry.yarnpkg.com/domain-browser/-/domain-browser-1.2.0.tgz#3d31f50191a6749dd1375a7f522e823d42e54eda" integrity sha512-jnjyiM6eRyZl2H+W8Q/zLMA481hzi0eszAaBUzIVnmYVDBbnLxVNnfu1HgEBvCbL+71FrxMl3E6lpKH7Ge3OXA== -domelementtype@1: - version "1.3.1" - resolved "https://registry.yarnpkg.com/domelementtype/-/domelementtype-1.3.1.tgz#d048c44b37b0d10a7f2a3d5fee3f4333d790481f" - integrity sha512-BSKB+TSpMpFI/HOxCNr1O8aMOTZ8hT3pM3GQ0w/mWRmkhEDSFJkkyzz4XQsBV44BChwGkrDfMyjVD0eA2aFV3w== - domelementtype@^2.0.1, domelementtype@^2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/domelementtype/-/domelementtype-2.2.0.tgz#9a0b6c2782ed6a1c7323d42267183df9bd8b1d57" integrity sha512-DtBMo82pv1dFtUmHyr48beiuq792Sxohr+8Hm9zoxklYPfa6n0Z3Byjj2IV7bmr2IyqClnqEQhfgHJJ5QF0R5A== +domelementtype@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/domelementtype/-/domelementtype-2.3.0.tgz#5c45e8e869952626331d7aab326d01daf65d589d" + integrity sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw== + domexception@^2.0.1: version "2.0.1" resolved "https://registry.yarnpkg.com/domexception/-/domexception-2.0.1.tgz#fb44aefba793e1574b0af6aed2801d057529f304" @@ -13988,13 +13990,6 @@ domexception@^4.0.0: dependencies: webidl-conversions "^7.0.0" -domhandler@2.1: - version "2.1.0" - resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-2.1.0.tgz#d2646f5e57f6c3bab11cf6cb05d3c0acf7412594" - integrity sha1-0mRvXlf2w7qxHPbLBdPArPdBJZQ= - dependencies: - domelementtype "1" - domhandler@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-3.0.0.tgz#51cd13efca31da95bbb0c5bee3a48300e333b3e9" @@ -14009,22 +14004,21 @@ domhandler@^4.0.0, domhandler@^4.2.0: dependencies: domelementtype "^2.2.0" -domutils@1.1: - version "1.1.6" - resolved "https://registry.yarnpkg.com/domutils/-/domutils-1.1.6.tgz#bddc3de099b9a2efacc51c623f28f416ecc57485" - integrity sha1-vdw94Jm5ou+sxRxiPyj0FuzFdIU= +domhandler@^4.3.1: + version "4.3.1" + resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-4.3.1.tgz#8d792033416f59d68bc03a5aa7b018c1ca89279c" + integrity sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ== dependencies: - domelementtype "1" + domelementtype "^2.2.0" -domutils@1.5.1: - version "1.5.1" - resolved "https://registry.yarnpkg.com/domutils/-/domutils-1.5.1.tgz#dcd8488a26f563d61079e48c9f7b7e32373682cf" - integrity sha1-3NhIiib1Y9YQeeSMn3t+Mjc2gs8= +domhandler@^5.0.1, domhandler@^5.0.2, domhandler@^5.0.3: + version "5.0.3" + resolved "https://registry.yarnpkg.com/domhandler/-/domhandler-5.0.3.tgz#cc385f7f751f1d1fc650c21374804254538c7d31" + integrity sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w== dependencies: - dom-serializer "0" - domelementtype "1" + domelementtype "^2.3.0" -domutils@^2.0.0, domutils@^2.5.2, domutils@^2.6.0, domutils@^2.7.0: +domutils@^2.0.0, domutils@^2.5.2, domutils@^2.8.0: version "2.8.0" resolved "https://registry.yarnpkg.com/domutils/-/domutils-2.8.0.tgz#4437def5db6e2d1f5d6ee859bd95ca7d02048135" integrity sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A== @@ -14033,6 +14027,15 @@ domutils@^2.0.0, domutils@^2.5.2, domutils@^2.6.0, domutils@^2.7.0: domelementtype "^2.2.0" domhandler "^4.2.0" +domutils@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/domutils/-/domutils-3.0.1.tgz#696b3875238338cb186b6c0612bd4901c89a4f1c" + integrity sha512-z08c1l761iKhDFtfXO04C7kTdPBLi41zwOZl00WS8b5eiaebNpY00HKbztwBq+e3vyqWNwWF3mP9YLUeqIrF+Q== + dependencies: + dom-serializer "^2.0.0" + domelementtype "^2.3.0" + domhandler "^5.0.1" + dot-case@^3.0.3, dot-case@^3.0.4: version "3.0.4" resolved "https://registry.yarnpkg.com/dot-case/-/dot-case-3.0.4.tgz#9b2b670d00a431667a8a75ba29cd1b98809ce751" @@ -14406,7 +14409,7 @@ entities@^2.0.0: resolved "https://registry.yarnpkg.com/entities/-/entities-2.2.0.tgz#098dc90ebb83d8dffa089d55256b351d34c4da55" integrity sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A== -entities@^4.4.0: +entities@^4.2.0, entities@^4.4.0: version "4.4.0" resolved "https://registry.yarnpkg.com/entities/-/entities-4.4.0.tgz#97bdaba170339446495e653cfd2db78962900174" integrity sha512-oYp7156SP8LkeGD0GF85ad1X9Ai79WtRsZ2gxJqtBuzH+98YUV6jkHEKlZkMbcrjJjIVJNIDP/3WL9wQkoPbWA== @@ -17201,16 +17204,16 @@ html-void-elements@^1.0.0: integrity sha512-uE/TxKuyNIcx44cIWnjr/rfIATDH7ZaOMmstu0CwhFG1Dunhlp4OC6/NMbhiwoq5BpW0ubi303qnEk/PZj614w== html-webpack-plugin@^4.0.0: - version "4.3.0" - resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-4.3.0.tgz#53bf8f6d696c4637d5b656d3d9863d89ce8174fd" - integrity sha512-C0fzKN8yQoVLTelcJxZfJCE+aAvQiY2VUf3UuKrR4a9k5UMWYOtpDLsaXwATbcVCnI05hUS7L9ULQHWLZhyi3w== + version "4.5.2" + resolved "https://registry.yarnpkg.com/html-webpack-plugin/-/html-webpack-plugin-4.5.2.tgz#76fc83fa1a0f12dd5f7da0404a54e2699666bc12" + integrity sha512-q5oYdzjKUIPQVjOosjgvCHQOv9Ett9CYYHlgvJeXG0qQvdSojnBq4vAdQBwn1+yGveAwHCoe/rMR86ozX3+c2A== dependencies: "@types/html-minifier-terser" "^5.0.0" "@types/tapable" "^1.0.5" "@types/webpack" "^4.41.8" html-minifier-terser "^5.0.1" loader-utils "^1.2.3" - lodash "^4.17.15" + lodash "^4.17.20" pretty-error "^2.1.1" tapable "^1.1.3" util.promisify "1.0.0" @@ -17242,15 +17245,15 @@ htmlparser2@^6.1.0: domutils "^2.5.2" entities "^2.0.0" -htmlparser2@~3.3.0: - version "3.3.0" - resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-3.3.0.tgz#cc70d05a59f6542e43f0e685c982e14c924a9efe" - integrity sha1-zHDQWln2VC5D8OaFyYLhTJJKnv4= +htmlparser2@^8.0.1: + version "8.0.2" + resolved "https://registry.yarnpkg.com/htmlparser2/-/htmlparser2-8.0.2.tgz#f002151705b383e62433b5cf466f5b716edaec21" + integrity sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA== dependencies: - domelementtype "1" - domhandler "2.1" - domutils "1.1" - readable-stream "1.0" + domelementtype "^2.3.0" + domhandler "^5.0.3" + domutils "^3.0.1" + entities "^4.4.0" http-cache-semantics@^4.0.0, http-cache-semantics@^4.1.0: version "4.1.1" @@ -21789,20 +21792,13 @@ npmlog@^6.0.0: gauge "^4.0.0" set-blocking "^2.0.0" -nth-check@^2.0.0: - version "2.0.1" - resolved "https://registry.yarnpkg.com/nth-check/-/nth-check-2.0.1.tgz#2efe162f5c3da06a28959fbd3db75dbeea9f0fc2" - integrity sha512-it1vE95zF6dTT9lBsYbxvqh0Soy4SPowchj0UBGj/V6cTPnXXtQOPUbhZ6CmGzAD/rW22LQK6E96pcdJXk4A4w== +nth-check@^2.0.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/nth-check/-/nth-check-2.1.1.tgz#c9eab428effce36cd6b92c924bdb000ef1f1ed1d" + integrity sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w== dependencies: boolbase "^1.0.0" -nth-check@~1.0.1: - version "1.0.2" - resolved "https://registry.yarnpkg.com/nth-check/-/nth-check-1.0.2.tgz#b2bd295c37e3dd58a3bf0700376663ba4d9cf05c" - integrity sha512-WeBOdju8SnzPN5vTUJYxYUxLeXpCaVP5i5e0LF8fg7WORF2Wd7wFX/pk0tYZk7s8T+J7VLy0Da6J1+wCT0AtHg== - dependencies: - boolbase "~1.0.0" - null-loader@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/null-loader/-/null-loader-3.0.0.tgz#3e2b6c663c5bda8c73a54357d8fa0708dc61b245" @@ -22472,14 +22468,15 @@ parse-node-version@^1.0.0: resolved "https://registry.yarnpkg.com/parse-node-version/-/parse-node-version-1.0.1.tgz#e2b5dbede00e7fa9bc363607f53327e8b073189b" integrity sha512-3YHlOa/JgH6Mnpr05jP9eDG254US9ek25LyIxZlDItp2iJtwyaXQb57lBYLdT3MowkUFYEV2XXNAYIPlESvJlA== -parse5-htmlparser2-tree-adapter@^6.0.1: - version "6.0.1" - resolved "https://registry.yarnpkg.com/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-6.0.1.tgz#2cdf9ad823321140370d4dbf5d3e92c7c8ddc6e6" - integrity sha512-qPuWvbLgvDGilKc5BoicRovlT4MtYT6JfJyBOMDsKoiT+GiuP5qyrPCnR9HcPECIJJmZh5jRndyNThnhhb/vlA== +parse5-htmlparser2-tree-adapter@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.0.0.tgz#23c2cc233bcf09bb7beba8b8a69d46b08c62c2f1" + integrity sha512-B77tOZrqqfUfnVcOrUvfdLbz4pu4RopLD/4vmu3HUPswwTA8OH0EMW9BlWR2B0RCoiZRAHEUu7IxeP1Pd1UU+g== dependencies: - parse5 "^6.0.1" + domhandler "^5.0.2" + parse5 "^7.0.0" -parse5@6.0.1, parse5@^6.0.0, parse5@^6.0.1: +parse5@6.0.1, parse5@^6.0.0: version "6.0.1" resolved "https://registry.yarnpkg.com/parse5/-/parse5-6.0.1.tgz#e1a1c085c569b3dc08321184f19a39cc27f7c30b" integrity sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw== @@ -23262,12 +23259,12 @@ pretty-bytes@^5.6.0: integrity sha512-FFw039TmrBqFK8ma/7OL3sDz/VytdtJr044/QUJtH0wK9lb9jLq9tJyIxUwtQJHwar2BqtiA4iCWSwo9JLkzFg== pretty-error@^2.1.1: - version "2.1.1" - resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-2.1.1.tgz#5f4f87c8f91e5ae3f3ba87ab4cf5e03b1a17f1a3" - integrity sha1-X0+HyPkeWuPzuoerTPXgOxoX8aM= + version "2.1.2" + resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-2.1.2.tgz#be89f82d81b1c86ec8fdfbc385045882727f93b6" + integrity sha512-EY5oDzmsX5wvuynAByrmY0P0hcp+QpnAKbJng2A2MPjVKXCxrDSUkzghVJ4ZGPIv+JC4gX8fPUWscC0RtjsWGw== dependencies: - renderkid "^2.0.1" - utila "~0.4" + lodash "^4.17.20" + renderkid "^2.0.4" pretty-format@^26.0.0, pretty-format@^26.6.2: version "26.6.2" @@ -24468,16 +24465,6 @@ read-pkg@^5.2.0: string_decoder "~1.1.1" util-deprecate "~1.0.1" -readable-stream@1.0, "readable-stream@>=1.0.33-1 <1.1.0-0", readable-stream@~1.0.17, readable-stream@~1.0.27-1: - version "1.0.34" - resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.0.34.tgz#125820e34bc842d2f2aaafafe4c2916ee32c157c" - integrity sha1-Elgg40vIQtLyqq+v5MKRbuMsFXw= - dependencies: - core-util-is "~1.0.0" - inherits "~2.0.1" - isarray "0.0.1" - string_decoder "~0.10.x" - "readable-stream@2 || 3", readable-stream@3, readable-stream@^3.0.6, readable-stream@^3.1.1, readable-stream@^3.4.0, readable-stream@^3.6.0: version "3.6.0" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.0.tgz#337bbda3adc0706bd3e024426a286d4b4b2c9198" @@ -24487,6 +24474,16 @@ readable-stream@1.0, "readable-stream@>=1.0.33-1 <1.1.0-0", readable-stream@~1.0 string_decoder "^1.1.1" util-deprecate "^1.0.1" +"readable-stream@>=1.0.33-1 <1.1.0-0", readable-stream@~1.0.17, readable-stream@~1.0.27-1: + version "1.0.34" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.0.34.tgz#125820e34bc842d2f2aaafafe4c2916ee32c157c" + integrity sha1-Elgg40vIQtLyqq+v5MKRbuMsFXw= + dependencies: + core-util-is "~1.0.0" + inherits "~2.0.1" + isarray "0.0.1" + string_decoder "~0.10.x" + readdir-glob@^1.0.0: version "1.1.1" resolved "https://registry.yarnpkg.com/readdir-glob/-/readdir-glob-1.1.1.tgz#f0e10bb7bf7bfa7e0add8baffdc54c3f7dbee6c4" @@ -24943,16 +24940,16 @@ remove-trailing-separator@^1.0.1: resolved "https://registry.yarnpkg.com/remove-trailing-separator/-/remove-trailing-separator-1.1.0.tgz#c24bce2a283adad5bc3f58e0d48249b92379d8ef" integrity sha1-wkvOKig62tW8P1jg1IJJuSN52O8= -renderkid@^2.0.1: - version "2.0.2" - resolved "https://registry.yarnpkg.com/renderkid/-/renderkid-2.0.2.tgz#12d310f255360c07ad8fde253f6c9e9de372d2aa" - integrity sha512-FsygIxevi1jSiPY9h7vZmBFUbAOcbYm9UwyiLNdVsLRs/5We9Ob5NMPbGYUTWiLq5L+ezlVdE0A8bbME5CWTpg== +renderkid@^2.0.4: + version "2.0.7" + resolved "https://registry.yarnpkg.com/renderkid/-/renderkid-2.0.7.tgz#464f276a6bdcee606f4a15993f9b29fc74ca8609" + integrity sha512-oCcFyxaMrKsKcTY59qnCAtmDVSLfPbrv6A3tVbPdFMMrv5jaK10V6m40cKsoPNhAqN6rmHW9sswW4o3ruSrwUQ== dependencies: - css-select "^1.1.0" - dom-converter "~0.2" - htmlparser2 "~3.3.0" - strip-ansi "^3.0.0" - utila "^0.4.0" + css-select "^4.1.3" + dom-converter "^0.2.0" + htmlparser2 "^6.1.0" + lodash "^4.17.21" + strip-ansi "^3.0.1" repeat-element@^1.1.2: version "1.1.2" @@ -27566,7 +27563,7 @@ tslib@^1.10.0, tslib@^1.8.1, tslib@^1.9.0, tslib@^1.9.3: resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.13.0.tgz#c881e13cc7015894ed914862d276436fa9a47043" integrity sha512-i/6DQjL8Xf3be4K/E6Wgpekn5Qasl1usyw++dAA35Ue5orEn65VIxOA+YvNNl9HV3qv70T7CNwjODHZrLwvd1Q== -tslib@^2.0.0, tslib@^2.0.1, tslib@^2.0.3, tslib@^2.1.0, tslib@^2.2.0, tslib@^2.3.1, tslib@^2.4.0, tslib@~2.4.0: +tslib@^2.0.0, tslib@^2.0.1, tslib@^2.0.3, tslib@^2.1.0, tslib@^2.3.1, tslib@^2.4.0, tslib@~2.4.0: version "2.4.1" resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.4.1.tgz#0d0bfbaac2880b91e22df0768e55be9753a5b17e" integrity sha512-tGyy4dAjRIEwI7BzsB0lynWgOpfqjUdq91XXAlIWD2OwKBH7oCl/GZG/HT4BOHrTlPMOASlMQ7veyTqpmRcrNA== @@ -28212,7 +28209,7 @@ util@^0.11.0: dependencies: inherits "2.0.3" -utila@^0.4.0, utila@~0.4: +utila@~0.4: version "0.4.0" resolved "https://registry.yarnpkg.com/utila/-/utila-0.4.0.tgz#8a16a05d445657a3aea5eecc5b12a4fa5379772c" integrity sha1-ihagXURWV6Oupe7MWxKk+lN5dyw=