Repository navigation
feat(roadmap): read-only epic status and ready work items (#333) #356
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| // Copyright 2025 MCTL Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package api | ||
|
|
||
| import ( | ||
| "errors" | ||
| "log/slog" | ||
| "net/http" | ||
| "strconv" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/mctlhq/mctl-api/internal/roadmap" | ||
| ) | ||
|
|
||
| // Roadmap read model (mctl-api#333). Every answer here is selected from the | ||
| // RoadmapPublication that mctlhq/.github publishes to its roadmap-state | ||
| // branch; nothing is evaluated, inferred or written. A publication that is | ||
| // missing or fails verification answers 503, which means "cannot say", never | ||
| // "nothing is ready". | ||
|
|
||
| const ( | ||
| roadmapCodeUnavailable = "roadmap_unavailable" | ||
| roadmapCodeEpicNotFound = "epic_not_found" | ||
| roadmapCodeInvalid = "invalid_request" | ||
| ) | ||
|
|
||
| func (h *Handlers) roadmapPublication(w http.ResponseWriter) (*roadmap.Publication, bool) { | ||
| pub, err := h.opts.Roadmap.Current() | ||
| if err != nil { | ||
| // The detail (paths, git output) goes to the log; the caller needs | ||
| // only to know nothing verified, which means "cannot say". | ||
| slog.Warn("roadmap publication unavailable", "error", err) | ||
| writeErrorCode(w, http.StatusServiceUnavailable, roadmapCodeUnavailable, | ||
| "no verified roadmap publication: readiness is unknown, not empty", nil) | ||
| return nil, false | ||
| } | ||
| return pub, true | ||
| } | ||
|
|
||
| func writeRoadmapLookupError(w http.ResponseWriter, err error) { | ||
| if errors.Is(err, roadmap.ErrEpicNotFound) { | ||
| writeErrorCode(w, http.StatusNotFound, roadmapCodeEpicNotFound, err.Error(), nil) | ||
| return | ||
| } | ||
| writeError(w, http.StatusInternalServerError, "roadmap lookup failed") | ||
| } | ||
|
|
||
| // ListRoadmapEpics handles GET /api/v1/roadmap/epics. | ||
| func (h *Handlers) ListRoadmapEpics(w http.ResponseWriter, r *http.Request) { | ||
| pub, ok := h.roadmapPublication(w) | ||
| if !ok { | ||
| return | ||
| } | ||
| writeJSON(w, http.StatusOK, map[string]any{ | ||
| "epics": pub.Epics(), | ||
| "provenance": pub.Provenance(time.Now()), | ||
| }) | ||
| } | ||
|
|
||
| // GetRoadmapEpicStatus handles GET /api/v1/roadmap/epic-status?epic=<name or owner/repo#N>. | ||
| func (h *Handlers) GetRoadmapEpicStatus(w http.ResponseWriter, r *http.Request) { | ||
| epic := strings.TrimSpace(r.URL.Query().Get("epic")) | ||
| if epic == "" { | ||
| writeErrorCode(w, http.StatusBadRequest, roadmapCodeInvalid, "epic is required: a name or a root issue such as mctlhq/.github#57", nil) | ||
| return | ||
| } | ||
| pub, ok := h.roadmapPublication(w) | ||
| if !ok { | ||
| return | ||
| } | ||
| status, err := pub.EpicStatus(epic, time.Now()) | ||
| if err != nil { | ||
| writeRoadmapLookupError(w, err) | ||
| return | ||
| } | ||
| writeJSON(w, http.StatusOK, status) | ||
| } | ||
|
|
||
| // GetRoadmapReadyWorkItems handles GET /api/v1/roadmap/ready?epic=&required_only=. | ||
| // Without epic it answers for every active epic. required_only defaults to | ||
| // true: the safe wave-selection default. | ||
| func (h *Handlers) GetRoadmapReadyWorkItems(w http.ResponseWriter, r *http.Request) { | ||
| q := r.URL.Query() | ||
| requiredOnly := true | ||
| if v := strings.TrimSpace(q.Get("required_only")); v != "" { | ||
| b, err := strconv.ParseBool(v) | ||
| if err != nil { | ||
| writeErrorCode(w, http.StatusBadRequest, roadmapCodeInvalid, "required_only must be true or false", nil) | ||
| return | ||
| } | ||
| requiredOnly = b | ||
| } | ||
| pub, ok := h.roadmapPublication(w) | ||
| if !ok { | ||
| return | ||
| } | ||
| ready, err := pub.ReadyWorkItems(q.Get("epic"), requiredOnly, time.Now()) | ||
| if err != nil { | ||
| writeRoadmapLookupError(w, err) | ||
| return | ||
| } | ||
| writeJSON(w, http.StatusOK, ready) | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P3 — this commit touches
.env.exampleto correct theWORK_ITEMS_DISABLEDwording, but does not add the fiveROADMAP_STATE_*variables it introduces.README.md gains all five rows (
ROADMAP_STATE_REPO_URL,_BRANCH,_LOCAL_PATH,_TOKEN,_DISABLED), and.env.exampleis the file an operator copies to.env—WORK_ITEMS_DB_URL/WORK_ITEMS_DISABLEDare both listed there for exactly that reason. Someone bringing up a local API from the template has no indication that a second git checkout is about to be cloned into/tmp/roadmap-state, nor the one variable that stops it. That matters more for this feature than for most, because the reader starts unconditionally at boot and fails only into log lines.Five commented lines mirroring the
WORK_ITEMS_*block would keep the template and the README saying the same thing.