FilesExpand file tree

main

/

licenses.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

229 lines (199 loc) · 6.6 KB

main

/

licenses.ts

Copy path

Top

File metadata and controls

• Code
• Blame

229 lines (199 loc) · 6.6 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

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

import {Change, Changes} from './schemas'

import {octokitClient} from './utils'

import {parsePURL, PackageURL, purlsMatch} from './purl'

import * as spdx from './spdx'

/**

* Loops through a list of changes, filtering and returning the

* ones that don't conform to the licenses allow/deny lists.

* It will also filter out the changes which are defined in the licenseExclusions list.

*

* Keep in mind that we don't let users specify both an allow and a deny

* list in their config files, so this code works under the assumption that

* one of the two list parameters will be empty. If both lists are provided,

* we will ignore the deny list.

* @param {Change[]} changes The list of changes to filter.

* @param { { allow?: string[], deny?: string[], licenseExclusions?: string[]}} licenses An object with `allow`/`deny`/`licenseExclusions` keys, each containing a list of licenses.

* @returns {Promise<{Object.<string, Array.<Change>>}} A promise to a Record Object. The keys are strings, unlicensed, unresolved and forbidden. The values are a list of changes

*/

export type InvalidLicenseChangeTypes =

'unlicensed' | 'unresolved' | 'forbidden'

export type InvalidLicenseChanges = Record<InvalidLicenseChangeTypes, Changes>

export async function getInvalidLicenseChanges(

changes: Change[],

licenses: {

allow?: string[]

deny?: string[]

licenseExclusions?: string[]

}

): Promise<InvalidLicenseChanges> {

const deny = licenses.deny

let allow = licenses.allow

// Filter out elements of the allow list that include AND

// or OR because the list should be simple license IDs and

// not expressions.

allow = allow?.filter(license => {

return !license.includes(' AND ') && !license.includes(' OR ')

})

const licenseExclusions = licenses.licenseExclusions?.map(

(pkgUrl: string) => {

return parsePURL(pkgUrl)

}

)

const groupedChanges = await groupChanges(changes, licenseExclusions)

const licensedChanges: Changes = groupedChanges.licensed

const invalidLicenseChanges: InvalidLicenseChanges = {

unlicensed: groupedChanges.unlicensed,

unresolved: [],

forbidden: []

}

const validityCache = new Map<string, boolean>()

for (const change of licensedChanges) {

const license = change.license

// should never happen since licensedChanges always have licenses but license is nullable in changes schema

if (license === null) {

continue

}

if (license === 'NOASSERTION') {

invalidLicenseChanges.unlicensed.push(change)

} else if (validityCache.get(license) === undefined) {

try {

if (allow !== undefined) {

if (spdx.isValid(license)) {

const found = spdx.satisfies(license, allow)

validityCache.set(license, found)

} else {

invalidLicenseChanges.unresolved.push(change)

}

} else if (deny !== undefined) {

if (spdx.isValid(license)) {

const found = spdx.satisfiesAny(license, deny)

validityCache.set(license, !found)

} else {

invalidLicenseChanges.unresolved.push(change)

}

}

} catch {

invalidLicenseChanges.unresolved.push(change)

}

}

if (validityCache.get(license) === false) {

invalidLicenseChanges.forbidden.push(change)

}

}

return invalidLicenseChanges

}

const fetchGHLicense = async (

owner: string,

repo: string

): Promise<string | null> => {

try {

const response = await octokitClient().rest.licenses.getForRepo({

owner,

repo

})

return response.data.license?.spdx_id ?? null

} catch {

return null

}

}

const parseGitHubURL = (url: string): {owner: string; repo: string} | null => {

try {

const parsed = new URL(url)

if (parsed.host !== 'github.com') {

return null

}

const components = parsed.pathname.split('/')

if (components.length < 3) {

return null

}

return {owner: components[1], repo: components[2]}

} catch {

return null

}

}

const setGHLicenses = async (changes: Change[]): Promise<Change[]> => {

const updatedChanges = changes.map(async change => {

if (change.license !== null || change.source_repository_url === null) {

return change

}

const githubUrl = parseGitHubURL(change.source_repository_url)

if (githubUrl === null) {

return change

}

return {

...change,

license: await fetchGHLicense(githubUrl.owner, githubUrl.repo)

}

})

return Promise.all(updatedChanges)

}

// Currently Dependency Graph licenses are truncated to 255 characters

// This possibly makes them invalid spdx ids

const truncatedDGLicense = (license: string): boolean =>

license.length === 255 && !spdx.isValid(license)

async function groupChanges(

changes: Changes,

licenseExclusions: PackageURL[] | null = null

): Promise<Record<string, Changes>> {

const result: Record<string, Changes> = {

licensed: [],

unlicensed: []

}

let candidateChanges = changes

// If a package is excluded from license checking, we don't bother trying to

// fetch the license for it and we leave it off of the `licensed` and

// `unlicensed` lists.

if (licenseExclusions !== null && licenseExclusions !== undefined) {

candidateChanges = candidateChanges.filter(change => {

if (change.package_url.length === 0) {

return true

}

const changeAsPackageURL = parsePURL(change.package_url)

// We want to find if the licenseExclusion list contains the PackageURL of the Change

// If it does, we want to filter it out and therefore return false

// If it doesn't, we want to keep it and therefore return true

if (

licenseExclusions.findIndex(exclusion =>

purlsMatch(exclusion, changeAsPackageURL)

) !== -1

) {

return false

} else {

return true

}

})

}

const ghChanges = []

for (const change of candidateChanges) {

if (change.change_type === 'removed') {

continue

}

if (change.license === null) {

if (change.source_repository_url !== null) {

ghChanges.push(change)

} else {

result.unlicensed.push(change)

}

} else {

if (

truncatedDGLicense(change.license) &&

change.source_repository_url !== null

) {

ghChanges.push(change)

} else {

result.licensed.push(change)

}

}

}

if (ghChanges.length > 0) {

const ghLicenses = await setGHLicenses(ghChanges)

for (const change of ghLicenses) {

if (change.license === null) {

result.unlicensed.push(change)

} else {

result.licensed.push(change)

}

}

}

return result

}