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

Plagiarism checks: Fix files not being shown in plagiarism viewer #9347

Merged

Conversation

magaupp
Copy link
Contributor

@magaupp magaupp commented Sep 21, 2024

Checklist

General

Client

Changes affecting Programming Exercises

  • High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).
  • I tested all changes and their related features with all corresponding user types on a test server configured with Gitlab and Jenkins.

Motivation and Context

The plagiarism code viewer always displays No file selected. #8803 moved the jhiTranslate into a tag which sets its content with innerHTML. jhiTranslate takes precedence over innerHTML here.

Description

The jhiTranslate attribute is moved into an inner <span> tag.

Steps for Testing

Prerequisites:

  • 1 Instructor
  • 2 Students
  • 1 Programming Exercise supporting plagiarism checks
  1. Submit a solution different from the base template as Student 1
  2. Submit the same solution as Student 2
  3. Run a plagiarism check as the Instructor
  4. The file contents should be visible in the plagiarism viewer

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.







Review Progress

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Test Coverage

Screenshots

Current:
Screenshot 2024-09-21 at 12-55-41 Plagiarism Detection Java Plag Local Course
Fixed:
Screenshot 2024-09-21 at 12-53-39 Plagiarism Detection Java Plag Test Course Marcel Gaupp

Summary by CodeRabbit

  • New Features

    • Improved semantic structure of the text submission viewer by wrapping the translation directive in a span element for better clarity.
  • Bug Fixes

    • Enhanced display handling of text submissions, ensuring proper rendering of content based on conditions.

@magaupp magaupp requested a review from a team as a code owner September 21, 2024 10:37
@magaupp magaupp added the small label Sep 21, 2024
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Sep 21, 2024
Copy link

coderabbitai bot commented Sep 21, 2024

Walkthrough

The changes involve modifying the HTML structure in the text-submission-viewer.component.html file. The jhiTranslate directive, which was previously an attribute of a div element, has been moved inside a span element within the same div. This adjustment maintains the existing class and binding attributes while altering the organization of the translation key for improved semantic clarity.

Changes

File Change Summary
src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.html The jhiTranslate directive for artemisApp.plagiarism.noFileSelected was moved from a div attribute to a span inside the div.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TextSubmissionViewer
    participant TranslationService

    User->>TextSubmissionViewer: Request to view text submission
    TextSubmissionViewer->>TranslationService: Fetch translation for 'artemisApp.plagiarism.noFileSelected'
    TranslationService-->>TextSubmissionViewer: Return translation
    TextSubmissionViewer-->>User: Display translated message
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 0354197 and d474715.

Files selected for processing (1)
  • src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.html (1 hunks)
Additional context used
Path-based instructions (1)
src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.html (1)

Pattern src/main/webapp/**/*.html: @if and @for are new and valid Angular syntax replacing *ngIf and *ngFor. They should always be used over the old style.

Additional comments not posted (1)
src/main/webapp/app/exercises/shared/plagiarism/plagiarism-split-view/text-submission-viewer/text-submission-viewer.component.html (1)

11-13: LGTM!

The change to move the jhiTranslate directive into an inner <span> tag is in line with the PR objective and is expected to resolve the display issue in the plagiarism viewer. The change is semantically correct, improves the clarity of the code, and adheres to the coding guidelines.


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 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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

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

@BaumiCoder BaumiCoder left a comment

Choose a reason for hiding this comment

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

Code

Copy link
Contributor

@JohannesWt JohannesWt left a comment

Choose a reason for hiding this comment

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

Code

Copy link
Contributor

@edkaya edkaya left a comment

Choose a reason for hiding this comment

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

Tested on TS2, works as expected

Copy link
Member

@BBesrour BBesrour left a comment

Choose a reason for hiding this comment

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

Tested on TS2, lgtm

@krusche krusche added this to the 7.5.4 milestone Sep 22, 2024
@krusche krusche merged commit e3f5cdd into develop Sep 22, 2024
69 of 74 checks passed
@krusche krusche deleted the bugfix/plagiarism-checks/fix-submissionviewer-translation branch September 22, 2024 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) ready to merge small
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants