From 8f4dd175077ceb5cf53e75c686448535bcda806d Mon Sep 17 00:00:00 2001
From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com>
Date: Tue, 6 Oct 2026 05:13:34 +0200
Subject: [PATCH] fix: preserve release assets by registered path

---
 scripts/generate_db.py         | 52 ++++++++++++++++------------------
 tests/test_large_file_cache.py | 34 +++++++++++++++++++---
 2 files changed, 54 insertions(+), 32 deletions(-)

diff --git a/scripts/generate_db.py b/scripts/generate_db.py
index 4b3f3689..2647db45 100644
--- a/scripts/generate_db.py
+++ b/scripts/generate_db.py
@@ -13,6 +13,7 @@ from __future__ import annotations
 import argparse
 import json
 import os
+import shutil
 import sys
 from datetime import datetime, timezone
 from pathlib import Path
@@ -257,33 +258,33 @@ def save_cache(cache_path: str, cache: dict):
         json.dump(cache, f)
 
 
-def _load_gitignored_large_files() -> dict[str, str]:
-    """Read .gitignore and return {filename: bios_path} for large files."""
+def _load_gitignored_large_files() -> set[str]:
+    """The bios/ paths .gitignore registers as release assets."""
     gitignore = Path(".gitignore")
     if not gitignore.exists():
-        return {}
-    entries = {}
-    for line in gitignore.read_text().splitlines():
-        line = line.strip()
-        if line.startswith("bios/") and not line.startswith("#"):
-            name = Path(line).name
-            entries[name] = line
-    return entries
+        return set()
+    return {
+        line.strip()
+        for line in gitignore.read_text().splitlines()
+        if line.strip().startswith("bios/")
+    }
 
 
 def _preserve_large_file_entries(files: dict, db_path: str) -> int:
-    """Preserve database entries for large files not on disk.
+    """Keep the entries of release assets the checkout does not hold.
 
-    Large files (>50 MB) are stored as GitHub release assets and listed
-    in .gitignore. When generate_db runs locally without them, their
-    entries would be lost. This reads the existing database, downloads
-    missing files from the release, and re-adds entries with paths
-    pointing to the local cache.
+    Files kept out of git live as assets of the large-files release, and
+    .gitignore registers their paths. An entry survives a scan that missed
+    its file only under that registered path: a bare name is shared by
+    other files (pak0.pk3, history.db), and a path rewritten into the
+    download cache is no longer one .gitignore knows, so the manifest
+    would send the installer to the repository for it. A fetched asset is
+    written back to its registered path.
     """
     from common import fetch_large_file
 
-    large_files = _load_gitignored_large_files()
-    if not large_files:
+    registered = _load_gitignored_large_files()
+    if not registered:
         return 0
 
     try:
@@ -299,22 +300,17 @@ def _preserve_large_file_entries(files: dict, db_path: str) -> int:
 
     count = 0
     for sha1, entry in existing_db.get("files", {}).items():
-        if sha1 in files:
-            continue
-        name = entry.get("name", "")
         path = entry.get("path", "")
-        # Match by gitignored bios/ path OR by filename of a known large file
-        if path not in large_files.values() and name not in large_files:
+        if sha1 in files or path not in registered or path in scanned_paths:
             continue
         cached = fetch_large_file(
-            path if path in large_files.values() else name,
+            path,
             expected_sha1=entry.get("sha1", ""),
             expected_md5=entry.get("md5", ""),
         )
-        if cached:
-            entry = {**entry, "path": cached}
-        elif path in scanned_paths:
-            continue
+        if cached and not os.path.exists(path):
+            os.makedirs(os.path.dirname(path), exist_ok=True)
+            shutil.copy2(cached, path)
         files[sha1] = entry
         count += 1
     return count
diff --git a/tests/test_large_file_cache.py b/tests/test_large_file_cache.py
index b83c85a0..58ec9275 100644
--- a/tests/test_large_file_cache.py
+++ b/tests/test_large_file_cache.py
@@ -280,15 +280,41 @@ class PreservedLargeFileEntries(unittest.TestCase):
         self.assertEqual(count, 1)
         self.assertIn("b" * 40, files)
 
-    def test_verified_cache_hit_repoints_the_entry(self):
+    def test_a_fetched_asset_returns_to_its_registered_path(self):
+        cache = self.tmp / "cache" / "FW.PUP"
+        cache.parent.mkdir()
+        cache.write_bytes(b"firmware")
+        common.fetch_large_file = lambda *a, **k: str(cache)
+        db_path = self._write_db(
+            {"b" * 40: {"name": "FW.PUP", "path": "bios/Sony/PS3/FW.PUP"}}
+        )
+        files: dict = {}
+        count = self.generate_db._preserve_large_file_entries(files, db_path)
+        self.assertEqual(count, 1)
+        self.assertEqual(files["b" * 40]["path"], "bios/Sony/PS3/FW.PUP")
+        self.assertEqual((self.tmp / "bios/Sony/PS3/FW.PUP").read_bytes(), b"firmware")
+
+    def test_a_file_sharing_only_the_name_is_not_preserved(self):
+        common.fetch_large_file = lambda *a, **k: "/cache/large/FW.PUP"
+        db_path = self._write_db(
+            {"c" * 40: {"name": "FW.PUP", "path": "bios/Sony/PSP/FW.PUP"}}
+        )
+        files: dict = {}
+        self.assertEqual(
+            self.generate_db._preserve_large_file_entries(files, db_path), 0
+        )
+        self.assertEqual(files, {})
+
+    def test_a_second_revision_under_a_rescanned_path_is_dropped(self):
         common.fetch_large_file = lambda *a, **k: "/cache/large/FW.PUP"
         db_path = self._write_db(
             {"b" * 40: {"name": "FW.PUP", "path": "bios/Sony/PS3/FW.PUP"}}
         )
         files = {"a" * 40: {"name": "FW.PUP", "path": "bios/Sony/PS3/FW.PUP"}}
-        count = self.generate_db._preserve_large_file_entries(files, db_path)
-        self.assertEqual(count, 1)
-        self.assertEqual(files["b" * 40]["path"], "/cache/large/FW.PUP")
+        self.assertEqual(
+            self.generate_db._preserve_large_file_entries(files, db_path), 0
+        )
+        self.assertEqual(list(files), ["a" * 40])
 
 
 class ReleaseAssetNames(unittest.TestCase):