add context to gnverifier methods (close #91)

Author: dimus

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v0.9.0] - 2022-03-13 Sun
+
+- Add [#91]: provide context to verification and searh methods.
+
 ## [v0.8.2] - 2022-02-25 Fri
 
 - Fix: go.mod bug

gnverifier.go

@@ -72,9 +72,12 @@ func (gnv gnverifier) VerifyOne(name string) (vlib.Name, error) {
 
 // VerifyBatch takes a list of name-strings, verifies them and returns
 // a batch of results back.
-func (gnv gnverifier) VerifyBatch(nameStrings []string) []vlib.Name {
+func (gnv gnverifier) VerifyBatch(
+	ctx context.Context,
+	nameStrings []string,
+) []vlib.Name {
 	params := gnv.setParams(nameStrings)
-	ctx, cancel := context.WithTimeout(context.Background(), 20*time.Second)
+	ctx, cancel := context.WithTimeout(ctx, 20*time.Second)
 	defer cancel()
 
 	return gnv.verifier.Verify(ctx, params).Names
@@ -84,26 +87,27 @@ func (gnv gnverifier) VerifyBatch(nameStrings []string) []vlib.Name {
 // channel and sends results of verification via output
 // channel.
 func (gnv gnverifier) VerifyStream(
+	ctx context.Context,
 	in <-chan []string,
 	out chan []vlib.Name,
 ) {
 	var wg sync.WaitGroup
 	wg.Add(gnv.cfg.Jobs)
 
-	ctx, cancel := context.WithCancel(context.Background())
+	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
 
 	vwChan := gnv.loadNames(ctx, in)
 
 	for i := 0; i < gnv.cfg.Jobs; i++ {
-		go gnv.VerifyWorker(ctx, vwChan, out, &wg)
+		go gnv.verifyWorker(ctx, vwChan, out, &wg)
 	}
 
 	wg.Wait()
 	close(out)
 }
 
-func (gnv gnverifier) VerifyWorker(
+func (gnv gnverifier) verifyWorker(
 	ctx context.Context,
 	in <-chan vlib.Input,
 	out chan<- []vlib.Name,
@@ -126,9 +130,10 @@ func (gnv gnverifier) VerifyWorker(
 }
 
 func (gnv gnverifier) Search(
+	ctx context.Context,
 	inp search.Input,
 ) ([]vlib.Name, error) {
-	res, err := gnv.verifier.Search(context.Background(), inp)
+	res, err := gnv.verifier.Search(ctx, inp)
 	return res.Names, err
 }
 

gnverifier/cmd/root.go

@@ -3,6 +3,7 @@ package cmd
 
 import (
 	"bufio"
+	"context"
 	_ "embed"
 	"fmt"
 	"io"
@@ -393,7 +394,7 @@ func verifyFile(gnv gnverifier.GNverifier, f io.Reader) {
 	out := make(chan []vlib.Name)
 	var wg sync.WaitGroup
 	wg.Add(1)
-	go gnv.VerifyStream(in, out)
+	go gnv.VerifyStream(context.Background(), in, out)
 	go processResults(gnv, out, &wg)
 	sc := bufio.NewScanner(f)
 	names := make([]string, 0, batch)
@@ -460,7 +461,7 @@ func searchQuery(gnv gnverifier.GNverifier, s string) {
 	if all := gnv.Config().WithAllMatches; all {
 		inp.WithAllMatches = all
 	}
-	res, err := gnv.Search(inp)
+	res, err := gnv.Search(context.Background(), inp)
 	if err != nil {
 		log.Fatal().Err(err)
 	}

gnverifier_test.go

@@ -1,6 +1,7 @@
 package gnverifier_test
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"os"
@@ -98,7 +99,7 @@ func TestVerifyBatch(t *testing.T) {
 		"Bubo bubo (Linnaeus, 1782)",
 		"NotName",
 	}
-	res := gnv.VerifyBatch(batch)
+	res := gnv.VerifyBatch(context.Background(), batch)
 	assert.Equal(t, 3, len(res))
 	assert.Equal(t, 1, vfr.VerifyCallCount())
 }
@@ -120,7 +121,7 @@ func TestVerifyStream(t *testing.T) {
 	chOut := make(chan []vlib.Name)
 	var wg sync.WaitGroup
 	wg.Add(1)
-	go gnv.VerifyStream(chIn, chOut)
+	go gnv.VerifyStream(context.Background(), chIn, chOut)
 
 	go func() {
 		defer wg.Done()

interface.go

@@ -1,6 +1,8 @@
 package gnverifier
 
 import (
+	"context"
+
 	"github.com/gnames/gnlib/ent/gnvers"
 	vlib "github.com/gnames/gnlib/ent/verifier"
 	"github.com/gnames/gnquery/ent/search"
@@ -15,14 +17,14 @@ type GNverifier interface {
 	VerifyOne(name string) (vlib.Name, error)
 
 	// VerifyBatch takes a slice of names and verifies them all at once
-	VerifyBatch(names []string) []vlib.Name
+	VerifyBatch(ctx context.Context, names []string) []vlib.Name
 
 	// VerifyStream receves batches of strings via one channel, verifies
 	// the strings and sends results to another channel.
-	VerifyStream(in <-chan []string, out chan []vlib.Name)
+	VerifyStream(ctx context.Context, in <-chan []string, out chan []vlib.Name)
 
 	// Search provides faceted search functionality.
-	Search(search.Input) ([]vlib.Name, error)
+	Search(ctx context.Context, srch search.Input) ([]vlib.Name, error)
 
 	// ChangeConfig modifies configuration of GNverifier.
 	ChangeConfig(opts ...config.Option) GNverifier

io/web/server.go

@@ -1,6 +1,7 @@
 package web
 
 import (
+	"context"
 	"embed"
 	"fmt"
 	"net/http"
@@ -256,7 +257,7 @@ func verificationResults(
 			if all := gnv.Config().WithAllMatches; all {
 				inp.WithAllMatches = all
 			}
-			data.Verified, err = gnv.Search(inp)
+			data.Verified, err = gnv.Search(context.Background(), inp)
 			if err != nil {
 				log.Warn(err)
 			}
@@ -274,7 +275,7 @@ func verificationResults(
 				}
 			}
 		} else {
-			data.Verified = gnv.VerifyBatch(names)
+			data.Verified = gnv.VerifyBatch(context.Background(), names)
 
 			if l := len(names); l > 0 {
 				zlog.Info().

version.go

@@ -2,7 +2,7 @@ package gnverifier
 
 var (
 	// Version of the gnverifier
-	Version = "v0.8.2+"
+	Version = "v0.9.0+"
 	// Build timestamp
 	Build = "n/a"
 )