add metadata to run summary

Author: Xetera

.github/workflows/custom.yaml

@@ -45,7 +45,5 @@ jobs:
         uses: ./
         env:
           GITHUB_TOKEN: ${{ github.token }}
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          postgres_url: http://query_doctor@localhost:5432/testing
-          log_path: /var/log/postgresql/postgres.log
+          POSTGRES_URL: http://query_doctor@localhost:5432/testing
+          # LOG_PATH: /var/log/postgresql/postgres.log

main.ts

@@ -23,10 +23,14 @@ function formatQuery(query: string) {
 }
 
 async function main() {
-  const logPath = process.env.LOG_PATH || core.getInput("log_path");
-  const postgresUrl = process.env.POSTGRES_URL || core.getInput("postgres_url");
-  console.log(logPath);
-  console.log(postgresUrl);
+  const logPath = process.env.LOG_PATH || "/var/log/postgresql/postgres.log";
+  const postgresUrl = process.env.POSTGRES_URL;
+  if (!postgresUrl) {
+    core.setFailed("POSTGRES_URL environment variable is not set");
+    Deno.exit(1);
+  }
+  const startDate = new Date();
+  const fileSize = Deno.statSync(logPath).size;
   // core.setOutput("time", new Date().toLocaleTimeString());
   const command = new Deno.Command("pgbadger", {
     stdout: "piped",
@@ -183,7 +187,13 @@ async function main() {
     }
   }
   const reporter = new GithubReporter(process.env.GITHUB_TOKEN);
-  await reporter.report({ recommendations });
+  await reporter.report({
+    recommendations,
+    metadata: {
+      logSize: fileSize,
+      timeElapsed: Date.now() - startTime,
+    },
+  });
   console.timeEnd("total");
   await output.status;
   console.log(`Ran ${matching} queries`);

reporters/github.ts

@@ -28,7 +28,6 @@ export class GithubReporter {
       (r) =>
         r.user &&
         r.body_html &&
-        r.user.type === "Bot" &&
         r.body_html.includes(GithubReporter.REVIEW_COMMENT_SUFFIX)
     );
     const recommendations = ctx.recommendations.map(
@@ -64,15 +63,28 @@ export class GithubReporter {
     `
     );
     let review: string;
+    const metadata = dedent`
+    <details>
+      <summary>Metadata</summary>
+      <dl>
+        <dt>Log size</dt>
+        <dd>${ctx.metadata.logSize}</dd>
+        <dt>Time elapsed</dt>
+        <dd>${ctx.metadata.timeElapsed}</dd>
+      </dl>
+    </details>
+    `;
     if (recommendations.length > 0) {
       review = dedent`
       # Found ${recommendations.length} queries that could be optimized
       ${recommendations.join("\n")}
+      ${metadata}
       ${GithubReporter.REVIEW_COMMENT_SUFFIX}
     `;
     } else {
       review = dedent`
       # Your queries are optimized!
+      ${metadata}
       ${GithubReporter.REVIEW_COMMENT_SUFFIX}
     `;
     }
@@ -97,8 +109,14 @@ export class GithubReporter {
   }
 }
 
+type ReportMetadata = {
+  logSize: number;
+  timeElapsed: number;
+};
+
 export type ReportContext = {
   recommendations: ReportIndexRecommendation[];
+  metadata: ReportMetadata;
 };
 
 export type ReportIndexRecommendation = {