Fabric Data Fixer API (v1)

build.gradle

@@ -272,7 +272,7 @@ allprojects {
 
 	spotless {
 		java {
-			licenseHeaderFile(rootProject.file("HEADER"))
+			licenseHeaderFile(rootProject.file("HEADER")).named('default')
 			removeUnusedImports()
 			importOrder('java', 'javax', '', 'net.minecraft', 'net.fabricmc')
 			indentWithTabs()

fabric-data-fixer-api-v1/HEADER-PORT

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2016-2022 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * This file is a modified version of Quilt Standard Libraries,
+ * authored by QuiltMC.
+ */
+

fabric-data-fixer-api-v1/README.md

@@ -0,0 +1,22 @@
+# Fabric Data Fixer API (v1)
+For user-facing documentation, please check the Javadoc.
+
+This is a port of data fixer API from QSL, with some internal changes and new methods:
+
+- Unlike QSL, this API saves the data version in a NBT compound `_FabricDataVersions`.
+- Current data version can be specified in the `fabric.mod.json` file.
+- `FabricDataFixerBuilder#build()` overload that uses bootstrap executor.
+
+Files with ported code are marked with `// From QSL.` comment and a special license header.
+
+## Running the tests
+The repository contains three files: `level.dat` and two region files (with chunks trimmed). You can run `gradlew runTestmodServer` to test the updating. If this does not error, the tests passed!
+
+To generate the file (without running the tests), run `gradlew runGenOldSave`, then optionally trim the chunks with NBT editing tools.
+
+The test files contain:
+
+- A chest block with a modded item, at `0, 10, 0` in the overworld
+- A modded chest block with a modded item, at `0, 9, 0` in the overworld
+- A modded block at `0, 8, 0` in the overworld
+- A modded biome at chunk `0, 0` in the End

fabric-data-fixer-api-v1/build.gradle

@@ -0,0 +1,38 @@
+archivesBaseName = "fabric-data-fixer-api-v1"
+version = getSubprojectVersion(project)
+
+moduleDependencies(project, [
+		'fabric-api-base',
+		'fabric-lifecycle-events-v1'
+])
+
+testDependencies(project, [
+		':fabric-biome-api-v1',
+		':fabric-item-api-v1',
+		':fabric-object-builder-api-v1'
+])
+
+loom {
+	accessWidenerPath = file('src/main/resources/fabric-data-fixer-api-v1.accesswidener')
+
+	runs {
+		genOldSave {
+			inherit testmodServer
+			name "Generate old save"
+			vmArg "-Dfabric.dataFixerTestMod.genMode=true"
+
+			ideConfigGenerated = true
+		}
+	}
+}
+
+spotless {
+	java {
+		/**
+		 * This module contains a code from QSL, and they need a separate license header.
+		 * Code ported from QSL should be marked as "From QSL" in a comment,
+		 * inside the "source" (i.e. not inside header comment).
+		 */
+		licenseHeaderFile(project.file("HEADER-PORT")).named('port').onlyIfContentMatches('.*From QSL.*')
+	}
+}

fabric-data-fixer-api-v1/src/client/java/net/fabricmc/fabric/impl/client/datafixer/v1/ClientFreezer.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2016-2022 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * This file is a modified version of Quilt Standard Libraries,
+ * authored by QuiltMC.
+ */
+
+package net.fabricmc.fabric.impl.client.datafixer.v1;
+
+import net.fabricmc.api.ClientModInitializer;
+import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientLifecycleEvents;
+import net.fabricmc.fabric.impl.datafixer.v1.FabricDataFixesInternals;
+
+public final class ClientFreezer implements ClientModInitializer {
+	// From QSL.
+	@Override
+	public void onInitializeClient() {
+		ClientLifecycleEvents.CLIENT_STARTED.register((client) -> FabricDataFixesInternals.get().freeze());
+	}
+}

fabric-data-fixer-api-v1/src/main/java/net/fabricmc/fabric/api/datafixer/v1/DataFixerEntrypoint.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2016, 2017, 2018, 2019 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.fabricmc.fabric.api.datafixer.v1;
+
+import com.mojang.datafixers.schemas.Schema;
+
+public interface DataFixerEntrypoint {
+	void onRegisterBlockEntities(SchemaRegistry registry, Schema schema);
+
+	void onRegisterEntities(SchemaRegistry registry, Schema schema);
+}

fabric-data-fixer-api-v1/src/main/java/net/fabricmc/fabric/api/datafixer/v1/EmptySchema.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2016-2022 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * This file is a modified version of Quilt Standard Libraries,
+ * authored by QuiltMC.
+ */
+
+package net.fabricmc.fabric.api.datafixer.v1;
+
+import java.util.Map;
+import java.util.function.Supplier;
+
+import com.mojang.datafixers.DSL;
+import com.mojang.datafixers.schemas.Schema;
+import com.mojang.datafixers.types.Type;
+import com.mojang.datafixers.types.templates.TypeTemplate;
+import it.unimi.dsi.fastutil.objects.Object2ObjectMaps;
+import org.jetbrains.annotations.Range;
+
+/**
+ * Represents an empty {@link Schema}, having no parent and containing no type definitions.
+ */
+public final class EmptySchema extends FirstSchema {
+	// From QSL.
+
+	/**
+	 * Constructs an empty schema.
+	 *
+	 * @param versionKey the data version key
+	 */
+	public EmptySchema(@Range(from = 0, to = Integer.MAX_VALUE) int versionKey) {
+		super(versionKey);
+	}
+
+	// Ensure the schema stays empty.
+	@Override
+	public void registerType(boolean recursive, DSL.TypeReference type, Supplier<TypeTemplate> template) {
+		throw new UnsupportedOperationException();
+	}
+
+	@Override
+	protected Map<String, Type<?>> buildTypes() {
+		return Object2ObjectMaps.emptyMap();
+	}
+}

fabric-data-fixer-api-v1/src/main/java/net/fabricmc/fabric/api/datafixer/v1/FabricDataFixerBuilder.java

@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2016-2022 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * This file is a modified version of Quilt Standard Libraries,
+ * authored by QuiltMC.
+ */
+
+package net.fabricmc.fabric.api.datafixer.v1;
+
+import java.util.Objects;
+import java.util.Set;
+import java.util.concurrent.Executor;
+import java.util.function.Supplier;
+
+import com.mojang.datafixers.DSL;
+import com.mojang.datafixers.DataFixerBuilder;
+import com.mojang.datafixers.DataFixerUpper;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.Range;
+
+import net.minecraft.util.Util;
+
+import net.fabricmc.fabric.impl.datafixer.v1.FabricDataFixesInternals;
+import net.fabricmc.loader.api.ModContainer;
+
+/**
+ * An extended variant of the {@link DataFixerBuilder} class, which provides an extra method.
+ */
+public class FabricDataFixerBuilder extends DataFixerBuilder {
+	// From QSL.
+	protected final int dataVersion;
+
+	/**
+	 * Creates a new {@code FabricDataFixerBuilder}.
+	 *
+	 * @param dataVersion the current data version
+	 */
+	public FabricDataFixerBuilder(@Range(from = 0, to = Integer.MAX_VALUE) int dataVersion) {
+		super(dataVersion);
+		this.dataVersion = dataVersion;
+	}
+
+	/**
+	 * Creates a new {@code FabricDataFixerBuilder}. This method gets the current version from
+	 * the {@code fabric-data-fixer-api-v1:version} field in the {@code custom} object of
+	 * the {@code fabric.mod.json} file of {@code mod}. To specify the version
+	 * manually, use the other overload.
+	 *
+	 * @param mod the mod container
+	 * @return the data fixer builder
+	 * @throws RuntimeException if the version field does not exist or is not a number
+	 */
+	public static FabricDataFixerBuilder create(ModContainer mod) {
+		Objects.requireNonNull(mod, "mod cannot be null");
+		int dataVersion = FabricDataFixesInternals.getDataVersionFromMetadata(mod);
+		return new FabricDataFixerBuilder(dataVersion);
+	}
+
+	/**
+	 * @return the current data version
+	 */
+	@Range(from = 0, to = Integer.MAX_VALUE)
+	public int getDataVersion() {
+		return this.dataVersion;
+	}
+
+	/**
+	 * Builds the final {@code DataFixer}.
+	 *
+	 * <p>This will build either an {@linkplain #build() unoptimized fixer} or an
+	 * optimized fixer, depending on the vanilla game's settings.
+	 *
+	 * @param types          the set of required {@link com.mojang.datafixers.DSL.TypeReference}s, only used if the game is using optimized data fixers
+	 * @param executorGetter the executor supplier, only invoked if the game is using optimized data fixers
+	 * @return the newly built data fixer
+	 */
+	@Contract(value = "_, _ -> new")
+	public DataFixerUpper build(Set<DSL.TypeReference> types, Supplier<Executor> executorGetter) {
+		Objects.requireNonNull(executorGetter, "executorGetter cannot be null");
+		return (DataFixerUpper) (types.isEmpty() ? this.build().fixer() : Util.make(() -> {
+			Result result = this.build();
+			result.optimize(types, executorGetter.get()).join();
+			return result.fixer();
+		}));
+	}
+}