v0.2.0 (#44)

* Increment version number to 0.2.0

* chore: Add update js assets to release bullets

* chore: polish news

* chore: revdepcheck::cloud_check()

* chore: update cran comments

* docs: update pkgdown site

* chore: update shinychat.js

* feat: Add shinychat hex logo

* chore: update logo

* feat: Use silent error in `chat_append()` to avoid crashing app (#46)

* feat: Don't crash app with an error in `chat_append_stream()`

* feat: Improve formatting of error message in chat

* chore: Update news item

* chore: remove unused code

* fix: Avoid unhandled promise error, but still throw silent error

* chore: update comment

* tests(chat_append_stream): Handles errors in the stream

* chore: Suggest {later}

* feat(chat_append): Return stream results as promise value (#45)

* feat(chat_append): Return stream results as value of promise

* chore: more robust to future ellmer changes

* docs: Add news item

* chore: Use fastmap

* tests(chat_append_stream): Promise resolves to stream contents

* docs(chat_append): Document resolved promise value

* chore: restore code changes

* avoid warning about fastmap

* rename: test-markdown-stream.R

* chore: organize reference index

* chore: Add Posit ROR id

* ci: Run r-cmd-check on all pull requests

* chore: Update shinychat.js assets

* chore: Use branch with fix

* tests: update snaps

* chore: Garrick as maintainer

Author: gadenbuie

.Rbuildignore

@@ -10,3 +10,4 @@
 ^_dev$
 ^cran-comments\.md$
 ^CRAN-SUBMISSION$
+^revdep$

.github/workflows/R-CMD-check.yaml

@@ -4,7 +4,6 @@ on:
   push:
     branches: [main, master]
   pull_request:
-    branches: [main, master]
 
 name: R-CMD-check.yaml
 

DESCRIPTION

@@ -1,12 +1,13 @@
 Package: shinychat
 Title: Chat UI Component for 'shiny'
-Version: 0.1.1.9001
+Version: 0.2.0
 Authors@R: c(
-    person("Joe", "Cheng", , "[email protected]", role = c("aut", "cre")),
+    person("Joe", "Cheng", , "[email protected]", role = "aut"),
     person("Carson", "Sievert", , "[email protected]", role = "aut"),
-    person("Garrick", "Aden-Buie", , "[email protected]", role = "aut",
+    person("Garrick", "Aden-Buie", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-7111-0077")),
-    person("Posit Software, PBC", role = c("cph", "fnd"))
+    person("Posit Software, PBC", role = c("cph", "fnd"),
+           comment = c(ROR = "03wc8by49"))
   )
 Description: Provides a scrolling chat interface with multiline input,
     suitable for creating chatbot apps based on Large Language Models
@@ -20,12 +21,14 @@ Imports:
     bslib,
     coro,
     ellmer,
+    fastmap,
     htmltools,
     jsonlite,
     promises (>= 1.3.2),
     rlang,
     shiny (>= 1.10.0)
 Suggests:
+    later,
     testthat (>= 3.0.0)
 Config/Needs/website: tidyverse/tidytemplate
 Config/testthat/edition: 3

NEWS.md

@@ -1,14 +1,22 @@
-# shinychat (development version)
+# shinychat 0.2.0
+
+## New features and improvements
 
 * Added new `output_markdown_stream()` and `markdown_stream()` functions to allow for streaming markdown content to the client. This is useful for showing Generative AI responses in real-time in a Shiny app, outside of a chat interface. (#23)
 
-* Both `chat_ui()` and `output_markdown_stream()` now support arbirary Shiny UI elements inside of messages. This allows for gathering input from the user (e.g., `selectInput()`), displaying of rich output (e.g., `{htmlwidgets}` like `{plotly}`), and more. (#1868)
+* Both `chat_ui()` and `output_markdown_stream()` now support arbitrary Shiny UI elements inside of messages. This allows for gathering input from the user (e.g., `selectInput()`), displaying of rich output (e.g., `{htmlwidgets}` like `{plotly}`), and more. (#29)
 
 * Added a new `chat_clear()` function to clear the chat of all messages. (#25)
 
+* Added `chat_app()`, `chat_mod_ui()` and `chat_mod_server()`. `chat_app()` takes an `ellmer::Chat` client and launches a simple Shiny app interface with the chat. `chat_mod_ui()` and `chat_mod_server()` replicate the interface as a Shiny module, for easily adding a simple chat interface connected to a specific `ellmer::Chat` client. (#36)
+
+* The promise returned by `chat_append()` now resolves to the content streamed into the chat. (#49)
+
+## Bug fixes
+
 * `chat_append()`, `chat_append_message()` and `chat_clear()` now all work in Shiny modules without needing to namespace the `id` of the Chat component. (#37)
 
-* Added `chat_app()`, `chat_mod_ui()` and `chat_mod_server()`. `chat_app()` takes an `ellmer::Chat` client and launches a simple Shiny app interface with the chat. `chat_mod_ui()` and `chat_mod_server()` replicate the interface as a Shiny module, for easily adding a simple chat interface connected to a specific `ellmer::Chat` client. (#36)
+* `chat_append()` now logs and throws a silent error if the stream errors for any reason. This prevents the app from crashing if the stream is interrupted. You can still use `promises::catch()` to handle the error in your app code if desired. (#46)
 
 # shinychat 0.1.1
 

R/chat.R

@@ -12,13 +12,11 @@ chat_deps <- function() {
     src = "lib/shiny",
     script = list(
       list(src = "chat/chat.js", type = "module"),
-      list(src = "markdown-stream/markdown-stream.js", type = "module"),
-      list(src = "text-area/textarea-autoresize.js", type = "module")
+      list(src = "markdown-stream/markdown-stream.js", type = "module")
     ),
     stylesheet = c(
       "chat/chat.css",
-      "markdown-stream/markdown-stream.css",
-      "text-area/textarea-autoresize.css"
+      "markdown-stream/markdown-stream.css"
     )
   )
 }
@@ -197,11 +195,12 @@ chat_ui <- function(
 #' @param role The role of the message (either "assistant" or "user"). Defaults
 #'   to "assistant".
 #' @param session The Shiny session object
-#' @returns Returns a promise. This promise resolves when the message has been
-#'   successfully sent to the client; note that it does not guarantee that the
-#'   message was actually received or rendered by the client. The promise
-#'   rejects if an error occurs while processing the response (see the "Error
-#'   handling" section).
+#'
+#' @returns Returns a promise that resolves to the contents of the stream, or an
+#'   error. This promise resolves when the message has been successfully sent to
+#'   the client; note that it does not guarantee that the message was actually
+#'   received or rendered by the client. The promise rejects if an error occurs
+#'   while processing the response (see the "Error handling" section).
 #'
 #' @examplesIf interactive()
 #' library(shiny)
@@ -409,26 +408,38 @@ chat_append_stream <- function(
 ) {
   result <- chat_append_stream_impl(id, stream, role, session)
   # Handle erroneous result...
+  result <- promises::catch(result, function(reason) {
+    # ...but rethrow the error as a silent error, so the caller can also handle
+    # it if they want, but it won't bring down the app.
+    class(reason) <- c("shiny.silent.error", class(reason))
+    cnd_signal(reason)
+  })
+
   promises::catch(result, function(reason) {
     chat_append_message(
       id,
       list(
         role = role,
-        content = paste0(
-          "\n\n**An error occurred:** ",
-          conditionMessage(reason)
-        )
+        content = sanitized_chat_error(reason)
       ),
       chunk = "end",
       operation = "append",
       session = session
     )
+    rlang::warn(
+      sprintf(
+        "ERROR: An error occurred in `chat_append_stream(id=\"%s\")`",
+        session$ns(id)
+      ),
+      parent = reason
+    )
   })
-  # ...but also return it, so the caller can also handle it if they want. Note
-  # that we're not returning the result of `promises::catch`; we want to return
-  # a rejected promise (so the caller can see the error) that was already
-  # handled (so there's no "unhandled promise error" warning if the caller
-  # chooses not to do anything with it).
+
+  # Note that we're not returning the result of `promises::catch()`, because we
+  # want to return a rejected promise so the caller can see the error. But we
+  # use the `catch()` both to make the error visible to the user *and* to ensure
+  # there's no "unhandled promise error" warning if the caller chooses not to do
+  # anything with it.
   result
 }
 
@@ -448,13 +459,19 @@ rlang::on_load(
       chunk = "start",
       session = session
     )
+
+    res <- fastmap::fastqueue(200)
+
     for (msg in stream) {
       if (promises::is.promising(msg)) {
         msg <- await(msg)
       }
       if (coro::is_exhausted(msg)) {
         break
       }
+
+      res$add(msg)
+
       chat_append_message(
         id,
         list(role = role, content = msg),
@@ -463,13 +480,21 @@ rlang::on_load(
         session = session
       )
     }
+
     chat_append_message(
       id,
       list(role = role, content = ""),
       chunk = "end",
       operation = "append",
       session = session
     )
+
+    res <- res$as_list()
+    if (every(res, is.character)) {
+      paste(unlist(res), collapse = "")
+    } else {
+      res
+    }
   })
 )
 

R/chat_app.R

@@ -157,68 +157,10 @@ chat_mod_server <- function(id, client) {
       )
     })
 
-    shiny::observe({
-      if (append_stream_task$status() == "error") {
-        tryCatch(
-          append_stream_task$result(),
-          error = notify_error("chat", session = session, module_id = id)
-        )
-      }
-    })
-
     shiny::reactive({
       if (append_stream_task$status() == "success") {
         client$last_turn()
       }
     })
   })
 }
-
-notify_error <- function(
-  id,
-  module_id,
-  session = shiny::getDefaultReactiveDomain()
-) {
-  function(err) {
-    rlang::warn(
-      sprintf(
-        "ERROR: An error occurred in `chat_mod_server(id=\"%s\")`",
-        module_id
-      ),
-      parent = err
-    )
-
-    needs_sanitized <-
-      isTRUE(getOption("shiny.sanitize.errors")) &&
-      !inherits(err, "shiny.custom.error")
-    if (needs_sanitized) {
-      msg <- "**An error occurred.** Please try again or contact the app author."
-    } else {
-      msg <- sprintf(
-        "**An error occurred:**\n\n```\n%s\n```",
-        strip_ansi(conditionMessage(err))
-      )
-    }
-
-    chat_append_message(
-      id,
-      msg = list(role = "assistant", content = msg),
-      chunk = TRUE,
-      operation = "append",
-      session = session
-    )
-    chat_append_message(
-      id,
-      list(role = "assistant", content = ""),
-      chunk = "end",
-      operation = "append",
-      session = session
-    )
-  }
-}
-
-strip_ansi <- function(text) {
-  # Matches codes like "\x1B[31;43m", "\x1B[1;3;4m"
-  ansi_pattern <- "(\x1B|\x033)\\[[0-9;?=<>]*[@-~]"
-  gsub(ansi_pattern, "", text)
-}

R/shinychat-package.R

@@ -10,4 +10,11 @@ NULL
 
 ignore_unused_imports <- function() {
   jsonlite::fromJSON
+  fastmap::fastqueue
+}
+
+release_bullets <- function() {
+  c(
+    "Check that shinychat js assets are up-to-date (`scripts/update-chat.sh`)"
+  )
 }

R/utils.R

@@ -0,0 +1,20 @@
+sanitized_chat_error <- function(err) {
+  needs_sanitized <-
+    isTRUE(getOption("shiny.sanitize.errors")) &&
+    !inherits(err, "shiny.custom.error")
+
+  if (needs_sanitized) {
+    "\n\n**An error occurred.** Please try again or contact the app author."
+  } else {
+    sprintf(
+      "\n\n**An error occurred:**\n\n```\n%s\n```",
+      strip_ansi(conditionMessage(err))
+    )
+  }
+}
+
+strip_ansi <- function(text) {
+  # Matches codes like "\x1B[31;43m", "\x1B[1;3;4m"
+  ansi_pattern <- "(\x1B|\x033)\\[[0-9;?=<>]*[@-~]"
+  gsub(ansi_pattern, "", text)
+}

_pkgdown.yml

@@ -0,0 +1,6 @@
+## revdepcheck results
+
+We checked 2 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
+
+ * We saw 0 new problems
+ * We failed to check 0 packages