🔥 Feature: Add support for custom KeyLookup functions in the Keyauth middleware by dave-gray101 · Pull Request #3028 · gofiber/fiber

dave-gray101 · 2024-06-09T21:07:47Z

Description

I'm working on a project that must accept api keys from multiple possible sources, such as different header names. I've implemented this by slightly modifying the existing Keyauth middleware, and I'd like to contribute it upstream. These modifications have been refined through the PR process, and now allow the use of a custom key lookup function with the following signature to allow arbitrary key material to be extracted from the request context.

type KeyauthKeyLookupFunc func(c fiber.Ctx) (string, error)

This was formerly PR #3027, but that was targeted at v2 instead of v3.

Changes introduced

Added CustomKeyLookup to keyauth.Config, allowing arbitrary key material to be extracted from the request context if more complex logic is required.
Exposed the existing KeyLookup functionality as SingleKeyLookup - this is still used by default, and can be used as a component of a custom implementation
Created MultipleKeySourceLookup to provide the functionality my project requires and accept multiple KeyLookup-formatted sources instead of one. This also serves as a (very simple) example of how to create more complex logic and how that could be used.

Type of change

Please delete options that are not relevant.

Enhancement (improvement to existing features and functionality)

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai · 2024-06-09T21:07:55Z

Walkthrough

The key changes involved refactoring the keyauth middleware to enhance its key lookup flexibility and error handling. The updates include the addition of support for multiple key sources, improved error management, and thorough test coverage to ensure robustness. Key extraction is now more dynamic, accommodating custom setups and fallback mechanisms effectively.

Changes

File	Change Summary
`middleware/keyauth/...keyauth.go`	Added `fmt` package. Refactored `New` function for multiple key lookups and fallback, introduced `extractorFunc` type, `MultipleKeySourceLookup`, `SingleKeyLookup`, and improved error handling.
`middleware/keyauth/...keyauth_test.go`	Introduced new test functions for handling invalid configurations, custom errors, multiple key lookups, and context token retrieval scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Middleware
    participant Config
    participant KeySource
    participant CustomKeyLookup

    Client->>Middleware: Request with key
    Middleware->>Config: Fetch configuration
    Config-->>Middleware: Return configuration
    alt Custom Key Lookup Enabled
        Middleware->>CustomKeyLookup: Fetch key
        CustomKeyLookup-->>Middleware: Return key
    else
        Middleware->>KeySource: Fetch key from source
        KeySource-->>Middleware: Return key
    end
    Middleware-->>Client: Process request/Respond

Poem

Amidst the code where logic flows,
Key lookups gleam, a feature grows.
With tests in place, no bugs can hide,
In Fiber's heart, keys now reside.
A rabbit's joy, in lines so neat,
Robust and swift, our code's heartbeat.
🐇✨

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

Outside diff range and nitpick comments (1)

middleware/keyauth/config.go (1)

35-37: Ensure proper documentation for FallbackKeyLookups to clarify its usage.

Consider adding a comment explaining the expected format and use cases for FallbackKeyLookups to help developers understand how to use this new configuration option effectively.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e561026 and 0b6b5e9.

Files selected for processing (4)

docs/middleware/keyauth.md (2 hunks)
middleware/keyauth/config.go (3 hunks)
middleware/keyauth/keyauth.go (3 hunks)
middleware/keyauth/keyauth_test.go (1 hunks)

Additional context used

Learnings (1)

docs/middleware/keyauth.md (1)

User: dave-gray101
PR: gofiber/fiber#3027
File: docs/api/middleware/keyauth.md:222-222
Timestamp: 2024-06-09T18:50:02.075Z
Learning: The `KeyLookup` field in the `keyauth` middleware does not support pipe-delimited keys. Instead, it specifies a single source and name for key extraction, with additional sources specified in the `FallbackKeyLookups` field.

golangci-lint

middleware/keyauth/keyauth.go

101-101: File is not gofumpt-ed with -extra (gofumpt)

104-104: fmt.Errorf can be replaced with errors.New (perfsprint)

middleware/keyauth/keyauth_test.go

[warning] 144-144: unused-parameter: parameter 'c' seems to be unused, consider removing or renaming it as _ (revive)

LanguageTool

docs/middleware/keyauth.md

[uncategorized] ~7-~7: This expression is usually spelled with a hyphen. (BASED_HYPHEN)
Context: ...Keyauth Key auth middleware provides a key based authentication. ## Signatures ```go f...

[uncategorized] ~78-~78: The abbreviation “e.g.” (= for example) requires two periods. (E_G)
Context: ...of keyauth and apply a filter function (eg. authFilter) like so ```go package ma...

Markdownlint

docs/middleware/keyauth.md

22-22: Column: 1 (MD010, no-hard-tabs)
Hard tabs

23-23: Column: 1 (MD010, no-hard-tabs)
Hard tabs

24-24: Column: 1 (MD010, no-hard-tabs)
Hard tabs

25-25: Column: 1 (MD010, no-hard-tabs)
Hard tabs

29-29: Column: 1 (MD010, no-hard-tabs)
Hard tabs

33-33: Column: 1 (MD010, no-hard-tabs)
Hard tabs

34-34: Column: 1 (MD010, no-hard-tabs)
Hard tabs

36-36: Column: 1 (MD010, no-hard-tabs)
Hard tabs

37-37: Column: 1 (MD010, no-hard-tabs)
Hard tabs

38-38: Column: 1 (MD010, no-hard-tabs)
Hard tabs

39-39: Column: 1 (MD010, no-hard-tabs)
Hard tabs

43-43: Column: 1 (MD010, no-hard-tabs)
Hard tabs

45-45: Column: 1 (MD010, no-hard-tabs)
Hard tabs

46-46: Column: 1 (MD010, no-hard-tabs)
Hard tabs

47-47: Column: 1 (MD010, no-hard-tabs)
Hard tabs

48-48: Column: 1 (MD010, no-hard-tabs)
Hard tabs

49-49: Column: 1 (MD010, no-hard-tabs)
Hard tabs

51-51: Column: 1 (MD010, no-hard-tabs)
Hard tabs

52-52: Column: 1 (MD010, no-hard-tabs)
Hard tabs

53-53: Column: 1 (MD010, no-hard-tabs)
Hard tabs

55-55: Column: 1 (MD010, no-hard-tabs)
Hard tabs

84-84: Column: 1 (MD010, no-hard-tabs)
Hard tabs

85-85: Column: 1 (MD010, no-hard-tabs)
Hard tabs

86-86: Column: 1 (MD010, no-hard-tabs)
Hard tabs

87-87: Column: 1 (MD010, no-hard-tabs)
Hard tabs

88-88: Column: 1 (MD010, no-hard-tabs)
Hard tabs

89-89: Column: 1 (MD010, no-hard-tabs)
Hard tabs

93-93: Column: 1 (MD010, no-hard-tabs)
Hard tabs

94-94: Column: 1 (MD010, no-hard-tabs)
Hard tabs

95-95: Column: 1 (MD010, no-hard-tabs)
Hard tabs

96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs

97-97: Column: 1 (MD010, no-hard-tabs)
Hard tabs

101-101: Column: 1 (MD010, no-hard-tabs)
Hard tabs

102-102: Column: 1 (MD010, no-hard-tabs)
Hard tabs

104-104: Column: 1 (MD010, no-hard-tabs)
Hard tabs

105-105: Column: 1 (MD010, no-hard-tabs)
Hard tabs

106-106: Column: 1 (MD010, no-hard-tabs)
Hard tabs

107-107: Column: 1 (MD010, no-hard-tabs)
Hard tabs

111-111: Column: 1 (MD010, no-hard-tabs)
Hard tabs

113-113: Column: 1 (MD010, no-hard-tabs)
Hard tabs

114-114: Column: 1 (MD010, no-hard-tabs)
Hard tabs

115-115: Column: 1 (MD010, no-hard-tabs)
Hard tabs

116-116: Column: 1 (MD010, no-hard-tabs)
Hard tabs

117-117: Column: 1 (MD010, no-hard-tabs)
Hard tabs

118-118: Column: 1 (MD010, no-hard-tabs)
Hard tabs

122-122: Column: 1 (MD010, no-hard-tabs)
Hard tabs

124-124: Column: 1 (MD010, no-hard-tabs)
Hard tabs

125-125: Column: 1 (MD010, no-hard-tabs)
Hard tabs

126-126: Column: 1 (MD010, no-hard-tabs)
Hard tabs

127-127: Column: 1 (MD010, no-hard-tabs)
Hard tabs

128-128: Column: 1 (MD010, no-hard-tabs)
Hard tabs

130-130: Column: 1 (MD010, no-hard-tabs)
Hard tabs

131-131: Column: 1 (MD010, no-hard-tabs)
Hard tabs

132-132: Column: 1 (MD010, no-hard-tabs)
Hard tabs

133-133: Column: 1 (MD010, no-hard-tabs)
Hard tabs

134-134: Column: 1 (MD010, no-hard-tabs)
Hard tabs

135-135: Column: 1 (MD010, no-hard-tabs)
Hard tabs

136-136: Column: 1 (MD010, no-hard-tabs)
Hard tabs

137-137: Column: 1 (MD010, no-hard-tabs)
Hard tabs

138-138: Column: 1 (MD010, no-hard-tabs)
Hard tabs

140-140: Column: 1 (MD010, no-hard-tabs)
Hard tabs

166-166: Column: 1 (MD010, no-hard-tabs)
Hard tabs

167-167: Column: 1 (MD010, no-hard-tabs)
Hard tabs

168-168: Column: 1 (MD010, no-hard-tabs)
Hard tabs

169-169: Column: 1 (MD010, no-hard-tabs)
Hard tabs

177-177: Column: 1 (MD010, no-hard-tabs)
Hard tabs

179-179: Column: 1 (MD010, no-hard-tabs)
Hard tabs

180-180: Column: 1 (MD010, no-hard-tabs)
Hard tabs

181-181: Column: 1 (MD010, no-hard-tabs)
Hard tabs

182-182: Column: 1 (MD010, no-hard-tabs)
Hard tabs

184-184: Column: 1 (MD010, no-hard-tabs)
Hard tabs

185-185: Column: 1 (MD010, no-hard-tabs)
Hard tabs

186-186: Column: 1 (MD010, no-hard-tabs)
Hard tabs

187-187: Column: 1 (MD010, no-hard-tabs)
Hard tabs

188-188: Column: 1 (MD010, no-hard-tabs)
Hard tabs

189-189: Column: 1 (MD010, no-hard-tabs)
Hard tabs

191-191: Column: 1 (MD010, no-hard-tabs)
Hard tabs

192-192: Column: 1 (MD010, no-hard-tabs)
Hard tabs

193-193: Column: 1 (MD010, no-hard-tabs)
Hard tabs

195-195: Column: 1 (MD010, no-hard-tabs)
Hard tabs

196-196: Column: 1 (MD010, no-hard-tabs)
Hard tabs

197-197: Column: 1 (MD010, no-hard-tabs)
Hard tabs

199-199: Column: 1 (MD010, no-hard-tabs)
Hard tabs

231-231: Column: 1 (MD010, no-hard-tabs)
Hard tabs

232-232: Column: 1 (MD010, no-hard-tabs)
Hard tabs

233-233: Column: 1 (MD010, no-hard-tabs)
Hard tabs

234-234: Column: 1 (MD010, no-hard-tabs)
Hard tabs

235-235: Column: 1 (MD010, no-hard-tabs)
Hard tabs

236-236: Column: 1 (MD010, no-hard-tabs)
Hard tabs

237-237: Column: 1 (MD010, no-hard-tabs)
Hard tabs

238-238: Column: 1 (MD010, no-hard-tabs)
Hard tabs

239-239: Column: 1 (MD010, no-hard-tabs)
Hard tabs

240-240: Column: 1 (MD010, no-hard-tabs)
Hard tabs

241-241: Column: 1 (MD010, no-hard-tabs)
Hard tabs

242-242: Column: 1 (MD010, no-hard-tabs)
Hard tabs

75-75: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines

Additional comments not posted (6)

middleware/keyauth/config.go (2)

58-60: Proper initialization of FallbackKeyLookups in ConfigDefault.

The initialization of FallbackKeyLookups as an empty slice in the default configuration is appropriate, ensuring that there are no null pointer exceptions when this field is accessed.

87-89: Good defensive programming practice in configDefault.

Setting FallbackKeyLookups to an empty slice if it is nil in the provided configuration is a good defensive programming practice, ensuring stability and preventing runtime errors.

middleware/keyauth/keyauth.go (2)

6-6: Import of fmt package is justified.

The import of the fmt package is necessary for error formatting in the new implementation, which uses fmt.Errorf to wrap errors with additional context.

32-33: Introduction of extractorFunc type.

The introduction of the extractorFunc type is a good design choice, encapsulating the key extraction logic into a type, which enhances modularity and readability.

docs/middleware/keyauth.md (1)

223-223: Documentation update for FallbackKeyLookups.

The documentation update to include FallbackKeyLookups in the Config struct description is clear and aligns with the code changes. This ensures that users are well-informed about the new configuration option.

middleware/keyauth/keyauth_test.go (1)

133-177: Comprehensive testing for multiple key lookups.

The new test function TestMultipleKeyLookup is comprehensive and effectively tests the new multiple key lookup feature. It covers various scenarios and properly asserts the outcomes, ensuring the functionality works as expected.

Tools

golangci-lint

[warning] 144-144: unused-parameter: parameter 'c' seems to be unused, consider removing or renaming it as _ (revive)

middleware/keyauth/keyauth.go

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai

Actionable comments posted: 2

Outside diff range and nitpick comments (1)

middleware/keyauth/keyauth.go (1)

101-101: Format the file with gofumpt to adhere to Go best practices.

Tools

golangci-lint

101-101: File is not gofumpt-ed with -extra (gofumpt)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0b6b5e9 and f118663.

Files selected for processing (1)

middleware/keyauth/keyauth.go (3 hunks)

Additional context used

golangci-lint

middleware/keyauth/keyauth.go

101-101: File is not gofumpt-ed with -extra (gofumpt)

middleware/keyauth/keyauth.go

codecov · 2024-06-09T23:46:27Z

Codecov Report

Attention: Patch coverage is 95.12195% with 2 lines in your changes missing coverage. Please review.

Project coverage is 82.96%. Comparing base (c9b7b1a) to head (d6d5bfe).

Files	Patch %	Lines
middleware/keyauth/keyauth.go	95.12%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3028      +/-   ##
==========================================
+ Coverage   82.85%   82.96%   +0.11%     
==========================================
  Files         115      115              
  Lines        8224     8248      +24     
==========================================
+ Hits         6814     6843      +29     
+ Misses       1080     1075       -5     
  Partials      330      330

Flag	Coverage Δ
unittests	`82.96% <95.12%> (+0.11%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

gaby · 2024-06-09T23:47:49Z

@dave-gray101 The linter is more strict in v3. On the root of the repo there's a makefile that helps you run some of the tests locally.

More info here: https://github.com/gofiber/fiber?tab=readme-ov-file#%EF%B8%8F-development

sixcolors · 2024-06-10T01:05:34Z

I'm not entirely convinced that the current approach is right for a general framework.

While I appreciate the effort behind the proposed changes, I'm concerned about the added complexity and potential performance impact. Before moving forward with this pull request, could we consider alternative solutions?

One idea that comes to mind is implementing a custom KeyLookup function that could be tailored to your project's needs.

@dave-gray101 what do you think about incorporating a custom KeyLookup function into the middleware instead?

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai

Actionable comments posted: 2

Outside diff range and nitpick comments (1)

middleware/keyauth/keyauth.go (1)

6-6: Consider removing the fmt import if it's not used elsewhere in the file.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f118663 and a432b80.

Files selected for processing (2)

middleware/keyauth/keyauth.go (3 hunks)
middleware/keyauth/keyauth_test.go (1 hunks)

Additional context used

golangci-lint

Additional comments not posted (2)

middleware/keyauth/keyauth.go (1)

32-32: The extractorFunc type is well-defined and clear.

middleware/keyauth/keyauth_test.go (1)

133-177: The TestMultipleKeyLookup function effectively tests the new functionality of handling multiple key lookups. It's comprehensive and covers various scenarios. Good job on ensuring thorough testing!

middleware/keyauth/keyauth.go

dave-gray101 · 2024-06-10T01:13:57Z

I'm not entirely convinced that the current approach is right for a general framework.

While I appreciate the effort behind the proposed changes, I'm concerned about the added complexity and potential performance impact. Before moving forward with this pull request, could we consider alternative solutions?

One idea that comes to mind is implementing a custom KeyLookup function that could be tailored to your project's needs.

@dave-gray101 what do you think about incorporating a custom KeyLookup function into the middleware instead?

I had considered that - initially, my plan was to change as little as possible, as this was targeted at the v2 branch at that time. Now that I'm targeting the v3 (which will have other, more pressing breaking changes for developers to worry about)... I feel more comfortable doing something like a custom KeyLookup parameter.

Now that I've had a chance to test out the makefiles for local linting / testing on v3, I'll see what that might look like - I think it might be nice to have a utility function in there that can still parse the format and generate a handler like this.

… as function, with utility functions to make creating these easy Signed-off-by: Dave Lee <dave@gray101.com>

dave-gray101 · 2024-06-10T02:01:37Z

I've gone ahead and swapped this over to use CustomKeyLookup as suggested by @sixcolors . It's definitely the most general approach, and gives the most flexibility to developers.

I've exposed the existing functionality that parses source:key groupings to be used by developers when creating their own CustomKeyLookup implementations, and created MultipleKeySourceLookup to provide the multi-source functionality I'm in need of, as well as provide an open-source example of how to use CustomKeyLookup.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a432b80 and 4e061aa.

Files selected for processing (4)

docs/middleware/keyauth.md (2 hunks)
middleware/keyauth/config.go (3 hunks)
middleware/keyauth/keyauth.go (4 hunks)
middleware/keyauth/keyauth_test.go (1 hunks)

Additional context used

Learnings (1)

docs/middleware/keyauth.md (1)

User: dave-gray101
PR: gofiber/fiber#3027
File: docs/api/middleware/keyauth.md:222-222
Timestamp: 2024-06-09T18:50:02.075Z
Learning: The `KeyLookup` field in the `keyauth` middleware does not support pipe-delimited keys. Instead, it specifies a single source and name for key extraction, with additional sources specified in the `FallbackKeyLookups` field.

golangci-lint

LanguageTool

docs/middleware/keyauth.md

[uncategorized] ~7-~7: This expression is usually spelled with a hyphen. (BASED_HYPHEN)
Context: ...Keyauth Key auth middleware provides a key based authentication. ## Signatures ```go f...

[uncategorized] ~78-~78: The abbreviation “e.g.” (= for example) requires two periods. (E_G)
Context: ...of keyauth and apply a filter function (eg. authFilter) like so ```go package ma...

[uncategorized] ~250-~250: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ... the above function until a key is found or the options are all exhausted

Markdownlint

docs/middleware/keyauth.md

22-22: Column: 1 (MD010, no-hard-tabs)
Hard tabs

23-23: Column: 1 (MD010, no-hard-tabs)
Hard tabs

24-24: Column: 1 (MD010, no-hard-tabs)
Hard tabs

25-25: Column: 1 (MD010, no-hard-tabs)
Hard tabs

29-29: Column: 1 (MD010, no-hard-tabs)
Hard tabs

33-33: Column: 1 (MD010, no-hard-tabs)
Hard tabs

34-34: Column: 1 (MD010, no-hard-tabs)
Hard tabs

36-36: Column: 1 (MD010, no-hard-tabs)
Hard tabs

37-37: Column: 1 (MD010, no-hard-tabs)
Hard tabs

38-38: Column: 1 (MD010, no-hard-tabs)
Hard tabs

39-39: Column: 1 (MD010, no-hard-tabs)
Hard tabs

43-43: Column: 1 (MD010, no-hard-tabs)
Hard tabs

45-45: Column: 1 (MD010, no-hard-tabs)
Hard tabs

46-46: Column: 1 (MD010, no-hard-tabs)
Hard tabs

47-47: Column: 1 (MD010, no-hard-tabs)
Hard tabs

48-48: Column: 1 (MD010, no-hard-tabs)
Hard tabs

49-49: Column: 1 (MD010, no-hard-tabs)
Hard tabs

51-51: Column: 1 (MD010, no-hard-tabs)
Hard tabs

52-52: Column: 1 (MD010, no-hard-tabs)
Hard tabs

53-53: Column: 1 (MD010, no-hard-tabs)
Hard tabs

55-55: Column: 1 (MD010, no-hard-tabs)
Hard tabs

84-84: Column: 1 (MD010, no-hard-tabs)
Hard tabs

85-85: Column: 1 (MD010, no-hard-tabs)
Hard tabs

86-86: Column: 1 (MD010, no-hard-tabs)
Hard tabs

87-87: Column: 1 (MD010, no-hard-tabs)
Hard tabs

88-88: Column: 1 (MD010, no-hard-tabs)
Hard tabs

89-89: Column: 1 (MD010, no-hard-tabs)
Hard tabs

93-93: Column: 1 (MD010, no-hard-tabs)
Hard tabs

94-94: Column: 1 (MD010, no-hard-tabs)
Hard tabs

95-95: Column: 1 (MD010, no-hard-tabs)
Hard tabs

96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs

97-97: Column: 1 (MD010, no-hard-tabs)
Hard tabs

101-101: Column: 1 (MD010, no-hard-tabs)
Hard tabs

102-102: Column: 1 (MD010, no-hard-tabs)
Hard tabs

104-104: Column: 1 (MD010, no-hard-tabs)
Hard tabs

105-105: Column: 1 (MD010, no-hard-tabs)
Hard tabs

106-106: Column: 1 (MD010, no-hard-tabs)
Hard tabs

107-107: Column: 1 (MD010, no-hard-tabs)
Hard tabs

111-111: Column: 1 (MD010, no-hard-tabs)
Hard tabs

113-113: Column: 1 (MD010, no-hard-tabs)
Hard tabs

114-114: Column: 1 (MD010, no-hard-tabs)
Hard tabs

115-115: Column: 1 (MD010, no-hard-tabs)
Hard tabs

116-116: Column: 1 (MD010, no-hard-tabs)
Hard tabs

117-117: Column: 1 (MD010, no-hard-tabs)
Hard tabs

118-118: Column: 1 (MD010, no-hard-tabs)
Hard tabs

122-122: Column: 1 (MD010, no-hard-tabs)
Hard tabs

124-124: Column: 1 (MD010, no-hard-tabs)
Hard tabs

125-125: Column: 1 (MD010, no-hard-tabs)
Hard tabs

126-126: Column: 1 (MD010, no-hard-tabs)
Hard tabs

127-127: Column: 1 (MD010, no-hard-tabs)
Hard tabs

128-128: Column: 1 (MD010, no-hard-tabs)
Hard tabs

130-130: Column: 1 (MD010, no-hard-tabs)
Hard tabs

131-131: Column: 1 (MD010, no-hard-tabs)
Hard tabs

132-132: Column: 1 (MD010, no-hard-tabs)
Hard tabs

133-133: Column: 1 (MD010, no-hard-tabs)
Hard tabs

134-134: Column: 1 (MD010, no-hard-tabs)
Hard tabs

135-135: Column: 1 (MD010, no-hard-tabs)
Hard tabs

136-136: Column: 1 (MD010, no-hard-tabs)
Hard tabs

137-137: Column: 1 (MD010, no-hard-tabs)
Hard tabs

138-138: Column: 1 (MD010, no-hard-tabs)
Hard tabs

140-140: Column: 1 (MD010, no-hard-tabs)
Hard tabs

166-166: Column: 1 (MD010, no-hard-tabs)
Hard tabs

167-167: Column: 1 (MD010, no-hard-tabs)
Hard tabs

168-168: Column: 1 (MD010, no-hard-tabs)
Hard tabs

169-169: Column: 1 (MD010, no-hard-tabs)
Hard tabs

177-177: Column: 1 (MD010, no-hard-tabs)
Hard tabs

179-179: Column: 1 (MD010, no-hard-tabs)
Hard tabs

180-180: Column: 1 (MD010, no-hard-tabs)
Hard tabs

181-181: Column: 1 (MD010, no-hard-tabs)
Hard tabs

182-182: Column: 1 (MD010, no-hard-tabs)
Hard tabs

184-184: Column: 1 (MD010, no-hard-tabs)
Hard tabs

185-185: Column: 1 (MD010, no-hard-tabs)
Hard tabs

186-186: Column: 1 (MD010, no-hard-tabs)
Hard tabs

187-187: Column: 1 (MD010, no-hard-tabs)
Hard tabs

188-188: Column: 1 (MD010, no-hard-tabs)
Hard tabs

189-189: Column: 1 (MD010, no-hard-tabs)
Hard tabs

191-191: Column: 1 (MD010, no-hard-tabs)
Hard tabs

192-192: Column: 1 (MD010, no-hard-tabs)
Hard tabs

193-193: Column: 1 (MD010, no-hard-tabs)
Hard tabs

195-195: Column: 1 (MD010, no-hard-tabs)
Hard tabs

196-196: Column: 1 (MD010, no-hard-tabs)
Hard tabs

197-197: Column: 1 (MD010, no-hard-tabs)
Hard tabs

199-199: Column: 1 (MD010, no-hard-tabs)
Hard tabs

231-231: Column: 1 (MD010, no-hard-tabs)
Hard tabs

232-232: Column: 1 (MD010, no-hard-tabs)
Hard tabs

233-233: Column: 1 (MD010, no-hard-tabs)
Hard tabs

234-234: Column: 1 (MD010, no-hard-tabs)
Hard tabs

235-235: Column: 1 (MD010, no-hard-tabs)
Hard tabs

236-236: Column: 1 (MD010, no-hard-tabs)
Hard tabs

237-237: Column: 1 (MD010, no-hard-tabs)
Hard tabs

238-238: Column: 1 (MD010, no-hard-tabs)
Hard tabs

239-239: Column: 1 (MD010, no-hard-tabs)
Hard tabs

240-240: Column: 1 (MD010, no-hard-tabs)
Hard tabs

241-241: Column: 1 (MD010, no-hard-tabs)
Hard tabs

242-242: Column: 1 (MD010, no-hard-tabs)
Hard tabs

75-75: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines

249-249: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines

Additional comments not posted (10)

middleware/keyauth/config.go (3)

9-9: Introduced a new type KeyauthKeyLookupFunc for custom key lookup functions.

This is a good addition as it allows for more flexible and complex key extraction logic, aligning with the PR's goal to enhance key lookup capabilities.

37-37: Added CustomKeyLookup field to the Config struct.

This change supports the new feature of custom key lookups, providing users the ability to specify their own key extraction logic. Ensure that the documentation is updated to reflect this new configuration option.

58-60: Updated default values for KeyLookup and introduced a default nil for CustomKeyLookup.

The update to the default KeyLookup to include the fiber.HeaderAuthorization is a sensible default. Setting CustomKeyLookup to nil by default is appropriate as it maintains backward compatibility.

middleware/keyauth/keyauth.go (5)

6-6: Imported the fmt package.

This import is necessary for error formatting in the new functions introduced in this file.

38-43: Implemented a fallback mechanism for CustomKeyLookup using SingleKeyLookup.

This implementation ensures that if CustomKeyLookup is not provided, the middleware defaults to a single key lookup based on the provided KeyLookup and AuthScheme. The use of panic for error handling here is appropriate given that configuration errors should be caught early.

54-54: Enhanced key extraction and validation logic within the middleware handler.

This change effectively integrates the CustomKeyLookup functionality into the middleware's request handling, allowing for more flexible authentication mechanisms.

79-102: Added MultipleKeySourceLookup function to handle multiple key sources.

This function is a significant enhancement, allowing the middleware to attempt key extraction from multiple specified sources until one succeeds. This aligns with the PR's objective to support multiple key sources.

104-121: Refactored SingleKeyLookup to support different types of key sources.

This refactor makes the function more modular and easier to maintain. It also supports the new feature of handling multiple key sources by providing a consistent interface for key extraction.

docs/middleware/keyauth.md (1)

223-223: Updated documentation to include the new CustomKeyLookup field in the Config struct.

The documentation update is thorough and correctly describes the new functionality. It's crucial that the documentation keeps pace with the code changes to help users understand how to use the new features.

middleware/keyauth/keyauth_test.go (1)

133-181: Added TestMultipleKeyLookup to validate the functionality of MultipleKeySourceLookup.

This test is well-structured and effectively checks the new functionality of handling multiple key sources. It's important to ensure that new features are accompanied by comprehensive tests to maintain code quality and functionality.

Signed-off-by: Dave Lee <dave@gray101.com>

dave-gray101 · 2024-06-10T15:05:13Z

I added a few more tests to boost the coverage numbers, as CI flagged a few error paths I forgot to cover.

Can someone please re-approve the workflow when they get a chance? Thanks!

coderabbitai

Actionable comments posted: 2

Outside diff range and nitpick comments (1)

middleware/keyauth/keyauth_test.go (1)
144-155: Validate error messages for better test accuracy.

In TestCustomKeyUtilityFunctionErrors, the tests verify that an error occurs but do not check the content of the error message. It's beneficial to also validate the error message to ensure that the function fails for the expected reasons.
require.EqualError(t, err, "expected error message")

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4e061aa and 397ff49.

Files selected for processing (1)

middleware/keyauth/keyauth_test.go (1 hunks)

Additional context used

golangci-lint

middleware/keyauth/keyauth_test.go

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai

Actionable comments posted: 4

Outside diff range and nitpick comments (1)

middleware/keyauth/keyauth.go (1)

6-6: Consider removing the fmt import if it's not used elsewhere in the file.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 397ff49 and 2968439.

Files selected for processing (2)

middleware/keyauth/keyauth.go (8 hunks)
middleware/keyauth/keyauth_test.go (1 hunks)

Additional context used

golangci-lint

Additional comments not posted (3)

middleware/keyauth/keyauth.go (3)
79-102: The implementation of MultipleKeySourceLookup is robust. However, consider handling errors more gracefully rather than using panic. This could improve the middleware's resilience and error reporting.
- panic(fmt.Errorf("error creating middleware: invalid keyauth Config.KeyLookup: %w", err))
+ return nil, fmt.Errorf("error creating middleware: invalid keyauth Config.KeyLookup: %w", err)
Likely invalid or redundant comment.

124-124: Ensure that the keyFromHeader function correctly handles cases where the authScheme is not provided.

Verification successful

The keyFromHeader function correctly handles cases where the authScheme is not provided by checking if the length of authScheme is 0 and returning the auth header directly.

middleware/keyauth/keyauth.go, lines 124-128
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify that `keyFromHeader` handles missing `authScheme`.

# Test: Search for test cases covering missing `authScheme`. Expect: At least one test case.
rg --type go $'keyFromHeader.*authScheme' tests/
Length of output: 96

Script:
#!/bin/bash
# Description: Verify that `keyFromHeader` handles missing `authScheme`.

# Test: Search for test cases covering missing `authScheme`. Expect: At least one test case.
rg --type go $'keyFromHeader' --glob '*_test.go'
Length of output: 47

Script:
#!/bin/bash
# Description: Find the implementation of `keyFromHeader` and analyze its logic.

# Step 1: Search for the implementation of `keyFromHeader`.
ast-grep --lang go --pattern 'func keyFromHeader($_, $_) $_' 

# Step 2: Search for any indirect references or usage of `keyFromHeader` in the codebase.
rg 'keyFromHeader' --type go
Length of output: 450

Script:
#!/bin/bash
# Description: Extract and review the implementation of `keyFromHeader`.

# Extract the implementation of `keyFromHeader` from `middleware/keyauth/keyauth.go`.
sed -n '/func keyFromHeader(header, authScheme string) KeyauthKeyLookupFunc {/,/}/p' middleware/keyauth/keyauth.go
Length of output: 331
54-54: Ensure that the CustomKeyLookup function is thoroughly tested to handle all possible error scenarios.

middleware/keyauth/keyauth.go

middleware/keyauth/keyauth_test.go

Signed-off-by: Dave Lee <dave@gray101.com>

dave-gray101 · 2024-06-16T21:23:35Z

@gaby Would it be possible to get the workflow kicked off again? I punched in a few more tests for coverage today, so I think this time the bots will accept it.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7bfc96d and 1004aa0.

Files selected for processing (1)

middleware/keyauth/keyauth_test.go (2 hunks)

Files skipped from review as they are similar to previous changes (1)

middleware/keyauth/keyauth_test.go

gaby · 2024-06-16T21:33:20Z

@coderabbitai full review

coderabbitai · 2024-06-16T21:33:25Z

Actions performed

Full review triggered.

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 23bcbd3 and 1004aa0.

Files selected for processing (4)

docs/middleware/keyauth.md (2 hunks)
middleware/keyauth/config.go (3 hunks)
middleware/keyauth/keyauth.go (8 hunks)
middleware/keyauth/keyauth_test.go (2 hunks)

Additional context used

Learnings (1)

docs/middleware/keyauth.md (1)

User: dave-gray101
PR: gofiber/fiber#3027
File: docs/api/middleware/keyauth.md:222-222
Timestamp: 2024-06-09T18:50:02.075Z
Learning: The `KeyLookup` field in the `keyauth` middleware does not support pipe-delimited keys. Instead, it specifies a single source and name for key extraction, with additional sources specified in the `FallbackKeyLookups` field.

GitHub Check: codecov/patch

middleware/keyauth/keyauth.go

[warning] 42-42: middleware/keyauth/keyauth.go#L42
Added line #L42 was not covered by tests

[warning] 97-97: middleware/keyauth/keyauth.go#L97
Added line #L97 was not covered by tests

LanguageTool

docs/middleware/keyauth.md

[uncategorized] ~7-~7: This expression is usually spelled with a hyphen. (BASED_HYPHEN)
Context: ...Keyauth Key auth middleware provides a key based authentication. ## Signatures ```go f...

[uncategorized] ~78-~78: The abbreviation “e.g.” (= for example) requires two periods. (E_G)
Context: ...of keyauth and apply a filter function (eg. authFilter) like so ```go package ma...

[uncategorized] ~250-~250: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ... the above function until a key is found or the options are all exhausted

Markdownlint

docs/middleware/keyauth.md

22-22: Column: 1 (MD010, no-hard-tabs)
Hard tabs

23-23: Column: 1 (MD010, no-hard-tabs)
Hard tabs

24-24: Column: 1 (MD010, no-hard-tabs)
Hard tabs

25-25: Column: 1 (MD010, no-hard-tabs)
Hard tabs

29-29: Column: 1 (MD010, no-hard-tabs)
Hard tabs

33-33: Column: 1 (MD010, no-hard-tabs)
Hard tabs

34-34: Column: 1 (MD010, no-hard-tabs)
Hard tabs

36-36: Column: 1 (MD010, no-hard-tabs)
Hard tabs

37-37: Column: 1 (MD010, no-hard-tabs)
Hard tabs

38-38: Column: 1 (MD010, no-hard-tabs)
Hard tabs

39-39: Column: 1 (MD010, no-hard-tabs)
Hard tabs

43-43: Column: 1 (MD010, no-hard-tabs)
Hard tabs

45-45: Column: 1 (MD010, no-hard-tabs)
Hard tabs

46-46: Column: 1 (MD010, no-hard-tabs)
Hard tabs

47-47: Column: 1 (MD010, no-hard-tabs)
Hard tabs

48-48: Column: 1 (MD010, no-hard-tabs)
Hard tabs

49-49: Column: 1 (MD010, no-hard-tabs)
Hard tabs

51-51: Column: 1 (MD010, no-hard-tabs)
Hard tabs

52-52: Column: 1 (MD010, no-hard-tabs)
Hard tabs

53-53: Column: 1 (MD010, no-hard-tabs)
Hard tabs

55-55: Column: 1 (MD010, no-hard-tabs)
Hard tabs

84-84: Column: 1 (MD010, no-hard-tabs)
Hard tabs

85-85: Column: 1 (MD010, no-hard-tabs)
Hard tabs

86-86: Column: 1 (MD010, no-hard-tabs)
Hard tabs

87-87: Column: 1 (MD010, no-hard-tabs)
Hard tabs

88-88: Column: 1 (MD010, no-hard-tabs)
Hard tabs

89-89: Column: 1 (MD010, no-hard-tabs)
Hard tabs

93-93: Column: 1 (MD010, no-hard-tabs)
Hard tabs

94-94: Column: 1 (MD010, no-hard-tabs)
Hard tabs

95-95: Column: 1 (MD010, no-hard-tabs)
Hard tabs

96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs

97-97: Column: 1 (MD010, no-hard-tabs)
Hard tabs

101-101: Column: 1 (MD010, no-hard-tabs)
Hard tabs

102-102: Column: 1 (MD010, no-hard-tabs)
Hard tabs

104-104: Column: 1 (MD010, no-hard-tabs)
Hard tabs

105-105: Column: 1 (MD010, no-hard-tabs)
Hard tabs

106-106: Column: 1 (MD010, no-hard-tabs)
Hard tabs

107-107: Column: 1 (MD010, no-hard-tabs)
Hard tabs

111-111: Column: 1 (MD010, no-hard-tabs)
Hard tabs

113-113: Column: 1 (MD010, no-hard-tabs)
Hard tabs

114-114: Column: 1 (MD010, no-hard-tabs)
Hard tabs

115-115: Column: 1 (MD010, no-hard-tabs)
Hard tabs

116-116: Column: 1 (MD010, no-hard-tabs)
Hard tabs

117-117: Column: 1 (MD010, no-hard-tabs)
Hard tabs

118-118: Column: 1 (MD010, no-hard-tabs)
Hard tabs

122-122: Column: 1 (MD010, no-hard-tabs)
Hard tabs

124-124: Column: 1 (MD010, no-hard-tabs)
Hard tabs

125-125: Column: 1 (MD010, no-hard-tabs)
Hard tabs

126-126: Column: 1 (MD010, no-hard-tabs)
Hard tabs

127-127: Column: 1 (MD010, no-hard-tabs)
Hard tabs

128-128: Column: 1 (MD010, no-hard-tabs)
Hard tabs

130-130: Column: 1 (MD010, no-hard-tabs)
Hard tabs

131-131: Column: 1 (MD010, no-hard-tabs)
Hard tabs

132-132: Column: 1 (MD010, no-hard-tabs)
Hard tabs

133-133: Column: 1 (MD010, no-hard-tabs)
Hard tabs

134-134: Column: 1 (MD010, no-hard-tabs)
Hard tabs

135-135: Column: 1 (MD010, no-hard-tabs)
Hard tabs

136-136: Column: 1 (MD010, no-hard-tabs)
Hard tabs

137-137: Column: 1 (MD010, no-hard-tabs)
Hard tabs

138-138: Column: 1 (MD010, no-hard-tabs)
Hard tabs

140-140: Column: 1 (MD010, no-hard-tabs)
Hard tabs

166-166: Column: 1 (MD010, no-hard-tabs)
Hard tabs

167-167: Column: 1 (MD010, no-hard-tabs)
Hard tabs

168-168: Column: 1 (MD010, no-hard-tabs)
Hard tabs

169-169: Column: 1 (MD010, no-hard-tabs)
Hard tabs

177-177: Column: 1 (MD010, no-hard-tabs)
Hard tabs

179-179: Column: 1 (MD010, no-hard-tabs)
Hard tabs

180-180: Column: 1 (MD010, no-hard-tabs)
Hard tabs

181-181: Column: 1 (MD010, no-hard-tabs)
Hard tabs

182-182: Column: 1 (MD010, no-hard-tabs)
Hard tabs

184-184: Column: 1 (MD010, no-hard-tabs)
Hard tabs

185-185: Column: 1 (MD010, no-hard-tabs)
Hard tabs

186-186: Column: 1 (MD010, no-hard-tabs)
Hard tabs

187-187: Column: 1 (MD010, no-hard-tabs)
Hard tabs

188-188: Column: 1 (MD010, no-hard-tabs)
Hard tabs

189-189: Column: 1 (MD010, no-hard-tabs)
Hard tabs

191-191: Column: 1 (MD010, no-hard-tabs)
Hard tabs

192-192: Column: 1 (MD010, no-hard-tabs)
Hard tabs

193-193: Column: 1 (MD010, no-hard-tabs)
Hard tabs

195-195: Column: 1 (MD010, no-hard-tabs)
Hard tabs

196-196: Column: 1 (MD010, no-hard-tabs)
Hard tabs

197-197: Column: 1 (MD010, no-hard-tabs)
Hard tabs

199-199: Column: 1 (MD010, no-hard-tabs)
Hard tabs

231-231: Column: 1 (MD010, no-hard-tabs)
Hard tabs

232-232: Column: 1 (MD010, no-hard-tabs)
Hard tabs

233-233: Column: 1 (MD010, no-hard-tabs)
Hard tabs

234-234: Column: 1 (MD010, no-hard-tabs)
Hard tabs

235-235: Column: 1 (MD010, no-hard-tabs)
Hard tabs

236-236: Column: 1 (MD010, no-hard-tabs)
Hard tabs

237-237: Column: 1 (MD010, no-hard-tabs)
Hard tabs

238-238: Column: 1 (MD010, no-hard-tabs)
Hard tabs

239-239: Column: 1 (MD010, no-hard-tabs)
Hard tabs

240-240: Column: 1 (MD010, no-hard-tabs)
Hard tabs

241-241: Column: 1 (MD010, no-hard-tabs)
Hard tabs

242-242: Column: 1 (MD010, no-hard-tabs)
Hard tabs

75-75: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines

249-249: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines

Additional comments not posted (10)

middleware/keyauth/config.go (3)

9-9: The new type KeyauthKeyLookupFunc is well-defined and correctly encapsulates the expected functionality for a custom key lookup function. This type will facilitate the implementation of custom logic for key extraction from various parts of the request.

37-37: Adding the CustomKeyLookup field to the Config struct is a crucial enhancement. It allows users to specify custom key extraction logic, which can be more flexible and powerful than predefined methods. Ensure that this new capability is well-documented and examples are provided to guide users on how to implement their custom functions effectively.

58-60: The default configuration is updated to include the CustomKeyLookup with a default value of nil. This change is consistent with the optional nature of the custom key lookup functionality. It's good practice to ensure that existing configurations without this field will still function as expected.
middleware/keyauth/keyauth.go (3)
6-6: The import of the fmt package is appropriate given its usage in error formatting throughout the file. This is a necessary addition to support the new error handling strategies introduced in this update.

54-54: This line introduces a dynamic key lookup which enhances the flexibility of the middleware. However, ensure that this line is covered by unit tests to verify its functionality, especially in error scenarios.

97-97: The error handling within MultipleKeySourceLookup is robust, but it lacks test coverage for the line where a formatted error is returned. It's important to test error conditions to ensure they are handled correctly.

Verification successful

The test file middleware/keyauth/keyauth_test.go does include tests for error handling in the MultipleKeySourceLookup function, specifically in the TestCustomKeyUtilityFunctionErrors and TestMultipleKeyLookup functions. These tests verify that errors are correctly handled and reported.

middleware/keyauth/keyauth_test.go:

TestCustomKeyUtilityFunctionErrors

TestMultipleKeyLookup
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify test coverage for error handling in `MultipleKeySourceLookup`.

# Test: Search for test coverage on line 97. Expect: Coverage report should include this line.
codecov --file middleware/keyauth/keyauth.go --line 97
Length of output: 131

Script:
#!/bin/bash
# Locate the definition of the `MultipleKeySourceLookup` function in the codebase.
ast-grep --lang go --pattern 'func MultipleKeySourceLookup($_) $_' 
Length of output: 68

Script:
#!/bin/bash
# Refine the search to locate the definition of the `MultipleKeySourceLookup` function.
rg 'func MultipleKeySourceLookup' 
Length of output: 166

Script:
#!/bin/bash
# Search for test files that reference the `MultipleKeySourceLookup` function.
rg 'MultipleKeySourceLookup' --glob '*_test.go'
Length of output: 302

Script:
#!/bin/bash
# Display the contents of the test file to verify error handling coverage.
cat middleware/keyauth/keyauth_test.go
Length of output: 16592
Tools

GitHub Check: codecov/patch

[warning] 97-97: middleware/keyauth/keyauth.go#L97
Added line #L97 was not covered by tests
docs/middleware/keyauth.md (1)

222-223: The documentation update correctly reflects the new CustomKeyLookup configuration option, providing clear information on its purpose and usage. It's essential to ensure that the documentation remains in sync with the code changes to help users understand how to utilize the new features effectively.

middleware/keyauth/keyauth_test.go (3)

133-146: The test for handling invalid configurations correctly uses require.Panics to ensure that the middleware behaves as expected in this scenario. Including a cleanup step in the deferred function is a good practice to ensure resources are properly released even when a test fails.

148-159: These tests effectively check for errors in custom key utility functions, which is crucial for ensuring the robustness of the middleware's error handling capabilities. It's good to see comprehensive testing around the new functionality.

161-218: The test for MultipleKeyLookup is well-implemented, covering various scenarios including success and failure cases. This thorough testing ensures that the middleware can handle multiple sources of authentication keys correctly.

middleware/keyauth/keyauth.go

docs/middleware/keyauth.md

middleware/keyauth/config.go

middleware/keyauth/keyauth.go

coderabbitai

Actionable comments posted: 1

Outside diff range and nitpick comments (1)

docs/middleware/keyauth.md (1)
250-250: While the description of MultipleKeySourceLookup is clear, the utility of this function could be enhanced by providing a practical example of its use in a real-world scenario.
It would be helpful for users to see an example of `MultipleKeySourceLookup` in action. Consider adding a snippet that demonstrates its use, perhaps in combination with `SingleKeyLookup`, to handle multiple potential sources of authentication keys.
Tools

LanguageTool

[uncategorized] ~250-~250: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ... the above function until a key is found or the options are all exhausted

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1004aa0 and 961e8de.

Files selected for processing (1)

docs/middleware/keyauth.md (2 hunks)

Additional context used

Learnings (1)

docs/middleware/keyauth.md (1)

User: dave-gray101
PR: gofiber/fiber#3027
File: docs/api/middleware/keyauth.md:222-222
Timestamp: 2024-06-09T18:50:02.075Z
Learning: The `KeyLookup` field in the `keyauth` middleware does not support pipe-delimited keys. Instead, it specifies a single source and name for key extraction, with additional sources specified in the `FallbackKeyLookups` field.

LanguageTool

docs/middleware/keyauth.md

[uncategorized] ~7-~7: This expression is usually spelled with a hyphen. (BASED_HYPHEN)
Context: ...Keyauth Key auth middleware provides a key based authentication. ## Signatures ```go f...

[uncategorized] ~78-~78: The abbreviation “e.g.” (= for example) requires two periods. (E_G)
Context: ...of keyauth and apply a filter function (eg. authFilter) like so ```go package ma...

[uncategorized] ~250-~250: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ... the above function until a key is found or the options are all exhausted

Markdownlint

docs/middleware/keyauth.md

22-22: Column: 1 (MD010, no-hard-tabs)
Hard tabs

23-23: Column: 1 (MD010, no-hard-tabs)
Hard tabs

24-24: Column: 1 (MD010, no-hard-tabs)
Hard tabs

25-25: Column: 1 (MD010, no-hard-tabs)
Hard tabs

29-29: Column: 1 (MD010, no-hard-tabs)
Hard tabs

33-33: Column: 1 (MD010, no-hard-tabs)
Hard tabs

34-34: Column: 1 (MD010, no-hard-tabs)
Hard tabs

36-36: Column: 1 (MD010, no-hard-tabs)
Hard tabs

37-37: Column: 1 (MD010, no-hard-tabs)
Hard tabs

38-38: Column: 1 (MD010, no-hard-tabs)
Hard tabs

39-39: Column: 1 (MD010, no-hard-tabs)
Hard tabs

43-43: Column: 1 (MD010, no-hard-tabs)
Hard tabs

45-45: Column: 1 (MD010, no-hard-tabs)
Hard tabs

46-46: Column: 1 (MD010, no-hard-tabs)
Hard tabs

47-47: Column: 1 (MD010, no-hard-tabs)
Hard tabs

48-48: Column: 1 (MD010, no-hard-tabs)
Hard tabs

49-49: Column: 1 (MD010, no-hard-tabs)
Hard tabs

51-51: Column: 1 (MD010, no-hard-tabs)
Hard tabs

52-52: Column: 1 (MD010, no-hard-tabs)
Hard tabs

53-53: Column: 1 (MD010, no-hard-tabs)
Hard tabs

55-55: Column: 1 (MD010, no-hard-tabs)
Hard tabs

84-84: Column: 1 (MD010, no-hard-tabs)
Hard tabs

85-85: Column: 1 (MD010, no-hard-tabs)
Hard tabs

86-86: Column: 1 (MD010, no-hard-tabs)
Hard tabs

87-87: Column: 1 (MD010, no-hard-tabs)
Hard tabs

88-88: Column: 1 (MD010, no-hard-tabs)
Hard tabs

89-89: Column: 1 (MD010, no-hard-tabs)
Hard tabs

93-93: Column: 1 (MD010, no-hard-tabs)
Hard tabs

94-94: Column: 1 (MD010, no-hard-tabs)
Hard tabs

95-95: Column: 1 (MD010, no-hard-tabs)
Hard tabs

96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs

97-97: Column: 1 (MD010, no-hard-tabs)
Hard tabs

101-101: Column: 1 (MD010, no-hard-tabs)
Hard tabs

102-102: Column: 1 (MD010, no-hard-tabs)
Hard tabs

104-104: Column: 1 (MD010, no-hard-tabs)
Hard tabs

105-105: Column: 1 (MD010, no-hard-tabs)
Hard tabs

106-106: Column: 1 (MD010, no-hard-tabs)
Hard tabs

107-107: Column: 1 (MD010, no-hard-tabs)
Hard tabs

111-111: Column: 1 (MD010, no-hard-tabs)
Hard tabs

113-113: Column: 1 (MD010, no-hard-tabs)
Hard tabs

114-114: Column: 1 (MD010, no-hard-tabs)
Hard tabs

115-115: Column: 1 (MD010, no-hard-tabs)
Hard tabs

116-116: Column: 1 (MD010, no-hard-tabs)
Hard tabs

117-117: Column: 1 (MD010, no-hard-tabs)
Hard tabs

118-118: Column: 1 (MD010, no-hard-tabs)
Hard tabs

122-122: Column: 1 (MD010, no-hard-tabs)
Hard tabs

124-124: Column: 1 (MD010, no-hard-tabs)
Hard tabs

125-125: Column: 1 (MD010, no-hard-tabs)
Hard tabs

126-126: Column: 1 (MD010, no-hard-tabs)
Hard tabs

127-127: Column: 1 (MD010, no-hard-tabs)
Hard tabs

128-128: Column: 1 (MD010, no-hard-tabs)
Hard tabs

130-130: Column: 1 (MD010, no-hard-tabs)
Hard tabs

131-131: Column: 1 (MD010, no-hard-tabs)
Hard tabs

132-132: Column: 1 (MD010, no-hard-tabs)
Hard tabs

133-133: Column: 1 (MD010, no-hard-tabs)
Hard tabs

134-134: Column: 1 (MD010, no-hard-tabs)
Hard tabs

135-135: Column: 1 (MD010, no-hard-tabs)
Hard tabs

136-136: Column: 1 (MD010, no-hard-tabs)
Hard tabs

137-137: Column: 1 (MD010, no-hard-tabs)
Hard tabs

138-138: Column: 1 (MD010, no-hard-tabs)
Hard tabs

140-140: Column: 1 (MD010, no-hard-tabs)
Hard tabs

166-166: Column: 1 (MD010, no-hard-tabs)
Hard tabs

167-167: Column: 1 (MD010, no-hard-tabs)
Hard tabs

168-168: Column: 1 (MD010, no-hard-tabs)
Hard tabs

169-169: Column: 1 (MD010, no-hard-tabs)
Hard tabs

177-177: Column: 1 (MD010, no-hard-tabs)
Hard tabs

179-179: Column: 1 (MD010, no-hard-tabs)
Hard tabs

180-180: Column: 1 (MD010, no-hard-tabs)
Hard tabs

181-181: Column: 1 (MD010, no-hard-tabs)
Hard tabs

182-182: Column: 1 (MD010, no-hard-tabs)
Hard tabs

184-184: Column: 1 (MD010, no-hard-tabs)
Hard tabs

185-185: Column: 1 (MD010, no-hard-tabs)
Hard tabs

186-186: Column: 1 (MD010, no-hard-tabs)
Hard tabs

187-187: Column: 1 (MD010, no-hard-tabs)
Hard tabs

188-188: Column: 1 (MD010, no-hard-tabs)
Hard tabs

189-189: Column: 1 (MD010, no-hard-tabs)
Hard tabs

191-191: Column: 1 (MD010, no-hard-tabs)
Hard tabs

192-192: Column: 1 (MD010, no-hard-tabs)
Hard tabs

193-193: Column: 1 (MD010, no-hard-tabs)
Hard tabs

195-195: Column: 1 (MD010, no-hard-tabs)
Hard tabs

196-196: Column: 1 (MD010, no-hard-tabs)
Hard tabs

197-197: Column: 1 (MD010, no-hard-tabs)
Hard tabs

199-199: Column: 1 (MD010, no-hard-tabs)
Hard tabs

231-231: Column: 1 (MD010, no-hard-tabs)
Hard tabs

232-232: Column: 1 (MD010, no-hard-tabs)
Hard tabs

233-233: Column: 1 (MD010, no-hard-tabs)
Hard tabs

234-234: Column: 1 (MD010, no-hard-tabs)
Hard tabs

235-235: Column: 1 (MD010, no-hard-tabs)
Hard tabs

236-236: Column: 1 (MD010, no-hard-tabs)
Hard tabs

237-237: Column: 1 (MD010, no-hard-tabs)
Hard tabs

238-238: Column: 1 (MD010, no-hard-tabs)
Hard tabs

239-239: Column: 1 (MD010, no-hard-tabs)
Hard tabs

240-240: Column: 1 (MD010, no-hard-tabs)
Hard tabs

241-241: Column: 1 (MD010, no-hard-tabs)
Hard tabs

242-242: Column: 1 (MD010, no-hard-tabs)
Hard tabs

75-75: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines

249-249: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines

docs/middleware/keyauth.md

Signed-off-by: Dave Lee <dave@gray101.com>

…101/fiber into feat-keyauth-fallback-keylookup

Signed-off-by: Dave Lee <dave@gray101.com>

dave-gray101 · 2024-06-16T23:45:34Z

@sixcolors I've addressed your comments, thanks for the review!

coderabbitai

Actionable comments posted: 5

Outside diff range and nitpick comments (2)

middleware/keyauth/keyauth.go (1)
[!TIP]
Codebase Verification

The current implementation does not handle the scenario where valid is false but err is nil. This could indeed lead to unintended behavior where an invalid key is treated as valid.

File: middleware/keyauth/keyauth.go

Lines: 51-57

Category:

Analysis chain

Line range hint 54-61: Ensure that the key validation logic handles all error scenarios appropriately.

The current implementation does not check for the scenario where valid is false but err is nil. This could lead to unintended behavior where an invalid key is treated as valid.
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Verify all error handling paths in the key validation logic.
grep -C 3 "cfg.Validator" middleware/keyauth/keyauth.go
Length of output: 188

Script:
#!/bin/bash
# Expand the context to gather more lines around the cfg.Validator call to see the complete error handling logic.
grep -C 10 "cfg.Validator" middleware/keyauth/keyauth.go
Length of output: 481
docs/middleware/keyauth.md (1)
223-223: Clarify the usage of CustomKeyLookup in the documentation.

The description of CustomKeyLookup could be enhanced by including a simple usage example directly in the documentation. This helps users understand how to implement custom key extraction functions.
Consider adding a simple example of `CustomKeyLookup` here to illustrate its usage, which can help developers understand how to implement it effectively. For example:
```go
func customKeyExtractor(c fiber.Ctx) (string, error) {
    // Custom logic to extract key
    return c.Cookies("custom_key"), nil
}

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 961e8de and 26bc132.

Files selected for processing (4)

docs/middleware/keyauth.md (2 hunks)
middleware/keyauth/config.go (3 hunks)
middleware/keyauth/keyauth.go (8 hunks)
middleware/keyauth/keyauth_test.go (2 hunks)

Files skipped from review as they are similar to previous changes (1)

middleware/keyauth/config.go

Additional context used

Learnings (1)

docs/middleware/keyauth.md (1)

User: dave-gray101
PR: gofiber/fiber#3027
File: docs/api/middleware/keyauth.md:222-222
Timestamp: 2024-06-09T18:50:02.075Z
Learning: The `KeyLookup` field in the `keyauth` middleware does not support pipe-delimited keys. Instead, it specifies a single source and name for key extraction, with additional sources specified in the `FallbackKeyLookups` field.

LanguageTool

docs/middleware/keyauth.md

[uncategorized] ~7-~7: This expression is usually spelled with a hyphen. (BASED_HYPHEN)
Context: ...Keyauth Key auth middleware provides a key based authentication. ## Signatures ```go f...

[uncategorized] ~78-~78: The abbreviation “e.g.” (= for example) requires two periods. (E_G)
Context: ...of keyauth and apply a filter function (eg. authFilter) like so ```go package ma...

[uncategorized] ~250-~250: Use a comma before “or” if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ... the above function until a key is found or the options are all exhausted. For exam...

Markdownlint

docs/middleware/keyauth.md

22-22: Column: 1 (MD010, no-hard-tabs)
Hard tabs

23-23: Column: 1 (MD010, no-hard-tabs)
Hard tabs

24-24: Column: 1 (MD010, no-hard-tabs)
Hard tabs

25-25: Column: 1 (MD010, no-hard-tabs)
Hard tabs

29-29: Column: 1 (MD010, no-hard-tabs)
Hard tabs

33-33: Column: 1 (MD010, no-hard-tabs)
Hard tabs

34-34: Column: 1 (MD010, no-hard-tabs)
Hard tabs

36-36: Column: 1 (MD010, no-hard-tabs)
Hard tabs

37-37: Column: 1 (MD010, no-hard-tabs)
Hard tabs

38-38: Column: 1 (MD010, no-hard-tabs)
Hard tabs

39-39: Column: 1 (MD010, no-hard-tabs)
Hard tabs

43-43: Column: 1 (MD010, no-hard-tabs)
Hard tabs

45-45: Column: 1 (MD010, no-hard-tabs)
Hard tabs

46-46: Column: 1 (MD010, no-hard-tabs)
Hard tabs

47-47: Column: 1 (MD010, no-hard-tabs)
Hard tabs

48-48: Column: 1 (MD010, no-hard-tabs)
Hard tabs

49-49: Column: 1 (MD010, no-hard-tabs)
Hard tabs

51-51: Column: 1 (MD010, no-hard-tabs)
Hard tabs

52-52: Column: 1 (MD010, no-hard-tabs)
Hard tabs

53-53: Column: 1 (MD010, no-hard-tabs)
Hard tabs

55-55: Column: 1 (MD010, no-hard-tabs)
Hard tabs

84-84: Column: 1 (MD010, no-hard-tabs)
Hard tabs

85-85: Column: 1 (MD010, no-hard-tabs)
Hard tabs

86-86: Column: 1 (MD010, no-hard-tabs)
Hard tabs

87-87: Column: 1 (MD010, no-hard-tabs)
Hard tabs

88-88: Column: 1 (MD010, no-hard-tabs)
Hard tabs

89-89: Column: 1 (MD010, no-hard-tabs)
Hard tabs

93-93: Column: 1 (MD010, no-hard-tabs)
Hard tabs

94-94: Column: 1 (MD010, no-hard-tabs)
Hard tabs

95-95: Column: 1 (MD010, no-hard-tabs)
Hard tabs

96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs

97-97: Column: 1 (MD010, no-hard-tabs)
Hard tabs

101-101: Column: 1 (MD010, no-hard-tabs)
Hard tabs

102-102: Column: 1 (MD010, no-hard-tabs)
Hard tabs

104-104: Column: 1 (MD010, no-hard-tabs)
Hard tabs

105-105: Column: 1 (MD010, no-hard-tabs)
Hard tabs

106-106: Column: 1 (MD010, no-hard-tabs)
Hard tabs

107-107: Column: 1 (MD010, no-hard-tabs)
Hard tabs

111-111: Column: 1 (MD010, no-hard-tabs)
Hard tabs

113-113: Column: 1 (MD010, no-hard-tabs)
Hard tabs

114-114: Column: 1 (MD010, no-hard-tabs)
Hard tabs

115-115: Column: 1 (MD010, no-hard-tabs)
Hard tabs

116-116: Column: 1 (MD010, no-hard-tabs)
Hard tabs

117-117: Column: 1 (MD010, no-hard-tabs)
Hard tabs

118-118: Column: 1 (MD010, no-hard-tabs)
Hard tabs

122-122: Column: 1 (MD010, no-hard-tabs)
Hard tabs

124-124: Column: 1 (MD010, no-hard-tabs)
Hard tabs

125-125: Column: 1 (MD010, no-hard-tabs)
Hard tabs

126-126: Column: 1 (MD010, no-hard-tabs)
Hard tabs

127-127: Column: 1 (MD010, no-hard-tabs)
Hard tabs

128-128: Column: 1 (MD010, no-hard-tabs)
Hard tabs

130-130: Column: 1 (MD010, no-hard-tabs)
Hard tabs

131-131: Column: 1 (MD010, no-hard-tabs)
Hard tabs

132-132: Column: 1 (MD010, no-hard-tabs)
Hard tabs

133-133: Column: 1 (MD010, no-hard-tabs)
Hard tabs

134-134: Column: 1 (MD010, no-hard-tabs)
Hard tabs

135-135: Column: 1 (MD010, no-hard-tabs)
Hard tabs

136-136: Column: 1 (MD010, no-hard-tabs)
Hard tabs

137-137: Column: 1 (MD010, no-hard-tabs)
Hard tabs

138-138: Column: 1 (MD010, no-hard-tabs)
Hard tabs

140-140: Column: 1 (MD010, no-hard-tabs)
Hard tabs

166-166: Column: 1 (MD010, no-hard-tabs)
Hard tabs

167-167: Column: 1 (MD010, no-hard-tabs)
Hard tabs

168-168: Column: 1 (MD010, no-hard-tabs)
Hard tabs

169-169: Column: 1 (MD010, no-hard-tabs)
Hard tabs

177-177: Column: 1 (MD010, no-hard-tabs)
Hard tabs

179-179: Column: 1 (MD010, no-hard-tabs)
Hard tabs

180-180: Column: 1 (MD010, no-hard-tabs)
Hard tabs

181-181: Column: 1 (MD010, no-hard-tabs)
Hard tabs

182-182: Column: 1 (MD010, no-hard-tabs)
Hard tabs

184-184: Column: 1 (MD010, no-hard-tabs)
Hard tabs

185-185: Column: 1 (MD010, no-hard-tabs)
Hard tabs

186-186: Column: 1 (MD010, no-hard-tabs)
Hard tabs

187-187: Column: 1 (MD010, no-hard-tabs)
Hard tabs

188-188: Column: 1 (MD010, no-hard-tabs)
Hard tabs

189-189: Column: 1 (MD010, no-hard-tabs)
Hard tabs

191-191: Column: 1 (MD010, no-hard-tabs)
Hard tabs

192-192: Column: 1 (MD010, no-hard-tabs)
Hard tabs

193-193: Column: 1 (MD010, no-hard-tabs)
Hard tabs

195-195: Column: 1 (MD010, no-hard-tabs)
Hard tabs

196-196: Column: 1 (MD010, no-hard-tabs)
Hard tabs

197-197: Column: 1 (MD010, no-hard-tabs)
Hard tabs

199-199: Column: 1 (MD010, no-hard-tabs)
Hard tabs

231-231: Column: 1 (MD010, no-hard-tabs)
Hard tabs

232-232: Column: 1 (MD010, no-hard-tabs)
Hard tabs

233-233: Column: 1 (MD010, no-hard-tabs)
Hard tabs

234-234: Column: 1 (MD010, no-hard-tabs)
Hard tabs

235-235: Column: 1 (MD010, no-hard-tabs)
Hard tabs

236-236: Column: 1 (MD010, no-hard-tabs)
Hard tabs

237-237: Column: 1 (MD010, no-hard-tabs)
Hard tabs

238-238: Column: 1 (MD010, no-hard-tabs)
Hard tabs

239-239: Column: 1 (MD010, no-hard-tabs)
Hard tabs

240-240: Column: 1 (MD010, no-hard-tabs)
Hard tabs

241-241: Column: 1 (MD010, no-hard-tabs)
Hard tabs

242-242: Column: 1 (MD010, no-hard-tabs)
Hard tabs

75-75: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines

249-249: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines

middleware/keyauth/keyauth.go

middleware/keyauth/keyauth_test.go

…rk purely defensive code Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 26bc132 and 9588706.

Files selected for processing (2)

middleware/keyauth/keyauth.go (8 hunks)
middleware/keyauth/keyauth_test.go (2 hunks)

Files skipped from review as they are similar to previous changes (1)

middleware/keyauth/keyauth_test.go

Additional context used

GitHub Check: codecov/patch

middleware/keyauth/keyauth.go

[warning] 98-98: middleware/keyauth/keyauth.go#L98
Added line #L98 was not covered by tests

Additional comments not posted (10)

middleware/keyauth/keyauth.go (10)
6-6: Import of fmt package to support error formatting.

54-54: Extraction and verification of key using the newly introduced CustomKeyLookup.

104-122: Refinement of DefaultKeyLookup function to include more descriptive error messages and support various key sources.

125-125: Simple header extraction logic in KeyFromHeader function.

140-140: Key extraction from query parameters in KeyFromQuery.

151-151: Key extraction from form data in KeyFromForm.

162-162: Key extraction from URL parameters in KeyFromParam.

173-173: Key extraction from cookies in KeyFromCookie.

79-102: Implementation of MultipleKeySourceLookup function to support multiple key sources.

Verification successful

The usage of errors.Is in the MultipleKeySourceLookup function is consistent with other parts of the middleware directory.

middleware/timeout/timeout.go

middleware/keyauth/keyauth.go

middleware/keyauth/config.go

middleware/csrf/csrf.go
Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify if the error handling in `MultipleKeySourceLookup` is consistent with other parts of the project.
rg --type go "errors.Is" src/middleware
Length of output: 94

Script:
#!/bin/bash
# Find the directory containing the `keyauth.go` file
fd keyauth.go

# Find all Go files under the middleware directory to locate the correct path
fd . --type f --extension go | grep middleware
Length of output: 3663

Script:
#!/bin/bash
# Verify the usage of `errors.Is` within the middleware directory to check for consistency in error handling
rg --type go "errors.Is" middleware
Length of output: 407
Tools

GitHub Check: codecov/patch

[warning] 98-98: middleware/keyauth/keyauth.go#L98
Added line #L98 was not covered by tests

38-43: Using panic for error handling in the initialization of the middleware.

Previous discussions suggest that using panic might be intentional to prevent the server from starting with invalid middleware configurations. However, consider providing a more graceful error handling mechanism that allows the caller to handle errors, especially in a library context.
- panic(fmt.Errorf("unable to create lookup function: %w", err))
+ return nil, fmt.Errorf("unable to create lookup function: %w", err)

gaby

LGTM

dave-gray101 · 2024-06-20T03:05:02Z

@sixcolors when you get a chance, please let me know if there's any other changes you'd like me to make. Thanks!

sixcolors · 2024-06-26T18:02:32Z

@sixcolors when you get a chance, please let me know if there's any other changes you'd like me to make. Thanks!

Will review tomorrow, thanks for your patience and efforts to make fiber better!

sixcolors

LGTM

welcome · 2024-06-27T18:30:51Z

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

port over FallbackKeyLookups from v2 middleware to v3

0b6b5e9

Signed-off-by: Dave Lee <dave@gray101.com>

dave-gray101 requested a review from a team as a code owner June 9, 2024 21:07

dave-gray101 requested review from ReneWerner87, efectn, gaby and sixcolors and removed request for a team June 9, 2024 21:07

coderabbitai bot reviewed Jun 9, 2024

View reviewed changes

middleware/keyauth/keyauth.go Outdated Show resolved Hide resolved

bot pointed out that I missed the format variable

f118663

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai bot reviewed Jun 9, 2024

View reviewed changes

middleware/keyauth/keyauth.go Outdated Show resolved Hide resolved

middleware/keyauth/keyauth.go Outdated Show resolved Hide resolved

gaby added v3 ✏️ Feature labels Jun 9, 2024

fix lint and gofumpt issues

a432b80

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai bot reviewed Jun 10, 2024

View reviewed changes

middleware/keyauth/keyauth.go Outdated Show resolved Hide resolved

middleware/keyauth/keyauth.go Outdated Show resolved Hide resolved

major revision: instead of FallbackKeyLookups, expose CustomKeyLookup…

4e061aa

… as function, with utility functions to make creating these easy Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai bot reviewed Jun 10, 2024

View reviewed changes

dave-gray101 changed the title ~~🔥 Feature: Add support for multiple keys in the KeyAuth middleware~~ 🔥 Feature: Add support for custom KeyLookup functions in the Keyauth middleware Jun 10, 2024

add more tests to boost coverage

397ff49

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai bot reviewed Jun 10, 2024

View reviewed changes

middleware/keyauth/keyauth_test.go Outdated Show resolved Hide resolved

middleware/keyauth/keyauth_test.go Show resolved Hide resolved

teardown code and cleanup

2968439

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai bot reviewed Jun 10, 2024

View reviewed changes

middleware/keyauth/keyauth.go Outdated Show resolved Hide resolved

middleware/keyauth/keyauth_test.go Show resolved Hide resolved

middleware/keyauth/keyauth_test.go Show resolved Hide resolved

gaby and others added 2 commits June 11, 2024 08:32

Merge branch 'main' into feat-keyauth-fallback-keylookup

5b24181

test fixes

7bfc96d

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai bot reviewed Jun 16, 2024

View reviewed changes

middleware/keyauth/keyauth.go Show resolved Hide resolved

sixcolors requested changes Jun 16, 2024

View reviewed changes

docs: fix md table alignment

961e8de

coderabbitai bot reviewed Jun 16, 2024

View reviewed changes

docs/middleware/keyauth.md Outdated Show resolved Hide resolved

dave-gray101 added 3 commits June 16, 2024 19:43

fix comments - change some names, expose functions, improve docs

293c01b

Signed-off-by: Dave Lee <dave@gray101.com>

Merge branch 'feat-keyauth-fallback-keylookup' of ghgray101:dave-gray…

825e11a

…101/fiber into feat-keyauth-fallback-keylookup

missed one old name

26bc132

Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai bot reviewed Jun 16, 2024

View reviewed changes

fix some suggestions from the bot - error messages, test coverage, ma…

9588706

…rk purely defensive code Signed-off-by: Dave Lee <dave@gray101.com>

coderabbitai bot reviewed Jun 17, 2024

View reviewed changes

ReneWerner87 added this to the v3 milestone Jun 17, 2024

Merge branch 'main' into feat-keyauth-fallback-keylookup

2711dc3

gaby approved these changes Jun 17, 2024

View reviewed changes

dave-gray101 requested a review from sixcolors June 17, 2024 16:49

Merge branch 'main' into feat-keyauth-fallback-keylookup

4da76e4

Merge branch 'main' into feat-keyauth-fallback-keylookup

12eeca8

ReneWerner87 approved these changes Jun 26, 2024

View reviewed changes

Merge branch 'main' into feat-keyauth-fallback-keylookup

d6d5bfe

sixcolors approved these changes Jun 27, 2024

View reviewed changes

ReneWerner87 merged commit 2db1858 into gofiber:main Jun 27, 2024

This was referenced Aug 13, 2025

Switch KeyAuth to extractor pattern #3651

Closed

Refactor KeyAuth Middleware: Extractor-Based Configuration and Enhanced Flexibility #3685

Merged

Uh oh!

Conversation

dave-gray101 commented Jun 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes introduced

Type of change

Uh oh!

coderabbitai bot commented Jun 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Jun 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gaby commented Jun 9, 2024

Uh oh!

sixcolors commented Jun 10, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dave-gray101 commented Jun 10, 2024

Uh oh!

dave-gray101 commented Jun 10, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

dave-gray101 commented Jun 10, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dave-gray101 commented Jun 16, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

gaby commented Jun 16, 2024

Uh oh!

coderabbitai bot commented Jun 16, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dave-gray101 commented Jun 9, 2024 •

edited

Loading

coderabbitai bot commented Jun 9, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented Jun 9, 2024 •

edited

Loading