Autolab icon indicating copy to clipboard operation
Autolab copied to clipboard

Progress loading for manage submissions

Open KesterTan opened this issue 9 months ago • 1 comments

Motivation and Context

Buttons takes a long time for a large class, instructors don't get any visual feedback when buttons are clicked. This might result in them clicking buttons another time which increases the time spent waiting for regrade-alls etc. This is now fixed by adding a loading symbol when the button is clicked. Screenshot 2025-04-14 at 3 32 16 AM

Description

  • Fixes selecting-all checkbox and then regrading
  • Converts regrade-all into Ajax
  • Adds loading before Ajax to all Ajax function calls (regrade-selected, excuse-selected, delete-selected, regrade-all)
  • Buttons disabled after it is clicked

How Has This Been Tested?

  • Check to see if manage submission buttons work as expected
  • Check that loading symbol renders when buttons are clicked and removed when the request is completed

Types of changes

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

Checklist:

  • [x] 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

KesterTan avatar Apr 14 '25 07:04 KesterTan

📝 Walkthrough

Walkthrough

This update introduces new user interface and control flow enhancements for regrading submissions. It adds a new event handler for regrade actions that verifies user intent and provides immediate visual feedback by disabling buttons and showing a loading icon. On the server side, modifications were made to improve submission ID filtering and update response handling for regrade requests. Additionally, the related CSS is enhanced with new classes and animations, and the HTML structure for the regrade buttons is streamlined.

Changes

File(s) Change Summary
app/assets/javascripts/manage_submissions.js
app/assets/stylesheets/manage_submissions.css.scss
Added click event handlers for #regrade-all-btn and #regrade-all-trigger to confirm regrade actions, disable UI elements, and show a loading icon via a new changeButtonStates function. Introduced new CSS classes (.loading-icon, .disabled-link) and @keyframes spin for visual feedback.
app/controllers/assessment/autograde.rb Modified regradeBatch to filter submission IDs with compact and adjusted error handling. Updated regradeAll to use a respond_to block for HTML and JSON responses. Modified the _is_i? method signature and logic to support both Integers and numeric Strings.
app/views/submissions/index.html.erb Updated the HTML structure for regrade-related buttons by replacing embedded Ruby helpers with direct <a> tags, adding specific IDs (regrade-all-btn, regrade-selected-btn, regrade-all-trigger) to streamline the triggering of JavaScript events.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant B as Browser
    participant JS as manage_submissions.js
    participant S as Server (AssessmentAutograde)
    
    U->>B: Click "Regrade All" button/link
    B->>JS: Trigger click event handler
    JS->>JS: Prompt confirmation for regrading all submissions
    alt User confirms
        JS->>B: Start refresh interval (5s)
        JS->>JS: Disable button & update loading icon
        JS->>S: AJAX POST to regradeAll (with CSRF token)
        S-->>JS: Respond with JSON (redirect or status)
        JS->>B: Clear refresh interval
        alt Response includes redirect URL
            JS->>B: Navigate to the provided URL
        else Response includes messages/errors
            JS->>B: Display alert with message/error
        end
    else User cancels
        JS->>B: Abort action
    end

[!TIP]

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

coderabbitai[bot] avatar Apr 14 '25 07:04 coderabbitai[bot]