reactor: STORIF-285 - Quota resource metric converted into an enum.

Author: dchyrva-akamai

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

@@ -1,5 +1,18 @@
 import type { ObjectStorageEndpointTypes } from 'src/object-storage';
 import type { Region } from 'src/regions';
+
+export enum QuotaResourceMetrics {
+  BUCKET = 'bucket',
+  BYTE = 'byte',
+  BYTE_PER_SECOND = 'byte_per_second',
+  CLUSTER = 'cluster',
+  CPU = 'CPU',
+  GPU = 'GPU',
+  OBJECT = 'object',
+  REQUEST = 'request',
+  VPU = 'VPU',
+}
+
 /**
  * A Quota is a service used limit that is rated based on service metrics such
  * as vCPUs used, instances or storage size.
@@ -54,7 +67,7 @@ export interface Quota {
   /**
    * The unit of measurement for this service limit.
    */
-  resource_metric: string;
+  resource_metric: QuotaResourceMetrics;
 
   /**
    * The S3 endpoint URL to which this limit applies.

packages/manager/cypress/e2e/core/account/quotas-storage.spec.ts

@@ -1,3 +1,4 @@
+import { type Quota, QuotaResourceMetrics } from '@linode/api-v4';
 import { regionFactory } from '@linode/utilities';
 import { profileFactory } from '@linode/utilities';
 import { mockAppendFeatureFlags } from 'support/intercepts/feature-flags';
@@ -22,8 +23,6 @@ import { objectStorageEndpointsFactory } from 'src/factories';
 import { quotaFactory, quotaUsageFactory } from 'src/factories/quotas';
 import { getQuotaIncreaseMessage } from 'src/features/Account/Quotas/utils';
 
-import type { Quota } from '@linode/api-v4';
-
 const mockFeatureFlags = {
   limitsEvolution: {
     enabled: true,
@@ -74,7 +73,7 @@ const mockQuotas = [
     endpoint_type: mockSelectedEndpoint.endpoint_type,
     quota_limit: 10,
     quota_name: randomLabel(15),
-    resource_metric: 'byte',
+    resource_metric: QuotaResourceMetrics.BYTE,
     s3_endpoint: selectedDomain,
   }),
   quotaFactory.build({
@@ -84,7 +83,7 @@ const mockQuotas = [
     endpoint_type: mockSelectedEndpoint.endpoint_type,
     quota_limit: 78,
     quota_name: randomLabel(15),
-    resource_metric: 'bucket',
+    resource_metric: QuotaResourceMetrics.BUCKET,
     s3_endpoint: selectedDomain,
   }),
   quotaFactory.build({
@@ -94,7 +93,7 @@ const mockQuotas = [
     endpoint_type: mockSelectedEndpoint.endpoint_type,
     quota_limit: 400,
     quota_name: randomLabel(15),
-    resource_metric: 'object',
+    resource_metric: QuotaResourceMetrics.OBJECT,
     s3_endpoint: selectedDomain,
   }),
 ];
@@ -229,7 +228,7 @@ describe('Quota workflow tests', () => {
           endpoint_type: updatedEndpoint.endpoint_type,
           quota_limit: 20,
           quota_name: randomLabel(15),
-          resource_metric: 'byte',
+          resource_metric: QuotaResourceMetrics.BYTE,
           s3_endpoint: updatedDomain,
         }),
         quotaFactory.build({
@@ -239,7 +238,7 @@ describe('Quota workflow tests', () => {
           endpoint_type: updatedEndpoint.endpoint_type,
           quota_limit: 122,
           quota_name: randomLabel(15),
-          resource_metric: 'bucket',
+          resource_metric: QuotaResourceMetrics.BUCKET,
           s3_endpoint: updatedDomain,
         }),
         quotaFactory.build({
@@ -249,7 +248,7 @@ describe('Quota workflow tests', () => {
           endpoint_type: updatedEndpoint.endpoint_type,
           quota_limit: 450,
           quota_name: randomLabel(15),
-          resource_metric: 'object',
+          resource_metric: QuotaResourceMetrics.OBJECT,
           s3_endpoint: updatedDomain,
         }),
       ];

packages/manager/cypress/e2e/core/objectStorage/object-storage-summary-page.spec.ts

@@ -1,3 +1,4 @@
+import { QuotaResourceMetrics } from '@linode/api-v4';
 import { regionFactory } from '@linode/utilities';
 import { authenticate } from 'support/api/authentication';
 import { mockAppendFeatureFlags } from 'support/intercepts/feature-flags';
@@ -58,7 +59,7 @@ const mockQuotas = [
     endpoint_type: mockSelectedEndpoint.endpoint_type,
     quota_limit: 10,
     quota_name: 'Total Capacity',
-    resource_metric: 'byte',
+    resource_metric: QuotaResourceMetrics.BYTE,
     s3_endpoint: selectedDomain,
   }),
   quotaFactory.build({
@@ -68,7 +69,7 @@ const mockQuotas = [
     endpoint_type: mockSelectedEndpoint.endpoint_type,
     quota_limit: 78,
     quota_name: 'Number of Objects',
-    resource_metric: 'bucket',
+    resource_metric: QuotaResourceMetrics.BUCKET,
     s3_endpoint: selectedDomain,
   }),
   quotaFactory.build({
@@ -78,7 +79,7 @@ const mockQuotas = [
     endpoint_type: mockSelectedEndpoint.endpoint_type,
     quota_limit: 400,
     quota_name: 'Number of Buckets',
-    resource_metric: 'object',
+    resource_metric: QuotaResourceMetrics.OBJECT,
     s3_endpoint: selectedDomain,
   }),
 ];

packages/manager/src/components/QuotaUsageBar/QuotaUsageBar.test.tsx

@@ -1,3 +1,4 @@
+import { QuotaResourceMetrics } from '@linode/api-v4';
 import React from 'react';
 
 import { renderWithTheme } from 'src/utilities/testHelpers';
@@ -43,7 +44,11 @@ describe('QuotaUsageBanner', () => {
     'should display correct byte quota usage text for $usage bytes used out of $limit bytes',
     ({ usage, limit, expectedText }) => {
       const { getByText } = renderWithTheme(
-        <QuotaUsageBar limit={limit} resourceMetric="byte" usage={usage} />
+        <QuotaUsageBar
+          limit={limit}
+          resourceMetric={QuotaResourceMetrics.BYTE}
+          usage={usage}
+        />
       );
       const quotaUsageText = getByText(expectedText);
       expect(quotaUsageText).toBeVisible();

packages/manager/src/components/QuotaUsageBar/QuotaUsageBar.tsx

@@ -2,14 +2,13 @@ import { Typography, useTheme } from '@linode/ui';
 import * as React from 'react';
 
 import { BarPercent } from 'src/components/BarPercent';
-import {
-  convertResourceMetric,
-  pluralizeMetric,
-} from 'src/features/Account/Quotas/utils';
+import { convertResourceMetric } from 'src/features/Account/Quotas/utils';
+
+import type { QuotaResourceMetrics } from '@linode/api-v4';
 
 interface Props {
   limit: number;
-  resourceMetric: string;
+  resourceMetric: QuotaResourceMetrics;
   usage: number;
 }
 
@@ -18,7 +17,7 @@ export const QuotaUsageBar = ({ limit, usage, resourceMetric }: Props) => {
 
   const { convertedUsage, convertedLimit, convertedResourceMetric } =
     convertResourceMetric({
-      initialResourceMetric: pluralizeMetric(limit, resourceMetric),
+      initialResourceMetric: resourceMetric,
       initialUsage: usage,
       initialLimit: limit,
     });

packages/manager/src/factories/quotas.ts

@@ -1,15 +1,18 @@
+import {
+  type Quota,
+  QuotaResourceMetrics,
+  type QuotaUsage,
+} from '@linode/api-v4/lib/quotas/types';
 import { Factory } from '@linode/utilities';
 
-import type { Quota, QuotaUsage } from '@linode/api-v4/lib/quotas/types';
-
 export const quotaFactory = Factory.Sync.makeFactory<Quota>({
   description: 'Maximimum number of vCPUs allowed',
   quota_id: Factory.each((id) => id.toString()),
   quota_limit: 50,
   quota_name: 'Linode Dedicated vCPUs',
   quota_type: 'linode-dedicated-cpus',
   region_applied: 'us-east',
-  resource_metric: 'CPU',
+  resource_metric: QuotaResourceMetrics.CPU,
   has_usage: true,
 });
 

packages/manager/src/features/Account/Quotas/QuotasTable/QuotasTable.test.tsx

@@ -1,3 +1,4 @@
+import { QuotaResourceMetrics } from '@linode/api-v4';
 import { waitFor } from '@testing-library/react';
 import * as React from 'react';
 
@@ -131,7 +132,7 @@ describe('QuotasTable', () => {
             'Current total ingress bandwidth per account, per endpoint',
           quota_limit: 1250000000,
           quota_type: 'obj-total-ingress-throughput',
-          resource_metric: 'byte_per_second',
+          resource_metric: QuotaResourceMetrics.BYTE_PER_SECOND,
           has_usage: false,
         }),
       ],

packages/manager/src/features/Account/Quotas/QuotasTable/QuotasTableRow.tsx

@@ -9,11 +9,7 @@ import { TableRow } from 'src/components/TableRow/TableRow';
 import { useFlags } from 'src/hooks/useFlags';
 import { useIsAkamaiAccount } from 'src/hooks/useIsAkamaiAccount';
 
-import {
-  convertResourceMetric,
-  getQuotaError,
-  pluralizeMetric,
-} from '../utils';
+import { convertResourceMetric, getQuotaError } from '../utils';
 
 import type { QuotaWithUsage } from '../utils';
 import type { Quota, QuotaUsage } from '@linode/api-v4';
@@ -58,10 +54,7 @@ export const QuotasTableRow = (props: QuotasTableRowProps) => {
       isAkamaiAccount);
 
   const { convertedLimit, convertedResourceMetric } = convertResourceMetric({
-    initialResourceMetric: pluralizeMetric(
-      quota.quota_limit,
-      quota.resource_metric
-    ),
+    initialResourceMetric: quota.resource_metric,
     initialUsage: quota.usage?.usage ?? 0,
     initialLimit: quota.quota_limit,
   });

packages/manager/src/features/Account/Quotas/utils.test.tsx

@@ -1,3 +1,4 @@
+import { QuotaResourceMetrics, type QuotaUsage } from '@linode/api-v4';
 import { profileFactory } from '@linode/utilities';
 import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
 import { renderHook } from '@testing-library/react';
@@ -13,7 +14,6 @@ import {
   useGetLocationsForQuotaService,
 } from './utils';
 
-import type { QuotaUsage } from '@linode/api-v4';
 import type { UseQueryResult } from '@tanstack/react-query';
 
 const queryMocks = vi.hoisted(() => ({
@@ -133,7 +133,7 @@ describe('useGetLocationsForQuotaService', () => {
 
 describe('convertResourceMetric', () => {
   it('should convert the resource metric to a human readable format', () => {
-    const resourceMetric = 'byte';
+    const resourceMetric = QuotaResourceMetrics.BYTE;
     const usage = 1e6;
     const limit = 1e8;
 
@@ -154,7 +154,7 @@ describe('convertResourceMetric', () => {
 describe('pluralizeMetric', () => {
   it('should not pluralize if the value is 1', () => {
     const value = 1;
-    const unit = 'CPU';
+    const unit = QuotaResourceMetrics.CPU;
 
     const result = pluralizeMetric(value, unit);
 
@@ -163,7 +163,7 @@ describe('pluralizeMetric', () => {
 
   it('should not pluralize the resource metric if the unit is byte', () => {
     const value = 100;
-    const unit = 'byte';
+    const unit = QuotaResourceMetrics.BYTE;
 
     const result = pluralizeMetric(value, unit);
 
@@ -172,7 +172,7 @@ describe('pluralizeMetric', () => {
 
   it('should pluralize the resource metric if the unit is not byte', () => {
     const value = 100;
-    const unit = 'CPU';
+    const unit = QuotaResourceMetrics.CPU;
 
     const result = pluralizeMetric(value, unit);
 

packages/manager/src/features/Account/Quotas/utils.ts

@@ -1,3 +1,4 @@
+import { QuotaResourceMetrics } from '@linode/api-v4';
 import { useRegionsQuery } from '@linode/queries';
 import { capitalize, readableBytes } from '@linode/utilities';
 import { object, string } from 'yup';
@@ -217,7 +218,7 @@ export const getQuotaIncreaseMessage = ({
 
 interface ConvertResourceMetricProps {
   initialLimit: number;
-  initialResourceMetric: string;
+  initialResourceMetric: QuotaResourceMetrics;
   initialUsage: number;
 }
 
@@ -233,19 +234,19 @@ export const convertResourceMetric = ({
   convertedResourceMetric: string;
   convertedUsage: number;
 } => {
-  if (initialResourceMetric === 'byte') {
+  if (initialResourceMetric === QuotaResourceMetrics.BYTE) {
     const limitReadable = readableBytes(initialLimit);
 
     return {
       convertedUsage: readableBytes(initialUsage, {
         unit: limitReadable.unit,
       }).value,
-      convertedResourceMetric: capitalize(limitReadable.unit),
       convertedLimit: limitReadable.value,
+      convertedResourceMetric: capitalize(limitReadable.unit),
     };
   }
 
-  if (initialResourceMetric === 'byte_per_second') {
+  if (initialResourceMetric === QuotaResourceMetrics.BYTE_PER_SECOND) {
     return {
       convertedUsage: 0,
       convertedResourceMetric: 'Gbps',
@@ -259,7 +260,9 @@ export const convertResourceMetric = ({
   return {
     convertedUsage: initialUsage,
     convertedLimit: initialLimit,
-    convertedResourceMetric: capitalize(initialResourceMetric),
+    convertedResourceMetric: capitalize(
+      pluralizeMetric(initialLimit, initialResourceMetric)
+    ),
   };
 };
 
@@ -270,16 +273,11 @@ export const convertResourceMetric = ({
  *
  * Note: the value should be the raw values in bytes, not an existing conversion
  */
-export const pluralizeMetric = (value: number, unit: string) => {
-  if (unit === 'byte_per_second') {
-    return unit;
-  }
-
-  if (unit !== 'byte') {
-    return value > 1 ? `${unit}s` : unit;
-  }
-
-  return unit;
+export const pluralizeMetric = (
+  value: number,
+  unit: QuotaResourceMetrics
+): string => {
+  return value > 1 ? `${unit}s` : unit;
 };
 
 export const getQuotaIncreaseFormSchema = (currentLimit: number) =>