FilesExpand file tree

main

/

resolve-carousels.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

176 lines (146 loc) · 5.51 KB

main

/

resolve-carousels.ts

Copy path

Top

File metadata and controls

• Code
• Blame

176 lines (146 loc) · 5.51 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

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

import type { Context, ExtendedRequest, Page, ResolvedArticle } from '@/types'

import type { Response, NextFunction } from 'express'

import findPage from '@/frame/lib/find-page'

import Permalink from '@/frame/lib/permalink'

import { createLogger } from '@/observability/logger/index'

// Page adds rawCarousels at runtime, but the Page type omits it.

interface PageCarouselProps {

rawCarousels?: Record<string, string[]>

}

const logger = createLogger('middleware:resolve-carousels')

function buildArticlePath(currentLanguage: string, articlePath: string, basePath?: string): string {

const pathPrefix = basePath ? `/${currentLanguage}/${basePath}` : `/${currentLanguage}`

const separator = articlePath.startsWith('/') ? '' : '/'

return `${pathPrefix}${separator}${articlePath}`

}

// Resolve carousel paths as content-relative, then page-relative, then retry both with .md.

function tryResolveArticlePath(

rawPath: string,

pageRelativePath: string | undefined,

req: ExtendedRequest,

language?: string,

): Page | undefined {

const { pages, redirects } = req.context!

const currentLanguage = language || req.context!.currentLanguage || 'en'

if (!pages || !redirects) {

return undefined

}

const contentRelativePath = buildArticlePath(currentLanguage, rawPath)

let foundPage = findPage(contentRelativePath, pages, redirects)

if (foundPage) {

return foundPage

}

if (pageRelativePath) {

const pageDirPath = pageRelativePath.split('/').slice(0, -1).join('/')

const pageRelativeFullPath = buildArticlePath(currentLanguage, rawPath, pageDirPath)

foundPage = findPage(pageRelativeFullPath, pages, redirects)

if (foundPage) {

return foundPage

}

}

if (!rawPath.endsWith('.md')) {

const pathWithExtension = `${rawPath}.md`

const contentRelativePathWithExt = buildArticlePath(currentLanguage, pathWithExtension)

foundPage = findPage(contentRelativePathWithExt, pages, redirects)

if (foundPage) {

return foundPage

}

if (pageRelativePath) {

const pageDirPath = pageRelativePath.split('/').slice(0, -1).join('/')

const pageRelativeFullPathWithExt = buildArticlePath(

currentLanguage,

pathWithExtension,

pageDirPath,

)

foundPage = findPage(pageRelativeFullPathWithExt, pages, redirects)

if (foundPage) {

return foundPage

}

}

}

return foundPage

}

function findEnglishArticle(

rawPath: string,

pageRelativePath: string | undefined,

req: ExtendedRequest,

): Page {

const enPage = tryResolveArticlePath(rawPath, pageRelativePath, req, 'en')

if (!enPage) {

throw new Error(`Unable to find English carousel article: ${rawPath}`)

}

return enPage

}

function getPageHref(page: Page): string {

if (page.relativePath) {

return Permalink.relativePathToSuffix(page.relativePath)

}

return ''

}

async function resolveCarousels(

req: ExtendedRequest,

res: Response,

next: NextFunction,

): Promise<void> {

try {

const page = req.context?.page

const rawCarousels = (page as unknown as PageCarouselProps)?.rawCarousels

if (rawCarousels && typeof rawCarousels === 'object') {

const resolvedCarousels: Record<string, ResolvedArticle[]> = {}

for (const [carouselKey, articlePaths] of Object.entries(rawCarousels)) {

if (!Array.isArray(articlePaths) || articlePaths.length === 0) {

continue

}

const uniquePaths = [...new Set(articlePaths)]

const resolved: ResolvedArticle[] = []

for (const rawPath of uniquePaths) {

try {

const foundPage = tryResolveArticlePath(rawPath, page?.relativePath, req)

if (

foundPage &&

(!req.context?.currentVersion ||

foundPage.applicableVersions.includes(req.context.currentVersion))

) {

const href = getPageHref(foundPage)

const category = foundPage.relativePath

? foundPage.relativePath.split('/').slice(0, -1).filter(Boolean)

: []

// The request's getEnglishPage resolves the landing page, not the carousel article.

const renderContext: Context = req.context!.getEnglishPage

? {

...req.context!,

getEnglishPage: () => findEnglishArticle(rawPath, page?.relativePath, req),

}

: req.context!

resolved.push({

// The shared Page keeps title and intro from its last render, which can be another version.

title: await foundPage.renderProp('title', renderContext, { textOnly: true }),

intro: await foundPage.renderProp('intro', renderContext, { textOnly: true }),

href,

category,

})

}

} catch (error) {

logger.warn(`Failed to resolve carousel article: ${rawPath}`, { error })

}

}

if (resolved.length > 0) {

// Reject unsafe object keys to prevent prototype pollution.

if (

carouselKey !== '__proto__' &&

carouselKey !== 'constructor' &&

carouselKey !== 'prototype'

) {

resolvedCarousels[carouselKey] = resolved

}

}

}

// Every version shares one page object, so per-version results belong on the request.

req.context!.carousels = resolvedCarousels

}

} catch (error) {

logger.error('Error in resolveCarousels middleware:', { error })

}

next()

}

export default resolveCarousels