Skip to content

Redownload Assets if the referenced asset files have gone missing #233

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.

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

Merged
merged 1 commit into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import net.neoforged.moddevgradle.internal.utils.OperatingSystem;
import net.neoforged.moddevgradle.internal.utils.StringUtils;
import net.neoforged.moddevgradle.internal.utils.VersionCapabilitiesInternal;
import net.neoforged.nfrtgradle.DownloadedAssetsReference;
import org.gradle.api.DefaultTask;
import org.gradle.api.GradleException;
import org.gradle.api.file.ConfigurableFileCollection;
Expand Down Expand Up @@ -274,7 +275,7 @@ private void writeProgramArguments(UserDevRunType runConfig, @Nullable String ma
}

lines.add("# NeoForge Run-Type Program Arguments");
var assetProperties = RunUtils.loadAssetProperties(getAssetProperties().get().getAsFile());
var assetProperties = DownloadedAssetsReference.loadProperties(getAssetProperties().get().getAsFile());
List<String> args = runConfig.args();
for (String arg : args) {
switch (arg) {
Expand Down
25 changes: 0 additions & 25 deletions src/main/java/net/neoforged/moddevgradle/internal/RunUtils.java
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
package net.neoforged.moddevgradle.internal;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Properties;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.stream.Collectors;
Expand Down Expand Up @@ -62,25 +58,6 @@ public static Provider<String> getRequiredType(Project project, RunModel runMode
}));
}

public static AssetProperties loadAssetProperties(File file) {
Properties assetProperties = new Properties();
try (var input = new BufferedInputStream(new FileInputStream(file))) {
assetProperties.load(input);
} catch (IOException e) {
throw new UncheckedIOException("Failed to load asset properties", e);
}
if (!assetProperties.containsKey("assets_root")) {
throw new IllegalStateException("Asset properties file does not contain assets_root");
}
if (!assetProperties.containsKey("asset_index")) {
throw new IllegalStateException("Asset properties file does not contain asset_index");
}

return new AssetProperties(
assetProperties.getProperty("asset_index"),
assetProperties.getProperty("assets_root"));
}

public static void writeLog4j2Configuration(Level rootLevel, Path destination) throws IOException {
Files.writeString(destination, """
<?xml version="1.0" encoding="UTF-8"?>
Expand Down Expand Up @@ -290,8 +267,6 @@ public static Provider<Map<String, ModFolder>> buildModFolders(Project project,
}
}

record AssetProperties(String assetIndex, String assetsRoot) {}

abstract class ModFoldersProvider implements CommandLineArgumentProvider {
@Inject
public ModFoldersProvider() {
Expand Down
40 changes: 39 additions & 1 deletion src/main/java/net/neoforged/nfrtgradle/DownloadAssets.java
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
package net.neoforged.nfrtgradle;

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import javax.inject.Inject;
import org.gradle.api.GradleException;
import org.gradle.api.Task;
import org.gradle.api.file.RegularFileProperty;
import org.gradle.api.logging.Logger;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Optional;
Expand All @@ -21,7 +24,9 @@
@ApiStatus.NonExtendable
public abstract class DownloadAssets extends NeoFormRuntimeTask {
@Inject
public DownloadAssets() {}
public DownloadAssets() {
getOutputs().upToDateWhen(DownloadAssets::checkAssetValidity);
}

/**
* Gradle dependency notation for the NeoForm data artifact, from which a Minecraft version will be derived.
Expand Down Expand Up @@ -109,4 +114,37 @@ public void downloadAssets() {

run(args);
}

private static boolean checkAssetValidity(Task task) {
var downloadTask = (DownloadAssets) task;
var logger = downloadTask.getLogger();

var assetReferenceFile = downloadTask.getAssetPropertiesFile();
if (assetReferenceFile.isPresent()) {
DownloadedAssetsReference assetReference;
try {
assetReference = DownloadedAssetsReference.loadProperties(assetReferenceFile.getAsFile().get());
} catch (Exception e) {
logger.error("Failed to read downloaded asset index: {}", assetReferenceFile);
return false;
}
return validateAssetReference(assetReference, logger);
}

return true;
}

private static boolean validateAssetReference(DownloadedAssetsReference assetReference, Logger logger) {
File assetRoot = new File(assetReference.assetsRoot());
if (!assetRoot.isDirectory()) {
logger.info("Downloaded assets directory has gone missing: {}", assetRoot);
return false;
}
File assetIndex = new File(assetRoot, "indexes/" + assetReference.assetIndex() + ".json");
if (!assetIndex.isFile()) {
logger.info("Downloaded assets index has gone missing: {}", assetIndex);
return false;
}
return true;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package net.neoforged.nfrtgradle;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.util.Properties;

public record DownloadedAssetsReference(String assetIndex, String assetsRoot) {
public static DownloadedAssetsReference loadProperties(File file) {
Properties assetProperties = new Properties();
try (var input = new BufferedInputStream(new FileInputStream(file))) {
assetProperties.load(input);
} catch (IOException e) {
throw new UncheckedIOException("Failed to load asset properties", e);
}
if (!assetProperties.containsKey("assets_root")) {
throw new IllegalStateException("Asset properties file does not contain assets_root");
}
if (!assetProperties.containsKey("asset_index")) {
throw new IllegalStateException("Asset properties file does not contain asset_index");
}

return new DownloadedAssetsReference(
assetProperties.getProperty("asset_index"),
assetProperties.getProperty("assets_root"));
}
}