`Lectures`: Disable submit button on invalid form and add tooltip #10129

laxerhd · 2025-01-11T20:44:00Z

Opening this PR from a branch in the main repository to enable test server deployment, as it wasn't possible with the previous PR from a forked repository (see #9846)

Checklist

General

I tested all changes and their related features with all corresponding user types on a test server.
This is a small issue that I tested locally and was confirmed by another developer on a test server.
Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
I chose a title conforming to the naming conventions for pull requests.

Server

Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
I strictly followed the server coding and design guidelines.

Client

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 added multiple screenshots/screencasts of my UI changes.
I translated all newly inserted strings into English and German.

Motivation and Context

Fixes #9829. The submit button did not indicate that a mandatory field was still missing and could be clicked.
This led to confusion among users.
The error message for files that were too large also had an redundant sentence.

Description

I have updated/changed the conditions in isValidForm to recognize empty string names and uploaded files.

Steps for Testing

Prerequisites:

1 Instructor
1 Course
1 Lecture

Log in to Artemis
Navigate the Course
Create a new Lecture
Click on Units -> File
Take a look at tooltip and unclickable submit button

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

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 even for very large courses with more than 2000 students.
I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

Code Review 1
Code Review 2

Manual Tests

Test 1
Test 2

Exam Mode Test

Test 1
Test 2

Performance Tests

Test 1
Test 2

Screenshots

tooltip-submit-button.mp4

Summary by CodeRabbit

New Features
- Enhanced form validation for attachment unit creation.
- Added multilingual validation error messages for required fields.
Bug Fixes
- Improved form input requirements for name and file selection.
Documentation
- Updated error messages in German and English translations to provide clearer user guidance.
Style
- Refined HTML template structure for attachment unit form.
- Added tooltip for form submission button.

…language

laxerhd · 2025-01-11T20:45:38Z

@florian-glombik I am very sorry for the pings, but here is the newly opend PR about the tooltip.

coderabbitai · 2025-01-11T20:46:47Z

Walkthrough

The pull request involves modifications to the attachment unit form in the Artemis application, focusing on enhancing validation and user experience. Changes include updates to the HTML structure, TypeScript component logic, and internationalization files. Specifically, the form now requires both a name and a file for submission, incorporates tooltips for better user guidance, and improves error messaging to inform users of validation issues.

Changes

File	Change Summary
`src/main/webapp/app/lecture/lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.html`	Updated label formatting, reorganized submit button with tooltip, adjusted cancel button placement, removed file size limitation message
`src/main/webapp/app/lecture/lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.ts`	Added imports, marked `fileName` as required, simplified `isFormValid`, introduced `currentLanguage` and `tooltipText`, updated `onFileChange` and `setFormValues` methods
`src/main/webapp/i18n/de/lectureUnit.json`	Added new validation error message for required name and file
`src/main/webapp/i18n/en/lectureUnit.json`	Added new validation error message for required name and file

Assessment against linked issues

Objective	Addressed	Explanation
Disable submit button if no file is uploaded	✅
Display tooltip on disabled button	✅
Indicate why saving is not possible	✅

Possibly related PRs

Development: Use signals in lecture add attachment form #9656: Introduces signals in attachment-unit-form component.
Development: Use signals in lecture online and text unit #9658: Uses signals in online-unit-form component.
Lectures: Validate the date for lecture units #9765: Enhances validation logic with date picker component.

Suggested labels

tests, ready for review, bugfix, user interface, small, ready to merge

Suggested reviewers

BBesrour
krusche
Feras797
JohannesStoehr
az108

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7af6ddb and 2765770.

📒 Files selected for processing (1)

src/main/webapp/app/lecture/lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.html (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

src/main/webapp/app/lecture/lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.html

⏰ Context from checks skipped due to timeout of 90000ms (8)

GitHub Check: client-tests-selected
GitHub Check: client-tests
GitHub Check: client-style
GitHub Check: server-tests
GitHub Check: server-style
GitHub Check: Build and Push Docker Image
GitHub Check: Build .war artifact
GitHub Check: Analyse

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

ole-ve

tested on TS4, works as described for editing file units in the Lecture > Units view.

Pbl out-of-scope, but I noticed that updating lecture units from within the edit-lecture view does not work. see attached video

Screen.Recording.2025-01-12.at.17.27.43.mov

laxerhd · 2025-01-12T19:36:34Z

I also noticed that the tooltip is misplaced when there is a Cancel button. Will fix that quickly.
@ole-ve you will probably have to reapprove after that, sorry about that!

laxerhd · 2025-01-12T19:39:57Z

Tooltip is now displayed correctly 👍
I also noticed that the color of the button is the same as the background when you hover over “Cancel”.

github-actions · 2025-02-06T12:05:44Z

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.

github-actions · 2025-02-15T12:13:02Z

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.

magaupp

Some suggestions

magaupp · 2025-02-16T19:01:31Z

.../lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.ts

+    tooltipText = computed(() => {
+        this.currentLanguage();
+        if (!this.fileName() && !this.name()) {
+            return this.translateService.instant('artemisApp.attachmentUnit.createAttachmentUnit.nameAndFileRequiredValidationError');
+        }
+        if (!this.fileName()) {
+            return this.translateService.instant('artemisApp.attachmentUnit.createAttachmentUnit.fileRequiredValidationError');
+        }
+        if (!this.name()) {
+            return this.translateService.instant('artemisApp.attachmentUnit.createAttachmentUnit.nameRequiredValidationError');
+        }
+        return undefined;
+    });


You can use the stream() method of the translateService to subscribe to language changes directly. Wrap the observables returned by stream() in a signal and use them here. No manual currentLanguage subscription required.

I made the changes to the manual subscription. Did you mean it like that?

You used stream() in the same way as the previous method.
This is calling the signal just to create a dependency on change notifications and then calling the translateService to get the new translation.

Instead, we can use the provided value of stream(), which already includes the translation. This way we can subscribe to changes and receive the translation with a single method call.

I was thinking of something like this:

private readonly nameAndFileRequiredValidationErrorTranslation = toSignal(this.translateService.stream('artemisApp.attachmentUnit.createAttachmentUnit.nameAndFileRequiredValidationError')); private readonly fileRequiredValidationErrorTranslation = toSignal(this.translateService.stream('artemisApp.attachmentUnit.createAttachmentUnit.fileRequiredValidationError')); private readonly nameRequiredValidationErrorTranslation = toSignal(this.translateService.stream('artemisApp.attachmentUnit.createAttachmentUnit.nameRequiredValidationError'));

tooltipText = computed(() => { if (!this.fileName() && !this.name()) { return this.nameAndFileRequiredValidationErrorTranslation(); } if (!this.fileName()) { return this.fileRequiredValidationErrorTranslation(); } if (!this.name()) { return this.nameRequiredValidationErrorTranslation(); } return undefined; });

.../lecture-unit/lecture-unit-management/attachment-unit-form/attachment-unit-form.component.ts

HanyangXu0508

tested on server 6 and worked as expected

…invalid-form-add-tooltip

…ation

krusche · 2025-02-22T08:28:22Z

Closed because of being inactive and/or open for a too long time. Please re-open a new pull request, if you still want to finish this feature and make sure to finish reviewing and testing quickly so merging the PR can be done within at most 2 weeks! This is best practice, avoids merge conflicts and reduces maintenance efforts!

laxerhd added 10 commits December 6, 2024 18:06

Added varying tooltip to submit button

4f615af

Refactor: Moved logic from html to ts component

4ee592e

Enable tooltip on whole button

2cdecd8

Remove duplicate file to big message

37b88d4

Added combined error message to lectureUnit translation

008dc3f

Usage of strict equality for consistency in condition

14bbaad

Fix grammar mistake in comment

694dffe

Add name signal and refactor tooltipText

565a910

Tracking of new language signal to compute new tooltip for different …

326fc94

…language

Integrate fileName into FormGroup

6947d0d

laxerhd self-assigned this Jan 11, 2025

laxerhd requested a review from a team as a code owner January 11, 2025 20:44

github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Jan 11, 2025

laxerhd force-pushed the bugfix/lectures/disable-submit-button-on-invalid-form-add-tooltip branch from 6947d0d to 549166b Compare January 11, 2025 20:44

laxerhd added the lecture Pull requests that affect the corresponding module label Jan 11, 2025

coderabbitai bot previously approved these changes Jan 11, 2025

View reviewed changes

ole-ve added the deploy:artemis-test4 label Jan 12, 2025

ole-ve temporarily deployed to artemis-test4.artemis.cit.tum.de January 12, 2025 16:15 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test4 and removed deploy:artemis-test4 labels Jan 12, 2025

ole-ve previously approved these changes Jan 12, 2025

View reviewed changes

ole-ve removed the lock:artemis-test4 label Jan 12, 2025

laxerhd dismissed stale reviews from ole-ve and coderabbitai[bot] via 7af6ddb January 12, 2025 19:38

github-actions bot removed the lecture Pull requests that affect the corresponding module label Jan 12, 2025

coderabbitai bot previously approved these changes Jan 12, 2025

View reviewed changes

ItsaaaMeMario added deploy:artemis-test4 and removed deploy:artemis-test4 labels Jan 24, 2025

vinceclifford added deploy:artemis-test5 and removed deploy:artemis-test5 labels Jan 29, 2025

github-actions bot added the stale label Feb 6, 2025

laxerhd removed the stale label Feb 8, 2025

github-actions bot added the stale label Feb 15, 2025

laxerhd removed the stale label Feb 16, 2025

magaupp requested changes Feb 17, 2025

View reviewed changes

HanyangXu0508 previously approved these changes Feb 17, 2025

View reviewed changes

Merge branch 'develop' into bugfix/lectures/disable-submit-button-on-…

b630299

…invalid-form-add-tooltip

laxerhd dismissed stale reviews from HanyangXu0508, asliayk, ole-ve, and coderabbitai[bot] via b630299 February 18, 2025 20:11

Added datePickerComponent back to isFormValid check

7d8af08

coderabbitai bot previously approved these changes Feb 18, 2025

View reviewed changes

laxerhd added 2 commits February 18, 2025 21:45

Use stream instead of manual subscription for language changes

7558eb9

Removed fileName from FormGroup and added check to isFormValid comput…

a88656d

…ation

laxerhd dismissed coderabbitai[bot]’s stale review via a88656d February 18, 2025 21:08

coderabbitai bot approved these changes Feb 20, 2025

View reviewed changes

krusche closed this Feb 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Lectures`: Disable submit button on invalid form and add tooltip #10129

`Lectures`: Disable submit button on invalid form and add tooltip #10129

laxerhd commented Jan 11, 2025 •

edited by coderabbitai bot

Loading

laxerhd commented Jan 11, 2025

coderabbitai bot commented Jan 11, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

ole-ve left a comment

laxerhd commented Jan 12, 2025

laxerhd commented Jan 12, 2025 •

edited

Loading

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 15, 2025

magaupp left a comment

magaupp Feb 16, 2025

laxerhd Feb 18, 2025

magaupp Feb 20, 2025

HanyangXu0508 left a comment

krusche commented Feb 22, 2025

Lectures: Disable submit button on invalid form and add tooltip #10129

Lectures: Disable submit button on invalid form and add tooltip #10129

Conversation

laxerhd commented Jan 11, 2025 • edited by coderabbitai bot Loading

Checklist

General

Server

Client

Motivation and Context

Description

Steps for Testing

Testserver States

Review Progress

Performance Review

Code Review

Manual Tests

Exam Mode Test

Performance Tests

Screenshots

Summary by CodeRabbit

laxerhd commented Jan 11, 2025

coderabbitai bot commented Jan 11, 2025 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

ole-ve left a comment

Choose a reason for hiding this comment

laxerhd commented Jan 12, 2025

laxerhd commented Jan 12, 2025 • edited Loading

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 15, 2025

magaupp left a comment

Choose a reason for hiding this comment

magaupp Feb 16, 2025

Choose a reason for hiding this comment

laxerhd Feb 18, 2025

Choose a reason for hiding this comment

magaupp Feb 20, 2025

Choose a reason for hiding this comment

HanyangXu0508 left a comment

Choose a reason for hiding this comment

krusche commented Feb 22, 2025

`Lectures`: Disable submit button on invalid form and add tooltip #10129

`Lectures`: Disable submit button on invalid form and add tooltip #10129

laxerhd commented Jan 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 11, 2025 •

edited

Loading

laxerhd commented Jan 12, 2025 •

edited

Loading