Button for others to opt-in to be notified for reminders #2973
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is the initial implementation - it's currently _far_ from perfect
and is very susceptible to errors.
Notable features beyond the basic requirements:
- Fails safely when max mentions reached (we're limited by the
2000-character limit when sending the reminder with the pings), and
disables the button.
- Adds an additional embed to the initial confirmation message to show
who clicked on the notify button.
- Edits the additional embed and disables the button when the reminder
is sent.
In many ways, this implementation is quite bad:
- Uses an async callback to delegate the task of PATCH-ing the API to
edit mentions to the `new_reminders` method.
- Edits to the opt-in list embed relies on the fact that the reminder is
not edited (using !remind edit) before someone clicks on the button. A
trivial way to fix this would be to add another field to the site
schema to store the `notification_view` in some way.
- The button is neither disabled nor any edits to the embed made when
the reminder is deleted before someone clicks on the button.
- String splitting is used which relies on the exact format of the embed
message when editing the embed to disable the button. We have to
reminder to update this piece of code when adjusting its format in the
future.
The UX can also be improved. Currently, I can't think of a way to
concisely phrase the button embed message so that it is clear that the
button is for people _other than_ the reminder author.
Notes:
- Max reminder mentions:
- Mentions are pinged directly in a discord message when the reminder
is sent. This means we're limited by the 2000-char limit. If we take
each User ID snowflake to be 18-characters, and considering each
mention to be formated as "<@id> " (with extra space), it results in
about 90 mentions max. I've set the constant to 80 just in case.
- This is not an issue when the mentions are added in through other
means than the button we're adding in this commit, because the user
has to use @-mentions when sending the `!remind edit` command, which
is already under the discord's character limit.
- Log messages are added when something unexpected occurs within the
code. Hopefully this is unlikely to happen after the implementation
issues listed above are solved.
- The opt-in list in the second embed is separate from mentions added in
the original reminder creation, or any further edits, because mentions
are added by the to-be-mentioned-user, rather than by the reminder
author in this way. (Even though they are stored the same way.)
This solves most, if not all issues from the previous commit.
- A timeout of 5 minutes is enforced - this means the button can no
longer be used either when the reminder arrives or 5 minutes passes
since creation, whichever comes first.
- Reminder edits in between creation and button clicks will be handled
responsibly
- This includes both edits of duration, mentions, and deleting
reminders altogether.
- UX is improved. This list of to-be-mentioned users is sent up-front
with the author included. Instructions to click the button comes right
after the list.
- No updates to the API or site schema required, as the button message
will disable itself when it encounters any sort of errors.
- Implementation is also somewhat simplified.
There are probably more improvements, maybe one caveat, but it's like
almost midnight and I want to sleep :/ I sure hope the list above covers
most of it.
Further testing will be done. Now `.remind 10s test` is ingrained in my
muscle memory...
hedyhli
added
t: feature
hedyhli
force-pushed
the
feat/reminder-add-notify
branch
from
fd40f30
to
ae8074f
Compare
- More resilient handling of API errors. - Don't rely on string manipulation to disable the button.
hedyhli
force-pushed
the
feat/reminder-add-notify
branch
from
ae8074f
to
e753586
Compare
This removes the need of any form of error handling from `embeds` list indexing, and makes the code more concise and readable. The drawback is that a whole new embed object have to be allocated each time, rather than editing the description like before.
wookie184
approved these changes
Apr 16, 2024
vivekashok1221
requested changes
May 21, 2024
There was a problem hiding this comment.
I couldn't find a good way to phrase the sentence that could concisely and professionally tell everyone that this button is for everyone other than the reminder's author, so I decided to list the reminder mentions upfront to make it clear what the button will do. In exchange the embed might be considered a little verbose (until the button times out).
If others feel the embed is fine as it is and is not too verbose , then let's stick with it- but how about "Notify me too" or "Join reminder"?
I actually like how the new (second) embed sends clear instructions. My suggestion is solely for brevity and to avoid sending the second embed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1327.
The bookmark command (Sir Lancebot) allows other people to click a button to receive a copy of a bookmark when someone bookmarks a message.
This PR adds a similar button for the
!remindcommand, other people can click the button to add themselves to the mention list of the reminder. When the reminder arrives, they will be notified with a ping.Demo
When the reminder is created, and someone clicks on the button:
When the reminder arrives, the person will be pinged along with the author and the button will be removed:
Implementation details
This is my first time using dpy 2.0 features, please do be pedantic with reviews if need be!
Other (less important) details can be found in the commit messages.
Design choices
Also, I haven't touched our dpy codebases (and dpy) in a long time, I'm quite happy to make modifications to comply with any best practices or prevailing styles we have that I hadn't noticed.