Skip to content

Enhance toString method in SockJsFrame #35510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 13 commits into from
Closed

Enhance toString method in SockJsFrame #35510

Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fb8ae80
Enhance toString method in SockJsFrame for better content representation
polyglot-k Sep 19, 2025
ef243d4
Refactor SockJsFrame by removing unused imports
polyglot-k Sep 19, 2025
0265b90
Add static methods for SockJsFrame creation and remove duplicates
polyglot-k Sep 19, 2025
55a6b27
Fix formatting issues in SockJsFrame by organizing imports
polyglot-k Sep 19, 2025
b8ccc8d
Refactor toString method in SockJsFrame for improved readability and …
polyglot-k Sep 19, 2025
318bda4
lint
polyglot-k Sep 20, 2025
c5facc7
Enhance SockJsFrame toString method for clarity and add truncated suffix
polyglot-k Sep 25, 2025
5dd868b
Add truncation to toString method in SockJsFrame for content exceedin…
polyglot-k Sep 25, 2025
c59bcbc
Remove unnecessary author comment from toString method in SockJsFrame
polyglot-k Sep 25, 2025
b32958e
Fix formatting in SockJsFrame toString method for StringBuilder initi…
polyglot-k Sep 25, 2025
c784f0a
Fix formatting in SockJsFrame toString method for variable initializa…
polyglot-k Sep 25, 2025
c4e97d1
Rename truncatedSuffix to TRUNCATED_SUFFIX for consistency and clarity
polyglot-k Sep 25, 2025
2e26f11
Refactor toString method in SockJsFrame for improved content preview …
polyglot-k Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions spring-websocket/src/main/java/org/springframework/web/socket/sockjs/frame/SockJsFrame.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import org.jspecify.annotations.Nullable;

import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

/**
* Represents a SockJS frame. Provides factory methods to create SockJS frames.
Expand All @@ -46,6 +45,7 @@ public class SockJsFrame {
private static final SockJsFrame CLOSE_ANOTHER_CONNECTION_OPEN_FRAME =
closeFrame(2010, "Another connection still open");

private static final String TRUNCATED_SUFFIX = "...(truncated)";

private final SockJsFrameType type;

Expand Down Expand Up @@ -83,7 +83,6 @@ else if (content.charAt(0) == 'c') {
}
}


/**
* Return the SockJS frame type.
*/
Expand Down Expand Up @@ -119,7 +118,6 @@ public byte[] getContentBytes() {
}
}


@Override
public boolean equals(@Nullable Object other) {
return (this == other || (other instanceof SockJsFrame that &&
Expand All @@ -133,13 +131,28 @@ public int hashCode() {

@Override
public String toString() {
String result = this.content;
if (result.length() > 80) {
result = result.substring(0, 80) + "...(truncated)";
int maxLength = 80;
int contentLength = this.content.length();
int truncatedContentLength = Math.min(contentLength, maxLength);

int extra = (contentLength > maxLength ? TRUNCATED_SUFFIX.length() : 0);

StringBuilder sb = new StringBuilder(truncatedContentLength + extra);

for (int i = 0; i < truncatedContentLength; i++) {
char c = this.content.charAt(i);
switch (c) {
case '\n' -> sb.append("\\n");
case '\r' -> sb.append("\\r");
default -> sb.append(c);
}
}

if (contentLength > maxLength) {
sb.append(TRUNCATED_SUFFIX);
}
result = StringUtils.replace(result, "\n", "\\n");
result = StringUtils.replace(result, "\r", "\\r");
return "SockJsFrame content='" + result + "'";

return "SockJsFrame content='" + sb + "'";
Copy link
Member

@bclozel bclozel Sep 25, 2025

Choose a reason for hiding this comment

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

Why not use the String Builder for this part as well? This PR is trying to optimize for memory allocation after all.

Copy link
Contributor Author

@polyglot-k polyglot-k Sep 26, 2025

Choose a reason for hiding this comment

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

Thank you for the review.

Regarding the other toString() methods, they also use StringBuilder, so I thought there’s no need for the unnecessary String objects to become GC targets in the JVM. Of course, I agree that the original code is more readable.

My perspective is that the readability of this part isn’t particularly high, and concatenating immutable Strings in this way is generally considered an anti-pattern, so I opted to use a mutable StringBuilder.

I will revise the return part as you suggested.

@bclozel

}


Expand Down