Hide annotations in speedgrader

[jlge]

Description

• Allow users to hide annotations in speedgrader view

Motivation and Context

Resolves #2203

How Has This Been Tested?

As instructor

• go to speedgrader for assignment, see that it works
• see that when comments are hidden, new annotations that are created are still hidden

As student

• go to assessment with comments on it
• view files, and see that it works

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:

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

Other issues / help required

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

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

The pull request introduces new JavaScript functions and HTML elements to enhance the visibility control of annotations within the application. Specifically, it adds functions to show and hide annotations and integrates these functionalities into the user interface through new buttons. The changes ensure that annotations can be toggled based on user interactions, improving the overall user experience for instructors and course assistants.

Changes

File	Change Summary
app/assets/javascripts/annotations.js	Added functions: commentsVisible, hideAnnotations, showAnnotations. Updated submitNewAnnotation to conditionally append annotations based on visibility. Modified initializeAnnotationsForPDF to incorporate visibility logic.
app/views/submissions/view.html.erb	Added "Hide Comments" and "Show Comments" buttons, which call hideAnnotations() and showAnnotations(). Buttons conditionally rendered for instructors and course assistants.

Assessment against linked issues

Objective	Addressed	Explanation
Have option to hide annotations in speedgrader (#2203)	✅

Possibly related PRs

• #2208: The changes in this PR involve the addition of buttons that utilize the hideAnnotations() and showAnnotations() functions, which are also introduced in the main PR, indicating a direct connection in functionality related to annotation visibility.

Suggested reviewers

• evanyeyeye

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[20wildmanj]

When you hide comments, you can still navigate to them using the annotations tab, but they aren't visible. Any thoughts on if they should become visible when you navigate to them?

Also, you can add annotations while annotations are hidden, and then the annotations are still hidden, not sure if that's the best user experience either.

[jlge]

When you hide comments, you can still navigate to them using the annotations tab, but they aren't visible. Any thoughts on if they should become visible when you navigate to them?

Also, you can add annotations while annotations are hidden, and then the annotations are still hidden, not sure if that's the best user experience either.

Yeah I was thinking about what the behavior should be and I felt like consistent behavior made the most sense for me (all hidden or all shown) since it could get confusing, but having the ability to hide on a more granular level could be helpful too idk tbh,, I will ask around maybe