feat: Add heartbeat endpoint & tests #881
Conversation
| request: FastifyRequest, | ||
| reply: FastifyReply | ||
| ) { | ||
| const verified = await handleCronAuth(request, reply); |
There was a problem hiding this comment.
Does this framework not provide a native way to authenticate requests rather than hoping every developer remembers to add authentication in their application code in every endpoint ?
There was a problem hiding this comment.
The auth for jobs are handled via cloud scheduler (managed by terraform), so developers don't need to worry about it
There was a problem hiding this comment.
The webhooks do currently require auth for each endpoint, but I'm not sure if there is a way around that from a security perspective, since traffic is open to the internet
There was a problem hiding this comment.
What I meant was whether the web framework we use supports that rather than implementing auth inside the application logic.
src/jobs/heartbeat/heartbeat.ts
Outdated
| await bolt.client.chat.postMessage({ | ||
| channel: INFRA_HUB_HEARTBEAT_CHANNEL, | ||
| text: 'Infra Hub is up', | ||
| }); |
There was a problem hiding this comment.
What's the goal of sending this message?
Is it about testing the Slack integration or are people supposed to notice these messages are not coming through ? I would push back against the second.
There was a problem hiding this comment.
It's for the second - Alex mentioned that we should have some sort of heartbeat to notice when it's down (since other important parts use eng-pipes, such as gocd deployment notifs in slack)
There was a problem hiding this comment.
nobody will catch that. There has to be a datadog alert, so you should probably record a datadog metric or an event and build an alert on that rather than relying on slack and hoping people pay attention to the channel.
brian-lou
force-pushed
the
brian/uptime-heartbeat-2
branch
from
10a3819
to
0958182
Compare
This PR adds an cron job endpoint that, when triggered, sends a heartbeat message to a Slack feed channel.