Skip to content
Navigation Menu
{{ message }}
forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpage.js
More file actions
577 lines (513 loc) · 23.8 KB
/
Copy pathpage.js
File metadata and controls
577 lines (513 loc) · 23.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
const path = require('path')
const cheerio = require('cheerio')
const Page = require('../../lib/page')
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')
// get the `free-pro-team` segment of `free-pro-team@latest`
const nonEnterpriseDefaultPlan = nonEnterpriseDefaultVersion.split('@')[0]
const opts = {
relativePath: 'github/collaborating-with-issues-and-pull-requests/about-branches.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
}
describe('Page class', () => {
test('preserves file path info', async () => {
const page = await Page.init(opts)
expect(page.relativePath).toBe('github/collaborating-with-issues-and-pull-requests/about-branches.md')
expect(page.fullPath.includes(page.relativePath)).toBe(true)
})
test('does not error out on translated TOC with no links', async () => {
const page = await Page.init({
relativePath: 'translated-toc-with-no-links-index.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'ja'
})
expect(typeof page.title).toBe('string')
})
describe('showMiniToc page property', () => {
let article, articleWithFM, tocPage, mapTopic
beforeAll(async () => {
article = await Page.init({
relativePath: 'sample-article.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
articleWithFM = await Page.init({
showMiniToc: false,
relativePath: article.relativePath,
basePath: article.basePath,
languageCode: article.languageCode
})
tocPage = await Page.init({
relativePath: 'sample-toc-index.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
mapTopic = await Page.init({
mapTopic: true,
relativePath: article.relativePath,
basePath: article.basePath,
languageCode: article.languageCode
})
})
test('is true by default on articles', () => {
expect(article.showMiniToc).toBe(true)
})
test('is false on articles when set in frontmatter', () => {
expect(articleWithFM.showMiniToc).toBe(false)
})
test('is undefined by default on index.md pages', () => {
expect(tocPage.showMiniToc).toBeUndefined()
})
test('is undefined by default on map topics', () => {
expect(mapTopic.showMiniToc).toBeUndefined()
})
})
describe('page.render(context)', () => {
test('rewrites links to include the current language prefix and version', async () => {
const page = await Page.init(opts)
const context = {
page: { version: `enterprise-server@${enterpriseServerReleases.latest}` },
currentVersion: `enterprise-server@${enterpriseServerReleases.latest}`,
currentPath: '/en/github/collaborating-with-issues-and-pull-requests/about-branches',
currentLanguage: 'en'
}
const rendered = await page.render(context)
const $ = cheerio.load(rendered)
expect(page.markdown.includes('(/articles/about-pull-requests)')).toBe(true)
expect(page.markdown.includes('(/en/articles/about-pull-requests)')).toBe(false)
expect($('a[href="/articles/about-pull-requests"]').length).toBe(0)
expect($(`a[href="/en/${`enterprise-server@${enterpriseServerReleases.latest}`}/articles/about-pull-requests"]`).length).toBeGreaterThan(0)
})
test('rewrites links on prerendered GraphQL page include the current language prefix and version', async () => {
const graphqlVersion = allVersions[`enterprise-server@${enterpriseServerReleases.latest}`].miscVersionName
const $ = cheerio.load(prerenderedObjects[graphqlVersion].html)
expect($('a[href^="/graphql/reference/input-objects"]').length).toBe(0)
expect($(`a[href^="/en/enterprise-server@${enterpriseServerReleases.latest}/graphql/reference/input-objects"]`).length).toBeGreaterThan(0)
})
test('rewrites links in the intro to include the current language prefix and version', async () => {
const page = await Page.init(opts)
page.rawIntro = '[Pull requests](/articles/about-pull-requests)'
const context = {
page: { version: nonEnterpriseDefaultVersion },
currentVersion: nonEnterpriseDefaultVersion,
currentPath: '/en/github/collaborating-with-issues-and-pull-requests/about-branches',
currentLanguage: 'en'
}
await page.render(context)
const $ = cheerio.load(page.intro)
expect($('a[href="/articles/about-pull-requests"]').length).toBe(0)
expect($('a[href="/en/articles/about-pull-requests"]').length).toBeGreaterThan(0)
})
test('does not rewrite links that include deprecated enterprise release numbers', async () => {
const page = await Page.init({
relativePath: 'admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
})
const context = {
page: { version: `enterprise-server@${enterpriseServerReleases.latest}` },
currentVersion: `enterprise-server@${enterpriseServerReleases.latest}`,
currentPath: `/en/enterprise-server@${enterpriseServerReleases.latest}/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123`,
currentLanguage: 'en'
}
const rendered = await page.render(context)
const $ = cheerio.load(rendered)
expect(page.markdown.includes('(/enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release/)')).toBe(true)
expect($(`a[href="/en/enterprise-server@${enterpriseServerReleases.latest}/11.10.340/admin/articles/upgrading-to-the-latest-release"]`).length).toBe(0)
expect($('a[href="/en/enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release"]').length).toBeGreaterThan(0)
})
test('does not rewrite links to external redirects', async () => {
const page = await Page.init(opts)
page.markdown = `${page.markdown}\n\nSee [Capistrano](/capistrano).`
const context = {
page: { version: nonEnterpriseDefaultVersion },
currentVersion: nonEnterpriseDefaultVersion,
currentPath: `/en/${nonEnterpriseDefaultVersion}/github/collaborating-with-issues-and-pull-requests/about-branches`,
currentLanguage: 'en'
}
const rendered = await page.render(context)
const $ = cheerio.load(rendered)
expect($('a[href="/capistrano"]').length).toBe(1)
})
// Most of our Liquid versioning tests are in https://github.com/docs/render-content,
// But they don't have access to our currently supported versions, which we're testing here.
// This test ensures that this works as expected: {% if enterpriseServerVersions contains currentVersion %}
test('renders the expected Enterprise Server versioned content', async () => {
const page = await Page.init({
relativePath: 'page-versioned-for-all-enterprise-releases.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
// set version to the latest enterprise version
const context = {
currentVersion: `enterprise-server@${enterpriseServerReleases.latest}`,
currentLanguage: 'en',
enterpriseServerVersions: Object.keys(allVersions).filter(id => id.startsWith('enterprise-server@'))
}
let rendered = await page.render(context)
let $ = cheerio.load(rendered)
expect($.text()).toBe('This text should render on any actively supported version of Enterprise Server')
expect($.text()).not.toBe('This text should only render on non-Enterprise')
// change version to the oldest enterprise version, re-render, and test again;
// the results should be the same
context.currentVersion = `enterprise-server@${enterpriseServerReleases.oldestSupported}`
rendered = await page.render(context)
$ = cheerio.load(rendered)
expect($.text()).toBe('This text should render on any actively supported version of Enterprise Server')
expect($.text()).not.toBe('This text should only render on non-Enterprise')
// change version to non-enterprise, re-render, and test again;
// the results should be the opposite
context.currentVersion = nonEnterpriseDefaultVersion
rendered = await page.render(context)
$ = cheerio.load(rendered)
expect($.text()).not.toBe('This text should render on any actively supported version of Enterprise Server')
expect($.text()).toBe('This text should only render on non-Enterprise')
})
test('support next to-be-released Enterprise Server version in frontmatter', async () => {
// This fixture has `enterprise-server: '>=3.1'` hardcoded in the frontmatter
const page = await Page.init({
relativePath: 'page-versioned-for-next-enterprise-release.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
// set version to 3.0
const context = {
currentVersion: 'enterprise-server@3.0',
currentLanguage: 'en'
}
await expect(() => { return page.render(context) }).not.toThrow()
})
test('support next GitHub AE version in frontmatter', async () => {
// This fixture has `github-ae: 'next'` hardcoded in the frontmatter
const page = await Page.init({
relativePath: 'page-versioned-for-ghae-next.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
// set version to @latest
const context = {
currentVersion: 'github-ae@latest',
currentLanguage: 'en'
}
await expect(() => { return page.render(context) }).not.toThrow()
})
})
test('preserves `languageCode`', async () => {
const page = await Page.init(opts)
expect(page.languageCode).toBe('en')
})
test('parentProductId getter', async () => {
let page = await Page.init({
relativePath: 'github/some-category/some-article.md',
basePath: path.join(__dirname, '../fixtures/products'),
languageCode: 'en'
})
expect(page.parentProductId).toBe('github')
page = await Page.init({
relativePath: 'actions/some-category/some-article.md',
basePath: path.join(__dirname, '../fixtures/products'),
languageCode: 'en'
})
expect(page.parentProductId).toBe('actions')
page = await Page.init({
relativePath: 'admin/some-category/some-article.md',
basePath: path.join(__dirname, '../fixtures/products'),
languageCode: 'en'
})
expect(page.parentProductId).toBe('admin')
})
describe('permalinks', () => {
test('is an array', async () => {
const page = await Page.init(opts)
expect(Array.isArray(page.permalinks)).toBe(true)
})
test('has a key for every supported enterprise version (and no deprecated versions)', async () => {
const page = await Page.init(opts)
const pageVersions = page.permalinks.map(permalink => permalink.pageVersion)
expect(enterpriseServerReleases.supported.every(version => pageVersions.includes(`enterprise-server@${version}`))).toBe(true)
expect(enterpriseServerReleases.deprecated.every(version => !pageVersions.includes(`enterprise-server@${version}`))).toBe(true)
})
test('sets versioned values', async () => {
const page = await Page.init(opts)
expect(page.permalinks.find(permalink => permalink.pageVersion === nonEnterpriseDefaultVersion).href).toBe('/en/github/collaborating-with-issues-and-pull-requests/about-branches')
expect(page.permalinks.find(permalink => permalink.pageVersion === `enterprise-server@${enterpriseServerReleases.oldestSupported}`).href).toBe(`/en/enterprise-server@${enterpriseServerReleases.oldestSupported}/github/collaborating-with-issues-and-pull-requests/about-branches`)
})
test('homepage permalinks', async () => {
const page = await Page.init({
relativePath: 'index.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
})
expect(page.permalinks.find(permalink => permalink.pageVersion === 'homepage').href).toBe('/en')
expect(page.permalinks.find(permalink => permalink.pageVersion === `enterprise-server@${enterpriseServerReleases.oldestSupported}`).href).toBe(`/en/enterprise-server@${enterpriseServerReleases.oldestSupported}`)
})
test('permalinks for dotcom-only pages', async () => {
const page = await Page.init({
relativePath: 'github/getting-started-with-github/signing-up-for-a-new-github-account.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
})
expect(page.permalinks.find(permalink => permalink.pageVersion === nonEnterpriseDefaultVersion).href).toBe('/en/github/getting-started-with-github/signing-up-for-a-new-github-account')
expect(page.permalinks.length).toBe(1)
})
test('permalinks for enterprise-only pages', async () => {
const page = await Page.init({
relativePath: 'products/admin/some-category/some-article.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
expect(page.permalinks.find(permalink => permalink.pageVersion === `enterprise-server@${enterpriseServerReleases.latest}`).href).toBe(`/en/enterprise-server@${enterpriseServerReleases.latest}/products/admin/some-category/some-article`)
const pageVersions = page.permalinks.map(permalink => permalink.pageVersion)
expect(pageVersions.length).toBeGreaterThan(1)
expect(pageVersions.includes(nonEnterpriseDefaultVersion)).toBe(false)
})
test('permalinks for non-GitHub.com products without Enterprise versions', async () => {
const page = await Page.init({
relativePath: 'products/actions/some-category/some-article.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
expect(page.permalinks.find(permalink => permalink.pageVersion === nonEnterpriseDefaultVersion).href).toBe('/en/products/actions/some-category/some-article')
expect(page.permalinks.length).toBe(1)
})
test('permalinks for non-GitHub.com products with Enterprise versions', async () => {
const page = await Page.init({
relativePath: '/insights/installing-and-configuring-github-insights/about-github-insights.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
})
expect(page.permalinks.find(permalink => permalink.pageVersion === `enterprise-server@${enterpriseServerReleases.latest}`).href).toBe(`/en/enterprise-server@${enterpriseServerReleases.latest}/insights/installing-and-configuring-github-insights/about-github-insights`)
const pageVersions = page.permalinks.map(permalink => permalink.pageVersion)
expect(pageVersions.length).toBeGreaterThan(1)
expect(pageVersions.includes(nonEnterpriseDefaultVersion)).toBe(false)
})
})
describe('learning tracks', () => {
let page
beforeEach(async () => {
page = await Page.init({
relativePath: 'article-with-learning-tracks.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
})
it('includes learning tracks specified in frontmatter', async () => {
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 () => {
const guides = ['/path/guide1', '/path/guide2']
const context = {
currentLanguage: 'en',
currentProduct: 'snowbird',
currentVersion: nonEnterpriseDefaultVersion,
site: {
data: {
'learning-tracks': {
snowbird: {
track_1: {
title: 'title',
description: 'description',
guides
},
track_2: {
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(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()
})
})
describe('includeGuides', () => {
let page
beforeEach(async () => {
page = await Page.init({
relativePath: 'article-with-includeGuides.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
})
it('includes guide paths specified in frontmatter', async () => {
expect(page.includeGuides).toStrictEqual(['/path/guide1', '/path/guide2', '/path/guide3'])
})
it('renders guides and topics', async () => {
getLinkData.mockImplementation(() => {
return [{
page: { topics: ['Spring', 'Summer'] }
}, {
page: { topics: ['Summer', 'Fall'] }
}, {
page: { topics: ['Fall', 'Winter'] }
}]
})
const guides = ['/path/guide1', '/path/guide2', '/path/guide3']
const context = {
currentVersion: nonEnterpriseDefaultVersion,
currentLanguage: 'en'
}
await page.render(context)
expect(getLinkData).toHaveBeenCalledWith(guides, context)
expect(page.includeGuides).toHaveLength(3)
expect(page.allTopics).toHaveLength(4)
expect(page.allTopics).toEqual(
expect.arrayContaining(['Spring', 'Summer', 'Fall', 'Winter'])
)
})
})
describe('Page.parseFrontmatter()', () => {
it('throws an error on bad input', () => {
const markdown = null
expect(() => {
Page.parseFrontmatter('some/file.md', markdown)
}).toThrow()
})
})
describe('Page.getLanguageVariants()', () => {
it('returns an array of language variants of the given URL', () => {
const variants = Page.getLanguageVariants('/en')
expect(variants.every(variant => variant.name)).toBe(true)
expect(variants.every(variant => variant.code)).toBe(true)
expect(variants.every(variant => variant.href)).toBe(true)
})
it('works for the homepage', () => {
const variants = Page.getLanguageVariants('/en')
expect(variants.find(({ code }) => code === 'en').href).toBe('/en')
// expect(variants.find(({ code }) => code === 'ja').href).toBe('/ja')
})
it('works for enterprise URLs', () => {
const variants = Page.getLanguageVariants(`/ja/enterprise/${enterpriseServerReleases.oldestSupported}/user/articles/github-glossary`)
expect(variants.find(({ code }) => code === 'en').href).toBe(`/en/enterprise/${enterpriseServerReleases.oldestSupported}/user/articles/github-glossary`)
// expect(variants.find(({ code }) => code === 'ja').href).toBe('/ja/enterprise/2.14/user/articles/github-glossary')
})
})
test('fixes translated frontmatter that includes verdadero', async () => {
const page = await Page.init({
relativePath: 'article-with-mislocalized-frontmatter.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'ja'
})
expect(page.mapTopic).toBe(true)
})
describe('page.versions frontmatter', () => {
test.skip('pages that apply to older enterprise versions', async () => {
// There are none of these in the content at this time!
})
// Note this test will go out of date when we deprecate 2.20
test('pages that apply to newer enterprise versions', async () => {
const page = await Page.init({
relativePath: 'github/administering-a-repository/comparing-releases.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
})
expect(nonEnterpriseDefaultPlan in page.versions).toBe(true)
expect(page.versions['enterprise-server']).toBe('>=2.21')
})
test('index page', async () => {
const page = await Page.init({
relativePath: 'index.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
})
expect(page.versions).toBe('*')
})
test('enterprise admin index page', async () => {
const page = await Page.init({
relativePath: 'admin/index.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
})
expect(nonEnterpriseDefaultPlan in page.versions).toBe(false)
expect(page.versions['enterprise-server']).toBe('*')
})
})
describe('platform specific content', () => {
test('page.defaultPlatform frontmatter', async () => {
const page = await Page.init({
relativePath: 'actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md',
basePath: path.join(__dirname, '../../content'),
languageCode: 'en'
})
expect(page.defaultPlatform).toBeDefined()
expect(page.defaultPlatform).toBe('linux')
})
})
})
describe('catches errors thrown in Page class', () => {
test('frontmatter parsing error', async () => {
async function getPage () {
return await Page.init({
relativePath: 'page-with-frontmatter-error.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
}
await expect(getPage).rejects.toThrowError('invalid frontmatter entry')
})
test('missing versions frontmatter', async () => {
async function getPage () {
return await Page.init({
relativePath: 'page-with-missing-product-versions.md',
basePath: path.join(__dirname, '../fixtures'),
languageCode: 'en'
})
}
await expect(getPage).rejects.toThrowError('versions')
})
test('English page with a version in frontmatter that its parent product is not available in', async () => {
async function getPage () {
return await Page.init({
relativePath: 'admin/some-category/some-article-with-mismatched-versions-frontmatter.md',
basePath: path.join(__dirname, '../fixtures/products'),
languageCode: 'en'
})
}
expect(getPage).rejects.toThrowError(/`versions` frontmatter.*? product is not available in/)
})
test('non-English page with a version in frontmatter that its parent product is not available in', async () => {
async function getPage () {
return await Page.init({
relativePath: 'admin/some-category/some-article-with-mismatched-versions-frontmatter.md',
basePath: path.join(__dirname, '../fixtures/products'),
languageCode: 'es'
})
}
await expect(getPage).rejects.toThrowError(/`versions` frontmatter.*? product is not available in/)
})
})
You can’t perform that action at this time.