Allow InputBinding.receiveMessage to be async (#3930)

Co-authored-by: wch <wch@users.noreply.github.com>
rstudio · Oct 30, 2023 · 6a09fda · 6a09fda
1 parent 77bc4e9
commit 6a09fda
Show file tree

Hide file tree

Showing 15 changed files with 168 additions and 134 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: shiny
 Type: Package
 Title: Web Application Framework for R
-Version: 1.7.5.9000
+Version: 1.7.5.9001
 Authors@R: c(
     person("Winston", "Chang", role = c("aut", "cre"), email = "winston@posit.co", comment = c(ORCID = "0000-0002-1576-2126")),
     person("Joe", "Cheng", role = "aut", email = "joe@posit.co"),

diff --git a/NEWS.md b/NEWS.md
@@ -10,7 +10,9 @@
 
 * Shiny's CSS styling (for things like `showNotification()`, `withProgress()`, `inputPanel()`, etc.), has been updated with `{bslib}`'s upcoming CSS-only dark mode feature in mind. (#3882, #3914)
 
-* Default styles for `showNotification()` were tweaked slightly to improve accessibility, sizing, and padding. (#3913) 
+* Default styles for `showNotification()` were tweaked slightly to improve accessibility, sizing, and padding. (#3913)
+
+* For `InputBinding`s, the `.receiveMessage()` method can now be asynchronous or synchronous (previously it could only be synchronous). (#3930)
 
 ## Bug fixes
 

diff --git a/inst/www/shared/shiny-autoreload.js b/inst/www/shared/shiny-autoreload.js
diff --git a/inst/www/shared/shiny-showcase.css b/inst/www/shared/shiny-showcase.css
diff --git a/inst/www/shared/shiny-showcase.js b/inst/www/shared/shiny-showcase.js
diff --git a/inst/www/shared/shiny-testmode.js b/inst/www/shared/shiny-testmode.js
diff --git a/inst/www/shared/shiny.js b/inst/www/shared/shiny.js
diff --git a/inst/www/shared/shiny.js.map b/inst/www/shared/shiny.js.map
diff --git a/inst/www/shared/shiny.min.css b/inst/www/shared/shiny.min.css
diff --git a/inst/www/shared/shiny.min.js b/inst/www/shared/shiny.min.js
diff --git a/inst/www/shared/shiny.min.js.map b/inst/www/shared/shiny.min.js.map
diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
   "homepage": "https://shiny.rstudio.com",
   "repository": "github:rstudio/shiny",
   "name": "@types/rstudio-shiny",
-  "version": "1.7.5-alpha.9000",
+  "version": "1.7.5-alpha.9001",
   "license": "GPL-3.0-only",
   "main": "",
   "browser": "",

diff --git a/srcts/src/bindings/input/inputBinding.ts b/srcts/src/bindings/input/inputBinding.ts
@@ -44,7 +44,7 @@ class InputBinding {
   // 'data' should be an object with elements corresponding to value, min,
   // max, etc., as appropriate for the type of input object. It also should
   // trigger a change event.
-  receiveMessage(el: HTMLElement, data: unknown): void {
+  receiveMessage(el: HTMLElement, data: unknown): Promise<void> | void {
     throw "Not implemented";
     el; // unused var
     data; // unused var

diff --git a/srcts/src/shiny/shinyapp.ts b/srcts/src/shiny/shinyapp.ts
@@ -717,7 +717,7 @@ class ShinyApp {
 
     addMessageHandler(
       "inputMessages",
-      (message: Array<{ id: string; message: unknown }>) => {
+      async (message: Array<{ id: string; message: unknown }>) => {
         // inputMessages should be an array
         for (let i = 0; i < message.length; i++) {
           const $obj = $(".shiny-bound-input#" + $escape(message[i].id));
@@ -734,7 +734,7 @@ class ShinyApp {
             $(el).trigger(evt);
             if (!evt.isDefaultPrevented()) {
               try {
-                inputBinding.receiveMessage(el, evt.message);
+                await inputBinding.receiveMessage(el, evt.message);
               } catch (error) {
                 console.error(
                   "[shiny] Error in inputBinding.receiveMessage()",

diff --git a/srcts/types/src/bindings/input/inputBinding.d.ts b/srcts/types/src/bindings/input/inputBinding.d.ts
@@ -8,7 +8,7 @@ declare class InputBinding {
     getValue(el: HTMLElement): any;
     subscribe(el: HTMLElement, callback: (value: boolean) => void): void;
     unsubscribe(el: HTMLElement): void;
-    receiveMessage(el: HTMLElement, data: unknown): void;
+    receiveMessage(el: HTMLElement, data: unknown): Promise<void> | void;
     getState(el: HTMLElement): unknown;
     getRatePolicy(el: HTMLElement): {
         policy: RatePolicyModes;