mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-06-29 23:41:12 +08:00
74 lines
2.9 KiB
Go
74 lines
2.9 KiB
Go
|
//
|
||
|
|
// Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
|
||
|
|
//
|
||
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
// you may not use this file except in compliance with the License.
|
||
|
|
// You may obtain a copy of the License at
|
||
|
|
//
|
||
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
//
|
||
|
|
// Unless required by applicable law or agreed to in writing, software
|
||
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
// See the License for the specific language governing permissions and
|
||
|
|
// limitations under the License.
|
||
|
|
//
|
||
|
|
|
||
|
|
// runtime — context-attached canvas state for cross-package access.
|
||
|
|
//
|
||
|
|
// The compile entry (canvas/compile.go) attaches *CanvasState to ctx
|
||
|
|
// once per run via WithState. Component bodies retrieve it via
|
||
|
|
// GetStateFromContext. eino's internal state plumbing also threads
|
||
|
|
// the state via WithGenLocalState; this context-key path is the
|
||
|
|
// fallback used by code that does not run as an eino handler (e.g.
|
||
|
|
// loop condition closures, ad-hoc tests, and the placeholder
|
||
|
|
// component bodies that BuildWorkflow installs).
|
||
|
|
package runtime
|
||
|
|
|
||
|
|
import (
|
||
|
|
"context"
|
||
|
|
"fmt"
|
||
|
|
"sync"
|
||
|
|
)
|
||
|
|
|
||
|
|
// stateCtxKey is the unexported context key used by WithState /
|
||
|
|
// GetStateFromContext. Defined at package scope so its identity is
|
||
|
|
// stable across calls (a fresh struct{}{} per call would key
|
||
|
|
// distinctly and break ctx.Value lookups).
|
||
|
|
type stateCtxKey struct{}
|
||
|
|
|
||
|
|
// WithState attaches *CanvasState to ctx for retrieval by
|
||
|
|
// GetStateFromContext. Production code (canvas/compile.go) calls this
|
||
|
|
// once per run; cross-package tests call it directly to set up state
|
||
|
|
// before invoking a component.
|
||
|
|
func WithState(ctx context.Context, s *CanvasState) context.Context {
|
||
|
|
return context.WithValue(ctx, stateCtxKey{}, s)
|
||
|
|
}
|
||
|
|
|
||
|
|
// 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
|
||
|
|
v := ctx.Value(stateCtxKey{})
|
||
|
|
if v == nil {
|
||
|
|
return zero, nil, fmt.Errorf("canvas: no state in context")
|
||
|
|
}
|
||
|
|
s, ok := v.(S)
|
||
|
|
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
|
||
|
|
}
|