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

ResourceIdentifier exceptions are SafeLoggable for better, safer observability #594

Merged
merged 2 commits into from
Nov 8, 2024

Conversation

carterkozak
Copy link
Contributor

==COMMIT_MSG==
ResourceIdentifier exceptions are SafeLoggable for better, safer observability
==COMMIT_MSG==

@changelog-app
Copy link

changelog-app bot commented Nov 8, 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

ResourceIdentifier exceptions are SafeLoggable for better, safer observability

Check the box to generate changelog(s)

  • Generate changelog entry

@@ -328,7 +332,7 @@ public static ResourceIdentifier valueOf(String rid) {
public static ResourceIdentifier of(String rid) {
ResourceIdentifier resultRid = tryOf(rid);
if (resultRid == null) {
throw new IllegalArgumentException("Illegal resource identifier format: " + rid);
throw new SafeIllegalArgumentException("Illegal resource identifier format", UnsafeArg.of("rid", rid));
Copy link

Choose a reason for hiding this comment

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

nit: This isn't incorrect now, but shall we also update the javadoc to @throws SafeIllegalArgumentException?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In general we don’t really want folks to catch the safe variants, so we don’t want folks to rely on the safe variant being api, but that would be more specific in javadoc. I could go either way :-)

Copy link

@mpritham mpritham Nov 8, 2024

Choose a reason for hiding this comment

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

Ok. If people shouldn't be catching only the safe variants, then having the API specify the superclass lets them know what to catch instead.

No strong stance either, but leaning towards keeping as-is with the principle "the @ throws block in the javadoc should specify what devs to should catch".

Copy link

Choose a reason for hiding this comment

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

Going to merge given this was the only comment.

Copy link

@mpritham mpritham left a comment

Choose a reason for hiding this comment

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

Removed merge-when-ready. Approving.

@bulldozer-bot bulldozer-bot bot merged commit ef835d0 into develop Nov 8, 2024
5 checks passed
@bulldozer-bot bulldozer-bot bot deleted the ckozak/safeloggable_throwables branch November 8, 2024 20:26
@autorelease3
Copy link

autorelease3 bot commented Nov 8, 2024

Released 2.8.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants