Add query plans to the html

Signed-off-by: Florent Poinsard <[email protected]>
planetscale · Dec 12, 2024 · aa1ba18 · aa1ba18
1 parent ff2bae4
commit aa1ba18
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 6 deletions.
diff --git a/go/summarize/markdown.go b/go/summarize/markdown.go
@@ -245,11 +245,11 @@ func renderPlansSection(md *markdown.MarkDown, analysis PlanAnalysis) error {
 	md.PrintTable(headers, rows)
 	md.NewLine()
 
-	err := renderQueryPlans(md, analysis.simpleRouted, planalyze.SimpleRouted.String())
+	err := renderQueryPlans(md, analysis.SimpleRoutedQ, planalyze.SimpleRouted.String())
 	if err != nil {
 		return err
 	}
-	return renderQueryPlans(md, analysis.complex, planalyze.Complex.String())
+	return renderQueryPlans(md, analysis.ComplexQ, planalyze.Complex.String())
 }
 
 func renderQueryPlans(md *markdown.MarkDown, queries []planalyze.AnalyzedQuery, title string) error {

diff --git a/go/summarize/summarize-planalyze.go b/go/summarize/summarize-planalyze.go
@@ -32,7 +32,7 @@ func summarizePlanAnalyze(s *Summary, data planalyze.Output) (err error) {
 	s.addPlanResult(data.SimpleRouted)
 	s.addPlanResult(data.Complex)
 
-	s.PlanAnalysis.simpleRouted = append(s.PlanAnalysis.simpleRouted, data.SimpleRouted...)
-	s.PlanAnalysis.complex = append(s.PlanAnalysis.complex, data.Complex...)
+	s.PlanAnalysis.SimpleRoutedQ = append(s.PlanAnalysis.SimpleRoutedQ, data.SimpleRouted...)
+	s.PlanAnalysis.ComplexQ = append(s.PlanAnalysis.ComplexQ, data.Complex...)
 	return nil
 }
diff --git a/go/summarize/summary.go b/go/summarize/summary.go
@@ -89,8 +89,8 @@ type (
 		Unplannable  int
 		Total        int
 
-		simpleRouted []planalyze.AnalyzedQuery
-		complex      []planalyze.AnalyzedQuery
+		SimpleRoutedQ []planalyze.AnalyzedQuery
+		ComplexQ      []planalyze.AnalyzedQuery
 	}
 )
 

diff --git a/go/web/templates/summarize.html b/go/web/templates/summarize.html
@@ -47,6 +47,47 @@ <h1>Query Analysis Report</h1>
     </table>
 </div>
 
+<button class="collapsible">Query Plans</button>
+<div class="content">
+    <h3>Simple Routed Queries</h3>
+    {{range $index, $query := .PlanAnalysis.SimpleRoutedQ}}
+    <table>
+        <thead>
+        <tr>
+            <th>Query</th>
+        </tr>
+        </thead>
+        <tbody>
+        <tr>
+            <td style="text-align: left">{{$query.QueryStructure}}</td>
+        </tr>
+        </tbody>
+    </table>
+    <pre>
+        {{- jsonToString $query.PlanOutput}}
+    </pre>
+    {{end}}
+
+    <h3>Complex Queries</h3>
+    {{range $index, $query := .PlanAnalysis.ComplexQ}}
+    <table>
+        <thead>
+        <tr>
+            <th>Query</th>
+        </tr>
+        </thead>
+        <tbody>
+        <tr>
+            <td style="text-align: left">{{$query.QueryStructure}}</td>
+        </tr>
+        </tbody>
+    </table>
+    <pre>
+        {{- jsonToString $query.PlanOutput}}
+    </pre>
+    {{end}}
+</div>
+
 <button class="collapsible">Top Queries</button>
 <div class="content">
     <table>

diff --git a/go/web/web.go b/go/web/web.go
@@ -48,6 +48,11 @@ type SummaryOutput struct {
 
 func getFuncMap() template.FuncMap {
 	return template.FuncMap{
+		"jsonToString": func(j json.RawMessage) string {
+			var formattedJSON bytes.Buffer
+			_ = json.Indent(&formattedJSON, j, "", "  ")
+			return formattedJSON.String()
+		},
 		"add": func(a, b int) int { return a + b },
 		"divide": func(a, b any) float64 {
 			if b == 0 || b == nil {