Return error response in submitBom

[marob]

When an error occurs, there is no possibility for the calling code to know the details.

In my case, I'd like to be able to log error response body, in particular to be able to know which validation is KO when uploading a SBOM to DependencyTrack (that recently enabled JsonSchema validation on upload).

[prabhu]

@marob Can we also enhance server.js so that it returns the error message in line 160

https://github.com/marob/cdxgen/blob/87d8f9bf2c1036341d47775998931786ff9cf788/server.js#L160

      res.writeHead(500, { "Content-Type": "application/json" });
      return res.end(
        "{'error': 'true', 'message': 'simpler error message'}\n",
      );

[marob]

@marob Can we also enhance server.js so that it returns the error message in line 160

https://github.com/marob/cdxgen/blob/87d8f9bf2c1036341d47775998931786ff9cf788/server.js#L160

      res.writeHead(500, { "Content-Type": "application/json" });
      return res.end(
        "{'error': 'true', 'message': 'simpler error message'}\n",
      );

OK. I'll do it next week.

But I'm questioning myself: shouldn't we throw an error instead of returning it like I implemented in my PR?

[prabhu]

@marob may be use the options.failOnError to determine that?

[prabhu]

@marob, I have a large PR coming up in #1119. Is it possible to wait and rebase once it is merged?

[marob]

OK @prabhu. I've rebased and applied the required modifications on server.js and cdxgen.js

[setchy]

@marob - awesome!

Would you be able to update the recently added openapi spec - https://github.com/CycloneDX/cdxgen/blob/master/lib/server/openapi.yaml - to have the new response code and response structure. Happy to help if you'd like, just lmk

[marob]

@setchy I've added the requested modification in openapi.
I've also changed the structure of the response for errors. I hope it's OK.
I'm wondering if we should keep an array of string as details for the error as it may be very specific to my case. Maybe we could stringify my array of string and put it directly at the end of the error?

[prabhu]

@setchy @marob what is left on this one? May be we have to rebase again due to some recent merges (apologies)

[setchy]

@setchy @marob what is left on this one? May be we have to rebase again due to some recent merges (apologies)

looks good to me 👍