WIP: fix(builder): a refused extracted dump leaves the saved copy of the game code alone #1175
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
3 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1175
Loading…
Reference in a new issue
No description provided.
Delete branch "TrashPanda/Longshot:fix/refused-dump-keeps-code"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Type: fix · Risk: low · Tested on: Linux, RTX 4070 Ti (game-free checks) · Needs: none
Why
Building a game folder again from an extracted dump of an unsupported version was refused, as it should be, but only after the dump's modules had replaced the folder's saved game code. Choosing the earlier, supported
.nupagain then reused the refused code and was refused too, until the folder was deleted.Restored from Hookshot 2968, by jarynclouatre, and split out of #286 so it can be reviewed and merged on its own.
How to reproduce
Seen on: any PC
Settings and switches: defaults
Steps: build from a supported
.nup, then from an extracted dump of another version (refused), then from the.nupagainExpected: the last build works
Actual: the last build is refused as well
What changed
nx2/make_game.pychecks the build right after the dump's modules are unpacked, before.longshot_exefsis touched, and an accepted dump removes the.nup's stamp so the.nupis read again next time.Commits, each with its original author and message:
75241396fix(builder): a refused extracted dump leaves the saved copy of the game code alone (jarynclouatre)In Hookshot Builder, a game folder that was built from a supported
.nupcan be rebuilt from an extracted dump. When that dump is ofanother game version, the build is refused ("This is build X. Hookshot
supports build Y"), which is right, but
nx2/make_game.pychecked theversion only after the dump's modules had replaced the folder's saved
copy (
.hookshot_exefs). The stamp of the earlier.nupstayed.Choosing that
.nupagain then said "reading it again is skipped",built from the refused modules and was refused too, until the folder was
deleted.
In the extracted-dump branch of
main():check_supported_buildruns right after the dump's modules areunpacked, before the romfs is linked in and before
.hookshot_exefsistouched. A refused dump leaves the folder as it was.
.nupstamp (.hookshot_romfs), sincethe saved copies are no longer that
.nup's. The next build from the.nupreads it again.The
.nupbranch already checks the build before it replaces anything;it is unchanged.
tests/test_make_game_cache.py, two new cases (the cache test's fake.nupand modules, no game):before, and the earlier
.nupthen reuses its copy and reaches the liftwith the supported build.
.nupstamp isgone, and the earlier
.nupis read again.on main on this machine (
test_bake_portability:zstandardis notinstalled;
nx2/test_texture_init_barrier.py:clang++is notinstalled).
Restored-from: https://github.com/NotRexed/Hookshot/pull/2968
Measurements
Verdict: nothing to measure: a correctness fix off the frame path, covered by game-free checks.
Flags and settings
None.
Testing
Tested: On Linux (kernel 7.0), RTX 4070 Ti,
main@71b1edd8, this PR @75241396:tests/test_make_game_cache.pypass.tests/test_make_game_cache.pyfails here onmaintoo (19 failures: the harness mockssubprocess.Popen, which also catches the real clang profile probe on this PC). With that probe stubbed, all 41 cases pass, the two new ones included. The full suite (tests/run_all.py) has not been run on this branch yet; a comment will follow when it has.Not tested: A real game build from a refused dump. Opened as work in progress until it runs in the game.
Must be tested:
.nup, then the other dump, then the.nupagain, expecting the last build to workRisks
What could break: the builder's extracted-dump path.
Turning it off: revert the commit.
Compatibility: Nothing changes.
Checklist
Everyone
type(scope): description) of the status line's type.can't be run by hand is in Testing's Not testable by hand, with why.
in Risks.
main.third_party/untouched (a new folder with aPROVENANCE.mdinstead).python -I -B tests/run_all.pypasses (any failure that also fails onmainis named).When it applies
mainand passing here.In Hookshot Builder, a game folder that was built from a supported `.nup` can be rebuilt from an extracted dump. When that dump is of another game version, the build is refused ("This is build X. Hookshot supports build Y"), which is right, but `nx2/make_game.py` checked the version only after the dump's modules had replaced the folder's saved copy (`.hookshot_exefs`). The stamp of the earlier `.nup` stayed. Choosing that `.nup` again then said "reading it again is skipped", built from the refused modules and was refused too, until the folder was deleted. In the extracted-dump branch of `main()`: - `check_supported_build` runs right after the dump's modules are unpacked, before the romfs is linked in and before `.hookshot_exefs` is touched. A refused dump leaves the folder as it was. - An accepted dump removes the `.nup` stamp (`.hookshot_romfs`), since the saved copies are no longer that `.nup`'s. The next build from the `.nup` reads it again. The `.nup` branch already checks the build before it replaces anything; it is unchanged. - `tests/test_make_game_cache.py`, two new cases (the cache test's fake `.nup` and modules, no game): - A refused extracted dump: the folder's files are byte for byte as before, and the earlier `.nup` then reuses its copy and reaches the lift with the supported build. - An accepted extracted dump: its modules are saved, the `.nup` stamp is gone, and the earlier `.nup` is read again. - Both fail on main and pass here. - Full suite on Linux: 473 passed, 53 skipped, 2 failed, both the same on main on this machine (`test_bake_portability`: `zstandard` is not installed; `nx2/test_texture_init_barrier.py`: `clang++` is not installed). - No real game build was run. Restored-from: https://github.com/NotRexed/Hookshot/pull/2968Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti 12 GB, NVIDIA 595.99.02, Ryzen 7 9800X3D: this branch built together with the other 18 split from #218 and #284-#288, merged onto main @
71b1edd8(make_game.py --update, build v3.0.0-rc.5-82-g5952bb3d), then played by a scripted tour through the control bridge (scripts/memtour.py: a save loaded, Zora's Domain, the Market, Hyrule Field and Death Mountain Trail, 40 s each with walking and camera swings). All 4 stops reached, a clean quit, and no device loss or Vulkan error in the log. The build was an update of a folder with its kept game code; no dump was refused, so the changed path did not run.Possibly related, for context:
Brought up to the ready-for-review standard (#1454): the checklist's Everyone list has two new boxes, added here from what this PR's description and comments show (please check they match what you know).
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.