FilesExpand file tree

main

/

test-open-api-schema.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

executable file

·

166 lines (138 loc) · 5.68 KB

main

/

test-open-api-schema.ts

Copy path

Top

File metadata and controls

• Code
• Blame

executable file

·

166 lines (138 loc) · 5.68 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

// Checks whether OpenAPI operations match content/rest version frontmatter.

import fs from 'fs'

import path from 'path'

import { isEqual } from 'lodash-es'

import frontmatter from '@/frame/lib/read-frontmatter'

import getApplicableVersions from '@/versions/lib/get-applicable-versions'

import { allVersions, getDocsVersion } from '@/versions/lib/all-versions'

import { REST_DATA_DIR } from '../lib/index'

import { nonAutomatedRestPaths } from '../lib/config'

import { deprecated } from '@/versions/lib/enterprise-server-releases'

import walkFiles from '@/workflows/walk-files'

type CheckObject = Record<string, Record<string, string[]>>

type DifferenceResult = Record<string, string[]>

type ErrorMessages = Record<string, Record<string, { contentDir: string[]; openAPI: string[] }>>

export async function getDiffOpenAPIContentRest(): Promise<ErrorMessages> {

const contentFiles = getAutomatedMarkdownFiles('content/rest')

const checkContentDir = await createCheckContentDirectory(contentFiles)

const openAPISchemaCheck = await createOpenAPISchemasCheck()

const differences = getDifferences(openAPISchemaCheck, checkContentDir)

const errorMessages: ErrorMessages = {}

if (Object.keys(differences).length > 0) {

for (const schemaName in differences) {

errorMessages[schemaName] = {}

for (const category of differences[schemaName]) {

errorMessages[schemaName][category] = {

contentDir: checkContentDir[schemaName][category],

openAPI: openAPISchemaCheck[schemaName][category],

}

}

}

}

return errorMessages

}

async function createOpenAPISchemasCheck(): Promise<CheckObject> {

const openAPICheck = createCheckObj()

const restDirectory = fs

.readdirSync(REST_DATA_DIR)

.filter((dir) => !dir.endsWith('.json'))

// Skip the most recently deprecated GitHub Enterprise Server data, which stays on disk until deprecation finishes.

.filter((dir) => !dir.includes(deprecated[0]))

for (const dir of restDirectory) {

const dirPath = path.join(REST_DATA_DIR, dir)

const categoryFiles = fs

.readdirSync(dirPath)

.filter((f) => f.endsWith('.json') && f !== 'schema.json')

const version = getDocsVersion(dir)

for (const categoryFile of categoryFiles) {

const category = categoryFile.replace('.json', '')

const categoryData = JSON.parse(fs.readFileSync(path.join(dirPath, categoryFile), 'utf8'))

const subcategories = Object.keys(categoryData) as string[]

if (isApiVersioned(version)) {

for (const apiVersion of getOnlyApiVersions(version)) {

openAPICheck[apiVersion][category] = subcategories.sort()

}

} else {

openAPICheck[version][category] = subcategories.sort()

}

}

}

return openAPICheck

}

async function createCheckContentDirectory(contentFiles: string[]): Promise<CheckObject> {

const checkContent = createCheckObj()

for (const filename of contentFiles) {

const { data } = frontmatter(await fs.promises.readFile(filename, 'utf8'))

const applicableVersions = getApplicableVersions(data?.versions, filename)

const splitPath = filename.split('/')

const subCategory = splitPath[splitPath.length - 1].replace('.md', '')

const category =

splitPath[splitPath.length - 2] === 'rest' ? subCategory : splitPath[splitPath.length - 2]

// Expand each docs version to its calendar-date API versions when present.

const allCompleteVersions = applicableVersions.flatMap((version) => {

return isApiVersioned(version)

? allVersions[version].apiVersions.map(

(apiVersion) => `${allVersions[version].version}.${apiVersion}`,

)

: version

})

for (const version of allCompleteVersions) {

if (!checkContent[version][category]) {

checkContent[version][category] = [subCategory]

} else {

checkContent[version][category].push(subCategory)

}

checkContent[version][category].sort()

}

}

return checkContent

}

function isApiVersioned(version: string): boolean {

return allVersions[version] && allVersions[version].apiVersions.length > 0

}

function getOnlyApiVersions(version: string): string[] {

return allVersions[version].apiVersions.map(

(apiVersion) => `${allVersions[version].version}.${apiVersion}`,

)

}

function createCheckObj(): CheckObject {

const versions: CheckObject = {}

for (const version of Object.keys(allVersions)) {

if (isApiVersioned(version)) {

for (const apiVersion of getOnlyApiVersions(version)) {

versions[apiVersion] = {}

}

} else {

versions[`${allVersions[version].version}`] = {}

}

}

return versions

}

function getDifferences(

openAPISchemaCheck: CheckObject,

contentCheck: CheckObject,

): DifferenceResult {

const differences: DifferenceResult = {}

for (const version in openAPISchemaCheck) {

const diffOpenApiContent = difference(openAPISchemaCheck[version], contentCheck[version])

if (Object.keys(diffOpenApiContent).length > 0) differences[version] = diffOpenApiContent

}

return differences

}

function difference(obj1: Record<string, string[]>, obj2: Record<string, string[]>): string[] {

const diff = Object.keys(obj1).reduce((result, key) => {

if (!Object.prototype.hasOwnProperty.call(obj2, key)) {

result.push(key)

} else if (isEqual(obj1[key], obj2[key])) {

const resultKeyIndex = result.indexOf(key)

result.splice(resultKeyIndex, 1)

}

return result

}, Object.keys(obj2))

return diff

}

export function getAutomatedMarkdownFiles(rootDir: string): string[] {

return walkFiles(rootDir, '.md')

.filter((file) => !file.includes('index.md'))

.filter((file) => !nonAutomatedRestPaths.some((excludePath) => file.includes(excludePath)))

}