Skip to content

feat: Provide preview of JSON when Parse fails #131

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: Provide preview of JSON when Parse fails #131

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82a1897
Provide preview of JSON when parse fails
dyastremsky Feb 26, 2025
c134020
Clean up formatting
dyastremsky Feb 26, 2025
6191cd8
Print entire JSON
dyastremsky Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions include/triton/common/triton_json.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,12 @@ class TritonJson {
std::string(GetParseError_En(document_.GetParseError())) + " at " +
std::to_string(document_.GetErrorOffset())));
}
TRITONJSON_STATUSTYPE status =
ParseErrorHandler(document_, std::string(base, size));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a before/after example in the PR description to highlight the new error/UX improvement?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! Let me run it through CI then. I wanted your feedback first in case there was a reason not to do this.

if (status != TRITONJSON_STATUSSUCCESS) {
return status;
}

allocator_ = &document_.GetAllocator();
return TRITONJSON_STATUSSUCCESS;
}
Expand All @@ -194,6 +200,28 @@ class TritonJson {
return Parse(json.data(), json.size());
}

// Helper function for Parse(const char* base, const size_t size) to handle
// errors. Return error message if parsing failed.
TRITONJSON_STATUSTYPE ParseErrorHandler(
const rapidjson::Document& document, const std::string& json)
{
if (document.HasParseError()) {
std::ostringstream error_stream;
error_stream << "failed to parse the request JSON buffer: "
<< GetParseError_En(document.GetParseError())
<< " at offset " << document.GetErrorOffset() << ".";

// Show part of the JSON to help debugging
const size_t preview_length = 100;
std::string json_text = json.substr(0);

error_stream << " JSON: \"" << json_text << "\"";

return TRITONJSON_STATUSRETURN(error_stream.str());
}
return TRITONJSON_STATUSSUCCESS;
}

// Write JSON representation into a 'buffer' in a compact
// format. Can only be called for a top-level document value,
// otherwise error is returned.
Expand Down