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

StreamOptionalGetWithoutFilter #2949

Draft
wants to merge 4 commits into
base: develop
Choose a base branch
from
Draft

Conversation

schlosna
Copy link
Contributor

@schlosna schlosna commented Nov 12, 2024

Before this PR

Discussion of #2946 identified potential value in identifying places where Streams of Optionals should get if the optional is present before mapping via Optional::get.

After this PR

==COMMIT_MSG==
Add StreamOptionalGetWithoutFilter to identify places where Stream<Optional<?>> should call filter(Optional::isPresent) before map(Optional::get).

Similar to OptionalNotPresent but for streams.
==COMMIT_MSG==

Possible downsides?

@changelog-app
Copy link

changelog-app bot commented Nov 12, 2024

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

StreamOptionalGetWithoutFilter

Check the box to generate changelog(s)

  • Generate changelog entry

Copy link
Member

@pkoenig10 pkoenig10 left a comment

Choose a reason for hiding this comment

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

How confident are we that there are no legitimate uses to call .map(Optional::get) without filtering? I can't think of an specific uses, but I wouldn't be surprised if there were some.


private static final Matcher<ExpressionTree> OPTIONAL_GET_METHOD = Matchers.staticMethod()
.onClass(Optional.class.getName())
.named("get")
Copy link
Member

Choose a reason for hiding this comment

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

Probably also want to include orElseThrow here.

@carterkozak
Copy link
Contributor

I'm not sure it's worth maintaining a check for this, unless we see failures begin to crop up in practice. I can imagine false positives causing more total friction than a couple failures getting through. It's certainly possible that my estimation is off, though.

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.

3 participants