Skip to content

fix(ci): the invisible-character gate never matched anything - #78

Merged
hyperpolymath merged 1 commit into
mainfrom
fix/empty-linter-pattern-never-matched
Aug 27, 2026
Merged

fix(ci): the invisible-character gate never matched anything#78
hyperpolymath merged 1 commit into
mainfrom
fix/empty-linter-pattern-never-matched

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Measured 2026-08-27: this gate caught 0 of 6 invisible-character test cases. It has never detected an NBSP, zero-width space, BOM, soft hyphen, bidi override or word joiner.

Root cause

The pattern used UTF-8 byte sequences (\xc2\xa0) while grep -P matches characters. Bytes c2 a0 are one character U+00A0; \xc2\xa0 asks for two, U+00C2 then U+00A0 — never present.

grep -P '\xc2\xa0'  ->  miss
grep -P '\x{a0}'    ->  MATCH

Only \x00 worked, being single-byte in both readings. The gate ran, passed, and could not see what it exists to see.

Fixed

  • codepoint escapes in place of byte sequences
  • C0 controls \x01-\x08,\x0B,\x0C,\x0E-\x1F added (TAB/LF/CR excluded)
  • grep -a — without it grep skips any NUL-bearing file as binary

The C0 range matters: a stray backspace byte made a workflow unparseable in developer-ecosystem, so it never ran — and this linter called it clean.

Canonical fix: hyperpolymath/empty-linter#70. 1 file(s) here.

Verified: YAML re-parsed, and the corrected pattern was confirmed to catch a real NBSP before the change was kept.

MEASURED 2026-08-27: this gate's pattern caught 0 OF 6 invisible-character test
cases. It has never detected an NBSP, zero-width space, BOM, soft hyphen, bidi
override or word joiner.

ROOT CAUSE: the pattern used UTF-8 BYTE sequences (\xc2\xa0) while grep -P
matches CHARACTERS. Bytes c2 a0 are ONE character U+00A0; \xc2\xa0 asks for TWO
characters, U+00C2 then U+00A0, which is never present.

  grep -P '\xc2\xa0'  ->  miss
  grep -P '\x{a0}'    ->  MATCH

Only \x00 worked, being single-byte in both readings.

FIXED: codepoint escapes; C0 control characters \x01-\x08,\x0B,\x0C,\x0E-\x1F
added (TAB/LF/CR excluded); and grep -a, without which grep skips any NUL-bearing
file as binary.

The C0 range matters: a stray BACKSPACE byte made a workflow unparseable in
developer-ecosystem, so it never ran, and this linter called it clean.

Canonical fix: hyperpolymath/empty-linter#70. 1 file(s) here.
VERIFIED: YAML re-parsed, and the corrected pattern was confirmed to catch a real
NBSP before the change was kept.
@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 785d2d55-c3ad-4994-849e-48c8064cc9b3

📥 Commits

Reviewing files that changed from the base of the PR and between 3034b06 and 01a356e.

📒 Files selected for processing (1)
  • .github/workflows/dogfood-gate.yml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (25)
  • GitHub Check: Gitar
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: scan / rust-secrets
  • GitHub Check: governance / Guix primary / Nix fallback policy
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Security policy checks
  • GitHub Check: governance / Licence consistency
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: rust-ci / Detect Cargo.toml
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Groove manifest check
  • GitHub Check: openssf-compliance
  • GitHub Check: analyze (actions, none)
  • GitHub Check: Patch Bridge CVE triage
  • GitHub Check: Hypatia neurosymbolic scan
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: panic-attack assail
🔇 Additional comments (1)
.github/workflows/dogfood-gate.yml (1)

116-116: 🎯 Functional Correctness

The leading-BOM failure is not established. GNU grep 3.8 exits with status 2 (character code point value in \x{} or \o{} is too large) before matching either leading or interior BOMs. The applicable ubuntu-latest grep behaviour is not established.


📝 Walkthrough

Summary by CodeRabbit

  • Bug Fixes
    • Improved detection of empty or invisible characters during validation.
    • Enhanced compatibility with Unicode text and binary-safe scanning.

Walkthrough

The workflow now detects invisible characters with Unicode code-point patterns. It also uses grep -a so files containing NUL characters remain eligible for scanning.

Changes

Invisible-character gate

Layer / File(s) Summary
Unicode-safe scan pattern and command
.github/workflows/dogfood-gate.yml
The invisible-character pattern uses explicit Unicode code-point escapes and includes additional control and formatting characters. The recursive Perl-compatible grep scan now uses -a while retaining filename-only output.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: 🔵 Low · up to 01a35

The workflow’s invisible-character check is corrected for several Unicode cases, but its BOM pattern may make the check exit with an error instead of matching BOMs on the CI runner. The PR is otherwise localized and mergeable with explicit owner verification of BOM handling.

Poem

A rabbit checks each code point bright
The hidden marks now come to light
grep -a reads through bytes in line
Unicode patterns match and shine
The gate now spots what stayed unseen

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The change addresses codepoint escapes, C0 controls, and grep -a for [#70]. However, the linked issue also requires a separate leading-BOM check, consistency with the compiled linter, verification of … Add the separate leading-BOM check, update the compiled linter and related configuration where applicable, apply the corrected pattern to all required estate copies, and provide evidence for the required detection and non-regression cases, …
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly states that the CI invisible-character gate is fixed. It is concise and directly related to the main change.
Description check ✅ Passed The description explains the root cause, the implemented changes, and verification results. It does not follow the repository template headings or complete the required checklist, but it provides suff…
Out of Scope Changes check ✅ Passed The reported change is limited to the CI invisible-character gate and remains within the scope of [#70]. No unrelated code or configuration changes are shown.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Description check

Explanation

The description explains the root cause, the implemented changes, and verification results. It does not follow the repository template headings or complete the required checklist, but it provides sufficient technical context.

Full details: Linked Issues check

Explanation

The change addresses codepoint escapes, C0 controls, and grep -a for [#70]. However, the linked issue also requires a separate leading-BOM check, consistency with the compiled linter, verification of a backspace-corrupted workflow, and applying the correction across the estate. The summary shows only one workflow file changed, so these requirements are not demonstrated.

Resolution

Add the separate leading-BOM check, update the compiled linter and related configuration where applicable, apply the corrected pattern to all required estate copies, and provide evidence for the required detection and non-regression cases, including the backspace-corrupted workflow, clean files, and legitimate whitespace.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sonarqubecloud

Copy link
Copy Markdown

@gitar-bot

gitar-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown

Important

You are using the Gitar free plan. Upgrade to unlock code review, CI analysis, auto-apply, custom automations, and more.

Gitar

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

The pull request successfully updates the invisible-character gate to use Unicode codepoint escapes and expands the detection range to include C0 control characters. These changes resolve the immediate issue of the gate failing to match intended characters.

However, a significant risk remains: using grep -P with Unicode escapes can cause the command to fail silently when encountering files with invalid UTF-8 sequences. Since stderr is redirected to /dev/null, these files will bypass the check entirely. Additionally, the current implementation is inefficient for large repositories as it spawns a new process for every file.

Finally, while the fix was verified locally, the lack of automated regression tests within the repository makes this gate vulnerable to future regressions.

About this PR

  • Regression tests for the invisible-character detection are currently missing from the repository. To prevent future regressions and ensure the gate remains functional, consider adding a set of test files containing the targeted invisible and control characters to the test suite.

Test suggestions

  • Verify detection of Non-Breaking Space (U+00A0) using codepoint escape
  • Verify detection of Zero-Width Space (U+200B) using codepoint escape
  • Verify detection of C0 control character like Backspace (\x08)
  • Verify that a file containing a NUL byte (\x00) is processed and the byte is detected instead of the file being skipped
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify detection of Non-Breaking Space (U+00A0) using codepoint escape
2. Verify detection of Zero-Width Space (U+200B) using codepoint escape
3. Verify detection of C0 control character like Backspace (\x08)
4. Verify that a file containing a NUL byte (\x00) is processed and the byte is detected instead of the file being skipped

TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback

-o -name '*.idr' -o -name '*.zig' -o -name '*.v' -o -name '*.jl' \
-o -name '*.gleam' -o -name '*.hs' -o -name '*.ml' -o -name '*.sh' \) \
-exec grep -Prl "$PATTERNS" {} \; > /tmp/empty-lint-results.txt 2>/dev/null
-exec grep -aPrl "$PATTERNS" {} \; > /tmp/empty-lint-results.txt 2>/dev/null

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 MEDIUM RISK

This command has logic and performance issues. Using grep -P with Unicode escapes causes grep to fail on files containing invalid UTF-8 sequences; because 2>/dev/null is used, these failures are silent and the files bypass the gate. Furthermore, the -r flag is redundant when find provides paths, and using + instead of \; significantly improves performance.

Consider using byte-based patterns (e.g., \xc2\xa0) with LC_ALL=C to ensure all files are scanned regardless of encoding:

Suggested change
-exec grep -aPrl "$PATTERNS" {} \; > /tmp/empty-lint-results.txt 2>/dev/null
-exec grep -aPl "$PATTERNS" {} + > /tmp/empty-lint-results.txt 2>/dev/null

@hyperpolymath
hyperpolymath merged commit 4fafa37 into main Aug 27, 2026
34 of 37 checks passed
@hyperpolymath
hyperpolymath deleted the fix/empty-linter-pattern-never-matched branch August 27, 2026 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant