refactor: [DI-26682] - Added a single type to all service type properties (linode#12646)

* refactor: [DI-26359] - Update the code to type safe for CloudPulseSerivceType for all service type properties

* refactor: [DI-26359] - Updated types & constant

* refactor: [DI-26359] - Updated typechecks

* refactor: [DI-26359] - Updated placeholder condition

* refactor: [DI-26359] - Updated test case

* refactor: [DI-26359] - Updated typecheck failures

* Updated failing tests

* refactor: [DI-26359] - Updated type

* Added changeset

* Fixed failing test cases

* Fixed lint issue

Author: nikhagra-akamai

packages/api-v4/.changeset/pr-12646-added-1754491697126.md

@@ -0,0 +1,5 @@
+---
+"@linode/api-v4": Added
+---
+
+ACLP: `CloudPulseServiceType` type for type safety across cloudpulse  ([#12646](https://github.com/linode/manager/pull/12646))

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

@@ -15,7 +15,6 @@ import Request, {
 import type { Filter, Params, ResourcePage } from '../types';
 import type {
   Alert,
-  AlertServiceType,
   CloudPulseAlertsPayload,
   CreateAlertDefinitionPayload,
   EditAlertDefinitionPayload,
@@ -24,7 +23,7 @@ import type {
 
 export const createAlertDefinition = (
   data: CreateAlertDefinitionPayload,
-  serviceType: AlertServiceType,
+  serviceType: string,
 ) =>
   Request<Alert>(
     setURL(

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

@@ -3,12 +3,12 @@ import type { AccountCapability } from 'src/account';
 export type AlertSeverityType = 0 | 1 | 2 | 3;
 export type MetricAggregationType = 'avg' | 'count' | 'max' | 'min' | 'sum';
 export type MetricOperatorType = 'eq' | 'gt' | 'gte' | 'lt' | 'lte';
-export type AlertServiceType = 'dbaas' | 'firewall' | 'linode' | 'nodebalancer';
-export type MetricsServiceType =
+export type CloudPulseServiceType =
   | 'dbaas'
   | 'firewall'
   | 'linode'
   | 'nodebalancer';
+
 export type AlertClass = 'dedicated' | 'shared';
 export type DimensionFilterOperatorType =
   | 'endswith'
@@ -41,7 +41,7 @@ export interface Dashboard {
   created: string;
   id: number;
   label: string;
-  service_type: string;
+  service_type: CloudPulseServiceType;
   time_duration: TimeDuration;
   updated: string;
   widgets: Widgets[];
@@ -76,8 +76,8 @@ export interface Widgets {
   metric: string;
   namespace_id: number;
   region_id: number;
-  service_type: string;
-  serviceType: string;
+  service_type: CloudPulseServiceType;
+  serviceType: CloudPulseServiceType;
   size: number;
   time_duration: TimeDuration;
   time_granularity: TimeGranularity;
@@ -183,7 +183,7 @@ export interface Service {
   alert: ServiceAlert;
   label: string;
   regions: string;
-  service_type: string;
+  service_type: CloudPulseServiceType;
 }
 
 export interface ServiceTypesList {
@@ -252,7 +252,7 @@ export interface Alert {
     rules: AlertDefinitionMetricCriteria[];
   };
   scope: AlertDefinitionScope;
-  service_type: AlertServiceType;
+  service_type: CloudPulseServiceType;
   severity: AlertSeverityType;
   status: AlertStatusType;
   tags: string[];
@@ -349,7 +349,7 @@ export interface EditAlertDefinitionPayload {
 export interface EditAlertPayloadWithService
   extends EditAlertDefinitionPayload {
   alertId: number;
-  serviceType: string;
+  serviceType: CloudPulseServiceType;
 }
 
 export type AlertStatusUpdateType = 'Disable' | 'Enable';
@@ -361,11 +361,11 @@ export interface EntityAlertUpdatePayload {
 
 export interface DeleteAlertPayload {
   alertId: number;
-  serviceType: string;
+  serviceType: CloudPulseServiceType;
 }
 
 export const capabilityServiceTypeMapping: Record<
-  AlertServiceType | MetricsServiceType | string,
+  CloudPulseServiceType,
   AccountCapability
 > = {
   linode: 'Linodes',

packages/manager/.changeset/pr-12646-changed-1754491732064.md

@@ -0,0 +1,5 @@
+---
+"@linode/manager": Changed
+---
+
+ACLP: all the instances of service type property has `CloudPulseServiceType` type ([#12646](https://github.com/linode/manager/pull/12646))

packages/manager/cypress/e2e/core/cloudpulse/alerts-listing-page.spec.ts

@@ -28,7 +28,11 @@ import {
 } from 'src/features/CloudPulse/Alerts/constants';
 import { formatDate } from 'src/utilities/formatDate';
 
-import type { Alert, AlertServiceType, AlertStatusType } from '@linode/api-v4';
+import type {
+  Alert,
+  AlertStatusType,
+  CloudPulseServiceType,
+} from '@linode/api-v4';
 import type { Flags } from 'src/featureFlags';
 const alertDefinitionsUrl = '/alerts/definitions';
 
@@ -111,7 +115,7 @@ const statusList: AlertStatusType[] = [
   'in progress',
   'failed',
 ];
-const serviceTypes: AlertServiceType[] = ['linode', 'dbaas'];
+const serviceTypes: CloudPulseServiceType[] = ['linode', 'dbaas'];
 
 /**
  * @description

packages/manager/cypress/e2e/core/cloudpulse/cloudpulse-dashboard-errors.spec.ts

@@ -63,16 +63,9 @@ const flags: Partial<Flags> = {
     },
   ],
 };
-const {
-  clusterName,
-  dashboardName,
-  engine,
-  id,
-  metrics,
-  nodeType,
-  serviceType,
-} = widgetDetails.dbaas;
-
+const { clusterName, dashboardName, engine, id, metrics, nodeType } =
+  widgetDetails.dbaas;
+const serviceType = 'dbaas';
 const dashboard = dashboardFactory.build({
   label: dashboardName,
   service_type: serviceType,

packages/manager/cypress/e2e/core/cloudpulse/create-user-alert.spec.ts

@@ -67,7 +67,8 @@ const mockRegions = [
     },
   }),
 ];
-const { metrics, serviceType } = widgetDetails.dbaas;
+const { metrics } = widgetDetails.dbaas;
+const serviceType = 'dbaas';
 const databaseMock = databaseFactory.buildList(10, {
   cluster_size: 3,
   engine: 'mysql',

packages/manager/cypress/e2e/core/cloudpulse/dbaas-widgets-verification.spec.ts

@@ -72,16 +72,9 @@ const flags: Partial<Flags> = {
   ],
 };
 
-const {
-  clusterName,
-  dashboardName,
-  engine,
-  id,
-  metrics,
-  nodeType,
-  serviceType,
-} = widgetDetails.dbaas;
-
+const { clusterName, dashboardName, engine, id, metrics, nodeType } =
+  widgetDetails.dbaas;
+const serviceType = 'dbaas';
 const dashboard = dashboardFactory.build({
   label: dashboardName,
   service_type: serviceType,

packages/manager/cypress/e2e/core/cloudpulse/groupby-tags.spec.ts

@@ -15,7 +15,11 @@ import { ui } from 'support/ui';
 
 import { accountFactory, alertFactory } from 'src/factories';
 
-import type { Alert, AlertServiceType, AlertStatusType } from '@linode/api-v4';
+import type {
+  Alert,
+  AlertStatusType,
+  CloudPulseServiceType,
+} from '@linode/api-v4';
 import type { Flags } from 'src/featureFlags';
 
 const flags: Partial<Flags> = { aclp: { beta: true, enabled: true } };
@@ -27,7 +31,7 @@ const statusList: AlertStatusType[] = [
   'in progress',
   'failed',
 ];
-const serviceTypes: AlertServiceType[] = ['linode', 'dbaas'];
+const serviceTypes: CloudPulseServiceType[] = ['linode', 'dbaas'];
 const tagSequence = ['LinodeTags', 'DBaaSTags', 'bothTags', 'No Tags'];
 
 // Generate mock alerts with a mix of tags, statuses, and service types

packages/manager/cypress/e2e/core/cloudpulse/linode-widget-verification.spec.ts

@@ -61,9 +61,8 @@ const flags: Partial<Flags> = {
     },
   ],
 };
-const { dashboardName, id, metrics, region, resource, serviceType } =
-  widgetDetails.linode;
-
+const { dashboardName, id, metrics, region, resource } = widgetDetails.linode;
+const serviceType = 'linode';
 const dashboard = dashboardFactory.build({
   label: dashboardName,
   service_type: serviceType,