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

Communication: Fix link in email notification #9212

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

Strohgelaender
Copy link
Contributor

@Strohgelaender Strohgelaender commented Aug 13, 2024

Checklist

General

Server

  • Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
  • I strictly followed the server coding and design guidelines.
  • I added multiple integration tests (Spring) related to the features (with a high test coverage).
  • I added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
  • I documented the Java code using JavaDoc style.

Motivation and Context

Fixes #9211

Description

Changed the endpoint to be the correct one.

Steps for Testing

Send someone a message who has email notification activated.
Click the link in the email and check that it works.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.







Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Summary by CodeRabbit

  • New Features

    • Updated notification URLs to enhance flexibility and clarity, now directing users to a unified communication page.
  • Bug Fixes

    • Adjusted URL structure in tests to reflect the new API endpoint, ensuring consistency and correctness in functionality.

@Strohgelaender Strohgelaender requested a review from a team as a code owner August 13, 2024 13:26
Copy link

coderabbitai bot commented Aug 13, 2024

Walkthrough

The recent changes primarily focus on updating the URL structure within the notification system. The extractNotificationUrl method now uses a more general base URL and directs users to a communication page instead of a messaging page. Corresponding test updates reflect these modifications, ensuring that generated URLs align with the new endpoint structure for improved clarity and functionality.

Changes

Files Change Summary
src/main/java/de/tum/in/www1/artemis/domain/notification/NotificationTargetFactory.java Updated extractNotificationUrl method to use a more general base URL and changed the return endpoint from /messages to /communication.
src/test/java/de/tum/in/www1/artemis/notification/NotificationTargetFactoryTest.java Removed MESSAGES_CONVERSATION constant; updated EXPECTED_POST_URL to reflect the new communication endpoint instead of the old messages endpoint.

Assessment against linked issues

Objective Addressed Explanation
Email links should direct to the new communication feature (#[9211])
Links in emails should not lead to a blank page (#[9211])

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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

CodeRabbit Configuration 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.

@github-actions github-actions bot added tests server Pull requests that update Java code. (Added Automatically!) labels Aug 13, 2024
Copy link
Contributor

@SimonEntholzer SimonEntholzer left a comment

Choose a reason for hiding this comment

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

Change makes sense, I'm not sure how to test it though, as I didn't get any mails from artemis.
This might be due to two different things: maybe the test server does not send mails (which would make sense) or I did not correctly activate email notification. When looking in the settings, I noticed that for communication notifications, there is no email option, like for other notifications:
image

edit: now also got an email from the announcement 👍

Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

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

Tested on TS3 with an announcement. The link leads to the correct conversation. 👍

Copy link
Contributor

@JohannesWt JohannesWt left a comment

Choose a reason for hiding this comment

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

Code 👍 (I also got the mail form @pzdr7s test ad the link worked)

Copy link
Contributor

@undernagruzez undernagruzez left a comment

Choose a reason for hiding this comment

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

tested on ts5 and received the correct link

@krusche krusche merged commit 93e5704 into develop Aug 21, 2024
33 of 36 checks passed
@krusche krusche deleted the bugfix/email-commmunication-link branch August 21, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready to merge server Pull requests that update Java code. (Added Automatically!) tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Email links are broken (Communication)
6 participants