HYPERFLEET-1370 - refactor: introduce typed container for API server dependencies#309
Open
kuudori wants to merge 1 commit into
Open
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (24)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
💤 Files with no reviewable changes (5)
🚧 Files skipped from review as they are similar to previous changes (18)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe API now centralizes lazy DAO, service, JWT, schema-validator, and server construction in a dependency container. Server configuration is injected, routing uses explicit registrars and middleware chains, and JWT validation is exposed as middleware. Application and integration-test startup obtain shared services and servers from the container, while plugin-based service registration is removed. Estimated code review effort: 4 (Complex) | ~60 minutes Sequence Diagram(s)sequenceDiagram
participant ServeCommand
participant Container
participant Router
participant APIServer
participant Client
ServeCommand->>Container: create with session factory
ServeCommand->>Container: request API server
Container->>Router: build with middleware and registrars
Router-->>Container: return configured router
Container->>APIServer: inject configuration and router
Client->>APIServer: send HTTP or HTTPS request
APIServer-->>Client: return response
Suggested reviewers: 🚥 Pre-merge checks | ✅ 9 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (9 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
Risk Score: 5 —
|
| Signal | Detail | Points |
|---|---|---|
| PR size | 1323 lines (>500) | +2 |
| Sensitive paths | cmd/ | +2 |
| Test coverage | Missing tests for: cmd/hyperfleet-api cmd/hyperfleet-api/servecmd pkg/config pkg/handlers plugins/adapterStatus plugins/generic plugins/resources test test/factories test/integration | +1 |
Computed by hyperfleet-risk-scorer
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
cmd/hyperfleet-api/server/api_server_test.go (1)
111-115: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick winInsecureSkipVerify disables cert-chain/hostname validation (CWE-295).
Flagged by both OpenGrep and ast-grep. You already generate the self-signed cert in
writeSelfSignedCert— build anx509.CertPoolfrom it and setRootCAsinstead of skipping verification entirely, and addMinVersion: tls.VersionTLS13.🔒 Proposed fix
+ certPool := x509.NewCertPool() + certPEM, err := os.ReadFile(certFile) + Expect(err).NotTo(HaveOccurred()) + Expect(certPool.AppendCertsFromPEM(certPEM)).To(BeTrue()) + client := &http.Client{ Transport: &http.Transport{ - TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, + TLSClientConfig: &tls.Config{RootCAs: certPool, MinVersion: tls.VersionTLS13}, }, }🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@cmd/hyperfleet-api/server/api_server_test.go` around lines 111 - 115, Update the HTTP client TLS configuration in the test to avoid InsecureSkipVerify: build an x509.CertPool from the certificate generated by writeSelfSignedCert, assign it to RootCAs, and set MinVersion to tls.VersionTLS13 while preserving trusted self-signed certificate validation.Source: Linters/SAST tools
pkg/auth/jwt_handler.go (1)
106-155: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win
Middlewareis near the QUAL-03 branching/length threshold.5+ distinct branch points (empty header, non-Bearer scheme, parse failure w/ expired precedence, terminal expired/invalid, no-credentials) in one closure. Extract the per-validator match loop into a helper (e.g.
matchValidator(r *http.Request) (*jwt.Token, config.JWTIssuerConfig, error, bool)) returning either a matched token or the sticky "expired" error, keepingMiddlewareitself as thin dispatch +handleErrorcalls.As per path instructions, "Functions >50 lines or >5 branching paths — flag for decomposition."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@pkg/auth/jwt_handler.go` around lines 106 - 155, Decompose the validator iteration from JWTHandler.Middleware into a helper such as matchValidator that evaluates headers and parsers, returns the matched token and issuer configuration, or the sticky expired/validation error plus whether a non-Bearer header was seen. Keep Middleware focused on invoking the helper, dispatching successful requests, and preserving the existing handleError behavior and error precedence.Source: Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@cmd/hyperfleet-api/server/routes.go`:
- Around line 48-54: Make authentication outermost on protected routes: in
cmd/hyperfleet-api/server/routes.go:48-54, register protectedMiddleware before
apiMiddleware so JWT and caller identity run before schema validation or
db.TransactionMiddleware. In cmd/hyperfleet-api/container/container.go:163-180,
adjust the middleware grouping consistently so transaction/schema middleware is
excluded from unauthenticated paths while authenticated requests still reach
db.TransactionMiddleware.
In `@test/integration/resource_helpers.go`:
- Line 15: Update the integration setup around test.RegisterIntegration(t) to
preserve and check its returned error before dereferencing h.Container. Fail the
test immediately with the original error when registration fails, then continue
to ResourceService only for a successful registration; ensure all error returns
in this setup are checked.
---
Nitpick comments:
In `@cmd/hyperfleet-api/server/api_server_test.go`:
- Around line 111-115: Update the HTTP client TLS configuration in the test to
avoid InsecureSkipVerify: build an x509.CertPool from the certificate generated
by writeSelfSignedCert, assign it to RootCAs, and set MinVersion to
tls.VersionTLS13 while preserving trusted self-signed certificate validation.
In `@pkg/auth/jwt_handler.go`:
- Around line 106-155: Decompose the validator iteration from
JWTHandler.Middleware into a helper such as matchValidator that evaluates
headers and parsers, returns the matched token and issuer configuration, or the
sticky expired/validation error plus whether a non-Bearer header was seen. Keep
Middleware focused on invoking the helper, dispatching successful requests, and
preserving the existing handleError behavior and error precedence.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Central YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 63920e6b-ce80-41f8-aa45-a382cb43ee94
📒 Files selected for processing (24)
cmd/hyperfleet-api/container/container.gocmd/hyperfleet-api/container/container_test.gocmd/hyperfleet-api/main.gocmd/hyperfleet-api/servecmd/cmd.gocmd/hyperfleet-api/server/api_server.gocmd/hyperfleet-api/server/api_server_test.gocmd/hyperfleet-api/server/routes.gocmd/hyperfleet-api/server/routes_entities.gocmd/hyperfleet-api/server/routes_entities_test.gocmd/hyperfleet-api/server/routes_test.gocmd/hyperfleet-api/server/server.gopkg/auth/jwt_handler.gopkg/auth/jwt_handler_test.gopkg/config/server.gopkg/handlers/resource_handler.goplugins/CLAUDE.mdplugins/adapterStatus/plugin.goplugins/generic/plugin.goplugins/resources/plugin.gotest/factories/clusters.gotest/factories/factory.gotest/factories/node_pools.gotest/helper.gotest/integration/resource_helpers.go
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
openshift-hyperfleet/architecture(manual)openshift-hyperfleet/hyperfleet-api(manual)openshift-hyperfleet/hyperfleet-sentinel(manual)openshift-hyperfleet/hyperfleet-adapter(manual)openshift-hyperfleet/hyperfleet-broker(manual)
💤 Files with no reviewable changes (5)
- plugins/CLAUDE.md
- plugins/resources/plugin.go
- plugins/generic/plugin.go
- plugins/adapterStatus/plugin.go
- cmd/hyperfleet-api/main.go
…dependencies Replace the plugin-based route registration (plugins/entities, adapterStatus, generic, resources) with a typed Container (cmd/hyperfleet-api/container) that lazily constructs and caches DAOs, services, and handlers via constructor injection instead of a global environments singleton. - Add Container with lazy-cached DAO/service/handler accessors and an APIServer(tracingEnabled) builder - Move entity route registration into cmd/hyperfleet-api/server (routes_entities.go, renamed from plugins/entities/plugin.go) - Refactor APIServer to take injected cfg and handler via its constructor rather than reaching into environments.Environment() - Split router middleware into public (metadata/openapi) vs protected (auth + transaction) subrouters so JWT, schema-validation, and transaction middleware never wrap the public docs endpoints - Simplify JWTHandler to a multi-issuer, mux.MiddlewareFunc-based design, dropping the old PublicPaths/Next self-contained handler - Add unit coverage: container_test.go, api_server_test.go, and routes_test.go (asserts public routes bypass middleware while protected routes are gated by it)
kuudori
force-pushed
the
HYPERFLEET-1370-refactor-typed-container
branch
from
July 23, 2026 16:04
24bb5ee to
b06edbb
Compare
|
@kuudori The container abstraction is nice but wouldn't it make more sense to have it store only the dependencies ? so without APIServer, JWTHandler and SchemaValidator ? The APIServer could be created somewhere in cmd/hyperfleet-api/server/. What do you think? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
plugins/entities,adapterStatus,generic,resources) with a typedContainer(cmd/hyperfleet-api/container) that lazily constructs and caches DAOs, services, and handlers via constructor injectionAPIServerto take injectedcfgandhandlervia its constructor instead of reaching into the globalenvironments.Environment()singleton/openapi,/openapi.html, metadata) vs protected (auth + schema validation + transaction) subrouters, so public docs endpoints are never wrapped by auth/transaction middlewareJWTHandlerto a multi-issuer,mux.MiddlewareFunc-based design, dropping the oldPublicPaths/Nextself-contained handlerTODO(HYPERFLEET-1371)marking the remainingenvironments.Environment()callers (health_server.go,metrics_server.go) for follow-up once theenvironments/package is removedTest plan
make verify-all(go vet, gofmt, unit tests) passesTestNewRouter_PublicVsProtectedMiddleware(new) verifies public routes bypass bothapiMiddlewareandprotectedMiddleware, while registered routes are gated by both — confirmed it fails against the pre-fix router wiring and passes against the fixTestContainerCachesDAOsAndServicesupdated to useBeIdenticalTofor genuine pointer-identity caching checkstest/integration/clusters_test.go,test/integration/openapi_test.go) continue to cover the public/protected boundary end-to-end under the default JWT-enabled config