stash/pkg/plugin/js.go
SmallCoccinelle 87709fd018
Errcheck phase 1 (#1715)
* 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.
2021-09-21 09:34:25 +10:00

129 lines
2.3 KiB
Go

package plugin
import (
"errors"
"fmt"
"path/filepath"
"sync"
"github.com/robertkrimen/otto"
"github.com/stashapp/stash/pkg/plugin/common"
"github.com/stashapp/stash/pkg/plugin/js"
)
var errStop = errors.New("stop")
type jsTaskBuilder struct{}
func (*jsTaskBuilder) build(task pluginTask) Task {
return &jsPluginTask{
pluginTask: task,
}
}
type jsPluginTask struct {
pluginTask
started bool
waitGroup sync.WaitGroup
vm *otto.Otto
}
func (t *jsPluginTask) onError(err error) {
errString := err.Error()
t.result = &common.PluginOutput{
Error: &errString,
}
}
func (t *jsPluginTask) makeOutput(o otto.Value) {
t.result = &common.PluginOutput{}
asObj := o.Object()
if asObj == nil {
return
}
t.result.Output, _ = asObj.Get("Output")
err, _ := asObj.Get("Error")
if !err.IsUndefined() {
errStr := err.String()
t.result.Error = &errStr
}
}
func (t *jsPluginTask) Start() error {
if t.started {
return errors.New("task already started")
}
t.started = true
if len(t.plugin.Exec) == 0 {
return errors.New("no script specified in exec")
}
scriptFile := t.plugin.Exec[0]
t.vm = otto.New()
pluginPath := t.plugin.getConfigPath()
script, err := t.vm.Compile(filepath.Join(pluginPath, scriptFile), nil)
if err != nil {
return err
}
if err := t.vm.Set("input", t.input); err != nil {
return fmt.Errorf("error setting input: %w", err)
}
if err := js.AddLogAPI(t.vm, t.progress); err != nil {
return fmt.Errorf("error adding log API: %w", err)
}
if err := js.AddUtilAPI(t.vm); err != nil {
return fmt.Errorf("error adding util API: %w", err)
}
if err := js.AddGQLAPI(t.vm, t.input.ServerConnection.SessionCookie, t.gqlHandler); err != nil {
return fmt.Errorf("error adding GraphQL API: %w", err)
}
t.vm.Interrupt = make(chan func(), 1)
t.waitGroup.Add(1)
go func() {
defer func() {
t.waitGroup.Done()
if caught := recover(); caught != nil {
if caught == errStop {
// TODO - log this
return
}
}
}()
output, err := t.vm.Run(script)
if err != nil {
t.onError(err)
} else {
t.makeOutput(output)
}
}()
return nil
}
func (t *jsPluginTask) Wait() {
t.waitGroup.Wait()
}
func (t *jsPluginTask) Stop() error {
// TODO - need another way of doing this that doesn't require panic
t.vm.Interrupt <- func() {
panic(errStop)
}
return nil
}