From fd50235315eef60d2029bab70e29aadb60e90bc5 Mon Sep 17 00:00:00 2001 From: scanner <280983584+hivecommons-hive[bot]@users.noreply.github.com> Date: Tue, 27 Oct 2026 19:51:35 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=8C=B1=20dashboard:=20rename=20slogWarnOv?= =?UTF-8?q?erviewEncode=20to=20logOverviewEncodeFailure?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: scanner <280983584+hivecommons-hive[bot]@users.noreply.github.com> --- changelog.d/changed-14718.md | 1 + src/pkg/dashboard/overview_export.go | 6 +++--- src/pkg/dashboard/overview_export_14696_test.go | 4 ++-- src/pkg/dashboard/stage_tracker.go | 6 +++--- 4 files changed, 9 insertions(+), 8 deletions(-) create mode 100644 changelog.d/changed-14718.md diff --git a/changelog.d/changed-14718.md b/changelog.d/changed-14718.md new file mode 100644 index 0000000000..4d99c1fedd --- /dev/null +++ b/changelog.d/changed-14718.md @@ -0,0 +1 @@ +- dashboard: rename the overview-export encode-failure log helper from `slogWarnOverviewEncode` to `logOverviewEncodeFailure` to match its Debug-level client-disconnect handling ([#14718](https://github.com/hivecommons/hive/issues/14718)). diff --git a/src/pkg/dashboard/overview_export.go b/src/pkg/dashboard/overview_export.go index ccbe9f369b..0d0ddd722e 100644 --- a/src/pkg/dashboard/overview_export.go +++ b/src/pkg/dashboard/overview_export.go @@ -83,18 +83,18 @@ func (s *Server) handleOverviewExport(w http.ResponseWriter, r *http.Request, ki w.Header().Set("Content-Type", overviewJSONType) resp := overviewJSONResponse{Kind: kind, GeneratedAt: now, HiveID: status.HiveID, StaleDays: normalizeIssueBandsConfig(cfg).StaleDays, Bands: bands, Rows: rows} if err := json.NewEncoder(w).Encode(resp); err != nil { - slogWarnOverviewEncode(err) + logOverviewEncodeFailure(err) } return } w.Header().Set("Content-Type", overviewCSVType) w.Header().Set("Content-Disposition", `inline; filename="`+overviewFilename(status.HiveID, kind, filters, bands, now)+`"`) if _, err := w.Write([]byte(overviewCSV(rows, overviewCSVColumns(kind)))); err != nil { - slogWarnOverviewEncode(err) + logOverviewEncodeFailure(err) } } -func slogWarnOverviewEncode(err error) { +func logOverviewEncodeFailure(err error) { if err != nil { logEncodeFailure("overview export encode failed", err) } diff --git a/src/pkg/dashboard/overview_export_14696_test.go b/src/pkg/dashboard/overview_export_14696_test.go index 76a6537e7a..e83b79f389 100644 --- a/src/pkg/dashboard/overview_export_14696_test.go +++ b/src/pkg/dashboard/overview_export_14696_test.go @@ -17,13 +17,13 @@ func TestOverviewEncodeLogLevels14696(t *testing.T) { slog.SetDefault(slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{Level: slog.LevelDebug}))) defer slog.SetDefault(prev) - slogWarnOverviewEncode(&net.OpError{Op: "write", Err: os.NewSyscallError("write", syscall.EPIPE)}) + logOverviewEncodeFailure(&net.OpError{Op: "write", Err: os.NewSyscallError("write", syscall.EPIPE)}) if strings.Contains(buf.String(), "level=WARN") { t.Errorf("client disconnect must not log WARN, got:\n%s", buf.String()) } buf.Reset() - slogWarnOverviewEncode(errors.New("boom")) + logOverviewEncodeFailure(errors.New("boom")) if !strings.Contains(buf.String(), "level=WARN") { t.Errorf("genuine encode failure should log WARN, got:\n%s", buf.String()) } diff --git a/src/pkg/dashboard/stage_tracker.go b/src/pkg/dashboard/stage_tracker.go index 281077acf6..d752730a70 100644 --- a/src/pkg/dashboard/stage_tracker.go +++ b/src/pkg/dashboard/stage_tracker.go @@ -1685,12 +1685,12 @@ func (s *Server) encodeStageTracker(status *StatusPayload, now time.Time, ttl ti hashResp := resp hashResp.GeneratedAt = time.Time{} if err := json.NewEncoder(&hashBuf).Encode(hashResp); err != nil { - slogWarnOverviewEncode(err) + logOverviewEncodeFailure(err) return stageTrackerCache{}, false } var buf bytes.Buffer if err := json.NewEncoder(&buf).Encode(resp); err != nil { - slogWarnOverviewEncode(err) + logOverviewEncodeFailure(err) return stageTrackerCache{}, false } return stageTrackerCache{body: buf.Bytes(), etag: webstatic.ETagFor(hashBuf.Bytes()), generatedAt: now}, true @@ -1767,7 +1767,7 @@ func (s *Server) handleStageTracker(w http.ResponseWriter, r *http.Request) { body = bytes.Replace(body, stageTrackerSourceCache, stageTrackerSourceStale, 1) } if _, err := w.Write(body); err != nil { - slogWarnOverviewEncode(err) + logOverviewEncodeFailure(err) } }