A failed Engine.ini revert forgets its record and cannot be retried

Open
#72 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
62/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
cpp
Domain
desktop

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

area: launcher area: ray-reconstruction bug

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 RevertRrConfig return a bool. Clear m.rrconfig only on success.
  • On uninstall with a failed revert, keep the record and rr-config\ (as keepBackup does) 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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from phantoslayer21/wronggpu

All issues in phantoslayer21/wronggpu

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.