account for the fact that featured_track values may either be booleans or strings to be parsed

sarahs · sarahs · commit 89da003ebda6 · 2021-04-28T13:42:17.000-04:00
diff --git a/lib/process-learning-tracks.js b/lib/process-learning-tracks.js
@@ -3,6 +3,8 @@ const getLinkData = require('./get-link-data')
 
 const renderOpts = { textOnly: true, encodeEntities: true }
 
+// This module returns an object that contains a single featured learning track
+// and an array of all the other learning tracks for the current version.
 module.exports = async function processLearningTracks (rawLearningTracks, context) {
   const learningTracks = []
 
@@ -30,17 +32,16 @@ module.exports = async function processLearningTracks (rawLearningTracks, contex
 
     // Determine if this is the featured track.
     if (track.featured_track) {
-      // Featured track properties may include Liquid conditionals with versioning, so we need to parse to
-      // determine if the featured track is relevant for this version.
-      const parsed = await renderContent(track.featured_track, context, renderOpts)
-      if (parsed === 'true') {
+      // Featured track properties may be booleans or string that include Liquid conditionals with versioning.
+      // We need to parse any strings to determine if the featured track is relevant for this version.
+      isFeaturedTrack = typeof track.featured_track === 'boolean' || (await renderContent(track.featured_track, context, renderOpts) === 'true')
+
+      if (isFeaturedTrack) {
         featuredTrack = learningTrack
-        isFeaturedTrack = true
       }
     }
 
-    // Only add the track to the array of tracks if there are guides in this version
-    // and it's not the featured track.
+    // Only add the track to the array of tracks if there are guides in this version and it's not the featured track.
     if (learningTrack.guides.length && !isFeaturedTrack) {
       learningTracks.push(learningTrack)
     }
diff --git a/tests/content/lint-files.js b/tests/content/lint-files.js
@@ -725,24 +725,25 @@ describe('lint learning tracks', () => {
         expect(errors.length, errorMessage).toBe(0)
       })
 
-      it.only('has one and only one featured track per version', async () => {
+      it('has one and only one featured track per version', async () => {
         const featuredTracks = {}
         const context = { enterpriseServerVersions }
 
         await Promise.all(allVersions.map(async (version) => {
           const featuredTracksPerVersion = (await Promise.all(Object.values(dictionary).map(async (entry) => {
             if (!entry.featured_track) return
             context.currentVersion = version
-            return renderContent(entry.featured_track, context, { textOnly: true, encodeEntities: true })
+            const isFeaturedLink = typeof entry.featured_track === 'boolean' || (await renderContent(entry.featured_track, context, { textOnly: true, encodeEntities: true }) === 'true')
+            return isFeaturedLink
           })))
-            .filter(val => val === 'true')
+            .filter(Boolean)
 
-          featuredTracks[version] = featuredTracksPerVersion
+          featuredTracks[version] = featuredTracksPerVersion.length
         }))
 
-        Object.entries(featuredTracks).forEach(([version, arrayOfTracks]) => {
-          const errorMessage = `Featured learning track not found for ${version} in ${yamlAbsPath}`
-          expect(arrayOfTracks.length, errorMessage).toBe(1)
+        Object.entries(featuredTracks).forEach(([version, numOfFeaturedTracks]) => {
+          const errorMessage = `Expected one featured learning track for ${version} in ${yamlAbsPath}`
+          expect(numOfFeaturedTracks, errorMessage).toBe(1)
         })
       })
 
