Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Notification function #139

Open
mira-miracoli opened this issue Sep 12, 2024 · 2 comments
Open

Proposal: Notification function #139

mira-miracoli opened this issue Sep 12, 2024 · 2 comments

Comments

@mira-miracoli
Copy link

We discussed about how to inform users that their ITs will be terminated after 24h. There were several suggestions: The website, training material, as static text in the 'running ITs' window and a notification that is send to users.
So I came to the idea that maybe TPV can send notifications to the user via the Galaxy API. These could be specified e.g. similar to the fail message and be triggered by a rule like:

- if: input_size > 10
  notify:
    msg: 
    subject: "Tool suggestion for *small file Tool*",
    message: "Please consider using the *tool for larger input files*",
    category: "info"
# OR
- if: true
  notify:
    subject: "24h lifetime for Interactive Tools",
    message: "For giving everyone a shorter waiting time we terminate Interactive tools after 24h",
    category: "warning"

Please share your opinions and ideas

@nuwang
Copy link
Member

nuwang commented Sep 12, 2024

If this is used often enough, providing a shorthand syntax may be worthwhile, but I'll wait for others to chime in. One suggestion, can we prototype this first with:

if: input_size > 10
execute:
   # do this notification using the API somehow

We could even start off with just a helper function in helpers.py. Later we can introduce the notify shorthand syntax?

@bgruening
Copy link
Member

A helper function could work in the beginning.

A few more use-cases:

  • deprecating tools (tophat)
  • moving users from one tool to a more performant tool (fastqc --> falco)
  • known bugs in certain tool versions
  • certain hints for GPU tools or otherwise limited tools

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants