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: Fix an issue with stale containers #10005

Merged

Conversation

BBesrour
Copy link
Member

@BBesrour BBesrour commented Dec 11, 2024

Checklist

General

Server

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

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

In the current state, we try to stop the container directly after retrieving the result files. Afterwards, we try to parse the results.
There is an issue with larger files: the buffer isn't big enough to store the files, so it keeps the connection open, which for some reason completely hangs the container and blocks it from being stopped, which results in a hanging container that we can't kill.

This PR fixes this issue

Description

Parse results and close the stream before stopping the container.

Steps for Testing

Prerequisites:

  • 1 Instructor
  • localCI server (TS1-4 or staging)
  1. Programming exercises behavior with localCI should be unchanged

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.







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 even for very large courses with more than 2000 students.
  • I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Performance Tests

  • Test 1
  • Test 2

Screenshots

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling during the execution of build jobs, specifically for parsing test results.
    • Enhanced resource management to prevent leaks by ensuring proper closure of input streams.
  • New Features

    • Updated logging messages for clearer context during the build process, especially in error scenarios.

@BBesrour BBesrour self-assigned this Dec 11, 2024
@BBesrour BBesrour requested a review from a team as a code owner December 11, 2024 22:09
@github-actions github-actions bot added server Pull requests that update Java code. (Added Automatically!) buildagent Pull requests that affect the corresponding module labels Dec 11, 2024
@SimonEntholzer SimonEntholzer changed the title Integrated code lifecyle: Parse build results before stopping container Integrated code lifecycle: Parse build results before stopping container Dec 11, 2024
Copy link

coderabbitai bot commented Dec 11, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 pmd (7.8.0)
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java

The following rules are missing or misspelled in your ruleset file category/vm/bestpractices.xml: BooleanInstantiation, DontImportJavaLang, DuplicateImports, EmptyFinallyBlock, EmptyIfStmt, EmptyInitializer, EmptyStatementBlock, EmptyStatementNotInLoop, EmptySwitchStatements, EmptySynchronizedBlock, EmptyTryBlock, EmptyWhileStmt, ExcessiveClassLength, ExcessiveMethodLength, ImportFromSamePackage, MissingBreakInSwitch, SimplifyBooleanAssertion. Please check your ruleset configuration.

Walkthrough

The changes in this pull request focus on enhancing the error handling and resource management within the BuildJobExecutionService class, specifically in the runScriptAndParseResults method. Key modifications include initializing variables to prevent resource leaks, improving error catching for various exceptions, and refining the cleanup process to ensure proper resource management. Additionally, logging messages have been updated for clarity during error occurrences, and unnecessary commented-out code has been removed to streamline the method's flow.

Changes

File Path Change Summary
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java Modified runScriptAndParseResults for better error handling and resource management; improved logging; removed commented-out code.

Possibly related PRs

Suggested labels

server, buildagent, programming, ready to merge

Suggested reviewers

  • krusche
  • magaupp
  • JohannesStoehr

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. (Experiment)
  • @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.

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: 1

🧹 Outside diff range and nitpick comments (2)
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java (2)

341-345: Enhance error logging for better debugging.

The error message "Error while parsing test results" could be more specific about which operation failed (e.g., reading from stream, parsing XML, etc.).

-            msg = "Error while parsing test results";
+            msg = "Error while parsing test results: " + e.getMessage() + ". Operation: " + 
+                  (e instanceof IOException ? "reading from stream" : "parsing result data");

347-356: Consider using try-with-resources for automatic resource management.

While the current implementation correctly handles resource cleanup, using try-with-resources would make the code more concise and eliminate the need for explicit cleanup in the finally block.

-        TarArchiveInputStream testResultsTarInputStream = null;
-        BuildResult buildResult;
-        try {
-            testResultsTarInputStream = buildJobContainerService.getArchiveFromContainer(containerId,
+        BuildResult buildResult;
+        try (TarArchiveInputStream testResultsTarInputStream = buildJobContainerService.getArchiveFromContainer(containerId,
                 LOCALCI_WORKING_DIRECTORY + LOCALCI_RESULTS_DIRECTORY);
+        ) {
             buildResult = parseTestResults(testResultsTarInputStream, buildJob.buildConfig().branch(),
                     assignmentRepoCommitHash, testRepoCommitHash, buildCompletedDate, buildJob.id());
             buildResult.setBuildLogEntries(buildLogsMap.getAndTruncateBuildLogs(buildJob.id()));
-        } finally {
-            try {
-                if (testResultsTarInputStream != null) {
-                    testResultsTarInputStream.close();
-                }
-            } catch (IOException e) {
-                msg = "Could not close test results tar input stream";
-                buildLogsMap.appendBuildLogEntry(buildJob.id(), msg);
-                log.error(msg, e);
-            }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e687499 and 2e1c1dd.

📒 Files selected for processing (1)
  • src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

🔇 Additional comments (1)
src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobExecutionService.java (1)

323-325: LGTM: Good variable initialization practice.

The initialization of variables outside the try block ensures proper scope and cleanup handling.

Copy link

@HawKhiem HawKhiem 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 and 3. I tested the following:

  • Creating a programming exercise
  • Edit a programming exercise
  • Run plagiarism test for a programming exercise
  • Cloning and pushing using http and ssh
  • Editing auxilary repositories
  • Asking Iris for help

Everything works perfectly

@krusche krusche changed the title Integrated code lifecycle: Parse build results before stopping container Integrated code lifecycle: Fix an issue with stale containers by parsing build results before stopping container Dec 12, 2024
@krusche krusche changed the title Integrated code lifecycle: Fix an issue with stale containers by parsing build results before stopping container Integrated code lifecycle: Fix an issue with stale containers by parsing build results earlier Dec 12, 2024
@krusche krusche changed the title Integrated code lifecycle: Fix an issue with stale containers by parsing build results earlier Integrated code lifecycle: Fix an issue with stale containers Dec 12, 2024
@krusche krusche added this to the 7.7.5 milestone Dec 12, 2024
@krusche krusche merged commit cc6c76d into develop Dec 12, 2024
65 of 83 checks passed
@krusche krusche deleted the bugfix/integrated-code-lifecycle/fix-hanging-containers branch December 12, 2024 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
buildagent Pull requests that affect the corresponding module ready for review server Pull requests that update Java code. (Added Automatically!)
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

4 participants