From 8a58d1844cc8308ab5f0ec49272be14e161312d9 Mon Sep 17 00:00:00 2001 From: Joe Portner Date: Fri, 3 Jun 2022 00:13:50 -0400 Subject: [PATCH] Fix broken tests --- .../get_upgradeable_config.ts | 2 +- .../integration_tests/create_or_upgrade.test.ts | 15 +++++++++++++++ .../management/telemetry_management_collector.ts | 7 ++++++- 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.ts b/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.ts index d2d3a114e80e5d..3ada382b3d548a 100644 --- a/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.ts +++ b/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.ts @@ -16,6 +16,7 @@ export interface UpgradeableConfigType { buildNum: number; defaultIndex?: string; isDefaultIndexMigrated?: boolean; + [key: string]: unknown; } /** @@ -37,7 +38,6 @@ export async function getUpgradeableConfig({ type: 'config', page: 1, perPage: 1000, - fields: ['buildNum', 'defaultIndex', 'isDefaultIndexMigrated'], // Optimization: we only need these type-level fields, don't return anything else sortField: 'buildNum', sortOrder: 'desc', }); diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts b/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts index 1da8bad330c31b..44efc558e10292 100644 --- a/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts +++ b/src/core/server/ui_settings/create_or_upgrade_saved_config/integration_tests/create_or_upgrade.test.ts @@ -90,6 +90,9 @@ describe('createOrUpgradeSavedConfig()', () => { // 5.4.0-SNAPSHOT and @@version were ignored so we only have the // attributes from 5.4.0-rc1, even though the other build nums are greater '5.4.0-rc1': true, + + // Should have the transform(s) applied + isDefaultIndexMigrated: true, }); // add the 5.4.0 flag to the 5.4.0 savedConfig @@ -115,6 +118,9 @@ describe('createOrUpgradeSavedConfig()', () => { // should also include properties from 5.4.0 and 5.4.0-rc1 '5.4.0': true, '5.4.0-rc1': true, + + // Should have the transform(s) applied + isDefaultIndexMigrated: true, }); // add the 5.4.1 flag to the 5.4.1 savedConfig @@ -141,6 +147,9 @@ describe('createOrUpgradeSavedConfig()', () => { '5.4.1': true, '5.4.0': true, '5.4.0-rc1': true, + + // Should have the transform(s) applied + isDefaultIndexMigrated: true, }); // tag the 7.0.0-rc1 doc @@ -168,6 +177,9 @@ describe('createOrUpgradeSavedConfig()', () => { '5.4.1': true, '5.4.0': true, '5.4.0-rc1': true, + + // Should have the transform(s) applied + isDefaultIndexMigrated: true, }); // tag the 7.0.0 doc @@ -194,6 +206,9 @@ describe('createOrUpgradeSavedConfig()', () => { '5.4.1': true, '5.4.0': true, '5.4.0-rc1': true, + + // Should have the transform(s) applied + isDefaultIndexMigrated: true, }); }, 30000); }); diff --git a/src/plugins/kibana_usage_collection/server/collectors/management/telemetry_management_collector.ts b/src/plugins/kibana_usage_collection/server/collectors/management/telemetry_management_collector.ts index b18fed38ef9e4e..1e99e55779a041 100644 --- a/src/plugins/kibana_usage_collection/server/collectors/management/telemetry_management_collector.ts +++ b/src/plugins/kibana_usage_collection/server/collectors/management/telemetry_management_collector.ts @@ -12,6 +12,11 @@ import { UsageStats } from './types'; import { REDACTED_KEYWORD } from '../../../common/constants'; import { stackManagementSchema } from './schema'; +/** + * These config keys should be redacted from any usage data, they are only used for implementation details of the config saved object. + */ +const CONFIG_KEYS_TO_REDACT = ['buildNum', 'isDefaultIndexMigrated']; + export function createCollectorFetch(getUiSettingsClient: () => IUiSettingsClient | undefined) { return async function fetchUsageStats(): Promise { const uiSettingsClient = getUiSettingsClient(); @@ -21,7 +26,7 @@ export function createCollectorFetch(getUiSettingsClient: () => IUiSettingsClien const userProvided = await uiSettingsClient.getUserProvided(); const modifiedEntries = Object.entries(userProvided) - .filter(([key]) => key !== 'buildNum') + .filter(([key]) => !CONFIG_KEYS_TO_REDACT.includes(key)) .reduce((obj: Record, [key, { userValue }]) => { const sensitive = uiSettingsClient.isSensitive(key); obj[key] = sensitive ? REDACTED_KEYWORD : userValue;