Release 1.0.4

Previously, the bot only had rudimentary typing notification support.

It used to send a single notification when starting a long task
and did not bother with notifications anymore.
By default matrix-rust-sdk gives these notifications a validity of 4
seconds, so it would expire shortly. If the bot takes longer to respond,
you'd see the typing notification expire and wonder if a response is
coming.

Another edge case is the bot sending an answer quicker and the typing
notice still being on. Some clients (like element-web) seem to hide the
typing notice when a new message comes, so they don't experience this as
problematic.

The reworked typing notification system should be robust:

- typing notices are sent continuously, until the bot finishes doing
  work
- if the bot is performing multiple actions in a room (even for
  different people), typing notices would continue to be sent until the
  bot becomes idle
- as soon as the bot becomes idle, a "not typing anymore" notice is sent
  to clear the state

CHANGELOG.md

@@ -1 +1,13 @@
-There's nothing here yet.
+# (2024-09-14) Version 1.0.4
+
+[Improves](https://github.com/etkecc/baibot/commit/dd1dd78312e3db7f92b37fb3b4750fbe35de7115) the typing notification logic.
+
+
+# (2024-09-13) Version 1.0.3
+
+Contains [fixes](https://github.com/etkecc/rust-mxlink/commit/f339fc85e69aa7f614394ad303d1614cd307319c) for [some](https://github.com/etkecc/baibot/issues/1) startup failures caused by partial initialization (errors during startup).
+
+
+# (2024-09-12) Version 1.0.0
+
+Initial release. 🎉

Cargo.lock

@@ -297,7 +297,7 @@ dependencies = [
 
 [[package]]
 name = "baibot"
-version = "1.0.2"
+version = "1.0.4"
 dependencies = [
  "anthropic-rs",
  "anyhow",
@@ -2122,9 +2122,9 @@ dependencies = [
 
 [[package]]
 name = "mxlink"
-version = "1.0.0"
+version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "80cb97e517e3bc8e85b4787ed87037cd324526862ca9375c6d038699010bf6c2"
+checksum = "195f0bd9764068de3e3e446bbac81a54489ff51674d80e387057b805c7dab96c"
 dependencies = [
  "base64 0.22.1",
  "chacha20poly1305",

Cargo.toml

@@ -7,7 +7,7 @@ license = "AGPL-3.0-or-later"
 readme = "README.md"
 keywords = ["matrix", "chat", "bot", "AI", "LLM"]
 include = ["/etc/assets/baibot-torso-768.png", "/src", "/README.md", "/CHANGELOG.md", "/LICENSE"]
-version = "1.0.2"
+version = "1.0.4"
 edition = "2021"
 
 [lib]
@@ -22,7 +22,7 @@ base64 = "0.22.*"
 # We'd rather not depend on this, but we cannot use the ruma-events EventContent macro without it.
 matrix-sdk = { version = "0.7.1", default-features = false }
 mxidwc = "1.0.*"
-mxlink = "1.0.*"
+mxlink = "1.2.*"
 etke_openai_api_rust = "0.1.*"
 quick_cache = "0.6.*"
 regex = "1.10.*"

docs/providers.md

@@ -49,7 +49,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local anthropic my-anthropic-agent`
   - create a global agent: `!bai agent create-global anthropic my-anthropic-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/anthropic.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/anthropic.yml).
 
 
 ### Groq
@@ -63,7 +63,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local groq my-groq-agent`
   - create a global agent: `!bai agent create-global groq my-groq-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/groq.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/groq.yml).
 
 
 ### LocalAI
@@ -77,7 +77,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local localai my-localai-agent`
   - create a global agent: `!bai agent create-global localai my-localai-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/localai.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/localai.yml).
 
 
 ### Mistral
@@ -91,7 +91,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local mistral my-mistral-agent`
   - create a global agent: `!bai agent create-global mistral my-mistral-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/mistral.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/mistral.yml).
 
 
 ### Ollama
@@ -105,7 +105,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local ollama my-ollama-agent`
   - create a global agent: `!bai agent create-global ollama my-ollama-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/ollama.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/ollama.yml).
 
 
 ### OpenAI
@@ -122,7 +122,7 @@ For services which are not fully compatible with the OpenAI API, consider using
   - create a room-local agent: `!bai agent create-room-local openai my-openai-agent`
   - create a global agent: `!bai agent create-global openai my-openai-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/openai.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/openai.yml).
 
 
 ### OpenAI Compatible
@@ -139,7 +139,7 @@ This provider is just as featureful as the [OpenAI](#openai) provider, but is mo
   - create a room-local agent: `!bai agent create-room-local openai-compatible my-openai-compatible-agent`
   - create a global agent: `!bai agent create-global openai-compatible my-openai-compatible-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/openai-compatible.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/openai-compatible.yml).
 
 
 ### OpenRouter
@@ -153,7 +153,7 @@ This provider is just as featureful as the [OpenAI](#openai) provider, but is mo
   - create a room-local agent: `!bai agent create-room-local openrouter my-openrouter-agent`
   - create a global agent: `!bai agent create-global openrouter my-openrouter-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/openrouter.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/openrouter.yml).
 
 
 ### Together AI
@@ -167,4 +167,4 @@ This provider is just as featureful as the [OpenAI](#openai) provider, but is mo
   - create a room-local agent: `!bai agent create-room-local together-ai my-together-ai-agent`
   - create a global agent: `!bai agent create-global together-ai my-together-ai-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/together-ai.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/together-ai.yml).

src/bot/messaging.rs

@@ -317,6 +317,13 @@ impl Messaging {
 
         let start_time = std::time::Instant::now();
 
+        let _typing_notice_guard = self
+            .bot
+            .matrix_link()
+            .rooms()
+            .start_typing_notice(message_context.room())
+            .await;
+
         let event_span = tracing::error_span!("message_controller", ?controller_type);
 
         crate::controller::dispatch_controller(&controller_type, &message_context, &self.bot)

src/bot/reacting.rs

@@ -244,6 +244,13 @@ impl Reacting {
 
         tracing::info!("Handling reaction via reaction controller");
 
+        let _typing_notice_guard = self
+            .bot
+            .matrix_link()
+            .rooms()
+            .start_typing_notice(message_context.room())
+            .await;
+
         let event_span = tracing::error_span!("reaction_controller");
 
         crate::controller::reaction::handle(

src/controller/agent/create/mod.rs

@@ -100,8 +100,6 @@ pub async fn handle_room_local(
         return Ok(());
     };
 
-    message_context.room().typing_notice(true).await?;
-
     if !try_to_ping_agent_or_complain(bot, message_context, &parsed_config.agent).await {
         return Ok(());
     }
@@ -215,8 +213,6 @@ pub async fn handle_global(
         return Ok(());
     };
 
-    message_context.room().typing_notice(true).await?;
-
     if !try_to_ping_agent_or_complain(bot, message_context, &parsed_config.agent).await {
         return Ok(());
     }

src/controller/chat_completion/mod.rs

@@ -337,8 +337,6 @@ async fn handle_stage_text_generation(
     )
     .await?;
 
-    _ = message_context.room().typing_notice(true).await;
-
     let prefixes_to_strip = match controller_type {
         ChatCompletionControllerType::ViaText { prefixes_to_strip } => prefixes_to_strip.clone(),
         ChatCompletionControllerType::ViaAudio => vec![],
@@ -498,8 +496,6 @@ async fn handle_stage_speech_to_text_actual_transcribing(
         .get_media_content(&media_request, true)
         .await?;
 
-    _ = message_context.room().typing_notice(true).await;
-
     let span = tracing::debug_span!(
         "speech_to_text_generation",
         agent_id = agent.identifier().as_string()

src/controller/image/generation.rs

@@ -56,8 +56,6 @@ pub async fn handle_image(
         original_prompt.to_owned()
     };
 
-    message_context.room().typing_notice(true).await?;
-
     let span = tracing::debug_span!(
         "image_generation",
         agent_id = agent.identifier().as_string()
@@ -139,8 +137,6 @@ pub async fn handle_sticker(
         return Ok(());
     };
 
-    message_context.room().typing_notice(true).await?;
-
     let span = tracing::debug_span!(
         "sticker_generation",
         agent_id = agent.identifier().as_string()

src/controller/utils/text_to_speech.rs

@@ -18,8 +18,6 @@ pub async fn generate_and_send_tts_for_message(
     text_message_event_id: &OwnedEventId,
     text_content: &str,
 ) -> bool {
-    _ = message_context.room().typing_notice(true).await;
-
     let reaction_event_response = bot
         .reacting()
         .react_no_fail(