Skip to content

Iris: Redesign citation representation #12042

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.

Sign up for GitHub

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

Jump to bottom
Draft
vivienxr wants to merge 30 commits into
base: develop
Choose a base branch
from
Draft

Iris: Redesign citation representation #12042

vivienxr wants to merge 30 commits into from
+1,245 −41

Conversation

@vivienxr
Copy link
Contributor

@vivienxr vivienxr commented Jan 26, 2026 •
edited by github-actions bot
Loading

This PR needs an Edutelligence PR to work: ls1intum/edutelligence#401

Fixes IRIS-19

Summary

Checklist

General

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 principle of data economy for all database calls.
  • I strictly followed the server coding and design guidelines and the REST API guidelines.
  • I added multiple integration tests (Spring) related to the features (with a high test coverage).
  • I added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
  • I documented the Java code using JavaDoc style.

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 (e.g. using paging).
  • I strictly followed the principle of data economy for all client-server REST calls.
  • I strictly followed the client coding guidelines.
  • I strictly followed the AET UI-UX 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.

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 LocalVC and Jenkins.

Motivation and Context

Description

Steps for Testing

Prerequisites:

  • 1 Instructor
  • 2 Students
  • 1 Programming Exercise with Complaints enabled
  1. Log in to Artemis
  2. Navigate to Course Administration
  3. ...

Exam Mode Testing

Prerequisites:

  • 1 Instructor
  • 2 Students
  • 1 Exam with a Programming Exercise
  1. Log in to Artemis
  2. Participate in the exam as a student
  3. Make sure that the UI of the programming exercise in the exam mode stays unchanged. You can use the exam mode documentation as reference.
  4. ...

Testserver States

You can manage test servers using Helios. Check environment statuses in the environment list. To deploy to a test server, go to the CI/CD page, find your PR or branch, and trigger the deployment.

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

Test Coverage

Warning: Both client and server tests failed. Coverage could not be fully measured. Please check the workflow logs.

Last updated: 2026-01-28 11:39:41 UTC

Screenshots

vivienxr added 25 commits January 17, 2026 18:32
@vivienxr
Adapt code to new citations dto from edutelligence
bffb35f
@vivienxr
Merge branch 'develop' into feature/iris/redesign-citation-presentation
25061f5
@vivienxr
Add very simple bubbles in Angular client
bd851e1
@vivienxr
Add working hover boxes
68ac68f
@vivienxr
Add wanted details to citation pills and hover boxes
bbc2116
@vivienxr
Make hover box centralized
0fb4b35
@vivienxr
Put hover box over message bubble
e50ad9b
@vivienxr
Small fix
7040738
@vivienxr
Make detail boxes stay inside the frame
a53efdd
@vivienxr
Add icons representing source type
62266a3
@vivienxr
Add +n for several citations
d32b55e
@vivienxr
Remove PyrisCitationDTO
63092d7
@vivienxr
Remove PyrisCitationDTO from tests
2a02db7
@vivienxr
Rewrite backend for new citation format and add IrisCitationMetaDTO
9fdcc02
@vivienxr
Add new DTO model for client
2b1e050
@vivienxr
Add IrisCitationMetaDTO for retrieving chat sessions
728623a
@vivienxr
Store list of IrisCitationMetaDTOs in Client and merge incomming list…
12768b8 
…s for same session
@vivienxr
Add simple UI and fix sending of IrisCitationMetaDTO from HTTP Endpoi…
7ebeb16 
…nt (including helper message)
@vivienxr
Remove lecture unit name from citation bubbles
c5c90dd
@vivienxr
Make citation bubbles smaller
4a9806a
@vivienxr
Change color and remove border of bubbles
aa7af59
@vivienxr
Design bubbles
c8b4639
@vivienxr
Design +n bubbles and add them to preview button
eb80686
@vivienxr
Fixes z index
bcdab92
@vivienxr
Improve hover message
3fd0ef4
@github-project-automation github-project-automation bot moved this to Work In Progress in Artemis Development Jan 26, 2026
@github-actions github-actions bot added tests server Pull requests that update Java code. (Added Automatically!) labels Jan 26, 2026
@github-actions github-actions bot added client Pull requests that update TypeScript code. (Added Automatically!) iris Pull requests that affect the corresponding module labels Jan 26, 2026
@vivienxr
Merge remote-tracking branch 'origin/develop' into feature/iris/redes…
d4042fa 
…ign-citation-presentation

# Conflicts:
#	package-lock.json
@github-actions
Copy link

github-actions bot commented Jan 26, 2026

@vivienxr Test coverage could not be fully measured because some tests failed. Please check the workflow logs for details.

@vivienxr vivienxr mentioned this pull request Jan 26, 2026
Draft
@github-actions
Copy link

github-actions bot commented Jan 26, 2026

End-to-End (E2E) Test Results Summary

TestsPassed ☑️Skipped ⚠️Failed ❌️Time ⏱
End-to-End (E2E) Test Report223 ran220 passed2 skipped1 failed1h 45m 32s 744ms
TestResultTime ⏱
End-to-End (E2E) Test Report
e2e/exam/ExamAssessment.spec.ts
ts.Exam assessment › Text exercise assessment › Complaints about text exercises assessment❌ failure1m 24s 323ms

@github-actions
Copy link

github-actions bot commented Jan 27, 2026

@vivienxr Test coverage could not be fully measured because some tests failed. Please check the workflow logs for details.

@github-actions
Copy link

github-actions bot commented Jan 27, 2026

@vivienxr Test coverage could not be fully measured because some tests failed. Please check the workflow logs for details.

@github-actions
Copy link

github-actions bot commented Jan 27, 2026

End-to-End (E2E) Test Results Summary

TestsPassed ☑️Skipped ⚠️Failed ❌️Time ⏱
End-to-End (E2E) Test Report223 ran221 passed1 skipped1 failed1h 37m 43s 651ms
TestResultTime ⏱
End-to-End (E2E) Test Report
e2e/exam/ExamTestRun.spec.ts
ts.Exam test run › Delete a test run › Deletes a test run❌ failure2m 59s 388ms

@github-actions
Copy link

github-actions bot commented Jan 27, 2026

End-to-End (E2E) Test Results Summary

TestsPassed ☑️Skipped ⚠️Failed ❌️Time ⏱
End-to-End (E2E) Test Report223 ran220 passed1 skipped2 failed1h 42m 14s 985ms
TestResultTime ⏱
End-to-End (E2E) Test Report
e2e/course/CourseMessages.spec.ts
ts.Course messages › Channel messages › Write/edit/delete message in channel › Student should be able to write message in channel❌ failure2m 21s 972ms
e2e/exam/ExamTestRun.spec.ts
ts.Exam test run › Delete a test run › Deletes a test run❌ failure2m 59s 94ms

@github-actions
Copy link

github-actions bot commented Jan 27, 2026

@vivienxr Test coverage could not be fully measured because some tests failed. Please check the workflow logs for details.

@github-actions
Copy link

github-actions bot commented Jan 27, 2026

End-to-End (E2E) Test Results Summary

TestsPassed ☑️Skipped ⚠️Failed ❌️Time ⏱
End-to-End (E2E) Test Report223 ran221 passed1 skipped1 failed1h 33m 1s 906ms
TestResultTime ⏱
End-to-End (E2E) Test Report
e2e/course/CourseMessages.spec.ts
ts.Course messages › Channel messages › Write/edit/delete message in channel › Student should be able to write message in channel❌ failure2m 22s 837ms

@github-actions
Copy link

github-actions bot commented Jan 28, 2026

@vivienxr Test coverage could not be fully measured because some tests failed. Please check the workflow logs for details.

@github-actions
Copy link

github-actions bot commented Jan 28, 2026

End-to-End (E2E) Test Results Summary

TestsPassed ✅Skipped ⚠️FailedTime ⏱
End-to-End (E2E) Test Report223 ran222 passed1 skipped0 failed1h 25m 53s 138ms
TestResultTime ⏱
No test annotations available

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@krusche krusche Awaiting requested review from krusche krusche will be requested when the pull request is marked ready for review krusche is a code owner

At least 4 approving reviews are required to merge this pull request.

Assignees

@vivienxr vivienxr

Labels

client Pull requests that update TypeScript code. (Added Automatically!) iris Pull requests that affect the corresponding module server Pull requests that update Java code. (Added Automatically!) tests

Projects

Artemis Development
Status: Work In Progress

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@vivienxr