-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathprogram_effects.go
More file actions
188 lines (181 loc) · 7.74 KB
/
Copy pathprogram_effects.go
File metadata and controls
188 lines (181 loc) · 7.74 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
package boatstack
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"github.com/operatorstack/boatstack/boatstack/delivery"
"github.com/operatorstack/boatstack/boatstack/internal/softwaredelivery/catalog"
"github.com/operatorstack/boatstack/boatstack/internal/softwaredelivery/effects"
"github.com/operatorstack/boatstack/boatstack/internal/softwaredelivery/ports"
"github.com/operatorstack/boatstack/boatstack/internal/softwaredelivery/protocol"
)
type programEffectDriver struct {
base ports.EffectDriver
program delivery.ControlProgram
resolver ports.InvocationResolver
clock ports.Clock
}
func (d programEffectDriver) Prepare(ctx context.Context, admission protocol.Admission, transition catalog.Transition) (ports.PreparedEffect, error) {
if err := protocol.ValidateEffectCapabilities(admission, transition); err != nil {
return nil, err
}
if transition.RuntimeExecution {
if err := protocol.RequireCapability(admission.EffectiveCapabilities, catalog.CapabilityCommandExecute, "component runtime "+transition.Origin.ID); err != nil {
return nil, err
}
}
if transition.Origin.Kind == catalog.OriginCoreSystem {
return d.base.Prepare(ctx, admission, transition)
}
if transition.Origin.Kind == catalog.OriginControlProgram {
flow := d.program.ProgramRuntime()
if flow.Manifest.RuntimeMode == delivery.ProgramRuntimeNative {
return d.base.Prepare(ctx, admission, transition)
}
if flow.Runtime == nil {
return nil, fmt.Errorf("control-program runtime %q is unavailable", flow.Identity.ID)
}
parameters, err := json.Marshal(admission.Parameters)
if err != nil {
return nil, err
}
request := delivery.ProgramRuntimeRequest{
ProtocolVersion: delivery.ProgramRuntimeProtocolVersion, ProgramID: flow.Identity.ID, ProgramVersion: flow.Identity.Version,
ProgramFingerprint: admission.ExpectedProgramFingerprint, CorrelationID: admission.Invocation.Correlation,
RepositoryRoot: admission.Invocation.InvokingPath, TransitionID: transition.ID, Parameters: parameters, Settings: flow.Manifest.Settings,
Capabilities: append([]delivery.Capability(nil), admission.EffectiveCapabilities...),
}
if transition.Class == catalog.EventOwnedExternal {
prepared, err := effects.NewExtensionExternalPrepared(func(executionContext context.Context) (ports.EffectResult, error) {
request.Operation = delivery.ProgramExecuteExternalOperation
response, invokeErr := flow.Runtime.InvokeProgram(executionContext, request)
if invokeErr != nil {
return ports.EffectResult{}, invokeErr
}
if err := validateProgramRuntimeResponse(flow, request.Operation, request.CorrelationID, response); err != nil {
return ports.EffectResult{}, err
}
return decodeExtensionSettlement(flow.Identity.ID, response.ExternalResult)
}, admission, transition)
if err != nil {
return nil, err
}
return effects.BindStateRevision(ctx, prepared, d.resolver, d.clock, admission, transition)
}
operation := delivery.ProgramPlanLocalEffectOperation
if transition.Class == catalog.EventRecovery {
operation = delivery.ProgramRecoverOperation
}
request.Operation = operation
response, invokeErr := flow.Runtime.InvokeProgram(ctx, request)
if invokeErr != nil {
return nil, invokeErr
}
if err := validateProgramRuntimeResponse(flow, operation, admission.Invocation.Correlation, response); err != nil {
return nil, err
}
if err := validateProgramWrites(d.program, transition, flow.Identity.ID, response.Writes); err != nil {
return nil, err
}
prepared, err := effects.NewFlowLocalPrepared(admission.Invocation.InvokingPath, flow.Identity.ID, response.Writes, admission, transition)
if err != nil {
return nil, err
}
return effects.BindStateRevision(ctx, prepared, d.resolver, d.clock, admission, transition)
}
extension, ok := d.program.ExtensionByID(transition.Origin.ID)
if !ok || extension.Runtime == nil {
return nil, fmt.Errorf("extension runtime %q is unavailable", transition.Origin.ID)
}
parameters, err := json.Marshal(admission.Parameters)
if err != nil {
return nil, err
}
baseRequest := delivery.ExtensionRequest{
ProtocolVersion: delivery.ExtensionProtocolVersion, ExtensionID: extension.Identity.ID, ExtensionVersion: extension.Identity.Version,
ProgramFingerprint: admission.ExpectedProgramFingerprint, CorrelationID: admission.Invocation.Correlation,
RepositoryRoot: admission.Invocation.InvokingPath, TransitionID: transition.ID, Parameters: parameters, Settings: extension.Manifest.Settings,
Capabilities: append([]delivery.Capability(nil), admission.EffectiveCapabilities...),
}
if transition.Class == catalog.EventOwnedExternal {
prepared, err := effects.NewExtensionExternalPrepared(func(executionContext context.Context) (ports.EffectResult, error) {
request := baseRequest
request.Operation = delivery.ExtensionExecuteExternalOperation
response, invokeErr := extension.Runtime.Invoke(executionContext, request)
if invokeErr != nil {
return ports.EffectResult{}, invokeErr
}
if err := validateExtensionResponse(extension, request.Operation, request.CorrelationID, response); err != nil {
return ports.EffectResult{}, err
}
return decodeExtensionSettlement(extension.Identity.ID, response.ExternalResult)
}, admission, transition)
if err != nil {
return nil, err
}
return effects.BindStateRevision(ctx, prepared, d.resolver, d.clock, admission, transition)
}
operation := delivery.ExtensionPlanLocalEffectOperation
if transition.Class == catalog.EventRecovery {
operation = delivery.ExtensionRecoverOperation
}
baseRequest.Operation = operation
response, err := extension.Runtime.Invoke(ctx, baseRequest)
if err != nil {
return nil, err
}
if err := validateExtensionResponse(extension, operation, admission.Invocation.Correlation, response); err != nil {
return nil, err
}
if err := validateProgramWrites(d.program, transition, extension.Identity.ID, response.Writes); err != nil {
return nil, err
}
prepared, err := effects.NewExtensionLocalPrepared(admission.Invocation.InvokingPath, extension.Identity.ID, response.Writes, admission, transition)
if err != nil {
return nil, err
}
return effects.BindStateRevision(ctx, prepared, d.resolver, d.clock, admission, transition)
}
func validateProgramWrites(program delivery.ControlProgram, transition catalog.Transition, owner string, writes []delivery.ResourceWrite) error {
allowed := map[string]bool{}
for _, resource := range transition.OwnedResources {
allowed[resource] = true
}
ownership := program.ResourceOwnership()
for _, write := range writes {
if !allowed[write.Resource] || ownership[write.Resource] != owner {
return fmt.Errorf("transition %q planned undeclared resource %q", transition.ID, write.Resource)
}
}
return nil
}
func decodeExtensionSettlement(owner string, raw []byte) (ports.EffectResult, error) {
var result struct {
Settlement ports.EffectSettlement `json:"settlement"`
Detail string `json:"detail,omitempty"`
}
if err := decodeStrictExtensionJSON(raw, &result); err != nil {
return ports.EffectResult{}, fmt.Errorf("component %q returned invalid external settlement", owner)
}
if result.Settlement != ports.EffectSettled && result.Settlement != ports.EffectUnknown {
return ports.EffectResult{}, fmt.Errorf("component %q returned invalid external settlement", owner)
}
return ports.EffectResult{Settlement: result.Settlement, Detail: result.Detail}, nil
}
func decodeStrictExtensionJSON(raw []byte, target any) error {
if len(raw) == 0 {
return fmt.Errorf("empty JSON")
}
decoder := json.NewDecoder(bytes.NewReader(raw))
decoder.DisallowUnknownFields()
if err := decoder.Decode(target); err != nil {
return err
}
var trailing any
if err := decoder.Decode(&trailing); err != io.EOF {
return fmt.Errorf("trailing JSON")
}
return nil
}