Error when export_directory or export_notebook fails #73

Activity

1. filchristou commented on Sep 20, 2023

   

   filchristou

   on Sep 20, 2023

   More actions

   btw PlutoStaticHTML.jl already support this. I am not sure how easily the same solution can be integrated here though..
2. fonsp

   added

   good first issueGood for newcomersGood for newcomers

   on Oct 18, 2023
3. theogf commented on Mar 12, 2024

   

   theogf

   on Mar 12, 2024

   ContributorAuthor

   More actions

   For what it's worth I have written my own small printing function that shows which notebooks failed and with which errors:

   """
   Given a selection of notebooks, check individually for each notebook if there are 
   any cells that errored.
   If it is the case print out, for each notebook, the content of the failing cells
   and the output messages.
   """
   function check_for_failed_notebooks(result::NamedTuple)
     failed_notebooks = Dict{String, Vector}()
     # notebook session is a `NotebookSession` from PlutoSliderServer.jl.
     for notebook_session in result.notebook_sessions
       # Check for every notebook that no cell errored.
       # State is a large JSON style `Dict` containing all the informations about the ran notebook.
       # You can find the definition in Pluto.jl/src/webserver/Dynamic.jl/notebook_to_js.
       state = notebook_session.run.original_state
       errored_cells = findall(cell -> cell["errored"], state["cell_results"])
       isempty(errored_cells) && continue
       failed_notebooks[notebook_session.path] = [
         (input = state["cell_inputs"][id]["code"], output = state["cell_results"][id]["output"]["body"][:msg]) for
         id in sort(errored_cells; by = id -> findfirst(==(id), state["cell_order"]))
       ]
     end
     if !isempty(failed_notebooks)
       io = IOBuffer()
       for (key, cells) in pairs(failed_notebooks)
         printstyled(IOContext(io, :color => true), "$key:\n"; bold = true, color = :green, underline = true)
         for (input, output) in cells
           printstyled(IOContext(io, :color => true), "• $input"; color = :blue)
           print(io, " => ")
           printstyled(IOContext(io, :color => true), "$output\n"; color = :red)
         end
         println(io)
       end
       error_msgs = String(take!(io))
       error(
         "The following Pluto notebook",
         length(failed_notebooks) > 1 ? "s" : "",
         " failed to run successfully: $(keys(failed_notebooks))\n\n",
         error_msgs,
       )
     end
   end

   This is to be passed to export_directory as the on_ready kwarg.
4. fonsp commented on Mar 7, 2025

   

   fonsp

   on Mar 7, 2025

   Member

   More actions

   I started working on this in https://github.com/JuliaPluto/PlutoNotebookComparison.jl :)

   This PR is using the new package: bmlip/course#20
5. fonsp commented on Mar 17, 2026

   

   fonsp

   on Mar 17, 2026

   Member

   More actions

   I made the package from my last comment to allow more granular checking (allow some cells to error), and to check for more things like broken URLs.

   But maybe we can also add a simple throw_on_cell_error option to PSS that just crashes everything once a single cell has an error? And then PlutoNotebookComparison can be used for more options? WDYT?
6. theogf commented on Mar 17, 2026

   

   theogf

   on Mar 17, 2026

   ContributorAuthor

   More actions

   But maybe we can also add a simple throw_on_cell_error option to PSS that just crashes everything once a single cell has an error? And then PlutoNotebookComparison can be used for more options? WDYT?

   Problem here is that when the failure happens on CI it is not necessarily easy to reproduce locally. It would already be good to report what the failure was.

   👍React with 👍1Reacted by Misha Mikhasenko