Adding a nicer description for WebSocketFrame.

[supersonicbyte]

Motivation:

Resolving the following issue: #2828

Modifications:

Making WebSocketFrame conform to CustomStringConvertible.

Result:

A nicer description for WebSocketFrame.

[weissi]

Thank you so much! @Lukasa to take a look. LGTM

[weissi]

Looks good to me, thank you! Could do with a tiny unit test though

[supersonicbyte]

Looks good to me, thank you! Could do with a tiny unit test though

Ofcourse, should I make a new test file or put it in an existing one? Thanks for the review.

[weissi]

Looks good to me, thank you! Could do with a tiny unit test though

Ofcourse, should I make a new test file or put it in an existing one? Thanks for the review.

Completely up to you. In case you're interested what I would do: Given that it's such a tiny thing I'd reuse an existing file because that's slightly less work :)

[supersonicbyte]

Looks good to me, thank you! Could do with a tiny unit test though

Ofcourse, should I make a new test file or put it in an existing one? Thanks for the review.

Completely up to you. In case you're interested what I would do: Given that it's such a tiny thing I'd reuse an existing file because that's slightly less work :)

Added! Thanks.

[FranzBusch]

Can we please avoid adding a multiline string as a description here. description is often used in other interpolated strings such as log messages and adding line breaks can often break those formats. Instead can we add a single line for this.

[weissi]

good point, we should add \s to the end of the line (such that the result is just one line). I missed that currently we'll actually print multiple lines.

[supersonicbyte]

@FranzBusch very good point, thanks! I will fix it.

[FranzBusch]

This is still a multiline string from what I can see. Can you use " instead of """ unless I am missing something here

[weissi]

@FranzBusch no it's not, it has \s everywhere but the last line.

[weissi]

  1> print(""" 
  2.     hello \ 
  3.     my \ 
  4.     beautiful \ 
  5.     world 
  6.     """)
hello my beautiful world

[FranzBusch]

NIT: Can we use ( instead of { to align it with other types.

[supersonicbyte]

ofcourse!

[supersonicbyte]

Updated. @FranzBusch please take a look when you find the time. Also I noticed that ByteBuffer's description uses curly braces {} so we might wanna convert those to () so we are unified with other types. Thanks.

[FranzBusch]

Updated. @FranzBusch please take a look when you find the time. Also I noticed that ByteBuffer's description uses curly braces {} so we might wanna convert those to () so we are unified with other types. Thanks.

Actually thinking about this again. We should probably drop the WebsocketFrame altogether for description. Normally types don't print their type name in description. The only difference then between description and debugDescription is wrapping it in () like String works e.g.

print(frame.description) // produces masKey: foo, fin: true
print(frame.debugDescription) // produces (masKey: foo, fin: true)

[dnadoba]

Normally types don't print their type name in description.

By default it does e.g.:

struct WebSocketFrame {}
print(WebSocketFrame()) // WebSocketFrame()
debugPrint(WebSocketFrame()) // PlaygroundExecutable.WebSocketFrame()

With that being said, I'm not opposed to remove the name but we would diverge from the default.

[supersonicbyte]

I dropped the names as @FranzBusch suggested. If needed otherwise I can add them back.

[FranzBusch]

You can just interpolate self.description here instead of duplicating the code. Can we also add a test for the debugDescription please

[supersonicbyte]

Yes, done!