Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Nov 6, 2024

add not found middleware

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4614

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Bug Fixes:

  • Add a handler for 404 Not Found errors that redirects users to the homepage.

Summary by Sourcery

Bug Fixes:

  • Add a handler for 404 Not Found errors that redirects users to the homepage.

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Nov 6, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 6, 2024
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 6, 2024

Reviewer's Guide by Sourcery

The PR implements a 404 Not Found error handler by adding middleware that redirects users to the homepage when a 404 status code is encountered. The implementation uses ASP.NET Core's UseStatusCodePages middleware with a custom handler function.

Sequence diagram for 404 Not Found middleware

sequenceDiagram
    actor User
    participant Server
    participant Middleware

    User->>Server: Request a non-existent page
    Server->>Middleware: 404 Not Found
    Middleware->>Server: Redirect to homepage
    Server->>User: Serve homepage
Loading

File-Level Changes

Change Details Files
Add status code handling middleware for 404 errors
  • Configure UseStatusCodePages middleware with a custom handler
  • Implement redirect to homepage ('/') when status code is 404
  • Use permanent redirect (true parameter in Redirect method)
src/BootstrapBlazor.Server/Program.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4614 Add sample code for handling 404 not found pages

Possibly linked issues


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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Nov 6, 2024
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Overall Comments:

  • Consider implementing a proper 404 page instead of redirecting to homepage. This would provide better user experience and maintain correct HTTP semantics.
  • It would be beneficial to add logging for 404 errors to help track and diagnose broken links or access issues.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues 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.

@codecov
Copy link

codecov bot commented Nov 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f099365) to head (96636ed).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4615   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27375     27375           
  Branches      3916      3916           
=========================================
  Hits         27375     27375           

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

@ArgoZhang ArgoZhang changed the title doc(404): add not found page handler doc(404): add not found middleware Nov 6, 2024
@ArgoZhang
Copy link
Member Author

@sourcery-ai review

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Overall Comments:

  • Automatically redirecting 404s to the homepage is not recommended as it can confuse users and mask real issues. Consider implementing a proper 404 page that informs users about the error instead.
  • Using permanent redirects (301) for 404s can cause browsers to cache the redirects permanently. If you must redirect (which is not recommended), use temporary redirects (302/303/307).
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.

@ArgoZhang ArgoZhang merged commit ed22793 into main Nov 6, 2024
4 checks passed
@ArgoZhang ArgoZhang deleted the doc-404 branch November 6, 2024 02:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc(404): add not found page handler

2 participants