QingWei-Li/notea
1
1
Fork 0
mirror of https://github.com/QingWei-Li/notea.git synced 2024-11-29 12:53:00 +03:00
Code Issues Projects Releases Wiki Activity

change(debug): More detailed issues for store configuration

Browse Source 
store-config-debug: Previously, all store issues were reduced down to `Could not load configuration for store`. Now, along with that message, it provides more detailed messages for improperly configured credentials and more.
misc: Reworded a few things as well.
This commit is contained in:
tecc 2022-11-28 01:18:08 +01:00
parent 11e2b79175
commit 031130615f
No known key found for this signature in database
GPG Key ID: 400AAD881FCC028B
1 changed files with 84 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
libs/server/config.ts
View File

@ -71,6 +71,14 @@ export function loadConfigAndListErrors(): {
const configFile = env.getEnvRaw('CONFIG_FILE', false) ?? './notea.yml';
const errors: Array<Issue> = [];
function tryElseAddError(f: (() => void), issue: ((e: any) => Issue)): void {
try {
f();
} catch (e) {
errors.push(issue(e));
}
}
let baseConfig: Configuration = {} as Configuration;
if (existsSync(configFile)) {
let data;
@ -135,11 +143,11 @@ export function loadConfigAndListErrors(): {
category: IssueCategory.CONFIG,
fixes: [
{
description: 'Include an auth section the configuration file',
description: 'Include an auth section in the configuration file',
recommendation: IssueFixRecommendation.RECOMMENDED,
},
{
description: 'Set the password using the environment variable',
description: 'Set the PASSWORD environment variable',
recommendation: IssueFixRecommendation.NEUTRAL,
},
{
@ -215,14 +223,58 @@ export function loadConfigAndListErrors(): {
// for now, this works
try {
store.detectCredentials ??= true;
store.accessKey = env.getEnvRaw(
'STORE_ACCESS_KEY',
!store.detectCredentials && !store.accessKey
) ?? store.accessKey;
store.secretKey = env.getEnvRaw(
'STORE_SECRET_KEY',
!store.detectCredentials && !store.secretKey
) ?? store.secretKey;
tryElseAddError(() => {
store.accessKey = env.getEnvRaw(
'STORE_ACCESS_KEY',
!store.detectCredentials && !store.accessKey
) ?? store.accessKey;
}, (e) => ({
name: "Store access key was not provided",
category: IssueCategory.CONFIG,
description: "The store access key was not provided to Notea, and detecting credentials is disabled.",
severity: IssueSeverity.FATAL_ERROR,
cause: coerceToValidCause(e),
fixes: [
{
description: "Set the STORE_ACCESS_KEY environment variable",
recommendation: IssueFixRecommendation.RECOMMENDED,
},
{
description: "Set store.accessKey in the configuration file",
recommendation: IssueFixRecommendation.RECOMMENDED,
},
{
description: "Allow autodetection of credentials",
recommendation: IssueFixRecommendation.NEUTRAL
}
]
}));
tryElseAddError(() => {
store.secretKey = env.getEnvRaw(
'STORE_SECRET_KEY',
!store.detectCredentials && !store.secretKey
) ?? store.secretKey;
}, (e) => ({
name: "Store secret key was not provided",
category: IssueCategory.CONFIG,
description: "The store secret key was not provided to Notea, and detecting credentials is disabled.",
severity: IssueSeverity.FATAL_ERROR,
cause: coerceToValidCause(e),
fixes: [
{
description: "Set the STORE_SECRET_KEY environment variable",
recommendation: IssueFixRecommendation.RECOMMENDED,
},
{
description: "Set store.secretKey in the configuration file",
recommendation: IssueFixRecommendation.RECOMMENDED,
},
{
description: "Allow autodetection of credentials",
recommendation: IssueFixRecommendation.NEUTRAL
}
]
}));
store.bucket = env.getEnvRaw(
'STORE_BUCKET',
false
@ -231,10 +283,28 @@ export function loadConfigAndListErrors(): {
'STORE_FORCE_PATH_STYLE',
false
)) ?? store.forcePathStyle ?? false;
store.endpoint = env.getEnvRaw(
'STORE_END_POINT',
store.endpoint == null
) ?? store.endpoint;
tryElseAddError(() => {
store.endpoint = env.getEnvRaw(
'STORE_END_POINT',
store.endpoint == null
) ?? store.endpoint;
}, (e) => ({
name: "Store endpoint was not provided",
category: IssueCategory.CONFIG,
description: "The store endpoint was not provided to Notea.",
severity: IssueSeverity.FATAL_ERROR,
cause: coerceToValidCause(e),
fixes: [
{
description: "Set the STORE_END_POINT environment variable",
recommendation: IssueFixRecommendation.RECOMMENDED,
},
{
description: "Set store.endpoint in the configuration file",
recommendation: IssueFixRecommendation.RECOMMENDED,
}
]
}));
store.region = env.getEnvRaw(
'STORE_REGION',
false