fix(hsts): added StartsWith rule #44

cnlangzi · 2025-02-11T14:21:36Z

Changed

Fixed

Added

added StartsWith rule in Redirect

Tests

Tasks to complete before merging PR:

Ensure unit tests are passing. If not run make unit-test to check for any regressions 📋
Ensure lint tests are passing. if not run make lint to check for any issues
Ensure codecov/patch is passing for changes.

Summary by Sourcery

Add a new StartsWith rule to the Redirect middleware, allowing requests with paths that start with specific prefixes to be ignored by HSTS.

New Features:

Added the StartsWith rule to the Redirect middleware in the hsts extension.

Tests:

Added tests for the new StartsWith rule.

sourcery-ai · 2025-02-11T14:21:40Z

Reviewer's Guide by Sourcery

This pull request introduces a new HSTS middleware rule, 'StartsWith', that evaluates if a request path starts with a specified prefix after converting it to lowercase. Additionally, it refactors the existing rule by renaming the 'Ignore' function to 'Match' for clarity, and updates the tests to use both the new 'StartsWith' rule and the refactored naming.

Class diagram for HSTS Rules in Middleware

classDiagram
    %% Define function type for rules
    class IgnoreRule {
      <<Function>>
      +func(*http.Request) bool
    }

    %% Function that renames the previous 'Ignore' to 'Match'
    class Match {
      <<Function>>
      +func(...string) IgnoreRule
    }

    %% New function to create a rule that checks for lower case prefix in the URL path
    class StartsWith {
      <<Function>>
      +func(...string) IgnoreRule
    }

    %% Relationships indicating both functions return an IgnoreRule
    Match ..> IgnoreRule : returns
    StartsWith ..> IgnoreRule : returns

    %% Additional note regarding renaming for clarity
    note for Match "Renamed from 'Ignore' for clarity"

File-Level Changes

Change	Details	Files
Introduced the new 'StartsWith' rule for prefix-based request ignoring.	Added a new function that converts request paths to lowercase and matches prefixes. Documented the function behavior and requirements (paths must be lowercase).	`ext/hsts/option.go`
Refactored the existing route ignoring rule and updated test cases.	Renamed the 'Ignore' function to 'Match' to better reflect its behavior of matching exact paths. Modified test cases to include the new 'StartsWith' rule along with the 'Match' rule.	`ext/hsts/option.go` `ext/hsts/hsts_test.go`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

deepsource-io · 2025-02-11T14:22:26Z

Here's the code health analysis summary for commits 2e8d638..c813d0a. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Go	✅ Success		View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

codecov · 2025-02-11T14:22:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.47%. Comparing base (2e8d638) to head (c813d0a).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #44      +/-   ##
==========================================
+ Coverage   92.41%   92.47%   +0.05%     
==========================================
  Files          43       43              
  Lines        1662     1675      +13     
==========================================
+ Hits         1536     1549      +13     
  Misses         93       93              
  Partials       33       33

Flag	Coverage Δ
Unit-Tests	`92.47% <100.00%> (+0.05%)`	⬆️

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.

sourcery-ai

Hey @cnlangzi - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider renaming Match to Equal for clarity, as it checks for exact path equality.
The comment for StartsWith says paths MUST be lower case - should this be enforced in code?

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

ext/hsts/option.go

fix(hsts): added StartsWith rule

966aef1

sourcery-ai bot reviewed Feb 11, 2025

View reviewed changes

ext/hsts/option.go Outdated Show resolved Hide resolved

fix(hsts): automatically convert paths to lower-case

c813d0a

cnlangzi merged commit 9c23fef into main Feb 11, 2025
7 checks passed

cnlangzi deleted the fix/hsts branch February 11, 2025 14:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(hsts): added StartsWith rule #44

fix(hsts): added StartsWith rule #44

Uh oh!

cnlangzi commented Feb 11, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Feb 11, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

deepsource-io bot commented Feb 11, 2025 •

edited

Loading

Analysis Summary

Uh oh!

codecov bot commented Feb 11, 2025 •

edited

Loading

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(hsts): added StartsWith rule #44

fix(hsts): added StartsWith rule #44

Uh oh!

Conversation

cnlangzi commented Feb 11, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changed

Fixed

Added

Tests

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Class diagram for HSTS Rules in Middleware

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

deepsource-io bot commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Analysis Summary

Uh oh!

codecov bot commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cnlangzi commented Feb 11, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 11, 2025 •

edited

Loading

deepsource-io bot commented Feb 11, 2025 •

edited

Loading

codecov bot commented Feb 11, 2025 •

edited

Loading