A failed Engine.ini revert forgets its record and cannot be retried
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 62/100
Research direction
Start in clean/installer/src/wg_core/rrconfig.cpp at RevertRrConfig (about lines 352-398), where the catch block always resets m.rrconfig, then check the callers in launcher.cpp (around lines 797 and 827) and DoRestore in record.cpp (around lines 541 and 569-572). Make the revert return a bool and clear the record only on success, keeping rr-config\ on uninstall when the revert fails. Done means that, with Engine.ini held open without sharing, Off leaves m.rrconfig.present true and the backup folder in place. The issue notes it has not been reproduced, so confirm the locking behaviour first.
Written by the indexing model from the issue text.
Description
This was found by reading the code. It has not been reproduced.
What happens
RevertRrConfig (clean/installer/src/wg_core/rrconfig.cpp:352-398) catches SetupError, adds a warning, and then always runs m.rrconfig = RrConfigFix() (rrconfig.cpp:398). The callers save the cleared record (launcher.cpp:797, 827). On uninstall, DoRestore calls it (record.cpp:541) and then removes the state folder, including the rr-config\ backup (record.cpp:569-572).
After a failure the backup file is not deleted (the delete is inside the try), but the record no longer knows about it. A later "On" runs ApplyRrConfig with no fix present. It writes a new backup over the old one, taken from the file that still holds WrongGPU's line (rrconfig.cpp:322-327).
Smaller defect: SetReadOnly(file, false) runs before the write (rrconfig.cpp:369). If the write fails, the read-only attribute stays cleared even when the player had set it.
When it can happen
Unusual but innocent. Engine.ini must be held open without write sharing, or access must be denied, at the moment of Off or uninstall. Examples: a sync tool, an editor that locks files, an antivirus scan.
What is actually lost: the automatic retry and the read-only restore. The player's settings are not lost. The live Engine.ini still holds all of the player's content plus WrongGPU's one line. The backup is only used when removing the line would leave the file empty or the file has gone missing (rrconfig.cpp:375, 379-384). The warning tells the player to remove the line by hand (rrconfig.cpp:394-395). Low severity: one stray r.RayTracing… line, and perhaps a read-only flag to clear.
To do
- Have
RevertRrConfigreturn a bool. Clearm.rrconfigonly on success. - On uninstall with a failed revert, keep the record and
rr-config\(askeepBackupdoes) and add the warning. - Restore the read-only attribute if the write fails.
- Caution: a permanently broken Engine.ini path makes every later Off retry and warn. That is acceptable, and arguably correct.
Test
CPU-only. Point a fake game's documents folder at a temporary folder with an Engine.ini. Apply the fix. Hold the file open without sharing. Run Off. Assert m.rrconfig.present is still true and rr-config\ still exists.
- Dominant language
- C++
- Stars
- 12
- Forks
- 2
- Avg merge
- 3h 10m
- Merged PRs (30d)
- 171
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from phantoslayer21/wronggpu
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
phantoslayer21/wronggpu#275 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
phantoslayer21/wronggpu#274 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
phantoslayer21/wronggpu#241 ·
Maintainers usually reply within 1 day
-
bug build
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
phantoslayer21/wronggpu#234 ·
Maintainers usually reply within 1 day
-
bug build
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
phantoslayer21/wronggpu#233 ·
Maintainers usually reply within 1 day
All issues in phantoslayer21/wronggpu
Similar issues
-
Difficulty 1/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
ReyeMe/SaturnRingLib#155 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Nheko-Reborn/nheko#2092 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
isocpp/CppCoreGuidelines#2345 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 71/100
ROCm/rocm-libraries#16108 ·
Maintainers usually reply within 2 days