add new middleware contextualizers that are feature flagged

Author: sarahs

middleware/contextualizers/breadcrumbs.js

@@ -0,0 +1,38 @@
+module.exports = async function breadcrumbs (req, res, next) {
+  if (!req.context.page) return next()
+  if (req.context.page.hidden) return next()
+
+  req.context.breadcrumbs = []
+
+  // Return an empty array on the landing page.
+  if (req.context.page.documentType === 'homepage') {
+    return next()
+  }
+
+  const currentSiteTree = req.context.siteTree[req.context.currentLanguage][req.context.currentVersion]
+
+  await createBreadcrumb(
+    // Array of child pages on the root, i.e., the product level.
+    currentSiteTree.childPages,
+    req.context
+  )
+
+  return next()
+}
+
+async function createBreadcrumb (pageArray, context) {
+  // Find each page in the siteTree's array of child pages that starts with the requested path.
+  const childPage = pageArray.find(page => context.currentPath.startsWith(page.href))
+
+  context.breadcrumbs.push({
+    documentType: childPage.page.documentType,
+    href: childPage.href,
+    title: await childPage.page.renderTitle(context, { textOnly: true, encodeEntities: true })
+  })
+
+  // Recursively loop through the siteTree and create each breadcrumb, until we reach the
+  // point where the current siteTree page is the same as the requested page. Then stop.
+  if (childPage.childPages && context.currentPath !== childPage.href) {
+    createBreadcrumb(childPage.childPages, context)
+  }
+}

middleware/contextualizers/current-product-tree.js

@@ -0,0 +1,10 @@
+module.exports = function currentProductTree (req, res, next) {
+  if (!req.context.page) return next()
+  if (req.context.page.documentType === 'homepage') return next()
+
+  const currentSiteTree = req.context.siteTree[req.context.currentLanguage][req.context.currentVersion]
+
+  req.context.currentProductTree = currentSiteTree.childPages.find(page => req.context.currentPath.startsWith(page.href))
+
+  return next()
+}

middleware/contextualizers/early-access-breadcrumbs.js

@@ -0,0 +1,55 @@
+module.exports = async function breadcrumbs (req, res, next) {
+  if (!req.context.page) return next()
+  if (!req.context.page.hidden) return next()
+
+  req.context.breadcrumbs = []
+
+  // Return an empty array on the landing page.
+  if (req.context.page.documentType === 'homepage') {
+    return next()
+  }
+
+  const earlyAccessProduct = req.context.siteTree[req.language][req.context.currentVersion].childPages.find(childPage => childPage.page.relativePath === 'early-access/index.md')
+  if (!earlyAccessProduct) return next()
+
+  // Create initial landing page breadcrumb
+  req.context.breadcrumbs.push({
+    documentType: earlyAccessProduct.page.documentType,
+    href: '',
+    title: earlyAccessProduct.page.title
+  })
+
+  // If this is the Early Access landing page, return now
+  if (req.context.currentPath === earlyAccessProduct.href) {
+    return next()
+  }
+
+  // Otherwise, create breadcrumbs
+  await createBreadcrumb(
+    earlyAccessProduct.childPages,
+    req.context
+  )
+
+  return next()
+}
+
+async function createBreadcrumb (pageArray, context) {
+  // Find each page in the siteTree's array of child pages that starts with the requested path.
+  const childPage = pageArray.find(page => context.currentPath.startsWith(page.href))
+
+  // Gray out product breadcrumb links and `Articles` categories
+  const hideHref = childPage.page.documentType === 'product' ||
+    (childPage.page.documentType === 'category' && childPage.page.relativePath.endsWith('/articles/index.md'))
+
+  context.breadcrumbs.push({
+    documentType: childPage.page.documentType,
+    href: hideHref ? '' : childPage.href,
+    title: await childPage.page.renderTitle(context, { textOnly: true, encodeEntities: true })
+  })
+
+  // Recursively loop through the siteTree and create each breadcrumb, until we reach the
+  // point where the current siteTree page is the same as the requested page. Then stop.
+  if (childPage.childPages && context.currentPath !== childPage.href) {
+    createBreadcrumb(childPage.childPages, context)
+  }
+}

middleware/contextualizers/generic-toc.js

@@ -0,0 +1,45 @@
+const { sortBy } = require('lodash')
+
+module.exports = async function genericToc (req, res, next) {
+  if (!req.context.page) return next()
+  if (req.context.page.hidden) return next()
+  if (req.context.currentLayoutName !== 'generic-toc') return next()
+
+  const currentSiteTree = req.context.siteTree[req.context.currentLanguage][req.context.currentVersion]
+
+  // Find the array of child pages that start with the requested path.
+  const currentPageInSiteTree = findPageInSiteTree(currentSiteTree.childPages, req.context.currentPath)
+
+  const unsortedTocItems = await Promise.all(currentPageInSiteTree.childPages.map(async (childPage) => {
+    // return an empty string if it's a hidden link on a non-hidden page (hidden links on hidden pages are OK)
+    if (childPage.page.hidden && !req.context.page.hidden) {
+      return ''
+    }
+
+    const fullPath = childPage.href
+    const title = await childPage.page.renderTitle(req.context, { textOnly: true, encodeEntities: true })
+    const intro = await childPage.page.renderProp('intro', req.context, { unwrap: true })
+
+    return { fullPath, title, intro }
+  }))
+
+  req.context.tocItems = sortBy(
+    unsortedTocItems,
+    // Sort by the ordered array of `children` in the frontmatter.
+    currentPageInSiteTree.page.children
+  )
+
+  return next()
+}
+
+// Recursively loop through the siteTree until we reach the point where the
+// current siteTree page is the same as the requested page. Then stop.
+function findPageInSiteTree (pageArray, currentPath) {
+  const childPage = pageArray.find(page => currentPath.startsWith(page.href))
+
+  if (childPage.href === currentPath) {
+    return childPage
+  }
+
+  return findPageInSiteTree(childPage.childPages, currentPath)
+}