refactor: 🐎 Overlay update optimization

Author: aditya-css

lib/src/models/action_button_icon.dart

@@ -51,4 +51,15 @@ class ActionButtonIcon {
 
   /// Optional padding to apply around the icon.
   final EdgeInsets? padding;
+
+  @override
+  bool operator ==(Object other) {
+    if (identical(this, other)) return true;
+    return other is ActionButtonIcon &&
+        icon == other.icon &&
+        padding == other.padding;
+  }
+
+  @override
+  int get hashCode => Object.hash(icon, padding);
 }

lib/src/models/linked_showcase_data.dart renamed to lib/src/models/linked_showcase_data_model.dart

@@ -19,6 +19,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+import 'package:flutter/foundation.dart';
 import 'package:flutter/widgets.dart';
 
 import '../showcase/showcase_controller.dart';
@@ -51,4 +52,16 @@ class ShowcaseScope {
   /// - Key: GlobalKey of a showcase (provided by user)
   /// - Value: Map of showcase IDs to their controllers
   final Map<GlobalKey, Map<int, ShowcaseController>> controllers = {};
+
+  @override
+  bool operator ==(Object other) {
+    if (identical(this, other)) return true;
+    return other is ShowcaseScope &&
+        name == other.name &&
+        showcaseView == other.showcaseView &&
+        mapEquals(controllers, other.controllers);
+  }
+
+  @override
+  int get hashCode => Object.hash(name, showcaseView, controllers);
 }

lib/src/models/showcase_scope.dart

@@ -19,6 +19,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 
 import '../../showcaseview.dart';
@@ -126,4 +127,44 @@ class TooltipActionButton {
   /// This only works for the global action widgets
   /// Defaults to []
   final List<GlobalKey> hideActionWidgetForShowcase;
+
+  @override
+  bool operator ==(Object other) {
+    if (identical(this, other)) return true;
+    return other is TooltipActionButton &&
+        other.type == type &&
+        other.borderRadius == borderRadius &&
+        other.padding == padding &&
+        other.backgroundColor == backgroundColor &&
+        other.textStyle == textStyle &&
+        other.leadIcon == leadIcon &&
+        other.tailIcon == tailIcon &&
+        other.name == name &&
+        other.button == button &&
+        other.border == border &&
+        listEquals(
+          other.hideActionWidgetForShowcase,
+          hideActionWidgetForShowcase,
+        );
+  }
+
+  @override
+  int get hashCode {
+    return Object.hashAllUnordered(
+      [
+        type,
+        borderRadius,
+        padding,
+        hideActionWidgetForShowcase,
+        backgroundColor,
+        textStyle,
+        leadIcon,
+        tailIcon,
+        name,
+        onTap,
+        button,
+        border,
+      ],
+    );
+  }
 }

lib/src/models/tooltip_action_button.dart

@@ -59,4 +59,26 @@ class TooltipActionConfig {
   /// If aligning items according to their baseline, which baseline to use.
   /// This must be set if using baseline alignment.
   final TextBaseline? textBaseline;
+
+  @override
+  bool operator ==(Object other) {
+    if (identical(this, other)) return true;
+    return other is TooltipActionConfig &&
+        alignment == other.alignment &&
+        actionGap == other.actionGap &&
+        position == other.position &&
+        gapBetweenContentAndAction == other.gapBetweenContentAndAction &&
+        crossAxisAlignment == other.crossAxisAlignment &&
+        textBaseline == other.textBaseline;
+  }
+
+  @override
+  int get hashCode => Object.hashAllUnordered([
+        alignment,
+        actionGap,
+        position,
+        gapBetweenContentAndAction,
+        crossAxisAlignment,
+        textBaseline,
+      ]);
 }

lib/src/models/tooltip_action_config.dart

@@ -573,7 +573,12 @@ class _ShowcaseState extends State<Showcase> {
     // This is to support hot reload
     _updateControllerValues();
 
-    _controller.recalculateRootWidgetSize(context);
+    _controller.recalculateRootWidgetSize(
+      context,
+      shouldUpdateOverlay:
+          _showCaseWidgetManager.showcaseView.getActiveShowcaseKey ==
+              widget.showcaseKey,
+    );
     return widget.child;
   }
 
@@ -584,14 +589,15 @@ class _ShowcaseState extends State<Showcase> {
       id: _uniqueId,
       scope: _showCaseWidgetManager.name,
     );
-
     super.dispose();
   }
 
   void _updateControllerValues() {
-    _showCaseWidgetManager = ShowcaseService.instance.getScope(
+    final manager = ShowcaseService.instance.getScope(
       scope: _showCaseWidgetManager.name,
     );
+    if (manager == _showCaseWidgetManager) return;
+    _showCaseWidgetManager = manager;
     ShowcaseService.instance.addController(
       controller: _controller
         ..showcaseView = _showCaseWidgetManager.showcaseView,

lib/src/showcase/showcase.dart

@@ -24,7 +24,7 @@ import 'dart:math';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/widgets.dart';
 
-import '../models/linked_showcase_data.dart';
+import '../models/linked_showcase_data_model.dart';
 import '../models/tooltip_action_config.dart';
 import '../tooltip/tooltip.dart';
 import '../utils/overlay_manager.dart';
@@ -134,20 +134,23 @@ class ShowcaseController {
   ///
   /// This method is typically called internally by the showcase system but
   /// can also be called manually to force a recalculation of showcase elements.
-  void startShowcase() {
+  void startShowcase({bool shouldUpdateOverlay = true}) {
     if (!showcaseView.enableShowcase || !_mounted) return;
 
-    recalculateRootWidgetSize(_context);
+    recalculateRootWidgetSize(
+      _context,
+      shouldUpdateOverlay: shouldUpdateOverlay,
+    );
     globalFloatingActionWidget = showcaseView
         .getFloatingActionWidget(config.showcaseKey)
         ?.call(_context);
-    final size = rootWidgetSize ?? MediaQuery.sizeOf(_context);
-    position ??= TargetPositionService(
-      rootRenderObject: rootRenderObject,
-      screenSize: size,
-      renderBox: _context.findRenderObject() as RenderBox?,
-      padding: config.targetPadding,
-    );
+    // final size = rootWidgetSize ?? MediaQuery.sizeOf(_context);
+    // position ??= TargetPositionService(
+    //   rootRenderObject: rootRenderObject,
+    //   screenSize: size,
+    //   renderBox: _context.findRenderObject() as RenderBox?,
+    //   padding: config.targetPadding,
+    // );
   }
 
   /// Used to scroll the target into view.
@@ -165,32 +168,32 @@ class ShowcaseController {
   ///
   /// Returns a Future that completes when scrolling is finished. If the widget
   /// is unmounted during scrolling, the operation will be canceled safely.
-  Future<void> scrollIntoView() async {
+  Future<void> scrollIntoView({bool shouldUpdateOverlay = true}) async {
     if (!_mounted) {
       assert(_mounted, 'Widget has been unmounted');
       return;
     }
 
     isScrollRunning = true;
-    updateControllerData();
-    startShowcase();
-    OverlayManager.instance.update(
-      show: showcaseView.isShowcaseRunning,
-      scope: showcaseView.scope,
-    );
+    // updateControllerData();
+    startShowcase(shouldUpdateOverlay: shouldUpdateOverlay);
+    // OverlayManager.instance.update(
+    //   show: showcaseView.isShowcaseRunning,
+    //   scope: showcaseView.scope,
+    // );
     await Scrollable.ensureVisible(
       _context,
       duration: showcaseView.scrollDuration,
       alignment: config.scrollAlignment,
     );
 
     isScrollRunning = false;
-    updateControllerData();
-    startShowcase();
-    OverlayManager.instance.update(
-      show: showcaseView.isShowcaseRunning,
-      scope: showcaseView.scope,
-    );
+    // updateControllerData();
+    startShowcase(shouldUpdateOverlay: shouldUpdateOverlay);
+    // OverlayManager.instance.update(
+    //   show: showcaseView.isShowcaseRunning,
+    //   scope: showcaseView.scope,
+    // );
   }
 
   /// Handles tap on barrier area.
@@ -214,20 +217,28 @@ class ShowcaseController {
   ///
   /// Parameter:
   /// * [context] The BuildContext of the [Showcase] widget.
-  void recalculateRootWidgetSize(BuildContext context) {
+  void recalculateRootWidgetSize(
+    BuildContext context, {
+    bool shouldUpdateOverlay = true,
+  }) {
+    if (!showcaseView.enableShowcase || !showcaseView.isShowcaseRunning) return;
     WidgetsBinding.instance.addPostFrameCallback((_) {
-      if (!context.mounted) return;
+      if (!context.mounted ||
+          !showcaseView.enableShowcase ||
+          !showcaseView.isShowcaseRunning) {
+        return;
+      }
 
       _initRootWidget();
-      if (!showcaseView.enableShowcase) return;
 
       updateControllerData();
-      if (!showcaseView.isShowcaseRunning) return;
 
-      OverlayManager.instance.update(
-        show: showcaseView.isShowcaseRunning,
-        scope: showcaseView.scope,
-      );
+      if (shouldUpdateOverlay) {
+        OverlayManager.instance.update(
+          show: showcaseView.isShowcaseRunning,
+          scope: showcaseView.scope,
+        );
+      }
     });
   }
 

lib/src/showcase/showcase_controller.dart

@@ -21,6 +21,7 @@
  */
 import 'dart:async';
 
+import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 
 import '../models/tooltip_action_button.dart';
@@ -320,10 +321,7 @@ class ShowcaseView {
       _ids = widgetIds;
       _activeWidgetId = 0;
       _onStart();
-      OverlayManager.instance.update(
-        show: isShowcaseRunning,
-        scope: scope,
-      );
+      // OverlayManager.instance.update(show: isShowcaseRunning, scope: scope);
     } else {
       Future.delayed(delay, () => _startShowcase(Duration.zero, widgetIds));
     }
@@ -410,14 +408,17 @@ class ShowcaseView {
       onStart?.call(_activeWidgetId, _ids![_activeWidgetId!]);
       final controllers = _getCurrentActiveControllers;
       final controllerLength = controllers.length;
-      for (var i = 0; i < controllerLength; i++) {
-        final controller = controllers[i];
-        final isAutoScroll =
-            controller.config.enableAutoScroll ?? enableAutoScroll;
-        if (controllerLength == 1 && isAutoScroll) {
-          await controller.scrollIntoView();
-        } else {
-          controller.startShowcase();
+      final firstController = controllers.firstOrNull;
+
+      final isAutoScroll =
+          firstController?.config.enableAutoScroll ?? enableAutoScroll;
+
+      // Auto scroll is not supported for multi-showcase feature.
+      if (controllerLength == 1 && isAutoScroll) {
+        await firstController?.scrollIntoView();
+      } else {
+        for (var i = 0; i < controllerLength; i++) {
+          controllers[i].startShowcase(shouldUpdateOverlay: i == 0);
         }
       }
     }
@@ -468,4 +469,52 @@ class ShowcaseView {
     _ids = _activeWidgetId = null;
     _cancelTimer();
   }
+
+  @override
+  bool operator ==(Object other) {
+    if (identical(this, other)) return true;
+    return other is ShowcaseView &&
+        scope == other.scope &&
+        autoPlay == other.autoPlay &&
+        autoPlayDelay == other.autoPlayDelay &&
+        enableAutoPlayLock == other.enableAutoPlayLock &&
+        blurValue == other.blurValue &&
+        scrollDuration == other.scrollDuration &&
+        disableMovingAnimation == other.disableMovingAnimation &&
+        disableScaleAnimation == other.disableScaleAnimation &&
+        enableAutoScroll == other.enableAutoScroll &&
+        disableBarrierInteraction == other.disableBarrierInteraction &&
+        enableShowcase == other.enableShowcase &&
+        globalTooltipActionConfig == other.globalTooltipActionConfig &&
+        listEquals(globalTooltipActions, other.globalTooltipActions) &&
+        listEquals(
+          hideFloatingActionWidgetForShowcase,
+          other.hideFloatingActionWidgetForShowcase,
+        );
+  }
+
+  @override
+  int get hashCode {
+    return Object.hashAllUnordered([
+      scope,
+      onFinish,
+      onDismiss,
+      onStart,
+      onComplete,
+      autoPlay,
+      autoPlayDelay,
+      enableAutoPlayLock,
+      blurValue,
+      scrollDuration,
+      disableMovingAnimation,
+      disableScaleAnimation,
+      enableAutoScroll,
+      disableBarrierInteraction,
+      enableShowcase,
+      globalTooltipActionConfig,
+      globalTooltipActions,
+      globalFloatingActionWidget,
+      hideFloatingActionWidgetForShowcase,
+    ]);
+  }
 }