Add a post step to report telemetry

Dockerfile

@@ -23,6 +23,8 @@ RUN yarn --frozen-lockfile
 
 COPY tsconfig.base.json tsconfig.json ./
 
+COPY scripts/post.sh /app
+
 COPY src src
 
 RUN yarn build

action.yml

@@ -65,6 +65,7 @@ outputs: {}
 runs:
   using: "docker"
   image: "docker://ghcr.io/alwaysmeticulous/report-diffs-action:main"
+  post-entrypoint: "/app/post.sh"
   env:
     API_TOKEN: ${{ inputs.api-token }}
     GITHUB_TOKEN: ${{ inputs.github-token }}

cloud-compute/action.yml

@@ -21,6 +21,7 @@ outputs: {}
 runs:
   using: node20
   main: "../out/cloud-compute.entrypoint.js"
+  post: "../out/post.entrypoint.js"
 branding:
   color: purple
   icon: camera

package.json

@@ -5,13 +5,21 @@
   "license": "Unliscensed",
   "private": true,
   "main": "dist/main.entrypoint.mjs",
+  "post": "out/post.entrypoint.js",
   "cloud-compute": "out/cloud-compute.entrypoint.js",
   "targets": {
     "main": {
       "source": "src/main.entrypoint.ts",
       "distDir": "dist",
       "outputFormat": "esmodule"
     },
+    "post": {
+      "source": "src/post.entrypoint.ts",
+      "includeNodeModules": true,
+      "distDir": "out",
+      "sourceMap": false,
+      "outputFormat": "commonjs"
+    },
     "cloud-compute": {
       "source": "src/cloud-compute.entrypoint.ts",
       "includeNodeModules": true,

scripts/post.sh

@@ -0,0 +1,3 @@
+#! /bin/bash
+
+node /app/out/post.entrypoint.js

src/common/run-post-step.ts

@@ -0,0 +1,58 @@
+import { getInput } from "@actions/core";
+import { context } from "@actions/github";
+import { createClient } from "@alwaysmeticulous/client";
+import { getInputFromEnv } from "./get-input-from-env";
+import { getOctokitOrFail } from "./octokit";
+
+export const runPostStep = async (): Promise<void> => {
+  const apiToken = getActionInput("api-token");
+  const githubToken = getActionInput("github-token");
+  const octokit = getOctokitOrFail(githubToken);
+  const workflow = await octokit.rest.actions.getWorkflowRun({
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    run_id: context.runId,
+  });
+
+  const values: Record<string, number> = {
+    "report_diffs_action.was_cancelled":
+      workflow.data.status === "cancelled" ? 1 : 0,
+  };
+
+  // This should always be true since the workflow is running, but we need to check it to make the compiler happy
+  if (workflow.data.run_started_at) {
+    const timeSinceStart =
+      new Date().getTime() - new Date(workflow.data.run_started_at).getTime();
+    values["report_diffs_action.job_duration_seconds"] = timeSinceStart / 1000;
+  }
+
+  if (context.payload.pull_request?.number) {
+    const shortSha = context.sha.slice(0, 7);
+    const prComments = await octokit.rest.issues.listComments({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      issue_number: context.payload.pull_request.number,
+    });
+    values["report_diffs_action.saw_comment"] = prComments.data.some(
+      (c) =>
+        c.body?.includes("alwaysmeticulous/report-diffs-action") &&
+        c.body?.includes(shortSha)
+    )
+      ? 1
+      : 0;
+  }
+
+  const client = createClient({ apiToken });
+  await client.post("test-runs/telemetry", { values });
+};
+
+const getActionInput = (name: string) => {
+  return (
+    getInput(name) ||
+    getInputFromEnv({
+      name: name,
+      required: true,
+      type: "string",
+    })
+  );
+};

src/post.entrypoint.ts

@@ -0,0 +1,8 @@
+import { warning } from "@actions/core";
+import { runPostStep } from "./common/run-post-step";
+
+runPostStep().catch((error) => {
+  // We're just emitting telemetry in this post step, so log a warning but don't fail
+  const message = error instanceof Error ? error.message : `${error}`;
+  warning(message);
+});