mesh-delivery/modules/mesh-delivery-assigner/internal/assign/asks_test.go

package assign

import (
	"fmt"
	"slices"
	"strings"
	"testing"
	"time"

	occ "git.novox.be/novox/mesh-contracts/go/clients/operatorchannelclient"
	oc "git.novox.be/novox/mesh-contracts/go/seats/operatorchannel"
	"git.novox.be/novox/mesh-sdk/go/delivery"
	"git.novox.be/novox/mesh-sdk/go/health"
)

// 1297/B9 (the assigner's half): the ask about a held fingerprint is a valid ask of the router and of mesh-sdk's layout at
// its key, of a kind the view may answer.
func TestTheHoldAskIsValid(t *testing.T) {
	key, err := delivery.HoldAskKey("mail", fNew)
	if err != nil {
		t.Fatal(err)
	}
	now := time.Now()
	a := HoldAsk(key, "mail", fNew, "ace", "health failed, phase running: connection refused", 0, now)
	if err := occ.Check(mustAsk(t, a), now); err != nil {
		t.Errorf("the router refuses the ask: %v", err)
	}
	if _, err := EncodeAsk(key, a); err != nil {
		t.Errorf("the ask cannot be written: %v", err)
	}
	// 1906/H3: the ask names the machine whose check failed and the hold's words.
	if !strings.Contains(mustAsk(t, a).Explanation, "on ace") || !strings.Contains(mustAsk(t, a).Explanation, "connection refused") {
		t.Errorf("the ask does not name the node and the hold's words: %q", mustAsk(t, a).Explanation)
	}
	// 1906/H2: an ask written again after a lift is another asking, under an id of its own.
	again := HoldAsk(key, "mail", fNew, "ace", "x", 7, now)
	if again.Asking != 7 || mustAsk(t, again).ID != delivery.AskingID(key, 7) || mustAsk(t, again).ID == mustAsk(t, a).ID {
		t.Errorf("the asking after a lift = %d %s", again.Asking, mustAsk(t, again).ID)
	}
	if _, err := EncodeAsk(key, again); err != nil {
		t.Errorf("the ask asked again cannot be written: %v", err)
	}
	if _, err := delivery.ViewAnswerKey(key); err != nil {
		t.Errorf("the view may not answer it: %v", err)
	}
	// The join (A1d ruling 1): mesh-sdk no longer refuses another id, no option or no ask in an assigner's ask; EncodeAsk does.
	t.Run("EncodeAsk refuses what mesh-sdk no longer does", func(t *testing.T) {
		good := HoldAsk(key, "mail", fNew, "ace", "x", 0, time.Unix(100, 0))
		other := good
		other.Asking = 3 // its id is the asking 0's
		empty := good
		ask := mustAsk(t, good)
		ask.Options = nil
		empty.Ask = assignerAsk(0, ask).Ask
		for name, a := range map[string]delivery.AssignerAsk{"another id": other, "no option": empty, "no ask": {}} {
			if _, err := EncodeAsk(key, a); err == nil {
				t.Errorf("%s: written", name)
			}
		}
	})
}

// 1906/D3 (ADR 0539 §19): the ask about a data module held on a node is a valid ask of the router and of mesh-sdk's layout at
// its restore key, of a kind the view may answer; it offers restoring (losing the newer writes) and leaving it stopped.
func TestTheRestoreAskIsValid(t *testing.T) {
	key, err := delivery.RestoreAskKey("ace", "mail", fNew)
	if err != nil {
		t.Fatal(err)
	}
	now := time.Now()
	a := RestoreAsk(key, "ace", "mail", fNew, "connection refused", now)
	if err := occ.Check(mustAsk(t, a), now); err != nil {
		t.Errorf("the router refuses the ask: %v", err)
	}
	if _, err := EncodeAsk(key, a); err != nil {
		t.Errorf("the ask cannot be written: %v", err)
	}
	if _, err := delivery.ViewAnswerKey(key); err != nil {
		t.Errorf("the view may not answer it: %v", err)
	}
	var ids []string
	for _, o := range mustAsk(t, a).Options {
		ids = append(ids, o.ID)
	}
	if len(ids) != 2 || ids[0] != OptionRestore || ids[1] != OptionLeaveStopped {
		t.Errorf("options = %v", ids)
	}
	if !strings.Contains(mustAsk(t, a).Explanation, "connection refused") || !strings.Contains(mustAsk(t, a).Explanation, "ace") {
		t.Errorf("the ask does not name the node and the check's words: %q", mustAsk(t, a).Explanation)
	}
}

// 1906/D3: the condition for a held fingerprint names the module, the node and the check's words, under the assigner's own
// name (ADR 0437 clause 9), and is cleared under the same key.
func TestTheAssignersConditions(t *testing.T) {
	t.Run("the held condition names module, node and words", heldConditionNamesModuleNodeAndWords)
	t.Run("a lifted hold clears its condition saying why", liftedHoldClearsItsConditionSayingWhy)
	t.Run("1952/WM6: each said condition is a finding, its clear deletes it, said straight only with no findings bucket", saidConditionsAreFindings)
}

func heldConditionNamesModuleNodeAndWords(t *testing.T) {
	c := HeldCondition("mail", fNew, "ace", "connection refused", true, true)
	if _, err := occ.EncodeCondition(c); err != nil {
		t.Fatalf("the condition is refused: %v", err)
	}
	if c.State != occ.StateRaised || c.Subject.ID != "mail" || c.Subject.Machine != "ace" || !strings.Contains(c.Explanation, "connection refused") || !strings.Contains(c.Key, "mail") {
		t.Errorf("condition = %+v", c)
	}
	if got := HeldCondition("mail", fNew, "", "", false, false); got.State != occ.StateCleared || got.Key != c.Key {
		t.Errorf("cleared = %+v", got)
	}
}

// 1906/H2: a hold lifted by itself clears the held condition under its key, saying why.
func liftedHoldClearsItsConditionSayingWhy(t *testing.T) {
	c := LiftedCondition("mail", fNew)
	if _, err := occ.EncodeCondition(c); err != nil {
		t.Fatalf("the condition is refused: %v", err)
	}
	if c.State != occ.StateCleared || c.Key != HeldCondition("mail", fNew, "ace", "x", true, false).Key || !strings.Contains(c.Resolved, "lifted its hold by itself") {
		t.Errorf("condition = %+v", c)
	}
}

// 1952/WM6 (ADR 0564 §2, issue 1952 note 16): every condition the assigner says is a finding in its own bucket, under
// `<scope>.<id>.<kind>`, written at the raise and deleted at the clear, and only as a finding: the keeper is the one
// source since the controller's end (novox/hq ADR 0590 §3, issue 1126 B8). Said straight to the router only where the
// findings bucket cannot be written to at all.
func saidConditionsAreFindings(t *testing.T) {
	at := time.Date(2026, 10, 29, 21, 0, 0, 0, time.UTC)
	for _, c := range []struct {
		raised, cleared oc.Condition
		key             string
	}{
		{HeldCondition("mail", fNew, "ace", "refused", true, true), LiftedCondition("mail", fNew), "module.mail." + strings.TrimPrefix(fNew, delivery.SourcePrefix2) + ".held"},
		{NodeFailedCondition("ace", "mail", fNew, NodeFailure{Words: "x", Others: []string{"g14"}}, true), NodeFailedCondition("ace", "mail", fNew, NodeFailure{}, false), "module.ace.mail.failed-alone"},
		{NeitherCondition("ace", "mail", Holding{Rule: 3, Words: "w"}, true), NeitherCondition("ace", "mail", Holding{}, false), "module.ace.mail.neither"},
		{SeatWaitsCondition([]string{"placement"}), SeatWaitsCondition(nil), "module.mesh-delivery-assigner.seat-states"},
		{BackupCondition("ace", "mail", fNew, "disk full", true), BackupCondition("ace", "mail", fNew, "", false), "module.ace.mail." + strings.TrimPrefix(fNew, delivery.SourcePrefix2) + ".backup"},
	} {
		puts, deletes, said := map[string]health.Finding{}, []string{}, 0
		f := Findings{Put: func(k string, v []byte) error {
			got, err := health.DecodeFinding(v)
			puts[k] = got
			return err
		}, Delete: func(k string) error { deletes = append(deletes, k); return nil }, Now: func() time.Time { return at }}
		say := f.Say(func(oc.Condition) error { said++; return nil })
		if err := say(c.raised); err != nil {
			t.Fatalf("%s: %v", c.key, err)
		}
		got, ok := puts[c.key]
		if !ok || got.Severity != health.Severity(c.raised.Severity) || got.Headline != c.raised.Headline || got.Observer != delivery.AssignerModule ||
			got.Subject.Machine != c.raised.Subject.Machine || said != 0 {
			t.Fatalf("%s: finding %+v (written %v), said %d", c.key, got, puts, said)
		}
		if err := say(c.cleared); err != nil || !slices.Equal(deletes, []string{c.key}) || said != 0 {
			t.Fatalf("%s: deleted %v, said %d (%v)", c.key, deletes, said, err)
		}
		if err := (Findings{}).Say(func(oc.Condition) error { said++; return nil })(c.raised); err != nil || said != 1 {
			t.Fatalf("%s: with no findings bucket said %d (%v), want straight once", c.key, said, err)
		}
	}
	if _, _, _, err := FindingOf(oc.Condition{Key: "another.x", State: occ.StateRaised}, at); err == nil {
		t.Error("a condition not the assigner's is a finding")
	}
}

// 1906/D4: the record ask and the backup ask are valid asks of the router and of mesh-sdk's layout at their keys, answerable in
// the view, and name the move and the node.
func TestTheRecordAndBackupAsksAreValid(t *testing.T) {
	now := time.Now()
	rkey, err := delivery.RecordAskKey("ace", "mail", "sha256:"+strings.Repeat("b", 64))
	if err != nil {
		t.Fatal(err)
	}
	r := RecordAsk(rkey, "ace", "mail", fNew, RecordNeed{Node: "ace", Digest: "sha256:" + strings.Repeat("b", 64), Judgement: delivery.JudgedCannot, Words: "the composition it runs is gone"}, now)
	bkey, err := delivery.BackupAskKey("ace", "mail", fNew)
	if err != nil {
		t.Fatal(err)
	}
	dgst := "sha256:" + strings.Repeat("b", 64)
	b := BackupAsk(bkey, "ace", "mail", fNew, dgst, "no space left", 0, now)
	for key, a := range map[string]delivery.AssignerAsk{rkey: r, bkey: b} {
		if err := occ.Check(mustAsk(t, a), now); err != nil {
			t.Errorf("%s: the router refuses the ask: %v", key, err)
		}
		if _, err := EncodeAsk(key, a); err != nil {
			t.Errorf("%s: cannot be written: %v", key, err)
		}
		if _, err := delivery.ViewAnswerKey(key); err != nil {
			t.Errorf("%s: the view may not answer it: %v", key, err)
		}
	}
	if !strings.Contains(mustAsk(t, r).Explanation, "gone") || mustAsk(t, r).Options[0].ID != OptionYes {
		t.Errorf("the record ask = %+v", mustAsk(t, r))
	}
	if !strings.Contains(mustAsk(t, b).Explanation, "no space left") || mustAsk(t, b).Options[0].ID != delivery.BackupAgain || mustAsk(t, b).Options[1].ID != delivery.BackupSkip {
		t.Errorf("the backup ask = %+v", mustAsk(t, b))
	}
	// the id binds the ask to the composition and to its number (review round 1, items 3 and 4)
	if again := BackupAsk(bkey, "ace", "mail", fNew, dgst, "x", NextBackupAsking(0), now); mustAsk(t, again).ID == mustAsk(t, b).ID {
		t.Errorf("asked again under the same id")
	}
	if NextBackupAsking(-1) != 0 || NextBackupAsking(0) != 2 || NextBackupAsking(2) != 3 {
		t.Errorf("the numbers of the askings: %d %d %d", NextBackupAsking(-1), NextBackupAsking(0), NextBackupAsking(2))
	}
	if BackupAskDigest(b) != dgst {
		t.Errorf("the ask names composition %q, want %q", BackupAskDigest(b), dgst)
	}
	if BackupAnswerWords("again", 0) == BackupAnswerWords("again", 1) {
		t.Errorf("two answers of the same option are one want value")
	}
	c := BackupCondition("ace", "mail", fNew, "no space left", true)
	if _, err := occ.EncodeCondition(c); err != nil {
		t.Errorf("the backup condition is refused: %v", err)
	}
	// ADR 0546 clauses 7 and 8: a put's ask is valid at the record ask's key; for the bus its yes approves and binds the act,
	// so the view cannot answer it, and it lasts no longer than an approving ask may.
	put := delivery.Put{FP: fNew, Why: "the bus's user list", Hold: true}
	d := delivery.ComposedDigest{Digest: dgst, Judgement: delivery.JudgedCannot, Words: "the have names no composition"}
	for _, bus := range []bool{false, true} {
		a, err := PutAsk(rkey, "ace", "mail", put, d, bus, now)
		if err != nil {
			t.Fatalf("bus %v: %v", bus, err)
		}
		if err := occ.Check(mustAsk(t, a), now); err != nil {
			t.Errorf("bus %v: the router refuses the put's ask: %v", bus, err)
		}
		if _, err := EncodeAsk(rkey, a); err != nil {
			t.Errorf("bus %v: the put's ask cannot be written: %v", bus, err)
		}
		viewed := delivery.ViewAnswerFits(delivery.ViewAnswer{Asking: mustAsk(t, a).ID, Option: OptionYes}, rkey, a)
		yes := mustAsk(t, a).Options[0]
		// mesh-sdk gives no refusal by level any more: the teller refuses an option a view cannot answer (its level is not
		// acknowledge), as it did through the sdk before.
		if viewed == nil {
			if o, ok := occ.OptionOf(mustAsk(t, a), OptionYes); ok && o.Level != "" && o.Level != occ.Acknowledge {
				viewed = fmt.Errorf("only a channel that proves who answered takes the option %s", o.ID)
			}
		}
		switch {
		case !strings.Contains(mustAsk(t, a).Explanation, "the bus's user list"):
			t.Errorf("bus %v: the put's ask does not say why: %s", bus, mustAsk(t, a).Explanation)
		case bus && (yes.Level != occ.Approve || yes.Binds == "" || viewed == nil || expiresAt(t, a).After(now.Add(occ.ApproveLasts))):
			t.Errorf("bus: the yes is %+v, the view's answer %v, expiring %s", yes, viewed, expiresAt(t, a))
		case !bus && (yes.Level != occ.Acknowledge || viewed != nil):
			t.Errorf("a recorded module: the yes is %+v, the view's answer %v", yes, viewed)
		}
		later := put
		later.At = now.Add(time.Minute)
		b, _ := PutAsk(rkey, "ace", "mail", later, d, bus, now)
		if mustAsk(t, b).ID == mustAsk(t, a).ID || b.Asking != PutAsking(later) {
			t.Errorf("bus %v: a later put's ask is asking %d under id %q, the earlier's %q", bus, b.Asking, mustAsk(t, b).ID, mustAsk(t, a).ID)
		}
		if err := occ.Performs(yes, PutAct("ace", "mail", fNew, dgst)); err != nil {
			t.Errorf("bus %v: the yes does not perform the act it bound: %v", bus, err)
		}
		if err := occ.Performs(yes, PutAct("ace", "mail", fNew, dig(fOld))); bus && err == nil {
			t.Errorf("bus: the yes performs another composition's act")
		}
	}
}

// 1945/AC21: the condition of a module on neither list is urgent, names the module, the node and the rule holding its want back,
// under the assigner's own name keyed by node and module, and is cleared under the same key.
func TestTheNeitherConditionNamesModuleNodeAndRule(t *testing.T) {
	c := NeitherCondition("g14", "i3status-rust", Holding{Rule: delivery.RuleProviders, Words: "no provider of x11-display runs healthy on g14 or at its canary"}, true)
	if _, err := occ.EncodeCondition(c); err != nil {
		t.Fatalf("the condition is refused: %v", err)
	}
	if c.State != occ.StateRaised || c.Severity != occ.SeverityUrgent || c.Subject.ID != "i3status-rust" || c.Subject.Machine != "g14" ||
		!strings.Contains(c.Explanation, "x11-display") || !strings.Contains(c.Explanation, "rule 5") || c.Key != "mesh-delivery-assigner.neither.g14.i3status-rust" {
		t.Errorf("condition = %+v", c)
	}
	if got := NeitherCondition("g14", "i3status-rust", Holding{}, false); got.State != occ.StateCleared || got.Key != c.Key {
		t.Errorf("cleared = %+v", got)
	}
}

// mustAsk is the router's ask an asks-state value carries.
func mustAsk(t *testing.T, a delivery.AssignerAsk) oc.Ask {
	t.Helper()
	ask, err := AskOf(a)
	if err != nil {
		t.Fatal(err)
	}
	return ask
}

func expiresAt(t *testing.T, a delivery.AssignerAsk) time.Time {
	t.Helper()
	return ExpiresAt(mustAsk(t, a))
}