feat: Locking and Deployment information changes #276

TurkerKoc · 2025-01-26T00:27:11Z

This PR introduces key improvements to environment visibility, deployment tracking, and user activity transparency. Below are the highlights:

Key changes

1. Environment Locking Enhancements

Lock Details: Now displays the user avatar of who locked the environment directly in the environment list.
Time Format: Lock durations are formatted as HH:MM:SS (e.g., 02:15:30) using a reusable client-side time-formatting service.

2. Deployment Visibility Without Expansion

At-a-Glance Info: Environments now show the latest deployment's:
Faster Insights: Users instantly see deployment status, lock details, and deployment history without expanding rows.
Transparency: Clear audit trail of who deployed what, when, and from which branch.
Consistency: GitHub UI-triggered deployments now appear in Helios alongside manual deployments.User: Who triggered the deployment.
- Branch: What branch was deployed.
- Timestamp: When the deployment occurred.
Status Tags: Replaced text with intuitive icons (e.g., ✅ for success, ⏳ for in progress). Hover over icons for status details.

3. Real-Time Deployment Status

Immediate Feedback: Shows IN_QUEUE status instantly when a deployment is triggered, by harmonizing HeliosDeployment and Deployment entity.
Webhook handling: Matches incoming deployment webhooks to existing HeliosDeployment records, ensuring seamless transitions between Deployments and Helios deployment entities to show IN_QUEUE, IN_PROGRESS, and final states (✅/❌).

4. Activity History Enrichment

User Attribution: Displays the deployer’s name in the Activity History page for both manual and GitHub-triggered deployments.

Technical Improvements

Entity Harmonization: Unified HeliosDeployment (created on deploy-click) and Deployment (created via webhook) to provide end-to-end tracking.
- HeliosDeployment created on deploy-click with deployment-id field empty.
- Deployment entity created via webhook and updated HeliosDeployment to match with Deployment Entity
- If we have HeliosDeployment in the environment without deployment-id we are showing that entity as latest deployment.
- Otherwise Deployment Entity is used to show latest deployment information.
GitHub User Mapping: Added JWT-based GitHub user ID resolution for accurate user attribution.
Backend Sync Logic: Updated webhook handlers, controllers and data sync to prioritize HeliosDeployment until webhook data arrives.

Impact

Faster Insights: Users instantly see deployment status, lock details, and deployment history without expanding rows.
Transparency: Clear audit trail of who deployed what, when, and from which branch.
Consistency: GitHub UI-triggered deployments now appear in Helios alongside manual deployments.

Screenshots and Recordings

Deployment via Helios

deployment_helios.mov

Deployment via Github UI and monitoring in Helios

deployment_github.mov

Activity History

codacy-production · 2025-01-26T00:28:09Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
Report missing for `3961265`¹	✅ 0.00%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`3961265`)	Report Missing	Report Missing	Report Missing
Head commit (`b88b4b1`)	849	266	31.33%

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#276)	38	0	0.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

Codacy didn't receive coverage data for the commit, or there was an error processing the received data. Check your integration for errors and validate that your coverage setup is correct. ↩

… deployment

StefanNemeth · 2025-01-30T20:32:06Z

Just for your info: You'll probably need to create a migration file for the entity changes and merge main into the feat branch. If you need any assistance just hit me up :)

github-actions · 2025-02-01T18:37:16Z

server/application-server/src/main/java/de/tum/cit/aet/helios/deployment/DeploymentService.java

+        (a, b) -> {
+          OffsetDateTime timeA = a.timestamp();
+          OffsetDateTime timeB = b.timestamp();
+          if (timeA == null && timeB == null) return 0;


🚫 [checkstyle] <com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck> _{reported by reviewdog 🐶}
'if' construct must use '{}'s.

github-actions · 2025-02-01T18:37:16Z

server/application-server/src/main/java/de/tum/cit/aet/helios/deployment/DeploymentService.java

+          OffsetDateTime timeA = a.timestamp();
+          OffsetDateTime timeB = b.timestamp();
+          if (timeA == null && timeB == null) return 0;
+          if (timeA == null) return 1;


🚫 [checkstyle] <com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck> _{reported by reviewdog 🐶}
'if' construct must use '{}'s.

github-actions · 2025-02-01T18:37:16Z

server/application-server/src/main/java/de/tum/cit/aet/helios/deployment/DeploymentService.java

+          OffsetDateTime timeB = b.timestamp();
+          if (timeA == null && timeB == null) return 0;
+          if (timeA == null) return 1;
+          if (timeB == null) return -1;


🚫 [checkstyle] <com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck> _{reported by reviewdog 🐶}
'if' construct must use '{}'s.

egekocabas

Had a review session with @TurkerKoc and below points will be changed 👍🏻

Also in an another PR we need to refactor this re-deploy logic where we have this hardcoded 20 minutes for any missing webhook events, we need to think about this case and how it effects our system.

client/src/app/components/environments/deployment-state-tag/deployment-state-tag.component.html

egekocabas · 2025-02-01T19:13:25Z

client/src/app/components/environments/environment-list/environment-list-view.component.html

+                  <i-tabler name="user" class="w-6 h-6 text-gray-600" />
+                }
+                <span>
+                  {{ environment.latestDeployment.user?.name }} deployed


Lets handle the case where the user is empty

egekocabas · 2025-02-01T19:14:56Z

client/src/app/components/environments/environment-list/environment-list-view.component.html

+                  <p-avatar
+                    class="w-6 h-6"
+                    shape="circle"
+                    size="normal"
+                    [image]="environment.latestDeployment.user?.avatarUrl"
+                    [pTooltip]="keycloakService.isCurrentUser(environment.latestDeployment.user?.login) ? 'You' : environment.latestDeployment.user?.name"
+                    [styleClass]="getAvatarBorderClass(environment.latestDeployment.user?.login || '')"
+                    (click)="openUserProfile(environment.latestDeployment.user?.login || '')"
+                  >
+                  </p-avatar>


it would be better if we make this a component so in pr list or other places we can use the user profile picture component

egekocabas · 2025-02-01T19:16:04Z

client/src/app/components/environments/environment-list/environment-list-view.component.ts

  permissionService = inject(PermissionService);
+  keycloakService = inject(KeycloakService);
+  dateService = inject(DateService);


would be better to use private

egekocabas · 2025-02-01T19:20:22Z

client/src/app/components/environments/environment-list/environment-list-view.component.ts

@@ -93,6 +108,7 @@ export class EnvironmentListViewComponent {
      message: `Are you sure you want to deploy to ${environment.name}?`,
      accept: () => {
        this.deploy.emit(environment);
+        this.queryClient.invalidateQueries({ queryKey: this.queryKey() });


Lets invalidate query in the parent compoennt 👍🏻

egekocabas · 2025-02-01T20:19:56Z

server/application-server/src/main/java/de/tum/cit/aet/helios/deployment/DeploymentService.java

+    // 4) Combine the lists
    List<ActivityHistoryDto> combined = new ArrayList<>();


We also need to add HeliosDeployment entities where deploymentId field is empty, in order to show failed workflowrun's of deployments
It is the case where we don't get the Deployment entity since the workflowrun failed before the Deployment entity is created

egekocabas · 2025-02-01T20:32:47Z

...cation-server/src/main/java/de/tum/cit/aet/helios/environment/EnvironmentLockHistoryDto.java

 import io.micrometer.common.lang.Nullable;
 import java.time.OffsetDateTime;
 import org.springframework.lang.NonNull;

 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public record EnvironmentLockHistoryDto(
    @NonNull Long id,
-    String lockedBy,
+    User lockedBy,


lets use userdto

egekocabas · 2025-02-01T20:33:59Z

...server/src/main/java/de/tum/cit/aet/helios/environment/EnvironmentLockHistoryRepository.java

+      FROM EnvironmentLockHistory elh
+      WHERE elh.environment.id = :environmentId
+        AND elh.unlockedAt IS NULL


lets also add
elh.environment.enabled = true

egekocabas · 2025-02-01T20:37:03Z

...r/application-server/src/main/java/de/tum/cit/aet/helios/environment/EnvironmentService.java

+  private Optional<Deployment> findDeploymentById(Environment environment, Long deploymentId) {
+    if (deploymentId == null) {
+      return Optional.empty();
+    }
+    return environment.getDeployments().stream()
+        .filter(d -> d.getId().equals(deploymentId))
+        .findFirst();
+  }


Lets remove this method

egekocabas · 2025-02-01T20:43:48Z

...r/application-server/src/main/java/de/tum/cit/aet/helios/environment/EnvironmentService.java

+   * <p>Returns a small wrapper object with either a real Deployment or a HeliosDeployment. This
+   * helps unify your "latest" logic into one place.
+   */
+  public LatestDeploymentUnion findLatestDeployment(Environment env) {


maybe it would be better to get latest heliosdeployment and also deployment and then compare which one is the latest by createdAt or updatedAt fields?

Lets imagine a scenario where somebody triggered deployment from Helios and we don't get any webhook data related with that, but then somebody else triggered deployment from GitHub UI and then lets discuss this scenario and what happens in WorklowRun webhook listener, Deployment webhook listener and our final entity status and other fields and what this method returns

TurkerKoc · 2025-02-02T00:49:11Z

Just for your info: You'll probably need to create a migration file for the entity changes and merge main into the feat branch. If you need any assistance just hit me up :)

Thanks for the heads up! Added the migration script :)

…yment

TurkerKoc added 3 commits January 26, 2025 01:25

added get user object using github_id in jwt

9fb2c5c

changed get username to get user object

8be6b03

openapi update

9ffdcfc

github-actions bot assigned TurkerKoc Jan 26, 2025

github-actions bot added client application-server feature size:XL labels Jan 26, 2025

TurkerKoc added 9 commits January 26, 2025 01:36

added user avatar to the environment list

6d2b3de

added user avatar in activity history page

b6aa222

deployment state tag update

f419c82

Environment list view navigate to locking user github profile

fa18c91

change comment

54ad1bd

linter fix

1c5a89e

activity history with user github profile link

18af68e

changed environment list user check with keycloak

a833409

fix deployment status tag

c4064fd

This was linked to issues Jan 26, 2025

Show who locked the environment in Environment List #253

Open

Immediate deployment in progress tag in environment list #260

Open

Format lock-time as HH:MM:SS instead of writing it out #269

Open

TurkerKoc added 2 commits January 27, 2025 00:13

generalize time since locked and generalize it with UI updates

b0d46f9

latest deployment information in environment list

4a21e92

TurkerKoc linked an issue Jan 27, 2025 that may be closed by this pull request

Environment table: Show deployment info (who, when, what) without expanding #268

Open

TurkerKoc added 2 commits January 27, 2025 18:36

last deployment date format changed

7914e4d

added creator of deployment information

ec7e57d

github-actions bot added size:XXL and removed size:XL labels Jan 27, 2025

TurkerKoc added 2 commits January 27, 2025 22:58

fix deploy button not showed

feddd97

showin who triggered last deployment

25a0991

TurkerKoc added 6 commits January 28, 2025 16:22

deployment info tag updated

d8065d2

Merge branch 'main' into feat/locking-deployment-info

8ab5a8b

removed unecessary unit test for small component

e959253

last deployment info ui alignment

4191fc6

vscode extension recommendations

861c9fa

Using HeliosDeployment and Deployment entities together for immediate…

43b4810

… deployment

TurkerKoc added 6 commits January 31, 2025 16:42

github deployment sync bug fix

34ff4e4

convert helios deployments to locking user

a0e5d92

openapi

1507a7d

activity history with immediate latest deployment information

217096b

openapi

6e8a118

Merge branch 'main' into feat/locking-deployment-info

cfbc091

github-actions bot reviewed Feb 1, 2025

View reviewed changes

openapi and some comments removed

b88b4b1

egekocabas requested changes Feb 1, 2025

View reviewed changes

egekocabas mentioned this pull request Feb 2, 2025

feat: Align test server deployment with Artemis workflow changes #273

Merged

TurkerKoc deployed to test-server-3 February 2, 2025 00:41 — with GitHub Actions Active

added migration script

725500f

TurkerKoc added 2 commits February 2, 2025 01:51

checkstyle fix

55715c8

deployment status tag updated and state matching moved to HeliosDeplo…

818808c

…yment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Locking and Deployment information changes #276

feat: Locking and Deployment information changes #276

TurkerKoc commented Jan 26, 2025 •

edited

Loading

codacy-production bot commented Jan 26, 2025 •

edited

Loading

StefanNemeth commented Jan 30, 2025

github-actions bot Feb 1, 2025

github-actions bot Feb 1, 2025

github-actions bot Feb 1, 2025

egekocabas left a comment

egekocabas Feb 1, 2025

egekocabas Feb 1, 2025

egekocabas Feb 1, 2025

egekocabas Feb 1, 2025

egekocabas Feb 1, 2025

egekocabas Feb 1, 2025

egekocabas Feb 1, 2025

egekocabas Feb 1, 2025

egekocabas Feb 1, 2025

TurkerKoc commented Feb 2, 2025

		// 4) Combine the lists
		List<ActivityHistoryDto> combined = new ArrayList<>();

feat: Locking and Deployment information changes #276

Are you sure you want to change the base?

feat: Locking and Deployment information changes #276

Conversation

TurkerKoc commented Jan 26, 2025 • edited Loading

Key changes

1. Environment Locking Enhancements

2. Deployment Visibility Without Expansion

3. Real-Time Deployment Status

4. Activity History Enrichment

Technical Improvements

Impact

Screenshots and Recordings

Deployment via Helios

Deployment via Github UI and monitoring in Helios

Activity History

codacy-production bot commented Jan 26, 2025 • edited Loading

Coverage summary from Codacy

Footnotes

StefanNemeth commented Jan 30, 2025

github-actions bot Feb 1, 2025

Choose a reason for hiding this comment

github-actions bot Feb 1, 2025

Choose a reason for hiding this comment

github-actions bot Feb 1, 2025

Choose a reason for hiding this comment

egekocabas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TurkerKoc commented Feb 2, 2025

TurkerKoc commented Jan 26, 2025 •

edited

Loading

codacy-production bot commented Jan 26, 2025 •

edited

Loading