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

Suppress SE_INNER_CLASS SpotBugs violations #6121

Merged
merged 1 commit into from
Dec 28, 2021

Conversation

basil
Copy link
Member

@basil basil commented Dec 27, 2021

Suppresses the following two SpotBugs violations:

[ERROR] Medium: hudson.util.ProcessTree$Remote$RemoteProcess is serializable and an inner class [hudson.util.ProcessTree$Remote$RemoteProcess] At ProcessTree.java:[lines 2180-2225] SE_INNER_CLASS
[ERROR] Medium: hudson.util.ProcessTree$SerializedProcess is serializable and an inner class [hudson.util.ProcessTree$SerializedProcess] At ProcessTree.java:[lines 397-406] SE_INNER_CLASS

The description of the check indicates that it's meant to catch accidental serializations of the outer instance, which might serialize more data than intended. In this case, the comments and the code are very clear that serializing the outer instance is intentional: we do so because it contains the process tree against which we call get() in the serialized inner instance. Since this code is working as intended, there is nothing to do except suppress the warning.

Proposed changelog entries

N/A

Proposed upgrade guidelines

N/A

Submitter checklist

  • (If applicable) Jira issue is well described
  • Changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developer, depending on the change). Examples
    • Fill-in the Proposed changelog entries section only if there are breaking changes or other changes which may require extra steps from users during the upgrade
  • Appropriate autotests or explanation to why this change has no tests
  • For dependency updates: links to external changelogs and, if possible, full diffs

Desired reviewers

@mention

Maintainer checklist

Before the changes are marked as ready-for-merge:

  • There are at least 2 approvals for the pull request and no outstanding requests for change
  • Conversations in the pull request are over OR it is explicit that a reviewer does not block the change
  • Changelog entries in the PR title and/or Proposed changelog entries are correct
  • Proper changelog labels are set so that the changelog can be generated automatically
  • If the change needs additional upgrade steps from users, upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the PR title. (example)
  • If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

@basil basil added the skip-changelog Should not be shown in the changelog label Dec 27, 2021
Copy link
Member Author

@basil basil left a comment

Choose a reason for hiding this comment

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

This PR is now ready for merge. We will merge it after approximately 24 hours if there is no negative feedback. Please see the merge process documentation for more information about the merge process. Thanks!

@basil basil added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Dec 27, 2021
@basil basil merged commit f173994 into jenkinsci:master Dec 28, 2021
@basil basil deleted the SE_INNER_CLASS branch December 28, 2021 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback skip-changelog Should not be shown in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants