From 9919046c1c0450fb3422752ea3442199b90c4e0c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9rgio=20Saquetim?=
 <1108771+megothss@users.noreply.github.com>
Date: Mon, 13 Nov 2023 19:00:00 -0300
Subject: [PATCH] DEV: Improve discovery components plugin-outlets
 compatibility with existing customizations

This commit changes some plugin outlets in `<Discovery::Layout>`, `<Discovery::Navigation>` and `Discovery::Topics` to improve compatibility with existing customization, simplifying the migration process to the new discovery routes.

In these components, the standard plugin outlets will receive by default at least the arguments: `category` and `tag`.

Furthermore, two new wrapping plugin outlets were added to enable the conversion of existing template overrides to the new pattern: `discovery-list-area` and `topic-list-bottom`. The new template overrides will receive a `model` argument containing the full model handled by the route.

---------

Co-authored-by: David Taylor <david@taylorhq.com>
---
 .../app/components/discovery/layout.hbs       | 50 ++++++++---
 .../app/components/discovery/navigation.hbs   |  4 +-
 .../app/components/discovery/topics.hbs       | 88 +++++++++++--------
 .../app/templates/discovery/categories.hbs    |  2 +-
 .../app/templates/discovery/filter.hbs        |  2 +-
 .../app/templates/discovery/list.hbs          |  2 +-
 6 files changed, 92 insertions(+), 56 deletions(-)

diff --git a/app/assets/javascripts/discourse/app/components/discovery/layout.hbs b/app/assets/javascripts/discourse/app/components/discovery/layout.hbs
index ab8d10777a4..d48ab8294c8 100644
--- a/app/assets/javascripts/discourse/app/components/discovery/layout.hbs
+++ b/app/assets/javascripts/discourse/app/components/discovery/layout.hbs
@@ -1,28 +1,37 @@
 <div class="container">
   <DiscourseBanner />
-  {{#if @category}}
+  {{#if @model.category}}
     <CategoryReadOnlyBanner
-      @category={{@category}}
+      @category={{@model.category}}
       @readOnly={{@createTopicDisabled}}
     />
   {{/if}}
 </div>
 
 <span>
-  <PluginOutlet @name="discovery-list-controls-above" @connectorTagName="div" />
+  <PluginOutlet
+    @name="discovery-list-controls-above"
+    @connectorTagName="div"
+    @outletArgs={{hash category=@model.category tag=@model.tag}}
+  />
 </span>
 
 <div class="list-controls">
   <PluginOutlet
     @name="discovery-navigation-bar-above"
     @connectorTagName="div"
+    @outletArgs={{hash category=@model.category tag=@model.tag}}
   />
   <div class="container">
     {{yield to="navigation"}}
   </div>
 </div>
 
-<PluginOutlet @name="discovery-above" @connectorTagName="div" />
+<PluginOutlet
+  @name="discovery-above"
+  @connectorTagName="div"
+  @outletArgs={{hash category=@model.category tag=@model.tag}}
+/>
 
 <div class="container list-container">
   <div class="row">
@@ -31,26 +40,43 @@
         {{yield to="header"}}
         <PluginOutlet
           @name="header-list-container-bottom"
-          @outletArgs={{hash category=@category}}
+          @outletArgs={{hash category=@model.category tag=@model.tag}}
         />
       </div>
     </div>
   </div>
   <div class="row">
     <div class="full-width">
-      <PluginOutlet @name="before-list-area" />
+      <PluginOutlet
+        @name="before-list-area"
+        @outletArgs={{hash category=@model.category tag=@model.tag}}
+      />
       <div id="list-area">
         <PluginOutlet
-          @name="discovery-list-container-top"
-          @connectorTagName="span"
-          @outletArgs={{hash category=@category}}
-        />
-        {{yield to="list"}}
+          @name="discovery-list-area"
+          @outletArgs={{hash
+            category=@model.category
+            tag=@model.tag
+            model=@model
+          }}
+          @defaultGlimmer={{true}}
+        >
+          <PluginOutlet
+            @name="discovery-list-container-top"
+            @connectorTagName="span"
+            @outletArgs={{hash category=@model.category tag=@model.tag}}
+          />
+          {{yield to="list"}}
+        </PluginOutlet>
       </div>
     </div>
   </div>
 </div>
 
 <span>
-  <PluginOutlet @name="discovery-below" @connectorTagName="div" />
+  <PluginOutlet
+    @name="discovery-below"
+    @connectorTagName="div"
+    @outletArgs={{hash category=@model.category tag=@model.tag}}
+  />
 </span>
\ No newline at end of file
diff --git a/app/assets/javascripts/discourse/app/components/discovery/navigation.hbs b/app/assets/javascripts/discourse/app/components/discovery/navigation.hbs
index b85fe2e9a9b..9535ebd0390 100644
--- a/app/assets/javascripts/discourse/app/components/discovery/navigation.hbs
+++ b/app/assets/javascripts/discourse/app/components/discovery/navigation.hbs
@@ -3,7 +3,7 @@
 {{#if @category}}
   <PluginOutlet
     @name="above-category-heading"
-    @outletArgs={{hash category=@category}}
+    @outletArgs={{hash category=@category tag=@tag}}
   />
 
   <section class="category-heading">
@@ -18,7 +18,7 @@
       <PluginOutlet
         @name="category-heading"
         @connectorTagName="div"
-        @outletArgs={{hash category=@category}}
+        @outletArgs={{hash category=@category tag=@tag}}
       />
     </span>
   </section>
diff --git a/app/assets/javascripts/discourse/app/components/discovery/topics.hbs b/app/assets/javascripts/discourse/app/components/discovery/topics.hbs
index 4144978714d..4b73aab621e 100644
--- a/app/assets/javascripts/discourse/app/components/discovery/topics.hbs
+++ b/app/assets/javascripts/discourse/app/components/discovery/topics.hbs
@@ -114,46 +114,56 @@
 <footer class="topic-list-bottom">
   <ConditionalLoadingSpinner @condition={{@model.loadingMore}} />
   {{#if this.allLoaded}}
-    <TopicDismissButtons
-      @position="bottom"
-      @selectedTopics={{@bulkSelectHelper.selected}}
-      @model={{@model}}
-      @showResetNew={{@showResetNew}}
-      @showDismissRead={{@showDismissRead}}
-      @resetNew={{this.resetNew}}
-      @dismissRead={{this.dismissRead}}
-    />
-
-    <FooterMessage
-      @education={{this.footerEducation}}
-      @message={{this.footerMessage}}
+    <PluginOutlet
+      @name="topic-list-bottom"
+      @outletArgs={{hash
+        category=@category
+        tag=@tag
+        allLoaded=this.allLoaded
+        model=@model
+      }}
     >
-      {{#if @tag}}
-        {{html-safe
-          (i18n "topic.browse_all_tags_or_latest" basePath=(base-path))
-        }}
-      {{else if this.latest}}
-        {{#if @category.canCreateTopic}}
-          <DiscourseLinkedText
-            @action={{fn
-              this.composer.openNewTopic
-              (hash category=@category preferDraft=true)
-            }}
-            @text="topic.suggest_create_topic"
-          />
+      <TopicDismissButtons
+        @position="bottom"
+        @selectedTopics={{@bulkSelectHelper.selected}}
+        @model={{@model}}
+        @showResetNew={{@showResetNew}}
+        @showDismissRead={{@showDismissRead}}
+        @resetNew={{this.resetNew}}
+        @dismissRead={{this.dismissRead}}
+      />
+
+      <FooterMessage
+        @education={{this.footerEducation}}
+        @message={{this.footerMessage}}
+      >
+        {{#if @tag}}
+          {{html-safe
+            (i18n "topic.browse_all_tags_or_latest" basePath=(base-path))
+          }}
+        {{else if this.latest}}
+          {{#if @category.canCreateTopic}}
+            <DiscourseLinkedText
+              @action={{fn
+                this.composer.openNewTopic
+                (hash category=@category preferDraft=true)
+              }}
+              @text="topic.suggest_create_topic"
+            />
+          {{/if}}
+        {{else if this.top}}
+          {{html-safe
+            (i18n
+              "topic.browse_all_categories_latest_or_top" basePath=(base-path)
+            )
+          }}
+          <TopPeriodButtons @period={{@period}} @action={{@changePeriod}} />
+        {{else}}
+          {{html-safe
+            (i18n "topic.browse_all_categories_latest" basePath=(base-path))
+          }}
         {{/if}}
-      {{else if this.top}}
-        {{html-safe
-          (i18n
-            "topic.browse_all_categories_latest_or_top" basePath=(base-path)
-          )
-        }}
-        <TopPeriodButtons @period={{@period}} @action={{@changePeriod}} />
-      {{else}}
-        {{html-safe
-          (i18n "topic.browse_all_categories_latest" basePath=(base-path))
-        }}
-      {{/if}}
-    </FooterMessage>
+      </FooterMessage>
+    </PluginOutlet>
   {{/if}}
 </footer>
\ No newline at end of file
diff --git a/app/assets/javascripts/discourse/app/templates/discovery/categories.hbs b/app/assets/javascripts/discourse/app/templates/discovery/categories.hbs
index 5104e9c4cd6..bc77a36ffc2 100644
--- a/app/assets/javascripts/discourse/app/templates/discovery/categories.hbs
+++ b/app/assets/javascripts/discourse/app/templates/discovery/categories.hbs
@@ -1,4 +1,4 @@
-<Discovery::Layout>
+<Discovery::Layout @model={{this.model}}>
   <:navigation>
     <Discovery::Navigation
       @showCategoryAdmin={{this.model.can_create_category}}
diff --git a/app/assets/javascripts/discourse/app/templates/discovery/filter.hbs b/app/assets/javascripts/discourse/app/templates/discovery/filter.hbs
index c65545503a3..5f1dbd4ab24 100644
--- a/app/assets/javascripts/discourse/app/templates/discovery/filter.hbs
+++ b/app/assets/javascripts/discourse/app/templates/discovery/filter.hbs
@@ -1,4 +1,4 @@
-<Discovery::Layout>
+<Discovery::Layout @model={{this.model}}>
   <:navigation>
     <Discovery::FilterNavigation
       @queryString={{this.q}}
diff --git a/app/assets/javascripts/discourse/app/templates/discovery/list.hbs b/app/assets/javascripts/discourse/app/templates/discovery/list.hbs
index 4eb8e2655a5..4ef572b7994 100644
--- a/app/assets/javascripts/discourse/app/templates/discovery/list.hbs
+++ b/app/assets/javascripts/discourse/app/templates/discovery/list.hbs
@@ -1,5 +1,5 @@
 <Discovery::Layout
-  @category={{this.model.category}}
+  @model={{this.model}}
   @createTopicDisabled={{this.createTopicDisabled}}
 >
   <:navigation>