chore: use nunjucks for github reporter

Author: Xetera

.env

@@ -0,0 +1,2 @@
+POSTGRES_URL=postgres://postgres:123@localhost:5432/hatira_dev
+LOG_PATH=/tmp/postgres_logs/postgres.log

.github/workflows/build-action.yaml

@@ -19,19 +19,12 @@ jobs:
       - name: Install Deno
         uses: denoland/setup-deno@v2
         with:
-          cache-hash: ${{ hashFiles('deno.json', '**/deno.lock') }}
+          cache-hash: ${{ hashFiles('**/deno.lock') }}
           deno-version: v2.x
       - name: Export version
         run: |
           echo "DENO_VERSION=$(jq -r '.version' deno.json)" >> $GITHUB_ENV
 
-      # - name: Build Action
-      #   shell: bash
-      #   working-directory: ${{ github.action_path }}
-      #   run: |
-      #     deno compile --target x86_64-unknown-linux-gnu --allow-run --allow-read --allow-write --allow-env --allow-net -o bin/analyzer_${{ env.DENO_VERSION }}_linux_x86_64 main.ts
-      #     deno compile --target aarch64-unknown-linux-gnu --allow-run --allow-read --allow-write --allow-env --allow-net -o bin/analyzer_${{ env.DENO_VERSION }}_linux_aarch64 main.ts
-
       - name: Upload files to release
         uses: softprops/action-gh-release@v2
         with:

action.yaml

@@ -66,7 +66,7 @@ runs:
     - name: Run Analyzer
       shell: bash
       working-directory: ${{ github.action_path }}
-      run: deno run --allow-run --allow-read --allow-write --allow-env --allow-net main.ts
+      run: deno run start
       env:
         INPUT_POSTGRES_URL: ${{ inputs.postgres_url }}
         INPUT_LOG_PATH: ${{ inputs.log_path }}

deno.json

@@ -2,7 +2,8 @@
   "$schema": "https://raw.githubusercontent.com/denoland/deno/refs/heads/main/cli/schemas/config-file.v1.json",
   "version": "0.0.1",
   "tasks": {
-    "dev": "deno run -A --watch main.ts"
+    "start": "deno run --env-file=.env -A --unstable-raw-imports main.ts",
+    "dev": "deno run --env-file=.env -A --unstable-raw-imports --watch main.ts"
   },
   "imports": {
     "@actions/core": "npm:@actions/core@^1.11.1",
@@ -12,8 +13,10 @@
     "@std/assert": "jsr:@std/assert@1",
     "@std/data-structures": "jsr:@std/data-structures@^1.0.8",
     "@std/fmt": "jsr:@std/fmt@^1.0.8",
+    "@types/nunjucks": "npm:@types/nunjucks@^3.2.6",
     "dedent": "npm:dedent@^1.6.0",
     "fast-csv": "npm:fast-csv@^5.0.2",
+    "nunjucks": "npm:nunjucks@^3.2.4",
     "pgsql-deparser": "npm:pgsql-deparser@^17.8.1",
     "sql-formatter": "npm:sql-formatter@^15.6.5",
     "sql-highlight": "npm:sql-highlight@^6.1.0",

deno.lock

@@ -8,12 +8,13 @@ import { Statistics } from "./optimizer/statistics.ts";
 import { IndexOptimizer } from "./optimizer/genalgo.ts";
 import process from "node:process";
 import { fingerprint } from "@libpg-query/parser";
-import {
-  GithubReporter,
-  ReportIndexRecommendation,
-} from "./reporters/github.ts";
+import { GithubReporter } from "./reporters/github/github.ts.tsx";
 import { preprocessEncodedJson } from "./json.ts";
 import { ExplainedLog } from "./pg_log.ts";
+import {
+  deriveIndexStatistics,
+  ReportIndexRecommendation,
+} from "./reporters/reporter.ts";
 
 function formatQuery(query: string) {
   return format(query, {
@@ -132,7 +133,7 @@ async function main() {
         console.log(
           "Skipping query that selects from catalog tables",
           selectsCatalog,
-          fingerprintNum
+          fingerprintNum,
         );
       }
       continue;
@@ -151,30 +152,31 @@ async function main() {
         } catch (err) {
           console.error(err);
           console.error(
-            `Something went wrong while running this query. Skipping`
+            `Something went wrong while running this query. Skipping`,
           );
           return;
         }
-        if (out.newIndexes.size > 0) {
+        if (out.kind === "ok" && out.newIndexes.size > 0) {
           const newIndexes = Array.from(out.newIndexes)
             .map((n) => out.triedIndexes.get(n)?.definition)
             .filter((n) => n !== undefined);
           const existingIndexesForQuery = Array.from(out.existingIndexes)
             .map((index) => {
               const existing = existingIndexes.find(
-                (e) => e.index_name === index
+                (e) => e.index_name === index,
               );
               if (existing) {
-                return `${existing.schema_name}.${
-                  existing.table_name
-                }(${existing.index_columns
-                  .map((c) => `"${c.name}" ${c.order}`)
-                  .join(", ")})`;
+                return `${existing.schema_name}.${existing.table_name}(${
+                  existing.index_columns
+                    .map((c) => `"${c.name}" ${c.order}`)
+                    .join(", ")
+                })`;
               }
             })
             .filter((i) => i !== undefined);
           console.log(`New indexes: ${newIndexes.join(", ")}`);
           recommendations.push({
+            fingerprint: fingerprintNum,
             formattedQuery: formatQuery(query),
             baseCost: out.baseCost,
             optimizedCost: out.finalCost,
@@ -192,10 +194,12 @@ async function main() {
   await output.status;
   console.log(`Matched ${matching} queries out of ${allQueries}`);
   const reporter = new GithubReporter(process.env.GITHUB_TOKEN);
+  const statistics = deriveIndexStatistics(recommendations);
   await reporter.report({
     recommendations,
-    queriesLookedAt: matching,
-    totalQueries: allQueries,
+    queriesMatched: matching,
+    queriesSeen: allQueries,
+    statistics,
     error,
     metadata: {
       logSize: fileSize,
@@ -207,6 +211,57 @@ async function main() {
 }
 
 if (import.meta.main) {
+  //   const reporter = new GithubReporter(process.env.GITHUB_TOKEN);
+  //   reporter.report({
+  //     metadata: {
+  //       logSize: 100,
+  //       timeElapsed: 100,
+  //     },
+  //     queriesMatched: 2,
+  //     queriesSeen: 100,
+  //     recommendations: [
+  //       {
+  //         fingerprint: "1234567890",
+  //         formattedQuery: `select
+  //   "id",
+  //   "ladder_id",
+  //   "challenger_id",
+  //   "opponent_id",
+  //   "match_date",
+  //   "outcome",
+  //   "rounds_won",
+  //   "rounds_lost",
+  //   "created_at",
+  //   "updated_at",
+  //   "deleted_at"
+  // from
+  //   "matches"
+  // where
+  //   (
+  //     (
+  //       "matches"."challenger_id" = $1
+  //       or "matches"."opponent_id" = $2
+  //     )
+  //     and "matches"."deleted_at" is null
+  //   )`,
+  //         baseCost: 100,
+  //         optimizedCost: 50,
+  //         existingIndexes: [],
+  //         proposedIndexes: ["assets(id, name)"],
+  //         explainPlan: {},
+  //         // isQueryLong: true
+  //       },
+  //       {
+  //         fingerprint: "999999",
+  //         formattedQuery: "SELECT * FROM users where aa",
+  //         baseCost: 1000,
+  //         optimizedCost: 50,
+  //         existingIndexes: [],
+  //         proposedIndexes: ["assets(id, name)", "guests(gaming, ez)"],
+  //         explainPlan: { hello: "world" },
+  //       },
+  //     ],
+  //   });
   await main();
 }