feat(@schematics/angular): stabilize refactor-jasmine-vitest schematic

Stabilize `refactor-jasmine-vitest` schematic by covering the known remaining test patterns and cases.

Author: hawkgs

packages/schematics/angular/refactor/jasmine-vitest/test-file-transformer.integration_spec.ts

@@ -288,8 +288,8 @@ describe('Jasmine to Vitest Transformer - Integration Tests', () => {
         });
 
         it('should handle spy call order', () => {
-          const spyA = vi.fn();
-          const spyB = vi.fn();
+          const spyA = vi.fn().mockName('spyA');
+          const spyB = vi.fn().mockName('spyB');
           spyA();
           spyB();
           expect(Math.min(...vi.mocked(spyA).mock.invocationCallOrder)).toBeLessThan(Math.min(...vi.mocked(spyB).mock.invocationCallOrder));
@@ -387,7 +387,7 @@ describe('Jasmine to Vitest Transformer - Integration Tests', () => {
         });
 
         it('should handle spies throwing errors', () => {
-          const spy = vi.fn().mockImplementation(() => { throw new Error('Test Error') });
+          const spy = vi.fn().mockName('mySpy').mockImplementation(() => { throw new Error('Test Error') });
           expect(() => spy()).toThrowError('Test Error');
         });
       });

packages/schematics/angular/refactor/jasmine-vitest/test-file-transformer.ts

@@ -29,7 +29,7 @@ import {
   transformSyntacticSugarMatchers,
   transformToHaveClass,
   transformWithContext,
-  transformtoHaveBeenCalledBefore,
+  transformToHaveBeenCalledBefore,
 } from './transformers/jasmine-matcher';
 import {
   transformDefaultTimeoutInterval,
@@ -40,6 +40,7 @@ import {
   transformUnsupportedJasmineCalls,
 } from './transformers/jasmine-misc';
 import {
+  transformCreateSpy,
   transformCreateSpyObj,
   transformSpies,
   transformSpyCallInspection,
@@ -116,10 +117,11 @@ const callExpressionTransformers = [
   transformSyntacticSugarMatchers,
   transformComplexMatchers,
   transformSpies,
+  transformCreateSpy,
   transformCreateSpyObj,
   transformSpyReset,
   transformSpyCallInspection,
-  transformtoHaveBeenCalledBefore,
+  transformToHaveBeenCalledBefore,
   transformToHaveClass,
 
   // **Stage 3: Global Functions & Cleanup**

packages/schematics/angular/refactor/jasmine-vitest/transformers/jasmine-matcher.ts

@@ -121,7 +121,7 @@ export function transformAsymmetricMatchers(
   return node;
 }
 
-export function transformtoHaveBeenCalledBefore(
+export function transformToHaveBeenCalledBefore(
   node: ts.Node,
   { sourceFile, reporter }: RefactorContext,
 ): ts.Node {

packages/schematics/angular/refactor/jasmine-vitest/transformers/jasmine-misc.ts

@@ -52,6 +52,20 @@ export function transformTimerMocks(
     case 'mockDate':
       newMethodName = 'setSystemTime';
       break;
+    case 'autoTick': {
+      const category = 'clockAutoTick';
+      reporter.recordTodo(category, sourceFile, node);
+      addTodoComment(node, category);
+
+      return node;
+    }
+    case 'withMock': {
+      const category = 'clockWithMock';
+      reporter.recordTodo(category, sourceFile, node);
+      addTodoComment(node, category);
+
+      return node;
+    }
   }
 
   if (newMethodName) {
@@ -85,15 +99,21 @@ export function transformFail(node: ts.Node, { sourceFile, reporter }: RefactorC
     node.expression.expression.text === 'fail'
   ) {
     reporter.reportTransformation(sourceFile, node, 'Transformed `fail()` to `throw new Error()`.');
-    const reason = node.expression.arguments[0];
 
-    const replacement = ts.factory.createThrowStatement(
-      ts.factory.createNewExpression(
+    const arg = node.expression.arguments[0];
+    let throwExpression: ts.Expression;
+
+    if (arg && ts.isNewExpression(arg)) {
+      throwExpression = arg;
+    } else {
+      throwExpression = ts.factory.createNewExpression(
         ts.factory.createIdentifier('Error'),
         undefined,
-        reason ? [reason] : [],
-      ),
-    );
+        arg ? [arg] : [],
+      );
+    }
+
+    const replacement = ts.factory.createThrowStatement(throwExpression);
 
     return ts.setOriginalNode(ts.setTextRange(replacement, node), node);
   }
@@ -163,15 +183,25 @@ export function transformGlobalFunctions(
 
 const UNSUPPORTED_JASMINE_CALLS_CATEGORIES = new Set<TodoCategory>([
   'addMatchers',
+  'addAsyncMatchers',
   'addCustomEqualityTester',
+  'addCustomObjectFormatter',
   'mapContaining',
   'setContaining',
+  'addSpyStrategy',
 ]);
 
 // A type guard to ensure that the methodName is one of the categories handled by this transformer.
 function isUnsupportedJasmineCall(
   methodName: string,
-): methodName is 'addMatchers' | 'addCustomEqualityTester' | 'mapContaining' | 'setContaining' {
+): methodName is
+  | 'addMatchers'
+  | 'addAsyncMatchers'
+  | 'addCustomEqualityTester'
+  | 'addCustomObjectFormatter'
+  | 'mapContaining'
+  | 'setContaining'
+  | 'addSpyStrategy' {
   return UNSUPPORTED_JASMINE_CALLS_CATEGORIES.has(methodName as TodoCategory);
 }
 
@@ -200,6 +230,7 @@ const HANDLED_JASMINE_PROPERTIES = new Set([
   'createSpy',
   'createSpyObj',
   'spyOnAllFunctions',
+  'addSpyStrategy',
   // Clock
   'clock',
   // Matchers
@@ -218,7 +249,9 @@ const HANDLED_JASMINE_PROPERTIES = new Set([
   // Other
   'DEFAULT_TIMEOUT_INTERVAL',
   'addMatchers',
+  'addAsyncMatchers',
   'addCustomEqualityTester',
+  'addCustomObjectFormatter',
 ]);
 
 export function transformUnknownJasmineProperties(

packages/schematics/angular/refactor/jasmine-vitest/transformers/jasmine-misc_spec.ts

@@ -35,6 +35,18 @@ describe('Jasmine to Vitest Transformer - transformTimerMocks', () => {
       input: `jasmine.clock().mockDate();`,
       expected: `vi.setSystemTime(new Date());`,
     },
+    {
+      description: 'should add a TODO for jasmine.clock().autoTick()',
+      input: 'jasmine.clock().autoTick();',
+      expected: `// TODO: vitest-migration: Vitest does not have a direct equivalent for jasmine.clock().autoTick(). Please migrate this manually. See: https://vitest.dev/api/vi.html#fake-timers
+jasmine.clock().autoTick();`,
+    },
+    {
+      description: 'should add a TODO for jasmine.clock().withMock()',
+      input: 'jasmine.clock().withMock(noop);',
+      expected: `// TODO: vitest-migration: Vitest does not have a direct equivalent for jasmine.clock().withMock(). Please migrate this manually via vi.useFakeTimers() and vi.useRealTimers(). See: https://vitest.dev/api/vi.html#vi-usefaketimers
+jasmine.clock().withMock(noop);`,
+    },
   ];
 
   testCases.forEach(({ description, input, expected }) => {
@@ -56,6 +68,11 @@ describe('transformFail', () => {
       input: `fail();`,
       expected: `throw new Error();`,
     },
+    {
+      description: 'should transform fail() with an Error object',
+      input: `fail(new TypeError('Invalid input'));`,
+      expected: `throw new TypeError('Invalid input');`,
+    },
   ];
 
   testCases.forEach(({ description, input, expected }) => {
@@ -81,7 +98,7 @@ describe('transformDefaultTimeoutInterval', () => {
   });
 });
 
-describe('transformAddMatchers', () => {
+describe('transformUnsupportedJasmineCalls', () => {
   const testCases = [
     {
       description: 'should add a TODO for jasmine.addMatchers',
@@ -113,17 +130,24 @@ describe('transformAddMatchers', () => {
           });
         `,
     },
-  ];
-
-  testCases.forEach(({ description, input, expected }) => {
-    it(description, async () => {
-      await expectTransformation(input, expected);
-    });
-  });
-});
-
-describe('transformAddCustomEqualityTester', () => {
-  const testCases = [
+    {
+      description: 'should add a TODO for jasmine.addAsyncMatchers',
+      input: `
+          jasmine.addAsyncMatchers({
+            toEventuallyEqual: () => ({
+              compare: async (actual, expected) => ({ pass: actual === expected }),
+            }),
+          });
+        `,
+      expected: `
+          // TODO: vitest-migration: jasmine.addAsyncMatchers is not supported. Please manually migrate to expect.extend(). See: https://vitest.dev/api/expect.html#expect-extend
+          jasmine.addAsyncMatchers({
+            toEventuallyEqual: () => ({
+              compare: async (actual, expected) => ({ pass: actual === expected }),
+            }),
+          });
+        `,
+    },
     {
       description: 'should add a TODO for jasmine.addCustomEqualityTester',
       input: `
@@ -137,6 +161,40 @@ describe('transformAddCustomEqualityTester', () => {
           });
         `,
     },
+    {
+      description: 'should add a TODO for jasmine.addCustomObjectFormatter',
+      input: `
+          jasmine.addCustomObjectFormatter((val) => {
+            if (val instanceof MyClass) return 'MyClass(' + val.id + '})';
+          });
+        `,
+      expected: `// TODO: vitest-migration: jasmine.addCustomObjectFormatter is not supported. May be possible to migrate to expect.addSnapshotSerializer(). See: https://vitest.dev/api/expect.html#expect-addsnapshotserializer
+          jasmine.addCustomObjectFormatter((val) => {
+            if (val instanceof MyClass) return 'MyClass(' + val.id + '})';
+          });
+        `,
+    },
+    {
+      description: 'should add a TODO for jasmine.mapContaining',
+      input: `expect(myMap).toEqual(jasmine.mapContaining(new Map()));`,
+      // eslint-disable-next-line max-len
+      expected: `// TODO: vitest-migration: jasmine.mapContaining is not supported. Vitest does not have a built-in matcher for Maps. Please manually assert the contents of the Map.
+expect(myMap).toEqual(jasmine.mapContaining(new Map()));`,
+    },
+    {
+      description: 'should add a TODO for jasmine.setContaining',
+      input: `expect(mySet).toEqual(jasmine.setContaining(new Set()));`,
+      // eslint-disable-next-line max-len
+      expected: `// TODO: vitest-migration: jasmine.setContaining is not supported. Vitest does not have a built-in matcher for Sets. Please manually assert the contents of the Set.
+expect(mySet).toEqual(jasmine.setContaining(new Set()));`,
+    },
+    {
+      description: 'should add a TODO for jasmine.addSpyStrategy',
+      input: `jasmine.addSpyStrategy('returnZero', () => () => 0);`,
+      expected: `// TODO: vitest-migration: jasmine.addSpyStrategy is not supported. Please manually migrate to spy.mockImplementation(). See: https://vitest.dev/api/mock.html#mockimplementation
+jasmine.addSpyStrategy('returnZero', () => () => 0);
+      `,
+    },
   ];
 
   testCases.forEach(({ description, input, expected }) => {
@@ -192,28 +250,3 @@ setSuiteProperty('myKey', 'myValue');`,
     });
   });
 });
-
-describe('transformUnsupportedJasmineCalls', () => {
-  const testCases = [
-    {
-      description: 'should add a TODO for jasmine.mapContaining',
-      input: `expect(myMap).toEqual(jasmine.mapContaining(new Map()));`,
-      // eslint-disable-next-line max-len
-      expected: `// TODO: vitest-migration: jasmine.mapContaining is not supported. Vitest does not have a built-in matcher for Maps. Please manually assert the contents of the Map.
-expect(myMap).toEqual(jasmine.mapContaining(new Map()));`,
-    },
-    {
-      description: 'should add a TODO for jasmine.setContaining',
-      input: `expect(mySet).toEqual(jasmine.setContaining(new Set()));`,
-      // eslint-disable-next-line max-len
-      expected: `// TODO: vitest-migration: jasmine.setContaining is not supported. Vitest does not have a built-in matcher for Sets. Please manually assert the contents of the Set.
-expect(mySet).toEqual(jasmine.setContaining(new Set()));`,
-    },
-  ];
-
-  testCases.forEach(({ description, input, expected }) => {
-    it(description, async () => {
-      await expectTransformation(input, expected);
-    });
-  });
-});