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

LNK-3334: Error occurred while evaluating measure: Cannot invoke "java.net.URL.openConnection()" because "url" is null #607

Merged
merged 1 commit into from
Jan 8, 2025

Conversation

smailliwcs
Copy link
Contributor

@smailliwcs smailliwcs commented Jan 8, 2025

🛠️ Description of Changes

Use the main thread's context class loader (rather than the system class loader) to resolve logback-cli.xml from the classpath. Otherwise resolution fails in a Spring Boot repackaged fat JAR, because the system class loader doesn't support reaching into nested JARs to find resources.

🧪 Testing Performed

Ran an arbitrary evaluation via java -jar. Successfully reproduced the error before the fix; verified that the error was resolved after the fix.

📓 Documentation Updated

N/A

Summary by CodeRabbit

  • Bug Fixes
    • Improved logging configuration error handling
    • Enhanced logging resilience by preventing application failure due to missing configuration files
    • Implemented more robust exception management during logging setup

Use the main thread's context class loader (rather than the system class
loader) to resolve logback-cli.xml from the classpath.  Otherwise
resolution fails in a Spring Boot `repackage`d fat JAR, because the
system class loader doesn't support reaching into nested JARs to find
resources.
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

Walkthrough

The pull request modifies the configureLogging method in the FileSystemInvocation class to improve error handling and logging configuration. The method now uses a more robust approach to loading the logging configuration, with enhanced exception handling and logging of potential configuration issues. The method signature has been simplified by removing the throws JoranException declaration, indicating a more flexible error management strategy.

Changes

File Change Summary
Java/measureeval/src/main/java/com/lantanagroup/link/measureeval/FileSystemInvocation.java Modified configureLogging method to improve logging configuration error handling

Assessment against linked issues

Objective Addressed Explanation
LNK-3334: Resolve null URL connection error Unable to definitively confirm full resolution without more context about the specific URL connection issue

Possibly related PRs

Suggested reviewers

  • amphillipsLGC

Poem

🐰 A Rabbit's Ode to Logging Grace 🌟

In code's dark forest, errors used to roam,
Now logging shines, a bright and gentle home
Exceptions caught with care, no drama's might
Configuration dances in the softest light
Resilience blooms where warnings gently grow


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 anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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
Contributor

@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: 0

🧹 Nitpick comments (1)
Java/measureeval/src/main/java/com/lantanagroup/link/measureeval/FileSystemInvocation.java (1)

37-53: Core fix looks good, but error handling could be improved.

The change to use Thread.currentThread().getContextClassLoader() correctly addresses the issue of resolving logback-cli.xml from the classpath in a Spring Boot fat JAR. The implementation properly handles the case where the resource is not found.

However, consider these improvements to make the error handling more robust:

  1. Add a fallback configuration when logback-cli.xml is not found
  2. Consider logging at ERROR level for configuration failures that might impact application behavior

Here's a suggested improvement:

 private static void configureLogging(Bundle bundle) {
     try {
         LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
         context.reset();
         JoranConfigurator configurator = new JoranConfigurator();
         configurator.setContext(context);
         ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
         URL resource = classLoader.getResource("logback-cli.xml");
         if (resource == null) {
-            logger.warn("logback-cli.xml not found in classpath");
-            return;
+            logger.error("logback-cli.xml not found in classpath, applying default configuration");
+            // Apply basic configuration
+            ch.qos.logback.classic.Logger rootLogger = context.getLogger(Logger.ROOT_LOGGER_NAME);
+            rootLogger.setLevel(ch.qos.logback.classic.Level.INFO);
         }
-        configurator.doConfigure(resource);
+        if (resource != null) {
+            configurator.doConfigure(resource);
+        }
         CqlLogAppender.start(context, libraryId -> CqlUtils.getLibrary(bundle, libraryId));
     } catch (Exception e) {
-        logger.warn("Failed to configure logging", e);
+        logger.error("Failed to configure logging. This may impact application behavior", e);
     }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a696f24 and 21991f2.

📒 Files selected for processing (1)
  • Java/measureeval/src/main/java/com/lantanagroup/link/measureeval/FileSystemInvocation.java (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (java-kotlin)
  • GitHub Check: Analyze (csharp)
🔇 Additional comments (2)
Java/measureeval/src/main/java/com/lantanagroup/link/measureeval/FileSystemInvocation.java (2)

19-19: LGTM!

The added import for java.net.URL is necessary for the URL handling in the configureLogging method.


37-37: Verify impact on other callers and similar patterns.

Let's verify:

  1. Other callers of this method that might expect JoranException
  2. Similar patterns in the codebase that might need the same fix
✅ Verification successful

Change is localized with no external impact

The configureLogging method is:

  • Private static and only called within FileSystemInvocation.java
  • No similar patterns exist in the codebase that would need the same fix
  • The logback configuration is specific to this CLI context
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for other callers of configureLogging
rg "configureLogging\(" --type java

# Check for similar patterns of ClassLoader usage that might need the same fix
ast-grep --pattern 'ClassLoader $_ = $_.getClassLoader()'

# Check for other usages of logback-cli.xml
rg "logback-cli.xml"

Length of output: 727

@smailliwcs smailliwcs merged commit b37072f into dev Jan 8, 2025
21 checks passed
@smailliwcs smailliwcs deleted the user/steven.williams/LNK-3334 branch January 8, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants