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

✨ Use the rich precense feature of discord to communicate the current update status. #84

Open
tjarbo opened this issue Jan 13, 2021 · 4 comments
Labels
✨ new feature New feature
Milestone

Comments

@tjarbo
Copy link
Owner

tjarbo commented Jan 13, 2021

As a User
I want to see directly in Discord when the Bot will fetch for updates next time.
so that I can estimate if it will be better to trigger the bot manually.

Description:

The Rich Presence feature of Discord looks very cool and bots can communicate over it for example how to get started (e.g. "Listens for !help"). We can use this feature to display the current moodle-fetch status.

Let's define the following states:

Description Text
STATE-1 Bot is looking for updates "Schaut nach Updates!
STATE-2 Bot will look for updates again at 5:12 pm "Schaut um 17:12 wieder nach."

Links:

Idea by @Stektax #83 (comment)

🟢 In scope:

  • Extend the discord implementation
  • Add a function which expects a time as parameter and sets the activity on Discord
  • Set the activity category to "WATCHING"

🔴 Not in scope:

  • I8n (English support)

What should be the result?

IF the bot starts to fetch new updates
THEN the activity will be set to STATE-1

IF the bot finished fetching updates,
THEN the activity will display the timestamp of the next fetch.

@tjarbo tjarbo added the ✨ new feature New feature label Jan 13, 2021
@tjarbo tjarbo added this to the Version 2.0 milestone Jan 13, 2021
@tjarbo tjarbo changed the title ✨ Use the rich precense of discord to communicate the current update status. ✨ Use the rich precense feature of discord to communicate the current update status. Jan 13, 2021
@antonplagemann
Copy link
Collaborator

Coole Idee!
Ich denke nur das der STATE-1 (Bot is looking for updates) zu kurz vorliegt um vernünftig angezeigt zu werden.
Ein Fetch dauert meist unter einer Sekunde, daher würde vermutlich kaum jemand je diesen Status sehen.

@Stektax
Copy link

Stektax commented Jan 13, 2021

Vielleicht wäre es besser dass der Bot wenn er Fertig ist den Status "Fetch Finished" für ein paar Sekunden anzeigt.
oder halt wenn er gerade dabei ist, das halt auch für X sekunden anzeigt

@tjarbo
Copy link
Owner Author

tjarbo commented Jan 14, 2021

Coole Idee!
Ich denke nur das der STATE-1 (Bot is looking for updates) zu kurz vorliegt um vernünftig angezeigt zu werden.
Ein Fetch dauert meist unter einer Sekunde, daher würde vermutlich kaum jemand je diesen Status sehen.

@antonplagemann Kann natürlich auch sein, dass die Verarbeitung mal etwas länger andauert. Sei es durch eine langsame Moodle Instanz oder einfach die Menge an Daten 📦📦📦📦

Ich denke, es wäre hierfür mal sinnvoll zu schauen, wie funktional die Discord-API dafür ist und wir es einfach ausprobieren. Kann natürlich auch sein, dass die API zu langsam ist, man also als Endnutzer nichts sieht oder vielleicht auch der Ratelimiter dazwischen funkt, weil wir die Aktivität mehrmals innerhalb einer Sekunde ändern. Versuchen wir es einfach 🧑‍🔬

@tjarbo
Copy link
Owner Author

tjarbo commented Jan 14, 2021

Vielleicht wäre es besser dass der Bot wenn er Fertig ist den Status "Fetch Finished" für ein paar Sekunden anzeigt.
oder halt wenn er gerade dabei ist, das halt auch für X sekunden anzeigt

Dass er fertig wäre, würde ja durch die Anzeige eines neuen Zeitstempels verdeutlicht werden - also STATE-2. Aber vielleicht denke ich da zu vereinfacht 😄 Wie siehst du das @antonplagemann ?

@tjarbo tjarbo modified the milestones: Version 2.0, Version 3.0 Apr 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ new feature New feature
Projects
None yet
Development

No branches or pull requests

3 participants