Skip to content
Success

Changes

Summary

  1. SPIGOT-4441: Fix serializing Components to and from Legacy (details)
Commit 1b2830a3b3aa5ecf4d2f44696654fc028a2c53a0 by md_5
SPIGOT-4441: Fix serializing Components to and from Legacy

While cfeef75cd97 might of semi helped being able to save black text
lore, it actually took a fundamental problem with the legacy serialization
code and expanded it to break even more aspects of the server when dealing
with Component to Legacy conversion.

This is causing data loss in Spigot with cases such as setting an item name
to white gets stripped resulting in it being italic.

Additionally, things such as book pages have been returning black formatting
codes for the end of the line even when the user doesn't have colors in the book.

The root issue is that the "Default Color" system is fundamentally wrong.

Components do not and should not care about what element of the game they
are being used by, and that's what the default color system did.

It results in components that if obtained from 1 source such as a Book
where the default / rendered color is black, is then copied to another
source such as an Entity name, the black is carried forward and shown
in the Entity name, when in reality it should have been white.

This commit reverts cfeef75cd97 and fixes the underlying serialization
issues when it comes to Legacy to and From conversions.

There was quite a number of issues with this code overall, in how
it handles inserting color codes, new line parsing and such.

Books was using mojangs own "getLegacyString" which doesn't match behavior.
We also do not want to use Mojangs method as there is no guarantee they don't
remove that in future.
Plus, everything about books uses the CB implementation anyways, and it should
be consistent (this was mandatory to avoid serialization format changes on old vs new)

These changes as is results in Item Stacks already serialized will not
change contents when they go to component and back, so this won't impact
any existing data.

Newly created books though for example will change behavior in that they
will no longer insert black color codes in the serialized data and will
only represent intentional color changes by the creator of the book.
This will result in cleaner data on them, and books are the only thing
I'm aware of that has a behavioral shift due to the likelyhood of the
default color system kicking in on other parts of the string.

A unit test has been added to verify integrity of serialization to
ensure that any legacy string that is converted into Components will
always re-encode back in the same way when going back to Legacy.
The file was modified nms-patches/PlayerConnection.patch
The file was modified src/main/java/org/bukkit/craftbukkit/util/CraftChatMessage.java
The file was modified src/main/java/org/bukkit/craftbukkit/inventory/CraftMetaItem.java
The file was modified src/main/java/org/bukkit/craftbukkit/inventory/CraftMetaBook.java
The file was modified src/main/java/org/bukkit/craftbukkit/entity/CraftEntity.java
The file was modified src/main/java/org/bukkit/craftbukkit/entity/CraftPlayer.java
The file was addedsrc/test/java/org/bukkit/craftbukkit/util/CraftChatMessageTest.java