Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Azure schema registry SDK does not have a "schema does not exist" return value

See original GitHub issue

Is your feature request related to a problem? Please describe.

When retrieving a schema with a method like SchemaRegistryClient.getSchemaId or SchemaRegistryClient.getSchemaById, an error is thrown if the schema does not exists.

This does not leave me with a clear way to differentiate a functional error (the schema doesn’t exists) from a technical errors (like ‘there is no network connection’ or’ you are not authorized to retrieve schemas’)

Describe the solution you’d like

The current signature of these 2 methods is:

getSchemaId(schema: SchemaDescription, options?: GetSchemaIdOptions): Promise<SchemaId>;
getSchemaById(id: string, options?: GetSchemaByIdOptions): Promise<Schema>;

A more natural return type would be one that encapsulates functional errors, for example

getSchemaId(schema: SchemaDescription, options?: GetSchemaIdOptions): Promise<SchemaId | null>;
getSchemaById(id: string, options?: GetSchemaByIdOptions): Promise<Schema | null>;

Describe alternatives you’ve considered

A return type like Promise<Schema | { error: 'notfound', content: '...' }> is more informative, but would not work with the widely used error handling patterns in Javascript like

const id = getSchemaById(...)
if(!id) {
  ...
}

If breaking backwards compatibility is not desired, I’d settle for having a fixed and documented behaviour about how one should check for this error, for example by ensuring the resulting Error in the rejected promise will always have a { statusCode: 404 } field like it does now.