diff --git a/modules/mesh-delivery-assigner/cmd/mesh-delivery-assigner/asksform_test.go b/modules/mesh-delivery-assigner/cmd/mesh-delivery-assigner/asksform_test.go index 675498415..e9c79f510 100644 --- a/modules/mesh-delivery-assigner/cmd/mesh-delivery-assigner/asksform_test.go +++ b/modules/mesh-delivery-assigner/cmd/mesh-delivery-assigner/asksform_test.go @@ -68,7 +68,7 @@ func TestTheAssignersAsksAreTheSeatMeshWantsAsks(t *testing.T) { if err != nil { t.Fatal(err) } - if v, err := meshwants.DecodeAsksByHoldModuleFingerprintValue(raw); err != nil || v.Asking != 2 { + if v, _, err := meshwants.DecodeAsksByHoldModuleFingerprintValue(raw); err != nil || v.Asking != 2 { t.Errorf("the ask %s is not the seat's Ask: %+v, %v", raw, v, err) } } diff --git a/modules/mesh-delivery-builder/internal/versions/names.go b/modules/mesh-delivery-builder/internal/versions/names.go index 4eead9177..46a9b9607 100644 --- a/modules/mesh-delivery-builder/internal/versions/names.go +++ b/modules/mesh-delivery-builder/internal/versions/names.go @@ -39,7 +39,7 @@ func NamesIn(s PackagesState) PackageNames { if !found { continue } - v, err := meshcatalog.DecodePackagesByPackageSeriesValue(value) // the indexer's value of a series key (mesh-sdk's contract, J4) + v, _, err := meshcatalog.DecodePackagesByPackageSeriesValue(value) // the indexer's value of a series key (mesh-sdk's contract, J4) if err != nil || v.Package != built { continue } @@ -56,7 +56,7 @@ func NamedModule(key string, value []byte) (module, name string, ok bool) { if !isSeriesKey(key) { return "", "", false } - v, err := meshcatalog.DecodePackagesByPackageSeriesValue(value) + v, _, err := meshcatalog.DecodePackagesByPackageSeriesValue(value) if err != nil || v.Name == "" { return "", "", false } @@ -99,7 +99,7 @@ func Carriers(s PackagesState) func(ctx context.Context, name string) ([]Built, if !found { continue } - v, err := meshcatalog.DecodePackagesByPackageSeriesValue(value) + v, _, err := meshcatalog.DecodePackagesByPackageSeriesValue(value) if err != nil || v.Name != name { continue } diff --git a/modules/mesh-delivery-contracts/go/clients/meshcatalogclient/catalog_test.go b/modules/mesh-delivery-contracts/go/clients/meshcatalogclient/catalog_test.go index 44bc27f51..8bebbd58d 100644 --- a/modules/mesh-delivery-contracts/go/clients/meshcatalogclient/catalog_test.go +++ b/modules/mesh-delivery-contracts/go/clients/meshcatalogclient/catalog_test.go @@ -213,10 +213,10 @@ func TestTakeInBodiesAndNoneYetAreTheSeatsTypes(t *testing.T) { } // design 47 H-A-48: the indexer stamps no source revision on a module; the take-in's commit names it, so a module value and an -// entry's inputs carrying src or fp-src are not the seat's. +// entry's inputs carrying src or fp-src are not the seat's: a reader leaves them unread (design 47 H2 §780). func TestNoSourceStamps(t *testing.T) { - if _, err := seat.DecodeModulesByModuleValue([]byte(`{"v":1,"repository":"mesh-sdk","commit":"` + hex64("a")[:40] + `","manifest":"` + hex64("b") + `","path":"go","src":41,"fp-src":41}`)); err == nil { - t.Error("a module value carrying src and fp-src is read") + if v, form, err := seat.DecodeModulesByModuleValue([]byte(`{"v":1,"repository":"mesh-sdk","commit":"` + hex64("a")[:40] + `","manifest":"` + hex64("b") + `","path":"go","src":41,"fp-src":41}`)); err != nil || v.Repository != "mesh-sdk" || form != 1 { + t.Errorf("a module value carrying src and fp-src is not read past them: %+v %d %v", v, form, err) } var in seat.EntryInputs dec := json.NewDecoder(strings.NewReader(`{"src":41,"fp-src":41}`)) diff --git a/modules/mesh-delivery-contracts/go/clients/meshdeliveryclient/gate.go b/modules/mesh-delivery-contracts/go/clients/meshdeliveryclient/gate.go index 055d93984..6da281fc4 100644 --- a/modules/mesh-delivery-contracts/go/clients/meshdeliveryclient/gate.go +++ b/modules/mesh-delivery-contracts/go/clients/meshdeliveryclient/gate.go @@ -58,7 +58,7 @@ func DecodeSource(data []byte) (seat.SourceByBranchValue, error) { if err := keys.CheckVersion(data); err != nil { return seat.SourceByBranchValue{}, err } - s, err := seat.DecodeSourceByBranchValue(data) + s, _, err := seat.DecodeSourceByBranchValue(data) if err != nil { return s, fmt.Errorf("meshdeliveryclient: a source does not fit its shape: %w", err) } @@ -80,7 +80,7 @@ func DecodeOwed(data []byte) (seat.OwedByRepositoryNumberHeadActValue, error) { if err := keys.CheckVersion(data); err != nil { return seat.OwedByRepositoryNumberHeadActValue{}, err } - o, err := seat.DecodeOwedByRepositoryNumberHeadActValue(data) + o, _, err := seat.DecodeOwedByRepositoryNumberHeadActValue(data) if err != nil { return o, fmt.Errorf("meshdeliveryclient: an owed value does not fit its shape: %w", err) } diff --git a/modules/mesh-delivery-contracts/go/clients/meshdeliveryclient/gate_test.go b/modules/mesh-delivery-contracts/go/clients/meshdeliveryclient/gate_test.go index c9cf3499b..50613698d 100644 --- a/modules/mesh-delivery-contracts/go/clients/meshdeliveryclient/gate_test.go +++ b/modules/mesh-delivery-contracts/go/clients/meshdeliveryclient/gate_test.go @@ -140,7 +140,8 @@ func TestGateValuesRefuseWhatTheirRulesRefuse(t *testing.T) { if _, err := DecodeSource([]byte(`{"v":2,"source":1,"call":"c","heads":{"a":"b"}}`)); !errors.Is(err, keys.ErrUnknownVersion) { t.Errorf("another version: %v", err) } - if _, err := DecodeSource([]byte(`{"v":1,"source":1,"call":"c","heads":{"a":"b"},"extra":1}`)); err == nil { - t.Error("an unknown field decodes") + // design 47 H2 §780: a reader leaves a field it does not know unread. + if s, err := DecodeSource([]byte(`{"v":1,"source":1,"call":"0123456789abcdef","heads":{"a":"b"},"extra":1}`)); err != nil || s.Source != 1 { + t.Errorf("an unknown field is not read past: %+v %v", s, err) } } diff --git a/modules/mesh-delivery-contracts/go/clients/meshwantsclient/wants.go b/modules/mesh-delivery-contracts/go/clients/meshwantsclient/wants.go index 5d7f8e6b8..21f87b008 100644 --- a/modules/mesh-delivery-contracts/go/clients/meshwantsclient/wants.go +++ b/modules/mesh-delivery-contracts/go/clients/meshwantsclient/wants.go @@ -233,7 +233,7 @@ func DecodeWant(data []byte) (Want, error) { if err := keys.CheckVersion(data); err != nil { return Want{}, err } - w, err := seat.DecodeWantsByWantNodeModuleValue(data) + w, _, err := seat.DecodeWantsByWantNodeModuleValue(data) if err != nil { return Want{}, fmt.Errorf("wants: value does not fit its shape: %w", err) } @@ -272,7 +272,7 @@ func DecodeNodeWant(data []byte) (NodeWant, error) { if err := keys.CheckVersion(data); err != nil { return NodeWant{}, err } - w, err := seat.DecodeWantsByWantNodeNodeValue(data) + w, _, err := seat.DecodeWantsByWantNodeNodeValue(data) if err != nil { return NodeWant{}, fmt.Errorf("wants: a node's own want does not fit its shape: %w", err) } @@ -298,7 +298,7 @@ func DecodeHeld(data []byte) (Held, error) { if err := keys.CheckVersion(data); err != nil { return Held{}, err } - h, err := seat.DecodeWantsByHeldModuleFingerprintValue(data) + h, _, err := seat.DecodeWantsByHeldModuleFingerprintValue(data) if err != nil { return Held{}, fmt.Errorf("wants: value does not fit its shape: %w", err) } diff --git a/modules/mesh-delivery-contracts/go/clients/meshwantsclient/wants_test.go b/modules/mesh-delivery-contracts/go/clients/meshwantsclient/wants_test.go index c967aace7..9a0d4a17d 100644 --- a/modules/mesh-delivery-contracts/go/clients/meshwantsclient/wants_test.go +++ b/modules/mesh-delivery-contracts/go/clients/meshwantsclient/wants_test.go @@ -76,17 +76,18 @@ func TestWantsAreWhatTheEarlierCodecWrote(t *testing.T) { t.Errorf("%s: written", name) } } - // design 47 H §750, H-A-37: a want names no digest, rule or newest; the earlier fields are refused. + // design 47 H §750, H-A-37: a want names no digest, rule or newest; a reader leaves the earlier fields unread + // (design 47 H2 §780). for _, old := range []string{`"composed":"` + c + `"`, `"parts":{"x:image":"` + d + `"}`, `"rule":3`, `"newest":"` + b + `"`, `"kept-on":"n1"`} { - if _, err := DecodeWant([]byte(`{"v":1,"fp":"` + a + `",` + old + `}`)); err == nil { - t.Errorf("a want naming %s is read", old) + if w, err := DecodeWant([]byte(`{"v":1,"fp":"` + a + `",` + old + `}`)); err != nil || w.Fp != a { + t.Errorf("a want naming %s is not read past it: %+v %v", old, w, err) } } if _, err := DecodeWant([]byte(`{"fp":"` + a + `","self":true}`)); !errors.Is(err, keys.ErrUnknownVersion) { t.Errorf("no version: %v", err) } - if _, err := DecodeWant([]byte(`{"v":1,"fp":"` + a + `","self":true,"extra":1}`)); err == nil { - t.Error("an unknown field is read") + if w, err := DecodeWant([]byte(`{"v":1,"fp":"` + a + `","self":true,"extra":1}`)); err != nil || !w.Self { + t.Errorf("an unknown field is not read past (design 47 H2 §780): %+v %v", w, err) } }) t.Run("node want and hold", func(t *testing.T) { @@ -108,8 +109,9 @@ func TestWantsAreWhatTheEarlierCodecWrote(t *testing.T) { t.Errorf("%s: written", name) } } - if _, err := DecodeNodeWant([]byte(`{"v":1,"composed":"` + c + `","fp":"` + a + `"}`)); err == nil { - t.Error("a fingerprint in a node's own want is read") + // design 47 H2 §780: a fingerprint is no field of a node's own want, and a reader leaves it unread. + if back, err := DecodeNodeWant([]byte(`{"v":1,"composed":"` + c + `","fp":"` + a + `"}`)); err != nil || back.Composed != c { + t.Errorf("a node's own want naming a fingerprint is not read past it: %+v %v", back, err) } raw, err = EncodeHeld(Held{Node: "anchor", Words: "unhealthy"}) if err != nil { diff --git a/modules/mesh-delivery-contracts/go/seats/containerimageregistry/contract.go b/modules/mesh-delivery-contracts/go/seats/containerimageregistry/contract.go index 80739294f..bad679dd6 100644 --- a/modules/mesh-delivery-contracts/go/seats/containerimageregistry/contract.go +++ b/modules/mesh-delivery-contracts/go/seats/containerimageregistry/contract.go @@ -4,15 +4,27 @@ package containerimageregistry import ( - "bytes" "encoding/json" - "errors" "strings" ) // Seat is the seat's name. const Seat = "container-image-registry" +// Form is the form of the seat's values, events and answers this contract was generated at (design 47 H2 §780): +// a reader of a value of another form says "form N, this reader knows M". +const Form = 1 + +// FormRegistry is the form of what the part registry adds. +const FormRegistry = 1 + +// The forms and the digest of the fields this contract was generated from: the generator's compare fails a definition +// whose fields changed while its forms did not (design 47 H2 §780). +const ( + generatedForms = "1 registry:1" + generatedFieldsDigest = "63651a5f06aa41743b7c77ff25bed94a2b3ad6bcc39ac9f15ffcd51ff55a3c9d" +) + const ( VerbPublish = "publish" VerbPublishPart = "publish-part" @@ -102,18 +114,13 @@ func ParseHoldsBySeatNameDigestKey(key string) (string, string, string, bool) { return v0, v2, v4, true } -// DecodeHoldsBySeatNameDigestValue reads one value of the state holds under the form "..", refusing a field HoldsBySeatNameDigestValue does not know and any text after the value. -func DecodeHoldsBySeatNameDigestValue(raw []byte) (HoldsBySeatNameDigestValue, error) { +// DecodeHoldsBySeatNameDigestValue reads one value of the state holds under the form ".." as another part wrote it: a field HoldsBySeatNameDigestValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeHoldsBySeatNameDigestValue(raw []byte) (HoldsBySeatNameDigestValue, int, error) { var v HoldsBySeatNameDigestValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // WindowsByCallerKey is the key of one value of the state windows under the form "". @@ -133,18 +140,13 @@ func ParseWindowsByCallerKey(key string) (string, bool) { return v0, true } -// DecodeWindowsByCallerValue reads one value of the state windows under the form "", refusing a field WindowsByCallerValue does not know and any text after the value. -func DecodeWindowsByCallerValue(raw []byte) (WindowsByCallerValue, error) { +// DecodeWindowsByCallerValue reads one value of the state windows under the form "" as another part wrote it: a field WindowsByCallerValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeWindowsByCallerValue(raw []byte) (WindowsByCallerValue, int, error) { var v WindowsByCallerValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // Artifact is one published thing, as every registry event and answer names it. @@ -182,6 +184,8 @@ type Hold struct { By string `json:"by,omitempty"` // the digest Digest string `json:"digest"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the module holding the seat Holder string `json:"holder"` // the name @@ -216,6 +220,8 @@ type Outcome struct { Digest string `json:"digest"` // the build's fingerprint Fingerprint string `json:"fingerprint,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the module holding the seat that said it Holder string `json:"holder"` // what it is @@ -296,6 +302,8 @@ const ( // PublishAnswer is what publish answers. type PublishAnswer struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the digest is held already: nothing to send; the outcome follows as an event Held bool `json:"held,omitempty"` // the digests of the parts the holder lacks, to send by publish-part @@ -322,6 +330,8 @@ type PublishPartInput struct { type PublishPartAnswer struct { // the part is whole and its bytes match its digest Complete bool `json:"complete,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the part Part string `json:"part"` // the chunks of the part held so far @@ -340,6 +350,8 @@ type VersionsInput struct { // VersionsAnswer is what versions answers. type VersionsAnswer struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the name Name string `json:"name"` // newest first @@ -369,6 +381,8 @@ const ( // RemoveAnswer is what remove answers. type RemoveAnswer struct { Artifact *Artifact `json:"artifact,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // it stays whole, its tag and its bytes: the store cannot remove the tag alone while another tag names its digest (reason, tags) Kept bool `json:"kept,omitempty"` // why it was kept: shared-digest, another tag names its digest @@ -398,6 +412,8 @@ type MirrorInput struct { type MirrorAnswer struct { // the digest stored Digest string `json:"digest"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the reference the seat answers Reference string `json:"reference"` } @@ -418,6 +434,8 @@ type TagsAnswerTagsItem struct { // TagsAnswer is what tags answers. type TagsAnswer struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the image Name string `json:"name"` // every tag @@ -436,6 +454,8 @@ type HoldInput struct { // HoldAnswer is what hold answers. type HoldAnswer struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // it is held Held bool `json:"held"` // when the hold began, RFC 3339 @@ -454,6 +474,8 @@ type ReleaseInput struct { // ReleaseAnswer is what release answers. type ReleaseAnswer struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // a hold was let go; false when there was none Released bool `json:"released"` } @@ -466,6 +488,8 @@ type ListInput struct { // ListAnswer is what list answers. type ListAnswer struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // each repository named, in order of its name Repositories []Repository `json:"repositories"` } @@ -492,9 +516,11 @@ type ReleasedEvent = Hold type HoldsBySeatNameDigestValue struct { By string `json:"by"` Digest string `json:"digest"` - Kind string `json:"kind"` - Name string `json:"name"` - Seat string `json:"seat"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` + Kind string `json:"kind"` + Name string `json:"name"` + Seat string `json:"seat"` // when (RFC 3339 time) Since string `json:"since"` Why string `json:"why,omitempty"` @@ -515,6 +541,8 @@ type WindowsByCallerValue struct { Closed string `json:"closed,omitempty"` // retired nodes dropped by hand Dropped []WindowsByCallerValueDroppedItem `json:"dropped,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the nodes holding it open Holding []string `json:"holding,omitempty"` LastHolding []string `json:"last_holding,omitempty"` @@ -526,3 +554,149 @@ type WindowsByCallerValue struct { // of each node holding the window, why it holds it Why map[string]string `json:"why,omitempty"` } + +// DecodePublishAnswer reads a PublishAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePublishAnswer(raw []byte) (PublishAnswer, int, error) { + var v PublishAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodePublishPartAnswer reads a PublishPartAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePublishPartAnswer(raw []byte) (PublishPartAnswer, int, error) { + var v PublishPartAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeVersionsAnswer reads a VersionsAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeVersionsAnswer(raw []byte) (VersionsAnswer, int, error) { + var v VersionsAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeRemoveAnswer reads a RemoveAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeRemoveAnswer(raw []byte) (RemoveAnswer, int, error) { + var v RemoveAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeMirrorAnswer reads a MirrorAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeMirrorAnswer(raw []byte) (MirrorAnswer, int, error) { + var v MirrorAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeTagsAnswer reads a TagsAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeTagsAnswer(raw []byte) (TagsAnswer, int, error) { + var v TagsAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeHoldAnswer reads a HoldAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeHoldAnswer(raw []byte) (HoldAnswer, int, error) { + var v HoldAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeReleaseAnswer reads a ReleaseAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeReleaseAnswer(raw []byte) (ReleaseAnswer, int, error) { + var v ReleaseAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeListAnswer reads a ListAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeListAnswer(raw []byte) (ListAnswer, int, error) { + var v ListAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodePublishedEvent reads a PublishedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePublishedEvent(raw []byte) (PublishedEvent, int, error) { + var v PublishedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeRefusedEvent reads a RefusedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeRefusedEvent(raw []byte) (RefusedEvent, int, error) { + var v RefusedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeRemovedEvent reads a RemovedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeRemovedEvent(raw []byte) (RemovedEvent, int, error) { + var v RemovedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeKeptEvent reads a KeptEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeKeptEvent(raw []byte) (KeptEvent, int, error) { + var v KeptEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeHeldEvent reads a HeldEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeHeldEvent(raw []byte) (HeldEvent, int, error) { + var v HeldEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeReleasedEvent reads a ReleasedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeReleasedEvent(raw []byte) (ReleasedEvent, int, error) { + var v ReleasedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// formRead is the form a value says on the wire: 1 when it says none, or is no object. +func formRead(raw []byte) int { + var f struct { + Form int `json:"form"` + } + if json.Unmarshal(raw, &f) != nil || f.Form < 1 { + return 1 + } + return f.Form +} diff --git a/modules/mesh-delivery-contracts/go/seats/git/contract.go b/modules/mesh-delivery-contracts/go/seats/git/contract.go index e5ba278d1..60fe8348a 100644 --- a/modules/mesh-delivery-contracts/go/seats/git/contract.go +++ b/modules/mesh-delivery-contracts/go/seats/git/contract.go @@ -4,9 +4,7 @@ package git import ( - "bytes" "encoding/json" - "errors" "strings" "time" ) @@ -14,6 +12,17 @@ import ( // Seat is the seat's name. const Seat = "git" +// Form is the form of the seat's values, events and answers this contract was generated at (design 47 H2 §780): +// a reader of a value of another form says "form N, this reader knows M". +const Form = 1 + +// The forms and the digest of the fields this contract was generated from: the generator's compare fails a definition +// whose fields changed while its forms did not (design 47 H2 §780). +const ( + generatedForms = "1" + generatedFieldsDigest = "76d91e80e3c40c239af4ab4ea133e72f3757b17fbbf98452cb53cbe15f343a57" +) + const ( VerbPull = "pull" VerbBranch = "branch" @@ -129,18 +138,13 @@ func ParseFailedStepsByModuleFingerprintStepKey(key string) (string, string, str return v0, v2, v4, true } -// DecodeFailedStepsByModuleFingerprintStepValue reads one value of the state failed-steps under the form "..", refusing a field FailedStepsByModuleFingerprintStepValue does not know and any text after the value. -func DecodeFailedStepsByModuleFingerprintStepValue(raw []byte) (FailedStepsByModuleFingerprintStepValue, error) { +// DecodeFailedStepsByModuleFingerprintStepValue reads one value of the state failed-steps under the form ".." as another part wrote it: a field FailedStepsByModuleFingerprintStepValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeFailedStepsByModuleFingerprintStepValue(raw []byte) (FailedStepsByModuleFingerprintStepValue, int, error) { var v FailedStepsByModuleFingerprintStepValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // CallsByCallCallKey is the key of one value of the state calls under the form "call.". @@ -164,18 +168,13 @@ func ParseCallsByCallCallKey(key string) (string, bool) { return v1, true } -// DecodeCallsByCallCallValue reads one value of the state calls under the form "call.", refusing a field CallsByCallCallValue does not know and any text after the value. -func DecodeCallsByCallCallValue(raw []byte) (CallsByCallCallValue, error) { +// DecodeCallsByCallCallValue reads one value of the state calls under the form "call." as another part wrote it: a field CallsByCallCallValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeCallsByCallCallValue(raw []byte) (CallsByCallCallValue, int, error) { var v CallsByCallCallValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // Call is one merge call, written before its first merge and updated as each member merges (design 47 H §766). @@ -184,7 +183,9 @@ type Call struct { Account string `json:"account"` At time.Time `json:"at"` // the caller as who@node - By string `json:"by"` + By string `json:"by"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` Members []CallMember `json:"members"` // merge-called was said for it Said bool `json:"said"` @@ -242,7 +243,9 @@ type FailedStep struct { Commits []string `json:"commits"` // the build-input fingerprint the step failed at Fingerprint string `json:"fingerprint"` - Module string `json:"module"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` + Module string `json:"module"` // the run that failed it: the runner's pipeline key Run string `json:"run"` // why it failed, as the runner's step-ended said @@ -369,6 +372,8 @@ type MergeCalled struct { By string `json:"by"` // the merge call, 16 lowercase hex characters made once per call Call string `json:"call"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // one per landed member Members []MergeCalledMembersItem `json:"members"` // one per member not merged after every member was judged (design 47 H §767) @@ -390,8 +395,10 @@ type PullAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` - Merging *Merging `json:"merging,omitempty"` - Pull *Pull `json:"pull,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` + Merging *Merging `json:"merging,omitempty"` + Pull *Pull `json:"pull,omitempty"` } // BranchInput is what branch takes. @@ -407,6 +414,8 @@ type BranchAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // a commit, its full 40-hex sha Head string `json:"head,omitempty"` Repository string `json:"repository,omitempty"` @@ -421,6 +430,8 @@ type OpenPullsAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // every open pull request; said empty when none is open, so an answer that lacks it is never read as none Pulls []OpenPull `json:"pulls"` } @@ -442,6 +453,8 @@ type TagsAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // another page exists More bool `json:"more,omitempty"` // the page @@ -473,6 +486,8 @@ type TreesAnswer struct { ErrorKind ErrorKind `json:"error-kind,omitempty"` // directory to {path: blob id} Files map[string]map[string]string `json:"files,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // directory to {path: object id} Paths map[string]map[string]string `json:"paths,omitempty"` // the root tree's hash @@ -502,6 +517,8 @@ type FileAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the path Path string `json:"path,omitempty"` // what was read @@ -531,6 +548,8 @@ type ContainsAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the other In string `json:"in,omitempty"` } @@ -552,6 +571,8 @@ type StatusesAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the newest of each context Statuses []Status `json:"statuses,omitempty"` } @@ -588,6 +609,8 @@ type StatusAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the id was already held on the pull request or the note, so nothing was done again Held bool `json:"held,omitempty"` // the act's id, as the caller gave it @@ -613,6 +636,8 @@ type CommentAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the id was already held on the pull request or the note, so nothing was done again Held bool `json:"held,omitempty"` // the act's id, as the caller gave it @@ -638,6 +663,8 @@ type ViewAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the id was already held on the pull request or the note, so nothing was done again Held bool `json:"held,omitempty"` // the act's id, as the caller gave it @@ -663,6 +690,8 @@ type NoteAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the id was already held on the pull request or the note, so nothing was done again Held bool `json:"held,omitempty"` // the act's id, as the caller gave it @@ -696,6 +725,8 @@ type MergePullAnswer struct { // why the forge could not answer, or refused: set alone with error-kind, and a caller reads it as a failure, never as none Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // each member's outcome, in the order named Members []MemberOutcome `json:"members,omitempty"` } @@ -715,6 +746,8 @@ type TagAnswer struct { // why the forge could not write it: set alone with error-kind Error string `json:"error,omitempty"` ErrorKind ErrorKind `json:"error-kind,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the forge holds the tag at that commit now Performed bool `json:"performed,omitempty"` // the tag, as asked @@ -732,6 +765,8 @@ type PullUpdatedEvent struct { // its head branch Branch string `json:"branch"` Change *Change `json:"change,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // a commit, its full 40-hex sha Head string `json:"head"` // the pull request's number @@ -753,6 +788,8 @@ type PullMergedEvent struct { // its head branch Branch string `json:"branch"` Change *Change `json:"change,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // a commit, its full 40-hex sha Head string `json:"head"` // the head's statuses by context, their states; absent when they could not be read @@ -779,6 +816,8 @@ type PullClosedEvent struct { Base string `json:"base"` // its head branch Branch string `json:"branch"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // a commit, its full 40-hex sha Head string `json:"head"` // the pull request's number @@ -801,6 +840,8 @@ type ForgePullEvent struct { Base string `json:"base,omitempty"` // its head branch Branch string `json:"branch,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // its head commit Head string `json:"head,omitempty"` // the merge commit @@ -823,6 +864,8 @@ type ForgeStatusEvent struct { Context string `json:"context"` // what it says Description string `json:"description,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the repository, / Repository string `json:"repository"` // who set it @@ -833,6 +876,8 @@ type ForgeStatusEvent struct { // ForgeDeleteEvent is the body of the event forge-delete. type ForgeDeleteEvent struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the deleted branch or tag Ref string `json:"ref"` // branch or tag @@ -847,6 +892,8 @@ type ForgeDeleteEvent struct { type RepoWritableEvent struct { // the account that writes it now Account string `json:"account"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the repository, / Repository string `json:"repository"` } @@ -855,6 +902,8 @@ type RepoWritableEvent struct { type BranchMovedEvent struct { At *time.Time `json:"at,omitempty"` Branch string `json:"branch"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the head the webhook said, a commit's full 40-hex sha; read again by branch Head string `json:"head,omitempty"` // the repository, / @@ -869,3 +918,221 @@ type FailedStepsByModuleFingerprintStepValue = FailedStep // CallsByCallCallValue is one value of the state calls under the key call.. type CallsByCallCallValue = Call + +// DecodePullAnswer reads a PullAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePullAnswer(raw []byte) (PullAnswer, int, error) { + var v PullAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeBranchAnswer reads a BranchAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeBranchAnswer(raw []byte) (BranchAnswer, int, error) { + var v BranchAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeOpenPullsAnswer reads a OpenPullsAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeOpenPullsAnswer(raw []byte) (OpenPullsAnswer, int, error) { + var v OpenPullsAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeTagsAnswer reads a TagsAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeTagsAnswer(raw []byte) (TagsAnswer, int, error) { + var v TagsAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeTreesAnswer reads a TreesAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeTreesAnswer(raw []byte) (TreesAnswer, int, error) { + var v TreesAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeFileAnswer reads a FileAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeFileAnswer(raw []byte) (FileAnswer, int, error) { + var v FileAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeContainsAnswer reads a ContainsAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeContainsAnswer(raw []byte) (ContainsAnswer, int, error) { + var v ContainsAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeStatusesAnswer reads a StatusesAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeStatusesAnswer(raw []byte) (StatusesAnswer, int, error) { + var v StatusesAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeStatusAnswer reads a StatusAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeStatusAnswer(raw []byte) (StatusAnswer, int, error) { + var v StatusAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeCommentAnswer reads a CommentAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeCommentAnswer(raw []byte) (CommentAnswer, int, error) { + var v CommentAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeViewAnswer reads a ViewAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeViewAnswer(raw []byte) (ViewAnswer, int, error) { + var v ViewAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeNoteAnswer reads a NoteAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeNoteAnswer(raw []byte) (NoteAnswer, int, error) { + var v NoteAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeMergePullAnswer reads a MergePullAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeMergePullAnswer(raw []byte) (MergePullAnswer, int, error) { + var v MergePullAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeTagAnswer reads a TagAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeTagAnswer(raw []byte) (TagAnswer, int, error) { + var v TagAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodePullUpdatedEvent reads a PullUpdatedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePullUpdatedEvent(raw []byte) (PullUpdatedEvent, int, error) { + var v PullUpdatedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodePullMergedEvent reads a PullMergedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePullMergedEvent(raw []byte) (PullMergedEvent, int, error) { + var v PullMergedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodePullClosedEvent reads a PullClosedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePullClosedEvent(raw []byte) (PullClosedEvent, int, error) { + var v PullClosedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeForgePullEvent reads a ForgePullEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeForgePullEvent(raw []byte) (ForgePullEvent, int, error) { + var v ForgePullEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeForgeStatusEvent reads a ForgeStatusEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeForgeStatusEvent(raw []byte) (ForgeStatusEvent, int, error) { + var v ForgeStatusEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeForgeDeleteEvent reads a ForgeDeleteEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeForgeDeleteEvent(raw []byte) (ForgeDeleteEvent, int, error) { + var v ForgeDeleteEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeRepoWritableEvent reads a RepoWritableEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeRepoWritableEvent(raw []byte) (RepoWritableEvent, int, error) { + var v RepoWritableEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeBranchMovedEvent reads a BranchMovedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeBranchMovedEvent(raw []byte) (BranchMovedEvent, int, error) { + var v BranchMovedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeMergeCalledEvent reads a MergeCalledEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeMergeCalledEvent(raw []byte) (MergeCalledEvent, int, error) { + var v MergeCalledEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// formRead is the form a value says on the wire: 1 when it says none, or is no object. +func formRead(raw []byte) int { + var f struct { + Form int `json:"form"` + } + if json.Unmarshal(raw, &f) != nil || f.Form < 1 { + return 1 + } + return f.Form +} diff --git a/modules/mesh-delivery-contracts/go/seats/gopackageregistry/contract.go b/modules/mesh-delivery-contracts/go/seats/gopackageregistry/contract.go index eb534618a..9329709ff 100644 --- a/modules/mesh-delivery-contracts/go/seats/gopackageregistry/contract.go +++ b/modules/mesh-delivery-contracts/go/seats/gopackageregistry/contract.go @@ -3,9 +3,27 @@ // Package gopackageregistry is the contract of the seat "go-package-registry", defined whole (seats/go-package-registry/seat.json): The mesh's Go modules: Go's module proxy protocol's read side, and publishing over the bus. package gopackageregistry +import ( + "encoding/json" +) + // Seat is the seat's name. const Seat = "go-package-registry" +// Form is the form of the seat's values, events and answers this contract was generated at (design 47 H2 §780): +// a reader of a value of another form says "form N, this reader knows M". +const Form = 1 + +// FormRegistry is the form of what the part registry adds. +const FormRegistry = 1 + +// The forms and the digest of the fields this contract was generated from: the generator's compare fails a definition +// whose fields changed while its forms did not (design 47 H2 §780). +const ( + generatedForms = "1 registry:1" + generatedFieldsDigest = "b80afb127966ec05c9c822eab0ab43488e6ee0a9d0f43cb1334e4fa32f07bb35" +) + const ( VerbPublish = "publish" VerbPublishPart = "publish-part" @@ -83,6 +101,8 @@ type Outcome struct { Digest string `json:"digest"` // the build's fingerprint Fingerprint string `json:"fingerprint,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the module holding the seat that said it Holder string `json:"holder"` // what it is @@ -155,6 +175,8 @@ const ( // PublishAnswer is what publish answers. type PublishAnswer struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the digest is held already: nothing to send; the outcome follows as an event Held bool `json:"held,omitempty"` // the digests of the parts the holder lacks, to send by publish-part @@ -181,6 +203,8 @@ type PublishPartInput struct { type PublishPartAnswer struct { // the part is whole and its bytes match its digest Complete bool `json:"complete,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the part Part string `json:"part"` // the chunks of the part held so far @@ -199,6 +223,8 @@ type VersionsInput struct { // VersionsAnswer is what versions answers. type VersionsAnswer struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the name Name string `json:"name"` // newest first @@ -228,6 +254,8 @@ const ( // RemoveAnswer is what remove answers. type RemoveAnswer struct { Artifact *Artifact `json:"artifact,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // it stays whole, its tag and its bytes: the store cannot remove the tag alone while another tag names its digest (reason, tags) Kept bool `json:"kept,omitempty"` // why it was kept: shared-digest, another tag names its digest @@ -260,3 +288,86 @@ type GoPackageRegistryForm struct { // the read side's address URL string `json:"url"` } + +// DecodePublishAnswer reads a PublishAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePublishAnswer(raw []byte) (PublishAnswer, int, error) { + var v PublishAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodePublishPartAnswer reads a PublishPartAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePublishPartAnswer(raw []byte) (PublishPartAnswer, int, error) { + var v PublishPartAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeVersionsAnswer reads a VersionsAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeVersionsAnswer(raw []byte) (VersionsAnswer, int, error) { + var v VersionsAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeRemoveAnswer reads a RemoveAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeRemoveAnswer(raw []byte) (RemoveAnswer, int, error) { + var v RemoveAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodePublishedEvent reads a PublishedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePublishedEvent(raw []byte) (PublishedEvent, int, error) { + var v PublishedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeRefusedEvent reads a RefusedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeRefusedEvent(raw []byte) (RefusedEvent, int, error) { + var v RefusedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeRemovedEvent reads a RemovedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeRemovedEvent(raw []byte) (RemovedEvent, int, error) { + var v RemovedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeKeptEvent reads a KeptEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeKeptEvent(raw []byte) (KeptEvent, int, error) { + var v KeptEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// formRead is the form a value says on the wire: 1 when it says none, or is no object. +func formRead(raw []byte) int { + var f struct { + Form int `json:"form"` + } + if json.Unmarshal(raw, &f) != nil || f.Form < 1 { + return 1 + } + return f.Form +} diff --git a/modules/mesh-delivery-contracts/go/seats/meshartifactsweep/contract.go b/modules/mesh-delivery-contracts/go/seats/meshartifactsweep/contract.go index 8aa87d219..928422ba8 100644 --- a/modules/mesh-delivery-contracts/go/seats/meshartifactsweep/contract.go +++ b/modules/mesh-delivery-contracts/go/seats/meshartifactsweep/contract.go @@ -3,11 +3,25 @@ // Package meshartifactsweep is the contract of the seat "mesh-artifact-sweep", defined whole (seats/mesh-artifact-sweep/seat.json): no description. package meshartifactsweep -import "time" +import ( + "encoding/json" + "time" +) // Seat is the seat's name. const Seat = "mesh-artifact-sweep" +// Form is the form of the seat's values, events and answers this contract was generated at (design 47 H2 §780): +// a reader of a value of another form says "form N, this reader knows M". +const Form = 1 + +// The forms and the digest of the fields this contract was generated from: the generator's compare fails a definition +// whose fields changed while its forms did not (design 47 H2 §780). +const ( + generatedForms = "1" + generatedFieldsDigest = "15ff15679b43316c05f50583f7ed5e367eac2ba26003374b05a94f5107857a92" +) + const ( VerbArtifacts = "artifacts" VerbHeld = "held" @@ -47,6 +61,8 @@ type ArtifactsGone struct { Event string `json:"event"` // the key's fingerprint Fingerprint string `json:"fingerprint"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // every reference of the key the store does not hold, sorted Gone []string `json:"gone"` // the builder's done key @@ -80,6 +96,8 @@ type HeldInput struct { // HeldAnswer is what held answers. type HeldAnswer struct { + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the references the store answered 404 for Gone []string `json:"gone"` // the references the store holds @@ -127,3 +145,68 @@ type ImagesAnswer = map[string]any // ArtifactsGoneEvent is the body of the event artifacts-gone. type ArtifactsGoneEvent = ArtifactsGone + +// DecodeArtifactsAnswer reads a ArtifactsAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeArtifactsAnswer(raw []byte) (ArtifactsAnswer, int, error) { + var v ArtifactsAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeHeldAnswer reads a HeldAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeHeldAnswer(raw []byte) (HeldAnswer, int, error) { + var v HeldAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeCollectAnswer reads a CollectAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeCollectAnswer(raw []byte) (CollectAnswer, int, error) { + var v CollectAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeMirrorsAnswer reads a MirrorsAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeMirrorsAnswer(raw []byte) (MirrorsAnswer, int, error) { + var v MirrorsAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeImagesAnswer reads a ImagesAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeImagesAnswer(raw []byte) (ImagesAnswer, int, error) { + var v ImagesAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeArtifactsGoneEvent reads a ArtifactsGoneEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeArtifactsGoneEvent(raw []byte) (ArtifactsGoneEvent, int, error) { + var v ArtifactsGoneEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// formRead is the form a value says on the wire: 1 when it says none, or is no object. +func formRead(raw []byte) int { + var f struct { + Form int `json:"form"` + } + if json.Unmarshal(raw, &f) != nil || f.Form < 1 { + return 1 + } + return f.Form +} diff --git a/modules/mesh-delivery-contracts/go/seats/meshbuilds/contract.go b/modules/mesh-delivery-contracts/go/seats/meshbuilds/contract.go index 10c632d2d..009dd68f4 100644 --- a/modules/mesh-delivery-contracts/go/seats/meshbuilds/contract.go +++ b/modules/mesh-delivery-contracts/go/seats/meshbuilds/contract.go @@ -3,11 +3,25 @@ // Package meshbuilds is the contract of the seat "mesh-builds", defined whole (seats/mesh-builds/seat.json): The builder's seat: it says each artifact it published and each agreed toolchain, and answers a module's reserved version. Held once for the mesh (design 47 G section 52, section 307). package meshbuilds -import "time" +import ( + "encoding/json" + "time" +) // Seat is the seat's name. const Seat = "mesh-builds" +// Form is the form of the seat's values, events and answers this contract was generated at (design 47 H2 §780): +// a reader of a value of another form says "form N, this reader knows M". +const Form = 1 + +// The forms and the digest of the fields this contract was generated from: the generator's compare fails a definition +// whose fields changed while its forms did not (design 47 H2 §780). +const ( + generatedForms = "1" + generatedFieldsDigest = "4001613559208a0a99ed933d22eefad947365f8bcd6ba091dc4edb5e869d4798" +) + const ( VerbReserved = "reserved" VerbPublished = "published" @@ -94,6 +108,8 @@ type PackagePublished struct { Dependencies []Dependency `json:"dependencies,omitempty"` // the published artifact's digest Digest string `json:"digest"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the module Module string `json:"module"` // the catalog revision number of that branch the build was made from, the indexer's count (design 47 H-A-218, H-A-220); absent from a reservation made before the field @@ -112,6 +128,8 @@ type StepEnded struct { Ended *time.Time `json:"ended,omitempty"` // each entry the step built, by module and fingerprint Entries []BuildEntry `json:"entries"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the ask's id ID string `json:"id"` // the node the builder ran it on, as in the subject @@ -180,6 +198,8 @@ type ToolchainAgreed struct { At *time.Time `json:"at,omitempty"` // each digest the nodes reporting the agreed version report, as it stood when the version was agreed, with those nodes (design 47 G section 472, section 495) Digests []ToolchainAgreedDigestsItem `json:"digests"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the language whose agreed toolchain changed Language string `json:"language"` V int64 `json:"v"` @@ -210,6 +230,8 @@ type ReservedAnswer struct { Artifacts []ReservedAnswerArtifactsItem `json:"artifacts,omitempty"` // a name no entry carries, or a version neither reserved nor released, naming which; set alone (design 47 G 582, 679) Error string `json:"error,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // the module Module string `json:"module,omitempty"` // true when the version is released: the catalog holds it, and artifacts are the ones its release recorded with their digests; false when it is reserved (design 47 G 582, 679) @@ -234,6 +256,8 @@ type PublishedAnswer struct { At *time.Time `json:"at,omitempty"` // the published artifact's digest, when published; absent for a release kept before the digest was kept (design 47 H-A-331) Digest string `json:"digest,omitempty"` + // is the form of what this value carries, left out while it is 1 (design 47 H2 §780). + Form int64 `json:"form,omitempty"` // true when the artifact built at the fingerprint is published; a number a take-over withdrew is never published (design 47 H-A-331) Published bool `json:"published"` // the version it is published at, MAJOR.MINOR.PATCH, when published @@ -251,3 +275,59 @@ type ToolchainAgreedEvent = ToolchainAgreed // StepEndedEvent is the body of the event step-ended. type StepEndedEvent = StepEnded + +// DecodeReservedAnswer reads a ReservedAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeReservedAnswer(raw []byte) (ReservedAnswer, int, error) { + var v ReservedAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodePublishedAnswer reads a PublishedAnswer as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePublishedAnswer(raw []byte) (PublishedAnswer, int, error) { + var v PublishedAnswer + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodePackagePublishedEvent reads a PackagePublishedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePackagePublishedEvent(raw []byte) (PackagePublishedEvent, int, error) { + var v PackagePublishedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeToolchainAgreedEvent reads a ToolchainAgreedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeToolchainAgreedEvent(raw []byte) (ToolchainAgreedEvent, int, error) { + var v ToolchainAgreedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// DecodeStepEndedEvent reads a StepEndedEvent as another part wrote it: a field this reader does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeStepEndedEvent(raw []byte) (StepEndedEvent, int, error) { + var v StepEndedEvent + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err + } + return v, formRead(raw), nil +} + +// formRead is the form a value says on the wire: 1 when it says none, or is no object. +func formRead(raw []byte) int { + var f struct { + Form int `json:"form"` + } + if json.Unmarshal(raw, &f) != nil || f.Form < 1 { + return 1 + } + return f.Form +} diff --git a/modules/mesh-delivery-contracts/go/seats/meshcatalog/contract.go b/modules/mesh-delivery-contracts/go/seats/meshcatalog/contract.go index 1ad5e63d5..1c98e0ade 100644 --- a/modules/mesh-delivery-contracts/go/seats/meshcatalog/contract.go +++ b/modules/mesh-delivery-contracts/go/seats/meshcatalog/contract.go @@ -4,9 +4,7 @@ package meshcatalog import ( - "bytes" "encoding/json" - "errors" "strings" "time" ) @@ -14,6 +12,17 @@ import ( // Seat is the seat's name. const Seat = "mesh-catalog" +// Form is the form of the seat's values, events and answers this contract was generated at (design 47 H2 §780): +// a reader of a value of another form says "form N, this reader knows M". +const Form = 1 + +// The forms and the digest of the fields this contract was generated from: the generator's compare fails a definition +// whose fields changed while its forms did not (design 47 H2 §780). +const ( + generatedForms = "1" + generatedFieldsDigest = "5a5f6106fe9ee419cc10e40c34f4e901b9ee9215033079381243d04d898e5c7c" +) + const ( VerbModules = "modules" VerbModule = "module" @@ -132,18 +141,13 @@ func ParseManifestsByDigestKey(key string) (string, bool) { return v0, true } -// DecodeManifestsByDigestValue reads one value of the state manifests under the form "", refusing a field ManifestsByDigestValue does not know and any text after the value. -func DecodeManifestsByDigestValue(raw []byte) (ManifestsByDigestValue, error) { +// DecodeManifestsByDigestValue reads one value of the state manifests under the form "" as another part wrote it: a field ManifestsByDigestValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeManifestsByDigestValue(raw []byte) (ManifestsByDigestValue, int, error) { var v ManifestsByDigestValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // ModulesByModuleKey is the key of one value of the state modules under the form "". @@ -163,18 +167,13 @@ func ParseModulesByModuleKey(key string) (string, bool) { return v0, true } -// DecodeModulesByModuleValue reads one value of the state modules under the form "", refusing a field ModulesByModuleValue does not know and any text after the value. -func DecodeModulesByModuleValue(raw []byte) (ModulesByModuleValue, error) { +// DecodeModulesByModuleValue reads one value of the state modules under the form "" as another part wrote it: a field ModulesByModuleValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeModulesByModuleValue(raw []byte) (ModulesByModuleValue, int, error) { var v ModulesByModuleValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // CandidatesByGroupKey is the key of one value of the state candidates under the form "". @@ -194,18 +193,13 @@ func ParseCandidatesByGroupKey(key string) (string, bool) { return v0, true } -// DecodeCandidatesByGroupValue reads one value of the state candidates under the form "", refusing a field CandidatesByGroupValue does not know and any text after the value. -func DecodeCandidatesByGroupValue(raw []byte) (CandidatesByGroupValue, error) { +// DecodeCandidatesByGroupValue reads one value of the state candidates under the form "" as another part wrote it: a field CandidatesByGroupValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeCandidatesByGroupValue(raw []byte) (CandidatesByGroupValue, int, error) { var v CandidatesByGroupValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // PredefinedByListKey is the key of one value of the state predefined under the form "list". @@ -224,18 +218,13 @@ func ParsePredefinedByListKey(key string) bool { return true } -// DecodePredefinedByListValue reads one value of the state predefined under the form "list", refusing a field PredefinedByListValue does not know and any text after the value. -func DecodePredefinedByListValue(raw []byte) (PredefinedByListValue, error) { +// DecodePredefinedByListValue reads one value of the state predefined under the form "list" as another part wrote it: a field PredefinedByListValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePredefinedByListValue(raw []byte) (PredefinedByListValue, int, error) { var v PredefinedByListValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // PackagesByModuleKey is the key of one value of the state packages under the form "". @@ -255,18 +244,13 @@ func ParsePackagesByModuleKey(key string) (string, bool) { return v0, true } -// DecodePackagesByModuleValue reads one value of the state packages under the form "", refusing a field PackagesByModuleValue does not know and any text after the value. -func DecodePackagesByModuleValue(raw []byte) (PackagesByModuleValue, error) { +// DecodePackagesByModuleValue reads one value of the state packages under the form "" as another part wrote it: a field PackagesByModuleValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePackagesByModuleValue(raw []byte) (PackagesByModuleValue, int, error) { var v PackagesByModuleValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // PackagesByPackageSeriesKey is the key of one value of the state packages under the form ".". @@ -291,18 +275,13 @@ func ParsePackagesByPackageSeriesKey(key string) (string, string, bool) { return v0, v2, true } -// DecodePackagesByPackageSeriesValue reads one value of the state packages under the form ".", refusing a field PackagesByPackageSeriesValue does not know and any text after the value. -func DecodePackagesByPackageSeriesValue(raw []byte) (PackagesByPackageSeriesValue, error) { +// DecodePackagesByPackageSeriesValue reads one value of the state packages under the form "." as another part wrote it: a field PackagesByPackageSeriesValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodePackagesByPackageSeriesValue(raw []byte) (PackagesByPackageSeriesValue, int, error) { var v PackagesByPackageSeriesValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // CatalogRevisionsByBranchRevisionKey is the key of one value of the state catalog-revisions under the form ".". @@ -329,18 +308,13 @@ func ParseCatalogRevisionsByBranchRevisionKey(key string) (string, string, bool) return v0, v2, true } -// DecodeCatalogRevisionsByBranchRevisionValue reads one value of the state catalog-revisions under the form ".", refusing a field CatalogRevisionsByBranchRevisionValue does not know and any text after the value. -func DecodeCatalogRevisionsByBranchRevisionValue(raw []byte) (CatalogRevisionsByBranchRevisionValue, error) { +// DecodeCatalogRevisionsByBranchRevisionValue reads one value of the state catalog-revisions under the form "." as another part wrote it: a field CatalogRevisionsByBranchRevisionValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeCatalogRevisionsByBranchRevisionValue(raw []byte) (CatalogRevisionsByBranchRevisionValue, int, error) { var v CatalogRevisionsByBranchRevisionValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // CatalogRevisionsByCandidateGroupHeadsKey is the key of one value of the state catalog-revisions under the form "candidate..". @@ -371,18 +345,13 @@ func ParseCatalogRevisionsByCandidateGroupHeadsKey(key string) (string, string, return v1, v3, true } -// DecodeCatalogRevisionsByCandidateGroupHeadsValue reads one value of the state catalog-revisions under the form "candidate..", refusing a field CatalogRevisionsByCandidateGroupHeadsValue does not know and any text after the value. -func DecodeCatalogRevisionsByCandidateGroupHeadsValue(raw []byte) (CatalogRevisionsByCandidateGroupHeadsValue, error) { +// DecodeCatalogRevisionsByCandidateGroupHeadsValue reads one value of the state catalog-revisions under the form "candidate.." as another part wrote it: a field CatalogRevisionsByCandidateGroupHeadsValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeCatalogRevisionsByCandidateGroupHeadsValue(raw []byte) (CatalogRevisionsByCandidateGroupHeadsValue, int, error) { var v CatalogRevisionsByCandidateGroupHeadsValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // CatalogRevisionsByEntryDigestKey is the key of one value of the state catalog-revisions under the form "entry.". @@ -406,18 +375,13 @@ func ParseCatalogRevisionsByEntryDigestKey(key string) (string, bool) { return v1, true } -// DecodeCatalogRevisionsByEntryDigestValue reads one value of the state catalog-revisions under the form "entry.", refusing a field CatalogRevisionsByEntryDigestValue does not know and any text after the value. -func DecodeCatalogRevisionsByEntryDigestValue(raw []byte) (CatalogRevisionsByEntryDigestValue, error) { +// DecodeCatalogRevisionsByEntryDigestValue reads one value of the state catalog-revisions under the form "entry." as another part wrote it: a field CatalogRevisionsByEntryDigestValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeCatalogRevisionsByEntryDigestValue(raw []byte) (CatalogRevisionsByEntryDigestValue, int, error) { var v CatalogRevisionsByEntryDigestValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // RegistrationsByModuleKey is the key of one value of the state registrations under the form "". @@ -437,18 +401,13 @@ func ParseRegistrationsByModuleKey(key string) (string, bool) { return v0, true } -// DecodeRegistrationsByModuleValue reads one value of the state registrations under the form "", refusing a field RegistrationsByModuleValue does not know and any text after the value. -func DecodeRegistrationsByModuleValue(raw []byte) (RegistrationsByModuleValue, error) { +// DecodeRegistrationsByModuleValue reads one value of the state registrations under the form "" as another part wrote it: a field RegistrationsByModuleValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeRegistrationsByModuleValue(raw []byte) (RegistrationsByModuleValue, int, error) { var v RegistrationsByModuleValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // RegistrationHistoryByModuleVersionKey is the key of one value of the state registration-history under the form ".". @@ -475,18 +434,13 @@ func ParseRegistrationHistoryByModuleVersionKey(key string) (string, string, boo return v0, v2, true } -// DecodeRegistrationHistoryByModuleVersionValue reads one value of the state registration-history under the form ".", refusing a field RegistrationHistoryByModuleVersionValue does not know and any text after the value. -func DecodeRegistrationHistoryByModuleVersionValue(raw []byte) (RegistrationHistoryByModuleVersionValue, error) { +// DecodeRegistrationHistoryByModuleVersionValue reads one value of the state registration-history under the form "." as another part wrote it: a field RegistrationHistoryByModuleVersionValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeRegistrationHistoryByModuleVersionValue(raw []byte) (RegistrationHistoryByModuleVersionValue, int, error) { var v RegistrationHistoryByModuleVersionValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // VersionsByModuleVersionKey is the key of one value of the state versions under the form ".". @@ -511,18 +465,13 @@ func ParseVersionsByModuleVersionKey(key string) (string, string, bool) { return v0, v2, true } -// DecodeVersionsByModuleVersionValue reads one value of the state versions under the form ".", refusing a field VersionsByModuleVersionValue does not know and any text after the value. -func DecodeVersionsByModuleVersionValue(raw []byte) (VersionsByModuleVersionValue, error) { +// DecodeVersionsByModuleVersionValue reads one value of the state versions under the form "." as another part wrote it: a field VersionsByModuleVersionValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeVersionsByModuleVersionValue(raw []byte) (VersionsByModuleVersionValue, int, error) { var v VersionsByModuleVersionValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // BuildEdgesByModuleBranchKey is the key of one value of the state build-edges under the form ".". @@ -547,18 +496,13 @@ func ParseBuildEdgesByModuleBranchKey(key string) (string, string, bool) { return v0, v2, true } -// DecodeBuildEdgesByModuleBranchValue reads one value of the state build-edges under the form ".", refusing a field BuildEdgesByModuleBranchValue does not know and any text after the value. -func DecodeBuildEdgesByModuleBranchValue(raw []byte) (BuildEdgesByModuleBranchValue, error) { +// DecodeBuildEdgesByModuleBranchValue reads one value of the state build-edges under the form "." as another part wrote it: a field BuildEdgesByModuleBranchValue does not know is left unread, never refused; the form read is answered, 1 when absent (design 47 H2 §780). +func DecodeBuildEdgesByModuleBranchValue(raw []byte) (BuildEdgesByModuleBranchValue, int, error) { var v BuildEdgesByModuleBranchValue - dec := json.NewDecoder(bytes.NewReader(raw)) - dec.DisallowUnknownFields() - if err := dec.Decode(&v); err != nil { - return v, err + if err := json.Unmarshal(raw, &v); err != nil { + return v, 0, err } - if dec.More() { - return v, errors.New("text after the value") - } - return v, nil + return v, formRead(raw), nil } // InputsByTimeDigestKey is the key of one value of the state inputs under the form "