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

[do-not-merge] Deserialize endpoint errors #2443

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

mpritham
Copy link
Contributor

@mpritham mpritham commented Dec 5, 2024

Before this PR

This is a prototype PR and should not be merged.

We'd like to support the a new method in BodySerDe that allows the creation of deserializers given an expected result type, and a set of expected error types.

A ConjureError is serialized and sent by servers. Dialogue deserializes the errors to a SerializableError which loses the type information of the parameters. By providing the type information of the parameters, Dialogue can deserialize the received ConjureError into the well-typed objects (instead of Strings).

After this PR

==COMMIT_MSG==

==COMMIT_MSG==

Possible downsides?

@changelog-app
Copy link

changelog-app bot commented Dec 5, 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

Check the box to generate changelog(s)

  • Generate changelog entry

@Safe String errorCode,
@Safe String errorName,
@Safe String errorInstanceId,
@Safe String arg,
Copy link
Contributor Author

@mpritham mpritham Dec 5, 2024

Choose a reason for hiding this comment

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

  • can put the args into a separate record which includes matches the parameters map for deserialization so we don't need a custom deserializer.
  • let's annotate each of the parameter fields with a @JsonProperty

@mpritham mpritham force-pushed the pm/endpoint-error-serde branch 4 times, most recently from 2977345 to 6081541 Compare December 6, 2024 18:28
@mpritham mpritham force-pushed the pm/endpoint-error-serde branch from 6081541 to 74008d5 Compare December 6, 2024 18:29
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.

1 participant