Add .NET debugging attributes #14097
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JamesNK
force-pushed
the
jamesnk/debugging
branch
from
1788bc1
to
f0dea34
Compare
|
Will look at this tomorrow - I've got Covid so I'm working more slowly in general. Will get to it eventually... |
JamesNK
commented
Sep 18, 2023
| @@ -23,6 +24,8 @@ namespace Google.Protobuf | |||
| /// Immutable array of bytes. | |||
| /// </summary> | |||
| [SecuritySafeCritical] | |||
| [DebuggerDisplay("Length = {Length}")] | |||
There was a problem hiding this comment.
Note: ByteString initially displays length rather than count to act more like array/span/memory. Also, ByteString has a Length property rather than a Count property.
jskeet
approved these changes
Sep 19, 2023
github-actions
bot
removed
the
🅰️ safe for tests
jskeet
requested review from
mkruskal-google
and removed request for
deannagarcia
mkruskal-google
approved these changes
Sep 22, 2023
copybara-service bot
pushed a commit
that referenced
this pull request
Sep 22, 2023
I've been working with a large Protobuf model and noticed debugging issues that can easily be improved.
Add debugging attributes to collections, `ByteString`, and descriptors. No impact on runtime behavior. Debugger type proxies are what the debugger displays by default, but full data is available by selecting "Raw View".
`RepeatedField` and `MapField` now display their item count. This is standard across .NET collections. For example, .NET's list and dictionary both display `Count = {Count}`.
Note that previously, Protobuf collections displayed the result of `ToString`, which returned JSON. The JSON debug view isn't useful when there is too much content to display at once because it's truncated. That experience will be fairly common.
Count benefits:
* Always useful
* Makes debugging Protobuf collections feel more like regular .NET collections
* Collection contents is now easier to access with debugger type proxies
No dependency between this PR and #13838. Each can be merged independently.
**MapField before:**
**MapField after:**
**RepeatedField before:**
**RepeatedField after:**
**ByteString before:**
**ByteString after:**
**Descriptor before:**
**Descriptor after:**
**TypeRegistry before:**
**TypeRegistry after:**
Closes #14097
COPYBARA_INTEGRATE_REVIEW=#14097 from JamesNK:jamesnk/debugging f0dea34
FUTURE_COPYBARA_INTEGRATE_REVIEW=#14097 from JamesNK:jamesnk/debugging f0dea34
PiperOrigin-RevId: 567636087
copybara-service bot
pushed a commit
that referenced
this pull request
Sep 26, 2023
I've been working with a large Protobuf model and noticed debugging issues that can easily be improved.
Add debugging attributes to collections, `ByteString`, and descriptors. No impact on runtime behavior. Debugger type proxies are what the debugger displays by default, but full data is available by selecting "Raw View".
`RepeatedField` and `MapField` now display their item count. This is standard across .NET collections. For example, .NET's list and dictionary both display `Count = {Count}`.
Note that previously, Protobuf collections displayed the result of `ToString`, which returned JSON. The JSON debug view isn't useful when there is too much content to display at once because it's truncated. That experience will be fairly common.
Count benefits:
* Always useful
* Makes debugging Protobuf collections feel more like regular .NET collections
* Collection contents is now easier to access with debugger type proxies
No dependency between this PR and #13838. Each can be merged independently.
**MapField before:**
**MapField after:**
**RepeatedField before:**
**RepeatedField after:**
**ByteString before:**
**ByteString after:**
**Descriptor before:**
**Descriptor after:**
**TypeRegistry before:**
**TypeRegistry after:**
Closes #14097
COPYBARA_INTEGRATE_REVIEW=#14097 from JamesNK:jamesnk/debugging f0dea34
FUTURE_COPYBARA_INTEGRATE_REVIEW=#14097 from JamesNK:jamesnk/debugging f0dea34
PiperOrigin-RevId: 567636087
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've been working with a large Protobuf model and noticed debugging issues that can easily be improved.
Add debugging attributes to collections,
ByteString, and descriptors. No impact on runtime behavior. Debugger type proxies are what the debugger displays by default, but full data is available by selecting "Raw View".RepeatedFieldandMapFieldnow display their item count. This is standard across .NET collections. For example, .NET's list and dictionary both displayCount = {Count}.Note that previously, Protobuf collections displayed the result of
ToString, which returned JSON. The JSON debug view isn't useful when there is too much content to display at once because it's truncated. That experience will be fairly common.Count benefits:
No dependency between this PR and #13838. Each can be merged independently.
MapField before:
MapField after:
RepeatedField before:
RepeatedField after:
ByteString before:
ByteString after:
Descriptor before:
Descriptor after:
TypeRegistry before:
TypeRegistry after: