Skip to content
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.

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

Lectures: Show slide numbers to be removed in automatic unit processing #7350

Merged
merged 14 commits into from
Nov 3, 2023

Conversation

rstief
Copy link
Contributor

@rstief rstief commented Oct 10, 2023

Checklist

General

Server

  • Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
  • I followed the coding and design 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.
  • I followed the coding and design guidelines.
  • I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
  • 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

Solves Issue #6896

Description

When adding attachment units to a lecture via automatic lecture processing, users can remove slides with certain keywords (e.g. "Break"). This PR adds the functionality that when the user searches for keywords, the slides that will be removed get displayed.

Steps for Testing

  1. Log in as an Editor/Instructor
  2. Go to any course -> manage -> lectures
  3. Create a new lecture or edit an existing one
  4. Tick the checkbox automatic unit processing
  5. Upload a .pdf file (Here is an Example.pdf)
  6. Click on Process units
  7. (Optional) split the file into more than the units that already exist
  8. Enter keyphrases, seperated by commas (e.g. "Break, Example Solution")
  9. Observe that the textbox above gets updated with the slide numbers that get removed
  10. Observe that empty keyphrases (e.g. " ", "ValidKeyphrase, ") don't get evaluated (For the latter "Valid Keyphrase gets evaluated but the empty keyphrase after it will not)
  11. Click on save and verify that the generated units are correct

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

Client

Class/File Line Coverage Confirmation (assert/expect)
attachment-units.component.ts 90.56%
attachmentUnit.service.ts 100%

Server

Class/File Line Coverage Confirmation (assert/expect)
LectureUnitProcessingService.java 93%
AttachmentUnitResource.java 92%

Screenshots

screen1

screen3

@rstief rstief self-assigned this Oct 10, 2023
@github-actions github-actions bot added tests server Pull requests that update Java code. (Added Automatically!) client Pull requests that update TypeScript code. (Added Automatically!) labels Oct 10, 2023
@rstief rstief marked this pull request as ready for review October 12, 2023 12:45
@rstief rstief requested a review from a team as a code owner October 12, 2023 12:46
jakubriegel
jakubriegel previously approved these changes Oct 12, 2023
Copy link
Contributor

@jakubriegel jakubriegel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested on ts1, works fine

basak-akan
basak-akan previously approved these changes Oct 12, 2023
Copy link
Contributor

@basak-akan basak-akan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested during testing session, worked well

@rstief rstief dismissed stale reviews from basak-akan and jakubriegel via 38c2b1d October 14, 2023 14:19
@github-actions
Copy link

❌ Unable to deploy to test servers ❌

The docker build needs to run through before deploying.

@github-actions github-actions bot added the deployment-error Added by deployment workflows if an error occured label Oct 17, 2023
@rstief rstief added deploy:artemis-test3 and removed deployment-error Added by deployment workflows if an error occured labels Oct 17, 2023
Copy link
Contributor

@lennart-keller lennart-keller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Retested locally. Works fine

@julian-christl julian-christl dismissed their stale review October 30, 2023 21:14

resolved issues

@rstief rstief temporarily deployed to artemis-test1.artemis.cit.tum.de October 31, 2023 14:07 — with GitHub Actions Inactive
Copy link
Contributor

@egekurt123 egekurt123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tested on ts1 in testing session. Works as expected

Copy link
Contributor

@max-bergmann max-bergmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested in Testing session on TS3 - LGTM

Copy link
Collaborator

@MaximilianAnzinger MaximilianAnzinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested during testing session

Copy link

@vinceclifford vinceclifford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works as expected

@krusche krusche added this to the 6.6.4 milestone Nov 3, 2023
Copy link
Collaborator

@MaximilianAnzinger MaximilianAnzinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM

Copy link
Contributor

@Strohgelaender Strohgelaender left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code

@krusche krusche changed the title Lecture: Show slide numbers to be removed in automatic unit processing Lectures: Show slide numbers to be removed in automatic unit processing Nov 3, 2023
@krusche krusche merged commit f963fc0 into develop Nov 3, 2023
50 of 54 checks passed
@krusche krusche deleted the feature/lecture/show-removed-slide-numbers branch November 3, 2023 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) Component:Lecture feature ready to merge server Pull requests that update Java code. (Added Automatically!) tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.