chore: migrate to vitest v3 (#3561)

Author: dreamorosi

examples/app/package.json

@@ -35,7 +35,7 @@
     "source-map-support": "^0.5.21",
     "tsx": "^4.19.2",
     "typescript": "^5.7.3",
-    "vitest": "^2.0.5"
+    "vitest": "^3.0.5"
   },
   "dependencies": {
     "@aws-lambda-powertools/batch": "^2.13.1",

layers/tests/unit/layer-publisher.test.ts

@@ -40,5 +40,5 @@ describe('Class: LayerPublisherStack', () => {
       Name: '/layers/powertools-layer-arn',
       Type: 'String',
     });
-  });
+  }, 120000);
 });

package-lock.json

@@ -53,7 +53,7 @@
     "@biomejs/biome": "^1.9.4",
     "@types/aws-lambda": "^8.10.147",
     "@types/node": "^22.12.0",
-    "@vitest/coverage-v8": "^2.1.8",
+    "@vitest/coverage-v8": "^3.0.5",
     "husky": "^9.1.7",
     "lerna": "8.1.2",
     "lint-staged": "^15.4.3",
@@ -65,7 +65,7 @@
     "typedoc-plugin-missing-exports": "^3.1.0",
     "typedoc-plugin-zod": "^1.3.1",
     "typescript": "^5.7.3",
-    "vitest": "^2.0.5"
+    "vitest": "^3.0.5"
   },
   "lint-staged": {
     "*.{js,ts}": "biome check --write",

package.json

@@ -50,7 +50,6 @@ describe('Class: DynamoDBPersistenceLayer', () => {
 
   afterEach(() => {
     vi.clearAllMocks();
-    vi.resetAllMocks();
     client.reset();
   });
 
@@ -306,9 +305,9 @@ describe('Class: DynamoDBPersistenceLayer', () => {
 
     it('puts record in DynamoDB table when using payload validation', async () => {
       // Prepare
-      vi.spyOn(persistenceLayer, 'isPayloadValidationEnabled').mockReturnValue(
-        true
-      );
+      const persistenceLayerSpy = vi
+        .spyOn(persistenceLayer, 'isPayloadValidationEnabled')
+        .mockReturnValue(true);
       const status = IdempotencyRecordStatus.EXPIRED;
       const expiryTimestamp = 0;
       const record = new IdempotencyRecord({
@@ -344,6 +343,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
         ConditionExpression:
           'attribute_not_exists(#id) OR #expiry < :now OR (#status = :inprogress AND attribute_exists(#in_progress_expiry) AND #in_progress_expiry < :now_in_millis)',
       });
+      persistenceLayerSpy.mockRestore();
     });
 
     it('throws when called with a record that fails any condition', async () => {
@@ -353,6 +353,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
         status: IdempotencyRecordStatus.EXPIRED,
         expiryTimestamp: 0,
       });
+      const expiration = Date.now();
       client.on(PutItemCommand).rejects(
         new ConditionalCheckFailedException({
           $metadata: {
@@ -363,7 +364,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
           Item: {
             id: { S: 'test-key' },
             status: { S: 'INPROGRESS' },
-            expiration: { N: Date.now().toString() },
+            expiration: { N: expiration.toString() },
           },
         })
       );
@@ -373,9 +374,9 @@ describe('Class: DynamoDBPersistenceLayer', () => {
         new IdempotencyItemAlreadyExistsError(
           `Failed to put record for already existing idempotency key: ${record.idempotencyKey}`,
           new IdempotencyRecord({
-            idempotencyKey: record.idempotencyKey,
-            status: IdempotencyRecordStatus.EXPIRED,
-            expiryTimestamp: Date.now() / 1000 - 1,
+            idempotencyKey: 'test-key',
+            status: IdempotencyRecordStatus.INPROGRESS,
+            expiryTimestamp: expiration,
           })
         )
       );
@@ -575,10 +576,9 @@ describe('Class: DynamoDBPersistenceLayer', () => {
 
     it('uses the payload hash in the expression when payload validation is enabled', async () => {
       // Prepare
-      vi.spyOn(
-        persistenceLayer,
-        'isPayloadValidationEnabled'
-      ).mockImplementation(() => true);
+      const persistenceLayerSpy = vi
+        .spyOn(persistenceLayer, 'isPayloadValidationEnabled')
+        .mockImplementation(() => true);
       const expiryTimestamp = Date.now();
       const record = new IdempotencyRecord({
         idempotencyKey: dummyKey,
@@ -612,6 +612,7 @@ describe('Class: DynamoDBPersistenceLayer', () => {
           ':validation_key': record.payloadHash,
         }),
       });
+      persistenceLayerSpy.mockRestore();
     });
   });
 

packages/idempotency/tests/unit/persistence/DynamoDbPersistenceLayer.test.ts

@@ -107,7 +107,7 @@ describe('Formatters', () => {
     process.env = { ...ENVIRONMENT_VARIABLES };
     const mockDate = new Date(1466424490000);
     vi.useFakeTimers().setSystemTime(mockDate);
-    vi.resetAllMocks();
+    vi.clearAllMocks();
     unformattedAttributes.timestamp = mockDate;
   });
 

packages/logger/tests/unit/formatters.test.ts

@@ -7,7 +7,7 @@ describe('Log levels', () => {
 
   beforeEach(() => {
     process.env = { ...ENVIRONMENT_VARIABLES, POWERTOOLS_DEV: 'true' };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('uses the default service name when none is provided', () => {

packages/logger/tests/unit/initializeLogger.test.ts

@@ -26,7 +26,7 @@ describe('Inject Lambda Context', () => {
       ...ENVIRONMENT_VARIABLES,
       POWERTOOLS_DEV: 'true',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('adds the context to log messages when the feature is enabled', () => {

packages/logger/tests/unit/injectLambdaContext.test.ts

@@ -18,7 +18,7 @@ describe('Log event', () => {
       POWERTOOLS_LOGGER_LOG_EVENT: 'true',
       POWERTOOLS_DEV: 'true',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('logs the event with the correct log level and message', () => {

packages/logger/tests/unit/logEvent.test.ts

@@ -34,7 +34,7 @@ describe('Log levels', () => {
 
   beforeEach(() => {
     process.env = { ...ENVIRONMENT_VARIABLES, POWERTOOLS_DEV: 'true' };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('sets the correct log level when initialized with a log level', () => {

packages/logger/tests/unit/logLevels.test.ts

@@ -14,7 +14,7 @@ describe('Working with keys', () => {
       ...ENVIRONMENT_VARIABLES,
       POWERTOOLS_DEV: 'true',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it.each([

packages/logger/tests/unit/workingWithkeys.test.ts

@@ -11,7 +11,7 @@ describe('ColdStart metric', () => {
       POWERTOOLS_DEV: 'true',
       POWERTOOLS_METRICS_DISABLED: 'false',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('emits a cold start metric', () => {

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

@@ -15,7 +15,7 @@ describe('Creating metrics', () => {
       POWERTOOLS_DEV: 'true',
       POWERTOOLS_METRICS_DISABLED: 'false',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('creates a compliant CloudWatch EMF metric', () => {

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

@@ -15,7 +15,7 @@ describe('Setting custom timestamp', () => {
       POWERTOOLS_DEV: 'true',
       POWERTOOLS_METRICS_DISABLED: 'false',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
     vi.useFakeTimers().setSystemTime(new Date());
   });
 

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

@@ -11,7 +11,7 @@ describe('Working with dimensions', () => {
       POWERTOOLS_DEV: 'true',
       POWERTOOLS_METRICS_DISABLED: 'false',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('adds default dimensions to the metric via constructor', () => {

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

@@ -12,7 +12,7 @@ describe('Initialize Metrics', () => {
       POWERTOOLS_DEV: 'true',
       POWERTOOLS_METRICS_DISABLED: 'false',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('uses the default service name when none is provided', () => {

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

@@ -15,7 +15,7 @@ describe('LogMetrics decorator & Middy.js middleware', () => {
       POWERTOOLS_DEV: 'true',
       POWERTOOLS_METRICS_DISABLED: 'false',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('captures the cold start metric on the first invocation', async () => {

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

@@ -10,7 +10,7 @@ describe('Working with metadata', () => {
       POWERTOOLS_DEV: 'true',
       POWERTOOLS_METRICS_DISABLED: 'false',
     };
-    vi.resetAllMocks();
+    vi.clearAllMocks();
   });
 
   it('adds metadata to the metric', () => {

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

@@ -60,7 +60,9 @@ describe('Class: AppConfigProvider', () => {
       const provider = new AppConfigProvider(options);
 
       // Assess
-      expect(provider.client.config.region()).resolves.toEqual('eu-south-2');
+      await expect(provider.client.config.region()).resolves.toEqual(
+        'eu-south-2'
+      );
       expect(addUserAgentMiddleware).toHaveBeenCalled();
     });
 
@@ -96,7 +98,6 @@ describe('Class: AppConfigProvider', () => {
         environment: 'MyAppProdEnv',
         awsSdkV3Client: awsSdkV3Client as AppConfigDataClient,
       };
-      const consoleWarnSpy = vi.spyOn(console, 'warn');
 
       // Act
       const provider = new AppConfigProvider(options);
@@ -107,7 +108,7 @@ describe('Class: AppConfigProvider', () => {
           serviceId: 'AppConfigData',
         })
       );
-      expect(consoleWarnSpy).toHaveBeenNthCalledWith(
+      expect(console.warn).toHaveBeenNthCalledWith(
         1,
         'awsSdkV3Client is not an AWS SDK v3 client, using default client'
       );

packages/parameters/tests/unit/AppConfigProvider.test.ts

@@ -58,7 +58,9 @@ describe('Class: DynamoDBProvider', () => {
       const provider = new DynamoDBProvider(options);
 
       // Assess
-      expect(provider.client.config.region()).resolves.toEqual('eu-south-2');
+      await expect(provider.client.config.region()).resolves.toEqual(
+        'eu-south-2'
+      );
       expect(addUserAgentMiddleware).toHaveBeenCalled();
     });
 
@@ -92,7 +94,6 @@ describe('Class: DynamoDBProvider', () => {
         tableName: 'test-table',
         awsSdkV3Client: awsSdkV3Client as DynamoDBClient,
       };
-      const consoleWarnSpy = vi.spyOn(console, 'warn');
 
       // Act
       const provider = new DynamoDBProvider(options);
@@ -103,7 +104,7 @@ describe('Class: DynamoDBProvider', () => {
           serviceId: 'DynamoDB',
         })
       );
-      expect(consoleWarnSpy).toHaveBeenNthCalledWith(
+      expect(console.warn).toHaveBeenNthCalledWith(
         1,
         'awsSdkV3Client is not an AWS SDK v3 client, using default client'
       );

packages/parameters/tests/unit/DynamoDBProvider.test.ts

@@ -64,7 +64,9 @@ describe('Class: SSMProvider', () => {
       const provider = new SSMProvider(options);
 
       // Assess
-      expect(provider.client.config.region()).resolves.toEqual('eu-south-2');
+      await expect(provider.client.config.region()).resolves.toEqual(
+        'eu-south-2'
+      );
       expect(addUserAgentMiddleware).toHaveBeenCalled();
     });
 
@@ -96,7 +98,6 @@ describe('Class: SSMProvider', () => {
       const options: SSMProviderOptions = {
         awsSdkV3Client: awsSdkV3Client as SSMClient,
       };
-      const consoleWarnSpy = vi.spyOn(console, 'warn');
 
       // Act
       const provider = new SSMProvider(options);
@@ -107,7 +108,7 @@ describe('Class: SSMProvider', () => {
           serviceId: 'SSM',
         })
       );
-      expect(consoleWarnSpy).toHaveBeenNthCalledWith(
+      expect(console.warn).toHaveBeenNthCalledWith(
         1,
         'awsSdkV3Client is not an AWS SDK v3 client, using default client'
       );

packages/parameters/tests/unit/SSMProvider.test.ts

@@ -51,7 +51,9 @@ describe('Class: SecretsProvider', () => {
       const provider = new SecretsProvider(options);
 
       // Assess
-      expect(provider.client.config.region()).resolves.toEqual('eu-south-2');
+      await expect(provider.client.config.region()).resolves.toEqual(
+        'eu-south-2'
+      );
       expect(addUserAgentMiddleware).toHaveBeenCalled();
     });
 
@@ -83,7 +85,6 @@ describe('Class: SecretsProvider', () => {
       const options: SecretsProviderOptions = {
         awsSdkV3Client: awsSdkV3Client as SecretsManagerClient,
       };
-      const consoleWarnSpy = vi.spyOn(console, 'warn');
 
       // Act
       const provider = new SecretsProvider(options);
@@ -94,7 +95,7 @@ describe('Class: SecretsProvider', () => {
           serviceId: 'Secrets Manager',
         })
       );
-      expect(consoleWarnSpy).toHaveBeenNthCalledWith(
+      expect(console.warn).toHaveBeenNthCalledWith(
         1,
         'awsSdkV3Client is not an AWS SDK v3 client, using default client'
       );

packages/parameters/tests/unit/SecretsProvider.test.ts

@@ -108,7 +108,7 @@ describe('Envelope: API Gateway REST', () => {
       const result = ApiGatewayEnvelope.safeParse(event, schema);
 
       // Assess
-      expect(result).toEqual({
+      expect(result).be.deep.equal({
         success: false,
         error: new ParseError('Failed to parse API Gateway body', {
           cause: new ZodError([

packages/parser/tests/unit/envelopes/apigw.test.ts

@@ -109,7 +109,7 @@ describe('Envelope: API Gateway HTTP', () => {
       const result = ApiGatewayV2Envelope.safeParse(event, schema);
 
       // Assess
-      expect(result).toEqual({
+      expect(result).be.deep.equal({
         success: false,
         error: new ParseError('Failed to parse API Gateway HTTP body', {
           cause: new ZodError([

packages/parser/tests/unit/envelopes/apigwv2.test.ts

@@ -203,7 +203,7 @@ describe('Envelope: CloudWatch', () => {
       );
 
       // Assess
-      expect(result).toStrictEqual({
+      expect(result).be.deep.equal({
         success: false,
         error: new ParseError(
           'Failed to parse CloudWatch Log message at index 0',
@@ -234,7 +234,7 @@ describe('Envelope: CloudWatch', () => {
       );
 
       // Assess
-      expect(result).toStrictEqual({
+      expect(result).be.deep.equal({
         success: false,
         error: new ParseError(
           'Failed to parse CloudWatch Log messages at indexes 0, 1, 2',