Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 157 additions & 0 deletions internal/api/queries_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@ package api
import (
"context"
"encoding/json"
"errors"
"github.com/labstack/echo/v5"
"github.com/labstack/fanout/internal/auth"
"github.com/labstack/fanout/internal/config"
"github.com/labstack/fanout/internal/dashboard"
"github.com/labstack/fanout/internal/engine"
"github.com/labstack/fanout/internal/telemetry"
telemetrystore "github.com/labstack/fanout/internal/telemetry/store"
"net/http"
"net/http/httptest"
"os"
Expand Down Expand Up @@ -344,3 +350,154 @@ func TestNoCacheSkipsStoredResults(t *testing.T) {
t.Fatalf("trace: %d bypass=%v", rec.Code, traces.bypass)
}
}

func TestPanelQueryIsolatesInvalidPanels(t *testing.T) {
cfg := config.Config{DataDir: t.TempDir(), DuckDBMemory: "256MB", DuckDBThreads: 2, DuckDBMaxConns: 2}
repo, err := telemetrystore.Open(cfg.TelemetryDir())
if err != nil {
t.Fatal(err)
}
duck, err := engine.NewDuck(t.Context(), cfg, repo)
if err != nil {
t.Fatal(err)
}
executor := query.NewExecutor(duck, 30)
t.Cleanup(func() { executor.Close(); _ = duck.Close(); _ = repo.Close() })
s := newTestAuthServer(t)
viewer, err := s.users.CreateWithAudit("viewer@example.com", "", "viewer", auth.AuditEvent{EventType: "user.created", Outcome: "success"})
if err != nil {
t.Fatal(err)
}
RegisterQueryRoutes(s.e, executor)
spec := query.Dashboard{Name: "Stale", Panels: []query.Panel{
{ID: "stale", Title: "Stale", Viz: "bar", Query: &query.Spec{From: "spans", Measures: []string{"count()"}, By: []string{"http_route"}}},
{ID: "valid", Title: "Valid", Viz: "stat", Query: &query.Spec{From: "spans", Measures: []string{"count()"}}},
}}
for _, global := range []bool{false, true} {
if global {
spec.Variables = []query.Variable{{Name: "route", Kind: "query", From: "spans", Field: "http_route"}}
}
raw, err := json.Marshal(query.RunRequest{Dashboard: spec})
if err != nil {
t.Fatal(err)
}
for _, accept := range []string{"application/json", streamType} {
req := sessionRequest(http.MethodPost, "/api/queries/run", strings.NewReader(string(raw)), s.login(t, viewer))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Accept", accept)
rec := httptest.NewRecorder()
s.e.ServeHTTP(rec, req)
if global {
if rec.Code != http.StatusBadRequest || !strings.Contains(rec.Body.String(), "variables[0].field") {
t.Fatalf("global: %d %s", rec.Code, rec.Body)
}
continue
}
if rec.Code != http.StatusOK {
t.Fatalf("%d %s", rec.Code, rec.Body)
}
var results []query.Result
if accept == streamType {
decoder := json.NewDecoder(rec.Body)
for decoder.More() {
var result query.Result
if err := decoder.Decode(&result); err != nil {
t.Fatal(err)
}
results = append(results, result)
}
} else {
var body struct {
Results []query.Result `json:"results"`
}
if err := json.Unmarshal(rec.Body.Bytes(), &body); err != nil {
t.Fatal(err)
}
results = body.Results
if len(results) != 2 || results[0].ID != "stale" {
t.Fatalf("order: %+v", results)
}
}
got := map[string]query.Result{}
for _, r := range results {
got[r.ID] = r
}
bad := got["stale"]
if len(results) != 2 || bad.Status != query.StatusInvalid || len(bad.Problems) == 0 || !strings.Contains(bad.Problems[0].Message, "http_route") || got["valid"].Status != query.StatusOK {
t.Fatalf("results: %+v", results)
}
}
}
spec.Variables = nil
service := dashboard.New(s.db.DB, executor)
_, err = service.Create(t.Context(), viewer.ID, spec, dashboard.Author{Kind: "user", ID: viewer.ID})
var problems query.Problems
if !errors.As(err, &problems) || !strings.Contains(err.Error(), "http_route") {
t.Fatalf("save = %v", err)
}
}

func TestAuxiliaryQueryRoutesIgnoreInvalidSiblings(t *testing.T) {
cfg := config.Config{DataDir: t.TempDir(), DuckDBMemory: "256MB", DuckDBThreads: 2, DuckDBMaxConns: 2}
repo, err := telemetrystore.Open(cfg.TelemetryDir())
if err != nil {
t.Fatal(err)
}
duck, err := engine.NewDuck(t.Context(), cfg, repo)
if err != nil {
t.Fatal(err)
}
executor := query.NewExecutor(duck, 30)
t.Cleanup(func() { executor.Close(); _ = duck.Close(); _ = repo.Close() })
from := time.Date(2026, 11, 1, 12, 0, 0, 0, time.UTC)
to := from.Add(time.Hour)
at := from.Add(time.Minute).UnixNano()
if err := repo.Commit(t.Context(), telemetrystore.Batch{ID: "auxiliary", Spans: []telemetry.Span{{ServiceName: "checkout", TraceID: "trace", SpanID: "root", Name: "GET /", StartUnixNanos: at, EndUnixNanos: at + 1000000, DurationMS: 1}}}); err != nil {
t.Fatal(err)
}
spec := query.Dashboard{Name: "Stale sibling", Time: query.Time{From: &from, To: &to}, Variables: []query.Variable{{Name: "service", Kind: "query", From: "spans", Field: "service", Default: "checkout"}}, Panels: []query.Panel{
{ID: "healthy", Title: "Healthy", Viz: "stat", Query: &query.Spec{From: "spans", Measures: []string{"count()"}, Where: []string{"service = $service"}}},
{ID: "stale", Title: "Stale", Viz: "bar", Query: &query.Spec{From: "spans", Measures: []string{"count()"}, By: []string{"http_route"}}},
}}
post := func(path string, input any) *httptest.ResponseRecorder {
t.Helper()
raw, err := json.Marshal(input)
if err != nil {
t.Fatal(err)
}
return servePanels(t, executor, http.MethodPost, path, string(raw))
}
rec := post("/api/queries/variables/resolve", query.ResolveRequest{Dashboard: spec})
var options struct {
Options map[string][]query.Option `json:"options"`
}
if rec.Code != http.StatusOK || json.Unmarshal(rec.Body.Bytes(), &options) != nil || len(options.Options["service"]) != 1 || options.Options["service"][0].Value != "checkout" {
t.Fatalf("variables: %d %s", rec.Code, rec.Body)
}
req := query.ExemplarRequest{Dashboard: spec, PanelID: "healthy", From: from, To: to}
rec = post("/api/queries/exemplars", req)
var exemplars query.ExemplarResponse
if rec.Code != http.StatusOK || json.Unmarshal(rec.Body.Bytes(), &exemplars) != nil || len(exemplars.Traces) != 1 {
t.Fatalf("healthy exemplars: %d %s", rec.Code, rec.Body)
}
req.PanelID = "stale"
rec = post("/api/queries/exemplars", req)
if rec.Code != http.StatusBadRequest || !strings.Contains(rec.Body.String(), "panels[1].query.by[0]") {
t.Fatalf("invalid selected panel: %d %s", rec.Code, rec.Body)
}
spec.Variables[0].Where = []string{"http_route = '/cart'"}
spec.Panels[1] = query.Panel{ID: "stale", Title: "Stale", Viz: "unknown"}
for _, path := range []string{"/api/queries/variables/resolve", "/api/queries/exemplars", "/api/queries/run"} {
var input any = query.RunRequest{Dashboard: spec}
if path == "/api/queries/variables/resolve" {
input = query.ResolveRequest{Dashboard: spec}
}
if path == "/api/queries/exemplars" {
input = query.ExemplarRequest{Dashboard: spec, PanelID: "healthy", From: from, To: to}
}
rec = post(path, input)
if rec.Code != http.StatusBadRequest || !strings.Contains(rec.Body.String(), "variables[0].where[0]") || !strings.Contains(rec.Body.String(), "panels[1].viz") {
t.Fatalf("global failure %s: %d %s", path, rec.Code, rec.Body)
}
}
}
4 changes: 2 additions & 2 deletions internal/mcp/apps/panels.html

Large diffs are not rendered by default.

18 changes: 12 additions & 6 deletions internal/mcp/dashboards.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,13 @@ type dashboardOutput struct {
}

type savedPanelCheck struct {
ID string `json:"id"`
Status string `json:"status"`
Rows int `json:"rows" jsonschema:"Executed rows or nonempty text content; not a measurement when status is not_run"`
Diagnosis string `json:"diagnosis,omitempty"`
Error string `json:"error,omitempty"`
ElapsedMS *int64 `json:"elapsed_ms,omitempty" jsonschema:"Execution duration in milliseconds; omitted when the panel did not run"`
Problems query.Problems `json:"problems,omitempty"`
ID string `json:"id"`
Status string `json:"status"`
Rows int `json:"rows" jsonschema:"Executed rows or nonempty text content; not a measurement when status is not_run"`
Diagnosis string `json:"diagnosis,omitempty"`
Error string `json:"error,omitempty"`
ElapsedMS *int64 `json:"elapsed_ms,omitempty" jsonschema:"Execution duration in milliseconds; omitted when the panel did not run"`
}

type saveCheck struct {
Expand Down Expand Up @@ -379,6 +380,11 @@ func (s *Server) saved(ctx context.Context, verb string, mutation dashboard.Muta
continue
}
r := matches[0]
if r.Status == query.StatusInvalid {
check.Panels[i] = savedPanelCheck{ID: r.ID, Status: r.Status, Problems: query.PresentProblems(r.Problems), Error: query.PresentMessage(r.Error)}
out.Warnings = append(out.Warnings, fmt.Sprintf("%s is invalid: %s", r.ID, check.Panels[i].Error))
continue
}
if r.Status != query.StatusOK && r.Status != query.StatusEmpty && r.Status != query.StatusError {
complete = false
continue
Expand Down
32 changes: 32 additions & 0 deletions internal/mcp/fanql_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package mcp
import (
"context"
"encoding/json"
"errors"
"reflect"
"strings"
"testing"
Expand Down Expand Up @@ -253,3 +254,34 @@ func TestFragmentRawJSONIsNotAnInteger(t *testing.T) {
t.Fatalf("arbitrary JSON restricted to integer: %s", raw)
}
}

func TestQueryTelemetryKeepsInvalidPanelProblems(t *testing.T) {
s := newPanelServer(t)
client := connectTestClient(t, s, nil)
for _, panel := range []query.Panel{
{ID: "stale", Title: "Stale", Viz: "table", SQL: "SELECT http_route FROM spans WHERE $__window(start_time)"},
{ID: "stale", Title: "Stale", Viz: "table", Query: &query.Spec{From: "spans", Measures: []string{"count()"}, By: []string{"http_route"}}},
} {
result, out, err := s.queryTelemetry(t.Context(), nil, QueryTelemetryInput{Panel: panel})
var problems query.Problems
if !errors.As(err, &problems) || len(problems) == 0 || !strings.Contains(problems[0].Message, "http_route") || result != nil || out.PanelFragment != nil {
t.Fatalf("invalid query: %+v %+v %v", result, out, err)
}
want := "panels[0].query.by[0]"
if panel.SQL != "" {
want = "panels[0].sql"
}
if problems[0].Path != want {
t.Fatalf("problem path: %+v", problems)
}
wire, err := client.CallTool(t.Context(), &mcp.CallToolParams{Name: "query_telemetry", Arguments: map[string]any{"panel": panel}})
if err != nil || wire == nil || !wire.IsError {
t.Fatalf("tool failure: %+v %v", wire, err)
}
text := wire.Content[0].(*mcp.TextContent).Text
if !strings.Contains(text, want) || !strings.Contains(text, "http_route") {
t.Fatalf("tool diagnostics: %s", text)
}

}
}
9 changes: 9 additions & 0 deletions internal/mcp/fragments.go
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,15 @@ func (s *Server) queryTelemetry(ctx context.Context, _ *mcp.CallToolRequest, inp
}
d := query.Dashboard{Name: input.Panel.Title, Variables: input.Variables, Panels: []query.Panel{input.Panel}}
result, out, err := s.runFragment(ctx, query.RunRequest{Dashboard: d, Time: input.Time, Vars: input.Vars})
// This tool authors one panel: preserve its validation-failure contract
// rather than publishing an invalid query as a successful view.
if err == nil {
for _, r := range out.Results {
if r.Status == query.StatusInvalid {
return nil, QueryTelemetryOutput{}, safePanelToolError(r.Problems)
}
}
}
response := QueryTelemetryOutput{PanelFragment: &out}
if err == nil && input.Text != "" {
response.Notices = notices
Expand Down
4 changes: 4 additions & 0 deletions internal/mcp/panels.go
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ func (s *Server) previewPanels(ctx context.Context, _ *mcp.CallToolRequest, inpu
}
for i, r := range results {
preview := PanelPreview{ElapsedMS: &r.ElapsedMS, ID: r.ID, Status: r.Status, Interval: r.Interval, Diagnosis: query.PresentDiagnosis(r.Diagnosis), Error: query.PresentMessage(r.Error)}
preview.Problems = query.PresentProblems(r.Problems)
if r.Status == query.StatusInvalid {
preview.ElapsedMS = nil
}
if r.Frame != nil {
preview.Rows = r.Frame.Rows
for _, c := range r.Frame.Columns {
Expand Down
16 changes: 12 additions & 4 deletions internal/mcp/panels_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,11 @@ func TestPreviewPanelsReportsEachPanel(t *testing.T) {
if out.Panels[1].Status != "invalid" || !strings.Contains(out.Panels[1].Problems[0].Message+out.Panels[1].Problems[0].Hint, "duration_ms") {
t.Fatalf("typo preview = %+v", out.Panels[1])
}
if out.Panels[0].Status != "not_run" {
t.Fatalf("a valid panel is not run while another is invalid: %+v", out.Panels[0])
if out.Panels[0].Status != "ok" {
t.Fatalf("valid panel did not run alongside invalid sibling: %+v", out.Panels[0])
}
if out.ElapsedMS < 0 || out.Panels[0].ElapsedMS != nil || out.Panels[1].ElapsedMS != nil {
t.Fatalf("invalid/not_run timing = %+v", out)
if out.ElapsedMS < 0 || out.Panels[0].ElapsedMS == nil || out.Panels[1].ElapsedMS != nil {
t.Fatalf("valid/invalid timing = %+v", out)
}
result, out, err := s.previewPanels(t.Context(), nil, PreviewInput{Panels: []query.Panel{{ID: "requests", Title: "Requests", Viz: "stat", Query: &query.Spec{From: "spans", Measures: []string{"count()"}}}}})
if err != nil || out.Panels[0].Status != "ok" || out.Panels[0].Diagnosis == "" || !strings.Contains(result.Content[0].(*mcp.TextContent).Text, "requests counted nothing: No spans") {
Expand Down Expand Up @@ -230,3 +230,11 @@ func TestTelemetrySchemaReportsBusy(t *testing.T) {
t.Fatalf("err=%v", err)
}
}

func TestPreviewRetainsPanelProblemsWhenVariablesFailLater(t *testing.T) {
s := newPanelServer(t)
_, out, err := s.previewPanels(t.Context(), nil, PreviewInput{Variables: []query.Variable{{Name: "service", Kind: "query", From: "spans", Field: "service", Where: []string{"http_route = '/cart'"}}}, Panels: []query.Panel{{ID: "broken", Title: "Broken", Viz: "unknown"}}})
if err != nil || len(out.Panels) != 1 || out.Panels[0].Status != "invalid" || len(out.Panels[0].Problems) != 1 || out.Panels[0].Problems[0].Path != "panels[0].viz" || len(out.Problems) != 1 || out.Problems[0].Path != "variables[0].where[0]" {
t.Fatalf("preview: %+v %v", out, err)
}
}
20 changes: 19 additions & 1 deletion internal/mcp/receipt_quality_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ func TestUnexecutedPanelRowsOmitTimingMeasurements(t *testing.T) {
t.Fatal(err)
}
for _, p := range value.Panels {
if _, ok := p["elapsed_ms"]; ok {
if _, ok := p["elapsed_ms"]; ok && p["status"] != "ok" {
t.Errorf("unexecuted %v serializes a timing: %s", p["status"], raw)
}
}
Expand Down Expand Up @@ -154,3 +154,21 @@ func TestNoOpDashboardEditCreatesADocumentedVersionWithoutChips(t *testing.T) {
t.Fatal("no-op saves are not documented")
}
}

func TestSaveReceiptRetainsInvalidPanelDiagnostics(t *testing.T) {
problems := query.Problems{{Path: "panels[0].sql", Message: "unknown field http_route"}}
s := newToolServer(t, structural{}, receiptExecutor{run: func(context.Context, query.RunRequest) ([]query.Result, error) {
return []query.Result{{ID: "notes", Status: query.StatusInvalid, Problems: problems, Error: problems.Error()}}, nil
}})
_, out, err := s.dashboardCreate(t.Context(), ownerRequest(), DashboardCreateInput{Dashboard: textDashboard("Invalid check")})
if err != nil {
t.Fatal(err)
}
check := out.Receipt.SaveCheck
if !check.Checked || check.Reason != "" || check.Panels[0].Status != query.StatusInvalid || len(check.Panels[0].Problems) != 1 || check.Panels[0].Problems[0].Path != problems[0].Path || check.Panels[0].ElapsedMS != nil || !strings.Contains(check.Panels[0].Error, "http_route") {
t.Fatalf("save check: %+v", check)
}
if len(out.Warnings) != 1 || !strings.Contains(out.Warnings[0], "http_route") {
t.Fatalf("warnings: %+v", out.Warnings)
}
}
7 changes: 7 additions & 0 deletions internal/query/check.go
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,13 @@ func checkWith(ctx context.Context, parser Parser, d *Dashboard, memo *checkMemo
if len(problems) > 0 {
return nil, problems, nil
}
return checkValidated(ctx, parser, d, memo)
}

// checkValidated runs database checks after structural validation. Run may pass
// no panels after isolating invalid ones, but must still check variables.
func checkValidated(ctx context.Context, parser Parser, d *Dashboard, memo *checkMemo) (*Checked, Problems, error) {
var problems Problems
checked := &Checked{AnnotationFilters: map[string][]AnnotationFilter{}, Filters: map[string][]Filter{}, VarFilters: map[string][]Filter{}, Measures: map[string][]Measure{}}
earlier := map[string]Variable{}
varsKey := memoKey(d.Variables, nil)
Expand Down
7 changes: 3 additions & 4 deletions internal/query/check_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package query

import (
"context"
"errors"
"strings"
"testing"
"time"
Expand Down Expand Up @@ -76,10 +75,10 @@ func TestSQLTimestampComparisonsReturnRepairHintOrExactResults(t *testing.T) {
d := Dashboard{Name: "Time literals", Panels: []Panel{{ID: "p", Title: "Calls", Viz: "table", SQL: "SELECT count(*) AS n FROM spans WHERE $__window(start_time) AND " + tc.predicate}}}
results, err := executor.Run(t.Context(), RunRequest{Dashboard: d})
if tc.invalid {
var problems Problems
if !errors.As(err, &problems) || len(problems) != 1 {
t.Fatalf("expected one SQL problem, got %v", err)
if err != nil || len(results) != 1 || results[0].Status != StatusInvalid || len(results[0].Problems) != 1 {
t.Fatalf("expected one SQL problem, got %+v %v", results, err)
}
problems := results[0].Problems
// Each publication boundary may present the same problem again.
for range 3 {
problems = PresentProblems(problems)
Expand Down
Loading
Loading