Vihren Atlas

go.temporal.io/server/chasm/ms_pointer.go

63 LOC · 17 covered · 46 uncovered · 5 ranges · 275 concepts · 4 introducers · 153 tests

File neighbourhood

The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.

Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.

Graph controls are ready.

Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.

Files sharing a concept 8

A concept that introduces code in this file also introduces code in these files.

Files with a broader (ancestor) concept 13

These files introduce code for a direct ancestor — a broader, larger-extent concept — of a concept that introduces code here.

Files with a narrower (descendant) concept 12

These files introduce code for a direct descendant — a narrower, larger-intent concept — of a concept that introduces code here.

1 package chasm
2
3 import (
4 "time"
5
6 enumspb "go.temporal.io/api/enums/v1"
7 historypb "go.temporal.io/api/history/v1"
8 "go.temporal.io/server/common/nexus/nexusrpc"
9 )
10
11 // MSPointer is a special CHASM type which components can use to access their Node's underlying backend (i.e. mutable
12 // state). It is used to expose methods needed from the mutable state without polluting the chasm.Context interface.
13 // When deserializing components with fields of this type, the CHASM engine will set the value to its NodeBackend.
14 // This should only be used by the Workflow component.
15 type MSPointer struct {
16 backend NodeBackend
17 }
18
19 // NewMSPointer creates a new MSPointer instance.
20 > func NewMSPointer(backend NodeBackend) MSPointer { ms_pointer.go ×1
21 > return MSPointer{
22 > backend: backend,
23 > }
24 > }
25
26 // WorkflowRunTimeout returns the workflow run timeout duration. Returns 0 if no timeout is set.
27 > func (m MSPointer) WorkflowRunTimeout() time.Duration { nexus_commands.go ×5
28 > return m.backend.GetExecutionInfo().GetWorkflowRunTimeout().AsDuration()
29 > }
30
31 // AddHistoryEvent adds a history event via the underlying mutable state.
32 > func (m MSPointer) AddHistoryEvent(t enumspb.EventType, setAttributes func(*historypb.HistoryEvent)) *historypb.HistoryEvent { nexus_commands.go ×5
33 > return m.backend.AddHistoryEvent(t, setAttributes)
34 > }
35
36 // HasAnyBufferedEvent returns true if there is at least one buffered event that matches the provided filter.
37 > func (m MSPointer) HasAnyBufferedEvent(filter func(*historypb.HistoryEvent) bool) bool { nexus_commands.go ×2
38 > return m.backend.HasAnyBufferedEvent(filter)
39 > }
40
41 > func (m MSPointer) GenerateEventLoadToken(event *historypb.HistoryEvent) ([]byte, error) { nexus_events.go ×4
42 > return m.backend.GenerateEventLoadToken(event)
43 > }
44
45 // LoadHistoryEvent loads a history event from the underlying mutable state using the given token.
46 func (m MSPointer) LoadHistoryEvent(ctx Context, token []byte) (*historypb.HistoryEvent, error) {
47 return m.backend.LoadHistoryEvent(ctx.goContext(), token)
48 }
49
50 // GetNexusCompletion retrieves the Nexus operation completion data for the given request ID from the underlying mutable state.
51 func (m MSPointer) GetNexusCompletion(ctx Context, requestID string) (nexusrpc.CompleteOperationOptions, error) {
52 return m.backend.GetNexusCompletion(ctx.goContext(), requestID)
53 }
54
55 // GetWorkflowTypeName retrieves the workflow type name from the underlying mutable state.
56 func (m MSPointer) GetWorkflowTypeName() string {
57 return m.backend.GetExecutionInfo().GetWorkflowTypeName()
58 }
59
60 // GetNexusUpdateCompletion retrieves the Nexus operation completion data for the given update ID and request ID from the underlying mutable state.
61 func (m MSPointer) GetNexusUpdateCompletion(ctx Context, updateID string, requestID string) (nexusrpc.CompleteOperationOptions, error) {
62 return m.backend.GetNexusUpdateCompletion(ctx.goContext(), updateID, requestID)
63 }