Merge pull request #10485 from atmire/main-seo-health-actuator

SEOHealthIndicator which verifies all relevant parameters for SEO issues

dspace-api/src/test/data/dspaceFolder/config/local.cfg

@@ -158,6 +158,7 @@ proxies.trusted.include_ui_ip = true
 
 # For the tests we have to disable this health indicator because there isn't a mock server and the calculated status was DOWN
 management.health.solrOai.enabled = false
+management.health.seo.enabled = false
 
 # Enable researcher profiles and orcid synchronization for tests
 researcher-profile.entity-type = Person

dspace-server-webapp/src/main/java/org/dspace/app/rest/configuration/ActuatorConfiguration.java

@@ -14,6 +14,7 @@ import java.util.Arrays;
 import org.apache.solr.client.solrj.SolrServerException;
 import org.dspace.app.rest.DiscoverableEndpointsService;
 import org.dspace.app.rest.health.GeoIpHealthIndicator;
+import org.dspace.app.rest.health.SEOHealthIndicator;
 import org.dspace.app.rest.health.SolrHealthIndicator;
 import org.dspace.authority.AuthoritySolrServiceImpl;
 import org.dspace.discovery.SolrSearchCore;
@@ -82,6 +83,12 @@ public class ActuatorConfiguration {
         return new SolrHealthIndicator(solrServerResolver.getServer());
     }
 
+    @Bean
+    @ConditionalOnEnabledHealthIndicator("seo")
+    public SEOHealthIndicator seoHealthIndicator() {
+        return new SEOHealthIndicator();
+    }
+
     @Bean
     @ConditionalOnEnabledHealthIndicator("geoIp")
     public GeoIpHealthIndicator geoIpHealthIndicator() {

dspace-server-webapp/src/main/java/org/dspace/app/rest/health/SEOHealthIndicator.java

@@ -0,0 +1,100 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.rest.health;
+
+import org.apache.commons.lang3.StringUtils;
+import org.dspace.services.ConfigurationService;
+import org.dspace.services.factory.DSpaceServicesFactory;
+import org.springframework.boot.actuate.health.AbstractHealthIndicator;
+import org.springframework.boot.actuate.health.Health;
+import org.springframework.web.client.RestTemplate;
+
+/**
+ * Implementation of {@link org.springframework.boot.actuate.health.HealthIndicator} that verifies if the SEO of the
+ * DSpace instance is configured correctly.
+ *
+ * This is only relevant in a production environment, where the DSpace instance is exposed to the public.
+ */
+public class SEOHealthIndicator extends AbstractHealthIndicator {
+
+    ConfigurationService configurationService = DSpaceServicesFactory.getInstance().getConfigurationService();
+
+    private final RestTemplate restTemplate = new RestTemplate();
+
+    @Override
+    protected void doHealthCheck(Health.Builder builder) {
+        String baseUrl = configurationService.getProperty("dspace.ui.url");
+
+        boolean sitemapOk = checkUrl(baseUrl + "/sitemap_index.xml") || checkUrl(baseUrl + "/sitemap_index.html");
+        RobotsTxtStatus robotsTxtStatus = checkRobotsTxt(baseUrl + "/robots.txt");
+        boolean ssrOk = checkSSR(baseUrl);
+
+        if (sitemapOk && robotsTxtStatus == RobotsTxtStatus.VALID && ssrOk) {
+            builder.up()
+                   .withDetail("sitemap", "OK")
+                   .withDetail("robots.txt", "OK")
+                   .withDetail("ssr", "OK");
+        } else {
+            builder.down();
+            builder.withDetail("sitemap", sitemapOk ? "OK" : "Sitemaps are missing or inaccessible. Please see the " +
+                    "DSpace Documentation on Search Engine Optimization for how to enable Sitemaps.");
+
+            if (robotsTxtStatus == RobotsTxtStatus.MISSING) {
+                builder.withDetail("robots.txt", "Missing or inaccessible. Please see the DSpace Documentation on " +
+                        "Search Engine Optimization for how to create a robots.txt.");
+            } else if (robotsTxtStatus == RobotsTxtStatus.INVALID) {
+                builder.withDetail("robots.txt", "Invalid because it contains localhost URLs. This is often a sign " +
+                        "that a proxy is failing to pass X-Forwarded headers to DSpace. Please see the DSpace " +
+                        "Documentation on Search Engine Optimization for how to pass X-Forwarded headers.");
+            } else {
+                builder.withDetail("robots.txt", "OK");
+            }
+            builder.withDetail("ssr", ssrOk ? "OK" : "Server-side rendering (SSR) appears to be disabled.  Most " +
+                    "search engines require enabling SSR for proper indexing. Please see the DSpace Documentation on" +
+                    " Search Engine Optimization for more details.");
+        }
+    }
+
+    private boolean checkUrl(String url) {
+        try {
+            restTemplate.getForEntity(url, String.class);
+            return true;
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
+    private RobotsTxtStatus checkRobotsTxt(String url) {
+        try {
+            String content = restTemplate.getForObject(url, String.class);
+            if (StringUtils.isBlank(content)) {
+                return RobotsTxtStatus.MISSING;
+            }
+            if (content.contains("localhost")) {
+                return RobotsTxtStatus.INVALID;
+            }
+            return RobotsTxtStatus.VALID;
+        } catch (Exception e) {
+            return RobotsTxtStatus.MISSING;
+        }
+    }
+
+    private boolean checkSSR(String url) {
+        try {
+            String content = restTemplate.getForObject(url, String.class);
+            return content != null && !content.contains("<ds-app></ds-app>");
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
+    private enum RobotsTxtStatus {
+        VALID, MISSING, INVALID
+    }
+}
+