-
+
+
+
+
-
+
+
-
+
+
+ );
+ }
+
return (
+
+
+ }
+ name="kibanaAdvancedSetting"
+ value="kibanaAdvancedSetting"
+ checked={isKibanaAdvancedSettingFormElement(indicesFormElement)}
+ onChange={changeToKibanaAdvancedSettingType}
+ disabled={isReadOnly}
+ >
+ {isKibanaAdvancedSettingFormElement(indicesFormElement) && (
+
+
+ CPU usage (legacy)
+
+
+ 10%
+
+
diff --git a/x-pack/plugins/observability_solution/infra/public/pages/metrics/inventory_view/components/waffle/conditional_tooltip.test.tsx b/x-pack/plugins/observability_solution/infra/public/pages/metrics/inventory_view/components/waffle/conditional_tooltip.test.tsx
index 439999d5b143f..b15779cbd2e9e 100644
--- a/x-pack/plugins/observability_solution/infra/public/pages/metrics/inventory_view/components/waffle/conditional_tooltip.test.tsx
+++ b/x-pack/plugins/observability_solution/infra/public/pages/metrics/inventory_view/components/waffle/conditional_tooltip.test.tsx
@@ -30,7 +30,7 @@ const NODE: InfraWaffleMapNode = {
id: 'host-01',
name: 'host-01',
path: [{ value: 'host-01', label: 'host-01' }],
- metrics: [{ name: 'cpu' }],
+ metrics: [{ name: 'cpuTotal' }],
};
export const nextTick = () => new Promise((res) => process.nextTick(res));
@@ -45,6 +45,7 @@ describe('ConditionalToolTip', () => {
name: 'host-01',
path: [{ label: 'host-01', value: 'host-01', ip: '192.168.1.10' }],
metrics: [
+ { name: 'cpuTotal', value: 0.1, avg: 0.4, max: 0.7 },
{ name: 'cpu', value: 0.1, avg: 0.4, max: 0.7 },
{ name: 'memory', value: 0.8, avg: 0.8, max: 1 },
{ name: 'txV2', value: 1000000, avg: 1000000, max: 1000000 },
@@ -78,13 +79,14 @@ describe('ConditionalToolTip', () => {
},
});
const expectedMetrics = [
+ { type: 'cpuTotal' },
{ type: 'cpu' },
{ type: 'memory' },
{ type: 'txV2' },
{ type: 'rxV2' },
{
aggregation: 'avg',
- field: 'host.cpu.pct',
+ field: 'host.cpuTotal.pct',
id: 'cedd6ca0-5775-11eb-a86f-adb714b6c486',
label: 'My Custom Label',
type: 'custom',
@@ -139,11 +141,11 @@ const mockedUseWaffleOptionsContexReturnValue: ReturnType
};
const converters: Record number> = {
cpu: (n) => Number(n) / 100,
+ cpuTotal: (n) => Number(n) / 100,
memory: (n) => Number(n) / 100,
tx: (n) => Number(n) / 8,
rx: (n) => Number(n) / 8,
diff --git a/x-pack/plugins/observability_solution/infra/server/routes/infra/lib/host/get_all_hosts.ts b/x-pack/plugins/observability_solution/infra/server/routes/infra/lib/host/get_all_hosts.ts
index 7172a0c3da4d4..15bc0df8d76e5 100644
--- a/x-pack/plugins/observability_solution/infra/server/routes/infra/lib/host/get_all_hosts.ts
+++ b/x-pack/plugins/observability_solution/infra/server/routes/infra/lib/host/get_all_hosts.ts
@@ -23,8 +23,8 @@ export const getAllHosts = async (
const result = (response.aggregations?.nodes.buckets ?? [])
.sort((a, b) => {
- const aValue = getMetricValue(a?.cpu) ?? 0;
- const bValue = getMetricValue(b?.cpu) ?? 0;
+ const aValue = getMetricValue(a?.cpuTotal) ?? 0;
+ const bValue = getMetricValue(b?.cpuTotal) ?? 0;
return bValue - aValue;
})
.map((bucket) => {
diff --git a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/index.ts b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/index.ts
index 42e8a0b81e6c8..d45fbfb5477f1 100644
--- a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/index.ts
+++ b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/index.ts
@@ -42,6 +42,7 @@ export const host: InventoryModel = {
metrics,
requiredMetrics: [
'hostSystemOverview',
+ 'hostCpuUsageTotal',
'hostCpuUsage',
'hostLoad',
'hostMemoryUsage',
@@ -54,5 +55,5 @@ export const host: InventoryModel = {
...awsRequiredMetrics,
...nginxRequireMetrics,
],
- tooltipMetrics: ['cpu', 'memory', 'txV2', 'rxV2'],
+ tooltipMetrics: ['cpuTotal', 'cpu', 'memory', 'txV2', 'rxV2'],
};
diff --git a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/formulas/cpu.ts b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/formulas/cpu.ts
index fa75dc071666c..3ee08c028f8fb 100644
--- a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/formulas/cpu.ts
+++ b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/formulas/cpu.ts
@@ -80,7 +80,7 @@ export const cpuUsageUser: LensBaseLayer = {
export const cpuUsage: LensBaseLayer = {
label: CPU_USAGE_LABEL,
- value: '(average(system.cpu.user.pct) + average(system.cpu.system.pct)) / max(system.cpu.cores)',
+ value: 'average(system.cpu.total.norm.pct)',
format: 'percent',
decimals: 0,
};
diff --git a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/index.ts b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/index.ts
index 6d2bc3381fdf1..5983b2a56f817 100644
--- a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/index.ts
+++ b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/index.ts
@@ -22,6 +22,6 @@ export const metrics: InventoryMetricsWithCharts = {
snapshot,
getFormulas: async () => await import('./formulas').then(({ formulas }) => formulas),
getCharts: async () => await import('./charts').then(({ charts }) => charts),
- defaultSnapshot: 'cpu',
+ defaultSnapshot: 'cpuTotal',
defaultTimeRangeInSeconds: 3600, // 1 hour
};
diff --git a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/snapshot/cpu_total.ts b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/snapshot/cpu_total.ts
new file mode 100644
index 0000000000000..f7b4661b65d99
--- /dev/null
+++ b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/snapshot/cpu_total.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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { MetricsUIAggregation } from '../../../types';
+
+export const cpuTotal: MetricsUIAggregation = {
+ cpuTotal: {
+ avg: {
+ field: 'system.cpu.total.norm.pct',
+ },
+ },
+};
diff --git a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/snapshot/index.ts b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/snapshot/index.ts
index e6f1cf6ac1912..4bf48e287fab7 100644
--- a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/snapshot/index.ts
+++ b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/host/metrics/snapshot/index.ts
@@ -5,6 +5,7 @@
* 2.0.
*/
+import { cpuTotal } from './cpu_total';
import { cpu } from './cpu';
import { diskLatency } from './disk_latency';
import { diskSpaceUsage } from './disk_space_usage';
@@ -21,6 +22,7 @@ import { txV2 } from './tx_v2';
import { rxV2 } from './rx_v2';
export const snapshot = {
+ cpuTotal,
cpu,
diskLatency,
diskSpaceUsage,
diff --git a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/types.ts b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/types.ts
index c9accaca490f6..2ced976e564a8 100644
--- a/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/types.ts
+++ b/x-pack/plugins/observability_solution/metrics_data_access/common/inventory_models/types.ts
@@ -43,6 +43,7 @@ export type InventoryItemType = rt.TypeOf;
export const InventoryMetricRT = rt.keyof({
hostSystemOverview: null,
+ hostCpuUsageTotal: null,
hostCpuUsage: null,
hostFilesystem: null,
hostK8sOverview: null,
@@ -348,6 +349,7 @@ export type MetricsUIAggregation = rt.TypeOf;
export const SnapshotMetricTypeKeys = {
count: null,
+ cpuTotal: null,
cpu: null,
diskLatency: null,
diskSpaceUsage: null,
diff --git a/x-pack/plugins/translations/translations/fr-FR.json b/x-pack/plugins/translations/translations/fr-FR.json
index 2e29605ad256d..9abcbd4c40cde 100644
--- a/x-pack/plugins/translations/translations/fr-FR.json
+++ b/x-pack/plugins/translations/translations/fr-FR.json
@@ -22340,7 +22340,6 @@
"xpack.infra.waffle.maxGroupByTooltip": "Seuls deux regroupements peuvent être sélectionnés en même temps",
"xpack.infra.waffle.metriclabel": "Indicateur",
"xpack.infra.waffle.metricOptions.countText": "compte",
- "xpack.infra.waffle.metricOptions.cpuUsageText": "Utilisation CPU",
"xpack.infra.waffle.metricOptions.diskIOReadBytes": "lectures du disque",
"xpack.infra.waffle.metricOptions.diskIOWriteBytes": "écritures sur le disque",
"xpack.infra.waffle.metricOptions.hostLogRateText": "taux de log",
diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json
index 119a79a5b8369..c5be020320a04 100644
--- a/x-pack/plugins/translations/translations/ja-JP.json
+++ b/x-pack/plugins/translations/translations/ja-JP.json
@@ -22264,7 +22264,6 @@
"xpack.infra.waffle.maxGroupByTooltip": "一度に選択できるグループは 2 つのみです",
"xpack.infra.waffle.metriclabel": "メトリック",
"xpack.infra.waffle.metricOptions.countText": "カウント",
- "xpack.infra.waffle.metricOptions.cpuUsageText": "CPU 使用状況",
"xpack.infra.waffle.metricOptions.diskIOReadBytes": "ディスク読み取り",
"xpack.infra.waffle.metricOptions.diskIOWriteBytes": "ディスク書き込み",
"xpack.infra.waffle.metricOptions.hostLogRateText": "ログレート",
diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json
index fd316f8055f38..0497f0f96fe31 100644
--- a/x-pack/plugins/translations/translations/zh-CN.json
+++ b/x-pack/plugins/translations/translations/zh-CN.json
@@ -22368,7 +22368,6 @@
"xpack.infra.waffle.maxGroupByTooltip": "一次只能选择两个分组",
"xpack.infra.waffle.metriclabel": "指标",
"xpack.infra.waffle.metricOptions.countText": "计数",
- "xpack.infra.waffle.metricOptions.cpuUsageText": "CPU 使用",
"xpack.infra.waffle.metricOptions.diskIOReadBytes": "磁盘读取数",
"xpack.infra.waffle.metricOptions.diskIOWriteBytes": "磁盘写入数",
"xpack.infra.waffle.metricOptions.hostLogRateText": "日志速率",
diff --git a/x-pack/test/api_integration/apis/metrics_ui/infra.ts b/x-pack/test/api_integration/apis/metrics_ui/infra.ts
index dfb6744a94583..641f61c9126fe 100644
--- a/x-pack/test/api_integration/apis/metrics_ui/infra.ts
+++ b/x-pack/test/api_integration/apis/metrics_ui/infra.ts
@@ -30,6 +30,9 @@ export default function ({ getService }: FtrProviderContext) {
{
type: 'cpu',
},
+ {
+ type: 'cpuTotal',
+ },
{
type: 'diskSpaceUsage',
},
@@ -95,6 +98,7 @@ export default function ({ getService }: FtrProviderContext) {
],
metrics: [
{ name: 'cpu', value: 0.44708333333333333 },
+ { name: 'cpuTotal', value: 0 },
{ name: 'diskSpaceUsage', value: 0 },
{ name: 'memory', value: 0.4563333333333333 },
{ name: 'memoryFree', value: 8573890560 },
@@ -155,7 +159,7 @@ export default function ({ getService }: FtrProviderContext) {
...basePayload,
metrics: [
{
- type: 'cpu',
+ type: 'cpuTotal',
},
],
query: { bool: { filter: [{ term: { 'host.os.name': 'CentOS Linux' } }] } },
@@ -164,8 +168,8 @@ export default function ({ getService }: FtrProviderContext) {
const names = (response.body as GetInfraMetricsResponsePayload).nodes.map((p) => p.name);
expect(names).eql([
- 'gke-observability-8--observability-8--bc1afd95-ngmh',
'gke-observability-8--observability-8--bc1afd95-f0zc',
+ 'gke-observability-8--observability-8--bc1afd95-ngmh',
'gke-observability-8--observability-8--bc1afd95-nhhw',
]);
});
@@ -175,7 +179,7 @@ export default function ({ getService }: FtrProviderContext) {
...basePayload,
metrics: [
{
- type: 'cpu',
+ type: 'cpuTotal',
},
],
query: { bool: { filter: [{ term: { 'host.os.name': 'Ubuntu' } }] } },
@@ -192,7 +196,7 @@ export default function ({ getService }: FtrProviderContext) {
...basePayload,
metrics: [
{
- type: 'cpu',
+ type: 'cpuTotal',
},
],
query: {
@@ -207,9 +211,8 @@ export default function ({ getService }: FtrProviderContext) {
const names = (response.body as GetInfraMetricsResponsePayload).nodes.map((p) => p.name);
expect(names).eql([
- 'gke-observability-8--observability-8--bc1afd95-ngmh',
'gke-observability-8--observability-8--bc1afd95-f0zc',
- ,
+ 'gke-observability-8--observability-8--bc1afd95-ngmh',
]);
});
@@ -246,7 +249,7 @@ export default function ({ getService }: FtrProviderContext) {
const response = await makeRequest({ invalidBody, expectedHTTPCode: 400 });
expect(normalizeNewLine(response.body.message)).to.be(
- '[request body]: Failed to validate: in metrics/0/type: "any" does not match expected type "cpu" | "normalizedLoad1m" | "diskSpaceUsage" | "memory" | "memoryFree" | "rx" | "tx" | "rxV2" | "txV2"'
+ '[request body]: Failed to validate: in metrics/0/type: "any" does not match expected type "cpu" | "cpuTotal" | "normalizedLoad1m" | "diskSpaceUsage" | "memory" | "memoryFree" | "rx" | "tx" | "rxV2" | "txV2"'
);
});
diff --git a/x-pack/test/functional/apps/infra/home_page.ts b/x-pack/test/functional/apps/infra/home_page.ts
index 0de16bc6af3f4..29cfa9bb37e0b 100644
--- a/x-pack/test/functional/apps/infra/home_page.ts
+++ b/x-pack/test/functional/apps/infra/home_page.ts
@@ -173,7 +173,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
});
[
- { metric: 'cpuUsage', value: '0.8%' },
+ { metric: 'cpuUsage', value: 'N/A' },
{ metric: 'normalizedLoad1m', value: '1.4%' },
{ metric: 'memoryUsage', value: '18.0%' },
{ metric: 'diskUsage', value: '35.0%' },
@@ -406,7 +406,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
await pageObjects.infraHome.clearSearchTerm();
});
- it('sort nodes by descending value', async () => {
+ it.skip('sort nodes by descending value', async () => {
await pageObjects.infraHome.goToTime(DATE_WITH_DATA);
await pageObjects.infraHome.getWaffleMap();
await pageObjects.infraHome.sortNodesBy('value');
@@ -423,7 +423,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
});
});
- it('sort nodes by ascending value', async () => {
+ it.skip('sort nodes by ascending value', async () => {
await pageObjects.infraHome.goToTime(DATE_WITH_DATA);
await pageObjects.infraHome.getWaffleMap();
await pageObjects.infraHome.sortNodesBy('value');
@@ -450,7 +450,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
});
});
- it('filter nodes by search term', async () => {
+ it.skip('filter nodes by search term', async () => {
await pageObjects.infraHome.goToTime(DATE_WITH_DATA);
await pageObjects.infraHome.getWaffleMap();
await pageObjects.infraHome.enterSearchTerm('host.name: "demo-stack-apache-01"');
@@ -463,7 +463,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
await pageObjects.infraHome.clearSearchTerm();
});
- it('change color palette', async () => {
+ it.skip('change color palette', async () => {
await pageObjects.infraHome.openLegendControls();
await pageObjects.infraHome.changePalette('temperature');
await pageObjects.infraHome.applyLegendControls();
@@ -581,14 +581,13 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
'system.core.softirq.pct',
'system.core.steal.pct',
'system.cpu.nice.pct',
- 'system.cpu.idle.pct',
];
for (const field of fields) {
await pageObjects.infraHome.addCustomMetric(field);
}
const metricsCount = await pageObjects.infraHome.getMetricsContextMenuItemsCount();
- // there are 6 default metrics in the context menu for hosts
+ // there are 7 default metrics in the context menu for hosts
expect(metricsCount).to.eql(20);
await pageObjects.infraHome.ensureCustomMetricAddButtonIsDisabled();
diff --git a/x-pack/test/functional/apps/infra/hosts_view.ts b/x-pack/test/functional/apps/infra/hosts_view.ts
index f185e479421e4..a016fbec64ecd 100644
--- a/x-pack/test/functional/apps/infra/hosts_view.ts
+++ b/x-pack/test/functional/apps/infra/hosts_view.ts
@@ -33,7 +33,7 @@ const tableEntries = [
{
alertsCount: 2,
title: 'demo-stack-apache-01',
- cpuUsage: '1.2%',
+ cpuUsage: '0%',
normalizedLoad: '0.5%',
memoryUsage: '18.4%',
memoryFree: '3.2 GB',
@@ -44,7 +44,7 @@ const tableEntries = [
{
alertsCount: 2,
title: 'demo-stack-mysql-01',
- cpuUsage: '0.9%',
+ cpuUsage: '0%',
normalizedLoad: '0%',
memoryUsage: '18.2%',
memoryFree: '3.2 GB',
@@ -55,7 +55,7 @@ const tableEntries = [
{
alertsCount: 2,
title: 'demo-stack-redis-01',
- cpuUsage: '0.8%',
+ cpuUsage: '0%',
normalizedLoad: '0%',
memoryUsage: '15.9%',
memoryFree: '3.3 GB',
@@ -65,19 +65,19 @@ const tableEntries = [
},
{
alertsCount: 0,
- title: 'demo-stack-nginx-01',
- cpuUsage: '0.8%',
- normalizedLoad: '1.4%',
- memoryUsage: '18%',
- memoryFree: '3.2 GB',
- diskSpaceUsage: '35%',
+ title: 'demo-stack-client-01',
+ cpuUsage: '0%',
+ normalizedLoad: '0.1%',
+ memoryUsage: '13.8%',
+ memoryFree: '3.3 GB',
+ diskSpaceUsage: '33.8%',
rx: '0 bit/s',
tx: '0 bit/s',
},
{
alertsCount: 0,
title: 'demo-stack-haproxy-01',
- cpuUsage: '0.8%',
+ cpuUsage: '0%',
normalizedLoad: '0%',
memoryUsage: '16.5%',
memoryFree: '3.2 GB',
@@ -87,12 +87,12 @@ const tableEntries = [
},
{
alertsCount: 0,
- title: 'demo-stack-client-01',
- cpuUsage: '0.5%',
- normalizedLoad: '0.1%',
- memoryUsage: '13.8%',
- memoryFree: '3.3 GB',
- diskSpaceUsage: '33.8%',
+ title: 'demo-stack-nginx-01',
+ cpuUsage: '0%',
+ normalizedLoad: '1.4%',
+ memoryUsage: '18%',
+ memoryFree: '3.2 GB',
+ diskSpaceUsage: '35%',
rx: '0 bit/s',
tx: '0 bit/s',
},
@@ -477,11 +477,10 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
});
it('should render the computed metrics for each host entry', async () => {
- hostRows.forEach((row, position) => {
- pageObjects.infraHostsView
- .getHostsRowData(row)
- .then((hostRowData) => expect(hostRowData).to.eql(tableEntries[position]));
- });
+ for (let i = 0; i < hostRows.length; i++) {
+ const hostRowData = await pageObjects.infraHostsView.getHostsRowData(hostRows[i]);
+ expect(hostRowData).to.eql(tableEntries[i]);
+ }
});
it('should select and filter hosts inside the table', async () => {
@@ -550,7 +549,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
describe('KPIs', () => {
[
{ metric: 'hostsCount', value: '6' },
- { metric: 'cpuUsage', value: '0.8%' },
+ { metric: 'cpuUsage', value: 'N/A' },
{ metric: 'normalizedLoad1m', value: '0.3%' },
{ metric: 'memoryUsage', value: '16.8%' },
{ metric: 'diskUsage', value: '35.7%' },
@@ -701,18 +700,17 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
expect(hostRows.length).to.equal(3);
- hostRows.forEach((row, position) => {
- pageObjects.infraHostsView
- .getHostsRowData(row)
- .then((hostRowData) => expect(hostRowData).to.eql(filtererEntries[position]));
- });
+ for (let i = 0; i < hostRows.length; i++) {
+ const hostRowData = await pageObjects.infraHostsView.getHostsRowData(hostRows[i]);
+ expect(hostRowData).to.eql(filtererEntries[i]);
+ }
});
it('should update the KPIs content on a search submit', async () => {
await Promise.all(
[
{ metric: 'hostsCount', value: '3' },
- { metric: 'cpuUsage', value: '0.9%' },
+ { metric: 'cpuUsage', value: 'N/A' },
{ metric: 'normalizedLoad1m', value: '0.2%' },
{ metric: 'memoryUsage', value: '17.5%' },
{ metric: 'diskUsage', value: '35.7%' },
@@ -782,38 +780,38 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
it('should show 5 rows on the first page', async () => {
const hostRows = await pageObjects.infraHostsView.getHostsTableData();
- hostRows.forEach((row, position) => {
- pageObjects.infraHostsView
- .getHostsRowData(row)
- .then((hostRowData) => expect(hostRowData).to.eql(tableEntries[position]));
- });
+
+ for (let i = 0; i < hostRows.length; i++) {
+ const hostRowData = await pageObjects.infraHostsView.getHostsRowData(hostRows[i]);
+ expect(hostRowData).to.eql(tableEntries[i]);
+ }
});
it('should paginate to the last page', async () => {
await pageObjects.infraHostsView.paginateTo(2);
const hostRows = await pageObjects.infraHostsView.getHostsTableData();
- hostRows.forEach((row) => {
- pageObjects.infraHostsView
- .getHostsRowData(row)
- .then((hostRowData) => expect(hostRowData).to.eql(tableEntries[5]));
- });
+
+ expect(hostRows.length).to.equal(1);
+
+ const hostRowData = await pageObjects.infraHostsView.getHostsRowData(hostRows[0]);
+ expect(hostRowData).to.eql(tableEntries[5]);
});
it('should show all hosts on the same page', async () => {
await pageObjects.infraHostsView.changePageSize(10);
const hostRows = await pageObjects.infraHostsView.getHostsTableData();
- hostRows.forEach((row, position) => {
- pageObjects.infraHostsView
- .getHostsRowData(row)
- .then((hostRowData) => expect(hostRowData).to.eql(tableEntries[position]));
- });
+
+ for (let i = 0; i < hostRows.length; i++) {
+ const hostRowData = await pageObjects.infraHostsView.getHostsRowData(hostRows[i]);
+ expect(hostRowData).to.eql(tableEntries[i]);
+ }
});
it('should sort by a numeric field asc', async () => {
- await pageObjects.infraHostsView.sortByCpuUsage();
+ await pageObjects.infraHostsView.sortByMemoryUsage();
let hostRows = await pageObjects.infraHostsView.getHostsTableData();
const hostDataFirtPage = await pageObjects.infraHostsView.getHostsRowData(hostRows[0]);
- expect(hostDataFirtPage).to.eql(tableEntries[5]);
+ expect(hostDataFirtPage).to.eql(tableEntries[3]);
await pageObjects.infraHostsView.paginateTo(2);
hostRows = await pageObjects.infraHostsView.getHostsTableData();
@@ -822,7 +820,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
});
it('should sort by a numeric field desc', async () => {
- await pageObjects.infraHostsView.sortByCpuUsage();
+ await pageObjects.infraHostsView.sortByMemoryUsage();
let hostRows = await pageObjects.infraHostsView.getHostsTableData();
const hostDataFirtPage = await pageObjects.infraHostsView.getHostsRowData(hostRows[0]);
expect(hostDataFirtPage).to.eql(tableEntries[0]);
@@ -830,7 +828,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
await pageObjects.infraHostsView.paginateTo(2);
hostRows = await pageObjects.infraHostsView.getHostsTableData();
const hostDataLastPage = await pageObjects.infraHostsView.getHostsRowData(hostRows[0]);
- expect(hostDataLastPage).to.eql(tableEntries[5]);
+ expect(hostDataLastPage).to.eql(tableEntries[3]);
});
it('should sort by text field asc', async () => {
diff --git a/x-pack/test/functional/apps/infra/node_details.ts b/x-pack/test/functional/apps/infra/node_details.ts
index bba769b6b9764..fbc442b5079c0 100644
--- a/x-pack/test/functional/apps/infra/node_details.ts
+++ b/x-pack/test/functional/apps/infra/node_details.ts
@@ -558,7 +558,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
});
[
- { metric: 'cpuUsage', value: '99.6%' },
+ { metric: 'cpuUsage', value: '100.0%' },
{ metric: 'normalizedLoad1m', value: '1,300.3%' },
{ metric: 'memoryUsage', value: '42.2%' },
{ metric: 'diskUsage', value: '36.0%' },
diff --git a/x-pack/test/functional/page_objects/infra_home_page.ts b/x-pack/test/functional/page_objects/infra_home_page.ts
index 03995ac6e7a6d..ec7908d916e9b 100644
--- a/x-pack/test/functional/page_objects/infra_home_page.ts
+++ b/x-pack/test/functional/page_objects/infra_home_page.ts
@@ -94,7 +94,7 @@ export function InfraHomePageProvider({ getService, getPageObjects }: FtrProvide
async clickOnFirstNode() {
const firstNode = await this.getFirstNode();
- firstNode.click();
+ return firstNode.click();
},
async clickOnGoToNodeDetails() {
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 2ee8bf266f843..d92cf51892a5f 100644
--- a/x-pack/test/functional/page_objects/infra_hosts_view.ts
+++ b/x-pack/test/functional/page_objects/infra_hosts_view.ts
@@ -247,17 +247,17 @@ export function InfraHostsViewProvider({ getService }: FtrProviderContext) {
},
// Sorting
- getCpuUsageHeader() {
- return testSubjects.find('tableHeaderCell_cpu_3');
+ getMemoryHeader() {
+ return testSubjects.find('tableHeaderCell_memory_5');
},
getTitleHeader() {
return testSubjects.find('tableHeaderCell_title_2');
},
- async sortByCpuUsage() {
- const diskLatency = await this.getCpuUsageHeader();
- const button = await testSubjects.findDescendant('tableHeaderSortButton', diskLatency);
+ async sortByMemoryUsage() {
+ const memory = await this.getMemoryHeader();
+ const button = await testSubjects.findDescendant('tableHeaderSortButton', memory);
await button.click();
},
From 432710065d619aeff0b54eec15320ceb3c3af517 Mon Sep 17 00:00:00 2001
From: Jon
Date: Wed, 7 Aug 2024 07:33:03 -0500
Subject: [PATCH 05/44] Reapply "[ci] Fix sonarqube scan (#189936)" (#190011)
I reverted the locations.yml change - I'll leave it for a PR that
migrates the remaining entries in that file.
---
.buildkite/scripts/common/env.sh | 12 +++++++-----
catalog-info.yaml | 3 +++
.../infra/server/routes/ip_to_hostname.ts | 6 +++---
3 files changed, 13 insertions(+), 8 deletions(-)
diff --git a/.buildkite/scripts/common/env.sh b/.buildkite/scripts/common/env.sh
index 1d401bab4282a..34b71b7004725 100755
--- a/.buildkite/scripts/common/env.sh
+++ b/.buildkite/scripts/common/env.sh
@@ -23,12 +23,14 @@ if [[ -d /opt/local-ssd/buildkite ]]; then
mkdir -p "$TMPDIR"
fi
-KIBANA_PKG_BRANCH="$(jq -r .branch "$KIBANA_DIR/package.json")"
-export KIBANA_PKG_BRANCH
-export KIBANA_BASE_BRANCH="$KIBANA_PKG_BRANCH"
+if command -v jq >/dev/null 2>&1; then
+ KIBANA_PKG_BRANCH="$(jq -r .branch "$KIBANA_DIR/package.json")"
+ export KIBANA_PKG_BRANCH
+ export KIBANA_BASE_BRANCH="$KIBANA_PKG_BRANCH"
-KIBANA_PKG_VERSION="$(jq -r .version "$KIBANA_DIR/package.json")"
-export KIBANA_PKG_VERSION
+ KIBANA_PKG_VERSION="$(jq -r .version "$KIBANA_DIR/package.json")"
+ export KIBANA_PKG_VERSION
+fi
# Detects and exports the final target branch when using a merge queue
if [[ "${BUILDKITE_BRANCH:-}" == "gh-readonly-queue"* ]]; then
diff --git a/catalog-info.yaml b/catalog-info.yaml
index 4af2698ca6cca..47fd1049e2fed 100644
--- a/catalog-info.yaml
+++ b/catalog-info.yaml
@@ -113,6 +113,9 @@ spec:
metadata:
name: kibana / sonarqube
spec:
+ env:
+ SLACK_NOTIFICATIONS_CHANNEL: '#kibana-operations-alerts'
+ ELASTIC_SLACK_NOTIFICATIONS_ENABLED: 'true'
repository: elastic/kibana
provider_settings:
trigger_mode: none
diff --git a/x-pack/plugins/observability_solution/infra/server/routes/ip_to_hostname.ts b/x-pack/plugins/observability_solution/infra/server/routes/ip_to_hostname.ts
index 7bafa78750690..0f8c00c51b0db 100644
--- a/x-pack/plugins/observability_solution/infra/server/routes/ip_to_hostname.ts
+++ b/x-pack/plugins/observability_solution/infra/server/routes/ip_to_hostname.ts
@@ -52,10 +52,10 @@ export const initIpToHostName = ({ framework }: InfraBackendLibs) => {
}
const hostDoc = first(hits.hits)!;
return response.ok({ body: { host: hostDoc._source.host.name } });
- } catch ({ statusCode = 500, message = 'Unknown error occurred' }) {
+ } catch (error) {
return response.customError({
- statusCode,
- body: { message },
+ statusCode: error.statusCode || 500,
+ body: { message: error.message || 'Unknown error occurred' },
});
}
}
From 8e3126ee8bba90c9034656726fafc7aae78da22f Mon Sep 17 00:00:00 2001
From: Jon
Date: Wed, 7 Aug 2024 07:42:28 -0500
Subject: [PATCH 06/44] Use wolfi as the base image for project deployments
(#183328)
Updates the base image for serverless project deployments from
`ubuntu:20.04` to `chainguard-base`
https://buildkite.com/elastic/appex-qa-serverless-kibana-ftr-tests/builds/2158
### Testing
Download docker-context in the artifacts tab of the `Build Project` step
or
```
cd $KIBANA_HOME
mkdir target
node scripts/build \
--skip-initialize \
--skip-generic-folders \
--skip-platform-folders \
--skip-archives \
--skip-cdn-assets
TEST_CONTEXT=$(mktemp -d)
tar -xf target/kibana-serverless-8.15.0-SNAPSHOT-docker-build-context.tar.gz -C "$TEST_CONTEXT"
cd "$TEST_CONTEXT"
docker build . -t docker.elastic.co/employees/jbudz/kibana-serverless
docker run --rm docker.elastic.co/employees/jbudz/kibana-serverless
---------
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Elastic Machine
---
src/dev/build/tasks/os_packages/create_os_package_tasks.ts | 6 +++---
src/dev/build/tasks/os_packages/docker_generator/run.ts | 2 +-
.../os_packages/docker_generator/templates/base/Dockerfile | 2 +-
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/dev/build/tasks/os_packages/create_os_package_tasks.ts b/src/dev/build/tasks/os_packages/create_os_package_tasks.ts
index 052d7592024d7..1a3708a3d5bcd 100644
--- a/src/dev/build/tasks/os_packages/create_os_package_tasks.ts
+++ b/src/dev/build/tasks/os_packages/create_os_package_tasks.ts
@@ -111,7 +111,7 @@ export const CreateDockerServerless: Task = {
async run(config, log, build) {
await runDockerGenerator(config, log, build, {
architecture: 'x64',
- baseImage: 'ubuntu',
+ baseImage: 'wolfi',
context: false,
serverless: true,
image: true,
@@ -119,7 +119,7 @@ export const CreateDockerServerless: Task = {
});
await runDockerGenerator(config, log, build, {
architecture: 'aarch64',
- baseImage: 'ubuntu',
+ baseImage: 'wolfi',
context: false,
serverless: true,
image: true,
@@ -210,7 +210,7 @@ export const CreateDockerContexts: Task = {
image: false,
});
await runDockerGenerator(config, log, build, {
- baseImage: 'ubuntu',
+ baseImage: 'wolfi',
serverless: true,
context: true,
image: false,
diff --git a/src/dev/build/tasks/os_packages/docker_generator/run.ts b/src/dev/build/tasks/os_packages/docker_generator/run.ts
index 62d17f0455723..a772650586c7b 100644
--- a/src/dev/build/tasks/os_packages/docker_generator/run.ts
+++ b/src/dev/build/tasks/os_packages/docker_generator/run.ts
@@ -48,7 +48,7 @@ export async function runDockerGenerator(
let imageFlavor = '';
if (flags.baseImage === 'ubi') imageFlavor += `-ubi`;
- if (flags.baseImage === 'wolfi') imageFlavor += `-wolfi`;
+ if (flags.baseImage === 'wolfi' && !flags.serverless) imageFlavor += `-wolfi`;
if (flags.ironbank) imageFlavor += '-ironbank';
if (flags.cloud) imageFlavor += '-cloud';
if (flags.serverless) imageFlavor += '-serverless';
diff --git a/src/dev/build/tasks/os_packages/docker_generator/templates/base/Dockerfile b/src/dev/build/tasks/os_packages/docker_generator/templates/base/Dockerfile
index 0195825313b57..acd5b54a74f1b 100644
--- a/src/dev/build/tasks/os_packages/docker_generator/templates/base/Dockerfile
+++ b/src/dev/build/tasks/os_packages/docker_generator/templates/base/Dockerfile
@@ -134,7 +134,7 @@ RUN for iter in {1..10}; do \
(exit $exit_code)
{{/ubuntu}}
{{#wolfi}}
-RUN apk --no-cache add bash curl fontconfig libstdc++ freetype nss findutils shadow
+RUN apk --no-cache add bash curl fontconfig libstdc++ nss findutils shadow
{{/wolfi}}
# Bring in Kibana from the initial stage.
From 2990ce0b6526773c1697af022e29f410243099dd Mon Sep 17 00:00:00 2001
From: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Date: Wed, 7 Aug 2024 22:42:33 +1000
Subject: [PATCH 07/44] skip failing test suite (#190030)
---
x-pack/test/functional/apps/lens/group2/fields_list.ts | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/x-pack/test/functional/apps/lens/group2/fields_list.ts b/x-pack/test/functional/apps/lens/group2/fields_list.ts
index 14151f481913f..21e22ebab60d1 100644
--- a/x-pack/test/functional/apps/lens/group2/fields_list.ts
+++ b/x-pack/test/functional/apps/lens/group2/fields_list.ts
@@ -20,7 +20,8 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
const queryBar = getService('queryBar');
const dataViews = getService('dataViews');
- describe('lens fields list tests', () => {
+ // Failing: See https://github.com/elastic/kibana/issues/190030
+ describe.skip('lens fields list tests', () => {
for (const datasourceType of ['form-based', 'ad-hoc', 'ad-hoc-no-timefield']) {
describe(`${datasourceType} datasource`, () => {
before(async () => {
From 6a3c98dbe15c50fa4205fc41de5f2c8954b1fba9 Mon Sep 17 00:00:00 2001
From: Dmitrii Shevchenko
Date: Wed, 7 Aug 2024 14:45:52 +0200
Subject: [PATCH 08/44] [Security Solution] Detection rules bootstrap endpoint
(#189518)
**Resolves: https://github.com/elastic/kibana/issues/187647**
## Summary
Added a new API endpoint `POST
/internal/detection_engine/prebuilt_rules/_bootstrap`. This endpoint is
responsible for installing the necessary packages for prebuilt detection
rules to function properly. This allows us to avoid calling Fleet
directly from FE and helps encapsulate complex logic of the package
version selection in a single place on the backend.
Currently, it installs or upgrades (if already installed) two packages:
`endpoint` and `security_detection_engine`.
The response looks like this:
```json5
{
packages: [
{
name: 'detection_engine',
version: '1.0.0',
status: 'installed',
},
{
name: 'endpoint',
version: '1.0.0',
status: 'already_installed',
},
],
}
```
We call this endpoint from Kibana every time a user lands on any
security solution page. The endpoint checks if the required packages are
missing or if a newer version is available. If so, the newer version is
installed, and the package status will be `installed` in the response.
If all packages are up-to-date, the package status will be
`already_installed` in the response. This allows us to invalidate
prebuilt rule endpoints more efficiently and avoid sending extra
requests from Kibana:
```ts
if (
response?.packages.find((pkg) => pkg.name === PREBUILT_RULES_PACKAGE_NAME)?.status === 'installed'
) {
// Invalidate other pre-packaged rules related queries. We need to do
// that only if the prebuilt rules package was installed, indicating
// that there might be new rules to install.
invalidatePrePackagedRulesStatus();
invalidatePrebuiltRulesInstallReview();
invalidatePrebuiltRulesUpdateReview();
}
```
The performance gain is that we do not invalidate prebuilt rules when
the package is already installed.
Previously:
`Fetch rules initially -> Upgrade rules package -(always)-> Re-fetch
rules`
Now:
`Fetch rules initially -> Upgrade rules package -(only if there's a new
package version)-> Re-fetch rules`
This will result in fewer redundant API requests from Kibana.
---
.../server/services/epm/package_service.ts | 6 +-
.../server/services/epm/packages/install.ts | 17 +-
.../server/routes/flow/route.ts | 3 +-
.../install_index_templates.ts | 4 +-
.../bootstrap_prebuilt_rules.gen.ts | 41 ++++
.../bootstrap_prebuilt_rules.schema.yaml | 51 +++++
.../detection_engine/prebuilt_rules/urls.ts | 19 +-
.../common/detection_engine/constants.ts | 1 +
.../rule_management/api/api.ts | 71 +------
...ion.ts => use_bootstrap_prebuilt_rules.ts} | 32 ++-
.../use_install_fleet_package_mutation.ts | 47 -----
.../use_upgrade_secuirty_packages.test.tsx | 198 ------------------
.../logic/use_upgrade_security_packages.ts | 77 +------
.../server/client/client.test.ts | 2 +-
.../security_solution/server/client/client.ts | 12 +-
.../server/client/factory.test.ts | 4 +
.../server/client/factory.ts | 24 ++-
.../bootstrap_prebuilt_rules.test.ts | 141 +++++++++++++
.../bootstrap_prebuilt_rules.ts | 66 ++++++
.../install_prebuilt_rules_package.ts | 44 +++-
.../prebuilt_rules/api/register_routes.ts | 2 +
.../routes/__mocks__/request_context.ts | 13 +-
.../routes/__mocks__/request_responses.ts | 7 +
.../plugins/security_solution/server/mocks.ts | 3 +
.../security_solution/server/plugin.ts | 2 +
.../server/request_context_factory.ts | 3 +
.../plugins/security_solution/tsconfig.json | 1 +
.../services/security_solution_api.gen.ts | 10 +
.../bootstrap_prebuilt_rules.ts | 64 ++++++
.../trial_license_complete_tier/index.ts | 1 +
.../delete_endpoint_fleet_package.ts | 30 +++
.../delete_prebuilt_rules_fleet_package.ts | 5 +-
.../sourcerer/sourcerer_timeline.cy.ts | 4 +-
.../cypress/tasks/api_calls/prebuilt_rules.ts | 4 +-
.../cypress/tasks/fleet_integrations.ts | 7 +-
35 files changed, 578 insertions(+), 438 deletions(-)
create mode 100644 x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.gen.ts
create mode 100644 x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.schema.yaml
rename x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/{use_bulk_install_fleet_packages_mutation.ts => use_bootstrap_prebuilt_rules.ts} (59%)
delete mode 100644 x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_install_fleet_package_mutation.ts
delete mode 100644 x-pack/plugins/security_solution/public/detection_engine/rule_management/logic/use_upgrade_secuirty_packages.test.tsx
create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.test.ts
create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.ts
create mode 100644 x-pack/test/security_solution_api_integration/test_suites/detections_response/rules_management/prebuilt_rules/management/trial_license_complete_tier/bootstrap_prebuilt_rules.ts
create mode 100644 x-pack/test/security_solution_api_integration/test_suites/detections_response/utils/rules/prebuilt_rules/delete_endpoint_fleet_package.ts
diff --git a/x-pack/plugins/fleet/server/services/epm/package_service.ts b/x-pack/plugins/fleet/server/services/epm/package_service.ts
index ae2f5721aae8b..1911ed14a7c80 100644
--- a/x-pack/plugins/fleet/server/services/epm/package_service.ts
+++ b/x-pack/plugins/fleet/server/services/epm/package_service.ts
@@ -40,7 +40,7 @@ import type { InstallResult } from '../../../common';
import { appContextService } from '..';
-import type { CustomPackageDatasetConfiguration } from './packages/install';
+import type { CustomPackageDatasetConfiguration, EnsurePackageResult } from './packages/install';
import type { FetchFindLatestPackageOptions } from './registry';
import { getPackageFieldsMetadata } from './registry';
@@ -73,7 +73,7 @@ export interface PackageClient {
pkgVersion?: string;
spaceId?: string;
force?: boolean;
- }): Promise;
+ }): Promise;
installPackage(options: {
pkgName: string;
@@ -201,7 +201,7 @@ class PackageClientImpl implements PackageClient {
pkgVersion?: string;
spaceId?: string;
force?: boolean;
- }): Promise {
+ }): Promise {
await this.#runPreflight(INSTALL_PACKAGES_AUTHZ);
return ensureInstalledPackage({
diff --git a/x-pack/plugins/fleet/server/services/epm/packages/install.ts b/x-pack/plugins/fleet/server/services/epm/packages/install.ts
index f27cb794475c9..ce406773a0635 100644
--- a/x-pack/plugins/fleet/server/services/epm/packages/install.ts
+++ b/x-pack/plugins/fleet/server/services/epm/packages/install.ts
@@ -158,6 +158,11 @@ export async function isPackageVersionOrLaterInstalled(options: {
});
}
+export interface EnsurePackageResult {
+ status: InstallResultStatus;
+ package: Installation;
+}
+
export async function ensureInstalledPackage(options: {
savedObjectsClient: SavedObjectsClientContract;
pkgName: string;
@@ -166,7 +171,7 @@ export async function ensureInstalledPackage(options: {
spaceId?: string;
force?: boolean;
authorizationHeader?: HTTPAuthorizationHeader | null;
-}): Promise {
+}): Promise {
const {
savedObjectsClient,
pkgName,
@@ -189,7 +194,10 @@ export async function ensureInstalledPackage(options: {
});
if (installedPackageResult) {
- return installedPackageResult.package;
+ return {
+ status: 'already_installed',
+ package: installedPackageResult.package,
+ };
}
const pkgkey = Registry.pkgToPkgKey(pkgKeyProps);
const installResult = await installPackage({
@@ -226,7 +234,10 @@ export async function ensureInstalledPackage(options: {
const installation = await getInstallation({ savedObjectsClient, pkgName });
if (!installation) throw new FleetError(`Could not get installation for ${pkgName}`);
- return installation;
+ return {
+ status: 'installed',
+ package: installation,
+ };
}
export async function handleInstallPackageFailure({
diff --git a/x-pack/plugins/observability_solution/observability_onboarding/server/routes/flow/route.ts b/x-pack/plugins/observability_solution/observability_onboarding/server/routes/flow/route.ts
index d035a7fa02716..b4b2541416e2f 100644
--- a/x-pack/plugins/observability_solution/observability_onboarding/server/routes/flow/route.ts
+++ b/x-pack/plugins/observability_solution/observability_onboarding/server/routes/flow/route.ts
@@ -383,7 +383,8 @@ async function ensureInstalledIntegrations(
const { pkgName, installSource } = integration;
if (installSource === 'registry') {
- const pkg = await packageClient.ensureInstalledPackage({ pkgName });
+ const installation = await packageClient.ensureInstalledPackage({ pkgName });
+ const pkg = installation.package;
const inputs = await packageClient.getAgentPolicyInputs(pkg.name, pkg.version);
const { packageInfo } = await packageClient.getPackage(pkg.name, pkg.version);
diff --git a/x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/install_index_templates.ts b/x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/install_index_templates.ts
index c9ee257335c99..cfbfef34f16da 100644
--- a/x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/install_index_templates.ts
+++ b/x-pack/plugins/observability_solution/synthetics/server/routes/synthetics_service/install_index_templates.ts
@@ -27,9 +27,9 @@ export async function installSyntheticsIndexTemplates(server: SyntheticsServerSe
pkgName: 'synthetics',
});
- if (!installation) {
+ if (!installation.package) {
return Promise.reject('No package installation found.');
}
- return installation;
+ return installation.package;
}
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.gen.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.gen.ts
new file mode 100644
index 0000000000000..5613a117aceb5
--- /dev/null
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.gen.ts
@@ -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.
+ */
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ * title: Bootstrap Prebuilt Rules API endpoint
+ * version: 1
+ */
+
+import { z } from 'zod';
+
+export type PackageInstallStatus = z.infer;
+export const PackageInstallStatus = z.object({
+ /**
+ * The name of the package
+ */
+ name: z.string(),
+ /**
+ * The version of the package
+ */
+ version: z.string(),
+ /**
+ * The status of the package installation
+ */
+ status: z.enum(['installed', 'already_installed']),
+});
+
+export type BootstrapPrebuiltRulesResponse = z.infer;
+export const BootstrapPrebuiltRulesResponse = z.object({
+ /**
+ * The list of packages that were installed or upgraded
+ */
+ packages: z.array(PackageInstallStatus),
+});
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.schema.yaml b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.schema.yaml
new file mode 100644
index 0000000000000..92cb6ccaf2ad1
--- /dev/null
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.schema.yaml
@@ -0,0 +1,51 @@
+openapi: 3.0.0
+info:
+ title: Bootstrap Prebuilt Rules API endpoint
+ version: '1'
+paths:
+ /internal/detection_engine/prebuilt_rules/_bootstrap:
+ post:
+ x-labels: [ess, serverless]
+ x-codegen-enabled: true
+ operationId: BootstrapPrebuiltRules
+ summary: Bootstrap Prebuilt Rules
+ description: Ensures that the packages needed for prebuilt detection rules to work are installed and up to date
+ tags:
+ - Prebuilt Rules API
+ responses:
+ 200:
+ description: Indicates a successful call
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ packages:
+ type: array
+ description: The list of packages that were installed or upgraded
+ items:
+ $ref: '#/components/schemas/PackageInstallStatus'
+ required:
+ - packages
+
+components:
+ schemas:
+ PackageInstallStatus:
+ type: object
+ properties:
+ name:
+ type: string
+ description: The name of the package
+ version:
+ type: string
+ description: The version of the package
+ status:
+ type: string
+ description: The status of the package installation
+ enum:
+ - installed
+ - already_installed
+ required:
+ - name
+ - version
+ - status
diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/urls.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/urls.ts
index ae62433d93a35..3f744dffc9447 100644
--- a/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/urls.ts
+++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/urls.ts
@@ -10,14 +10,15 @@ import {
INTERNAL_DETECTION_ENGINE_URL as INTERNAL,
} from '../../../constants';
-const OLD_BASE_URL = `${RULES}/prepackaged` as const;
-const NEW_BASE_URL = `${INTERNAL}/prebuilt_rules` as const;
+const LEGACY_BASE_URL = `${RULES}/prepackaged` as const;
+const BASE_URL = `${INTERNAL}/prebuilt_rules` as const;
-export const PREBUILT_RULES_URL = OLD_BASE_URL;
-export const PREBUILT_RULES_STATUS_URL = `${OLD_BASE_URL}/_status` as const;
+export const PREBUILT_RULES_URL = LEGACY_BASE_URL;
+export const PREBUILT_RULES_STATUS_URL = `${LEGACY_BASE_URL}/_status` as const;
-export const GET_PREBUILT_RULES_STATUS_URL = `${NEW_BASE_URL}/status` as const;
-export const REVIEW_RULE_UPGRADE_URL = `${NEW_BASE_URL}/upgrade/_review` as const;
-export const PERFORM_RULE_UPGRADE_URL = `${NEW_BASE_URL}/upgrade/_perform` as const;
-export const REVIEW_RULE_INSTALLATION_URL = `${NEW_BASE_URL}/installation/_review` as const;
-export const PERFORM_RULE_INSTALLATION_URL = `${NEW_BASE_URL}/installation/_perform` as const;
+export const GET_PREBUILT_RULES_STATUS_URL = `${BASE_URL}/status` as const;
+export const BOOTSTRAP_PREBUILT_RULES_URL = `${BASE_URL}/_bootstrap` as const;
+export const REVIEW_RULE_UPGRADE_URL = `${BASE_URL}/upgrade/_review` as const;
+export const PERFORM_RULE_UPGRADE_URL = `${BASE_URL}/upgrade/_perform` as const;
+export const REVIEW_RULE_INSTALLATION_URL = `${BASE_URL}/installation/_review` as const;
+export const PERFORM_RULE_INSTALLATION_URL = `${BASE_URL}/installation/_perform` as const;
diff --git a/x-pack/plugins/security_solution/common/detection_engine/constants.ts b/x-pack/plugins/security_solution/common/detection_engine/constants.ts
index 8e06f46f1f46d..7057e3c8b3091 100644
--- a/x-pack/plugins/security_solution/common/detection_engine/constants.ts
+++ b/x-pack/plugins/security_solution/common/detection_engine/constants.ts
@@ -29,6 +29,7 @@ export enum RULE_PREVIEW_FROM {
}
export const PREBUILT_RULES_PACKAGE_NAME = 'security_detection_engine';
+export const ENDPOINT_PACKAGE_NAME = 'endpoint';
/**
* Rule signature id (`rule.rule_id`) of the prebuilt "Endpoint Security" rule.
diff --git a/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/api.ts b/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/api.ts
index 57f6c5f4e8305..3513c9a21aa7b 100644
--- a/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/api.ts
+++ b/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/api.ts
@@ -13,9 +13,6 @@ import { INTERNAL_ALERTING_API_FIND_RULES_PATH } from '@kbn/alerting-plugin/comm
import { BASE_ACTION_API_PATH } from '@kbn/actions-plugin/common';
import type { ActionType, AsApiContract } from '@kbn/actions-plugin/common';
import type { ActionResult } from '@kbn/actions-plugin/server';
-import type { BulkInstallPackagesResponse } from '@kbn/fleet-plugin/common';
-import { epmRouteService } from '@kbn/fleet-plugin/common';
-import type { InstallPackageResponse } from '@kbn/fleet-plugin/common/types';
import { convertRulesFilterToKQL } from '../../../../common/detection_engine/rule_management/rule_filtering';
import type {
UpgradeSpecificRulesRequest,
@@ -48,6 +45,7 @@ import {
} from '../../../../common/constants';
import {
+ BOOTSTRAP_PREBUILT_RULES_URL,
GET_PREBUILT_RULES_STATUS_URL,
PERFORM_RULE_INSTALLATION_URL,
PERFORM_RULE_UPGRADE_URL,
@@ -81,6 +79,7 @@ import type {
RulesSnoozeSettingsMap,
UpdateRulesProps,
} from '../logic/types';
+import type { BootstrapPrebuiltRulesResponse } from '../../../../common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.gen';
/**
* Create provided Rule
@@ -594,66 +593,6 @@ export const addRuleExceptions = async ({
}
);
-export interface InstallFleetPackageProps {
- packageName: string;
- packageVersion: string;
- prerelease?: boolean;
- force?: boolean;
-}
-
-/**
- * Install a Fleet package from the registry
- *
- * @param packageName Name of the package to install
- * @param packageVersion Version of the package to install
- * @param prerelease Whether to install a prerelease version of the package
- * @param force Whether to force install the package. If false, the package will only be installed if it is not already installed
- *
- * @returns The response from the Fleet API
- */
-export const installFleetPackage = ({
- packageName,
- packageVersion,
- prerelease = false,
- force = true,
-}: InstallFleetPackageProps): Promise => {
- return KibanaServices.get().http.post(
- epmRouteService.getInstallPath(packageName, packageVersion),
- {
- query: { prerelease },
- version: '2023-10-31',
- body: JSON.stringify({ force }),
- }
- );
-};
-
-export interface BulkInstallFleetPackagesProps {
- packages: string[];
- prerelease?: boolean;
-}
-
-/**
- * Install multiple Fleet packages from the registry
- *
- * @param packages Array of package names to install
- * @param prerelease Whether to install prerelease versions of the packages
- *
- * @returns The response from the Fleet API
- */
-export const bulkInstallFleetPackages = ({
- packages,
- prerelease = false,
-}: BulkInstallFleetPackagesProps): Promise => {
- return KibanaServices.get().http.post(
- epmRouteService.getBulkInstallPath(),
- {
- query: { prerelease },
- version: '2023-10-31',
- body: JSON.stringify({ packages }),
- }
- );
-};
-
/**
* NEW PREBUILT RULES ROUTES START HERE! 👋
* USE THESE ONES! THEY'RE THE NICE ONES, PROMISE!
@@ -759,3 +698,9 @@ export const performUpgradeSpecificRules = async (
pick_version: 'TARGET', // Setting fixed 'TARGET' temporarily for Milestone 2
}),
});
+
+export const bootstrapPrebuiltRules = async (): Promise =>
+ KibanaServices.get().http.fetch(BOOTSTRAP_PREBUILT_RULES_URL, {
+ method: 'POST',
+ version: '1',
+ });
diff --git a/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_bulk_install_fleet_packages_mutation.ts b/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_bootstrap_prebuilt_rules.ts
similarity index 59%
rename from x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_bulk_install_fleet_packages_mutation.ts
rename to x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_bootstrap_prebuilt_rules.ts
index d47f4799fcc30..9f2b810138a6c 100644
--- a/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_bulk_install_fleet_packages_mutation.ts
+++ b/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_bootstrap_prebuilt_rules.ts
@@ -4,39 +4,37 @@
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
-import { EPM_API_ROUTES } from '@kbn/fleet-plugin/common';
-import type { BulkInstallPackagesResponse } from '@kbn/fleet-plugin/common/types';
import type { UseMutationOptions } from '@tanstack/react-query';
import { useMutation } from '@tanstack/react-query';
+import { BOOTSTRAP_PREBUILT_RULES_URL } from '../../../../../common/api/detection_engine';
+import type { BootstrapPrebuiltRulesResponse } from '../../../../../common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.gen';
import { PREBUILT_RULES_PACKAGE_NAME } from '../../../../../common/detection_engine/constants';
-import type { BulkInstallFleetPackagesProps } from '../api';
-import { bulkInstallFleetPackages } from '../api';
+import { bootstrapPrebuiltRules } from '../api';
import { useInvalidateFetchPrebuiltRulesInstallReviewQuery } from './prebuilt_rules/use_fetch_prebuilt_rules_install_review_query';
import { useInvalidateFetchPrebuiltRulesStatusQuery } from './prebuilt_rules/use_fetch_prebuilt_rules_status_query';
import { useInvalidateFetchPrebuiltRulesUpgradeReviewQuery } from './prebuilt_rules/use_fetch_prebuilt_rules_upgrade_review_query';
-export const BULK_INSTALL_FLEET_PACKAGES_MUTATION_KEY = [
- 'POST',
- EPM_API_ROUTES.BULK_INSTALL_PATTERN,
-];
+export const BOOTSTRAP_PREBUILT_RULES_KEY = ['POST', BOOTSTRAP_PREBUILT_RULES_URL];
-export const useBulkInstallFleetPackagesMutation = (
- options?: UseMutationOptions
+export const useBootstrapPrebuiltRulesMutation = (
+ options?: UseMutationOptions
) => {
const invalidatePrePackagedRulesStatus = useInvalidateFetchPrebuiltRulesStatusQuery();
const invalidatePrebuiltRulesInstallReview = useInvalidateFetchPrebuiltRulesInstallReviewQuery();
const invalidatePrebuiltRulesUpdateReview = useInvalidateFetchPrebuiltRulesUpgradeReviewQuery();
- return useMutation((props: BulkInstallFleetPackagesProps) => bulkInstallFleetPackages(props), {
+ return useMutation(() => bootstrapPrebuiltRules(), {
...options,
- mutationKey: BULK_INSTALL_FLEET_PACKAGES_MUTATION_KEY,
+ mutationKey: BOOTSTRAP_PREBUILT_RULES_KEY,
onSettled: (...args) => {
const response = args[0];
- const rulesPackage = response?.items.find(
- (item) => item.name === PREBUILT_RULES_PACKAGE_NAME
- );
- if (rulesPackage && 'result' in rulesPackage && rulesPackage.result.status === 'installed') {
- // The rules package was installed/updated, so invalidate the pre-packaged rules status query
+ if (
+ response?.packages.find((pkg) => pkg.name === PREBUILT_RULES_PACKAGE_NAME)?.status ===
+ 'installed'
+ ) {
+ // Invalidate other pre-packaged rules related queries. We need to do
+ // that only in case the prebuilt rules package was installed indicating
+ // that there might be new rules to install.
invalidatePrePackagedRulesStatus();
invalidatePrebuiltRulesInstallReview();
invalidatePrebuiltRulesUpdateReview();
diff --git a/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_install_fleet_package_mutation.ts b/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_install_fleet_package_mutation.ts
deleted file mode 100644
index e4f88d8b9c3ef..0000000000000
--- a/x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_install_fleet_package_mutation.ts
+++ /dev/null
@@ -1,47 +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 { EPM_API_ROUTES } from '@kbn/fleet-plugin/common';
-import type { InstallPackageResponse } from '@kbn/fleet-plugin/common/types';
-import type { UseMutationOptions } from '@tanstack/react-query';
-import { useMutation } from '@tanstack/react-query';
-import { PREBUILT_RULES_PACKAGE_NAME } from '../../../../../common/detection_engine/constants';
-import type { InstallFleetPackageProps } from '../api';
-import { installFleetPackage } from '../api';
-import { useInvalidateFetchPrebuiltRulesInstallReviewQuery } from './prebuilt_rules/use_fetch_prebuilt_rules_install_review_query';
-import { useInvalidateFetchPrebuiltRulesStatusQuery } from './prebuilt_rules/use_fetch_prebuilt_rules_status_query';
-import { useInvalidateFetchPrebuiltRulesUpgradeReviewQuery } from './prebuilt_rules/use_fetch_prebuilt_rules_upgrade_review_query';
-
-export const INSTALL_FLEET_PACKAGE_MUTATION_KEY = [
- 'POST',
- EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN,
-];
-
-export const useInstallFleetPackageMutation = (
- options?: UseMutationOptions
-) => {
- const invalidatePrePackagedRulesStatus = useInvalidateFetchPrebuiltRulesStatusQuery();
- const invalidatePrebuiltRulesInstallReview = useInvalidateFetchPrebuiltRulesInstallReviewQuery();
- const invalidatePrebuiltRulesUpdateReview = useInvalidateFetchPrebuiltRulesUpgradeReviewQuery();
-
- return useMutation((props: InstallFleetPackageProps) => installFleetPackage(props), {
- ...options,
- mutationKey: INSTALL_FLEET_PACKAGE_MUTATION_KEY,
- onSettled: (...args) => {
- const { packageName } = args[2];
- if (packageName === PREBUILT_RULES_PACKAGE_NAME) {
- // Invalidate the pre-packaged rules status query as there might be new rules to install
- invalidatePrePackagedRulesStatus();
- invalidatePrebuiltRulesInstallReview();
- invalidatePrebuiltRulesUpdateReview();
- }
-
- if (options?.onSettled) {
- options.onSettled(...args);
- }
- },
- });
-};
diff --git a/x-pack/plugins/security_solution/public/detection_engine/rule_management/logic/use_upgrade_secuirty_packages.test.tsx b/x-pack/plugins/security_solution/public/detection_engine/rule_management/logic/use_upgrade_secuirty_packages.test.tsx
deleted file mode 100644
index 9454a1c4dfb16..0000000000000
--- a/x-pack/plugins/security_solution/public/detection_engine/rule_management/logic/use_upgrade_secuirty_packages.test.tsx
+++ /dev/null
@@ -1,198 +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 { epmRouteService } from '@kbn/fleet-plugin/common';
-import { renderHook } from '@testing-library/react-hooks';
-import { useKibana, KibanaServices } from '../../../common/lib/kibana';
-import { TestProviders } from '../../../common/mock';
-import { useUpgradeSecurityPackages } from './use_upgrade_security_packages';
-
-jest.mock('../../../common/components/user_privileges', () => {
- return {
- useUserPrivileges: jest.fn().mockReturnValue({
- endpointPrivileges: {
- canAccessFleet: true,
- },
- }),
- };
-});
-jest.mock('../../../common/lib/kibana');
-
-const mockGetPrebuiltRulesPackageVersion =
- KibanaServices.getPrebuiltRulesPackageVersion as jest.Mock;
-const mockGetKibanaVersion = KibanaServices.getKibanaVersion as jest.Mock;
-const mockGetKibanaBranch = KibanaServices.getKibanaBranch as jest.Mock;
-const mockBuildFlavor = KibanaServices.getBuildFlavor as jest.Mock;
-const useKibanaMock = useKibana as jest.MockedFunction;
-
-describe('When using the `useUpgradeSecurityPackages()` hook', () => {
- beforeEach(() => {
- jest.clearAllMocks();
- });
-
- it('should call fleet setup first via `isInitialized()` and then send upgrade request', async () => {
- const { waitFor } = renderHook(() => useUpgradeSecurityPackages(), {
- wrapper: TestProviders,
- });
-
- expect(useKibanaMock().services.fleet?.isInitialized).toHaveBeenCalled();
- expect(useKibanaMock().services.http.post).not.toHaveBeenCalled();
-
- await waitFor(() => (useKibanaMock().services.http.post as jest.Mock).mock.calls.length > 0);
-
- expect(useKibanaMock().services.http.post).toHaveBeenCalledWith(
- `${epmRouteService.getBulkInstallPath()}`,
- expect.objectContaining({
- body: '{"packages":["endpoint","security_detection_engine"]}',
- })
- );
- });
-
- it('should send upgrade request with prerelease:false if in serverless', async () => {
- mockGetKibanaVersion.mockReturnValue('8.0.0');
- mockGetKibanaBranch.mockReturnValue('main');
- mockBuildFlavor.mockReturnValue('serverless');
-
- const { waitFor } = renderHook(() => useUpgradeSecurityPackages(), {
- wrapper: TestProviders,
- });
-
- await waitFor(() => (useKibanaMock().services.http.post as jest.Mock).mock.calls.length > 0);
-
- expect(useKibanaMock().services.http.post).toHaveBeenCalledWith(
- `${epmRouteService.getBulkInstallPath()}`,
- expect.objectContaining({
- body: '{"packages":["endpoint","security_detection_engine"]}',
- query: expect.objectContaining({ prerelease: false }),
- })
- );
- });
-
- it('should send upgrade request with prerelease:false if in serverless SNAPSHOT', async () => {
- mockGetKibanaVersion.mockReturnValue('8.0.0-SNAPSHOT');
- mockGetKibanaBranch.mockReturnValue('main');
- mockBuildFlavor.mockReturnValue('serverless');
-
- const { waitFor } = renderHook(() => useUpgradeSecurityPackages(), {
- wrapper: TestProviders,
- });
-
- await waitFor(() => (useKibanaMock().services.http.post as jest.Mock).mock.calls.length > 0);
-
- expect(useKibanaMock().services.http.post).toHaveBeenCalledWith(
- `${epmRouteService.getBulkInstallPath()}`,
- expect.objectContaining({
- body: '{"packages":["endpoint","security_detection_engine"]}',
- query: expect.objectContaining({ prerelease: false }),
- })
- );
- });
-
- it('should send upgrade request with prerelease:false if build does not include `-SNAPSHOT`', async () => {
- mockGetKibanaVersion.mockReturnValue('8.0.0');
- mockGetKibanaBranch.mockReturnValue('release');
- mockBuildFlavor.mockReturnValue('traditional');
-
- const { waitFor } = renderHook(() => useUpgradeSecurityPackages(), {
- wrapper: TestProviders,
- });
-
- await waitFor(() => (useKibanaMock().services.http.post as jest.Mock).mock.calls.length > 0);
-
- expect(useKibanaMock().services.http.post).toHaveBeenCalledWith(
- `${epmRouteService.getBulkInstallPath()}`,
- expect.objectContaining({
- body: '{"packages":["endpoint","security_detection_engine"]}',
- query: expect.objectContaining({ prerelease: false }),
- })
- );
- });
-
- it('should send upgrade request with prerelease:true if not serverless and branch is `main` AND build includes `-SNAPSHOT`', async () => {
- mockGetKibanaVersion.mockReturnValue('8.0.0-SNAPSHOT');
- mockGetKibanaBranch.mockReturnValue('main');
- mockBuildFlavor.mockReturnValue('traditional');
-
- const { waitFor } = renderHook(() => useUpgradeSecurityPackages(), {
- wrapper: TestProviders,
- });
-
- await waitFor(() => (useKibanaMock().services.http.post as jest.Mock).mock.calls.length > 0);
-
- expect(useKibanaMock().services.http.post).toHaveBeenCalledWith(
- `${epmRouteService.getBulkInstallPath()}`,
- expect.objectContaining({
- body: '{"packages":["endpoint","security_detection_engine"]}',
- query: expect.objectContaining({ prerelease: true }),
- })
- );
- });
-
- it('should send upgrade request with prerelease:true if branch is `release` and build includes `-SNAPSHOT`', async () => {
- mockGetKibanaVersion.mockReturnValue('8.0.0-SNAPSHOT');
- mockGetKibanaBranch.mockReturnValue('release');
- mockBuildFlavor.mockReturnValue('traditional');
-
- const { waitFor } = renderHook(() => useUpgradeSecurityPackages(), {
- wrapper: TestProviders,
- });
-
- await waitFor(() => (useKibanaMock().services.http.post as jest.Mock).mock.calls.length > 0);
-
- expect(useKibanaMock().services.http.post).toHaveBeenCalledWith(
- `${epmRouteService.getBulkInstallPath()}`,
- expect.objectContaining({
- body: '{"packages":["endpoint","security_detection_engine"]}',
- query: expect.objectContaining({ prerelease: true }),
- })
- );
- });
-
- it('should send upgrade request with prerelease:true if branch is `main` and build does not include `-SNAPSHOT`', async () => {
- mockGetKibanaVersion.mockReturnValue('8.0.0');
- mockGetKibanaBranch.mockReturnValue('main');
- mockBuildFlavor.mockReturnValue('traditional');
-
- const { waitFor } = renderHook(() => useUpgradeSecurityPackages(), {
- wrapper: TestProviders,
- });
-
- await waitFor(() => (useKibanaMock().services.http.post as jest.Mock).mock.calls.length > 0);
-
- expect(useKibanaMock().services.http.post).toHaveBeenCalledWith(
- `${epmRouteService.getBulkInstallPath()}`,
- expect.objectContaining({
- body: '{"packages":["endpoint","security_detection_engine"]}',
- query: expect.objectContaining({ prerelease: true }),
- })
- );
- });
-
- it('should send separate upgrade requests if prebuiltRulesPackageVersion is provided', async () => {
- mockGetPrebuiltRulesPackageVersion.mockReturnValue('8.2.1');
-
- const { waitFor } = renderHook(() => useUpgradeSecurityPackages(), {
- wrapper: TestProviders,
- });
-
- await waitFor(() => (useKibanaMock().services.http.post as jest.Mock).mock.calls.length > 0);
-
- expect(useKibanaMock().services.http.post).toHaveBeenNthCalledWith(
- 1,
- `${epmRouteService.getInstallPath('security_detection_engine', '8.2.1')}`,
- expect.objectContaining({ query: { prerelease: true } })
- );
- expect(useKibanaMock().services.http.post).toHaveBeenNthCalledWith(
- 2,
- `${epmRouteService.getBulkInstallPath()}`,
- expect.objectContaining({
- body: expect.stringContaining('endpoint'),
- query: expect.objectContaining({ prerelease: true }),
- })
- );
- });
-});
diff --git a/x-pack/plugins/security_solution/public/detection_engine/rule_management/logic/use_upgrade_security_packages.ts b/x-pack/plugins/security_solution/public/detection_engine/rule_management/logic/use_upgrade_security_packages.ts
index 8ad266169231d..e19cf2bcacf94 100644
--- a/x-pack/plugins/security_solution/public/detection_engine/rule_management/logic/use_upgrade_security_packages.ts
+++ b/x-pack/plugins/security_solution/public/detection_engine/rule_management/logic/use_upgrade_security_packages.ts
@@ -7,88 +7,29 @@
import { useIsMutating } from '@tanstack/react-query';
import { useEffect } from 'react';
-import { PREBUILT_RULES_PACKAGE_NAME } from '../../../../common/detection_engine/constants';
-import { useUserPrivileges } from '../../../common/components/user_privileges';
-import { KibanaServices, useKibana } from '../../../common/lib/kibana';
-import type { BulkInstallFleetPackagesProps, InstallFleetPackageProps } from '../api/api';
import {
- BULK_INSTALL_FLEET_PACKAGES_MUTATION_KEY,
- useBulkInstallFleetPackagesMutation,
-} from '../api/hooks/use_bulk_install_fleet_packages_mutation';
-import {
- INSTALL_FLEET_PACKAGE_MUTATION_KEY,
- useInstallFleetPackageMutation,
-} from '../api/hooks/use_install_fleet_package_mutation';
+ BOOTSTRAP_PREBUILT_RULES_KEY,
+ useBootstrapPrebuiltRulesMutation,
+} from '../api/hooks/use_bootstrap_prebuilt_rules';
/**
* Install or upgrade the security packages (endpoint and prebuilt rules)
*/
export const useUpgradeSecurityPackages = () => {
- const context = useKibana();
- const canAccessFleet = useUserPrivileges().endpointPrivileges.canAccessFleet;
- const { mutate: bulkInstallFleetPackages } = useBulkInstallFleetPackagesMutation();
- const { mutate: installFleetPackage } = useInstallFleetPackageMutation();
+ const { mutate: bootstrapPrebuiltRules } = useBootstrapPrebuiltRulesMutation();
useEffect(() => {
- if (!canAccessFleet) {
- return;
- }
-
- (async () => {
- // Make sure fleet is initialized first
- await context.services.fleet?.isInitialized();
-
- // Install the latest prerelease if in non-production non-serverless environments
- const prerelease =
- KibanaServices.getBuildFlavor() === 'traditional' &&
- (KibanaServices.getKibanaVersion().includes('-SNAPSHOT') ||
- KibanaServices.getKibanaBranch() === 'main');
-
- const prebuiltRulesPackageVersion = KibanaServices.getPrebuiltRulesPackageVersion();
- // ignore the response for now since we aren't notifying the user
- const packages = ['endpoint', PREBUILT_RULES_PACKAGE_NAME];
-
- // If `prebuiltRulesPackageVersion` is provided, try to install that version
- // Must be done as two separate requests as bulk API doesn't support versions
- if (prebuiltRulesPackageVersion != null) {
- installFleetPackage({
- packageName: PREBUILT_RULES_PACKAGE_NAME,
- packageVersion: prebuiltRulesPackageVersion,
- prerelease,
- force: true,
- });
- packages.splice(packages.indexOf(PREBUILT_RULES_PACKAGE_NAME), 1);
- }
-
- // Note: if `prerelease:true` option is provided, endpoint package will also be installed as prerelease
- bulkInstallFleetPackages({
- packages,
- prerelease,
- });
- })();
- }, [bulkInstallFleetPackages, canAccessFleet, context.services.fleet, installFleetPackage]);
+ bootstrapPrebuiltRules();
+ }, [bootstrapPrebuiltRules]);
};
/**
* @returns true if the security packages are being installed or upgraded
*/
export const useIsUpgradingSecurityPackages = () => {
- const isInstallingPackages = useIsMutating({
- predicate: ({ options: { mutationKey }, state: { variables } }) => {
- // The mutation is bulk Fleet packages installation. Check if the packages include the prebuilt rules package
- if (mutationKey === BULK_INSTALL_FLEET_PACKAGES_MUTATION_KEY) {
- return (variables as BulkInstallFleetPackagesProps).packages.includes(
- PREBUILT_RULES_PACKAGE_NAME
- );
- }
-
- // The mutation is single Fleet package installation. Check if the package is the prebuilt rules package
- if (mutationKey === INSTALL_FLEET_PACKAGE_MUTATION_KEY) {
- return (variables as InstallFleetPackageProps).packageName === PREBUILT_RULES_PACKAGE_NAME;
- }
- return false;
- },
+ const bootstrappingRules = useIsMutating({
+ mutationKey: BOOTSTRAP_PREBUILT_RULES_KEY,
});
- return isInstallingPackages > 0;
+ return bootstrappingRules > 0;
};
diff --git a/x-pack/plugins/security_solution/server/client/client.test.ts b/x-pack/plugins/security_solution/server/client/client.test.ts
index 4c0c4361b3a72..59be6609b3374 100644
--- a/x-pack/plugins/security_solution/server/client/client.test.ts
+++ b/x-pack/plugins/security_solution/server/client/client.test.ts
@@ -17,7 +17,7 @@ describe('SiemClient', () => {
[SIGNALS_INDEX_KEY]: 'mockSignalsIndex',
};
const spaceId = 'fooSpace';
- const client = new AppClient(spaceId, mockConfig, '8.7', 'main');
+ const client = new AppClient(spaceId, mockConfig, '8.7', 'main', 'traditional');
expect(client.getSignalsIndex()).toEqual('mockSignalsIndex-fooSpace');
});
diff --git a/x-pack/plugins/security_solution/server/client/client.ts b/x-pack/plugins/security_solution/server/client/client.ts
index c7e63769ac1e0..b2418e0263699 100644
--- a/x-pack/plugins/security_solution/server/client/client.ts
+++ b/x-pack/plugins/security_solution/server/client/client.ts
@@ -5,6 +5,7 @@
* 2.0.
*/
+import type { BuildFlavor } from '@kbn/config';
import type { ConfigType } from '../config';
import {
DEFAULT_ALERTS_INDEX,
@@ -20,8 +21,15 @@ export class AppClient {
private readonly sourcererDataViewId: string;
private readonly kibanaVersion: string;
private readonly kibanaBranch: string;
+ private readonly buildFlavor: BuildFlavor;
- constructor(spaceId: string, config: ConfigType, kibanaVersion: string, kibanaBranch: string) {
+ constructor(
+ spaceId: string,
+ config: ConfigType,
+ kibanaVersion: string,
+ kibanaBranch: string,
+ buildFlavor: BuildFlavor
+ ) {
const configuredSignalsIndex = config.signalsIndex;
this.alertsIndex = `${DEFAULT_ALERTS_INDEX}-${spaceId}`;
@@ -31,6 +39,7 @@ export class AppClient {
this.spaceId = spaceId;
this.kibanaVersion = kibanaVersion;
this.kibanaBranch = kibanaBranch;
+ this.buildFlavor = buildFlavor;
}
public getAlertsIndex = (): string => this.alertsIndex;
@@ -40,4 +49,5 @@ export class AppClient {
public getSpaceId = (): string => this.spaceId;
public getKibanaVersion = (): string => this.kibanaVersion;
public getKibanaBranch = (): string => this.kibanaBranch;
+ public getBuildFlavor = (): BuildFlavor => this.buildFlavor;
}
diff --git a/x-pack/plugins/security_solution/server/client/factory.test.ts b/x-pack/plugins/security_solution/server/client/factory.test.ts
index 681daf88fc0d9..81f9f73d759a7 100644
--- a/x-pack/plugins/security_solution/server/client/factory.test.ts
+++ b/x-pack/plugins/security_solution/server/client/factory.test.ts
@@ -23,6 +23,7 @@ describe('AppClientFactory', () => {
config: createMockConfig(),
kibanaVersion: '8.7',
kibanaBranch: 'main',
+ buildFlavor: 'traditional',
});
factory.create(mockRequest);
@@ -30,6 +31,7 @@ describe('AppClientFactory', () => {
'mockSpace',
expect.anything(),
expect.anything(),
+ expect.anything(),
expect.anything()
);
});
@@ -42,6 +44,7 @@ describe('AppClientFactory', () => {
config: createMockConfig(),
kibanaVersion: '8.7',
kibanaBranch: 'main',
+ buildFlavor: 'traditional',
});
factory.create(mockRequest);
@@ -49,6 +52,7 @@ describe('AppClientFactory', () => {
'default',
expect.anything(),
expect.anything(),
+ expect.anything(),
expect.anything()
);
});
diff --git a/x-pack/plugins/security_solution/server/client/factory.ts b/x-pack/plugins/security_solution/server/client/factory.ts
index 3dc8925c0c6e3..d36b076e55531 100644
--- a/x-pack/plugins/security_solution/server/client/factory.ts
+++ b/x-pack/plugins/security_solution/server/client/factory.ts
@@ -6,6 +6,7 @@
*/
import type { KibanaRequest } from '@kbn/core/server';
+import type { BuildFlavor } from '@kbn/config';
import { AppClient } from './client';
import type { ConfigType } from '../config';
import { invariant } from '../../common/utils/invariant';
@@ -15,6 +16,7 @@ interface SetupDependencies {
config: ConfigType;
kibanaVersion: string;
kibanaBranch: string;
+ buildFlavor: BuildFlavor;
}
export class AppClientFactory {
@@ -22,12 +24,20 @@ export class AppClientFactory {
private config?: SetupDependencies['config'];
private kibanaVersion?: string;
private kibanaBranch?: string;
+ private buildFlavor?: BuildFlavor;
- public setup({ getSpaceId, config, kibanaBranch, kibanaVersion }: SetupDependencies) {
+ public setup({
+ getSpaceId,
+ config,
+ kibanaBranch,
+ kibanaVersion,
+ buildFlavor,
+ }: SetupDependencies) {
this.getSpaceId = getSpaceId;
this.config = config;
this.kibanaVersion = kibanaVersion;
this.kibanaBranch = kibanaBranch;
+ this.buildFlavor = buildFlavor;
}
public create(request: KibanaRequest): AppClient {
@@ -43,8 +53,18 @@ export class AppClientFactory {
this.kibanaBranch != null,
'Cannot create AppClient as kibanaBranch is not present. Did you forget to call setup()?'
);
+ invariant(
+ this.buildFlavor != null,
+ 'Cannot create AppClient as buildFlavor is not present. Did you forget to call setup()?'
+ );
const spaceId = this.getSpaceId?.(request) ?? 'default';
- return new AppClient(spaceId, this.config, this.kibanaVersion, this.kibanaBranch);
+ return new AppClient(
+ spaceId,
+ this.config,
+ this.kibanaVersion,
+ this.kibanaBranch,
+ this.buildFlavor
+ );
}
}
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.test.ts
new file mode 100644
index 0000000000000..c2982d4b16092
--- /dev/null
+++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.test.ts
@@ -0,0 +1,141 @@
+/*
+ * 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 { bootstrapPrebuiltRulesRoute } from './bootstrap_prebuilt_rules';
+
+import type { Installation, RegistryPackage } from '@kbn/fleet-plugin/common';
+import { requestContextMock, serverMock } from '../../../routes/__mocks__';
+import { getBootstrapRulesRequest } from '../../../routes/__mocks__/request_responses';
+
+const packageMock: RegistryPackage = {
+ name: 'detection_engine',
+ version: '1.0.0',
+ format_version: '1.0.0',
+ title: 'Test package',
+ description: 'Test package',
+ owner: { github: 'elastic' },
+ download: '',
+ path: '',
+};
+
+const installationMock: Installation = {
+ name: 'detection_engine',
+ version: '1.0.0',
+ installed_kibana: [],
+ installed_es: [],
+ es_index_patterns: {},
+ install_status: 'installed',
+ verification_status: 'verified',
+ install_version: '1.0.0',
+ install_source: 'registry',
+ install_started_at: '2021-08-02T15:00:00.000Z',
+};
+
+describe('bootstrap_prebuilt_rules_route', () => {
+ let server: ReturnType;
+ let { clients, context } = requestContextMock.createTools();
+
+ beforeEach(() => {
+ jest.clearAllMocks();
+ server = serverMock.create();
+ ({ clients, context } = requestContextMock.createTools());
+
+ bootstrapPrebuiltRulesRoute(server.router);
+ });
+
+ it('returns information about installed packages', async () => {
+ clients.internalFleetServices.packages.fetchFindLatestPackage.mockResolvedValue(packageMock);
+ clients.internalFleetServices.packages.ensureInstalledPackage.mockResolvedValue({
+ status: 'installed',
+ package: installationMock,
+ });
+ const response = await server.inject(
+ getBootstrapRulesRequest(),
+ requestContextMock.convertContext(context)
+ );
+ expect(response.status).toEqual(200);
+ expect(response.body).toEqual({
+ packages: expect.arrayContaining([
+ expect.objectContaining({
+ name: 'detection_engine',
+ version: '1.0.0',
+ status: 'installed',
+ }),
+ ]),
+ });
+ });
+
+ it('installs pre-release packages in dev mode', async () => {
+ // Mock the package installation
+ clients.internalFleetServices.packages.fetchFindLatestPackage.mockResolvedValue(packageMock);
+ clients.internalFleetServices.packages.ensureInstalledPackage.mockResolvedValue({
+ status: 'installed',
+ package: installationMock,
+ });
+
+ // Mock Kibana build and branch
+ clients.appClient.getBuildFlavor.mockReturnValue('traditional');
+ clients.appClient.getKibanaBranch.mockReturnValue('main');
+
+ const response = await server.inject(
+ getBootstrapRulesRequest(),
+ requestContextMock.convertContext(context)
+ );
+ expect(response.status).toEqual(200);
+ expect(clients.internalFleetServices.packages.fetchFindLatestPackage).toHaveBeenCalledWith(
+ 'security_detection_engine',
+ { prerelease: true }
+ );
+ });
+
+ it('installs pre-release packages for release candidates', async () => {
+ // Mock the package installation
+ clients.internalFleetServices.packages.fetchFindLatestPackage.mockResolvedValue(packageMock);
+ clients.internalFleetServices.packages.ensureInstalledPackage.mockResolvedValue({
+ status: 'installed',
+ package: installationMock,
+ });
+
+ // Mock Kibana build and branch
+ clients.appClient.getBuildFlavor.mockReturnValue('traditional');
+ clients.appClient.getKibanaBranch.mockReturnValue('8.16.0');
+ clients.appClient.getKibanaVersion.mockReturnValue('8.16.0-SNAPSHOT');
+
+ const response = await server.inject(
+ getBootstrapRulesRequest(),
+ requestContextMock.convertContext(context)
+ );
+ expect(response.status).toEqual(200);
+ expect(clients.internalFleetServices.packages.fetchFindLatestPackage).toHaveBeenCalledWith(
+ 'security_detection_engine',
+ { prerelease: true }
+ );
+ });
+
+ it('installs release packages for Serverless', async () => {
+ // Mock the package installation
+ clients.internalFleetServices.packages.fetchFindLatestPackage.mockResolvedValue(packageMock);
+ clients.internalFleetServices.packages.ensureInstalledPackage.mockResolvedValue({
+ status: 'installed',
+ package: installationMock,
+ });
+
+ // Mock Kibana build and branch
+ clients.appClient.getBuildFlavor.mockReturnValue('serverless');
+ clients.appClient.getKibanaBranch.mockReturnValue('main');
+
+ const response = await server.inject(
+ getBootstrapRulesRequest(),
+ requestContextMock.convertContext(context)
+ );
+ expect(response.status).toEqual(200);
+ expect(clients.internalFleetServices.packages.fetchFindLatestPackage).toHaveBeenCalledWith(
+ 'security_detection_engine',
+ { prerelease: false }
+ );
+ });
+});
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.ts
new file mode 100644
index 0000000000000..d17435a543320
--- /dev/null
+++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.ts
@@ -0,0 +1,66 @@
+/*
+ * 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 { transformError } from '@kbn/securitysolution-es-utils';
+import type { IKibanaResponse } from '@kbn/core/server';
+import { BOOTSTRAP_PREBUILT_RULES_URL } from '../../../../../../common/api/detection_engine/prebuilt_rules';
+import type { BootstrapPrebuiltRulesResponse } from '../../../../../../common/api/detection_engine/prebuilt_rules/bootstrap_prebuilt_rules/bootstrap_prebuilt_rules.gen';
+import type { SecuritySolutionPluginRouter } from '../../../../../types';
+import { buildSiemResponse } from '../../../routes/utils';
+import {
+ installEndpointPackage,
+ installPrebuiltRulesPackage,
+} from '../install_prebuilt_rules_and_timelines/install_prebuilt_rules_package';
+
+export const bootstrapPrebuiltRulesRoute = (router: SecuritySolutionPluginRouter) => {
+ router.versioned
+ .post({
+ access: 'internal',
+ path: BOOTSTRAP_PREBUILT_RULES_URL,
+ options: {
+ tags: ['access:securitySolution'],
+ },
+ })
+ .addVersion(
+ {
+ version: '1',
+ validate: {},
+ },
+ async (context, _, response): Promise> => {
+ const siemResponse = buildSiemResponse(response);
+
+ try {
+ const ctx = await context.resolve(['securitySolution']);
+ const securityContext = ctx.securitySolution;
+ const config = securityContext.getConfig();
+
+ const results = await Promise.all([
+ installPrebuiltRulesPackage(config, securityContext),
+ installEndpointPackage(config, securityContext),
+ ]);
+
+ const responseBody: BootstrapPrebuiltRulesResponse = {
+ packages: results.map((result) => ({
+ name: result.package.name,
+ version: result.package.version,
+ status: result.status,
+ })),
+ };
+
+ return response.ok({
+ body: responseBody,
+ });
+ } catch (err) {
+ const error = transformError(err);
+ return siemResponse.error({
+ body: error.message,
+ statusCode: error.statusCode,
+ });
+ }
+ }
+ );
+};
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/install_prebuilt_rules_package.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/install_prebuilt_rules_package.ts
index 4bbc4c3561674..23bcc654eb780 100644
--- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/install_prebuilt_rules_package.ts
+++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/install_prebuilt_rules_package.ts
@@ -6,7 +6,10 @@
*/
import type { SecuritySolutionApiRequestHandlerContext } from '../../../../../types';
-import { PREBUILT_RULES_PACKAGE_NAME } from '../../../../../../common/detection_engine/constants';
+import {
+ ENDPOINT_PACKAGE_NAME,
+ PREBUILT_RULES_PACKAGE_NAME,
+} from '../../../../../../common/detection_engine/constants';
import type { ConfigType } from '../../../../../config';
/**
@@ -19,24 +22,45 @@ export async function installPrebuiltRulesPackage(
config: ConfigType,
context: SecuritySolutionApiRequestHandlerContext
) {
- // Get package version from the config
+ const pkgVersion = await findLatestPackageVersion(config, context, PREBUILT_RULES_PACKAGE_NAME);
+
+ return context
+ .getInternalFleetServices()
+ .packages.ensureInstalledPackage({ pkgName: PREBUILT_RULES_PACKAGE_NAME, pkgVersion });
+}
+
+export async function installEndpointPackage(
+ config: ConfigType,
+ context: SecuritySolutionApiRequestHandlerContext
+) {
+ const pkgVersion = await findLatestPackageVersion(config, context, ENDPOINT_PACKAGE_NAME);
+
+ return context.getInternalFleetServices().packages.ensureInstalledPackage({
+ pkgName: ENDPOINT_PACKAGE_NAME,
+ pkgVersion,
+ });
+}
+
+async function findLatestPackageVersion(
+ config: ConfigType,
+ context: SecuritySolutionApiRequestHandlerContext,
+ packageName: string
+) {
let pkgVersion = config.prebuiltRulesPackageVersion;
// Find latest package if the version isn't specified in the config
if (!pkgVersion) {
+ const securityAppClient = context.getAppClient();
// Use prerelease versions in dev environment
const isPrerelease =
- context.getAppClient().getKibanaVersion().includes('-SNAPSHOT') ||
- context.getAppClient().getKibanaBranch() === 'main';
+ securityAppClient.getBuildFlavor() === 'traditional' &&
+ (securityAppClient.getKibanaVersion().includes('-SNAPSHOT') ||
+ securityAppClient.getKibanaBranch() === 'main');
const result = await context
.getInternalFleetServices()
- .packages.fetchFindLatestPackage(PREBUILT_RULES_PACKAGE_NAME, { prerelease: isPrerelease });
+ .packages.fetchFindLatestPackage(packageName, { prerelease: isPrerelease });
pkgVersion = result.version;
}
-
- // Install the package
- await context
- .getInternalFleetServices()
- .packages.ensureInstalledPackage({ pkgName: PREBUILT_RULES_PACKAGE_NAME, pkgVersion });
+ return pkgVersion;
}
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/register_routes.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/register_routes.ts
index 71740086e3fa5..c9871f86a43e2 100644
--- a/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/register_routes.ts
+++ b/x-pack/plugins/security_solution/server/lib/detection_engine/prebuilt_rules/api/register_routes.ts
@@ -14,6 +14,7 @@ import { reviewRuleInstallationRoute } from './review_rule_installation/review_r
import { reviewRuleUpgradeRoute } from './review_rule_upgrade/review_rule_upgrade_route';
import { performRuleInstallationRoute } from './perform_rule_installation/perform_rule_installation_route';
import { performRuleUpgradeRoute } from './perform_rule_upgrade/perform_rule_upgrade_route';
+import { bootstrapPrebuiltRulesRoute } from './bootstrap_prebuilt_rules/bootstrap_prebuilt_rules';
export const registerPrebuiltRulesRoutes = (router: SecuritySolutionPluginRouter) => {
// Legacy endpoints that we're going to deprecate
@@ -26,4 +27,5 @@ export const registerPrebuiltRulesRoutes = (router: SecuritySolutionPluginRouter
performRuleUpgradeRoute(router);
reviewRuleInstallationRoute(router);
reviewRuleUpgradeRoute(router);
+ bootstrapPrebuiltRulesRoute(router);
};
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 fa9fcc1fa5e22..b39cba0cf4952 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
@@ -39,6 +39,8 @@ import { riskScoreDataClientMock } from '../../../entity_analytics/risk_score/ri
import { assetCriticalityDataClientMock } from '../../../entity_analytics/asset_criticality/asset_criticality_data_client.mock';
import { auditLoggerMock } from '@kbn/security-plugin/server/audit/mocks';
import { detectionRulesClientMock } from '../../rule_management/logic/detection_rules_client/__mocks__/detection_rules_client';
+import { packageServiceMock } from '@kbn/fleet-plugin/server/services/epm/package_service.mock';
+import type { EndpointInternalFleetServicesInterface } from '../../../../endpoint/services/fleet';
export const createMockClients = () => {
const core = coreMock.createRequestHandlerContext();
@@ -70,6 +72,10 @@ export const createMockClients = () => {
riskEngineDataClient: riskEngineDataClientMock.create(),
riskScoreDataClient: riskScoreDataClientMock.create(),
assetCriticalityDataClient: assetCriticalityDataClientMock.create(),
+
+ internalFleetServices: {
+ packages: packageServiceMock.createClient(),
+ },
};
};
@@ -146,10 +152,9 @@ const createSecuritySolutionRequestContextMock = (
getDetectionEngineHealthClient: jest.fn(() => clients.detectionEngineHealthClient),
getRuleExecutionLog: jest.fn(() => clients.ruleExecutionLog),
getExceptionListClient: jest.fn(() => clients.lists.exceptionListClient),
- getInternalFleetServices: jest.fn(() => {
- // TODO: Mock EndpointInternalFleetServicesInterface and return the mocked object.
- throw new Error('Not implemented');
- }),
+ getInternalFleetServices: jest.fn(
+ () => clients.internalFleetServices as unknown as EndpointInternalFleetServicesInterface
+ ),
getRiskEngineDataClient: jest.fn(() => clients.riskEngineDataClient),
getRiskScoreDataClient: jest.fn(() => clients.riskScoreDataClient),
getAssetCriticalityDataClient: jest.fn(() => clients.assetCriticalityDataClient),
diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts
index 2bd7efdbbdcf2..3a48bb449c55d 100644
--- a/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts
+++ b/x-pack/plugins/security_solution/server/lib/detection_engine/routes/__mocks__/request_responses.ts
@@ -33,6 +33,7 @@ import {
import { RULE_MANAGEMENT_FILTERS_URL } from '../../../../../common/api/detection_engine/rule_management/urls';
import {
+ BOOTSTRAP_PREBUILT_RULES_URL,
PREBUILT_RULES_STATUS_URL,
PREBUILT_RULES_URL,
} from '../../../../../common/api/detection_engine/prebuilt_rules';
@@ -203,6 +204,12 @@ export const getRuleManagementFiltersRequest = () =>
path: RULE_MANAGEMENT_FILTERS_URL,
});
+export const getBootstrapRulesRequest = () =>
+ requestMock.create({
+ method: 'post',
+ path: BOOTSTRAP_PREBUILT_RULES_URL,
+ });
+
export interface FindHit {
page: number;
perPage: number;
diff --git a/x-pack/plugins/security_solution/server/mocks.ts b/x-pack/plugins/security_solution/server/mocks.ts
index 7e71246fd1c2c..1d838476a8325 100644
--- a/x-pack/plugins/security_solution/server/mocks.ts
+++ b/x-pack/plugins/security_solution/server/mocks.ts
@@ -18,6 +18,9 @@ const createAppClientMock = (): AppClientMock =>
getAlertsIndex: jest.fn(),
getSignalsIndex: jest.fn(),
getSourcererDataViewId: jest.fn().mockReturnValue('security-solution'),
+ getKibanaVersion: jest.fn().mockReturnValue('8.0.0'),
+ getKibanaBranch: jest.fn().mockReturnValue('main'),
+ getBuildFlavor: jest.fn().mockReturnValue('traditional'),
} as unknown as AppClientMock);
export const siemMock = {
diff --git a/x-pack/plugins/security_solution/server/plugin.ts b/x-pack/plugins/security_solution/server/plugin.ts
index 0fb3f0355fbf5..c24e70baa5db8 100644
--- a/x-pack/plugins/security_solution/server/plugin.ts
+++ b/x-pack/plugins/security_solution/server/plugin.ts
@@ -224,6 +224,7 @@ export class Plugin implements ISecuritySolutionPlugin {
ruleMonitoringService: this.ruleMonitoringService,
kibanaVersion: pluginContext.env.packageInfo.version,
kibanaBranch: pluginContext.env.packageInfo.branch,
+ buildFlavor: pluginContext.env.packageInfo.buildFlavor,
});
productFeaturesService.registerApiAccessControl(core.http);
@@ -417,6 +418,7 @@ export class Plugin implements ISecuritySolutionPlugin {
config,
kibanaVersion: pluginContext.env.packageInfo.version,
kibanaBranch: pluginContext.env.packageInfo.branch,
+ buildFlavor: pluginContext.env.packageInfo.buildFlavor,
});
const endpointFieldsStrategy = endpointFieldsProvider(
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 780b69681caf4..4bda7e0338aa8 100644
--- a/x-pack/plugins/security_solution/server/request_context_factory.ts
+++ b/x-pack/plugins/security_solution/server/request_context_factory.ts
@@ -9,6 +9,7 @@ import { memoize } from 'lodash';
import type { Logger, KibanaRequest, RequestHandlerContext } from '@kbn/core/server';
+import type { BuildFlavor } from '@kbn/config';
import { DEFAULT_SPACE_ID } from '../common/constants';
import { AppClientFactory } from './client';
import type { ConfigType } from './config';
@@ -47,6 +48,7 @@ interface ConstructorOptions {
ruleMonitoringService: IRuleMonitoringService;
kibanaVersion: string;
kibanaBranch: string;
+ buildFlavor: BuildFlavor;
}
export class RequestContextFactory implements IRequestContextFactory {
@@ -79,6 +81,7 @@ export class RequestContextFactory implements IRequestContextFactory {
config,
kibanaVersion: options.kibanaVersion,
kibanaBranch: options.kibanaBranch,
+ buildFlavor: options.buildFlavor,
});
const getAuditLogger = () => security?.audit.asScoped(request);
diff --git a/x-pack/plugins/security_solution/tsconfig.json b/x-pack/plugins/security_solution/tsconfig.json
index ba89ca2864d74..3258167eb50b7 100644
--- a/x-pack/plugins/security_solution/tsconfig.json
+++ b/x-pack/plugins/security_solution/tsconfig.json
@@ -208,5 +208,6 @@
"@kbn/core-theme-browser",
"@kbn/integration-assistant-plugin",
"@kbn/avc-banner",
+ "@kbn/config",
]
}
diff --git a/x-pack/test/api_integration/services/security_solution_api.gen.ts b/x-pack/test/api_integration/services/security_solution_api.gen.ts
index 676fea3fd5364..582b7feea4d55 100644
--- a/x-pack/test/api_integration/services/security_solution_api.gen.ts
+++ b/x-pack/test/api_integration/services/security_solution_api.gen.ts
@@ -129,6 +129,16 @@ after 30 days. It also deletes other artifacts specific to the migration impleme
.set(ELASTIC_HTTP_VERSION_HEADER, '1')
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana');
},
+ /**
+ * Ensures that the packages needed for prebuilt detection rules to work are installed and up to date
+ */
+ bootstrapPrebuiltRules() {
+ return supertest
+ .post('/internal/detection_engine/prebuilt_rules/_bootstrap')
+ .set('kbn-xsrf', 'true')
+ .set(ELASTIC_HTTP_VERSION_HEADER, '1')
+ .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana');
+ },
/**
* Create new detection rules in bulk.
*/
diff --git a/x-pack/test/security_solution_api_integration/test_suites/detections_response/rules_management/prebuilt_rules/management/trial_license_complete_tier/bootstrap_prebuilt_rules.ts b/x-pack/test/security_solution_api_integration/test_suites/detections_response/rules_management/prebuilt_rules/management/trial_license_complete_tier/bootstrap_prebuilt_rules.ts
new file mode 100644
index 0000000000000..97287ef0cdb93
--- /dev/null
+++ b/x-pack/test/security_solution_api_integration/test_suites/detections_response/rules_management/prebuilt_rules/management/trial_license_complete_tier/bootstrap_prebuilt_rules.ts
@@ -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 {
+ ENDPOINT_PACKAGE_NAME,
+ PREBUILT_RULES_PACKAGE_NAME,
+} from '@kbn/security-solution-plugin/common/detection_engine/constants';
+import expect from 'expect';
+import { FtrProviderContext } from '../../../../../../ftr_provider_context';
+import { deletePrebuiltRulesFleetPackage } from '../../../../utils';
+import { deleteEndpointFleetPackage } from '../../../../utils/rules/prebuilt_rules/delete_endpoint_fleet_package';
+
+export default ({ getService }: FtrProviderContext): void => {
+ const supertest = getService('supertest');
+ const securitySolutionApi = getService('securitySolutionApi');
+
+ describe('@ess @serverless @skipInServerlessMKI Bootstrap Prebuilt Rules', () => {
+ beforeEach(async () => {
+ await deletePrebuiltRulesFleetPackage(supertest);
+ await deleteEndpointFleetPackage(supertest);
+ });
+
+ it('should install fleet packages required for detection engine to function', async () => {
+ const { body } = await securitySolutionApi.bootstrapPrebuiltRules().expect(200);
+
+ expect(body).toMatchObject({
+ packages: expect.arrayContaining([
+ expect.objectContaining({
+ name: PREBUILT_RULES_PACKAGE_NAME,
+ status: 'installed',
+ }),
+ expect.objectContaining({
+ name: ENDPOINT_PACKAGE_NAME,
+ status: 'installed',
+ }),
+ ]),
+ });
+ });
+
+ it('should skip installing fleet packages if they are already installed', async () => {
+ // Install the packages
+ await securitySolutionApi.bootstrapPrebuiltRules().expect(200);
+ // Try to install the packages again
+ const { body } = await securitySolutionApi.bootstrapPrebuiltRules().expect(200);
+
+ expect(body).toMatchObject({
+ packages: expect.arrayContaining([
+ expect.objectContaining({
+ name: PREBUILT_RULES_PACKAGE_NAME,
+ status: 'already_installed',
+ }),
+ expect.objectContaining({
+ name: ENDPOINT_PACKAGE_NAME,
+ status: 'already_installed',
+ }),
+ ]),
+ });
+ });
+ });
+};
diff --git a/x-pack/test/security_solution_api_integration/test_suites/detections_response/rules_management/prebuilt_rules/management/trial_license_complete_tier/index.ts b/x-pack/test/security_solution_api_integration/test_suites/detections_response/rules_management/prebuilt_rules/management/trial_license_complete_tier/index.ts
index 4d17ef3f63f72..8266fba86a099 100644
--- a/x-pack/test/security_solution_api_integration/test_suites/detections_response/rules_management/prebuilt_rules/management/trial_license_complete_tier/index.ts
+++ b/x-pack/test/security_solution_api_integration/test_suites/detections_response/rules_management/prebuilt_rules/management/trial_license_complete_tier/index.ts
@@ -9,6 +9,7 @@ import { FtrProviderContext } from '../../../../../../ftr_provider_context';
export default ({ loadTestFile }: FtrProviderContext): void => {
describe('Rules Management - Prebuilt Rules - Prebuilt Rules Management', function () {
+ loadTestFile(require.resolve('./bootstrap_prebuilt_rules'));
loadTestFile(require.resolve('./get_prebuilt_rules_status'));
loadTestFile(require.resolve('./get_prebuilt_timelines_status'));
loadTestFile(require.resolve('./install_prebuilt_rules'));
diff --git a/x-pack/test/security_solution_api_integration/test_suites/detections_response/utils/rules/prebuilt_rules/delete_endpoint_fleet_package.ts b/x-pack/test/security_solution_api_integration/test_suites/detections_response/utils/rules/prebuilt_rules/delete_endpoint_fleet_package.ts
new file mode 100644
index 0000000000000..e53e24f98de3b
--- /dev/null
+++ b/x-pack/test/security_solution_api_integration/test_suites/detections_response/utils/rules/prebuilt_rules/delete_endpoint_fleet_package.ts
@@ -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 { epmRouteService } from '@kbn/fleet-plugin/common';
+import { ENDPOINT_PACKAGE_NAME } from '@kbn/security-solution-plugin/common/detection_engine/constants';
+import type SuperTest from 'supertest';
+
+/**
+ * Delete the endpoint package using fleet API.
+ *
+ * @param supertest Supertest instance
+ */
+export async function deleteEndpointFleetPackage(supertest: SuperTest.Agent) {
+ const resp = await supertest
+ .get(epmRouteService.getInfoPath(ENDPOINT_PACKAGE_NAME))
+ .set('kbn-xsrf', 'true')
+ .set('elastic-api-version', '2023-10-31')
+ .send();
+
+ if (resp.status === 200 && resp.body.response.status === 'installed') {
+ await supertest
+ .delete(epmRouteService.getRemovePath(ENDPOINT_PACKAGE_NAME, resp.body.response.version))
+ .set('kbn-xsrf', 'true')
+ .send({ force: true });
+ }
+}
diff --git a/x-pack/test/security_solution_api_integration/test_suites/detections_response/utils/rules/prebuilt_rules/delete_prebuilt_rules_fleet_package.ts b/x-pack/test/security_solution_api_integration/test_suites/detections_response/utils/rules/prebuilt_rules/delete_prebuilt_rules_fleet_package.ts
index a3468ccb32b5a..930c9d39757f4 100644
--- a/x-pack/test/security_solution_api_integration/test_suites/detections_response/utils/rules/prebuilt_rules/delete_prebuilt_rules_fleet_package.ts
+++ b/x-pack/test/security_solution_api_integration/test_suites/detections_response/utils/rules/prebuilt_rules/delete_prebuilt_rules_fleet_package.ts
@@ -6,6 +6,7 @@
*/
import { epmRouteService } from '@kbn/fleet-plugin/common';
+import { PREBUILT_RULES_PACKAGE_NAME } from '@kbn/security-solution-plugin/common/detection_engine/constants';
import type SuperTest from 'supertest';
/**
@@ -15,7 +16,7 @@ import type SuperTest from 'supertest';
*/
export async function deletePrebuiltRulesFleetPackage(supertest: SuperTest.Agent) {
const resp = await supertest
- .get(epmRouteService.getInfoPath('security_detection_engine'))
+ .get(epmRouteService.getInfoPath(PREBUILT_RULES_PACKAGE_NAME))
.set('kbn-xsrf', 'true')
.set('elastic-api-version', '2023-10-31')
.send();
@@ -23,7 +24,7 @@ export async function deletePrebuiltRulesFleetPackage(supertest: SuperTest.Agent
if (resp.status === 200 && resp.body.response.status === 'installed') {
await supertest
.delete(
- epmRouteService.getRemovePath('security_detection_engine', resp.body.response.version)
+ epmRouteService.getRemovePath(PREBUILT_RULES_PACKAGE_NAME, resp.body.response.version)
)
.set('kbn-xsrf', 'true')
.send({ force: true });
diff --git a/x-pack/test/security_solution_cypress/cypress/e2e/investigations/sourcerer/sourcerer_timeline.cy.ts b/x-pack/test/security_solution_cypress/cypress/e2e/investigations/sourcerer/sourcerer_timeline.cy.ts
index fbb434c4d7263..bb4010a6db4f6 100644
--- a/x-pack/test/security_solution_cypress/cypress/e2e/investigations/sourcerer/sourcerer_timeline.cy.ts
+++ b/x-pack/test/security_solution_cypress/cypress/e2e/investigations/sourcerer/sourcerer_timeline.cy.ts
@@ -31,7 +31,7 @@ import {
saveSourcerer,
} from '../../../tasks/sourcerer';
import { openTimelineUsingToggle } from '../../../tasks/security_main';
-import { waitForFleetSetup } from '../../../tasks/fleet_integrations';
+import { waitForRulesBootstrap } from '../../../tasks/fleet_integrations';
import { SOURCERER } from '../../../screens/sourcerer';
import { createTimeline, deleteTimelines } from '../../../tasks/api_calls/timelines';
import { getTimelineModifiedSourcerer } from '../../../objects/timeline';
@@ -42,7 +42,7 @@ const dataViews = ['logs-*', 'metrics-*', '.kibana-event-log-*'];
describe('Timeline scope', { tags: ['@ess', '@serverless', '@skipInServerless'] }, () => {
before(() => {
- waitForFleetSetup();
+ waitForRulesBootstrap();
});
beforeEach(() => {
diff --git a/x-pack/test/security_solution_cypress/cypress/tasks/api_calls/prebuilt_rules.ts b/x-pack/test/security_solution_cypress/cypress/tasks/api_calls/prebuilt_rules.ts
index 273491ebd2efe..f4273cad22299 100644
--- a/x-pack/test/security_solution_cypress/cypress/tasks/api_calls/prebuilt_rules.ts
+++ b/x-pack/test/security_solution_cypress/cypress/tasks/api_calls/prebuilt_rules.ts
@@ -8,6 +8,7 @@
import {
PerformRuleInstallationResponseBody,
PERFORM_RULE_INSTALLATION_URL,
+ BOOTSTRAP_PREBUILT_RULES_URL,
} from '@kbn/security-solution-plugin/common/api/detection_engine';
import { ELASTIC_SECURITY_RULE_ID } from '@kbn/security-solution-plugin/common/detection_engine/constants';
import type { PrePackagedRulesStatusResponse } from '@kbn/security-solution-plugin/public/detection_engine/rule_management/logic/types';
@@ -203,8 +204,7 @@ export const getRuleAssets = (index: string | undefined = '.kibana_security_solu
/* during e2e tests, and allow for manual installation of mock rules instead. */
export const preventPrebuiltRulesPackageInstallation = () => {
cy.log('Prevent prebuilt rules package installation');
- cy.intercept('POST', '/api/fleet/epm/packages/_bulk*', {});
- cy.intercept('POST', '/api/fleet/epm/packages/security_detection_engine/*', {});
+ cy.intercept('POST', BOOTSTRAP_PREBUILT_RULES_URL, {});
};
/**
diff --git a/x-pack/test/security_solution_cypress/cypress/tasks/fleet_integrations.ts b/x-pack/test/security_solution_cypress/cypress/tasks/fleet_integrations.ts
index 7105ebc4df70f..f0b59a39b8478 100644
--- a/x-pack/test/security_solution_cypress/cypress/tasks/fleet_integrations.ts
+++ b/x-pack/test/security_solution_cypress/cypress/tasks/fleet_integrations.ts
@@ -6,6 +6,7 @@
*/
import {
+ BOOTSTRAP_PREBUILT_RULES_URL,
GET_ALL_INTEGRATIONS_URL,
Integration,
} from '@kbn/security-solution-plugin/common/api/detection_engine';
@@ -21,10 +22,10 @@ export const mockFleetIntegrations = (integrations: Integration[] = []) => {
}).as('integrations');
};
-export const waitForFleetSetup = () => {
- cy.intercept('POST', '/api/fleet/epm/packages/_bulk?prerelease=true').as('fleetSetup');
+export const waitForRulesBootstrap = () => {
+ cy.intercept('POST', BOOTSTRAP_PREBUILT_RULES_URL).as('rulesBootstrap');
cy.clearLocalStorage();
login();
visitGetStartedPage();
- cy.wait('@fleetSetup');
+ cy.wait('@rulesBootstrap');
};
From a76390722ea22fdc5e5764c319754d66f0defbb1 Mon Sep 17 00:00:00 2001
From: Janki Salvi <117571355+js-jankisalvi@users.noreply.github.com>
Date: Wed, 7 Aug 2024 13:50:45 +0100
Subject: [PATCH 09/44] [ResponseOps][Cases] Fix AllCasesList test (#190032)
## Summary
Fixes https://github.com/elastic/kibana/issues/148095
I updated whole test file to use `findBy` instead of `getBy` and removed
unnecessary `await waitFor`.
---
.../all_cases/all_cases_list.test.tsx | 405 ++++++++----------
1 file changed, 176 insertions(+), 229 deletions(-)
diff --git a/x-pack/plugins/cases/public/components/all_cases/all_cases_list.test.tsx b/x-pack/plugins/cases/public/components/all_cases/all_cases_list.test.tsx
index 242fc3260b7e2..5324a5a793067 100644
--- a/x-pack/plugins/cases/public/components/all_cases/all_cases_list.test.tsx
+++ b/x-pack/plugins/cases/public/components/all_cases/all_cases_list.test.tsx
@@ -184,31 +184,28 @@ describe('AllCasesListGeneric', () => {
useLicenseMock.mockReturnValue({ isAtLeastPlatinum: () => true });
appMockRenderer.render(
);
- expect(queryByTestId('options-filter-popover-button-owner')).toBeFalsy();
+ expect(screen.queryByTestId('options-filter-popover-button-owner')).not.toBeInTheDocument();
});
});
@@ -677,16 +660,13 @@ describe('AllCasesListGeneric', () => {
it('Renders bulk action', async () => {
appMockRenderer.render(
Date: Wed, 7 Aug 2024 15:13:13 +0200
Subject: [PATCH 10/44] [Telemetry][Security Solution] Fix flaky tests
(#190044)
## Summary
Fixes: https://github.com/elastic/kibana/issues/188234
https://github.com/elastic/kibana/issues/187719 and
https://github.com/elastic/kibana/issues/178918
The flakiness was while calculating the Detection Rules task
invocations. It could have two different RCs: 1) The code didn't retry
in case the task wasn't executed yet, which makes sense in a CI
environment, which is slower than a dev environment; 2) The timestamp to
filter out requests was calculated after the task was triggered, and if
the task is executed fast enough, it could lead to empty responses
because of that.
---
.../integration_tests/telemetry.test.ts | 103 ++++++++----------
1 file changed, 45 insertions(+), 58 deletions(-)
diff --git a/x-pack/plugins/security_solution/server/integration_tests/telemetry.test.ts b/x-pack/plugins/security_solution/server/integration_tests/telemetry.test.ts
index d45e59b2fe295..558f7e7ade2f6 100644
--- a/x-pack/plugins/security_solution/server/integration_tests/telemetry.test.ts
+++ b/x-pack/plugins/security_solution/server/integration_tests/telemetry.test.ts
@@ -148,8 +148,7 @@ describe('telemetry tasks', () => {
});
});
- // FLAKY: https://github.com/elastic/kibana/issues/187719
- describe.skip('detection-rules', () => {
+ describe('detection-rules', () => {
it('should execute when scheduled', async () => {
await mockAndScheduleDetectionRulesTask();
@@ -169,8 +168,7 @@ describe('telemetry tasks', () => {
});
it('should send task metrics', async () => {
- const task = await mockAndScheduleDetectionRulesTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleDetectionRulesTask();
const requests = await getTaskMetricsRequests(task, started);
@@ -181,13 +179,10 @@ describe('telemetry tasks', () => {
});
});
- // FLAKY: https://github.com/elastic/kibana/issues/178918
- // FLAKY: https://github.com/elastic/kibana/issues/187720
- describe.skip('sender configuration', () => {
+ describe('sender configuration', () => {
it('should use legacy sender by default', async () => {
// launch a random task and verify it uses the new configuration
- const task = await mockAndScheduleDetectionRulesTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleDetectionRulesTask();
const requests = await getTaskMetricsRequests(task, started);
expect(requests.length).toBeGreaterThan(0);
@@ -216,8 +211,7 @@ describe('telemetry tasks', () => {
expect(found).toBeFalsy();
});
- const task = await mockAndScheduleDetectionRulesTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleDetectionRulesTask();
const requests = await getTaskMetricsRequests(task, started);
expect(requests.length).toBeGreaterThan(0);
@@ -258,8 +252,7 @@ describe('telemetry tasks', () => {
});
});
- // FLAKY: https://github.com/elastic/kibana/issues/189192
- describe.skip('endpoint-diagnostics', () => {
+ describe('endpoint-diagnostics', () => {
it('should execute when scheduled', async () => {
await mockAndScheduleEndpointDiagnosticsTask();
@@ -298,8 +291,7 @@ describe('telemetry tasks', () => {
});
});
- // FLAKY: https://github.com/elastic/kibana/issues/189330
- describe.skip('endpoint-meta-telemetry', () => {
+ describe('endpoint-meta-telemetry', () => {
beforeEach(async () => {
await initEndpointIndices(esClient);
});
@@ -335,8 +327,7 @@ describe('telemetry tasks', () => {
Promise.reject(Error(errorMessage))
);
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const requests = await getTaskMetricsRequests(task, started);
@@ -361,8 +352,7 @@ describe('telemetry tasks', () => {
agentClient.listAgents = jest.fn((_) => Promise.reject(Error(errorMessage)));
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const endpointMetaRequests = await getEndpointMetaRequests();
@@ -401,8 +391,7 @@ describe('telemetry tasks', () => {
})
);
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const endpointMetaRequests = await getEndpointMetaRequests();
@@ -434,8 +423,7 @@ describe('telemetry tasks', () => {
telemetryReceiver.fetchPolicyConfigs = jest.fn((_) => Promise.reject(Error(errorMessage)));
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const endpointMetaRequests = await getEndpointMetaRequests();
@@ -478,8 +466,7 @@ describe('telemetry tasks', () => {
} as unknown as AgentPolicy);
});
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const endpointMetaRequests = await getEndpointMetaRequests();
@@ -512,8 +499,7 @@ describe('telemetry tasks', () => {
return Promise.reject(Error(errorMessage));
});
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const endpointMetaRequests = await getEndpointMetaRequests();
@@ -545,8 +531,7 @@ describe('telemetry tasks', () => {
return Promise.resolve(new Map());
});
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const endpointMetaRequests = await getEndpointMetaRequests();
@@ -579,8 +564,7 @@ describe('telemetry tasks', () => {
return Promise.reject(Error(errorMessage));
});
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const endpointMetaRequests = await getEndpointMetaRequests();
@@ -615,8 +599,7 @@ describe('telemetry tasks', () => {
return Promise.resolve(new Map());
});
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const endpointMetaRequests = await getEndpointMetaRequests();
@@ -663,8 +646,7 @@ describe('telemetry tasks', () => {
return esClient.search(query);
});
- const task = await mockAndScheduleEndpointTask();
- const started = performance.now();
+ const [task, started] = await mockAndScheduleEndpointTask();
const endpointMetaRequests = await getEndpointMetaRequests();
@@ -688,8 +670,7 @@ describe('telemetry tasks', () => {
});
});
- // FLAKY: https://github.com/elastic/kibana/issues/188234
- describe.skip('telemetry-prebuilt-rule-alerts', () => {
+ describe('telemetry-prebuilt-rule-alerts', () => {
it('should execute when scheduled', async () => {
await mockAndSchedulePrebuiltRulesTask();
@@ -722,8 +703,7 @@ describe('telemetry tasks', () => {
telemetryReceiver.fetchPrebuiltRuleAlertsBatch = mockedGenerator;
- const task = await mockAndSchedulePrebuiltRulesTask();
- const started = performance.now();
+ const [task, started] = await mockAndSchedulePrebuiltRulesTask();
const requests = await getTaskMetricsRequests(task, started);
@@ -781,7 +761,7 @@ describe('telemetry tasks', () => {
});
}
- async function mockAndScheduleDetectionRulesTask(): Promise {
+ async function mockAndScheduleDetectionRulesTask(): Promise<[SecurityTelemetryTask, number]> {
const task = getTelemetryTask(tasks, 'security:telemetry-detection-rules');
// create some data
@@ -797,50 +777,52 @@ describe('telemetry tasks', () => {
exceptionsListItem.push(exceptionListItem);
// schedule task to run ASAP
- await eventually(async () => {
+ return eventually(async () => {
+ const started = performance.now();
await taskManagerPlugin.runSoon(task.getTaskId());
+ return [task, started];
});
-
- return task;
}
- async function mockAndScheduleEndpointTask(): Promise {
+ async function mockAndScheduleEndpointTask(): Promise<[SecurityTelemetryTask, number]> {
const task = getTelemetryTask(tasks, 'security:endpoint-meta-telemetry');
await mockEndpointData(esClient, kibanaServer.coreStart.savedObjects);
// schedule task to run ASAP
- await eventually(async () => {
+ return eventually(async () => {
+ const started = performance.now();
await taskManagerPlugin.runSoon(task.getTaskId());
+ return [task, started];
});
-
- return task;
}
- async function mockAndSchedulePrebuiltRulesTask(): Promise {
+ async function mockAndSchedulePrebuiltRulesTask(): Promise<[SecurityTelemetryTask, number]> {
const task = getTelemetryTask(tasks, 'security:telemetry-prebuilt-rule-alerts');
await mockPrebuiltRulesData(esClient);
// schedule task to run ASAP
- await eventually(async () => {
+ return eventually(async () => {
+ const started = performance.now();
await taskManagerPlugin.runSoon(task.getTaskId());
+ return [task, started];
});
-
- return task;
}
- async function mockAndScheduleEndpointDiagnosticsTask(): Promise {
+ async function mockAndScheduleEndpointDiagnosticsTask(): Promise<
+ [SecurityTelemetryTask, number]
+ > {
const task = getTelemetryTask(tasks, 'security:endpoint-diagnostics');
await createMockedEndpointAlert(kibanaServer.coreStart.elasticsearch.client.asInternalUser);
// schedule task to run ASAP
- await eventually(async () => {
+ return eventually(async () => {
+ const started = performance.now();
await taskManagerPlugin.runSoon(task.getTaskId());
+ return [task, started];
});
-
- return task;
}
function mockAxiosGet(bufferConfig: unknown = fakeBufferAndSizesConfigAsyncDisabled) {
@@ -877,6 +859,7 @@ describe('telemetry tasks', () => {
requestConfig: AxiosRequestConfig | undefined;
}>
> {
+ const taskType = getTelemetryTaskType(task);
return eventually(async () => {
const calls = mockedAxiosPost.mock.calls.flatMap(([url, data, config]) => {
return (data as string).split('\n').map((body) => {
@@ -886,20 +869,24 @@ describe('telemetry tasks', () => {
const requests = calls.filter(({ url, body }) => {
return (
- body.indexOf(getTelemetryTaskType(task)) !== -1 &&
+ body.indexOf(taskType) !== -1 &&
url.startsWith(ENDPOINT_STAGING) &&
url.endsWith('task-metrics')
);
});
expect(requests.length).toBeGreaterThan(0);
- return requests
+ const filtered = requests
.map((r) => {
return {
taskMetric: JSON.parse(r.body) as TaskMetric,
requestConfig: r.config,
};
})
- .filter((t) => t.taskMetric.start_time >= olderThan);
+ .filter((t) => {
+ return t.taskMetric.start_time >= olderThan;
+ });
+ expect(filtered.length).toBeGreaterThan(0);
+ return filtered;
});
}
});
From 44c5f8ca806edfe124023618d2845d5ba98c4d67 Mon Sep 17 00:00:00 2001
From: Drew Tate
Date: Wed, 7 Aug 2024 07:31:18 -0600
Subject: [PATCH 11/44] [ES|QL] open the suggestion menu automatically in more
places (#189585)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
## Summary
Closes https://github.com/elastic/kibana/issues/189662
### Before
https://github.com/user-attachments/assets/9f4e0fc6-1399-4b17-a151-753178e5ec7f
### After
https://github.com/user-attachments/assets/45d59b63-3f18-457e-b4b9-1d98fa0ad8b1
| | Before | After |
|------------------------------|------------------------------------------|-----------------------|
| Source command | ✅ | ✅ |
| Pipe command | ✅ | ✅ |
| Function argument (when the minimum args aren't met) | ❌ | ✅ |
| Pipe `\|` | ❌ | ✅ |
| Assignment `var0 =` | ❌ | ✅ |
| FROM source | ❌ | ✅ |
| FROM source METADATA | ✅ | ✅ |
| FROM source METADATA field | ❌ | ❌ |
| FROM source METADATA field, | ❌ | ❌ |
| EVAL argument | ❌ | ❌ |
| DISSECT field | ❌ | ❌ |
| DISSECT field pattern | ❌ | ❌ |
| DISSECT field pattern APPEND_SEPARATOR | ✅ | ✅ |
| DISSECT field pattern APPEND_SEPARATOR = separator | ❌ | ❌ |
| DROP field | ❌ | ❌ |
| DROP field1, field2 | ❌ | ❌ |
| ENRICH policy | ❌ | ❌ |
| ENRICH policy ON | ✅ | ✅ |
| ENRICH policy ON field | ❌ | ❌ |
| ENRICH policy WITH | ✅ | ✅ |
| ENRICH policy WITH field | ❌ | ❌ |
| GROK field | ❌ | ❌ |
| GROK field pattern | ❌ | ❌ |
| KEEP field | ❌ | ❌ |
| KEEP field1, field2 | ❌ | ❌ |
| LIMIT number | ❌ | ✅ |
| MV_EXPAND field | ❌ | ❌ |
| RENAME field | ❌ | ❌ |
| RENAME field AS | ✅ |✅ |
| RENAME field AS var0 | ❌ | ❌ |
| SORT field | ❌ | ✅ |
| SORT field order | ❌ | ✅ |
| SORT field order nulls-order | ❌ | ✅ |
| STATS argument | ✅ | ✅ |
| STATS argument BY | ✅ | ✅ |
| STATS argument BY expression | ❌ | ✅ |
| WHERE argument | ❌ | ✅ |
| WHERE argument comparison | ✅ | ✅ |
| WHERE argument comparison argument | ❌ | ❌ |
Also made a couple of improvements
- Added support for Invoke completion triggers for subsequent function
arguments (e.g. `date_diff("day", )`)
- When you select a date in the date picker, your cursor is now advanced
past the inserted date and the editor is refocused.
### Checklist
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
---
.../autocomplete.command.from.test.ts | 39 +-
.../autocomplete.command.stats.test.ts | 39 +-
.../src/autocomplete/__tests__/helpers.ts | 1 +
.../src/autocomplete/autocomplete.test.ts | 509 +++++++++++++-----
.../src/autocomplete/autocomplete.ts | 195 ++++---
.../src/autocomplete/complete_items.ts | 13 +-
.../src/autocomplete/factories.ts | 83 ++-
.../src/shared/esql_types.ts | 29 +-
.../src/shared/helpers.ts | 5 +
.../src/text_based_languages_editor.tsx | 10 +
10 files changed, 654 insertions(+), 269 deletions(-)
diff --git a/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.from.test.ts b/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.from.test.ts
index 3752fad6c580f..911f8760f60b7 100644
--- a/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.from.test.ts
+++ b/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.from.test.ts
@@ -14,6 +14,9 @@ const visibleIndices = indexes
.map(({ name, suggestedAs }) => suggestedAs || name)
.sort();
+const addTrailingSpace = (strings: string[], predicate: (s: string) => boolean = (_s) => true) =>
+ strings.map((string) => (predicate(string) ? `${string} ` : string));
+
const metadataFields = [...METADATA_FIELDS].sort();
describe('autocomplete.suggest', () => {
@@ -33,17 +36,17 @@ describe('autocomplete.suggest', () => {
test('suggests visible indices on space', async () => {
const { assertSuggestions } = await setup();
- await assertSuggestions('from /', visibleIndices);
- await assertSuggestions('FROM /', visibleIndices);
- await assertSuggestions('from /index', visibleIndices);
+ await assertSuggestions('from /', addTrailingSpace(visibleIndices));
+ await assertSuggestions('FROM /', addTrailingSpace(visibleIndices));
+ await assertSuggestions('from /index', addTrailingSpace(visibleIndices));
});
test('suggests visible indices on comma', async () => {
const { assertSuggestions } = await setup();
- await assertSuggestions('FROM a,/', visibleIndices);
- await assertSuggestions('FROM a, /', visibleIndices);
- await assertSuggestions('from *,/', visibleIndices);
+ await assertSuggestions('FROM a,/', addTrailingSpace(visibleIndices));
+ await assertSuggestions('FROM a, /', addTrailingSpace(visibleIndices));
+ await assertSuggestions('from *,/', addTrailingSpace(visibleIndices));
});
test('can suggest integration data sources', async () => {
@@ -52,17 +55,21 @@ describe('autocomplete.suggest', () => {
.filter(({ hidden }) => !hidden)
.map(({ name, suggestedAs }) => suggestedAs || name)
.sort();
+ const expectedSuggestions = addTrailingSpace(
+ visibleDataSources,
+ (s) => !integrations.find(({ name }) => name === s)
+ );
const { assertSuggestions, callbacks } = await setup();
const cb = {
...callbacks,
getSources: jest.fn().mockResolvedValue(dataSources),
};
- assertSuggestions('from /', visibleDataSources, { callbacks: cb });
- assertSuggestions('FROM /', visibleDataSources, { callbacks: cb });
- assertSuggestions('FROM a,/', visibleDataSources, { callbacks: cb });
- assertSuggestions('from a, /', visibleDataSources, { callbacks: cb });
- assertSuggestions('from *,/', visibleDataSources, { callbacks: cb });
+ await assertSuggestions('from /', expectedSuggestions, { callbacks: cb });
+ await assertSuggestions('FROM /', expectedSuggestions, { callbacks: cb });
+ await assertSuggestions('FROM a,/', expectedSuggestions, { callbacks: cb });
+ await assertSuggestions('from a, /', expectedSuggestions, { callbacks: cb });
+ await assertSuggestions('from *,/', expectedSuggestions, { callbacks: cb });
});
});
@@ -71,7 +78,7 @@ describe('autocomplete.suggest', () => {
test('on SPACE without comma ",", suggests adding metadata', async () => {
const { assertSuggestions } = await setup();
- const expected = ['METADATA $0', ',', '|'].sort();
+ const expected = ['METADATA $0', ',', '| '].sort();
await assertSuggestions('from a, b /', expected);
});
@@ -86,10 +93,10 @@ describe('autocomplete.suggest', () => {
test('on SPACE after "METADATA" column suggests command and pipe operators', async () => {
const { assertSuggestions } = await setup();
- await assertSuggestions('from a, b [metadata _index /]', [',', '|']);
- await assertSuggestions('from a, b metadata _index /', [',', '|']);
- await assertSuggestions('from a, b metadata _index, _source /', [',', '|']);
- await assertSuggestions(`from a, b metadata ${METADATA_FIELDS.join(', ')} /`, ['|']);
+ await assertSuggestions('from a, b [metadata _index /]', [',', '| ']);
+ await assertSuggestions('from a, b metadata _index /', [',', '| ']);
+ await assertSuggestions('from a, b metadata _index, _source /', [',', '| ']);
+ await assertSuggestions(`from a, b metadata ${METADATA_FIELDS.join(', ')} /`, ['| ']);
});
test('filters out already used metadata fields', async () => {
diff --git a/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.stats.test.ts b/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.stats.test.ts
index 88fd654a83453..a94fb0b8bead9 100644
--- a/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.stats.test.ts
+++ b/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/autocomplete.command.stats.test.ts
@@ -45,7 +45,7 @@ describe('autocomplete.suggest', () => {
describe('... ...', () => {
test('lists possible aggregations on space after command', async () => {
const { assertSuggestions } = await setup();
- const expected = ['var0 =', ...allAggFunctions, ...allEvaFunctions];
+ const expected = ['var0 = ', ...allAggFunctions, ...allEvaFunctions];
await assertSuggestions('from a | stats /', expected);
await assertSuggestions('FROM a | STATS /', expected);
@@ -60,14 +60,14 @@ describe('autocomplete.suggest', () => {
test('on space after aggregate field', async () => {
const { assertSuggestions } = await setup();
- await assertSuggestions('from a | stats a=min(b) /', ['BY $0', ',', '|']);
+ await assertSuggestions('from a | stats a=min(b) /', ['BY $0', ',', '| ']);
});
test('on space after aggregate field with comma', async () => {
const { assertSuggestions } = await setup();
await assertSuggestions('from a | stats a=max(b), /', [
- 'var0 =',
+ 'var0 = ',
...allAggFunctions,
...allEvaFunctions,
]);
@@ -78,7 +78,7 @@ describe('autocomplete.suggest', () => {
await assertSuggestions('from a | stats by bucket(/', [
...getFieldNamesByType([...ESQL_COMMON_NUMERIC_TYPES, 'date']).map(
- (field) => `${field},`
+ (field) => `${field}, `
),
...getFunctionSignaturesByReturnType('eval', ['date', ...ESQL_COMMON_NUMERIC_TYPES], {
scalar: true,
@@ -172,21 +172,21 @@ describe('autocomplete.suggest', () => {
test('when typing right paren', async () => {
const { assertSuggestions } = await setup();
- await assertSuggestions('from a | stats a = min(b)/ | sort b', ['BY $0', ',', '|']);
+ await assertSuggestions('from a | stats a = min(b)/ | sort b', ['BY $0', ',', '| ']);
});
test('increments suggested variable name counter', async () => {
const { assertSuggestions } = await setup();
await assertSuggestions('from a | eval var0=round(b), var1=round(c) | stats /', [
- 'var2 =',
+ 'var2 = ',
...allAggFunctions,
'var0',
'var1',
...allEvaFunctions,
]);
await assertSuggestions('from a | stats var0=min(b),var1=c,/', [
- 'var2 =',
+ 'var2 = ',
...allAggFunctions,
...allEvaFunctions,
]);
@@ -197,8 +197,8 @@ describe('autocomplete.suggest', () => {
test('on space after "BY" keyword', async () => {
const { assertSuggestions } = await setup();
const expected = [
- 'var0 =',
- ...getFieldNamesByType('any'),
+ 'var0 = ',
+ ...getFieldNamesByType('any').map((field) => `${field} `),
...allEvaFunctions,
...allGroupingFunctions,
];
@@ -211,26 +211,27 @@ describe('autocomplete.suggest', () => {
test('on space after grouping field', async () => {
const { assertSuggestions } = await setup();
- await assertSuggestions('from a | stats a=c by d /', [',', '|']);
+ await assertSuggestions('from a | stats a=c by d /', [',', '| ']);
});
test('after comma "," in grouping fields', async () => {
const { assertSuggestions } = await setup();
+ const fields = getFieldNamesByType('any').map((field) => `${field} `);
await assertSuggestions('from a | stats a=c by d, /', [
- 'var0 =',
- ...getFieldNamesByType('any'),
+ 'var0 = ',
+ ...fields,
...allEvaFunctions,
...allGroupingFunctions,
]);
await assertSuggestions('from a | stats a=min(b),/', [
- 'var0 =',
+ 'var0 = ',
...allAggFunctions,
...allEvaFunctions,
]);
await assertSuggestions('from a | stats avg(b) by c, /', [
- 'var0 =',
- ...getFieldNamesByType('any'),
+ 'var0 = ',
+ ...fields,
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
...allGroupingFunctions,
]);
@@ -251,12 +252,12 @@ describe('autocomplete.suggest', () => {
...allGroupingFunctions,
]);
await assertSuggestions('from a | stats avg(b) by var0 = /', [
- ...getFieldNamesByType('any'),
+ ...getFieldNamesByType('any').map((field) => `${field} `),
...allEvaFunctions,
...allGroupingFunctions,
]);
await assertSuggestions('from a | stats avg(b) by c, var0 = /', [
- ...getFieldNamesByType('any'),
+ ...getFieldNamesByType('any').map((field) => `${field} `),
...allEvaFunctions,
...allGroupingFunctions,
]);
@@ -265,11 +266,11 @@ describe('autocomplete.suggest', () => {
test('on space after expression right hand side operand', async () => {
const { assertSuggestions } = await setup();
- await assertSuggestions('from a | stats avg(b) by doubleField % 2 /', [',', '|']);
+ await assertSuggestions('from a | stats avg(b) by doubleField % 2 /', [',', '| ']);
await assertSuggestions(
'from a | stats var0 = AVG(doubleField) BY var1 = BUCKET(dateField, 1 day)/',
- [',', '|', '+ $0', '- $0']
+ [',', '| ', '+ $0', '- $0']
);
});
});
diff --git a/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/helpers.ts b/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/helpers.ts
index 6600ffdbaf1d8..464239d3ae960 100644
--- a/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/helpers.ts
+++ b/packages/kbn-esql-validation-autocomplete/src/autocomplete/__tests__/helpers.ts
@@ -41,6 +41,7 @@ export const triggerCharacters = [',', '(', '=', ' '];
export const fields: Array<{ name: string; type: string; suggestedAs?: string }> = [
...[
'string',
+ 'keyword',
'double',
'date',
'boolean',
diff --git a/packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.test.ts b/packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.test.ts
index d9c958b5bd4f7..a6c2756914ce2 100644
--- a/packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.test.ts
+++ b/packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.test.ts
@@ -10,7 +10,12 @@ import { suggest } from './autocomplete';
import { evalFunctionDefinitions } from '../definitions/functions';
import { timeUnitsToSuggest } from '../definitions/literals';
import { commandDefinitions } from '../definitions/commands';
-import { getSafeInsertText, getUnitDuration, TRIGGER_SUGGESTION_COMMAND } from './factories';
+import {
+ getSafeInsertText,
+ getUnitDuration,
+ TIME_SYSTEM_PARAMS,
+ TRIGGER_SUGGESTION_COMMAND,
+} from './factories';
import { camelCase, partition } from 'lodash';
import { getAstAndSyntaxErrors } from '@kbn/esql-ast';
import { FunctionParameter, FunctionReturnType } from '../definitions/types';
@@ -26,6 +31,7 @@ import {
createCompletionContext,
getPolicyFields,
PartialSuggestionWithText,
+ TIME_PICKER_SUGGESTION,
} from './__tests__/helpers';
import { METADATA_FIELDS } from '../shared/constants';
import {
@@ -143,7 +149,7 @@ describe('autocomplete', () => {
describe('show', () => {
testSuggestions('show ', ['INFO']);
for (const fn of ['info']) {
- testSuggestions(`show ${fn} `, ['|']);
+ testSuggestions(`show ${fn} `, ['| ']);
}
});
@@ -151,9 +157,12 @@ describe('autocomplete', () => {
const allEvalFns = getFunctionSignaturesByReturnType('where', 'any', {
scalar: true,
});
- testSuggestions('from a | where ', [...getFieldNamesByType('any'), ...allEvalFns]);
+ testSuggestions('from a | where ', [
+ ...getFieldNamesByType('any').map((field) => `${field} `),
+ ...allEvalFns,
+ ]);
testSuggestions('from a | eval var0 = 1 | where ', [
- ...getFieldNamesByType('any'),
+ ...getFieldNamesByType('any').map((name) => `${name} `),
'var0',
...allEvalFns,
]);
@@ -172,6 +181,14 @@ describe('autocomplete', () => {
...getFieldNamesByType('any'),
...getFunctionSignaturesByReturnType('where', ['any'], { scalar: true }),
]);
+
+ testSuggestions('from a | where dateField >= ', [
+ TIME_PICKER_SUGGESTION,
+ ...TIME_SYSTEM_PARAMS,
+ ...getFieldNamesByType('date'),
+ ...getFunctionSignaturesByReturnType('where', ['date'], { scalar: true }),
+ ]);
+
// Skip these tests until the insensitive case equality gets restored back
testSuggestions.skip('from a | where stringField =~ ', [
...getFieldNamesByType('string'),
@@ -182,7 +199,7 @@ describe('autocomplete', () => {
...getFunctionSignaturesByReturnType('where', 'any', { scalar: true }),
]);
testSuggestions.skip('from a | where stringField =~ stringField ', [
- '|',
+ '| ',
...getFunctionSignaturesByReturnType(
'where',
'boolean',
@@ -307,7 +324,7 @@ describe('autocomplete', () => {
for (const subExpression of subExpressions) {
testSuggestions(`from a | ${subExpression} grok `, getFieldNamesByType('string'));
testSuggestions(`from a | ${subExpression} grok stringField `, [constantPattern], ' ');
- testSuggestions(`from a | ${subExpression} grok stringField ${constantPattern} `, ['|']);
+ testSuggestions(`from a | ${subExpression} grok stringField ${constantPattern} `, ['| ']);
}
});
@@ -324,7 +341,7 @@ describe('autocomplete', () => {
testSuggestions(`from a | ${subExpression} dissect stringField `, [constantPattern], ' ');
testSuggestions(
`from a | ${subExpression} dissect stringField ${constantPattern} `,
- ['APPEND_SEPARATOR = $0', '|'],
+ ['APPEND_SEPARATOR = $0', '| '],
' '
);
testSuggestions(
@@ -333,30 +350,30 @@ describe('autocomplete', () => {
);
testSuggestions(
`from a | ${subExpression} dissect stringField ${constantPattern} append_separator = ":" `,
- ['|']
+ ['| ']
);
}
});
describe('sort', () => {
testSuggestions('from a | sort ', [
- ...getFieldNamesByType('any'),
+ ...getFieldNamesByType('any').map((name) => `${name} `),
...getFunctionSignaturesByReturnType('sort', 'any', { scalar: true }),
]);
- testSuggestions('from a | sort stringField ', ['ASC', 'DESC', ',', '|']);
- testSuggestions('from a | sort stringField desc ', ['NULLS FIRST', 'NULLS LAST', ',', '|']);
+ testSuggestions('from a | sort stringField ', ['ASC ', 'DESC ', ',', '| ']);
+ testSuggestions('from a | sort stringField desc ', ['NULLS FIRST ', 'NULLS LAST ', ',', '| ']);
// @TODO: improve here
// testSuggestions('from a | sort stringField desc ', ['first', 'last']);
});
describe('limit', () => {
- testSuggestions('from a | limit ', ['10', '100', '1000']);
- testSuggestions('from a | limit 4 ', ['|']);
+ testSuggestions('from a | limit ', ['10 ', '100 ', '1000 ']);
+ testSuggestions('from a | limit 4 ', ['| ']);
});
describe('mv_expand', () => {
testSuggestions('from a | mv_expand ', getFieldNamesByType('any'));
- testSuggestions('from a | mv_expand a ', ['|']);
+ testSuggestions('from a | mv_expand a ', ['| ']);
});
describe('rename', () => {
@@ -413,8 +430,9 @@ describe('autocomplete', () => {
testSuggestions(`from a ${prevCommand}| enrich _${mode.toUpperCase()}:`, policyNames, ':');
testSuggestions(`from a ${prevCommand}| enrich _${camelCase(mode)}:`, policyNames, ':');
}
- testSuggestions(`from a ${prevCommand}| enrich policy `, ['ON $0', 'WITH $0', '|']);
+ testSuggestions(`from a ${prevCommand}| enrich policy `, ['ON $0', 'WITH $0', '| ']);
testSuggestions(`from a ${prevCommand}| enrich policy on `, [
+ 'keywordField',
'stringField',
'doubleField',
'dateField',
@@ -427,28 +445,28 @@ describe('autocomplete', () => {
'`any#Char$Field`',
'kubernetes.something.something',
]);
- testSuggestions(`from a ${prevCommand}| enrich policy on b `, ['WITH $0', ',', '|']);
+ testSuggestions(`from a ${prevCommand}| enrich policy on b `, ['WITH $0', ',', '| ']);
testSuggestions(
`from a ${prevCommand}| enrich policy on b with `,
- ['var0 =', ...getPolicyFields('policy')],
+ ['var0 = ', ...getPolicyFields('policy')],
' '
);
- testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 `, ['= $0', ',', '|']);
+ testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 `, ['= $0', ',', '| ']);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 = `, [
...getPolicyFields('policy'),
]);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 = stringField `, [
',',
- '|',
+ '| ',
]);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 = stringField, `, [
- 'var1 =',
+ 'var1 = ',
...getPolicyFields('policy'),
]);
testSuggestions(`from a ${prevCommand}| enrich policy on b with var0 = stringField, var1 `, [
'= $0',
',',
- '|',
+ '| ',
]);
testSuggestions(
`from a ${prevCommand}| enrich policy on b with var0 = stringField, var1 = `,
@@ -456,16 +474,20 @@ describe('autocomplete', () => {
);
testSuggestions(
`from a ${prevCommand}| enrich policy with `,
- ['var0 =', ...getPolicyFields('policy')],
+ ['var0 = ', ...getPolicyFields('policy')],
' '
);
- testSuggestions(`from a ${prevCommand}| enrich policy with stringField `, ['= $0', ',', '|']);
+ testSuggestions(`from a ${prevCommand}| enrich policy with stringField `, [
+ '= $0',
+ ',',
+ '| ',
+ ]);
}
});
describe('eval', () => {
testSuggestions('from a | eval ', [
- 'var0 =',
+ 'var0 = ',
...getFieldNamesByType('any'),
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
]);
@@ -474,7 +496,7 @@ describe('autocomplete', () => {
'double',
]),
',',
- '|',
+ '| ',
]);
testSuggestions('from index | EVAL stringField not ', ['LIKE $0', 'RLIKE $0', 'IN $0']);
testSuggestions('from index | EVAL stringField NOT ', ['LIKE $0', 'RLIKE $0', 'IN $0']);
@@ -499,7 +521,7 @@ describe('autocomplete', () => {
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
]);
testSuggestions('from a | eval a=doubleField, ', [
- 'var0 =',
+ 'var0 = ',
...getFieldNamesByType('any'),
'a',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
@@ -548,7 +570,7 @@ describe('autocomplete', () => {
);
testSuggestions('from a | eval a=round(doubleField) ', [
',',
- '|',
+ '| ',
...getFunctionSignaturesByReturnType('eval', 'any', { builtin: true, skipAssign: true }, [
'double',
]),
@@ -573,7 +595,7 @@ describe('autocomplete', () => {
' '
);
testSuggestions('from a | eval a=round(doubleField),', [
- 'var0 =',
+ 'var0 = ',
...getFieldNamesByType('any'),
'a',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
@@ -597,7 +619,7 @@ describe('autocomplete', () => {
testSuggestions(
'from a | stats avg(doubleField) by stringField | eval ',
[
- 'var0 =',
+ 'var0 = ',
'`avg(doubleField)`',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
],
@@ -609,7 +631,7 @@ describe('autocomplete', () => {
testSuggestions(
'from a | eval abs(doubleField) + 1 | eval ',
[
- 'var0 =',
+ 'var0 = ',
...getFieldNamesByType('any'),
'`abs(doubleField) + 1`',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
@@ -619,7 +641,7 @@ describe('autocomplete', () => {
testSuggestions(
'from a | stats avg(doubleField) by stringField | eval ',
[
- 'var0 =',
+ 'var0 = ',
'`avg(doubleField)`',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
],
@@ -631,7 +653,7 @@ describe('autocomplete', () => {
testSuggestions(
'from a | stats avg(doubleField), avg(kubernetes.something.something) by stringField | eval ',
[
- 'var0 =',
+ 'var0 = ',
'`avg(doubleField)`',
'`avg(kubernetes.something.something)`',
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
@@ -664,7 +686,7 @@ describe('autocomplete', () => {
);
// test that comma is correctly added to the suggestions if minParams is not reached yet
testSuggestions('from a | eval a=concat( ', [
- ...getFieldNamesByType(['text', 'keyword']).map((v) => `${v},`),
+ ...getFieldNamesByType(['text', 'keyword']).map((v) => `${v}, `),
...getFunctionSignaturesByReturnType(
'eval',
['text', 'keyword'],
@@ -691,7 +713,7 @@ describe('autocomplete', () => {
testSuggestions(
'from a | eval a=cidr_match(ipField, textField, ',
[
- ...getFieldNamesByType('text'),
+ ...getFieldNamesByType('keyword'),
...getFunctionSignaturesByReturnType(
'eval',
['text', 'keyword'],
@@ -704,7 +726,7 @@ describe('autocomplete', () => {
);
// test that comma is correctly added to the suggestions if minParams is not reached yet
testSuggestions('from a | eval a=cidr_match( ', [
- ...getFieldNamesByType('ip').map((v) => `${v},`),
+ ...getFieldNamesByType('ip').map((v) => `${v}, `),
...getFunctionSignaturesByReturnType('eval', 'ip', { scalar: true }, undefined, [
'cidr_match',
]).map((v) => ({ ...v, text: `${v.text},` })),
@@ -749,7 +771,7 @@ describe('autocomplete', () => {
'from a | eval var0 = abs(doubleField) | eval abs(var0)',
[
',',
- '|',
+ '| ',
...getFunctionSignaturesByReturnType('eval', 'any', { builtin: true, skipAssign: true }, [
'double',
]),
@@ -807,13 +829,13 @@ describe('autocomplete', () => {
if (!requiresMoreArgs || s === '' || (typeof s === 'object' && s.text === '')) {
return s;
}
- return typeof s === 'string' ? `${s},` : { ...s, text: `${s.text},` };
+ return typeof s === 'string' ? `${s}, ` : { ...s, text: `${s.text},` };
};
testSuggestions(
`from a | eval ${fn.name}(${Array(i).fill('field').join(', ')}${i ? ',' : ''} )`,
suggestedConstants?.length
- ? suggestedConstants.map((option) => `"${option}"${requiresMoreArgs ? ',' : ''}`)
+ ? suggestedConstants.map((option) => `"${option}"${requiresMoreArgs ? ', ' : ''}`)
: [
...getDateLiteralsByFieldType(getTypesFromParamDefs(acceptsFieldParamDefs)),
...getFieldNamesByType(getTypesFromParamDefs(acceptsFieldParamDefs)),
@@ -833,7 +855,7 @@ describe('autocomplete', () => {
i ? ',' : ''
} )`,
suggestedConstants?.length
- ? suggestedConstants.map((option) => `"${option}"${requiresMoreArgs ? ',' : ''}`)
+ ? suggestedConstants.map((option) => `"${option}"${requiresMoreArgs ? ', ' : ''}`)
: [
...getDateLiteralsByFieldType(getTypesFromParamDefs(acceptsFieldParamDefs)),
...getFieldNamesByType(getTypesFromParamDefs(acceptsFieldParamDefs)),
@@ -865,7 +887,7 @@ describe('autocomplete', () => {
testSuggestions(
`from a | eval ${fn.name}(`,
suggestedConstants?.length
- ? [...suggestedConstants.map((option) => `"${option}"${requiresMoreArgs ? ',' : ''}`)]
+ ? [...suggestedConstants.map((option) => `"${option}"${requiresMoreArgs ? ', ' : ''}`)]
: []
);
}
@@ -881,7 +903,7 @@ describe('autocomplete', () => {
[
...dateSuggestions,
',',
- '|',
+ '| ',
...getFunctionSignaturesByReturnType('eval', 'any', { builtin: true, skipAssign: true }, [
'integer',
]),
@@ -890,12 +912,12 @@ describe('autocomplete', () => {
);
testSuggestions('from a | eval a = 1 year ', [
',',
- '|',
+ '| ',
...getFunctionSignaturesByReturnType('eval', 'any', { builtin: true, skipAssign: true }, [
'time_interval',
]),
]);
- testSuggestions('from a | eval a = 1 day + 2 ', [',', '|']);
+ testSuggestions('from a | eval a = 1 day + 2 ', [',', '| ']);
testSuggestions(
'from a | eval 1 day + 2 ',
[
@@ -908,19 +930,19 @@ describe('autocomplete', () => {
);
testSuggestions(
'from a | eval var0=date_trunc()',
- [...getLiteralsByType('time_literal').map((t) => `${t},`)],
+ getLiteralsByType('time_literal').map((t) => `${t}, `),
'('
);
testSuggestions(
'from a | eval var0=date_trunc(2 )',
- [...dateSuggestions.map((t) => `${t},`), ','],
+ [...dateSuggestions.map((t) => `${t}, `), ','],
' '
);
});
});
describe('values suggestions', () => {
- testSuggestions('FROM "a"', ['a', 'b'], undefined, 7, [
+ testSuggestions('FROM "a"', ['a ', 'b '], undefined, 7, [
,
[
{ name: 'a', hidden: false },
@@ -975,50 +997,6 @@ describe('autocomplete', () => {
});
});
- describe('auto triggers', () => {
- function getSuggestionsFor(statement: string) {
- const callbackMocks = createCustomCallbackMocks(undefined, undefined, undefined);
- const triggerOffset = statement.lastIndexOf(' ') + 1; // drop
- const context = createCompletionContext(statement[triggerOffset]);
- return suggest(
- statement,
- triggerOffset + 1,
- context,
- async (text) => (text ? getAstAndSyntaxErrors(text) : { ast: [], errors: [] }),
- callbackMocks
- );
- }
- it('should trigger further suggestions for functions', async () => {
- const suggestions = await getSuggestionsFor('from a | eval ');
- // test that all functions will retrigger suggestions
- expect(
- suggestions
- .filter(({ kind }) => kind === 'Function')
- .every(({ command }) => command === TRIGGER_SUGGESTION_COMMAND)
- ).toBeTruthy();
- // now test that non-function won't retrigger
- expect(
- suggestions
- .filter(({ kind }) => kind !== 'Function')
- .every(({ command }) => command == null)
- ).toBeTruthy();
- });
- it('should trigger further suggestions for commands', async () => {
- const suggestions = await getSuggestionsFor('from a | ');
- // test that all commands will retrigger suggestions
- expect(
- suggestions.every(({ command }) => command === TRIGGER_SUGGESTION_COMMAND)
- ).toBeTruthy();
- });
- it('should trigger further suggestions after enrich mode', async () => {
- const suggestions = await getSuggestionsFor('from a | enrich _any:');
- // test that all commands will retrigger suggestions
- expect(
- suggestions.every(({ command }) => command === TRIGGER_SUGGESTION_COMMAND)
- ).toBeTruthy();
- });
- });
-
/**
* Monaco asks for suggestions in at least two different scenarios.
* 1. When the user types a non-whitespace character (e.g. 'FROM k') - this is the Invoke trigger kind
@@ -1049,24 +1027,47 @@ describe('autocomplete', () => {
10
);
- // function argument
- testSuggestions(
- 'FROM kibana_sample_data_logs | EVAL TRIM(e)',
- [
- ...getFunctionSignaturesByReturnType(
- 'eval',
- ['text', 'keyword'],
- { scalar: true },
- undefined,
- ['trim']
- ),
- ],
- undefined,
- 42
- );
+ describe('function arguments', () => {
+ // function argument
+ testSuggestions(
+ 'FROM kibana_sample_data_logs | EVAL TRIM(e)',
+ [
+ ...getFieldNamesByType(['text', 'keyword']),
+ ...getFunctionSignaturesByReturnType(
+ 'eval',
+ ['text', 'keyword'],
+ { scalar: true },
+ undefined,
+ ['trim']
+ ),
+ ],
+ undefined,
+ 42
+ );
+
+ // subsequent function argument
+ const expectedDateDiff2ndArgSuggestions = [
+ TIME_PICKER_SUGGESTION,
+ ...TIME_SYSTEM_PARAMS.map((t) => `${t}, `),
+ ...getFieldNamesByType('date').map((name) => `${name}, `),
+ ...getFunctionSignaturesByReturnType('eval', 'date', { scalar: true }).map((s) => ({
+ ...s,
+ text: `${s.text},`,
+ })),
+ ];
+ testSuggestions(
+ 'FROM a | EVAL DATE_DIFF("day", )',
+ expectedDateDiff2ndArgSuggestions,
+ undefined,
+ 31
+ );
+
+ // trigger character case for comparison
+ testSuggestions('FROM a | EVAL DATE_DIFF("day", )', expectedDateDiff2ndArgSuggestions, ' ');
+ });
// FROM source
- testSuggestions('FROM k', ['index1', 'index2'], undefined, 6, [
+ testSuggestions('FROM k', ['index1 ', 'index2 '], undefined, 6, [
,
[
{ name: 'index1', hidden: false },
@@ -1075,7 +1076,7 @@ describe('autocomplete', () => {
]);
// FROM source METADATA
- testSuggestions('FROM index1 M', [',', 'METADATA $0', '|'], undefined, 13);
+ testSuggestions('FROM index1 M', [',', 'METADATA $0', '| '], undefined, 13);
// FROM source METADATA field
testSuggestions('FROM index1 METADATA _', METADATA_FIELDS, undefined, 22);
@@ -1084,7 +1085,7 @@ describe('autocomplete', () => {
testSuggestions(
'FROM index1 | EVAL b',
[
- 'var0 =',
+ 'var0 = ',
...getFieldNamesByType('any'),
...getFunctionSignaturesByReturnType('eval', 'any', { scalar: true }),
],
@@ -1117,7 +1118,7 @@ describe('autocomplete', () => {
);
// ENRICH policy ON
- testSuggestions('FROM index1 | ENRICH policy O', ['ON $0', 'WITH $0', '|'], undefined, 29);
+ testSuggestions('FROM index1 | ENRICH policy O', ['ON $0', 'WITH $0', '| '], undefined, 29);
// ENRICH policy ON field
testSuggestions('FROM index1 | ENRICH policy ON f', getFieldNamesByType('any'), undefined, 32);
@@ -1125,14 +1126,14 @@ describe('autocomplete', () => {
// ENRICH policy WITH policyfield
testSuggestions(
'FROM index1 | ENRICH policy WITH v',
- ['var0 =', ...getPolicyFields('policy')],
+ ['var0 = ', ...getPolicyFields('policy')],
undefined,
34
);
testSuggestions(
'FROM index1 | ENRICH policy WITH \tv',
- ['var0 =', ...getPolicyFields('policy')],
+ ['var0 = ', ...getPolicyFields('policy')],
undefined,
34
);
@@ -1154,7 +1155,7 @@ describe('autocomplete', () => {
// LIMIT argument
// Here we actually test that the invoke trigger kind does not work
// because it isn't very useful to see literal suggestions when typing a number
- testSuggestions('FROM a | LIMIT 1', ['|'], undefined, 16);
+ testSuggestions('FROM a | LIMIT 1', ['| '], undefined, 16);
// MV_EXPAND field
testSuggestions('FROM index1 | MV_EXPAND f', getFieldNamesByType('any'), undefined, 25);
@@ -1173,19 +1174,24 @@ describe('autocomplete', () => {
'FROM index1 | SORT f',
[
...getFunctionSignaturesByReturnType('sort', 'any', { scalar: true }),
- ...getFieldNamesByType('any'),
+ ...getFieldNamesByType('any').map((field) => `${field} `),
],
undefined,
20
);
// SORT field order
- testSuggestions('FROM index1 | SORT stringField a', ['ASC', 'DESC', ',', '|'], undefined, 32);
+ testSuggestions(
+ 'FROM index1 | SORT stringField a',
+ ['ASC ', 'DESC ', ',', '| '],
+ undefined,
+ 32
+ );
// SORT field order nulls
testSuggestions(
'FROM index1 | SORT stringField ASC n',
- ['NULLS FIRST', 'NULLS LAST', ',', '|'],
+ ['NULLS FIRST ', 'NULLS LAST ', ',', '| '],
undefined,
36
);
@@ -1193,21 +1199,24 @@ describe('autocomplete', () => {
// STATS argument
testSuggestions(
'FROM index1 | STATS f',
- ['var0 =', ...getFunctionSignaturesByReturnType('stats', 'any', { scalar: true, agg: true })],
+ [
+ 'var0 = ',
+ ...getFunctionSignaturesByReturnType('stats', 'any', { scalar: true, agg: true }),
+ ],
undefined,
21
);
// STATS argument BY
- testSuggestions('FROM index1 | STATS AVG(booleanField) B', ['BY $0', ',', '|'], undefined, 39);
+ testSuggestions('FROM index1 | STATS AVG(booleanField) B', ['BY $0', ',', '| '], undefined, 39);
// STATS argument BY expression
testSuggestions(
'FROM index1 | STATS field BY f',
[
- 'var0 =',
+ 'var0 = ',
...getFunctionSignaturesByReturnType('stats', 'any', { grouping: true, scalar: true }),
- ...getFieldNamesByType('any'),
+ ...getFieldNamesByType('any').map((field) => `${field} `),
],
undefined,
30
@@ -1217,7 +1226,7 @@ describe('autocomplete', () => {
testSuggestions(
'FROM index1 | WHERE f',
[
- ...getFieldNamesByType('any'),
+ ...getFieldNamesByType('any').map((field) => `${field} `),
...getFunctionSignaturesByReturnType('where', 'any', { scalar: true }),
],
undefined,
@@ -1239,4 +1248,264 @@ describe('autocomplete', () => {
33
);
});
+
+ describe('advancing the cursor and opening the suggestion menu automatically ✨', () => {
+ const attachTriggerCommand = (
+ s: string | PartialSuggestionWithText
+ ): PartialSuggestionWithText =>
+ typeof s === 'string'
+ ? {
+ text: s,
+ command: TRIGGER_SUGGESTION_COMMAND,
+ }
+ : { ...s, command: TRIGGER_SUGGESTION_COMMAND };
+
+ const attachAsSnippet = (s: PartialSuggestionWithText): PartialSuggestionWithText => ({
+ ...s,
+ asSnippet: true,
+ });
+
+ // Source command
+ testSuggestions(
+ 'F',
+ ['FROM $0', 'ROW $0', 'SHOW $0'].map(attachTriggerCommand).map(attachAsSnippet),
+ undefined,
+ 1
+ );
+
+ // Pipe command
+ testSuggestions(
+ 'FROM a | E',
+ commandDefinitions
+ .filter(({ name }) => !sourceCommands.includes(name))
+ .map(({ name }) => attachTriggerCommand(name.toUpperCase() + ' $0'))
+ .map(attachAsSnippet), // TODO consider making this check more fundamental
+ undefined,
+ 10
+ );
+
+ describe('function arguments', () => {
+ // literalSuggestions parameter
+ const dateDiffFirstParamSuggestions =
+ evalFunctionDefinitions.find(({ name }) => name === 'date_diff')?.signatures[0].params?.[0]
+ .literalSuggestions ?? [];
+ testSuggestions(
+ 'FROM a | EVAL DATE_DIFF()',
+ dateDiffFirstParamSuggestions.map((s) => `"${s}", `).map(attachTriggerCommand),
+ undefined,
+ 24
+ );
+
+ // field parameter
+
+ const expectedStringSuggestionsWhenMoreArgsAreNeeded = [
+ ...getFieldNamesByType('keyword')
+ .map((field) => `${field}, `)
+ .map(attachTriggerCommand),
+ ...getFunctionSignaturesByReturnType('eval', 'keyword', { scalar: true }, undefined, [
+ 'replace',
+ ]).map((s) => ({
+ ...s,
+ text: `${s.text},`,
+ })),
+ ];
+
+ testSuggestions(
+ 'FROM a | EVAL REPLACE()',
+ expectedStringSuggestionsWhenMoreArgsAreNeeded,
+ undefined,
+ 22
+ );
+
+ // subsequent parameter
+ testSuggestions(
+ 'FROM a | EVAL REPLACE(stringField, )',
+ expectedStringSuggestionsWhenMoreArgsAreNeeded,
+ undefined,
+ 35
+ );
+
+ // final parameter — should not advance!
+ testSuggestions(
+ 'FROM a | EVAL REPLACE(stringField, stringField, )',
+ [
+ ...getFieldNamesByType('keyword').map((field) => ({ text: field, command: undefined })),
+ ...getFunctionSignaturesByReturnType('eval', 'keyword', { scalar: true }, undefined, [
+ 'replace',
+ ]),
+ ],
+ undefined,
+ 48
+ );
+
+ // Trigger character because this is how it will actually be... the user will press
+ // space-bar... this may change if we fix the tokenization of timespan literals
+ // such that "2 days" is a single monaco token
+ testSuggestions(
+ 'FROM a | EVAL DATE_TRUNC(2 )',
+ [...timeUnitsToSuggest.map((s) => `${s.name}, `).map(attachTriggerCommand), ','],
+ ' '
+ );
+ });
+
+ // PIPE (|)
+ testSuggestions(
+ 'FROM a ',
+ [attachTriggerCommand('| '), ',', attachAsSnippet(attachTriggerCommand('METADATA $0'))],
+ undefined,
+ 7
+ );
+
+ // Assignment
+ testSuggestions(`FROM a | ENRICH policy on b with `, [
+ attachTriggerCommand('var0 = '),
+ ...getPolicyFields('policy'),
+ ]);
+
+ // FROM source
+ //
+ // Using an Invoke trigger kind here because that's what Monaco uses when the show suggestions
+ // action is triggered (e.g. accepting the "FROM" suggestion)
+ testSuggestions(
+ 'FROM ',
+ [
+ { text: 'index1 ', command: TRIGGER_SUGGESTION_COMMAND },
+ { text: 'index2 ', command: TRIGGER_SUGGESTION_COMMAND },
+ ],
+ undefined,
+ 5,
+ [
+ ,
+ [
+ { name: 'index1', hidden: false },
+ { name: 'index2', hidden: false },
+ ],
+ ]
+ );
+
+ // FROM source METADATA
+ testSuggestions(
+ 'FROM index1 M',
+ [',', attachAsSnippet(attachTriggerCommand('METADATA $0')), '| '],
+ undefined,
+ 13
+ );
+
+ // LIMIT number
+ testSuggestions('FROM a | LIMIT ', ['10 ', '100 ', '1000 '].map(attachTriggerCommand));
+
+ // SORT field
+ testSuggestions(
+ 'FROM a | SORT ',
+ [
+ ...getFieldNamesByType('any').map((field) => `${field} `),
+ ...getFunctionSignaturesByReturnType('sort', 'any', { scalar: true }),
+ ].map(attachTriggerCommand),
+ undefined,
+ 14
+ );
+
+ // SORT field order
+ testSuggestions(
+ 'FROM a | SORT field ',
+ [',', ...['ASC ', 'DESC ', '| '].map(attachTriggerCommand)],
+ undefined,
+ 20
+ );
+
+ // SORT field order nulls
+ testSuggestions(
+ 'FROM a | SORT field ASC ',
+ [',', ...['NULLS FIRST ', 'NULLS LAST ', '| '].map(attachTriggerCommand)],
+ undefined,
+ 24
+ );
+
+ // STATS argument
+ testSuggestions(
+ 'FROM a | STATS ',
+ [
+ 'var0 = ',
+ ...getFunctionSignaturesByReturnType('stats', 'any', { scalar: true, agg: true }).map(
+ attachAsSnippet
+ ),
+ ].map(attachTriggerCommand),
+ undefined,
+ 15
+ );
+
+ // STATS argument BY
+ testSuggestions(
+ 'FROM a | STATS AVG(numberField) ',
+ [',', attachAsSnippet(attachTriggerCommand('BY $0')), attachTriggerCommand('| ')],
+ undefined,
+ 32
+ );
+
+ // STATS argument BY field
+ const allByCompatibleFunctions = getFunctionSignaturesByReturnType(
+ 'stats',
+ 'any',
+ {
+ scalar: true,
+ grouping: true,
+ },
+ undefined,
+ undefined,
+ 'by'
+ );
+ testSuggestions(
+ 'FROM a | STATS AVG(numberField) BY ',
+ [
+ attachTriggerCommand('var0 = '),
+ ...getFieldNamesByType('any')
+ .map((field) => `${field} `)
+ .map(attachTriggerCommand),
+ ...allByCompatibleFunctions,
+ ],
+ undefined,
+ 35
+ );
+
+ // STATS argument BY assignment (checking field suggestions)
+ testSuggestions(
+ 'FROM a | STATS AVG(numberField) BY var0 = ',
+ [
+ ...getFieldNamesByType('any')
+ .map((field) => `${field} `)
+ .map(attachTriggerCommand),
+ ...allByCompatibleFunctions,
+ ],
+ undefined,
+ 41
+ );
+
+ // WHERE argument (field suggestions)
+ testSuggestions(
+ 'FROM a | WHERE ',
+ [
+ ...getFieldNamesByType('any')
+ .map((field) => `${field} `)
+ .map(attachTriggerCommand),
+ ...getFunctionSignaturesByReturnType('where', 'any', { scalar: true }).map(attachAsSnippet),
+ ],
+ undefined,
+ 15
+ );
+
+ // WHERE argument comparison
+ testSuggestions(
+ 'FROM a | WHERE stringField ',
+ getFunctionSignaturesByReturnType(
+ 'where',
+ 'boolean',
+ {
+ builtin: true,
+ },
+ ['string']
+ ).map((s) => (s.text.toLowerCase().includes('null') ? s : attachTriggerCommand(s))),
+ undefined,
+ 27
+ );
+ });
});
diff --git a/packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts b/packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts
index d2d617aac4315..67af737d34da0 100644
--- a/packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts
+++ b/packages/kbn-esql-validation-autocomplete/src/autocomplete/autocomplete.ts
@@ -13,10 +13,11 @@ import type {
ESQLCommand,
ESQLCommandOption,
ESQLFunction,
+ ESQLLiteral,
ESQLSingleAstItem,
} from '@kbn/esql-ast';
import { partition } from 'lodash';
-import { ESQL_NUMBER_TYPES, isNumericType } from '../shared/esql_types';
+import { ESQL_NUMBER_TYPES, compareTypesWithLiterals, isNumericType } from '../shared/esql_types';
import type { EditorContext, SuggestionRawDefinition } from './types';
import {
lookupColumn,
@@ -44,6 +45,7 @@ import {
nonNullable,
getColumnExists,
findPreviousWord,
+ noCaseCompare,
} from '../shared/helpers';
import { collectVariables, excludeVariablesFromCurrentCommand } from '../shared/variables';
import type { ESQLPolicy, ESQLRealField, ESQLVariable, ReferenceMaps } from '../validation/types';
@@ -93,7 +95,7 @@ import {
isAggFunctionUsedAlready,
removeQuoteForSuggestedSources,
} from './helper';
-import { FunctionParameter } from '../definitions/types';
+import { FunctionParameter, FunctionReturnType, SupportedFieldType } from '../definitions/types';
type GetSourceFn = () => Promise;
type GetDataStreamsForIntegrationFn = (
@@ -101,7 +103,8 @@ type GetDataStreamsForIntegrationFn = (
) => Promise | undefined>;
type GetFieldsByTypeFn = (
type: string | string[],
- ignored?: string[]
+ ignored?: string[],
+ options?: { advanceCursorAndOpenSuggestions?: boolean; addComma?: boolean }
) => Promise;
type GetFieldsMapFn = () => Promise>;
type GetPoliciesFn = () => Promise;
@@ -185,8 +188,8 @@ function correctQuerySyntax(_query: string, context: EditorContext) {
(context.triggerCharacter && charThatNeedMarkers.includes(context.triggerCharacter)) ||
// monaco.editor.CompletionTriggerKind['Invoke'] === 0
(context.triggerKind === 0 && unclosedRoundBrackets === 0) ||
- (context.triggerCharacter === ' ' &&
- (isMathFunction(query, query.length) || isComma(query.trimEnd()[query.trimEnd().length - 1])))
+ (context.triggerCharacter === ' ' && isMathFunction(query, query.length)) ||
+ isComma(query.trimEnd()[query.trimEnd().length - 1])
) {
query += EDITOR_MARKER;
}
@@ -308,12 +311,19 @@ export async function suggest(
return [];
}
-function getFieldsByTypeRetriever(queryString: string, resourceRetriever?: ESQLCallbacks) {
+function getFieldsByTypeRetriever(
+ queryString: string,
+ resourceRetriever?: ESQLCallbacks
+): { getFieldsByType: GetFieldsByTypeFn; getFieldsMap: GetFieldsMapFn } {
const helpers = getFieldsByTypeHelper(queryString, resourceRetriever);
return {
- getFieldsByType: async (expectedType: string | string[] = 'any', ignored: string[] = []) => {
+ getFieldsByType: async (
+ expectedType: string | string[] = 'any',
+ ignored: string[] = [],
+ options
+ ) => {
const fields = await helpers.getFieldsByType(expectedType, ignored);
- return buildFieldsDefinitionsWithMetadata(fields);
+ return buildFieldsDefinitionsWithMetadata(fields, options);
},
getFieldsMap: helpers.getFieldsMap,
};
@@ -429,7 +439,13 @@ function areCurrentArgsValid(
function extractFinalTypeFromArg(
arg: ESQLAstItem,
references: Pick
-): string | undefined {
+):
+ | ESQLLiteral['literalType']
+ | SupportedFieldType
+ | FunctionReturnType
+ | 'timeInterval'
+ | string // @TODO remove this
+ | undefined {
if (Array.isArray(arg)) {
return extractFinalTypeFromArg(arg[0], references);
}
@@ -792,7 +808,11 @@ async function getExpressionSuggestionsByType(
// if the definition includes a list of constants, suggest them
if (argDef.values) {
// ... | ...
- suggestions.push(...buildConstantsDefinitions(argDef.values));
+ suggestions.push(
+ ...buildConstantsDefinitions(argDef.values, undefined, undefined, {
+ advanceCursorAndOpenSuggestions: true,
+ })
+ );
}
// If the type is specified try to dig deeper in the definition to suggest the best candidate
if (
@@ -815,6 +835,7 @@ async function getExpressionSuggestionsByType(
// ... |
// In this case start suggesting something not strictly based on type
suggestions.push(
+ ...(await getFieldsByType('any', [], { advanceCursorAndOpenSuggestions: true })),
...(await getFieldsOrFunctionsSuggestions(
['any'],
command.name,
@@ -822,7 +843,7 @@ async function getExpressionSuggestionsByType(
getFieldsByType,
{
functions: true,
- fields: true,
+ fields: false,
variables: anyVariables,
}
))
@@ -1087,7 +1108,11 @@ async function getFieldsOrFunctionsSuggestions(
} = {}
): Promise {
const filteredFieldsByType = pushItUpInTheList(
- (await (fields ? getFieldsByType(types, ignoreFields) : [])) as SuggestionRawDefinition[],
+ (await (fields
+ ? getFieldsByType(types, ignoreFields, {
+ advanceCursorAndOpenSuggestions: commandName === 'sort',
+ })
+ : [])) as SuggestionRawDefinition[],
functions
);
@@ -1187,6 +1212,8 @@ async function getFunctionArgsSuggestions(
? refSignature.minParams - 1 > argIndex
: false);
+ const shouldAddComma = hasMoreMandatoryArgs && fnDefinition.type !== 'builtin';
+
const suggestedConstants = Array.from(
new Set(
fnDefinition.signatures.reduce((acc, signature) => {
@@ -1207,13 +1234,13 @@ async function getFunctionArgsSuggestions(
);
if (suggestedConstants.length) {
- return buildValueDefinitions(suggestedConstants).map((suggestion) => ({
- ...suggestion,
- text: addCommaIf(hasMoreMandatoryArgs && fnDefinition.type !== 'builtin', suggestion.text),
- }));
+ return buildValueDefinitions(suggestedConstants, {
+ addComma: hasMoreMandatoryArgs,
+ advanceCursorAndOpenSuggestions: hasMoreMandatoryArgs,
+ });
}
- const suggestions = [];
+ const suggestions: SuggestionRawDefinition[] = [];
const noArgDefined = !arg;
const isUnknownColumn =
arg &&
@@ -1267,7 +1294,9 @@ async function getFunctionArgsSuggestions(
// if existing arguments are preset already, use them to filter out incompatible signatures
.filter((signature) => {
if (existingTypes.length) {
- return existingTypes.every((type, index) => signature.params[index].type === type);
+ return existingTypes.every((type, index) =>
+ compareTypesWithLiterals(signature.params[index].type, type)
+ );
}
return true;
});
@@ -1299,28 +1328,51 @@ async function getFunctionArgsSuggestions(
return Array.from(new Set(paramDefs.map(({ type }) => type)));
};
+ // Literals
suggestions.push(
- ...getCompatibleLiterals(command.name, getTypesFromParamDefs(constantOnlyParamDefs))
+ ...getCompatibleLiterals(
+ command.name,
+ getTypesFromParamDefs(constantOnlyParamDefs),
+ undefined,
+ { addComma: shouldAddComma, advanceCursorAndOpenSuggestions: hasMoreMandatoryArgs }
+ )
);
+ // Fields
suggestions.push(
- ...(await getFieldsOrFunctionsSuggestions(
- getTypesFromParamDefs(paramDefsWhichSupportFields),
+ ...pushItUpInTheList(
+ await getFieldsByType(getTypesFromParamDefs(paramDefsWhichSupportFields), [], {
+ addComma: shouldAddComma,
+ advanceCursorAndOpenSuggestions: hasMoreMandatoryArgs,
+ }),
+ true
+ )
+ );
+
+ // Functions
+ suggestions.push(
+ ...getCompatibleFunctionDefinition(
command.name,
option?.name,
- getFieldsByType,
- {
- functions: true,
- fields: true,
- variables: variablesExcludingCurrentCommandOnes,
- },
- // do not repropose the same function as arg
- // i.e. avoid cases like abs(abs(abs(...))) with suggestions
- {
- ignoreFn: fnToIgnore,
- }
- ))
+ getTypesFromParamDefs(paramDefsWhichSupportFields),
+ fnToIgnore
+ ).map((suggestion) => ({
+ ...suggestion,
+ text: addCommaIf(shouldAddComma, suggestion.text),
+ }))
);
+
+ // could also be in stats (bucket) but our autocomplete is not great yet
+ if (
+ getTypesFromParamDefs(paramDefsWhichSupportFields).includes('date') &&
+ ['where', 'eval'].includes(command.name)
+ )
+ suggestions.push(
+ ...getDateLiterals({
+ addComma: shouldAddComma,
+ advanceCursorAndOpenSuggestions: hasMoreMandatoryArgs,
+ })
+ );
}
// for eval and row commands try also to complete numeric literals with time intervals where possible
@@ -1329,18 +1381,10 @@ async function getFunctionArgsSuggestions(
if (isLiteralItem(arg) && isNumericType(arg.literalType)) {
// ... | EVAL fn(2 )
suggestions.push(
- ...(await getFieldsOrFunctionsSuggestions(
- ['time_literal_unit'],
- command.name,
- option?.name,
- getFieldsByType,
- {
- functions: false,
- fields: false,
- variables: variablesExcludingCurrentCommandOnes,
- literals: true,
- }
- ))
+ ...getCompatibleLiterals(command.name, ['time_literal_unit'], undefined, {
+ addComma: shouldAddComma,
+ advanceCursorAndOpenSuggestions: hasMoreMandatoryArgs,
+ })
);
}
}
@@ -1349,24 +1393,9 @@ async function getFunctionArgsSuggestions(
// suggest a comma if there's another argument for the function
suggestions.push(commaCompleteItem);
}
- // if there are other arguments in the function, inject automatically a comma after each suggestion
- return suggestions.map((suggestion) =>
- suggestion !== commaCompleteItem
- ? {
- ...suggestion,
- text:
- hasMoreMandatoryArgs && fnDefinition.type !== 'builtin'
- ? `${suggestion.text},`
- : suggestion.text,
- }
- : suggestion
- );
}
- return suggestions.map(({ text, ...rest }) => ({
- ...rest,
- text: addCommaIf(hasMoreMandatoryArgs && fnDefinition.type !== 'builtin' && text !== '', text),
- }));
+ return suggestions;
}
async function getListArgsSuggestions(
@@ -1521,7 +1550,7 @@ async function getOptionArgsSuggestions(
innerText
);
- if (isNewExpression || findPreviousWord(innerText) === 'WITH') {
+ if (isNewExpression || noCaseCompare(findPreviousWord(innerText), 'WITH')) {
suggestions.push(buildNewVarDefinition(findNewVariable(anyEnhancedVariables)));
}
@@ -1595,19 +1624,6 @@ async function getOptionArgsSuggestions(
}
if (command.name === 'stats') {
- suggestions.push(
- ...(await getFieldsOrFunctionsSuggestions(
- ['column'],
- command.name,
- option.name,
- getFieldsByType,
- {
- functions: false,
- fields: true,
- }
- ))
- );
-
const argDef = optionDef?.signature.params[argIndex];
const nodeArgType = extractFinalTypeFromArg(nodeArg, references);
@@ -1667,20 +1683,27 @@ async function getOptionArgsSuggestions(
})
);
} else if (isNewExpression || (isAssignment(nodeArg) && !isAssignmentComplete(nodeArg))) {
- // Otherwise try to complete the expression suggesting some columns
suggestions.push(
- ...(await getFieldsOrFunctionsSuggestions(
- types[0] === 'column' ? ['any'] : types,
- command.name,
- option.name,
- getFieldsByType,
- {
- functions: option.name === 'by',
- fields: true,
- }
- ))
+ ...(await getFieldsByType(types[0] === 'column' ? ['any'] : types, [], {
+ advanceCursorAndOpenSuggestions: true,
+ }))
);
+ if (option.name === 'by') {
+ suggestions.push(
+ ...(await getFieldsOrFunctionsSuggestions(
+ types[0] === 'column' ? ['any'] : types,
+ command.name,
+ option.name,
+ getFieldsByType,
+ {
+ functions: true,
+ fields: false,
+ }
+ ))
+ );
+ }
+
if (command.name === 'stats' && isNewExpression) {
suggestions.push(buildNewVarDefinition(findNewVariable(anyVariables)));
}
diff --git a/packages/kbn-esql-validation-autocomplete/src/autocomplete/complete_items.ts b/packages/kbn-esql-validation-autocomplete/src/autocomplete/complete_items.ts
index e0ab600aa1382..88acf1c207f09 100644
--- a/packages/kbn-esql-validation-autocomplete/src/autocomplete/complete_items.ts
+++ b/packages/kbn-esql-validation-autocomplete/src/autocomplete/complete_items.ts
@@ -98,13 +98,16 @@ function buildCharCompleteItem(
sortText,
};
}
-export const pipeCompleteItem = buildCharCompleteItem(
- '|',
- i18n.translate('kbn-esql-validation-autocomplete.esql.autocomplete.pipeDoc', {
+export const pipeCompleteItem: SuggestionRawDefinition = {
+ label: '|',
+ text: '| ',
+ kind: 'Keyword',
+ detail: i18n.translate('kbn-esql-validation-autocomplete.esql.autocomplete.pipeDoc', {
defaultMessage: 'Pipe (|)',
}),
- { sortText: 'C', quoted: false }
-);
+ sortText: 'C',
+ command: TRIGGER_SUGGESTION_COMMAND,
+};
export const commaCompleteItem = buildCharCompleteItem(
',',
diff --git a/packages/kbn-esql-validation-autocomplete/src/autocomplete/factories.ts b/packages/kbn-esql-validation-autocomplete/src/autocomplete/factories.ts
index cb56f40a6d6f4..13a3c76b389f0 100644
--- a/packages/kbn-esql-validation-autocomplete/src/autocomplete/factories.ts
+++ b/packages/kbn-esql-validation-autocomplete/src/autocomplete/factories.ts
@@ -130,7 +130,8 @@ export function getSuggestionCommandDefinition(
}
export const buildFieldsDefinitionsWithMetadata = (
- fields: ESQLRealField[]
+ fields: ESQLRealField[],
+ options?: { advanceCursorAndOpenSuggestions?: boolean; addComma?: boolean }
): SuggestionRawDefinition[] => {
return fields.map((field) => {
const description = field.metadata?.description;
@@ -138,7 +139,10 @@ export const buildFieldsDefinitionsWithMetadata = (
const titleCaseType = field.type.charAt(0).toUpperCase() + field.type.slice(1);
return {
label: field.name,
- text: getSafeInsertText(field.name),
+ text:
+ getSafeInsertText(field.name) +
+ (options?.addComma ? ',' : '') +
+ (options?.advanceCursorAndOpenSuggestions ? ' ' : ''),
kind: 'Variable',
detail: titleCaseType,
documentation: description
@@ -151,6 +155,7 @@ ${description}`,
: undefined,
// If there is a description, it is a field from ECS, so it should be sorted to the top
sortText: description ? '1D' : 'D',
+ command: options?.advanceCursorAndOpenSuggestions ? TRIGGER_SUGGESTION_COMMAND : undefined,
};
});
};
@@ -185,9 +190,8 @@ export const buildSourcesDefinitions = (
): SuggestionRawDefinition[] =>
sources.map(({ name, isIntegration, title }) => ({
label: title ?? name,
- text: getSafeInsertSourceText(name),
+ text: getSafeInsertSourceText(name) + (!isIntegration ? ' ' : ''),
isSnippet: isIntegration,
- ...(isIntegration && { command: TRIGGER_SUGGESTION_COMMAND }),
kind: isIntegration ? 'Class' : 'Issue',
detail: isIntegration
? i18n.translate('kbn-esql-validation-autocomplete.esql.autocomplete.integrationDefinition', {
@@ -197,16 +201,24 @@ export const buildSourcesDefinitions = (
defaultMessage: `Index`,
}),
sortText: 'A',
+ command: TRIGGER_SUGGESTION_COMMAND,
}));
export const buildConstantsDefinitions = (
userConstants: string[],
detail?: string,
- sortText?: string
+ sortText?: string,
+ /**
+ * Whether or not to advance the cursor and open the suggestions dialog after inserting the constant.
+ */
+ options?: { advanceCursorAndOpenSuggestions?: boolean; addComma?: boolean }
): SuggestionRawDefinition[] =>
userConstants.map((label) => ({
label,
- text: label,
+ text:
+ label +
+ (options?.addComma ? ',' : '') +
+ (options?.advanceCursorAndOpenSuggestions ? ' ' : ''),
kind: 'Constant',
detail:
detail ??
@@ -214,32 +226,35 @@ export const buildConstantsDefinitions = (
defaultMessage: `Constant`,
}),
sortText: sortText ?? 'A',
+ command: options?.advanceCursorAndOpenSuggestions ? TRIGGER_SUGGESTION_COMMAND : undefined,
}));
export const buildValueDefinitions = (
values: string[],
- detail?: string
+ options?: { advanceCursorAndOpenSuggestions?: boolean; addComma?: boolean }
): SuggestionRawDefinition[] =>
values.map((value) => ({
label: `"${value}"`,
- text: `"${value}"`,
- detail:
- detail ??
- i18n.translate('kbn-esql-validation-autocomplete.esql.autocomplete.valueDefinition', {
- defaultMessage: 'Literal value',
- }),
+ text: `"${value}"${options?.addComma ? ',' : ''}${
+ options?.advanceCursorAndOpenSuggestions ? ' ' : ''
+ }`,
+ detail: i18n.translate('kbn-esql-validation-autocomplete.esql.autocomplete.valueDefinition', {
+ defaultMessage: 'Literal value',
+ }),
kind: 'Value',
+ command: options?.advanceCursorAndOpenSuggestions ? TRIGGER_SUGGESTION_COMMAND : undefined,
}));
export const buildNewVarDefinition = (label: string): SuggestionRawDefinition => {
return {
label,
- text: `${label} =`,
+ text: `${label} = `,
kind: 'Variable',
detail: i18n.translate('kbn-esql-validation-autocomplete.esql.autocomplete.newVarDoc', {
defaultMessage: 'Define a new variable',
}),
sortText: '1',
+ command: TRIGGER_SUGGESTION_COMMAND,
};
};
@@ -358,21 +373,39 @@ export function getUnitDuration(unit: number = 1) {
* "magical" logic. Maybe this is really the same thing as the literalOptions parameter
* definition property...
*/
-export function getCompatibleLiterals(commandName: string, types: string[], names?: string[]) {
+export function getCompatibleLiterals(
+ commandName: string,
+ types: string[],
+ names?: string[],
+ options?: { advanceCursorAndOpenSuggestions?: boolean; addComma?: boolean }
+) {
const suggestions: SuggestionRawDefinition[] = [];
if (types.some(isNumericType)) {
if (commandName === 'limit') {
// suggest 10/100/1000 for limit
- suggestions.push(...buildConstantsDefinitions(['10', '100', '1000'], ''));
+ suggestions.push(
+ ...buildConstantsDefinitions(['10', '100', '1000'], '', undefined, {
+ advanceCursorAndOpenSuggestions: true,
+ })
+ );
}
}
if (types.includes('time_literal')) {
// filter plural for now and suggest only unit + singular
- suggestions.push(...buildConstantsDefinitions(getUnitDuration(1))); // i.e. 1 year
+ suggestions.push(
+ ...buildConstantsDefinitions(getUnitDuration(1), undefined, undefined, options)
+ ); // i.e. 1 year
}
// this is a special type built from the suggestion system, not inherited from the AST
if (types.includes('time_literal_unit')) {
- suggestions.push(...buildConstantsDefinitions(timeUnitsToSuggest.map(({ name }) => name))); // i.e. year, month, ...
+ suggestions.push(
+ ...buildConstantsDefinitions(
+ timeUnitsToSuggest.map(({ name }) => name),
+ undefined,
+ undefined,
+ options
+ )
+ ); // i.e. year, month, ...
}
if (types.includes('string')) {
if (names) {
@@ -383,25 +416,31 @@ export function getCompatibleLiterals(commandName: string, types: string[], name
[commandName === 'grok' ? '"%{WORD:firstWord}"' : '"%{firstWord}"'],
i18n.translate('kbn-esql-validation-autocomplete.esql.autocomplete.aPatternString', {
defaultMessage: 'A pattern string',
- })
+ }),
+ undefined,
+ options
)
);
} else {
- suggestions.push(...buildConstantsDefinitions(['string'], ''));
+ suggestions.push(...buildConstantsDefinitions(['string'], '', undefined, options));
}
}
}
return suggestions;
}
-export function getDateLiterals() {
+export function getDateLiterals(options?: {
+ advanceCursorAndOpenSuggestions?: boolean;
+ addComma?: boolean;
+}) {
return [
...buildConstantsDefinitions(
TIME_SYSTEM_PARAMS,
i18n.translate('kbn-esql-validation-autocomplete.esql.autocomplete.namedParamDefinition', {
defaultMessage: 'Named parameter',
}),
- '1A'
+ '1A',
+ options
),
{
label: i18n.translate(
diff --git a/packages/kbn-esql-validation-autocomplete/src/shared/esql_types.ts b/packages/kbn-esql-validation-autocomplete/src/shared/esql_types.ts
index dab8769f8477a..fada6bea88134 100644
--- a/packages/kbn-esql-validation-autocomplete/src/shared/esql_types.ts
+++ b/packages/kbn-esql-validation-autocomplete/src/shared/esql_types.ts
@@ -6,7 +6,8 @@
* Side Public License, v 1.
*/
-import { ESQLDecimalLiteral, ESQLNumericLiteralType } from '@kbn/esql-ast/src/types';
+import { ESQLDecimalLiteral, ESQLLiteral, ESQLNumericLiteralType } from '@kbn/esql-ast/src/types';
+import { FunctionParameterType } from '../definitions/types';
export const ESQL_COMMON_NUMERIC_TYPES = ['double', 'long', 'integer'] as const;
export const ESQL_NUMERIC_DECIMAL_TYPES = [
@@ -47,3 +48,29 @@ export function isNumericDecimalType(type: unknown): type is ESQLDecimalLiteral
ESQL_NUMERIC_DECIMAL_TYPES.includes(type as (typeof ESQL_NUMERIC_DECIMAL_TYPES)[number])
);
}
+
+/**
+ * Compares two types, taking into account literal types
+ * @TODO strengthen typing here (remove `string`)
+ */
+export const compareTypesWithLiterals = (
+ a: ESQLLiteral['literalType'] | FunctionParameterType | string,
+ b: ESQLLiteral['literalType'] | FunctionParameterType | string
+) => {
+ if (a === b) {
+ return true;
+ }
+ if (a === 'decimal') {
+ return isNumericDecimalType(b);
+ }
+ if (b === 'decimal') {
+ return isNumericDecimalType(a);
+ }
+ if (a === 'string') {
+ return isStringType(b);
+ }
+ if (b === 'string') {
+ return isStringType(a);
+ }
+ return false;
+};
diff --git a/packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts b/packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts
index e13326c2a9f43..1c9c82f676087 100644
--- a/packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts
+++ b/packages/kbn-esql-validation-autocomplete/src/shared/helpers.ts
@@ -645,3 +645,8 @@ export const isParam = (x: unknown): x is ESQLParamLiteral =>
typeof x === 'object' &&
(x as ESQLParamLiteral).type === 'literal' &&
(x as ESQLParamLiteral).literalType === 'param';
+
+/**
+ * Compares two strings in a case-insensitive manner
+ */
+export const noCaseCompare = (a: string, b: string) => a.toLowerCase() === b.toLowerCase();
diff --git a/packages/kbn-text-based-editor/src/text_based_languages_editor.tsx b/packages/kbn-text-based-editor/src/text_based_languages_editor.tsx
index 8b92bb213157e..e67ffeac3c177 100644
--- a/packages/kbn-text-based-editor/src/text_based_languages_editor.tsx
+++ b/packages/kbn-text-based-editor/src/text_based_languages_editor.tsx
@@ -763,8 +763,18 @@ export const TextBasedLanguagesEditor = memo(function TextBasedLanguagesEditor({
forceMoveMarkers: true,
},
]);
+
setPopoverPosition({});
+
datePickerOpenStatusRef.current = false;
+
+ // move the cursor past the date we just inserted
+ editor1.current?.setPosition({
+ lineNumber: currentCursorPosition?.lineNumber ?? 0,
+ column: (currentCursorPosition?.column ?? 0) + addition.length - 1,
+ });
+ // restore focus to the editor
+ editor1.current?.focus();
}
}}
inline
From f985bd4a1459308f7e72bfb2e2e7c8f09dcb180d Mon Sep 17 00:00:00 2001
From: Jeramy Soucy
Date: Wed, 7 Aug 2024 15:41:59 +0200
Subject: [PATCH 12/44] Unskips security response headers tests for mki
(#190012)
## Summary
Unskips the security response headers tests for MKI, as skipped by
https://github.com/elastic/kibana/pull/188716.
The issue was resolved by https://github.com/elastic/kibana/pull/189139.
---
.../test_suites/common/platform_security/response_headers.ts | 3 ---
1 file changed, 3 deletions(-)
diff --git a/x-pack/test_serverless/api_integration/test_suites/common/platform_security/response_headers.ts b/x-pack/test_serverless/api_integration/test_suites/common/platform_security/response_headers.ts
index 97afa8213aa4f..562e98d33866a 100644
--- a/x-pack/test_serverless/api_integration/test_suites/common/platform_security/response_headers.ts
+++ b/x-pack/test_serverless/api_integration/test_suites/common/platform_security/response_headers.ts
@@ -17,9 +17,6 @@ export default function ({ getService }: FtrProviderContext) {
let roleAuthc: RoleCredentials;
describe('security/response_headers', function () {
- // fails on MKI, see https://github.com/elastic/kibana/issues/188714
- this.tags(['failsOnMKI']);
-
const baseCSP = `script-src 'report-sample' 'self'; worker-src 'report-sample' 'self' blob:; style-src 'report-sample' 'self' 'unsafe-inline'; frame-ancestors 'self'`;
const defaultCOOP = 'same-origin';
const defaultPermissionsPolicy =
From 1c4b5c748977463b70b8fe7716498e99ab6863dc Mon Sep 17 00:00:00 2001
From: Julia Rechkunova
Date: Wed, 7 Aug 2024 15:51:52 +0200
Subject: [PATCH 13/44] [OneDiscover][Extension] DataTable Row Actions
(#188762)
- Closes https://github.com/elastic/kibana/issues/186637
- Closes https://github.com/elastic/kibana/issues/186808
## Summary
- [x] Extend UnifiedDataTable with a new `rowAdditionalLeadingControls`
prop to render additional leading controls
- [x] In case of many actions, collapse the rest of them under "More"
button
- [x] New OneDiscover extension
- [x] Convert from `customControlColumnsConfiguration` to the new prop.
Refactor actions format in Log Explorer.
- [x] Swap the default "select" and "expand" control columns ~if custom
row actions are specified~
- [x] Add to example OneDiscover profile
- [x] Add functional and units tests
### Testing
For testing the example profile:
- add `discover.experimental.enabledProfiles: ['example-root-profile',
'example-data-source-profile', 'example-document-profile']` to
kibana.dev.yml
- start kibana
- make sure to have an index with `my-example-logs` name or create an
alias to an existing index:
```
POST _aliases
{
"actions": [
{
"add": {
"index": "kibana_sample_data_logs",
"alias": "my-example-logs"
}
}
]
}
```
- create a data view for `my-example-logs` index
### Follow up for Security solution
The following items would require deprecation/refactoring in components
on Security Solution pages to have consistent UX (can result in 500+
lines of code changes):
- Convert from `externalControlColumns` to the new prop
`rowAdditionalLeadingControls`
- Convert from `trailingControlColumns` to a normal column.
`trailingControlColumns` is deprecated.
- https://github.com/elastic/kibana/issues/189294
- Use `getRowIndicator` prop on UnifiedDataTable instead of
`border-left` style
- https://github.com/elastic/kibana/issues/189295
### Checklist
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [x] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)
---------
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
---
packages/kbn-unified-data-table/README.md | 5 +-
.../__mocks__/external_control_columns.tsx | 20 ++
packages/kbn-unified-data-table/index.ts | 2 +-
...et_additional_row_control_columns.test.tsx | 51 +++++
.../get_additional_row_control_columns.ts | 25 +++
.../additional_row_control/index.ts | 9 +
.../row_control_column.test.tsx | 53 +++++
.../row_control_column.tsx | 76 ++++++++
.../row_menu_control_column.test.tsx | 65 +++++++
.../row_menu_control_column.tsx | 130 +++++++++++++
.../color_indicator_control_column.tsx | 30 +--
.../custom_control_columns/index.ts | 2 +
.../src/components/data_table.scss | 13 +-
.../src/components/data_table.test.tsx | 31 +--
.../src/components/data_table.tsx | 77 +++++---
.../src/components/data_table_columns.tsx | 19 +-
.../data_table_document_selection.tsx | 27 +--
.../components/data_table_expand_button.tsx | 32 +--
.../src/components/data_table_row_control.tsx | 13 +-
.../kbn-unified-data-table/src/constants.ts | 2 +
.../src/hooks/use_control_column.ts | 41 ++++
packages/kbn-unified-data-table/src/types.ts | 36 ++--
.../layout/discover_documents.test.tsx | 11 +-
.../components/layout/discover_documents.tsx | 4 +-
.../discover_grid/discover_grid.tsx | 16 +-
.../example_data_source_profile/profile.tsx | 26 +++
.../public/context_awareness/types.ts | 13 +-
.../data_table_customisation.ts | 4 +-
.../_get_row_additional_leading_controls.ts | 64 ++++++
.../apps/discover/context_awareness/index.ts | 1 +
.../apps/discover/esql/_esql_view.ts | 2 +-
.../dashboard_embed_mode_scrolling.png | Bin 88013 -> 82090 bytes
test/functional/services/data_grid.ts | 16 ++
.../public/components/common/translations.tsx | 45 +----
.../actions_column_tooltip.tsx | 95 ---------
.../customizations/custom_control_column.tsx | 182 +++++++-----------
.../customizations/logs_explorer_profile.tsx | 4 +-
.../translations/translations/fr-FR.json | 5 -
.../translations/translations/ja-JP.json | 5 -
.../translations/translations/zh-CN.json | 5 -
.../columns_selection.ts | 24 +--
.../custom_control_columns.ts | 10 +-
.../_get_row_additional_leading_controls.ts | 66 +++++++
.../discover/context_awareness/index.ts | 1 +
.../common/discover/esql/_esql_view.ts | 2 +-
.../columns_selection.ts | 24 +--
.../custom_control_columns.ts | 31 ++-
47 files changed, 942 insertions(+), 473 deletions(-)
create mode 100644 packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/get_additional_row_control_columns.test.tsx
create mode 100644 packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/get_additional_row_control_columns.ts
create mode 100644 packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/index.ts
create mode 100644 packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_control_column.test.tsx
create mode 100644 packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_control_column.tsx
create mode 100644 packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_menu_control_column.test.tsx
create mode 100644 packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_menu_control_column.tsx
create mode 100644 packages/kbn-unified-data-table/src/hooks/use_control_column.ts
create mode 100644 test/functional/apps/discover/context_awareness/extensions/_get_row_additional_leading_controls.ts
delete mode 100644 x-pack/plugins/observability_solution/logs_explorer/public/components/virtual_columns/column_tooltips/actions_column_tooltip.tsx
create mode 100644 x-pack/test_serverless/functional/test_suites/common/discover/context_awareness/extensions/_get_row_additional_leading_controls.ts
diff --git a/packages/kbn-unified-data-table/README.md b/packages/kbn-unified-data-table/README.md
index 576a676289d7a..7a2db17781ad1 100644
--- a/packages/kbn-unified-data-table/README.md
+++ b/packages/kbn-unified-data-table/README.md
@@ -41,13 +41,12 @@ Props description:
| **configRowHeight** | (optional)number | Optional value for providing configuration setting for UnifiedDataTable rows height. |
| **showMultiFields** | (optional)boolean | Optional value for providing configuration setting for enabling to display the complex fields in the table. Default is true. |
| **maxDocFieldsDisplayed** | (optional)number | Optional value for providing configuration setting for maximum number of document fields to display in the table. Default is 50. |
-| **externalControlColumns** | (optional)EuiDataGridControlColumn[] | Optional value for providing EuiDataGridControlColumn list of the additional leading control columns. UnifiedDataTable includes two control columns: Open Details and Select. |
+| **rowAdditionalLeadingControls** | (optional)RowControlColumn[] | Optional value for providing an list of the additional leading control columns. UnifiedDataTable includes two control columns: Open Details and Select. |
| **totalHits** | (optional)number | Number total hits from ES. |
| **onFetchMoreRecords** | (optional)() => void | To fetch more. |
| **externalAdditionalControls** | (optional)React.ReactNode | Optional value for providing the additional controls available in the UnifiedDataTable toolbar to manage it's records or state. UnifiedDataTable includes Columns, Sorting and Bulk Actions. |
| **rowsPerPageOptions** | (optional)number[] | Optional list of number type values to set custom UnifiedDataTable paging options to display the records per page. |
| **renderCustomGridBody** | (optional)(args: EuiDataGridCustomBodyProps) => React.ReactNode; | An optional function called to completely customize and control the rendering of EuiDataGrid's body and cell placement. |
-| **trailingControlColumns** | (optional)EuiDataGridControlColumn[] | An optional list of the EuiDataGridControlColumn type for setting trailing control columns standard for EuiDataGrid. |
| **visibleCellActions** | (optional)number | An optional value for a custom number of the visible cell actions in the table. By default is up to 3. |
| **externalCustomRenderers** | (optional)Record React.ReactNode>; | An optional settings for a specified fields rendering like links. Applied only for the listed fields rendering. |
| **consumer** | (optional)string | Name of the UnifiedDataTable consumer component or application. |
@@ -141,9 +140,7 @@ Usage example:
[browserFields, handleOnPanelClosed, runtimeMappings, timelineId]
);
}
- externalControlColumns={leadingControlColumns}
externalAdditionalControls={additionalControls}
- trailingControlColumns={trailingControlColumns}
renderCustomGridBody={renderCustomGridBody}
rowsPerPageOptions={[10, 30, 40, 100]}
showFullScreenButton={false}
diff --git a/packages/kbn-unified-data-table/__mocks__/external_control_columns.tsx b/packages/kbn-unified-data-table/__mocks__/external_control_columns.tsx
index d67afccc01559..dce5e13a3c89d 100644
--- a/packages/kbn-unified-data-table/__mocks__/external_control_columns.tsx
+++ b/packages/kbn-unified-data-table/__mocks__/external_control_columns.tsx
@@ -17,6 +17,7 @@ import {
EuiSpacer,
EuiDataGridControlColumn,
} from '@elastic/eui';
+import type { RowControlColumn } from '../src/types';
const SelectionHeaderCell = () => {
return (
@@ -116,3 +117,22 @@ export const testLeadingControlColumn: EuiDataGridControlColumn = {
rowCellRender: SelectionRowCell,
width: 100,
};
+
+export const mockRowAdditionalLeadingControls = ['visBarVerticalStacked', 'heart', 'inspect'].map(
+ (iconType, index): RowControlColumn => ({
+ id: `exampleControl_${iconType}`,
+ headerAriaLabel: `Example Row Control ${iconType}`,
+ renderControl: (Control, rowProps) => {
+ return (
+ {
+ alert(`Example "${iconType}" control clicked. Row index: ${rowProps.rowIndex}`);
+ }}
+ />
+ );
+ },
+ })
+);
diff --git a/packages/kbn-unified-data-table/index.ts b/packages/kbn-unified-data-table/index.ts
index 0929c33208fa0..7dace83c3774e 100644
--- a/packages/kbn-unified-data-table/index.ts
+++ b/packages/kbn-unified-data-table/index.ts
@@ -25,7 +25,7 @@ export { getRowsPerPageOptions } from './src/utils/rows_per_page';
export { popularizeField } from './src/utils/popularize_field';
export { useColumns } from './src/hooks/use_data_grid_columns';
-export { OPEN_DETAILS, SELECT_ROW } from './src/components/data_table_columns';
+export { OPEN_DETAILS, SELECT_ROW } from './src/components/data_table_columns'; // TODO: deprecate?
export { DataTableRowControl } from './src/components/data_table_row_control';
export type {
diff --git a/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/get_additional_row_control_columns.test.tsx b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/get_additional_row_control_columns.test.tsx
new file mode 100644
index 0000000000000..044b864213d82
--- /dev/null
+++ b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/get_additional_row_control_columns.test.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 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 { getAdditionalRowControlColumns } from './get_additional_row_control_columns';
+import { mockRowAdditionalLeadingControls } from '../../../../__mocks__/external_control_columns';
+
+describe('getAdditionalRowControlColumns', () => {
+ it('should work correctly for 0 controls', () => {
+ const columns = getAdditionalRowControlColumns([]);
+
+ expect(columns).toHaveLength(0);
+ });
+
+ it('should work correctly for 1 control', () => {
+ const columns = getAdditionalRowControlColumns([mockRowAdditionalLeadingControls[0]]);
+
+ expect(columns.map((column) => column.id)).toEqual([
+ `additionalRowControl_${mockRowAdditionalLeadingControls[0].id}`,
+ ]);
+ });
+
+ it('should work correctly for 2 controls', () => {
+ const columns = getAdditionalRowControlColumns([
+ mockRowAdditionalLeadingControls[0],
+ mockRowAdditionalLeadingControls[1],
+ ]);
+
+ expect(columns.map((column) => column.id)).toEqual([
+ `additionalRowControl_${mockRowAdditionalLeadingControls[0].id}`,
+ `additionalRowControl_${mockRowAdditionalLeadingControls[1].id}`,
+ ]);
+ });
+
+ it('should work correctly for 3 and more controls', () => {
+ const columns = getAdditionalRowControlColumns([
+ mockRowAdditionalLeadingControls[0],
+ mockRowAdditionalLeadingControls[1],
+ mockRowAdditionalLeadingControls[2],
+ ]);
+
+ expect(columns.map((column) => column.id)).toEqual([
+ `additionalRowControl_${mockRowAdditionalLeadingControls[0].id}`,
+ `additionalRowControl_menuControl`,
+ ]);
+ });
+});
diff --git a/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/get_additional_row_control_columns.ts b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/get_additional_row_control_columns.ts
new file mode 100644
index 0000000000000..bd297b37bb5df
--- /dev/null
+++ b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/get_additional_row_control_columns.ts
@@ -0,0 +1,25 @@
+/*
+ * 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 { EuiDataGridControlColumn } from '@elastic/eui';
+import type { RowControlColumn } from '../../../types';
+import { getRowControlColumn } from './row_control_column';
+import { getRowMenuControlColumn } from './row_menu_control_column';
+
+export const getAdditionalRowControlColumns = (
+ rowControlColumns: RowControlColumn[]
+): EuiDataGridControlColumn[] => {
+ if (rowControlColumns.length <= 2) {
+ return rowControlColumns.map(getRowControlColumn);
+ }
+
+ return [
+ getRowControlColumn(rowControlColumns[0]),
+ getRowMenuControlColumn(rowControlColumns.slice(1)),
+ ];
+};
diff --git a/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/index.ts b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/index.ts
new file mode 100644
index 0000000000000..d3a79fc3a0d50
--- /dev/null
+++ b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/index.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 { getAdditionalRowControlColumns } from './get_additional_row_control_columns';
diff --git a/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_control_column.test.tsx b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_control_column.test.tsx
new file mode 100644
index 0000000000000..360fa7bc235c4
--- /dev/null
+++ b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_control_column.test.tsx
@@ -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 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 React from 'react';
+import type { EuiDataGridCellValueElementProps } from '@elastic/eui';
+import { render, screen } from '@testing-library/react';
+import { getRowControlColumn } from './row_control_column';
+import { dataTableContextMock } from '../../../../__mocks__/table_context';
+import { UnifiedDataTableContext } from '../../../table_context';
+
+describe('getRowControlColumn', () => {
+ const contextMock = {
+ ...dataTableContextMock,
+ };
+
+ it('should render the component', () => {
+ const mockClick = jest.fn();
+ const props = {
+ id: 'test_row_control',
+ headerAriaLabel: 'row control',
+ renderControl: jest.fn((Control, rowProps) => (
+ ;
+ render(
+
+
+ );
+ const button = screen.getByTestId('unifiedDataTable_rowControl_test_row_control');
+ expect(button).toBeInTheDocument();
+
+ button.click();
+
+ expect(mockClick).toHaveBeenCalledWith({ record: contextMock.rows[1], rowIndex: 1 });
+ });
+});
diff --git a/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_control_column.tsx b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_control_column.tsx
new file mode 100644
index 0000000000000..f8d3ad063fb2d
--- /dev/null
+++ b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_control_column.tsx
@@ -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 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 React, { useMemo } from 'react';
+import {
+ EuiButtonIcon,
+ EuiDataGridCellValueElementProps,
+ EuiDataGridControlColumn,
+ EuiScreenReaderOnly,
+ EuiToolTip,
+} from '@elastic/eui';
+import { DataTableRowControl, Size } from '../../data_table_row_control';
+import type { RowControlColumn, RowControlProps } from '../../../types';
+import { DEFAULT_CONTROL_COLUMN_WIDTH } from '../../../constants';
+import { useControlColumn } from '../../../hooks/use_control_column';
+
+export const RowControlCell = ({
+ renderControl,
+ ...props
+}: EuiDataGridCellValueElementProps & {
+ renderControl: RowControlColumn['renderControl'];
+}) => {
+ const rowProps = useControlColumn(props);
+
+ const Control: React.FC = useMemo(
+ () =>
+ ({ 'data-test-subj': dataTestSubj, color, disabled, label, iconType, onClick }) => {
+ return (
+
+
+ {
+ onClick?.(rowProps);
+ }}
+ />
+
+
+ );
+ },
+ [props.columnId, rowProps]
+ );
+
+ return renderControl(Control, rowProps);
+};
+
+export const getRowControlColumn = (
+ rowControlColumn: RowControlColumn
+): EuiDataGridControlColumn => {
+ const { id, headerAriaLabel, headerCellRender, renderControl } = rowControlColumn;
+
+ return {
+ id: `additionalRowControl_${id}`,
+ width: DEFAULT_CONTROL_COLUMN_WIDTH,
+ headerCellRender:
+ headerCellRender ??
+ (() => (
+
+ {headerAriaLabel}
+
+ )),
+ rowCellRender: (props) => {
+ return ;
+ render(
+
+
+ );
+ const menuButton = screen.getByTestId('unifiedDataTable_test_row_menu_control');
+ expect(menuButton).toBeInTheDocument();
+
+ menuButton.click();
+
+ expect(screen.getByTestId('exampleRowControl-visBarVerticalStacked')).toBeInTheDocument();
+ expect(screen.getByTestId('exampleRowControl-heart')).toBeInTheDocument();
+
+ const button = screen.getByTestId('unifiedDataTable_rowMenu_test_row_menu_control');
+ expect(button).toBeInTheDocument();
+
+ button.click();
+ expect(mockClick).toHaveBeenCalledWith({ record: contextMock.rows[1], rowIndex: 1 });
+ });
+});
diff --git a/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_menu_control_column.tsx b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_menu_control_column.tsx
new file mode 100644
index 0000000000000..917174618fa37
--- /dev/null
+++ b/packages/kbn-unified-data-table/src/components/custom_control_columns/additional_row_control/row_menu_control_column.tsx
@@ -0,0 +1,130 @@
+/*
+ * 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 React, { Fragment, useCallback, useMemo, useState } from 'react';
+import {
+ EuiButtonIcon,
+ EuiContextMenuItem,
+ EuiContextMenuPanel,
+ EuiDataGridCellValueElementProps,
+ EuiDataGridControlColumn,
+ EuiPopover,
+ EuiScreenReaderOnly,
+ EuiToolTip,
+} from '@elastic/eui';
+import { i18n } from '@kbn/i18n';
+import { css } from '@emotion/react';
+import { DataTableRowControl, Size } from '../../data_table_row_control';
+import type { RowControlColumn, RowControlProps } from '../../../types';
+import { DEFAULT_CONTROL_COLUMN_WIDTH } from '../../../constants';
+import { useControlColumn } from '../../../hooks/use_control_column';
+
+/**
+ * Menu button under which all other additional row controls would be placed
+ */
+export const RowMenuControlCell = ({
+ rowControlColumns,
+ ...props
+}: EuiDataGridCellValueElementProps & {
+ rowControlColumns: RowControlColumn[];
+}) => {
+ const rowProps = useControlColumn(props);
+ const [isMoreActionsPopoverOpen, setIsMoreActionsPopoverOpen] = useState(false);
+
+ const buttonLabel = i18n.translate('unifiedDataTable.grid.additionalRowActions', {
+ defaultMessage: 'Additional actions',
+ });
+
+ const getControlComponent: (id: string) => React.FC = useCallback(
+ (id) =>
+ ({ 'data-test-subj': dataTestSubj, color, disabled, label, iconType, onClick }) => {
+ return (
+ {
+ onClick?.(rowProps);
+ setIsMoreActionsPopoverOpen(false);
+ }}
+ >
+ {label}
+
+ );
+ },
+ [rowProps, setIsMoreActionsPopoverOpen]
+ );
+
+ const popoverMenuItems = useMemo(
+ () =>
+ rowControlColumns.map((rowControlColumn) => {
+ const Control = getControlComponent(rowControlColumn.id);
+ return (
+
+ {rowControlColumn.renderControl(Control, rowProps)}
+
+ );
+ }),
+ [rowControlColumns, rowProps, getControlComponent]
+ );
+
+ return (
+
+
+ {
+ setIsMoreActionsPopoverOpen(!isMoreActionsPopoverOpen);
+ }}
+ />
+
+
+ }
+ isOpen={isMoreActionsPopoverOpen}
+ closePopover={() => setIsMoreActionsPopoverOpen(false)}
+ panelPaddingSize="none"
+ anchorPosition="downLeft"
+ >
+
+ );
+};
+
+export const getRowMenuControlColumn = (
+ rowControlColumns: RowControlColumn[]
+): EuiDataGridControlColumn => {
+ return {
+ id: 'additionalRowControl_menuControl',
+ width: DEFAULT_CONTROL_COLUMN_WIDTH,
+ headerCellRender: () => (
+
+
+ {i18n.translate('unifiedDataTable.additionalActionsColumnHeader', {
+ defaultMessage: 'Additional actions column',
+ })}
+
+
+ ),
+ rowCellRender: (props) => {
+ return = ({
- rowIndex,
- setCellProps,
- getRowIndicator,
-}) => {
+const ColorIndicatorCell: React.FC = ({ getRowIndicator, ...props }) => {
+ const { record } = useControlColumn(props);
const { euiTheme } = useEuiTheme();
- const { rows, expanded } = useContext(UnifiedDataTableContext);
- const row = rows[rowIndex];
- const configuration = row ? getRowIndicator(row, euiTheme) : undefined;
+
+ const configuration = record ? getRowIndicator(record, euiTheme) : undefined;
const color = configuration?.color || 'transparent';
const label = configuration?.label;
- useEffect(() => {
- if (row.isAnchor) {
- setCellProps({
- className: 'unifiedDataTable__cell--highlight',
- });
- } else if (expanded && row && expanded.id === row.id) {
- setCellProps({
- className: 'unifiedDataTable__cell--expanded',
- });
- } else {
- setCellProps({ className: '' });
- }
- }, [expanded, row, setCellProps]);
-
return (
{
});
});
- describe('customControlColumnsConfiguration', () => {
- const customControlColumnsConfiguration = jest.fn();
- it('should be able to customise the leading control column', async () => {
+ describe('custom control columns', () => {
+ it('should be able to customise the leading controls', async () => {
const component = await getComponent({
...getProps(),
expandedDoc: {
@@ -467,23 +467,19 @@ describe('UnifiedDataTable', () => {
setExpandedDoc: jest.fn(),
renderDocumentView: jest.fn(),
externalControlColumns: [testLeadingControlColumn],
- customControlColumnsConfiguration: customControlColumnsConfiguration.mockImplementation(
- () => {
- return {
- leadingControlColumns: [testLeadingControlColumn, testTrailingControlColumns[0]],
- trailingControlColumns: [],
- };
- }
- ),
+ rowAdditionalLeadingControls: mockRowAdditionalLeadingControls,
});
expect(findTestSubject(component, 'test-body-control-column-cell').exists()).toBeTruthy();
expect(
- findTestSubject(component, 'test-trailing-column-popover-button').exists()
+ findTestSubject(component, 'exampleRowControl-visBarVerticalStacked').exists()
+ ).toBeTruthy();
+ expect(
+ findTestSubject(component, 'unifiedDataTable_additionalRowControl_menuControl').exists()
).toBeTruthy();
});
- it('should be able to customise the trailing control column', async () => {
+ it('should be able to customise the trailing controls', async () => {
const component = await getComponent({
...getProps(),
expandedDoc: {
@@ -497,14 +493,7 @@ describe('UnifiedDataTable', () => {
setExpandedDoc: jest.fn(),
renderDocumentView: jest.fn(),
externalControlColumns: [testLeadingControlColumn],
- customControlColumnsConfiguration: customControlColumnsConfiguration.mockImplementation(
- () => {
- return {
- leadingControlColumns: [],
- trailingControlColumns: [testLeadingControlColumn, testTrailingControlColumns[0]],
- };
- }
- ),
+ trailingControlColumns: testTrailingControlColumns,
});
expect(findTestSubject(component, 'test-body-control-column-cell').exists()).toBeTruthy();
diff --git a/packages/kbn-unified-data-table/src/components/data_table.tsx b/packages/kbn-unified-data-table/src/components/data_table.tsx
index 1a12151c7c18a..243b86b540865 100644
--- a/packages/kbn-unified-data-table/src/components/data_table.tsx
+++ b/packages/kbn-unified-data-table/src/components/data_table.tsx
@@ -51,18 +51,19 @@ import {
DataTableColumnsMeta,
CustomCellRenderer,
CustomGridColumnsConfiguration,
- CustomControlColumnConfiguration,
+ RowControlColumn,
} from '../types';
import { getDisplayedColumns } from '../utils/columns';
import { convertValueToString } from '../utils/convert_value_to_string';
import { getRowsPerPageOptions } from '../utils/rows_per_page';
import { getRenderCellValueFn } from '../utils/get_render_cell_value';
import {
- getAllControlColumns,
getEuiGridColumns,
getLeadControlColumns,
getVisibleColumns,
canPrependTimeFieldColumn,
+ SELECT_ROW,
+ OPEN_DETAILS,
} from './data_table_columns';
import { UnifiedDataTableContext } from '../table_context';
import { getSchemaDetectors } from './data_table_schema';
@@ -85,8 +86,11 @@ import { useSelectedDocs } from '../hooks/use_selected_docs';
import {
getColorIndicatorControlColumn,
type ColorIndicatorControlColumnParams,
+ getAdditionalRowControlColumns,
} from './custom_control_columns';
+const CONTROL_COLUMN_IDS_DEFAULT = [SELECT_ROW, OPEN_DETAILS];
+
export type SortOrder = [string, string];
export enum DataLoadingState {
@@ -290,9 +294,20 @@ export interface UnifiedDataTableProps {
*/
maxDocFieldsDisplayed?: number;
/**
+ * @deprecated Use only `rowAdditionalLeadingControls` instead
* Optional value for providing EuiDataGridControlColumn list of the additional leading control columns. UnifiedDataTable includes two control columns: Open Details and Select.
*/
externalControlColumns?: EuiDataGridControlColumn[];
+ /**
+ * An optional list of the EuiDataGridControlColumn type for setting trailing control columns standard for EuiDataGrid.
+ * We recommend to rather position all controls in the beginning of rows and use `rowAdditionalLeadingControls` for that
+ * as number of columns can be dynamically changed and we don't want the controls to become hidden due to horizontal scroll.
+ */
+ trailingControlColumns?: EuiDataGridControlColumn[];
+ /**
+ * Optional value to extend the list of default row actions
+ */
+ rowAdditionalLeadingControls?: RowControlColumn[];
/**
* Number total hits from ES
*/
@@ -327,10 +342,6 @@ export interface UnifiedDataTableProps {
* @param gridProps
*/
renderCustomToolbar?: UnifiedDataTableRenderCustomToolbar;
- /**
- * An optional list of the EuiDataGridControlColumn type for setting trailing control columns standard for EuiDataGrid.
- */
- trailingControlColumns?: EuiDataGridControlColumn[];
/**
* An optional value for a custom number of the visible cell actions in the table. By default is up to 3.
**/
@@ -347,10 +358,6 @@ export interface UnifiedDataTableProps {
* An optional settings for customising the column
*/
customGridColumnsConfiguration?: CustomGridColumnsConfiguration;
- /**
- * An optional settings to control which columns to render as trailing and leading control columns
- */
- customControlColumnsConfiguration?: CustomControlColumnConfiguration;
/**
* Name of the UnifiedDataTable consumer component or application
*/
@@ -396,8 +403,6 @@ export interface UnifiedDataTableProps {
export const EuiDataGridMemoized = React.memo(EuiDataGrid);
-const CONTROL_COLUMN_IDS_DEFAULT = ['openDetails', 'select'];
-
export const UnifiedDataTable = ({
ariaLabelledBy,
columns,
@@ -407,6 +412,7 @@ export const UnifiedDataTable = ({
headerRowHeightState,
onUpdateHeaderRowHeight,
controlColumnIds = CONTROL_COLUMN_IDS_DEFAULT,
+ rowAdditionalLeadingControls,
dataView,
loadingState,
onFilter,
@@ -437,7 +443,8 @@ export const UnifiedDataTable = ({
services,
renderCustomGridBody,
renderCustomToolbar,
- trailingControlColumns,
+ externalControlColumns, // TODO: deprecate in favor of rowAdditionalLeadingControls
+ trailingControlColumns, // TODO: deprecate in favor of rowAdditionalLeadingControls
totalHits,
onFetchMoreRecords,
renderDocumentView,
@@ -446,7 +453,6 @@ export const UnifiedDataTable = ({
configRowHeight,
showMultiFields = true,
maxDocFieldsDisplayed = 50,
- externalControlColumns,
externalAdditionalControls,
rowsPerPageOptions,
visibleCellActions,
@@ -458,7 +464,6 @@ export const UnifiedDataTable = ({
rowLineHeightOverride,
cellActionsMetadata,
customGridColumnsConfiguration,
- customControlColumnsConfiguration,
enableComparisonMode,
cellContext,
renderCellPopover,
@@ -847,10 +852,19 @@ export const UnifiedDataTable = ({
const canSetExpandedDoc = Boolean(setExpandedDoc && !!renderDocumentView);
const leadingControlColumns: EuiDataGridControlColumn[] = useMemo(() => {
- const internalControlColumns = getLeadControlColumns(canSetExpandedDoc).filter(({ id }) =>
- controlColumnIds.includes(id)
- );
- const leadingColumns = externalControlColumns
+ const defaultControlColumns = getLeadControlColumns(canSetExpandedDoc);
+ const internalControlColumns = controlColumnIds
+ ? // reorder the default controls as per controlColumnIds
+ controlColumnIds.reduce((acc, id) => {
+ const controlColumn = defaultControlColumns.find((col) => col.id === id);
+ if (controlColumn) {
+ acc.push(controlColumn);
+ }
+ return acc;
+ }, [] as EuiDataGridControlColumn[])
+ : defaultControlColumns;
+
+ const leadingColumns: EuiDataGridControlColumn[] = externalControlColumns
? [...internalControlColumns, ...externalControlColumns]
: internalControlColumns;
@@ -861,17 +875,18 @@ export const UnifiedDataTable = ({
leadingColumns.unshift(colorIndicatorControlColumn);
}
- return leadingColumns;
- }, [canSetExpandedDoc, controlColumnIds, externalControlColumns, getRowIndicator]);
-
- const controlColumnsConfig = customControlColumnsConfiguration?.({
- controlColumns: getAllControlColumns(),
- });
+ if (rowAdditionalLeadingControls?.length) {
+ leadingColumns.push(...getAdditionalRowControlColumns(rowAdditionalLeadingControls));
+ }
- const customLeadingControlColumn =
- controlColumnsConfig?.leadingControlColumns ?? leadingControlColumns;
- const customTrailingControlColumn =
- controlColumnsConfig?.trailingControlColumns ?? trailingControlColumns;
+ return leadingColumns;
+ }, [
+ canSetExpandedDoc,
+ controlColumnIds,
+ externalControlColumns,
+ getRowIndicator,
+ rowAdditionalLeadingControls,
+ ]);
const additionalControls = useMemo(() => {
if (!externalAdditionalControls && !selectedDocIds.length) {
@@ -1082,7 +1097,7 @@ export const UnifiedDataTable = ({
columns={euiGridColumns}
columnVisibility={columnsVisibility}
data-test-subj="docTable"
- leadingControlColumns={customLeadingControlColumn}
+ leadingControlColumns={leadingControlColumns}
onColumnResize={onResize}
pagination={paginationObj}
renderCellValue={renderCellValue}
@@ -1096,7 +1111,7 @@ export const UnifiedDataTable = ({
gridStyle={gridStyleOverride ?? GRID_STYLE}
renderCustomGridBody={renderCustomGridBody}
renderCustomToolbar={renderCustomToolbarFn}
- trailingControlColumns={customTrailingControlColumn}
+ trailingControlColumns={trailingControlColumns}
cellContext={cellContext}
renderCellPopover={renderCustomPopover}
/>
diff --git a/packages/kbn-unified-data-table/src/components/data_table_columns.tsx b/packages/kbn-unified-data-table/src/components/data_table_columns.tsx
index 202a593018792..4528e323c2047 100644
--- a/packages/kbn-unified-data-table/src/components/data_table_columns.tsx
+++ b/packages/kbn-unified-data-table/src/components/data_table_columns.tsx
@@ -17,12 +17,16 @@ import { type DataView, DataViewField } from '@kbn/data-views-plugin/public';
import { ToastsStart, IUiSettingsClient } from '@kbn/core/public';
import { DocViewFilterFn } from '@kbn/unified-doc-viewer/types';
import { ExpandButton } from './data_table_expand_button';
-import { ControlColumns, CustomGridColumnsConfiguration, UnifiedDataTableSettings } from '../types';
+import { CustomGridColumnsConfiguration, UnifiedDataTableSettings } from '../types';
import type { ValueToStringConverter, DataTableColumnsMeta } from '../types';
import { buildCellActions } from './default_cell_actions';
import { getSchemaByKbnType } from './data_table_schema';
import { SelectButton, SelectAllButton } from './data_table_document_selection';
-import { defaultTimeColumnWidth, ROWS_HEIGHT_OPTIONS } from '../constants';
+import {
+ defaultTimeColumnWidth,
+ ROWS_HEIGHT_OPTIONS,
+ DEFAULT_CONTROL_COLUMN_WIDTH,
+} from '../constants';
import { buildCopyColumnNameButton, buildCopyColumnValuesButton } from './build_copy_column_button';
import { buildEditFieldButton } from './build_edit_field_button';
import { DataTableColumnHeader, DataTableTimeColumnHeader } from './data_table_column_header';
@@ -53,7 +57,7 @@ export const SELECT_ROW = 'select';
const openDetails = {
id: OPEN_DETAILS,
- width: 26,
+ width: DEFAULT_CONTROL_COLUMN_WIDTH,
headerCellRender: () => (
@@ -68,18 +72,11 @@ const openDetails = {
const select = {
id: SELECT_ROW,
- width: 24,
+ width: DEFAULT_CONTROL_COLUMN_WIDTH,
rowCellRender: SelectButton,
headerCellRender: SelectAllButton,
};
-export function getAllControlColumns(): ControlColumns {
- return {
- [SELECT_ROW]: select,
- [OPEN_DETAILS]: openDetails,
- };
-}
-
export function getLeadControlColumns(canSetExpandedDoc: boolean) {
if (!canSetExpandedDoc) {
return [select];
diff --git a/packages/kbn-unified-data-table/src/components/data_table_document_selection.tsx b/packages/kbn-unified-data-table/src/components/data_table_document_selection.tsx
index b844a4bb537ca..2a34c4866cb86 100644
--- a/packages/kbn-unified-data-table/src/components/data_table_document_selection.tsx
+++ b/packages/kbn-unified-data-table/src/components/data_table_document_selection.tsx
@@ -5,7 +5,7 @@
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
-import React, { useCallback, useContext, useEffect, useMemo, useState } from 'react';
+import React, { useCallback, useContext, useMemo, useState } from 'react';
import type { FieldFormatsStart } from '@kbn/field-formats-plugin/public';
import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from '@kbn/field-types';
import {
@@ -28,28 +28,19 @@ import { css } from '@emotion/react';
import type { DataTableRecord } from '@kbn/discover-utils/types';
import type { UseSelectedDocsState } from '../hooks/use_selected_docs';
import { UnifiedDataTableContext } from '../table_context';
+import { useControlColumn } from '../hooks/use_control_column';
-export const SelectButton = ({ rowIndex, setCellProps }: EuiDataGridCellValueElementProps) => {
+export const SelectButton = (props: EuiDataGridCellValueElementProps) => {
+ const { record, rowIndex } = useControlColumn(props);
const { euiTheme } = useEuiTheme();
- const { selectedDocsState, expanded, rows, isDarkMode } = useContext(UnifiedDataTableContext);
+ const { selectedDocsState } = useContext(UnifiedDataTableContext);
const { isDocSelected, toggleDocSelection } = selectedDocsState;
- const doc = useMemo(() => rows[rowIndex], [rows, rowIndex]);
const toggleDocumentSelectionLabel = i18n.translate('unifiedDataTable.grid.selectDoc', {
defaultMessage: `Select document ''{rowNumber}''`,
values: { rowNumber: rowIndex + 1 },
});
- useEffect(() => {
- if (expanded && doc && expanded.id === doc.id) {
- setCellProps({
- className: 'unifiedDataTable__cell--selected',
- });
- } else {
- setCellProps({ className: '' });
- }
- }, [expanded, doc, setCellProps, isDarkMode]);
-
return (
{
- toggleDocSelection(doc.id);
+ toggleDocSelection(record.id);
}}
/>
diff --git a/packages/kbn-unified-data-table/src/components/data_table_expand_button.tsx b/packages/kbn-unified-data-table/src/components/data_table_expand_button.tsx
index da3c8a5026ea0..04ae49abec141 100644
--- a/packages/kbn-unified-data-table/src/components/data_table_expand_button.tsx
+++ b/packages/kbn-unified-data-table/src/components/data_table_expand_button.tsx
@@ -10,39 +10,27 @@ import React, { useContext, useEffect, useRef, useState } from 'react';
import { EuiButtonIcon, EuiDataGridCellValueElementProps, EuiToolTip } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { UnifiedDataTableContext } from '../table_context';
-import { DataTableRowControl } from './data_table_row_control';
+import { DataTableRowControl, Size } from './data_table_row_control';
+import { useControlColumn } from '../hooks/use_control_column';
/**
* Button to expand a given row
*/
-export const ExpandButton = ({ rowIndex, setCellProps }: EuiDataGridCellValueElementProps) => {
+export const ExpandButton = (props: EuiDataGridCellValueElementProps) => {
+ const { record, rowIndex } = useControlColumn(props);
+
const toolTipRef = useRef(null);
const [pressed, setPressed] = useState(false);
- const { expanded, setExpanded, rows, isDarkMode, componentsTourSteps } =
- useContext(UnifiedDataTableContext);
- const current = rows[rowIndex];
+ const { expanded, setExpanded, componentsTourSteps } = useContext(UnifiedDataTableContext);
const tourStep = componentsTourSteps ? componentsTourSteps.expandButton : undefined;
- useEffect(() => {
- if (current.isAnchor) {
- setCellProps({
- className: 'unifiedDataTable__cell--highlight',
- });
- } else if (expanded && current && expanded.id === current.id) {
- setCellProps({
- className: 'unifiedDataTable__cell--expanded',
- });
- } else {
- setCellProps({ className: '' });
- }
- }, [expanded, current, setCellProps, isDarkMode]);
- const isCurrentRowExpanded = current === expanded;
+ const isCurrentRowExpanded = record === expanded;
const buttonLabel = i18n.translate('unifiedDataTable.grid.viewDoc', {
defaultMessage: 'Toggle dialog with details',
});
- const testSubj = current.isAnchor
+ const testSubj = record.isAnchor
? 'docTableExpandToggleColumnAnchor'
: 'docTableExpandToggleColumn';
@@ -60,7 +48,7 @@ export const ExpandButton = ({ rowIndex, setCellProps }: EuiDataGridCellValueEle
}
return (
-
+
{
- const nextHit = isCurrentRowExpanded ? undefined : current;
+ const nextHit = isCurrentRowExpanded ? undefined : record;
toolTipRef.current?.hideToolTip();
setPressed(Boolean(nextHit));
setExpanded?.(nextHit);
diff --git a/packages/kbn-unified-data-table/src/components/data_table_row_control.tsx b/packages/kbn-unified-data-table/src/components/data_table_row_control.tsx
index 4ceadea549dce..0ac0bbd4cb2f6 100644
--- a/packages/kbn-unified-data-table/src/components/data_table_row_control.tsx
+++ b/packages/kbn-unified-data-table/src/components/data_table_row_control.tsx
@@ -7,7 +7,16 @@
*/
import React from 'react';
+import classnames from 'classnames';
-export const DataTableRowControl = ({ children }: { children: React.ReactNode }) => {
- return {children};
+export enum Size {
+ normal = 'normal',
+}
+
+export const DataTableRowControl: React.FC<{ size?: Size }> = ({ size, children }) => {
+ const classes = classnames('unifiedDataTable__rowControl', {
+ // normalize the size of the control
+ [`unifiedDataTable__rowControl--size-${size}`]: size,
+ });
+ return {children};
};
diff --git a/packages/kbn-unified-data-table/src/constants.ts b/packages/kbn-unified-data-table/src/constants.ts
index c2d5654c602c2..c7cf1793039a5 100644
--- a/packages/kbn-unified-data-table/src/constants.ts
+++ b/packages/kbn-unified-data-table/src/constants.ts
@@ -7,6 +7,8 @@
*/
import { EuiDataGridStyle } from '@elastic/eui';
+export const DEFAULT_CONTROL_COLUMN_WIDTH = 24;
+
export const DEFAULT_ROWS_PER_PAGE = 100;
export const MAX_LOADED_GRID_ROWS = 10000;
diff --git a/packages/kbn-unified-data-table/src/hooks/use_control_column.ts b/packages/kbn-unified-data-table/src/hooks/use_control_column.ts
new file mode 100644
index 0000000000000..e2bc05f668508
--- /dev/null
+++ b/packages/kbn-unified-data-table/src/hooks/use_control_column.ts
@@ -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 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 { useContext, useEffect, useMemo } from 'react';
+import type { EuiDataGridCellValueElementProps } from '@elastic/eui';
+import type { DataTableRecord } from '@kbn/discover-utils';
+import { UnifiedDataTableContext } from '../table_context';
+
+export const useControlColumn = ({
+ rowIndex,
+ setCellProps,
+}: Pick): {
+ record: DataTableRecord;
+ rowIndex: number;
+} => {
+ const { expanded, rows } = useContext(UnifiedDataTableContext);
+ const record = useMemo(() => rows[rowIndex], [rows, rowIndex]);
+
+ useEffect(() => {
+ if (record.isAnchor) {
+ setCellProps({
+ className: 'unifiedDataTable__cell--highlight',
+ });
+ } else if (expanded && record && expanded.id === record.id) {
+ setCellProps({
+ className: 'unifiedDataTable__cell--expanded',
+ });
+ } else {
+ setCellProps({
+ className: '',
+ });
+ }
+ }, [expanded, record, setCellProps]);
+
+ return useMemo(() => ({ record, rowIndex }), [record, rowIndex]);
+};
diff --git a/packages/kbn-unified-data-table/src/types.ts b/packages/kbn-unified-data-table/src/types.ts
index 5914fa03f8827..b08818e1a861a 100644
--- a/packages/kbn-unified-data-table/src/types.ts
+++ b/packages/kbn-unified-data-table/src/types.ts
@@ -6,8 +6,13 @@
* Side Public License, v 1.
*/
-import type { ReactElement } from 'react';
-import type { EuiDataGridCellValueElementProps, EuiDataGridColumn } from '@elastic/eui';
+import type { ReactElement, FC } from 'react';
+import type {
+ EuiDataGridCellValueElementProps,
+ EuiDataGridColumn,
+ IconType,
+ EuiButtonIconProps,
+} from '@elastic/eui';
import type { DataTableRecord } from '@kbn/discover-utils/src/types';
import type { DataView } from '@kbn/data-views-plugin/common';
import type { FieldFormatsStart } from '@kbn/field-formats-plugin/public';
@@ -70,16 +75,25 @@ export type CustomGridColumnsConfiguration = Record<
(props: CustomGridColumnProps) => EuiDataGridColumn
>;
-export interface ControlColumns {
- select: EuiDataGridControlColumn;
- openDetails: EuiDataGridControlColumn;
+export interface RowControlRowProps {
+ rowIndex: number;
+ record: DataTableRecord;
}
-export interface ControlColumnsProps {
- controlColumns: ControlColumns;
+export interface RowControlProps {
+ 'data-test-subj'?: string;
+ color?: EuiButtonIconProps['color'];
+ disabled?: boolean;
+ label: string;
+ iconType: IconType;
+ onClick: ((props: RowControlRowProps) => void) | undefined;
}
-export type CustomControlColumnConfiguration = (props: ControlColumnsProps) => {
- leadingControlColumns: EuiDataGridControlColumn[];
- trailingControlColumns?: EuiDataGridControlColumn[];
-};
+export type RowControlComponent = FC;
+
+export interface RowControlColumn {
+ id: string;
+ headerAriaLabel: string;
+ headerCellRender?: EuiDataGridControlColumn['headerCellRender'];
+ renderControl: (Control: RowControlComponent, props: RowControlRowProps) => ReactElement;
+}
diff --git a/src/plugins/discover/public/application/main/components/layout/discover_documents.test.tsx b/src/plugins/discover/public/application/main/components/layout/discover_documents.test.tsx
index 85c2dd581eecb..458d3dcb6318c 100644
--- a/src/plugins/discover/public/application/main/components/layout/discover_documents.test.tsx
+++ b/src/plugins/discover/public/application/main/components/layout/discover_documents.test.tsx
@@ -114,15 +114,10 @@ describe('Discover documents layout', () => {
});
test('should render customisations', async () => {
- const customControlColumnsConfiguration = () => ({
- leadingControlColumns: [],
- trailingControlColumns: [],
- });
-
const customization: DiscoverCustomization = {
id: 'data_table',
logsEnabled: true,
- customControlColumnsConfiguration,
+ rowAdditionalLeadingControls: [],
};
customisationService.set(customization);
@@ -130,8 +125,8 @@ describe('Discover documents layout', () => {
const discoverGridComponent = component.find(DiscoverGrid);
expect(discoverGridComponent.exists()).toBeTruthy();
- expect(discoverGridComponent.prop('customControlColumnsConfiguration')).toEqual(
- customControlColumnsConfiguration
+ expect(discoverGridComponent.prop('rowAdditionalLeadingControls')).toBe(
+ customization.rowAdditionalLeadingControls
);
expect(discoverGridComponent.prop('externalCustomRenderers')).toBeDefined();
expect(discoverGridComponent.prop('customGridColumnsConfiguration')).toBeDefined();
diff --git a/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx b/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx
index e6fb6472397f3..e1b5636d010b1 100644
--- a/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx
+++ b/src/plugins/discover/public/application/main/components/layout/discover_documents.tsx
@@ -259,7 +259,7 @@ function DiscoverDocumentsComponent({
[dataView, onAddColumn, onAddFilter, onRemoveColumn, query, savedSearch.id, setExpandedDoc]
);
- const { customControlColumnsConfiguration } = useDiscoverCustomization('data_table') || {};
+ const { rowAdditionalLeadingControls } = useDiscoverCustomization('data_table') || {};
const { customCellRenderer, customGridColumnsConfiguration } =
useContextualGridCustomisations() || {};
const additionalFieldGroups = useAdditionalFieldGroups();
@@ -435,7 +435,7 @@ function DiscoverDocumentsComponent({
componentsTourSteps={TOUR_STEPS}
externalCustomRenderers={cellRenderers}
customGridColumnsConfiguration={customGridColumnsConfiguration}
- customControlColumnsConfiguration={customControlColumnsConfiguration}
+ rowAdditionalLeadingControls={rowAdditionalLeadingControls}
additionalFieldGroups={additionalFieldGroups}
/>
diff --git a/src/plugins/discover/public/components/discover_grid/discover_grid.tsx b/src/plugins/discover/public/components/discover_grid/discover_grid.tsx
index 79ca8afd005e3..986f66e9680c4 100644
--- a/src/plugins/discover/public/components/discover_grid/discover_grid.tsx
+++ b/src/plugins/discover/public/components/discover_grid/discover_grid.tsx
@@ -16,21 +16,33 @@ import { useProfileAccessor } from '../../context_awareness';
/**
* Customized version of the UnifiedDataTable
- * @param props
* @constructor
*/
-export const DiscoverGrid: React.FC = (props) => {
+export const DiscoverGrid: React.FC = ({
+ rowAdditionalLeadingControls: customRowAdditionalLeadingControls,
+ ...props
+}) => {
const getRowIndicatorProvider = useProfileAccessor('getRowIndicatorProvider');
const getRowIndicator = useMemo(() => {
return getRowIndicatorProvider(() => undefined)({ dataView: props.dataView });
}, [getRowIndicatorProvider, props.dataView]);
+ const getRowAdditionalLeadingControlsAccessor = useProfileAccessor(
+ 'getRowAdditionalLeadingControls'
+ );
+ const rowAdditionalLeadingControls = useMemo(() => {
+ return getRowAdditionalLeadingControlsAccessor(() => customRowAdditionalLeadingControls)({
+ dataView: props.dataView,
+ });
+ }, [getRowAdditionalLeadingControlsAccessor, props.dataView, customRowAdditionalLeadingControls]);
+
return (
{
+ alert(`Example "${iconType}" control clicked. Row index: ${rowProps.rowIndex}`);
+ }}
+ />
+ );
+ },
+ })
+ ),
+ ];
+ },
getDefaultAppState: () => () => ({
columns: [
{
diff --git a/src/plugins/discover/public/context_awareness/types.ts b/src/plugins/discover/public/context_awareness/types.ts
index 38c7116a765b1..b6e4d4558162d 100644
--- a/src/plugins/discover/public/context_awareness/types.ts
+++ b/src/plugins/discover/public/context_awareness/types.ts
@@ -38,11 +38,20 @@ export interface DefaultAppStateExtension {
rowHeight?: number;
}
+export interface RowControlsExtensionParams {
+ dataView: DataView;
+}
+
export interface Profile {
- getCellRenderers: () => CustomCellRenderer;
- getDocViewer: (params: DocViewerExtensionParams) => DocViewerExtension;
getDefaultAppState: (params: DefaultAppStateExtensionParams) => DefaultAppStateExtension;
+ // Data grid
+ getCellRenderers: () => CustomCellRenderer;
getRowIndicatorProvider: (
params: RowIndicatorExtensionParams
) => UnifiedDataTableProps['getRowIndicator'] | undefined;
+ getRowAdditionalLeadingControls: (
+ params: RowControlsExtensionParams
+ ) => UnifiedDataTableProps['rowAdditionalLeadingControls'] | undefined;
+ // Doc viewer
+ getDocViewer: (params: DocViewerExtensionParams) => DocViewerExtension;
}
diff --git a/src/plugins/discover/public/customizations/customization_types/data_table_customisation.ts b/src/plugins/discover/public/customizations/customization_types/data_table_customisation.ts
index 3e6e510488fbd..d53485911d12c 100644
--- a/src/plugins/discover/public/customizations/customization_types/data_table_customisation.ts
+++ b/src/plugins/discover/public/customizations/customization_types/data_table_customisation.ts
@@ -6,10 +6,10 @@
* Side Public License, v 1.
*/
-import { CustomControlColumnConfiguration } from '@kbn/unified-data-table';
+import type { UnifiedDataTableProps } from '@kbn/unified-data-table';
export interface DataTableCustomization {
id: 'data_table';
logsEnabled: boolean; // TODO / NOTE: Just temporary until Discover's data type contextual awareness lands.
- customControlColumnsConfiguration?: CustomControlColumnConfiguration;
+ rowAdditionalLeadingControls?: UnifiedDataTableProps['rowAdditionalLeadingControls'];
}
diff --git a/test/functional/apps/discover/context_awareness/extensions/_get_row_additional_leading_controls.ts b/test/functional/apps/discover/context_awareness/extensions/_get_row_additional_leading_controls.ts
new file mode 100644
index 0000000000000..be536fd6cdbe9
--- /dev/null
+++ b/test/functional/apps/discover/context_awareness/extensions/_get_row_additional_leading_controls.ts
@@ -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 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 kbnRison from '@kbn/rison';
+import type { FtrProviderContext } from '../../ftr_provider_context';
+
+export default function ({ getService, getPageObjects }: FtrProviderContext) {
+ const PageObjects = getPageObjects(['common', 'discover']);
+ const testSubjects = getService('testSubjects');
+ const dataViews = getService('dataViews');
+
+ describe('extension getRowAdditionalLeadingControls', () => {
+ describe('ES|QL mode', () => {
+ it('should render logs controls for logs data source', async () => {
+ const state = kbnRison.encode({
+ dataSource: { type: 'esql' },
+ query: { esql: 'from my-example-logs | sort @timestamp desc' },
+ });
+ await PageObjects.common.navigateToApp('discover', {
+ hash: `/?_a=${state}`,
+ });
+ await PageObjects.discover.waitUntilSearchingHasFinished();
+ await testSubjects.existOrFail('exampleLogsControl_visBarVerticalStacked');
+ await testSubjects.existOrFail('unifiedDataTable_additionalRowControl_menuControl');
+ });
+
+ it('should not render logs controls for non-logs data source', async () => {
+ const state = kbnRison.encode({
+ dataSource: { type: 'esql' },
+ query: { esql: 'from my-example-metrics | sort @timestamp desc' },
+ });
+ await PageObjects.common.navigateToApp('discover', {
+ hash: `/?_a=${state}`,
+ });
+ await PageObjects.discover.waitUntilSearchingHasFinished();
+ await testSubjects.missingOrFail('exampleLogsControl_visBarVerticalStacked');
+ await testSubjects.missingOrFail('unifiedDataTable_additionalRowControl_menuControl');
+ });
+ });
+
+ describe('data view mode', () => {
+ it('should render logs controls for logs data source', async () => {
+ await PageObjects.common.navigateToApp('discover');
+ await dataViews.switchTo('my-example-logs');
+ await PageObjects.discover.waitUntilSearchingHasFinished();
+ await testSubjects.existOrFail('exampleLogsControl_visBarVerticalStacked');
+ await testSubjects.existOrFail('unifiedDataTable_additionalRowControl_menuControl');
+ });
+
+ it('should not render logs controls for non-logs data source', async () => {
+ await PageObjects.common.navigateToApp('discover');
+ await dataViews.switchTo('my-example-metrics');
+ await PageObjects.discover.waitUntilSearchingHasFinished();
+ await testSubjects.missingOrFail('exampleLogsControl_visBarVerticalStacked');
+ await testSubjects.missingOrFail('unifiedDataTable_additionalRowControl_menuControl');
+ });
+ });
+ });
+}
diff --git a/test/functional/apps/discover/context_awareness/index.ts b/test/functional/apps/discover/context_awareness/index.ts
index 82f03e7f54bbc..0bba18a339263 100644
--- a/test/functional/apps/discover/context_awareness/index.ts
+++ b/test/functional/apps/discover/context_awareness/index.ts
@@ -36,6 +36,7 @@ export default function ({ getService, getPageObjects, loadTestFile }: FtrProvid
loadTestFile(require.resolve('./_root_profile'));
loadTestFile(require.resolve('./_data_source_profile'));
loadTestFile(require.resolve('./extensions/_get_row_indicator_provider'));
+ loadTestFile(require.resolve('./extensions/_get_row_additional_leading_controls'));
loadTestFile(require.resolve('./extensions/_get_doc_viewer'));
loadTestFile(require.resolve('./extensions/_get_cell_renderers'));
loadTestFile(require.resolve('./extensions/_get_default_app_state'));
diff --git a/test/functional/apps/discover/esql/_esql_view.ts b/test/functional/apps/discover/esql/_esql_view.ts
index a66471b921528..0ab0e30a45eab 100644
--- a/test/functional/apps/discover/esql/_esql_view.ts
+++ b/test/functional/apps/discover/esql/_esql_view.ts
@@ -194,8 +194,8 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
const cell = await dataGrid.getCellElementExcludingControlColumns(0, 1);
expect(await cell.getVisibleText()).to.be(' - ');
expect(await dataGrid.getHeaders()).to.eql([
- 'Control column',
'Select column',
+ 'Control column',
'Numberbytes',
'machine.ram_range',
]);
diff --git a/test/functional/screenshots/baseline/dashboard_embed_mode_scrolling.png b/test/functional/screenshots/baseline/dashboard_embed_mode_scrolling.png
index 3fd3025ebb9a18b2f5b94dd38d4dcdb6f01a4a05..94de1a1c3cc4f74f73a410a4f508cd7f81602b7f 100644
GIT binary patch
literal 82090
zcmb@tbyOTp@HR?}kObG@0fM_bB#XPd1$TERWPt#|gUjOX?j*RoyE`oIu-_zkf8V{|
zx#!$-|G0DJEW_;fOm}rvb=6Z(2g}QfA-%Bq1)W2nY8H6AtbLJ;HO~jy{RS
zD)8r-qoNoHu5_4S4-W1FoP_XaWw(^WC1Y(&Equ6>sxF3dx}_y*aatM#7gtx;o*Ld#
zota~XP8&@5XCg1No0>d5uOFF~y&LN3LOV$XU=U)L;WX~^LBytG)}29Ig3uumI6s#?
z5wEQ$6!(gNK?is*S>J%?0bg=Nbq`9pNBt@G)PYXG!F_5{(vreyV?mBKg`3aosn{~K
z$&ug*L0*3n?$B3#8y)_q%W!bjj53mGrzN;=;8te{ALKvmq4FSeCH(y=J@JD(e0pjK
zqlqLBIQ#`N#oxPT6yj;m%<^bf1$N?IyvF!@j}7DF$lnX#;}aRs>VN+6aXYwHFysEe
zzJ)_K8U~%40+0CbCw{QaLBXAoNWK?vPeQ4Z4~?@dE;%(ku~h#J1I~<0&~)HZQuvXJ
zLkGr|m0fGo_q*as$}^c=S?q{(^<>6Xtw#HspC_28n&$HYcq_w
z2*Xdurp!Bn*0Z6k@SaPTJAgvgGje)%8~;
zU`dLX^woB}SbFk9Xf6G*%5u!|5w(+V>t8})J4&m}$qx?zGSLc@tL?VxmEH;{)9bGMh=w~z$
zw-mXUQ;UgEioNOX!;l|)Q1^||-l+vaSj#T!S-eeanjb!aN;$viQ+=9aSSyhrd9YfHXv
zd(b|!4v0UQkmXP=+2B87UU6^k)J+#92h)IdwLkT*CucMS1s3(Pr!gL$#!@sO
zE~ZngDQX{ef#B<4VPVKZEfA0
z)YA3D0$EkfGZ{f)r1et;`UBWE*_n$v?FkrcqdL**xH|NAM2DmDRneE&8zWtE&3#Fy&a!3i&avaov{wCKpai76w7UvGO~3y%BYsmJZwXve!BK
zeN|r&IY3kbW#cXf0}JPiqTKse0=r`57@i3Q$G*6ss7Z@mc2F~3>UCdu&l$pMh?cCL
zGv^{F2QdlTtn9(6y60hkdtP?t5K2}%tJD@%c5vyPr`W=pJ=Z|kh*C&lMahcZsC7aM
za%jiG9o7E!&V?j=Q&C0#SLRe}CrnM~2P)b=GH{`#1saHtNRWkto1Ydkw3bgr%{80Q
zKcIvLLZmp*G6MO0enU*cZY+{FjLkA`1V&B$jTkCD$Vk_<7Fio-VQQ&ViAnvDkAa;G
zhs0@TjF**6=k)@-t$QR_@d)lf3a`2N3dD+UUDLtonPGkG^9b0%kY<5`EYghYSgZuK
z{`67O^0by^Ogx2sN8P)u3sdf*58xYLUZQt&+PZnj{}kj%lI*&^lKWwuhT^I$J83S3
zzH3`qy6OGmkn-iNL&R8kW2g-nP#{up>8sqK2E28HY%gbgy}B#tS_>~Pi7XH;|Ow6K0$_dO)fr?_E^I12Z)uONfJ+e|0UdVER>Uftr
zH%(sin8oKl5lD1M>BwHAefiLw-zNKYJAPr`7sq?zD_DwRv+2*J(x}?9%(HT(NL_8#
z)$eU=!FHCV3-iz7db}}ETEfK;mQp6B6!iLJ)qdNSsG+d3gGc@G^%!60mLA)>yXVqI
z1l!Y;Vu!SKeE`?ZjiY9r(xoG2X!}D8KoEwlWJ3uoU0;{6L-NFwjDx2FX}58l`sKFT=p%@r8cpG
z#eHs~n07^SID8W3-qrSaJ`#jU2KGpi;JPYEcfLaTs|kMCqv9jySto~LYjd-f&yiMch*)n2#S1LIXQU!1Cm&-V7hy&rvOl
z1EwD7x|{Y%z${Xh9CyO1qjP8D*?P+X9#>&|R+$X0{fy?zmt}4Qc(W4sy)QkzjWrH+
zP~O$NFg!v7$-+xsE$Dg6QZuW><6Grn)wkAFWw3yHr^L4&dVc=eTxaN}K_Fp(_&Sy*
zXB5(b%+@Z;NL>nJ^T)Ci33Ta0LxZY%s@e+Uxe<1KJBLPrjoP*lrhP1sAk
zUDD>+vnU_|vrYZ<)_rNTg`M=?Oig8C%Uqe?+8G>~=}&+hB!pnRgRP=65p)TaC6OWl
zXXo@ieO<#+VLx-IWEsZvk6Fj
z@mD|6yV#=n0QXsfe_=?)LNrsX-;sumhmBYLOzfeBj?E*XDBO9R4DEznTGrt6RJE^d
zQTK*j4+YO#Rc7T3gG5$U`iAoTYCV=K?1&N9bs7?IJL^DJWxw(EN=N_gcRg3OnkYOh
z&y11}-%x3a^lQGH{piR5MCQoeHCRFZqWC>HT@|BE`m7j(AfgfiTUkb#yq9(H=>;SMMYHk8y5Kv
z{fyit`SY4uy>2%rgNo+p&jwP^K#$hdcME3vWd)eyV|8yT+_CxsrlK^qXevS74`N1f
zr)Wub6yoyjTjvv@T3lTQm9r6gj|qNhem%Sk8uG?Dj_09hpwA=<{uW+f3yWO@5)7fE
z(eF1qw%;aIV%a8RYuHuLK*n3KUIMVw0hqLro|062e2n#+nU;2_(J(>=3y|ep=2FeLyM|NB}Rrqx&w?q*X#03MhI2l)P
z0{Q^`VNo{6WI?kn7S-V#l~hwO>E2@0QI8#tBt=ZTDALr4Si5ft;RwFac|Yker8h5
z@{yol<1oFV(LZr(&TXs&&XyAD)Zahk`h^jwM>kPHHHf)+XO8SF}GnUG;WL3
zmIPirN{Et`lJ{UTad=n^Ix8Ic@O*w4Y#?ENg-A-YV@?-D@9}t_NhCllRg&Dm{%=k+
z)nZH+I3^;MV#sVgZc_WUyLZ%zV+f
z{=s!>ZzH#nNwZA>fp!o$-Dz5KIJYJBtB1{xXgVHb^|LlLpW-4Iuh>c@6<=s);DYrjSI8
zbQM(#?x;LhxqBuIG7%JD##4#Ejo3Xo>FV>TDcH@PoLP1Z)SXN%&W{N`q
z%2>fbC7#p7CF>mNr~Mh5As+ReXTEUqR0A0OI3_iC^m_NB
zHzAV9tF^hTZ1p0gW3L@D@Nn2Tu{%F`ZDhr7CBvkwke)ekb2rhXb_5$5=aPa(xw__n
zJG$B_Q=^rw@6muEV(tBQf7F|EZIyu1P;1K-xKu4P^0fx14CjA35Lr(_If9A4c9&8*
zU=u*!iZ#C?YANG8P;*VzsbOCoqbtk(SgkjnF>|Wn2ZOC4VYPn>+6I0*BvIXupx3P>JRi7(?@fs|gElAHX6?CK4TLz6hX@N!mB5
zH~pDfepJ_-?AUbdO?1!1cVHo(#1hMwl{|K}mMZLu0!dnDJ2;ESjTf}+Rk{kVd^bRa
zrCDO_vOm4^Lkq&1E%B0!eSbKrcEBU~4NqN!bUDPE+i0MJikAM?JBv4h=Tf3Pt|Yvj
z$upHcg49wY`O85D5+f4MP?G94By=r
zAJTGcBTDCvI;>cwEI0*!Osf7Q+RFFzNgBY`oD_tj4_MBnI$@?UIC9RUvsX84
zSJki#57UPHkg<0zcW^Eb`5_@8*=JP2_4dqx$R^d?fdwIhh@o~(K|-&!>*Q8kMI*zJ
zQi%Xr>?0~)6R)r^d4LExDR@!^tHJ>s`L$G3!Q5Ta1398cNtwyEWz~0RxK$Goxon`%
z4LoY$dZ{r?BZF5$|0xTVA>tOsUIul)ptQ$Qq0?On4bBTXAjZwa*ZP&Pm-=Mi8cAly
z+FafAbx|7!iv*2%a|_Xc3+@m3i4OZpp;0El!xf(EG!#
zBa-)LntMeN*e?ZkR*)^#zTtTMZTJgPP+R+kj9AMRnFc_9wjg(gA!RRKIB!>vdJq3o
zC?{nZqFN-l-S>PW=?v39TWFVS^~+x@$U0Sn?7wduJ)WE%?k&6I%X8+k*VoA%J
zzb#KFe{H-`6edlS&XuQHFH=$IDlXL@PqadgpGg{fHfoRh#?721m_{lto-DLM5;s+=
zZ*!{B-HNEKYlCFXp5-H7*blXz6xCm~++27P;g}dQRJ>c;dY4l)WBrFYdiAmG2uB{zqheCCv?F@Qx*^qP@GD$SN2f7(Rq_#4X
zF<*MgZqvk
z1hF9-=eW{=-+8c9q=|48jK!_rNV4Hj2ci{5f@!%{(74$%_bnXX*82>g!6QTAh*
zrNQG{A8WXuxNw3j;$Nvay&SKsbZX4sY^Y3+HSUj)G>
zAQ&Gdg-g%6Yl$)Sg`otYK$Qs{T)R*
znK)g3lH-w<*JrHS{MI}3CD#g(cg_tm-{|hu3#6z-;hyL)QXF#3CR%
z4GtT-QIDeCf&QQuFCN42rzt2tmgrXLA1`Wrdwm^m_T#@tzjvp&`TbD3z3)Kkk!I*X
zYpVS?pBA$-J9{G}CPzU@ZfRjLn98~|Fd;OKCJ_z2ms6RVA`7flZT+=oH=Ne?a5zUx
z5wo}4VGWFeElHc!y6DBm>1{-tvA|oI5t@=UyIX9{vkrob*G|*FH|&CMW334Wp-Fr@
zo0~*DP7j-cK?f$o&rP;-lk1B0T0Df}8HQe}lM~QU)!z@V5~2B?;Qb
z-3(nFZ!Kpf7kyC(rwK)^JTfXs|5T)QJ|4S3Q`j%``tmX7WT7nLs~)ITv{+N1EOs8p
zgXyb0;ic^#J-v~c!Y_PWXmCH!<>Z_(SE3{ZBO+ZWDNg9#x58p#OleeHrYal6U=4OF
zI~t)oBjn^c%P2%EjrIy^YWO78-UD}gtT>xnSY{TrD_`FnAweQ)@4+aplgX1q!t%Q|
z8EZBfUr`Mz8;nRZ!h|dmH|NajY*le}cC{Kq#xw9e>v~o9?;f~~rV4X158OO1>fN?H
z0FSPLYmQ~y
z^UxP2Wa8VM$9oinpo6_JYrxKoSQ?gdiTQneplNclHl?NESH&7i{GN@5TPyADaw%NN
zNpbo%Hav!R*YTS)#y?k4>xnLM<8ur
zuc~sUj&O94xRB7})H{fWb4W-?P*{T9#+^Hv(2HWD$=$w*JUJqkdS7$%xr`3VRdAJLaL(hB$z~3kBePJr>DUV4wL#q@WV;$SR_BAqd7c}qqhdI(|CR7y5{r`
z;x4%x+&!;|fX7G0=Yhw%5vT;(@-7fI>?#0FB&Zj?vt@QBU%WZCMl7MyFPFEVuW0MLU
zj8!iAp_KNg5{il+gN9QB5%;AsBGEvWoQHU9>8`(ezF^1HSl;XTWB1e2a9S_botEYJ
zhstTW670_O43rcZiWpBlzLwiqk3o3pFSH{|7KHLMnp9tAD2;h+a1wz;Syi{f{Gj!P
zuWejZoB+_1kV*qp7aK)~`8Xt6Wfd5!^b*YQq{)?-wy2Phkf(qO1}j;Q9;cMk>!Hj&
zsc)9$z%~>^iH*x$ymsFvMg{5?)m9yy_GFC>-0wmC;uAC~UJA$+y3wGeOd)()=i
zJLbt}DQuRnBxD96V`ESE=UVF2A{t*$zzprItfEW9w}T=er!SkeaPstp?)1Zc#>K6)
zUQ=;%htW{-y0_)@dL6E5E-A)^G#t!L6w)L+gRo2OBQc_ClR#)LV
zL9Z{)_uucC952`ZvE~$s%9p8M)3aPb~OV7
zaOn%Rr9iMEEiLJOzP+?A;t0cli-}E+kLcM@E1gFr#3;%sVD`MKJ{FWITga=M;cY`v
zKO0=L6YzPvTT{{+{QDec4M3@)IwW49ehzVSP!=cz$(D&u2qyzWolwvrrBb@eL>yi;vwAANht6T@g-JB>?t@re5uN^
z$UnOMh<7*ynC{Po(${VE4TgVGGTd>UFxo`;=@OHC-pb1gaL`EIv`&Q&JTOBL2aHa5$8
z2eo*(_#Rh>fb(Wa)NA$Pcihj<%zO?qyA5e;bUkP^yzhQ!euypNOh``V;hvvaauT9E
zUd=E(J(UPTKFk$Y8iust5n@d9R{++rZYpYNV3Y1JJqU0+}25*<-A
zTytA%2wD;x3kJxkNjNBPLwT%{KYcj4eGn}=bq|}lePyY}(CqM7S{QQn>#60t@bmZ{
zUia;gw9;+8BJ43-L`V>$&7u#JXSZ;%!x#D9pTSwmFwcV;f4-r~PNoM>#5g`vlkJ~s
z%JZ(Z+YSwY<*KTw=~Nj!3+=k{xp_FNX*xHN!zPrIx7+PJ?Z}hErId=jwY{y|Vf4zA
zCdkPs#m2khUlodMZ6yMIAK8Jl*a<1=IA5OKB4k){9t(Ouxg7420B%KDMdb+_ufge*
z?)kG7d3NTA@!*MgUJb3m1fJIH;={>A+D0CmEJptS;R0xGn{+$Ve$30p!`(k#tmUBO
zgl;C%-g(TY9$9e#(lBK_Ff%XJYN@Ym?B5xaqKKj1#uh<{_}+TG+E+i;fr#WpmbDR1
zAXsPK;b2VO^;%$rm8EKDBvFzi=27rvDwn(cc{i5gM|2K<@BU7O35u{cZ;;wtHd>=H
zS~H)QWLF#WyazeG}%kb8S9cEYaUD$*9}fWIy5A
zRoNgb>ykIDtzR)an-h5g9ScXU1u`O%P7_B`(yW#x^1v!0d!O(4RwJmIHt|~V+E{hlmFOU|%YJgmHz81~&%xM|^=)N9O^p*bHx0;aaCa?&h`*>L2S8EDz`3%C
zW`>3V?8)(ZW|o#=&K*yV4}L#?Dz}{Qc{aM%R&}Abk$k&{@OTRdkW@5D&ICoIHPmy-
zr1Cr?$Sy!4b@tLjU$$Iur_AV~y
zGHkatw}WH&+T3m_7~8%;OG`YjiA|Vr$;1#Z-ETT4CR%iB3Jdom%T`z_D><#TJGM^4
z3Ah`4Ho`Z=uBVEo^Xl^It~)eX^FDx=?_bqBJLf1GzxXClHJ5^Ppl0Y?YxQJ#kwC4Y
zGG$Rn6X9iJC?=tz(lu7$sO$t-%lYktN>LmQEww?}ySE{Wi`ucVn7~Oa*!<{-Q!$Fs
zvu3B;?B#gcPVLBwVbvrQ6w$H&+83FcfuX_e>Eo4>%g&WdM_|NAZ}0fbjP=F$$I9Yy
z3raF9G^_{1a}Q1PT3t9n%f8Kq<<%oqyz;QIiHYFgu!D7)!XSETW{LZiD0BmlyN9Fm
z_|{oVa`LVce6_bFq94&u0CkHXi~5d`Q9t{VA)eR#f$DIHI;O{J!Mz+PaYV(5B3vF!
zOpJc&Jvt0Wc6lQ9hrhZ8Aq0pBYiMbRODSb$ZqU#aO_yqle?&(EvF3)YR9`~<{Yjmj
zRnYW#=UpqIi+ei`FqE&~;IC?ri~>;cX4}*p9C%d2JJwVgQl&_v0M`TRo$GpXJmCbR
zK8v7SJw*sAe*_`CDWO0XfavL}+8A2PW+|An?H?ZSzjRg%hk
z4ez^D;T*;%gG|Eaaxpqv|Lx72zEmqZG!XD%RZNcx;%{tdy?g{>iIV&;SSM>$RavQd
zLHHnX5e@s3^wwv@-}cEzjB~aM`}^VV8o3B;26stju?R58UTEMZCd|GBdgjDK#vow6
zn=asQ$ZjR>ix(DxdgcV(z9!iPmT$Bj1Hi$(4o^9@GJOPs0pn29jeVWJ^{!8$=pXw4
z1D5$LYLQZf{MB#efy-m#lN8IdwjJY?
z^k5ScLHLVxJ1%_ufzHlsQIr`yTAT;%UZcuzNUN2>$LaU0mE)B@-kx*wa|HaAwsU7S
zIE*^btu1{U6U8#TuYRUX2|*~wad~5?pw}peMEow2l9EZMzNWlaXHJ4nH^LqsxnIAg
zK~{Q1-kFkt(J`U{-|cZtNRi*YbN((gWNR~@4*THB8k)WN^Dt$xz8$y_1xcWM^f^dPq}K
zQW=|6mXnq=pW009**V8MeoLR94)w*p#ityx=5||HZatsKV-%(wK_TXMJlLnnY#;Gx
zY;uO)Wy$b8W8Bu%m~#(!B~k>NC!tz9zs1^$RX_WoGj^LOWSZ=`Ecf;-bdp_}tW^vJ
zf1H@)XKGAYQC5KQFan9ltE9?k0~gt}-A#>f3L^|J0YS#L(ez<6Q!=ua!D7BccI2RY
zJiMr=C>3qRq_o76^bd^H#>_=;bSmT+uUU6WH8hfvlW`YZYj3&TRf{K*ihm%wd}gD>
z;e9T6{KUz@g6bGb3WNzMDa~&TgWgGM>l~ti`U>_4kWF`v$^0GQV>C2XN!Xf`G~q#1
zyp){m^c$ADuEi+>8wN|0&fMH{-iQy)j!*?lDMx%u$Kp1^pbqZYg+MXkIoI0YA0bLg
zN@LScFfkp8(;gUuvc}%L=312#hZ6%E`;@1XBmdJ#m(7y4lhgdg!5?Jw=EbAt2&<^B
zrbTfU$D5#J&&TAr=f-xFLs%_CCqunJ<+QT0@*1k!p(~fj;xn4=Gd@0kd0Zug(AU=|
zArW=RyYN=BxTM63=uLxAldWypwGVM1GU3gd;po>#-U<+l#{T?N6>JVCi2!7FAKr5M
zCRiv4(aE7YK5xuq1j~V#9h9G}g+mNYhCCMx3J4fUXt0}$z9kcV*s#;X1=Opw^OBQ3-JD`5q>$trWU{{Rk=11xok2UdXJR#Zc#lz7n(J|X
z7qGsL?(AFxDJq~UdY}9rC{ka2lM&INW)y7GJ(JGrbGCQBI=^4t-qzGrJ)XW4i~o^Y
zGSnSrxj(I}q7WV-r`_xnW;${_JdB(rhJ1PDJ}w{WXetMtSYYL%+T7?_Wi@3?<*IF4
z&UeV53?JA4&`Q21n8YXyg=@Xe`*m0_4?Rg+yR6&|A=22KF$d2jWs!w-+d=se0J_K~
zFg;3%=NE;Zd@h6tz<2dfS}j$!N(}Y)^%YuvmsG+xurgvYU(atOe|r`-NKH>hW^Hbc
zeZ@Z?XsxTF^Uc|Tv=e7%MDYRojws?9HUlf|`oeS#BzgHCY**&Gmot=nK9BXt>G|lY
z4O$?*;&A&yO!>Mgp&p#STc0E&eys+{|tl>)We=ftAdJ5Od^2pFe?6W
zy|D&%8y6oNi@lVaCst=;!{9ISAh$+MOKme(O~b&!OhUcYf7xV`D+-`fVhG&a^F;ji
zX>gqFygqh6ySS}ueX6WvN#)TX10y0{audk9Yc#}8
zMXYU+=n2JITf6fuYw5K)nuhC7wRf~}Vyb9*1U4qkkCMCyM8>s)E_b{Zh&Ui0v0Z6}
z@R<{EU~q+YF)%Q6_ah-*w2F0qY1u-^*xlti49JLj7Ss_O7S%Zi2a^YeEhQj+ZK0T+%JM+eSF
zch>Nsb5*9UEE;b~j0_B%M(#5*{hzy_Wmi_x@Y4%PDQzfyDX)p$>P8Zb-uGw4K|%`n
zVY}tf(AQV6y`38fe}_RCu2JW+5E^g0Pced&%Ej-^&yyOJl441u;*3l+NoZc
z0nn>ZPOXT_%JD!X%d10f)H`}@vw(A)vT$7fOe|vI@Qyb&`P0*iBSValS^b4nw7}Uf
zu0%sa^W9)D<@oRm4iOp_HrmwOFdlwtQC3M}V(P$`hx&oK`t0iLYH2Yo44^bBQ&3Rw
zyI)FDvI_wcCnXvEm
zXZ}FcK&1>FDlINz6#=>J+&lrlN2MGwW3h0WC_anZukh6SR-ebXm>AEy
z!!9Izm&xhr^;0(;oue7sm95Q9QIReJUi;h(8QYZx=t&d?0D1xX@Kqsd*M{`
zP0&|HLPAPvWVY73>`VFaiT=0e-vn0b-8orl@0UDbc_X@SKzKY(qoqr)Ny)NUt17RL
z1ltWN?yt-r!nYa=i!6}|d9Mc&tIS+nQh)qFoO!AtXAodM^Ss!vNhTmX3J5Pa9BZ+3
zaXH=)8@a!FwExxQ;;f*mI^S%p1_CKcO3q&q`a-yzkx8MRTlmb(
z6(CL>6%~HhCq*E70Rn`McG65kg9`JAmv}t({gNR-9MI$fjR*;mkdRnt+3`!qD6+)C
z!NS@irfqGop32IzMks?;#m8JDlWjY9
zK1*6hJelM1DP9eYhK7b)wbB*eo10j!uvwQ%IvR#Ih)??$wlv1Z<`i-3<7u7_4770e5PfgWYvFV4>2DNV3;TCGfEEfmf8tdJSLeHRL8IibJ1#!CwcK@aLc
zy2Vpa)Wjx2yIeCY|AOVtZK3;FU(vyWK9wOe$sV%Iii{LeQ}0HOen
z%xL}GTlXE@`P1J&vuFnT?#|%et)b0p0|y;XL0Nkr2i55y93@KlXKbwf!MfAdT}wT9
zGjn|$SSkK+bme%wP|~)sU%2d<=VrV|PL4gLSi&x!k;_g(J@hEj!G=BzqrK
zJ3EBwsfY7Wm*KfS{hq5Z6k>ry0moJ-FU;H5w#>Do>Jvmj7b`Z_UmMx8G*)cnnAhb9
z!e;CuEIfIdbzg2?gnYPyg%i(Ze^&f0C|oX)uQWpjI^SB5pYPN^$$gGfDzBvSbWpZ+
zNkgZ>q9>!`KAqAjR%W~Iln{}$%kTWHGy8p!+JEgX;A>9PBW)s%sbn)YaG
zi=_JVt5>()zEHQji>_T}rP`w#&)w0lWMY%Bd#l|}YxTDI!AYa8LZovXhPv9y>S`t&
zu+zoK%FE~aS1DZsYQ?OaoJ+ONI`0Vc;1#kF#3)@`&=Q(q?ncr8JC3T&-{(wvZ|`*JzrRu6bL~>J>dr-J7zMh;P^ZT+~{>=W1!d%WR@>oalS+phJ;CdL=Q%G
z;Q%m!_G9eQ{QO3r0bX))9Tgel-e1e6!+JP;g@wy8)%#~C2xs1~jKaq0t~psHA$|c8
z=e6bngpA(&+1Dr#HC2`5r1y!5?|q)|TFsYOtT21{p?M@3YaKzzcF^N_`I<(>2^O0r
zZ)I(50}~4aV}10CE&Qwe!rA)Ho)O)h9UMht<0cn-0=9HcRX$kPC&cBFME>Fe=28#*I%|k+~9wUEyzqx^FgAFR?mIX#gTYH!i>4dzO
z#>ig3vk_sSqg!shKbd6~;%|i2XXGqbwPt2*91FNLIv&hJVBO%f(8y5)TZpL^XDMLq
z`Yal}*96BaWjK7&_`te_T3DVh-?Fxncv>K`Pg9B1a$r9S9W=no70KkT1WE3%ftGgr0>YqI6FkKnUW@z*}pyBXa%~8d#IX+
zg%Hfm$vcB%TEAuFYt#o+s^B~+?*mdAb;$6!-_)p{t-rZEs3YR37h_V=_H^8c<4gpZ
z&zV-jjsafv2SQ^O4cZx-g-ZQ^UFr!R9P%9F1y`c^Do6g<`Bm7^pGDe?d`KeA(2>?e
z_dZTln=I4Y(Rsh|S=^F(VTwi1g1F2*vrdH
zUeDvRqhy>v)vpCEIwT1Y<*T+s~XAuCwXfl
z1ei%92hE-NH^8ndfz{qI-@A(|0)ghJ*A#U~Qc~xA7(Hp+j?A2l5Yd=}xvHLM5l3=D
zWhox-J1=>=UZ4`OAOtWrG%JmkD>m|W7}dLtDy3z@P>5!4-z7S}p8oBbwonDEBO*N%
zh(xn_%S!&Ay$sH(Ol=(<&h6b&fH-t_?S+cUf`@1rwwk4U6aj7k&M?BM=Kb2$+M*f@T*V+t`laS-c2I{Ek5{qld?eD!~@TE4@_
zmj@ZV}!nD3_dx7wf^MtADx2-o+C);BdUn<2dOA7?X`%EXK>%kYU4!WEKVw9#)Ux(
zffLaH3&Wja72hia>t7Gsa6Dwfs;l$!_^ErNEG@XK-=o11qK0-*Q)kikM&TExe)~~^LtYxO*%5hVq)0To#k`dVn6=~0!dPevX4G{>hEobwWoh9p_6353IQxBI~)8v
zU8%q!Y+6k%x*(@2biiT{5jlRqGUolWo1;@VFN#ndT?x5OYn
z&?fqNlI≈c`EozvKnrv11?_7IH4tX~V#Q)LRemuxJ$8xT~mKb`SA3)$_=tFy+el
zKUx!Tx!tVi6gln;YBm^{57a*Jmnf^LU`KSYYsU2Km|{)M;&ME_p`oH9T|EU#gnUFJ
zOOENex!sSvYMNBKquOf$xE^d+e0TQUhAfJRY}FHIl}PN)MtwgU+1Rkn4RqquxHA+V@}dz}jSUF7B2dvp))V({^!z
zZ-|L8S~sd}^t`AmXKM1<8Z4_hIh?xpApdsnNdnG{Ig>`33@BBE3hI5Zr;IVc34)j4
zc?&lmZ-}fDpQI%PTqosbz`Sss8gIf-yNXRM3{rlktnZKC$iX%@F)=UMD}3|!i{;Io|>lbAztu=5)#4raG#1ABctIGS>Xh=u(72n
zR(BHBC3#Q*t*Y;!MBfUK{FWr&V#
zA|S0^2M1~j3ZHWnOG@bHtX%NL#yPqp@b@-nZ;u~??Csy+CeGd6H3BP5o*W?u8){wh
zyJ`gISBZzw7RCYrq#_n(KLN*9W^6B2w8zswDT+TiJ~`Xw+Oy{vA5O$8lhYqg#BSA>
z$xTnpd83k~tZ8D5ORQl0T@fjaYxT_C3ArgjH%H9!!Ga7##lpfv#nm}D>2^PTNl$3Y
zE221Iv}1yf)*fXn{|!RG0MQ+wrX@B1J%bnd!!xnKQAj}Y&*T@p(tEKbp}29m(Aa?p
z*N5&p%K^&I&86U>;Na%YDK3`Yr3ncMp`hsIm{tV{blJ}gkS<}b
zv=cloKG_gy<(YO`syb&o`qzQhuvQ{d(;s)61JIED}ffbY^V<
z-_4%75x%?2vC%juI=Jen6)OSyKQ6>?8beo=L14q$J6Hb?OF3@9sR3oD(Qyk>{h%y)MZFyf8NG}060{MAUHg=P9sDlw~hena5yssD*<1#
zU&*~+vwmjxMu)%h!=|8d4}{(SX)sE1dh?L+%=T>}qQvXxpI-kIDkHocyY?>o%q1cA
z{L_HH{sQnTxSNgQFodsrHP6iWp90+RTYY1JUQ{#vCni((gj63Y0ZCwVqrV>s?;kZ}
zbF;JH(#ii(82tprLB?I19|VEn{36x|jo$yXN=~|VmU}9s+Y5enwlh?sTbb9D`ANQ!>%y9qvKH`Lq@?29h8hGt$
zgd;QinuKiNpDw)mrxkwTjF8U|yhBEy&5e)@3Nlq7WyjYQNd6Ar41myMU|=NwOi@%-
zrKtAL%*-qZuBfSrEiSei5JC7e`cdtT7b~$98h@rnP#HIwox2wnYwG()U{&9f`DP|3
zo4sx|)#O}1!CHX|4d?)1+fb0_0XIE<`T6{dH_}tNqTXZ3C;aU}R?F~+Kq_Y4uSvx}
z13u`KNi#GsaK3Z`Y(!*IK~d4cS)rW-lMsWpF;||QogE-UAdomavl9}Q#0H8p=83C&8MwI~aw2yUm`!KG!)-j`{tz}b00#LM~kT4yu%jig`Y%|cOuZ4Nl)jxVR*z*Ev`92UHu6`4>zkL`Z
z_QvINQ$&V~?pd|(@$u-{IwvPYfNK+9+-xW=F3uR6zoeq3W_MDmHUnJkH~33@0WZ51
zfi#W8IT@YQo{dXFCKiB%$7t0^!p+^#BbP$RW@Kfg{3E@*u<&l05ISa^KZCAhQA(#RRn0_h(ayv_ByY124qmWK(G3&D!E2^41^nM+FxhH5a`#l(_!<+}+sW9Td(iGw_wA*U}Ix3YSh-6mXXBd4TpsXTdpHNTT8n5Dk&?Q%5141
zSN6MVhe1Y0s^_g(l1Svf%8}D*e$01tH?mA$UBcbHYu;I_N47xlMA`
zGBCurxN!0*ne)Dnu*ffJ^EhttoY@A14P6m%P!cxhg+qzsAffFFjF*>o-1ho@l$B0o3Pv!EogALCx
zdSz3OQ_7}w^pB*rtv{|-R77QPndW3yJHb{KypQ#+8+^SFw%f|vL*oHd^2F_S{MOUO
z7Omy3WMLTydI0uA8lU~iLqL%~ky^$O2e{9OklQ6hnDmWgk~?A-+6f6N$;C4C1@d($
z{qDhDsa{>C&6`9z5eliPB2m()UL$J0);G!eEQuKzYfDYezp=Xn6PjFz%WG=f@B2;H
z9yEMQ7W$3a>3HeWC5ZD0o31>s4p09VS#JSUW!J@h6AB1YD&5`PB_-Y6-Q6vrq|z-d
zl1hhkBOrO`?(XjVHurr$@B7Yt3^Se?;hfFB*0uJE-}+yN2X6std%$;TM6=NX+jIHU
z{IHNF@#_~Y0BrtPCnY5C@=hBSOl&>6xv-5TA*c14mgqNn^{qP{ExyNLFI)m8wu)0G
zl59Q?0%lImWyi-X9Ov{}n_5fd$aed488*0C2{}=d}2pEKkQaheqAU
zCu2UyGEh9R@3-q}+BorJEy<^F4GJl>pVGks1#co>aj-JIqj)@vg
zNR5}{Fs}tTjA{oCoT4O8_lgCf73hL*YRhXnukJ7LV}KzR9Q!6Y@+KG3A_1txv*%DbGiLtqZf{>IQtP%cTM~R`k#%kmaJEKQZ6E`&Cr*pv%U`
zXEFZ`T|5L1A-g^BmO#)6lP-(Lgf&I>@tTI4k}-Rc7W4+Hwix)z9YU+(1=N+5m95Rp
zvP<)63sv;=T=t@_KwV-&Rn2d4JIT)HYq*U3gA0Pr`Pmb<|DvoG4h}#oz#_oDq^6}H
z*r^A}XxMw!dHCF4KM_m~@`pr@PL4)IJ@d6KN3gseHC>1)vXd)0R0b{HbaZr$mhJms
zRU|<}26f&yy9~uJX@i8^-;XX!_U>Wdm)zJOiAbuePd+V-86X6-8}18w-m5HIz$`rnCO+ZIwJd4~7ZVEm51`vI5Pbt^wrtZi*>9f1Zo!w?MP0yP~S84Zob#12MU+Cx*5jg6fs
zG+Y+j;ZK1*MZbOlSOIV?%}07AC3%2;Qc|qXc3{h9KoTJKIJyCUb()}u_(E#N0dGAw
zUz{X4V3!5-GODXx<>W3xVBY&)j^4Ja8$yRKCL!Ei5@o!%Tb(GXtq>boGXL(odU6vV
z_+S`74RwH=3<0ALXtVxx*ly642D4%i7k&NqZaKcI!`aUp1D6?g!IYjqUc&hjGJmiA
z)S|!O^WnsE{-VeNlEveGv3t-UitMn^a%AY>b8xytfwaXrP7KPGx%h6ez3chi>Qk|z
zKIKdLiHT|{S~E$Q=F@0eViYff6hY&u5@WAUSKmp>N_4Jr&-8(To>Z`vSg>_jM>FW5
z_0=2%G5jkMVz`f&7ic*3jadSts`u*H!o4_keKx7f+q)}EfRTuMfST6tni@sbm>$e}
zU47t|HyIk?k#QQm_MWC2&pZnoxS*Cp+ouzMzf9bpHMNT+m7?B}qdBlLP}3eM6*vgL
z^!29``@il=%j3udJz!-<^>~8H=PJb|hXm`8CbY@o^mb=m8$lS7UiFr1PfUkUJe|QY5gGdY`?yIL-fB#j}J(Utm
zOI1E6z3mE%?VIpH)}txDQzus=XsOl$LUqs8b*(o)x7(ZdNbWwP67YOMzPrj0IM@jP
zo6JNC2_jUENxn+qCzSc5-y>M>z7a7Doi5-XES?h@x_~f)_3?aq2f!>L{*j*VHdvjx
zFB_NPs|pK0=<8=nCS)sH(LKN-A|h7Q!d5F*X-5ONMvVXKub)4Cu?elLMu4(PNgB$f
z{pj|2Iec_+34J+(j7$DpH^NUA(9z=%0CgRb%^IGA9=B*01LZlctczCD3sz8LIGMfzY
z?;dm$%A0FvxC*YlWkFBunTnh~Asrj}S5K3#!wO=~$8#%{n{uF_9Ah=r-^68p^>_!x
zj`!H>A`ESHa4Xk7_xakDjD2VBiXR!-4a021Nc2GePxE>LYWeTDgoN?Q!_{r(b+JJ7
z1xB(A{+@=ty*;<1(z#UuG`O_EMa(9Pc}uk5AQd|
z^5v|n@r6V|Ozr08w!3S+V#LMIuRB$`G(QhT{caajK)^bz-(h3{%gD}BJ4YsZdkoIa
zwy_4(BR^FR{a7q0mQaOLT|K>r10O<8ZJ)u0$hjK0YI2wE?tDrLfBg3yCP$BCO!|%~
zm&MsX7ac1$P-y!Yyy}zqocF-6OX3<(Pf&whK(+a6I_xrp*N`jBQ1!KU(Z
z>ecqaP$MqZDre7<3^Fn@6%7pu@;BhBjJ+@D|NHmjW1NxYcZi#bEHKT%2Dvn@Qjj-U
zI@N`QeMsSW>@P041q~nuEq*MW`pEXes*0NOiW=3J}$GGSta-t=s9UR-sGO_5a4+1XOoF7h~
zQtFrCG^asnJ;TRHF3rPB}shmb&;eNh%O>1}2l5Q0Py#Bc%%9)d+PXZC
z;)Tbx<#wG@4&I=>rMeB=pZ4>q3N^o(CT3=4w)agoC?+W%
z?q?x3T|$iID!#UgsPE0_OZm=F(xAS+z6v&t(g|lk;~a1~yoI0TL9KQvEi67y;p94X
zVlRsXR~^QP3~Y~^&As;(YZvb&1qH=~Dj(*%$*V_|@o`lPRxMBz?r!Meaezllaad|q`8lq{
zDF5L{L|T!HmsnTr(G8D*i$SYYn>evgg!{&8$;Ych*r6_AEiKY44|PjhPM@<$y#-e{
zbNQ?R|9)_hbsuUMV%laSLsz2dXz9>JLf{1ME)Noux?L74LmIq67a{Vph$}~HhA%_k
zO^|+d`h*SkAl)~Au%xgU-*QV=Rd=*_^7Znev;Aaz2a%@)G?b-?snO%b5f6AR#J0?1
zn>J`{H#a)^-eP~?z2K8XYfJNQc8+Rxj@yd^0<0(8yRorvSRnE}aPdALn!F;%uT94po^%hKZJk%N=76BY9IP7&Ms|Gdm$X@JRV+8pA7aq
zk$)52Z#$_1Hzy2Db8EGa*7&LESJ(Q+gJ!wqOU@u@64%Y~6%D883aKvIzP{w4tmP`E
z&qSio_4T|m?3y+{>wj0ML?I*F=fKDwoAEYRSA$+Q`5a|4q)io3KjB`tnOCLAQpR_6
zbT@J~m7o+5fz-y>iYNZdL)0`qXMFFU!(tt6X^;RFf^+|Yaz)0QGG1%x?0(GxI#|T6
z&gL_bENQHzjR_7WX1j64Vv8I-4TVd7JM75zY#tIgaKz!8!hE_wN#1?uL*6K-J>p|#
zGQ_kJOemE5>DktF{ba-1-Q5M~@7p(V^aDEnR<$`j3S&EJk3~rw^%Pl?5xu6R+633^
zn>Qbn4*&U;b`6$3~GgR{vNF}S$+Meu{d2`e-SaQn~iWuIb^rT5*#$T#Mj-U
zf7BZ<;Gn+CF?_@_Xb<4?4saJ8UavRli85t{h#BCL#`hBNou)^Ij0~&#ryW1~X?~av
z44a=ng6VGS55LxE_DORhyxf~h8;g}BMx#_nsruN(yQDQH>&e7CM(ga-sx!mO&Qs60
zzI>APGMF$k{vaf(5}azil@rrDvzH~%jhFb2_$-^9Jqkq+HyPRTX}mvOs7hE&s3K3&
zi;Ic`%qp?U7%YaqDXZ(hx4$3nRr!b~-}s=ne|G)n&w70JRz=}{NR+hn<6nOXTABm}
zD}%pJtz)*p(P@-uuGShaAYegGPZ4cdtJ2f=4>QsrnXRk)t5VsDSWLH&Q`?yt13+SP
zqf&WA14!BJ>i9CF*0uY*clxuCZc&%2s=A-_ow9!S(dI-Gg5T?4HvdCe4vvY6wU5B@
zrwKY>au(c99{8xz+JQN)Y4pp>6unm5OX7kr@#dqJ>~q5MHG%2nN>I~Brp`0tJ7>1=
zJk9=3&?M|;v%26vl|~>UD1=o6>#n=!FN22Tx?FOyx_Kkd>%8_#OCl+PMcR$SA|eQP
z?z8&g2YJ8YO_q5le_LN>H(&ac!&mEIyTa@BU1}(&yV*DGuNO5FQ>{%;zNm!g0fBCG
z7I&4$6sDHe%=_j+^P%)g!x3qTf)Rrj)6$c&*5;Yft}~D^hVn)0Z4i}PZ^YRzxN39N
z0KUp)tE|Z@jd^?o`R+WE$0KE``=fSMLqkKtcr_)wlEURBD<>!Z8jsh-Y-EuJLuUwO
zi9sVN8{3>yP*1v7zqxFd?WAE$*HPAD+eJ}}FT?|P$7xGm^Y~JzH-GZo-@kp*kb%`!
zEP@OGA^ivKtIRE$4@}U$Rz858+iEuI6h
z&dl#o!IreJ#vO}fauV~;XE8ed?z$*PXUp(D|En9B?tPx{wJan-AIt#tbq=TQN8dS}
z_f#-p-7!WvQTVfCjmb2NpP-Z^2kDu&hkVD?a+nN;b+hRD2MHHHr>Q^>N1>6Ek1ljy
zss8a2COrlv#0?!iH40CP&x>0#0|V?J_lF_zeaQU9Pl+1eyIx$pf3$R_tDBxytfjuB+oN@RJVrJg+N`xO-sWbKfs4TN>-?(h~l(^-I;C`R!X#5MTUr
z0{ADq!|-_N5SO&+Y~lqKuuOP={n%88b_8Y_2Qigmo^p>vRSHTyL5cb83xa=iDFW1?
zJ8R}(!Us9M9ofRQzjzP>iP&vA+JeT&WZUw4TBwpDwGg|t`dQBBnzc|7cf!dlR-n~d
zMsK}wQVe-MYu^6b%@?{;A1Xw?{zlyv0tI#Qdqor`FX|J>JdR<3Y()u~;1ksrVLy0}
z4>ZRnr0FiO!;6V5)?E2*YRtrw;2pkW++S+}0TieVc`Q>C*7}Gp>vVG$2B6S6ocodY
zz|tIdQ3{PSD3b1fFVKkB8WzanJMYIlFDhzH?c`y-gVpQ%4f
zHfi<0{?a{q*R=qCLOROf7rQTr|-KT`u6oGc1d__L+AqV1$(xmaoT!k>p
z3X1*4!dq-;7N83-tZbDvMn^OL33m7B6foM&j_vy@1x)3d#b5jS_P7q|b$E$L&NuBk
zl1dsu^-N#micV@%ds@3;XSZ0ds%fGKh&r6aDimZqrG5c>5uonE%O?;m-^qsvRR@|q
z0ZCu|aBa9Og*x99taPq#Z2b6P0w%&(JY!0}RFH@i8Z5o9wNKAtUaVS4(nVsKn3%|!
zZ!XnsruiTVFICL|WP!
zQp(UF0Ql6;Ld0m~cm@PjwM3@o=AY4=UCaI7V00G1>EOxmHGVq7yjA*HU6d^U3JVY<
z)jz*Se<=ql75AT71~0)@9232n_&wj4%jzQ4{F*nMpAc%6h&GYaX>?#u142zrU2Q)Yc%Ubu
zfZulL`V#8eB-b1h+jXlYf%xMM;*WHtxs9cMwWgkND5%HRr!Qc7$0U@bagT)BvI3@(
z9o*CsmlK5`!1D773zs)IF4un|mFOIVM*qy&x}D8gB?o4JF0D5zzJZqq8!7IuNGmr%zR+}|F*
z(2UP>LCwOXC&LaSl9Q89mYk?4DcN`NzIyQ)K*x0Iph@T-5N^O0Zv6|G6BIG&jT*Zq
z0a_U9zx~l+`+do~01xm}v9o74WQ!zFim3krHr1%HFK>1d5T7eRVXDqNH#9p`VAq~i
zl%8F9BYGT4RR;7m-oYKrRWXb)^nbqv8$6)~e(~9i+k~$nO`mCbpFJ*c0(NWDCu1O*
zh{WeOG~MQrCyA67blk4%;m!&PZklg#S(>xB?C7GyOH58kKyh`3crHAU2YUdij8Chp27+HBT0X9jhYx0MG)@l;m<|i!1;sq=3WA-gzSg`TNxx5(Ch>OE}l&|m@x<%o~!+0
zW`;3W3zve82U5z@pGnerdiCymhJWROTf*3Qnt$BY6Hyk1?(Lqf98qC3sORZhC~Cm9
zUxIU@9!_0FE5WzGakpq}&#}4G-Ka2nzpyFGpW;FgHhk;_GZg^0Pc9;rjhd
zlL1lCaGJ-Lj7CejG!_VO#S1-o`$Ew59X^jI?(?=F|5|$f3%@<|7AOkx)^^-lu
zy<^_@4n?886OA(70Fw^2HHQwSg->@X_#wzM%`R-8gek
zm^S&D{oa0lJLnI&J_akc8|Ne@=-(oqo{r_qOG|o2qupvLdOo%1c)6H|IYNLP)29zg
zS(F=&e_vZk2hvm;s2~qghgYw80`>(!kjG`1p)nGWF644E{8W
zAXr&h$9$D8M<$PXk)?0UAcw51*^rOWprDLbUPsKs)ji9IVS3@7@l$ZvX&j6D+_i&*r414J{K7b^XKdRQH}aC6
zbMfzAC=&J#tLe_;zs3KI$ADpJl=9!3Y6XdEPv8Rl?HS?V_?=ufkI&qOOHyt5>1gko
zipk(Z%SUt`+ik;EGo-0f{UI-DEiEtiOO40uxLz}G2Afo9PFpX6l?ExQp0nA;f+;LC
z1)~05oCN8A?)u;>vplU~(5eTZLcp&M^f)Z<;@o9sAJAnTITaX($k{~q)1lK8WH8R%sp`C#8X_`IK#%8dC&KfVYH6+jIX
z@&ccI7K`(R4(B3CKx^^`H-;+;f42YQ%7LpyO-|J^9M%ip%UbTg@_;kqsw^BHc>z^8
zrIWYTqqGLxNVQ;7%g3UkR41Yj+y8jAfN#lZauJxB)!i@wl+IxUjUelC(DX
z)(0~z8WJTYhJqNc;TA`r=RZ^##<5?40%6ZA5jaXVds`|G#12aa0z&c&}D_uN=rp=
z=L-CY=M)JWDsH@FxKnk%EsFaw>5D;(vY4ERIi+gD&cP2IFxgc$C_PAzW<(AZMkA-z
zMaqhCME&^DF-tbI<=nefNY-UKKi7N
zm?+MI*qGV&AJ*8I>en&+^NI{dlze|%E&03pNG=n+Qi@xi8}m%c94Tok;~RZX-acx4
zu#^K+_Xq9+^5H+&6x7LSLoR~-hw;UoJ~~~Z^%&++lO}A_A^f;EZ}c0yk0hd+IsXdl
z$U`4F3WX=IS-c9`yWj!xJ(dL_~(>
zjC4|Me3-=imUIDO|EaN^fS|A2wpL@!wZWp!%Wl_>Lz!<6P`4eWp+VX;=yDD-JX4H
zXuM+Pq>KF7r=tIN&xkLp*7?Q?Sw>ndO%0jMYJ{F0HPBGExD&29j7oe=;)4C`sRhFT
zhn8XfS}}Xf5=41CJUkm48@gQE!`XqEnVH$yu}va(_5#n0SO69`hP^~sTpSl1U)14k
z=m1VqT+H+gWL8?vMEPC??zO)q)v_}l8ijDY1#cwg+cQvdw@3&FJuuoSyT7K+=IZXU
z17k*=`2S+zLM|2P-g+=^Gw0wbXm)x!b!{g&PEc|aA9BV-$J!?tIOCMzuVifC7Zcu9
zpnpDr5n=}ka7JuwX;G1hiCq_+i#P%p+?&+3AcX5)Ag_
zecrj*#;f%>Ys|M`=f-$@`VS
zAN9#kLAYjo>ga}pN+L|L#kXHZ{_$J-z0+W7+o~~3!($ch$V5`iqxui*+bI`=H{FQA2*9{G*=?iJRFhHpiVk|C&C@Piw)?A^C)yzyo%vN7WHhO82XJUO!l8D_$;oFsF7}dYYKc?1mX84b=W|sB9TIVb
zjjgBQVavtOq4b#jF6mdZ6Lhw=CBdF!Uq3d7
z1|Glx5wD_px1_j!6nyUVgmYmfVW(SHB8#mRO)u%b0$-9)$zU;1{=2!m`}xy-{Y<++
zKEns?Q4%J5@Tz2Kmxwn@{A?v+D-WWSO`(%mMOm-k*83U;N>eV^sH8nLkw7#c%
zNc#25{R0B1Xl_B)4i|hBRe&VWH1uO*jqyf9P|$~c4?4PVfyP?0AV$3wTwHGyIsnK;
zd7lO-Aa`cWV@KSQD7$>Lkj>;rCpq7rIeSY5QKn8*PkPWO)y*Fsj|iA5TPoFm>v%cv
zN}&0$=@O~ayb1sY`9HH;yi}l`c)e(->C?HLW^XTwB)EBEdd=1zQ`jvIWshF1rRgZB
zs}D_<@C{|~eGyPqR{n^O6M~kyEbx29oGOaQv|@U$_Q+Zt%qJe<@>_myelXNOLe~Jp
zCVU<%?or1W?Kb{hC(K6X&3K*r%E>n{`md!{>Hf2cOQ{
zFx#KR$jZX9YRk0TN;Rd`hP0RB`>a_^zzL2XsOZ2(z4uPN%(!)#qLB}Vd1wis_1ln
zC+^jecyP^5y-PrOjZwd8b(vXJJ!D!=$7ks=u&HLCuaC$5etfdz)6-%-qeOy$(mJ)oDDv1XZvJ4lG994I)uFxr5joDo|j#Il`i(r@z-Ztj+f*
zra5t9LKlH#^++M`t%yrV%sF($g;0F>@j8}z%#zK@%8FD;T)7g532>qD=Z~EM(45nv
zrNAn{WbDyI|M}v=9zYx5;q1Y1wcQX3^dX~eleW6L-@$BfUig;7e051v)90zA{v-x(
zU~3Qfg6@h21`5D5rv5PvH4Zg-=4i4`IAmOA*Fu8Jg0_Ic;NW1qz)3Hkvqtkj9H*(N
zvlq~5l=Amf^!qhcRb$<9bGYxtV*C|KOU{9V6BR*mn88PLf68xYnEg3+fpzpk@LKn3
z?{J~Kx*B2u!58%1ou2b}6-^|;Ro!00s=T1cxMMA(K-#8
zn