feat: log all events (#299)

Author: gr2m

index.js

@@ -1,8 +1,8 @@
 module.exports = wip;
 
 const handlePullRequestChange = require("./lib/handle-pull-request-change");
-const handleMarketplacePurchase = require("./lib/handle-marketplace-purchase");
 const handleInstallation = require("./lib/handle-installation");
+const logEvent = require("./lib/log-event");
 
 /**
  * @param {import('probot').Probot} app
@@ -20,19 +20,12 @@ function wip(app) {
     handlePullRequestChange.bind(null, app)
   );
 
-  // listen to relevant marketplace purchase events
-  app.on(
-    [
-      "marketplace_purchase.purchased",
-      "marketplace_purchase.changed",
-      "marketplace_purchase.cancelled",
-    ],
-    handleMarketplacePurchase.bind(null, app)
-  );
-
   // listen to installation events
   app.on(
     ["installation", "installation_repositories"],
     handleInstallation.bind(null, app)
   );
+
+  // Log all events
+  app.on("*", logEvent);
 }

lib/handle-marketplace-purchase.js

@@ -0,0 +1,17 @@
+module.exports = logEvent;
+
+function logEvent({ id, name, payload, log }) {
+  const fullEventName = payload.action ? `${name}.${payload.action}` : name;
+  const owner = payload.installation.account.login.toLowerCase();
+  log.info(
+    {
+      id,
+      event: name,
+      action: payload.action,
+      installation: payload.installation.id,
+      owner,
+      isEventStat: true,
+    },
+    `${fullEventName} event received for ${owner} (id: ${id})`
+  );
+}

lib/log-event.js

@@ -0,0 +1,97 @@
+const Stream = require("stream");
+
+const { beforeEach, test, expectUncaughtException } = require("tap");
+const pino = require("pino");
+
+const { Probot, ProbotOctokit } = require("probot");
+
+const app = require("../../");
+
+let output;
+const streamLogsToOutput = new Stream.Writable({ objectMode: true });
+streamLogsToOutput._write = (object, encoding, done) => {
+  output.push(JSON.parse(object));
+  done();
+};
+
+beforeEach(function (done) {
+  // Clear log output
+  output = [];
+  delete process.env.APP_NAME;
+
+  this.probot = new Probot({
+    id: 1,
+    githubToken: "test",
+    Octokit: ProbotOctokit.defaults({
+      throttle: { enabled: false },
+      retry: { enabled: false },
+      log: pino(streamLogsToOutput),
+    }),
+    log: pino(streamLogsToOutput),
+  });
+  this.probot.load(app);
+
+  done();
+});
+
+test("logs event with action", async function (t) {
+  await this.probot.receive({
+    name: "check_run",
+    id: "event123",
+    payload: {
+      action: "completed",
+      installation: {
+        id: 1,
+        account: {
+          login: "wip",
+        },
+      },
+    },
+  });
+
+  t.equal(output.length, 1);
+  delete output[0].pid;
+  delete output[0].hostname;
+  delete output[0].time;
+  t.deepEqual(output[0], {
+    level: 30,
+    name: "event",
+    id: "event123",
+    event: "check_run",
+    action: "completed",
+    installation: 1,
+    owner: "wip",
+    isEventStat: true,
+    msg: "check_run.completed event received for wip (id: event123)",
+  });
+});
+
+test("logs event without action", async function (t) {
+  await this.probot.receive({
+    name: "ping",
+    id: "event123",
+    payload: {
+      installation: {
+        id: 1,
+        account: {
+          login: "wip",
+        },
+      },
+    },
+  });
+
+  t.equal(output.length, 1);
+  delete output[0].pid;
+  delete output[0].hostname;
+  delete output[0].time;
+  t.deepEqual(output[0], {
+    level: 30,
+    name: "event",
+    id: "event123",
+    event: "ping",
+    installation: 1,
+    owner: "wip",
+    isEventStat: true,
+    msg: "ping event received for wip (id: event123)",
+  });
+});

test/integration/event-logging-test.js

@@ -25,7 +25,10 @@
       "login": "wip"
     },
     "installation": {
-      "id": 1
+      "id": 1,
+      "account": {
+        "login": "wip"
+      }
     }
   }
 }

test/integration/events/new-pull-request-with-do-not-merge-title.json

@@ -25,7 +25,10 @@
       "login": "wip"
     },
     "installation": {
-      "id": 1
+      "id": 1,
+      "account": {
+        "login": "wip"
+      }
     }
   }
 }

test/integration/events/new-pull-request-with-emoji-no-space-title.json

@@ -25,7 +25,10 @@
       "login": "wip"
     },
     "installation": {
-      "id": 1
+      "id": 1,
+      "account": {
+        "login": "wip"
+      }
     }
   }
 }

test/integration/events/new-pull-request-with-emoji-title.json

@@ -22,7 +22,10 @@
       }
     },
     "installation": {
-      "id": 1
+      "id": 1,
+      "account": {
+        "login": "wip"
+      }
     }
   }
 }

test/integration/events/new-pull-request-with-test-title-from-user.json

@@ -25,7 +25,10 @@
       "login": "wip"
     },
     "installation": {
-      "id": 1
+      "id": 1,
+      "account": {
+        "login": "wip"
+      }
     }
   }
 }

test/integration/events/new-pull-request-with-test-title.json

@@ -29,7 +29,10 @@
       "login": "wip"
     },
     "installation": {
-      "id": 1
+      "id": 1,
+      "account": {
+        "login": "wip"
+      }
     }
   }
 }