sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat(app): improved errors and warning for disabled features

Browse Source
This commit is contained in:
lowlighter
2022-08-28 12:32:57 -04:00
parent 77dfb2ae7e
commit 7a53a2da55
45 changed files with 58 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
source/app/metrics/metadata.mjs
View File

@@ -217,9 +217,20 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) {
Object.assign(meta.inputs, inputs, Object.fromEntries(Object.entries(inputs).map(([key, value]) => [metadata.to.query(key, {name}), value])))
}
//Enable state handler
{
meta.enabled = function(enabled, {extras = {}, error = true} = {}) {
if ((process.env.GITHUB_ACTIONS)&&(!enabled))
console.warn(`::warning::Plugin "${name}" is currently disabled. Add "plugin_${name}: yes" to your workflow to enable it.`)
if ((error)&&(!enabled))
throw Object.assign(new Error(`Plugin "${name}" is disabled${process.env.GITHUB_ACTIONS ? "" : " on this server"}`), {enabled: true})
return (enabled) && (meta.extras("enabled", {extras, error}))
}
}
//Extra features parser
{
meta.extras = function(input, {extras = {}, error = true}) {
meta.extras = function(input, {extras = {}, error = true} = {}) {
const key = metadata.to.yaml(input, {name})
try {
//Required permissions
@@ -270,7 +281,7 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) {
console.debug(`metrics/extras > ${name} > ${key} > skipping (no error mode)`)
return false
}
throw Object.assign(new Error(`Unsupported option "${key}"`), {extras: true})
throw Object.assign(new Error(`Option "${key}" is disabled on this server`), {extras: true})
}
}
}

4
source/app/metrics/utils.mjs
View File

@@ -130,8 +130,8 @@ export function formatters({timeZone} = {}) {
/**Error formatter */
format.error = function(error, {descriptions = {}, ...attributes} = {}) {
try {
//Extras features error
if (error.extras)
//Extras features or enable state error
if ((error.extras)||(error.enabled))
throw {error: {message: error.message, instance: error}}
//Already formatted error
if (error.error?.message)