🩹 Fix: static server in sub app with mount (#3104) #3132

yinheli · 2024-09-14T15:20:10Z

Description

This commit fixes an issue with static file serving in sub-app when using the Mount method. The problem was that static routes in sub-apps were not being properly handled when the sub-app was mounted to a parent app.

Key changes:

Modified the PathRewrite function in router.go to handle mount paths correctly for static file serving.
Updated the Test_Route_Static_SubApp test in router_test.go to include a nested sub-app scenario.
Added assertions to verify correct static file serving in both sub-app and nested sub-app cases.

Fixes #3104

Changes introduced

Examples:

parentApp := fiber.New()
subApp := fiber.New()

subApp.Static("/public", "./public")
parentApp.Mount("/sub", subApp)

// Now, "/sub/public/*" will correctly serve static files from the "./public" directory

Type of change

Enhancement (improvement to existing features and functionality)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
Conducted a self-review of the code and provided comments for complex or critical parts.
Updated the documentation in the /docs/ directory for Fiber's documentation.
Added or updated unit tests to validate the effectiveness of the changes or new features.
Ensured that new and existing unit tests pass locally with the changes.
Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
Aimed for optimal performance with minimal allocations in the new code.
Provided benchmarks for the new code to analyze and improve upon.

welcome · 2024-09-14T15:20:12Z

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

coderabbitai · 2024-09-14T15:20:23Z

Walkthrough

The pull request introduces modifications to the registerStatic function in the fiber package to enhance path handling for static file serving, particularly when applications are mounted at specific paths. It also adds two new test functions in router_test.go to verify the functionality of static file routing, ensuring that both direct access and access through sub-applications to static files work correctly. Additionally, a new field parentApp is added to the mountFields struct in mount.go to improve path management.

Changes

Files	Change Summary
`router.go`	Modified `registerStatic` function to enhance path rewriting logic for static file serving.
`router_test.go`	Added `Test_Route_Static_HasPrefix` and `Test_Route_Static_SubApp` to test static file routing functionality.
`mount.go`	Introduced `parentApp` field in `mountFields` struct and added `FullMountPath` method to `App` struct for better path management.

Assessment against linked issues

Objective	Addressed	Explanation
Static server in sub app does not work (Issue #3104)	✅

🐰 In the meadow where I hop and play,
A path was fixed to brighten the day.
Static files now serve with glee,
In sub-apps, they’re wild and free!
So come along, let’s cheer and sing,
For routing joy that changes bring! 🌼

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0bd4c0e and d415399.

Files selected for processing (3)

mount.go (3 hunks)
router.go (2 hunks)
router_test.go (2 hunks)

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

mount.go
router.go
router_test.go

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>, please review it.
-- 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 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 using 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

router_test.go

efectn · 2024-09-14T19:49:06Z

router_test.go

+	subApp := New()
+	subApp.Static("/css", dir)
+
+	app.Mount("/sub", subApp)


Can you add a testcase for nested mounting

Nested mounting is not working. I'll try to fix it.

gaby · 2024-09-15T00:56:37Z

@yinheli Does this issue affect v3 too? If so, can you do a Pull Request against main for v3. Thanks!

efectn · 2024-09-15T16:01:56Z

router.go

@@ -357,6 +358,12 @@ func (app *App) registerStatic(prefix, root string, config ...Static) {
 		IndexNames:           []string{"index.html"},
 		PathRewrite: func(fctx *fasthttp.RequestCtx) []byte {
 			path := fctx.Path()
+			mountPath := app.FullMountPath()
+			if n := len(mountPath); n > 0 {
+				if bytes.Equal(path[:n], utils.UnsafeBytes(mountPath)) {


You don't need two-level if here. You can write:

if n := len(mountPath); n > 0 && bytes.Equal(path[:n], utils.UnsafeBytes(mountPath)) { ... }

efectn · 2024-09-15T16:04:28Z

mount.go

@@ -23,6 +23,8 @@ type mountFields struct {
 	subAppsProcessed sync.Once
 	// Prefix of app if it was mounted
 	mountPath string
+	// Parent app of the current app


@ReneWerner87 do you think we should use full-mount path for mounting? I think this might be a bug related to MountPath

MountPath can only see that of subApp. Currently, the app cannot know how the upper layer is mounted. So I introduce a reference to Parent here. Do you have any good suggestions?

My current thinking is that when PathRewrite in registerStatic can replace the mounted part of the path.

@efectn @yinheli yes it should have something to do with the path
don't know if we necessarily need the complete parent reference for this

in the bug you said that the path is public/public, then we should start there

yinheli requested a review from a team as a code owner September 14, 2024 15:20

yinheli requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team September 14, 2024 15:20

gaby added ☢️ Bug v3 labels Sep 14, 2024

gaby reviewed Sep 14, 2024

View reviewed changes

router_test.go Show resolved Hide resolved

yinheli force-pushed the bugfix/static-server-in-sub-app branch 2 times, most recently from fe948ca to 506a800 Compare September 14, 2024 15:54

efectn reviewed Sep 14, 2024

View reviewed changes

gaby added v2 and removed v3 labels Sep 15, 2024

yinheli force-pushed the bugfix/static-server-in-sub-app branch 6 times, most recently from 733357b to 9808465 Compare September 15, 2024 16:01

efectn reviewed Sep 15, 2024

View reviewed changes

yinheli force-pushed the bugfix/static-server-in-sub-app branch 3 times, most recently from 1ddc40f to 258e56e Compare September 15, 2024 16:09

🩹 Fix: static server in sub app with mount (gofiber#3104)

d415399

yinheli force-pushed the bugfix/static-server-in-sub-app branch from 258e56e to d415399 Compare September 15, 2024 16:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🩹 Fix: static server in sub app with mount (#3104) #3132

🩹 Fix: static server in sub app with mount (#3104) #3132

yinheli commented Sep 14, 2024 •

edited

Loading

welcome bot commented Sep 14, 2024

coderabbitai bot commented Sep 14, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

efectn Sep 14, 2024

yinheli Sep 15, 2024

gaby commented Sep 15, 2024

efectn Sep 15, 2024

efectn Sep 15, 2024

yinheli Sep 15, 2024

ReneWerner87 Sep 19, 2024

🩹 Fix: static server in sub app with mount (#3104) #3132

Are you sure you want to change the base?

🩹 Fix: static server in sub app with mount (#3104) #3132

Conversation

yinheli commented Sep 14, 2024 • edited Loading

Description

Changes introduced

Type of change

Checklist

welcome bot commented Sep 14, 2024

coderabbitai bot commented Sep 14, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

efectn Sep 14, 2024

Choose a reason for hiding this comment

yinheli Sep 15, 2024

Choose a reason for hiding this comment

gaby commented Sep 15, 2024

efectn Sep 15, 2024

Choose a reason for hiding this comment

efectn Sep 15, 2024

Choose a reason for hiding this comment

yinheli Sep 15, 2024

Choose a reason for hiding this comment

ReneWerner87 Sep 19, 2024

Choose a reason for hiding this comment

yinheli commented Sep 14, 2024 •

edited

Loading

coderabbitai bot commented Sep 14, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)