Skip to content

Commit

Permalink
Fix wrong timestamp/UUID being used for legacy conversion (#167)
Browse files Browse the repository at this point in the history 
* Maintain legacy snapshot IDs when updating

* Also maintain timestamps during conversion

* Actually implement timestamp fix in LegacyConverter
  • Loading branch information
@WiIIiam278
WiIIiam278 committed Sep 22, 2023
1 parent 635edb9 commit 7034a97
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 12 deletions.
5 changes: 4 additions & 1 deletion bukkit/src/main/java/net/william278/husksync/util/BukkitLegacyConverter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import java.io.ByteArrayInputStream;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.time.OffsetDateTime;
import java.util.*;

public class BukkitLegacyConverter extends LegacyConverter {
Expand All @@ -49,7 +50,8 @@ public BukkitLegacyConverter(@NotNull HuskSync plugin) {

@NotNull
@Override
public DataSnapshot.Packed convert(@NotNull byte[] data) throws DataAdapter.AdaptionException {
public DataSnapshot.Packed convert(@NotNull byte[] data, @NotNull UUID id,
@NotNull OffsetDateTime timestamp) throws DataAdapter.AdaptionException {
final JSONObject object = new JSONObject(plugin.getDataAdapter().bytesToString(data));
final int version = object.getInt("format_version");
if (version != 3) {
Expand All @@ -61,6 +63,7 @@ public DataSnapshot.Packed convert(@NotNull byte[] data) throws DataAdapter.Adap

// Read legacy data from the JSON object
final DataSnapshot.Builder builder = DataSnapshot.builder(plugin)
.id(id).timestamp(timestamp)
.saveCause(DataSnapshot.SaveCause.CONVERTED_FROM_V2)
.data(readStatusData(object));
readInventory(object).ifPresent(builder::inventory);
Expand Down
33 changes: 30 additions & 3 deletions common/src/main/java/net/william278/husksync/data/DataSnapshot.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,11 @@ public static DataSnapshot.Builder builder(@NotNull HuskSync plugin) {
return new Builder(plugin);
}

// Deserialize a DataSnapshot downloaded from the database (with an ID & Timestamp from the database)
@NotNull
@ApiStatus.Internal
public static DataSnapshot.Packed deserialize(@NotNull HuskSync plugin, byte[] data) throws IllegalStateException {
public static DataSnapshot.Packed deserialize(@NotNull HuskSync plugin, byte[] data, @Nullable UUID id,
@Nullable OffsetDateTime timestamp) throws IllegalStateException {
final DataSnapshot.Packed snapshot = plugin.getDataAdapter().fromBytes(data, DataSnapshot.Packed.class);
if (snapshot.getMinecraftVersion().compareTo(plugin.getMinecraftVersion()) > 0) {
throw new IllegalStateException(String.format("Cannot set data for user because the Minecraft version of " +
Expand All @@ -114,7 +116,11 @@ public static DataSnapshot.Packed deserialize(@NotNull HuskSync plugin, byte[] d
}
if (snapshot.getFormatVersion() < CURRENT_FORMAT_VERSION) {
if (plugin.getLegacyConverter().isPresent()) {
return plugin.getLegacyConverter().get().convert(data);
return plugin.getLegacyConverter().get().convert(
data,
Objects.requireNonNull(id, "Attempted legacy conversion with null UUID!"),
Objects.requireNonNull(timestamp, "Attempted legacy conversion with null timestamp!")
);
}
throw new IllegalStateException(String.format(
"No legacy converter to convert format version: %s", snapshot.getFormatVersion()
Expand All @@ -129,6 +135,13 @@ public static DataSnapshot.Packed deserialize(@NotNull HuskSync plugin, byte[] d
return snapshot;
}

// Deserialize a DataSnapshot from a network message payload (without an ID)
@NotNull
@ApiStatus.Internal
public static DataSnapshot.Packed deserialize(@NotNull HuskSync plugin, byte[] data) throws IllegalStateException {
return deserialize(plugin, data, null, null);
}

/**
* Return the ID of the snapshot
*
Expand Down Expand Up @@ -393,6 +406,7 @@ id, pinned, timestamp, saveCause, serializeData(plugin),
public static class Builder {

private final HuskSync plugin;
private UUID id;
private SaveCause saveCause;
private boolean pinned;
private OffsetDateTime timestamp;
Expand All @@ -403,6 +417,19 @@ private Builder(@NotNull HuskSync plugin) {
this.pinned = false;
this.data = new HashMap<>();
this.timestamp = OffsetDateTime.now();
this.id = UUID.randomUUID();
}

/**
* Set the {@link UUID unique ID} of the snapshot
*
* @param id The {@link UUID} of the snapshot
* @return The builder
*/
@NotNull
public Builder id(@NotNull UUID id) {
this.id = id;
return this;
}

/**
Expand Down Expand Up @@ -661,7 +688,7 @@ public DataSnapshot.Unpacked build() throws IllegalStateException {
throw new IllegalStateException("Cannot build DataSnapshot without a save cause");
}
return new Unpacked(
UUID.randomUUID(),
id,
pinned || plugin.getSettings().doAutoPin(saveCause),
timestamp,
saveCause,
Expand Down
23 changes: 17 additions & 6 deletions common/src/main/java/net/william278/husksync/database/MySqlDatabase.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -217,18 +217,22 @@ public Optional<User> getUserByName(@NotNull String username) {
public Optional<DataSnapshot.Packed> getLatestSnapshot(@NotNull User user) {
try (Connection connection = getConnection()) {
try (PreparedStatement statement = connection.prepareStatement(formatStatementTables("""
SELECT `version_uuid`, `timestamp`, `save_cause`, `pinned`, `data`
SELECT `version_uuid`, `timestamp`, `data`
FROM `%user_data_table%`
WHERE `player_uuid`=?
ORDER BY `timestamp` DESC
LIMIT 1;"""))) {
statement.setString(1, user.getUuid().toString());
final ResultSet resultSet = statement.executeQuery();
if (resultSet.next()) {
final UUID versionUuid = UUID.fromString(resultSet.getString("version_uuid"));
final OffsetDateTime timestamp = OffsetDateTime.ofInstant(
resultSet.getTimestamp("timestamp").toInstant(), TimeZone.getDefault().toZoneId()
);
final Blob blob = resultSet.getBlob("data");
final byte[] dataByteArray = blob.getBytes(1, (int) blob.length());
blob.free();
return Optional.of(DataSnapshot.deserialize(plugin, dataByteArray));
return Optional.of(DataSnapshot.deserialize(plugin, dataByteArray, versionUuid, timestamp));
}
}
} catch (SQLException | DataAdapter.AdaptionException e) {
Expand All @@ -244,17 +248,21 @@ public List<DataSnapshot.Packed> getAllSnapshots(@NotNull User user) {
final List<DataSnapshot.Packed> retrievedData = new ArrayList<>();
try (Connection connection = getConnection()) {
try (PreparedStatement statement = connection.prepareStatement(formatStatementTables("""
SELECT `version_uuid`, `timestamp`, `save_cause`, `pinned`, `data`
SELECT `version_uuid`, `timestamp`, `data`
FROM `%user_data_table%`
WHERE `player_uuid`=?
ORDER BY `timestamp` DESC;"""))) {
statement.setString(1, user.getUuid().toString());
final ResultSet resultSet = statement.executeQuery();
while (resultSet.next()) {
final UUID versionUuid = UUID.fromString(resultSet.getString("version_uuid"));
final OffsetDateTime timestamp = OffsetDateTime.ofInstant(
resultSet.getTimestamp("timestamp").toInstant(), TimeZone.getDefault().toZoneId()
);
final Blob blob = resultSet.getBlob("data");
final byte[] dataByteArray = blob.getBytes(1, (int) blob.length());
blob.free();
retrievedData.add(DataSnapshot.deserialize(plugin, dataByteArray));
retrievedData.add(DataSnapshot.deserialize(plugin, dataByteArray, versionUuid, timestamp));
}
return retrievedData;
}
Expand All @@ -269,7 +277,7 @@ public List<DataSnapshot.Packed> getAllSnapshots(@NotNull User user) {
public Optional<DataSnapshot.Packed> getSnapshot(@NotNull User user, @NotNull UUID versionUuid) {
try (Connection connection = getConnection()) {
try (PreparedStatement statement = connection.prepareStatement(formatStatementTables("""
SELECT `version_uuid`, `timestamp`, `save_cause`, `pinned`, `data`
SELECT `version_uuid`, `timestamp`, `data`
FROM `%user_data_table%`
WHERE `player_uuid`=? AND `version_uuid`=?
ORDER BY `timestamp` DESC
Expand All @@ -279,9 +287,12 @@ public Optional<DataSnapshot.Packed> getSnapshot(@NotNull User user, @NotNull UU
final ResultSet resultSet = statement.executeQuery();
if (resultSet.next()) {
final Blob blob = resultSet.getBlob("data");
final OffsetDateTime timestamp = OffsetDateTime.ofInstant(
resultSet.getTimestamp("timestamp").toInstant(), TimeZone.getDefault().toZoneId()
);
final byte[] dataByteArray = blob.getBytes(1, (int) blob.length());
blob.free();
return Optional.of(DataSnapshot.deserialize(plugin, dataByteArray));
return Optional.of(DataSnapshot.deserialize(plugin, dataByteArray, versionUuid, timestamp));
}
}
} catch (SQLException | DataAdapter.AdaptionException e) {
Expand Down
6 changes: 5 additions & 1 deletion common/src/main/java/net/william278/husksync/util/LegacyConverter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
import net.william278.husksync.data.DataSnapshot;
import org.jetbrains.annotations.NotNull;

import java.time.OffsetDateTime;
import java.util.UUID;

public abstract class LegacyConverter {

protected final HuskSync plugin;
Expand All @@ -33,6 +36,7 @@ protected LegacyConverter(@NotNull HuskSync plugin) {
}

@NotNull
public abstract DataSnapshot.Packed convert(@NotNull byte[] data) throws DataAdapter.AdaptionException;
public abstract DataSnapshot.Packed convert(@NotNull byte[] data, @NotNull UUID id,
@NotNull OffsetDateTime timestamp) throws DataAdapter.AdaptionException;

}
2 changes: 1 addition & 1 deletion gradle.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ org.gradle.jvmargs='-Dfile.encoding=UTF-8'
org.gradle.daemon=true
javaVersion=16

plugin_version=3.0
plugin_version=3.0.1
plugin_archive=husksync
plugin_description=A modern, cross-server player data synchronization system

Expand Down

0 comments on commit 7034a97

Please sign in to comment.