Support recursive partial SetupState

This allows for more ergonomic namespacing in SetupState and gives us a
natural way to extend the interface with more properties in the future.

x-pack/plugins/profiling/common/setup.ts

@@ -5,6 +5,8 @@
  * 2.0.
  */
 
+import { RecursivePartial } from '@kbn/apm-plugin/typings/common';
+
 export interface SetupState {
   cloud: {
     available: boolean;
@@ -19,14 +21,16 @@ export interface SetupState {
   permissions: {
     configured: boolean;
   };
-  apm_policy: {
-    installed: boolean;
-  };
-  collector_policy: {
-    installed: boolean;
-  };
-  symbolizer_policy: {
-    installed: boolean;
+  policies: {
+    apm: {
+      installed: boolean;
+    };
+    collector: {
+      installed: boolean;
+    };
+    symbolizer: {
+      installed: boolean;
+    };
   };
   resource_management: {
     enabled: boolean;
@@ -39,6 +43,8 @@ export interface SetupState {
   };
 }
 
+export type PartialSetupState = RecursivePartial<SetupState>;
+
 export function createDefaultSetupState(): SetupState {
   return {
     cloud: {
@@ -54,14 +60,16 @@ export function createDefaultSetupState(): SetupState {
     permissions: {
       configured: false,
     },
-    apm_policy: {
-      installed: false,
-    },
-    collector_policy: {
-      installed: false,
-    },
-    symbolizer_policy: {
-      installed: false,
+    policies: {
+      apm: {
+        installed: false,
+      },
+      collector: {
+        installed: false,
+      },
+      symbolizer: {
+        installed: false,
+      },
     },
     resource_management: {
       enabled: false,
@@ -81,18 +89,20 @@ export function areResourcesSetup(state: SetupState): boolean {
     state.resources.created &&
     state.packages.installed &&
     state.permissions.configured &&
-    state.apm_policy.installed &&
-    state.collector_policy.installed &&
-    state.symbolizer_policy.installed &&
+    state.policies.apm.installed &&
+    state.policies.collector.installed &&
+    state.policies.symbolizer.installed &&
     state.settings.configured
   );
 }
 
+function mergeRecursivePartial<T>(base: T, partial: RecursivePartial<T>): T {
+  return { ...base, ...partial };
+}
+
 export function mergePartialSetupStates(
   base: SetupState,
-  partials: Array<Partial<SetupState>>
+  partials: PartialSetupState[]
 ): SetupState {
-  return partials.reduce<SetupState>((previous, current) => {
-    return { ...previous, ...current };
-  }, base);
+  return partials.reduce<SetupState>(mergeRecursivePartial, base);
 }

x-pack/plugins/profiling/server/lib/setup/apm_package.ts

@@ -11,11 +11,11 @@ import {
   pkgToPkgKey,
 } from '@kbn/fleet-plugin/server/services/epm/registry';
 import { ProfilingSetupOptions } from './types';
-import { SetupState } from '../../../common/setup';
+import { PartialSetupState } from '../../../common/setup';
 
 export async function isApmPackageInstalled({
   soClient,
-}: ProfilingSetupOptions): Promise<Partial<SetupState>> {
+}: ProfilingSetupOptions): Promise<PartialSetupState> {
   const installation = await getInstallation({
     pkgName: 'apm',
     savedObjectsClient: soClient,

x-pack/plugins/profiling/server/lib/setup/cluster_settings.ts

@@ -6,13 +6,13 @@
  */
 
 import { ProfilingSetupOptions } from './types';
-import { SetupState } from '../../../common/setup';
+import { PartialSetupState } from '../../../common/setup';
 
 const MAX_BUCKETS = 150000;
 
 export async function validateMaximumBuckets({
   client,
-}: ProfilingSetupOptions): Promise<Partial<SetupState>> {
+}: ProfilingSetupOptions): Promise<PartialSetupState> {
   const settings = await client.getEsClient().cluster.getSettings({});
   const maxBuckets = settings.persistent.search?.max_buckets;
   return {
@@ -34,7 +34,7 @@ export async function setMaximumBuckets({ client }: ProfilingSetupOptions) {
 
 export async function validateResourceManagement({
   client,
-}: ProfilingSetupOptions): Promise<Partial<SetupState>> {
+}: ProfilingSetupOptions): Promise<PartialSetupState> {
   const statusResponse = await client.profilingStatus();
   return {
     resource_management: {

x-pack/plugins/profiling/server/lib/setup/fleet_policies.ts

@@ -10,7 +10,7 @@ import { ElasticsearchClient } from '@kbn/core/server';
 import { fetchFindLatestPackageOrThrow } from '@kbn/fleet-plugin/server/services/epm/registry';
 import { getApmPolicy } from './get_apm_policy';
 import { ProfilingSetupOptions } from './types';
-import { SetupState } from '../../../common/setup';
+import { PartialSetupState } from '../../../common/setup';
 
 async function createIngestAPIKey(esClient: ElasticsearchClient) {
   const apiKeyResponse = await esClient.security.createApiKey({
@@ -43,11 +43,13 @@ async function createIngestAPIKey(esClient: ElasticsearchClient) {
 export async function validateApmPolicy({
   soClient,
   packagePolicyClient,
-}: ProfilingSetupOptions): Promise<Partial<SetupState>> {
+}: ProfilingSetupOptions): Promise<PartialSetupState> {
   const apmPolicy = await getApmPolicy({ packagePolicyClient, soClient });
   return {
-    apm_policy: {
-      installed: !!(apmPolicy && apmPolicy?.inputs[0].config?.['apm-server'].value?.profiling),
+    policies: {
+      apm: {
+        installed: !!(apmPolicy && apmPolicy?.inputs[0].config?.['apm-server'].value?.profiling),
+      },
     },
   };
 }
@@ -112,11 +114,13 @@ const SYMBOLIZER_PACKAGE_POLICY_NAME = 'elastic-universal-profiling-symbolizer';
 export async function validateCollectorPackagePolicy({
   soClient,
   packagePolicyClient,
-}: ProfilingSetupOptions): Promise<Partial<SetupState>> {
+}: ProfilingSetupOptions): Promise<PartialSetupState> {
   const packagePolicies = await packagePolicyClient.list(soClient, {});
   return {
-    collector_policy: {
-      installed: packagePolicies.items.some((pkg) => pkg.name === COLLECTOR_PACKAGE_POLICY_NAME),
+    policies: {
+      collector: {
+        installed: packagePolicies.items.some((pkg) => pkg.name === COLLECTOR_PACKAGE_POLICY_NAME),
+      },
     },
   };
 }
@@ -156,11 +160,13 @@ export async function createCollectorPackagePolicy({
 export async function validateSymbolizerPackagePolicy({
   soClient,
   packagePolicyClient,
-}: ProfilingSetupOptions): Promise<Partial<SetupState>> {
+}: ProfilingSetupOptions): Promise<PartialSetupState> {
   const packagePolicies = await packagePolicyClient.list(soClient, {});
   return {
-    symbolizer_policy: {
-      installed: packagePolicies.items.some((pkg) => pkg.name === SYMBOLIZER_PACKAGE_POLICY_NAME),
+    policies: {
+      symbolizer: {
+        installed: packagePolicies.items.some((pkg) => pkg.name === SYMBOLIZER_PACKAGE_POLICY_NAME),
+      },
     },
   };
 }

x-pack/plugins/profiling/server/lib/setup/has_profiling_data.ts

@@ -6,11 +6,11 @@
  */
 
 import { ProfilingSetupOptions } from './types';
-import { SetupState } from '../../../common/setup';
+import { PartialSetupState } from '../../../common/setup';
 
 export async function hasProfilingData({
   client,
-}: ProfilingSetupOptions): Promise<Partial<SetupState>> {
+}: ProfilingSetupOptions): Promise<PartialSetupState> {
   const hasProfilingDataResponse = await client.search('has_any_profiling_data', {
     index: 'profiling*',
     size: 0,

x-pack/plugins/profiling/server/lib/setup/security_role.ts

@@ -6,13 +6,13 @@
  */
 
 import { ProfilingSetupOptions } from './types';
-import { SetupState } from '../../../common/setup';
+import { PartialSetupState } from '../../../common/setup';
 
 const PROFILING_READER_ROLE_NAME = 'profiling-reader';
 
 export async function validateSecurityRole({
   client,
-}: ProfilingSetupOptions): Promise<Partial<SetupState>> {
+}: ProfilingSetupOptions): Promise<PartialSetupState> {
   const esClient = client.getEsClient();
   const roles = await esClient.security.getRole();
   return {

x-pack/plugins/profiling/tsconfig.json

@@ -45,6 +45,7 @@
     "@kbn/share-plugin",
     "@kbn/observability-shared-plugin",
     "@kbn/licensing-plugin",
+    "@kbn/apm-plugin",
     // add references to other TypeScript projects the plugin depends on
 
     // requiredPlugins from ./kibana.json