search

elimu-ai / webapp

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

refactor(crowdsource): remove platform from contribution events #1708

Closed jo-elimu closed 3 weeks ago

jo-elimu commented 3 weeks ago

ref #1674

[!NOTE] Includes DB migration SQL script for altering existing databases in production: https://github.com/elimu-ai/webapp/commit/6cd2dfec3c539a3c53d20af995fa37959aee5753#diff-ecca7b129fd84cb80790d5006843f71ec549a30959eb2796fd11f91bd7f309b5

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 15.26%. Comparing base (b865b3a) to head (ba7f64d).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1708 +/- ## ============================================ + Coverage 15.24% 15.26% +0.02% + Complexity 451 450 -1 ============================================ Files 248 248 Lines 7623 7592 -31 Branches 799 799 ============================================ - Hits 1162 1159 -3 + Misses 6411 6383 -28 Partials 50 50 ```

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

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes involve a comprehensive removal of the platform property from the ContributionEvent class and its usage across various parts of the system. This includes eliminating the platform field, as well as its getter and setter methods, from several controllers and database tables. Consequently, all references to the platform property in these files have been deleted, simplifying the event model and its related database schema.

Changes

File/Path Summary
src/main/java/ai/elimu/model/contributor/ContributionEvent.java Removed platform property, getter, and setter methods.
src/main/java/ai/elimu/util/db/DbContentImportHelper.java Removed setting of Platform for various contribution events in performDatabaseContentImport method.
Various LetterCreateController and LetterEditController Removed setting of platform for letterContributionEvent.
Various LetterSoundCreateController and LetterSoundEditController Removed setting of platform for letterSoundContributionEvent.
Various AudioCreateController and AudioEditController Removed setting of platform for audioContributionEvent.
Various ImageCreateController and ImageEditController Removed setting of platform for imageContributionEvent.
Various NumberCreateController and NumberEditController Removed setting of platform for numberContributionEvent.
Various SoundCreateController and SoundEditController Removed setting of platform for soundContributionEvent.
Various StoryBookCreateController, StoryBookEditController, StoryBookCreateFromEPubController, and others Removed setting of platform for storyBookContributionEvent and imageContributionEvent.
Various StoryBookChapterCreateController, StoryBookChapterDeleteController, StoryBookParagraphCreateController, StoryBookParagraphDeleteController, and StoryBookParagraphEditController Removed setting of platform for storyBookContributionEvent.
Various WordCreateController and WordEditController Removed setting of platform for wordContributionEvent and removed related audio dependencies.
src/main/resources/META-INF/jpa-schema-export.sql Removed platform field from multiple tables in the database schema.
src/main/resources/db/migration/2004004.sql Dropped platform column from various contribution event tables.
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 6cd2dfec3c539a3c53d20af995fa37959aee5753 and ba7f64d31017d4a64d662243e4e3aab020e12d7a.
Files selected for processing (1) * src/main/java/ai/elimu/model/contributor/ContributionEvent.java (3 hunks)
Files skipped from review as they are similar to previous changes (1) * src/main/java/ai/elimu/model/contributor/ContributionEvent.java
--- 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.