fix(hsts): split hsts into WriteHeader and Redirect #31

cnlangzi · 2025-01-24T05:34:01Z

Changed

split hsts.Enable into hsts.Redirect for http request, and hsts.WriteHeader for https request

Fixed

Added

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

Split the HSTS middleware into two separate middlewares: Redirect and WriteHeader. Redirect redirects HTTP requests to HTTPS, and WriteHeader sets the Strict-Transport-Security header for HTTPS requests.

Enhancements:

Refactor the HSTS middleware to improve clarity and testability.

Tests:

Add unit tests for the new Redirect and WriteHeader middlewares.

sourcery-ai · 2025-01-24T05:34:05Z

Reviewer's Guide by Sourcery

This pull request splits the HSTS middleware into two separate middlewares: WriteHeader and Redirect. WriteHeader is used for HTTPS requests and sets the Strict-Transport-Security header. Redirect is used for HTTP requests and redirects them to HTTPS.

Sequence diagram for HSTS middleware before and after split

sequenceDiagram
    participant Client
    participant HSTS_Before as HSTS (Before)
    participant HSTS_After as HSTS (After)
    participant App

    Note over HSTS_Before: Single middleware handling both HTTP and HTTPS
    Client->>HSTS_Before: HTTP Request
    HSTS_Before-->>Client: Redirect to HTTPS
    Client->>HSTS_Before: HTTPS Request
    HSTS_Before->>HSTS_Before: Set STS Header
    HSTS_Before->>App: Forward Request

    Note over HSTS_After: Split into two middlewares
    Client->>HSTS_After: HTTP Request
    rect rgb(200, 200, 200)
        Note right of HSTS_After: Redirect Middleware
        HSTS_After-->>Client: Redirect to HTTPS
    end
    Client->>HSTS_After: HTTPS Request
    rect rgb(200, 200, 200)
        Note right of HSTS_After: WriteHeader Middleware
        HSTS_After->>HSTS_After: Set STS Header
        HSTS_After->>App: Forward Request
    end

Class diagram for HSTS middleware changes

classDiagram
    class Config {
        +int64 MaxAge
        +bool IncludeSubDomains
        +bool Preload
    }

    class HSTS_Old {
        +Enable(opts ...Option) Middleware
    }
    note for HSTS_Old "Before: Single middleware"

    class HSTS_New {
        +WriteHeader(opts ...Option) Middleware
        +Redirect() Middleware
    }
    note for HSTS_New "After: Split into two middlewares"

    HSTS_Old ..> Config
    HSTS_New ..> Config

Flow diagram for HSTS request handling

flowchart TD
    A[Request] --> B{Is HTTPS?}
    B -->|No| C[Redirect Middleware]
    B -->|Yes| D[WriteHeader Middleware]
    C --> E[Return 302 Found]
    C --> F[Redirect to HTTPS URL]
    D --> G[Set STS Header]
    D --> H[Continue Request]

File-Level Changes

Change	Details	Files
Split the HSTS middleware into `WriteHeader` and `Redirect`	The `Enable` middleware was split into `WriteHeader` and `Redirect` middlewares. The `WriteHeader` middleware sets the `Strict-Transport-Security` header for HTTPS requests. The `Redirect` middleware redirects HTTP requests to HTTPS. The `WithDomains` option was renamed to `WithIncludeSubDomains`. The `WithPreload` option now sets the preload value to true.	`ext/hsts/hsts_test.go` `ext/hsts/hsts.go` `ext/hsts/option.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.

sourcery-ai

Hey @cnlangzi - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟢 General issues: all looks good
🟡 Security: 1 issue found
🟢 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/hsts.go

deepsource-io · 2025-01-24T05:34:54Z

Here's the code health analysis summary for commits 87e3e56..c51ae5b. 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-01-24T05:35:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.66%. Comparing base (87e3e56) to head (c51ae5b).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #31      +/-   ##
==========================================
+ Coverage   90.53%   90.66%   +0.12%     
==========================================
  Files          37       37              
  Lines        1279     1286       +7     
==========================================
+ Hits         1158     1166       +8     
+ Misses         84       83       -1     
  Partials       37       37

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

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.

fix(hsts): split hsts into WriteHeader and Redirect

56fc1fe

sourcery-ai bot reviewed Jan 24, 2025

View reviewed changes

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

fix(hsts): fixed warnings from review bots

c51ae5b

cnlangzi merged commit 4cd8e0c into main Jan 24, 2025
7 checks passed

cnlangzi deleted the fix/hsts_redirect branch January 24, 2025 05:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(hsts): split hsts into WriteHeader and Redirect #31

fix(hsts): split hsts into WriteHeader and Redirect #31

Uh oh!

cnlangzi commented Jan 24, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Jan 24, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

deepsource-io bot commented Jan 24, 2025 •

edited

Loading

Analysis Summary

Uh oh!

codecov bot commented Jan 24, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

fix(hsts): split hsts into WriteHeader and Redirect #31

fix(hsts): split hsts into WriteHeader and Redirect #31

Uh oh!

Conversation

cnlangzi commented Jan 24, 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 Jan 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for HSTS middleware before and after split

Class diagram for HSTS middleware changes

Flow diagram for HSTS request handling

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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

Uh oh!

Analysis Summary

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

cnlangzi commented Jan 24, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jan 24, 2025 •

edited

Loading

deepsource-io bot commented Jan 24, 2025 •

edited

Loading

codecov bot commented Jan 24, 2025 •

edited

Loading