From 569299b7a9dfd0ed5cc20747a4cdbd71c34e89b1 Mon Sep 17 00:00:00 2001
From: Ayke Halder <rr-it@users.noreply.github.com>
Date: Mon, 5 Dec 2022 17:00:32 +0100
Subject: [PATCH] DEV: use structured data in topic-list for referencing only
 (#16235)

This simplifies the ItemList to only be a point of reference to the
actual DiscussionForumPosting objects.

See "Summary page": https://developers.google.com/search/docs/advanced/structured-data/carousel?hl=en#summary-page

Co-authored-by: Bianca Nenciu <nenciu.bianca@gmail.com>
---
 app/views/list/list.erb               |  7 +------
 spec/requests/list_controller_spec.rb | 10 ++++++++++
 spec/views/list/list.erb_spec.rb      | 13 +++++++++++++
 3 files changed, 24 insertions(+), 6 deletions(-)

diff --git a/app/views/list/list.erb b/app/views/list/list.erb
index 63a9b91c0c6..d6ea1749631 100644
--- a/app/views/list/list.erb
+++ b/app/views/list/list.erb
@@ -57,14 +57,9 @@
       <% @list.topics.each_with_index do |t,i| %>
         <tr class="topic-list-item">
           <td class="main-link" itemprop='itemListElement' itemscope itemtype='http://schema.org/ListItem'>
-            <meta itemprop='name' content='<%= t.title %>'>
-            <meta itemprop='url' content='<%= t.url %>'>
-            <% if t.image_url.present? %>
-              <meta itemprop='image' content='<%= t.image_url %>'>
-            <% end %>
             <meta itemprop='position' content='<%= i + 1 %>'>
             <span class="link-top-line">
-              <a href='<%= t.url %>' class='title raw-link raw-topic-link'><%= t.title %></a>
+              <a itemprop='url' href='<%= t.url %>' class='title raw-link raw-topic-link'><%= t.title %></a>
             </span>
             <div class="link-bottom-line">
               <% if (!@category || @category.has_children?) && t.category && !t.category.uncategorized? %>
diff --git a/spec/requests/list_controller_spec.rb b/spec/requests/list_controller_spec.rb
index 60ea55c524a..d98121066c4 100644
--- a/spec/requests/list_controller_spec.rb
+++ b/spec/requests/list_controller_spec.rb
@@ -89,6 +89,16 @@ RSpec.describe ListController do
 
       expect(response.body).to have_tag "title", text: "Discourse - Best community"
     end
+
+    it "returns structured data" do
+      get "/latest"
+
+      expect(response.status).to eq(200)
+      topic_list = Nokogiri::HTML5(response.body).css('.topic-list')
+      first_item = topic_list.css('[itemprop="itemListElement"]')
+      expect(first_item.css('[itemprop="position"]')[0]['content']).to eq('1')
+      expect(first_item.css('[itemprop="url"]')[0]['href']).to eq(topic.url)
+    end
   end
 
   describe "categories and X" do
diff --git a/spec/views/list/list.erb_spec.rb b/spec/views/list/list.erb_spec.rb
index 093e4408938..07279e1582e 100644
--- a/spec/views/list/list.erb_spec.rb
+++ b/spec/views/list/list.erb_spec.rb
@@ -4,6 +4,7 @@ require "rails_helper"
 
 RSpec.describe "list/list.erb" do
   fab!(:category) { Fabricate(:category) }
+  fab!(:topic) { Fabricate(:topic) }
 
   it "add nofollow to RSS alternate link for category" do
     view.stubs(:include_crawler_content?).returns(false)
@@ -15,4 +16,16 @@ RSpec.describe "list/list.erb" do
     expect(view.content_for(:head)).to match(/<link rel="alternate nofollow" type="application\/rss\+xml" title="[^"]+" href="https:\/\/www.example.com\/test\.rss" \/>/)
   end
 
+  it "adds sturctured data" do
+    view.stubs(:include_crawler_content?).returns(true)
+    topic.posters = []
+    assign(:list, OpenStruct.new(topics: [topic]))
+
+    render template: 'list/list', formats: []
+
+    topic_list = Nokogiri::HTML5::fragment(rendered).css('.topic-list')
+    first_item = topic_list.css('[itemprop="itemListElement"]')
+    expect(first_item.css('[itemprop="position"]')[0]['content']).to eq('1')
+    expect(first_item.css('[itemprop="url"]')[0]['href']).to eq(topic.url)
+  end
 end