Merge pull request #64 from HichemTab-tech/add-integration-tests

Add tests for plugins, transformers, and integration

Author: HichemTab-tech

package-lock.json

@@ -20,7 +20,9 @@
     }
   },
   "scripts": {
-    "build": "vite build && node add-banner.js"
+    "build": "vite build && node add-banner.js",
+    "test": "vitest run",
+    "test:watch": "vitest"
   },
   "keywords": [
     "typescript",
@@ -40,6 +42,7 @@
     "ts-loader": "^9.5.1",
     "typescript": "^5.0.0",
     "vite": "^6.0.3",
+    "vitest": "^3.1.4",
     "webpack": "^5.97.1",
     "webpack-cli": "^6.0.1"
   }

package.json

@@ -0,0 +1,20 @@
+import { describe, it, expect } from 'vitest';
+import { createPicker, createFullPicker } from '../src';
+
+describe('index', () => {
+  describe('createPicker', () => {
+    it('should throw an error when called directly', () => {
+      expect(() => {
+        createPicker<{ name: string }>()({}); 
+      }).toThrow('createPicker is a placeholder. Use the ts-runtime-picker plugin to transform it during build.');
+    });
+  });
+
+  describe('createFullPicker', () => {
+    it('should throw an error when called directly', () => {
+      expect(() => {
+        createFullPicker<{ name: string }>()({}); 
+      }).toThrow('createFullPicker is a placeholder. Use the ts-runtime-picker plugin to transform it during build.');
+    });
+  });
+});

test/index.test.ts

@@ -0,0 +1,92 @@
+import { describe, it, expect } from 'vitest';
+import { transform } from '../src/ts-transformer';
+
+describe('Integration', () => {
+  it('should transform createPicker to pick only specified properties', () => {
+    // noinspection NpmUsedModulesInstalled,JSUnresolvedReference,UnnecessaryLabelJS,BadExpressionStatementJS,JSValidateTypes,JSUnusedLocalSymbols
+    const code = `
+      // noinspection JSAnnotator
+      
+      import { createPicker } from "ts-runtime-picker";
+
+      interface User {
+        firstName: string;
+        lastName: string;
+        email: string;
+        password: string;
+      }
+
+      const picker = createPicker<User>();
+
+      const user = {
+        firstName: "John",
+        lastName: "Doe",
+        email: "john.doe@example.com",
+        password: "secret",
+        extraData: "will be removed"
+      };
+
+      const result = picker(user);
+    `;
+
+    const filePath = 'test-file.ts';
+    const transformedCode = transform(code, filePath);
+
+    // Verify the transformation
+    expect(transformedCode).toContain('const _keys: string[] = ["firstName","lastName","email","password"]');
+    expect(transformedCode).not.toContain('createPicker<User>()');
+
+    // Instead of executing the code (which would fail due to import statements),
+    // we'll verify the structure of the transformed code
+
+    // Check that the picker function is correctly transformed
+    expect(transformedCode).toContain('const picker = (_obj: any) => {');
+    expect(transformedCode).toContain('const _keys: string[] = ["firstName","lastName","email","password"]');
+    expect(transformedCode).toContain('return _keys.reduce((_acc: {[k: string]: any}, _key: string) => {');
+    expect(transformedCode).toContain('if (_key in _obj) _acc[_key] = _obj[_key];');
+    expect(transformedCode).toContain('return _acc;');
+    expect(transformedCode).toContain('}, {});');
+  });
+
+  it('should transform createFullPicker to pick all properties', () => {
+    // noinspection NpmUsedModulesInstalled,JSUnresolvedReference,UnnecessaryLabelJS,BadExpressionStatementJS,JSValidateTypes,JSUnusedLocalSymbols
+    const code = `
+      // noinspection JSAnnotator
+      
+      import { createFullPicker } from "ts-runtime-picker";
+
+      interface User {
+        firstName: string;
+        lastName: string;
+      }
+
+      const picker = createFullPicker<User>();
+
+      const user = {
+        firstName: "John",
+        lastName: "Doe",
+        extraData: "will be removed"
+      };
+
+      const result = picker(user);
+    `;
+
+    const filePath = 'test-file.ts';
+    const transformedCode = transform(code, filePath);
+
+    // Verify the transformation
+    expect(transformedCode).toContain('const _keys: string[] = ["firstName","lastName"]');
+    expect(transformedCode).not.toContain('createFullPicker<User>()');
+
+    // Instead of executing the code (which would fail due to import statements),
+    // we'll verify the structure of the transformed code
+
+    // Check that the picker function is correctly transformed
+    expect(transformedCode).toContain('const picker = (_obj: any) => {');
+    expect(transformedCode).toContain('const _keys: string[] = ["firstName","lastName"]');
+    expect(transformedCode).toContain('return _keys.reduce((_acc: {[k: string]: any}, _key: string) => {');
+    expect(transformedCode).toContain('if (_key in _obj) _acc[_key] = _obj[_key];');
+    expect(transformedCode).toContain('return _acc;');
+    expect(transformedCode).toContain('}, {});');
+  });
+});

test/integration.test.ts

@@ -0,0 +1,85 @@
+import { describe, it, expect } from 'vitest';
+import { transform } from '../src/ts-transformer';
+
+describe('ts-transformer', () => {
+  it('should transform createPicker calls', () => {
+    const code = `
+      import { createPicker } from "ts-runtime-picker";
+
+      interface User {
+        firstName: string;
+        lastName: string;
+        email: string;
+      }
+
+      const picker = createPicker<User>();
+    `;
+
+    const filePath = 'test-file.ts';
+    const result = transform(code, filePath);
+
+    // The transformed code should contain the runtime implementation
+    expect(result).toContain('const picker = (_obj: any) => {');
+    expect(result).toContain('const _keys: string[] = ["firstName","lastName","email"]');
+    expect(result).toContain('if (_key in _obj) _acc[_key] = _obj[_key];');
+  });
+
+  it('should handle aliased imports', () => {
+    const code = `
+      import { createPicker as cp } from "ts-runtime-picker";
+
+      interface User {
+        firstName: string;
+        lastName: string;
+      }
+
+      const picker = cp<User>();
+    `;
+
+    const filePath = 'test-file.ts';
+    const result = transform(code, filePath);
+
+    // The transformed code should contain the runtime implementation
+    expect(result).toContain('const picker = (_obj: any) => {');
+    expect(result).toContain('const _keys: string[] = ["firstName","lastName"]');
+  });
+
+  it('should not transform code without createPicker imports', () => {
+    const code = `
+      interface User {
+        firstName: string;
+        lastName: string;
+      }
+
+      const picker = someOtherFunction<User>();
+    `;
+
+    const filePath = 'test-file.ts';
+    const result = transform(code, filePath);
+
+    // The code should remain unchanged
+    expect(result).toBe(code);
+  });
+
+  it('should transform createFullPicker calls', () => {
+    const code = `
+      import { createFullPicker } from "ts-runtime-picker";
+
+      interface User {
+        firstName: string;
+        lastName: string;
+        email: string;
+      }
+
+      const picker = createFullPicker<User>();
+    `;
+
+    const filePath = 'test-file.ts';
+    const result = transform(code, filePath);
+
+    // The transformed code should contain the runtime implementation
+    expect(result).toContain('const picker = (_obj: any) => {');
+    expect(result).toContain('const _keys: string[] = ["firstName","lastName","email"]');
+    expect(result).toContain('if (_key in _obj) _acc[_key] = _obj[_key];');
+  });
+});

test/ts-transformer.test.ts

@@ -0,0 +1,61 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { TsRuntimePickerVitePlugin } from '../src/vite-plugin';
+import * as transformer from '../src/ts-transformer';
+
+// Mock the transform function
+vi.mock('../src/ts-transformer', () => ({
+  transform: vi.fn((code) => `transformed: ${code}`)
+}));
+
+beforeEach(() => {
+  vi.clearAllMocks();
+});
+
+describe('TsRuntimePickerVitePlugin', () => {
+  it('should create a Vite plugin with the correct configuration', () => {
+    const plugin = TsRuntimePickerVitePlugin();
+
+    expect(plugin.name).toBe('vite-plugin-ts-runtime-picker');
+    expect(plugin.enforce).toBe('pre');
+    expect(typeof plugin.transform).toBe('function');
+  });
+
+  it('should transform TypeScript files', () => {
+    const plugin = TsRuntimePickerVitePlugin();
+    const code = 'const x = 1;';
+    const id = 'file.ts';
+
+    const result = plugin.transform(code, id);
+
+    expect(transformer.transform).toHaveBeenCalledWith(code, id);
+    expect(result).toEqual({
+      code: `transformed: ${code}`,
+      map: null
+    });
+  });
+
+  it('should transform TypeScript JSX files', () => {
+    const plugin = TsRuntimePickerVitePlugin();
+    const code = 'const x = <div />;';
+    const id = 'file.tsx';
+
+    const result = plugin.transform(code, id);
+
+    expect(transformer.transform).toHaveBeenCalledWith(code, id);
+    expect(result).toEqual({
+      code: `transformed: ${code}`,
+      map: null
+    });
+  });
+
+  it('should not transform non-TypeScript files', () => {
+    const plugin = TsRuntimePickerVitePlugin();
+    const code = 'const x = 1;';
+    const id = 'file.js';
+
+    const result = plugin.transform(code, id);
+
+    expect(transformer.transform).not.toHaveBeenCalled();
+    expect(result).toBeNull();
+  });
+});

test/vite-plugin.test.ts

@@ -0,0 +1,73 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import TsRuntimePickerWebpackLoader from '../src/webpack-loader';
+import * as transformer from '../src/ts-transformer';
+
+// Mock the transform function
+vi.mock('../src/ts-transformer', () => ({
+  transform: vi.fn((code) => `transformed: ${code}`)
+}));
+
+describe('TsRuntimePickerWebpackLoader', () => {
+  let loaderContext: any;
+  let callback: any;
+  
+  beforeEach(() => {
+    // Reset mocks
+    vi.clearAllMocks();
+    
+    // Create a mock loader context
+    callback = vi.fn();
+    loaderContext = {
+      resourcePath: 'file.ts',
+      async: () => callback
+    };
+  });
+  
+  it('should transform TypeScript files', () => {
+    const source = 'const x = 1;';
+    const map = { version: 3, sources: [], mappings: '' };
+    
+    TsRuntimePickerWebpackLoader.call(loaderContext, source, map);
+    
+    expect(transformer.transform).toHaveBeenCalledWith(source, 'file.ts');
+    expect(callback).toHaveBeenCalledWith(null, `transformed: ${source}`, map);
+  });
+  
+  it('should transform TypeScript JSX files', () => {
+    loaderContext.resourcePath = 'file.tsx';
+    const source = 'const x = <div />;';
+    const map = { version: 3, sources: [], mappings: '' };
+    
+    TsRuntimePickerWebpackLoader.call(loaderContext, source, map);
+    
+    expect(transformer.transform).toHaveBeenCalledWith(source, 'file.tsx');
+    expect(callback).toHaveBeenCalledWith(null, `transformed: ${source}`, map);
+  });
+  
+  it('should handle errors during transformation', () => {
+    const error = new Error('Transformation error');
+    (transformer.transform as any).mockImplementationOnce(() => {
+      throw error;
+    });
+    
+    const source = 'const x = 1;';
+    const map = { version: 3, sources: [], mappings: '' };
+    
+    TsRuntimePickerWebpackLoader.call(loaderContext, source, map);
+    
+    expect(transformer.transform).toHaveBeenCalledWith(source, 'file.ts');
+    expect(callback).toHaveBeenCalledWith(error);
+  });
+  
+  it('should not transform non-TypeScript files', () => {
+    loaderContext.resourcePath = 'file.js';
+    const source = 'const x = 1;';
+    const map = { version: 3, sources: [], mappings: '' };
+    
+    TsRuntimePickerWebpackLoader.call(loaderContext, source, map);
+    
+    expect(transformer.transform).not.toHaveBeenCalled();
+    // The callback should not be called for non-TypeScript files
+    expect(callback).not.toHaveBeenCalled();
+  });
+});

test/webpack-loader.test.ts

@@ -1,8 +1,15 @@
 import { defineConfig } from 'vite';
 import { resolve } from 'path';
+import { configDefaults } from 'vitest/config';
 
 // noinspection JSUnusedGlobalSymbols
 export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    include: ['**/*.{test,spec}.{js,ts}'],
+    exclude: [...configDefaults.exclude, 'dist/**']
+  },
   build: {
     lib: {
       // Define multiple entry points
@@ -37,4 +44,4 @@ export default defineConfig({
       }
     }
   ]
-});
+});