feat: [M3-7487] - Add AGLB Endpoint Health

packages/api-v4/.changeset/pr-10008-added-1704919102710.md

@@ -0,0 +1,5 @@
+---
+"@linode/api-v4": Added
+---
+
+AGLB endpoint health endpoints ([#10008](https://github.com/linode/manager/pull/10008))

packages/api-v4/src/aglb/configurations.ts

@@ -10,6 +10,7 @@ import { BETA_API_ROOT } from '../constants';
 import type {
   Configuration,
   ConfigurationPayload,
+  ConfigurationsEndpointHealth,
   UpdateConfigurationPayload,
 } from './types';
 import {
@@ -56,6 +57,23 @@ export const getLoadbalancerConfiguration = (
     setMethod('GET')
   );
 
+/**
+ * getLoadbalancerConfigurationsEndpointHealth
+ *
+ * Returns endpoint health for an Akamai Global Load Balancer configuration
+ */
+export const getLoadbalancerConfigurationsEndpointHealth = (
+  loadbalancerId: number
+) =>
+  Request<ConfigurationsEndpointHealth>(
+    setURL(
+      `${BETA_API_ROOT}/aglb/${encodeURIComponent(
+        loadbalancerId
+      )}/configurations/endpoints-health`
+    ),
+    setMethod('GET')
+  );
+
 /**
  * createLoadbalancerConfiguration
  *

packages/api-v4/src/aglb/loadbalancers.ts

@@ -10,6 +10,7 @@ import { Filter, Params, ResourcePage } from '../types';
 import type {
   CreateBasicLoadbalancerPayload,
   CreateLoadbalancerPayload,
+  LoadBalancerEndpointHealth,
   Loadbalancer,
   UpdateLoadbalancerPayload,
 } from './types';
@@ -39,6 +40,17 @@ export const getLoadbalancer = (id: number) =>
     setMethod('GET')
   );
 
+/**
+ * getLoadbalancerEndpointHealth
+ *
+ * Returns the general endpoint health of an Akamai Global Load Balancer
+ */
+export const getLoadbalancerEndpointHealth = (id: number) =>
+  Request<LoadBalancerEndpointHealth>(
+    setURL(`${BETA_API_ROOT}/aglb/${encodeURIComponent(id)}/endpoints-health`),
+    setMethod('GET')
+  );
+
 /**
  * createLoadbalancer
  *

packages/api-v4/src/aglb/service-targets.ts

@@ -7,7 +7,11 @@ import Request, {
 } from '../request';
 import { Filter, Params, ResourcePage } from '../types';
 import { BETA_API_ROOT } from '../constants';
-import type { ServiceTarget, ServiceTargetPayload } from './types';
+import type {
+  ServiceTarget,
+  ServiceTargetPayload,
+  ServiceTargetsEndpointHealth,
+} from './types';
 import {
   CreateServiceTargetSchema,
   UpdateServiceTargetSchema,
@@ -52,6 +56,21 @@ export const getServiceTarget = (
     setMethod('GET')
   );
 
+/**
+ * getServiceTargetsEndpointHealth
+ *
+ * Returns endpoint health data for each service targets on an Akamai Global Load Balancer
+ */
+export const getServiceTargetsEndpointHealth = (loadbalancerId: number) =>
+  Request<ServiceTargetsEndpointHealth>(
+    setURL(
+      `${BETA_API_ROOT}/aglb/${encodeURIComponent(
+        loadbalancerId
+      )}/service-targets/endpoints-health`
+    ),
+    setMethod('GET')
+  );
+
 /**
  * createLoadbalancerServiceTarget
  *

packages/api-v4/src/aglb/types.ts

@@ -201,3 +201,42 @@ export interface UpdateCertificatePayload {
   label?: string;
   type?: CertificateType;
 }
+
+export interface LoadBalancerEndpointHealth {
+  id: number;
+  healthy_endpoints: number;
+  total_endpoints: number;
+  timestamp: string;
+}
+
+export interface EndpointHealth {
+  id: number;
+  label: string;
+  url: string;
+  type: string;
+  healthy_endpoints: number;
+  total_endpoints: number;
+  timestamp: string;
+}
+
+export interface ConfigurationsEndpointHealth {
+  /**
+   * The id of the AGLB
+   */
+  id: number;
+  /**
+   * An array of health data for each configuration on the AGLB
+   */
+  configurations: EndpointHealth[];
+}
+
+export interface ServiceTargetsEndpointHealth {
+  /**
+   * The id of the AGLB
+   */
+  id: number;
+  /**
+   * An array of health data for each service target on the AGLB
+   */
+  service_targets: EndpointHealth[];
+}

packages/manager/.changeset/pr-10008-upcoming-features-1704919046550.md

@@ -0,0 +1,5 @@
+---
+"@linode/manager": Upcoming Features
+---
+
+Added AGLB Endpoint Health ([#10008](https://github.com/linode/manager/pull/10008))

packages/manager/src/factories/aglb.ts

@@ -1,14 +1,18 @@
 import {
   Certificate,
   Configuration,
+  ConfigurationsEndpointHealth,
   CreateCertificatePayload,
   CreateLoadbalancerPayload,
   CreateRoutePayload,
   Endpoint,
+  EndpointHealth,
+  LoadBalancerEndpointHealth,
   Loadbalancer,
   Route,
   ServiceTarget,
   ServiceTargetPayload,
+  ServiceTargetsEndpointHealth,
   UpdateLoadbalancerPayload,
 } from '@linode/api-v4/lib/aglb/types';
 import * as Factory from 'factory.ts';
@@ -337,3 +341,36 @@ export const endpointFactory = Factory.Sync.makeFactory<Endpoint>({
   port: 80,
   rate_capacity: 10_000,
 });
+
+export const loadbalancerEndpointHealthFactory = Factory.Sync.makeFactory<LoadBalancerEndpointHealth>(
+  {
+    healthy_endpoints: 4,
+    id: Factory.each((i) => i),
+    timestamp: '2020-01-31T12:00:00',
+    total_endpoints: 6,
+  }
+);
+
+export const endpointHealthFactory = Factory.Sync.makeFactory<EndpointHealth>({
+  healthy_endpoints: 4,
+  id: Factory.each((i) => i),
+  label: Factory.each((i) => `endpoint-${i}`),
+  timestamp: '2020-01-31T12:00:00',
+  total_endpoints: 6,
+  type: '',
+  url: '',
+});
+
+export const configurationsEndpointHealthFactory = Factory.Sync.makeFactory<ConfigurationsEndpointHealth>(
+  {
+    configurations: endpointHealthFactory.buildList(5),
+    id: Factory.each((i) => i),
+  }
+);
+
+export const serviceTargetsEndpointHealthFactory = Factory.Sync.makeFactory<ServiceTargetsEndpointHealth>(
+  {
+    id: Factory.each((i) => i),
+    service_targets: endpointHealthFactory.buildList(5),
+  }
+);

packages/manager/src/features/LoadBalancers/LoadBalancerDetail/Configurations/ConfigurationAccordion.tsx

@@ -14,12 +14,20 @@ interface Props {
 
 export const ConfigurationAccordion = (props: Props) => {
   const { configuration } = props;
-  const { configurationId } = useParams<{ configurationId: string }>();
+  const { configurationId, loadbalancerId } = useParams<{
+    configurationId: string;
+    loadbalancerId: string;
+  }>();
 
   return (
     <Accordion
+      heading={
+        <ConfigurationAccordionHeader
+          configuration={configuration}
+          loadbalancerId={Number(loadbalancerId)}
+        />
+      }
       defaultExpanded={configuration.id === Number(configurationId)}
-      heading={<ConfigurationAccordionHeader configuration={configuration} />}
       headingProps={{ sx: { width: '100%' } }}
     >
       <ConfigurationForm configuration={configuration} mode="edit" />

packages/manager/src/features/LoadBalancers/LoadBalancerDetail/Configurations/ConfigurationAccordionHeader.test.tsx

@@ -0,0 +1,73 @@
+import React from 'react';
+
+import {
+  configurationFactory,
+  configurationsEndpointHealthFactory,
+  endpointHealthFactory,
+} from 'src/factories';
+import { rest, server } from 'src/mocks/testServer';
+import { renderWithTheme } from 'src/utilities/testHelpers';
+
+import { ConfigurationAccordionHeader } from './ConfigurationAccordionHeader';
+
+describe('ConfigurationAccordionHeader', () => {
+  it('renders configuration information', () => {
+    const configuration = configurationFactory.build({ routes: [] });
+
+    const { getByText } = renderWithTheme(
+      <ConfigurationAccordionHeader
+        configuration={configuration}
+        loadbalancerId={0}
+      />
+    );
+
+    // Label
+    expect(getByText(configuration.label)).toBeVisible();
+
+    // ID
+    expect(getByText(`ID: ${configuration.id}`)).toBeVisible();
+
+    // Port
+    expect(
+      getByText(`Port ${configuration.port}`, { exact: false })
+    ).toBeVisible();
+
+    // Number of Routes
+    expect(getByText('0 Routes', { exact: false })).toBeVisible();
+  });
+
+  it('renders endpoint health for a configuration', async () => {
+    const configuration = configurationFactory.build({ routes: [] });
+
+    const configurationHealth = endpointHealthFactory.build({
+      healthy_endpoints: 5,
+      id: configuration.id,
+      total_endpoints: 9,
+    });
+
+    const allConfigurationsEndpointHealth = configurationsEndpointHealthFactory.build(
+      {
+        configurations: [configurationHealth],
+        id: 5,
+      }
+    );
+
+    server.use(
+      rest.get(
+        '*/v4beta/aglb/5/configurations/endpoints-health',
+        (req, res, ctx) => res(ctx.json(allConfigurationsEndpointHealth))
+      )
+    );
+
+    const { findByText } = renderWithTheme(
+      <ConfigurationAccordionHeader
+        configuration={configuration}
+        loadbalancerId={5}
+      />
+    );
+
+    await findByText('5 up');
+
+    await findByText('4 down'); // 9 - 5
+  });
+});

packages/manager/src/features/LoadBalancers/LoadBalancerDetail/Configurations/ConfigurationAccordionHeader.tsx

@@ -2,15 +2,24 @@ import React from 'react';
 
 import { Stack } from 'src/components/Stack';
 import { Typography } from 'src/components/Typography';
+import { useLoadBalancerConfigurationsEndpointsHealth } from 'src/queries/aglb/configurations';
 import { pluralize } from 'src/utilities/pluralize';
 
+import { EndpointHealth } from '../EndpointHealth';
+
 import type { Configuration } from '@linode/api-v4';
 
 interface Props {
   configuration: Configuration;
+  loadbalancerId: number;
 }
 
-export const ConfigurationAccordionHeader = ({ configuration }: Props) => {
+export const ConfigurationAccordionHeader = (props: Props) => {
+  const { configuration, loadbalancerId } = props;
+  const { data } = useLoadBalancerConfigurationsEndpointsHealth(loadbalancerId);
+
+  const health = data?.configurations.find((c) => c.id === configuration.id);
+
   return (
     <Stack
       alignItems="center"
@@ -28,7 +37,18 @@ export const ConfigurationAccordionHeader = ({ configuration }: Props) => {
           {pluralize('Route', 'Routes', configuration.routes.length)}
         </Typography>
       </Stack>
-      <Typography>ID: {configuration.id}</Typography>
+      <Stack direction="row" spacing={2}>
+        <Stack direction="row" spacing={1}>
+          <Typography>Endpoints:</Typography>
+          {health && (
+            <EndpointHealth
+              down={health.total_endpoints - health.healthy_endpoints}
+              up={health.healthy_endpoints}
+            />
+          )}
+        </Stack>
+        <Typography>ID: {configuration.id}</Typography>
+      </Stack>
     </Stack>
   );
 };

packages/manager/src/features/LoadBalancers/LoadBalancerDetail/EndpointHealth.test.tsx

@@ -0,0 +1,51 @@
+import React from 'react';
+
+import { renderWithTheme } from 'src/utilities/testHelpers';
+
+import { EndpointHealth } from './EndpointHealth';
+
+describe('EndpointHealth', () => {
+  it('renders endpoints that are up and down', () => {
+    const { getByText } = renderWithTheme(<EndpointHealth down={0} up={0} />);
+
+    expect(getByText('0 up')).toBeVisible();
+    expect(getByText('0 down')).toBeVisible();
+  });
+  it('renders endpoints that are up and down', () => {
+    const { getByLabelText, getByText } = renderWithTheme(
+      <EndpointHealth down={6} up={18} />,
+      { theme: 'light' }
+    );
+
+    const upStatusIcon = getByLabelText('Status is active');
+    const downStatusIcon = getByLabelText('Status is error');
+
+    expect(upStatusIcon).toHaveStyle({ backgroundColor: '#17cf73' });
+    expect(downStatusIcon).toHaveStyle({ backgroundColor: '#ca0813' });
+
+    expect(getByText('18 up')).toBeVisible();
+    expect(getByText('6 down')).toBeVisible();
+  });
+  it('should render gray when the "down" number is zero', () => {
+    const { getByLabelText, getByText } = renderWithTheme(
+      <EndpointHealth down={0} up={18} />
+    );
+
+    const statusIcon = getByLabelText('Status is inactive');
+
+    expect(statusIcon).toBeVisible();
+    expect(statusIcon).toHaveStyle({ backgroundColor: '#dbdde1' });
+    expect(getByText('0 down')).toBeVisible();
+  });
+  it('should render gray when the "up" number is zero', () => {
+    const { getByLabelText, getByText } = renderWithTheme(
+      <EndpointHealth down={8} up={0} />
+    );
+
+    const statusIcon = getByLabelText('Status is inactive');
+
+    expect(statusIcon).toBeVisible();
+    expect(statusIcon).toHaveStyle({ backgroundColor: '#dbdde1' });
+    expect(getByText('0 up')).toBeVisible();
+  });
+});