google/googleapis.dart

DetailedApiRequestError.toString() should print more information

Open

#70 opened on Mar 25, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Dart (133 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (419 stars)
PR merge metrics
 (PR metrics pending)

Description

I've often found the DetailedApiRequestError.jsonResponse to contain critically important information about errors...

Maybe we could just dump that as part of the error messages using toString(), if we pretty print it with indentation it probably doesn't matter so much if it's a huge blob.

I'm not entirely sure if any APIs would include sensitive information in error messages that you wouldn't want to risk leaking into logs. But I suspect that's not the case, although it can never be excluded as users could be doing anything..

Contributor guide

Research direction
Investigate the DetailedApiRequestError class in the googleapis Dart package, locate the `jsonResponse` property, and modify the `toString()` method to include a pretty printed version of that JSON. Consider potential sensitive information exposure and decide if a warning or opt in is needed.
Tech stack
None
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Dart
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75