stash/pkg/plugin/raw.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

123 lines
2.4 KiB
Go

package plugin
import (
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"os/exec"
"sync"
"github.com/stashapp/stash/pkg/logger"
"github.com/stashapp/stash/pkg/plugin/common"
)
type rawTaskBuilder struct{}
func (*rawTaskBuilder) build(task pluginTask) Task {
return &rawPluginTask{
pluginTask: task,
}
}
type rawPluginTask struct {
pluginTask
started bool
waitGroup sync.WaitGroup
cmd *exec.Cmd
done chan bool
}
func (t *rawPluginTask) Start() error {
if t.started {
return errors.New("task already started")
}
command := t.plugin.getExecCommand(t.operation)
if len(command) == 0 {
return fmt.Errorf("empty exec value in operation %s", t.operation.Name)
}
cmd := exec.Command(command[0], command[1:]...)
stdin, err := cmd.StdinPipe()
if err != nil {
return fmt.Errorf("error getting plugin process stdin: %s", err.Error())
}
go func() {
defer stdin.Close()
inBytes, _ := json.Marshal(t.input)
if k, err := io.WriteString(stdin, string(inBytes)); err != nil {
logger.Warnf("error writing input to plugins stdin (wrote %v bytes out of %v): %v", k, len(string(inBytes)), err)
}
}()
stderr, err := cmd.StderrPipe()
if err != nil {
logger.Error("plugin stderr not available: " + err.Error())
}
stdout, err := cmd.StdoutPipe()
if nil != err {
logger.Error("plugin stdout not available: " + err.Error())
}
t.waitGroup.Add(1)
t.done = make(chan bool, 1)
if err = cmd.Start(); err != nil {
return fmt.Errorf("error running plugin: %s", err.Error())
}
go t.handlePluginStderr(t.plugin.Name, stderr)
t.cmd = cmd
// send the stdout to the plugin output
go func() {
defer t.waitGroup.Done()
defer close(t.done)
stdoutData, _ := ioutil.ReadAll(stdout)
stdoutString := string(stdoutData)
output := t.getOutput(stdoutString)
err := cmd.Wait()
if err != nil && output.Error == nil {
errStr := err.Error()
output.Error = &errStr
}
t.result = &output
}()
t.started = true
return nil
}
func (t *rawPluginTask) getOutput(output string) common.PluginOutput {
// try to parse the output as a PluginOutput json. If it fails just
// get the raw output
ret := common.PluginOutput{}
decodeErr := json.Unmarshal([]byte(output), &ret)
if decodeErr != nil {
ret.Output = &output
}
return ret
}
func (t *rawPluginTask) Wait() {
t.waitGroup.Wait()
}
func (t *rawPluginTask) Stop() error {
if t.cmd == nil {
return nil
}
return t.cmd.Process.Kill()
}