fix: fire shiny:outputinvalidated for outputs bound after invalidation (#2797)

When an output is invalidated before it's in the DOM (e.g., inside a
closed modal), the shiny:outputinvalidated event was never fired. The
progress state machine already tracks this — the Invalidated state means
"this output was invalidated while not bound."

Adds isInvalidated() to OutputProgressReporter and uses it in
bindOutputs() to fire the event when an output in the Invalidated state
is first bound. This is intentionally separate from the isRecalculating()
check that drives showProgress(), since isRecalculating() also includes
the Initial state (every output on first page load) where firing the
invalidated event would be incorrect.

Author: cpsievert

inst/www/shared/shiny.js

@@ -231,6 +231,7 @@ type BindInputsCtx = {
   outputBindings: BindingRegistry<OutputBinding>;
   initDeferredIframes: () => void;
   outputIsRecalculating: (id: string) => boolean;
+  outputIsInvalidated: (id: string) => boolean;
 };
 function bindInputs(
   shinyCtx: BindInputsCtx,
@@ -316,7 +317,7 @@ function bindInputs(
 }
 
 async function bindOutputs(
-  { outputBindings, outputIsRecalculating }: BindInputsCtx,
+  { outputBindings, outputIsRecalculating, outputIsInvalidated }: BindInputsCtx,
   scope: BindScope = document.documentElement,
 ): Promise<void> {
   const $scope = $(scope);
@@ -359,6 +360,15 @@ async function bindOutputs(
         bindingAdapter.showProgress(true);
       }
 
+      if (outputIsInvalidated(id)) {
+        $el.trigger({
+          type: "shiny:outputinvalidated",
+          // @ts-expect-error; Can not remove info on a established, malformed Event object
+          binding: binding,
+          name: id,
+        });
+      }
+
       bindingsRegistry.addBinding(id, "output");
       $el.trigger({
         type: "shiny:bound",

inst/www/shared/shiny.js.map

@@ -224,6 +224,8 @@ class ShinyClass {
         initDeferredIframes,
         outputIsRecalculating: (id: string) =>
           this.shinyapp?.$outputProgress.isRecalculating(id) ?? false,
+        outputIsInvalidated: (id: string) =>
+          this.shinyapp?.$outputProgress.isInvalidated(id) ?? false,
       };
     };
 

inst/www/shared/shiny.min.js

@@ -96,6 +96,10 @@ class OutputProgressReporter {
     return result;
   }
 
+  isInvalidated(name: string): boolean {
+    return this.#getState(name) === OutputStates.Invalidated;
+  }
+
   // Returns whether the output is recalculating or not.
   isRecalculating(name: string): boolean {
     const state = this.#getState(name);

inst/www/shared/shiny.min.js.map

@@ -9,6 +9,7 @@ type BindInputsCtx = {
     outputBindings: BindingRegistry<OutputBinding>;
     initDeferredIframes: () => void;
     outputIsRecalculating: (id: string) => boolean;
+    outputIsInvalidated: (id: string) => boolean;
 };
 declare function bindInputs(shinyCtx: BindInputsCtx, scope?: BindScope): {
     [key: string]: {

srcts/src/shiny/bind.ts

@@ -6,6 +6,7 @@ declare class OutputProgressReporter {
     private outputStates;
     private changedOutputs;
     takeChanges(): Map<string, boolean>;
+    isInvalidated(name: string): boolean;
     isRecalculating(name: string): boolean;
     updateStateFromMessage(message: Message): void;
 }