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

Generate new result type methods for Conjure services #298

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

Conversation

samialfhaily
Copy link
Contributor

@samialfhaily samialfhaily commented Dec 17, 2024

This PR updates the code generation to generate a new method for each service endpoint where the method returns the "declared errors" on the endpoint as a result instead of throwing them.

For example, for the following endpoint definition:

services:
  FlightSearchService:
    name: Flight Search Service
    package: com.palantir.flightsearch
    base-path: /flights
    endpoints:
      list:
        docs: Returns flights departing from the given airport.
        http: GET /list/{airport}
        args:
          airport: Airport
        errors:
          - InvalidAirport
        returns: SearchResult

Conjure will now generate the following code:

...

export interface IFlightSearchService {
  /** Returns flights departing from the given airport.  */
  list(airport: Airport): Promise<SearchResult>;
  /** Returns flights departing from the given airport.  */
  listOrError(airport: Airport): Promise<{ status: "success", response: SearchResult } | { status: "failure", error: IInvalidAirport }>; // NEW METHOD
}

export class FlightSearchService {
    constructor(private bridge: IHttpApiBridge) {
    }

  /** Returns flights departing from the given airport.  */
  public list(airport: Airport): Promise<SearchResult> {
    ...
  }

  /** Returns flights departing from the given airport.  */
  public listOrError(airport: Airport): Promise<{ status: "success", response: SearchResult } | { status: "failure", error: IInvalidAirport }> {
    return this.list(airport)
      .then(response => ({ status: "success", response }) as { status: "success", response: SearchResult })
      .catch((e: any) => {
        if (e == null || e.body == null) {
          throw e;
        }
        if (e.body.errorName === "Namespace:InvalidAirport") {
          return { status: "failure", error: e.body } as { status: "failure", error: IInvalidAirport };
        }
        throw e;
      });
  }
}


list(airport: Airport): Promise<SearchResult>;
listOrError(airport: Airport): Promise<{ status: "success", response: SearchResult } | { status: "failure", error: IInvalidAirport }>; // NEW METHOD

@samialfhaily samialfhaily self-assigned this Dec 17, 2024
@changelog-app
Copy link

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

Generate a new method for each service endpoint where the method returns the "declared errors" on the endpoint as a result instead of throwing them

Check the box to generate changelog(s)

  • Generate changelog entry

@samialfhaily samialfhaily changed the title Add support for union types Generate new result type methods for Conjure services Dec 18, 2024
@samialfhaily samialfhaily marked this pull request as ready for review December 18, 2024 18:05
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