feat: cancelable web hooks

Introduces the ability to cancel web hooks by calling `error "cancel"` in JsonNet.

persistence/sql/persister_test.go

@@ -3,15 +3,16 @@ package sql_test
 import (
 	"context"
 	"fmt"
-	"github.com/ory/kratos/driver/config"
-	"github.com/ory/kratos/schema"
-	"github.com/ory/x/sqlxx"
-	"github.com/ory/x/urlx"
 	"os"
 	"path/filepath"
 	"sync"
 	"testing"
 
+	"github.com/ory/kratos/driver/config"
+	"github.com/ory/kratos/schema"
+	"github.com/ory/x/sqlxx"
+	"github.com/ory/x/urlx"
+
 	"github.com/ory/kratos/x/xsql"
 
 	"github.com/go-errors/errors"

request/builder.go

@@ -3,20 +3,23 @@ package request
 import (
 	"bytes"
 	"encoding/json"
-	"errors"
 	"io"
 	"net/http"
 	"net/url"
 	"reflect"
 	"strings"
 
+	"github.com/pkg/errors"
+
 	"github.com/google/go-jsonnet"
 	"github.com/hashicorp/go-retryablehttp"
 
 	"github.com/ory/x/fetcher"
 	"github.com/ory/x/logrusx"
 )
 
+var ErrCancel = errors.New("request cancel by JsonNet")
+
 const (
 	ContentTypeForm = "application/x-www-form-urlencoded"
 	ContentTypeJSON = "application/json"
@@ -100,15 +103,21 @@ func (b *Builder) addJSONBody(template *bytes.Buffer, body interface{}) error {
 	enc.SetIndent("", "")
 
 	if err := enc.Encode(body); err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	vm := jsonnet.MakeVM()
 	vm.TLACode("ctx", buf.String())
 
 	res, err := vm.EvaluateAnonymousSnippet(b.conf.TemplateURI, template.String())
 	if err != nil {
-		return err
+		// Unfortunately we can not use errors.As / errors.Is, see:
+		// https://github.com/google/go-jsonnet/issues/592
+		if strings.Contains(err.Error(), (&jsonnet.RuntimeError{Msg: "cancel"}).Error()) {
+			return errors.WithStack(ErrCancel)
+		}
+
+		return errors.WithStack(err)
 	}
 
 	rb := strings.NewReader(res)

request/builder_test.go

@@ -262,6 +262,20 @@ func TestBuildRequest(t *testing.T) {
 			}
 		})
 	}
+
+	t.Run("cancel request", func(t *testing.T) {
+		l := logrusx.New("kratos", "test")
+
+		rb, err := NewBuilder(json.RawMessage(`{
+	"url": "https://test.kratos.ory.sh/my_endpoint6",
+	"method": "POST",
+	"body": "file://./stub/cancel_body.jsonnet"
+}`), nil, l)
+		require.NoError(t, err)
+
+		_, err = rb.BuildRequest(json.RawMessage(`{}`))
+		require.ErrorIs(t, err, ErrCancel)
+	})
 }
 
 func mustContainHeader(t *testing.T, expected http.Header, actual http.Header) {

request/stub/cancel_body.jsonnet

@@ -0,0 +1 @@
+error "cancel"

selfservice/hook/stub/cancel_template.jsonnet

@@ -0,0 +1 @@
+error "cancel"

selfservice/hook/web_hook.go

@@ -6,6 +6,8 @@ import (
 	"fmt"
 	"net/http"
 
+	"github.com/pkg/errors"
+
 	"github.com/ory/kratos/identity"
 	"github.com/ory/kratos/request"
 	"github.com/ory/kratos/selfservice/flow"
@@ -121,7 +123,9 @@ func (e *WebHook) execute(ctx context.Context, data *templateContext) error {
 	}
 
 	req, err := builder.BuildRequest(data)
-	if err != nil {
+	if errors.Is(err, request.ErrCancel) {
+		return nil
+	} else if err != nil {
 		return err
 	}
 

selfservice/hook/web_hook_integration_test.go

@@ -293,7 +293,7 @@ func TestWebHooks(t *testing.T) {
 		})
 	}
 
-	t.Run("Must error when config is erroneous", func(t *testing.T) {
+	t.Run("must error when config is erroneous", func(t *testing.T) {
 		req := &http.Request{
 			Header:     map[string][]string{"Some-Header": {"Some-Value"}},
 			RequestURI: "https://www.ory.sh/some_end_point",
@@ -307,7 +307,7 @@ func TestWebHooks(t *testing.T) {
 		assert.Error(t, err)
 	})
 
-	t.Run("Must error when template is erroneous", func(t *testing.T) {
+	t.Run("must error when template is erroneous", func(t *testing.T) {
 		ts := newServer(webHookHttpCodeEndPoint(200))
 		req := &http.Request{
 			Header:     map[string][]string{"Some-Header": {"Some-Value"}},
@@ -326,6 +326,24 @@ func TestWebHooks(t *testing.T) {
 		assert.Error(t, err)
 	})
 
+	t.Run("must not make request", func(t *testing.T) {
+		req := &http.Request{
+			Header:     map[string][]string{"Some-Header": {"Some-Value"}},
+			RequestURI: "https://www.ory.sh/some_end_point",
+			Method:     http.MethodPost,
+		}
+		f := &login.Flow{ID: x.NewUUID()}
+		conf := json.RawMessage(`{
+	"url": "https://i-do-not-exist/",
+	"method": "POST",
+	"body": "./stub/cancel_template.jsonnet"
+}`)
+		wh := hook.NewWebHook(reg, conf)
+
+		err := wh.ExecuteLoginPreHook(nil, req, f)
+		assert.NoError(t, err)
+	})
+
 	boolToString := func(f bool) string {
 		if f {
 			return " not"