Async Counter App is unlisted and unfinished?

[aquirdTurtle]

Hello, I found (via google) the page https://ratatui.rs/tutorials/counter-async-app/ and was excited as I'm trying to make my ratatui program async, but I realized that this page seems stranded on the website. Nothing seems to connect to it and it seems unfinished, and that smells buggy.

[kdheepak]

We should probably add a note at the top of the page as to why these pages have been delisted.

[joshka]

Yep, For the benefit of the OP here, we delisted those pages because we had some problems with the approach suggested and we haven't made time to rewrite them. @kdheepak we could probably delete them from the repo and make a note that there's code in a branch somewhere.

The big things to note about async + terminal code are:

1. you shouldn't block inside async context (i.e. all code running in async should be non-blocking). See https://ryhl.io/blog/async-what-is-blocking/ for more details
2. this means that the code to read and write from the terminal should be on its own thread
3. some operations which query the terminal for information such as the cursor position or terminal size report information on stdin. These operations can fail if this is done on a different thread than the one that reads events as a race condition can occur which may cause app lockups
4. generally avoid waiting on mutexes or other structured concurrency primitives within the ratatui draw code. You want this code to have all the information to render pre-processed so that it happens fast. Add any code for synchronization before the ratatui code so that it's inherently single threaded synchronous

If you're still wanting to make your code async, keep those things in mind, give the tokio tutorials a really good read, dig into what's happening with crossterm events (particularly the async event stream). You might end up with a better idea of what these docs should look like and eventually may want to contribute some fixes as a PR... (always welcome)