Files
multica/server/internal/handler/runtime_test.go
YYClaw 614dfae884 MUL-2488 feat(timezone): Scheduling / Viewing two-layer timezone architecture (#2968)
* docs(timezone): add scheduling/viewing timezone architecture RFC

* feat(db): replace daily rollups with task_usage_hourly, add user.timezone

Migrations 100-104: add "user".timezone (Viewing tz), build the UTC
hourly task_usage_hourly rollup with its pipeline, drop the legacy
task_usage_daily / task_usage_dashboard_daily pipelines, and drop the
agent_runtime.timezone column. Report queries now slice day boundaries
at read time by the caller-supplied @tz instead of materialising in a
fixed tz. Regenerate sqlc.

* feat(server): add task_usage_hourly backfill command

Replace the two legacy backfill commands (daily / dashboard_daily) with
a single backfill_task_usage_hourly that loads historical task_usage
into the new UTC hourly rollup, sliced per workspace.

* refactor(server): resolve viewing timezone in report handlers

Report handlers resolve the Viewing tz per request (?tz query param,
then user.timezone, then UTC) and pass it to the hourly-rollup queries.
Drop the UseDailyRollup feature flags and the old raw-scan/daily-rollup
dual paths, remove the /api/usage endpoints, and stop the daemon from
reporting and the runtime handler from accepting host timezone.

* refactor(core): switch report queries to viewing timezone

API client and dashboard/runtime queries send ?tz with each report
request, the user schema/types carry the new timezone field, and the
runtime timezone field/mutation is removed.

* feat(views): add viewing timezone preference and UI

Add the useViewingTimezone hook and a Timezone setting in Preferences;
report charts and the dashboard week boundary follow the viewer tz.
Remove the runtime detail timezone editor and its locale strings.

* fix(test): update fixtures and stabilize tests for timezone refactor

The timezone architecture refactor changed several types without
updating dependent test code:

- RuntimeDevice no longer has a timezone field — drop it from the
  create-agent-dialog runtime fixture.
- User now requires a timezone field — add it to the apps/web mockUser
  fixture.
- The PreferencesTab timezone tests asserted on the async save handler
  (PATCH then store update) with a bare expect, racing the mutation's
  settle callback, and timed out querying the Select's ~600-option IANA
  list on a loaded CI runner. Wrap the assertions in waitFor and extend
  the timeout for those three tests.

* docs(timezone): document self-host migration order and trigger invariant

Add a SELF-HOST UPGRADE ORDER runbook to the backfill command's package
comment: applying migrations 100-104 in a single migrate-up drops the
legacy daily rollups before the hourly backfill runs, leaving dashboards
empty until cron catches up.

Add an INVARIANT comment on trg_atq_dirty_hourly noting that agent_id
must be added to the trigger's OF list if it ever becomes mutable,
otherwise dirty buckets for the old agent_id are silently missed.

* style(runtimes): drop trailing blank line in runtime-detail
2026-05-21 15:33:47 +08:00

383 lines
14 KiB
Go

package handler
import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
"time"
"github.com/jackc/pgx/v5/pgtype"
)
func TestRuntimeHandlersRejectMalformedRuntimeID(t *testing.T) {
tests := []struct {
name string
method string
path string
handle func(http.ResponseWriter, *http.Request)
}{
{
name: "usage",
method: "GET",
path: "/api/runtimes/not-a-uuid/usage",
handle: testHandler.GetRuntimeUsage,
},
{
name: "task activity",
method: "GET",
path: "/api/runtimes/not-a-uuid/task-activity",
handle: testHandler.GetRuntimeTaskActivity,
},
{
name: "delete",
method: "DELETE",
path: "/api/runtimes/not-a-uuid",
handle: testHandler.DeleteAgentRuntime,
},
{
name: "models",
method: "POST",
path: "/api/runtimes/not-a-uuid/models",
handle: testHandler.InitiateListModels,
},
{
name: "update",
method: "POST",
path: "/api/runtimes/not-a-uuid/update",
handle: testHandler.InitiateUpdate,
},
{
name: "local skills",
method: "POST",
path: "/api/runtimes/not-a-uuid/local-skills",
handle: testHandler.InitiateListLocalSkills,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
w := httptest.NewRecorder()
req := newRequest(tt.method, tt.path, nil)
req = withURLParam(req, "runtimeId", "not-a-uuid")
tt.handle(w, req)
if w.Code != http.StatusBadRequest {
t.Fatalf("%s: expected 400 for malformed runtimeId, got %d: %s", tt.name, w.Code, w.Body.String())
}
})
}
}
// TestGetRuntimeUsage_BucketsByUsageTime ensures a task that was enqueued on
// one calendar day but whose tokens were reported the next day (e.g. execution
// crossed midnight, or the task sat in the queue) is attributed to the day
// tokens were actually produced, not the enqueue day. It also verifies the
// ?days=N cutoff covers the full earliest calendar day, not just "now minus N
// days" which would clip the morning of that day.
func TestGetRuntimeUsage_BucketsByUsageTime(t *testing.T) {
if testHandler == nil {
t.Skip("database not available")
}
ctx := context.Background()
// Pick a runtime bound to the fixture workspace.
var runtimeID string
if err := testPool.QueryRow(ctx, `
SELECT id FROM agent_runtime WHERE workspace_id = $1 LIMIT 1
`, testWorkspaceID).Scan(&runtimeID); err != nil {
t.Fatalf("fetch runtime: %v", err)
}
var agentID string
if err := testPool.QueryRow(ctx, `
SELECT id FROM agent WHERE workspace_id = $1 LIMIT 1
`, testWorkspaceID).Scan(&agentID); err != nil {
t.Fatalf("fetch agent: %v", err)
}
// Create an issue for the tasks to reference.
var issueID string
if err := testPool.QueryRow(ctx, `
INSERT INTO issue (workspace_id, title, creator_id, creator_type)
VALUES ($1, 'runtime usage test', $2, 'member')
RETURNING id
`, testWorkspaceID, testUserID).Scan(&issueID); err != nil {
t.Fatalf("create issue: %v", err)
}
t.Cleanup(func() {
testPool.Exec(ctx, `DELETE FROM issue WHERE id = $1`, issueID)
})
// enqueued yesterday 23:58 UTC, finished today 00:05 UTC — tokens belong to today.
now := time.Now().UTC()
today := time.Date(now.Year(), now.Month(), now.Day(), 0, 0, 0, 0, time.UTC)
yesterdayLate := today.Add(-2 * time.Minute)
todayEarly := today.Add(5 * time.Minute)
// Task that ran entirely yesterday around 05:00 — used to verify the
// ?days cutoff isn't clipping yesterday's morning.
yesterdayMorning := today.Add(-19 * time.Hour)
insertTaskWithUsage := func(enqueueAt, usageAt time.Time, inputTokens int64) string {
var taskID string
if err := testPool.QueryRow(ctx, `
INSERT INTO agent_task_queue (agent_id, issue_id, runtime_id, status, created_at)
VALUES ($1, $2, $3, 'completed', $4)
RETURNING id
`, agentID, issueID, runtimeID, enqueueAt).Scan(&taskID); err != nil {
t.Fatalf("insert task: %v", err)
}
if _, err := testPool.Exec(ctx, `
INSERT INTO task_usage (task_id, provider, model, input_tokens, output_tokens, created_at)
VALUES ($1, 'claude', 'claude-3-5-sonnet', $2, 0, $3)
`, taskID, inputTokens, usageAt); err != nil {
t.Fatalf("insert task_usage: %v", err)
}
t.Cleanup(func() {
testPool.Exec(ctx, `DELETE FROM agent_task_queue WHERE id = $1`, taskID)
})
return taskID
}
insertTaskWithUsage(yesterdayLate, todayEarly, 1000) // cross-midnight
insertTaskWithUsage(yesterdayMorning, yesterdayMorning, 2000) // full-day yesterday
// ListRuntimeUsage reads from task_usage_hourly,
// aggregated to per-(date, provider, model) at query time. The
// window function is idempotent, so re-running this test rewrites
// the same totals.
if _, err := testPool.Exec(ctx, `
SELECT rollup_task_usage_hourly_window('-infinity'::timestamptz, 'infinity'::timestamptz)
`); err != nil {
t.Fatalf("rollup window: %v", err)
}
t.Cleanup(func() {
// Hourly buckets touched by this test cover the two calendar
// days in fixture data (today and yesterday in UTC, which is
// what the test uses for `today` / `yesterday` mocks).
testPool.Exec(ctx, `
DELETE FROM task_usage_hourly
WHERE runtime_id = $1
AND DATE(bucket_hour AT TIME ZONE 'UTC') IN ($2::date, $3::date)
`, runtimeID, today, today.Add(-24*time.Hour))
})
// Call the handler with ?days=1 at whatever "now" is. That should include
// both today and yesterday in full.
w := httptest.NewRecorder()
req := newRequest("GET", "/api/runtimes/"+runtimeID+"/usage?days=1", nil)
req = withURLParam(req, "runtimeId", runtimeID)
testHandler.GetRuntimeUsage(w, req)
if w.Code != http.StatusOK {
t.Fatalf("GetRuntimeUsage: expected 200, got %d: %s", w.Code, w.Body.String())
}
var resp []RuntimeUsageResponse
if err := json.NewDecoder(w.Body).Decode(&resp); err != nil {
t.Fatalf("decode response: %v", err)
}
byDate := make(map[string]int64)
for _, r := range resp {
byDate[r.Date] += r.InputTokens
}
todayKey := today.Format("2006-01-02")
yesterdayKey := today.Add(-24 * time.Hour).Format("2006-01-02")
// Cross-midnight task must attribute to today (tu.created_at), not yesterday
// (atq.created_at). Before the fix this was 0 on today / 1000 on yesterday.
if byDate[todayKey] != 1000 {
t.Errorf("cross-midnight task: today bucket expected 1000 input tokens, got %d (full map: %v)", byDate[todayKey], byDate)
}
// Yesterday's morning task must still be included — this is what breaks
// when ?days=N is interpreted as a rolling window instead of calendar days.
if byDate[yesterdayKey] != 2000 {
t.Errorf("yesterday morning task: yesterday bucket expected 2000 input tokens, got %d (full map: %v)", byDate[yesterdayKey], byDate)
}
}
// TestListRuntimeUsageBucketsByViewerTimezone proves the runtime trend reads
// bucket the day boundary in the VIEWER's tz (the argument passed to
// listRuntimeUsage). The viewer tz is Asia/Shanghai; assertions only pass if
// listRuntimeUsage applies that tz correctly.
func TestListRuntimeUsageBucketsByViewerTimezone(t *testing.T) {
if testHandler == nil {
t.Skip("database not available")
}
ctx := context.Background()
runtimeID := handlerTestRuntimeID(t)
loc, err := time.LoadLocation("Asia/Shanghai")
if err != nil {
t.Fatalf("load location: %v", err)
}
cutoff := time.Date(2026, 5, 4, 0, 0, 0, 0, loc)
cutoffDate := cutoff.Format("2006-01-02")
extraDate := cutoff.AddDate(0, 0, -1).Format("2006-01-02")
t.Cleanup(func() {
testPool.Exec(ctx, `DELETE FROM task_usage_hourly WHERE runtime_id = $1 AND provider = 'cutoff-test'`, runtimeID)
})
// Seed task_usage_hourly directly with one bucket per Shanghai calendar
// day. Pick 04:00 local (= 20:00 UTC the previous day) to catch
// off-by-one tz-cutoff bugs.
var agentID pgtype.UUID
if err := testPool.QueryRow(ctx, `
SELECT id FROM agent WHERE workspace_id = $1 ORDER BY id LIMIT 1
`, testWorkspaceID).Scan(&agentID); err != nil {
t.Fatalf("pick fixture agent: %v", err)
}
if _, err := testPool.Exec(ctx, `
INSERT INTO task_usage_hourly (
bucket_hour, workspace_id, runtime_id, agent_id, project_id,
provider, model,
input_tokens, output_tokens, cache_read_tokens, cache_write_tokens, event_count
)
VALUES
(($1::date + interval '4 hours') AT TIME ZONE 'Asia/Shanghai', $3, $4, $5, NULL,
'cutoff-test', 'old-day', 111, 0, 0, 0, 1),
(($2::date + interval '4 hours') AT TIME ZONE 'Asia/Shanghai', $3, $4, $5, NULL,
'cutoff-test', 'cutoff-day', 222, 0, 0, 0, 1)
ON CONFLICT ON CONSTRAINT uq_task_usage_hourly_key DO UPDATE
SET input_tokens = EXCLUDED.input_tokens,
output_tokens = EXCLUDED.output_tokens,
cache_read_tokens = EXCLUDED.cache_read_tokens,
cache_write_tokens = EXCLUDED.cache_write_tokens,
event_count = EXCLUDED.event_count
`, extraDate, cutoffDate, testWorkspaceID, runtimeID, agentID); err != nil {
t.Fatalf("seed hourly rows: %v", err)
}
resp, err := testHandler.listRuntimeUsage(ctx, parseUUID(runtimeID), "Asia/Shanghai", pgtype.Timestamptz{
Time: cutoff,
Valid: true,
})
if err != nil {
t.Fatalf("listRuntimeUsage: %v", err)
}
byDate := make(map[string]int64)
for _, row := range resp {
if row.Provider == "cutoff-test" {
byDate[row.Date] += row.InputTokens
}
}
if byDate[cutoffDate] != 222 {
t.Fatalf("expected cutoff date %s to be included with 222 tokens, got map %v", cutoffDate, byDate)
}
if byDate[extraDate] != 0 {
t.Fatalf("expected extra date %s to be excluded, got map %v", extraDate, byDate)
}
}
// TestResolveViewingTZ covers the three legs of resolveViewingTZ:
// explicit `?tz=` query param, the authenticated user's stored
// user.timezone, and the UTC fallback when neither yields a valid zone.
func TestResolveViewingTZ(t *testing.T) {
if testHandler == nil {
t.Skip("database not available")
}
ctx := context.Background()
var userID string
if err := testPool.QueryRow(ctx,
`INSERT INTO "user" (name, email, timezone)
VALUES ('TZ Resolve', 'tz-resolve@multica.ai', 'Asia/Tokyo') RETURNING id`,
).Scan(&userID); err != nil {
t.Fatalf("insert user: %v", err)
}
t.Cleanup(func() { testPool.Exec(ctx, `DELETE FROM "user" WHERE id = $1`, userID) })
// Explicit ?tz= wins over the stored preference.
req := newRequest("GET", "/api/dashboard/usage/daily?tz=America/New_York", nil)
req.Header.Set("X-User-ID", userID)
if got := testHandler.resolveViewingTZ(req); got != "America/New_York" {
t.Fatalf("query param: expected America/New_York, got %q", got)
}
// No ?tz= → falls back to the authenticated user's stored timezone.
req = newRequest("GET", "/api/dashboard/usage/daily", nil)
req.Header.Set("X-User-ID", userID)
if got := testHandler.resolveViewingTZ(req); got != "Asia/Tokyo" {
t.Fatalf("stored fallback: expected Asia/Tokyo, got %q", got)
}
// An unparseable ?tz= is ignored, falling through to the stored value.
req = newRequest("GET", "/api/dashboard/usage/daily?tz=Mars/Olympus", nil)
req.Header.Set("X-User-ID", userID)
if got := testHandler.resolveViewingTZ(req); got != "Asia/Tokyo" {
t.Fatalf("invalid query param: expected Asia/Tokyo fallback, got %q", got)
}
// No ?tz= and no stored value → UTC.
var bareUserID string
if err := testPool.QueryRow(ctx,
`INSERT INTO "user" (name, email)
VALUES ('TZ Bare', 'tz-bare@multica.ai') RETURNING id`,
).Scan(&bareUserID); err != nil {
t.Fatalf("insert bare user: %v", err)
}
t.Cleanup(func() { testPool.Exec(ctx, `DELETE FROM "user" WHERE id = $1`, bareUserID) })
req = newRequest("GET", "/api/dashboard/usage/daily", nil)
req.Header.Set("X-User-ID", bareUserID)
if got := testHandler.resolveViewingTZ(req); got != "UTC" {
t.Fatalf("no preference: expected UTC, got %q", got)
}
// A stored timezone that is itself an invalid IANA zone — e.g. a row
// written before server-side validation existed — must fall through
// to UTC. Without the LoadLocation guard on the stored value this
// string would reach SQL `AT TIME ZONE` and 500 every dashboard read.
var badTZUserID string
if err := testPool.QueryRow(ctx,
`INSERT INTO "user" (name, email, timezone)
VALUES ('TZ Bad', 'tz-bad@multica.ai', 'Bad/Zone') RETURNING id`,
).Scan(&badTZUserID); err != nil {
t.Fatalf("insert bad-tz user: %v", err)
}
t.Cleanup(func() { testPool.Exec(ctx, `DELETE FROM "user" WHERE id = $1`, badTZUserID) })
req = newRequest("GET", "/api/dashboard/usage/daily", nil)
req.Header.Set("X-User-ID", badTZUserID)
if got := testHandler.resolveViewingTZ(req); got != "UTC" {
t.Fatalf("invalid stored tz: expected UTC fallback, got %q", got)
}
// No X-User-ID header and no ?tz= — an unauthenticated caller has
// neither signal, so the resolver must return UTC without attempting
// (and panicking on) a GetUser lookup.
req = newRequest("GET", "/api/dashboard/usage/daily", nil)
if got := testHandler.resolveViewingTZ(req); got != "UTC" {
t.Fatalf("unauthenticated caller: expected UTC, got %q", got)
}
}
// TestRuntimeHeatmapEndpointsUseViewerTZ verifies that the hour-of-day
// heatmap endpoints (GetRuntimeUsageByHour and GetRuntimeTaskActivity) bucket
// in the viewer's tz supplied via ?tz= and return 200.
func TestRuntimeHeatmapEndpointsUseViewerTZ(t *testing.T) {
if testHandler == nil {
t.Skip("database not available")
}
runtimeID := handlerTestRuntimeID(t)
cases := []struct {
name string
path string
handle func(http.ResponseWriter, *http.Request)
}{
{"usage by-hour", "/api/runtimes/" + runtimeID + "/usage/by-hour?tz=Asia/Shanghai", testHandler.GetRuntimeUsageByHour},
{"task activity", "/api/runtimes/" + runtimeID + "/activity?tz=Asia/Shanghai", testHandler.GetRuntimeTaskActivity},
}
for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
w := httptest.NewRecorder()
req := newRequest("GET", c.path, nil)
req = withURLParam(req, "runtimeId", runtimeID)
c.handle(w, req)
if w.Code != http.StatusOK {
t.Fatalf("%s: expected 200, got %d: %s", c.name, w.Code, w.Body.String())
}
})
}
}