EotvosCollegium / mars

Unified IT System of the Eötvös József College for Advanced Studies.
https://uran.eotvos.elte.hu
MIT License
2 stars 15 forks source link

Upload files after application deadline #620

Closed kdmnk closed 3 months ago

kdmnk commented 3 months ago

And sends email to the committee members (also if the notes are changed)

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The recent changes significantly enhance the functionality of the `AdmissionController` by renaming the `updateNote` method to `update`, now managing both note updates and file uploads. New mail classes have been introduced to notify committee members of these changes. Additionally, the implementation features improved variable naming and consistency throughout various classes and templates. These adjustments streamline user interactions and provide a more cohesive user experience. ## Changes | File | Change Summary | |--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `app/Http/Controllers/Auth/AdmissionController.php` | Renamed `updateNote` to `update`, consolidating note updates and file uploads. Introduced email notifications for changes and file uploads. | | `app/Mail/ApplicationFileUploaded.php`, `app/Mail/ApplicationNoteChanged.php` | Introduced new classes for handling email notifications regarding file uploads and application note changes, including relevant application details and modifiers. | | `resources/views/auth/admission/application.blade.php` | Enhanced application view with a file upload feature and updated form action URL to reflect new functionality, improving user experience in managing applications. | | `resources/views/emails/application_file_uploaded.blade.php`, `resources/views/emails/application_note_changed.blade.php` | New templates for file upload and note change notifications, featuring personalised greetings and contextual information about the applications. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant AdmissionController participant EmailService participant CommitteeMember User->>AdmissionController: Submit application update (note/file) AdmissionController->>AdmissionController: Validate input Note over AdmissionController: Check for note modification or file upload AdmissionController->>EmailService: Queue notifications EmailService->>CommitteeMember: Notify of application update ```

Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 19209b825e9c3f93d568361c9e710282dba9b5fe and 88e36c451b1e4bfbcd7173f687d10db936121728.
Files selected for processing (2) * app/Http/Controllers/Auth/AdmissionController.php (3 hunks) * resources/views/auth/admission/application.blade.php (1 hunks)
Files skipped from review as they are similar to previous changes (1) * resources/views/auth/admission/application.blade.php
Additional comments not posted (2)
app/Http/Controllers/Auth/AdmissionController.php (2)
`171-171`: **Address constructor and variable issues in file upload notification.** The `ApplicationFileUploaded` constructor is invoked with parameters that do not match the expected signature. Ensure the constructor accepts the correct parameters or adjust the call accordingly. --- `154-154`: **Ensure correct authorization check for note modification.** The authorization check for modifying notes should ensure that the user is authorized to modify the specific application note. Consider adding a specific policy check for this action.
--- 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 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](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.
BertalanD commented 3 months ago

I'm a bit conflicted about sending emails for notes, but if you see a use case for it, sure. But please clarify in the helper text that an email will be sent.

kdmnk commented 3 months ago

I'm a bit conflicted about sending emails for notes, but if you see a use case for it, sure. But please clarify in the helper text that an email will be sent.

True, I wanted to clarify it. As far as I saw, the notes are not used that much, maybe to state some changes to the application and alike. For those, an email is nice but I can remove the feature. You know better.

BertalanD commented 3 months ago

As far as I saw, the notes are not used that much, maybe to state some changes to the application and alike. For those, an email is nice but I can remove the feature. You know better.

Keeping it as a way to urgently notify application committee members about important changes to an application sounds good to me.

kdmnk commented 3 months ago

I've used bcc now to send emails but I have issues testing it and I don't have more time now. Please test this on staging and fix if needed.

viktorcsimma commented 3 months ago

I haven't checked it out thoroughly, but LGTM; thanks:)

BertalanD commented 3 months ago

Needed this fix post-commit: https://github.com/EotvosCollegium/mars/commit/7d93901ca25222553bfd4c0758279f66664aa4f3