fix: original asset objects are now cast during first load to avoid leaking originals where we shouldnt, #977

AlmasB · AlmasB · commit 6ba47157fe67 · 2023-02-28T19:38:20.000Z
diff --git a/fxgl/src/main/kotlin/com/almasb/fxgl/app/services/FXGLAssetLoaderService.kt b/fxgl/src/main/kotlin/com/almasb/fxgl/app/services/FXGLAssetLoaderService.kt
@@ -533,7 +533,7 @@ class FXGLAssetLoaderService : AssetLoaderService() {
                 cachedAssets[cacheKey] = loaded as Any
             }
 
-            loaded
+            data.cast(loaded as Any)
         } catch (e: Exception) {
             log.warning("Failed to load ${loadParams.url}", e)
             data.getDummy()
@@ -696,6 +696,12 @@ private class TextAssetLoader : AssetLoader<List<*>>(
         List::class.java,
         TEXT_DIR
 ) {
+    override fun cast(obj: Any): List<String> {
+        val list = obj as List<String>
+
+        return list.toList()
+    }
+
     override fun load(url: URL): List<String> = url.openStream().bufferedReader().readLines()
 
     override fun getDummy(): List<String> = emptyList()
diff --git a/fxgl/src/test/kotlin/com/almasb/fxgl/app/AssetLoaderServiceTest.kt b/fxgl/src/test/kotlin/com/almasb/fxgl/app/AssetLoaderServiceTest.kt
@@ -185,7 +185,8 @@ class AssetLoaderServiceTest {
 
         assertThat(lines.size, `is`(0))
 
-        assertTrue(assetLoader.loadText("test1.txt") === assetLoader.loadText("test1.txt"))
+        // ensure a new copy of the list is loaded so that original cannot be modified
+        assertTrue(assetLoader.loadText("test1.txt") !== assetLoader.loadText("test1.txt"))
     }
 
     @Test

Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,8 @@ class AssetLoaderServiceTest {`
`185`	`185`
`186`	`186`	assertThat(lines.size, `is`(0))
`187`	`187`
`188`		`- assertTrue(assetLoader.loadText("test1.txt") === assetLoader.loadText("test1.txt"))`
	`188`	`+ // ensure a new copy of the list is loaded so that original cannot be modified`
	`189`	`+ assertTrue(assetLoader.loadText("test1.txt") !== assetLoader.loadText("test1.txt"))`
`189`	`190`	`}`
`190`	`191`
`191`	`192`	`@Test`