Convert generic_http provider to extension

Author: halleysfifthinc

Project.toml

@@ -16,16 +16,17 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 Sockets = "6462fe0b-24de-5631-8697-dd941f90decc"
 UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
-WebSockets = "104b5d7c-a370-577a-8038-80a2059c5097"
 Widgets = "cc8bc4a8-27d6-5769-a93b-9d913e69aa62"
 
 [weakdeps]
 IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
 Mux = "a975b10e-0019-58db-a62f-e48ff68538c9"
+WebSockets = "104b5d7c-a370-577a-8038-80a2059c5097"
 
 [extensions]
 IJuliaExt = "IJulia"
 MuxExt = "Mux"
+WebSocketsExt = "WebSockets"
 
 [compat]
 AssetRegistry = "0.1.0"

ext/generic_http.jl renamed to ext/WebSocketsExt.jl

@@ -1,9 +1,12 @@
-using .Sockets
-import .AssetRegistry, .JSON
-using .WebIO
-using .WebSockets: is_upgrade, upgrade, writeguarded
-using .WebSockets: HTTP
+module WebSocketsExt
 
+using WebIO, JSON, AssetRegistry
+using Sockets
+
+using WebIO: WEBIO_APPLICATION_MIME, GENERIC_HTTP_BUNDLE_PATH, bundle_key, 
+    global_server_config, WebIOServer, singleton_instance, routing_callback,
+    webio_server_config
+using WebSockets: WebSockets, HTTP, is_upgrade, upgrade, writeguarded
 
 struct WSConnection{T} <: WebIO.AbstractConnection
     sock::T
@@ -12,15 +15,7 @@ end
 Sockets.send(p::WSConnection, data) = writeguarded(p.sock, JSON.json(data))
 Base.isopen(p::WSConnection) = isopen(p.sock)
 
-if !isfile(GENERIC_HTTP_BUNDLE_PATH)
-    error(
-        "Unable to find WebIO JavaScript bundle for generic HTTP provider; "
-        * "try rebuilding WebIO (via `Pkg.build(\"WebIO\")`)."
-    )
-end
-const bundle_key = AssetRegistry.register(GENERIC_HTTP_BUNDLE_PATH)
-
-include(joinpath(@__DIR__, "..", "..", "deps", "mimetypes.jl"))
+include(joinpath(@__DIR__, "..", "deps", "mimetypes.jl"))
 
 """
 Serve an asset from the asset registry.
@@ -52,17 +47,8 @@ function websocket_handler(ws)
     end
 end
 
-struct WebIOServer{S}
-    server::S
-    serve_task::Task
-end
-
 kill!(server::WebIOServer) = put!(server.server.in, HTTP.Servers.KILL)
 
-const singleton_instance = Ref{WebIOServer}()
-
-const routing_callback = Ref{Any}((req)-> missing)
-
 """
 Run the WebIO server.
 
@@ -84,7 +70,7 @@ end
 server = WebIO.WebIOServer(serve_app, verbose = true)
 ```
 """
-function WebIOServer(
+function WebIO.WebIOServer(
         default_response::Function = (req)-> missing;
         baseurl::String = "127.0.0.1", http_port::Int = 8081,
         verbose = false, singleton = true,
@@ -111,7 +97,7 @@ function WebIOServer(
             else # relative url
                 string("http://", baseurl, ":", http_port, WebIO.baseurl[])
             end
-            string(base, bundle_key)
+            string(base, bundle_key[])
         end
         wait_time = 5; start = time() # wait for max 5 s
         while time() - start < wait_time
@@ -127,24 +113,22 @@ function WebIOServer(
     return singleton_instance[]
 end
 
-const webio_server_config = Ref{typeof((url = "", bundle_url = "", http_port = 0, ws_url = ""))}()
-
 """
 Fetches the global configuration for our http + websocket server from environment
 variables. It will memoise the result, so after a first call, any update to
 the environment will get ignored.
 """
-function global_server_config()
+function WebIO.global_server_config()
     if !isassigned(webio_server_config)
 
-        setbaseurl!(get(ENV, "JULIA_WEBIO_BASEURL", ""))
+        WebIO.setbaseurl!(get(ENV, "JULIA_WEBIO_BASEURL", ""))
 
         url = get(ENV, "WEBIO_SERVER_HOST_URL", "127.0.0.1")
         http_port = parse(Int, get(ENV, "WEBIO_HTTP_PORT", "8081"))
         ws_default = string("ws://", url, ":", http_port, "/webio_websocket/")
         ws_url = get(ENV, "WEBIO_WEBSOCKT_URL", ws_default)
         # make it possible, to e.g. host the bundle online
-        bundle_url = get(ENV, "WEBIO_BUNDLE_URL", string(WebIO.baseurl[], bundle_key))
+        bundle_url = get(ENV, "WEBIO_BUNDLE_URL", string(WebIO.baseurl[], bundle_key[]))
         webio_server_config[] = (
             url = url, bundle_url = bundle_url,
             http_port = http_port, ws_url = ws_url
@@ -176,3 +160,15 @@ function Base.show(io::IO, m::WEBIO_APPLICATION_MIME, app::Application)
     show(io, "text/html", app)
     return
 end
+
+function __init__()
+    if !isfile(GENERIC_HTTP_BUNDLE_PATH)
+        error(
+            "Unable to find WebIO JavaScript bundle for generic HTTP provider; "
+            * "try rebuilding WebIO (via `Pkg.build(\"WebIO\")`)."
+            )
+    end
+    bundle_key[] = AssetRegistry.register(GENERIC_HTTP_BUNDLE_PATH)
+end
+
+end

src/WebIO.jl

@@ -94,8 +94,6 @@ function prefetch_provider_file(basename)
   (file = filepath, code = code)
 end
 
-provider_generic_http = prefetch_provider_file("generic_http.jl")
-
 struct _IJuliaInit
     function _IJuliaInit()
         # based on assert_extension from longemen3000/ExtensionsExt
@@ -107,14 +105,30 @@ struct _IJuliaInit
     end
 end
 
+struct WebIOServer{S}
+    server::S
+    serve_task::Task
+
+    function WebIOServer(server::S, serve_task::Task) where S
+        # based on assert_extension from longemen3000/ExtensionsExt
+        ext = Base.get_extension(@__MODULE__, :WebSocketsExt)
+        if isnothing(ext)
+            throw(error("Extension `WebSocketsExt` must be loaded to construct the type `WebIOServer`."))
+        end
+        return new{S}(server, serve_task)
+    end
+end
+
 function webio_serve end
+function global_server_config end
+
+const bundle_key = Ref{String}()
+const singleton_instance = Ref{WebIOServer}()
+const routing_callback = Ref{Any}((req) -> missing)
+const webio_server_config = Ref{typeof((url = "", bundle_url = "", http_port = 0, ws_url = ""))}()
 
 function __init__()
     push!(Observables.addhandler_callbacks, WebIO.setup_comm)
-    @require WebSockets="104b5d7c-a370-577a-8038-80a2059c5097" begin
-        include_string(@__MODULE__, provider_generic_http.code, provider_generic_http.file)
-    end
-
 end
 
 end # module

test/http-tests.jl

@@ -7,6 +7,6 @@ using Test
     @test occursin("_webIOWebSocketURL = ", output)
     @test occursin("ws://127.0.0.1:8081/webio_websocket/", output)
     @test occursin("""hello, world""", output)
-    @test WebIO.webio_server_config[] == (url = "127.0.0.1", bundle_url = WebIO.bundle_key, http_port = 8081, ws_url = "ws://127.0.0.1:8081/webio_websocket/")
+    @test WebIO.webio_server_config[] == (url = "127.0.0.1", bundle_url = WebIO.bundle_key[], http_port = 8081, ws_url = "ws://127.0.0.1:8081/webio_websocket/")
     @test isassigned(WebIO.singleton_instance)
 end