From 8405ec2831322314b8145e7908f025ba6dee4881 Mon Sep 17 00:00:00 2001
From: Vinoth Kannan <svkn.87@gmail.com>
Date: Mon, 3 Apr 2023 14:36:47 +0530
Subject: [PATCH] FEATURE: use "Comment" schema type for post replies. (#20932)

Previously, we used the schema type "DiscussionForumPosting" for all the posts including replies. This is not recommended as per Google search experts. This commit changes the schema type to "Comment" for replies.
---
 app/views/topics/show.html.erb          | 151 ++++++++++++------------
 spec/views/topics/show.html.erb_spec.rb |  17 +++
 2 files changed, 92 insertions(+), 76 deletions(-)

diff --git a/app/views/topics/show.html.erb b/app/views/topics/show.html.erb
index 60670a3cd52..2df22c41421 100644
--- a/app/views/topics/show.html.erb
+++ b/app/views/topics/show.html.erb
@@ -34,85 +34,84 @@
   <%= server_plugin_outlet "topic_header" %>
 
   <%- if include_crawler_content? %>
-
-  <% @topic_view.posts.each_with_index do |post, idx| %>
-    <% if (u = post.user) %>
-      <div id='post_<%= post.post_number %>' itemscope itemtype='http://schema.org/DiscussionForumPosting' class='topic-body crawler-post'>
-        <div class='crawler-post-meta'>
-          <div itemprop='publisher' itemscope itemtype="http://schema.org/Organization">
-            <meta itemprop='name' content='<%= SiteSetting.company_name.presence || SiteSetting.title %>'>
-            <% if application_logo_url.present? %>
-              <div itemprop='logo' itemscope itemtype="http://schema.org/ImageObject">
-                <meta itemprop='url' content='<%= application_logo_url %>'>
-              </div>
-            <% end %>
+    <div itemscope itemtype='http://schema.org/DiscussionForumPosting'>
+      <meta itemprop='headline' content='<%= @topic_view.title %>'>
+      <meta itemprop='keywords' content='<%= @tags.map(&:name).join(', ') %>'>
+      <div itemprop='publisher' itemscope itemtype="http://schema.org/Organization">
+        <meta itemprop='name' content='<%= SiteSetting.company_name.presence || SiteSetting.title %>'>
+        <% if application_logo_url.present? %>
+          <div itemprop='logo' itemscope itemtype="http://schema.org/ImageObject">
+            <meta itemprop='url' content='<%= application_logo_url %>'>
           </div>
-          <span class="creator" itemprop="author" itemscope itemtype="http://schema.org/Person">
-            <a itemprop="url" href='<%= Discourse.base_url %>/u/<%= u.username %>'><span itemprop='name'><%= u.username %></span></a>
-            <%= "(#{u.name})" if (SiteSetting.display_name_on_posts && SiteSetting.enable_names? && !u.name.blank?) %>
-            <%
-              post_custom_fields = @topic_view.post_custom_fields[post.id] || {}
-              who_username = post_custom_fields["action_code_who"] || ""
-              small_action_href = post_custom_fields["action_code_path"] || ""
-              if post.action_code
-            %>
-              <%= t("js.action_codes.#{post.action_code}", when: "", who: who_username, href: small_action_href).html_safe %>
-            <% end %>
-          </span>
-
-          <link itemprop="mainEntityOfPage" href="<%= post.topic.url %>">
-
-          <% if post.image_url %>
-            <link itemprop="image" href="<%= post.image_url %>">
-          <% end %>
-
-          <span class="crawler-post-infos">
-              <time itemprop='datePublished' datetime='<%= post.created_at.to_formatted_s(:iso8601) %>' class='post-time'>
-                <%= l post.created_at, format: :long %>
-              </time>
-            <% if post.version > 1 %>
-              <meta itemprop='dateModified' content='<%= post.last_version_at.to_formatted_s(:iso8601) %>'>
-            <% else %>
-              <meta itemprop='dateModified' content='<%= post.created_at.to_formatted_s(:iso8601) %>'>
-            <% end %>
-          <span itemprop='position'><%= post.post_number %></span>
-          </span>
-        </div>
-        <div class='post' itemprop='articleBody'>
-          <%= post.hidden ? t('flagging.user_must_edit').html_safe : post.cooked.html_safe %>
-        </div>
-
-        <meta itemprop='headline' content='<%= @topic_view.title %>'>
-        <% if idx == 0 %>
-          <meta itemprop='keywords' content='<%= @tags.map(&:name).join(', ') %>'>
         <% end %>
-
-        <div itemprop="interactionStatistic" itemscope itemtype="http://schema.org/InteractionCounter">
-           <meta itemprop="interactionType" content="http://schema.org/LikeAction"/>
-           <meta itemprop="userInteractionCount" content="<%= post.like_count %>" />
-           <span class='post-likes'><%= post.like_count > 0 ? t('post.has_likes', count: post.like_count) : '' %></span>
-         </div>
-
-         <div itemprop="interactionStatistic" itemscope itemtype="http://schema.org/InteractionCounter">
-            <meta itemprop="interactionType" content="http://schema.org/CommentAction"/>
-            <meta itemprop="userInteractionCount" content="<%= post.reply_count %>" />
-          </div>
-
-          <% if @topic_view.link_counts[post.id] && @topic_view.link_counts[post.id].filter { |l| l[:reflection] }.length > 0 %>
-            <div class='crawler-linkback-list' itemscope itemtype='http://schema.org/ItemList'>
-              <% @topic_view.link_counts[post.id].each_with_index do |link, i| %>
-                <% if link[:reflection] && link[:title].present? %>
-                  <div itemprop='itemListElement' itemscope itemtype='http://schema.org/ListItem'>
-                    <a itemprop='url' href="<%=link[:url]%>"><%=link[:title]%></a>
-                    <meta itemprop='position' content='<%= i+1 %>'>
-                  </div>
-                <% end %>
-              <% end %>
-            </div>
-         <% end %>
       </div>
-    <% end %>
-  <% end %>
+
+      <% @topic_view.posts.each do |post| %>
+        <% if (u = post.user) %>
+          <div id='post_<%= post.post_number %>' <%= post.is_first_post? ? "" : "itemprop='comment' itemscope itemtype='http://schema.org/Comment'".html_safe %> class='topic-body crawler-post'>
+            <div class='crawler-post-meta'>
+              <span class="creator" itemprop="author" itemscope itemtype="http://schema.org/Person">
+                <a itemprop="url" href='<%= Discourse.base_url %>/u/<%= u.username %>'><span itemprop='name'><%= u.username %></span></a>
+                <%= "(#{u.name})" if (SiteSetting.display_name_on_posts && SiteSetting.enable_names? && !u.name.blank?) %>
+                <%
+                  post_custom_fields = @topic_view.post_custom_fields[post.id] || {}
+                  who_username = post_custom_fields["action_code_who"] || ""
+                  small_action_href = post_custom_fields["action_code_path"] || ""
+                  if post.action_code
+                %>
+                  <%= t("js.action_codes.#{post.action_code}", when: "", who: who_username, href: small_action_href).html_safe %>
+                <% end %>
+              </span>
+
+              <link itemprop="mainEntityOfPage" href="<%= post.topic.url %>">
+
+              <% if post.image_url %>
+                <link itemprop="image" href="<%= post.image_url %>">
+              <% end %>
+
+              <span class="crawler-post-infos">
+                  <time itemprop='datePublished' datetime='<%= post.created_at.to_formatted_s(:iso8601) %>' class='post-time'>
+                    <%= l post.created_at, format: :long %>
+                  </time>
+                <% if post.version > 1 %>
+                  <meta itemprop='dateModified' content='<%= post.last_version_at.to_formatted_s(:iso8601) %>'>
+                <% else %>
+                  <meta itemprop='dateModified' content='<%= post.created_at.to_formatted_s(:iso8601) %>'>
+                <% end %>
+              <span itemprop='position'><%= post.post_number %></span>
+              </span>
+            </div>
+            <div class='post' itemprop='<%= post.is_first_post? ? 'articleBody' : 'text'  %>'>
+              <%= post.hidden ? t('flagging.user_must_edit').html_safe : post.cooked.html_safe %>
+            </div>
+
+            <div itemprop="interactionStatistic" itemscope itemtype="http://schema.org/InteractionCounter">
+              <meta itemprop="interactionType" content="http://schema.org/LikeAction"/>
+              <meta itemprop="userInteractionCount" content="<%= post.like_count %>" />
+              <span class='post-likes'><%= post.like_count > 0 ? t('post.has_likes', count: post.like_count) : '' %></span>
+            </div>
+
+            <div itemprop="interactionStatistic" itemscope itemtype="http://schema.org/InteractionCounter">
+                <meta itemprop="interactionType" content="http://schema.org/CommentAction"/>
+                <meta itemprop="userInteractionCount" content="<%= post.reply_count %>" />
+              </div>
+
+              <% if @topic_view.link_counts[post.id] && @topic_view.link_counts[post.id].filter { |l| l[:reflection] }.length > 0 %>
+                <div class='crawler-linkback-list' itemscope itemtype='http://schema.org/ItemList'>
+                  <% @topic_view.link_counts[post.id].each_with_index do |link, i| %>
+                    <% if link[:reflection] && link[:title].present? %>
+                      <div itemprop='itemListElement' itemscope itemtype='http://schema.org/ListItem'>
+                        <a itemprop='url' href="<%=link[:url]%>"><%=link[:title]%></a>
+                        <meta itemprop='position' content='<%= i+1 %>'>
+                      </div>
+                    <% end %>
+                  <% end %>
+                </div>
+            <% end %>
+          </div>
+        <% end %>
+      <% end %>
+    </div>
 
   <% if @topic_view.prev_page || @topic_view.next_page %>
     <div role='navigation' itemscope itemtype='http://schema.org/SiteNavigationElement' class="topic-body crawler-post">
diff --git a/spec/views/topics/show.html.erb_spec.rb b/spec/views/topics/show.html.erb_spec.rb
index e2293544417..d4a401b1395 100644
--- a/spec/views/topics/show.html.erb_spec.rb
+++ b/spec/views/topics/show.html.erb_spec.rb
@@ -43,4 +43,21 @@ RSpec.describe "topics/show.html.erb" do
     expect(first_item.css('[itemprop="position"]')[0]["content"]).to eq("1")
     expect(first_item.css('[itemprop="url"]')[0]["href"]).to eq("https://example.com/")
   end
+
+  it "uses comment scheme type for replies" do
+    view.stubs(:crawler_layout?).returns(true)
+    view.stubs(:include_crawler_content?).returns(true)
+    Fabricate(:post, topic: topic)
+    Fabricate(:post, topic: topic)
+    Fabricate(:post, topic: topic)
+    assign(:topic_view, TopicView.new(topic))
+    assign(:tags, [])
+
+    render template: "topics/show", formats: [:html]
+
+    doc = Nokogiri::HTML5.fragment(rendered)
+    topic_schema = doc.css('[itemtype="http://schema.org/DiscussionForumPosting"]')
+    expect(topic_schema.size).to eq(1)
+    expect(topic_schema.css('[itemtype="http://schema.org/Comment"]').size).to eq(2)
+  end
 end