fix(error): use compact JSON for error output to preserve NDJSON streams#831
fix(error): use compact JSON for error output to preserve NDJSON streams#831nuthalapativarun wants to merge 1 commit into
Conversation
🦋 Changeset detectedLatest commit: 2c84f41 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses an issue where error messages were being emitted as multi-line JSON, which disrupted consumers expecting NDJSON format. By switching to compact serialization, the CLI now ensures that each error is represented as a single line, maintaining protocol consistency for streaming tools. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request modifies the error printing logic in the Google Workspace CLI to output compact JSON instead of pretty-printed JSON, preserving NDJSON stream compatibility. It also adds a unit test to verify that all error variants serialize to a single line without newline characters. I have no feedback to provide as the changes are clean and well-tested.
Description
print_error_jsonwas usingserde_json::to_string_pretty, which produces multi-line output. This breaks NDJSON consumers (e.g.gmail +watch,events +subscribe) that expect one JSON object per line.Changed to
serde_json::to_stringso errors are always emitted as a single line, consistent with the NDJSON protocol.Closes #680
Checklist:
google-*crates).cargo fmt --allto format the code perfectly.cargo clippy -- -D warningsand resolved all warnings.pnpx changeset) to document my changes.