some "Preview Manim Cell" execute but progress bar hangs (MacOS)

VladimirFokow commented 4 days ago

Example:

from manimlib import *

class SquareToCircle(Scene):
    def construct(self):
        # 
        ## Set up
        circle = Circle()
        circle.set_fill(BLUE, opacity=0.5)
        circle.set_stroke(BLUE_E, width=4)
        square = Square()

        ## Cell
        self.play(ShowCreation(square), run_time=3)
        self.play(ReplacementTransform(square, circle))
        self.wait()

start scene on line 17
click "Preview Manim Cell" on line 7

Hangs:

Screenshot 2024-10-28 at 22 28 13

It doesn't matter where you start the scene.

The problem is: "Preview Manim Cell" just always hangs.. - for the First cell only. (2nd cell works!!)

What solved it: pressing "Enter" in the terminal.

Hypothesis of what could be the reason:

Cell 1 doesn't output any progress bars to the terminal
but cell 2 does

is execution triggered by progress bars?

@Splines reproducible on linux?

Splines commented 4 days ago

Mmh, ok that's weird, for me it works just fine even for the first scene.

https://github.com/user-attachments/assets/8ada6b3b-5c41-4457-82ba-ae6b7df7852a

You know what: this is now a good time to introduce some logging to the extension (not just debugging console, but a proper file). This way, for future issues, we can ask users to send us the log, otherwise issues like these are really hard to debug as I don't have any MacOS system.

bhoov commented 4 days ago

I can confirm with @VladimirFokow the hanging on MacOS. Must fix for v0.1.0. Good find!

VladimirFokow commented 3 days ago

looks like the commands DO execute, BUT just: the "Previewing Manim" info box doesn't go away until the user presses Enter

Interestingly:

If we do NOT have sleep -

Both commands do print
the notification hangs (but it should NOT)

if we HAVE sleep

Both commands do print
the notification ends after 1 sec (like it should)

outdated (click to expand)

Play around: ```py from manimlib import * import time class SquareToCircle(Scene): def construct(self): # ## Test print('1') # time.sleep(1) print('2') ```

Logs (click to expand)

Here I ran ## Test, it printed 1 and 2 immediately, but was showing a progress bar indefinitely, (the first 2 blocks of logs were created) I waited for a bit, then pressed Enter in the terminal (the 3rd block of logs was created). ``` 2024-10-29 14:37:03.099 [info] [extension.ts:17:11] [unknown] 💠 Command requested: Preview Manim Cell, startLine=6 2024-10-29 14:37:03.119 [debug] [manimShell.ts:232:16] [unknown] 🚀 Exec command: checkpoint_paste(), waitUntilFinished=true, forceExecute=false, errorOnNoActiveShell=false 2024-10-29 14:37:03.119 [debug] [manimShell.ts:265:16] [unknown] 🔒 Command execution locked 2024-10-29 14:37:03.119 [debug] [manimShell.ts:451:20] [unknown] 🔍 Active shell already there 2024-10-29 14:37:03.120 [debug] [manimShell.ts:421:16] [unknown] 🔒 Shell execution end detection disabled 2024-10-29 14:37:03.120 [debug] [manimShell.ts:424:20] [unknown] 💨 Sending command to terminal (with shell integration): checkpoint_paste() 2024-10-29 14:37:03.120 [debug] [manimShell.ts:432:16] [unknown] 🔓 Shell execution end detection re-enabled 2024-10-29 14:37:03.120 [debug] [previewCode.ts:38:24] [unknown] 📊 Command issued: checkpoint_paste(). Will restore clipboard 2024-10-29 14:37:03.120 [debug] [manimShell.ts:290:20] [unknown] 🕒 Waiting until command has finished: checkpoint_paste() 2024-10-29 14:37:03.193 [trace] [manimShell.ts:514:28] [unknown] 🧾 Terminal data: 2024-10-29 14:37:03.326 [trace] [manimShell.ts:514:28] [unknown] 🧾 Terminal data: In [3]: checkpoint_paste()In [3]: checkpoint_paste() 1 2 In [4]: In [4]: 2024-10-29 14:37:03.326 [debug] [manimShell.ts:536:32] [unknown] 📦 IPython cell 3 detected 2024-10-29 14:37:03.326 [debug] [manimShell.ts:475:24] [unknown] 🕒 While waiting for command to finish, iPythonCellCount=3, currentExecutionCount=3 2024-10-29 14:37:03.326 [debug] [manimShell.ts:475:24] [unknown] 🕒 While waiting for command to finish, iPythonCellCount=3, currentExecutionCount=3 2024-10-29 14:37:23.811 [trace] [manimShell.ts:514:28] [unknown] 🧾 Terminal data: In [4]: In [4]: In [4]: 2024-10-29 14:37:23.811 [debug] [manimShell.ts:536:32] [unknown] 📦 IPython cell 4 detected 2024-10-29 14:37:23.811 [debug] [manimShell.ts:475:24] [unknown] 🕒 While waiting for command to finish, iPythonCellCount=4, currentExecutionCount=3 2024-10-29 14:37:23.811 [debug] [manimShell.ts:479:28] [unknown] 🕒 Command has finished 2024-10-29 14:37:23.811 [debug] [manimShell.ts:475:24] [unknown] 🕒 While waiting for command to finish, iPythonCellCount=4, currentExecutionCount=3 2024-10-29 14:37:23.811 [debug] [manimShell.ts:479:28] [unknown] 🕒 Command has finished 2024-10-29 14:37:23.811 [debug] [manimShell.ts:487:20] [unknown] 🕒 Calling callback after command has finished 2024-10-29 14:37:23.811 [debug] [manimShell.ts:285:20] [unknown] 🔓 Command execution unlocked 2024-10-29 14:37:23.811 [debug] [manimShell.ts:292:20] [unknown] 🕒 Command has finished: checkpoint_paste() 2024-10-29 14:37:23.811 [debug] [previewCode.ts:139:16] [unknown] 📊 Finishing progress notification ```

VladimirFokow commented 2 days ago

Log 1:

Manim Notebook.log

To show that:

it runs but hangs
enter makes it stop hanging

Code:

from manimlib import *
import time

class SquareToCircle(Scene):
    def construct(self):
        #
        ## Test
        print('1')
        # time.sleep(1)
        print('2')

Steps:

start manim on line 6
open the manim terminal
start logging
"preview manim cell" -> it runs, but then hangs
wait a bit
click Enter in the terminal -> it stops hanging

VladimirFokow commented 2 days ago

Log 2:

Manim Notebook.log

To show that:

opening the manim terminal -> makes it stop hanging
command "Preview selected Manim code": also causes it to hang

Code:

same as above (version 1)

Steps:

start manim on line 6
start logging
click "preview manim cell" -> the progress bars hangs
open the manim terminal -> IT STOPS HANGING (just because of opening the terminal)
select code, run it with "Preview selected Manim code" -> it hangs
press Enter in manim terminal -> it stops hanging

VladimirFokow commented 2 days ago

Log 3:

Manim Notebook.log

To show that:

sleep causes it to stop hanging.
to show an example that sometimes it does stop hanging.

Code:

uncommented sleep:

from manimlib import *
import time

class SquareToCircle(Scene):
    def construct(self):
        #
        ## Test
        print('1')
        time.sleep(1)
        print('2')

Steps:

start logging
click "preview manim cell" -> it starts manim, 1 sec progress bar, then progress bar ends like it should
click "preview manim cell" -> 1 sec progress bar, then progress bar ends like it should

VladimirFokow commented 2 days ago

Log 4:

Manim Notebook.log

To show that:

if I type something in the manim terminal, then it won't hang

Code:

same as version 1

from manimlib import *
import time

class SquareToCircle(Scene):
    def construct(self):
        #
        ## Test
        print('1')
        # time.sleep(1)
        print('2')

Steps:

start logging
start manim on line 6
open the manim terminal
type and run in the manim terminal: print('hi')
"preview manim cell" (I did it several times) -> it runs with NO HANGING!

VladimirFokow commented 2 days ago

hm.. considering this looks very weird, @Splines I certainly don't expect you to solve this without even having a MacOS system.

I would be able to see how your ManimShell class works in the coming 1-2 months, and then debug this from the ground up

Manim-Notebook / manim-notebook