refactor: load env by json

.env.default

@@ -1,6 +1,6 @@
+# FIXME: deprecated, suggest use config.json only
 
 REDIS_HOST=
-# parseInt(process.env.REDIS_PORT, 10)
 REDIS_PORT=
 REDIS_PWD=
 REDIS_DB=
@@ -15,8 +15,6 @@ AWS_REGION=
 
 COOKIE_SIGN_KEY=
 
-REDIS_HOST=
-
 LOKALISE_TOKEN=
 LOKALISE_PROJECT_ID=
 

.eslintrc.js

@@ -1,4 +1,3 @@
-const isDev = process.env.NODE_ENV !== 'production';
 const jsRules = {
   // eslint-disable-next-line global-require
   'prettier/prettier': ['error', require('./.prettierrc.js')],
@@ -25,7 +24,7 @@ const tsRules = {
   '@typescript-eslint/default-param-last': 'off',
   '@typescript-eslint/consistent-type-imports': 'off',
   '@typescript-eslint/no-var-requires': 'off',
-  '@typescript-eslint/no-unused-vars': [isDev ? 'warn' : 'error'],
+  '@typescript-eslint/no-unused-vars': ['error'],
   '@typescript-eslint/no-use-before-define': ['error'],
   '@typescript-eslint/no-shadow': ['error'],
   '@typescript-eslint/explicit-module-boundary-types': 'off',

.gitignore

@@ -13,6 +13,7 @@ run/
 .tsbuildinfo
 .tsbuildinfo.*
 .env
+config.json
 junit.xml
 test-report.html
 jest-stare/

Dockerfile

@@ -28,6 +28,6 @@ RUN yarn run prepare-env\
 
 ENV TZ="Asia/Shanghai"
 
-EXPOSE 7001
+EXPOSE 80
 
 CMD ["yarn", "run", "start"]

config.default.json

@@ -0,0 +1,17 @@
+{
+  "COOKIE_SIGN_KEY": "0000000000000_000",
+  "PORT": "80",
+  "GLOBAL_PREFIX": "",
+  "REDIS_HOST": "localhost",
+  "REDIS_PORT": "6379",
+  "REDIS_PWD": "",
+  "REDIS_DB": "0",
+  "MONGODB_URI": "mongodb://localhost:27017/test",
+  "MONGODB_USER": "",
+  "MONGODB_PASSWORD": "",
+  "AWS_ACCESS_KEY_ID": "",
+  "AWS_SECRET_KEY": "",
+  "AWS_REGION": "",
+  "LOKALISE_TOKEN": "",
+  "LOKALISE_PROJECT_ID": ""
+}

src/config/config.default.ts

@@ -2,13 +2,7 @@
 
 import localeConfig from '../locales';
 
-const getRedisConfig = (db = 0, options: Record<string, unknown> = {}) => ({
-  host: process.env.REDIS_HOST,
-  port: parseInt(process.env.REDIS_PORT, 10),
-  password: process.env.REDIS_PWD,
-  db,
-  ...options,
-});
+import type { MidwayConfig } from '@midwayjs/core';
 
 /*
   default中的配置项，会被config.xxxx.ts中相同配置项覆盖
@@ -24,7 +18,12 @@ export default {
       enableConsole: false,
     },
   },
-  redis: getRedisConfig(parseInt(process.env.REDIS_DB, 10)),
+  redis: {
+    host: process.env.REDIS_HOST,
+    port: parseInt(process.env.REDIS_PORT, 10),
+    password: process.env.REDIS_PWD,
+    db: parseInt(process.env.REDIS_DB, 10),
+  },
   mongoose: {
     dataSource: {
       default: {
@@ -52,4 +51,4 @@ export default {
     writeCookie: false,
     resolver: false,
   },
-};
+} as MidwayConfig;

src/config/config.jest.ts

@@ -0,0 +1,3 @@
+import { MidwayConfig } from '@midwayjs/core';
+
+export default {} as MidwayConfig;

src/config/config.local.ts

@@ -1,3 +1,12 @@
 import { MidwayConfig } from '@midwayjs/core';
 
-export default {} as MidwayConfig;
+export default {
+  midwayLogger: {
+    default: {
+      fileLevel: 'info',
+      enableFile: false,
+      consoleLevel: 'debug',
+      enableConsole: true,
+    },
+  },
+} as MidwayConfig;

src/configuration.ts

@@ -1,4 +1,5 @@
-import './init';
+// eslint-disable-next-line import/order
+import './init'; // XXX: must run before all code
 
 import { hostname } from 'os';
 import path, { join } from 'path';
@@ -23,10 +24,11 @@ import { sync } from 'read-pkg';
 import { DefaultErrorFilter } from './filter/default.filter';
 import { LocaleMiddleware } from './middleware/locale.middleware';
 import { ResponseWrapperMiddleware } from './middleware/response-wrapper.middleware';
-import { RUNTIME_ENV_MAP, ServerEnv } from './types/config/config.dto';
-import { validateBy } from './utils/common';
+import { NODE_ENV, ConfigDTO } from './types/config.dto';
+import { validateBy } from './utils';
 import { CloudwatchTransport } from './utils/logger';
 import { registerModel } from './utils/register-model';
+
 @Configuration({
   imports: [
     koa,
@@ -64,7 +66,7 @@ export class MainConfiguration {
   async onConfigLoad() {
     const config = this.app.getConfig();
 
-    return validateBy(config, ServerEnv, {
+    return validateBy(config, ConfigDTO, {
       allowUnknown: true,
     });
   }
@@ -73,7 +75,7 @@ export class MainConfiguration {
     this.app.useMiddleware([LocaleMiddleware, ResponseWrapperMiddleware]);
     this.app.useFilter([DefaultErrorFilter]);
 
-    if (this.envConfig === RUNTIME_ENV_MAP.PRODUCTION) {
+    if (this.envConfig === NODE_ENV.PRODUCTION) {
       const cloudwatchTransport = new CloudwatchTransport({
         app: this.app.getProjectName(),
         hostname: hostname(),

src/init.ts

@@ -1,37 +1,50 @@
 /* eslint-disable no-process-env */
-import { join, resolve } from 'path';
+
+import path from 'path';
 
 import * as dotenv from 'dotenv';
 
-export const ServerSecretsPath = resolve(
-  '/',
-  'mnt',
-  'secrets',
-  `onekey-eks-dashboard-${process.env.NODE_ENV}.json`
-);
-export const ServerConfigPath = resolve('/', 'mnt', 'config', 'config.json');
-
-function loadJsonConfigFile(file: string, errorMessage: string) {
-  try {
-    dotenv.populate(process.env, require(file));
-  } catch (error) {
-    console.log(errorMessage, file);
-  }
+import { NODE_ENV } from './types/config.dto';
+
+// ============================================================================
+const PROJECT_NAME = ''; // FIXME: set by your project
+if (!PROJECT_NAME) {
+  console.log('Please set your own PROJECT_NAME and delete this console');
+}
+
+// first load config as default, second load config will not cover prev load config
+if (
+  [NODE_ENV.LOCAL, NODE_ENV.JEST].includes(process.env.NODE_ENV as NODE_ENV)
+) {
+  // local load config
+  dotenv.populate(
+    process.env,
+    require(path.resolve(__dirname, '..', 'config.json'))
+  );
+
+  // FIXME: deprecated, suggest use config.json only
+  dotenv.config({
+    path: path.join(__dirname, '..', '.env'),
+  });
+} else {
+  // online load config
+  dotenv.populate(
+    process.env,
+    require(path.resolve('/', 'mnt', 'config', 'config.json'))
+  );
+
+  dotenv.populate(
+    process.env,
+    require(path.resolve(
+      '/',
+      'mnt',
+      'secrets',
+      `onekey-eks-${PROJECT_NAME}-${process.env.NODE_ENV}.json`
+    ))
+  );
 }
 
-/*
-  加载线上配置文件
-*/
-loadJsonConfigFile(ServerConfigPath, 'No config found path:');
-loadJsonConfigFile(ServerSecretsPath, 'No secrets found path:');
-loadJsonConfigFile(
-  join(__dirname, '..', '.config.json'),
-  'No local json config found'
-);
-
-/*
-  加载本地配置文件，注意.config.json和.env只需要一个即可，两个都存在的话，.config.json会覆盖.env
-*/
-dotenv.config({
-  path: join(__dirname, '..', '.env'),
-});
+// ============================================================================
+BigInt.prototype['toJSON'] = function () {
+  return this.toString();
+};

src/types/config.dto.ts

@@ -0,0 +1,103 @@
+import { getSchema, Rule, RuleType } from '@midwayjs/validate';
+
+// ============================================================================
+export enum NODE_ENV {
+  LOCAL = 'local',
+  JEST = 'jest',
+  TEST = 'test',
+  STAGING = 'staging',
+  PRODUCTION = 'production',
+}
+
+// ============================================================================
+class AwsDTO {
+  @Rule(RuleType.string().allow('').required())
+  awsAccessKeyId!: string;
+
+  @Rule(RuleType.string().allow('').required())
+  awsSecretKey!: string;
+
+  @Rule(RuleType.string().allow('').required())
+  awsRegion!: string;
+}
+
+// ============================================================================
+
+class RedisDTO {
+  @Rule(RuleType.string().required())
+  host!: string;
+
+  @Rule(RuleType.number().integer().positive().required())
+  port!: number;
+
+  @Rule(RuleType.string().allow('').required())
+  password!: string;
+
+  @Rule(RuleType.number().integer().min(0).required())
+  db!: number;
+}
+
+// ============================================================================
+class MongooseDataSourceManagerOptionsDTO {
+  @Rule(RuleType.string().allow('').required())
+  user!: string;
+
+  @Rule(RuleType.string().allow('').required())
+  pass!: string;
+}
+
+class MongooseDataSourceManagerDTO {
+  @Rule(RuleType.string().required())
+  uri!: string;
+
+  @Rule(getSchema(MongooseDataSourceManagerOptionsDTO).required())
+  options: MongooseDataSourceManagerOptionsDTO;
+}
+
+class MongooseDataSourceDTO {
+  @Rule(getSchema(MongooseDataSourceManagerDTO).required())
+  default!: MongooseDataSourceManagerDTO;
+
+  @Rule(getSchema(MongooseDataSourceManagerDTO))
+  test?: MongooseDataSourceManagerDTO;
+}
+
+class MongooseDTO {
+  @Rule(getSchema(MongooseDataSourceDTO).required())
+  dataSource!: MongooseDataSourceDTO;
+}
+
+// ============================================================================
+class KoaDTO {
+  @Rule(RuleType.number().required())
+  port!: number;
+
+  @Rule(RuleType.string().allow('').required())
+  globalPrefix!: string;
+}
+
+// ============================================================================
+
+export class ConfigDTO {
+  @Rule(
+    RuleType.string()
+      .valid(...Object.values(NODE_ENV))
+      .required()
+  )
+  NODE_ENV!: NODE_ENV;
+
+  @Rule(RuleType.string().required().description('cookieSignKey'))
+  keys!: string;
+
+  @Rule(getSchema(KoaDTO).required())
+  koa: KoaDTO;
+
+  @Rule(getSchema(AwsDTO).required())
+  aws!: AwsDTO;
+
+  @Rule(getSchema(MongooseDTO).required())
+  mongoose: MongooseDTO;
+
+  @Rule(getSchema(RedisDTO).required())
+  redis: RedisDTO;
+}