Skip to content
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

Avoid swallowing errors in case of AttachmentType Serialization failure #1953

Merged
merged 2 commits into from
Feb 12, 2025
Merged

Avoid swallowing errors in case of AttachmentType Serialization failure #1953

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0130d3
Do not swallow errors in case of AttachmentType RW failure
TheSilkMiner Feb 11, 2025
9782956
Add validation around serialization in AttachmentHolder
TheSilkMiner Feb 11, 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
16 changes: 13 additions & 3 deletions src/main/java/net/neoforged/neoforge/attachment/AttachmentType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import com.google.common.base.Predicates;
import com.mojang.serialization.Codec;
import com.mojang.serialization.DataResult;
import java.util.Objects;
import java.util.function.Function;
import java.util.function.Predicate;
Expand Down Expand Up @@ -198,17 +199,26 @@ public Builder<T> serialize(Codec<T> codec) {
*/
public Builder<T> serialize(Codec<T> codec, Predicate<? super T> shouldSerialize) {
Objects.requireNonNull(codec);
// TODO: better error handling
return serialize(new IAttachmentSerializer<>() {
@Override
public T read(IAttachmentHolder holder, Tag tag, HolderLookup.Provider provider) {
return codec.parse(provider.createSerializationContext(NbtOps.INSTANCE), tag).result().get();
final DataResult<T> parsingResult = codec.parse(provider.createSerializationContext(NbtOps.INSTANCE), tag);
return parsingResult.getOrThrow(msg -> buildException("read", msg));
}

@Nullable
@Override
public Tag write(T attachment, HolderLookup.Provider provider) {
return shouldSerialize.test(attachment) ? codec.encodeStart(provider.createSerializationContext(NbtOps.INSTANCE), attachment).result().get() : null;
if (!shouldSerialize.test(attachment)) {
return null;
}
final DataResult<Tag> encodingResult = codec.encodeStart(provider.createSerializationContext(NbtOps.INSTANCE), attachment);
return encodingResult.getOrThrow(msg -> buildException("write", msg));
}

private RuntimeException buildException(final String operation, final String error) {
// TODO: Maybe find a way to let the user know *which* attachment has exploded?
TheSilkMiner marked this conversation as resolved.
Show resolved Hide resolved
return new IllegalStateException("Unable to " + operation + " attachment due to an internal codec error: " + error);
}
});
}
Expand Down
Loading