TypeORMサポートのトライアル

.env.example

@@ -0,0 +1,15 @@
+# # postgres
+# DS_TYPE=postgres
+# DS_DATABASE=ba000001
+# DS_HOST=localhost
+# DS_PORT=5432
+# DS_USERNAME=postgres
+# DS_PASSWORD=postgres
+
+# # mysql
+# DS_TYPE=mysql
+# DS_DATABASE=ba000001
+# DS_HOST=127.0.0.1
+# DS_PORT=3306
+# DS_USERNAME=root
+# DS_PASSWORD=password

.gitignore

@@ -11,4 +11,5 @@ spec/*.sqlite
 *.tgz
 .pnpm-store/
 pnpm-lock.yaml
-.vscode/result.*
+.vscode/result.*
+.env

.vscode/launch.json

@@ -185,6 +185,34 @@
       ],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen",
-    }
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "test",
+      "program": "${workspaceFolder}/node_modules/jest/bin/jest",
+      "preLaunchTask": "npm: build",
+      "runtimeArgs": [
+        "--require",
+        "ts-node/register"
+      ],
+      "args": [
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "test:system",
+      "program": "${workspaceFolder}/spec/execution-test.spec.mjs",
+      "preLaunchTask": "npm: build",
+      "runtimeArgs": [
+        "--require",
+        "ts-node/register"
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+    },
   ]
 }

__mocks__/typeorm.ts

@@ -0,0 +1,52 @@
+// import { jest } from '@jest/globals';
+// import 'reflect-metadata';
+
+export const QueryRunner = jest.fn().mockImplementation(
+  () => {
+    return {
+      isTransactionActive: false,
+      connect: jest.fn().mockImplementation(() => {
+        return Promise.resolve();
+      }),
+      startTransaction: jest.fn(() => {
+        return Promise.resolve();
+      }),
+      connection: {
+        query: jest.fn(() => {
+          return Promise.resolve();
+        })
+      },
+      commitTransaction: jest.fn(() => {
+        return Promise.resolve();
+      }),
+      rollbackTransaction: jest.fn(() => {
+        return Promise.resolve();
+      }),
+      release: jest.fn(() => {
+        return Promise.resolve();
+      })
+    }
+  }
+);
+
+export const DataSource = jest.fn().mockImplementation(
+  () => {
+    return {
+      initialize: jest.fn(() => {
+        return Promise.resolve(this);
+      }),
+      query: jest.fn().mockImplementation(() => {
+        return Promise.resolve([]);
+      }),
+      createQueryRunner: jest.fn().mockImplementation(() => {
+        return new QueryRunner();
+      }),
+      destroy: jest.fn(() => {
+        return Promise.resolve();
+      }),
+      options: {
+        type: 'better-sqlite3'
+      }
+    };
+  }
+);

jest.config.js

@@ -25,6 +25,7 @@ module.exports = {
     'node:fs': '<rootDir>/__mocks__/fs.ts',
     'node:os': '<rootDir>/__mocks__/os.ts',
     'better-sqlite3': '<rootDir>/__mocks__/better-sqlite3.ts',
+    'typeorm': '<rootDir>/__mocks__/typeorm.ts',
     'csv-parser': '<rootDir>/__mocks__/csv-parser.ts',
     ...pathsToModuleNameMapper(compilerOptions.paths),
   },

package.json

@@ -25,7 +25,8 @@
     "test:ci": "jest --runInBand",
     "test:system": "npm run build && node spec/execution-test.spec.mjs",
     "lint": "eslint . --ext .ts",
-    "lint-and-fix": "eslint . --ext .ts --fix"
+    "lint-and-fix": "eslint . --ext .ts --fix",
+    "typeorm": "typeorm-ts-node-commonjs"
   },
   "devDependencies": {
     "@jest/globals": "29.7.0",
@@ -69,14 +70,18 @@
     "cli-infinity-progress": "^0.6.7",
     "cli-progress": "^3.12.0",
     "csv-parser": "^3.0.0",
+    "dotenv": "^16.3.2",
     "http-status-codes": "^2.3.0",
     "i18next": "^23.5.1",
     "lru-cache": "^10.1.0",
+    "mysql2": "^3.7.1",
     "node-stream-zip": "^1.15.0",
+    "pg": "^8.11.3",
     "proj4": "^2.9.1",
     "reflect-metadata": "^0.1.13",
     "string-hash": "^1.1.3",
     "tsyringe": "^4.8.0",
+    "typeorm": "^0.3.19",
     "undici": "^5.26.3",
     "winston": "^3.11.0",
     "yargs": "^17.7.2"

src/abrg-data-source.ts

@@ -0,0 +1,46 @@
+import 'reflect-metadata';
+import { join } from 'path';
+import { DataSource, DataSourceOptions } from 'typeorm';
+import 'dotenv/config';
+
+export const commonOptions = {
+  synchronize: false,
+  logging: false,
+  entities: [join(__dirname, 'entity', '*.{ts,js}')],
+  migrations: [join(__dirname, 'migration', '*.{ts,js}')],
+  migrationsRun: true,
+};
+
+const sqliteOptions: DataSourceOptions = {
+  ...commonOptions,
+  type: 'better-sqlite3',
+  // src/interface-adapter/providers/provide-data-source.ts 内で絶対パスに置換
+  database: 'ba000001.sqlite',
+};
+
+let options: DataSourceOptions = sqliteOptions;
+if (process.env.DS_TYPE === 'postgres') {
+  options = {
+    ...commonOptions,
+    type: 'postgres',
+    host: process.env.DS_HOST,
+    port: Number(process.env.DS_PORT),
+    username: process.env.DS_USERNAME,
+    password: process.env.DS_PASSWORD,
+    database: process.env.DS_DATABASE,
+    parseInt8: true,
+  };
+} else if (process.env.DS_TYPE === 'mysql') {
+  options = {
+    ...commonOptions,
+    type: 'mysql',
+    host: process.env.DS_HOST,
+    port: Number(process.env.DS_PORT),
+    username: process.env.DS_USERNAME,
+    password: process.env.DS_PASSWORD,
+    database: process.env.DS_DATABASE,
+    charset: 'utf8mb4',
+  };
+}
+
+export const AbrgDataSource = new DataSource(options);

src/controller/download/__tests__/download-dataset.spec.ts

@@ -23,7 +23,6 @@
  */
 import { describe, expect, it, jest } from '@jest/globals';
 import mockedFs from '@mock/fs';
-import { default as BetterSqlite3 } from 'better-sqlite3';
 import { downloadDataset } from '../download-dataset';
 import { downloadProcess } from '../process/download-process';
 import { extractDatasetProcess } from '../process/extract-dataset-process';
@@ -32,7 +31,7 @@ import { DOWNLOAD_DATASET_RESULT } from '../download-dataset-result';
 jest.mock('fs');
 jest.mock('node:fs');
 jest.mock('winston');
-jest.mock<BetterSqlite3.Database>('better-sqlite3');
+// jest.mock('typeorm.DataSource');
 jest.mock('@interface-adapter/setup-container');
 jest.mock('@usecase/ckan-downloader/ckan-downloader');
 jest.mock('@domain/key-store/get-value-with-key')

src/controller/download/download-dataset.ts

@@ -28,7 +28,7 @@ import { AbrgMessage } from '@abrg-message/abrg-message';
 import { saveKeyAndValue } from '@domain/key-store/save-key-and-value';
 import { setupContainer } from '@interface-adapter/setup-container';
 import { DI_TOKEN } from '@interface-adapter/tokens';
-import { Database } from 'better-sqlite3';
+import { DataSource } from 'typeorm';
 import fs from 'node:fs';
 import path from 'node:path';
 import { Logger } from 'winston';
@@ -70,9 +70,9 @@ export const downloadDataset = async ({
     return DOWNLOAD_DATASET_RESULT.CAN_NOT_ACCESS_TO_DATASET_ERROR;
   }
 
-  const db = container.resolve<Database>(DI_TOKEN.DATABASE);
+  const ds = container.resolve<DataSource>(DI_TOKEN.DATASOURCE);
   const datasetHistory = await loadDatasetHistory({
-    db,
+    ds,
   });
 
   // --------------------------------------
@@ -92,7 +92,7 @@ export const downloadDataset = async ({
     logger?.info(
       AbrgMessage.toString(AbrgMessage.ERROR_NO_UPDATE_IS_AVAILABLE)
     );
-    db.close();
+    await ds.destroy();
 
     // 展開したzipファイルのディレクトリを削除
     await fs.promises.rm(extractDir, { recursive: true });
@@ -103,18 +103,18 @@ export const downloadDataset = async ({
   logger?.info(AbrgMessage.toString(AbrgMessage.LOADING_INTO_DATABASE));
 
   await loadDatasetProcess({
-    db,
+    ds,
     csvFiles,
     container,
   });
 
-  saveKeyAndValue({
-    db,
+  await saveKeyAndValue({
+    ds,
     key: ckanId,
     value: downloadInfo.metadata.toString(),
   });
 
-  db.close();
+  await ds.destroy();
 
   // 展開したzipファイルのディレクトリを削除
   await fs.promises.rm(extractDir, { recursive: true });

src/controller/download/process/__mocks__/load-dataset-history.ts

@@ -23,7 +23,7 @@
  */
 import { DatasetRow } from "@domain/dataset/dataset-row";
 import { jest } from '@jest/globals';
-import { Database } from "better-sqlite3";
+import { DataSource } from "typeorm";
 
 export const expectedResult = new Map<string, DatasetRow>([
   ['mt_city_all.csv', new DatasetRow({
@@ -85,7 +85,7 @@ export const expectedResult = new Map<string, DatasetRow>([
 ]);
 
 export const loadDatasetHistory = jest.fn(async (params: {
-  db: Database,
+  ds: DataSource,
 }): Promise<Map<string, DatasetRow>> => {
   return Promise.resolve(expectedResult);
 });

src/controller/download/process/__tests__/load-dataset-history.spec.ts

@@ -22,18 +22,21 @@
  * SOFTWARE.
  */
 
-import MockedDB from '@mock/better-sqlite3';
+import { DataSource as MockedDS } from '@mock/typeorm';
 import { describe, expect, it, jest } from "@jest/globals";
 import { loadDatasetHistory } from '../load-dataset-history';
 import { expectedResult } from '../__mocks__/load-dataset-history';
-jest.mock('better-sqlite3');
+jest.mock('typeorm');
 jest.dontMock('../load-dataset-history')
 
 describe('load-dataset-history', () => {
   it('should return a Map<string, DatasetRow>', async () => {
-    const db = new MockedDB('dummy database');
-    db.prepare.mockImplementation(() => ({
-      all: jest.fn().mockReturnValue([
+    const ds = new MockedDS({
+      type: 'better-sqlite3',
+      database: 'dummy database',
+    });
+    ds.query.mockImplementation(() => (
+      Promise.resolve([
         {
           key: 'mt_city_all.csv',
           type: 'city',
@@ -97,13 +100,13 @@ describe('load-dataset-history', () => {
           crc32: 4236985285,
           last_modified: 1674556138000,
         }
-      ]),
-    }));
+      ])
+    ));
 
     const results = await loadDatasetHistory({
-      db,
+      ds,
     });
 
     expect(results).toEqual(expectedResult);
   })
-})
+})