import { jest } from '@jest/globals' import { liquid } from '../../lib/render-content/index.js' import shortVersionsMiddleware from '../../middleware/contextualizers/short-versions.js' import featureVersionsMiddleware from '../../middleware/contextualizers/features.js' import { allVersions } from '../../lib/all-versions.js' import enterpriseServerReleases from '../../lib/enterprise-server-releases.js' // Setup these variables so we don't need to manually update tests as GHES // versions continually get deprecated. For example, if we deprecate GHES 3.0, // oldestSupportedGhes will be 3.1, secondOldestSupportedGhes will be 3.2, and // thirdOldestSupportedGhes will be 3.3. const oldestSupportedGhes = enterpriseServerReleases.supported[enterpriseServerReleases.supported.length - 1] const secondOldestSupportedGhes = enterpriseServerReleases.supported[enterpriseServerReleases.supported.length - 2] const thirdOldestSupportedGhes = enterpriseServerReleases.supported[enterpriseServerReleases.supported.length - 3] const shortVersionsTemplate = ` {% ifversion fpt %} I am FPT {% endif %} {% ifversion ghae %} I am GHAE {% endif %} {% ifversion ghec %} I am GHEC{% endif %} {% ifversion ghes %} I am GHES {% endif %} {% ifversion ghes = ${secondOldestSupportedGhes} %} I am GHES = ${secondOldestSupportedGhes} {% endif %} {% ifversion ghes > ${secondOldestSupportedGhes} %} I am GHES > ${secondOldestSupportedGhes} {% endif %} {% ifversion ghes < ${secondOldestSupportedGhes} %} I am GHES < ${secondOldestSupportedGhes} {% endif %} {% ifversion fpt or ghes < ${secondOldestSupportedGhes} %} I am FTP or GHES < ${secondOldestSupportedGhes} {% endif %} {% ifversion ghes < ${thirdOldestSupportedGhes} and ghes > ${oldestSupportedGhes} %} I am ${secondOldestSupportedGhes} only {% endif %} ` const negativeVersionsTemplate = ` {% ifversion not ghae %} I am not GHAE {% endif %} {% ifversion not ghec %} I am not GHEC {% endif %} {% ifversion not ghes %} I am not GHES {% endif %} {% ifversion ghes != ${secondOldestSupportedGhes} %} I am not GHES ${secondOldestSupportedGhes} {% endif %} ` const featureVersionsTemplate = ` {% if placeholder %} I am placeholder content {% endif %} ` describe('liquid template parser', () => { jest.setTimeout(60 * 1000) describe('short versions', () => { // Create a fake req so we can test the shortVersions middleware const req = { language: 'en', query: {} } test('FPT works as expected when it is FPT', async () => { req.context = { currentVersion: 'free-pro-team@latest', page: {}, allVersions, enterpriseServerReleases, } await shortVersionsMiddleware(req, null, () => {}) const output = await liquid.parseAndRender(shortVersionsTemplate, req.context) // We should have TWO results because we are supporting two shortcuts expect(output.replace(/\s\s+/g, ' ').trim()).toBe( `I am FPT I am FTP or GHES < ${secondOldestSupportedGhes}` ) }) test('GHAE works as expected', async () => { req.context = { currentVersion: 'github-ae@latest', page: {}, allVersions, enterpriseServerReleases, } await shortVersionsMiddleware(req, null, () => {}) const output = await liquid.parseAndRender(shortVersionsTemplate, req.context) expect(output.trim()).toBe('I am GHAE') }) test('GHEC works as expected', async () => { req.context = { currentVersion: 'enterprise-cloud@latest', page: {}, allVersions, enterpriseServerReleases, } await shortVersionsMiddleware(req, null, () => {}) const output = await liquid.parseAndRender(shortVersionsTemplate, req.context) expect(output.trim()).toBe('I am GHEC') }) test('GHES works as expected', async () => { req.context = { currentVersion: `enterprise-server@${oldestSupportedGhes}`, page: {}, allVersions, enterpriseServerReleases, } await shortVersionsMiddleware(req, null, () => {}) const output = await liquid.parseAndRender(shortVersionsTemplate, req.context) expect(output.replace(/\s\s+/g, ' ').trim()).toBe( `I am GHES I am GHES < ${secondOldestSupportedGhes} I am FTP or GHES < ${secondOldestSupportedGhes}` ) }) test('AND statements work as expected', async () => { req.context = { currentVersion: `enterprise-server@${secondOldestSupportedGhes}`, page: {}, allVersions, enterpriseServerReleases, } await shortVersionsMiddleware(req, null, () => {}) const output = await liquid.parseAndRender(shortVersionsTemplate, req.context) expect(output.replace(/\s\s+/g, ' ').trim()).toBe( `I am GHES I am GHES = ${secondOldestSupportedGhes} I am ${secondOldestSupportedGhes} only` ) }) test('NOT statements work as expected on versions without numbered releases', async () => { req.context = { currentVersion: 'github-ae@latest', page: {}, allVersions, enterpriseServerReleases, } await shortVersionsMiddleware(req, null, () => {}) const output = await liquid.parseAndRender(negativeVersionsTemplate, req.context) expect(output.replace(/\s\s+/g, ' ').trim()).toBe( `I am not GHEC I am not GHES I am not GHES ${secondOldestSupportedGhes}` ) }) test('NOT statements work as expected on versions with numbered releases', async () => { req.context = { currentVersion: `enterprise-server@${oldestSupportedGhes}`, page: {}, allVersions, enterpriseServerReleases, } await shortVersionsMiddleware(req, null, () => {}) const output = await liquid.parseAndRender(negativeVersionsTemplate, req.context) expect(output.replace(/\s\s+/g, ' ').trim()).toBe( `I am not GHAE I am not GHEC I am not GHES ${secondOldestSupportedGhes}` ) }) test('The != operator works as expected', async () => { req.context = { currentVersion: `enterprise-server@${secondOldestSupportedGhes}`, page: {}, allVersions, enterpriseServerReleases, } await shortVersionsMiddleware(req, null, () => {}) const output = await liquid.parseAndRender(negativeVersionsTemplate, req.context) expect(output.replace(/\s\s+/g, ' ').trim()).toBe('I am not GHAE I am not GHEC') }) }) describe('feature versions', () => { // Create a fake req so we can test the feature versions middleware const req = { language: 'en', query: {} } test('does not render in FPT because feature is not available in FPT', async () => { req.context = { currentVersion: 'free-pro-team@latest', page: {}, allVersions, enterpriseServerReleases, } await featureVersionsMiddleware(req, null, () => {}) const outputFpt = await liquid.parseAndRender(featureVersionsTemplate, req.context) expect(outputFpt.includes('placeholder content')).toBe(false) }) test('renders in GHES because feature is available in GHES', async () => { req.context = { currentVersion: `enterprise-server@${enterpriseServerReleases.latest}`, page: {}, allVersions, enterpriseServerReleases, } await featureVersionsMiddleware(req, null, () => {}) const outputFpt = await liquid.parseAndRender(featureVersionsTemplate, req.context) expect(outputFpt.includes('placeholder content')).toBe(true) }) test('renders in GHEC because feature is available in GHEC', async () => { req.context = { currentVersion: 'enterprise-cloud@latest', page: {}, allVersions, enterpriseServerReleases, } await featureVersionsMiddleware(req, null, () => {}) const outputFpt = await liquid.parseAndRender(featureVersionsTemplate, req.context) expect(outputFpt.includes('placeholder content')).toBe(true) }) test('renders in GHAE because feature is available in GHAE', async () => { req.context = { currentVersion: 'github-ae@latest', page: {}, allVersions, enterpriseServerReleases, } await featureVersionsMiddleware(req, null, () => {}) const outputFpt = await liquid.parseAndRender(featureVersionsTemplate, req.context) expect(outputFpt.includes('placeholder content')).toBe(true) }) }) })