Convert Mux provider to extension

- Mux tests were failing because the rdeits CSAIL account is expired
- Added the js file to the assets/ folder in the docs build to provide a
  stable URI to test against
  - (Explicitly add the js file so its removed/handled when switching
    branches but should otherwise be ignored.)

Author: halleysfifthinc

.gitignore

@@ -6,6 +6,7 @@ coverage/
 *.jl.cov
 *.jl.*.cov
 *.jl.mem
+docs/src/assets/trivial_import.js
 
 # JavaScript
 dist

Project.toml

@@ -21,15 +21,18 @@ Widgets = "cc8bc4a8-27d6-5769-a93b-9d913e69aa62"
 
 [weakdeps]
 IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
+Mux = "a975b10e-0019-58db-a62f-e48ff68538c9"
 
 [extensions]
 IJuliaExt = "IJulia"
+MuxExt = "Mux"
 
 [compat]
 AssetRegistry = "0.1.0"
 FunctionalCollections = "0.5.0"
 IJulia = "1.13"
 JSON = "0.18, 0.19, 0.20, 0.21"
+Mux = "1"
 Observables = "0.5"
 Requires = "0.4.4, 0.5, 1.0.0"
 WebSockets = "1.5.0, 1.6.0"

docs/Project.toml

@@ -3,3 +3,10 @@ Blink = "ad839575-38b3-5650-b840-f874b8c74a25"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
 Mux = "a975b10e-0019-58db-a62f-e48ff68538c9"
+WebIO = "0f1e0344-ec1d-5b48-a673-e5cf874b6c29"
+
+[compat]
+Blink = "0.12"
+Documenter = "1.8"
+IJulia = "1.13"
+Mux = "1"

docs/make.jl

@@ -1,12 +1,33 @@
-using Documenter
+using Documenter, SHA
 using WebIO
 
+# Copy or update trivial_import.js
+docs_trivial_path = joinpath(@__DIR__, "src/assets/trivial_import.js")
+test_trivial_path = joinpath(@__DIR__, "../test/assets/trivial_import.js")
+if isfile(docs_trivial_path)
+    test_sha = open(test_trivial_path) do io
+        sha1(io)
+    end
+    docs_sha = open(docs_trivial_path) do io
+        sha1(io)
+    end
+    if test_sha != docs_sha
+        cp(test_trivial_path, docs_trivial_path; force=true)
+    end
+else
+    mkdir(dirname(docs_trivial_path))
+    cp(test_trivial_path, docs_trivial_path)
+end
+
 # We have to ensure that these modules are loaded because some functions are
 # defined behind @require guards.
 using IJulia, Mux, Blink
 
+DocMeta.setdocmeta!(WebIO, :DocTestSetup, :(using WebIO); recursive=true)
+
 makedocs(
     sitename="WebIO",
+    warnonly=true,
     format=Documenter.HTML(),
     modules=[WebIO],
     pages=[

docs/src/assets/trivial_import.js

@@ -0,0 +1,14 @@
+// A trivial importable module that simply produces "ok".
+// Used for testing the WebIO Scope imports machinery.
+
+(function (root, factory) {
+    if (typeof define === 'function' && define.amd) {
+        // AMD. Register as an anonymous module.
+        define([], factory);
+    } else {
+        // Browser globals
+        root.amdWeb = factory();
+    }
+}(typeof self !== 'undefined' ? self : this, function () {
+    return {x: "ok"}
+}));

ext/mux.jl renamed to ext/MuxExt.jl

@@ -1,23 +1,26 @@
-using .JSON
-using .AssetRegistry
-using .Sockets
-using .Base64: stringmime
-export webio_serve
+module MuxExt
+
+using WebIO
+using WebIO: MUX_BUNDLE_PATH
+
+using Mux, JSON, AssetRegistry
+using Sockets
+using Base64: stringmime
 
 """
     webio_serve(app, port=8000)
 
 Serve a Mux app which might return a WebIO node.
 """
-function webio_serve(app, args...)
+function WebIO.webio_serve(app, args...)
     http = Mux.App(Mux.mux(
         Mux.defaults,
         app,
         Mux.notfound()
     ))
-    webio_serve(http, args...)
+    WebIO.webio_serve(http, args...)
 end
-function webio_serve(app::Mux.App, args...)
+function WebIO.webio_serve(app::Mux.App, args...)
     websock = Mux.App(Mux.mux(
         Mux.wdefaults,
         Mux.route("/webio-socket", create_socket),
@@ -53,7 +56,9 @@ end
 
 Base.isopen(p::WebSockConnection) = isopen(p.sock)
 
-Mux.Response(o::AbstractWidget) = Mux.Response(Widgets.render(o))
+# TYPE-PIRACY
+# Mux.Response(o::AbstractWidget) = Mux.Response(Widgets.render(o))
+
 function Mux.Response(content::Union{Node, Scope})
     script_url = try
         AssetRegistry.register(MUX_BUNDLE_PATH)
@@ -86,4 +91,9 @@ function WebIO.register_renderable(::Type{T}, ::Val{:mux}) where {T}
 end
 
 WebIO.setup_provider(::Val{:mux}) = nothing # Mux setup has no side-effects
-WebIO.setup(:mux)
+
+function __init__()
+    WebIO.setup(:mux)
+end
+
+end

src/WebIO.jl

@@ -94,7 +94,6 @@ function prefetch_provider_file(basename)
   (file = filepath, code = code)
 end
 
-provider_mux = prefetch_provider_file("mux.jl")
 provider_generic_http = prefetch_provider_file("generic_http.jl")
 
 struct _IJuliaInit
@@ -108,11 +107,10 @@ struct _IJuliaInit
     end
 end
 
+function webio_serve end
+
 function __init__()
     push!(Observables.addhandler_callbacks, WebIO.setup_comm)
-    @require Mux="a975b10e-0019-58db-a62f-e48ff68538c9" begin
-        include_string(@__MODULE__, provider_mux.code, provider_mux.file)
-    end
     @require WebSockets="104b5d7c-a370-577a-8038-80a2059c5097" begin
         include_string(@__MODULE__, provider_generic_http.code, provider_generic_http.file)
     end

test/blink-tests.jl

@@ -90,15 +90,11 @@ w = open_window()
             end
 
             @testset "global URL, no http:" begin
-                # TODO: change this to a permanent URL because this CSAIL account
-                # will eventually expire.
-                @test scope_import(w, "//people.csail.mit.edu/rdeits/webio_tests/trivial_import.js", use_iframe) == "ok"
+                @test scope_import(w, "//juliagizmos.github.io/WebIO.jl/dev/assets/trivial_import.js", use_iframe) == "ok"
             end
 
             @testset "global URL, with http:" begin
-                # TODO: change this to a permanent URL because this CSAIL account
-                # will eventually expire.
-                @test scope_import(w, "http://people.csail.mit.edu/rdeits/webio_tests/trivial_import.js", use_iframe) == "ok"
+                @test scope_import(w, "http://juliagizmos.github.io/WebIO.jl/dev/assets/trivial_import.js", use_iframe) == "ok"
             end
         end
     end