[8.x] [Fleet] Filter integrations/packages list shown depending on th…

…e `policy_templates_behavior` field (elastic#200605) (elastic#200749) # Backport This will backport the following commits from `main` to `8.x`: - [[Fleet] Filter integrations/packages list shown depending on the `policy_templates_behavior` field (elastic#200605)](elastic#200605)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  --------- Co-authored-by: Mario Rodriguez Molins <[email protected]>
kibanamachine · Nov 19, 2024 · 4a9f70d · 4a9f70d
1 parent 7575f42
commit 4a9f70d
Show file tree

Hide file tree

Showing 8 changed files with 421 additions and 26 deletions.
diff --git a/x-pack/plugins/fleet/common/services/index.ts b/x-pack/plugins/fleet/common/services/index.ts
@@ -33,6 +33,7 @@ export {
   isIntegrationPolicyTemplate,
   getNormalizedInputs,
   getNormalizedDataStreams,
+  filterPolicyTemplatesTiles,
 } from './policy_template';
 export { doesPackageHaveIntegrations } from './packages_with_integrations';
 export type {

diff --git a/x-pack/plugins/fleet/common/services/policy_template.test.ts b/x-pack/plugins/fleet/common/services/policy_template.test.ts
@@ -10,13 +10,15 @@ import type {
   RegistryPolicyIntegrationTemplate,
   PackageInfo,
   RegistryVarType,
+  PackageListItem,
 } from '../types';
 
 import {
   isInputOnlyPolicyTemplate,
   isIntegrationPolicyTemplate,
   getNormalizedInputs,
   getNormalizedDataStreams,
+  filterPolicyTemplatesTiles,
 } from './policy_template';
 
 describe('isInputOnlyPolicyTemplate', () => {
@@ -280,3 +282,161 @@ describe('getNormalizedDataStreams', () => {
     expect(result?.[0].streams?.[0]?.vars).toEqual([datasetVar]);
   });
 });
+
+describe('filterPolicyTemplatesTiles', () => {
+  const topPackagePolicy: PackageListItem = {
+    id: 'nginx',
+    integration: 'nginx',
+    title: 'Nginx',
+    name: 'nginx',
+    version: '0.0.1',
+    status: 'not_installed',
+    description: 'nginx',
+    download: 'nginx',
+    path: 'nginx',
+  };
+
+  const childPolicyTemplates: PackageListItem[] = [
+    {
+      id: 'nginx-template1',
+      integration: 'nginx-template-1',
+      title: 'Nginx Template 1',
+      name: 'nginx',
+      version: '0.0.1',
+      status: 'not_installed',
+      description: 'nginx-template-1',
+      download: 'nginx-template-1',
+      path: 'nginx-template-1',
+    },
+    {
+      id: 'nginx-template2',
+      integration: 'nginx-template-2',
+      title: 'Nginx Template 2',
+      name: 'nginx',
+      version: '0.0.1',
+      status: 'not_installed',
+      description: 'nginx-template-2',
+      download: 'nginx-template-2',
+      path: 'nginx-template-2',
+    },
+  ];
+  it('should return all tiles as undefined value', () => {
+    expect(filterPolicyTemplatesTiles(undefined, topPackagePolicy, childPolicyTemplates)).toEqual([
+      {
+        id: 'nginx',
+        integration: 'nginx',
+        title: 'Nginx',
+        name: 'nginx',
+        version: '0.0.1',
+        status: 'not_installed',
+        description: 'nginx',
+        download: 'nginx',
+        path: 'nginx',
+      },
+      {
+        id: 'nginx-template1',
+        integration: 'nginx-template-1',
+        title: 'Nginx Template 1',
+        name: 'nginx',
+        version: '0.0.1',
+        status: 'not_installed',
+        description: 'nginx-template-1',
+        download: 'nginx-template-1',
+        path: 'nginx-template-1',
+      },
+      {
+        id: 'nginx-template2',
+        integration: 'nginx-template-2',
+        title: 'Nginx Template 2',
+        name: 'nginx',
+        version: '0.0.1',
+        status: 'not_installed',
+        description: 'nginx-template-2',
+        download: 'nginx-template-2',
+        path: 'nginx-template-2',
+      },
+    ]);
+  });
+  it('should return all tiles', () => {
+    expect(filterPolicyTemplatesTiles('all', topPackagePolicy, childPolicyTemplates)).toEqual([
+      {
+        id: 'nginx',
+        integration: 'nginx',
+        title: 'Nginx',
+        name: 'nginx',
+        version: '0.0.1',
+        status: 'not_installed',
+        description: 'nginx',
+        download: 'nginx',
+        path: 'nginx',
+      },
+      {
+        id: 'nginx-template1',
+        integration: 'nginx-template-1',
+        title: 'Nginx Template 1',
+        name: 'nginx',
+        version: '0.0.1',
+        status: 'not_installed',
+        description: 'nginx-template-1',
+        download: 'nginx-template-1',
+        path: 'nginx-template-1',
+      },
+      {
+        id: 'nginx-template2',
+        integration: 'nginx-template-2',
+        title: 'Nginx Template 2',
+        name: 'nginx',
+        version: '0.0.1',
+        status: 'not_installed',
+        description: 'nginx-template-2',
+        download: 'nginx-template-2',
+        path: 'nginx-template-2',
+      },
+    ]);
+  });
+  it('should return just the combined policy tile', () => {
+    expect(
+      filterPolicyTemplatesTiles('combined_policy', topPackagePolicy, childPolicyTemplates)
+    ).toEqual([
+      {
+        id: 'nginx',
+        integration: 'nginx',
+        title: 'Nginx',
+        name: 'nginx',
+        version: '0.0.1',
+        status: 'not_installed',
+        description: 'nginx',
+        download: 'nginx',
+        path: 'nginx',
+      },
+    ]);
+  });
+  it('should return just the individual policies (tiles)', () => {
+    expect(
+      filterPolicyTemplatesTiles('individual_policies', topPackagePolicy, childPolicyTemplates)
+    ).toEqual([
+      {
+        id: 'nginx-template1',
+        integration: 'nginx-template-1',
+        title: 'Nginx Template 1',
+        name: 'nginx',
+        version: '0.0.1',
+        status: 'not_installed',
+        description: 'nginx-template-1',
+        download: 'nginx-template-1',
+        path: 'nginx-template-1',
+      },
+      {
+        id: 'nginx-template2',
+        integration: 'nginx-template-2',
+        title: 'Nginx Template 2',
+        name: 'nginx',
+        version: '0.0.1',
+        status: 'not_installed',
+        description: 'nginx-template-2',
+        download: 'nginx-template-2',
+        path: 'nginx-template-2',
+      },
+    ]);
+  });
+});
diff --git a/x-pack/plugins/fleet/common/services/policy_template.ts b/x-pack/plugins/fleet/common/services/policy_template.ts
@@ -39,6 +39,7 @@ export function packageHasNoPolicyTemplates(packageInfo: PackageInfo): boolean {
     )
   );
 }
+
 export function isInputOnlyPolicyTemplate(
   policyTemplate: RegistryPolicyTemplate
 ): policyTemplate is RegistryPolicyInputOnlyTemplate {
@@ -142,3 +143,27 @@ const createDefaultDatasetName = (
   packageInfo: { name: string },
   policyTemplate: { name: string }
 ): string => packageInfo.name + '.' + policyTemplate.name;
+
+export function filterPolicyTemplatesTiles<T>(
+  templatesBehavior: string | undefined,
+  packagePolicy: T,
+  packagePolicyTemplates: T[]
+): T[] {
+  switch (templatesBehavior || 'all') {
+    case 'combined_policy':
+      return [packagePolicy];
+    case 'individual_policies':
+      return [
+        ...(packagePolicyTemplates && packagePolicyTemplates.length > 1
+          ? packagePolicyTemplates
+          : []),
+      ];
+    default:
+      return [
+        packagePolicy,
+        ...(packagePolicyTemplates && packagePolicyTemplates.length > 1
+          ? packagePolicyTemplates
+          : []),
+      ];
+  }
+}
diff --git a/x-pack/plugins/fleet/common/types/models/epm.ts b/x-pack/plugins/fleet/common/types/models/epm.ts
@@ -311,6 +311,7 @@ export type RegistrySearchResult = Pick<
   | 'icons'
   | 'internal'
   | 'data_streams'
+  | 'policy_templates_behavior'
   | 'policy_templates'
   | 'categories'
 >;

diff --git a/x-pack/plugins/fleet/common/types/models/package_spec.ts b/x-pack/plugins/fleet/common/types/models/package_spec.ts
@@ -24,6 +24,7 @@ export interface PackageSpecManifest {
   conditions?: PackageSpecConditions;
   icons?: PackageSpecIcon[];
   screenshots?: PackageSpecScreenshot[];
+  policy_templates_behavior?: 'all' | 'combined_policy' | 'individual_policies';
   policy_templates?: RegistryPolicyTemplate[];
   vars?: RegistryVarsEntry[];
   owner: { github: string; type?: 'elastic' | 'partner' | 'community' };

diff --git a/...blic/applications/integrations/sections/epm/screens/home/hooks/use_available_packages.tsx b/...blic/applications/integrations/sections/epm/screens/home/hooks/use_available_packages.tsx
@@ -28,6 +28,7 @@ import { doesPackageHaveIntegrations, ExperimentalFeaturesService } from '../../
 import {
   isInputOnlyPolicyTemplate,
   isIntegrationPolicyTemplate,
+  filterPolicyTemplatesTiles,
 } from '../../../../../../../../common/services';
 
 import {
@@ -83,30 +84,33 @@ const packageListToIntegrationsList = (packages: PackageList): PackageList => {
       categories: getAllCategoriesFromIntegrations(pkg),
     };
 
-    return [
-      ...acc,
+    const integrationsPolicyTemplates = doesPackageHaveIntegrations(pkg)
+      ? policyTemplates.map((policyTemplate) => {
+          const { name, title, description, icons } = policyTemplate;
+
+          const categories =
+            isIntegrationPolicyTemplate(policyTemplate) && policyTemplate.categories
+              ? policyTemplate.categories
+              : [];
+          const allCategories = [...topCategories, ...categories];
+          return {
+            ...restOfPackage,
+            id: `${restOfPackage.id}-${name}`,
+            integration: name,
+            title,
+            description,
+            icons: icons || restOfPackage.icons,
+            categories: uniq(allCategories),
+          };
+        })
+      : [];
+
+    const tiles = filterPolicyTemplatesTiles<PackageListItem>(
+      pkg.policy_templates_behavior,
       topPackage,
-      ...(doesPackageHaveIntegrations(pkg)
-        ? policyTemplates.map((policyTemplate) => {
-            const { name, title, description, icons } = policyTemplate;
-
-            const categories =
-              isIntegrationPolicyTemplate(policyTemplate) && policyTemplate.categories
-                ? policyTemplate.categories
-                : [];
-            const allCategories = [...topCategories, ...categories];
-            return {
-              ...restOfPackage,
-              id: `${restOfPackage.id}-${name}`,
-              integration: name,
-              title,
-              description,
-              icons: icons || restOfPackage.icons,
-              categories: uniq(allCategories),
-            };
-          })
-        : []),
-    ];
+      integrationsPolicyTemplates
+    );
+    return [...acc, ...tiles];
   }, []);
 };