refactor: introduce summary holder

Signed-off-by: Andres Taylor <[email protected]>
planetscale · Nov 18, 2024 · c0ab4d9 · c0ab4d9
1 parent 591e697
commit c0ab4d9
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 8 deletions.
diff --git a/go/summarize/summarize-keys.go b/go/summarize/summarize-keys.go
@@ -45,6 +45,11 @@ type (
 		Pos  Position
 	}
 
+	Summary struct {
+		tables   []TableSummary
+		failures []FailuresSummary
+	}
+
 	TableSummary struct {
 		Table           string
 		ReadQueryCount  int
@@ -153,11 +158,11 @@ func printKeysSummary(out io.Writer, file readingSummary, now time.Time) {
 `
 	md.Printf(msg, now.Format(time.DateTime), file.Name)
 
-	tableSummaries, failuresSummaries := summarizeKeysQueries(file.AnalysedQueries)
+	summary := summarizeKeysQueries(file.AnalysedQueries)
 
-	renderTableUsage(tableSummaries, md)
+	renderTableUsage(summary.tables, md)
 	renderTablesJoined(md, file.AnalysedQueries)
-	renderFailures(md, failuresSummaries)
+	renderFailures(md, summary.failures)
 
 	_, err := md.WriteTo(out)
 	if err != nil {
@@ -315,7 +320,7 @@ func makeKey(lhs, rhs operators.Column) graphKey {
 	return graphKey{rhs.Table, lhs.Table}
 }
 
-func summarizeKeysQueries(queries *keys.Output) ([]TableSummary, []FailuresSummary) {
+func summarizeKeysQueries(queries *keys.Output) Summary {
 	tableSummaries := make(map[string]*TableSummary)
 	tableUsageWriteCounts := make(map[string]int)
 	tableUsageReadCounts := make(map[string]int)
@@ -373,7 +378,7 @@ func summarizeKeysQueries(queries *keys.Output) ([]TableSummary, []FailuresSumma
 		})
 	}
 
-	return result, failures
+	return Summary{tables: result, failures: failures}
 }
 
 func summarizeColumnUsage(tableSummary *TableSummary, query keys.QueryAnalysisResult) {

diff --git a/go/summarize/testdata/keys-summary.md b/go/summarize/testdata/keys-summary.md
@@ -148,7 +148,7 @@ partsupp ↔ supplier (Occurrences: 1)
 
 ```
 ## Failures
-|Query|Error|Count|
-|---|---|---|
-|I am a failing query;|syntax error at position 2 near 'I'|2|
+|Error|Count|
+|---|---|
+|syntax error at position 2 near 'I'|2|