config: splits config in multiple files

splits the big appConfig in multiple configs
adds media.config.mock.ts

Signed-off-by: Philip Molares <philip.molares@udo.edu>

src/config/app.config.mock.ts

@@ -8,12 +8,4 @@ import { registerAs } from '@nestjs/config';
 
 export default registerAs('appConfig', () => ({
   port: 3000,
-  media: {
-    backend: {
-      use: 'filesystem',
-      filesystem: {
-        uploadPath: 'uploads',
-      },
-    },
-  },
 }));

src/config/auth.config.ts

@@ -7,6 +7,7 @@
 import * as Joi from 'joi';
 import { GitlabScope, GitlabVersion } from './gitlab.enum';
 import { toArrayConfig } from './utils';
+import { registerAs } from '@nestjs/config';
 
 export interface AuthConfig {
   email: {
@@ -99,7 +100,7 @@ export interface AuthConfig {
   ];
 }
 
-export const authSchema = Joi.object({
+const authSchema = Joi.object({
   email: {
     enableLogin: Joi.boolean().default(false).optional(),
     enableRegister: Joi.boolean().default(false).optional(),
@@ -297,35 +298,47 @@ const oauth2s = oauth2Names.map((oauth2Name) => {
   };
 });
 
-export const appConfigAuth = {
-  email: {
-    enableLogin: process.env.HD_AUTH_EMAIL_ENABLE_LOGIN,
-    enableRegister: process.env.HD_AUTH_EMAIL_ENABLE_REGISTER,
-  },
-  facebook: {
-    clientID: process.env.HD_AUTH_FACEBOOK_CLIENT_ID,
-    clientSecret: process.env.HD_AUTH_FACEBOOK_CLIENT_SECRET,
-  },
-  twitter: {
-    consumerKey: process.env.HD_AUTH_TWITTER_CONSUMER_KEY,
-    consumerSecret: process.env.HD_AUTH_TWITTER_CONSUMER_SECRET,
-  },
-  github: {
-    clientID: process.env.HD_AUTH_GITHUB_CLIENT_ID,
-    clientSecret: process.env.HD_AUTH_GITHUB_CLIENT_SECRET,
-  },
-  dropbox: {
-    clientID: process.env.HD_AUTH_DROPBOX_CLIENT_ID,
-    clientSecret: process.env.HD_AUTH_DROPBOX_CLIENT_SECRET,
-    appKey: process.env.HD_AUTH_DROPBOX_APP_KEY,
-  },
-  google: {
-    clientID: process.env.HD_AUTH_GOOGLE_CLIENT_ID,
-    clientSecret: process.env.HD_AUTH_GOOGLE_CLIENT_SECRET,
-    apiKey: process.env.HD_AUTH_GOOGLE_APP_KEY,
-  },
-  gitlab: gitlabs,
-  ldap: ldaps,
-  saml: samls,
-  oauth2: oauth2s,
-};
+export default registerAs('authConfig', async () => {
+  const authConfig = authSchema.validate(
+    {
+      email: {
+        enableLogin: process.env.HD_AUTH_EMAIL_ENABLE_LOGIN,
+        enableRegister: process.env.HD_AUTH_EMAIL_ENABLE_REGISTER,
+      },
+      facebook: {
+        clientID: process.env.HD_AUTH_FACEBOOK_CLIENT_ID,
+        clientSecret: process.env.HD_AUTH_FACEBOOK_CLIENT_SECRET,
+      },
+      twitter: {
+        consumerKey: process.env.HD_AUTH_TWITTER_CONSUMER_KEY,
+        consumerSecret: process.env.HD_AUTH_TWITTER_CONSUMER_SECRET,
+      },
+      github: {
+        clientID: process.env.HD_AUTH_GITHUB_CLIENT_ID,
+        clientSecret: process.env.HD_AUTH_GITHUB_CLIENT_SECRET,
+      },
+      dropbox: {
+        clientID: process.env.HD_AUTH_DROPBOX_CLIENT_ID,
+        clientSecret: process.env.HD_AUTH_DROPBOX_CLIENT_SECRET,
+        appKey: process.env.HD_AUTH_DROPBOX_APP_KEY,
+      },
+      google: {
+        clientID: process.env.HD_AUTH_GOOGLE_CLIENT_ID,
+        clientSecret: process.env.HD_AUTH_GOOGLE_CLIENT_SECRET,
+        apiKey: process.env.HD_AUTH_GOOGLE_APP_KEY,
+      },
+      gitlab: gitlabs,
+      ldap: ldaps,
+      saml: samls,
+      oauth2: oauth2s,
+    },
+    {
+      abortEarly: false,
+      presence: 'required',
+    },
+  );
+  if (authConfig.error) {
+    throw new Error(authConfig.error.toString());
+  }
+  return authConfig.value;
+});

src/config/csp-config.ts

@@ -1,24 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
- *
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-import * as Joi from 'joi';
-
-export interface CspConfig {
-  enable: boolean;
-  maxAgeSeconds: number;
-  includeSubdomains: boolean;
-  preload: boolean;
-}
-
-export const cspSchema = Joi.object({
-  enable: Joi.boolean().default(true).optional(),
-  reportURI: Joi.string().optional(),
-});
-
-export const appConfigCsp = {
-  enable: process.env.HD_CSP_ENABLE || true,
-  reportURI: process.env.HD_CSP_REPORTURI,
-};

src/config/csp.config.ts

@@ -0,0 +1,37 @@
+/*
+ * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import * as Joi from 'joi';
+import { registerAs } from '@nestjs/config';
+
+export interface CspConfig {
+  enable: boolean;
+  maxAgeSeconds: number;
+  includeSubdomains: boolean;
+  preload: boolean;
+}
+
+const cspSchema = Joi.object({
+  enable: Joi.boolean().default(true).optional(),
+  reportURI: Joi.string().optional(),
+});
+
+export default registerAs('cspConfig', async () => {
+  const cspConfig = cspSchema.validate(
+    {
+      enable: process.env.HD_CSP_ENABLE || true,
+      reportURI: process.env.HD_CSP_REPORTURI,
+    },
+    {
+      abortEarly: false,
+      presence: 'required',
+    },
+  );
+  if (cspConfig.error) {
+    throw new Error(cspConfig.error.toString());
+  }
+  return cspConfig.value;
+});

src/config/database-config.ts

@@ -1,42 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
- *
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-import * as Joi from 'joi';
-import { DatabaseDialect } from './database-dialect.enum';
-
-export interface DatabaseConfig {
-  username: string;
-  password: string;
-  database: string;
-  host: string;
-  port: number;
-  storage: string;
-  dialect: DatabaseDialect;
-}
-
-export const databaseSchema = Joi.object({
-  username: Joi.string(),
-  password: Joi.string(),
-  database: Joi.string(),
-  host: Joi.string(),
-  port: Joi.number(),
-  storage: Joi.when('...dialect', {
-    is: Joi.valid(DatabaseDialect.SQLITE),
-    then: Joi.string(),
-    otherwise: Joi.optional(),
-  }),
-  dialect: Joi.string().valid(...Object.values(DatabaseDialect)),
-});
-
-export const appConfigDatabase = {
-  username: process.env.HD_DATABASE_USER,
-  password: process.env.HD_DATABASE_PASS,
-  database: process.env.HD_DATABASE_NAME,
-  host: process.env.HD_DATABASE_HOST,
-  port: parseInt(process.env.HD_DATABASE_PORT) || undefined,
-  storage: process.env.HD_DATABASE_STORAGE,
-  dialect: process.env.HD_DATABASE_DIALECT,
-};

src/config/database.config.ts

@@ -0,0 +1,75 @@
+/*
+ * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import * as Joi from 'joi';
+import { DatabaseDialect } from './database-dialect.enum';
+import { registerAs } from '@nestjs/config';
+
+export interface DatabaseConfig {
+  username: string;
+  password: string;
+  database: string;
+  host: string;
+  port: number;
+  storage: string;
+  dialect: DatabaseDialect;
+}
+
+const databaseSchema = Joi.object({
+  username: Joi.when('dialect', {
+    is: Joi.invalid(DatabaseDialect.SQLITE),
+    then: Joi.string(),
+    otherwise: Joi.optional(),
+  }),
+  password: Joi.when('dialect', {
+    is: Joi.invalid(DatabaseDialect.SQLITE),
+    then: Joi.string(),
+    otherwise: Joi.optional(),
+  }),
+  database: Joi.when('dialect', {
+    is: Joi.invalid(DatabaseDialect.SQLITE),
+    then: Joi.string(),
+    otherwise: Joi.optional(),
+  }),
+  host: Joi.when('dialect', {
+    is: Joi.invalid(DatabaseDialect.SQLITE),
+    then: Joi.string(),
+    otherwise: Joi.optional(),
+  }),
+  port: Joi.when('dialect', {
+    is: Joi.invalid(DatabaseDialect.SQLITE),
+    then: Joi.number(),
+    otherwise: Joi.optional(),
+  }),
+  storage: Joi.when('dialect', {
+    is: Joi.valid(DatabaseDialect.SQLITE),
+    then: Joi.string(),
+    otherwise: Joi.optional(),
+  }),
+  dialect: Joi.string().valid(...Object.values(DatabaseDialect)),
+});
+
+export default registerAs('databaseConfig', async () => {
+  const databaseConfig = databaseSchema.validate(
+    {
+      username: process.env.HD_DATABASE_USER,
+      password: process.env.HD_DATABASE_PASS,
+      database: process.env.HD_DATABASE_NAME,
+      host: process.env.HD_DATABASE_HOST,
+      port: parseInt(process.env.HD_DATABASE_PORT) || undefined,
+      storage: process.env.HD_DATABASE_STORAGE,
+      dialect: process.env.HD_DATABASE_DIALECT,
+    },
+    {
+      abortEarly: false,
+      presence: 'required',
+    },
+  );
+  if (databaseConfig.error) {
+    throw new Error(databaseConfig.error.toString());
+  }
+  return databaseConfig.value;
+});

src/config/hsts-config.ts

@@ -1,30 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
- *
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-import * as Joi from 'joi';
-
-export interface HstsConfig {
-  enable: boolean;
-  maxAgeSeconds: number;
-  includeSubdomains: boolean;
-  preload: boolean;
-}
-
-export const hstsSchema = Joi.object({
-  enable: Joi.boolean().default(true).optional(),
-  maxAgeSeconds: Joi.number()
-    .default(60 * 60 * 24 * 365)
-    .optional(),
-  includeSubdomains: Joi.boolean().default(true).optional(),
-  preload: Joi.boolean().default(true).optional(),
-});
-
-export const appConfigHsts = {
-  enable: process.env.HD_HSTS_ENABLE,
-  maxAgeSeconds: parseInt(process.env.HD_HSTS_MAX_AGE) || undefined,
-  includeSubdomains: process.env.HD_HSTS_INCLUDE_SUBDOMAINS,
-  preload: process.env.HD_HSTS_PRELOAD,
-};

src/config/hsts.config.ts

@@ -0,0 +1,43 @@
+/*
+ * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import * as Joi from 'joi';
+import { registerAs } from '@nestjs/config';
+
+export interface HstsConfig {
+  enable: boolean;
+  maxAgeSeconds: number;
+  includeSubdomains: boolean;
+  preload: boolean;
+}
+
+const hstsSchema = Joi.object({
+  enable: Joi.boolean().default(true).optional(),
+  maxAgeSeconds: Joi.number()
+    .default(60 * 60 * 24 * 365)
+    .optional(),
+  includeSubdomains: Joi.boolean().default(true).optional(),
+  preload: Joi.boolean().default(true).optional(),
+});
+
+export default registerAs('hstsConfig', async () => {
+  const hstsConfig = hstsSchema.validate(
+    {
+      enable: process.env.HD_HSTS_ENABLE,
+      maxAgeSeconds: parseInt(process.env.HD_HSTS_MAX_AGE) || undefined,
+      includeSubdomains: process.env.HD_HSTS_INCLUDE_SUBDOMAINS,
+      preload: process.env.HD_HSTS_PRELOAD,
+    },
+    {
+      abortEarly: false,
+      presence: 'required',
+    },
+  );
+  if (hstsConfig.error) {
+    throw new Error(hstsConfig.error.toString());
+  }
+  return hstsConfig.value;
+});

src/config/media.config.mock.ts

@@ -0,0 +1,16 @@
+/*
+ * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import { registerAs } from '@nestjs/config';
+
+export default registerAs('mediaConfig', () => ({
+  backend: {
+    use: 'filesystem',
+    filesystem: {
+      uploadPath: 'uploads',
+    },
+  },
+}));

src/config/media.config.ts

@@ -6,6 +6,7 @@
 
 import * as Joi from 'joi';
 import { BackendType } from '../media/backends/backend-type.enum';
+import { registerAs } from '@nestjs/config';
 
 export interface MediaConfig {
   backend: {
@@ -30,7 +31,7 @@ export interface MediaConfig {
   };
 }
 
-export const mediaSchema = Joi.object({
+const mediaSchema = Joi.object({
   backend: {
     use: Joi.string().valid(...Object.values(BackendType)),
     filesystem: {
@@ -69,25 +70,38 @@ export const mediaSchema = Joi.object({
   },
 });
 
-export const appConfigMedia = {
-  backend: {
-    use: process.env.HD_MEDIA_BACKEND,
-    filesystem: {
-      uploadPath: process.env.HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH,
+export default registerAs('mediaConfig', async () => {
+  const mediaConfig = mediaSchema.validate(
+    {
+      backend: {
+        use: process.env.HD_MEDIA_BACKEND,
+        filesystem: {
+          uploadPath: process.env.HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH,
+        },
+        s3: {
+          accessKey: process.env.HD_MEDIA_BACKEND_S3_ACCESS_KEY,
+          secretKey: process.env.HD_MEDIA_BACKEND_S3_ACCESS_KEY,
+          endPoint: process.env.HD_MEDIA_BACKEND_S3_ENDPOINT,
+          secure: process.env.HD_MEDIA_BACKEND_S3_SECURE,
+          port: parseInt(process.env.HD_MEDIA_BACKEND_S3_PORT) || undefined,
+        },
+        azure: {
+          connectionString:
+            process.env.HD_MEDIA_BACKEND_AZURE_CONNECTION_STRING,
+          container: process.env.HD_MEDIA_BACKEND_AZURE_CONTAINER,
+        },
+        imgur: {
+          clientID: process.env.HD_MEDIA_BACKEND_IMGUR_CLIENTID,
+        },
+      },
     },
-    s3: {
-      accessKey: process.env.HD_MEDIA_BACKEND_S3_ACCESS_KEY,
-      secretKey: process.env.HD_MEDIA_BACKEND_S3_ACCESS_KEY,
-      endPoint: process.env.HD_MEDIA_BACKEND_S3_ENDPOINT,
-      secure: process.env.HD_MEDIA_BACKEND_S3_SECURE,
-      port: parseInt(process.env.HD_MEDIA_BACKEND_S3_PORT) || undefined,
+    {
+      abortEarly: false,
+      presence: 'required',
     },
-    azure: {
-      connectionString: process.env.HD_MEDIA_BACKEND_AZURE_CONNECTION_STRING,
-      container: process.env.HD_MEDIA_BACKEND_AZURE_CONTAINER,
-    },
-    imgur: {
-      clientID: process.env.HD_MEDIA_BACKEND_IMGUR_CLIENTID,
-    },
-  },
-};
+  );
+  if (mediaConfig.error) {
+    throw new Error(mediaConfig.error.toString());
+  }
+  return mediaConfig.value;
+});