event.name type/value disagreement

[jablko]

I get TS2367: This condition will always return 'false' since the types '"check_run.completed" | "code_scanning_alert.fixed"' and '"check_run"' have no overlap. from the following since 7.22.0/#406:

on(["check_run.completed", "code_scanning_alert.fixed"], (event) => {
  if (event.name === "check_run") {
    console.log(`a run was ${event.payload.action}!`);
  }
});

I confirmed this wasn't an error in 7.21.0.

Thanks for the work in #406 to upgrade the types! ❤️

[G-Rath]

This is because you'll never get an event whose name is check_run - you'll only ever get check_run.completed or code_scanning_alert.fixed.

[jablko]

The docs describe using the X-GitHub-Event header https://github.com/octokit/webhooks.js#user-content-webhooksverifyandreceive:~:text=name%3A%20request.headers%5B%22x%2Dgithub%2Devent%22%5D%2C

which is what webhooks.middleware() does

webhooks.js/src/middleware/middleware.ts

Line 48 in 56f8147

const eventName = request.headers["x-github-event"] as WebhookEventName;

and in the GitHub docs that header doesn't include the action https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#example-delivery:~:text=%3E%20X%2DGitHub%2DEvent%3A%20issues

What am I missing?

[G-Rath]

The docs describe using the X-GitHub-Event

It says that for webhooks.receive, so it's correct.

However the docs for webhooks.on are misleading as they say:

Required. Name of the event. One of GitHub's supported event names.

Really it should say something like "One of Githubs supported event names, or (if the event has an action property) the name of an event followed by its action in form of <event>.<action>", and link here.

[jablko]

I can call webhooks.on() on "check_run.completed" but my handler is still getting the X-GitHub-Event header value (in this case "check_run"):

const { Webhooks } = require("@octokit/webhooks");
const webhooks = new Webhooks({
  secret: "mysecret",
});
webhooks.on("check_run.completed", (event) => console.log(event.name)); // -> "check_run"
webhooks.receive({
  name: "check_run",
  payload: {
    action: "completed",
  },
});

[G-Rath]

Interesting - I actually thought we had tests that checked this; I'll have to look at my notes.

@gr2m @wolfy1339 would you be able to weight in on what the desired behaviour in this situation should be, and then I'll aim to ensure that's what we're doing?

[gr2m]

I can call webhooks.on() on "check_run.completed" but my handler is still getting the X-GitHub-Event header value (in this case "check_run"):

const { Webhooks } = require("@octokit/webhooks");
const webhooks = new Webhooks({
  secret: "mysecret",
});
webhooks.on("check_run.completed", (event) => console.log(event.name)); // -> "check_run"

That is correct behavior. webhooks.on("check_run.completed", handler) is just a shortcut to filter out all check_run events which payload's action value is not "complected"

[G-Rath]

Ok cool - I'll modify the types when I get a chance to reflect this :)

(and will also add this to the typescript test file)

[G-Rath]

🎉 This issue has been resolved in version 7.24.2 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

(me filling in for the bot as I targeted the wrong thing with my PR by mistake)