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

✨ feature: new error type Service Unavailable #543

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

Conversation

JRPCF
Copy link

@JRPCF JRPCF commented Oct 3, 2023

Summary

  • Adding a new ServiceUnavailable error code with status code 503 StatusServiceUnavailable. This is needed for redirection behavior.

==COMMIT_MSG==
Adding new ServiceUnavailable error code with status code 503 StatusServiceUnavailable
==COMMIT_MSG==

@changelog-app
Copy link

changelog-app bot commented Oct 3, 2023

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 new ServiceUnavailable error code with status code 503 StatusServiceUnavailable

Check the box to generate changelog(s)

  • Generate changelog entry

@JRPCF JRPCF changed the title ❌ new error type Service Unavailable ❌ feature: new error type Service Unavailable Oct 3, 2023
@JRPCF JRPCF changed the title ❌ feature: new error type Service Unavailable ✨ feature: new error type Service Unavailable Oct 3, 2023
@JRPCF JRPCF requested a review from splucs October 3, 2023 19:49
@@ -152,6 +158,8 @@ func (ec *ErrorCode) UnmarshalText(data []byte) error {
*ec = CustomClient
case "CUSTOM_SERVER":
*ec = CustomServer
case "SERVICE_UNAVAILABLE":
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we accepting that these can not be included in generated errors? Otherwise this needs to be added to the enum here: https://github.com/palantir/conjure/blob/3d0fec99877ca6dbe899d3faba43c4b45866e9da/conjure-api/src/main/conjure/conjure-api.yml#L46

@carterkozak
Copy link

Slight preference to handle these in a different way that doesn't produce a response body (similar to the java QosExceptions.(throttle|unavailable|retryOther) types)

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.

4 participants