* feat(http): serve list/show counts/dep tree/ping, close+reopen under a session, one-lookup not-found (S6b/S6c/S6d) S6c. The external-dependency decorator rebuilt its role views from the legacy DoltStorage seam (storereader over itself, IsBlocked, GetDependencyTree, ClaimReadyIssue), which a remote store only partly serves: `bd list`/`bd children` refused on the SearchIssuesWithCounts stub, `bd show --json` printed zero counts, the default `bd dep tree` refused, `bd ready --claim` and `bd close` of an externally blocked issue reached unsupported paths. For a storage.RemoteBackendStore each view now passes the inner role through and lays the policy over it in role terms (externaldeps/remote_roles.go): ready reads and the ready claim exclude the workspace-wide blocked set over a widened window; per-issue checks (claim, close, batch close, list annotations, tree leaves) read only the named issues' edges through EdgeReader instead of every edge in the workspace. A server advertising policy.external_dependencies (MC's does) gets a plain passthrough. `bd ping` uses a new storage.Pinger, which the http store answers with its authenticated context read. S6d. A store reporting storage.CallerAttributionLimitedStore (http) cannot carry a Provenance label or a patch's closed_by_session. The library still refuses both; the CLI omits them where nothing is lost: `bd reopen`'s fixed "bd: reopen <id>" label (the server labels the same entry), and the closed_by_session of `bd update -s closed` (attribution only, usually the ambient CLAUDE_SESSION_ID; an explicit --session prints a notice; `bd close` still records it). See cmd/bd/remote_backend.go. S6b. utils.ExactIDLookupStore: the resolver stops at exact lookups for a store with no substring search, so a missing prefixed id is a not-found (beadserrors.ErrNotFound, "no issue found matching") after one getIssue. The general resolver no longer repeats an identical normalized probe. The http SearchIssueIDs answers D11's partial-id refusal, which now unwraps to ErrNotFound. Contributor auto-routing for a remote workspace reads local config only, so the not-found fallback pays no settings round trip. `bd update <absent> --claim` (gc's hook claim) answers a gc-classifiable not-found in at most two requests. Served e2e (backend/http/e2e_remote_roles_test.go): every gc list shape and `bd children` against embedded, `show --json` count parity, default dep tree parity, external blocking still enforced, close/reopen under CLAUDE_SESSION_ID, missing-id request counts, absent-id claim against the current server and the MC handshake mask, policy passthrough under the MC mask, ping. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test(externaldeps): role-level remote reader and claimer cases bd ready and bd update --claim reach the policy through the legacy seam and the lifecycle guard, so the remote Reader.Ready exclusion and the remote Claimer guard (what bd serve and library callers reach) are pinned at the role level with a fake remote store. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * feat(http): bd serve advertises policy.external_dependencies; clients pass through bd serve composes every ready, claim, claim-next, close, blocking and tree role through the external-dependency policy, but never said so. Every client therefore ran the policy a second time, with the CLIENT machine's external-project config, and claim-next became a non-atomic read-then-claim loop on the client. The server now advertises the token exactly when the roles it serves were composed through the policy: httpapi.Config.ExternalDependencyPolicy, which bd serve derives from its actual chain (externaldeps.Applied for the store arm, externaldeps.AppliedToProvider for the provider arm). A server handed raw roles still withholds it, so the token stays truthful. Against a server that advertises it, every remote role view hands the request to the server's own role untouched: no client validation, no edge reads, claim-next is the server's one atomic call, and the ready count is the server's countReadyWork (new remoteReadyCounter). The client-side policy remains only for servers that do not advertise the token. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(create): default created_by to the request's actor in the create role created_by was stamped in two front doors and never in the library: the CLI (creationActorStamp, with a remote-workspace special case) and the three httpapi create handlers. A library caller of Lifecycle.Create or BatchCreator with an empty CreatedBy stored "" locally and the actor over http. PreparePublicCreateRequest, which every create shape prepares through (Lifecycle.Create, BatchCreator items, batch-apply create items), now defaults an empty CreatedBy to request.Actor; an explicit value is kept. The handlers no longer stamp, `bd create` and the state event create pass only the actor, and creationActorStamp/isRemoteBackendWorkspace are gone. The CLI sites that still create through the raw CreateIssue seam (swarm, todo, gate, the create form) keep stamping currentActor(): that seam is shared with import, where defaulting would re-attribute imported rows, and the http store refuses it anyway, so the remote special case was never reachable there. Conformance: the lifecycle-create, batch-creator and batch-apply contracts now pin created_by == actor for an item that names none, on every leg. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(httpclient): GetIssue answers a miss with storage.ErrNotFound, like the local stores The http store's raw GetIssue answered a missing id with (nil, nil), where DoltStore and the embedded store return a wrapped storage.ErrNotFound. A caller written against the backend contract read the http miss as a hit: `bd create --graph` refused every explicit-id plan over http (patched in cmd/bd on feat/http-mc-corpus; that workaround is reverted there). GetIssue now returns the miss (and the empty id) as storage.ErrNotFound, spelled as issueops.GetIssueInTx spells it. GetLabels, which reads through GetIssue, keeps the local read's "no labels" answer for a missing id; the `bd list --parent` walk reads the typed miss as "parent issue not found". The served bridge test now holds the local reference store and the http store to the same miss: ErrNotFound with the same text. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test(createbatchequiv): re-record the apply golden for the created_by default c2866ea7fe made the create role default an empty CreatedBy to the request's actor, so every create item of the apply scenario's batch (actor "apply-writer") now stores created_by "apply-writer" instead of "". TestCreateBatchFastPathsMatchPerRow_*/apply compared the stored rows to a digest recorded before that change and failed on exactly the three tables the column reaches: issues and wisps (the row) and events (the update event's old-value snapshot). Fast and per-row bodies still agree; the batch-apply conformance contract pins the same value. Bisected with bazel: passes at be92efe40f's integ twin 696f7acc8e, fails from the created_by commit on. Only apply.json's three digests move. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * style: gofmt ledger.go and the externaldeps remote-roles test Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(cmd/bd): bd create reads routing settings local-only on a remote backend too determineAutoRoutedRepoPath skipped a remote backend's settings document (routing targets are local paths that one shared document cannot name for every client), but getRoutingConfigValue, which `bd create` and migrate-personal read routing.* and contributor.* through, still asked it. The same workspace could route a create one way and a lookup another, and every create paid a settings round trip per key. Both now go through routingSettingsStore: nil for a remote backend, so routing comes from config.yaml / the environment only there, and a local store is still consulted. A unit test holds both reads to the rule with a store that counts settings reads. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(cmd/bd): say so when update -s closed drops an ambient CLAUDE_SESSION_ID Over http `bd update -s closed` cannot carry closed_by_session, so the CLI drops it rather than refusing the close. An explicit --session printed a notice; the ambient CLAUDE_SESSION_ID every agent under Claude Code exports was dropped without a word, a silent data difference from a local backend (the served corpus's mc-update-meta-status-closed). The drop is now named on stderr in both cases, once per command, pointing at `bd close`, whose wire operation records the session. The served e2e asserts the notice. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test(backend/http): hold bd list --limit 2 to each side's own unlimited order TestE2E_ListWithGCFiltersMatchesEmbedded compared the --limit 2 rows of the served and embedded workspaces as sets. The seed has four P2 rows, so the limit cuts a priority tie whose created_at order differs between two workspaces seeded seconds apart: a test-only flake, the order itself being total. Each side's two rows must now be, in order, the first two of that same side's --limit 0 listing; the unlimited listings are still compared across sides by the shape loop. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test: unit-tier pins for the created_by default, the policy token and the GetIssue miss Three review mutations were caught only by a heavier tier (the uow conformance legs, the served httpclient tier) or by one package's test alone. Each now has a unit test where its rule lives: - issueops: PreparePublicCreateRequest defaults an empty CreatedBy to the actor and keeps an explicit one, without mutating the caller's request. - externaldeps: the policy layer AppliedToProvider finds becomes the handshake's policy.external_dependencies through httpapi.Listen, the composition bd serve performs, and a raw provider's handshake lacks it. - httpclient (no embedded engine): GetIssue over the real wire client against a stub server answers a 404 not_found, and the empty id without dialing, as storage.ErrNotFound spelled like the local stores. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(changelog): S6b/c/d entries match the code The S6 entry still said `bd create` suppresses created_by on a remote workspace and that the external-dependency policy runs client-side. Since S6b/c/d, created_by defaults to the actor in the library on every backend, and every bd serve composed through the policy advertises policy.external_dependencies, so clients pass those operations through; the client-side policy (now in role terms) runs only against a server that does not advertise it. New entries: the advertised policy token, bd ping over http, the created_by library default, closed_by_session dropped by an http `bd update -s closed` (with a notice, typed or ambient), reopen without a Provenance label over http, local-only routing.* / contributor.* on a remote backend, GetIssue's miss as storage.ErrNotFound, and list/children/show counts/dep tree over http. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(externaldeps): keep S6's list --ready, --claim-next refusal and lost-race error on the S6c composition The re-adopted S6 head (#7288) carries the review fixup's remote role composition; S6c replaces it with its own (rolesAreRemote, the widened ready window, the policy passthrough). Two behaviours S6 shipped and its reviews pinned would otherwise go: - bd close --claim-next against a server that does not apply the policy is refused whole, before anything is read or closed, with "the served batch close cannot carry a next claim, so nothing was closed; close without --claim-next, then run `bd ready --claim`". S6c passed the batch to the http closer, whose W-CloseBatchRequest.ClaimNext refusal drops the remedy, so TestE2E_BDOverHTTP's two refuseClaimNext steps went red. A request invalid on every backend is still ErrValidation first, and a server that applies the policy still gets the request untouched. - remoteReadyClaimer.ClaimNext reports a page on which every candidate was lost to another actor as "claim ready: lost N races ...", not as the empty answer that means there is no work. - `bd list --ready` (List with ReadyFlag) is answered by the policy store's own reader over the served ready reads, as S6 does. S6c passed it to the served listing, which cannot carry ReadyFlag (httpclient ledger row E-ListRequest.ReadyFlag), so it exited 1 over http with or without external refs; TestE2E_BDOverHTTP and TestServedRolesKeepTheExternalDependencyPolicy were red on it. TestRemoteReaderAnswersAReadyListingWithoutTheWireFlag pins it, with the fake's served List refusing ReadyFlag as the wire does. S6's composition tests now run against S6c as remote_roles_composition_test.go. Their fake serves Ready the way a server does (the S6 composition read ready work through the legacy policy reader instead), and two call logs gain that Ready. TestRemoteBatchCloserRefusesANextClaim, TestRemoteBatchCloserValidatesANextClaimFirst and TestRemoteReadyClaimerReportsLostRaces were red on S6c before this change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(externaldeps): unassigned claim-next and fail-closed close reads Review fixes for the S6c composition against a server that does not advertise policy.external_dependencies: the two majors of review attempt 1, plus the minors on the same code. - ReadyClaimer: the composed claim-next reads only open, unassigned ready rows (Unassigned=true, Assignee cleared), the candidates the local ClaimReadyIssueInTx selects. A row another actor holds, or one already assigned to the caller, is no longer taken or counted as a lost race. Each pass reads 25 candidates past the blocked rows, as httpclient's composed claim does, and a full window lost end to end is read once more: claimed rows leave the unassigned set. Only a claim that tried candidates and won none is an error. - BatchCloser: an externally blocked item travels to the server only when its status read finds it closed or not found (liveRefusal). Any other read error is that item's outcome, so a transient or auth failure no longer forwards a refused close to a server that will not refuse it. - TreeWalker: a failed capability probe renders the external leaves over the walked tree instead of failing a walk the server already answered. appendTreeExternalReferences skips an id the tree holds, so an enforcing server's own leaves are not doubled. - remoteEdges names each anchor once and skips an empty one, which the http EdgeReader refuses with ErrValidation. The composition fakes now honor Unassigned/Assignee as workapi.BuildReadyFilter does, model a rival claim landing first and a failing GetIssue, and refuse an empty edge anchor as httpclient does. New: TestRemoteReadyClaimerTakesOnlyUnassignedWork, TestRemoteReadyClaimerWalksAContendedFront, TestRemoteBatchCloserAnswersAFailedReadWithIt, TestRemoteEdgesNamesEachAnchorOnce, and the probe-failure cases of TestRemoteTreeWalkerAddsExternalLeaves. Each is red with its fix reverted. From review attempt 2, three nearby cleanups: - TestServedRolesKeepTheExternalDependencyPolicy seeds open rows held by another actor and by the claimant ahead of the free work, then claims with and without an assignee filter. The unassigned-only claim is now pinned over a real served server, not only through the fakes: red with the pre-fixup remote_roles.go, with filter.Unassigned dropped, and (the filtered claim) with an explicit assignee honored. - The capabilities description in openapi.v0.yaml (and the regenerated types.gen.go comment) no longer calls the whole list build-level: policy.external_dependencies depends on how the server composed its roles, as the paragraph above it says. - createbatchequiv's golden note names issueops.PreparePublicCreateRequest instead of a commit id that is not on this branch. Agent-Signature: claude-code-claude-opus-5-5-max on behalf of Julian Knutsen Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * test(backend/http): count a not_found read as reaching the remote in #7469's credential doors main's #7469 added TestExplicitCredentialIgnoresTheEnvPlaintextGrant. Its OpenWith and Open doors read bd-1 from plaintextRemote, which answers every issue read not_found, and the granted leg needs that read to return a nil error. That held while the http client answered a miss with (nil, nil). This branch's "fix(httpclient): GetIssue answers a miss with storage.ErrNotFound, like the local stores" makes the same read return storage.ErrNotFound. So on main plus this branch both doors fail at per_open_credential_test.go:392 ("with Target.AllowInsecureCredential: not found: issue bd-1") under plain go test. The merge is textually clean, so only a build of the merge shows it. The two store doors now count storage.ErrNotFound as success, since that answer came off the wire. The assertions are unchanged. The refused leg still needs the "refusing to send a credential" error and no request on the transport. The granted leg still needs exactly one request carrying "Bearer explicit-token": a granted read that never reaches the wire still fails at :408. Agent-Signature: claude-code-claude-opus-5-5-max on behalf of Julian Knutsen Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
497 lines
21 KiB
Go
497 lines
21 KiB
Go
package httpapi
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/steveyegge/beads/internal/httpapi/apigen"
|
|
"github.com/steveyegge/beads/internal/storage"
|
|
"github.com/steveyegge/beads/internal/types"
|
|
"github.com/steveyegge/beads/issueops"
|
|
)
|
|
|
|
// The wire adapter over issueops.Lifecycle.Create: ONE issue, its parent, its
|
|
// explicit edges and its waits-for gate, written as one transaction.
|
|
//
|
|
// It carries the claim's posture verbatim. The actor is caller-ASSERTED
|
|
// provenance for the audit trail and not authenticated identity; hooks do not
|
|
// fire and the per-command auto-commit machinery does not run. The only durable
|
|
// effect is the single storage commit the role makes inside its own
|
|
// transaction.
|
|
//
|
|
// EVERYTHING ABOVE THE ROLE IS ARGUMENT VALIDATION. The id minting, the prefix
|
|
// check, the create-only guard, the workspace's status and type vocabularies,
|
|
// the plane routing, the edge write and the graph gates all belong to
|
|
// issueops.Lifecycle. This file decodes a body two levels deep, refuses the
|
|
// shapes the document refuses, and marshals the row that came back.
|
|
|
|
const (
|
|
// maxCreateBodyBytes bounds the request body. One issue can carry a
|
|
// description, a design, acceptance criteria, notes and a metadata document
|
|
// at once, so this is the update's bound rather than the claim's megabyte.
|
|
maxCreateBodyBytes = 4 << 20
|
|
// maxCreateDependencies is the document's cap on `dependencies`. It bounds
|
|
// how long one request may hold a write transaction — not create semantics,
|
|
// which have no edge count in them.
|
|
maxCreateDependencies = 100
|
|
// createMetadataMember is the one member whose explicit `null` is not
|
|
// refused at the edge: its bytes are the metadata plane's own, and the role
|
|
// is the single definition of what that plane accepts.
|
|
createMetadataMember = "metadata"
|
|
)
|
|
|
|
// The document's member list at each of this body's levels. Every schema is
|
|
// additionalProperties: false, so anything else is refused BY NAME — which is
|
|
// why each level is decoded as raw members first: encoding/json's
|
|
// DisallowUnknownFields reports the offender only inside an error string.
|
|
var (
|
|
createRequestMembers = []string{
|
|
"acceptance_criteria", "actor", "assignee", "defer_until", "dependencies",
|
|
"description", "design", "due_at", "ephemeral", "estimated_minutes",
|
|
"external_ref", "force_id_prefix", "id", "inherit_labels_from_parent",
|
|
"issue_type", "labels", createMetadataMember, "no_history", "notes", "owner",
|
|
"parent_id", "priority", "sender", "status", "title", "waits_for",
|
|
}
|
|
createDependencyMembers = []string{"metadata", "reverse", "target_id", "type"}
|
|
createWaitsForMembers = []string{"gate", "spawner_id"}
|
|
)
|
|
|
|
// handleCreateIssue creates one issue, or creates nothing.
|
|
//
|
|
// A PLAIN COLLECTION POST rather than a custom method: this creates one member
|
|
// of the collection the path names, which is what POST already means — the
|
|
// argument rememberMemory makes on its own collection. The path was left free
|
|
// for exactly this operation when issues:batchCreate chose a custom method.
|
|
func (s *Server) handleCreateIssue(w http.ResponseWriter, r *http.Request) {
|
|
if !s.requireNoQuery(w, r) {
|
|
return
|
|
}
|
|
if !s.requireJSONContent(w, r) {
|
|
return
|
|
}
|
|
request, ok := s.createIssueRequest(w, r)
|
|
if !ok {
|
|
return
|
|
}
|
|
|
|
lifecycle, err := s.lifecycle(r)
|
|
if err != nil {
|
|
s.failCreateIssue(w, r, err)
|
|
return
|
|
}
|
|
result, err := lifecycle.Create(r.Context(), request)
|
|
if err != nil {
|
|
s.failCreateIssue(w, r, err)
|
|
return
|
|
}
|
|
// The row as STORED, never the request reflected back: the role clones its
|
|
// request, so the minted id, the defaulted status and the persisted
|
|
// timestamps exist only on this snapshot. checkedLifecycle.Create is what
|
|
// makes the dereference safe.
|
|
writeJSON(w, *result.Issue)
|
|
}
|
|
|
|
// createIssueRequest decodes and validates the body, and reports whether the
|
|
// request may proceed. Every refusal here happens BEFORE any database work,
|
|
// which is what lets these 400s reflect the caller's own input back.
|
|
func (s *Server) createIssueRequest(w http.ResponseWriter, r *http.Request) (issueops.CreateRequest, bool) {
|
|
refuse := func(res *Result) (issueops.CreateRequest, bool) {
|
|
s.fail(w, r, *res)
|
|
return issueops.CreateRequest{}, false
|
|
}
|
|
|
|
members, res := decodeJSONObject(w, r, maxCreateBodyBytes)
|
|
if res != nil {
|
|
return refuse(res)
|
|
}
|
|
if offender, unknown := unknownMember(members, createRequestMembers); unknown {
|
|
s.failUnknownMember(w, r, offender, createRequestMembers)
|
|
return issueops.CreateRequest{}, false
|
|
}
|
|
// Explicit null, before any typed decode. NO MEMBER OF A CREATE IS
|
|
// NULLABLE: a create has nothing to clear, so `null` is never a third state
|
|
// here — unmarshaling it into *T yields nil, which is indistinguishable
|
|
// from omission, and the value the client asked for would be silently
|
|
// replaced by the workspace default. `metadata` is the one exception and
|
|
// travels unparsed for the reason applyDepAddItem gives about an edge blob:
|
|
// the role is the single definition of what that plane accepts, and a
|
|
// second parse here would be a second definition.
|
|
for name, value := range members {
|
|
if name != createMetadataMember && isJSONNull(value) {
|
|
return refuse(createRefusal(name, "`"+name+"` is not nullable; omit it to leave it at the workspace default"))
|
|
}
|
|
}
|
|
|
|
// The two members with a level below them are shaped BEFORE the typed
|
|
// decode, applyItems' order and for its reason: the whole-body decode fails
|
|
// as one unit, so a `waits_for` that is a string would otherwise be reported
|
|
// against the body rather than against the member the client can fix.
|
|
rawEdges, res := createRawEdges(members)
|
|
if res != nil {
|
|
return refuse(res)
|
|
}
|
|
rawWaitsFor, res := createRawWaitsFor(members)
|
|
if res != nil {
|
|
return refuse(res)
|
|
}
|
|
|
|
actor, ok := s.bodyActor(w, r, members)
|
|
if !ok {
|
|
return issueops.CreateRequest{}, false
|
|
}
|
|
|
|
// The typed decode, which is what makes a member's type the DOCUMENT's
|
|
// type: `priority: "high"` is refused here rather than reaching a role that
|
|
// would have to guess what the caller meant.
|
|
var wire apigen.CreateIssueRequest
|
|
if err := json.Unmarshal(rawObject(members), &wire); err != nil {
|
|
return refuse(createRefusal("", "a request member carries the wrong JSON type"))
|
|
}
|
|
if strings.TrimSpace(wire.Title) == "" {
|
|
return refuse(createRefusal("title", "`title` is required and must not be blank"))
|
|
}
|
|
// The role validates the type, the status and the id prefix against the
|
|
// workspace's own configuration, which this server cannot read without a
|
|
// transaction; what is checked here is only what the schema declares. A
|
|
// SLICE and not a map, so a request breaking two rules always names the same
|
|
// offender: `param` is what a client dispatches on and it must not depend on
|
|
// map order.
|
|
for _, bounded := range []struct {
|
|
member string
|
|
value *string
|
|
}{
|
|
{"id", wire.Id}, {"title", &wire.Title}, {"issue_type", wire.IssueType},
|
|
{"status", wire.Status}, {"assignee", wire.Assignee}, {"owner", wire.Owner},
|
|
{"external_ref", wire.ExternalRef}, {"sender", wire.Sender},
|
|
{"parent_id", wire.ParentId},
|
|
} {
|
|
if res := applyBoundedText("", bounded.member, bounded.value); res != nil {
|
|
return refuse(res)
|
|
}
|
|
}
|
|
if wire.Priority != nil && (*wire.Priority < 0 || *wire.Priority > 4) {
|
|
return refuse(createRefusal("priority", fmt.Sprintf("`priority` is %d; the range is 0 to 4", *wire.Priority)))
|
|
}
|
|
if wire.Labels != nil {
|
|
if res := applyBoundedLabels("", "labels", *wire.Labels); res != nil {
|
|
return refuse(res)
|
|
}
|
|
}
|
|
if derefBool(wire.Ephemeral) && derefBool(wire.NoHistory) {
|
|
return refuse(createRefusal("no_history", "`ephemeral` and `no_history` select different retention modes; send one"))
|
|
}
|
|
|
|
issue := &types.Issue{
|
|
ID: derefString(wire.Id),
|
|
Title: wire.Title,
|
|
Description: derefString(wire.Description),
|
|
Design: derefString(wire.Design),
|
|
AcceptanceCriteria: derefString(wire.AcceptanceCriteria),
|
|
Notes: derefString(wire.Notes),
|
|
Status: types.Status(derefString(wire.Status)),
|
|
IssueType: types.IssueType(derefString(wire.IssueType)),
|
|
Assignee: derefString(wire.Assignee),
|
|
Owner: derefString(wire.Owner),
|
|
EstimatedMinutes: wire.EstimatedMinutes,
|
|
ExternalRef: wire.ExternalRef,
|
|
DueAt: wire.DueAt,
|
|
DeferUntil: wire.DeferUntil,
|
|
Sender: derefString(wire.Sender),
|
|
Ephemeral: derefBool(wire.Ephemeral),
|
|
NoHistory: derefBool(wire.NoHistory),
|
|
// No CreatedBy: the wire publishes none, and the role defaults it to
|
|
// the request's actor (issueops.PreparePublicCreateRequest), the same
|
|
// rule every front door and library caller gets.
|
|
}
|
|
if wire.Priority != nil {
|
|
issue.Priority = *wire.Priority
|
|
}
|
|
if wire.Labels != nil {
|
|
issue.Labels = append([]string(nil), *wire.Labels...)
|
|
}
|
|
if raw, present := members[createMetadataMember]; present {
|
|
// COPIED rather than aliasing the decoded body, so nothing downstream
|
|
// can be surprised by the request buffer's lifetime.
|
|
issue.Metadata = applyRawCopy(raw)
|
|
}
|
|
|
|
request := issueops.CreateRequest{
|
|
Actor: actor,
|
|
Issue: issue,
|
|
ParentID: derefString(wire.ParentId),
|
|
InheritLabelsFromParent: derefBool(wire.InheritLabelsFromParent),
|
|
ForceIDPrefix: derefBool(wire.ForceIdPrefix),
|
|
// An absent `priority` is the role's default, never a 0 this handler
|
|
// would have to make up: 0 is P0, and the document says absent means
|
|
// the default (CreateRequest.DefaultPriority).
|
|
DefaultPriority: wire.Priority == nil,
|
|
}
|
|
// IDPrefix stays ZERO, and its absence is a decision rather than an
|
|
// omission. It exists because a workspace's own config.yaml prefix wins over
|
|
// the database's and only a local front door can read that file
|
|
// (CreateRequest.IDPrefix). A remote client's config.yaml describes a
|
|
// workspace this server does not serve, so publishing it would let a caller
|
|
// override the served workspace's prefix rule from outside it.
|
|
|
|
dependencies, res := createDependencies(rawEdges, wire.Dependencies)
|
|
if res != nil {
|
|
return refuse(res)
|
|
}
|
|
request.Dependencies = dependencies
|
|
|
|
waitsFor, res := createWaitsFor(rawWaitsFor, wire.WaitsFor)
|
|
if res != nil {
|
|
return refuse(res)
|
|
}
|
|
request.WaitsFor = waitsFor
|
|
return request, true
|
|
}
|
|
|
|
// createRawEdges reads `dependencies` as raw members, so an unknown member
|
|
// INSIDE an edge is refused by name and a member that is not an array of
|
|
// objects is refused against `dependencies` rather than against the body.
|
|
//
|
|
// It answers nil for an absent member, which is what "no edges" means.
|
|
func createRawEdges(members map[string]json.RawMessage) ([]map[string]json.RawMessage, *Result) {
|
|
raw, present := members["dependencies"]
|
|
if !present {
|
|
return nil, nil
|
|
}
|
|
var edges []map[string]json.RawMessage
|
|
if err := json.Unmarshal(raw, &edges); err != nil || edges == nil {
|
|
return nil, createRefusal("dependencies", "`dependencies` must be an array of edges")
|
|
}
|
|
for i, edge := range edges {
|
|
if edge == nil {
|
|
return nil, createRefusal(strings.TrimSuffix(createDependencyParam(i, ""), "."), "an edge must be a JSON object")
|
|
}
|
|
}
|
|
return edges, nil
|
|
}
|
|
|
|
// createRawWaitsFor reads `waits_for` as raw members, for createRawEdges'
|
|
// reason. It answers nil for an absent member, which is what "no gate" means.
|
|
func createRawWaitsFor(members map[string]json.RawMessage) (map[string]json.RawMessage, *Result) {
|
|
raw, present := members["waits_for"]
|
|
if !present {
|
|
return nil, nil
|
|
}
|
|
var gate map[string]json.RawMessage
|
|
if err := json.Unmarshal(raw, &gate); err != nil || gate == nil {
|
|
return nil, createRefusal("waits_for", "`waits_for` must be a JSON object naming a `spawner_id`")
|
|
}
|
|
return gate, nil
|
|
}
|
|
|
|
// createDependencies validates `dependencies` and projects it onto the role's
|
|
// edges. The raw members are re-read beside the generated slice so an unknown
|
|
// member INSIDE an edge is refused by name like every other one.
|
|
func createDependencies(rawEdges []map[string]json.RawMessage, wire *[]apigen.CreateIssueDependency) ([]issueops.CreateDependency, *Result) {
|
|
if wire == nil {
|
|
return nil, nil
|
|
}
|
|
if len(*wire) > maxCreateDependencies {
|
|
return nil, createRefusal("dependencies",
|
|
fmt.Sprintf("`dependencies` carries %d edges; the limit is %d per request", len(*wire), maxCreateDependencies))
|
|
}
|
|
edges := make([]issueops.CreateDependency, 0, len(*wire))
|
|
for i, edge := range *wire {
|
|
if offender, unknown := unknownMember(rawEdgeAt(rawEdges, i), createDependencyMembers); unknown {
|
|
return nil, applyUnknownMember(createDependencyParam(i, ""), offender, createDependencyMembers)
|
|
}
|
|
if edge.TargetId == "" {
|
|
return nil, createRefusal(createDependencyParam(i, "target_id"), "`target_id` is required and must not be empty")
|
|
}
|
|
if res := applyBoundedText(createDependencyParam(i, ""), "target_id", &edge.TargetId); res != nil {
|
|
return nil, res
|
|
}
|
|
// A value at all, and one the column holds — never membership of a
|
|
// known-types list. The edge vocabulary is OPEN, as EdgeReadRequest.Types
|
|
// says, so a workspace's own type passes and only an unstorable one is
|
|
// refused.
|
|
if !types.DependencyType(edge.Type).IsValid() {
|
|
return nil, createRefusal(createDependencyParam(i, "type"),
|
|
fmt.Sprintf("`type` must be 1 to %d characters", types.MaxDependencyTypeLen))
|
|
}
|
|
created := issueops.CreateDependency{
|
|
TargetID: edge.TargetId,
|
|
Type: types.DependencyType(edge.Type),
|
|
Reverse: derefBool(edge.Reverse),
|
|
}
|
|
// The blob travels as the bytes the caller sent, applyDepAddItem's rule
|
|
// unchanged: the role is the single definition of what it will accept.
|
|
if raw := rawEdgeMember(rawEdges, i, "metadata"); raw != nil {
|
|
created.Metadata = string(raw)
|
|
}
|
|
// ThreadID stays zero: CreateDependency carries one, this document
|
|
// publishes it on no operation, and a discussion-thread id nothing on
|
|
// this surface can read back is write-only state.
|
|
edges = append(edges, created)
|
|
}
|
|
return edges, nil
|
|
}
|
|
|
|
// createWaitsFor validates `waits_for` and projects it onto the role's typed
|
|
// gate. The gate VOCABULARY is the role's — an unknown one is its ErrValidation
|
|
// reaching the wire — so only the schema's own bounds are applied here.
|
|
func createWaitsFor(raw map[string]json.RawMessage, wire *apigen.CreateIssueWaitsFor) (*issueops.WaitsFor, *Result) {
|
|
if raw == nil || wire == nil {
|
|
return nil, nil
|
|
}
|
|
if offender, unknown := unknownMember(raw, createWaitsForMembers); unknown {
|
|
return nil, applyUnknownMember("waits_for.", offender, createWaitsForMembers)
|
|
}
|
|
if wire.SpawnerId == "" {
|
|
return nil, createRefusal("waits_for.spawner_id", "`spawner_id` is required and must not be empty")
|
|
}
|
|
for _, bounded := range []struct {
|
|
member string
|
|
value *string
|
|
}{{"spawner_id", &wire.SpawnerId}, {"gate", wire.Gate}} {
|
|
if res := applyBoundedText("waits_for.", bounded.member, bounded.value); res != nil {
|
|
return nil, res
|
|
}
|
|
}
|
|
return &issueops.WaitsFor{SpawnerID: wire.SpawnerId, Gate: derefString(wire.Gate)}, nil
|
|
}
|
|
|
|
// failCreateIssue answers a refused create, mapping the role's TYPED refusals
|
|
// onto the frozen codes.
|
|
//
|
|
// THERE IS NO 404 BRANCH, and its absence is this operation's posture rather
|
|
// than an oversight. A dependency, parent or waits-for target that names
|
|
// nothing arrives as ErrValidation WRAPPING ErrNotFound, and it is a statement
|
|
// about the request body rather than about a resource this operation was asked
|
|
// to address — there is no id in the path to have missed. That is
|
|
// batchCreateIssues' argument and addDependencies', applied to a single create.
|
|
// The ErrValidation check therefore has to run before any ErrNotFound reading,
|
|
// exactly as failBatchCreate's does.
|
|
//
|
|
// NOTHING HERE QUOTES THE ROLE'S MESSAGE. A refusal from the workspace's own
|
|
// vocabulary arrives as prose about statuses and types, and a refused edge
|
|
// arrives as a driver error naming tables and constraints; 4xx details on this
|
|
// surface reflect the caller's own input back rather than server internals. The
|
|
// real error goes to the log with the request id.
|
|
func (s *Server) failCreateIssue(w http.ResponseWriter, r *http.Request, err error) {
|
|
var hierarchy *issueops.DependencyHierarchyConflictError
|
|
// The 409 constructors take no param, and the document promises one on
|
|
// every problem but the body that failed to parse, so the conflicts name
|
|
// the member that earned them here.
|
|
named := func(res Result, param string) Result {
|
|
res.Problem.Param = ¶m
|
|
return res
|
|
}
|
|
|
|
switch {
|
|
// An occupied explicit id is a 409: the body is well-formed and stays
|
|
// well-formed, and what refuses it is STATE the client cannot see without
|
|
// reading it — so recovery is to look at that state (adopt the row with
|
|
// PATCH, pick another id, or stop) rather than to fix a malformed request.
|
|
// The identical body succeeded before the id was taken. Matched before
|
|
// ErrValidation because the create path can wrap both.
|
|
case errors.Is(err, storage.ErrAlreadyExists):
|
|
s.refusedCreateIssue(r, err)
|
|
s.fail(w, r, named(newResult(CodeAlreadyExists,
|
|
"`id` already names a stored row; nothing was created"), "id"))
|
|
|
|
// The hierarchy refusal and the plain scheduling cycle share one code, and
|
|
// the three extension members are what tells them apart — presence is the
|
|
// discriminator, so the hierarchy arm must be matched first.
|
|
case errors.As(err, &hierarchy):
|
|
s.refusedCreateIssue(r, err)
|
|
s.fail(w, r, named(newResult(CodeDependencyCycle,
|
|
"a blocking edge against the new issue's own ancestor or descendant would never clear").
|
|
WithHierarchyConflict(hierarchy.IssueID, hierarchy.BlockerID, hierarchy.BlockerIsAncestor), "dependencies"))
|
|
|
|
case errors.Is(err, issueops.ErrDependencyCycle):
|
|
s.refusedCreateIssue(r, err)
|
|
s.fail(w, r, named(newResult(CodeDependencyCycle,
|
|
"the requested edges would create a dependency cycle; nothing was created"), "dependencies"))
|
|
|
|
case !errors.Is(err, storage.ErrValidation):
|
|
s.failErr(w, r, err)
|
|
|
|
// The 4xx path does not log by default, so the branches below are the one
|
|
// place the real refusal is recorded for the operator.
|
|
case errors.Is(err, storage.ErrNotFound):
|
|
s.refusedCreateIssue(r, err)
|
|
s.fail(w, r, InvalidArgument("dependencies", ReasonInvalidValue,
|
|
"a dependency, parent or waits-for target names no issue in this workspace; nothing was created"))
|
|
|
|
case errors.Is(err, issueops.ErrSelfDependency):
|
|
s.refusedCreateIssue(r, err)
|
|
s.fail(w, r, InvalidArgument("dependencies", ReasonInvalidValue,
|
|
"an issue cannot depend on itself; nothing was created"))
|
|
|
|
case errors.Is(err, issueops.ErrPrefixMismatch):
|
|
s.refusedCreateIssue(r, err)
|
|
s.fail(w, r, InvalidArgument("id", ReasonInvalidValue,
|
|
"`id` is outside this workspace's configured issue prefix; send `force_id_prefix` to create it anyway"))
|
|
|
|
default:
|
|
s.refusedCreateIssue(r, err)
|
|
// No `param`: the remaining refusals are the workspace's own
|
|
// vocabularies, which can name a member this request does not carry.
|
|
// deleteIssues draws the same line for the same reason.
|
|
s.fail(w, r, InvalidArgument("", ReasonInvalidValue,
|
|
"the request was refused by this workspace's own validation; nothing was created"))
|
|
}
|
|
}
|
|
|
|
// refusedCreateIssue records the real refusal for the operator, since the 4xx
|
|
// path does not log by default and the response carries the server's own words.
|
|
func (s *Server) refusedCreateIssue(r *http.Request, err error) {
|
|
s.event("request_refused", "request_id", requestInfo(r.Context()).id, "error", err.Error())
|
|
}
|
|
|
|
// createRefusal is the 400 this body's levels raise, with `param` already
|
|
// spelled the way the client reads it back.
|
|
func createRefusal(param, detail string) *Result {
|
|
res := InvalidArgument(param, ReasonInvalidValue, detail)
|
|
return &res
|
|
}
|
|
|
|
// createDependencyParam spells the `param` member for a refusal inside
|
|
// `dependencies`, so a client dispatching on it learns WHICH edge and WHICH
|
|
// member. An empty member names the edge itself, and the trailing dot is what
|
|
// the nested unknown-member refusal appends its offender to.
|
|
func createDependencyParam(index int, member string) string {
|
|
return fmt.Sprintf("dependencies[%d].%s", index, member)
|
|
}
|
|
|
|
// rawEdgeMember reads one member off a decoded edge, or nil when the edge or
|
|
// the member is absent.
|
|
func rawEdgeMember(edges []map[string]json.RawMessage, index int, member string) json.RawMessage {
|
|
edge := rawEdgeAt(edges, index)
|
|
if edge == nil {
|
|
return nil
|
|
}
|
|
raw, ok := edge[member]
|
|
if !ok {
|
|
return nil
|
|
}
|
|
return raw
|
|
}
|
|
|
|
// rawObject re-encodes a decoded object so the generated struct can be
|
|
// unmarshaled from the same bytes the raw member check ran over. The two
|
|
// decodes have to see one document, and re-encoding the members is cheaper than
|
|
// buffering the body twice.
|
|
func rawObject(members map[string]json.RawMessage) []byte {
|
|
encoded, err := json.Marshal(members)
|
|
if err != nil {
|
|
// json.RawMessage values came out of a successful decode, so this
|
|
// cannot fail; `null` keeps the typed decode's own refusal honest.
|
|
return []byte("null")
|
|
}
|
|
return encoded
|
|
}
|
|
|
|
// derefBool reads an optional boolean member, defaulting to false — the
|
|
// document's default for every flag on this surface.
|
|
func derefBool(value *bool) bool {
|
|
return value != nil && *value
|
|
}
|