(DAL) Update dal key validation #1747
Conversation
WalkthroughWalkthroughThe recent updates entail enhancing API security by integrating a new API key validator within the middleware in Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Middleware
participant API
Client->>+API: Request without API Key
API->>+Middleware: Validate API Key
Middleware-->>-API: Validation Failed (401)
API-->>-Client: 401 Unauthorized
Poem
🐇🚀 Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
node/pkg/dal/utils/utils.go (1)
21-31: Consider adding logging for failed validation attempts.The
validatorfunction correctly implements the validation logic. Adding logging can help in monitoring and debugging.func validator(ctx *fiber.Ctx, s string) (bool, error) { key := os.Getenv("API_KEY") if s == "" { log.Warn().Msg("missing api key") return false, fmt.Errorf("missing api key") } if s == key { return true, nil } log.Warn().Msg("invalid api key") return false, fmt.Errorf("invalid api key") }node/pkg/dal/tests/api_test.go (1)
82-103: Consider adding a cleanup step to stop the server after the test.The
TestShouldFailWithoutApiKeyfunction is well-written and correctly tests the intended scenario. Adding a cleanup step to stop the server can prevent potential issues with subsequent tests.func TestShouldFailWithoutApiKey(t *testing.T) { ctx := context.Background() clean, testItems, err := setup(ctx) if err != nil { t.Fatalf("error setting up test: %v", err) } defer func() { if cleanupErr := clean(); cleanupErr != nil { t.Logf("Cleanup failed: %v", cleanupErr) } }() testItems.Controller.Start(ctx) go testItems.App.Listen(":8090") defer testItems.App.Shutdown() // Add this line for cleanup resp, err := request.RequestRaw(request.WithEndpoint("http://localhost:8090/api/v1")) if err != nil { t.Fatalf("error getting latest data: %v", err) } assert.Equal(t, 401, resp.StatusCode) }
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- node/pkg/dal/tests/api_test.go (2 hunks)
- node/pkg/dal/utils/utils.go (2 hunks)
Additional comments not posted (3)
node/pkg/dal/utils/utils.go (2)
16-16: Import statement forkeyauthmiddleware is correct.The import statement is necessary for the new functionality.
61-64: Usage ofkeyauthmiddleware is correct.The
keyauthmiddleware is correctly configured to use thevalidatorfunction and integrates well within theSetupfunction.node/pkg/dal/tests/api_test.go (1)
14-14: Import statement forrequestpackage is correct.The import statement is necessary for the new test functionality.
Description
Use Keyauth instead of manual implementation.
Adds test to check if it fails to get result without proper api key header.
Type of change
Please delete options that are not relevant.
Checklist before requesting a review
Deployment