Skip to content

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

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#96
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: 6a4919cb-33b4-4454-b422-4fdadf3ddb21

📥 Commits

Reviewing files that changed from the base of the PR and between 1bc33c7 and d39bf89.

📒 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. (29)
  • GitHub Check: Gitar
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: governance / Allowlist Preflight
  • GitHub Check: governance / Well-Known (RFC 9116 + RSR)
  • GitHub Check: governance / Licence consistency
  • GitHub Check: check
  • GitHub Check: governance / Guix packaging policy (Nix retired)
  • GitHub Check: governance / Workflow security linter
  • GitHub Check: governance / Check Workflow Staleness
  • GitHub Check: governance / Trusted-base reduction policy
  • GitHub Check: governance / Code quality + docs
  • GitHub Check: scan / gitleaks
  • GitHub Check: governance / Security policy checks
  • GitHub Check: scan / shell-secrets
  • GitHub Check: governance / Language / package anti-pattern policy
  • GitHub Check: scan / rust-secrets
  • GitHub Check: scan / Hypatia Neurosymbolic Analysis
  • GitHub Check: Runtime Policy
  • GitHub Check: check
  • GitHub Check: lint
  • GitHub Check: Validate K9 contracts
  • GitHub Check: Groove manifest check
  • GitHub Check: Empty-linter (invisible characters)
  • GitHub Check: lint-workflows
  • GitHub Check: docs
  • GitHub Check: antipattern-check
  • GitHub Check: Validate A2ML manifests
  • GitHub Check: analyze (actions, none)
  • GitHub Check: lint-workflows
🔇 Additional comments (2)
.github/workflows/dogfood-gate.yml (2)

132-132: LGTM!


143-143: LGTM!


📝 Walkthrough

Summary by CodeRabbit

  • Bug Fixes
    • Improved invisible-character detection during automated checks.
    • Added detection for additional control and bidirectional text characters.
    • Scanning now handles binary files consistently.

Walkthrough

The workflow now detects invisible characters with Unicode code-point escapes, including control and bidi-control characters. Its grep scan treats binary files as text.

Changes

Invisible-character gate

Layer / File(s) Summary
Pattern and scan updates
.github/workflows/dogfood-gate.yml
The pattern uses Unicode code-point escapes and includes additional control and bidi-control characters. The grep scan uses -a for binary files.

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

Merge Risk: ⚪ Minimal · up to d39bf

This narrowly corrects the invisible-character check in one workflow file; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: metadatastician

Poem

A rabbit checks each hidden mark,
And scans the files from light to dark.
Code points hop in tidy rows,
Bidi shadows lose their shows.
Binary pages join the queue,
The gate now sees what once slipped through.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The changes implement codepoint escapes, C0 control detection, bidi-control detection, and grep -a as required by issue [#70]. However, the linked issue also specifies a separate leading-BOM check, wh… Add the separate byte-wise leading-BOM check required by issue [#70], or provide explicit evidence that this repository does not require that companion check.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: fixing the CI invisible-character gate.
Description check ✅ Passed The description directly explains the gate failure, root cause, implemented fixes, and verification.
Out of Scope Changes check ✅ Passed The changes are limited to the invisible-character detection logic in .github/workflows/dogfood-gate.yml and are related to issue [#70].
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 changes implement codepoint escapes, C0 control detection, bidi-control detection, and grep -a as required by issue [#70]. However, the linked issue also specifies a separate leading-BOM check, which is not shown in this pull request.

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 addresses the logic gaps in the invisible-character gate; however, the chosen implementation of using Unicode codepoint escapes (\x{...}) presents a significant reliability risk.

While Codacy reports the PR is up to standards, technical analysis suggests that the interaction between grep -P, the -a (text) flag, and files containing null bytes may force the PCRE engine into a non-UTF-8 mode. If this occurs, the Unicode escapes will cause an internal error. Since stderr is redirected to /dev/null, the CI gate will appear to pass successfully even if forbidden characters are present in the codebase.

It is recommended to revert to hex-encoded UTF-8 byte sequences to ensure the linter functions correctly across all file types without relying on the PCRE engine's UTF mode state.

Test suggestions

  • Detection of Non-Breaking Space (U+00A0) using codepoint escape
  • Detection of Zero-Width Space (U+200B) using codepoint escape
  • Detection of C0 control characters (e.g., Backspace \x08)
  • Scanning files containing NUL bytes without skipping them as binary
  • Detection of Byte Order Mark (BOM, U+FEFF)

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

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

🔴 HIGH RISK

The Unicode escape sequences (e.g., \x{200b}) are likely to cause grep -P to fail when the -a flag is used or when null bytes are encountered, as the PCRE engine may not be in UTF-8 mode. Because stderr is redirected to /dev/null, this error will be hidden and the check will silently 'pass' without actually scanning the files. It is safer to use UTF-8 hex byte sequences to ensure compatibility.

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]|\xc2\xa0|\xc2\xad|\xe2\x80\x8b|\xe2\x80\x8c|\xe2\x80\x8d|\xe2\x80\x8e|\xe2\x80\x8f|\xe2\x80\xaa|\xe2\x80\xab|\xe2\x80\xac|\xe2\x80\xad|\xe2\x80\xae|\xe2\x81\xa0|\xef\xbb\xbf'

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

⚪ LOW RISK

Nitpick: The -r flag is redundant here because find is already handling the file traversal. Also, consider using + instead of \; to execute grep once for multiple files, which significantly improves performance in large repositories.

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

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