FilesExpand file tree

main

/

render-page.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

121 lines (97 loc) · 4.06 KB

main

/

render-page.js

Copy path

Top

File metadata and controls

• Code
• Blame

121 lines (97 loc) · 4.06 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

import { get } from 'lodash-es'

import patterns from '../lib/patterns.js'

import getMiniTocItems from '../lib/get-mini-toc-items.js'

import Page from '../lib/page.js'

import statsd from '../lib/statsd.js'

import { isConnectionDropped } from './halt-on-dropped-connection.js'

import { nextApp, nextHandleRequest } from './next.js'

async function buildRenderedPage(req) {

const { context } = req

const { page } = context

const path = req.pagePath || req.path

const pageRenderTimed = statsd.asyncTimer(page.render, 'middleware.render_page', [`path:${path}`])

const renderedPage = await pageRenderTimed(context)

// handle special-case prerendered GraphQL objects page

if (path.endsWith('graphql/reference/objects')) {

return renderedPage + context.graphql.prerenderedObjectsForCurrentVersion.html

}

// handle special-case prerendered GraphQL input objects page

if (path.endsWith('graphql/reference/input-objects')) {

return renderedPage + context.graphql.prerenderedInputObjectsForCurrentVersion.html

}

// handle special-case prerendered GraphQL mutations page

if (path.endsWith('graphql/reference/mutations')) {

return renderedPage + context.graphql.prerenderedMutationsForCurrentVersion.html

}

return renderedPage

}

async function buildMiniTocItems(req) {

const { context } = req

const { page } = context

const isRestReferencePage =

page.relativePath.startsWith('rest') &&

!page.relativePath.includes('rest/guides') &&

!page.relativePath.includes('rest/overview')

// get mini TOC items on articles

if (!page.showMiniToc) {

return

}

return getMiniTocItems(context.renderedPage, page.miniTocMaxHeadingLevel, '', isRestReferencePage)

}

export default async function renderPage(req, res, next) {

const { context } = req

const { page } = context

const path = req.pagePath || req.path

// render a 404 page

if (!page) {

if (process.env.NODE_ENV !== 'test' && context.redirectNotFound) {

console.error(

`\nTried to redirect to ${context.redirectNotFound}, but that page was not found.\n`

)

}

return nextApp.render404(req, res)

}

// Just finish fast without all the details like Content-Length

if (req.method === 'HEAD') {

return res.status(200).end()

}

// Updating the Last-Modified header for substantive changes on a page for engineering

// Docs Engineering Issue #945

if (page.effectiveDate) {

// Note that if a page has an invalidate `effectiveDate` string value,

// it would be caught prior to this usage and ultimately lead to

// 500 error.

res.setHeader('Last-Modified', new Date(page.effectiveDate).toUTCString())

}

// collect URLs for variants of this page in all languages

page.languageVariants = Page.getLanguageVariants(path)

// Stop processing if the connection was already dropped

if (isConnectionDropped(req, res)) return

req.context.renderedPage = await buildRenderedPage(req)

req.context.miniTocItems = await buildMiniTocItems(req)

// Stop processing if the connection was already dropped

if (isConnectionDropped(req, res)) return

// Create string for <title> tag

page.fullTitle = page.titlePlainText

// add localized ` - GitHub Docs` suffix to <title> tag (except for the homepage)

if (!patterns.homepagePath.test(path)) {

page.fullTitle = page.fullTitle + ' - ' + context.site.data.ui.header.github_docs

}

// Is the request for JSON debugging info?

const isRequestingJsonForDebugging = 'json' in req.query && process.env.NODE_ENV !== 'production'

// `?json` query param for debugging request context

if (isRequestingJsonForDebugging) {

if (req.query.json.length > 1) {

// deep reference: ?json=page.permalinks

return res.json(get(context, req.query.json))

} else {

// dump all the keys: ?json

return res.json({

message:

'The full context object is too big to display! Try one of the individual keys below, e.g. ?json=page. You can also access nested props like ?json=site.data.reusables',

keys: Object.keys(context),

})

}

}

return nextHandleRequest(req, res)

}