From 9d1946a5ce2be8e2c0dd7f70c07178b3a0c8861a Mon Sep 17 00:00:00 2001
From: Kyle Conroy <kyleconroy@gmail.com>
Date: Thu, 7 Mar 2024 12:36:57 -0500
Subject: [PATCH] migrate temporary disabling previews upstream (#3)

---
 lcviz/plugins/binning/binning.py  | 19 +++----------------
 lcviz/plugins/binning/binning.vue | 22 +++++-----------------
 lcviz/plugins/flatten/flatten.py  | 18 ++++--------------
 lcviz/plugins/flatten/flatten.vue | 23 ++++++-----------------
 4 files changed, 18 insertions(+), 64 deletions(-)

diff --git a/lcviz/plugins/binning/binning.py b/lcviz/plugins/binning/binning.py
index f2440404..24d2348b 100644
--- a/lcviz/plugins/binning/binning.py
+++ b/lcviz/plugins/binning/binning.py
@@ -1,5 +1,3 @@
-import numpy as np
-from time import time
 from astropy.time import Time
 from traitlets import Bool, Float, observe
 from glue.config import data_translator
@@ -10,7 +8,7 @@
 from jdaviz.core.template_mixin import (PluginTemplateMixin,
                                         DatasetSelectMixin, AddResultsMixin,
                                         skip_if_no_updates_since_last_active,
-                                        with_spinner)
+                                        with_spinner, with_temp_disable)
 from jdaviz.core.user_api import PluginUserApi
 
 from lcviz.components import FluxColumnSelectMixin
@@ -54,9 +52,6 @@ class Binning(PluginTemplateMixin, FluxColumnSelectMixin, DatasetSelectMixin,
     n_bins = IntHandleEmpty(100).tag(sync=True)
     bin_enabled = Bool(True).tag(sync=True)
 
-    last_live_time = Float(0).tag(sync=True)
-    previews_temp_disable = Bool(False).tag(sync=True)
-
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
@@ -164,8 +159,9 @@ def _toggle_marks(self, event={}):
 
     @observe('flux_column_selected', 'dataset_selected',
              'ephemeris_selected',
-             'n_bins', 'previews_temp_disable')
+             'n_bins', 'previews_temp_disabled')
     @skip_if_no_updates_since_last_active()
+    @with_temp_disable(timeout=0.3)
     def _live_update(self, event={}):
         self.bin_enabled = self.n_bins != '' and self.n_bins > 0
 
@@ -173,11 +169,6 @@ def _live_update(self, event={}):
             self._clear_marks()
             return
 
-        if self.previews_temp_disable:
-            return
-
-        start = time()
-
         if event.get('name', '') not in ('is_active', 'show_live_preview'):
             # mark visibility hasn't been handled yet
             self._toggle_marks()
@@ -214,10 +205,6 @@ def _live_update(self, event={}):
                 mark.times = []
                 mark.update_xy(times, lc.flux.value)
 
-        self.last_live_time = np.round(time() - start, 2)
-        if self.last_live_time > 0.3:
-            self.previews_temp_disable = True
-
     def _on_ephemeris_update(self, msg):
         if not self.show_live_preview or not self.is_active:
             return
diff --git a/lcviz/plugins/binning/binning.vue b/lcviz/plugins/binning/binning.vue
index c280da46..6bad2b59 100644
--- a/lcviz/plugins/binning/binning.vue
+++ b/lcviz/plugins/binning/binning.vue
@@ -57,23 +57,11 @@
       </v-text-field>
     </v-row>
 
-    <v-alert v-if="previews_temp_disable && show_live_preview" type='warning' style="margin-left: -12px; margin-right: -12px">
-      Live-updating is temporarily disabled (last update took {{last_live_time}}s)
-      <v-row justify='center'>
-        <j-tooltip tooltipcontent='hide live preview (can be re-enabled from the settings section in the plugin).' span_style="width: 100%">
-          <v-btn style='width: 100%' @click="show_live_preview = false">
-            disable previews
-          </v-btn>
-        </j-tooltip>
-      </v-row>
-      <v-row justify='center'>
-        <j-tooltip tooltipcontent='manually update live-previews based on current plugin inputs.' span_style="width: 100%">
-          <v-btn style='width: 100%' @click="previews_temp_disable = false">
-            update preview
-          </v-btn>
-        </j-tooltip>
-      </v-row>
-    </v-alert>
+    <plugin-previews-temp-disabled
+      :previews_temp_disabled.sync="previews_temp_disabled"
+      :previews_last_time="previews_last_time"
+      :show_live_preview.sync="show_live_preview"
+    />
 
     <plugin-add-results
       :label.sync="results_label"
diff --git a/lcviz/plugins/flatten/flatten.py b/lcviz/plugins/flatten/flatten.py
index 172ff904..35b2323f 100644
--- a/lcviz/plugins/flatten/flatten.py
+++ b/lcviz/plugins/flatten/flatten.py
@@ -1,7 +1,6 @@
 import numpy as np
-from time import time
 
-from traitlets import Bool, Float, Unicode, observe
+from traitlets import Bool, Unicode, observe
 
 from jdaviz.core.custom_traitlets import FloatHandleEmpty, IntHandleEmpty
 from jdaviz.core.events import ViewerAddedMessage
@@ -10,7 +9,7 @@
                                         DatasetSelectMixin,
                                         AutoTextField,
                                         skip_if_no_updates_since_last_active,
-                                        with_spinner)
+                                        with_spinner, with_temp_disable)
 from jdaviz.core.user_api import PluginUserApi
 
 from lcviz.components import FluxColumnSelectMixin
@@ -70,9 +69,6 @@ class Flatten(PluginTemplateMixin, FluxColumnSelectMixin, DatasetSelectMixin):
     flux_label_invalid_msg = Unicode('').tag(sync=True)
     flux_label_overwrite = Bool(False).tag(sync=True)
 
-    last_live_time = Float(0).tag(sync=True)
-    previews_temp_disable = Bool(False).tag(sync=True)
-
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
@@ -217,16 +213,14 @@ def _toggle_marks(self, event={}):
 
     @observe('dataset_selected', 'flux_column_selected',
              'window_length', 'polyorder', 'break_tolerance',
-             'niters', 'sigma', 'previews_temp_disable')
+             'niters', 'sigma', 'previews_temp_disabled')
     @skip_if_no_updates_since_last_active()
+    @with_temp_disable(0.3)
     def _live_update(self, event={}):
-        if self.previews_temp_disable:
-            return
         if self.dataset_selected == '' or self.flux_column_selected == '':
             self._clear_marks()
             return
 
-        start = time()
         try:
             output_lc, trend_lc = self.flatten(add_data=False)
         except Exception as e:
@@ -253,10 +247,6 @@ def _live_update(self, event={}):
         for mark in flattened_marks.values():
             mark.update_ty(times.value, output_flux)
 
-        self.last_live_time = np.round(time() - start, 2)
-        if self.last_live_time > 0.3:
-            self.previews_temp_disable = True
-
     def vue_apply(self, *args, **kwargs):
         try:
             self.flatten(add_data=True)
diff --git a/lcviz/plugins/flatten/flatten.vue b/lcviz/plugins/flatten/flatten.vue
index 191df121..be51f402 100644
--- a/lcviz/plugins/flatten/flatten.vue
+++ b/lcviz/plugins/flatten/flatten.vue
@@ -138,23 +138,12 @@
       hint="Label for flux column."
     ></plugin-auto-label>
 
-    <v-alert v-if="previews_temp_disable && (show_live_preview || show_trend_preview)" type='warning' style="margin-left: -12px; margin-right: -12px">
-      Live-updating is temporarily disabled (last update took {{last_live_time}}s)
-      <v-row justify='center'>
-        <j-tooltip tooltipcontent='hide live trend and flattened previews (can be re-enabled from the settings section in the plugin).' span_style="width: 100%">
-          <v-btn style='width: 100%' @click="() => {show_live_preview = false; show_trend_preview = false}">
-            disable previews
-          </v-btn>
-        </j-tooltip>
-      </v-row>
-      <v-row justify='center'>
-        <j-tooltip tooltipcontent='manually update live-previews based on current plugin inputs.' span_style="width: 100%">
-          <v-btn style='width: 100%' @click="previews_temp_disable = false">
-            update preview
-          </v-btn>
-        </j-tooltip>
-      </v-row>
-    </v-alert>
+    <plugin-previews-temp-disabled
+      :previews_temp_disabled.sync="previews_temp_disabled"
+      :previews_last_time="previews_last_time"
+      :show_live_preview="show_live_preview || show_trend_preview"
+      @disable_previews="() => {show_live_preview=false; show_trend_preview=false}"
+    />
 
     <v-row justify="end">
       <j-tooltip tooltipcontent="Flatten and select the new column as the adopted flux column">