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

Add error-prone rule for converting Stream to Iterator #3058

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

rynorris
Copy link

Before this PR

In certain cases (https://bugs.openjdk.org/browse/JDK-8267359) converting Stream to Iterator can cause the entire stream to be consumed eagerly. This has bitten us on multiple occasions, causing poor performance in otherwise innocuous code.

Catching the specific cases isn't easy, but just generally converting between the two iteration paradigms is a code smell and should be avoided where possible, so let's warn against it.

After this PR

==COMMIT_MSG==
Add error-prone rule for converting Stream to Iterator
==COMMIT_MSG==

@changelog-app
Copy link

changelog-app bot commented Feb 28, 2025

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Add error-prone rule for converting Stream to Iterator

Check the box to generate changelog(s)

  • Generate changelog entry

@rynorris rynorris force-pushed the rn/stream-to-iterator branch from ba66f8e to 3f3ecda Compare February 28, 2025 16:59
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