Merge pull request #18543 from github/support-conditionals-in-sublanding-fm

Support conditionals in sublanding FM properties

Author: sarahs

lib/page.js

@@ -202,16 +202,21 @@ class Page {
 
     if (this.learningTracks) {
       const learningTracks = []
-      for await (const trackName of this.rawLearningTracks) {
-        const track = context.site.data['learning-tracks'][context.currentProduct][trackName]
+      for await (const rawTrackName of this.rawLearningTracks) {
+        // Track names in frontmatter may include Liquid conditionals
+        const renderedTrackName = await renderContent(rawTrackName, context, { textOnly: true, encodeEntities: true })
+        if (!renderedTrackName) continue
+
+        const track = context.site.data['learning-tracks'][context.currentProduct][renderedTrackName]
         if (!track) continue
         learningTracks.push({
-          trackName,
+          trackName: renderedTrackName,
           title: await renderContent(track.title, context, { textOnly: true, encodeEntities: true }),
           description: await renderContent(track.description, context, { textOnly: true, encodeEntities: true }),
           guides: await getLinkData(track.guides, context)
         })
       }
+
       this.learningTracks = learningTracks
     }
 

tests/fixtures/article-with-learning-tracks.md

@@ -6,5 +6,7 @@ learningTracks:
   - track_1
   - track_2
   - non_existing_track
+  - '{% if currentVersion == "free-pro-team@latest" %}dotcom_only_track{% endif %}'
+  - '{% if currentVersion != "free-pro-team@latest" %}enterprise_only_track{% endif %}'
 layout: product-sublanding
 ---

tests/unit/page.js

@@ -5,6 +5,7 @@ const prerenderedObjects = require('../../lib/graphql/static/prerendered-objects
 const allVersions = require('../../lib/all-versions')
 const enterpriseServerReleases = require('../../lib/enterprise-server-releases')
 const nonEnterpriseDefaultVersion = require('../../lib/non-enterprise-default-version')
+const { latest } = require('../../lib/enterprise-server-releases')
 
 const getLinkData = require('../../lib/get-link-data')
 jest.mock('../../lib/get-link-data')
@@ -336,7 +337,13 @@ describe('Page class', () => {
     })
 
     it('includes learning tracks specified in frontmatter', async () => {
-      expect(page.learningTracks).toStrictEqual(['track_1', 'track_2', 'non_existing_track'])
+      expect(page.learningTracks).toStrictEqual([
+        'track_1',
+        'track_2',
+        'non_existing_track',
+        '{% if currentVersion == "free-pro-team@latest" %}dotcom_only_track{% endif %}',
+        '{% if currentVersion != "free-pro-team@latest" %}enterprise_only_track{% endif %}'
+      ])
     })
 
     it('renders learning tracks that have been defined', async () => {
@@ -358,15 +365,35 @@ describe('Page class', () => {
                   title: 'title',
                   description: 'description',
                   guides
+                },
+                dotcom_only_track: {
+                  title: 'title',
+                  description: 'description',
+                  guides
+                },
+                enterprise_only_track: {
+                  title: 'title',
+                  description: 'description',
+                  guides
                 }
               }
             }
           }
         }
       }
       await page.render(context)
+      // To actually render the guides in this test, we would have to load context.pages and context.redirects;
+      // To avoid that we can just test that the function was called with the expected data.
       expect(getLinkData).toHaveBeenCalledWith(guides, context)
-      expect(page.learningTracks).toHaveLength(2)
+      expect(page.learningTracks).toHaveLength(3)
+      expect(page.learningTracks.find(track => track.trackName === 'dotcom_only_track')).toBeTruthy()
+
+      // Test that Liquid versioning is respected
+      context.currentVersion = `enterprise-server@${latest}`
+      await page.render(context)
+      expect(page.learningTracks).toHaveLength(3)
+      expect(page.learningTracks.find(track => track.trackName === 'dotcom_only_track')).toBeFalsy()
+      expect(page.learningTracks.find(track => track.trackName === 'enterprise_only_track')).toBeTruthy()
     })
   })