`Development`: Add compliance text highlighting client side by ge94zec · Pull Request #2306 · ls1intum/tum-apply

ge94zec · 2026-04-15T23:00:16Z

Checklist

General

I tested all changes and their related features with all corresponding user types.
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 (e.g. using paging).
I strictly followed the principle of data economy for all client-server REST calls.
I strictly followed the client coding and design guidelines.
I added multiple integration tests (Vitest) related to the features (with a high test coverage), while following the client test guidelines.
I documented the TypeScript code using JSDoc style.
I added multiple screenshots/screencasts of my UI changes.

Motivation and Context

This PR introduces client-side compliance text highlighting for job descriptions. The goal is to make detected compliance issues immediately visible and understandable to users while editing job postings.

Closes: #2064

Description

Server-side: Compliance issues are extended with a language attribute to correctly associate issues with job descriptions across language switches. The database schema (Liquibase), ComplianceIssue DTO, and AiService were updated accordingly. The AI service now explicitly assigns the detected language to each compliance issue after analysis.

Client-side: The job creation form introduces a complianceIssues signal to manage compliance issues for both languages independently. Issues are filtered by the active editor language and dynamically applied as highlights. A highlightEffect ensures highlights are applied whenever the language switches or new issues arrive.
A custom Quill blot (HighlightBlot) renders highlighted text spans using Tailwind utility classes, visually distinguishing critical AGG violations and transparency issues via different colors.

TranslateText.st was updated to return only the translated text, ensuring compliance and gender bias issues introduced during manual editing are preserved and not silently corrected by the translation.

Fixed a bug where a score of 0 was not displayed due to an early return in the animation effect when animatedScore was undefined but targetScore was 0.

Steps for Testing

Prerequisites:

Log in to TUMApply
Navigate to Create new Position
Check if non compliant text phrases get highlighted

Review Progress

Code Review

Code Review 1

Manual Tests

Test 1

Screenshots

Test Coverage

Client

Class/File	Line Coverage	Lines	Expects	Ratio
job-creation-form.component.ts	62.95%	1092	124	11.4
ai-score-ring.component.ts	88.67%	73	3	4.1
editor.component.ts	80.79%	306	56	18.3

Server

Class/File	Line Coverage	Lines
ComplianceIssue.java	0.00%	26
AiService.java	8.70%	224
ComplianceScoreService.java	85.71%	81
AiResource.java	50.00%	70
Job.java	100.00%	81
JobDTO.java	100.00%	33
JobFormDTO.java	95.45%	61
JobService.java	78.33%	310

Last updated: 2026-04-19 14:53:25 UTC

added endpoint for compliance added ComplianceIssueDTO for later on highlighting added ComplianceIssueDTO[]

…side' into feat/2063-add-compliance-server-side

- refactored prompt - moved enum to constants - changed endpoint to POST temporary - removed unused imports

…nce-server-side # Conflicts: # openapi/openapi.yaml # src/main/java/de/tum/cit/aet/ai/service/AiService.java # src/main/java/de/tum/cit/aet/ai/web/AiResource.java # src/main/webapp/app/generated/.openapi-generator/FILES # src/main/webapp/app/generated/api/aiResourceApi.service.ts # src/main/webapp/app/generated/model/models.ts

@RequestBody

…ith dual-language support - Move score calculation from frontend to backend (AiService) to persist across navigation - Add genderBiasScore and complianceAnalysis fields to Job entity with Liquibase migration - Calculate combined inclusivity score as average of DE and EN gender bias analyses - Strip HTML tags via Jsoup before analysis to fix zero-score bug - Adjust autosave timer to prevent premature translation triggering to 5s debounce - Read persisted score from JobDTO/JobFormDTO instead of recomputing on frontend - Fix AiScoreRingComponent animation to only animate on first render or actual score change - Add TranslateComplianceDTO wrapper to avoid multiple @RequestBody parameters - Update analyzeCurrentJobDescription and translateAndPersistJobDescription to use plain text - added sanitization -> write + read in Job-Description - adjusted tests

…side' into feat/2063-add-compliance-server-side # Conflicts: # openapi/openapi.yaml # src/main/webapp/app/generated/api/ai-resource-api.ts

# Conflicts: # openapi/openapi.yaml # src/main/java/de/tum/cit/aet/ai/service/AiService.java # src/main/java/de/tum/cit/aet/job/dto/JobFormDTO.java # src/main/java/de/tum/cit/aet/job/service/JobService.java # src/main/resources/config/liquibase/master.xml # src/main/webapp/app/generated/model/job.ts

…side' into feat/2063-add-compliance-server-side

@ElementCollection

changed Json compliance field to @ElementCollection

…side' into feat/2063-add-compliance-server-side

-added server tests -prettier

Cathy0123456789

Thank you, small comments

github-actions · 2026-04-18T09:27:11Z

🤖 No OpenAPI or client changes needed.

CelineLahnor

Thank you code looks already good to me I just left some small questions in the code :)

CelineLahnor · 2026-04-18T18:48:17Z

Can you please create a follow-up issue to add the missing test coverage introduced by this PR, so it does not get forgotten?

Cathy0123456789

Thank you, small questions

- split HighlightBlot into criticalClasses and warningClasses - moved color-mix into _tokens.scss - updated highlightTexts() - updated applyHighlights() - added Promise.all for analyzeAndUpdateScore() - added onComplete callback to forceUpdate()

github-actions · 2026-04-19T13:40:12Z

🤖 No OpenAPI or client changes needed.

github-actions · 2026-04-19T13:57:54Z

🤖 No OpenAPI or client changes needed.

github-actions · 2026-04-19T14:03:41Z

🤖 No OpenAPI or client changes needed.

github-actions · 2026-04-19T14:50:33Z

🤖 No OpenAPI or client changes needed.

Cathy0123456789

Code LGTM, not tested though

az108

Code + Tested Locally 👍

ge94zec and others added 30 commits March 17, 2026 13:18

added prompt

7c1b236

added endpoint for compliance added ComplianceIssueDTO for later on highlighting added ComplianceIssueDTO[]

prettier

bf426b2

Merge branch 'main' into feat/2063-add-compliance-server-side

d25fb1e

chore: update OpenAPI spec and generated client

91c583e

updated java doc

5abed90

Merge remote-tracking branch 'origin/feat/2063-add-compliance-server-…

4a034ec

…side' into feat/2063-add-compliance-server-side

fix: change requests

ae98a60

- refactored prompt - moved enum to constants - changed endpoint to POST temporary - removed unused imports

Merge branch 'main' into feat/2063-add-compliance-server-side

6570dda

chore: update OpenAPI spec and generated client

33f4691

Merge branch 'main' into feat/2063-add-compliance-server-side

2502905

chore: update OpenAPI spec and generated client

e392f27

Merge remote-tracking branch 'origin/feat/2063-add-compliance-server-…

b66e7ca

…side' into feat/2063-add-compliance-server-side # Conflicts: # openapi/openapi.yaml # src/main/webapp/app/generated/api/ai-resource-api.ts

prettier

74b6b72

chore: update OpenAPI spec and generated client

de857d5

fix client tests

a641e92

fix client tests

7ec341d

Merge branch 'main' into feat/2063-add-compliance-server-side

17acc03

fix change requests

b8f8944

Merge remote-tracking branch 'origin/feat/2063-add-compliance-server-…

ce179aa

…side' into feat/2063-add-compliance-server-side

Merge branch 'main' into feat/2063-add-compliance-server-side

292f6de

changed ComplianceIssueDTO to class

f20fc15

changed Json compliance field to @ElementCollection

Merge remote-tracking branch 'origin/feat/2063-add-compliance-server-…

a9f0fe5

…side' into feat/2063-add-compliance-server-side

chore: update OpenAPI spec and generated client

140fd6a

eslint

4ccd2b6

Merge remote-tracking branch 'origin/feat/2063-add-compliance-server-…

db09e52

…side' into feat/2063-add-compliance-server-side

-refactored comments

3ca255c

-added server tests -prettier

client and server tests fix

97e4fd4

ge94zec requested a review from az108 as a code owner April 17, 2026 22:39

Cathy0123456789 requested changes Apr 18, 2026

View reviewed changes

fix request changes

79ff061

ge94zec requested a review from Cathy0123456789 April 18, 2026 09:26

CelineLahnor requested changes Apr 18, 2026

View reviewed changes

Comment thread src/main/webapp/app/shared/components/atoms/editor/editor.component.ts Outdated

Comment thread src/main/webapp/app/job/job-creation-form/job-creation-form.component.ts Outdated

Comment thread src/main/webapp/app/shared/components/atoms/editor/editor.component.ts Outdated

helios-aet bot had a problem deploying to test-server April 18, 2026 11:38 Failure

ge94zec mentioned this pull request Apr 19, 2026

Development: Add compliance checker UI and popover #2317

Merged

11 tasks

Cathy0123456789 requested changes Apr 19, 2026

View reviewed changes

Comment thread src/main/resources/prompts/AnalyzeComplianceText.st Outdated

Comment thread src/main/resources/prompts/TranslateText.st Outdated

az108 requested changes Apr 19, 2026

View reviewed changes

ge94zec added 2 commits April 19, 2026 15:12

change requests

089e8c0

change requests

5cca627

- split HighlightBlot into criticalClasses and warningClasses - moved color-mix into _tokens.scss - updated highlightTexts() - updated applyHighlights() - added Promise.all for analyzeAndUpdateScore() - added onComplete callback to forceUpdate()

github-actions bot added the job Code changes in job module. label Apr 19, 2026

change prompt temporary

31cc1e2

ge94zec requested review from Cathy0123456789, CelineLahnor and az108 April 19, 2026 13:56

Merge branch 'main' into feat/2064-add-compliance-client-side

23011ed

helios-aet bot had a problem deploying to test-server April 19, 2026 14:47 Failure

unaddressed comments

9ad8b37

Cathy0123456789 approved these changes Apr 19, 2026

View reviewed changes

helios-aet bot temporarily deployed to test-server April 19, 2026 15:06 Inactive

az108 approved these changes Apr 19, 2026

View reviewed changes

az108 merged commit 5f3536b into main Apr 19, 2026
16 of 17 checks passed

az108 deleted the feat/2064-add-compliance-client-side branch April 19, 2026 15:16

Conversation

ge94zec commented Apr 15, 2026 • edited by az108 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

General

Client

Motivation and Context

Description

Steps for Testing

Review Progress

Code Review

Manual Tests

Screenshots

Test Coverage

Client

Server

Uh oh!

Cathy0123456789 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 18, 2026

Uh oh!

CelineLahnor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CelineLahnor commented Apr 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Cathy0123456789 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 19, 2026

Uh oh!

github-actions bot commented Apr 19, 2026

Uh oh!

github-actions bot commented Apr 19, 2026

Uh oh!

github-actions bot commented Apr 19, 2026

Uh oh!

Cathy0123456789 left a comment

Choose a reason for hiding this comment

Uh oh!

az108 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ge94zec commented Apr 15, 2026 •

edited by az108

Loading

CelineLahnor commented Apr 18, 2026 •

edited

Loading