Skip to content

Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.

feat(backend:config): improve error messages for environment config validation

johavena5df5295f0f9
diff --git a/backend/src/common/functions.ts b/backend/src/common/functions.ts
index 12900fce..f479d049 100755
--- a/backend/src/common/functions.ts
+++ b/backend/src/common/functions.ts
@@ -90,17 +90,36 @@ export function splitFullName(fullName?: string): { firstName: string; lastName:
return { firstName, lastName }
}
+function formatValidationErrors(errors: ValidationError[]): string[] {
+ const messages: string[] = []
+ const walk = (items: ValidationError[]) => {
+ for (const error of items) {
+ if (error.constraints) {
+ messages.push(...Object.values(error.constraints))
+ }
+ if (error.children && error.children.length > 0) {
+ walk(error.children)
+ }
+ }
+ }
+ walk(errors)
+ return messages
+}
+
export function transformAndValidate<T extends object>(
schema: new () => T,
object: any,
transformOptions: ClassTransformOptions = {},
- validatorOptions: ValidatorOptions = {}
+ validatorOptions: ValidatorOptions = {},
+ context?: string
): T {
// warning: plainToInstance do not use constructor to instantiate class
const instance: T = plainToInstance(schema, object, transformOptions)
const errors: ValidationError[] = validateSync(instance, validatorOptions)
if (errors.length > 0) {
- throw new Error(errors.toString())
+ const messages = formatValidationErrors(errors)
+ const message = messages.length > 0 ? messages.join('; ') : errors.toString()
+ throw new Error(context ? `${context}: ${message}` : message)
}
return instance
}
diff --git a/backend/src/configuration/config.environment.ts b/backend/src/configuration/config.environment.ts
index 143a96f3..c85b6057 100755
--- a/backend/src/configuration/config.environment.ts
+++ b/backend/src/configuration/config.environment.ts
@@ -41,5 +41,11 @@ function loadConfiguration(): GlobalConfig {
config.applications.files.usersPath = join(config.applications.files.dataPath, 'users')
config.applications.files.spacesPath = join(config.applications.files.dataPath, 'spaces')
config.applications.files.tmpPath = join(config.applications.files.dataPath, 'tmp')
- return transformAndValidate(GlobalConfig, config, { exposeDefaultValues: true }, { skipMissingProperties: false })
+ return transformAndValidate(
+ GlobalConfig,
+ config,
+ { exposeDefaultValues: true },
+ { skipMissingProperties: false },
+ 'Invalid configuration in environment.yaml'
+ )
}