Remove 'invalid api use' prefix in result when exception occurs

[nikhilgupta345]

Since all other exceptions raised also show the traceback, we have all of our caught exceptions routed to an APIException to avoid that. However, this forces the "invalid api use" message to be prepended to all error messages, which we would like to remove.

[toumorokoshi]

Hey Nikhil, thanks for the PR! I'm thinking through this situation a little. The intention with prefixing with that value was to allow it to be obvious from the payload, regardless of the help text. For example, here's what the response looks like today for a validationerror:

{
  "headers": {},
  "code": 400,
  "result": "invalid api use: {\"number_of_cats\": [\"Value 'foo' is not int.\"]}",
  "success": false
}

I suppose it's not too bad without it:

{
  "headers": {},
  "code": 400,
  "result": "{\"number_of_cats\": [\"Value 'foo' is not int.\"]}",
  "success": false
}

Although it is not backwards-incompatible in the sense that error messages that assume that clarification.

Just to better understand: what's the rationalle to not prefix? What type of exceptions do you raise that do not count as an exception based on user input?

[nikhilgupta345]

So we have a few classes of exceptions we've defined that we want to be able to throw. Examples include FailedDependencyException (self-explanatory) and a RetryableException that indicates to our frontend that they can retry. These are all subclasses of APIException, since without being an APIException they would also have the traceback returned as part of the response body.

The end goal is to be able to throw custom error messages (without the prefix) without a traceback. If there's a way to do that without using APIException please let me know!

[toumorokoshi]

The choice to log tracebacks is framework-dependent but generally true. I hear the value of returning back an exception that is more or less "expected", or indicates some behavior on the consumer.

Ultimately I think reducing assumptions from APIException is probably better than introducing some other way of doing what you're looking for. Thanks again!

[toumorokoshi]

Released 1.13.1. Thanks! https://pypi.org/project/transmute-core/