✂ Separate modules for different notebooks

Project.toml

@@ -2,7 +2,7 @@ name = "Pluto"
 uuid = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
 license = "MIT"
 authors = ["Fons van der Plas <[email protected]>", "Mikołaj Bochenski <[email protected]>"]
-version = "0.3.4"
+version = "0.3.5"
 
 [deps]
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"

README.md

@@ -28,9 +28,10 @@ Your notebooks are saved as pure Julia files, which you can then import as if yo
 
 _(To developers: follow [these instructions](https://github.com/fonsp/Pluto.jl/blob/master/dev_instructions.md) to start working on the package.)_
 
-To add the package:
+After [installing julia](https://julialang.org/), add the package:
 ```julia
-julia> using Pkg; Pkg.add(PackageSpec(url="https://github.com/fonsp/Pluto.jl"))
+julia> ]
+(v1.0) pkg> add Pluto
 ```
 
 To run the notebook server:

src/react/ModuleManager.jl

@@ -1,15 +1,33 @@
 module ModuleManager
+    import UUIDs: UUID
+    import ..Pluto: Notebook
+
     "These expressions get executed whenever a new workspace is created."
     workspace_preamble = [:(using Markdown), :(ENV["GKSwstype"] = "nul")]
 
-    workspace_count = 0
+    workspace_counts = Dict{UUID,Int64}()
+    next_count() = maximum(values(workspace_counts) ∪ [0]) + 1
+
+    function get_workspace_id(notebook::Notebook)
+        if haskey(workspace_counts, notebook.uuid)
+            workspace_counts[notebook.uuid]
+        else
+            make_workspace(notebook)
+        end
+    end
 
-    get_workspace(id=workspace_count) = Core.eval(ModuleManager, Symbol("workspace", id))
+    function get_workspace_at(id::Int64)
+        Core.eval(ModuleManager, Symbol("workspace", id))
+    end
+
+    function get_workspace(notebook::Notebook)
+        get_workspace_at(get_workspace_id(notebook))
+    end
 
-    function make_workspace()
-        global workspace_count += 1
+    function make_workspace(notebook::Notebook)
+        id = workspace_counts[notebook.uuid] = next_count()
 
-        new_workspace_name = Symbol("workspace", workspace_count)
+        new_workspace_name = Symbol("workspace", id)
         workspace_creation = :(module $(new_workspace_name) $(workspace_preamble...) end)
 
         # We suppress this warning:
@@ -26,15 +44,16 @@ module ModuleManager
         redirect_stderr(original_stderr)
         close(wr)
         close(rd)
+
+        id
     end
-    make_workspace() # so that there's immediately something to work with
 
     forbiddenmove(sym::Symbol) = sym == :eval || sym == :include || string(sym)[1] == '#'
 
-    function move_vars(old_index::Integer, new_index::Integer, to_delete::Set{Symbol}=Set{Symbol}(), module_usings::Set{Expr}=Set{Expr}())
-        old_workspace = get_workspace(old_index)
+    function move_vars(notebook::Notebook, old_index::Integer, new_index::Integer, to_delete::Set{Symbol}=Set{Symbol}(), module_usings::Set{Expr}=Set{Expr}())
+        old_workspace = get_workspace_at(old_index)
         old_workspace_name = Symbol("workspace", old_index)
-        new_workspace = get_workspace(new_index)
+        new_workspace = get_workspace_at(new_index)
         new_workspace_name = Symbol("workspace", new_index)
         Core.eval(new_workspace, :(import ..($(old_workspace_name))))
 
@@ -57,11 +76,11 @@ module ModuleManager
         end
     end
 
-    function delete_vars(to_delete::Set{Symbol}=Set{Symbol}(), module_usings::Set{Expr}=Set{Expr}())
+    function delete_vars(notebook::Notebook, to_delete::Set{Symbol}=Set{Symbol}(), module_usings::Set{Expr}=Set{Expr}())
         if !isempty(to_delete)
-            old_index = workspace_count
-            make_workspace()
-            move_vars(old_index, old_index+1, to_delete, module_usings)
+            old_index = get_workspace_id(notebook)
+            new_index = make_workspace(notebook)
+            move_vars(notebook, old_index, new_index, to_delete, module_usings)
         end
     end
 end

src/react/Notebook.jl

@@ -110,7 +110,7 @@ function load_notebook(io, path)
             # Change windows line endings to linux; remove the cell appendix.
             code_normalised = replace(code, "\r\n" => "\n")[1:end - ncodeunits(_cell_appendix)]
 
-            read_cell = Cell(uuid, code_normalised, nothing, nothing, nothing, Set{Symbol}(), Set{Symbol}(), Set{Expr}())
+            read_cell = Cell(uuid, code_normalised, nothing, nothing, missing, nothing, Set{Symbol}(), Set{Symbol}(), Set{Expr}())
 
             collected_cells[uuid] = read_cell
         end

src/react/React.jl

@@ -23,7 +23,7 @@ function run_reactive!(initiator, notebook::Notebook, cell::Cell)
     module_usings = union((c.module_usings for c in notebook.cells)...)
     to_delete = union(old_modified, (c.modified_symbols for c in will_update)...)
 
-    ModuleManager.delete_vars(to_delete, module_usings)
+    ModuleManager.delete_vars(notebook, to_delete, module_usings)
 
     cell.modified_symbols = symstate.assignments
 
@@ -49,23 +49,22 @@ function run_reactive!(initiator, notebook::Notebook, cell::Cell)
             end
             relay_error!(to_run, "Cyclic references: $(join(modified_cyclic, ", ", " and "))")
         else
-            run_single!(to_run)
+            run_single!(initiator, notebook, to_run)
         end
         putnotebookupdates!(notebook, clientupdate_cell_output(initiator, notebook, to_run))
-        # sleep(0.001)
     end
 
     return will_update
 end
 
 
-function run_single!(cell::Cell)
+function run_single!(initiator, notebook::Notebook, cell::Cell)
     # if isa(cell.parsedcode, Expr) && cell.parsedcode.head == :using
     #     # Don't run this cell. We set its output directly and stop the method prematurely.
     #     relay_error!(cell, "Use `import` instead of `using`.\nSupport for `using` will be added soon.")
     #     return
     # end
-    workspace = ModuleManager.get_workspace()
+    workspace = ModuleManager.get_workspace(notebook)
     starttime = time_ns()
     try
         starttime = time_ns()

src/webserver/NotebookServer.jl

@@ -58,11 +58,13 @@ function flushclient(client)
         didsomething = true
 
         try
-            if isopen(client.stream)
-                write(client.stream, serialize_message(next_to_send))
-            else
-                @info "Client $(client.id) stream closed."
-                return false
+            if client.stream !== nothing
+                if isopen(client.stream)
+                    write(client.stream, serialize_message(next_to_send))
+                else
+                    @info "Client $(client.id) stream closed."
+                    return false
+                end
             end
         catch e
             @warn "Failed to write to WebSocket of $(client.id) " e

test/ModuleManager.jl

@@ -0,0 +1,26 @@
+@testset "Module manager" begin
+# basic functionality is already tested by the reactivity tests
+
+    @testset "Multiple notebooks" begin
+        fakeclientA = Client(:fakeA, nothing)
+        fakeclientB = Client(:fakeB, nothing)
+        Pluto.connectedclients[fakeclientA.id] = fakeclientA
+        Pluto.connectedclients[fakeclientB.id] = fakeclientB
+
+
+        notebookA = Notebook(joinpath(tempdir(), "test.jl"), [
+            createcell_fromcode("x = 3")
+        ])
+        fakeclientA.connected_notebook = notebookA
+
+        notebookB = Notebook(joinpath(tempdir(), "test.jl"), [
+            createcell_fromcode("x")
+        ])
+        fakeclientB.connected_notebook = notebookB
+
+        @test_nowarn run_reactive!(fakeclientA, notebookA, notebookA.cells[1])
+        @test_nowarn run_reactive!(fakeclientB, notebookB, notebookB.cells[1])
+
+        @test notebookB.cells[1].errormessage !== nothing
+    end
+end

test/React.jl

@@ -1,15 +1,18 @@
 using Test
 using Pluto
-import Pluto: Notebook, Client, run_reactive!,fakeclient,  createcell_fromcode
-
+import Pluto: Notebook, Client, run_reactive!,fakeclient,  createcell_fromcode, ModuleManager
 
 @testset "Reactivity" begin
     fakeclient = Client(:fake, nothing)
+    Pluto.connectedclients[fakeclient.id] = fakeclient
+
     @testset "Basic" begin
         notebook = Notebook(joinpath(tempdir(), "test.jl"), [
-        createcell_fromcode("x = 1"),
-        createcell_fromcode("y = x")
-    ])
+            createcell_fromcode("x = 1"),
+            createcell_fromcode("y = x")
+        ])
+        fakeclient.connected_notebook = notebook
+
         run_reactive!(fakeclient, notebook, notebook.cells[1])
         run_reactive!(fakeclient, notebook, notebook.cells[2])
         @test notebook.cells[1].output == notebook.cells[2].output
@@ -20,9 +23,11 @@ import Pluto: Notebook, Client, run_reactive!,fakeclient,  createcell_fromcode
 
     @testset "Cyclic" begin
         notebook = Notebook(joinpath(tempdir(), "test.jl"), [
-        createcell_fromcode("x = y"),
-        createcell_fromcode("y = x")
-    ])
+            createcell_fromcode("x = y"),
+            createcell_fromcode("y = x")
+        ])
+        fakeclient.connected_notebook = notebook
+
         run_reactive!(fakeclient, notebook, notebook.cells[1])
         run_reactive!(fakeclient, notebook, notebook.cells[2])
         @test occursin("Cyclic reference", notebook.cells[1].errormessage)
@@ -31,9 +36,11 @@ import Pluto: Notebook, Client, run_reactive!,fakeclient,  createcell_fromcode
 
     @testset "Variable deletion" begin
         notebook = Notebook(joinpath(tempdir(), "test.jl"), [
-        createcell_fromcode("x = 1"),
-        createcell_fromcode("y = x")
-    ])
+            createcell_fromcode("x = 1"),
+            createcell_fromcode("y = x")
+        ])
+        fakeclient.connected_notebook = notebook
+
         run_reactive!(fakeclient, notebook, notebook.cells[1])
         run_reactive!(fakeclient, notebook, notebook.cells[2])
         @test notebook.cells[1].output == notebook.cells[2].output
@@ -47,17 +54,21 @@ import Pluto: Notebook, Client, run_reactive!,fakeclient,  createcell_fromcode
 
     @testset "Recursive function is not considered cyclic" begin
         notebook = Notebook(joinpath(tempdir(), "test.jl"), [
-        createcell_fromcode("factorial(n) = n * factorial(n-1)")
-    ])
+            createcell_fromcode("factorial(n) = n * factorial(n-1)")
+        ])
+        fakeclient.connected_notebook = notebook
+
         run_reactive!(fakeclient, notebook, notebook.cells[1])
         @test !isempty(methods(notebook.cells[1].output))
         @test notebook.cells[1].errormessage == nothing
     end
 
     @testset "Variable cannot reference its previous value" begin
         notebook = Notebook(joinpath(tempdir(), "test.jl"), [
-        createcell_fromcode("x = 3")
-    ])
+            createcell_fromcode("x = 3")
+        ])
+        fakeclient.connected_notebook = notebook
+
         run_reactive!(fakeclient, notebook, notebook.cells[1])
         notebook.cells[1].code = "x = x + 1"
         run_reactive!(fakeclient, notebook, notebook.cells[1])

test/runtests.jl

@@ -1,3 +1,4 @@
 include("./ExploreExpression.jl")
 include("./React.jl")
+include("./ModuleManager.jl")
 include("./Notebook.jl")