refactor: constants for magic numbers

Author: arnabrahman

packages/metrics/src/Metrics.ts

@@ -10,6 +10,8 @@ import { EnvironmentVariablesService } from './config/EnvironmentVariablesServic
 import {
   COLD_START_METRIC,
   DEFAULT_NAMESPACE,
+  EMF_MAX_TIMESTAMP_FUTURE_AGE,
+  EMF_MAX_TIMESTAMP_PAST_AGE,
   MAX_DIMENSION_COUNT,
   MAX_METRICS_SIZE,
   MAX_METRIC_VALUES_SIZE,
@@ -975,9 +977,6 @@ class Metrics extends Utility implements MetricsInterface {
    * @param timestamp - Date object or epoch time in milliseconds representing the timestamp to validate.
    */
   #validateEmfTimestamp(timestamp: number | Date): boolean {
-    const EMF_MAX_TIMESTAMP_PAST_AGE = 14 * 24 * 60 * 60 * 1000; // 14 days in milliseconds
-    const EMF_MAX_TIMESTAMP_FUTURE_AGE = 2 * 60 * 60 * 1000; // 2 hours in milliseconds
-
     if (!isDate(timestamp) && !isIntegerNumber(timestamp)) {
       return false;
     }

packages/metrics/src/constants.ts

@@ -18,6 +18,16 @@ const MAX_METRIC_VALUES_SIZE = 100;
  * The maximum number of dimensions that can be added to a metric (0-indexed).
  */
 const MAX_DIMENSION_COUNT = 29;
+/**
+ * The maximum age of a timestamp in milliseconds that can be emitted in a metric.
+ * This is set to 14 days.
+ */
+const EMF_MAX_TIMESTAMP_PAST_AGE = 14 * 24 * 60 * 60 * 1000;
+/**
+ * The maximum age of a timestamp in milliseconds that can be emitted in a metric.
+ * This is set to 2 hours.
+ */
+const EMF_MAX_TIMESTAMP_FUTURE_AGE = 2 * 60 * 60 * 1000;
 
 /**
  * The unit of the metric.
@@ -73,4 +83,6 @@ export {
   MAX_DIMENSION_COUNT,
   MetricUnit,
   MetricResolution,
+  EMF_MAX_TIMESTAMP_PAST_AGE,
+  EMF_MAX_TIMESTAMP_FUTURE_AGE,
 };

packages/metrics/tests/unit/Metrics.test.ts

@@ -10,6 +10,8 @@ import { EnvironmentVariablesService } from '../../src/config/EnvironmentVariabl
 import {
   COLD_START_METRIC,
   DEFAULT_NAMESPACE,
+  EMF_MAX_TIMESTAMP_FUTURE_AGE,
+  EMF_MAX_TIMESTAMP_PAST_AGE,
   MAX_DIMENSION_COUNT,
   MAX_METRICS_SIZE,
   MAX_METRIC_VALUES_SIZE,
@@ -2269,9 +2271,6 @@ describe('Class: Metrics', () => {
 
     for (const { format, getTimestamp } of testCases) {
       describe(`when timestamp is provided as ${format}`, () => {
-        const twoHours = 2 * 60 * 60 * 1000;
-        const fourteenDays = 14 * 24 * 60 * 60 * 1000;
-
         test('should set the timestamp if provided in the future', () => {
           // Prepare
           const testMetric = 'test-metric';
@@ -2314,10 +2313,10 @@ describe('Class: Metrics', () => {
           );
         });
 
-        test('should not log a warning if the timestamp exact two hours in the future and set the timestamp', () => {
+        test('should not log a warning if the timestamp is withing valid future range', () => {
           // Prepare
           const testMetric = 'test-metric';
-          const timestampMs = mockDate.getTime() + twoHours;
+          const timestampMs = mockDate.getTime() + EMF_MAX_TIMESTAMP_FUTURE_AGE;
           const customLogger = {
             warn: jest.fn(),
             debug: jest.fn(),
@@ -2343,10 +2342,11 @@ describe('Class: Metrics', () => {
           );
         });
 
-        test('should log a warning if the timestamp is more than two hours in the future but still set the timestamp', () => {
+        test('should log a warning if the timestamp is more than the future range but still set the timestamp', () => {
           // Prepare
           const testMetric = 'test-metric';
-          const timestampMs = mockDate.getTime() + twoHours + 1;
+          const timestampMs =
+            mockDate.getTime() + EMF_MAX_TIMESTAMP_FUTURE_AGE + 1;
           const customLogger = {
             warn: jest.fn(),
             debug: jest.fn(),
@@ -2375,10 +2375,10 @@ describe('Class: Metrics', () => {
           );
         });
 
-        test('should not log a warning if the timestamp is exact 14 days in the past and set the timestamp', () => {
+        test('should not log a warning if the timestamp is within past range and set the timestamp', () => {
           // Prepare
           const testMetric = 'test-metric';
-          const timestampMs = mockDate.getTime() - fourteenDays;
+          const timestampMs = mockDate.getTime() - EMF_MAX_TIMESTAMP_PAST_AGE;
           const customLogger = {
             warn: jest.fn(),
             debug: jest.fn(),
@@ -2404,10 +2404,11 @@ describe('Class: Metrics', () => {
           );
         });
 
-        test('should log a warning if the timestamp is more than 14 days in the past but still set the timestamp', () => {
+        test('should log a warning if the timestamp is more than past range but still set the timestamp', () => {
           // Prepare
           const testMetric = 'test-metric';
-          const timestampMs = mockDate.getTime() - fourteenDays - 1;
+          const timestampMs =
+            mockDate.getTime() - EMF_MAX_TIMESTAMP_PAST_AGE - 1;
           const customLogger = {
             warn: jest.fn(),
             debug: jest.fn(),