`Development`: Migrate exam and exam exercise import client code to signals #10106

coolchock · 2025-01-05T22:13:28Z

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

I strictly followed the client coding and design guidelines.

Description

This PR updates the Exam and Exam Exercise Import components to use Signals.

Steps for Testing

Prerequisites:

1 Instructor

Log in to Artemis
Navigate to Course Administration -> Exams
Try to import an exam and check if it works
Try to import an exam exercise to an exam and check if it works

Review Progress

Code Review

Code Review 1
Code Review 2

Manual Tests

Test 1
Test 2

Summary by CodeRabbit

Refactor
- Transitioned component input handling to a function-based approach for improved consistency in data retrieval and UI evaluation.
- Updated template conditional logic to use function calls for clearer state management.
- Replaced direct property assignments with setter methods for managing component state.
- Modified how properties are accessed within components to enhance interaction with parent components.
Chores
- Streamlined initialization by removing redundant constructors in certain services.
Tests
- Aligned test cases with the new input-binding mechanism by updating the way component inputs are set.
- Enhanced test initialization for modal components using reactive signals for state management.

# Conflicts: # src/main/webapp/app/exam/manage/exam-management.module.ts

github-actions · 2025-01-13T12:06:04Z

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.

# Conflicts: # src/main/webapp/app/exam/manage/exam-management.module.ts # src/main/webapp/app/exam/manage/exams/exam-exercise-import/exam-exercise-import.component.ts # src/main/webapp/app/exam/manage/exams/exam-import/exam-import-paging.service.ts # src/main/webapp/app/exam/manage/exams/exam-import/exam-import.component.ts # src/test/javascript/spec/component/exam/exam-update.component.spec.ts

github-actions · 2025-02-03T12:05:43Z

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.

# Conflicts: # src/main/webapp/app/exam/manage/exam-management.module.ts # src/test/javascript/spec/component/exam/manage/exam-import.component.spec.ts

coderabbitai · 2025-02-15T09:42:43Z

Walkthrough

This pull request refactors how component inputs are accessed by transitioning from direct property access to function calls. In several Angular components and their corresponding tests, the use of the @Input() and @ViewChild() decorators has been replaced with function-based approaches using input() and viewChild.required(). The changes update both the HTML templates and TypeScript files to call properties as functions (e.g., exam() instead of exam) and adjust the test suites to use fixture.componentRef.setInput(). Additionally, a redundant constructor was removed from a paging service.

Changes

File(s)	Change Summary
`src/main/webapp/app/exam/manage/exams/exam-exercise-import/exam-exercise-import.component.html` `src/main/webapp/app/exam/manage/exams/exam-exercise-import/exam-exercise-import.component.ts`	Refactored the Exam Exercise Import Component by replacing direct property accesses (e.g., `exam.exerciseGroups`) with function calls (e.g., `exam().exerciseGroups`), removing `@Input()` decorators and initializing inputs using `input()` methods.
`src/main/webapp/app/exam/manage/exams/exam-import/exam-import-paging.service.ts`	Removed the redundant constructor in the Exam Import Paging Service, which previously called the superclass constructor.
`src/main/webapp/app/exam/manage/exams/exam-import/exam-import.component.html` `src/main/webapp/app/exam/manage/exams/exam-import/exam-import.component.ts`	Updated the Exam Import Component by replacing traditional `@Input()` and `@ViewChild()` usage with `input()` and `viewChild.required()`, and converting property accesses to function calls for inputs and internal component references.
`src/test/javascript/spec/component/exam/exam-update.component.spec.ts` `src/test/javascript/spec/component/exam/manage/exam-exercise-import.component.spec.ts` `src/test/javascript/spec/component/exam/manage/exam-import.component.spec.ts`	Adjusted test suites to set component inputs using `fixture.componentRef.setInput()`, and updated import statements to include the new `input` decorator from Angular’s core package.
`src/test/javascript/spec/component/exam/manage/exam-management.component.spec.ts` `src/main/webapp/app/exam/manage/exam-management.component.ts` `src/main/webapp/app/exam/manage/exercise-groups/exercise-groups.component.ts`	Updated test cases and component methods to use setter methods for various properties instead of direct assignments, reflecting a shift towards a functional approach in managing component state.

Sequence Diagram(s)

sequenceDiagram
    participant P as Parent Component/Test
    participant E as ExamExerciseImportComponent
    P->>E: Set input using setInput('exam', examObject)
    E->>E: Initialize exam via input.required<Exam>()
    E->>E: Invoke exam() to retrieve exam data
    E->>Template: Bind exam().exerciseGroups in HTML

sequenceDiagram
    participant P as Parent Component/Test
    participant I as ExamImportComponent
    P->>I: Set inputs using setInput (e.g., subsequentExerciseGroupSelection, targetExamId)
    I->>I: Initialize inputs via input() functions
    I->>I: Call input functions (e.g., subsequentExerciseGroupSelection()) during processing
    I->>Child: Access child component via viewChild.required()

Possibly related PRs

Development: Migrate the git diff report module to standalone components #9443: The changes in the main PR are related to the modifications in the retrieved PR as both involve transitioning from direct property access to function calls for managing component inputs, specifically in the context of Angular's reactive programming model.
Development: Migrate suspicious behavior module to new client coding guidelines #9887: The changes in the main PR and the retrieved PR are related as both involve a transition from direct property access to function calls for managing component inputs and state, specifically in how properties like exam and exerciseGroups are accessed.
Development: Use signals in lecture unit wizard #9708: The changes in the main PR, which involve transitioning from direct property access to function calls for managing component inputs, are related to the retrieved PR, where similar modifications are made to use function calls for property access in the lecture unit wizard components.

Suggested labels

ready to merge, exam

📜 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 56d68c5 and e6a709c.

📒 Files selected for processing (1)

src/test/javascript/spec/component/exam/manage/exam-management.component.spec.ts (2 hunks)

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

src/test/javascript/spec/component/exam/manage/exam-management.component.spec.ts

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

GitHub Check: Call Build Workflow / Build .war artifact
GitHub Check: Call Build Workflow / Build and Push Docker Image
GitHub Check: client-tests-selected
GitHub Check: client-style
GitHub Check: client-tests
GitHub Check: server-style
GitHub Check: server-tests
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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/test/javascript/spec/component/exam/manage/exercise-groups/exercise-groups.component.spec.ts (1)

283-286: Enhance test coverage for signal-based properties.

While the signal initialization is correct, consider adding test cases to verify:

Signal value updates during the modal interaction
Signal subscriptions and their effects

Example test case to add:

it('updates signal values in the import modal', fakeAsync(() => {
    const mockReturnValue = {
        componentInstance: {
            subsequentExerciseGroupSelection: signal<boolean>(false),
            targetCourseId: signal<number | undefined>(undefined),
            targetExamId: signal<number | undefined>(undefined),
        },
        result: Promise.resolve([]),
    } as NgbModalRef;
    
    jest.spyOn(modalService, 'open').mockReturnValue(mockReturnValue);
    
    comp.openExerciseGroupImportModal();
    
    // Test signal updates
    mockReturnValue.componentInstance.subsequentExerciseGroupSelection.set(true);
    mockReturnValue.componentInstance.targetCourseId.set(123);
    mockReturnValue.componentInstance.targetExamId.set(456);
    
    tick();
    
    expect(mockReturnValue.componentInstance.subsequentExerciseGroupSelection()).toBeTrue();
    expect(mockReturnValue.componentInstance.targetCourseId()).toBe(123);
    expect(mockReturnValue.componentInstance.targetExamId()).toBe(456);
}));

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c699dd9 and 56d68c5.

📒 Files selected for processing (1)

src/test/javascript/spec/component/exam/manage/exercise-groups/exercise-groups.component.spec.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`src/test/javascript/spec/**/*.ts`: jest: true; mock: NgMock...

src/test/javascript/spec/**/*.ts: jest: true; mock: NgMocks; bad_practices: avoid_full_module_import; perf_improvements: mock_irrelevant_deps; service_testing: mock_http_for_logic; no_schema: avoid_NO_ERRORS_SCHEMA; expectation_specificity: true; solutions: {boolean: toBeTrue/False, reference: toBe, existence: toBeNull/NotNull, undefined: toBeUndefined, class_obj: toContainEntries/toEqual, spy_calls: {not_called: not.toHaveBeenCalled, once: toHaveBeenCalledOnce, with_value: toHaveBeenCalledWith|toHaveBeenCalledExactlyOnceWith}}

src/test/javascript/spec/component/exam/manage/exercise-groups/exercise-groups.component.spec.ts

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

GitHub Check: client-style
GitHub Check: client-tests-selected
GitHub Check: client-tests
GitHub Check: server-style
GitHub Check: server-tests
GitHub Check: Call Build Workflow / Build .war artifact
GitHub Check: Call Build Workflow / Build and Push Docker Image
GitHub Check: Codacy Static Code Analysis
GitHub Check: Analyse

🔇 Additional comments (1)

src/test/javascript/spec/component/exam/manage/exercise-groups/exercise-groups.component.spec.ts (1)

32-32: LGTM!

The import of signal from @angular/core is correctly placed and necessary for the signal-based reactivity system.

ole-ve

Tested on TS4, error does not occur anymore and all test steps were valid

magaupp

Looks good overall. One issue:

src/test/javascript/spec/component/exam/manage/exam-management.component.spec.ts

magaupp

Thanks for the change. Code looks good

ole-ve

manual testing, unchanged by client test change

# Conflicts: # src/test/javascript/spec/component/exam/manage/exercise-groups/exercise-groups.component.spec.ts

HanyangXu0508

tested on server 4 and worked well.

magaupp

Re-approve code

coolchock added 7 commits January 5, 2025 01:37

migrate exam exercise import files

16fdc36

migrate exam import files

9180ea1

migrate exam-import-paging.service.ts

a137462

remove components from module

ed5270b

add imports

43f2fff

adjust exam-exercise-import.component.spec.ts

364a282

adjust exam-import.component.spec.ts

014b6da

github-actions bot added tests client Pull requests that update TypeScript code. (Added Automatically!) labels Jan 5, 2025

github-actions bot assigned coolchock Jan 5, 2025

coolchock and others added 5 commits January 5, 2025 23:17

Merge branch 'develop' into chore/exam-import-client-migration

eb49662

# Conflicts: # src/main/webapp/app/exam/manage/exam-management.module.ts

resolve merge conflict

32003ff

fix input issue

06f4bf9

Merge branch 'develop' into chore/exam-import-client-migration

eef424c

fix imports and declarations

9b64b94

github-actions bot added the stale label Jan 13, 2025

coolchock removed the stale label Jan 26, 2025

coolchock added 2 commits January 26, 2025 12:45

resolve conflict

2da145c

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

coolchock added 2 commits February 13, 2025 19:32

Merge branch 'develop' into chore/exam-import-client-migration

4a0fa55

# Conflicts: # src/main/webapp/app/exam/manage/exam-management.module.ts # src/test/javascript/spec/component/exam/manage/exam-import.component.spec.ts

fix tests

7ff7f3f

github-actions bot removed the stale label Feb 14, 2025

coolchock changed the title ~~General: Migrate exam and exam exercise import to signals, inject and standalone~~ General: Migrate exam and exam exercise import to signals Feb 15, 2025

coolchock marked this pull request as ready for review February 15, 2025 09:38

coolchock requested a review from a team as a code owner February 15, 2025 09:38

github-actions bot added the ready for review label Feb 15, 2025

fix exercise-groups.component.spec.ts

56d68c5

coolchock dismissed coderabbitai[bot]’s stale review via 56d68c5 February 16, 2025 12:55

coderabbitai bot reviewed Feb 16, 2025

View reviewed changes

coderabbitai bot previously approved these changes Feb 16, 2025

View reviewed changes

helios-aet bot temporarily deployed to artemis-test1.artemis.cit.tum.de February 16, 2025 13:12 Inactive

helios-aet bot temporarily deployed to artemis-test4.artemis.cit.tum.de February 16, 2025 13:17 Inactive

ole-ve previously approved these changes Feb 16, 2025

View reviewed changes

BBesrour previously approved these changes Feb 16, 2025

View reviewed changes

magaupp requested changes Feb 16, 2025

View reviewed changes

src/test/javascript/spec/component/exam/manage/exam-management.component.spec.ts Outdated Show resolved Hide resolved

replace undefined with signals of undefined

e6a709c

coolchock dismissed stale reviews from BBesrour, ole-ve, and coderabbitai[bot] via e6a709c February 16, 2025 19:11

coderabbitai bot previously approved these changes Feb 16, 2025

View reviewed changes

magaupp previously approved these changes Feb 16, 2025

View reviewed changes

ole-ve previously approved these changes Feb 16, 2025

View reviewed changes

BBesrour previously approved these changes Feb 16, 2025

View reviewed changes

coolchock added ready to merge and removed ready for review labels Feb 17, 2025

krusche changed the title ~~Development: Migrate exam and exam exercise import to signals~~ Development: Migrate exam and exam exercise import client code to signals Feb 17, 2025

Merge branch 'develop' into chore/exam-import-client-migration

2a3b14a

# Conflicts: # src/test/javascript/spec/component/exam/manage/exercise-groups/exercise-groups.component.spec.ts

coolchock dismissed stale reviews from BBesrour, ole-ve, magaupp, and coderabbitai[bot] via 2a3b14a February 17, 2025 19:58

helios-aet bot temporarily deployed to artemis-test4.artemis.cit.tum.de February 17, 2025 20:44 Inactive

HanyangXu0508 approved these changes Feb 17, 2025

View reviewed changes

helios-aet bot temporarily deployed to artemis-test1.artemis.cit.tum.de February 17, 2025 23:22 Inactive

helios-aet bot temporarily deployed to artemis-test4.artemis.cit.tum.de February 17, 2025 23:28 Inactive

magaupp approved these changes Feb 18, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Development`: Migrate exam and exam exercise import client code to signals #10106

`Development`: Migrate exam and exam exercise import client code to signals #10106

coolchock commented Jan 5, 2025 •

edited

Loading

github-actions bot commented Jan 13, 2025

github-actions bot commented Feb 3, 2025

coderabbitai bot commented Feb 15, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

ole-ve left a comment

magaupp left a comment

magaupp left a comment

ole-ve left a comment

HanyangXu0508 left a comment

magaupp left a comment

Development: Migrate exam and exam exercise import client code to signals #10106

Are you sure you want to change the base?

Development: Migrate exam and exam exercise import client code to signals #10106

Conversation

coolchock commented Jan 5, 2025 • edited Loading

Checklist

General

Client

Description

Steps for Testing

Review Progress

Code Review

Manual Tests

Summary by CodeRabbit

Summary by CodeRabbit

github-actions bot commented Jan 13, 2025

github-actions bot commented Feb 3, 2025

coderabbitai bot commented Feb 15, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

ole-ve left a comment

Choose a reason for hiding this comment

magaupp left a comment

Choose a reason for hiding this comment

magaupp left a comment

Choose a reason for hiding this comment

ole-ve left a comment

Choose a reason for hiding this comment

HanyangXu0508 left a comment

Choose a reason for hiding this comment

magaupp left a comment

Choose a reason for hiding this comment

`Development`: Migrate exam and exam exercise import client code to signals #10106

`Development`: Migrate exam and exam exercise import client code to signals #10106

coolchock commented Jan 5, 2025 •

edited

Loading

coderabbitai bot commented Feb 15, 2025 •

edited

Loading