chore: migrate CLI to ESM and vitest (#6777)

* chore: migrate CLI to ESM and vitest

* fix lint

* update github workflow

* format

.github/workflows/test.yml

@@ -151,7 +151,7 @@ jobs:
         run: npm ci
 
       - name: Run npm install (server)
-        run: npm ci
+        run: npm ci && npm run build
         working-directory: ./server
 
       - name: Run e2e tests

cli/package.json

@@ -2,7 +2,8 @@
   "name": "@immich/cli",
   "version": "2.0.6",
   "description": "Command Line Interface (CLI) for Immich",
-  "main": "dist/index.js",
+  "type": "module",
+  "exports": "./dist/index.js",
   "bin": {
     "immich": "./dist/src/index.js"
   },
@@ -25,61 +26,33 @@
     "@testcontainers/postgresql": "^10.4.0",
     "@types/byte-size": "^8.1.0",
     "@types/cli-progress": "^3.11.0",
-    "@types/jest": "^29.5.2",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^20.3.1",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
+    "@vitest/coverage-v8": "^1.2.2",
     "eslint": "^8.43.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-jest": "^27.2.2",
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-unicorn": "^50.0.0",
     "immich": "file:../server",
-    "jest": "^29.5.0",
-    "jest-extended": "^4.0.0",
     "mock-fs": "^5.2.0",
-    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.3",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "vitest": "^1.2.1"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" --max-warnings 0",
     "lint:fix": "npm run lint -- --fix",
     "prepack": "npm run build",
-    "test": "jest",
+    "test": "vitest",
-    "test:cov": "jest --coverage",
+    "test:cov": "vitest --coverage",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
     "check": "tsc --noEmit",
-    "test:e2e": "jest --config test/e2e/jest-e2e.json --runInBand"
+    "test:e2e": "vitest --config test/e2e/vitest.config.ts"
-  },
-  "jest": {
-    "clearMocks": true,
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": ".",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.ts$": "ts-jest"
-    },
-    "collectCoverageFrom": [
-      "<rootDir>/src/**/*.(t|j)s",
-      "!**/open-api/**"
-    ],
-    "moduleNameMapper": {
-      "^@test(|/.*)$": "<rootDir>../server/test/$1",
-      "^@app/immich(|/.*)$": "<rootDir>../server/src/immich/$1",
-      "^@app/infra(|/.*)$": "<rootDir>../server/src/infra/$1",
-      "^@app/domain(|/.*)$": "<rootDir>../server/src/domain/$1"
-    },
-    "coverageDirectory": "./coverage",
-    "testEnvironment": "node"
   },
   "repository": {
     "type": "git",

cli/src/services/session.service.spec.ts

@@ -12,28 +12,21 @@ import {
   spyOnConsole,
 } from '../../test/cli-test-utils';
 
-const mockPingServer = jest.fn(() => Promise.resolve({ data: { res: 'pong' } }));
+const mockPingServer = vi.fn(() => Promise.resolve({ data: { res: 'pong' } }));
-const mockUserInfo = jest.fn(() => Promise.resolve({ data: { email: 'admin@example.com' } }));
+const mockUserInfo = vi.fn(() => Promise.resolve({ data: { email: 'admin@example.com' } }));
-
+
-jest.mock('@immich/sdk', () => {
+vi.mock('@immich/sdk', async () => ({
-  return {
+  ...(await vi.importActual('@immich/sdk')),
-    ...jest.requireActual('@immich/sdk'),
+  UserApi: vi.fn().mockImplementation(() => {
-    UserApi: jest.fn().mockImplementation(() => {
+    return { getMyUserInfo: mockUserInfo };
-      return { getMyUserInfo: mockUserInfo };
+  }),
-    }),
+  ServerInfoApi: vi.fn().mockImplementation(() => {
-    ServerInfoApi: jest.fn().mockImplementation(() => {
+    return { pingServer: mockPingServer };
-      return { pingServer: mockPingServer };
+  }),
-    }),
+}));
-  };
-});
 
 describe('SessionService', () => {
   let sessionService: SessionService;
-  let consoleSpy: jest.SpyInstance;
-
-  beforeAll(() => {
-    consoleSpy = spyOnConsole();
-  });
 
   beforeEach(() => {
     deleteAuthFile();
@@ -93,6 +86,8 @@ describe('SessionService', () => {
   });
 
   it('should delete auth file when logging out', async () => {
+    const consoleSpy = spyOnConsole();
+
     await createTestAuthFile(
       JSON.stringify({
         apiKey: TEST_IMMICH_API_KEY,

cli/test/cli-test-utils.ts

@@ -27,7 +27,7 @@ export const setup = async () => {
   return api;
 };
 
-export const spyOnConsole = () => jest.spyOn(console, 'log').mockImplementation();
+export const spyOnConsole = () => vi.spyOn(console, 'log').mockImplementation(() => {});
 
 export const createTestAuthFile = async (contents: string) => {
   if (!fs.existsSync(TEST_CONFIG_DIR)) {

cli/test/e2e/jest-e2e.json

@@ -1,24 +0,0 @@
-{
-  "moduleFileExtensions": ["js", "json", "ts"],
-  "modulePaths": ["<rootDir>"],
-  "rootDir": "../..",
-  "globalSetup": "<rootDir>/test/e2e/setup.ts",
-  "testEnvironment": "node",
-  "testRegex": ".e2e-spec.ts$",
-  "testTimeout": 6000000,
-  "transform": {
-    "^.+\\.ts$": "ts-jest"
-  },
-  "collectCoverageFrom": [
-    "<rootDir>/src/**/*.(t|j)s",
-    "!<rootDir>/src/**/*.spec.(t|s)s",
-    "!<rootDir>/src/infra/migrations/**"
-  ],
-  "coverageDirectory": "./coverage",
-  "moduleNameMapper": {
-    "^@test(|/.*)$": "<rootDir>../server/test/$1",
-    "^@app/immich(|/.*)$": "<rootDir>../server/src/immich/$1",
-    "^@app/infra(|/.*)$": "<rootDir>../server/src/infra/$1",
-    "^@app/domain(|/.*)$": "<rootDir>/../server/src/domain/$1"
-  }
-}

cli/test/e2e/login-key.e2e-spec.ts

@@ -1,4 +1,4 @@
-import { restoreTempFolder, testApp } from '@test/../e2e/jobs/utils';
+import { restoreTempFolder, testApp } from '@test-utils';
 import { CLI_BASE_OPTIONS, setup, spyOnConsole } from 'test/cli-test-utils';
 import { LoginCommand } from '../../src/commands/login';
 

cli/test/e2e/server-info.e2e-spec.ts

@@ -1,4 +1,4 @@
-import { restoreTempFolder, testApp } from '@test/../e2e/jobs/utils';
+import { restoreTempFolder, testApp } from '@test-utils';
 import { CLI_BASE_OPTIONS, setup, spyOnConsole } from 'test/cli-test-utils';
 import { ServerInfoCommand } from '../../src/commands/server-info.command';
 

cli/test/e2e/upload.e2e-spec.ts

@@ -1,4 +1,4 @@
-import { IMMICH_TEST_ASSET_PATH, restoreTempFolder, testApp } from '@test/../e2e/jobs/utils';
+import { IMMICH_TEST_ASSET_PATH, restoreTempFolder, testApp } from '@test-utils';
 import { CLI_BASE_OPTIONS, setup, spyOnConsole } from 'test/cli-test-utils';
 import { UploadCommand } from '../../src/commands/upload.command';
 import { ImmichApi } from '../../src/services/api.service';

cli/test/e2e/vitest.config.ts

@@ -0,0 +1,22 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  resolve: {
+    alias: {
+      '@test-utils': new URL('../../../server/dist/test-utils/utils.js', import.meta.url).pathname,
+    },
+  },
+  test: {
+    include: ['**/*.e2e-spec.ts'],
+    globals: true,
+    globalSetup: 'test/e2e/setup.ts',
+    pool: 'forks',
+    poolOptions: {
+      forks: {
+        maxForks: 1,
+        minForks: 1,
+      },
+    },
+    testTimeout: 10000,
+  },
+});

cli/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
+    "module": "esnext",
+    "moduleResolution": "bundler",
     "strict": true,
     "declaration": true,
     "removeComments": true,
@@ -19,13 +20,15 @@
     "paths": {
       "@test": ["../server/test"],
       "@test/*": ["../server/test/*"],
+      "@test-utils": ["../server/src/test-utils/utils"],
       "@app/immich": ["../server/src/immich"],
       "@app/immich/*": ["../server/src/immich/*"],
       "@app/infra": ["../server/src/infra"],
       "@app/infra/*": ["../server/src/infra/*"],
       "@app/domain": ["../server/src/domain"],
       "@app/domain/*": ["../server/src/domain/*"]
-    }
+    },
+    "types": ["vitest/globals"]
   },
   "exclude": ["dist", "node_modules", "upload"]
 }

cli/vitest.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+  },
+});

server/e2e/jobs/specs/formats.e2e-spec.ts

@@ -2,8 +2,8 @@ import { LoginResponseDto } from '@app/domain';
 import { AssetType } from '@app/infra/entities';
 import { readFile } from 'fs/promises';
 import { basename, join } from 'path';
+import { IMMICH_TEST_ASSET_PATH, testApp } from '../../../src/test-utils/utils';
 import { api } from '../../client';
-import { IMMICH_TEST_ASSET_PATH, testApp } from '../utils';
 
 const JPEG = {
   type: AssetType.IMAGE,

server/e2e/jobs/specs/library.e2e-spec.ts

@@ -5,8 +5,13 @@ import { errorStub, uuidStub } from '@test/fixtures';
 import * as fs from 'fs';
 import request from 'supertest';
 import { utimes } from 'utimes';
+import {
+  IMMICH_TEST_ASSET_PATH,
+  IMMICH_TEST_ASSET_TEMP_PATH,
+  restoreTempFolder,
+  testApp,
+} from '../../../src/test-utils/utils';
 import { api } from '../../client';
-import { IMMICH_TEST_ASSET_PATH, IMMICH_TEST_ASSET_TEMP_PATH, restoreTempFolder, testApp } from '../utils';
 
 describe(`${LibraryController.name} (e2e)`, () => {
   let server: any;

server/e2e/jobs/specs/metadata.e2e-spec.ts

@@ -3,8 +3,14 @@ import { AssetController } from '@app/immich';
 import { INestApplication } from '@nestjs/common';
 import { exiftool } from 'exiftool-vendored';
 import { readFile, writeFile } from 'fs/promises';
+import {
+  IMMICH_TEST_ASSET_PATH,
+  IMMICH_TEST_ASSET_TEMP_PATH,
+  db,
+  restoreTempFolder,
+  testApp,
+} from '../../../src/test-utils/utils';
 import { api } from '../../client';
-import { IMMICH_TEST_ASSET_PATH, IMMICH_TEST_ASSET_TEMP_PATH, db, restoreTempFolder, testApp } from '../utils';
 
 describe(`${AssetController.name} (e2e)`, () => {
   let app: INestApplication;

server/src/immich/api-v1/asset/asset-repository.ts

@@ -3,8 +3,8 @@ import { AssetEntity, ExifEntity } from '@app/infra/entities';
 import { OptionalBetween } from '@app/infra/infra.utils';
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
-import { In } from 'typeorm/find-options/operator/In';
+import { In } from 'typeorm/find-options/operator/In.js';
-import { Repository } from 'typeorm/repository/Repository';
+import { Repository } from 'typeorm/repository/Repository.js';
 import { AssetSearchDto } from './dto/asset-search.dto';
 import { CheckExistingAssetsDto } from './dto/check-existing-assets.dto';
 import { SearchPropertiesDto } from './dto/search-properties.dto';

server/src/infra/database.config.ts

@@ -1,5 +1,5 @@
 import { DataSource } from 'typeorm';
-import { PostgresConnectionOptions } from 'typeorm/driver/postgres/PostgresConnectionOptions';
+import { PostgresConnectionOptions } from 'typeorm/driver/postgres/PostgresConnectionOptions.js';
 
 const url = process.env.DB_URL;
 const urlOrParts = url

server/src/infra/entities/exif.entity.ts

@@ -1,6 +1,6 @@
 import { Index, JoinColumn, OneToOne, PrimaryColumn } from 'typeorm';
-import { Column } from 'typeorm/decorator/columns/Column';
+import { Column } from 'typeorm/decorator/columns/Column.js';
-import { Entity } from 'typeorm/decorator/entity/Entity';
+import { Entity } from 'typeorm/decorator/entity/Entity.js';
 import { AssetEntity } from './asset.entity';
 
 @Entity('exif')

server/src/infra/repositories/library.repository.ts

@@ -2,7 +2,7 @@ import { ILibraryRepository, LibraryStatsResponseDto } from '@app/domain';
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
 import { IsNull, Not } from 'typeorm';
-import { Repository } from 'typeorm/repository/Repository';
+import { Repository } from 'typeorm/repository/Repository.js';
 import { LibraryEntity, LibraryType } from '../entities';
 import { DummyValue, GenerateSql } from '../infra.util';
 

server/src/test-utils/utils.ts

@@ -9,7 +9,7 @@ import * as fs from 'node:fs';
 import path from 'node:path';
 import { Server } from 'node:tls';
 import { EntityTarget, ObjectLiteral } from 'typeorm';
-import { AppService } from '../../src/microservices/app.service';
+import { AppService } from '../microservices/app.service';
 
 export const IMMICH_TEST_ASSET_PATH = process.env.IMMICH_TEST_ASSET_PATH as string;
 export const IMMICH_TEST_ASSET_TEMP_PATH = path.normalize(`${IMMICH_TEST_ASSET_PATH}/temp/`);