CI doesn't stop new silent failures: unexplained try?, catches that drop the error, ignored statuses, sleeps on the main thread
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 52/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- ci-cd, testing-qa
Research direction
Start by reading the existing scripts/eq-mic-permission-audit.sh, scripts/audit-localization.sh, and the "Static audits" CI job, then inspect how make test runs checks. Add scripts/audit-error-handling.sh with a baseline and fixture tests under scripts/tests/, and extend the microphone audit to SpotiglassEQDriver/. Done means each of the six rules rejects new violations with a file, line, and rule message, the baseline cannot go stale, and CONTRIBUTING.md explains the rules.
Written by the indexing model from the issue text.
Description
The issues from this audit (#593, #595, #596, #597, #598, #599, #602, #604) mostly come from a handful of patterns repeated across the app. Fixing each place won't stop the next one. I want CI to fail when a new one goes in, the same way eq-mic-permission-audit.sh and audit-localization.sh already guard their areas in the "Static audits" job.
What's on main today (counted on 02efbfc0)
- 213
try?inSpotiglass/, about 20 with a reason next to them (Services 45, Browsing 45, Playback 38, Settings 19, Views 14, CommandPalette 14, Infrastructure 12, Utilities 11, Persistence 9). Several of these are the bugs above:try? cache.loadPinnedItems(#597),try? settingsStore.mutate(#597),try? connectPlayer(#598),(try? await libraryPlaylists(...)) ?? [](#596). - 121 of 209
catchblocks neither log nor rethrow. - Ignored statuses:
guard status == noErr else { return }with no log (PlaybackSessionViewModel+MacAudioOutput.swift:40-42),(void)AudioObjectSetPropertyDatain the driver (SpotiglassEQPlugin.cpp:504-568, #605). Thread.sleepand semaphore waits reachable from@MainActor(6 in the equalizer code, #604).error.localizedDescriptionput straight into text the user sees (4: SpotiglassSettingsStore.swift:117, :522, EqualizerSettingsView.swift:80, :461).- The microphone audit only scans
Spotiglass SpotiglassTests(eq-mic-permission-audit.sh:25-27), notSpotiglassEQDriver/, though EQRouter.cpp:15-19 says it covers that file. - No
print/NSLogtoday, which is good; nothing keeps it that way.
Proposal
One new script, scripts/audit-error-handling.sh, run in "Static audits" and by make test, with a checked-in baseline (scripts/error-handling-baseline.json, like periphery-baseline.json) so today's sites don't block anyone but no new ones get in, and the baseline only shrinks:
try?needs a reason comment on the same or previous line (// try?: best-effort cleanup, nothing depends on it).- A
catchmust log (SpotiglassLog), rethrow, or hand the error to the shared failure path (the "one way to log and show errors" issue). An emptycatch {}always fails. - No
print(,NSLog(,debugPrint(in app, helper or driver code (driver debug logging behindSPOTIGLASS_EQ_DEBUGis allowlisted). - No
Thread.sleep,usleeporDispatchSemaphore.waitinSpotiglass/outside an allowlist. - No
localizedDescriptionassigned to a user-visible property (only insideSpotiglassLogcalls). - No
(void)on anOSStatus-returning Core Audio call inSpotiglassEQDriver/, and no_ = AudioObject...in Swift.
And:eq-mic-permission-audit.shalso scansSpotiglassEQDriver/(with the two existingkAudioObjectPropertyScopeInputuses in SpotiglassEQPlugin.cpp reviewed and allowlisted by line content, not line number).
A test in scripts/tests/ feeds the script a small fixture for each rule and checks it fails, and that the baseline doesn't let a new site through.
Done means
scripts/audit-error-handling.shexists, runs in CI "Static audits" and inmake test, and fails on each of rules 1-6 for new code, with a one-line message naming the file, line and rule.- The baseline lists today's sites; fixing one removes it from the baseline (the script fails if a baseline entry no longer exists, so it can't go stale).
- The mic audit covers the driver.
- CONTRIBUTING.md has two lines on the rules and how to write the reason comment.
- Dominant language
- Swift
- Stars
- 9
- Forks
- 3
- Avg merge
- 5h 37m
- Merged PRs (30d)
- 111
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 isaaclins/wax
-
bug priority:low status:queued
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
enhancement good first issue priority:low
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
bug good first issue localization priority:low
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
bug good first issue localization priority:low
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
haacked/switchboard#420 ·
Maintainers usually reply within 1 day
-
area: sidebar enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
ZigaoWang/zigzag#351 · 1 comment ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
manaflow-ai/cmux#46584 ·
Maintainers usually reply within 1 day
-
android:core ios:core
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day