[TT-11737] [PoC] custom Tyk directive @uppercase

pkg/customdirective/customdirective.go

@@ -0,0 +1,7 @@
+package customdirective
+
+type CustomDirective interface {
+	Name() string
+	DataType() string
+	Execute([]byte) ([]byte, error)
+}

pkg/engine/datasource/graphql_datasource/graphql_datasource.go

@@ -8,22 +8,22 @@ import (
 	"io"
 	"net/http"
 
-	"github.com/buger/jsonparser"
-	"github.com/tidwall/sjson"
-
 	"github.com/TykTechnologies/graphql-go-tools/internal/pkg/unsafebytes"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/ast"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/astnormalization"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/astparser"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/astprinter"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/asttransform"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/astvalidation"
+	"github.com/TykTechnologies/graphql-go-tools/pkg/customdirective"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/engine/datasource/httpclient"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/engine/plan"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/engine/resolve"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/federation"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/lexer/literal"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/operationreport"
+	"github.com/buger/jsonparser"
+	"github.com/tidwall/sjson"
 )
 
 const removeNullVariablesDirectiveName = "removeNullVariables"
@@ -60,7 +60,8 @@ type Planner struct {
 	customScalarFieldRef    int
 	unnulVariables          bool
 
-	parentTypeNodes []ast.Node
+	parentTypeNodes  []ast.Node
+	customDirectives map[string]customdirective.CustomDirective
 }
 
 func (p *Planner) parentNodeIsAbstract() bool {
@@ -90,6 +91,11 @@ func (p *Planner) EnterDirective(ref int) {
 
 func (p *Planner) addDirectiveToNode(directiveRef int, node ast.Node) {
 	directiveName := p.visitor.Operation.DirectiveNameString(directiveRef)
+	if _, ok := p.customDirectives[directiveName]; ok {
+		// Custom directive
+		return
+	}
+
 	operationType := ast.OperationTypeQuery
 	if !p.isNested {
 		operationType = p.visitor.Operation.OperationDefinitions[p.visitor.Walker.Ancestors[0].Ref].OperationType
@@ -1308,6 +1314,7 @@ type Factory struct {
 	StreamingClient            *http.Client
 	OnWsConnectionInitCallback *OnWsConnectionInitCallback
 	SubscriptionClient         *SubscriptionClient
+	CustomDirectives           map[string]customdirective.CustomDirective
 }
 
 func (f *Factory) Planner(ctx context.Context) plan.DataSourcePlanner {
@@ -1325,6 +1332,7 @@ func (f *Factory) Planner(ctx context.Context) plan.DataSourcePlanner {
 		batchFactory:       f.BatchFactory,
 		fetchClient:        f.HTTPClient,
 		subscriptionClient: f.SubscriptionClient,
+		customDirectives:   f.CustomDirectives,
 	}
 }
 

pkg/engine/plan/plan.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/TykTechnologies/graphql-go-tools/pkg/customdirective"
 	"reflect"
 	"regexp"
 	"strings"
@@ -37,6 +38,7 @@ type Configuration struct {
 	// In production, this should be set to false so that error messages are easier to understand
 	DisableResolveFieldPositions bool
 	CustomResolveMap             map[string]resolve.CustomResolve
+	CustomDirectives             map[string]customdirective.CustomDirective
 }
 
 type DirectiveConfigurations []DirectiveConfiguration
@@ -247,6 +249,7 @@ func NewPlanner(ctx context.Context, config Configuration) *Planner {
 		Walker:                       &planningWalker,
 		fieldConfigs:                 map[int]*FieldConfiguration{},
 		disableResolveFieldPositions: config.DisableResolveFieldPositions,
+		CustomDirectives:             config.CustomDirectives,
 	}
 
 	p := &Planner{
@@ -384,6 +387,7 @@ type Visitor struct {
 	exportedVariables            map[string]struct{}
 	skipIncludeFields            map[int]skipIncludeField
 	disableResolveFieldPositions bool
+	CustomDirectives             map[string]customdirective.CustomDirective
 }
 
 type skipIncludeField struct {
@@ -748,11 +752,23 @@ func (v *Visitor) resolveFieldValue(fieldRef, typeRef int, nullable bool, path [
 			fieldExport := v.resolveFieldExport(fieldRef)
 			switch typeName {
 			case "String":
+
+				// Start TT-11737 - [PoC] custom Tyk directive @uppercase
+				var customDirectives []customdirective.CustomDirective
+				for _, ref := range v.Operation.Fields[fieldRef].Directives.Refs {
+					directiveName := v.Operation.Input.ByteSliceString(v.Operation.Directives[ref].Name)
+					if customDirective, ok := v.CustomDirectives[directiveName]; ok {
+						customDirectives = append(customDirectives, customDirective)
+					}
+				}
+				// End
+
 				return &resolve.String{
 					Path:                 path,
 					Nullable:             nullable,
 					Export:               fieldExport,
 					UnescapeResponseJson: unescapeResponseJson,
+					CustomDirectives:     customDirectives,
 				}
 			case "Boolean":
 				return &resolve.Boolean{

pkg/engine/resolve/resolve.go

@@ -14,14 +14,14 @@ import (
 	"sync"
 	"time"
 
-	"github.com/buger/jsonparser"
-	"github.com/cespare/xxhash/v2"
-	"github.com/tidwall/gjson"
-
 	"github.com/TykTechnologies/graphql-go-tools/internal/pkg/unsafebytes"
+	"github.com/TykTechnologies/graphql-go-tools/pkg/customdirective"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/fastbuffer"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/lexer/literal"
 	"github.com/TykTechnologies/graphql-go-tools/pkg/pool"
+	"github.com/buger/jsonparser"
+	"github.com/cespare/xxhash/v2"
+	"github.com/tidwall/gjson"
 )
 
 var (
@@ -1016,6 +1016,15 @@ func (r *Resolver) resolveString(ctx *Context, str *String, data []byte, stringB
 	)
 
 	value, valueType, _, err = jsonparser.Get(data, str.Path...)
+	// Start - TT-11737 - [PoC] custom Tyk directive @uppercase
+	for _, dir := range str.CustomDirectives {
+		value, err = dir.Execute(value)
+		if err != nil {
+			return err
+		}
+	}
+	// End - TT-11737
+
 	if err != nil || valueType != jsonparser.String {
 		if err == nil && str.UnescapeResponseJson {
 			switch valueType {
@@ -1561,6 +1570,7 @@ type String struct {
 	Export               *FieldExport `json:"export,omitempty"`
 	UnescapeResponseJson bool         `json:"unescape_response_json,omitempty"`
 	IsTypeName           bool         `json:"is_type_name,omitempty"`
+	CustomDirectives     []customdirective.CustomDirective
 }
 
 func (_ *String) NodeKind() NodeKind {

pkg/graphql/config_factory_proxy.go

@@ -1,6 +1,7 @@
 package graphql
 
 import (
+	"github.com/TykTechnologies/graphql-go-tools/pkg/customdirective"
 	"net/http"
 	"time"
 
@@ -13,10 +14,17 @@ type proxyEngineConfigFactoryOptions struct {
 	httpClient                *http.Client
 	streamingClient           *http.Client
 	subscriptionClientFactory graphqlDataSource.GraphQLSubscriptionClientFactory
+	customDirectives          map[string]customdirective.CustomDirective
 }
 
 type ProxyEngineConfigFactoryOption func(options *proxyEngineConfigFactoryOptions)
 
+func WithProxyCustomDirectives(customDirectives map[string]customdirective.CustomDirective) ProxyEngineConfigFactoryOption {
+	return func(options *proxyEngineConfigFactoryOptions) {
+		options.customDirectives = customDirectives
+	}
+}
+
 func WithProxyHttpClient(client *http.Client) ProxyEngineConfigFactoryOption {
 	return func(options *proxyEngineConfigFactoryOptions) {
 		options.httpClient = client
@@ -51,6 +59,7 @@ type ProxyEngineConfigFactory struct {
 	proxyUpstreamConfig       ProxyUpstreamConfig
 	batchFactory              resolve.DataSourceBatchFactory
 	subscriptionClientFactory graphqlDataSource.GraphQLSubscriptionClientFactory
+	customDirectives          map[string]customdirective.CustomDirective
 }
 
 func NewProxyEngineConfigFactory(schema *Schema, proxyUpstreamConfig ProxyUpstreamConfig, batchFactory resolve.DataSourceBatchFactory, opts ...ProxyEngineConfigFactoryOption) *ProxyEngineConfigFactory {
@@ -79,6 +88,7 @@ func NewProxyEngineConfigFactory(schema *Schema, proxyUpstreamConfig ProxyUpstre
 		proxyUpstreamConfig:       proxyUpstreamConfig,
 		batchFactory:              batchFactory,
 		subscriptionClientFactory: options.subscriptionClientFactory,
+		customDirectives:          options.customDirectives,
 	}
 }
 
@@ -97,6 +107,8 @@ func (p *ProxyEngineConfigFactory) EngineV2Configuration() (EngineV2Configuratio
 
 	conf := NewEngineV2Configuration(p.schema)
 
+	conf.SetCustomDirectives(p.customDirectives)
+
 	rawDoc, report := astparser.ParseGraphqlDocumentBytes(p.schema.rawInput)
 	if report.HasErrors() {
 		return EngineV2Configuration{}, report
@@ -108,6 +120,7 @@ func (p *ProxyEngineConfigFactory) EngineV2Configuration() (EngineV2Configuratio
 		p.httpClient,
 		WithDataSourceV2GeneratorSubscriptionConfiguration(p.streamingClient, p.proxyUpstreamConfig.SubscriptionType),
 		WithDataSourceV2GeneratorSubscriptionClientFactory(p.subscriptionClientFactory),
+		WithDataSourceV2GeneratorCustomDirectives(p.customDirectives),
 	)
 	if err != nil {
 		return EngineV2Configuration{}, err

pkg/graphql/engine_config_v2.go

@@ -2,6 +2,7 @@ package graphql
 
 import (
 	"errors"
+	"github.com/TykTechnologies/graphql-go-tools/pkg/customdirective"
 	"net/http"
 
 	"github.com/TykTechnologies/graphql-go-tools/pkg/ast"
@@ -19,6 +20,7 @@ type EngineV2Configuration struct {
 	plannerConfig            plan.Configuration
 	websocketBeforeStartHook WebsocketBeforeStartHook
 	dataLoaderConfig         dataLoaderConfig
+	customDirectives         map[string]customdirective.CustomDirective
 }
 
 func NewEngineV2Configuration(schema *Schema) EngineV2Configuration {
@@ -41,6 +43,14 @@ type dataLoaderConfig struct {
 	EnableDataLoader         bool
 }
 
+func (e *EngineV2Configuration) SetCustomDirectives(customDirectives map[string]customdirective.CustomDirective) {
+	e.plannerConfig.CustomDirectives = customDirectives
+}
+
+func (e *EngineV2Configuration) CustomDirectives() map[string]customdirective.CustomDirective {
+	return e.plannerConfig.CustomDirectives
+}
+
 func (e *EngineV2Configuration) SetCustomResolveMap(customResolveMap map[string]resolve.CustomResolve) {
 	e.plannerConfig.CustomResolveMap = customResolveMap
 }
@@ -86,10 +96,17 @@ type dataSourceV2GeneratorOptions struct {
 	streamingClient           *http.Client
 	subscriptionType          SubscriptionType
 	subscriptionClientFactory graphqlDataSource.GraphQLSubscriptionClientFactory
+	customDirectives          map[string]customdirective.CustomDirective
 }
 
 type DataSourceV2GeneratorOption func(options *dataSourceV2GeneratorOptions)
 
+func WithDataSourceV2GeneratorCustomDirectives(customDirectives map[string]customdirective.CustomDirective) DataSourceV2GeneratorOption {
+	return func(options *dataSourceV2GeneratorOptions) {
+		options.customDirectives = customDirectives
+	}
+}
+
 func WithDataSourceV2GeneratorSubscriptionConfiguration(streamingClient *http.Client, subscriptionType SubscriptionType) DataSourceV2GeneratorOption {
 	return func(options *dataSourceV2GeneratorOptions) {
 		options.streamingClient = streamingClient
@@ -129,9 +146,10 @@ func (d *graphqlDataSourceV2Generator) Generate(config graphqlDataSource.Configu
 	}
 
 	factory := &graphqlDataSource.Factory{
-		HTTPClient:      httpClient,
-		StreamingClient: definedOptions.streamingClient,
-		BatchFactory:    batchFactory,
+		HTTPClient:       httpClient,
+		StreamingClient:  definedOptions.streamingClient,
+		BatchFactory:     batchFactory,
+		CustomDirectives: definedOptions.customDirectives,
 	}
 
 	subscriptionClient, err := d.generateSubscriptionClient(httpClient, definedOptions)