diff --git a/cmd/server/internal/api/api.go b/cmd/server/internal/api/api.go index 1031362..f5bedcb 100644 --- a/cmd/server/internal/api/api.go +++ b/cmd/server/internal/api/api.go @@ -16,6 +16,7 @@ import ( "github.com/appthrust/appserver-go/appserver/identity" "github.com/appthrust/appserver-go/appserver/link" "github.com/appthrust/appserver-go/appserver/platformclient" + "github.com/appthrust/appserver-go/appserver/requestlog" "github.com/appthrust/tool-builder/cmd/server/internal/domain" "github.com/appthrust/tool-builder/cmd/server/internal/store" ) @@ -51,14 +52,12 @@ type detailedError struct { Code string `json:"error"` Message string `json:"message"` Details any `json:"details"` + + fromUpstream bool } func (e *detailedError) Error() string { return e.Code + ": " + e.Message } -func detail(status int, code, message string, details any) error { - return &detailedError{Status: status, Code: code, Message: message, Details: details} -} - // The origin is explicit because platformclient intentionally exposes only // shared team-role operations, not an arbitrary authenticated proxy. func New(database *store.Store, eng Engine, auth *identity.Authenticator, platform *platformclient.Client, links *link.Client, origin, publicURL string) http.Handler { @@ -129,13 +128,13 @@ func (a *API) handle(pattern string, handler endpoint) { } else { err = httpx.Fail(401, "unauthenticated", "A valid bearer token is required") } - writeError(w, err) + writeError(w, r, err) return } s := &request{r: r, w: w, claims: claims, bearer: r.Header.Get("Authorization")} access, err := a.platform.Access(ctx, claims.Principal.Subject, s.bearer) if err != nil { - writeError(w, httpx.Fail(502, "upstream_unavailable", "The platform is temporarily unavailable")) + writeError(w, r, httpx.Fail(502, "upstream_unavailable", "The platform is temporarily unavailable")) return } s.admin = access.IsConsoleAdmin @@ -144,7 +143,7 @@ func (a *API) handle(pattern string, handler endpoint) { if err != nil && !errors.Is(err, link.ErrAbsent) { var denied *link.DeniedError if !s.admin || errors.As(err, &denied) { - writeError(w, linkError(err)) + writeError(w, r, linkError(err)) return } s.me = directory.MeResponse{} @@ -158,7 +157,7 @@ func (a *API) handle(pattern string, handler endpoint) { if s.rollback != nil { s.rollback() } - writeError(w, err) + writeError(w, r, err) return } if status == 204 { @@ -174,7 +173,7 @@ func (a *API) handle(pattern string, handler endpoint) { httpx.WriteJSON(w, status, body) }) } -func writeError(w http.ResponseWriter, err error) { +func writeError(w http.ResponseWriter, r *http.Request, err error) { var denied *link.DeniedError if errors.As(err, &denied) { httpx.WriteError(w, linkError(err), "tool_builder") @@ -182,6 +181,10 @@ func writeError(w http.ResponseWriter, err error) { } var d *detailedError if errors.As(err, &d) { + if d.fromUpstream { + // Code, message and details all come from the upstream response. + requestlog.SetOutcome(r, "failed", "upstream_rejected") + } httpx.WriteJSON(w, d.Status, d) return } @@ -296,7 +299,7 @@ func (a *API) authorizedTool(s *request, edit bool) (domain.Tool, domain.Grants, } } } - return t, g, access, detail(403, "tool_forbidden", "Request access from the tool's editing groups", map[string]any{"toolName": t.Name, "editors": editors}) + return t, g, access, &detailedError{Status: 403, Code: "tool_forbidden", Message: "Request access from the tool's editing groups", Details: map[string]any{"toolName": t.Name, "editors": editors}} } return t, g, access, nil } diff --git a/cmd/server/internal/api/sources.go b/cmd/server/internal/api/sources.go index 40a8ac0..5619146 100644 --- a/cmd/server/internal/api/sources.go +++ b/cmd/server/internal/api/sources.go @@ -67,7 +67,7 @@ func (a *API) platformRequest(ctx context.Context, bearer, method, path string, _ = json.NewDecoder(io.LimitReader(res.Body, 1<<20)).Decode(&failure) if res.StatusCode >= 400 && res.StatusCode < 500 && failure.Error != "" { if failure.Details != nil { - return res.StatusCode, detail(res.StatusCode, failure.Error, failure.Message, failure.Details) + return res.StatusCode, &detailedError{Status: res.StatusCode, Code: failure.Error, Message: failure.Message, Details: failure.Details, fromUpstream: true} } return res.StatusCode, httpx.Fail(res.StatusCode, failure.Error, failure.Message) } diff --git a/cmd/server/main.go b/cmd/server/main.go index 33d385c..5afeacd 100644 --- a/cmd/server/main.go +++ b/cmd/server/main.go @@ -4,6 +4,7 @@ import ( "context" "errors" "flag" + "io" "log" "net/http" "os" @@ -12,6 +13,7 @@ import ( "time" "github.com/appthrust/appserver-go/appserver/platformenv" + "github.com/appthrust/appserver-go/appserver/requestlog" ) func main() { @@ -43,7 +45,7 @@ func main() { if err != nil { log.Fatal(err) } - server := &http.Server{Addr: *listen, Handler: handler, ReadHeaderTimeout: 10 * time.Second} + server := newServer(*listen, handler, os.Stderr) ctx, stop := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM) defer stop() go func() { @@ -59,3 +61,11 @@ func main() { log.Fatal(err) } } + +func newServer(addr string, handler http.Handler, requestLogs io.Writer) *http.Server { + return &http.Server{ + Addr: addr, + Handler: requestlog.Wrap(handler, requestlog.Options{Service: "tool-builder", Output: requestLogs}), + ReadHeaderTimeout: 10 * time.Second, + } +} diff --git a/cmd/server/server.go b/cmd/server/server.go index c152dd6..353a808 100644 --- a/cmd/server/server.go +++ b/cmd/server/server.go @@ -9,6 +9,7 @@ import ( "github.com/appthrust/appserver-go/appserver/platformclient" "github.com/appthrust/appserver-go/appserver/platformenv" "github.com/appthrust/appserver-go/appserver/releaseidentity" + "github.com/appthrust/appserver-go/appserver/requestlog" "github.com/appthrust/tool-builder/cmd/server/internal/api" "net/http" "net/url" @@ -44,7 +45,8 @@ func newHandler(staticDir, upstreamURL, projectID string, tools http.Handler, re writeJSON(w, http.StatusOK, map[string]string{"projectId": projectID, "publicUrl": os.Getenv("TOOL_BUILDER_PUBLIC_URL")}) }) mux.Handle("GET /launcher", launcher.NewHandler(catalog, authenticator.Authenticate)) - mux.Handle("GET /releasez", releaseidentity.NewHandler("TOOL_BUILDER", func(w http.ResponseWriter, _ *http.Request) { + mux.Handle("GET /releasez", releaseidentity.NewHandler("TOOL_BUILDER", func(w http.ResponseWriter, r *http.Request) { + requestlog.SetOutcome(r, "unavailable", "release_status_unavailable") w.Header().Set("Content-Type", "text/plain; charset=utf-8") w.WriteHeader(http.StatusServiceUnavailable) _, _ = w.Write([]byte("UI release status unavailable\n")) diff --git a/cmd/server/server_test.go b/cmd/server/server_test.go index b9f1521..c9eefaa 100644 --- a/cmd/server/server_test.go +++ b/cmd/server/server_test.go @@ -1,6 +1,7 @@ package main import ( + "bytes" "context" "encoding/json" "net/http" @@ -139,6 +140,35 @@ func TestReleaseFileFallback(t *testing.T) { require.Contains(t, w.Body.String(), "file-revision") } +func TestRequestLogForUnavailableRelease(t *testing.T) { + clearRuntimeEnv(t) + for _, key := range []string{"TOOL_BUILDER_RELEASE_VERSION", "TOOL_BUILDER_SOURCE_REVISION", "TOOL_BUILDER_ARTIFACT_DIGEST"} { + t.Setenv(key, "") + } + t.Setenv("TOOL_BUILDER_RELEASE_FILE", filepath.Join(t.TempDir(), "missing.json")) + handler, err := newHandler(t.TempDir(), "https://platform.example.test", "pj-test", nil, nil) + require.NoError(t, err) + var logs bytes.Buffer + server := newServer(":8080", handler, &logs) + response := httptest.NewRecorder() + server.Handler.ServeHTTP(response, httptest.NewRequest(http.MethodGet, "/releasez?private-query=value", nil)) + require.Equal(t, http.StatusServiceUnavailable, response.Code) + require.Equal(t, "UI release status unavailable\n", response.Body.String()) + + var entry struct { + Msg, Service, Path, Outcome, Reason string + Status int + } + require.NoError(t, json.Unmarshal(logs.Bytes(), &entry)) + require.Equal(t, "request", entry.Msg) + require.Equal(t, "tool-builder", entry.Service) + require.Equal(t, "/releasez", entry.Path) + require.Equal(t, http.StatusServiceUnavailable, entry.Status) + require.Equal(t, "unavailable", entry.Outcome) + require.Equal(t, "release_status_unavailable", entry.Reason) + require.NotContains(t, logs.String(), "private-query") +} + func TestLauncherAuthenticationAndCurrentAppInstallation(t *testing.T) { clearRuntimeEnv(t) const bearer = "Bearer eyJhbGciOiJub25lIn0.eyJzdWIiOiJkZXYtYWRtaW4iLCJlbWFpbCI6ImFkbWluQGV4YW1wbGUudGVzdCIsIm5hbWUiOiJBZG1pbiJ9." diff --git a/go.mod b/go.mod index c61be9e..56e04f4 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/appthrust/tool-builder go 1.26.0 require ( - github.com/appthrust/appserver-go v0.5.1 + github.com/appthrust/appserver-go v0.7.0 github.com/lib/pq v1.12.3 github.com/oklog/ulid/v2 v2.1.1 github.com/stretchr/testify v1.11.1 diff --git a/go.sum b/go.sum index 1cbbb1a..e5c75ef 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,5 @@ -github.com/appthrust/appserver-go v0.5.1 h1:L9IfLUZjR2GxQmEK+d7rjo8P1bItbbb+kqKotRRoey4= -github.com/appthrust/appserver-go v0.5.1/go.mod h1:0KSf9RQZ6OxBcE0lxYzzjKF37nfwbKps3wXUGlE0oFo= +github.com/appthrust/appserver-go v0.7.0 h1:Fd1G+l/Ys0aAAiI2ZmMKqAz4qY6Dv7WwsF/rZtUgPUA= +github.com/appthrust/appserver-go v0.7.0/go.mod h1:0KSf9RQZ6OxBcE0lxYzzjKF37nfwbKps3wXUGlE0oFo= github.com/coreos/go-oidc/v3 v3.20.0 h1:EtE0WIBHk03N+DqGkY4+UONzzZHk7amKt6IyNd7OsZE= github.com/coreos/go-oidc/v3 v3.20.0/go.mod h1:DYCf24+ncYi+XkIH97GY1+dqoRlbaSI26KVTCI9SrY4= github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=