Add more metadata elements

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2021-10-21 17:55:16 +02:00 · 2021-10-21 17:55:16 +02:00 · 3b63c2928e
commit 3b63c2928e
parent e47f38691d
10 changed files with 180 additions and 25 deletions
--- a/lib/service/metadata/actor.ex
+++ b/lib/service/metadata/actor.ex
@ -20,14 +20,24 @@ defimpl Mobilizon.Service.Metadata, for: Mobilizon.Actors.Actor do

    [
      Tag.tag(:meta, property: "og:title", content: Actor.display_name_and_username(group)),
-      Tag.tag(:meta, property: "og:url", content: group.url),
+      Tag.tag(:meta,
+        property: "og:url",
+        content:
+          Endpoint
+          |> Routes.page_url(
+            :actor,
+            Actor.preferred_username_and_domain(group)
+          )
+          |> URI.decode()
+      ),
      Tag.tag(:meta, property: "og:description", content: group.summary),
      Tag.tag(:meta, property: "og:type", content: "profile"),
      Tag.tag(:meta,
        property: "profile:username",
        content: Actor.preferred_username_and_domain(group)
      ),
-      Tag.tag(:meta, property: "twitter:card", content: "summary")
+      Tag.tag(:meta, property: "twitter:card", content: "summary"),
+      Tag.tag(:meta, property: "twitter:site", content: "@joinmobilizon")
    ]
    |> maybe_add_avatar(group)
    |> add_group_schema(group)
@ -50,8 +60,22 @@ defimpl Mobilizon.Service.Metadata, for: Mobilizon.Actors.Actor do

  @spec add_group_schema(list(Tag.t()), Actor.t()) :: list(Tag.t())
  defp add_group_schema(tags, %Actor{} = group) do
+    breadcrumbs = %{
+      "@context" => "https://schema.org",
+      "@type" => "BreadcrumbList",
+      "itemListElement" => [
+        %{
+          "@type" => "ListItem",
+          "position" => 1,
+          "name" => Actor.display_name(group)
+        }
+      ]
+    }
+
    tags ++
      [
+        ~s{<script type="application/ld+json">#{Jason.encode!(breadcrumbs)}</script>}
+        |> HTML.raw(),
        ~s{<script type="application/ld+json">#{json(group)}</script>} |> HTML.raw()
      ]
  end
--- a/lib/service/metadata/event.ex
+++ b/lib/service/metadata/event.ex
@ -1,9 +1,12 @@
 defimpl Mobilizon.Service.Metadata, for: Mobilizon.Events.Event do
  alias Phoenix.HTML
  alias Phoenix.HTML.Tag
+  alias Mobilizon.Actors.Actor
  alias Mobilizon.Addresses.Address
  alias Mobilizon.Events.{Event, EventOptions}
+  alias Mobilizon.Web.Endpoint
  alias Mobilizon.Web.JsonLD.ObjectView
+  alias Mobilizon.Web.Router.Helpers, as: Routes

  import Mobilizon.Service.Metadata.Utils,
    only: [process_description: 2, strip_tags: 1, datetime_to_string: 2, render_address: 1]
@ -35,9 +38,64 @@ defimpl Mobilizon.Service.Metadata, for: Mobilizon.Events.Event do
          ]
      end

+    breadcrumbs =
+      if event.attributed_to do
+        [
+          %{
+            "@context" => "https://schema.org",
+            "@type" => "BreadcrumbList",
+            "itemListElement" => [
+              %{
+                "@type" => "ListItem",
+                "position" => 1,
+                "name" => Actor.display_name(event.attributed_to),
+                "item" =>
+                  Endpoint
+                  |> Routes.page_url(
+                    :actor,
+                    Actor.preferred_username_and_domain(event.attributed_to)
+                  )
+                  |> URI.decode()
+              },
+              %{
+                "@type" => "ListItem",
+                "position" => 2,
+                "name" => event.title
+              }
+            ]
+          }
+        ]
+      else
+        []
+      end
+
+    breadcrumbs =
+      breadcrumbs ++
+        [
+          %{
+            "@context" => "https://schema.org",
+            "@type" => "BreadcrumbList",
+            "itemListElement" => [
+              %{
+                "@type" => "ListItem",
+                "position" => 1,
+                "name" => "Events",
+                "item" => "#{Endpoint.url()}/search"
+              },
+              %{
+                "@type" => "ListItem",
+                "position" => 2,
+                "name" => event.title
+              }
+            ]
+          }
+        ]
+
    tags ++
      [
        Tag.tag(:meta, property: "twitter:card", content: "summary_large_image"),
+        ~s{<script type="application/ld+json">#{Jason.encode!(breadcrumbs)}</script>}
+        |> HTML.raw(),
        ~s{<script type="application/ld+json">#{json(event)}</script>} |> HTML.raw()
      ]
  end
--- a/lib/service/metadata/instance.ex
+++ b/lib/service/metadata/instance.ex
@ -20,18 +20,20 @@ defmodule Mobilizon.Service.Metadata.Instance do
    description = Utils.process_description(Config.instance_description())
    title = "#{Config.instance_name()} - Mobilizon"

-    instance_json_ld = """
-    <script type="application/ld+json">{
-    "@context": "http://schema.org",
-    "@type": "WebSite",
-    "name": "#{title}",
-    "url": "#{Endpoint.url()}",
-    "potentialAction": {
-    "@type": "SearchAction",
-    "target": "#{Endpoint.url()}/search?term={search_term}",
-    "query-input": "required name=search_term"
+    json_ld = %{
+      "@context" => "http://schema.org",
+      "@type" => "WebSite",
+      "name" => "#{title}",
+      "url" => "#{Endpoint.url()}",
+      "potentialAction" => %{
+        "@type" => "SearchAction",
+        "target" => "#{Endpoint.url()}/search?term={search_term}",
+        "query-input" => "required name=search_term"
+      }
    }
-    }</script>
+
+    instance_json_ld = """
+    <script type="application/ld+json">#{Jason.encode!(json_ld)}</script>
    """

    [
--- a/lib/service/metadata/post.ex
+++ b/lib/service/metadata/post.ex
@ -1,9 +1,12 @@
 defimpl Mobilizon.Service.Metadata, for: Mobilizon.Posts.Post do
  alias Phoenix.HTML
  alias Phoenix.HTML.Tag
+  alias Mobilizon.Actors.Actor
  alias Mobilizon.Medias.{File, Media}
  alias Mobilizon.Posts.Post
+  alias Mobilizon.Web.Endpoint
  alias Mobilizon.Web.JsonLD.ObjectView
+  alias Mobilizon.Web.Router.Helpers, as: Routes
  import Mobilizon.Service.Metadata.Utils, only: [process_description: 2, strip_tags: 1]

  def build_tags(%Post{} = post, locale \\ "en") do
@ -21,9 +24,35 @@ defimpl Mobilizon.Service.Metadata, for: Mobilizon.Posts.Post do
      ]
      |> maybe_add_post_picture(post)

+    breadcrumbs = %{
+      "@context" => "https://schema.org",
+      "@type" => "BreadcrumbList",
+      "itemListElement" => [
+        %{
+          "@type" => "ListItem",
+          "position" => 1,
+          "name" => Actor.display_name(post.attributed_to),
+          "item" =>
+            Endpoint
+            |> Routes.page_url(
+              :actor,
+              Actor.preferred_username_and_domain(post.attributed_to)
+            )
+            |> URI.decode()
+        },
+        %{
+          "@type" => "ListItem",
+          "position" => 2,
+          "name" => post.title
+        }
+      ]
+    }
+
    tags ++
      [
        Tag.tag(:meta, property: "twitter:card", content: "summary_large_image"),
+        ~s{<script type="application/ld+json">#{Jason.encode!(breadcrumbs)}</script>}
+        |> HTML.raw(),
        ~s{<script type="application/ld+json">#{json(post)}</script>} |> HTML.raw()
      ]
  end
--- a/lib/web/views/json_ld/object_view.ex
+++ b/lib/web/views/json_ld/object_view.ex
@ -11,13 +11,30 @@ defmodule Mobilizon.Web.JsonLD.ObjectView do

  @spec render(String.t(), map()) :: map()
  def render("group.json", %{group: %Actor{} = group}) do
-    %{
+    res = %{
      "@context" => "http://schema.org",
      "@type" => "Organization",
      "url" => group.url,
      "name" => group.name || group.preferred_username,
      "address" => render_address(group)
    }
+
+    res =
+      if group.banner do
+        Map.put(res, "image", group.banner.url)
+      else
+        res
+      end
+
+    if group.physical_address do
+      Map.put(
+        res,
+        "address",
+        render_one(group.physical_address, ObjectView, "address.json", as: :address)
+      )
+    else
+      res
+    end
  end

  def render("event.json", %{event: %Event{} = event}) do
@ -93,12 +110,27 @@ defmodule Mobilizon.Web.JsonLD.ObjectView do
      "@context" => "https://schema.org",
      "@type" => "Article",
      "name" => post.title,
+      "headline" => post.title,
      "author" => %{
        "@type" => "Organization",
-        "name" => Actor.display_name(post.attributed_to)
+        "name" => Actor.display_name(post.attributed_to),
+        "url" =>
+          Endpoint
+          |> Routes.page_url(
+            :actor,
+            Actor.preferred_username_and_domain(post.attributed_to)
+          )
+          |> URI.decode()
      },
      "datePublished" => post.publish_at,
-      "dateModified" => post.updated_at
+      "dateModified" => post.updated_at,
+      "image" =>
+        if(post.picture,
+          do: [
+            post.picture.file.url
+          ],
+          else: ["#{Endpoint.url()}/img/mobilizon_default_card.png"]
+        )
    }
  end

--- a/test/service/metadata/instance_test.exs
+++ b/test/service/metadata/instance_test.exs
@ -10,7 +10,9 @@ defmodule Mobilizon.Service.Metadata.InstanceTest do
      description = Utils.process_description(Config.instance_description())

      assert Instance.build_tags() |> Utils.stringify_tags() ==
-               "<title>#{title}</title><meta content=\"#{description}\" name=\"description\"><meta content=\"#{title}\" property=\"og:title\"><meta content=\"#{Endpoint.url()}\" property=\"og:url\"><meta content=\"#{description}\" property=\"og:description\"><meta content=\"website\" property=\"og:type\"><script type=\"application/ld+json\">{\n\"@context\": \"http://schema.org\",\n\"@type\": \"WebSite\",\n\"name\": \"#{title}\",\n\"url\": \"#{Endpoint.url()}\",\n\"potentialAction\": {\n\"@type\": \"SearchAction\",\n\"target\": \"#{Endpoint.url()}/search?term={search_term}\",\n\"query-input\": \"required name=search_term\"\n}\n}</script>\n"
+               """
+               <title>#{title}</title><meta content="#{description}" name="description"><meta content="#{title}" property="og:title"><meta content="#{Endpoint.url()}" property="og:url"><meta content="#{description}" property="og:description"><meta content="website" property="og:type"><script type="application/ld+json">{"@context":"http://schema.org","@type":"WebSite","name":"#{title}","potentialAction":{"@type":"SearchAction","query-input":"required name=search_term","target":"#{Endpoint.url()}/search?term={search_term}"},"url":"#{Endpoint.url()}"}</script>
+               """
    end
  end
 end
--- a/test/service/metadata/metadata_test.exs
+++ b/test/service/metadata/metadata_test.exs
@ -18,7 +18,7 @@ defmodule Mobilizon.Service.MetadataTest do

      assert group |> Metadata.build_tags() |> Metadata.Utils.stringify_tags() ==
               String.trim("""
-               <meta content="#{group.name} (@#{group.preferred_username}@#{group.domain})" property="og:title"><meta content="#{group.url}" property="og:url"><meta content="The event organizer didn&#39;t add any description." property="og:description"><meta content="profile" property="og:type"><meta content="#{Actor.preferred_username_and_domain(group)}" property="profile:username"><meta content="summary" property="twitter:card"><meta content="#{group.avatar.url}" property="og:image"><script type="application/ld+json">{"@context":"http://schema.org","@type":"Organization","address":null,"name":"#{group.name}","url":"#{group.url}"}</script><link href="#{Routes.feed_url(Endpoint, :actor, Actor.preferred_username_and_domain(group), "atom")}" rel="alternate" title="#{group.name}'s feed" type="application/atom+xml"><link href="#{Routes.feed_url(Endpoint, :actor, Actor.preferred_username_and_domain(group), "ics")}" rel="alternate" title="#{group.name}'s feed" type="text/calendar"><link href=\"#{group.url}\" rel=\"alternate\" type=\"application/activity+json\"><link href=\"#{group.url}\" rel=\"canonical\"><meta content=\"noindex\" name=\"robots\">
+               <meta content="#{group.name} (@#{group.preferred_username}@#{group.domain})" property="og:title"><meta content="#{URI.decode(Routes.page_url(Endpoint, :actor, Actor.preferred_username_and_domain(group)))}" property="og:url"><meta content="The event organizer didn&#39;t add any description." property="og:description"><meta content="profile" property="og:type"><meta content="#{Actor.preferred_username_and_domain(group)}" property="profile:username"><meta content="summary" property="twitter:card"><meta content="@joinmobilizon" property="twitter:site"><meta content="#{group.avatar.url}" property="og:image"><script type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","name":"#{group.name}","position":1}]}</script><script type="application/ld+json">{"@context":"http://schema.org","@type":"Organization","address":{"@type":"PostalAddress","addressCountry":"My Country","addressLocality":"My Locality","addressRegion":"My Region","postalCode":"My Postal Code","streetAddress":"My Street Address"},"image":"#{group.banner.url}","name":"#{group.name}","url":"#{group.url}"}</script><link href="#{Routes.feed_url(Endpoint, :actor, Actor.preferred_username_and_domain(group), "atom")}" rel="alternate" title="#{group.name}'s feed" type="application/atom+xml"><link href="#{Routes.feed_url(Endpoint, :actor, Actor.preferred_username_and_domain(group), "ics")}" rel="alternate" title="#{group.name}'s feed" type="text/calendar"><link href="#{group.url}" rel="alternate" type="application/activity+json"><link href="#{group.url}" rel="canonical"><meta content="noindex" name="robots">
               """)

      assert group
@ -26,7 +26,7 @@ defmodule Mobilizon.Service.MetadataTest do
             |> Metadata.build_tags()
             |> Metadata.Utils.stringify_tags() ==
               String.trim("""
-               <meta content="#{group.name} (@#{group.preferred_username}@#{group.domain})" property="og:title"><meta content="#{group.url}" property="og:url"><meta content="The event organizer didn&#39;t add any description." property="og:description"><meta content="profile" property="og:type"><meta content="#{Actor.preferred_username_and_domain(group)}" property="profile:username"><meta content="summary" property="twitter:card"><script type="application/ld+json">{"@context":"http://schema.org","@type":"Organization","address":null,"name":"#{group.name}","url":"#{group.url}"}</script><link href="#{Routes.feed_url(Endpoint, :actor, Actor.preferred_username_and_domain(group), "atom")}" rel="alternate" title="#{group.name}'s feed" type="application/atom+xml"><link href="#{Routes.feed_url(Endpoint, :actor, Actor.preferred_username_and_domain(group), "ics")}" rel="alternate" title="#{group.name}'s feed" type="text/calendar"><link href=\"#{group.url}\" rel=\"alternate\" type=\"application/activity+json\"><link href=\"#{group.url}\" rel=\"canonical\"><meta content=\"noindex\" name=\"robots\">
+               <meta content="#{group.name} (@#{group.preferred_username}@#{group.domain})" property="og:title"><meta content="#{URI.decode(Routes.page_url(Endpoint, :actor, Actor.preferred_username_and_domain(group)))}" property="og:url"><meta content="The event organizer didn&#39;t add any description." property="og:description"><meta content="profile" property="og:type"><meta content="#{Actor.preferred_username_and_domain(group)}" property="profile:username"><meta content="summary" property="twitter:card"><meta content="@joinmobilizon" property="twitter:site"><script type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","name":"#{group.name}","position":1}]}</script><script type="application/ld+json">{"@context":"http://schema.org","@type":"Organization","address":{"@type":"PostalAddress","addressCountry":"My Country","addressLocality":"My Locality","addressRegion":"My Region","postalCode":"My Postal Code","streetAddress":"My Street Address"},"image":"#{group.banner.url}","name":"#{group.name}","url":"#{group.url}"}</script><link href="#{Routes.feed_url(Endpoint, :actor, Actor.preferred_username_and_domain(group), "atom")}" rel="alternate" title="#{group.name}'s feed" type="application/atom+xml"><link href="#{Routes.feed_url(Endpoint, :actor, Actor.preferred_username_and_domain(group), "ics")}" rel="alternate" title="#{group.name}'s feed" type="text/calendar"><link href="#{group.url}" rel="alternate" type="application/activity+json"><link href="#{group.url}" rel="canonical"><meta content="noindex" name="robots">
               """)
    end

@ -100,7 +100,13 @@ defmodule Mobilizon.Service.MetadataTest do
               |> Floki.attribute("content")
               |> hd

-      assert "event.json" |> ObjectView.render(%{event: event}) |> Jason.encode!() ==
+      event_json_ld = "event.json" |> ObjectView.render(%{event: event}) |> Jason.encode!()
+
+      breadcrumbs = """
+      [{\"@context\":\"https://schema.org\",\"@type\":\"BreadcrumbList\",\"itemListElement\":[{\"@type\":\"ListItem\",\"item\":\"http://mobilizon.test/search\",\"name\":\"Events\",\"position\":1},{\"@type\":\"ListItem\",\"name\":\"#{event.title}\",\"position\":2}]}]
+      """
+
+      assert String.trim(breadcrumbs) <> event_json_ld ==
               document
               |> Floki.find("script[type=\"application/ld+json\"]")
               |> Floki.text(js: true)
@ -125,7 +131,7 @@ defmodule Mobilizon.Service.MetadataTest do
             |> Metadata.build_tags()
             |> Metadata.Utils.stringify_tags() ==
               String.trim("""
-               <meta content="#{post.title}" property="og:title"><meta content="#{post.url}" property="og:url"><meta content="#{Metadata.Utils.process_description(post.body)}" property="og:description"><meta content="article" property="og:type"><meta content="summary" property="twitter:card"><link href="#{post.url}" rel="canonical"><meta content="#{post.picture.file.url}" property="og:image"><meta content="summary_large_image" property="twitter:card"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","author":{"@type":"Organization","name":"#{post.attributed_to.preferred_username}"},"dateModified":"#{DateTime.to_iso8601(post.updated_at)}","datePublished":"#{DateTime.to_iso8601(post.publish_at)}","name":"My Awesome article"}</script>
+               <meta content="#{post.title}" property="og:title"><meta content="#{post.url}" property="og:url"><meta content="#{Metadata.Utils.process_description(post.body)}" property="og:description"><meta content="article" property="og:type"><meta content="summary" property="twitter:card"><link href="#{post.url}" rel="canonical"><meta content="#{post.picture.file.url}" property="og:image"><meta content="summary_large_image" property="twitter:card"><script type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"#{post.attributed_to.url}","name":"#{post.attributed_to.name}","position":1},{"@type":"ListItem","name":"#{post.title}","position":2}]}</script><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","author":{"@type":"Organization","name":"#{post.attributed_to.name}","url":"#{post.attributed_to.url}"},"dateModified":"#{DateTime.to_iso8601(post.updated_at)}","datePublished":"#{DateTime.to_iso8601(post.publish_at)}","headline":"#{post.title}","image":["#{post.picture.file.url}"],"name":"My Awesome article"}</script>
               """)
    end
  end
--- a/test/support/factory.ex
+++ b/test/support/factory.ex
@ -45,6 +45,7 @@ defmodule Mobilizon.Factory do

    %Mobilizon.Actors.Actor{
      preferred_username: preferred_username,
+      name: sequence("Thomas Named"),
      domain: nil,
      followers: [],
      followings: [],
@ -81,7 +82,8 @@ defmodule Mobilizon.Factory do
        resources_url: Actor.build_url(preferred_username, :resources),
        inbox_url: Actor.build_url(preferred_username, :inbox),
        outbox_url: Actor.build_url(preferred_username, :outbox),
-        user: nil
+        user: nil,
+        physical_address: build(:address)
      }
    )
  end
--- a/test/tasks/users_test.exs
+++ b/test/tasks/users_test.exs
@ -216,7 +216,7 @@ defmodule Mix.Tasks.Mobilizon.UsersTest do
      actor2 = insert(:actor, user: user)

      output =
-        "Informations for the user #{@email}:\n  - account status: Activated on #{confirmed_at} (UTC)\n  - Role: #{role}\n  Identities (2):\n    - @#{actor1.preferred_username} / \n    - @#{actor2.preferred_username} / \n\n\n"
+        "Informations for the user #{@email}:\n  - account status: Activated on #{confirmed_at} (UTC)\n  - Role: #{role}\n  Identities (2):\n    - @#{actor1.preferred_username} / #{actor1.name}\n    - @#{actor2.preferred_username} / #{actor2.name}\n\n\n"

      Show.run([@email])
      assert_received {:mix_shell, :info, [output_received]}
--- a/test/web/controllers/feed_controller_test.exs
+++ b/test/web/controllers/feed_controller_test.exs
@ -30,7 +30,7 @@ defmodule Mobilizon.Web.FeedControllerTest do
      {:ok, feed} = ElixirFeedParser.parse(conn.resp_body)

      assert feed.title ==
-               actor.preferred_username <> "'s public events feed on #{Config.instance_name()}"
+               actor.name <> "'s public events feed on #{Config.instance_name()}"

      [entry1, entry2] = entries = feed.entries

@ -270,7 +270,7 @@ defmodule Mobilizon.Web.FeedControllerTest do
      {:ok, feed} = ElixirFeedParser.parse(conn.resp_body)

      assert feed.title ==
-               "#{actor1.preferred_username}'s private events feed on #{Config.instance_name()}"
+               "#{actor1.name}'s private events feed on #{Config.instance_name()}"

      [entry] = feed.entries
      assert entry.title == event1.title