feat: add module to add operation name also as operationName field

router-tests/modules/add_operation_name_test.go

@@ -0,0 +1,83 @@
+package module_test
+
+import (
+	"encoding/json"
+	"io"
+	"net/http"
+	"sync"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	custom_add_operation_name "github.com/wundergraph/cosmo/router-tests/modules/custom-add-operation-name"
+	"github.com/wundergraph/cosmo/router-tests/testenv"
+	"github.com/wundergraph/cosmo/router/core"
+	"github.com/wundergraph/cosmo/router/pkg/config"
+)
+
+func TestAddOperationNameModule(t *testing.T) {
+	t.Parallel()
+
+	t.Run("adds the client operation name to the origin request body", func(t *testing.T) {
+		t.Parallel()
+
+		cfg := config.Config{
+			Graph: config.Graph{},
+			Modules: map[string]any{
+				"addOperationNameModule": custom_add_operation_name.AddOperationNameModule{},
+			},
+		}
+
+		var (
+			mu             sync.Mutex
+			capturedBodies [][]byte
+		)
+
+		testenv.Run(t, &testenv.Config{
+			Subgraphs: testenv.SubgraphsConfig{
+				GlobalMiddleware: func(handler http.Handler) http.Handler {
+					return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+						body, err := io.ReadAll(r.Body)
+						require.NoError(t, err)
+
+						mu.Lock()
+						capturedBodies = append(capturedBodies, body)
+						mu.Unlock()
+
+						handler.ServeHTTP(w, r)
+					})
+				},
+			},
+			RouterOptions: []core.Option{
+				core.WithModulesConfig(cfg.Modules),
+				core.WithCustomModules(&custom_add_operation_name.AddOperationNameModule{}),
+			},
+			ModifyEngineExecutionConfiguration: func(conf *config.EngineExecutionConfiguration) {
+				conf.EnableSubgraphFetchOperationName = true
+			},
+		}, func(t *testing.T, xEnv *testenv.Environment) {
+			res, err := xEnv.MakeGraphQLRequest(testenv.GraphQLRequest{
+				Query:         `query MyQuery { employees { id } }`,
+				OperationName: json.RawMessage(`"MyQuery"`),
+			})
+			require.NoError(t, err)
+			require.Equal(t, 200, res.Response.StatusCode)
+
+			mu.Lock()
+			defer mu.Unlock()
+			require.Len(t, capturedBodies, 1)
+
+			var payload map[string]json.RawMessage
+			require.NoError(t, json.Unmarshal(capturedBodies[0], &payload))
+
+			// The operationName property must sit at the same level as the query property
+			require.Contains(t, payload, "query")
+			require.Contains(t, payload, "operationName")
+
+			var operationName string
+			require.NoError(t, json.Unmarshal(payload["operationName"], &operationName))
+			assert.Equal(t, "MyQuery__employees__0", operationName)
+		})
+	})
+}

router-tests/modules/custom-add-operation-name/module.go

@@ -0,0 +1,73 @@
+package module
+
+import (
+	"bytes"
+	"io"
+	"net/http"
+
+	"github.com/wundergraph/astjson"
+	"github.com/wundergraph/cosmo/router/core"
+	"github.com/wundergraph/graphql-go-tools/v2/pkg/astparser"
+	"go.uber.org/zap"
+)
+
+const moduleID = "addOperationNameModule"
+
+type AddOperationNameModule struct {
+	Logger *zap.Logger
+}
+
+func (m *AddOperationNameModule) Provision(ctx *core.ModuleContext) error {
+
+	// Assign the logger to the module for non-request related logging
+	m.Logger = ctx.Logger
+
+	return nil
+}
+
+func (m *AddOperationNameModule) OnOriginRequest(request *http.Request, ctx core.RequestContext) (*http.Request, *http.Response) {
+	if request.Body == nil {
+		return request, nil
+	}
+	body, err := io.ReadAll(request.Body)
+	_ = request.Body.Close()
+	if err != nil {
+		m.Logger.Error("addOperationNameModule: failed to read origin request body", zap.Error(err))
+		return request, nil
+	}
+
+	// Best-effort: on any parse failure, forward the original body unchanged.
+	if payload, err := astjson.ParseBytes(body); err == nil {
+		doc, report := astparser.ParseGraphqlDocumentBytes(payload.GetStringBytes("query"))
+		if !report.HasErrors() && len(doc.OperationDefinitions) == 1 {
+			if name := doc.Input.ByteSlice(doc.OperationDefinitions[0].Name); len(name) > 0 {
+				payload.Set(nil, "operationName", astjson.StringValueBytes(nil, name))
+				body = payload.MarshalTo(nil)
+			}
+		}
+	}
+	request.Body = io.NopCloser(bytes.NewReader(body))
+	request.ContentLength = int64(len(body))
+	request.GetBody = func() (io.ReadCloser, error) {
+		return io.NopCloser(bytes.NewReader(body)), nil
+	}
+	return request, nil
+}
+
+func (m *AddOperationNameModule) Module() core.ModuleInfo {
+	return core.ModuleInfo{
+		// This is the ID of your module, it must be unique
+		ID: moduleID,
+		// The priority of your module, lower numbers are executed first
+		Priority: 1,
+		New: func() core.Module {
+			return &AddOperationNameModule{}
+		},
+	}
+}
+
+// Interface guard
+var (
+	_ core.EnginePreOriginHandler = (*AddOperationNameModule)(nil)
+	_ core.Provisioner            = (*AddOperationNameModule)(nil)
+)

router/cmd/custom-add-operation-name/module.go

@@ -0,0 +1,78 @@
+package module
+
+import (
+	"bytes"
+	"io"
+	"net/http"
+
+	"github.com/wundergraph/astjson"
+	"github.com/wundergraph/cosmo/router/core"
+	"github.com/wundergraph/graphql-go-tools/v2/pkg/astparser"
+	"go.uber.org/zap"
+)
+
+func init() {
+	// Register your module here
+	core.RegisterModule(&AddOperationNameModule{})
+}
+
+const moduleID = "addOperationNameModule"
+
+type AddOperationNameModule struct {
+	Logger *zap.Logger
+}
+
+func (m *AddOperationNameModule) Provision(ctx *core.ModuleContext) error {
+
+	// Assign the logger to the module for non-request related logging
+	m.Logger = ctx.Logger
+
+	return nil
+}
+
+func (m *AddOperationNameModule) OnOriginRequest(request *http.Request, ctx core.RequestContext) (*http.Request, *http.Response) {
+	if request.Body == nil {
+		return request, nil
+	}
+	body, err := io.ReadAll(request.Body)
+	_ = request.Body.Close()
+	if err != nil {
+		m.Logger.Error("addOperationNameModule: failed to read origin request body", zap.Error(err))
+		return request, nil
+	}
+
+	// Best-effort: on any parse failure, forward the original body unchanged.
+	if payload, err := astjson.ParseBytes(body); err == nil {
+		doc, report := astparser.ParseGraphqlDocumentBytes(payload.GetStringBytes("query"))
+		if !report.HasErrors() && len(doc.OperationDefinitions) == 1 {
+			if name := doc.Input.ByteSlice(doc.OperationDefinitions[0].Name); len(name) > 0 {
+				payload.Set(nil, "operationName", astjson.StringValueBytes(nil, name))
+				body = payload.MarshalTo(nil)
+			}
+		}
+	}
+	request.Body = io.NopCloser(bytes.NewReader(body))
+	request.ContentLength = int64(len(body))
+	request.GetBody = func() (io.ReadCloser, error) {
+		return io.NopCloser(bytes.NewReader(body)), nil
+	}
+	return request, nil
+}
+
+func (m *AddOperationNameModule) Module() core.ModuleInfo {
+	return core.ModuleInfo{
+		// This is the ID of your module, it must be unique
+		ID: moduleID,
+		// The priority of your module, lower numbers are executed first
+		Priority: 1,
+		New: func() core.Module {
+			return &AddOperationNameModule{}
+		},
+	}
+}
+
+// Interface guard
+var (
+	_ core.EnginePreOriginHandler = (*AddOperationNameModule)(nil)
+	_ core.Provisioner            = (*AddOperationNameModule)(nil)
+)

router/cmd/main.go

@@ -22,6 +22,8 @@ import (
 	"github.com/wundergraph/cosmo/router/pkg/profile"
 	"github.com/wundergraph/cosmo/router/pkg/watcher"
 
+	_ "github.com/wundergraph/cosmo/router/cmd/custom-add-operation-name"
+
 	"go.uber.org/zap"
 )