chore: split configs (#1902)

* fix: make configs separate

* fix: imports

Author: spaenleh

src/app.ts

@@ -5,6 +5,7 @@ import 'reflect-metadata';
 import type { FastifyInstance } from 'fastify';
 import fp from 'fastify-plugin';
 
+import { REDIS_CONNECTION } from './config/redis';
 import { registerDependencies } from './di/container';
 import databasePlugin from './plugins/database';
 import metaPlugin from './plugins/meta';
@@ -17,7 +18,6 @@ import { maintenancePlugin } from './services/maintenance/maintenance.controller
 import MemberServiceApi from './services/member';
 import tagPlugin from './services/tag/tag.controller';
 import websocketsPlugin from './services/websockets/websocket.controller';
-import { REDIS_CONNECTION } from './utils/config';
 
 export default async function (instance: FastifyInstance): Promise<void> {
   await instance

src/config/env.ts

@@ -0,0 +1,44 @@
+import { config } from 'dotenv';
+
+const Environment = {
+  production: 'production',
+  staging: 'staging',
+  development: 'development',
+  test: 'test',
+} as const;
+
+export const NODE_ENV: string | undefined = process.env.NODE_ENV;
+
+const once = (fn) => {
+  let called = false;
+  return function (...args) {
+    if (called) return;
+    called = true;
+    return fn.apply(this, args);
+  };
+};
+
+/**
+ * Pull env vars from file depending on `NODE_ENV` variable
+ */
+export const getEnv = once(() => {
+  switch (NODE_ENV) {
+    case Environment.production:
+      config({ path: '.env.production', override: true });
+      return Environment.production;
+    case Environment.staging:
+      config({ path: '.env.staging', override: true });
+      return Environment.staging;
+    case Environment.test:
+      config({ path: '.env.test', override: true });
+      return Environment.test;
+    default:
+      config({ path: '.env.development', override: true });
+      return Environment.development;
+  }
+});
+
+export const PROD = NODE_ENV === Environment.production;
+export const STAGING = NODE_ENV === Environment.staging;
+export const DEV = NODE_ENV === Environment.development;
+export const TEST = NODE_ENV === Environment.test;

src/config/helpers.ts

@@ -0,0 +1,20 @@
+export class ExpectedEnvVariable extends Error {
+  constructor(envVarName: string) {
+    super(`Expected to find env variable "${envVarName}" but it was undefined.`);
+    this.name = 'MissingEnvVar';
+  }
+}
+
+/**
+ *
+ * @param name the name of the env var
+ * @throws an error if the var is not defined
+ * @returns the env var value if it is defined
+ */
+export function requiredEnvVar(name: string) {
+  const varValue = process.env[name];
+  if (varValue === undefined) {
+    throw new ExpectedEnvVariable(name);
+  }
+  return varValue;
+}

src/config/mailer.ts

@@ -0,0 +1,8 @@
+import { getEnv } from './env';
+import { requiredEnvVar } from './helpers';
+
+getEnv();
+
+export const MAILER_CONNECTION = requiredEnvVar('MAILER_CONNECTION');
+export const MAILER_CONFIG_FROM_EMAIL =
+  process.env.MAILER_CONFIG_FROM_EMAIL ?? 'no-reply@graasp.org';

src/config/redis.ts

@@ -0,0 +1,6 @@
+import { getEnv } from './env';
+import { requiredEnvVar } from './helpers';
+
+getEnv();
+
+export const REDIS_CONNECTION = requiredEnvVar('REDIS_CONNECTION');

src/config/secrets.ts

@@ -0,0 +1,46 @@
+import { getEnv } from './env';
+import { requiredEnvVar } from './helpers';
+
+// ensure env is setup
+getEnv();
+
+/**
+ * Session cookie key
+ */
+export const SECURE_SESSION_SECRET_KEY = requiredEnvVar('SECURE_SESSION_SECRET_KEY');
+export const SECURE_SESSION_EXPIRATION_IN_SECONDS = 604800; // 7days
+export const MAX_SECURE_SESSION_EXPIRATION_IN_SECONDS = 15552000; // 6 * 30days -> 6 months
+
+/**
+ * JWT
+ */
+export const JWT_SECRET = requiredEnvVar('JWT_SECRET');
+/** Register token expiration, in minutes */
+export const REGISTER_TOKEN_EXPIRATION_IN_MINUTES = 60;
+/** Login token expiration, in minutes */
+export const LOGIN_TOKEN_EXPIRATION_IN_MINUTES = 30;
+
+/** Password reset token Secret */
+export const PASSWORD_RESET_JWT_SECRET: string = requiredEnvVar('PASSWORD_RESET_JWT_SECRET');
+/** Password reset token expiration, in minutes */
+export const PASSWORD_RESET_JWT_EXPIRATION_IN_MINUTES = 1440; // 24 hours
+
+/** Email change token Secret */
+export const EMAIL_CHANGE_JWT_SECRET: string = requiredEnvVar('EMAIL_CHANGE_JWT_SECRET');
+/** Email change token expiration, in minutes */
+export const EMAIL_CHANGE_JWT_EXPIRATION_IN_MINUTES = 1440; // 24 hours
+
+/** Graasp apps authentication */
+export const APPS_JWT_SECRET = requiredEnvVar('APPS_JWT_SECRET');
+
+// TODO: remove mobile auth variables as it is deprecated and not supported anymore
+/**
+ * Mobile auth
+ */
+export const AUTH_TOKEN_JWT_SECRET = requiredEnvVar('AUTH_TOKEN_JWT_SECRET');
+/** Auth token expiration, in minutes */
+export const AUTH_TOKEN_EXPIRATION_IN_MINUTES = 10080; // 7 days
+
+export const REFRESH_TOKEN_JWT_SECRET = requiredEnvVar('REFRESH_TOKEN_JWT_SECRET');
+/** Refresh token expiration, in minutes */
+export const REFRESH_TOKEN_EXPIRATION_IN_MINUTES = 86400; // 60 days

src/di/container.ts

@@ -5,6 +5,8 @@ import type { FastifyInstance } from 'fastify';
 
 import Etherpad from '@graasp/etherpad-api';
 
+import { MAILER_CONFIG_FROM_EMAIL, MAILER_CONNECTION } from '../config/mailer';
+import { REDIS_CONNECTION } from '../config/redis';
 import { CRON_3AM_MONDAY, JobServiceBuilder } from '../jobs';
 import { BaseLogger } from '../logger';
 import { MailerService } from '../plugins/mailer/mailer.service';
@@ -21,11 +23,8 @@ import {
   FILE_STORAGE_TYPE,
   GEOLOCATION_API_KEY,
   IMAGE_CLASSIFIER_API,
-  MAILER_CONFIG_FROM_EMAIL,
-  MAILER_CONNECTION,
   MEILISEARCH_MASTER_KEY,
   MEILISEARCH_URL,
-  REDIS_CONNECTION,
   S3_FILE_ITEM_PLUGIN_OPTIONS,
 } from '../utils/config';
 import {

src/fastify.ts

@@ -3,18 +3,11 @@ import type { TypeBoxTypeProvider } from '@fastify/type-provider-typebox';
 import { fastify } from 'fastify';
 
 import registerAppPlugins from './app';
+import { DEV, NODE_ENV, PROD } from './config/env';
 import { client } from './drizzle/db';
 import ajvFormats from './schemas/ajvFormats';
 import { initSentry } from './sentry';
-import {
-  APP_VERSION,
-  CORS_ORIGIN_REGEX,
-  DEV,
-  ENVIRONMENT,
-  HOST_LISTEN_ADDRESS,
-  PORT,
-  PROD,
-} from './utils/config';
+import { APP_VERSION, CORS_ORIGIN_REGEX, HOST_LISTEN_ADDRESS, PORT } from './utils/config';
 import { GREETING } from './utils/constants';
 
 export const instance = fastify({
@@ -65,7 +58,7 @@ const start = async () => {
 
   try {
     await instance.listen({ port: PORT, host: HOST_LISTEN_ADDRESS });
-    instance.log.info('App is running version %s in %s mode', APP_VERSION, ENVIRONMENT);
+    instance.log.info('App is running version %s in %s mode', APP_VERSION, NODE_ENV);
     if (DEV) {
       // greet the world
       // eslint-disable-next-line no-console

src/jobs.ts

@@ -1,7 +1,8 @@
 import { type ConnectionOptions, Queue, Worker } from 'bullmq';
 
+import { REDIS_CONNECTION } from './config/redis';
 import { BaseLogger } from './logger';
-import { JOB_SCHEDULING, REDIS_CONNECTION } from './utils/config';
+import { JOB_SCHEDULING } from './utils/config';
 
 const connection: ConnectionOptions = {
   url: REDIS_CONNECTION,

src/sentry.ts

@@ -3,9 +3,9 @@ import '@sentry/tracing';
 
 import type { FastifyInstance } from 'fastify';
 
+import { NODE_ENV } from './config/env';
 import {
   APP_VERSION,
-  NODE_ENV,
   SENTRY_DSN,
   SENTRY_ENABLE_PERFORMANCE,
   SENTRY_ENABLE_PROFILING,