Ref/use new match syntax log

[AliiiBenn]

Summary by CodeRabbit

• New Features
  • More consistent success/error behavior across log endpoints for a smoother API experience.
• Bug Fixes
  • Invalid or inactive API keys now correctly return 403 responses.
  • Input sanitization added for API keys to prevent malformed requests.
• Refactor
  • Streamlined error handling in log endpoints to improve reliability and maintainability.
• Tests
  • Added comprehensive tests for result handling to ensure predictable responses and robust error propagation.

[coderabbitai]

Walkthrough

Introduces Result.match pattern in utils, updates log routes to use match-based control flow with a helper to re-raise errors, tightens API key dependency with sanitization and active checks, and adds tests covering match behavior and edge cases.

Changes

Cohort / File(s)	Summary
Router refactor to match-based flow src/routers/log.py	Added _raise_error(error) helper. Refactored route handlers to use Result.match(on_success, on_error) instead of manual checks. Enhanced get_api_key_dep with input sanitization and active-status validation; returns 403 for invalid/inactive keys. Minor formatting adjustments.
Result.match feature src/utils/result.py	Added generic type R. Extended Result protocol with match(self, on_success, on_error) -> R. Implemented match in Ok and Err. Added module-level match(result=..., on_success=..., on_error=...). Updated Err.unwrap to raise the contained exception.
Tests for match API tests/test_match.py	New tests for module-level match and instance Result.match, including success/error paths, type variations, None handling, exception propagation, and return-shape consistency.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Client
  participant Router as Log Router
  participant Service as Domain Service
  participant Result as Result[T,E]
  participant Callbacks as on_success / on_error

  Client->>Router: HTTP request (e.g., create/update/get log)
  Router->>Service: invoke operation
  Service-->>Router: Result (Ok/Err)
  Router->>Result: match(on_success, on_error)
  activate Result
  alt Ok
    Result->>Callbacks: on_success(value)
    Callbacks-->>Router: Response payload
    Router-->>Client: 200/201 response
  else Err
    Result->>Callbacks: on_error(error)
    Callbacks-->>Router: raise error via _raise_error
    Router-->>Client: Error response (propagated)
  end
  deactivate Result

Loading

sequenceDiagram
  autonumber
  actor Client
  participant Dep as get_api_key_dep
  participant Store as DB Session

  Client->>Dep: Authorization: ApiKey <token>
  Dep->>Dep: sanitize/validate input
  Dep->>Store: lookup API key
  alt valid and active
    Store-->>Dep: APIKey
    Dep-->>Client: proceed (dependency resolves)
  else invalid or inactive
    Dep-->>Client: 403 Forbidden
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related issues

• Add match Function to Result Utility #15 — Implements the requested module-level match and Result.match in src/utils/result.py.
• Implement match Method for Result Utility #16 — Adds Result.match and updates log router to use the new API as described.
• Refactor log.py Router to Use New Match Syntax #18 — Refactors the same log routes to replace is_err()/unwrap() with match-based handling.

Poem

A rabbit taps keys with a gentle thrum,
Pattern-matching ready—here it comes! 🐇
Ok hops right, Err bounds left,
Clean little paths where bugs once crept.
Keys checked, logs flow, neat and bright—
Another tidy warren in the night.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 31.58% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly indicates that the pull request refactors log-related functionality to adopt the new match syntax, which is the primary focus of the changeset.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ref/use-new-match-syntax-log

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3d1f8b1 and a354513.

⛔ Files ignored due to path filters (3)

• src/utils/__pycache__/result.cpython-312.pyc is excluded by !**/*.pyc
• tests/__pycache__/__init__.cpython-312.pyc is excluded by !**/*.pyc
• tests/__pycache__/test_match.cpython-312-pytest-8.4.2.pyc is excluded by !**/*.pyc

📒 Files selected for processing (3)

• src/routers/log.py (14 hunks)
• src/utils/result.py (4 hunks)
• tests/test_match.py (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (3)

tests/test_match.py (1)

src/utils/result.py (3)

• Ok (18-47)
• Err (50-73)
• Result (9-15)

src/utils/result.py (1)

src/utils/maybe.py (2)

• map (20-26)
• bind (28-34)

src/routers/log.py (4)

src/core/log.py (8)

• get_logs_by_tag (242-269)
• create_log (18-53)
• get_logs_by_project (56-80)
• get_log_by_id (83-109)
• update_log (112-153)
• delete_log (156-177)
• get_logs_by_level (180-212)
• get_logs_by_category (215-239)

src/models/base.py (1)

• get_db (18-23)

src/models/api_key.py (1)

• APIKey (7-20)

src/utils/result.py (4)

• match (15-15)
• match (43-44)
• match (69-70)
• match (76-88)

🪛 Ruff (0.13.3)

tests/test_match.py

1-1: Shebang is present but file is not executable

(EXE001)

---

19-19: Unused lambda argument: e

(ARG005)

---

30-30: Unused lambda argument: e

(ARG005)

---

62-62: Unused lambda argument: e

(ARG005)

---

71-71: Unused lambda argument: e

(ARG005)

---

83-83: Unused lambda argument: e

(ARG005)

---

91-91: Unused lambda argument: x

(ARG005)

---

105-105: Unused lambda argument: x

(ARG005)

---

106-106: Unused lambda argument: e

(ARG005)

---

108-108: Avoid specifying long messages outside the exception class

(TRY003)

---

117-117: Unused lambda argument: x

(ARG005)

---

118-118: Unused lambda argument: e

(ARG005)

---

120-120: Avoid specifying long messages outside the exception class

(TRY003)

---

132-132: Unused lambda argument: e

(ARG005)

---

140-140: Unused lambda argument: e

(ARG005)

---

204-204: Do not catch blind exception: Exception

(BLE001)

---

221-221: Unused lambda argument: e

(ARG005)

---

229-229: Unused lambda argument: e

(ARG005)

---

237-237: Unused lambda argument: x

(ARG005)

src/utils/result.py

43-43: Unused method argument: on_error

(ARG002)

---

61-61: Create your own exception

(TRY002)

---

61-61: Avoid specifying long messages outside the exception class

(TRY003)

---

63-63: Unused method argument: f

(ARG002)

---

66-66: Unused method argument: f

(ARG002)

---

69-69: Unused method argument: on_success

(ARG002)

src/routers/log.py

74-74: Do not perform function call Depends in argument defaults; instead, perform the call within the function, or read the default from a module-level singleton variable

(B008)

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

Fix match() signature to accept the positional result argument

The helper is declared with a leading *, so result becomes keyword-only. Every new caller (e.g., tests/test_match.py, Line 16) passes the Result as a positional argument, causing TypeError: match() takes 0 positional arguments but 1 was given before any logic runs. This breaks all uses of the helper. Allow result to be positional (or update all call sites), e.g.:

-def match(*, result: Result[T, E], on_success: Callable[[T], R], on_error: Callable[[E], R]) -> R:
+def match(result: Result[T, E], *, on_success: Callable[[T], R], on_error: Callable[[E], R]) -> R:

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	def match(*, result: Result[T, E], on_success: Callable[[T], R], on_error: Callable[[E], R]) -> R:
	"""
	Functional pattern matching for Result objects.
	Args:
	result: The Result object to match against
	on_success: Function to call for success values
	on_error: Function to call for error values
	Returns:
	The result of calling either on_success or on_error
	"""
	return result.match(on_success, on_error)
	def match(result: Result[T, E], *, on_success: Callable[[T], R], on_error: Callable[[E], R]) -> R:
	"""
	Functional pattern matching for Result objects.
	Args:
	result: The Result object to match against
	on_success: Function to call for success values
	on_error: Function to call for error values
	Returns:
	The result of calling either on_success or on_error
	"""
	return result.match(on_success, on_error)

🤖 Prompt for AI Agents

In src/utils/result.py around lines 76 to 88, the match helper was defined with
a leading * which made result keyword-only, causing callers that pass the Result
positionally to raise a TypeError; change the signature so result is a
positional parameter and keep on_success/on_error as keyword-only (e.g., make
result the first parameter and use a single * before the keyword-only callbacks)
and then return result.match(on_success, on_error) as before.