JuliaWeb/HTTP.jl

Feature: serve_file

Closed

#567 opened on Aug 10, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Julia (182 forks)batch import
enhancementhelp wantedserver

Repository metrics

Stars
 (679 stars)
PR merge metrics
 (Avg merge 2d 5h) (40 merged PRs in 30d)

Description

This seems like generic enough functionality it could make sense to put in HTTP.jl. I don't have an api figured out, but just as a placeholder/starting point

# ?serve_file
#     serve_file(path; mimetype="infer", extension="infer", ...) :: HTTP.Response
#     serve_file(stream::HTTP.Stream, ...) :: Nothing

using HTTP

function handle_file(req::HTTP.Request)
    return HTTP.serve_file("file.txt") 
end

Some pointers to other implementations

PkgServer - https://github.com/JuliaPackaging/PkgServer.jl/blob/065235d39b4f66018dbc51ce3cb6861429f095e2/src/resource.jl#L394

Genie - https://github.com/GenieFramework/Genie.jl/blob/899ea32d3a7a95aab3bfe508fc9d6821bde2a1e0/src/Router.jl#L992

Flask - https://github.com/pallets/flask/blob/632f85b65354ad573bb33c54a0a9dd3ffcef371f/src/flask/helpers.py#L447

Contributor guide

Research direction
Review the linked implementations (PkgServer.jl, Genie.jl, Flask) for reference on serving files. Investigate the HTTP.jl source to understand how to integrate a serve file function, looking at existing handlers and the response type. Check the issue comments for any further discussion on desired API.
Tech stack
None
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Unclear
Prerequisites
basic Julia knowledgeunderstanding of HTTP.jl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25