ES Modules 방식으로 마이그레이션 (#258)

* ES Modules 방식으로 마이그레이션 * verbatimModuleSyntax: true * eslintrc를 cjs로 명시 * 린터 설정 마이그레이션 * pg.Pool 해결 시도
bacchus-snu · Mar 27, 2024 · 63f4e1b · 63f4e1b
1 parent 77b38dd
commit 63f4e1b
Show file tree

Hide file tree

Showing 48 changed files with 223 additions and 173 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -1 +1,6 @@
+packageExtensions:
+  [email protected]:
+    dependencies:
+      "@typescript-eslint/utils": 7.3.1
+
 yarnPath: .yarn/releases/yarn-4.1.1.cjs
diff --git a/bootstrap/bootstrap_host.ts b/bootstrap/bootstrap_host.ts
@@ -1,9 +1,9 @@
 import * as bunyan from 'bunyan';
 import * as fs from 'fs';
-import Config from '../src/config';
-import Model from '../src/model/model';
+import type Config from '../src/config.js';
+import Model from '../src/model/model.js';
 
-import { HARDWARE_LAB, LOUNGE, PRACTICE_SERVER, SOFTWARE_LAB } from './hosts_info';
+import { HARDWARE_LAB, LOUNGE, PRACTICE_SERVER, SOFTWARE_LAB } from './hosts_info.js';
 
 const config: Config = JSON.parse(fs.readFileSync('config.json', { encoding: 'utf-8' }));
 

diff --git a/bootstrap/rebuild_group_cache.ts b/bootstrap/rebuild_group_cache.ts
@@ -1,7 +1,7 @@
 import * as bunyan from 'bunyan';
 import * as fs from 'fs';
-import Config from '../src/config';
-import Model from '../src/model/model';
+import type Config from '../src/config.js';
+import Model from '../src/model/model.js';
 
 const config: Config = JSON.parse(fs.readFileSync('config.json', { encoding: 'utf-8' }));
 

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,16 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    rules: {
+      'no-sequences': 'error',
+      'no-constant-condition': ['error', { checkLoops: false }],
+      '@typescript-eslint/array-type': ['error', { default: 'generic' }],
+    },
+  },
+);
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
   "bugs": {
     "url": "https://github.com/bacchus-snu/id/issues"
   },
+  "type": "module",
   "dependencies": {
     "@koa/cors": "^5.0.0",
     "@phc/format": "^1.0.0",
@@ -40,7 +41,9 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
+    "@eslint/js": "^8.57.0",
     "@types/bunyan": "^1.8.11",
+    "@types/eslint__js": "^8",
     "@types/koa": "^2.15.0",
     "@types/koa-bodyparser": "^4.3.12",
     "@types/koa-mount": "^4.0.5",
@@ -52,13 +55,12 @@
     "@types/pg": "^8.11.4",
     "@types/supertest": "^6.0.2",
     "@types/uuid": "^9.0.8",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
     "ava": "^6.1.2",
     "dprint": "^0.45.0",
     "eslint": "^8.57.0",
     "supertest": "^6.3.4",
-    "typescript": "^5.4.3"
+    "typescript": "^5.4.3",
+    "typescript-eslint": "7.3.1"
   },
   "packageManager": "[email protected]"
 }
diff --git a/src/api/email.ts b/src/api/email.ts
@@ -1,7 +1,7 @@
 import * as Bunyan from 'bunyan';
 import * as nodemailer from 'nodemailer';
-import Config from '../config';
-import { InvalidEmailError, ResendLimitExeededError } from '../model/errors';
+import type Config from '../config.js';
+import { InvalidEmailError, ResendLimitExeededError } from '../model/errors.js';
 
 export interface EmailOption {
   address: string;

diff --git a/src/api/handlers/emails.ts b/src/api/handlers/emails.ts
@@ -1,11 +1,11 @@
-import { IMiddleware } from 'koa-router';
+import type { IMiddleware } from 'koa-router';
 import z from 'zod';
-import Config from '../../config';
-import { EmailAddress } from '../../model/email_addresses';
-import { EmailInUseError, InvalidEmailError, ResendLimitExeededError } from '../../model/errors';
-import Model from '../../model/model';
-import { sendEmail } from '../email';
-import emailVerificationTemplate from '../templates/verification_email_template';
+import type Config from '../../config.js';
+import type { EmailAddress } from '../../model/email_addresses.js';
+import { EmailInUseError, InvalidEmailError, ResendLimitExeededError } from '../../model/errors.js';
+import Model from '../../model/model.js';
+import { sendEmail } from '../email.js';
+import emailVerificationTemplate from '../templates/verification_email_template.js';
 
 export function sendVerificationEmail(model: Model, config: Config): IMiddleware {
   const bodySchema = z.object({

diff --git a/src/api/handlers/groups.ts b/src/api/handlers/groups.ts
@@ -1,8 +1,8 @@
-import { IMiddleware } from 'koa-router';
+import type { IMiddleware } from 'koa-router';
 import z from 'zod';
-import { BadParameterError } from '../../model/errors';
-import Model from '../../model/model';
-import { User } from '../../model/users';
+import { BadParameterError } from '../../model/errors.js';
+import Model from '../../model/model.js';
+import type { User } from '../../model/users.js';
 
 export function listGroups(model: Model): IMiddleware {
   return async (ctx, next) => {

diff --git a/src/api/handlers/login.ts b/src/api/handlers/login.ts
@@ -1,10 +1,10 @@
-import { IMiddleware } from 'koa-router';
+import type { IMiddleware } from 'koa-router';
 
 import z from 'zod';
-import Config from '../../config';
-import { AuthorizationError, ControllableError, NoSuchEntryError } from '../../model/errors';
-import Model from '../../model/model';
-import { SignatureError, verifyPubkeyReq } from '../pubkey';
+import type Config from '../../config.js';
+import { AuthorizationError, ControllableError, NoSuchEntryError } from '../../model/errors.js';
+import Model from '../../model/model.js';
+import { SignatureError, verifyPubkeyReq } from '../pubkey.js';
 
 const loginBodySchema = z.object({
   username: z.string(),

diff --git a/src/api/handlers/nss.ts b/src/api/handlers/nss.ts
@@ -1,7 +1,7 @@
-import { IMiddleware } from 'koa-router';
+import type { IMiddleware } from 'koa-router';
 
-import { NoSuchEntryError } from '../../model/errors';
-import Model from '../../model/model';
+import { NoSuchEntryError } from '../../model/errors.js';
+import Model from '../../model/model.js';
 
 export function getPasswd(model: Model): IMiddleware {
   return async (ctx, next) => {

diff --git a/src/api/handlers/shells.ts b/src/api/handlers/shells.ts
@@ -1,5 +1,5 @@
-import { IMiddleware } from 'koa-router';
-import Model from '../../model/model';
+import type { IMiddleware } from 'koa-router';
+import Model from '../../model/model.js';
 
 export function getShells(model: Model): IMiddleware {
   return async (ctx, next) => {

diff --git a/src/api/handlers/users.ts b/src/api/handlers/users.ts
@@ -1,13 +1,13 @@
 import { createPublicKey } from 'crypto';
 import { jwtVerify } from 'jose';
-import { IMiddleware } from 'koa-router';
+import type { IMiddleware } from 'koa-router';
 import z from 'zod';
-import Config from '../../config';
-import { EmailAddress } from '../../model/email_addresses';
-import { InvalidEmailError, ResendLimitExeededError, UserExistsError } from '../../model/errors';
-import Model from '../../model/model';
-import { sendEmail } from '../email';
-import changePasswordTemplate from '../templates/change_password_email_template';
+import type Config from '../../config.js';
+import type { EmailAddress } from '../../model/email_addresses.js';
+import { InvalidEmailError, ResendLimitExeededError, UserExistsError } from '../../model/errors.js';
+import Model from '../../model/model.js';
+import { sendEmail } from '../email.js';
+import changePasswordTemplate from '../templates/change_password_email_template.js';
 
 export function createUser(model: Model, config: Config): IMiddleware {
   const bodySchema = z.object({

diff --git a/src/api/pubkey.ts b/src/api/pubkey.ts
@@ -1,5 +1,5 @@
-import { Context } from 'koa';
-import * as tweetnacl from 'tweetnacl';
+import type { Context } from 'koa';
+import tweetnacl from 'tweetnacl';
 
 export class SignatureError extends Error {
   constructor() {

diff --git a/src/api/router.ts b/src/api/router.ts
@@ -1,9 +1,12 @@
 import bodyParser from 'koa-bodyparser';
 import Router from 'koa-router';
-import Config from '../config';
-import Model from '../model/model';
-import createOIDCRouter from '../oidc/routes';
-import { checkVerificationEmailToken, sendVerificationEmail } from './handlers/emails';
+import type OIDCProvider from 'oidc-provider';
+import type { Configuration as OIDCConfiguration } from 'oidc-provider';
+
+import type Config from '../config.js';
+import Model from '../model/model.js';
+import createOIDCRouter from '../oidc/routes.js';
+import { checkVerificationEmailToken, sendVerificationEmail } from './handlers/emails.js';
 import {
   acceptGroup,
   applyGroup,
@@ -12,21 +15,19 @@ import {
   listMembers,
   listPending,
   rejectGroup,
-} from './handlers/groups';
-import { checkLogin, login, loginLegacy, loginPAM, logout } from './handlers/login';
-import { getGroup, getPasswd } from './handlers/nss';
-import { getShells } from './handlers/shells';
+} from './handlers/groups.js';
+import { checkLogin, login, loginLegacy, loginPAM, logout } from './handlers/login.js';
+import { getGroup, getPasswd } from './handlers/nss.js';
+import { getShells } from './handlers/shells.js';
 import {
   changePassword,
   checkChangePasswordEmailToken,
   createUser,
   getUserEmails,
   getUserInfo,
   sendChangePasswordEmail,
-} from './handlers/users';
-import { changeUserShell, getUserShell } from './handlers/users';
-// @ts-expect-error: https://github.com/microsoft/TypeScript/issues/49721
-import type OIDCProvider, { Configuration as OIDCConfiguration } from 'oidc-provider';
+} from './handlers/users.js';
+import { changeUserShell, getUserShell } from './handlers/users.js';
 
 export function createRouter(
   model: Model,

diff --git a/src/api/server.ts b/src/api/server.ts
@@ -3,15 +3,15 @@ import * as Bunyan from 'bunyan';
 import * as crypto from 'crypto';
 import Koa from 'koa';
 import mount from 'koa-mount';
+import OIDCProvider from 'oidc-provider';
 
-import Config from '../config';
-import Model from '../model/model';
-import createOIDCConfig from '../oidc/configuration';
-import { createRouter } from './router';
+import type Config from '../config.js';
+import Model from '../model/model.js';
+import createOIDCConfig from '../oidc/configuration.js';
+import { createRouter } from './router.js';
 
-const createServer = async (config: Config, log: Bunyan, inputModel?: Model) => {
+const createServer = (config: Config, log: Bunyan, inputModel?: Model) => {
   const model = inputModel ?? new Model(config, log);
-  const OIDCProvider = (await import('oidc-provider')).default;
   const oidcConfig = createOIDCConfig(model, config.oidc);
   const oidcProvider = new OIDCProvider(config.oidc.issuer, oidcConfig);
 

diff --git a/src/config.ts b/src/config.ts
@@ -2,7 +2,6 @@
  * Configuration.
  */
 
-// @ts-expect-error: https://github.com/microsoft/TypeScript/issues/49721
 import type { ClientMetadata, JWKS } from 'oidc-provider';
 
 /**

diff --git a/src/index.ts b/src/index.ts
@@ -1,7 +1,7 @@
 import * as bunyan from 'bunyan';
 import * as fs from 'fs';
-import createAPIServer from './api/server';
-import Config from './config';
+import createAPIServer from './api/server.js';
+import type Config from './config.js';
 
 const config: Config = JSON.parse(fs.readFileSync('config.json', { encoding: 'utf-8' }));
 
@@ -10,8 +10,8 @@ const log = bunyan.createLogger({
   level: config.logLevel,
 });
 
-async function run() {
-  const apiServer = await createAPIServer(config, log);
+function run() {
+  const apiServer = createAPIServer(config, log);
   apiServer.listen(config.api.listenPort, config.api.listenHost);
 }
 

diff --git a/src/model/email_addresses.ts b/src/model/email_addresses.ts
@@ -1,7 +1,7 @@
 import * as crypto from 'crypto';
 import moment from 'moment';
-import { ExpiredTokenError, NoSuchEntryError } from './errors';
-import Transaction from './transaction';
+import { ExpiredTokenError, NoSuchEntryError } from './errors.js';
+import Transaction from './transaction.js';
 
 interface EmailAddressRow {
   address_local: string;

diff --git a/src/model/groups.ts b/src/model/groups.ts
@@ -1,6 +1,6 @@
-import { NoSuchEntryError } from './errors';
-import Transaction from './transaction';
-import { Translation } from './translation';
+import { NoSuchEntryError } from './errors.js';
+import Transaction from './transaction.js';
+import type { Translation } from './translation.js';
 
 interface GroupRow {
   idx: number;

diff --git a/src/model/hosts.ts b/src/model/hosts.ts
@@ -1,6 +1,6 @@
-import { AuthorizationError, NoSuchEntryError } from './errors';
-import Model from './model';
-import Transaction from './transaction';
+import { AuthorizationError, NoSuchEntryError } from './errors.js';
+import Model from './model.js';
+import Transaction from './transaction.js';
 
 interface HostRow {
   idx: number;

diff --git a/src/model/model.ts b/src/model/model.ts
@@ -1,15 +1,15 @@
 import * as Bunyan from 'bunyan';
-import * as pg from 'pg';
-import Config from '../config';
-import EmailAddresses from './email_addresses';
-import { ControllableError } from './errors';
-import Groups from './groups';
-import Hosts from './hosts';
-import OAuth from './oauth';
-import Permissions from './permissions';
-import Shells from './shells';
-import Transaction from './transaction';
-import Users from './users';
+import pg from 'pg';
+import type Config from '../config.js';
+import EmailAddresses from './email_addresses.js';
+import { ControllableError } from './errors.js';
+import Groups from './groups.js';
+import Hosts from './hosts.js';
+import OAuth from './oauth.js';
+import Permissions from './permissions.js';
+import Shells from './shells.js';
+import Transaction from './transaction.js';
+import Users from './users.js';
 
 const PSQL_SERIALIZATION_FAILURE = '40001';
 const PSQL_DEADLOCK_DETECTED = '40P01';

diff --git a/src/model/oauth.ts b/src/model/oauth.ts
@@ -1,8 +1,7 @@
-// @ts-expect-error: https://github.com/microsoft/TypeScript/issues/49721
 import type { AllClientMetadata } from 'oidc-provider';
 
-import { NoSuchEntryError } from './errors';
-import Transaction from './transaction';
+import { NoSuchEntryError } from './errors.js';
+import Transaction from './transaction.js';
 
 export default class OAuth {
   public async getClientById(tr: Transaction, id: string): Promise<AllClientMetadata> {

diff --git a/src/model/permissions.ts b/src/model/permissions.ts
@@ -1,7 +1,7 @@
-import { NoSuchEntryError } from './errors';
-import Model from './model';
-import Transaction from './transaction';
-import { Translation } from './translation';
+import { NoSuchEntryError } from './errors.js';
+import Model from './model.js';
+import Transaction from './transaction.js';
+import type { Translation } from './translation.js';
 
 export default class Permissions {
   constructor(private readonly model: Model) {

diff --git a/src/model/shells.ts b/src/model/shells.ts
@@ -1,4 +1,4 @@
-import Transaction from './transaction';
+import Transaction from './transaction.js';
 
 export default class Shells {
   constructor() {

diff --git a/src/model/users.ts b/src/model/users.ts
@@ -8,9 +8,9 @@ import {
   ExpiredTokenError,
   NoSuchEntryError,
   NotActivatedError,
-} from './errors';
-import Model from './model';
-import Transaction from './transaction';
+} from './errors.js';
+import Model from './model.js';
+import Transaction from './transaction.js';
 
 // see language enum in schema.sql
 export type Language = 'ko' | 'en';