Propagate JSON unmarshal errors in type conversion functions #24

Mischulee · 2025-12-18T10:12:57Z

https://issues.redhat.com/browse/HYPERFLEET-300

Summary by CodeRabbit

Bug Fixes
- Improved error handling when presenting cluster, node pool, and adapter status data.
- Errors from data serialization are now properly surfaced instead of being silently ignored.
Tests
- Added test coverage for data serialization failure scenarios.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-18T10:13:08Z

Walkthrough

This PR introduces consistent error handling to presenter functions across the API layer. The functions PresentAdapterStatus, PresentCluster, and PresentNodePool were updated to return (value, error) tuples instead of single values. Each now validates JSON unmarshalling of critical fields (Conditions, Data, Metadata for adapters; Spec, Labels, StatusConditions for clusters and node pools) and propagates errors instead of silently ignoring failures. Corresponding handler functions in cluster, node pool, and adapter status management were updated to check for presentation errors and return GeneralError responses when presentation fails. All tests were updated to verify the new error return values and include additional test cases for malformed JSON scenarios.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Multiple presenter functions updated with identical error-handling pattern; verify consistency across all three (PresentAdapterStatus, PresentCluster, PresentNodePool)
Handler files (cluster.go, cluster_nodepools.go, cluster_status.go, node_pool.go, nodepool_status.go) all follow similar error-propagation patterns—confirm all call sites handle errors correctly
Test additions for malformed JSON scenarios across all presenter tests; validate coverage is comprehensive
Error messages and GeneralError wrapping—ensure consistency and clarity in user-facing error communications

Possibly related PRs

Implement Schema Validation for Cluster and NodePool Specifications #8: Directly modified the same presenter functions (PresentAdapterStatus, PresentCluster, PresentNodePool) to return error tuples and updated call sites to handle errors.

Suggested labels

error-handling, presenters, testing

Suggested reviewers

rh-amarin
yingzhanredhat

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main objective: propagating JSON unmarshal errors in type conversion functions (PresentAdapterStatus, PresentCluster, PresentNodePool, etc.).
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bb50b29 and 5416054.

📒 Files selected for processing (11)

pkg/api/presenters/adapter_status.go (3 hunks)
pkg/api/presenters/adapter_status_test.go (7 hunks)
pkg/api/presenters/cluster.go (2 hunks)
pkg/api/presenters/cluster_test.go (7 hunks)
pkg/api/presenters/node_pool.go (2 hunks)
pkg/api/presenters/node_pool_test.go (8 hunks)
pkg/handlers/cluster.go (4 hunks)
pkg/handlers/cluster_nodepools.go (3 hunks)
pkg/handlers/cluster_status.go (2 hunks)
pkg/handlers/node_pool.go (4 hunks)
pkg/handlers/nodepool_status.go (2 hunks)

🧰 Additional context used

📓 Path-based instructions (6)

pkg/**/*.go

📄 CodeRabbit inference engine (AGENTS.md)

Use structured logging via pkg/logger/logger.go with Extra() method for adding context fields

Files:

pkg/api/presenters/node_pool.go
pkg/handlers/node_pool.go
pkg/api/presenters/cluster_test.go
pkg/handlers/nodepool_status.go
pkg/handlers/cluster_nodepools.go
pkg/api/presenters/cluster.go
pkg/handlers/cluster_status.go
pkg/api/presenters/adapter_status_test.go
pkg/handlers/cluster.go
pkg/api/presenters/adapter_status.go
pkg/api/presenters/node_pool_test.go

pkg/{handlers,services}/**/*.go

📄 CodeRabbit inference engine (AGENTS.md)

Retrieve database sessions from context via db.NewContext() rather than creating new GORM connections

Files:

pkg/handlers/node_pool.go
pkg/handlers/nodepool_status.go
pkg/handlers/cluster_nodepools.go
pkg/handlers/cluster_status.go
pkg/handlers/cluster.go

pkg/handlers/**/*.go

📄 CodeRabbit inference engine (AGENTS.md)

pkg/handlers/**/*.go: Automatically convert errors to OpenAPI error responses using errors.SendError() in HTTP handlers
Parse HTTP request bodies using json.NewDecoder(r.Body) in handler functions
Write HTTP responses using json.NewEncoder(w) for consistency with request parsing
Ensure all HTTP handlers follow the pattern: parse request, call service/DAO, handle errors, send response
Implement handlers as methods on handler structs that accept (w http.ResponseWriter, r *http.Request) parameters
Set HTTP status codes correctly: 201 Created for POST, 200 OK for GET, 204 No Content for DELETE operations

Files:

pkg/handlers/node_pool.go
pkg/handlers/nodepool_status.go
pkg/handlers/cluster_nodepools.go
pkg/handlers/cluster_status.go
pkg/handlers/cluster.go

pkg/{dao,handlers}/**/*.go

📄 CodeRabbit inference engine (AGENTS.md)

Support pagination in list operations via ListArgs parameter with configurable limit and offset

Files:

pkg/handlers/node_pool.go
pkg/handlers/nodepool_status.go
pkg/handlers/cluster_nodepools.go
pkg/handlers/cluster_status.go
pkg/handlers/cluster.go

pkg/{handlers,services,dao}/**/*.go

📄 CodeRabbit inference engine (AGENTS.md)

Return ServiceError type from pkg/errors/ with HttpCode, Code, and Reason fields in error handling

Files:

pkg/handlers/node_pool.go
pkg/handlers/nodepool_status.go
pkg/handlers/cluster_nodepools.go
pkg/handlers/cluster_status.go
pkg/handlers/cluster.go

pkg/{db/transaction_middleware.go,handlers}/**/*.go

📄 CodeRabbit inference engine (AGENTS.md)

Store request operation IDs in context for tracing and debugging purposes in error logs

Files:

pkg/handlers/node_pool.go
pkg/handlers/nodepool_status.go
pkg/handlers/cluster_nodepools.go
pkg/handlers/cluster_status.go
pkg/handlers/cluster.go

🧠 Learnings (9)