From 4e95fa3b5acce2c66dc0a308f7cdd0e2adfaaef9 Mon Sep 17 00:00:00 2001
From: robyngit <thiessenbock@nceas.ucsb.edu>
Date: Thu, 10 Oct 2024 14:07:38 -0400
Subject: [PATCH] Fix issues with timing of MetadataView re-render

The metadata view re-renders when a users' logged in status changes. Depending on the timing of this change,
re-rendering may occur in the middle of a previous render. This causes elements of the view to break, especially the
new CanonicalDatasetHandlerView. This commit fixes the issue by adding a check to see if the view is already
rendering before re-rendering.

Issue #2541
---
 src/js/views/MetadataView.js | 26 +++++++++++++++-----------
 1 file changed, 15 insertions(+), 11 deletions(-)

diff --git a/src/js/views/MetadataView.js b/src/js/views/MetadataView.js
index d447dfc9c..daa4bb1ae 100644
--- a/src/js/views/MetadataView.js
+++ b/src/js/views/MetadataView.js
@@ -168,6 +168,13 @@ define([
 
       /** @inheritdoc */
       render() {
+        if (this.isRendering) {
+          // If we re-render before the first render is complete the view breaks
+          this.stopListening(this, "renderComplete", this.render);
+          this.listenToOnce(this, "renderComplete", this.render);
+          return;
+        }
+        this.isRendering = true;
         this.stopListening();
 
         MetacatUI.appModel.set("headerType", "default");
@@ -185,19 +192,14 @@ define([
         this.listenTo(MetacatUI.appUserModel, "change:loggedIn", this.render);
 
         // Listen to when the metadata has been rendered
-        this.once("metadataLoaded", () => {
+        this.listenToOnce(this, "metadataLoaded", () => {
           this.createAnnotationViews();
           this.insertMarkdownViews();
           // Modifies the view to indicate that this is a dataset is essentially
           // a duplicate of another dataset, if applicable
-          if (!this.canonicalDatasetHandler) {
-            // The view should only be created once, but "metadataLoaded" can be
-            // triggered multiple times
-            this.canonicalDatasetHandler = new CanonicalDatasetHandlerView({
-              metadataView: this,
-            });
-          }
-          this.canonicalDatasetHandler.render();
+          this.canonicalDatasetHandler = new CanonicalDatasetHandlerView({
+            metadataView: this,
+          }).render();
         });
 
         // Listen to when the package table has been rendered
@@ -540,14 +542,16 @@ define([
 
                   viewRef.alterMarkup();
 
-                  viewRef.trigger("metadataLoaded");
-
                   // Add a map of the spatial coverage
                   if (gmaps) viewRef.insertSpatialCoverageMap();
 
                   // Injects Clipboard objects into DOM elements returned from
                   // the View Service
                   viewRef.insertCopiables();
+
+                  viewRef.trigger("metadataLoaded");
+                  viewRef.isRendering = false;
+                  viewRef.trigger("renderComplete");
                 }
               } catch (e) {
                 MetacatUI.analytics?.trackException(