Improve the assets path cache algorithm?

Author: Raltyro

source/funkin/backend/assets/AssetsLibraryList.hx

@@ -57,9 +57,16 @@ class AssetsLibraryList extends AssetLibrary {
 	var existsSpecificCacheLibrary:Map<AssetSource, Map<Null<String>, Map<String, AssetLibrary>>> = [];
 	var existsSpecificCacheTime:Map<AssetSource, Map<Null<String>, Map<String, Float>>> = [];
 
-	public function existsSpecific(id:String, type:String, source:AssetSource = BOTH) {
-		if (!id.startsWith("assets/") && existsSpecific('assets/$id', type, source))
-			return true;
+	private function shouldSkipLib(lib:AssetLibrary, source:AssetSource) {
+		if (source == BOTH || lib.tag == BOTH) return false;
+		return source != lib.tag;
+	}
+
+	public function getAssetPathLibrary(id:String, type:String, source:AssetSource = BOTH, checkAssetsPrefix:Bool = true):Null<AssetLibrary> {
+		if (checkAssetsPrefix && !id.startsWith("assets/")) {
+			final library = getAssetPathLibrary('assets/$id', type, source, false);
+			if (library != null) return library;
+		}
 
 		// Prevent massive lags on repetitive usage, primarily with getting note sprite sheets in mania charts (usually 2k+ notes)
 		final time = haxe.Timer.stamp();
@@ -77,47 +84,51 @@ class AssetsLibraryList extends AssetLibrary {
 		}
 
 		if (cacheTimePaths.exists(id)) {
-			final cacheSafeTime = cacheTimePaths.get(id) + 6, library = cacheLibraryPaths.get(id);
+			final library = cacheLibraryPaths.get(id);
+			final cacheSafeTime = (Flags.PATHS_CACHE_LIFETIME == null ? null : cacheTimePaths.get(id) + Flags.PATHS_CACHE_LIFETIME);
+
 			if (library != null) {
-				if (time < cacheSafeTime) return true;
-				else if (!shouldSkipLib(library, source) && library.exists(id, type)) {
+				if (cacheSafeTime == null || time < cacheSafeTime) return library;
+				else if (!shouldSkipLib(library, source)
+					&& (type == null ? library.exists(id, @:privateAccess library.types.get(id)) : library.exists(id, type))
+				) {
 					cacheTimePaths.set(id, time);
-					return true;
+					return library;
 				}
 
 				cacheLibraryPaths.remove(id);
 			}
-			else if (time < cacheSafeTime) {
-				return false;
-			}
+			/*else if (time < cacheSafeTime) {
+				return null;
+			}*/
 		}
 
 		cacheTimePaths.set(id, time);
 
 		for (library in libraries) {
 			if (shouldSkipLib(library, source)) continue;
-			if (library.exists(id, type)) {
+			if (type == null ? library.exists(id, @:privateAccess library.types.get(id)) : library.exists(id, type)) {
 				cacheLibraryPaths.set(id, library);
-				return true;
+				return library;
 			}
 		}
 
-		return false;
+		return null;
 	}
+
+	public function existsSpecific(id:String, type:String, source:AssetSource = BOTH)
+		return getAssetPathLibrary(id, type, source) != null;
+
 	public override inline function exists(id:String, type:String):Bool
 		return existsSpecific(id, type, BOTH);
 
-	public function getSpecificPath(id:String, source:AssetSource = BOTH) {
-		for(k=>e in libraries) {
-			if (shouldSkipLib(e, source)) continue;
-
-			@:privateAccess
-			if (e.exists(id, e.types.get(id))) {
-				var path = e.getPath(id);
-				if (path != null)
-					return path;
-			}
+	public function getSpecificPath(id:String, source:AssetSource = BOTH):Null<String> {
+		final library = getAssetPathLibrary(id, type, source);
+		if (library != null) {
+			final path = library.getPath(id);
+			if (path != null) return path;
 		}
+
 		return null;
 	}
 
@@ -163,36 +174,15 @@ class AssetsLibraryList extends AssetLibrary {
 	}
 
 	public function getSpecificAsset(id:String, type:String, source:AssetSource = BOTH):Dynamic {
-		try {
-			if (!id.startsWith("assets/")) {
-				var ass = getSpecificAsset('assets/$id', type, source);
-				if (ass != null) {
-					return ass;
-				}
-			}
-			for(k=>l in libraries) {
-				if (shouldSkipLib(l, source)) continue;
-
-				@:privateAccess
-				if (l.exists(id, l.types.get(id))) {
-					var asset = l.getAsset(id, type);
-					if (asset != null) {
-						return asset;
-					}
-				}
-			}
-			return null;
-		} catch(e) {
-			// TODO: trace the error
-			throw e;
+		final library = getAssetPathLibrary(id, type, source);
+		if (library != null) {
+			final asset = library.getAsset(id, type);
+			if (asset != null) return asset;
 		}
+
 		return null;
 	}
 
-	private function shouldSkipLib(lib:AssetLibrary, source:AssetSource) {
-		if (source == BOTH || lib.tag == BOTH) return false;
-		return source != lib.tag;
-	}
 	public override inline function getAsset(id:String, type:String):Dynamic
 		return getSpecificAsset(id, type, BOTH);
 
@@ -254,18 +244,21 @@ class AssetsLibraryList extends AssetLibrary {
 
 	public function reset() {
 		unloadLibraries();
+		resetAssetPathCache();
+
+		libraries.resize(0);
 
-		for(source in [AssetSource.SOURCE, AssetSource.MODS, AssetSource.BOTH]) {
+		// adds default libraries in again
+		for (d in __defaultLibraries) addLibrary(d);
+	}
+
+	public function resetAssetPathCache() {
+		for (source in [AssetSource.SOURCE, AssetSource.MODS, AssetSource.BOTH]) {
 			existsSpecificCacheLibrary[source]?.clear();
 			existsSpecificCacheTime[source]?.clear();
 		}
 		existsSpecificCacheLibrary.clear();
 		existsSpecificCacheTime.clear();
-
-		libraries.resize(0);
-
-		// adds default libraries in again
-		for (d in __defaultLibraries) addLibrary(d);
 	}
 
 	public function addLibrary(lib:AssetLibrary, ?tag:AssetSource, ?addTransLib:Bool = true) {

source/funkin/backend/scripting/GlobalScript.hx

@@ -71,6 +71,8 @@ class GlobalScript {
 		FlxG.signals.preStateSwitch.add(function() {
 			call("preStateSwitch");
 
+			if (Flags.PATHS_CACHE_RESET_ON_SWITCH_STATE) Paths.assetsTree.resetAssetPathCache();
+
 			var stateName = Type.getClassName(Type.getClass(@:privateAccess FlxG.game._requestedState));
 			stateName = stateName.substring(stateName.lastIndexOf(".") + 1);
 			if (Flags.MOD_REDIRECT_STATES.exists(stateName)) {

source/funkin/backend/system/Flags.hx

@@ -61,6 +61,10 @@ class Flags {
 	public static var REPO_OWNER:String = "CodenameCrew";
 	public static var REPO_URL:String = 'https://github.com/$REPO_OWNER/$REPO_NAME';
 
+	@:lazy public static var PATHS_CACHE_LIFETIME:Null<Int> = null;
+	public static var PATHS_CACHE_RESET_ON_SWITCH_STATE:Bool = true;
+	//public static var PATHS_CHECK_ASSETS_PREFIX:Bool = true; // Doesn't work fully
+
 	/**
 	 * Preferred sound extension for the game's audio files.
 	 * Currently is set to `mp3` for web targets, and `ogg` for other targets.