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

honor mutes when sending push notifications #1145

Merged
merged 6 commits into from
May 12, 2024

Conversation

SatsAllDay
Copy link
Contributor

@SatsAllDay SatsAllDay commented May 4, 2024

Description

Closes #717

This PR updates the push notification code paths to ensure that user-configured mutes are checked before sending push notifications, if applicable. The following code paths were updated:

  • territory subscriptions - you only receive a push notification for a territory to which you're subscribed if the user who submitted the post is not a user you've muted
  • mentions - if a user that you've muted mentions you, you will not receive a push notification for it
  • user subscriptions - if for some reason you've muted and subscribed to the same user, you'll no longer receive push notifications when that user posts or comments (whichever you've subscribed to)

This PR also updates the API validation to disallow users from muting and subscribing to the same user - only one or the other is allowed. No migration is performed, so if any user got themselves into this state, they can keep it until they change it. Then they can't go back.

In order to explain this behavior to users, I updated the UI code that toggles subscriptions/mutes to show the error message from the API request in the error toast, instead of a generic "Failed to <mute|subscribe>" message.

Screenshots

N/A

Additional Context

N/A

Checklist

Are your changes backwards compatible? Please answer below:
Yes. No database changes or migrations. The only notable change is that users will no longer be able to mute and subscribe to the same user. However, if they've already done that, it will still be honored. They just can't re-configure such a thing.

Did you QA this? Could we deploy this straight to production? Please answer below:
Yes.

For frontend changes: Tested on mobile? Please answer below:
N/A

Did you introduce any new environment variables? If so, call them out explicitly here:
No.

@SatsAllDay SatsAllDay changed the title honor mutes when sending push notifications DRAFT: honor mutes when sending push notifications May 4, 2024
@@ -1227,7 +1227,7 @@ export const createMentions = async (item, models) => {

// only send if mention is new to avoid duplicates
if (mention.createdAt.getTime() === mention.updatedAt.getTime()) {
notifyMention(user.id, item)
notifyMention({ models, userId: user.id, item })
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered altering the surrounding code in this context to only invoke this notifyMention function for users that didn't mute OP, but instead I kept that logic within notifyMention for consistency with the other notifyXXX functions. It's slightly dangerous to assume that the caller of notifyXXX is doing the mute filtering, IMO.

It would probably be more performant to do it here, instead of doing a DB call for each mentioned user, so I am open to refactoring if we think that's a major concern. But for consistency and all that, I did it this way.

@@ -112,6 +112,19 @@ export function viewValueGroup () {
) vv`
}

const isMuted = async ({ models, me, mutedId }) => {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extracted this to a reusable function for code de-dupe.

SatsAllDay added 4 commits May 5, 2024 11:15
* territory subscriptions
* mentions
* user subscriptions

Also, don't allow you to mute a subscribed user, or vice versa
update mute/subscribe error messages for consistency
@SatsAllDay SatsAllDay marked this pull request as ready for review May 5, 2024 15:17
Copy link
Contributor

coderabbitai bot commented May 5, 2024

Walkthrough

Walkthrough

The recent updates aim to improve the notification system by enhancing mute functionality across various components. Changes involve passing structured data for notification functions, consolidating mute logic in a shared library, and enhancing error handling in UI components. These modifications ensure consistent respect for user muting preferences throughout the application.

Changes

Files Summary of Changes
api/resolvers/item.js Updated createMentions function to pass structured data for notifyMention function.
api/resolvers/user.js Added isMuted import and implemented mute checks in various functions.
components/mute.js Enhanced error handling for muting/unmuting operations.
components/subscribeUser.js Improved error message handling for subscribing/unsubscribing users.
lib/user.js Introduced isMuted function to check if a user is muted.
lib/webPush.js Modified notifyUserSubscribers to exclude muted users and updated notifyMention for mute checks.

Assessment against linked issues

Objective Addressed Explanation
Respect mutes all for push notifications (#717) The changes, especially the introduction of isMuted function and its integration in relevant functions, ensure that mute preferences are respected for all push notifications, extending beyond just replies as per the objective.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 46318fe and cc725c6.
Files ignored due to path filters (1)
  • awards.csv is excluded by !**/*.csv, !**/*.csv
Files selected for processing (1)
  • api/resolvers/item.js (1 hunks)
Additional comments not posted (1)
api/resolvers/item.js (1)

1234-1234: LGTM! The change enhances the context passed to notifyMention, aligning with the PR's objectives. Consider the performance impact of DB calls for each mentioned user as noted in previous discussions.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@SatsAllDay SatsAllDay changed the title DRAFT: honor mutes when sending push notifications honor mutes when sending push notifications May 5, 2024
@ekzyis ekzyis self-requested a review May 6, 2024 20:01
@huumn huumn merged commit 77c87da into stackernews:master May 12, 2024
6 checks passed
@SatsAllDay SatsAllDay deleted the 717-mutes-push branch May 16, 2024 00:46
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

Successfully merging this pull request may close these issues.

Respect mutes all for push notifications
2 participants