feat: replace jest with vitest

DIYgod · Mar 3, 2024 · 38e4215 · 38e4215
1 parent 3bfdf94
commit 38e4215
Show file tree

Hide file tree

Showing 38 changed files with 698 additions and 1,646 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -18,7 +18,7 @@ permissions:
   contents: read
 
 jobs:
-  jest:
+  vitest:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     services:
@@ -31,7 +31,7 @@ jobs:
       fail-fast: false
       matrix:
         node-version: [ 18, 20, 21 ]
-    name: Jest on Node ${{ matrix.node-version }}
+    name: Vitest on Node ${{ matrix.node-version }}
     steps:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v3
@@ -46,7 +46,7 @@ jobs:
       - name: Run postinstall script for dependencies
         run: pnpm rb
       - name: Test all and generate coverage
-        run: pnpm run jest:coverage
+        run: pnpm run vitest:coverage
         env:
           REDIS_URL: redis://localhost:${{ job.services.redis.ports[6379] }}/
       - name: Upload coverage to Codecov
@@ -72,7 +72,7 @@ jobs:
           - name: Chrome from Google
             dependency: google-chrome-stable
             environment: '{ "CHROMIUM_EXECUTABLE_PATH": "google-chrome-stable" }'
-    name: Jest puppeteer on Node ${{ matrix.node-version }} with ${{ matrix.chromium.name }}
+    name: Vitest puppeteer on Node ${{ matrix.node-version }} with ${{ matrix.chromium.name }}
     steps:
       - uses: actions/checkout@v4
       - uses: pnpm/action-setup@v3
@@ -101,7 +101,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install -yq --no-install-recommends ${{ matrix.chromium.dependency }}
       - name: Test puppeteer
-        run: pnpm run jest puppeteer
+        run: pnpm run vitest puppeteer
         env: ${{ fromJSON(matrix.chromium.environment) }}
 
   docs:
@@ -153,7 +153,7 @@ jobs:
 
   automerge:
     if: github.triggering_actor == 'dependabot[bot]' && github.event_name == 'pull_request'
-    needs: [ jest, puppeteer, docs, all ]
+    needs: [ vitest, puppeteer, docs, all ]
     runs-on: ubuntu-latest
     permissions:
       pull-requests: write

diff --git a/lib/app.test.ts b/lib/app.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it } from '@jest/globals';
+import { describe, expect, it } from 'vitest';
 
 import app from '@/app';
 

diff --git a/lib/config.test.ts b/lib/config.test.ts
@@ -1,8 +1,8 @@
-import { describe, expect, it, afterEach, jest } from '@jest/globals';
+import { describe, expect, it, afterEach, vi } from 'vitest';
 import nock from 'nock';
 
 afterEach(() => {
-    jest.resetModules();
+    vi.resetModules();
 });
 
 describe('config', () => {

diff --git a/lib/config.ts b/lib/config.ts
@@ -633,16 +633,18 @@ calculateValue();
 
 if (envs.REMOTE_CONFIG) {
     got.get(envs.REMOTE_CONFIG)
-        .then((response) => {
+        .then(async (response) => {
             const data = JSON.parse(response.body);
             if (data) {
                 envs = Object.assign(envs, data);
                 calculateValue();
-                require('@/utils/logger').default.info('Remote config loaded.');
+                const { default: logger } = await import('@/utils/logger');
+                logger.info('Remote config loaded.');
             }
         })
-        .catch((error) => {
-            require('@/utils/logger').default.error('Remote config load failed.', error);
+        .catch(async (error) => {
+            const { default: logger } = await import('@/utils/logger');
+            logger.error('Remote config load failed.', error);
         });
 }
 

diff --git a/lib/errors/index.test.ts b/lib/errors/index.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it, afterAll } from '@jest/globals';
+import { describe, expect, it, afterAll } from 'vitest';
 import supertest from 'supertest';
 import server from '@/index';
 import { load } from 'cheerio';

diff --git a/lib/middleware/access-control.test.ts b/lib/middleware/access-control.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it, jest, afterEach } from '@jest/globals';
+import { describe, expect, it, vi, afterEach } from 'vitest';
 import md5 from '@/utils/md5';
 
 process.env.NODE_NAME = 'mock';
@@ -10,7 +10,7 @@ async function checkBlock(response) {
 
 afterEach(() => {
     delete process.env.ACCESS_KEY;
-    jest.resetModules();
+    vi.resetModules();
 });
 
 describe('access-control', () => {

diff --git a/lib/middleware/anti-hotlink.test.ts b/lib/middleware/anti-hotlink.test.ts
@@ -1,8 +1,7 @@
-import { describe, expect, it, jest, afterEach, afterAll } from '@jest/globals';
+import { describe, expect, it, vi, afterEach, afterAll } from 'vitest';
 import Parser from 'rss-parser';
 
 const parser = new Parser();
-jest.setTimeout(50000);
 
 afterAll(() => {
     delete process.env.HOTLINK_TEMPLATE;
@@ -16,7 +15,7 @@ afterEach(() => {
     delete process.env.HOTLINK_INCLUDE_PATHS;
     delete process.env.HOTLINK_EXCLUDE_PATHS;
     delete process.env.ALLOW_USER_HOTLINK_TEMPLATE;
-    jest.resetModules();
+    vi.resetModules();
 });
 
 const expects = {

diff --git a/lib/middleware/cache.test.ts b/lib/middleware/cache.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it, jest, afterEach, afterAll, beforeAll } from '@jest/globals';
+import { describe, expect, it, vi, afterEach, afterAll, beforeAll } from 'vitest';
 import Parser from 'rss-parser';
 import wait from '@/utils/wait';
 
@@ -11,7 +11,7 @@ beforeAll(() => {
 
 afterEach(() => {
     delete process.env.CACHE_TYPE;
-    jest.resetModules();
+    vi.resetModules();
 });
 
 afterAll(() => {

diff --git a/lib/middleware/debug.test.ts b/lib/middleware/debug.test.ts
@@ -1,16 +1,9 @@
-import { describe, expect, it } from '@jest/globals';
+import { describe, expect, it } from 'vitest';
 import app from '@/app';
 import { load } from 'cheerio';
 
 process.env.NODE_NAME = 'mock';
 
-let gitHash;
-try {
-    gitHash = require('git-rev-sync').short();
-} catch {
-    gitHash = (process.env.HEROKU_SLUG_COMMIT && process.env.HEROKU_SLUG_COMMIT.slice(0, 7)) || 'unknown';
-}
-
 describe('debug', () => {
     it('debug', async () => {
         const response1 = await app.request('/test/1');
@@ -34,9 +27,6 @@ describe('debug', () => {
                 case 'Node Name:':
                     expect(value).toBe('mock');
                     break;
-                case 'Git Hash:':
-                    expect(value).toBe(gitHash);
-                    break;
                 case 'Request Amount:':
                     expect(value).toBe('6');
                     break;

diff --git a/lib/middleware/filter-engine.test.ts b/lib/middleware/filter-engine.test.ts
@@ -1,14 +1,12 @@
-import { describe, expect, it, afterAll, jest, afterEach } from '@jest/globals';
-
-jest.setTimeout(50000);
+import { describe, expect, it, afterAll, vi, afterEach } from 'vitest';
 
 afterAll(() => {
     delete process.env.FILTER_REGEX_ENGINE;
 });
 
 afterEach(() => {
     delete process.env.FILTER_REGEX_ENGINE;
-    jest.resetModules();
+    vi.resetModules();
 });
 
 describe('filter-engine', () => {

diff --git a/lib/middleware/header.test.ts b/lib/middleware/header.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it, afterAll } from '@jest/globals';
+import { describe, expect, it, afterAll } from 'vitest';
 
 process.env.NODE_NAME = 'mock';
 process.env.ALLOW_ORIGIN = 'rsshub.mock';

diff --git a/lib/middleware/parameter.test.ts b/lib/middleware/parameter.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it, jest } from '@jest/globals';
+import { describe, expect, it, vi } from 'vitest';
 import app from '@/app';
 import Parser from 'rss-parser';
 import { config } from '@/config';
@@ -423,7 +423,7 @@ describe('multi parameter', () => {
 
 describe('openai', () => {
     it(`chatgpt`, async () => {
-        jest.resetModules();
+        vi.resetModules();
 
         process.env.OPENAI_API_KEY = 'sk-1234567890';
         const app = (await import('@/app')).default;

diff --git a/lib/middleware/template.test.ts b/lib/middleware/template.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it } from '@jest/globals';
+import { describe, expect, it } from 'vitest';
 import app from '@/app';
 import Parser from 'rss-parser';
 

diff --git a/lib/pkg.test.ts b/lib/pkg.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it } from '@jest/globals';
+import { describe, expect, it } from 'vitest';
 import { init, request } from './pkg';
 
 describe('pkg', () => {
@@ -10,64 +10,59 @@ describe('pkg', () => {
         expect(config.ua).toBe('mock');
     });
 
-    it('request', (done) => {
-        request('/test/1').then((data) => {
-            expect(data).toMatchObject({
-                atomlink: 'http://localhost/test/1',
-                title: 'Test 1',
-                itunes_author: null,
-                link: 'https://github.com/DIYgod/RSSHub',
-                item: [
-                    {
-                        title: 'Title1',
-                        description: 'Description1',
-                        pubDate: 'Mon, 31 Dec 2018 15:59:50 GMT',
-                        link: 'https://github.com/DIYgod/RSSHub/issues/1',
-                        author: 'DIYgod1',
-                    },
-                    {
-                        title: 'Title2',
-                        description: 'Description2',
-                        pubDate: 'Mon, 31 Dec 2018 15:59:40 GMT',
-                        link: 'https://github.com/DIYgod/RSSHub/issues/2',
-                        author: 'DIYgod2',
-                    },
-                    {
-                        title: 'Title3',
-                        description: 'Description3',
-                        pubDate: 'Mon, 31 Dec 2018 15:59:30 GMT',
-                        link: 'https://github.com/DIYgod/RSSHub/issues/3',
-                        author: 'DIYgod3',
-                    },
-                    {
-                        title: 'Title4',
-                        description: 'Description4',
-                        pubDate: 'Mon, 31 Dec 2018 15:59:20 GMT',
-                        link: 'https://github.com/DIYgod/RSSHub/issues/4',
-                        author: 'DIYgod4',
-                    },
-                    {
-                        title: 'Title5',
-                        description: 'Description5',
-                        pubDate: 'Mon, 31 Dec 2018 15:59:10 GMT',
-                        link: 'https://github.com/DIYgod/RSSHub/issues/5',
-                        author: 'DIYgod5',
-                    },
-                ],
-                allowEmpty: false,
-            });
-            done();
+    it('request', async () => {
+        const data = await request('/test/1');
+        expect(data).toMatchObject({
+            atomlink: 'http://localhost/test/1',
+            title: 'Test 1',
+            itunes_author: null,
+            link: 'https://github.com/DIYgod/RSSHub',
+            item: [
+                {
+                    title: 'Title1',
+                    description: 'Description1',
+                    pubDate: 'Mon, 31 Dec 2018 15:59:50 GMT',
+                    link: 'https://github.com/DIYgod/RSSHub/issues/1',
+                    author: 'DIYgod1',
+                },
+                {
+                    title: 'Title2',
+                    description: 'Description2',
+                    pubDate: 'Mon, 31 Dec 2018 15:59:40 GMT',
+                    link: 'https://github.com/DIYgod/RSSHub/issues/2',
+                    author: 'DIYgod2',
+                },
+                {
+                    title: 'Title3',
+                    description: 'Description3',
+                    pubDate: 'Mon, 31 Dec 2018 15:59:30 GMT',
+                    link: 'https://github.com/DIYgod/RSSHub/issues/3',
+                    author: 'DIYgod3',
+                },
+                {
+                    title: 'Title4',
+                    description: 'Description4',
+                    pubDate: 'Mon, 31 Dec 2018 15:59:20 GMT',
+                    link: 'https://github.com/DIYgod/RSSHub/issues/4',
+                    author: 'DIYgod4',
+                },
+                {
+                    title: 'Title5',
+                    description: 'Description5',
+                    pubDate: 'Mon, 31 Dec 2018 15:59:10 GMT',
+                    link: 'https://github.com/DIYgod/RSSHub/issues/5',
+                    author: 'DIYgod5',
+                },
+            ],
+            allowEmpty: false,
         });
     });
 
-    it('error', (done) => {
-        request('/test/error')
-            .then(() => {
-                done();
-            })
-            .catch((error) => {
-                expect(error).toBe('Error test');
-                done();
-            });
+    it('error', async () => {
+        try {
+            await request('/test/error');
+        } catch (error) {
+            expect(error).toBe('Error test');
+        }
     });
 });
diff --git a/lib/routes.test.ts b/lib/routes.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it, afterAll } from '@jest/globals';
+import { describe, expect, it, afterAll } from 'vitest';
 process.env.SOCKET = 'socket';
 
 import app from '@/app';

diff --git a/lib/routes.ts b/lib/routes.ts
@@ -10,21 +10,25 @@ type Root = {
     get: (routePath: string, filePath: string) => void;
 };
 
-const imports = directoryImport({
-    targetDirectoryPath: path.join(__dirname, './routes'),
-    importPattern: /router\.js$/,
-});
-
 const routes: Record<string, (root: Root) => void> = {};
 
-for (const path in imports) {
-    const name = path.split('/').find(Boolean);
-    if (name) {
-        routes[name] = (
-            imports[path] as {
-                default: (root: Root) => void;
-            }
-        ).default;
+if (process.env.NODE_ENV === 'test') {
+    routes.test = (await import('./routes/test/router')).default;
+} else {
+    const imports = directoryImport({
+        targetDirectoryPath: path.join(__dirname, './routes'),
+        importPattern: /router\.js$/,
+    });
+
+    for (const path in imports) {
+        const name = path.split('/').find(Boolean);
+        if (name) {
+            routes[name] = (
+                imports[path] as {
+                    default: (root: Root) => void;
+                }
+            ).default;
+        }
     }
 }