Move to HTTP.jl v2

This required making Julia 1.10 the minimum supported version.

Author: JamesWrigley

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.6'
+          - '1.10'
           - '1'
         os:
           - ubuntu-latest

.github/workflows/documentation.yml

@@ -14,14 +14,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - uses: julia-actions/setup-julia@v2
+      - uses: julia-actions/setup-julia@v3
         with:
-          version: '1.9'
-      - uses: julia-actions/cache@v2
-      - name: Install dependencies
-        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
-      - name: Build and deploy
+          version: '1'
+      - uses: julia-actions/cache@v3
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-        run: julia --project=docs/ docs/make.jl

Project.toml

@@ -1,20 +1,17 @@
 name = "LiveServer"
 uuid = "16fef848-5104-11e9-1b77-fb7a48bbb589"
+version = "1.6.0"
 authors = ["Jonas Asprion <jonas.asprion@gmx.ch", "Thibaut Lienart <tlienart@me.com>"]
-version = "1.5.0"
 
 [deps]
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
-LoggingExtras = "e6f89c97-d47a-5376-807f-9c37f3926c36"
 MIMEs = "6c6e2e6c-3030-632d-7369-2d6c69616d65"
 Sockets = "6462fe0b-24de-5631-8697-dd941f90decc"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
-[apps]
-liveserver = {}
-
 [compat]
-HTTP = "1"
+HTTP = "2"
 MIMEs = "0.1, 1"
-LoggingExtras = "1"
-julia = "1.6"
+julia = "1.10"
+
+[apps.liveserver]

docs/Project.toml

@@ -4,3 +4,6 @@ LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 
 [compat]
 Documenter = "^0.27"
+
+[sources]
+LiveServer = {path = ".."}

src/LiveServer.jl

@@ -5,7 +5,6 @@ using Base.Filesystem
 using Base.Threads: @spawn
 
 using HTTP
-using LoggingExtras
 
 export serve, servedocs
 

src/server.jl

@@ -50,21 +50,21 @@ function update_and_close_viewers!(
 
     # send update message to all viewers
     @sync for wsᵢ in ws_to_update_and_close
-        isopen(wsᵢ.io) && @spawn begin
+        !wsᵢ.writeclosed && @spawn begin
             try
                 HTTP.WebSockets.send(wsᵢ, "update")
             catch
             end
         end
     end
 
-    # force close all viewers (these will be replaced by 'fresh' ones
-    # after the reload triggered by the update message)
-    @sync for wsi in ws_to_update_and_close
-        isopen(wsi.io) && @spawn begin
+    # close all viewers in the background — writeclosed is set immediately
+    # inside close(), causing ws_tracker's loop to exit, while the full WS
+    # close handshake completes asynchronously without blocking the callback.
+    for wsi in ws_to_update_and_close
+        !wsi.writeclosed && @spawn begin
             try
-                wsi.writeclosed = wsi.readclosed = true
-                close(wsi.io)
+                close(wsi)
             catch
             end
         end
@@ -485,7 +485,7 @@ function serve_file(
     end
     push!(headers, "Content-Length" => string(binary_length(content)))
     resp         = HTTP.Response(ret_code, content)
-    resp.headers = HTTP.mkheaders(headers)
+    resp.headers = HTTP.Headers(headers)
 
     # add the file to the file watcher
     watch_file!(fw, fs_path)
@@ -518,10 +518,10 @@ function ws_tracker(ws::HTTP.WebSockets.WebSocket)::Nothing
     # NOTE: unless we're in the case of a 404, this file always exists because
     # the query is generated just after serving it; the 404 case will return an
     # empty path.
-    fs_path, case = get_fs_path(ws.request.target, silent=true)
+    fs_path, case = get_fs_path(ws.handshake_request.target, silent=true)
 
     if case in (:not_found_with_404, :not_found_without_404)
-        raw_fs_path, _ = get_fs_path(ws.request.target, onlyfs=true)
+        raw_fs_path, _ = get_fs_path(ws.handshake_request.target, onlyfs=true)
         add_to_viewers(raw_fs_path, ws)
     end
 
@@ -545,7 +545,7 @@ function ws_tracker(ws::HTTP.WebSockets.WebSocket)::Nothing
         # forces the websocket to stay open until it's closed by LiveServer (and
         # not by the browser) upon writing a `update` message on the websocket.
         # See update_and_close_viewers
-        while isopen(ws.io)
+        while !ws.writeclosed
             sleep(0.1)
         end
     catch err
@@ -643,15 +643,6 @@ current directory. (See also [`example`](@ref) for an example folder).
         )
     end
 
-    old_logger = global_logger()
-    old_stderr = stderr
-    global_logger(
-        EarlyFilteredLogger(
-            log -> log._module !== HTTP.Servers,
-            global_logger()
-        )
-    )
-
     server, port = get_server(host, port, req_handler)
     host_str     = ifelse(host == string(Sockets.localhost), "localhost", host)
     url          = "http://$host_str:$port"
@@ -692,10 +683,9 @@ current directory. (See also [`example`](@ref) for an example folder).
         # close any remaining websockets
         for wss ∈ values(WS_VIEWERS)
             @sync for wsi in wss
-                isopen(wsi.io) && @spawn begin
+                !wsi.writeclosed && @spawn begin
                     try
-                        wsi.writeclosed = wsi.readclosed = true
-                        close(wsi.io)
+                        close(wsi)
                     catch
                     end
                 end
@@ -704,19 +694,13 @@ current directory. (See also [`example`](@ref) for an example folder).
         # empty the dictionary of viewers
         empty!(WS_VIEWERS)
         # shut down the server
-        HTTP.Servers.forceclose(server)
+        HTTP.forceclose(server)
         # reset other environment variables
         reset_content_dir()
         reset_ws_interrupt()
         println("✓")
     end
 
-    # given that LiveServer is interrupted via an InterruptException, we have
-    # to be extra careful that things are back as they were before, otherwise
-    # there's a high risk of the disgusting broken pipe error...
-    redirect_stderr(old_stderr)
-    global_logger(old_logger)
-
     return nothing
 end
 
@@ -737,7 +721,7 @@ function get_server(
 
     incr >= 10 && @error "couldn't find a free port in $incr tries"
     try
-        server = HTTP.listen!(host, port; readtimeout=0, verbose=-1) do http::HTTP.Stream
+        server = HTTP.listen!(host, port; read_timeout=0) do http::HTTP.Stream
             if HTTP.WebSockets.isupgrade(http.message)
                 # upgrade to websocket and add to list of viewers and keep open
                 # until written to

test/Project.toml

@@ -7,5 +7,5 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
 Crayons = "4"
-HTTP = "1"
-MIMEs = "0.1"
+HTTP = "2"
+MIMEs = "0.1"

test/server.jl

@@ -48,7 +48,7 @@ tasks that you will try to start.
     # define filewatcher outside so that can follow it
     fw = LS.SimpleWatcher(LS.file_changed_callback)
     task = @spawn serve(fw; port=port)
-    sleep(0.1) # give it time to get started
+    timedwait(() -> LS.is_running(fw), 10) # give it time to get started
 
     # there should be a callback associated with fw now
     @test fw.status == :runnable
@@ -97,19 +97,17 @@ tasks that you will try to start.
     # and then subsequently close a websocket. We check this happens properly by adding
     # our own sentinel websocket
     function makews()
-        req = HTTP.Request()
-        return HTTP.WebSockets.WebSocket(
-            HTTP.Connection(IOBuffer()), req, req.response; client=false
-        )
+        io = IOBuffer(UInt8[], read=true, write=true)
+        return HTTP.WebSockets.WebSocket(io, () -> nothing; is_client=false)
     end
     sentinel = makews()
     LS.WS_VIEWERS["tmp.html"] = [sentinel]
 
-    @test sentinel.io.io.writable
+    @test !sentinel.writeclosed
     write("tmp.html", "something new")
     sleep(0.5)
     # the sentinel websocket should be closed
-    @test !sentinel.io.io.writable
+    @test sentinel.writeclosed
     # the websockets should have been flushed
     @test isempty(LS.WS_VIEWERS["tmp.html"])
 
@@ -121,8 +119,8 @@ tasks that you will try to start.
     write("css/foo.css", "body { color:blue; }")
     sleep(0.5)
     # all sentinel websockets should be closed
-    @test !sentinel1.io.io.writable
-    @test !sentinel2.io.io.writable
+    @test sentinel1.writeclosed
+    @test sentinel2.writeclosed
 
     # Mimic an error when building documentation with Documenter.jl. When this
     # happens servedocs_callback!() will set the watcher status to
@@ -174,27 +172,24 @@ end
     cd(mktempdir())
     write("test_file.html", "Hello!")
 
-    server = Sockets.listen(Sockets.localhost, 8001)
-    io = Sockets.connect(Sockets.localhost, 8001)
-    key = "k5zQsAMXfFlvmWIE/YCiEg=="
-    s = HTTP.Stream(
-        HTTP.Request(
-            "GET",
-            "http://localhost:8562/test_file.html",
-            [
-                "Connection" => "upgrade",
-                "Upgrade" => "websocket",
-                "Sec-WebSocket-Key" => key,
-                "Sec-WebSocket-Version" => "13"
-            ]
-        ),
-        HTTP.Connection(io)
-    )
-
-    fs_path, _ = LS.get_fs_path(s.message.target)
+    target = "/test_file.html"
+    fs_path, _ = LS.get_fs_path(target)
     @test fs_path == "test_file.html"
 
-    tsk = @spawn LS.HTTP.WebSockets.upgrade(LS.ws_tracker, s)
+    function make_tracking_ws(tgt)
+        io = IOBuffer(UInt8[], read=true, write=true)
+        ws = HTTP.WebSockets.WebSocket(io, () -> nothing; is_client=false)
+        ws.handshake_request = HTTP.Request("GET", tgt, [
+            "Connection" => "upgrade",
+            "Upgrade" => "websocket",
+            "Sec-WebSocket-Key" => "k5zQsAMXfFlvmWIE/YCiEg==",
+            "Sec-WebSocket-Version" => "13"
+        ])
+        return ws
+    end
+
+    ws1 = make_tracking_ws(target)
+    tsk = @spawn LS.ws_tracker(ws1)
     sleep(1.0)
     # the websocket should have been added to the list
     @test LS.WS_VIEWERS[fs_path] isa Vector{HTTP.WebSockets.WebSocket}
@@ -207,23 +202,8 @@ end
     @test istaskdone(tsk)
     @test !LS.WS_INTERRUPT[]
 
-    io = Sockets.connect(Sockets.localhost, 8001)
-    key = "k5zQsAMXfFlvmWIE/YCiEg=="
-    s = HTTP.Stream(
-            HTTP.Request(
-                "GET",
-                "http://localhost:8562/test_file.html",
-                [
-                    "Connection" => "upgrade",
-                    "Upgrade" => "websocket",
-                    "Sec-WebSocket-Key" => key,
-                    "Sec-WebSocket-Version" => "13"
-                ]
-            ),
-        HTTP.Connection(io)
-    )
-
-    tsk = @spawn LS.HTTP.WebSockets.upgrade(LS.ws_tracker, s)
+    ws2 = make_tracking_ws(target)
+    tsk = @spawn LS.ws_tracker(ws2)
     sleep(1.0)
 
     # simulate a "bad" closure
@@ -235,7 +215,6 @@ end
     @test length(LS.WS_VIEWERS[fs_path]) == 2
 
     # cleanup
-    close(server)
     empty!(LS.WS_VIEWERS)
 
     cd(bk)