upcoming: [DI-27569] - Integrate endpoints dashboard for object-storage service in CloudPulse Metrics (#13133)

* upcoming: [DI-27569] - Integrate endpoints dashboard for object-storage service

* upcoming: [DI-27569] - Update endpoints config for buckets dashboard

* upcoming: [DI-27569] - add util for dashboard type identification, simplify props

* upcoming: [DI-27569] - Add dimensionkey for endpoints filter in endpoints config

* upcoming: [DI-27569] - Cleanup

* upcoming: [DI-27569] - Simplify props

* upcoming: [DI-27569] - Move computations outside

* upcoming: [DI-27569] - Fix group_by bug

* upcoming: [DI-27569] - Update imports

* upcoming: [DI-27569] - Move test case

* upcoming: [DI-27569] - Add changesets

* upcoming: [DI-27569] - Simplify

Author: ankita-akamai

packages/api-v4/.changeset/pr-13133-upcoming-features-1764084018326.md

@@ -0,0 +1,5 @@
+---
+"@linode/api-v4": Upcoming Features
+---
+
+CloudPulse-Metrics: Update `entity_ids` type in `CloudPulseMetricsRequest` for metrics api in endpoints dahsboard ([#13133](https://github.com/linode/manager/pull/13133))

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

@@ -159,7 +159,7 @@ export interface Metric {
 export interface CloudPulseMetricsRequest {
   absolute_time_duration: DateTimeWithPreset | undefined;
   associated_entity_region?: string;
-  entity_ids: number[] | string[];
+  entity_ids: number[] | string[] | undefined;
   entity_region?: string;
   filters?: Filters[];
   group_by?: string[];

packages/manager/.changeset/pr-13133-upcoming-features-1764084041956.md

@@ -0,0 +1,5 @@
+---
+"@linode/manager": Upcoming Features
+---
+
+CloudPulse-Metrics: Update `FilterConfig.ts` to handle integration of endpoints dashboard for object-storage service in metrics page([#13133](https://github.com/linode/manager/pull/13133))

packages/manager/src/features/CloudPulse/Dashboard/CloudPulseDashboard.tsx

@@ -150,7 +150,7 @@ export const CloudPulseDashboard = (props: DashboardProperties) => {
   } = useCloudPulseJWEtokenQuery(
     dashboard?.service_type,
     getJweTokenPayload(),
-    Boolean(resources) && !isDashboardLoading && !isDashboardApiError
+    !isDashboardLoading && !isDashboardApiError
   );
 
   if (isDashboardApiError) {

packages/manager/src/features/CloudPulse/GroupBy/utils.test.ts

@@ -87,7 +87,7 @@ describe('useGlobalDimensions method test', () => {
 
   it('should return non-empty options and defaultValue if no common dimensions', () => {
     queryMocks.useCloudPulseDashboardByIdQuery.mockReturnValue({
-      data: dashboardFactory.build(),
+      data: dashboardFactory.build({ id: 1 }),
       isLoading: false,
     });
     queryMocks.useGetCloudPulseMetricDefinitionsByServiceType.mockReturnValue({
@@ -106,7 +106,7 @@ describe('useGlobalDimensions method test', () => {
 
   it('should return non-empty options and defaultValue from preferences', () => {
     queryMocks.useCloudPulseDashboardByIdQuery.mockReturnValue({
-      data: dashboardFactory.build(),
+      data: dashboardFactory.build({ id: 1 }),
       isLoading: false,
     });
     queryMocks.useGetCloudPulseMetricDefinitionsByServiceType.mockReturnValue({
@@ -123,6 +123,22 @@ describe('useGlobalDimensions method test', () => {
       isLoading: false,
     });
   });
+
+  it('should not return default option in case of endpoints-only dashboard', () => {
+    queryMocks.useCloudPulseDashboardByIdQuery.mockReturnValue({
+      data: dashboardFactory.build({ id: 10 }),
+      isLoading: false,
+    });
+    queryMocks.useGetCloudPulseMetricDefinitionsByServiceType.mockReturnValue({
+      data: {
+        data: metricDefinitions,
+      },
+      isLoading: false,
+    });
+    const result = useGlobalDimensions(10, 'objectstorage');
+    // Verify if options contain the default option - 'entityId' or not
+    expect(result.options).toEqual([{ label: 'Dim 2', value: 'Dim 2' }]);
+  });
 });
 
 describe('useWidgetDimension method test', () => {

packages/manager/src/features/CloudPulse/GroupBy/utils.ts

@@ -2,7 +2,10 @@ import { useCloudPulseDashboardByIdQuery } from 'src/queries/cloudpulse/dashboar
 import { useGetCloudPulseMetricDefinitionsByServiceType } from 'src/queries/cloudpulse/services';
 
 import { ASSOCIATED_ENTITY_METRIC_MAP } from '../Utils/constants';
-import { getAssociatedEntityType } from '../Utils/FilterConfig';
+import {
+  getAssociatedEntityType,
+  isEndpointsOnlyDashboard,
+} from '../Utils/FilterConfig';
 
 import type { GroupByOption } from './CloudPulseGroupByDrawer';
 import type {
@@ -62,10 +65,12 @@ export const useGlobalDimensions = (
     metricDefinition?.data ?? [],
     dashboard
   );
-  const commonDimensions = [
-    defaultOption,
-    ...getCommonDimensions(metricDimensions),
-  ];
+  const baseDimensions = getCommonDimensions(metricDimensions);
+  const shouldIncludeDefault = !isEndpointsOnlyDashboard(dashboardId ?? 0);
+
+  const commonDimensions = shouldIncludeDefault
+    ? [defaultOption, ...baseDimensions]
+    : baseDimensions;
 
   const commonGroups = getCommonGroups(
     preference ? preference : (dashboard?.group_by ?? []),

packages/manager/src/features/CloudPulse/Utils/CloudPulseWidgetUtils.test.ts

@@ -328,7 +328,7 @@ describe('getTimeDurationFromPreset method', () => {
       expect(result).toEqual([123]);
     });
 
-    it('should return entity ids for objectstorage service type', () => {
+    it('should return entity ids for objectstorage buckets dashboard', () => {
       const result = getEntityIds(
         [{ id: 'bucket-1', label: 'bucket-name-1' }],
         ['bucket-1'],

packages/manager/src/features/CloudPulse/Utils/CloudPulseWidgetUtils.ts

@@ -354,7 +354,9 @@ export const getCloudPulseMetricRequest = (
       presetDuration === undefined
         ? { end: duration.end, start: duration.start }
         : undefined,
-    entity_ids: getEntityIds(resources, entityIds, widget, serviceType),
+    entity_ids: !entityIds.length
+      ? undefined
+      : getEntityIds(resources, entityIds, widget, serviceType),
     filters: undefined,
     group_by: !groupBy?.length ? undefined : groupBy,
     relative_time_duration: presetDuration,

packages/manager/src/features/CloudPulse/Utils/FilterBuilder.test.ts

@@ -34,7 +34,6 @@ import { FILTER_CONFIG } from './FilterConfig';
 import { CloudPulseAvailableViews, CloudPulseSelectTypes } from './models';
 import { deepEqual } from './utils';
 
-import type { CloudPulseEndpoints } from '../shared/CloudPulseEndpointsSelect';
 import type { CloudPulseResources } from '../shared/CloudPulseResourcesSelect';
 import type { CloudPulseServiceTypeFilters } from './models';
 
@@ -686,13 +685,15 @@ describe('filterUsingDependentFilters', () => {
 });
 
 describe('filterEndpointsUsingRegion', () => {
-  const mockData: CloudPulseEndpoints[] = [
+  const mockData: CloudPulseResources[] = [
     {
       ...objectStorageEndpointsFactory.build({ region: 'us-east' }),
+      id: 'us-east-1.linodeobjects.com',
       label: 'us-east-1.linodeobjects.com',
     },
     {
       ...objectStorageEndpointsFactory.build({ region: 'us-west' }),
+      id: 'us-west-1.linodeobjects.com',
       label: 'us-west-1.linodeobjects.com',
     },
   ];

packages/manager/src/features/CloudPulse/Utils/FilterBuilder.ts

@@ -15,7 +15,6 @@ import type {
 } from '../Dashboard/CloudPulseDashboardLanding';
 import type { CloudPulseCustomSelectProps } from '../shared/CloudPulseCustomSelect';
 import type { CloudPulseEndpointsSelectProps } from '../shared/CloudPulseEndpointsSelect';
-import type { CloudPulseEndpoints } from '../shared/CloudPulseEndpointsSelect';
 import type {
   CloudPulseFirewallNodebalancersSelectProps,
   CloudPulseNodebalancers,
@@ -404,12 +403,14 @@ export const getEndpointsProperties = (
         preferences
       ),
     handleEndpointsSelection: handleEndpointsChange,
+    dashboardId: dashboard.id,
     label,
     placeholder,
     serviceType: dashboard.service_type,
     region: dependentFilters?.[REGION],
     savePreferences: !isServiceAnalyticsIntegration,
     xFilter: filterBasedOnConfig(config, dependentFilters ?? {}),
+    hasRestrictedSelections: config.configuration.hasRestrictedSelections,
   };
 };
 
@@ -733,9 +734,9 @@ export const filterUsingDependentFilters = (
  * @returns The filtered endpoints
  */
 export const filterEndpointsUsingRegion = (
-  data?: CloudPulseEndpoints[],
+  data?: CloudPulseResources[],
   regionFilter?: CloudPulseMetricsFilter
-): CloudPulseEndpoints[] | undefined => {
+): CloudPulseResources[] | undefined => {
   if (!data) {
     return data;
   }