🌱 dashboard: rename slogWarnOverviewEncode to logOverviewEncodeFailure

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)).

src/pkg/dashboard/overview_export.go

@@ -1,3 +1,3 @@
 package dashboard
 
 import (
@@ -83,18 +83,18 @@
 		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)
 	}

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())
 	}

src/pkg/dashboard/stage_tracker.go

@@ -1,3 +1,3 @@
 package dashboard
 
 import (
@@ -1685,12 +1685,12 @@
 	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 @@
 		body = bytes.Replace(body, stageTrackerSourceCache, stageTrackerSourceStale, 1)
 	}
 	if _, err := w.Write(body); err != nil {
-		slogWarnOverviewEncode(err)
+		logOverviewEncodeFailure(err)
 	}
 }