Provide a way to set fallback file extensions for FileService
#5806
Conversation
Motivation: I personally prefer clean URL patterns without a trailing slash. `/app/projects` is prefered over `/app/projects/`. If I built `/app/projects` with a Javascript framework, `/app/projects/index.html` or `/app/projects.html` may be exported by the framework. In `FileService`, `/app/projects/index.html` can be served by `/app/projects/` path, but cannot be found by `/app/projects`. Handling trailing slash is tricky and difficult to modify. Alternatively, I propose an option that appends an extension if there is no file for the request path. For example, a request sent to `/app/projects` also finds `/app/projects.[ext]` as a fallback. Relate links: - line#4542 - line#1655 - https://ktor.io/docs/server-static-content.html#extensions Modifications: - Allow configuring `fileExtensions()` via `FileServiceBuilder` - Find a file with fallback extensions if missing. Result: You can now set fallback file extensions to look up files in `FileService`. ```java FileService .builder(rootDir) .fileExtensions("html", "txt") ... ```
|
I feel like the proposed property name ( |
| final String extension = extensionIterator.next(); | ||
| return findFile(ctx, path + '.' + extension, supportedEncodings, decompress).thenCompose(file -> { | ||
| if (file != null) { | ||
| return UnmodifiableFuture.completedFuture(file); |
There was a problem hiding this comment.
Question) I'm not sure if we should be redirecting to the location with the extension like done in the other location, or we can just return the file as-is.
e.g.
HttpFile.ofRedirect(path + '.' + extension);I think either way should work, but asking just in case I'm missing anything.
I prefer clean URL patterns without a trailing slash so /app/projects is preferred over /app/projects/.
Also, if it isn't necessary to redirect for the index.html case, then I thought maybe this is solvable in a simpler way (by just adding an option to either redirect or return the file as-is)
There was a problem hiding this comment.
Talked internally, and it seems like other web servers are also employing the redirect logic. I think the current approach is probably fine then 👍
| } else { | ||
| return HttpFile.nonExistent(); | ||
| // Try appending file extensions if it was a file access and file extensions are configured. | ||
| return findFileWithExtensions(ctx, fallbackExtensions.iterator(), decodedMappedPath, |
There was a problem hiding this comment.
Note: I understood the order of 1) check extensions 2) and then check index.html is important since the objective is to avoid a trailing slash
Motivation:
I prefer clean URL patterns without a trailing slash so
/app/projectsis preferred over/app/projects/. If I built/app/projectswith a Javascript framework,/app/projects/index.htmlor/app/projects.htmlmay be exported by the framework which is a common feature.In
FileService,/app/projects/index.htmlcan be served by/app/projects/path, but cannot be found by/app/projects. A trailing slash/can be converted into/index.htmlor an auto index page. As some fallback logics are already implemented, I didn't want to add a new fallback option for a trailing slash.Alternatively, I propose an option that appends an extension if there is no file for the request path. For example, a request sent to
/app/projectsalso finds/app/projects.[ext]as a fallback.Related links:
FileService#4542Modifications:
fallbackFileExtensions()viaFileServiceBuilderResult:
FileService.FileService#4542