1 Commits
10 changed files with 19 additions and 213 deletions
+2 -85
View File
@@ -10,7 +10,6 @@ import (
"errors"
"fmt"
"regexp"
"strconv"
"strings"
"time"
@@ -58,7 +57,7 @@ var ErrUnknownVersion = errors.New("node-engine: unknown compose-candidate answe
var nameOK = regexp.MustCompile(`^[-/_=a-zA-Z0-9]+$`)
func checkAsk(a seat.ComposeCandidateInput) error {
if _, err := ParseCandidateKey(a.Candidate); err != nil {
if _, _, err := ParseCompositionKey(a.Candidate); err != nil {
return fmt.Errorf("node-engine: a compose-candidate ask names no candidate: %w", err)
}
return nil
@@ -91,7 +90,7 @@ func CheckAnswer(a seat.ComposeCandidateAnswer) error {
if a.Node == "" || !nameOK.MatchString(a.Node) {
return fmt.Errorf("node-engine: the answer's node name %q is empty or holds a dot, a wildcard, whitespace or a character a key refuses", a.Node)
}
if _, err := ParseCandidateKey(a.Candidate); err != nil {
if _, _, err := ParseCompositionKey(a.Candidate); err != nil {
return err
}
if a.Took < 0 {
@@ -217,85 +216,3 @@ func ParseCompositionKey(key string) (group, headsHash string, err error) {
}
return group, headsHash, nil
}
// The three forms of the key `compose-candidate` takes (ADR 0593 §7; design 47 G A-226, A-226b): a check's candidate
// `<group>.<heads hash>` (CompositionKey), a branch pipeline's catalog graph revision `<branch>.<revision>` (RevisionKey)
// and a run on request's `run-<id>` (RunKey). Every caller builds its key with the builders and the node-engine reads it with
// ParseCandidateKey, so no caller writes a key by hand.
// The kinds of candidate a key names.
const (
CandidateCheck = "check"
CandidateRevision = "revision"
CandidateRun = "run"
)
const runKeyPrefix = "run-"
// maxRevision keeps a revision number from reading as a 12-digit heads hash: 12 decimal digits are 12 lowercase hex digits.
const maxRevision = 99999999999
// Candidate is what a key names: Kind says which of the others are set.
type Candidate struct {
Kind string
// Group and HeadsHash of a check's candidate.
Group, HeadsHash string
// Branch and Revision of a branch pipeline's catalog graph revision.
Branch string
Revision int64
// Run is a run on request's id.
Run string
}
// RevisionKey is the key of a branch's catalog graph revision: `<escaped branch>.<revision>`, the branch escaped as a key
// part as the pipeline key escapes it, the revision a positive number of at most 11 digits.
func RevisionKey(branch string, revision int64) (string, error) {
if branch == "" {
return "", errors.New("node-engine: the branch name is empty")
}
if revision <= 0 || revision > maxRevision {
return "", fmt.Errorf("node-engine: %d is not a catalog graph revision, a positive number of at most 11 digits", revision)
}
return keys.EscapeName(branch) + "." + strconv.FormatInt(revision, 10), nil
}
// RunKey is the key of a run on request's candidate: `run-<id>`, the id one key part with no dot.
func RunKey(run string) (string, error) {
if run == "" || strings.ContainsAny(run, ". \t\n") {
return "", fmt.Errorf("node-engine: %q is no run's id: it is empty or holds a dot or whitespace", run)
}
return runKeyPrefix + run, nil
}
// ParseCandidateKey is the inverse of the three builders; it refuses a key that is none of them, naming it. A key with a
// dot whose last part is 12 lowercase hex digits is a check's (a revision number has at most 11 digits), one with a dot and a
// number is a revision's, and `run-<id>` with no dot is a run's.
func ParseCandidateKey(key string) (Candidate, error) {
if !strings.Contains(key, ".") {
if run, ok := strings.CutPrefix(key, runKeyPrefix); ok && run != "" && !strings.ContainsAny(run, " \t\n") {
return Candidate{Kind: CandidateRun, Run: run}, nil
}
return Candidate{}, fmt.Errorf("node-engine: %q is not a candidate key, <group>.<heads hash>, <branch>.<revision> or run-<id>", key)
}
i := strings.LastIndex(key, ".")
if heads12.MatchString(key[i+1:]) {
group, headsHash, err := ParseCompositionKey(key)
if err != nil {
return Candidate{}, err
}
return Candidate{Kind: CandidateCheck, Group: group, HeadsHash: headsHash}, nil
}
part, number := key[:i], key[i+1:]
revision, err := strconv.ParseInt(number, 10, 64)
if err != nil || revision <= 0 || revision > maxRevision || strconv.FormatInt(revision, 10) != number {
return Candidate{}, fmt.Errorf("node-engine: %q is not a candidate key: %q is neither a heads hash, 12 lowercase hex digits, nor a revision number", key, number)
}
if part == "" || strings.Contains(part, ".") {
return Candidate{}, fmt.Errorf("node-engine: %q is not a candidate key: the branch part is empty or holds a dot", key)
}
branch, err := keys.UnescapeName(part)
if err != nil {
return Candidate{}, fmt.Errorf("node-engine: %q is not a candidate key: %w", key, err)
}
return Candidate{Kind: CandidateRevision, Branch: branch, Revision: revision}, nil
}
@@ -113,68 +113,3 @@ func TestCompositionKeyRoundTripsAndRefuses(t *testing.T) {
t.Error("a key with no group was made")
}
}
// A-226b: the three forms of a compose-candidate key are built by the client and read by one parser; a check's key reads as it
// did, a revision's number is never mistaken for a heads hash, and what is none of them is refused naming it.
func TestCandidateKeysOfTheThreeFormsRoundTripAndRefuse(t *testing.T) {
check, _ := CompositionKey("fix/1.2", "0123456789ab")
revision, err := RevisionKey("fix/1", 362)
if err != nil {
t.Fatal(err)
}
run, err := RunKey("r1")
if err != nil {
t.Fatal(err)
}
for key, want := range map[string]Candidate{
check: {Kind: CandidateCheck, Group: "fix/1.2", HeadsHash: "0123456789ab"},
revision: {Kind: CandidateRevision, Branch: "fix/1", Revision: 362},
run: {Kind: CandidateRun, Run: "r1"},
"main.1": {Kind: CandidateRevision, Branch: "main", Revision: 1},
} {
if got, err := ParseCandidateKey(key); err != nil || got != want {
t.Errorf("%q parsed as %+v (%v), want %+v", key, got, err, want)
}
}
for _, bad := range []string{"", "nogroup", "run-", "g.0123456789AB", ".362", "a.b.362", "main.0", "main.-3", "main.0362", "main.123456789012x"} {
if _, err := ParseCandidateKey(bad); err == nil {
t.Errorf("%q was taken for a candidate key", bad)
}
}
for _, bad := range []int64{0, -1, 100000000000} {
if _, err := RevisionKey("main", bad); err == nil {
t.Errorf("a key for revision %d was made", bad)
}
}
if _, err := RevisionKey("", 1); err == nil {
t.Error("a key with no branch was made")
}
if _, err := RunKey("a.b"); err == nil {
t.Error("a run key with a dot was made")
}
// The ask and the answer accept all three.
if _, err := EncodeAsk(seat.ComposeCandidateInput{Candidate: revision}); err != nil {
t.Errorf("an ask naming a revision: %v", err)
}
}
// A-237b: compose-candidate is a verb marked chunks: an ask carries the caller's call token, and an answer names the chunks the
// composition input is sent in; the inline input stays for an ask with no token.
func TestComposeCandidateAskAndAnswerCarryTheChunkedForm(t *testing.T) {
key, _ := RevisionKey("main", 7)
ask, err := EncodeAsk(seat.ComposeCandidateInput{Candidate: key, Input: true, Call: "0123456789abcdef0123456789abcdef"})
if err != nil {
t.Fatal(err)
}
back, err := DecodeAsk(ask)
if err != nil || back.Call != "0123456789abcdef0123456789abcdef" || !back.Input {
t.Errorf("the ask came back as %+v (%v)", back, err)
}
raw, err := EncodeAnswer(seat.ComposeCandidateAnswer{Node: "n1", Candidate: key, Verdict: Composed, Modules: []seat.Module{}, Own: seat.Module{Module: NodeWord, State: ModuleComposed, Digest: "sha256:" + strings.Repeat("a", 64)}, Chunks: 3})
if err != nil {
t.Fatal(err)
}
if a, err := DecodeAnswer(raw); err != nil || a.Chunks != 3 || a.Input != nil {
t.Errorf("the answer came back as %+v (%v)", a, err)
}
}
+3 -15
View File
@@ -49,9 +49,6 @@ type Composition struct {
Own seat.NodeOwn
Plan json.RawMessage
Refused string
// Templates are the digests ("sha256:<hex>"), sorted, of the templates archives the module's files were rendered from
// (design 47 G A-481, A-481a); part of the digest as the resources are.
Templates []string
}
type adoptionWire struct {
@@ -142,7 +139,6 @@ type composedWire struct {
Own *ownWire `json:"own,omitempty"`
Plan json.RawMessage `json:"plan,omitempty"`
Refused string `json:"refused,omitempty"`
Templates []string `json:"templates,omitempty"`
// Signature is read and dropped: a composition is unsigned (ADR 0593 §6), and a value the ended controller signed
// still decodes. Nothing writes it.
Signature json.RawMessage `json:"signature,omitempty"`
@@ -187,17 +183,9 @@ func (c Composition) check() error {
return fmt.Errorf("node-engine: the composition of %s carries the node's own parts, which only <node>.node carries", c.Module)
}
}
if c.Refused != "" && (len(c.Resources) > 0 || len(c.Filled) > 0 || c.Data || len(c.Plan) > 0 || len(c.Templates) > 0) {
if c.Refused != "" && (len(c.Resources) > 0 || len(c.Filled) > 0 || c.Data || len(c.Plan) > 0) {
return fmt.Errorf("node-engine: the composition of %s on %s is refused and holds resources, filled files, data or a plan", c.Module, c.Node)
}
for i, d := range c.Templates {
if hex, ok := strings.CutPrefix(d, "sha256:"); !ok || !keys.IsHex64(hex) {
return fmt.Errorf("node-engine: the templates digest %q of %s is not sha256: and 64 lowercase hex digits", d, c.Module)
}
if i > 0 && c.Templates[i-1] >= d {
return fmt.Errorf("node-engine: the templates digests of %s are not sorted and distinct", c.Module)
}
}
seen := map[string]bool{}
files := map[string][]*declaration.File{}
for _, raw := range c.Resources {
@@ -257,7 +245,7 @@ func (c Composition) wire() (composedWire, error) {
return composedWire{}, err
}
w := composedWire{V: keys.Version, Node: c.Node, Module: c.Module, FP: c.FP, Data: c.Data, Filled: c.Filled,
Refused: c.Refused, Templates: c.Templates, Resources: make([]json.RawMessage, len(c.Resources))}
Refused: c.Refused, Resources: make([]json.RawMessage, len(c.Resources))}
for i, r := range c.Resources {
canon, err := canonicalJSON(r)
if err != nil {
@@ -302,7 +290,7 @@ func DecodeComposition(data []byte) (Composition, error) {
return Composition{}, fmt.Errorf("node-engine: a composition does not fit its shape: %w", err)
}
c := Composition{V: w.V, Node: w.Node, Module: w.Module, FP: w.FP, Data: w.Data, Resources: w.Resources,
Filled: w.Filled, Plan: w.Plan, Refused: w.Refused, Templates: w.Templates}
Filled: w.Filled, Plan: w.Plan, Refused: w.Refused}
if w.Own != nil {
c.Own = ownFromWire(*w.Own)
}
@@ -60,7 +60,6 @@ func TestCompositionDigests(t *testing.T) {
{"one package", Composition{Node: "ace", Module: "buildah", FP: fp(7), Resources: by["buildah"]}, "sha256:84e480a7a62333960b3e4be21a7548bbaa09572ef73ca8fb9dc6dfd1228aeb6b"},
{"a service and a file", Composition{Node: "ace", Module: "mesh-wireguard", FP: fp(14), Resources: by["mesh-wireguard"]}, "sha256:d6edec2474f606503e55d4ee2e0b4f5d1ffc25d016e4bc595e86ea67fe205b8c"},
{"a plan beside the resources", Composition{Node: "ace", Module: "hostname", FP: fp(8), Resources: by["hostname"], Plan: json.RawMessage(`{"files":[{"path":"/etc/hostname"}]}`)}, "sha256:49e17d6c471ee65cdef745ca3ac5cea4d37b6a100e11d8434dc64a6e2949e57e"},
{"the templates archives it was rendered from", Composition{Node: "ace", Module: "hostname", FP: fp(8), Resources: by["hostname"], Templates: []string{"sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"}}, "sha256:342df17a2e81fc08911452ecf1f37c6267aa58b66b26109b8e10253196248364"},
}
for _, c := range cases {
got, err := ComposedDigest(c.c)
@@ -108,8 +107,6 @@ func TestCompositionRefusals(t *testing.T) {
{"a resource of another module", Composition{Node: "ace", Module: "hostname", FP: fp(8), Resources: ok.Resources}, "is of"},
{"the node's own parts on a module", Composition{Node: "ace", Module: "buildah", FP: fp(7), Own: seat.NodeOwn{ProvisionerAccount: "x"}}, "node's own parts"},
{"a refusal that holds resources", Composition{Node: "ace", Module: "buildah", FP: fp(7), Resources: ok.Resources, Refused: "no secret"}, "refused and holds"},
{"templates digests not sorted", Composition{Node: "ace", Module: "hostname", FP: fp(8), Resources: by["hostname"], Templates: []string{"sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}}, "not sorted"},
{"a templates digest of no form", Composition{Node: "ace", Module: "hostname", FP: fp(8), Resources: by["hostname"], Templates: []string{"abc"}}, "templates digest"},
{"the node's own with a fingerprint", Composition{Node: "ace", FP: fp(7)}, "names no fingerprint"},
{"a node name with a dot", Composition{Node: "a.ce"}, "node"},
}
+3 -9
View File
@@ -1349,9 +1349,7 @@ type ComposeAnswer struct {
// ComposeCandidateInput is what compose-candidate takes.
type ComposeCandidateInput struct {
// 128 random bits the caller chooses: the subject token of the chunks and acknowledgements the composition input is sent in, whatever its size (design 47 G A-237b); an ask with input and no call is answered inline, as before the checker goes (G-6 section 321)
Call string `json:"call,omitempty"`
// the key of the candidate to compose: a check's candidate in the indexer, <group>.<heads hash>; a branch pipeline's catalog graph revision, <branch>.<revision> (the node-engine reads its entries through mesh-catalog.revision); or a run on request's, run-<id>; built and read by the seat's client (nodeengineclient)
// the key of the indexer's candidate, <group>.<heads hash>
Candidate string `json:"candidate"`
// also answer the composition input the candidate was composed from, for the sandbox path
Input bool `json:"input,omitempty"`
@@ -1361,9 +1359,7 @@ type ComposeCandidateInput struct {
type ComposeCandidateAnswer struct {
// the candidate's key
Candidate string `json:"candidate"`
// when asked with input and a call token: how many chunks of at most 512 KiB carry the composition input, sent on the chunk subject of the call, each acknowledged by the caller (design 47 G A-237b)
Chunks int64 `json:"chunks,omitempty"`
// when asked without a call token: the composition input it composed from, inline, up to what one answer carries (the checker's form, kept until G removes the checker, G-6 section 321)
// when asked: the composition input it composed from
Input map[string]any `json:"input,omitempty"`
// every module placed on the node, sorted by name
Modules []Module `json:"modules"`
@@ -1649,9 +1645,7 @@ type ComposedByNodeModuleFingerprintValue struct {
Refused string `json:"refused,omitempty"`
// the declaration resources, each saying its module
Resources []map[string]any `json:"resources"`
// the digests, sorted, of the templates archives the composition was rendered from
Templates []string `json:"templates,omitempty"`
V int64 `json:"v"`
V int64 `json:"v"`
}
// ComposedByNodeNodeValue is one value of the state composed under the key <node>.node.
@@ -1,3 +1,4 @@
// Package findings is kept empty as a bridge: the modules whose last build before G imported it get a fingerprint
// naming their packages' commits only while it is published. It goes once those modules have built under G.
// naming their packages' commits only while it is published. It goes once those modules have built under G
// (mesh-contracts #12; this second commit only carries #12's merge to the indexer, whose message was lost).
package findings
@@ -176,6 +176,7 @@ func Glance(explanation string) error {
// The bounds of an ask (novox/hq ADR 0234 §8, ADR 0259 §4).
const (
MostOptions = 4
MostOpen = 3
ApproveLasts = 24 * time.Hour
DestroyLasts = 10 * time.Minute
HeadlineLength = approval.HeadlineLength
+4 -8
View File
@@ -56,8 +56,7 @@
"entries"
]
},
"optional": true,
"class": "read"
"optional": true
},
{
"name": "show",
@@ -68,8 +67,7 @@
"answer": {
"$ref": "#/defs/Held"
},
"optional": true,
"class": "read"
"optional": true
},
{
"name": "check",
@@ -124,8 +122,7 @@
"differences"
]
},
"optional": true,
"class": "read"
"optional": true
},
{
"name": "orphans",
@@ -150,8 +147,7 @@
"entries"
]
},
"optional": true,
"class": "read"
"optional": true
},
{
"name": "create",
+2 -19
View File
@@ -600,16 +600,12 @@
"input": {
"properties": {
"candidate": {
"description": "the key of the candidate to compose: a check's candidate in the indexer, <group>.<heads hash>; a branch pipeline's catalog graph revision, <branch>.<revision> (the node-engine reads its entries through mesh-catalog.revision); or a run on request's, run-<id>; built and read by the seat's client (nodeengineclient)",
"description": "the key of the indexer's candidate, <group>.<heads hash>",
"type": "string"
},
"input": {
"description": "also answer the composition input the candidate was composed from, for the sandbox path",
"type": "boolean"
},
"call": {
"description": "128 random bits the caller chooses: the subject token of the chunks and acknowledgements the composition input is sent in, whatever its size (design 47 G A-237b); an ask with input and no call is answered inline, as before the checker goes (G-6 section 321)",
"type": "string"
}
},
"required": [
@@ -662,12 +658,7 @@
},
"input": {
"type": "object",
"description": "when asked without a call token: the composition input it composed from, inline, up to what one answer carries (the checker's form, kept until G removes the checker, G-6 section 321)"
},
"chunks": {
"type": "integer",
"minimum": 0,
"description": "when asked with input and a call token: how many chunks of at most 512 KiB carry the composition input, sent on the chunk subject of the call, each acknowledged by the caller (design 47 G A-237b)"
"description": "when asked: the composition input it composed from"
}
},
"required": [
@@ -680,7 +671,6 @@
"took"
]
},
"chunks": true,
"class": "read"
},
{
@@ -1310,13 +1300,6 @@
"refused": {
"type": "string",
"description": "why the module cannot be composed at this fingerprint"
},
"templates": {
"type": "array",
"items": {
"type": "string"
},
"description": "the digests, sorted, of the templates archives the composition was rendered from"
}
},
"required": [
+2 -8
View File
@@ -981,9 +981,7 @@ export interface ComposeAnswer {
/** is what compose-candidate takes. */
export interface ComposeCandidateInput {
/** 128 random bits the caller chooses: the subject token of the chunks and acknowledgements the composition input is sent in, whatever its size (design 47 G A-237b); an ask with input and no call is answered inline, as before the checker goes (G-6 section 321) */
"call"?: string;
/** the key of the candidate to compose: a check's candidate in the indexer, <group>.<heads hash>; a branch pipeline's catalog graph revision, <branch>.<revision> (the node-engine reads its entries through mesh-catalog.revision); or a run on request's, run-<id>; built and read by the seat's client (nodeengineclient) */
/** the key of the indexer's candidate, <group>.<heads hash> */
"candidate": string;
/** also answer the composition input the candidate was composed from, for the sandbox path */
"input"?: boolean;
@@ -993,9 +991,7 @@ export interface ComposeCandidateInput {
export interface ComposeCandidateAnswer {
/** the candidate's key */
"candidate": string;
/** when asked with input and a call token: how many chunks of at most 512 KiB carry the composition input, sent on the chunk subject of the call, each acknowledged by the caller (design 47 G A-237b) */
"chunks"?: number;
/** when asked without a call token: the composition input it composed from, inline, up to what one answer carries (the checker's form, kept until G removes the checker, G-6 section 321) */
/** when asked: the composition input it composed from */
"input"?: Record<string, unknown>;
/** every module placed on the node, sorted by name */
"modules": Module[];
@@ -1237,8 +1233,6 @@ export interface ComposedByNodeModuleFingerprintValue {
"refused"?: string;
/** the declaration resources, each saying its module */
"resources": Record<string, unknown>[];
/** the digests, sorted, of the templates archives the composition was rendered from */
"templates"?: string[];
"v": number;
}