`Exam mode`: Fix problems with highlighting of the differences in the problem statement #8461

coolchock · 2024-04-22T22:20:22Z

Checklist

General

I tested all changes and their related features with all corresponding user types on a test server.
I chose a title conforming to the naming conventions for pull requests.

Client

Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data.
I strictly followed the client coding and design guidelines.
Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
I documented the TypeScript code using JSDoc style.
I added multiple screenshots/screencasts of my UI changes.

Motivation and Context

Currently there is an issue that differences in a problem statement are not properly highlighted when a change occurs inside of code tag (single backtick operator) or in the task that gets injected into the markdown.
This pull requests resolves this issue and ensures that differences are rendered correctly, regardless of their location in the markdown.

Description

Previously, differences between two problem statements were calculated at the markdown level and then markdown with highlighted differences was rendered. This occasionally led to errors, especially when changes occurred within special syntax such as code blocks or URLs. With the new approach, the problem statement markdowns are first converted into HTML. Then, differences between rendered problem statements are calculated using an HTML diff library.

The logic to remove tasks and inject them back into the document was moved to ProgrammingExerciseInstructionComponent to enable calculating tasks from the markdown with differences.

Steps for Testing

Prerequisites:

1 Instructor
1 Student
1 Exam with a programming exercise

There is already an exam called 'problem-statement-updates' in 'Test Course Michal Kawka' on ts2. Test users 1-7 are registered for the exam.

Log in to Artemis as a student in one browser
Log in to Artemis as an instructor in the second browser or incognito tab
Navigate to the exam as a student and open the programming exercise
As instructor, make some changes to the problem statement inside inside of special syntax (triple backtip, single backtick, <>, etc.)
As student, verify that the differences are highlighted correctly
As instructor, make some changes to the problem statement in one of the tasks. Task looks as follows (this is not highlighting, just an explanation what is meant by task):

As student, verify that the differences are highlighted correctly
Please also make some changes in the other places, for example headers, bold and italic parts of the markdown and ensure that everything works as expected.

Testserver States

Note

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

Review Progress

Performance Review

I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance
I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

Code Review 1
Code Review 2

Manual Tests

Test 1
Test 2

Exam Mode Test

Test 1
Test 2

Screenshots

Differences inside single backticks
Before:

After:

Differences in the tasks
Before:

After:

Summary by CodeRabbit

New Features
- Enhanced problem statement highlighting in exam exercises using HTML for better visual differentiation.
- Improved markdown to HTML conversion for more accurate problem statement displays.
Updates
- All exam submission components now display problem statements using an HTML variable for consistency and clarity.
- Problem statement update methods now accept HTML inputs for uniform handling across different exam exercise types.

coderabbitai · 2024-04-23T21:55:08Z

Walkthrough

The recent updates primarily focus on enhancing the way problem statements are processed and displayed across various exam exercise components. The significant change involves using the htmlForMarkdown utility to convert markdown to HTML and employing html-diff-ts for highlighting differences in updated problem statements. These changes streamline problem statement handling by using a unified HTML representation, improving clarity and consistency.

Changes

Files	Change Summary
`.../exam-exercise-update-highlighter/exam-exercise-update-highlighter.component.ts`	Updated to handle problem statement differences with `html-diff-ts` and `htmlForMarkdown`. Added and modified class properties to support these changes.
`.../exercises/file-upload/file-upload-exam-submission.component.ts` `.../exercises/modeling/modeling-exam-submission.component.ts` `.../exercises/text/text-exam-submission.component.ts`	Imported `htmlForMarkdown` and updated problem statement handling by introducing `problemStatementHtml`. Adjusted method signatures for updating problem statements.
`.../exercises/file-upload/file-upload-exam-submission.component.html` `.../exercises/modeling/modeling-exam-submission.component.html` `.../exercises/text/text-exam-submission.component.html`	Updated the HTML templates to use `problemStatementHtml` for displaying problem statements instead of directly accessing `exercise.problemStatement`.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between edae665 and 9231c0e.

Files selected for processing (3)

src/main/webapp/app/exam/participate/exercises/file-upload/file-upload-exam-submission.component.html (1 hunks)
src/main/webapp/app/exam/participate/exercises/modeling/modeling-exam-submission.component.html (1 hunks)
src/main/webapp/app/exam/participate/exercises/text/text-exam-submission.component.html (1 hunks)

Additional context used

Path-based instructions (3)

src/main/webapp/app/exam/participate/exercises/modeling/modeling-exam-submission.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.

src/main/webapp/app/exam/participate/exercises/text/text-exam-submission.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.

src/main/webapp/app/exam/participate/exercises/file-upload/file-upload-exam-submission.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 (6)

src/main/webapp/app/exam/participate/exercises/modeling/modeling-exam-submission.component.html (2)

48-48: Use problemStatementHtml instead of exercise.problemStatement.

The updated code correctly uses problemStatementHtml for the problem statement.

50-50: Use problemStatementHtml instead of exercise.problemStatement.

The updated code correctly uses problemStatementHtml for the problem statement.

src/main/webapp/app/exam/participate/exercises/text/text-exam-submission.component.html (2)

54-54: Use problemStatementHtml instead of exercise.problemStatement.

The updated code correctly uses problemStatementHtml for the problem statement.

56-56: Use problemStatementHtml instead of exercise.problemStatement.

The updated code correctly uses problemStatementHtml for the problem statement.

src/main/webapp/app/exam/participate/exercises/file-upload/file-upload-exam-submission.component.html (2)

77-77: Use problemStatementHtml instead of exercise.problemStatement.

The updated code correctly uses problemStatementHtml for the problem statement.

79-79: Use problemStatementHtml instead of exercise.problemStatement.

The updated code correctly uses problemStatementHtml for the problem statement.

Tip

Early access features: enabled

We are currently testing the following features in early access:

OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
Please join our Discord Community to provide feedback and report issues.
OSS projects are always opted into early access features.

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

pzdr7

Tested on TS2 - can you double check the code block (```) functionality?

pzdr7 · 2024-04-24T08:30:08Z

src/main/webapp/app/shared/markdown.service.ts

@@ -59,4 +68,19 @@ export class ArtemisMarkdownService {
        convertedString = convertedString.slice(0, paragraphPosition) + convertedString.slice(paragraphPosition).replace('<p>', '<p class="inline-paragraph">');
        return this.sanitizer.bypassSecurityTrustHtml(convertedString);
    }
+
+    /**
+     * Unescapes html tags that are placed inside <code> tags (single backtick operator).


The <code> tag is also used for code blocks (triple backtick):

Source code:

Problem statement:

If I make a change, e.g.

The problem statement (with changes enabled) displays this:

Can we do something about this?

pzdr7 · 2024-04-24T08:38:20Z

It could be out of scope for this PR, but URLs have a similar problem:

I changed

[url](https://github.com/ls1intum/Artemis/pull/8461)

to

[url](https://github.com/ls1intum/Artemis/pull/8462)

and got

krusche · 2024-04-27T08:28:42Z

I'm not sure if escaping is a good solution here. There will always be difficulties for special syntax. Would it not make more sense to use some kind of html diff?

github-actions · 2024-05-04T12:03:57Z

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

…of-differences

github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Apr 22, 2024

github-actions bot assigned coolchock Apr 22, 2024

coolchock added the deploy:artemis-test2 label Apr 23, 2024

coolchock temporarily deployed to artemis-test2.artemis.cit.tum.de April 23, 2024 21:38 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test2 and removed deploy:artemis-test2 labels Apr 23, 2024

coolchock added ready for review bugfix component:Exam Mode and removed lock:artemis-test2 labels Apr 23, 2024

coolchock marked this pull request as ready for review April 23, 2024 21:55

coolchock requested a review from a team as a code owner April 23, 2024 21:55

coderabbitai bot previously approved these changes Apr 23, 2024

View reviewed changes

pzdr7 reviewed Apr 24, 2024

View reviewed changes

github-actions bot added stale and removed ready for review labels May 4, 2024

fix problems with highlighting of differences

6f7fadb

coolchock dismissed coderabbitai[bot]’s stale review via 6f7fadb May 9, 2024 13:19

coolchock force-pushed the bugfix/exam-mode/highlighting-of-differences branch from 85d4409 to 6f7fadb Compare May 9, 2024 13:19

github-actions bot added the server Pull requests that update Java code. (Added Automatically!) label May 9, 2024

Merge branch 'refs/heads/develop' into bugfix/exam-mode/highlighting-…

4fa380f

…of-differences

coderabbitai bot previously approved these changes May 9, 2024

View reviewed changes

coolchock added the deploy:artemis-test3 label May 9, 2024

coolchock temporarily deployed to artemis-test3.artemis.cit.tum.de May 9, 2024 17:42 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test3 and removed deploy:artemis-test3 labels May 9, 2024

coderabbitai bot approved these changes Jun 30, 2024

View reviewed changes

krusche approved these changes Jun 30, 2024

View reviewed changes

krusche merged commit 6ae0625 into develop Jun 30, 2024
26 of 29 checks passed

krusche deleted the bugfix/exam-mode/highlighting-of-differences branch June 30, 2024 14:57

Strohgelaender mentioned this pull request Jun 30, 2024

Exam mode: The diff for problem statement changes is broken if inside Markdown structures #7793

Closed

just-max mentioned this pull request Jul 13, 2024

Programming Exercise Descriptions: Underscores in Both Task Name and in Test Names Break Display by Adding Italics #9035

Closed

pzdr7 mentioned this pull request Jul 13, 2024

Programming exercises: Fix an issue with special characters in task names #9037

Merged

11 tasks

just-max mentioned this pull request Jul 24, 2024

Problem Statement in Text Exercises not getting displayed properly #9110

Open

This was referenced Sep 22, 2024

Exam mode: Enable students to participate in the test exam multiple times #8609

Closed

Development: Upgrade markdown library to markdown-it #9354

Merged

This was referenced Sep 29, 2024

Development: Fix flaky e2e tests #9326

Merged

General: Animate content sidebar on toggle #9412

Merged

This was referenced Oct 19, 2024

Communication: Improve unread messages count view on sidebar #9522

Merged

Development: Replace deprecated before unload event with pending changes guard #9479

Merged

coderabbitai bot mentioned this pull request Nov 4, 2024

Programming exercises: Add information box to exercise details page #9668

Merged

17 tasks

This was referenced Dec 6, 2024

Programming exercises: Fix table overflow in rendered markdown #9957

Merged

Feature: Add conditional tooltip for edit button in exam exercise row #9917

Closed

coderabbitai bot mentioned this pull request Feb 15, 2025

General: Migrate exercise group module to signals #9924

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Exam mode`: Fix problems with highlighting of the differences in the problem statement #8461

`Exam mode`: Fix problems with highlighting of the differences in the problem statement #8461

coolchock commented Apr 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 23, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

pzdr7 left a comment

pzdr7 Apr 24, 2024

pzdr7 commented Apr 24, 2024

krusche commented Apr 27, 2024

github-actions bot commented May 4, 2024

Exam mode: Fix problems with highlighting of the differences in the problem statement #8461

Exam mode: Fix problems with highlighting of the differences in the problem statement #8461

Conversation

coolchock commented Apr 22, 2024 • edited by coderabbitai bot Loading

Checklist

General

Client

Motivation and Context

Description

Steps for Testing

Testserver States

Review Progress

Performance Review

Code Review

Manual Tests

Exam Mode Test

Screenshots

Summary by CodeRabbit

coderabbitai bot commented Apr 23, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

pzdr7 left a comment

Choose a reason for hiding this comment

pzdr7 Apr 24, 2024

Choose a reason for hiding this comment

pzdr7 commented Apr 24, 2024

krusche commented Apr 27, 2024

github-actions bot commented May 4, 2024

`Exam mode`: Fix problems with highlighting of the differences in the problem statement #8461

`Exam mode`: Fix problems with highlighting of the differences in the problem statement #8461

coolchock commented Apr 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 23, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)