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

Fix student download submission bug to have unique names #2244

Merged
merged 2 commits into from
Feb 18, 2025

Conversation

jhs-panda
Copy link
Contributor

@jhs-panda jhs-panda commented Nov 20, 2024

Description

Fix bug missed by #2137.
If a file has multiple files with the same name, will add unique identifier at end to differentiate files and ensure zipping for download all submissions feature for students does not run into issues.
Note: Could be made more efficient if in the case of multiple of the same name, the first has the normal name and the future ones have _ver# attached. For aesthetic purposes, appended _ver# to all those with same name.

Motivation and Context

If a student has multiple submissions with the same submission file name, downloading the submissions will run into issues because there are multiple files of the same name being zipped together. Issue occurred in production.

The change will append "_ver{#}" to the name of the file if there are multiple files with that same name to differentiate the different files and allow for smooth folder compression.

Fixes #2188.

How Has This Been Tested?

To test, duplicates some of the files when downloading (so file names had multiples) to ensure version naming worked.
image
For files that don't have duplicate file names, feature does not add the unique name modification (what it was like previously).
Screen Shot 2024-11-20 at 2 09 09 AM

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting
  • My change requires a change to the documentation, which is located at Autolab Docs
  • I have updated the documentation accordingly, included in this PR

Other issues / help required

If unsure, feel free to submit first and we'll help you along.

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

📝 Walkthrough

Walkthrough

The changes in the UsersController focus on enhancing the functionality of the download_all_submissions method. New logic has been introduced to manage duplicate file names during the zipping process by utilizing two hash structures: track_duplicate_counts and filename_counts. These changes improve how file names are handled without altering the overall control flow of the method. No modifications were made to the signatures of exported or public entities.

Changes

File Change Summary
app/controllers/users_controller.rb - Updated download_all_submissions to track duplicate file names and append version numbers.

Assessment against linked issues

Objective Addressed Explanation
Fix Zip::EntryExistsError in download_all_submissions (#2188)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 891efc6 and 8329224.

📒 Files selected for processing (1)
  • app/controllers/users_controller.rb (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/controllers/users_controller.rb
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
app/controllers/users_controller.rb (1)

199-215: Consider adding tests for the versioning logic.

The implementation correctly handles duplicate filenames by appending version numbers while preserving file extensions. However, to prevent regression, consider adding tests that verify:

  1. Files without duplicates remain unchanged
  2. Duplicate files get correct version numbers
  3. File extensions are preserved correctly

Would you like me to help create test cases for these scenarios?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 96006d5 and 891efc6.

📒 Files selected for processing (1)
  • app/controllers/users_controller.rb (1 hunks)
🔇 Additional comments (1)
app/controllers/users_controller.rb (1)

192-197: LGTM! Effective solution for tracking duplicate filenames.

The implementation efficiently tracks duplicate filenames using a hash with default value of 0, which is a good practice for counting occurrences.

@jhs-panda jhs-panda requested review from a team and jlge and removed request for a team November 20, 2024 08:31
@KesterTan KesterTan requested review from KesterTan and removed request for jlge January 18, 2025 20:42
Copy link
Contributor

@KesterTan KesterTan left a comment

Choose a reason for hiding this comment

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

LGTM! Nice work

@jhs-panda jhs-panda added this pull request to the merge queue Feb 18, 2025
Merged via the queue into master with commit cd900f8 Feb 18, 2025
6 checks passed
@jhs-panda jhs-panda deleted the joy-fix-download-all branch February 18, 2025 01:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Download all submissions feature for students failing in production
2 participants