WIP: fix(menu): a bug report whose report.txt could not be written out is not shown as saved #1170

Draft
TrashPanda wants to merge 1 commit from TrashPanda/Longshot:fix/bug-report-save-errors into main
Contributor

Type: fix · Risk: low · Tested on: Linux, RTX 4070 Ti (game-free checks) · Needs: none

Why

On a full disk, "Report a bug" showed the report as saved while its report.txt was cut short or empty: the write only filled a buffer, and the close that failed was not checked.

Restored from Hookshot 2948, by jarynclouatre, and split out of #286 so it can be reviewed and merged on its own.

How to reproduce

Seen on: Linux (a full disk, or report.txt pointed at /dev/full)
Settings and switches: defaults
Steps: save a bug report from the Insert menu
Expected: the menu says it could not be written
Actual: the menu says it was saved

What changed

bug_report::write in gpu/vk/vk_bug_report.cpp counts a failed fclose as a failed write, so the report ends with the existing "report.txt could not be written" reason.

Commits, each with its original author and message:

656f4a16 fix(menu): a bug report whose report.txt could not be written out is not shown as saved (jarynclouatre)

"Report a bug" in the Insert menu checked report.txt's write by
fwrite's count only and dropped fclose's result. On a full disk the
write only fills the stream's buffer and succeeds; the close is what
fails. The menu then showed the report as saved, and the folder held a
cut or empty report.txt.

bug_report::write in gpu/vk/vk_bug_report.cpp counts a failed
fclose as a failed write, so the report ends with the existing
"report.txt could not be written" reason.

  • tests/test_bug_report.py, new case (Linux, where /dev/full
    exists): the driver points the report folder's report.txt at /dev/full
    before it is written; the report is not shown as saved and the log gives
    the reason. It fails on main (the report shows as saved) and passes
    here.
  • Full suite on Linux: 442 passed, 85 skipped, 1 failed
    (test_bake_portability: zstandard is not installed on this machine;
    it fails the same on main).
  • Not tested on Windows.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2948

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 @ 656f4a16: tests/test_bug_report.py pass. 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 full disk in the game; Windows. Opened as work in progress until it runs in the game.

Must be tested:

  • None: the check covers the failing close

Risks

What could break: the bug report's save.

Turning it off: revert the commit.

Compatibility: Nothing changes.

Checklist

Everyone

  • One topic.
  • The title is a Conventional Commit (type(scope): description) of the status line's type.
  • Why gives the reason plainly and links the issues that fit (the tracker searched).
  • Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what
    can't be run by hand is in Testing's Not testable by hand, with why.
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and
    in Risks.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main.
  • No game files, dumps, build output or generated files.
  • third_party/ untouched (a new folder with a PROVENANCE.md instead).
  • The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named).

When it applies

  • A game-free test added for the fix, failing on main and passing here.
**Type:** fix · **Risk:** low · **Tested on:** Linux, RTX 4070 Ti (game-free checks) · **Needs:** none ## Why On a full disk, "Report a bug" showed the report as saved while its report.txt was cut short or empty: the write only filled a buffer, and the close that failed was not checked. Restored from [Hookshot 2948](https://github.com/NotRexed/Hookshot/pull/2948), by jarynclouatre, and split out of [#286](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/286) so it can be reviewed and merged on its own. ## How to reproduce **Seen on:** Linux (a full disk, or report.txt pointed at /dev/full) **Settings and switches:** defaults **Steps:** save a bug report from the Insert menu **Expected:** the menu says it could not be written **Actual:** the menu says it was saved ## What changed `bug_report::write` in `gpu/vk/vk_bug_report.cpp` counts a failed `fclose` as a failed write, so the report ends with the existing "report.txt could not be written" reason. Commits, each with its original author and message: <details><summary><code>656f4a16</code> fix(menu): a bug report whose report.txt could not be written out is not shown as saved (jarynclouatre)</summary> "Report a bug" in the Insert menu checked report.txt's write by `fwrite`'s count only and dropped `fclose`'s result. On a full disk the write only fills the stream's buffer and succeeds; the close is what fails. The menu then showed the report as saved, and the folder held a cut or empty report.txt. `bug_report::write` in `gpu/vk/vk_bug_report.cpp` counts a failed `fclose` as a failed write, so the report ends with the existing "report.txt could not be written" reason. - `tests/test_bug_report.py`, new case (Linux, where `/dev/full` exists): the driver points the report folder's report.txt at `/dev/full` before it is written; the report is not shown as saved and the log gives the reason. It fails on main (the report shows as saved) and passes here. - Full suite on Linux: 442 passed, 85 skipped, 1 failed (`test_bake_portability`: `zstandard` is not installed on this machine; it fails the same on main). - Not tested on Windows. Restored-from: https://github.com/NotRexed/Hookshot/pull/2948 </details> ## 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 @ 656f4a16: `tests/test_bug_report.py` pass. 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 full disk in the game; Windows. Opened as work in progress until it runs in the game. **Must be tested:** - None: the check covers the failing close ## Risks **What could break:** the bug report's save. **Turning it off:** revert the commit. **Compatibility:** Nothing changes. ## Checklist ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what can't be run by hand is in Testing's Not testable by hand, with why. - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and in Risks. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. - [ ] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). ### When it applies - [x] A game-free test added for the fix, failing on `main` and passing here.
fix(menu): a bug report whose report.txt could not be written out is not shown as saved
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 9s
656f4a166e
"Report a bug" in the Insert menu checked report.txt's write by
`fwrite`'s count only and dropped `fclose`'s result. On a full disk the
write only fills the stream's buffer and succeeds; the close is what
fails. The menu then showed the report as saved, and the folder held a
cut or empty report.txt.

`bug_report::write` in `gpu/vk/vk_bug_report.cpp` counts a failed
`fclose` as a failed write, so the report ends with the existing
"report.txt could not be written" reason.

- `tests/test_bug_report.py`, new case (Linux, where `/dev/full`
exists): the driver points the report folder's report.txt at `/dev/full`
before it is written; the report is not shown as saved and the log gives
the reason. It fails on main (the report shows as saved) and passes
here.
- Full suite on Linux: 442 passed, 85 skipped, 1 failed
(`test_bake_portability`: `zstandard` is not installed on this machine;
it fails the same on main).
- Not tested on Windows.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2948
Author
Contributor

Tested 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. No bug report was saved in this run, so the changed save path did not run; the check covers a report.txt that cannot be written.

Tested 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. No bug report was saved in this run, so the changed save path did not run; the check covers a report.txt that cannot be written.
Collaborator

Possibly related, for context:

  • PR #575 feat(reports): the local bug report lists what it holds and what it left out in manifest.json — Open bug-report writer change touches same code; overlapping report.txt output work.
Possibly related, for context: - PR #575 feat(reports): the local bug report lists what it holds and what it left out in manifest.json — Open bug-report writer change touches same code; overlapping report.txt output work.
Owner

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).

  • Tested on my own PC: ticked: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, though the changed save path did not run.
  • Nothing gets worse that I know of: ticked: Measurements gives a verdict of nothing to measure for a correctness fix, and Risks names no slower, latency or memory cost.
Brought up to the [ready-for-review standard](https://git.magicbean.dev/MagicBeanDev/Longshot/src/branch/main/CONTRIBUTING.md#ready-for-review-out-of-wip) (#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). - *Tested on my own PC*: ticked: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, though the changed save path did not run. - *Nothing gets worse that I know of*: ticked: Measurements gives a verdict of nothing to measure for a correctness fix, and Risks names no slower, latency or memory cost.
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 9s
This pull request is marked as a work in progress.
Some workflows are waiting to be reviewed.
This branch is out-of-date with the base branch
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'fix/bug-report-save-errors:TrashPanda-fix/bug-report-save-errors'
git switch 'TrashPanda-fix/bug-report-save-errors'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
MagicBeanDev/Longshot!1170
No description provided.