SEAB-5860: Convert "ecs stopped task" event to Slack message #160
Conversation
svonworl
changed the title
I can see it being useful to see how long the task lived. For example, it would tell use if tasks were started then killed immediately or if a long-running task was killed EDIT: I read that too fast and read |
FWIW, we definitely appreciate it! |
|
Should this PR be directed at the release/0.3.0 branch? |
| } | ||
|
|
||
| function ecsTaskStateChangeMessageText(message) { | ||
| const taskArn = message?.detail?.taskArn; |
There was a problem hiding this comment.
Huh, for some reason I thought optional chaining was a TypeScript only feature. Good to know it's not. Looks like the feature was added to most browsers in 2020, so when I first started on Dockstore, it actually was TS-only, and I never noticed it was added to JS.
There was a problem hiding this comment.
Huh, for some reason I thought optional chaining was a TypeScript only feature. Good to know it's not. Looks like the feature was added to most browsers in 2020, so when I first started on Dockstore, it actually was TS-only, and I never noticed it was added to JS.
Looks like it got added to Node in version 14:
https://nodejs.medium.com/node-js-version-14-available-now-8170d384567e
| let messageText = `Task ${taskArn} is now ${lastStatus}`; | ||
| if (message?.detail != undefined) { | ||
| ["startedAt", "stoppedAt", "stoppedReason"].forEach((name) => { | ||
| const value = message?.detail[name]; |
There was a problem hiding this comment.
As I browsed regarding optional chaining, I noticed that there's a syntax a?.[expr] that "optional chains" the expression-based lookup. I am going to make a quick mod to eliminate the outer if
There was a problem hiding this comment.
denis-yuen
deleted the
feature/seab-5860/send-ecs-stopped-tasks-to-slack
branch
Description
This PR modifies the "cloudwatch-to-slack" lambda to produce a "ecs task stopped" Slack message when it processes an event that indicates such. The companion deploy PR, which modifies
DockstoreStackto send the event to the associated SNS topic, is https://github.com/dockstore/dockstore-deploy/pull/746.The Slack message looks like: https://ucsc-gi.slack.com/archives/C02DTE86E8J/p1705536998257129
Note that subsequently, I removed the
startedByfield, it will rarely change and didn't seem worth the space. We can nuke any of the other information if we don't think it is useful.Charles mentions that it'd be useful to link items in this and other Slack messages to the appropriate AWS page. So, I investigated, and it's certainly doable, but not as easy as pasting a resource ARN onto the end of an AWS url. https://github.com/link2aws/link2aws.github.io purports to convert an ARN to an AWS page, and at first glance, the source looks ok, but I haven't tried it out. I recommend we defer the addition of links until later.
A message will be produced for each task that is scaled out of existence. Eventually, as more people use Dockstore, the scaling-related messages will become too numerous, and we'll probably want to filter them out, and only display information about tasks that were stopped for other reasons (due to an error, by administrative action, etc).
This PR took much longer for me, someone who has touched the deploy in mostly tangential/superficial fashion, than it would have for the primary deploy authors. None of it was difficult, but piecing together the how everything worked, and then how to test it, and executing on that, in enough detail to confirm that I didn't break anything else in the process, was super-duper time-consuming. Imagine me spending 5 minutes each figuring out 100 things that someone that wrote the code would've already known, that was basically how it went...
Review Instructions
See https://github.com/dockstore/dockstore-deploy/pull/746
Issue
https://ucsc-cgl.atlassian.net/browse/SEAB-5860
Security
Is the information that's contained in the message suitable for display in the target Slack channel?
Please make sure that you've checked the following before submitting your pull request. Thanks!