backend: use js config files for node-config/node-config#530

README.md

@@ -35,7 +35,7 @@ More commands can be found in `frontend/README.md` and `backend/README.md`.
 # Deployment
 
 1. Configure db initial password in `.env`
-1. Create and modify `backend/config/production.ts` based on `backend/config/production.sample.ts`
+1. Create and modify `backend/config/production.js` based on `backend/config/production.sample.js`
 2. `docker-compose up`
 
 Default configs are provided in `docker-compose.yml`. The following can be changed.
@@ -46,7 +46,7 @@ Default configs are provided in `docker-compose.yml`. The following can be chang
 | backend port               | 5000                           | mapped from 3000                 |
 | frontend args (see below)  | USE_MOCK=0                     |                                  |
 | static files directory     | ./static                       |                                  |
-| backend configuration file | ./backend/config/production.ts | Must be created before starting. |
+| backend configuration file | ./backend/config/production.js | Must be created before starting. |
 | backend db files           | ./backend/distdb               | MySQL                            |
 | backend upload dir         | ./backend/distupload           |                                  |
 

backend/README.md

@@ -44,9 +44,9 @@ npm run devenv:stop
 [node-config](https://github.com/lorenwest/node-config) is used for configuration. Create config files on `config` dir according to its strategy.
 
 
-For example, you will need a `production.ts` (which can be copied from `production.sample.ts`) for production deployment.
+For example, you will need a `production.js` (which can be based on `production.sample.js`) for production deployment.
 
-See `config/default.ts` for default config.
+See `config/default.js` for default config.
 
 # Deployment
 
@@ -92,9 +92,9 @@ On the folder with built assets shown above,
 # Only install production dependencies
 npm ci --only=production
 
-# Copy `config/production.sample.ts` to `config/production.ts` and change the configs
+# Copy `config/production.sample.json` to `config/production.json` and change the configs
 # Or use symlink or docker mount to mount a predefined production.json to the config directory
-cp config/production.sample.ts config/production.ts
+cp config/production.sample.json config/production.json
 vim config/production.json
 
 # Run!

backend/config/default.ts → backend/config/default.js

@@ -1,6 +1,7 @@
-import type { Config } from "@/utils/config";
+// @ts-check
 
-export default {
+/** @type {import("../src/utils/config").Config} */
+const config = {
   address: "0.0.0.0",
   pluginTimeout: 30000,
   port: 5000,
@@ -9,7 +10,6 @@ export default {
   logger: true,
   jwtSecret: "testsecret",
   orm: {
-    logging: true,
     connectionTimeout: 20000,
     type: "mysql",
     debug: true,
@@ -21,7 +21,6 @@ export default {
   staticPrefix: "static",
   bcryptSaltLength: 10,
   mail: {
-    pool: true,
     secure: true,
     from: "yaarxiv",
     ignoreError: true,
@@ -36,4 +35,6 @@ export default {
     timeoutSeconds: 120 * 60,
     sendIntervalSeconds: 30 * 60,
   },
-} as Config;
+};
+
+module.exports = config;

backend/config/development.ts → backend/config/development.js

@@ -1,11 +1,12 @@
-import type { ConfigOverride } from "@/utils/config";
+// @ts-check
 
-export default {
+/** @type {import("../src/utils/config").ConfigOverride} */
+const config = {
   loadSwagger: true,
   orm: {
     host: "localhost",
     port: 3306,
-    username: "root",
+    user: "root",
     password: "dbfordev",
     dbName: "yaarxiv_dev",
   },
@@ -14,4 +15,6 @@ export default {
     level: "trace",
     prettyPrint: true,
   },
-} as ConfigOverride;
+};
+
+module.exports = config;

backend/config/production.sample.ts → backend/config/production.sample.js

@@ -1,8 +1,11 @@
-export default {
+// @ts-check
+
+/** @type {import("../src/utils/config").ConfigOverride} */
+const config = {
   orm: {
     host: "localhost",
     port: 3306,
-    username: "root",
+    user: "root",
     password: "dbfordev",
     dbName: "yaarxiv_prod",
   },
@@ -16,3 +19,5 @@ export default {
   },
   frontendUrl: "http://localhost:5000",
 };
+
+module.exports = config;

backend/config/test.ts → backend/config/test.js

@@ -1,14 +1,13 @@
-import type { ConfigOverride } from "@/utils/config";
+// @ts-check
 
-export default {
-  port: 0,
-  loadSwagger: false,
+/** @type {import("../src/utils/config").ConfigOverride} */
+const config = {
   orm: {
     type: "mysql",
     host: "localhost",
     port: 3306,
     dbName: `yaarxiv_test_${process.env.JEST_WORKER_ID}`,
-    username: "root",
+    user: "root",
     password: "dbfordev",
     synchronize: true,
     dropSchema: true,
@@ -20,4 +19,6 @@ export default {
   upload: {
     path: "testupload",
   },
-} as ConfigOverride;
+};
+
+module.exports = config;

backend/src/plugins/orm.ts

@@ -19,14 +19,14 @@ declare module "fastify" {
 
 export const ormPlugin = fp(async (fastify) => {
   // create the database if not exists.
-  const { dbName, dropSchema, highlight, connectTimeout, host, port, runMigrations, synchronize } = config.orm;
+  const { dbName, dropSchema, highlight, connectionTimeout, host, port, runMigrations, synchronize } = config.orm;
 
   fastify.log.info("Wait for db connection.");
 
   // wait for db to be alive
   await waitOn({
     resources: [`tcp:${host}:${port}`],
-    timeout: connectTimeout,
+    timeout: connectionTimeout,
   });
 
   fastify.log.info("db is started. Connecting to it.");
@@ -37,7 +37,7 @@ export const ormPlugin = fp(async (fastify) => {
     logger: (msg) => fastify.log.info(msg),
     entities,
     driverOptions: {
-      connectTimeout,
+      connectTimeout: connectionTimeout,
     },
   });
 

backend/src/utils/config.ts

@@ -16,7 +16,7 @@ export interface Config {
     runMigrations?: boolean;
     dropSchema?: boolean;
     highlight?: boolean;
-    connectTimeout?: number;
+    connectionTimeout?: number;
     synchronize?: boolean;
   };
   upload: {

backend/tsconfig.json

@@ -28,10 +28,10 @@
   },
   "include": [
     "src/**/*",
-    "config",
     "tests/**/*",
-    "mikro-orm.config.ts"
-, "tests/globals.d.ts"  ],
+    "mikro-orm.config.ts",
+    "tests/globals.d.ts"
+  ],
   "exclude": [
     "node_modules",
     "migrations",