`Learning path`: Add learning path explanation for students #8815

JohannesWt · 2024-06-17T19:33:45Z

Checklist

General

I tested all changes and their related features with all corresponding user types 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.

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 added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
I added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
I documented the TypeScript code using JSDoc style.
I added multiple screenshots/screencasts of my UI changes.
I translated all newly inserted strings into English and German.

Motivation and Context

This PRs introduces students to the concept of learning paths if they did not use it before.

Description

If a learning path has not been generated yet a new welcome text is displayed. The text shortly introduces the student to the concept of learning paths. Additionally the student generates his/her learning path him/herself by clicking on a new generation button.

Steps for Testing

Prerequisites:

1 student (with no learning path generated yet)
1 lecture with learning paths enabled
at least one Lecture Unit (or Exercise) connected to a competency

Log in to Artemis
Navigate to the course
navigate to learning paths
if no learning path has yet been generated a short text should be displayed and a generate button
by clicking on the generate button a learning path should be generated and the "normal" learning path UI should be displayed

The following test servers can be used for testing -> Course Johannes Wiest (if you don't want to test locally).
Please mark the user if you tested with it that other testers don't use the same user.

Test Server 1:

artemis_test_user_2
artemis_test_user_4
artemis_test_user_5

Test Server 4:

artemis_test_user_2
artemis_test_user_3
artemis_test_user_4
artemis_test_user_5

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

Test Coverage

github-actions · 2024-06-18T12:31:15Z

⚠️ Unable to deploy to test servers ⚠️

Testserver "artemis-test4.artemis.cit.tum.de" is already in use by PR #8662.

github-actions · 2024-06-18T12:36:50Z

⚠️ Unable to deploy to test servers ⚠️

Testserver "artemis-test1.artemis.cit.tum.de" is already in use by PR #8809.

rstief

tested on ts4 works as expected. Code also lgtm

edkaya

Code lgtm

...se/learning-paths/pages/learning-path-student-page/learning-path-student-page.component.html

pzdr7 · 2024-06-18T22:21:46Z

.../javascript/spec/component/learning-paths/pages/learning-path-student-page.component.spec.ts

+        expect(loadingSpy).toHaveBeenCalledWith(true);
+        expect(loadingSpy).toHaveBeenCalledWith(false);


Just a thought: I wonder if we could be more specific here. Would toHaveBeenNthCalledWith(1, true) and toHaveBeenNthCalledWith(2, false) work? Same for the test should set isLoading correctly during learning path load

This way, we'd be making sure that the order of values is also correct

...se/learning-paths/pages/learning-path-student-page/learning-path-student-page.component.html

pzdr7 · 2024-06-18T22:35:33Z

src/main/webapp/i18n/en/learningPath.json

+            "generation": {
+                "title": "Welcome to learning paths!",
+                "description": "Welcome to your learning path! This feature lets you learn at your own pace with a personalized journey tailored to your performance. It adapts dynamically, ensuring you always have the most relevant content and challenges. Start now and experience a customized path to success!",
+                "generateButton": "Start my learning path"


The translations don't seem 100% consistent between German and English here.

For example:

German: Willkommen bei deinem Lernpfad
English: Welcome to learning paths!

in English, the "Welcome to your learning path" that I would expect in the title (based on the German translation) is in the description instead.

Is there a reason for this?

True I first did the English ones, then thought that the 1to1 translations don't really fit in German. But now I adapted the English ones again. 👍

dmytropolityka

tested on ts4 with user 5, works as expected
code also looks good

pzdr7

Code 👍

JohannesStoehr

Code

MaximilianAnzinger

Maintainer approved

add explanation if learning path is not yet generated

6e48e5d

JohannesWt self-assigned this Jun 17, 2024

github-actions bot added tests client Pull requests that update TypeScript code. (Added Automatically!) labels Jun 17, 2024

add translations

648fbd2

JohannesWt added the deploy:artemis-test4 label Jun 18, 2024

JohannesWt had a problem deploying to artemis-test4.artemis.cit.tum.de June 18, 2024 12:30 — with GitHub Actions Failure

github-actions bot removed the deploy:artemis-test4 label Jun 18, 2024

github-actions bot added the deployment-error Added by deployment workflows if an error occured label Jun 18, 2024

JohannesWt added deploy:artemis-test1 and removed deployment-error Added by deployment workflows if an error occured labels Jun 18, 2024

JohannesWt had a problem deploying to artemis-test1.artemis.cit.tum.de June 18, 2024 12:36 — with GitHub Actions Failure

github-actions bot removed the deploy:artemis-test1 label Jun 18, 2024

github-actions bot added the deployment-error Added by deployment workflows if an error occured label Jun 18, 2024

JohannesWt added deploy:artemis-test4 and removed deployment-error Added by deployment workflows if an error occured labels Jun 18, 2024

JohannesWt temporarily deployed to artemis-test4.artemis.cit.tum.de June 18, 2024 12:40 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test4 and removed deploy:artemis-test4 labels Jun 18, 2024

JohannesWt removed the lock:artemis-test4 label Jun 18, 2024

JohannesWt marked this pull request as ready for review June 18, 2024 12:47

JohannesWt requested a review from a team as a code owner June 18, 2024 12:47

github-actions bot added the ready for review label Jun 18, 2024

rstief added the deploy:artemis-test4 label Jun 18, 2024

rstief temporarily deployed to artemis-test4.artemis.cit.tum.de June 18, 2024 13:07 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test4 and removed deploy:artemis-test4 labels Jun 18, 2024

rstief removed the lock:artemis-test4 label Jun 18, 2024

rstief approved these changes Jun 18, 2024

View reviewed changes

edkaya approved these changes Jun 18, 2024

View reviewed changes

JohannesStoehr requested changes Jun 18, 2024

View reviewed changes

...se/learning-paths/pages/learning-path-student-page/learning-path-student-page.component.html Outdated Show resolved Hide resolved

...se/learning-paths/pages/learning-path-student-page/learning-path-student-page.component.html Show resolved Hide resolved

pzdr7 requested changes Jun 18, 2024

View reviewed changes

dmytropolityka added the deploy:artemis-test4 label Jun 18, 2024

dmytropolityka temporarily deployed to artemis-test4.artemis.cit.tum.de June 18, 2024 22:50 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test4 and removed deploy:artemis-test4 labels Jun 18, 2024

dmytropolityka removed the lock:artemis-test4 label Jun 18, 2024

dmytropolityka approved these changes Jun 18, 2024

View reviewed changes

coderabbitai bot approved these changes Jun 19, 2024

View reviewed changes

JohannesWt added the deploy:artemis-test4 label Jun 19, 2024

code review feedback

e0db003

JohannesWt temporarily deployed to artemis-test4.artemis.cit.tum.de June 19, 2024 06:12 — with GitHub Actions Inactive

github-actions bot added lock:artemis-test4 and removed deploy:artemis-test4 labels Jun 19, 2024

JohannesWt removed the lock:artemis-test4 label Jun 19, 2024

pzdr7 approved these changes Jun 19, 2024

View reviewed changes

JohannesStoehr approved these changes Jun 19, 2024

View reviewed changes

MaximilianAnzinger approved these changes Jun 19, 2024

View reviewed changes

MaximilianAnzinger merged commit 9460b12 into feature/learning-paths/refactor-student-ui Jun 19, 2024
26 of 30 checks passed

MaximilianAnzinger deleted the feature/learning-paths/add-generation-ui branch June 19, 2024 09:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Learning path`: Add learning path explanation for students #8815

`Learning path`: Add learning path explanation for students #8815

JohannesWt commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 18, 2024

github-actions bot commented Jun 18, 2024

rstief left a comment •

edited

Loading

edkaya left a comment

pzdr7 Jun 18, 2024

pzdr7 Jun 18, 2024

JohannesWt Jun 19, 2024

dmytropolityka left a comment

pzdr7 left a comment

JohannesStoehr left a comment

MaximilianAnzinger left a comment

		expect(loadingSpy).toHaveBeenCalledWith(true);
		expect(loadingSpy).toHaveBeenCalledWith(false);

Learning path: Add learning path explanation for students #8815

Learning path: Add learning path explanation for students #8815

Conversation

JohannesWt commented Jun 17, 2024 • edited Loading

Checklist

General

Client

Motivation and Context

Description

Steps for Testing

Test Server 1:

Test Server 4:

Testserver States

Review Progress

Performance Review

Code Review

Manual Tests

Test Coverage

github-actions bot commented Jun 18, 2024

⚠️ Unable to deploy to test servers ⚠️

github-actions bot commented Jun 18, 2024

⚠️ Unable to deploy to test servers ⚠️

rstief left a comment • edited Loading

Choose a reason for hiding this comment

edkaya left a comment

Choose a reason for hiding this comment

pzdr7 Jun 18, 2024

Choose a reason for hiding this comment

pzdr7 Jun 18, 2024

Choose a reason for hiding this comment

JohannesWt Jun 19, 2024

Choose a reason for hiding this comment

dmytropolityka left a comment

Choose a reason for hiding this comment

pzdr7 left a comment

Choose a reason for hiding this comment

JohannesStoehr left a comment

Choose a reason for hiding this comment

MaximilianAnzinger left a comment

Choose a reason for hiding this comment

`Learning path`: Add learning path explanation for students #8815

`Learning path`: Add learning path explanation for students #8815

JohannesWt commented Jun 17, 2024 •

edited

Loading

rstief left a comment •

edited

Loading