jschoubben
7359d187db
mesh/delivery merged: source.main moved to novox/mesh-sdk@47eb1009921d
mesh/delivery-group group fix/1126-switch-safe merged: every member is merged
mesh/check pass 7359d187db8d on 47b1dcf08f85 | unit 2992 run, 1008 kept, 36 skipped | integration 3025 run, 1102 kept, 29 skipped | over bound: unit (…
324 lines
12 KiB
Go
324 lines
12 KiB
Go
package compose
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"slices"
|
|
"sort"
|
|
"strings"
|
|
|
|
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
|
"git.novox.be/novox/mesh-sdk/go/declaration"
|
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
|
"git.novox.be/novox/mesh-sdk/go/overlay"
|
|
)
|
|
|
|
// Compositions is one node's compositions (novox/hq ADR 0539 clauses 1 and 2): its declaration composed over in, as
|
|
// the controller composes it, split into each module's composition at the fingerprint fps gives it and the node's own
|
|
// (`<node>.node`), by key (delivery.ComposedKey). Each resource says its module, whatever the node reported it reads.
|
|
// A module fps gives no fingerprint for is not composed and is named in skipped, so a caller composing one module
|
|
// (mesh-hand-compose) gets that one; but for a module the node runs inside its own composition (Node.InOwn, and the
|
|
// private network's always), which fps names at no fingerprint of the new form: its resources go into the node's own,
|
|
// their module taken off and their ids still naming it, and its filled paths with them, as the controller's composed
|
|
// writer folds them (issue 1126). Each module's Data says whether its manifest declares data. The compositions are not
|
|
// signed and not yet by digest: the writer does both (delivery.SignComposed, Composed.ByDigest).
|
|
func Compositions(in Input, node string, fps map[string]string, mode Mode) (out map[string]delivery.Composed, skipped []string, err error) {
|
|
out, skipped, _, err = compositions(in, node, fps, mode, false)
|
|
return out, skipped, err
|
|
}
|
|
|
|
// ErrStoodIn is a composition that holds a stand-in for a value the input does not carry (an own secret, a grant's
|
|
// sealed copy, a vault box, the certificate, the bus's user list) or a port it does not give: what a send would make,
|
|
// never what may be applied.
|
|
var ErrStoodIn = errors.New("compose: the composition stands in for what its input does not carry")
|
|
|
|
// BusUsersStandIn is what a composition says it stood in for when its input carries no bus user list.
|
|
const BusUsersStandIn = "the bus's user list"
|
|
|
|
// CompositionsApplied is Compositions for a node that applies what it composed itself (novox/hq ADR 0547 §2, issue
|
|
// 1126): a declaration that stands in for anything (Declared.StoodIn, Foreseen, ForeseenPorts) is refused with
|
|
// ErrStoodIn, naming each, so a stand-in is never applied as if it were the value; but for the bus's user list
|
|
// (BusUsersStandIn), which the bus node holds out of every apply of a composition it made itself.
|
|
func CompositionsApplied(in Input, node string, fps map[string]string) (map[string]delivery.Composed, []string, error) {
|
|
out, skipped, _, err := compositions(in, node, fps, Reading, true)
|
|
return out, skipped, err
|
|
}
|
|
|
|
// CompositionsShadow is CompositionsApplied for a composition that is compared and never applied (a node's answer to a
|
|
// placement candidate, novox/hq ADR 0559 §4): composed in the Foreseeing mode, so an own secret never issued (a module
|
|
// the candidate adds) is a named stand-in rather than an error, and what it stands in for is answered (stood, sorted,
|
|
// the bus's user list left out) rather than refused, so the caller judges each stand-in: a value not yet issued for a
|
|
// module the candidate adds, or one missing for a module the node runs. A module whose every value is held composes
|
|
// as CompositionsApplied composes it: the modes differ only in an own secret never issued.
|
|
func CompositionsShadow(in Input, node string, fps map[string]string) (out map[string]delivery.Composed, skipped, stood []string, err error) {
|
|
return compositions(in, node, fps, Foreseeing, false)
|
|
}
|
|
|
|
func compositions(in Input, node string, fps map[string]string, mode Mode, applied bool) (out map[string]delivery.Composed, skipped, stood []string, err error) {
|
|
reading := in
|
|
reading.Nodes = append([]Node(nil), in.Nodes...)
|
|
found := false
|
|
inOwn := map[string]bool{}
|
|
for i := range reading.Nodes {
|
|
if reading.Nodes[i].Name == node {
|
|
reading.Nodes[i].ReadsModules = true
|
|
found = true
|
|
for m, ok := range reading.Nodes[i].InOwn {
|
|
inOwn[m] = ok
|
|
}
|
|
}
|
|
}
|
|
// The private network's module is built by nobody: no fingerprint of the new form ever names it.
|
|
inOwn[overlay.Name] = true
|
|
folds := func(module string) bool {
|
|
return module != "" && inOwn[module] && !strings.HasPrefix(fps[module], delivery.SourcePrefix2)
|
|
}
|
|
if !found {
|
|
return nil, nil, nil, fmt.Errorf("compose: the mesh has no node %q", node)
|
|
}
|
|
// A folded module built by a build of the old form (Node.RunsOwn) is left to the node: composed as a stub, so what
|
|
// it provides and requires still shapes the rest, and its resources are then the ones the node runs.
|
|
carried := map[string]bool{}
|
|
var runsOwn *delivery.Composed
|
|
for i := range reading.Nodes {
|
|
n := &reading.Nodes[i]
|
|
if n.Name != node || n.RunsOwn == nil {
|
|
continue
|
|
}
|
|
runsOwn = n.RunsOwn
|
|
for m := range inOwn {
|
|
if !folds(m) {
|
|
continue
|
|
}
|
|
man, ok := n.Kept[m]
|
|
if !ok {
|
|
man, ok = reading.Catalogue[m]
|
|
}
|
|
if !ok || !NamesBuild(man) {
|
|
continue
|
|
}
|
|
carried[m] = true
|
|
kept := make(map[string]catalogue.Manifest, len(n.Kept)+1)
|
|
for k, v := range n.Kept {
|
|
kept[k] = v
|
|
}
|
|
kept[m] = Stub(man)
|
|
n.Kept = kept
|
|
}
|
|
}
|
|
isCarried := func(module, id string) bool {
|
|
if module == "" {
|
|
module, _ = declaration.ModuleGuess(id)
|
|
}
|
|
return carried[module]
|
|
}
|
|
d, problems, err := ComposeIn(reading, node, mode)
|
|
if err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
if len(problems) > 0 {
|
|
return nil, nil, nil, fmt.Errorf("compose: %s's declaration is refused by the node-engine's validator: %v", node, problems)
|
|
}
|
|
for _, x := range d.StoodIn {
|
|
// The bus's user list is the bus node's own to follow, written alone and never from a composition the node
|
|
// made itself (ADR 0547 §7, §8): its stand-in is held out of the apply, not applied.
|
|
if x != BusUsersStandIn {
|
|
stood = append(stood, x)
|
|
}
|
|
}
|
|
stood = append(stood, d.Foreseen...)
|
|
for _, p := range d.ForeseenPorts {
|
|
stood = append(stood, "port "+p)
|
|
}
|
|
sort.Strings(stood)
|
|
stood = slices.Compact(stood) // an own secret is both stood in for and foreseen
|
|
if applied && len(stood) > 0 {
|
|
return nil, nil, nil, fmt.Errorf("%w on %s: %s", ErrStoodIn, node, strings.Join(stood, ", "))
|
|
}
|
|
body, err := d.Body()
|
|
if err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
var envelope struct {
|
|
Resources []json.RawMessage `json:"resources"`
|
|
Adoption *declaration.Adoption `json:"adoption"`
|
|
Filled []string `json:"filled_files"`
|
|
Provisioner string `json:"provisioner_account"`
|
|
}
|
|
if err := json.Unmarshal(body, &envelope); err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
var kept []json.RawMessage
|
|
keptPaths := map[string]bool{}
|
|
foldedPaths := map[string]bool{}
|
|
left := map[string]bool{}
|
|
for _, raw := range envelope.Resources {
|
|
var head struct {
|
|
ID string `json:"id"`
|
|
Module string `json:"module"`
|
|
Type string `json:"type"`
|
|
Path string `json:"path"`
|
|
}
|
|
if err := json.Unmarshal(raw, &head); err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
if isCarried(head.Module, head.ID) {
|
|
continue // what the stub composed of it: the node's own carries what runs of it instead
|
|
}
|
|
if folds(head.Module) {
|
|
// Into the node's own, in its place among the node's resources, its module taken off (mesh-controller's
|
|
// compositionsOf): the node's own composition is then the controller's, byte for byte.
|
|
var fields map[string]json.RawMessage
|
|
if err := json.Unmarshal(raw, &fields); err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
delete(fields, "module")
|
|
if raw, err = json.Marshal(fields); err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
if head.Type == string(declaration.TypeFile) {
|
|
foldedPaths[head.Path] = true
|
|
}
|
|
kept = append(kept, raw)
|
|
continue
|
|
}
|
|
if _, ok := fps[head.Module]; head.Module != "" && !ok {
|
|
left[head.Module] = true
|
|
continue
|
|
}
|
|
if head.Type == string(declaration.TypeFile) {
|
|
keptPaths[head.Path] = true
|
|
}
|
|
kept = append(kept, raw)
|
|
}
|
|
// What runs of each carried module, in the node's own composition, each after the resource it runs after.
|
|
if len(carried) > 0 {
|
|
var err error
|
|
if kept, foldedPaths, err = carry(kept, foldedPaths, runsOwn, isCarried); err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
for _, p := range runsOwn.Filled {
|
|
if foldedPaths[p] && !slices.Contains(envelope.Filled, p) {
|
|
envelope.Filled = append(envelope.Filled, p)
|
|
}
|
|
}
|
|
}
|
|
// A filled file of a module's own composition goes with that module (SplitComposed); one of a folded module goes with
|
|
// the node's own, after them, in the declaration's order; one of a module left out is dropped.
|
|
var filled, ownFilled []string
|
|
for _, p := range envelope.Filled {
|
|
switch {
|
|
case foldedPaths[p]:
|
|
ownFilled = append(ownFilled, p)
|
|
case keptPaths[p]:
|
|
filled = append(filled, p)
|
|
}
|
|
}
|
|
out, err = delivery.SplitComposed(node, kept, fps, filled,
|
|
delivery.NodeOwn{Adoption: envelope.Adoption, Provisioner: envelope.Provisioner})
|
|
if err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
if len(ownFilled) > 0 {
|
|
own, err := delivery.ComposedNodeKey(node)
|
|
if err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
c := out[own]
|
|
c.Filled = append(c.Filled, ownFilled...)
|
|
out[own] = c
|
|
}
|
|
for key, c := range out {
|
|
if m, ok := in.Catalogue[c.Module]; ok && c.Module != "" {
|
|
c.Data = len(m.DataItems()) > 0
|
|
out[key] = c
|
|
}
|
|
}
|
|
for m := range left {
|
|
skipped = append(skipped, m)
|
|
}
|
|
sort.Strings(skipped)
|
|
return out, skipped, stood, nil
|
|
}
|
|
|
|
// NamesBuild says a manifest names what a build makes: its build, or a resource naming an artifact. A node cannot
|
|
// compose such a module folded into its own composition: the build of the old form it runs is held by the controller
|
|
// alone (issue 1126).
|
|
func NamesBuild(m catalogue.Manifest) bool {
|
|
if m.Build != nil {
|
|
return true
|
|
}
|
|
for _, r := range m.Resources {
|
|
if _, ok := r["artifact"]; ok {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Stub is m with nothing to build and no resource but its directories: what it provides, requires, serves and grants
|
|
// still shape the rest of the composition, the places its own secrets, data and grants name (${dir:…}) still resolve,
|
|
// and nothing else of its own is composed (issue 1126: nats's ${dir:mesh-state} on novox).
|
|
func Stub(m catalogue.Manifest) catalogue.Manifest {
|
|
m.Build = nil
|
|
var dirs []map[string]any
|
|
for _, r := range m.Resources {
|
|
if r["type"] == "directory" {
|
|
dirs = append(dirs, r)
|
|
}
|
|
}
|
|
m.Resources = dirs
|
|
return m
|
|
}
|
|
|
|
// carry puts into the node's resources (kept, in the declaration's order) the resources of the node's own composition as
|
|
// it runs (runs) that belong to a carried module, each after the resource it runs after, or first when that one is
|
|
// not among them; a file among them is a folded path.
|
|
func carry(kept []json.RawMessage, foldedPaths map[string]bool, runs *delivery.Composed, carried func(module, id string) bool) ([]json.RawMessage, map[string]bool, error) {
|
|
idOf := func(raw json.RawMessage) (string, string, string, string, error) {
|
|
var head struct {
|
|
ID string `json:"id"`
|
|
Module string `json:"module"`
|
|
Type string `json:"type"`
|
|
Path string `json:"path"`
|
|
}
|
|
err := json.Unmarshal(raw, &head)
|
|
return head.ID, head.Module, head.Type, head.Path, err
|
|
}
|
|
present := map[string]bool{}
|
|
for _, raw := range kept {
|
|
if id, module, _, _, err := idOf(raw); err == nil && module == "" {
|
|
present[id] = true
|
|
}
|
|
}
|
|
// By the id of the resource of the node's own it runs after, "" for first: the last one before it that is composed.
|
|
after := map[string][]json.RawMessage{}
|
|
anchor := ""
|
|
for _, raw := range runs.Resources {
|
|
id, module, typ, path, err := idOf(raw)
|
|
if err != nil {
|
|
return nil, nil, fmt.Errorf("compose: a resource the node runs in its own composition: %w", err)
|
|
}
|
|
if !carried(module, id) {
|
|
if module == "" && present[id] {
|
|
anchor = id
|
|
}
|
|
continue
|
|
}
|
|
after[anchor] = append(after[anchor], raw)
|
|
if typ == string(declaration.TypeFile) {
|
|
foldedPaths[path] = true
|
|
}
|
|
}
|
|
out := make([]json.RawMessage, 0, len(kept)+len(runs.Resources))
|
|
out = append(out, after[""]...)
|
|
for _, raw := range kept {
|
|
out = append(out, raw)
|
|
if id, module, _, _, err := idOf(raw); err == nil && module == "" {
|
|
out = append(out, after[id]...)
|
|
}
|
|
}
|
|
return out, foldedPaths, nil
|
|
}
|