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.

Sign up for GitHub

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

Jump to bottom

adding custom ConjureDefined exception types #1246

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

adding custom ConjureDefined exception types #1246

wants to merge 3 commits into from

Conversation

mpritham
Copy link
Contributor

Before this PR

After this PR

==COMMIT_MSG==
==COMMIT_MSG==

Possible downsides?

@changelog-app
Copy link

changelog-app bot commented Oct 21, 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

adding custom ConjureDefined exception types

Check the box to generate changelog(s)

  • Generate changelog entry

carterkozak
carterkozak reviewed Oct 21, 2024
View reviewed changes
errors/src/main/java/com/palantir/conjure/java/api/errors/SerializableError.java Outdated
@@ -129,6 +130,19 @@ public static SerializableError forException(ServiceException exception) {
return builder.build();
}

public static SerializableError forExceptionWithSerializedArgs(ServiceException exception) {
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't necessarily need to reuse the SerializableError type, it's the serialized form as defined here that we want: https://palantir.github.io/conjure/#/docs/spec/wire?id=_55-conjure-errors

carterkozak
carterkozak reviewed Oct 21, 2024
View reviewed changes
errors/src/main/java/com/palantir/conjure/java/api/errors/ConjureDefinedError.java Outdated
// TODO(pm): copy-paste the ServiceException logic. I don't like extending ServiceException because we have
// (instanceof ServiceException) checks scattered across a few repos. Enumerate them, and see if they need to be
// handled differently compared to ServiceException.
public final class ConjureDefinedError extends ServiceException implements SafeLoggable {
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't this be a checked exception? Extending ServiceException means we're also extending RuntimeException, which means it's unchecked.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carterkozak carterkozak carterkozak left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mpritham @carterkozak