Feature/support user channels (#13254)

* upcoming: [DI-29113] - Support for User Channel Details in Alert flows

* add changeset

* add support for new alerts object in Notification Channel

* changesets

* remove changesets

* remove unnecessary comment

---------

Co-authored-by: Ankita <ankitaan@akamai.com>

Author: santoshp210-akamai

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

@@ -282,14 +282,13 @@ export interface Alert {
   updated_by: string;
 }
 
-interface NotificationChannelAlerts {
-  id: number;
-  label: string;
+interface NotificationChannelAlertInfo {
+  alert_count: number;
   type: 'alerts-definitions';
   url: string;
 }
 interface NotificationChannelBase {
-  alerts: NotificationChannelAlerts[];
+  alerts: NotificationChannelAlertInfo;
   channel_type: ChannelType;
   created: string;
   created_by: string;

packages/manager/cypress/e2e/core/cloudpulse/alert-notification-channel-list.spec.ts

@@ -41,12 +41,11 @@ const notificationChannels = notificationChannelFactory
   .buildList(26)
   .map((ch, i) => {
     const isEmail = i % 2 === 0;
-    const alerts = Array.from({ length: isEmail ? 5 : 3 }).map((_, idx) => ({
-      id: idx + 1,
-      label: `Alert-${idx + 1}`,
+    const alerts = {
+      alert_count: isEmail ? 5 : 3,
+      url: `monitor/alert-channels/${i + 1}/alerts`,
       type: 'alerts-definitions',
-      url: 'Sample',
-    }));
+    };
 
     if (isEmail) {
       return {
@@ -147,7 +146,7 @@ const VerifyChannelSortingParams = (
   );
 
   const order = sortOrderMap[sortOrder];
-  const orderBy = LabelLookup[columnLabel];
+  const orderBy = encodeURIComponent(LabelLookup[columnLabel]);
 
   cy.url().should(
     'endWith',
@@ -215,16 +214,7 @@ describe('Notification Channel Listing Page', () => {
         }
 
         // Alerts list
-        expect(item.alerts.length).to.eq(expected.alerts.length);
-
-        item.alerts.forEach((alert, aIndex) => {
-          const expAlert = expected.alerts[aIndex];
-
-          expect(alert.id).to.eq(expAlert.id);
-          expect(alert.label).to.eq(expAlert.label);
-          expect(alert.type).to.eq(expAlert.type);
-          expect(alert.url).to.eq(expAlert.url);
-        });
+        expect(item.alerts.alert_count).to.eq(expected.alerts.alert_count);
       });
     });
   });
@@ -254,7 +244,9 @@ describe('Notification Channel Listing Page', () => {
 
           cy.wrap($row).within(() => {
             cy.findByText(expected.label).should('be.visible');
-            cy.findByText(String(expected.alerts.length)).should('be.visible');
+            cy.findByText(String(expected.alerts.alert_count)).should(
+              'be.visible'
+            );
             cy.findByText('Email').should('be.visible');
             cy.get('td').eq(3).should('have.text', expected.created_by);
             cy.findByText(
@@ -284,11 +276,11 @@ describe('Notification Channel Listing Page', () => {
       {
         column: 'Alerts',
         ascending: [...notificationChannels]
-          .sort((a, b) => a.alerts.length - b.alerts.length)
+          .sort((a, b) => a.alerts.alert_count - b.alerts.alert_count)
           .map((ch) => ch.id),
 
         descending: [...notificationChannels]
-          .sort((a, b) => b.alerts.length - a.alerts.length)
+          .sort((a, b) => b.alerts.alert_count - a.alerts.alert_count)
           .map((ch) => ch.id),
       },
 

packages/manager/src/factories/cloudpulse/channels.ts

@@ -4,14 +4,11 @@ import type { NotificationChannel } from '@linode/api-v4';
 
 export const notificationChannelFactory =
   Factory.Sync.makeFactory<NotificationChannel>({
-    alerts: [
-      {
-        id: Number(Factory.each((i) => i)),
-        label: String(Factory.each((id) => `Alert-${id}`)),
-        type: 'alerts-definitions',
-        url: 'Sample',
-      },
-    ],
+    alerts: {
+      type: 'alerts-definitions',
+      alert_count: 1,
+      url: 'monitor/alert-channels/{id}/alerts',
+    },
     channel_type: 'email',
     content: {
       email: {

packages/manager/src/features/CloudPulse/Alerts/CreateAlert/NotificationChannels/RenderChannelDetails.test.tsx

@@ -1,3 +1,4 @@
+import { screen } from '@testing-library/react';
 import * as React from 'react';
 
 import { notificationChannelFactory } from 'src/factories/cloudpulse/channels';
@@ -21,4 +22,21 @@ describe('RenderChannelDetails component', () => {
     expect(container.getByText(emailAddresses[0])).toBeVisible();
     expect(container.getByText(emailAddresses[1])).toBeVisible();
   });
+  it('should render the email channel with usernames if details is present', () => {
+    const usernames = ['user1', 'user2'];
+    const mockDataWithDetails: NotificationChannel =
+      notificationChannelFactory.build({
+        channel_type: 'email',
+        content: {},
+        details: {
+          email: {
+            usernames,
+            recipient_type: 'user',
+          },
+        },
+      });
+    renderWithTheme(<RenderChannelDetails template={mockDataWithDetails} />);
+    expect(screen.getByText(usernames[0])).toBeVisible();
+    expect(screen.getByText(usernames[1])).toBeVisible();
+  });
 });

packages/manager/src/features/CloudPulse/Alerts/CreateAlert/NotificationChannels/RenderChannelDetails.tsx

@@ -1,6 +1,8 @@
 import { Chip } from '@mui/material';
 import * as React from 'react';
 
+import { shouldUseContentsForEmail } from '../../Utils/utils';
+
 import type { NotificationChannel } from '@linode/api-v4';
 
 interface RenderChannelDetailProps {
@@ -12,9 +14,21 @@ interface RenderChannelDetailProps {
 export const RenderChannelDetails = (props: RenderChannelDetailProps) => {
   const { template } = props;
   if (template.channel_type === 'email') {
-    return template.content?.email.email_addresses.map((value, index) => (
-      <Chip key={index} label={value} />
-    ));
+    const contentEmail = template.content?.email;
+    const detailEmail = template.details?.email;
+    const useContents = shouldUseContentsForEmail(template);
+
+    const recipients = useContents
+      ? (contentEmail?.email_addresses ?? [])
+      : (detailEmail?.usernames ?? []);
+
+    return (
+      <>
+        {recipients.map((value) => (
+          <Chip key={value} label={value} />
+        ))}
+      </>
+    );
   }
   return null;
 };

packages/manager/src/features/CloudPulse/Alerts/NotificationChannels/NotificationsChannelsListing/NotificationChannelListTable.test.tsx

@@ -10,8 +10,6 @@ import { NotificationChannelListTable } from './NotificationChannelListTable';
 
 const mockScrollToElement = vi.fn();
 
-const ALERT_TYPE = 'alerts-definitions';
-
 describe('NotificationChannelListTable', () => {
   it('should render the notification channel table headers', () => {
     renderWithTheme(
@@ -127,11 +125,7 @@ describe('NotificationChannelListTable', () => {
 
   it('should display correct alerts count', () => {
     const channel = notificationChannelFactory.build({
-      alerts: [
-        { id: 1, label: 'Alert 1', type: ALERT_TYPE, url: 'url1' },
-        { id: 2, label: 'Alert 2', type: ALERT_TYPE, url: 'url2' },
-        { id: 3, label: 'Alert 3', type: ALERT_TYPE, url: 'url3' },
-      ],
+      alerts: { alert_count: 3 },
     });
 
     renderWithTheme(

packages/manager/src/features/CloudPulse/Alerts/NotificationChannels/NotificationsChannelsListing/NotificationChannelTableRow.test.tsx

@@ -18,10 +18,11 @@ describe('NotificationChannelTableRow', () => {
   it('should render a notification channel row with all fields', () => {
     const updated = new Date().toISOString();
     const channel = notificationChannelFactory.build({
-      alerts: [
-        { id: 1, label: 'Alert 1', type: 'alerts-definitions', url: 'url1' },
-        { id: 2, label: 'Alert 2', type: 'alerts-definitions', url: 'url2' },
-      ],
+      alerts: {
+        type: 'alerts-definitions',
+        alert_count: 2,
+        url: 'monitor/alert-channels/{id}/alerts',
+      },
       channel_type: 'email',
       created_by: 'user1',
       label: 'Test Channel',
@@ -142,7 +143,7 @@ describe('NotificationChannelTableRow', () => {
 
   it('should render zero alerts count when no alerts are associated', () => {
     const channel = notificationChannelFactory.build({
-      alerts: [],
+      alerts: { alert_count: 0 },
     });
 
     renderWithTheme(

packages/manager/src/features/CloudPulse/Alerts/NotificationChannels/NotificationsChannelsListing/NotificationChannelTableRow.tsx

@@ -52,7 +52,7 @@ export const NotificationChannelTableRow = (
           {label}
         </Link>
       </TableCell>
-      <TableCell>{alerts.length}</TableCell>
+      <TableCell>{alerts.alert_count}</TableCell>
       <TableCell>{channelTypeMap[channel_type]}</TableCell>
       <TableCell>{created_by}</TableCell>
       <TableCell>

packages/manager/src/features/CloudPulse/Alerts/NotificationChannels/NotificationsChannelsListing/constants.ts

@@ -2,7 +2,7 @@ import type { NotificationChannel } from '@linode/api-v4';
 
 type ChannelListingTableLabel = {
   colName: string;
-  label: keyof NotificationChannel;
+  label: `${keyof NotificationChannel}:${string}` | keyof NotificationChannel;
 };
 
 export const ChannelListingTableLabelMap: ChannelListingTableLabel[] = [
@@ -12,7 +12,7 @@ export const ChannelListingTableLabelMap: ChannelListingTableLabel[] = [
   },
   {
     colName: 'Alerts',
-    label: 'alerts',
+    label: 'alerts:alert_count',
   },
   {
     colName: 'Channel Type',

packages/manager/src/features/CloudPulse/Alerts/Utils/utils.test.ts

@@ -1,7 +1,7 @@
 import { regionFactory } from '@linode/utilities';
 import { act, renderHook } from '@testing-library/react';
 
-import { alertFactory, serviceTypesFactory } from 'src/factories';
+import { alertFactory, notificationChannelFactory, serviceTypesFactory } from 'src/factories';
 
 import { useContextualAlertsState } from '../../Utils/utils';
 import { transformDimensionValue } from '../CreateAlert/Criteria/DimensionFilterValue/utils';
@@ -17,6 +17,7 @@ import {
   getSchemaWithEntityIdValidation,
   getServiceTypeLabel,
   handleMultipleError,
+  shouldUseContentsForEmail,
 } from './utils';
 
 import type { AlertValidationSchemaProps } from './utils';
@@ -497,3 +498,60 @@ describe('transformDimensionValue', () => {
     ).toBe('Test_value');
   });
 });
+
+describe('shouldUseContentsForEmail', () => {
+  it('should return false for email channel with valid usernames in details', () => {
+    const notificationChannel = notificationChannelFactory.build({
+      channel_type: 'email',
+      details: {
+        email: {
+          usernames: ['user1', 'user2'],
+        },
+      },
+    });
+    expect(shouldUseContentsForEmail(notificationChannel)).toBe(false);
+  });
+
+  it('should return true for email channel with undefined details', () => {
+    const notificationChannel = notificationChannelFactory.build({
+      channel_type: 'email',
+      details: undefined,
+    });
+    expect(shouldUseContentsForEmail(notificationChannel)).toBe(true);
+  });
+
+  it('should return true for email channel with undefined details.email', () => {
+    const notificationChannel = notificationChannelFactory.build({
+      channel_type: 'email',
+      details: {
+        email: undefined,
+      },
+    });
+    expect(shouldUseContentsForEmail(notificationChannel)).toBe(true);
+  });
+
+  it('should return true for email channel with undefined usernames', () => {
+    const notificationChannel = notificationChannelFactory.build({
+      channel_type: 'email',
+      details: {
+        email: {
+          usernames: undefined,
+        },
+      },
+    });
+    expect(shouldUseContentsForEmail(notificationChannel)).toBe(true);
+  });
+
+  it('should return true for email channel with empty usernames array', () => {
+    const notificationChannel = notificationChannelFactory.build({
+      channel_type: 'email',
+      details: {
+        email: {
+          usernames: [],
+          recipient_type: 'admin_users',
+        },
+      },
+    });
+    expect(shouldUseContentsForEmail(notificationChannel)).toBe(true);
+  });
+});