Skip to content

Fix NPE - #866

Open
lmartelli wants to merge 1 commit into
approvals:masterfrom
lmartelli:patch-1
Open

lmartelli wants to merge 1 commit into
approvals:masterfrom
lmartelli:patch-1

Conversation

@lmartelli

@lmartelli lmartelli commented Sep 28, 2026 •

Copy link
Copy Markdown

Stacktrace from version 23.1.0 :

java.lang.NullPointerException: Cannot invoke "java.util.List.contains(Object)" because "validExtensionsWithDot" is null

	at org.approvaltests.reporters.GenericDiffReporter.isFileExtensionValid(GenericDiffReporter.java:122)
	at org.approvaltests.reporters.GenericDiffReporter.isFileExtensionHandled(GenericDiffReporter.java:117)
	at org.approvaltests.reporters.GenericDiffReporter.isWorkingInThisEnvironment(GenericDiffReporter.java:104)
	at org.approvaltests.reporters.GenericDiffReporter.report(GenericDiffReporter.java:56)
	at org.approvaltests.reporters.FirstWorkingReporter.report(FirstWorkingReporter.java:21)
	at org.approvaltests.reporters.FirstWorkingReporter.report(FirstWorkingReporter.java:21)
	at org.approvaltests.reporters.FirstWorkingReporter.report(FirstWorkingReporter.java:21)
	at org.approvaltests.reporters.FirstWorkingReporter.report(FirstWorkingReporter.java:21)
	at org.approvaltests.approvers.FileApprover.reportFailure(FileApprover.java:49)
	at org.approvaltests.Approvals.verify(Approvals.java:220)
	at org.approvaltests.Approvals.verify(Approvals.java:183)
	at org.approvaltests.Approvals.verify(Approvals.java:191)
	at org.approvaltests.Approvals.verify(Approvals.java:50)

Summary by Sourcery

Bug Fixes:

  • Fix the generic diff reporter so configured valid file extensions are retained, preventing a null-pointer exception when validating file extensions.

Stacktrace from version 23.1.0 :
java.lang.NullPointerException: Cannot invoke "java.util.List.contains(Object)" because "validExtensionsWithDot" is null

	at org.approvaltests.reporters.GenericDiffReporter.isFileExtensionValid(GenericDiffReporter.java:122)
	at org.approvaltests.reporters.GenericDiffReporter.isFileExtensionHandled(GenericDiffReporter.java:117)
	at org.approvaltests.reporters.GenericDiffReporter.isWorkingInThisEnvironment(GenericDiffReporter.java:104)
	at org.approvaltests.reporters.GenericDiffReporter.report(GenericDiffReporter.java:56)
	at org.approvaltests.reporters.FirstWorkingReporter.report(FirstWorkingReporter.java:21)
	at org.approvaltests.reporters.FirstWorkingReporter.report(FirstWorkingReporter.java:21)
	at org.approvaltests.reporters.FirstWorkingReporter.report(FirstWorkingReporter.java:21)
	at org.approvaltests.reporters.FirstWorkingReporter.report(FirstWorkingReporter.java:21)
	at org.approvaltests.approvers.FileApprover.reportFailure(FileApprover.java:49)
	at org.approvaltests.Approvals.verify(Approvals.java:220)
	at org.approvaltests.Approvals.verify(Approvals.java:183)
	at org.approvaltests.Approvals.verify(Approvals.java:191)
	at org.approvaltests.Approvals.verify(Approvals.java:50)
@sourcery-ai

sourcery-ai Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Fixes the GenericDiffReporter constructor so the provided valid extension list is stored on the instance, preventing the reported NullPointerException when checking whether a file extension is supported.

Sequence diagram for GenericDiffReporter extension validation

sequenceDiagram
    Approvals->>GenericDiffReporter: report()
    GenericDiffReporter->>GenericDiffReporter: isWorkingInThisEnvironment()
    GenericDiffReporter->>GenericDiffReporter: isFileExtensionHandled()
    GenericDiffReporter->>GenericDiffReporter: isFileExtensionValid()
    GenericDiffReporter-->>GenericDiffReporter: validExtensions.contains(extension)
    GenericDiffReporter-->>Approvals: extension support result
Loading

File-Level Changes

Change Details Files
Correctly initialize the instance field containing valid file extensions to prevent null access during extension checks.
  • Replaced assignment to an unqualified symbol with an explicit assignment to the validExtensions field.
  • Ensures isFileExtensionValid can access the constructor-provided extension list.
approvaltests/src/main/java/org/approvaltests/reporters/GenericDiffReporter.java

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="approvaltests/src/main/java/org/approvaltests/reporters/GenericDiffReporter.java" line_range="50" />
<code_context>
     this.arguments = argumentsFormat;
     this.diffProgramNotFoundMessage = diffProgramNotFoundMessage;
-    validExtensions = validFileExtensions;
+    this.validExtensions = validFileExtensions;
   }

</code_context>
<issue_to_address>
**issue (bug_risk):** The change is behaviorally identical to the removed assignment and does not prevent `validExtensions` from remaining null. When `validFileExtensions` is null—as permitted by the four-argument constructor and used by existing tests—`isFileExtensionHandled` passes null to `isFileExtensionValid`, whose `contains` call raises the reported NullPointerException.

**Triggers:** When a reporter is constructed with a null extension list.

**Suggested fix:** Default null extension lists to an empty list or handle null in `isFileExtensionHandled`/`isFileExtensionValid`.

```suggestion
    this.validExtensions = validFileExtensions == null ? new ArrayList<String>() : validFileExtensions;
```
</issue_to_address>

Sourcery assessment

Approval pending. 1 finding to address first.

Blocking findings: approvaltests/src/main/java/org/approvaltests/reporters/GenericDiffReporter.java:50


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

this.arguments = argumentsFormat;
this.diffProgramNotFoundMessage = diffProgramNotFoundMessage;
validExtensions = validFileExtensions;
this.validExtensions = validFileExtensions;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

issue (bug_risk): The change is behaviorally identical to the removed assignment and does not prevent validExtensions from remaining null. When validFileExtensions is null—as permitted by the four-argument constructor and used by existing tests—isFileExtensionHandled passes null to isFileExtensionValid, whose contains call raises the reported NullPointerException.

Triggers: When a reporter is constructed with a null extension list.

Suggested fix: Default null extension lists to an empty list or handle null in isFileExtensionHandled/isFileExtensionValid.

Suggested change
this.validExtensions = validFileExtensions;
this.validExtensions = validFileExtensions == null ? new ArrayList<String>() : validFileExtensions;

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.

1 participant