Codecov Report

❌ Patch coverage is 82.50000% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.07%. Comparing base (fbe2ee5) to head (14a8812).
⚠️ Report is 1 commits behind head on hotfix/1.18.1.

@@                 Coverage Diff                 @@
##             hotfix/1.18.1    #6168      +/-   ##
===================================================
+ Coverage            74.02%   74.07%   +0.04%     
- Complexity            5712     5724      +12     
===================================================
  Files                  397      397              
  Lines                20543    20571      +28     
  Branches              2112     2116       +4     
===================================================
+ Hits                 15207    15238      +31     
+ Misses                4332     4326       -6     
- Partials              1004     1007       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

• issues at most one "missing dockstore.yml" notification per github repository, ever.

• does not issue a "missing dockstore.yml" notification if there are registered .dockstore.yml-based entries corresponding to the github repository, indicating that there must be a .dockstore.yml on one of the branches.

Thought to ponder, should these be user-spaced?

For example, recently we saw users requiring assistance from an admin to configure our app. The admin installs the app, triggers the notification to their account. The original user starts back up, doesn't see the notification for the admin, doesn't see their own notification.

Alternatively, job turn-over, multiple staff on a team, the heuristic that the first user to interact with us gets a notification is decent, but GitHub itself doesn't work that way for example (i.e. we all get a notification stuff happens usually, unless we've configured it differently)

• issues at most one "missing dockstore.yml" notification per github repository, ever.

• does not issue a "missing dockstore.yml" notification if there are registered .dockstore.yml-based entries corresponding to the github repository, indicating that there must be a .dockstore.yml on one of the branches.

Thought to ponder, should these be user-spaced?

For example, recently we saw users requiring assistance from an admin to configure our app. The admin installs the app, triggers the notification to their account. The original user starts back up, doesn't see the notification for the admin, doesn't see their own notification.

Alternatively, job turn-over, multiple staff on a team, the heuristic that the first user to interact with us gets a notification is decent, but GitHub itself doesn't work that way for example (i.e. we all get a notification stuff happens usually, unless we've configured it differently)

Might make sense to issue multiple notifications, one per user, etc, as above. There's some subtle failure modes that we'd need to ponder.

However, given that this is a hotfix, would prefer to stick with the simpler solution, which works good enough for now.

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
86.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

unsure about cases, will discuss on devs

Per the discussion on devs, I modified the notification generation code so that it now considers the user when determining if a notification has already been issued. That is, the "needs a .dockstore.yml" notification will now be issued at most once for each user/repository pair, allowing multiple different users to be sent a notification for a given repository. This will gracefully handle the scenario wherein an admin installs the GitHub app on a .dockstore.yml-less repo, and then a different user pushes to the repo. A notification will be issued to each user, one at the time of the install, and the other at the time of the push.

Per the discussion on devs, I modified the notification generation code so that it now considers the user when determining if a notification has already been issued.

Sweet!