mirror of
https://github.com/stashapp/stash.git
synced 2025-12-07 08:54:10 +01:00
* Avoid redundant logging in migrations
Return the error and let the caller handle the logging of the error if
needed.
While here, defer m.Close() to the function boundary.
* Treat errors as values
Use %v rather than %s and pass the errors directly.
* Generate a wrapped error on stat-failure
* Log 3 unchecked errors
Rather than ignore errors, log them at
the WARNING log level.
The server has been functioning without these, so assume they are not at
the ERROR level.
* Propagate errors upward
Failure in path generation was ignored. Propagate the errors upward the
call stack, so it can be handled at the level of orchestration.
* Warn on errors
Log errors rather than quenching them.
Errors are logged at the Warn-level for now.
* Check error when creating test databases
Use the builtin log package and stop the program fatally on error.
* Add warnings to uncheck task errors
Focus on the task system in a single commit, logging unchecked
errors as warnings.
* Warn-on-error in API routes
Look through the API routes, and make sure errors are being logged if
they occur. Prefer the Warn-log-level because none of these has proven
to be fatal in the system up until now.
* Propagate error when adding Util API
* Propagate error on adding util API
* Return unhandled error
* JS log API: propagate and log errors
* JS Plugins: log GQL addition failures.
* Warn on failure to write to stdin
* Warn on failure to stop task
* Wrap viper.BindEnv
The current viper code only errors if no name is provided, so it should
never fail. Rewrite the code flow to factor through a panic-function.
This removes error warnings from this part of the code.
* Log errors in concurrency test
If we can't initialize the configuration, treat the test as a failure.
* Warn on errors in configuration code
* Plug an unchecked error in gallery zip walking
* Warn on screenshot serving failure
* Warn on encoder screenshot failure
* Warn on errors in path-handling code
* Undo the errcheck on configurations for now.
* Use one-line initializers where applicable
rather than using
err := f()
if err!= nil { ..
prefer the shorter
if err := f(); err != nil { ..
If f() isn't too long of a name, or wraps a function with a body.
93 lines
2.4 KiB
Go
93 lines
2.4 KiB
Go
package js
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"math"
|
|
|
|
"github.com/robertkrimen/otto"
|
|
"github.com/stashapp/stash/pkg/logger"
|
|
)
|
|
|
|
const pluginPrefix = "[Plugin] "
|
|
|
|
func argToString(call otto.FunctionCall) string {
|
|
arg := call.Argument(0)
|
|
if arg.IsObject() {
|
|
o, _ := arg.Export()
|
|
data, _ := json.Marshal(o)
|
|
return string(data)
|
|
}
|
|
|
|
return arg.String()
|
|
}
|
|
|
|
func logTrace(call otto.FunctionCall) otto.Value {
|
|
logger.Trace(pluginPrefix + argToString(call))
|
|
return otto.UndefinedValue()
|
|
}
|
|
|
|
func logDebug(call otto.FunctionCall) otto.Value {
|
|
logger.Debug(pluginPrefix + argToString(call))
|
|
return otto.UndefinedValue()
|
|
}
|
|
|
|
func logInfo(call otto.FunctionCall) otto.Value {
|
|
logger.Info(pluginPrefix + argToString(call))
|
|
return otto.UndefinedValue()
|
|
}
|
|
|
|
func logWarn(call otto.FunctionCall) otto.Value {
|
|
logger.Warn(pluginPrefix + argToString(call))
|
|
return otto.UndefinedValue()
|
|
}
|
|
|
|
func logError(call otto.FunctionCall) otto.Value {
|
|
logger.Error(pluginPrefix + argToString(call))
|
|
return otto.UndefinedValue()
|
|
}
|
|
|
|
// Progress logs the current progress value. The progress value should be
|
|
// between 0 and 1.0 inclusively, with 1 representing that the task is
|
|
// complete. Values outside of this range will be clamp to be within it.
|
|
func logProgressFunc(c chan float64) func(call otto.FunctionCall) otto.Value {
|
|
return func(call otto.FunctionCall) otto.Value {
|
|
arg := call.Argument(0)
|
|
if !arg.IsNumber() {
|
|
return otto.UndefinedValue()
|
|
}
|
|
|
|
progress, _ := arg.ToFloat()
|
|
progress = math.Min(math.Max(0, progress), 1)
|
|
c <- progress
|
|
|
|
return otto.UndefinedValue()
|
|
}
|
|
}
|
|
|
|
func AddLogAPI(vm *otto.Otto, progress chan float64) error {
|
|
log, _ := vm.Object("({})")
|
|
if err := log.Set("Trace", logTrace); err != nil {
|
|
return fmt.Errorf("error setting Trace: %w", err)
|
|
}
|
|
if err := log.Set("Debug", logDebug); err != nil {
|
|
return fmt.Errorf("error setting Debug: %w", err)
|
|
}
|
|
if err := log.Set("Info", logInfo); err != nil {
|
|
return fmt.Errorf("error setting Info: %w", err)
|
|
}
|
|
if err := log.Set("Warn", logWarn); err != nil {
|
|
return fmt.Errorf("error setting Warn: %w", err)
|
|
}
|
|
if err := log.Set("Error", logError); err != nil {
|
|
return fmt.Errorf("error setting Error: %w", err)
|
|
}
|
|
if err := log.Set("Progress", logProgressFunc(progress)); err != nil {
|
|
return fmt.Errorf("error setting Progress: %v", err)
|
|
}
|
|
if err := vm.Set("log", log); err != nil {
|
|
return fmt.Errorf("unable to set log: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|