Skip to content

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

Open
hyperpolymath wants to merge 1 commit into
mainfrom
fix/empty-linter-pattern-never-matched
Open

fix(ci): the invisible-character gate never matched anything#81
hyperpolymath wants to merge 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: 68e21cad-3e81-4c55-a4b7-0672a1cc4e94

📥 Commits

Reviewing files that changed from the base of the PR and between 16a3b70 and 85b685b.

📒 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
🔇 Additional comments (1)
.github/workflows/dogfood-gate.yml (1)

114-114: 🎯 Functional Correctness

No separate leading-BOM check is required for this pattern.

grep -aPrl '\x{feff}' matches both a leading UTF-8 BOM (EF BB BF) and an embedded BOM. grep does not remove the leading BOM before matching.


📝 Walkthrough

Summary by CodeRabbit

  • Bug Fixes
    • Improved detection of empty or invisible characters, including Unicode characters.
    • Enhanced scanning reliability for binary and non-text content.

Walkthrough

The workflow now uses Unicode code-point patterns for invisible-character detection. It also uses binary-safe grep processing so files containing NUL characters are scanned.

Changes

Invisible-character gate

Layer / File(s) Summary
Unicode-aware gate scan
.github/workflows/dogfood-gate.yml
The pattern now uses Unicode code points and includes additional control characters. The scan uses grep -aPrl to process binary files as text.

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

Merge Risk: ⚪ Minimal · up to 85b68

This change corrects invisible-character detection in the workflow without introducing an actionable merge-blocking risk; it is merge-ready after normal checks and review.

Poem

A rabbit checks each hidden sign
Unicode marks now align
Binary files join the queue
The gate sees what it should do
Clean paths pass beneath the moon

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The change fixes the inline pattern in one dogfood-gate.yml file, including codepoint escapes, C0 controls, and grep -a. It does not satisfy all linked issue requirements because the compiled linter c… Apply the correction to all required dogfood-gate.yml copies. Add the corresponding C0-control support to stdlib/ByteDetector.affine and config.ncl. Add the separate byte-wise leading-BOM check. Confirm that the CI gate and compiled linter …
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the CI invisible-character gate defect and accurately summarises the main change.
Description check ✅ Passed The description is directly related to the changes. It explains the root cause, the pattern corrections, the C0 control coverage, and the use of grep -a.
Out of Scope Changes check ✅ Passed The two-line change is limited to the CI invisible-character gate and is directly related to the linked issue. No unrelated 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: Linked Issues check

Explanation

The change fixes the inline pattern in one dogfood-gate.yml file, including codepoint escapes, C0 controls, and grep -a. It does not satisfy all linked issue requirements because the compiled linter changes, separate leading-BOM check, and estate-wide copies are not present [#70].

Resolution

Apply the correction to all required dogfood-gate.yml copies. Add the corresponding C0-control support to stdlib/ByteDetector.affine and config.ncl. Add the separate byte-wise leading-BOM check. Confirm that the CI gate and compiled linter remain aligned [#70].

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 PR successfully fixes the invisible-character linting gate by transitioning to Unicode codepoint escapes and including C0 control characters. However, the regex pattern currently excludes several bidirectional control characters associated with the 'Trojan Source' vulnerability (CVE-2021-42574). Additionally, the use of find -exec ... \; is inefficient compared to the + variant, and silencing stderr may result in silent failures during PCRE execution. While Codacy indicates the PR is up to standards, the absence of automated test files containing prohibited characters makes it difficult to verify that the gate is operational and remains so in the future.

About this PR

  • The PR lacks automated regression tests. Consider adding a dummy file or a test step containing problematic characters (e.g., NBSP, Zero-Width Space) to the repository to verify that the gate correctly identifies and blocks them in CI.

Test suggestions

  • Verify detection of Non-Breaking Space (U+00A0)
  • Verify detection of C0 control characters (e.g., Backspace \x08)
  • Verify that files containing NUL bytes are scanned and not ignored as binary
  • Verify detection of Zero-Width Space (U+200B) and Word Joiner (U+2060)
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify detection of Non-Breaking Space (U+00A0)
2. Verify detection of C0 control characters (e.g., Backspace \x08)
3. Verify that files containing NUL bytes are scanned and not ignored as binary
4. Verify detection of Zero-Width Space (U+200B) and Word Joiner (U+2060)

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

Suggestion: Using -exec ... {} + is significantly more efficient than -exec ... {} \; because it reduces the number of grep processes spawned. The -r flag is redundant here as find passes specific file paths. Additionally, removing 2>/dev/null ensures that matching errors (like invalid UTF-8) are visible.

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

# non-breaking spaces, null bytes, and other invisible Unicode in source files.
set +e
PATTERNS='\xc2\xa0|\xe2\x80\x8b|\xe2\x80\x8c|\xe2\x80\x8d|\xef\xbb\xbf|\xc2\xad|\xe2\x80\x8e|\xe2\x80\x8f|\xe2\x80\xaa|\xe2\x80\xab|\xe2\x80\xac|\xe2\x80\xad|\xe2\x80\xae|\x00'
PATTERNS='\x00|[\x01-\x08\x0B\x0C\x0E-\x1F]|\x{a0}|\x{ad}|\x{200b}|\x{200c}|\x{200d}|\x{200e}|\x{200f}|\x{202a}|\x{202b}|\x{202c}|\x{202d}|\x{202e}|\x{2060}|\x{feff}'

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

Suggestion: This pattern list is missing several important bidirectional control characters used in Trojan Source attacks. Including these improves the security coverage of the invisible-character scan.

Suggested change
PATTERNS='\x00|[\x01-\x08\x0B\x0C\x0E-\x1F]|\x{a0}|\x{ad}|\x{200b}|\x{200c}|\x{200d}|\x{200e}|\x{200f}|\x{202a}|\x{202b}|\x{202c}|\x{202d}|\x{202e}|\x{2060}|\x{feff}'
PATTERNS='\x00|[\x01-\x08\x0B\x0C\x0E-\x1F]|\x{a0}|\x{ad}|\x{200b}|\x{200c}|\x{200d}|\x{200e}|\x{200f}|\x{202a}|\x{202b}|\x{202c}|\x{202d}|\x{202e}|\x{2066}|\x{2067}|\x{2068}|\x{2069}|\x{2060}|\x{feff}'

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