fix(PlaygroundLogger): use String(describing:) for CustomStringConvertible in generateSummary to remove extra debug quotes#82
Open
AkshatRaj00 wants to merge 1 commit into
Conversation
…ummary Previously, generateSummary() used String(reflecting:) for any type conforming to CustomStringConvertible or CustomDebugStringConvertible. String(reflecting:) adds debug decoration (e.g. surrounding quotes for String values and other types), causing the Playground sidebar to show "\"Hello\"" instead of "Hello" for user-defined CustomStringConvertible types. Fix: Use String(describing:) for CustomStringConvertible conformers (which calls .description directly without decoration), and keep String(reflecting:) only for types that are solely CustomDebugStringConvertible. Fixes: apple#81
This file contains hidden or 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
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.
Summary
This PR fixes a display bug in
PlaygroundLoggerwhere the Playground sidebar shows unwanted surrounding quotes for user-definedCustomStringConvertibletypes.File:
PlaygroundLogger/PlaygroundLogger/LogEntry+Reflection.swiftRelated Issue: #81
The Bug
generateSummary()usedString(reflecting:)for bothCustomStringConvertibleandCustomDebugStringConvertible:String(reflecting:)is designed for debug output — it callsdebugDescriptionorCustomReflectable, and adds surrounding quotes forStringvalues and similar types. When a user implementsCustomStringConvertibleexpecting their.descriptionto appear in the sidebar, they instead see their output wrapped in extra quotes:The Fix
Split the check into two separate branches:
String(describing:)calls.descriptiondirectly without any wrapping — exactly what the Playground sidebar should show for user-defined types.Before / After
structimplementingCustomStringConvertible"Hello, Playground!"(extra quotes)Hello, Playground!✅classimplementingCustomStringConvertible"MyClass description"(extra quotes)MyClass description✅CustomDebugStringConvertibleString(handled by the earlieras? Stringbranch)Scope of Change
PlaygroundLogger/PlaygroundLogger/LogEntry+Reflection.swiftgenerateSummary()— one||condition split into two separateifblocksReported and fixed as part of open-source contribution.