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

Integrated code lifecycle: Separate build agent summary and details view #8395

Merged
merged 28 commits into from
May 12, 2024

Conversation

mateusmm01
Copy link
Contributor

@mateusmm01 mateusmm01 commented Apr 13, 2024

Checklist

General

Server

  • Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
  • I strictly followed the server 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 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.

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).

Motivation and Context

The current BuildAgentView is very cluttered and hardy navigable with lots of build agents and recent build jobs. This view should be decoupled to a BuildAgentSummaryView and BuildAgentDetailsView
Screenshot 2024-03-19 at 18 32 46

Description

BuildAgentSummaryView: Offers a list of all build agents and their running build jobs.
BuildAgentDetailsView: Shows the running build jobs for a specific agent and it's recent build jobs.

Steps for Testing

Prerequisites:

  • 1 Admin
  • 1 Programming Exercise
  1. Log in to Artemis
  2. Navigate to System Administration > Build Agents
  3. See that you can see all build agents and their running build jobs. Cancel a few.
  4. Navigate to the BuildAgentDetailsView by clicking on the agent name. Check that you can see the running build jobs of this agent and the recent build jobs
  5. Navigate to System Administration > Build Queue
  6. Check that you can navigate to the BuildAgentDetailsView by clicking on the agent name of a running build job.

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

Client

Class/File Line Coverage Confirmation (assert/expect)
build-agent-details.component.ts 95.55%
build-agents.service.ts 90%
navbar.component.ts 88.75%

Server

Class/File Line Coverage Confirmation (assert/expect)
LocalCIQueueWebsocketService.java 100%
AdminBuildJobQueueResource.java 100%
AuditResource.java 100%
LocalCIWebsocketMessagingService.java 93%

Screenshots

Build Agent Summary
Screenshot 2024-04-15 at 19 52 33

Build Agent Details
Screenshot 2024-04-15 at 19 53 53

Build Queue with clickable agent name
Screenshot 2024-04-15 at 19 53 36

Summary by CodeRabbit

  • New Features

    • Enhanced build agent management with separate components for summary and detailed views.
    • Added real-time updates for build agent status and job processing via websockets.
    • Introduced detailed build agent information accessible through new administrative endpoints.
    • Implemented hyperlinking in build queue display for direct access to detailed build agent information.
  • Bug Fixes

    • Improved error handling in build agent details retrieval.
  • Documentation

    • Updated German and English localization files to include terms for "summary" and "details."
  • Style

    • Added CSS for handling long text wrapping in build agent summaries.
  • Tests

    • Expanded integration and component tests to cover new functionalities and components related to build agent management.

@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 Apr 13, 2024
Copy link
Member

@julian-christl julian-christl left a comment

Choose a reason for hiding this comment

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

code looks good

@BBesrour BBesrour requested a review from laurenzfb May 11, 2024 12:15
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Copy link
Contributor

@JohannesWt JohannesWt left a comment

Choose a reason for hiding this comment

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

Reapprove 👍

@krusche krusche changed the title Integrated code lifecycle: Decouple build agent summary and details view Integrated code lifecycle: Separate build agent summary and details view May 11, 2024
@florian-glombik florian-glombik temporarily deployed to artemis-test3.artemis.cit.tum.de May 11, 2024 21:07 — with GitHub Actions Inactive
Copy link
Contributor

@florian-glombik florian-glombik left a comment

Choose a reason for hiding this comment

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

Followed the testing steps and it worked fine, I do have some suggestions for a follow up regarding the UI:

  • Even if I am in full screen the Running build jobs table will need to be scrolled horizontally, I think it would be good if the table would not need to be scrolled
    image
  • I guess that it would be beneficial if there would be a general navigation option to the Build Agents (I did not find that option, except for clicking on a build agent if one is running)
  • I think that the Cancel All button should not be displayed or disabled if there are no build jobs running

@krusche krusche removed the blocked label May 12, 2024
@krusche krusche merged commit d5df0b0 into develop May 12, 2024
41 of 52 checks passed
@krusche krusche deleted the feature/localci/decouple-agent-view branch May 12, 2024 06:38
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:integrated code lifecycle server Pull requests that update Java code. (Added Automatically!) tests too-long-open !!! This is an antipattern, we should aim for small PRs that are only open for a short time !!!
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

9 participants