search

elimu-ai / webapp

🖥 Web application for hosting Android applications and educational content
https://hin.elimu.ai
MIT License
30 stars 55 forks source link

refactor(dao) : LetterSoundContributionEvent #1677 #1724

Closed SnehaHS65 closed 1 month ago

SnehaHS65 commented 1 month ago

refs : #1677 Refactor LetterSoundCorrespondenceContributionEvent -> LetterSoundContributionEvent

coderabbitai[bot] commented 1 month ago

Walkthrough

This update involves renaming the LetterSoundCorrespondenceContributionEvent class to LetterSoundContributionEvent across various files and adjusting method signatures accordingly. This change aims to align with the updated entity naming conventions. Additionally, there are updates to import statements, and SQL schema changes to reflect the new class name.

Changes

File Path Change Summary
src/main/java/ai/elimu/dao/LetterSoundContributionEventDao.java Renamed methods and class references from LetterSoundCorrespondenceContributionEvent to LetterSoundContributionEvent.
src/main/java/ai/elimu/dao/jpa/LetterSoundContributionEventDaoJpa.java Updated method signatures and implementations to use LetterSoundContributionEvent instead of LetterSoundCorrespondenceContributionEvent.
src/main/java/ai/elimu/dao/LetterSoundPeerReviewEventDao.java Renamed methods and class references from LetterSoundCorrespondenceContributionEvent to LetterSoundContributionEvent.
src/main/java/ai/elimu/model/contributor/LetterSoundContributionEvent.java Renamed class from LetterSoundCorrespondenceContributionEvent to LetterSoundContributionEvent.
src/main/java/ai/elimu/model/contributor/LetterSoundPeerReviewEvent.java Updated method signatures to use LetterSoundContributionEvent instead of LetterSoundCorrespondenceContributionEvent.
src/main/java/ai/elimu/util/db/DbContentImportHelper.java Updated import statements and class instantiation to reflect the renaming of LetterSoundCorrespondenceContributionEvent to LetterSoundContributionEvent.
src/main/java/ai/elimu/web/content/letter_sound/LetterSoundCreateController.java Updated import statements and class instantiation in the handleSubmit method to use LetterSoundContributionEvent instead of LetterSoundCorrespondenceContributionEvent.
src/main/java/ai/elimu/web/content/letter_sound/LetterSoundEditController.java Updated import statements and method usage to reflect the renaming to LetterSoundContributionEvent.
src/main/java/ai/elimu/web/content/peer_review/LetterSoundPeerReviewEventCreateController.java Changed import statements and variable types to use LetterSoundContributionEvent instead of LetterSoundCorrespondenceContributionEvent.
src/main/resources/META-INF/jpa-schema-export.sql Added table creation and foreign key constraints for LetterSoundContributionEvent, and removed the corresponding entries for LetterSoundCorrespondenceContributionEvent.
src/main/resources/db/migration/2004011.sql Introduced changes for renaming a table from LetterSoundContributionEvent to LetterSoundCorrespondenceContributionEvent.

Possibly related issues

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 861af7141464f1e70d4fef001d8f09115103ccca and 97a4217801fac619b4b260eb2b050fe61d434e8c.
Files selected for processing (1) * src/main/java/ai/elimu/util/db/DbContentImportHelper.java (2 hunks)
Files skipped from review as they are similar to previous changes (1) * src/main/java/ai/elimu/util/db/DbContentImportHelper.java
Additional context used
Learnings (1)
Common learnings
``` Learnt from: venkatesh2k3 PR: elimu-ai/webapp#1682 File: src/main/java/ai/elimu/dao/LetterSoundContributionEventDao.java:13-13 Timestamp: 2024-07-06T17:37:44.413Z Learning: In the `LetterSoundContributionEventDao.java` file, the method signatures should use `LetterSoundContributionEvent` instead of `LetterSoundCorrespondenceContributionEvent` to maintain consistency with the renaming of entities. ```
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 22.22222% with 7 lines in your changes missing coverage. Please review.

Project coverage is 15.26%. Comparing base (99f378d) to head (97a4217).

Files Patch % Lines
...letter_sound/LetterSoundPeerReviewsController.java 0.00% 3 Missing :warning:
...n/java/ai/elimu/util/db/DbContentImportHelper.java 0.00% 1 Missing :warning:
...tent/letter_sound/LetterSoundCreateController.java 0.00% 1 Missing :warning:
...ontent/letter_sound/LetterSoundEditController.java 0.00% 1 Missing :warning:
...ew/LetterSoundPeerReviewEventCreateController.java 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1724 +/- ## ========================================= Coverage 15.26% 15.26% Complexity 450 450 ========================================= Files 248 248 Lines 7584 7584 Branches 799 799 ========================================= Hits 1158 1158 Misses 6376 6376 Partials 50 50 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

SnehaHS65 commented 1 month ago

@jo-elimu , Please review my PR to rename only LetterSoundCorrespondenceContributionEvent -> LetterSoundContributionEvent.

SnehaHS65 commented 1 month ago

Please do not resolve comments that have not been addressed

I have addressed your comments in the latest commit. Can you please check

jo-elimu commented 1 month ago

@SnehaHS65 Your DB migration script ran successfully in production:

[HIN] 23:46:03.987 [main] INFO  ai.elimu.util.db.DbMigrationHelper - performDatabaseMigration
[HIN] 23:46:03.987 [main] INFO  ai.elimu.util.db.DbMigrationHelper - pomVersion: 2.4.11
[HIN] 23:46:03.988 [main] INFO  ai.elimu.util.db.DbMigrationHelper - pomVersionAsInteger: 2004011
[HIN] 23:46:04.373 [main] INFO  ai.elimu.util.db.DbMigrationHelper - dbMigrations.size(): 42
[HIN] 23:46:04.374 [main] INFO  ai.elimu.util.db.DbMigrationHelper - versionOfMostRecentMigration: 2004010
[HIN] 23:46:04.374 [main] INFO  ai.elimu.util.db.DbMigrationHelper - Looking up pending DB migrations after version 2004010
[HIN] 23:46:04.374 [main] INFO  ai.elimu.util.db.DbMigrationHelper - Looking up file "db/migration/2004011.sql"...
[HIN] 23:46:04.374 [main] INFO  ai.elimu.util.db.DbMigrationHelper - Migration script found for version 2004011
[HIN] 23:46:04.379 [main] INFO  ai.elimu.util.db.DbMigrationHelper - Executing sql: DROP TABLE IF EXISTS `LetterSoundContributionEvent`;
[HIN] 23:46:04.415 [main] INFO  ai.elimu.util.db.DbMigrationHelper - Executing sql: ALTER TABLE `LetterSoundCorrespondenceContributionEvent` RENAME `LetterSoundContributionEvent`;
[HIN] 23:46:04.428 [main] INFO  ai.elimu.util.db.DbMigrationHelper - Updating current version (2004011)
[HIN] 23:46:04.499 [main] INFO  ai.elimu.util.db.DbMigrationHelper - Database migration complete!