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.

Sign up for GitHub

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

Jump to bottom

chore: Remove upsert in setting last release notes version #31324

Merged
merged 1 commit into from Feb 29, 2024
Merged

chore: Remove upsert in setting last release notes version #31324

merged 1 commit into from Feb 29, 2024

Conversation

sharat87
Copy link
Member

@sharat87 sharat87 commented Feb 28, 2024 •
edited by coderabbitai bot

Instead of upsert, we update first, which is arguably the most used operation in this context, and if that fails, then we attempt an insert.

We're not expecting a performance hit, since most operations here would be an actual update only.

Summary by CodeRabbit

  • Refactor
    • Updated the method for saving viewed release notes versions to improve performance and reliability.
  • Bug Fixes
    • Fixed an issue where viewing release notes under certain conditions wouldn't save correctly.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Feb 28, 2024
@sharat87 sharat87 marked this pull request as ready for review February 28, 2024 06:07
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 28, 2024 •
edited

Walkthrough

Walkthrough

The recent update involves modifications to how the release notes viewed version is saved in the Appsmith server application. The saveReleaseNotesViewedVersion method's return type was changed to provide more informative feedback. Additionally, the method's implementation was refactored for better clarity and efficiency, utilizing a query builder for database operations. The logic in the UserDataServiceCEImpl service was also enhanced to conditionally handle user data, specifically addressing cases where no previous data exists.

Changes

File Path Change Summary
.../server/repositories/ce/CustomUserDataRepositoryCE.java Changed return type of saveReleaseNotesViewedVersion from Mono<Void> to Mono<Integer>.
.../server/repositories/ce/CustomUserDataRepositoryCEImpl.java Refactored saveReleaseNotesViewedVersion to use queryBuilder for criteria and update operations.
.../server/services/ce/UserDataServiceCEImpl.java Updated logic in setViewedCurrentVersionReleaseNotes to conditionally save user data based on count.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot]
coderabbitai bot reviewed Feb 28, 2024
View reviewed changes
...ith-server/src/main/java/com/appsmith/server/repositories/ce/CustomUserDataRepositoryCE.java
@@ -8,7 +8,7 @@

public interface CustomUserDataRepositoryCE extends AppsmithRepository<UserData> {

Mono<Void> saveReleaseNotesViewedVersion(String userId, String version);
Mono<Integer> saveReleaseNotesViewedVersion(String userId, String version);
Copy link
Contributor

Choose a reason for hiding this comment

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

The change in return type from Mono<Void> to Mono<Integer> for saveReleaseNotesViewedVersion method is a significant improvement as it provides more informative feedback from the operation. However, it would be beneficial to add documentation to clarify what the returned Integer represents (e.g., number of records updated or inserted).

...ver/appsmith-server/src/main/java/com/appsmith/server/services/ce/UserDataServiceCEImpl.java
Comment on lines +177 to +187
.flatMap(userId -> repository
.saveReleaseNotesViewedVersion(userId, version)
.flatMap(count -> {
if (count == 0) {
final UserData userData = new UserData();
userData.setReleaseNotesViewedVersion(version);
userData.setUserId(user.getId());
return repository.save(userData).then();
}
return Mono.empty();
}))
Copy link
Contributor

Choose a reason for hiding this comment

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

The update to setViewedCurrentVersionReleaseNotes introduces a conditional logic that aligns with the PR's objective, enhancing the method's functionality to handle cases where no records are updated. It's recommended to add error handling for the repository.save(userData) operation to ensure robustness, especially in scenarios where the save operation might fail.

@sharat87 sharat87 merged commit 45b81f9 into release Feb 29, 2024
19 checks passed
@sharat87 sharat87 deleted the chore/no-upsert-2 branch February 29, 2024 06:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai left review comments

@nidhi-nair nidhi-nair nidhi-nair approved these changes

@mohanarpit mohanarpit Awaiting requested review from mohanarpit

@trishaanand trishaanand Awaiting requested review from trishaanand

Assignees
No one assigned
Labels
skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@sharat87 @nidhi-nair