[Fleet] Fix exception in agents list when units field is missing from…

… components (#161360) ## Summary Fix an issue found in 8.8.2 with `8.7.1` inactive agents. The agents list endpoint was returning an exception, after some investigation it was found that the issue was a missing `units` property in the components field of the agents. This was a very specific edge case and in fact I could not reproduce locally, but it still happened in a minority of cases after upgrading to 8.8.2. The agents in this case have components that look like this: ``` "components": [ { "id": "http/metrics-monitoring", "type": "http/metrics", "message": "Starting", "status": "STARTING" }, ... ] ``` But this property was typed as mandatory so we didn't check for undefined. The actual bug was tracked here: https://github.com/elastic/kibana/blob/2070836060046aaec0ff28ddfcce91356cf98930/x-pack/plugins/fleet/server/services/agents/helpers.ts#L50 and was causing this error: https://github.com/elastic/kibana/assets/16084106/607b5aed-155b-4509-896a-ada7507e4dc3 I also updated the type to have `units` as optional and fixed a couple of other places where this could cause issues. ### Checklist - [ ] [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 --------- Co-authored-by: Kibana Machine <[email protected]>
elastic · Jul 7, 2023 · 36e7d60 · 36e7d60
1 parent 6b52658
commit 36e7d60
Show file tree

Hide file tree

Showing 6 changed files with 154 additions and 4 deletions.
diff --git a/x-pack/plugins/fleet/common/types/models/agent.ts b/x-pack/plugins/fleet/common/types/models/agent.ts
@@ -202,7 +202,8 @@ export interface FleetServerAgentComponent {
   type: string;
   status: FleetServerAgentComponentStatus;
   message: string;
-  units: FleetServerAgentComponentUnit[];
+  // In some case units could be missing
+  units?: FleetServerAgentComponentUnit[];
 }
 
 /**

diff --git a/...nts/agent_details_page/components/agent_details/agent_details_integration_inputs.test.tsx b/...nts/agent_details_page/components/agent_details/agent_details_integration_inputs.test.tsx
@@ -106,4 +106,21 @@ describe('AgentDetailsIntegrationInputs', () => {
       component.getByTestId('agentDetailsIntegrationsInputStatusHealthSuccess')
     ).toBeInTheDocument();
   });
+
+  it('does not render when there is no units array', () => {
+    agent.components = [
+      {
+        id: 'endpoint-default',
+        type: 'endpoint',
+        status: 'HEALTHY',
+        message: 'Healthy',
+      },
+    ];
+
+    const component = renderComponent();
+    userEvent.click(component.getByTestId('agentIntegrationsInputsTitle'));
+    expect(
+      component.queryByTestId('agentDetailsIntegrationsInputStatusHealthSuccess')
+    ).not.toBeInTheDocument();
+  });
 });
diff --git a/...et/sections/agents/agent_details_page/components/agent_details/input_status_utils.test.ts b/...et/sections/agents/agent_details_page/components/agent_details/input_status_utils.test.ts
@@ -168,6 +168,13 @@ describe('getInputUnitsByPackage', () => {
         },
       ],
     },
+    // test a component with no units
+    {
+      id: 'beat/metrics-monitoring',
+      type: 'beat/metrics',
+      status: 'HEALTHY',
+      message: "Healthy: communicating with pid '2234'",
+    },
   ];
 
   const packageMock = createPackagePolicyMock();

diff --git a/...s/fleet/sections/agents/agent_details_page/components/agent_details/input_status_utils.ts b/...s/fleet/sections/agents/agent_details_page/components/agent_details/input_status_utils.ts
@@ -49,8 +49,9 @@ export const getInputUnitsByPackage = (
   packagePolicy: PackagePolicy
 ): FleetServerAgentComponentUnit[] => {
   const re = new RegExp(packagePolicy.id);
+
   return agentComponents
-    .map((c) => c.units)
+    .map((c) => c?.units || [])
     .flat()
-    .filter((u) => u.id.match(re));
+    .filter((u) => !!u && u.id.match(re));
 };
diff --git a/x-pack/plugins/fleet/server/services/agents/helpers.test.ts b/x-pack/plugins/fleet/server/services/agents/helpers.test.ts
@@ -163,4 +163,128 @@ describe('searchHitToAgent', () => {
       },
     });
   });
+
+  it('should work when units is not present', () => {
+    const hit = {
+      _source: {
+        access_api_key_id: 'EH_RlIgBn_WkCEINY-qh',
+        active: true,
+        enrolled_at: '2023-06-07T07:45:30Z',
+        local_metadata: {
+          elastic: {
+            agent: {
+              'build.original':
+                '8.9.0-SNAPSHOT (build: 953fda060f317c2389ef6fd1cac8806a2bfe92ac at 2023-05-29 14:51:32 +0000 UTC)',
+            },
+          },
+        },
+        agent: {
+          id: '504b3006-52df-46a6-b7db-f3dc67aca7ac',
+          version: '8.9.0',
+        },
+        policy_id: '76c5b020-0486-11ee-97a3-c3856dd800f7',
+        type: 'PERMANENT',
+        outputs: {
+          '68233290-0486-11ee-97a3-c3856dd800f7': {
+            api_key: 'En_RlIgBn_WkCEINb-pQ:mfeV4ji6RNGyCOBs25gteg',
+            permissions_hash: '6ac9e595a2f8cba8893f9ea1fbfb6cba4b4d6f16d935c17a6368f11ee0b0a5d8',
+            type: 'elasticsearch',
+            api_key_id: 'En_RlIgBn_WkCEINb-pQ',
+            to_retire_api_key_ids: [],
+          },
+        },
+        policy_revision_idx: 2,
+        components: [
+          {
+            id: 'system/metrics-68233290-0486-11ee-97a3-c3856dd800f7',
+            type: 'system/metrics',
+            message: "Healthy: communicating with pid '36'",
+            status: 'HEALTHY',
+          },
+        ],
+        last_checkin_message: 'Running',
+        last_checkin_status: 'online',
+        last_checkin: '2023-06-07T08:39:03Z',
+        unenrolled_at: '2023-06-07T07:45:30Z',
+        unenrollment_started_at: '2023-06-07T07:45:30Z',
+        upgraded_at: '2023-06-07T07:45:30Z',
+        upgrade_started_at: '2023-06-07T07:45:30Z',
+        default_api_key_id: 'EH_RlIgBn_WkCEINY-qh',
+        packages: ['system'],
+        tags: ['agent'],
+        user_provided_metadata: {
+          key: 'val',
+        },
+        default_api_key_history: [
+          {
+            retired_at: '',
+          },
+        ],
+      },
+      sort: [1686123930000, 'beb13bf6a73e'],
+      fields: {
+        status: ['online'],
+      },
+      _id: '504b3006-52df-46a6-b7db-f3dc67aca7ac',
+    };
+    const agent = searchHitToAgent(hit as any);
+    expect(agent).toEqual({
+      id: '504b3006-52df-46a6-b7db-f3dc67aca7ac',
+      type: 'PERMANENT',
+      active: true,
+      enrolled_at: '2023-06-07T07:45:30Z',
+      access_api_key_id: 'EH_RlIgBn_WkCEINY-qh',
+      policy_id: '76c5b020-0486-11ee-97a3-c3856dd800f7',
+      last_checkin: '2023-06-07T08:39:03Z',
+      last_checkin_status: 'online',
+      last_checkin_message: 'Running',
+      policy_revision: 2,
+      sort: [1686123930000, 'beb13bf6a73e'],
+      outputs: {
+        '68233290-0486-11ee-97a3-c3856dd800f7': {
+          api_key_id: 'En_RlIgBn_WkCEINb-pQ',
+          type: 'elasticsearch',
+          to_retire_api_key_ids: [],
+        },
+      },
+      components: [
+        {
+          id: 'system/metrics-68233290-0486-11ee-97a3-c3856dd800f7',
+          type: 'system/metrics',
+          status: 'HEALTHY',
+          message: "Healthy: communicating with pid '36'",
+          units: undefined,
+        },
+      ],
+      local_metadata: {
+        elastic: {
+          agent: {
+            'build.original':
+              '8.9.0-SNAPSHOT (build: 953fda060f317c2389ef6fd1cac8806a2bfe92ac at 2023-05-29 14:51:32 +0000 UTC)',
+          },
+        },
+      },
+      status: 'online',
+      unenrolled_at: '2023-06-07T07:45:30Z',
+      unenrollment_started_at: '2023-06-07T07:45:30Z',
+      upgraded_at: '2023-06-07T07:45:30Z',
+      upgrade_started_at: '2023-06-07T07:45:30Z',
+      default_api_key_id: 'EH_RlIgBn_WkCEINY-qh',
+      packages: ['system'],
+      tags: ['agent'],
+      user_provided_metadata: {
+        key: 'val',
+      },
+      default_api_key_history: [
+        {
+          id: undefined,
+          retired_at: '',
+        },
+      ],
+      agent: {
+        id: '504b3006-52df-46a6-b7db-f3dc67aca7ac',
+        version: '8.9.0',
+      },
+    });
+  });
 });
diff --git a/x-pack/plugins/fleet/server/services/agents/helpers.ts b/x-pack/plugins/fleet/server/services/agents/helpers.ts
@@ -47,7 +47,7 @@ export function searchHitToAgent(
         type: component.type,
         status: component.status,
         message: component.message,
-        units: component.units.map((unit) => ({
+        units: component.units?.map((unit) => ({
           id: unit.id,
           type: unit.type,
           status: unit.status,