Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

refactor(agent): use concrete canvas state access (#20173)

Sbaaoui Idrissf15de42d58c8
diff --git a/internal/agent/audio/model_provider_synthesizer.go b/internal/agent/audio/model_provider_synthesizer.go
index 65603963ee..e2f45b8da7 100644
--- a/internal/agent/audio/model_provider_synthesizer.go
+++ b/internal/agent/audio/model_provider_synthesizer.go
@@ -97,7 +97,7 @@ func (m *modelProviderSynthesizer) Synthesize(ctx context.Context, req Synthesiz
// Resolve tenant from canvas state when not on the request.
tenantID := ""
- if state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && state != nil {
+ if state, err := runtime.GetStateFromContext(ctx); err == nil && state != nil {
if uid, ok := state.Sys["user_id"].(string); ok {
tenantID = uid
}
diff --git a/internal/agent/canvas/interrupt_resume.go b/internal/agent/canvas/interrupt_resume.go
index db87d3c2a6..b4f93c146f 100644
--- a/internal/agent/canvas/interrupt_resume.go
+++ b/internal/agent/canvas/interrupt_resume.go
@@ -99,7 +99,7 @@ func buildUserFillUpInterruptInfo(ctx context.Context, params map[string]any) ma
if tips == "" {
return info
}
- state, _, err := GetStateFromContext[*CanvasState](ctx)
+ state, err := GetStateFromContext(ctx)
if err != nil || state == nil {
return info
}
diff --git a/internal/agent/canvas/loop_subgraph.go b/internal/agent/canvas/loop_subgraph.go
index c3e40410e6..0398c29bad 100644
--- a/internal/agent/canvas/loop_subgraph.go
+++ b/internal/agent/canvas/loop_subgraph.go
@@ -199,7 +199,7 @@ func buildSubWorkflow(
// build time by resolveLoopVarValue)
initNode := sub.AddLambdaNode(loopInitKey,
compose.InvokableLambda(func(ctx context.Context, in map[string]any) (map[string]any, error) {
- state, _, err := GetStateFromContext[*CanvasState](ctx)
+ state, err := GetStateFromContext(ctx)
if err != nil || state == nil {
return in, nil
}
@@ -529,7 +529,7 @@ func translateLoopCondition(loopID string, params map[string]any) (workflowx.Loo
// and other DSL variables. The workflowx lambda passes the
// loop's outer context into this closure, so
// canvas.GetStateFromContext works.
- state, _, err := GetStateFromContext[*CanvasState](ctx)
+ state, err := GetStateFromContext(ctx)
if err != nil || state == nil {
return false, fmt.Errorf("loop %q: condition eval: no canvas state in context", loopID)
}
diff --git a/internal/agent/canvas/loop_subgraph_test.go b/internal/agent/canvas/loop_subgraph_test.go
index 6770983042..069b016c9a 100644
--- a/internal/agent/canvas/loop_subgraph_test.go
+++ b/internal/agent/canvas/loop_subgraph_test.go
@@ -801,7 +801,7 @@ func TestBuildWorkflow_LoopSharesOuterCanvasState(t *testing.T) {
state := NewCanvasState("run-1", "task-1")
ctx := WithState(t.Context(), state)
- got, _, err := GetStateFromContext[*CanvasState](ctx)
+ got, err := GetStateFromContext(ctx)
if err != nil {
t.Fatalf("GetStateFromContext: %v", err)
}
diff --git a/internal/agent/canvas/node_body.go b/internal/agent/canvas/node_body.go
index c4fe408aba..5d1472eb9a 100644
--- a/internal/agent/canvas/node_body.go
+++ b/internal/agent/canvas/node_body.go
@@ -320,7 +320,7 @@ func placeholderBody(cpnID string) nodeBodyFn {
func withStateBracket(cpnID, componentName string, body nodeBodyFn) nodeBodyFn {
return func(ctx context.Context, in map[string]any) (map[string]any, error) {
originalIn := in
- state, _, _ := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, _ := runtime.GetStateFromContext(ctx)
if state != nil {
nodeStartedAt(ctx, state, cpnID, componentName, componentName, originalIn)
if in == nil {
diff --git a/internal/agent/canvas/parallel_subgraph.go b/internal/agent/canvas/parallel_subgraph.go
index 306cfff2ef..fe428cb27f 100644
--- a/internal/agent/canvas/parallel_subgraph.go
+++ b/internal/agent/canvas/parallel_subgraph.go
@@ -159,7 +159,7 @@ func buildParallelItemWorkflow(
collector := wrapper.AddLambdaNode(
parallelItemCollectNodeKey,
compose.InvokableLambda(func(ctx context.Context, in map[string]any) (map[string]any, error) {
- localState, _, err := GetStateFromContext[*CanvasState](ctx)
+ localState, err := GetStateFromContext(ctx)
if err != nil || localState == nil {
return nil, fmt.Errorf("canvas: parallel %q item collector: no canvas state in context", parallelID)
}
@@ -201,7 +201,7 @@ func buildParallelOuterWorkflow(
toBatch := outer.AddLambdaNode(
batchInputKey,
compose.InvokableLambda(func(ctx context.Context, _ map[string]any) ([]map[string]any, error) {
- state, _, err := GetStateFromContext[*CanvasState](ctx)
+ state, err := GetStateFromContext(ctx)
if err != nil || state == nil {
return nil, fmt.Errorf("canvas: parallel %q: no canvas state in context", key)
}
@@ -223,7 +223,7 @@ func buildParallelOuterWorkflow(
parOpts = append(parOpts, workflowx.WithParallelContextBuilder(func(
ctx context.Context, item any, index int,
) context.Context {
- parentState, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ parentState, err := runtime.GetStateFromContext(ctx)
if err != nil || parentState == nil {
return ctx
}
diff --git a/internal/agent/canvas/scheduler.go b/internal/agent/canvas/scheduler.go
index 7560dcdb0a..06a8d537a5 100644
--- a/internal/agent/canvas/scheduler.go
+++ b/internal/agent/canvas/scheduler.go
@@ -150,7 +150,7 @@ func statePre(ctx context.Context, in map[string]any, state *CanvasState) (map[s
// downstream components reading via GetStateFromContext see
// the upstream outputs the state post handler already wrote.
if state != nil {
- if ctxState, _, _ := runtime.GetStateFromContext[*runtime.CanvasState](ctx); ctxState != nil && ctxState != state {
+ if ctxState, _ := runtime.GetStateFromContext(ctx); ctxState != nil && ctxState != state {
localHistory := state.SnapshotHistory()
contextHistory := ctxState.SnapshotHistory()
localMemory := state.SnapshotMemory()
@@ -221,7 +221,7 @@ func statePost(ctx context.Context, out map[string]any, state *CanvasState) (map
if cpnID == "" {
return out, nil
}
- ctxState, _, _ := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ ctxState, _ := runtime.GetStateFromContext(ctx)
for k, v := range out {
if k == "__cpn_id__" || k == "state" || k == "__legacy_noop__" {
continue
@@ -429,7 +429,7 @@ func BuildWorkflow(ctx context.Context, c *Canvas) (*compose.Workflow[map[string
// self.globals["env.counter"] = 0 path.
globals := c.Globals
genState := func(runCtx context.Context) *CanvasState {
- if ctxState, _, _ := runtime.GetStateFromContext[*runtime.CanvasState](runCtx); ctxState != nil {
+ if ctxState, _ := runtime.GetStateFromContext(runCtx); ctxState != nil {
st := NewCanvasState(ctxState.RunID, ctxState.SessionID)
for cpnID, bucket := range ctxState.Snapshot() {
for key, value := range bucket {
@@ -484,12 +484,12 @@ func BuildWorkflow(ctx context.Context, c *Canvas) (*compose.Workflow[map[string
opts = append(opts, workflowx.WithLoopStream(workflowx.LoopStreamEveryIteration))
opts = append(opts, workflowx.WithLoopLifecycleHooks(
func(ctx context.Context, input any) {
- state, _, _ := runtime.GetStateFromContext[*CanvasState](ctx)
+ state, _ := runtime.GetStateFromContext(ctx)
in, _ := input.(map[string]any)
nodeStartedAt(ctx, state, cpnID, comp.Obj.ComponentName, comp.Obj.ComponentName, in)
},
func(ctx context.Context, loopErr error) {
- state, _, _ := runtime.GetStateFromContext[*CanvasState](ctx)
+ state, _ := runtime.GetStateFromContext(ctx)
nodeFinishedNow(ctx, state, cpnID, comp.Obj.ComponentName, comp.Obj.ComponentName, loopErr)
},
))
diff --git a/internal/agent/canvas/state.go b/internal/agent/canvas/state.go
index 99bda2818b..521320e289 100644
--- a/internal/agent/canvas/state.go
+++ b/internal/agent/canvas/state.go
@@ -9,7 +9,6 @@ package canvas
import (
"context"
- "sync"
"ragflow/internal/agent/runtime"
)
@@ -25,6 +24,6 @@ func withState(ctx context.Context, s *CanvasState) context.Context {
// GetStateFromContext re-exports runtime.GetStateFromContext so
// canvas-side callers (and tests that already import canvas) keep
// compiling without an extra import.
-func GetStateFromContext[S any](ctx context.Context) (S, *sync.Mutex, error) {
- return runtime.GetStateFromContext[S](ctx)
+func GetStateFromContext(ctx context.Context) (*CanvasState, error) {
+ return runtime.GetStateFromContext(ctx)
}
diff --git a/internal/agent/component/agent.go b/internal/agent/component/agent.go
index ac94a62fce..1f0848ea3e 100644
--- a/internal/agent/component/agent.go
+++ b/internal/agent/component/agent.go
@@ -295,7 +295,7 @@ func scanAllStreamForToolCall(_ context.Context, stream *schema.StreamReader[*sc
// images attached as multi-modal content parts).
func buildAgentInputMessages(ctx context.Context, p AgentParam) []*schema.Message {
var state *runtime.CanvasState
- if s, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && s != nil {
+ if s, err := runtime.GetStateFromContext(ctx); err == nil && s != nil {
state = s
}
// Inject sys.files uploads into the current user message, mirroring
@@ -524,7 +524,7 @@ func applyCitationGrounding(ctx context.Context, db *gorm.DB, p AgentParam, cont
// chunks key is absent / empty. The returned slice is shaped
// for prompts.CitationSource — the grounding renderer.
func chunksFromState(ctx context.Context) []prompts.CitationSource {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return nil
}
@@ -914,7 +914,7 @@ func (c *AgentComponent) invokeNow(ctx context.Context, db *gorm.DB, inputs map[
}
var state *runtime.CanvasState
- if s, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && s != nil {
+ if s, err := runtime.GetStateFromContext(ctx); err == nil && s != nil {
state = s
if inputs["_ERROR"] == "No dataset is selected." {
return map[string]any{"content": "No dataset is selected."}, nil
@@ -962,7 +962,7 @@ func (c *AgentComponent) invokeNow(ctx context.Context, db *gorm.DB, inputs map[
// a dedicated LLM call. The rephrased prompt is what the Agent runner
// actually consumes.
if p.OptimizeMultiTurn {
- if state, _, sErr := runtime.GetStateFromContext[*runtime.CanvasState](ctx); sErr == nil && state != nil {
+ if state, sErr := runtime.GetStateFromContext(ctx); sErr == nil && state != nil {
if rephrased, err := optimizeMultiTurnQuestion(ctx, db, p, state.SnapshotPriorHistory()); err == nil && rephrased != "" {
p.UserPrompt = rephrased
}
@@ -976,7 +976,7 @@ func (c *AgentComponent) invokeNow(ctx context.Context, db *gorm.DB, inputs map[
// the canvas state's Memory. Conversation History is reserved for
// actual user/assistant turns maintained by the canvas service.
if err == nil && msg != nil {
- if state, _, sErr := runtime.GetStateFromContext[*runtime.CanvasState](ctx); sErr == nil && state != nil {
+ if state, sErr := runtime.GetStateFromContext(ctx); sErr == nil && state != nil {
if summary, sErr2 := addToolCallMemory(ctx, db, p, msg); sErr2 == nil && summary != "" {
state.AppendMemory(p.UserPrompt, msg.Content, summary)
}
diff --git a/internal/agent/component/agent_mcp.go b/internal/agent/component/agent_mcp.go
index 34d20985cc..09a4078a78 100644
--- a/internal/agent/component/agent_mcp.go
+++ b/internal/agent/component/agent_mcp.go
@@ -39,7 +39,7 @@ func buildAgentMCPTools(ctx context.Context, db *gorm.DB, raw any, timeout time.
if len(selection.Tools) == 0 {
continue
}
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil || db == nil {
return nil, fmt.Errorf("MCP server %q: missing runtime tenant or database", selection.ID)
}
diff --git a/internal/agent/component/begin.go b/internal/agent/component/begin.go
index 68dcd9b16e..a5dd65a82a 100644
--- a/internal/agent/component/begin.go
+++ b/internal/agent/component/begin.go
@@ -70,7 +70,7 @@ func (b *BeginComponent) Name() string { return b.name }
// outputs unchanged. The input map is shallow-copied to avoid aliasing
// surprises across concurrent goroutines that share an inputs map.
func (b *BeginComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[string]any) (map[string]any, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("begin: %w", err)
}
diff --git a/internal/agent/component/browser.go b/internal/agent/component/browser.go
index b2f0f883bd..6c8f023d1f 100644
--- a/internal/agent/component/browser.go
+++ b/internal/agent/component/browser.go
@@ -262,7 +262,7 @@ func (b *BrowserComponent) Name() string { return b.name }
// File upload/download and session persistence are not supported
// in this component; they are v1-deferred.
func (b *BrowserComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[string]any) (map[string]any, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("browser: %w", err)
}
diff --git a/internal/agent/component/browser_test.go b/internal/agent/component/browser_test.go
index d6ef4c5afb..71ed080009 100644
--- a/internal/agent/component/browser_test.go
+++ b/internal/agent/component/browser_test.go
@@ -171,7 +171,7 @@ func TestBrowser_ResolvesSysQueryTemplate(t *testing.T) {
// need to test template resolution without going through Invoke.
func mustState(t *testing.T, ctx context.Context) *runtime.CanvasState {
t.Helper()
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
t.Fatalf("get state from context: %v", err)
}
diff --git a/internal/agent/component/categorize.go b/internal/agent/component/categorize.go
index 8b9367235e..5b41e96132 100644
--- a/internal/agent/component/categorize.go
+++ b/internal/agent/component/categorize.go
@@ -254,7 +254,7 @@ type categorizeHistoryMessage struct {
func categorizeHistory(ctx context.Context, window int, query string) []categorizeHistoryMessage {
msgs := []categorizeHistoryMessage{}
if window > 0 {
- if state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && state != nil {
+ if state, err := runtime.GetStateFromContext(ctx); err == nil && state != nil {
start := 0
if len(state.History) > window {
start = len(state.History) - window
@@ -301,7 +301,7 @@ func resolveCategorizeQuery(ctx context.Context, p CategorizeParam, inputs map[s
if v, ok := stringValueFromAny(inputs[queryRef]); ok && strings.TrimSpace(v) != "" {
return v
}
- if state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && state != nil {
+ if state, err := runtime.GetStateFromContext(ctx); err == nil && state != nil {
if v, err := state.GetVar(queryRef); err == nil {
if s, ok := stringValueFromAny(v); ok {
return s
diff --git a/internal/agent/component/data_operations.go b/internal/agent/component/data_operations.go
index e5c2679dbf..d5ff158bf3 100644
--- a/internal/agent/component/data_operations.go
+++ b/internal/agent/component/data_operations.go
@@ -185,7 +185,7 @@ func (d *DataOperationsComponent) Name() string { return d.name }
// Invoke loads input_objects from the configured query refs, then
// dispatches to the operation-specific helper.
func (d *DataOperationsComponent) Invoke(ctx context.Context, db *gorm.DB, _ map[string]any) (map[string]any, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("DataOperations: %w", err)
}
diff --git a/internal/agent/component/docs_generator.go b/internal/agent/component/docs_generator.go
index cdab0df9af..a9d4f79007 100644
--- a/internal/agent/component/docs_generator.go
+++ b/internal/agent/component/docs_generator.go
@@ -357,7 +357,7 @@ func resolveDocsGeneratorContent(ctx context.Context, configured string, inputs
return strings.TrimSpace(common.StripThinkTrailing(content)), nil
}
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
return "", err
}
@@ -372,7 +372,7 @@ func resolveDocsGeneratorContent(ctx context.Context, configured string, inputs
}
func storeAgentAttachment(ctx context.Context, docID string, payload []byte) (bool, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return false, nil
}
diff --git a/internal/agent/component/excel_processor.go b/internal/agent/component/excel_processor.go
index b348c004bc..e49866d565 100644
--- a/internal/agent/component/excel_processor.go
+++ b/internal/agent/component/excel_processor.go
@@ -159,7 +159,7 @@ func (e *ExcelProcessorComponent) Invoke(ctx context.Context, db *gorm.DB, input
// ExcelProcessor does not currently read from canvas state for
// binary blobs, but we still pull state so a nil-state error is
// surfaced early.
- if _, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err != nil {
+ if _, err := runtime.GetStateFromContext(ctx); err != nil {
return nil, fmt.Errorf("ExcelProcessor: %w", err)
}
diff --git a/internal/agent/component/fillup.go b/internal/agent/component/fillup.go
index 7cd7111db8..c38334f8db 100644
--- a/internal/agent/component/fillup.go
+++ b/internal/agent/component/fillup.go
@@ -86,7 +86,7 @@ func (f *FillupComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[st
// State is required by the engine contract; we don't read from it
// here, but we still extract it to fail loudly if the engine forgot
// to wire it (consistent with UserFillUp's behavior).
- if _, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err != nil {
+ if _, err := runtime.GetStateFromContext(ctx); err != nil {
return nil, fmt.Errorf("Fillup: %w", err)
}
diff --git a/internal/agent/component/fixture_stubs.go b/internal/agent/component/fixture_stubs.go
index 6beddba533..bf6f5f9fe2 100644
--- a/internal/agent/component/fixture_stubs.go
+++ b/internal/agent/component/fixture_stubs.go
@@ -159,7 +159,7 @@ func (a *AnswerStub) Name() string { return componentNameAnswer }
func (a *AnswerStub) Invoke(ctx context.Context, db *gorm.DB, _ map[string]any) (map[string]any, error) {
// Mirror the no-state-check pattern of Message/Retrieval: we
// don't read state, but the signature must match.
- if _, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err != nil {
+ if _, err := runtime.GetStateFromContext(ctx); err != nil {
return nil, fmt.Errorf("Answer: %w", err)
}
return map[string]any{"answer": ""}, nil
diff --git a/internal/agent/component/list_operations.go b/internal/agent/component/list_operations.go
index 94cf14dbe4..8be3874cdf 100644
--- a/internal/agent/component/list_operations.go
+++ b/internal/agent/component/list_operations.go
@@ -284,7 +284,7 @@ func (l *ListOperationsComponent) Invoke(ctx context.Context, db *gorm.DB, _ map
panic(r)
}()
- state, _, serr := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, serr := runtime.GetStateFromContext(ctx)
if serr != nil {
return nil, fmt.Errorf("ListOperations: %w", serr)
}
diff --git a/internal/agent/component/llm.go b/internal/agent/component/llm.go
index e6305f6b2d..c0a3e9cef2 100644
--- a/internal/agent/component/llm.go
+++ b/internal/agent/component/llm.go
@@ -688,7 +688,7 @@ func (c *LLMComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[strin
// tenantID scopes composite-reference resolution to the tenant's own rows
// so a per-model "max_tokens" override in tenant_model.extra is honored.
tenantID := ""
- if state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && state != nil {
+ if state, err := runtime.GetStateFromContext(ctx); err == nil && state != nil {
if tid, ok := state.Sys["tenant_id"].(string); ok {
tenantID = tid
}
@@ -714,7 +714,7 @@ func (c *LLMComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[strin
// state is absent (e.g. tests that call Invoke directly without
// going through the canvas scheduler), the prompts pass through
// unchanged — backward compatible.
- if state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && state != nil {
+ if state, err := runtime.GetStateFromContext(ctx); err == nil && state != nil {
// ResolveTemplate returns the partial output (with "" in place
// of unresolved refs) even on error — we accept the partial
// output and log the error for diagnostics. This matches
@@ -752,7 +752,7 @@ func (c *LLMComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[strin
var sysFileTexts []string
var sysFileImgs []string
hasSysFilesPlaceholder := strings.Contains(p.SystemPrompt, "{sys.files}") || strings.Contains(p.UserPrompt, "{sys.files}")
- if state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && state != nil {
+ if state, err := runtime.GetStateFromContext(ctx); err == nil && state != nil {
if err := rejectUnsupportedImages(ctx, db, state, originalModelID, p.ModelID); err != nil {
return nil, err
}
@@ -811,7 +811,7 @@ func (c *LLMComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[strin
// empty,
// this is a no-op.
if p.MessageHistoryWindowSize > 0 {
- if state, _, sErr := runtime.GetStateFromContext[*runtime.CanvasState](ctx); sErr == nil && state != nil {
+ if state, sErr := runtime.GetStateFromContext(ctx); sErr == nil && state != nil {
msgs = prependHistory(msgs, state.SnapshotPriorHistory(), p.MessageHistoryWindowSize)
}
}
diff --git a/internal/agent/component/llm_credentials.go b/internal/agent/component/llm_credentials.go
index e2d032f752..83c8794110 100644
--- a/internal/agent/component/llm_credentials.go
+++ b/internal/agent/component/llm_credentials.go
@@ -24,7 +24,7 @@ func resolveTenantLLMConfig(ctx context.Context, db *gorm.DB, driver, modelID, a
if apiKey != "" || driver == "" || modelID == "" {
return apiKey, baseURL
}
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
common.Debug("llm credentials: no canvas state in ctx")
return apiKey, baseURL
@@ -220,7 +220,7 @@ func resolveTenantChatModelByID(ctx context.Context, db *gorm.DB, modelRef, apiK
if !isBareTenantModelID(modelRef) {
return "", "", apiKey, baseURL, false, nil
}
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return "", "", apiKey, baseURL, false, nil
}
diff --git a/internal/agent/component/message.go b/internal/agent/component/message.go
index c9c7328e58..9b07e17266 100644
--- a/internal/agent/component/message.go
+++ b/internal/agent/component/message.go
@@ -172,7 +172,7 @@ func (m *MessageComponent) Name() string { return m.name }
// same node can be reused with different templates at run time when
// the orchestrator wants to override the DSL-declared value.
func (m *MessageComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[string]any) (map[string]any, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("Message: %w", err)
}
diff --git a/internal/agent/component/stagehand_runtime_integration_test.go b/internal/agent/component/stagehand_runtime_integration_test.go
index 433e574fcc..5ce789cfcc 100644
--- a/internal/agent/component/stagehand_runtime_integration_test.go
+++ b/internal/agent/component/stagehand_runtime_integration_test.go
@@ -241,7 +241,7 @@ func TestBrowser_E2E_Extract(t *testing.T) {
}
ctx := canvas.WithState(t.Context(), canvas.NewCanvasState("run-1", "task-1"))
- state, _, _ := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, _ := runtime.GetStateFromContext(ctx)
state.Sys["user_id"] = "tenant-1"
invokeCtx, cancel := context.WithTimeout(ctx, 3*time.Minute)
diff --git a/internal/agent/component/string_transform.go b/internal/agent/component/string_transform.go
index a9503bbf37..9564e80a7b 100644
--- a/internal/agent/component/string_transform.go
+++ b/internal/agent/component/string_transform.go
@@ -140,7 +140,7 @@ func (s *StringTransformComponent) Name() string { return s.name }
// Invoke runs the configured method (split or merge) and returns
// outputs["result"] with the transformed payload.
func (s *StringTransformComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[string]any) (map[string]any, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("StringTransform: %w", err)
}
diff --git a/internal/agent/component/switch.go b/internal/agent/component/switch.go
index e2511e73c6..9d32075ff8 100644
--- a/internal/agent/component/switch.go
+++ b/internal/agent/component/switch.go
@@ -82,7 +82,7 @@ func (s *SwitchComponent) Name() string { return s.name }
// scheduler's MultiBranch condition consumes this list via
// NewGraphMultiBranch so every declared target fires.
func (s *SwitchComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[string]any) (map[string]any, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("Switch: %w", err)
}
diff --git a/internal/agent/component/tool_component.go b/internal/agent/component/tool_component.go
index 0084b37b91..97d42f603d 100644
--- a/internal/agent/component/tool_component.go
+++ b/internal/agent/component/tool_component.go
@@ -98,7 +98,7 @@ func (c *ToolBackedComponent) Invoke(ctx context.Context, db *gorm.DB, inputs ma
if builder, ok := c.tool.(agenttool.ReferenceBuilder); ok {
chunks, docAggs := builder.BuildReferences(ctx, decoded)
- if state, _, stateErr := runtime.GetStateFromContext[*runtime.CanvasState](ctx); stateErr == nil && state != nil {
+ if state, stateErr := runtime.GetStateFromContext(ctx); stateErr == nil && state != nil {
state.SetRetrievalReferences(chunks, docAggs)
}
}
diff --git a/internal/agent/component/universe_a_wrappers.go b/internal/agent/component/universe_a_wrappers.go
index 31f405786d..341497f347 100644
--- a/internal/agent/component/universe_a_wrappers.go
+++ b/internal/agent/component/universe_a_wrappers.go
@@ -203,7 +203,7 @@ func (c *retrievalComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map
merged := c.applyDefaults(inputs)
normalizeLegacyRetrievalInputs(ctx, db, merged)
query, _ := merged["query"].(string)
- if state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && state != nil {
+ if state, err := runtime.GetStateFromContext(ctx); err == nil && state != nil {
if resolved, err := runtime.ResolveTemplateAuto(query, state); err == nil {
query = resolved
}
@@ -413,7 +413,7 @@ func resolveRetrievalDatasetID(ctx context.Context, db *gorm.DB, kbName string)
common.Warn("agent retrieval component: resolve dataset id by id failed",
zap.Error(err))
}
- if state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && state != nil {
+ if state, err := runtime.GetStateFromContext(ctx); err == nil && state != nil {
common.Debug("agent retrieval component: resolve dataset id context")
if tenantID, _ := state.Sys["tenant_id"].(string); tenantID != "" {
if kb, lookupErr := dao.NewKnowledgebaseDAO().GetByName(ctx, db, kbName, tenantID); lookupErr == nil && kb != nil {
@@ -518,7 +518,7 @@ func (c *codeExecComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[
merged[k] = v
}
if rawArgs, ok := merged["arguments"].(map[string]any); ok {
- state, _, _ := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, _ := runtime.GetStateFromContext(ctx)
merged["arguments"] = resolveCodeExecArguments(rawArgs, merged, state)
}
common.Debug("CodeExec wrapper invoke",
@@ -779,7 +779,7 @@ func attachCodeExecArtifacts(ctx context.Context, decoded map[string]any) {
return
}
sessionID := ""
- if state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err == nil && state != nil {
+ if state, err := runtime.GetStateFromContext(ctx); err == nil && state != nil {
sessionID = state.SessionID
}
// The CodeExec tool already hosts sandbox artifacts and surfaces
diff --git a/internal/agent/component/userfillup.go b/internal/agent/component/userfillup.go
index f206248c75..e19d11af80 100644
--- a/internal/agent/component/userfillup.go
+++ b/internal/agent/component/userfillup.go
@@ -122,7 +122,7 @@ func (u *UserFillUpComponent) Invoke(ctx context.Context, db *gorm.DB, inputs ma
// tips substitution uses simple {{key}} placeholders resolved
// against the form input map. We still extract state so a
// nil-state error surfaces early.
- if _, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx); err != nil {
+ if _, err := runtime.GetStateFromContext(ctx); err != nil {
return nil, fmt.Errorf("UserFillUp: %w", err)
}
diff --git a/internal/agent/component/variable_aggregator.go b/internal/agent/component/variable_aggregator.go
index 18c23875fe..ce9278d508 100644
--- a/internal/agent/component/variable_aggregator.go
+++ b/internal/agent/component/variable_aggregator.go
@@ -163,7 +163,7 @@ func (v *VariableAggregatorComponent) Name() string { return v.name }
// per-invocation. When inputs["variables"] is absent the static param
// config is used unchanged.
func (v *VariableAggregatorComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[string]any) (map[string]any, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("VariableAggregator: %w", err)
}
diff --git a/internal/agent/component/variable_assigner.go b/internal/agent/component/variable_assigner.go
index 7fa2e948fd..11579ced64 100644
--- a/internal/agent/component/variable_assigner.go
+++ b/internal/agent/component/variable_assigner.go
@@ -147,7 +147,7 @@ func (v *VariableAssignerComponent) GetInputForm() map[string]any {
// assigned is returned at outputs["assignments"]; per-item errors (if
// any) are returned at outputs["errors"].
func (v *VariableAssignerComponent) Invoke(ctx context.Context, db *gorm.DB, inputs map[string]any) (map[string]any, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil {
return nil, fmt.Errorf("VariableAssigner: %w", err)
}
diff --git a/internal/agent/runtime/context.go b/internal/agent/runtime/context.go
index 05a44f08c3..23b0d71a3f 100644
--- a/internal/agent/runtime/context.go
+++ b/internal/agent/runtime/context.go
@@ -460,29 +460,15 @@ func ResetAgentMessageEmission(ctx context.Context) {
state.mu.Unlock()
}
-// GetStateFromContext extracts a typed state attached via WithState.
-// Returns the state and a nil *sync.Mutex for *CanvasState (the
-// embedded RWMutex is what callers actually contend on through
-// helper methods); the *sync.Mutex return value mirrors eino's
-// getState shape for API parity.
-//
-// The generic type parameter is needed for compatibility with eino's
-// compose.getState[S] signature so callers can write the same shape
-// whether they're reading our state or eino's.
-func GetStateFromContext[S any](ctx context.Context) (S, *sync.Mutex, error) {
- var zero S
+// GetStateFromContext extracts the per-run CanvasState attached via WithState.
+func GetStateFromContext(ctx context.Context) (*CanvasState, error) {
v := ctx.Value(stateCtxKey{})
if v == nil {
- return zero, nil, fmt.Errorf("canvas: no state in context")
+ return nil, fmt.Errorf("canvas: no state in context")
}
- s, ok := v.(S)
+ s, ok := v.(*CanvasState)
if !ok {
- return zero, nil, fmt.Errorf("canvas: state type mismatch: have %T, want %T", v, zero)
- }
- // For *CanvasState the returned *sync.Mutex is nil on purpose:
- // CanvasState exposes its own sync.RWMutex via the exported
- // methods (GetVar / SetVar / ReadVars), all of which lock
- // internally. Callers reading *CanvasState should prefer the
- // self-locking methods over holding the mutex themselves.
- return s, nil, nil
+ return nil, fmt.Errorf("canvas: state type mismatch: have %T, want *CanvasState", v)
+ }
+ return s, nil
}
diff --git a/internal/agent/runtime/context_test.go b/internal/agent/runtime/context_test.go
index 0289c92efe..f0a4de618d 100644
--- a/internal/agent/runtime/context_test.go
+++ b/internal/agent/runtime/context_test.go
@@ -70,6 +70,23 @@ func TestAgentMessageCallbacksRunOutsideStateLocks(t *testing.T) {
assertCompletes("reset", func() { ResetAgentMessageEmission(lifecycleCtx) })
}
+func TestGetStateFromContextReturnsCanvasState(t *testing.T) {
+ state := NewCanvasState("run", "session")
+ ctx := WithState(t.Context(), state)
+
+ got, err := GetStateFromContext(ctx)
+ if err != nil {
+ t.Fatalf("GetStateFromContext: %v", err)
+ }
+ if got != state {
+ t.Fatalf("GetStateFromContext returned %p, want %p", got, state)
+ }
+
+ if _, err := GetStateFromContext(t.Context()); err == nil {
+ t.Fatal("GetStateFromContext without state returned nil error")
+ }
+}
+
func TestAgentMessageRunStateSurvivesInvocationReset(t *testing.T) {
ctx := WithAgentMessageEmitter(t.Context(), func(string, string) {})
EmitAgentMessage(ctx, "first", "")
diff --git a/internal/agent/tool/canvas_ctx.go b/internal/agent/tool/canvas_ctx.go
index 6fb4d78687..e8ae840657 100644
--- a/internal/agent/tool/canvas_ctx.go
+++ b/internal/agent/tool/canvas_ctx.go
@@ -25,7 +25,7 @@ import (
// canvasTenantID derives the tenant id from canvas state, falling back to
// user_id. Shared by agentic search and dataset-navigation tools.
func canvasTenantID(ctx context.Context) string {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return ""
}
@@ -48,7 +48,7 @@ func canvasDatasetIDs(ctx context.Context, explicit []string) []string {
}
return out
}
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return nil
}
diff --git a/internal/agent/tool/email.go b/internal/agent/tool/email.go
index ea64304762..9f0cb4c256 100644
--- a/internal/agent/tool/email.go
+++ b/internal/agent/tool/email.go
@@ -175,7 +175,7 @@ func (e *EmailTool) InvokableRun(ctx context.Context, argsJSON string, _ ...tool
return emailErrJSON(fmt.Errorf("email: parse arguments: %w", err)),
fmt.Errorf("email: parse arguments: %w", err)
}
- state, _, _ := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, _ := runtime.GetStateFromContext(ctx)
p.ToEmail = runtime.ResolveTemplateForDisplay(p.ToEmail, state)
p.CCEmail = runtime.ResolveTemplateForDisplay(p.CCEmail, state)
p.Subject = stripEmailHeaderLineBreaks(runtime.ResolveTemplateForDisplay(p.Subject, state))
diff --git a/internal/agent/tool/exesql.go b/internal/agent/tool/exesql.go
index c9f5478a7e..bf9a3bba70 100644
--- a/internal/agent/tool/exesql.go
+++ b/internal/agent/tool/exesql.go
@@ -296,7 +296,7 @@ func (e *ExeSQLTool) InvokableRun(ctx context.Context, argumentsInJSON string, _
return exesqlErrorResult(fmt.Errorf("exesql: parse arguments: %w", err)),
fmt.Errorf("exesql: parse arguments: %w", err)
}
- if state, _, stateErr := runtime.GetStateFromContext[*runtime.CanvasState](ctx); stateErr == nil && state != nil {
+ if state, stateErr := runtime.GetStateFromContext(ctx); stateErr == nil && state != nil {
resolved, resolveErr := runtime.ResolveTemplate(args.SQL, state)
if resolveErr != nil {
return exesqlErrorResult(resolveErr), resolveErr
diff --git a/internal/agent/tool/retrieval.go b/internal/agent/tool/retrieval.go
index fc9e50531a..a66830d39e 100644
--- a/internal/agent/tool/retrieval.go
+++ b/internal/agent/tool/retrieval.go
@@ -252,7 +252,7 @@ func (r *RetrievalTool) InvokableRun(ctx context.Context, argumentsInJSON string
// citation grounding call can read them. The recording is
// best-effort — when the canvas state is not
// attached (e.g. unit tests), we skip silently.
- if state, _, sErr := runtime.GetStateFromContext[*runtime.CanvasState](ctx); sErr == nil && state != nil && len(chunks) > 0 && args.RetrievalFrom == "dataset" {
+ if state, sErr := runtime.GetStateFromContext(ctx); sErr == nil && state != nil && len(chunks) > 0 && args.RetrievalFrom == "dataset" {
state.SetRetrievalReferences(referenceChunksFromRetrieval(chunks), referenceDocAggsFromRetrieval(chunks))
}
result, err := stubJSONWithErr(out)
@@ -328,7 +328,7 @@ func cloneStringAnyMap(src map[string]any) map[string]any {
}
func resolveRetrievalQuery(ctx context.Context, query string) (string, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return query, nil
}
@@ -362,7 +362,7 @@ func resolveRetrievalUserID(ctx context.Context, userID string) (string, error)
if trimmed == "" {
return "", nil
}
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return trimmed, nil
}
@@ -388,7 +388,7 @@ func resolveRetrievalUserID(ctx context.Context, userID string) (string, error)
}
func resolveRetrievalDatasetIDs(ctx context.Context, datasetIDs []string) ([]string, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return compactStrings(datasetIDs), nil
}
@@ -429,7 +429,7 @@ func resolveRetrievalFilter(ctx context.Context, filter map[string]any) (map[str
if filter == nil {
return nil, nil
}
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return cloneStringAnyMap(filter), nil
}
@@ -501,7 +501,7 @@ func renderMemoryChunks(chunks []RetrievalChunk) string {
}
func retrievalTenantID(ctx context.Context) string {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return ""
}
diff --git a/internal/handler/agent_component_test.go b/internal/handler/agent_component_test.go
index d9dc21ee0f..3755d30b17 100644
--- a/internal/handler/agent_component_test.go
+++ b/internal/handler/agent_component_test.go
@@ -331,7 +331,7 @@ func TestDebugComponent_HappyPath_Begin(t *testing.T) {
type sysEchoComponent struct{}
func (s *sysEchoComponent) Invoke(ctx context.Context, _ *gorm.DB, _ map[string]any) (map[string]any, error) {
- state, _, err := agentruntime.GetStateFromContext[*agentruntime.CanvasState](ctx)
+ state, err := agentruntime.GetStateFromContext(ctx)
if err != nil {
return nil, err
}
diff --git a/internal/ingestion/component/extractor.go b/internal/ingestion/component/extractor.go
index d0e5a6af6a..771318474c 100644
--- a/internal/ingestion/component/extractor.go
+++ b/internal/ingestion/component/extractor.go
@@ -1421,7 +1421,7 @@ type extractorChatConfig struct {
// Returns nil error when there is no canvas state (unit tests) —
// the caller's @ split fallback handles that case.
func resolveExtractorChatConfig(ctx context.Context, db *gorm.DB, compositeLLMID string) (extractorChatConfig, error) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return extractorChatConfig{}, nil
}
@@ -1473,7 +1473,7 @@ func resolveExtractorChatConfig(ctx context.Context, db *gorm.DB, compositeLLMID
// model when no explicit llm_id is provided. Returns empty config when
// no canvas state or tenant_id is available (unit-test context).
func resolveExtractorChatDefaultConfig(ctx context.Context, db *gorm.DB) extractorChatConfig {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return extractorChatConfig{}
}
@@ -1561,7 +1561,7 @@ func extractorContextLength(ctx context.Context, db *gorm.DB, llmID string) int
if db == nil {
db = dao.DB
}
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return 0
}
diff --git a/internal/ingestion/component/globals/globals.go b/internal/ingestion/component/globals/globals.go
index 9b64fb6e63..d267b033fc 100644
--- a/internal/ingestion/component/globals/globals.go
+++ b/internal/ingestion/component/globals/globals.go
@@ -34,7 +34,7 @@ import (
// pipeline (canvas.WithState). Returns nil when no state is present (e.g.
// headless unit tests that don't attach a CanvasState).
func canvasStateFromContext(ctx context.Context) *runtime.CanvasState {
- st, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ st, err := runtime.GetStateFromContext(ctx)
if err != nil {
return nil
}
diff --git a/internal/rag/agentic-rag/runtime/tool_executor.go b/internal/rag/agentic-rag/runtime/tool_executor.go
index 725f1fe847..64c4110bc1 100644
--- a/internal/rag/agentic-rag/runtime/tool_executor.go
+++ b/internal/rag/agentic-rag/runtime/tool_executor.go
@@ -1983,7 +1983,7 @@ func passageFromChunk(c map[string]any) map[string]any {
// caller sits in the parent agentic_rag package (agentic_rag.go), not
// inside retrieval.
func PublishReferences(ctx context.Context, kb *Kbinfos) {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return
}
@@ -2096,7 +2096,7 @@ func chunksToMaps(chunks []runtime.RetrievalChunk) []map[string]any {
// what CanvasState.GetVar exposes. Exported so the agentic_rag package's Run can call
// it.
func TenantIDFromContext(ctx context.Context) string {
- state, _, err := runtime.GetStateFromContext[*runtime.CanvasState](ctx)
+ state, err := runtime.GetStateFromContext(ctx)
if err != nil || state == nil {
return ""
}