stash/pkg/plugin/examples/common/graphql.go
SmallCoccinelle 655d3ae969
Toward better context handling (#1835)
* Use the request context

The code uses context.Background() in a flow where there is a
http.Request. Use the requests context instead.

* Use a true context in the plugin example

Let AddTag/RemoveTag take a context and use that context throughout
the example.

* Avoid the use of context.Background

Prefer context.TODO over context.Background deep in the call chain.

This marks the site as something which we need to context-handle
later, and also makes it clear to the reader that the context is
sort-of temporary in the code base.

While here, be consistent in handling the `act` variable in each
branch of the if .. { .. } .. check.

* Prefer context.TODO over context.Background

For the different scraping operations here, there is a context
higher up the call chain, which we ought to use. Mark the call-sites
as TODO for now, so we can come back later on a sweep of which parts
can be context-lifted.

* Thread context upwards

Initialization requires context for transactions. Thread the context
upward the call chain.

At the intialization call, add a context.TODO since we can't break this
yet. The singleton assumption prevents us from pulling it up into main for
now.

* make tasks context-aware

Change the task interface to understand contexts.

Pass the context down in some of the branches where it is needed.

* Make QueryStashBoxScene context-aware

This call naturally sits inside the request-context. Use it.

* Introduce a context in the JS plugin code

This allows us to use a context for HTTP calls inside the system.

Mark the context with a TODO at top level for now.

* Nitpick error formatting

Use %v rather than %s for error interfaces.
Do not begin an error strong with a capital letter.

* Avoid the use of http.Get in FFMPEG download chain

Since http.Get has no context, it isn't possible to break out or have
policy induced. The call will block until the GET completes. Rewrite
to use a http Request and provide a context.

Thread the context through the call chain for now. provide
context.TODO() at the top level of the initialization chain.

* Make getRemoteCDPWSAddress aware of contexts

Eliminate a call to http.Get and replace it with a context-aware
variant.

Push the context upwards in the call chain, but plug it before the
scraper interface so we don't have to rewrite said interface yet.

Plugged with context.TODO()

* Scraper: make the getImage function context-aware

Use a context, and pass it upwards. Plug it with context.TODO()
up the chain before the rewrite gets too much out of hand for now.

Minor tweaks along the way, remove a call to context.Background()
deep in the call chain.

* Make NOTIFY request context-aware

The call sits inside a Request-handler. So it's natural to use the
requests context as the context for the outgoing HTTP request.

* Use a context in the url scraper code

We are sitting in code which has a context, so utilize it for the
request as well.

* Use a context when checking versions

When we check the version of stash on Github, use a context. Thread
the context up to the initialization routine of the HTTP/GraphQL
server and plug it with a context.TODO() for now.

This paves the way for providing a context to the HTTP server code in a
future patch.

* Make utils func ReadImage context-aware

In almost all of the cases, there is a context in the call chain which
is a natural use. This is true for all the GraphQL mutations.

The exception is in task_stash_box_tag, so plug that task with
context.TODO() for now.

* Make stash-box get context-aware

Thread a context through the call chain until we hit the Client API.
Plug it with context.TODO() there for now.

* Enable the noctx linter

The code is now free of any uncontexted HTTP request. This means we
pass the noctx linter, and we can enable it in the code base.
2021-10-14 15:32:41 +11:00

232 lines
4.1 KiB
Go

//go:build plugin_example
// +build plugin_example
package common
import (
"context"
"errors"
"fmt"
"github.com/shurcooL/graphql"
"github.com/stashapp/stash/pkg/plugin/common/log"
)
const tagName = "Hawwwwt"
// graphql inputs and returns
type TagCreate struct {
ID graphql.ID `graphql:"id"`
}
type TagCreateInput struct {
Name graphql.String `graphql:"name" json:"name"`
}
type TagDestroyInput struct {
ID graphql.ID `graphql:"id" json:"id"`
}
type FindScenesResultType struct {
Count graphql.Int
Scenes []Scene
}
type Tag struct {
ID graphql.ID `graphql:"id"`
Name graphql.String `graphql:"name"`
}
type Scene struct {
ID graphql.ID
Tags []Tag
}
func (s Scene) getTagIds() []graphql.ID {
ret := []graphql.ID{}
for _, t := range s.Tags {
ret = append(ret, t.ID)
}
return ret
}
type FindFilterType struct {
PerPage *graphql.Int `graphql:"per_page" json:"per_page"`
Sort *graphql.String `graphql:"sort" json:"sort"`
}
type SceneUpdate struct {
ID graphql.ID `graphql:"id"`
}
type SceneUpdateInput struct {
ID graphql.ID `graphql:"id" json:"id"`
TagIds []graphql.ID `graphql:"tag_ids" json:"tag_ids"`
}
func getTagID(ctx context.Context, client *graphql.Client, create bool) (*graphql.ID, error) {
log.Info("Checking if tag exists already")
// see if tag exists already
var q struct {
AllTags []Tag `graphql:"allTags"`
}
err := client.Query(ctx, &q, nil)
if err != nil {
return nil, fmt.Errorf("Error getting tags: %s\n", err.Error())
}
for _, t := range q.AllTags {
if t.Name == tagName {
id := t.ID
return &id, nil
}
}
if !create {
log.Info("Not found and not creating")
return nil, nil
}
// create the tag
var m struct {
TagCreate TagCreate `graphql:"tagCreate(input: $s)"`
}
input := TagCreateInput{
Name: tagName,
}
vars := map[string]interface{}{
"s": input,
}
log.Info("Creating new tag")
err = client.Mutate(ctx, &m, vars)
if err != nil {
return nil, fmt.Errorf("Error mutating scene: %s\n", err.Error())
}
return &m.TagCreate.ID, nil
}
func findRandomScene(ctx context.Context, client *graphql.Client) (*Scene, error) {
// get a random scene
var q struct {
FindScenes FindScenesResultType `graphql:"findScenes(filter: $c)"`
}
pp := graphql.Int(1)
sort := graphql.String("random")
filterInput := &FindFilterType{
PerPage: &pp,
Sort: &sort,
}
vars := map[string]interface{}{
"c": filterInput,
}
log.Info("Finding a random scene")
err := client.Query(ctx, &q, vars)
if err != nil {
return nil, fmt.Errorf("Error getting random scene: %s\n", err.Error())
}
if q.FindScenes.Count == 0 {
return nil, nil
}
return &q.FindScenes.Scenes[0], nil
}
func addTagId(tagIds []graphql.ID, tagId graphql.ID) []graphql.ID {
for _, t := range tagIds {
if t == tagId {
return tagIds
}
}
tagIds = append(tagIds, tagId)
return tagIds
}
func AddTag(ctx context.Context, client *graphql.Client) error {
tagID, err := getTagID(ctx, client, true)
if err != nil {
return err
}
scene, err := findRandomScene(ctx, client)
if err != nil {
return err
}
if scene == nil {
return errors.New("no scenes to add tag to")
}
var m struct {
SceneUpdate SceneUpdate `graphql:"sceneUpdate(input: $s)"`
}
input := SceneUpdateInput{
ID: scene.ID,
TagIds: scene.getTagIds(),
}
input.TagIds = addTagId(input.TagIds, *tagID)
vars := map[string]interface{}{
"s": input,
}
log.Infof("Adding tag to scene %v", scene.ID)
err = client.Mutate(ctx, &m, vars)
if err != nil {
return fmt.Errorf("Error mutating scene: %v", err)
}
return nil
}
func RemoveTag(ctx context.Context, client *graphql.Client) error {
tagID, err := getTagID(ctx, client, false)
if err != nil {
return err
}
if tagID == nil {
log.Info("Tag does not exist. Nothing to remove")
return nil
}
// destroy the tag
var m struct {
TagDestroy bool `graphql:"tagDestroy(input: $s)"`
}
input := TagDestroyInput{
ID: *tagID,
}
vars := map[string]interface{}{
"s": input,
}
log.Info("Destroying tag")
err = client.Mutate(ctx, &m, vars)
if err != nil {
return fmt.Errorf("Error destroying tag: %v", err)
}
return nil
}