jonchurch / airlock Goto Github PK

Handling Errors in @spacejunk/airlock

This issue is for tracking a few concerns related to error handling in the @spacejunk/airlock package while using Fetch as the http client:

1. Handling of error status codes: Currently, the typescript-fetch generator throws a ResponseError for status codes above 299, which is a departure from the pure Fetch behavior. This choice is not intentional but is imposed by the generator's source, which still needs to be located.
2. Typed error objects: Ideally, we want the error objects to be typed. However, those types are not currently available in the OpenAPI SpaceTraders spec.
3. Accessing the error response: Since the package uses Fetch, the error response can be accessed by calling response.json(). The generator's runtime handles response.json() for successful requests, so it's unexpected for users to have this magic removed for error responses.

Here's sample TypeScript code to illustrate the error handling:

import { Configuration, FleetApi, ResponseError } from '../dist';

export const config = new Configuration({
  accessToken: 'NO_TOKEN',
});

// Fails if there is NO_TOKEN, but also fails with a real token because the shipSymbol is nonsense
const badRequest = async () => {
  const fleet = new FleetApi(config);
  const res = await fleet.getShipCooldown('asdfasdfasa');
  if (res) {
    return res.data;
  }
  return undefined;
};

badRequest()
  .then((result) => console.log('Result from fulfilled promise:', result))
  .catch(async (err: ResponseError) => {
    const { response } = err;
    console.log('Full response', response);
    console.log('JSON body:', await response.json());
    console.log('status:', response.status);
  });

There is a configuration option for the generator [--http-user-agent <http user agent>]

I should figure out how/if to set that for the client library.

I'd likely do @spacejunk/airlock, would be great to have the version number in there too.

I could go super verbose with
@spacejunk/[email protected] (Node.js; TypeScript; https://github.com/jonchurch/airlock)