Skip to content

fix(error): use compact JSON for error output to preserve NDJSON streams#831

Open
nuthalapativarun wants to merge 1 commit into
googleworkspace:mainfrom
nuthalapativarun:fix/680-compact-error-json
Open

fix(error): use compact JSON for error output to preserve NDJSON streams#831
nuthalapativarun wants to merge 1 commit into
googleworkspace:mainfrom
nuthalapativarun:fix/680-compact-error-json

Conversation

@nuthalapativarun
Copy link
Copy Markdown

Description

print_error_json was using serde_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_string so errors are always emitted as a single line, consistent with the NDJSON protocol.

Closes #680

Checklist:

  • My code follows the AGENTS.md guidelines (no generated google-* crates).
  • I have run cargo fmt --all to format the code perfectly.
  • I have run cargo clippy -- -D warnings and resolved all warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have provided a Changeset file (e.g. via pnpx changeset) to document my changes.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Jun 2, 2026

🦋 Changeset detected

Latest commit: 2c84f41

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@googleworkspace/cli Patch

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

@googleworkspace-bot googleworkspace-bot added the area: core Core CLI parsing, commands, error handling, utilities label Jun 2, 2026
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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

  • JSON Serialization Update: Updated the error reporting mechanism to use compact JSON serialization instead of pretty-printing, ensuring compatibility with NDJSON stream consumers.
  • Regression Testing: Added a new test suite to verify that all error variants are serialized as single-line strings, preventing future regressions in stream compatibility.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Generative AI Prohibited Use Policy, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: core Core CLI parsing, commands, error handling, utilities

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Watch/subscribe commands output pretty-printed JSON errors instead of NDJSON

2 participants