Add cases indexing controls and Apostrophe sitemap/robots setup

website/app.js

@@ -67,6 +67,7 @@ function createAposConfig() {
       },
       // Enable local SEO module with GTM integration
       '@apostrophecms/seo': {},
+      '@apostrophecms/sitemap': {},
       '@apostrophecms/global': {},
       // Make getEnv function available to templates
       '@apostrophecms/template': {
@@ -79,6 +80,7 @@ function createAposConfig() {
 
       // Add global data module
       'global-data': {},
+      'robots': {},
 
       // Shared constants module
       '@apostrophecms/shared-constants': {},

website/modules/@apostrophecms/sitemap/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  options: {
+    cacheLifetime: 60 * 60,
+  },
+};

website/modules/case-studies-page/index.js

@@ -165,6 +165,36 @@ const runSetupIndexData = async function (self, req) {
   }
 };
 
+const buildIndexSeoData = function (req) {
+  const query = req.query || {};
+  const hasFilterParams =
+    Boolean(query.search) ||
+    Boolean(query.industry) ||
+    Boolean(query.stack) ||
+    Boolean(query.caseStudyType) ||
+    Boolean(query.partner);
+  const pageNumber = Number(query.page || 1);
+  const hasPaginationParam = Number.isFinite(pageNumber) && pageNumber > 1;
+  const shouldNoindex = hasFilterParams || hasPaginationParam;
+  let pageUrl = '/cases';
+  if (req.data && req.data.page && req.data.page.slug) {
+    pageUrl = req.data.page.slug;
+  }
+  let robots = 'index,follow';
+  if (shouldNoindex) {
+    robots = 'noindex,follow';
+  }
+  return {
+    canonicalUrl: pageUrl,
+    robots,
+  };
+};
+
+const runSetupIndexSeoData = function (req) {
+  req.data ||= {};
+  req.data.caseListingSeo = buildIndexSeoData(req);
+};
+
 const runSetupShowData = async function (self, req) {
   try {
     const navigation = await NavigationService.getNavigationDataForPage(
@@ -219,6 +249,7 @@ module.exports = {
       await self.resolveSearchRelationships(req);
       await self.applyEnhancedSearchResults(req);
       await self.setupIndexData(req);
+      self.setupIndexSeoData(req);
     };
 
     const superBeforeShow = self.beforeShow;
@@ -244,6 +275,9 @@ module.exports = {
       setupIndexData(req) {
         return runSetupIndexData(self, req);
       },
+      setupIndexSeoData(req) {
+        return runSetupIndexSeoData(req);
+      },
       setupShowData(req) {
         return runSetupShowData(self, req);
       },

website/modules/case-studies-page/services/UrlService.js

@@ -153,6 +153,7 @@ class UrlService {
 
     reqCopy.data.backUrl = UrlService.buildCaseStudyUrl('/cases', queryParams);
     reqCopy.data.query = queryParams;
+    reqCopy.data.hasQueryParams = Object.keys(req.query || {}).length > 0;
   }
 }
 

website/modules/case-studies-page/views/index.html

@@ -1,6 +1,11 @@
 {# modules/case-studies-page/views/index.html #}
 {% extends "layout.html" %}
 {% import '@apostrophecms/pager:macros.html' as pager with context %}
+{% block extraHead %}
+  {{ super() }}
+  <link rel="canonical" href="{{ data.caseListingSeo.canonicalUrl | e }}" />
+  <meta name="robots" content="{{ data.caseListingSeo.robots | e }}" />
+{% endblock %}
 {% block main %}
 <div
   class="cs_container"

website/modules/case-studies-page/views/show.html

@@ -1,4 +1,13 @@
-{% extends "layout.html" %} {% block main %}
+{% extends "layout.html" %}
+{% block extraHead %}
+  {{ super() }}
+  <link rel="canonical" href="{{ data.piece._url | e }}" />
+  <meta
+    name="robots"
+    content="{% if data.hasQueryParams %}noindex,follow{% else %}index,follow{% endif %}"
+  />
+{% endblock %}
+{% block main %}
 
 <div>
   <div class="cs_nav-container">

website/modules/robots/index.js

@@ -0,0 +1,29 @@
+module.exports = {
+  routes(self) {
+    return {
+      get: {
+        '/robots.txt': (req, res) => {
+          const baseUrl = self.apos.baseUrl || '';
+          let baseHost = '';
+          try {
+            baseHost = new URL(baseUrl).hostname;
+          } catch (error) {
+            self.apos.util.warn('Invalid baseUrl for robots.txt route', error);
+            baseHost = '';
+          }
+          const isProduction = process.env.NODE_ENV === 'production';
+          const isProductionHost = baseHost === 'www.speedandfunction.com';
+          if (!isProduction || !isProductionHost) {
+            return res.type('text/plain').send('User-agent: *\nDisallow: /\n');
+          }
+
+          const robotsContent =
+            'User-agent: *\n' +
+            'Allow: /\n\n' +
+            `Sitemap: ${baseUrl}/sitemap.xml\n`;
+          return res.type('text/plain').send(robotsContent);
+        },
+      },
+    };
+  },
+};

website/package.json

@@ -41,6 +41,7 @@
     "@apostrophecms/form": "^1.4.2",
     "@apostrophecms/import-export": "^3.2.0",
     "@apostrophecms/security-headers": "^1.0.2",
+    "@apostrophecms/sitemap": "^1.2.0",
     "@barba/core": "^2.10.3",
     "abort-controller": "^3.0.0",
     "apostrophe": "^4.17.0",