Skip to content

feat: add cache hit statuses to expr context #2643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SkArchon merged 7 commits into from
Mar 16, 2026
Merged

feat: add cache hit statuses to expr context #2643

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
21cc5dc
feat: add cache hit statuses to expr context
SkArchon Mar 12, 2026
d09726f
fix: reset websockets
SkArchon Mar 12, 2026
f0f11d5
Merge remote-tracking branch 'origin/main' into milinda/eng-9179-rout…
SkArchon Mar 15, 2026
1523507
feat: documentation
SkArchon Mar 15, 2026
e98cbbb
fix: tests
SkArchon Mar 15, 2026
8021533
Merge branch 'main' into milinda/eng-9179-router-add-cache-metric-hit…
SkArchon Mar 16, 2026
2e756cb
fix: updates
SkArchon Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 219 additions & 0 deletions router-tests/structured_logging_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2910,6 +2910,225 @@ func TestFlakyAccessLogs(t *testing.T) {
})
})
})

t.Run("validate request.operation.normalizationCacheHit expression", func(t *testing.T) {
t.Parallel()

testenv.Run(t,
&testenv.Config{
AccessLogFields: []config.CustomAttribute{
{
Key: "normalization_cache_hit",
ValueFrom: &config.CustomDynamicAttribute{
Expression: "request.operation.normalizationCacheHit",
},
},
},
LogObservation: testenv.LogObservationConfig{
Enabled: true,
LogLevel: zapcore.InfoLevel,
},
},
func(t *testing.T, xEnv *testenv.Environment) {
// First request: cache miss
xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: `query employees { employees { id } }`,
})
requestLog := xEnv.Observer().FilterMessage("/graphql")
requestContext := requestLog.All()[0].ContextMap()
val, ok := requestContext["normalization_cache_hit"].(bool)
require.True(t, ok)
require.False(t, val)

// Second request: cache hit
xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: `query employees { employees { id } }`,
})
requestLog = xEnv.Observer().FilterMessage("/graphql")
requestContext = requestLog.All()[1].ContextMap()
val, ok = requestContext["normalization_cache_hit"].(bool)
require.True(t, ok)
require.True(t, val)
},
)
})

t.Run("validate request.operation.variablesNormalizationCacheHit expression", func(t *testing.T) {
t.Parallel()

testenv.Run(t,
&testenv.Config{
AccessLogFields: []config.CustomAttribute{
{
Key: "variables_normalization_cache_hit",
ValueFrom: &config.CustomDynamicAttribute{
Expression: "request.operation.variablesNormalizationCacheHit",
},
},
},
LogObservation: testenv.LogObservationConfig{
Enabled: true,
LogLevel: zapcore.InfoLevel,
},
},
func(t *testing.T, xEnv *testenv.Environment) {
// First request: cache miss
xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: `query employees { employees { id } }`,
})
requestLog := xEnv.Observer().FilterMessage("/graphql")
requestContext := requestLog.All()[0].ContextMap()
val, ok := requestContext["variables_normalization_cache_hit"].(bool)
require.True(t, ok)
require.False(t, val)

// Second request: cache hit
xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: `query employees { employees { id } }`,
})
requestLog = xEnv.Observer().FilterMessage("/graphql")
requestContext = requestLog.All()[1].ContextMap()
val, ok = requestContext["variables_normalization_cache_hit"].(bool)
require.True(t, ok)
require.True(t, val)
},
)
})

t.Run("validate request.operation.variablesRemappingCacheHit expression", func(t *testing.T) {
t.Parallel()

testenv.Run(t,
&testenv.Config{
AccessLogFields: []config.CustomAttribute{
{
Key: "variables_remapping_cache_hit",
ValueFrom: &config.CustomDynamicAttribute{
Expression: "request.operation.variablesRemappingCacheHit",
},
},
},
LogObservation: testenv.LogObservationConfig{
Enabled: true,
LogLevel: zapcore.InfoLevel,
},
},
func(t *testing.T, xEnv *testenv.Environment) {
// First request: cache miss
xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: `query employees { employees { id } }`,
})
requestLog := xEnv.Observer().FilterMessage("/graphql")
requestContext := requestLog.All()[0].ContextMap()
val, ok := requestContext["variables_remapping_cache_hit"].(bool)
require.True(t, ok)
require.False(t, val)

// Second request: cache hit
xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: `query employees { employees { id } }`,
})
requestLog = xEnv.Observer().FilterMessage("/graphql")
requestContext = requestLog.All()[1].ContextMap()
val, ok = requestContext["variables_remapping_cache_hit"].(bool)
require.True(t, ok)
require.True(t, val)
},
)
})

t.Run("validate request.operation.persistedOperationCacheHit expression", func(t *testing.T) {
t.Parallel()

testenv.Run(t,
&testenv.Config{
AccessLogFields: []config.CustomAttribute{
{
Key: "persisted_operation_cache_hit",
ValueFrom: &config.CustomDynamicAttribute{
Expression: "request.operation.persistedOperationCacheHit",
},
},
},
LogObservation: testenv.LogObservationConfig{
Enabled: true,
LogLevel: zapcore.InfoLevel,
},
},
func(t *testing.T, xEnv *testenv.Environment) {
// First request with persisted operation: cache miss
res, err := xEnv.MakeGraphQLRequest(testenv.GraphQLRequest{
OperationName: []byte(`"Employees"`),
Extensions: []byte(`{"persistedQuery": {"version": 1, "sha256Hash": "dc67510fb4289672bea757e862d6b00e83db5d3cbbcfb15260601b6f29bb2b8f"}}`),
Header: map[string][]string{"graphql-client-name": {"my-client"}},
})
require.NoError(t, err)
require.JSONEq(t, employeesIDData, res.Body)
requestLog := xEnv.Observer().FilterMessage("/graphql")
requestContext := requestLog.All()[0].ContextMap()
val, ok := requestContext["persisted_operation_cache_hit"].(bool)
require.True(t, ok)
require.False(t, val)

// Second request: cache hit
res, err = xEnv.MakeGraphQLRequest(testenv.GraphQLRequest{
OperationName: []byte(`"Employees"`),
Extensions: []byte(`{"persistedQuery": {"version": 1, "sha256Hash": "dc67510fb4289672bea757e862d6b00e83db5d3cbbcfb15260601b6f29bb2b8f"}}`),
Header: map[string][]string{"graphql-client-name": {"my-client"}},
})
require.NoError(t, err)
require.JSONEq(t, employeesIDData, res.Body)
requestLog = xEnv.Observer().FilterMessage("/graphql")
requestContext = requestLog.All()[1].ContextMap()
val, ok = requestContext["persisted_operation_cache_hit"].(bool)
require.True(t, ok)
require.True(t, val)
},
)
})

t.Run("validate request.operation.planCacheHit expression", func(t *testing.T) {
t.Parallel()

testenv.Run(t,
&testenv.Config{
AccessLogFields: []config.CustomAttribute{
{
Key: "plan_cache_hit",
ValueFrom: &config.CustomDynamicAttribute{
Expression: "request.operation.planCacheHit",
},
},
},
LogObservation: testenv.LogObservationConfig{
Enabled: true,
LogLevel: zapcore.InfoLevel,
},
},
func(t *testing.T, xEnv *testenv.Environment) {
// First request: cache miss
xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: `query employees { employees { id } }`,
})
requestLog := xEnv.Observer().FilterMessage("/graphql")
requestContext := requestLog.All()[0].ContextMap()
val, ok := requestContext["plan_cache_hit"].(bool)
require.True(t, ok)
require.False(t, val)

// Second request: cache hit
xEnv.MakeGraphQLRequestOK(testenv.GraphQLRequest{
Query: `query employees { employees { id } }`,
})
requestLog = xEnv.Observer().FilterMessage("/graphql")
requestContext = requestLog.All()[1].ContextMap()
val, ok = requestContext["plan_cache_hit"].(bool)
require.True(t, ok)
require.True(t, val)
},
)
})

})

t.Run("verify error codes from engine and not subgraph", func(t *testing.T) {
Expand Down
5 changes: 5 additions & 0 deletions router/core/graphql_prehandler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,7 @@ func (h *PreHandler) handleOperation(req *http.Request, httpOperation *httpOpera
span.End()

requestContext.operation.persistedOperationCacheHit = operationKit.parsedOperation.PersistedOperationCacheHit
requestContext.expressionContext.Request.Operation.PersistedOperationCacheHit = operationKit.parsedOperation.PersistedOperationCacheHit
}

// If the persistent operation is already in the cache, we skip the parse step
Expand Down Expand Up @@ -810,6 +811,7 @@ func (h *PreHandler) handleOperation(req *http.Request, httpOperation *httpOpera

engineNormalizeSpan.SetAttributes(otel.WgNormalizationCacheHit.Bool(cached))
requestContext.operation.normalizationCacheHit = operationKit.parsedOperation.NormalizationCacheHit
requestContext.expressionContext.Request.Operation.NormalizationCacheHit = operationKit.parsedOperation.NormalizationCacheHit

/**
* Normalize the variables
Expand All @@ -832,6 +834,7 @@ func (h *PreHandler) handleOperation(req *http.Request, httpOperation *httpOpera
}
engineNormalizeSpan.SetAttributes(otel.WgVariablesNormalizationCacheHit.Bool(cached))
requestContext.operation.variablesNormalizationCacheHit = cached
requestContext.expressionContext.Request.Operation.VariablesNormalizationCacheHit = cached

// Update file upload paths if they were used in the nested field of the extracted variables.
for mapping := range slices.Values(uploadsMapping) {
Expand Down Expand Up @@ -883,6 +886,7 @@ func (h *PreHandler) handleOperation(req *http.Request, httpOperation *httpOpera

engineNormalizeSpan.SetAttributes(otel.WgVariablesRemappingCacheHit.Bool(cached))
requestContext.operation.variablesRemappingCacheHit = cached
requestContext.expressionContext.Request.Operation.VariablesRemappingCacheHit = cached
requestContext.operation.hash = operationKit.parsedOperation.ID
requestContext.operation.internalHash = operationKit.parsedOperation.InternalID
requestContext.operation.remapVariables = operationKit.parsedOperation.RemapVariables
Expand Down Expand Up @@ -1100,6 +1104,7 @@ func (h *PreHandler) handleOperation(req *http.Request, httpOperation *httpOpera
requestContext.expressionContext.Request.Operation.PlanningTime = requestContext.operation.planningTime
setTelemetryAttributes(planCtx, requestContext, expr.BucketPlanningTime)

requestContext.expressionContext.Request.Operation.PlanCacheHit = requestContext.operation.planCacheHit
enginePlanSpan.SetAttributes(otel.WgEnginePlanCacheHit.Bool(requestContext.operation.planCacheHit))
enginePlanSpan.End()

Expand Down
3 changes: 3 additions & 0 deletions router/core/websocket.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,20 +906,23 @@ func (h *WebSocketConnectionHandler) parseAndPlan(registration *SubscriptionRegi
return nil, nil, err
}
opContext.normalizationCacheHit = operationKit.parsedOperation.NormalizationCacheHit
reqCtx.expressionContext.Request.Operation.NormalizationCacheHit = operationKit.parsedOperation.NormalizationCacheHit

cached, _, err := operationKit.NormalizeVariables()
if err != nil {
opContext.normalizationTime = time.Since(startNormalization)
return nil, nil, err
}
opContext.variablesNormalizationCacheHit = cached
reqCtx.expressionContext.Request.Operation.VariablesNormalizationCacheHit = cached

cached, err = operationKit.RemapVariables(h.disableVariablesRemapping)
if err != nil {
opContext.normalizationTime = time.Since(startNormalization)
return nil, nil, err
}
opContext.variablesRemappingCacheHit = cached
reqCtx.expressionContext.Request.Operation.VariablesRemappingCacheHit = cached
Comment thread
SkArchon marked this conversation as resolved.
Outdated

opContext.hash = operationKit.parsedOperation.ID
opContext.internalHash = operationKit.parsedOperation.InternalID
Expand Down
6 changes: 6 additions & 0 deletions router/internal/expr/expr.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,12 @@ type Operation struct {
Hash string `expr:"hash"`
ValidationTime time.Duration `expr:"validationTime"`
PlanningTime time.Duration `expr:"planningTime"`

NormalizationCacheHit bool `expr:"normalizationCacheHit"`
VariablesNormalizationCacheHit bool `expr:"variablesNormalizationCacheHit"`
VariablesRemappingCacheHit bool `expr:"variablesRemappingCacheHit"`
PersistedOperationCacheHit bool `expr:"persistedOperationCacheHit"`
PlanCacheHit bool `expr:"planCacheHit"`
}

type Client struct {
Expand Down
Loading