cleveragents/cleveragents-core

Fork 3

BUG-HUNT: [type-safety] Type validation missing in redaction functions causes AttributeError on non-string inputs #7205

New issue

Open

opened 2026-04-10 08:54:45 +00:00 by HAL9000 · 3 comments

HAL9000 commented

2026-04-10 08:54:45 +00:00

Owner

Background and Context

The is_sensitive_key(key: str) and redact_value(value: str) functions in src/cleveragents/shared/redaction.py carry str type hints but perform no runtime type validation. When non-string types are passed (e.g. None, int, dict, list), both functions crash with an AttributeError because they immediately invoke string methods (.lower(), pattern.sub()) on the unvalidated input.

This violates the project's Fail-Fast Principles and Argument Validation mandate (CONTRIBUTING.md §"Error and Exception Handling"), which require all public functions to validate argument types as the first guard. The set_show_secrets() function in the same file already demonstrates the correct pattern (isinstance check → TypeError), but is_sensitive_key() and redact_value() do not follow it.

The redaction module is a cross-cutting utility called from the structlog processor chain, CLI output formatters, and error detail formatting. Any non-string value reaching these functions (e.g. an integer token count, a None default, or a nested dict that bypasses _redact_dict_inner's isinstance guards) will crash the application with an opaque AttributeError rather than a clear TypeError.

Current Behaviour

# is_sensitive_key — crashes on non-string input
is_sensitive_key(None)   # AttributeError: 'NoneType' object has no attribute 'lower'
is_sensitive_key(42)     # AttributeError: 'int' object has no attribute 'lower'
is_sensitive_key({})     # AttributeError: 'dict' object has no attribute 'lower'

# redact_value — crashes on non-string input
redact_value(None)       # returns None (falsy guard passes), but type hint is violated
redact_value(42)         # AttributeError: expected string or bytes-like object (pattern.sub)
redact_value({"k": "v"})# AttributeError: expected string or bytes-like object (pattern.sub)

Root cause in is_sensitive_key:

def is_sensitive_key(key: str) -> bool:
    if not key:
        return False
    lower = key.lower()  # AttributeError if key is not a string
    ...

Root cause in redact_value:

def redact_value(value: str) -> str:
    if not value:
        return value          # silently returns non-string on falsy input
    result = value
    for pattern in patterns:
        result = pattern.sub(REDACTED, result)  # TypeError/AttributeError on non-string
    return result

Expected Behaviour

Both functions should validate their input type at the entry point and raise an informative TypeError — consistent with set_show_secrets() in the same module and the project's fail-fast principle:

def is_sensitive_key(key: str) -> bool:
    if not isinstance(key, str):
        raise TypeError(f"key must be str, got {type(key).__name__}")
    ...

def redact_value(value: str) -> str:
    if not isinstance(value, str):
        raise TypeError(f"value must be str, got {type(value).__name__}")
    ...

Acceptance Criteria

is_sensitive_key() raises TypeError with a descriptive message when passed a non-str argument.
redact_value() raises TypeError with a descriptive message when passed a non-str argument.
Both functions continue to behave identically for all valid str inputs (including empty strings).
BDD scenarios cover: None, int, dict, list, and valid str inputs for both functions.
All nox stages pass; coverage ≥ 97%.

Supporting Information

File: src/cleveragents/shared/redaction.py
Functions: is_sensitive_key() (line ~107) and redact_value() (line ~125)
Reference pattern: set_show_secrets() in the same file already implements the correct isinstance guard.
Specification: CONTRIBUTING.md §"Fail-Fast Principles" — "Type Safety, Early Validation, Assertions, No Silent Failures, Explicit Over Implicit."
Related issues: #6716 (show_secrets not wired), #6678 (incomplete pattern coverage), #7062 (circular reference in _redact_dict_inner)

Metadata

Branch: bugfix/m3-type-safety-redaction-missing-type-validation
Commit Message: fix(redaction): add isinstance type guards to is_sensitive_key and redact_value to raise TypeError on non-string inputs
Milestone: v3.2.0
Parent Epic: #5502

Subtasks

Add isinstance(key, str) guard to is_sensitive_key() raising TypeError on failure
Add isinstance(value, str) guard to redact_value() raising TypeError on failure
Write BDD scenario tagged @tdd_issue, @tdd_issue_<N>, @tdd_expected_fail reproducing the AttributeError for each function
Verify all existing is_sensitive_key and redact_value call sites pass str values (audit src/)
Run nox -s typecheck to confirm Pyright strict compliance
Run nox -s unit_tests and nox -s coverage_report — coverage ≥ 97%

Definition of Done

is_sensitive_key(None) raises TypeError: key must be str, got NoneType
redact_value(42) raises TypeError: value must be str, got int
All existing call sites confirmed to pass str values
BDD scenarios added covering non-string inputs for both functions
@tdd_expected_fail tag removed from TDD scenarios after fix is applied
All nox stages pass
Coverage >= 97%

Automated by CleverAgents Bot
Supervisor: Acting on behalf of: Bug Hunter | Agent: new-issue-creator

## Background and Context The `is_sensitive_key(key: str)` and `redact_value(value: str)` functions in `src/cleveragents/shared/redaction.py` carry `str` type hints but perform **no runtime type validation**. When non-string types are passed (e.g. `None`, `int`, `dict`, `list`), both functions crash with an `AttributeError` because they immediately invoke string methods (`.lower()`, `pattern.sub()`) on the unvalidated input. This violates the project's **Fail-Fast Principles** and **Argument Validation** mandate (CONTRIBUTING.md §"Error and Exception Handling"), which require all public functions to validate argument types as the first guard. The `set_show_secrets()` function in the same file already demonstrates the correct pattern (`isinstance` check → `TypeError`), but `is_sensitive_key()` and `redact_value()` do not follow it. The redaction module is a cross-cutting utility called from the structlog processor chain, CLI output formatters, and error detail formatting. Any non-string value reaching these functions (e.g. an integer token count, a `None` default, or a nested dict that bypasses `_redact_dict_inner`'s `isinstance` guards) will crash the application with an opaque `AttributeError` rather than a clear `TypeError`. ## Current Behaviour ```python # is_sensitive_key — crashes on non-string input is_sensitive_key(None) # AttributeError: 'NoneType' object has no attribute 'lower' is_sensitive_key(42) # AttributeError: 'int' object has no attribute 'lower' is_sensitive_key({}) # AttributeError: 'dict' object has no attribute 'lower' # redact_value — crashes on non-string input redact_value(None) # returns None (falsy guard passes), but type hint is violated redact_value(42) # AttributeError: expected string or bytes-like object (pattern.sub) redact_value({"k": "v"})# AttributeError: expected string or bytes-like object (pattern.sub) ``` Root cause in `is_sensitive_key`: ```python def is_sensitive_key(key: str) -> bool: if not key: return False lower = key.lower() # AttributeError if key is not a string ... ``` Root cause in `redact_value`: ```python def redact_value(value: str) -> str: if not value: return value # silently returns non-string on falsy input result = value for pattern in patterns: result = pattern.sub(REDACTED, result) # TypeError/AttributeError on non-string return result ``` ## Expected Behaviour Both functions should validate their input type at the entry point and raise an informative `TypeError` — consistent with `set_show_secrets()` in the same module and the project's fail-fast principle: ```python def is_sensitive_key(key: str) -> bool: if not isinstance(key, str): raise TypeError(f"key must be str, got {type(key).__name__}") ... def redact_value(value: str) -> str: if not isinstance(value, str): raise TypeError(f"value must be str, got {type(value).__name__}") ... ``` ## Acceptance Criteria - `is_sensitive_key()` raises `TypeError` with a descriptive message when passed a non-`str` argument. - `redact_value()` raises `TypeError` with a descriptive message when passed a non-`str` argument. - Both functions continue to behave identically for all valid `str` inputs (including empty strings). - BDD scenarios cover: `None`, `int`, `dict`, `list`, and valid `str` inputs for both functions. - All nox stages pass; coverage ≥ 97%. ## Supporting Information - **File**: `src/cleveragents/shared/redaction.py` - **Functions**: `is_sensitive_key()` (line ~107) and `redact_value()` (line ~125) - **Reference pattern**: `set_show_secrets()` in the same file already implements the correct `isinstance` guard. - **Specification**: CONTRIBUTING.md §"Fail-Fast Principles" — *"Type Safety, Early Validation, Assertions, No Silent Failures, Explicit Over Implicit."* - **Related issues**: #6716 (show_secrets not wired), #6678 (incomplete pattern coverage), #7062 (circular reference in `_redact_dict_inner`) --- ## Metadata - **Branch**: `bugfix/m3-type-safety-redaction-missing-type-validation` - **Commit Message**: `fix(redaction): add isinstance type guards to is_sensitive_key and redact_value to raise TypeError on non-string inputs` - **Milestone**: v3.2.0 - **Parent Epic**: #5502 ## Subtasks - [ ] Add `isinstance(key, str)` guard to `is_sensitive_key()` raising `TypeError` on failure - [ ] Add `isinstance(value, str)` guard to `redact_value()` raising `TypeError` on failure - [ ] Write BDD scenario tagged `@tdd_issue`, `@tdd_issue_<N>`, `@tdd_expected_fail` reproducing the `AttributeError` for each function - [ ] Verify all existing `is_sensitive_key` and `redact_value` call sites pass `str` values (audit `src/`) - [ ] Run `nox -s typecheck` to confirm Pyright strict compliance - [ ] Run `nox -s unit_tests` and `nox -s coverage_report` — coverage ≥ 97% ## Definition of Done - [ ] `is_sensitive_key(None)` raises `TypeError: key must be str, got NoneType` - [ ] `redact_value(42)` raises `TypeError: value must be str, got int` - [ ] All existing call sites confirmed to pass `str` values - [ ] BDD scenarios added covering non-string inputs for both functions - [ ] `@tdd_expected_fail` tag removed from TDD scenarios after fix is applied - [ ] All nox stages pass - [ ] Coverage >= 97% --- **Automated by CleverAgents Bot** Supervisor: Acting on behalf of: Bug Hunter | Agent: new-issue-creator

HAL9000 added this to the v3.2.0 milestone

2026-04-10 08:54:59 +00:00

HAL9000 added a new dependency

2026-04-10 08:55:01 +00:00

#5502 EPIC: Actor Execution & Configuration — GRAPH Actor, Config Schema & CLI Compliance (v3.5.0)

HAL9000 added the

labels

2026-04-10 08:55:26 +00:00

HAL9000 referenced this issue

2026-04-10 09:24:40 +00:00

[AUTO-BUG-HUNT] Worker worker-shared-1 Completed #7224

HAL9000 referenced this issue

2026-04-10 18:46:12 +00:00

[AUTO-IMP-SUP] Implementation Pool Status (Cycle 1) #7386

HAL9000 added

and removed

labels

2026-04-14 06:24:00 +00:00

HAL9000 commented

2026-04-14 06:24:00 +00:00

Author

Owner

✅ Verified — Critical type safety bug: missing validation in redaction functions causes AttributeError. MoSCoW: Must-have. Priority: Critical.

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner-pool-supervisor

✅ **Verified** — Critical type safety bug: missing validation in redaction functions causes AttributeError. MoSCoW: Must-have. Priority: Critical. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner-pool-supervisor

HAL9000 commented

2026-04-14 06:29:38 +00:00

Author

Owner

✅ Verified — Critical type safety bug: missing validation in redaction functions causes AttributeError. MoSCoW: Must-have. Priority: Critical.

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner-pool-supervisor