github-docs/src/github-apps/scripts/sync.js at main · Fryguy/github-docs · GitHub

History

executable file

349 lines (312 loc) · 12.5 KB

Raw

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

#!/usr/bin/env node

import { existsSync } from 'fs'

import { mkdirp } from 'mkdirp'

import { readFile, writeFile } from 'fs/promises'

import path from 'path'

import { slug } from 'github-slugger'

import yaml from 'js-yaml'

import walk from 'walk-sync'

import { getContents, getDirectoryContents } from '#src/workflows/git-utils.ts'

import permissionSchema from './permission-list-schema.js'

import enabledSchema from './enabled-list-schema.js'

import { validateJson } from '#src/tests/lib/validate-json-schema.js'

const ENABLED_APPS_DIR = 'src/github-apps/data'

const CONFIG_FILE = 'src/github-apps/lib/config.json'

export async function syncGitHubAppsData(openApiSource, sourceSchemas, progAccessSource) {

console.log(

`Generating GitHub Apps data from ${openApiSource}, ${sourceSchemas} and ${progAccessSource}`,

)

const { progAccessData, progActorResources } = await getProgAccessData(progAccessSource)

for (const schemaName of sourceSchemas) {

const data = JSON.parse(await readFile(path.join(openApiSource, schemaName), 'utf8'))

const appsDataConfig = JSON.parse(await readFile(CONFIG_FILE, 'utf8'))

// Initialize the data structure with keys for each page type

const githubAppsData = {}

for (const pageType of Object.keys(appsDataConfig.pages)) {

githubAppsData[pageType] = {}

}

// Because the information used on the apps page doesn't require any

// rendered content we can parse the dereferenced files directly

for (const [requestPath, operationsAtPath] of Object.entries(data.paths)) {

for (const [verb, operation] of Object.entries(operationsAtPath)) {

// We only want to process operations that have programmatic access data

if (!progAccessData[operation.operationId]) continue

const isInstallationAccessToken = progAccessData[operation.operationId].serverToServer

const isUserAccessToken = progAccessData[operation.operationId].userToServerRest

const isFineGrainedPat =

isUserAccessToken && !progAccessData[operation.operationId].disabledForPatV2

const { category, subcategory } = operation['x-github']

const appDataOperation = {

slug: slug(operation.summary),

subcategory,

verb,

requestPath,

}

const appDataOperationWithCategory = Object.assign({ category }, appDataOperation)

// server-to-server

if (isInstallationAccessToken) {

addAppData(githubAppsData['server-to-server-rest'], category, appDataOperation)

}

// user-to-server

if (isUserAccessToken) {

addAppData(githubAppsData['user-to-server-rest'], category, appDataOperation)

}

// fine-grained pat

if (isFineGrainedPat) {

addAppData(githubAppsData['fine-grained-pat'], category, appDataOperation)

}

// permissions

for (const permissionSet of progAccessData[operation.operationId].permissions) {

for (const [permissionName, readOrWrite] of Object.entries(permissionSet)) {

const { title, displayTitle } = getDisplayTitle(permissionName, progActorResources)

if (progActorResources[permissionName]['visibility'] === 'private') continue

const additionalPermissions =

progAccessData[operation.operationId].permissions.length > 1 ||

progAccessData[operation.operationId].permissions.some(

(permissionSet) => Object.keys(permissionSet).length > 1,

)

// github app permissions

const serverToServerPermissions = githubAppsData['server-to-server-permissions']

if (!serverToServerPermissions[permissionName]) {

serverToServerPermissions[permissionName] = {

title,

displayTitle,

permissions: [],

}

const worksWithData = {

'user-to-server': Boolean(isUserAccessToken),

'server-to-server': Boolean(isInstallationAccessToken),

'additional-permissions': additionalPermissions,

}

serverToServerPermissions[permissionName].permissions.push(

Object.assign(

{},

appDataOperationWithCategory,

{ access: readOrWrite },

worksWithData,

)

// fine-grained pats

if (isFineGrainedPat) {

const findGrainedPatPermissions = githubAppsData['fine-grained-pat-permissions']

if (!findGrainedPatPermissions[permissionName]) {

findGrainedPatPermissions[permissionName] = {

title,

displayTitle,

permissions: [],

}

findGrainedPatPermissions[permissionName].permissions.push(

Object.assign({}, appDataOperationWithCategory, {

'additional-permissions': additionalPermissions,

access: readOrWrite,

}),

)

}

const versionName = path.basename(schemaName, '.json')

const targetDirectory = path.join(ENABLED_APPS_DIR, versionName)

// When a new version is added, we need to create the directory for it

if (!existsSync(targetDirectory)) {

await mkdirp(targetDirectory)

}

for (const pageType of Object.keys(githubAppsData)) {

const data = githubAppsData[pageType]

await validateAppData(data, pageType)

const filename = `${pageType}.json`

if (Object.keys(data).length === 0) {

throw new Error(

`Generating GitHub Apps data failed for ${openApiSource}/${schemaName}. The generated data file was empty.`,

)

}

const sortedOperations = pageType.includes('permissions')

? sortObjectByTitle(data)

: sortObjectByKeys(data)

const targetPath = path.join(targetDirectory, filename)

await writeFile(targetPath, JSON.stringify(sortedOperations, null, 2))

console.log(`✅ Wrote ${targetPath}`)

}

export async function getProgAccessData(progAccessSource, isRest = false) {

const useRemoteGitHubFiles = progAccessSource === 'rest-api-description'

// check for required PAT

if (useRemoteGitHubFiles && !process.env.GITHUB_TOKEN) {

throw new Error(

'Error! You must have the GITHUB_TOKEN environment variable set to access the programmatic access and resource files via the GitHub REST API.',

)

}

let progAccessDataRaw

let progActorResources

const progAccessFilepath = 'config/access_control/programmatic_access.yaml'

const progActorDirectory =

'config/access_control/fine_grained_permissions/programmatic_actor_fine_grained_resources'

if (!useRemoteGitHubFiles) {

progAccessDataRaw = yaml.load(

await readFile(path.join(progAccessSource, progAccessFilepath), 'utf8'),

)

progActorResources = await getProgActorResourceContent({

gitHubSourceDirectory: path.join(progAccessSource, progActorDirectory),

})

} else {

progAccessDataRaw = yaml.load(

await getContents('github', 'github', 'master', progAccessFilepath),

)

progActorResources = await getProgActorResourceContent({

owner: 'github',

repo: 'github',

branch: 'master',

path: progActorDirectory,

})

}

const progAccessData = {}

for (const operation of progAccessDataRaw) {

progAccessData[operation.operation_ids] = {

userToServerRest: operation.user_to_server.enabled,

serverToServer: operation.server_to_server.enabled,

fineGrainedPat: operation.user_to_server.enabled && !operation.disabled_for_patv2,

permissions: isRest

? getDisplayPermissions(operation.permission_sets || [], progActorResources)

: operation.permission_sets || [],

allowPermissionlessAccess: operation.allows_permissionless_access,

allowsPublicRead: operation.allows_public_read,

basicAuth: operation.basic_auth,

}

return { progAccessData, progActorResources }

}

function getDisplayPermissions(permissionSets, progActorResources) {

const displayPermissions = permissionSets.map((permissionSet) => {

const displayPermissionSet = {}

Object.entries(permissionSet).forEach(([key, value]) => {

const { displayTitle } = getDisplayTitle(key, progActorResources, true)

displayPermissionSet[displayTitle] = value

})

return displayPermissionSet

})

return displayPermissions

}

function sortObjectByKeys(obj) {

return Object.keys(obj)

.sort()

.reduce((acc, key) => {

acc[key] = obj[key]

return acc

}, {})

}

function sortObjectByTitle(obj) {

return Object.keys(obj)

.sort((a, b) => {

if (obj[a].displayTitle > obj[b].displayTitle) {

return 1

}

if (obj[a].displayTitle < obj[b].displayTitle) {

return -1

}

return 0

})

.reduce((acc, key) => {

acc[key] = obj[key]

return acc

}, {})

}

function getDisplayTitle(permissionName, progActorResources, isRest = false) {

const tempTitle = permissionName.replace(/_/g, ' ')

const permissionNameExists = progActorResources[permissionName]

if (!permissionNameExists) {

console.warn(

`The permission ${permissionName} is missing from the definitions in the config/access_control/fine_grained_permissions/programmatic_actor_fine_grained_resources directory. Creating a placeholder value of ${tempTitle} until it's added.`,

)

}

const title = progActorResources[permissionName]?.title || tempTitle

const resourceGroup = progActorResources[permissionName]?.resource_group || ''

if (!title) {

console.warn(`No title found for title ${title} resource group ${resourceGroup}`)

return ''

}

const displayTitle = isRest

? !resourceGroup

? sentenceCase(title) + ' permissions'

: `"${sentenceCase(title)}" ` + resourceGroup + ' permissions'

: !resourceGroup

? sentenceCase(title) + ' permissions'

: sentenceCase(resourceGroup) + ' permissions for ' + `"${title}"`

return { title, displayTitle }

}

function sentenceCase(str) {

return str.charAt(0).toUpperCase() + str.slice(1)

}

function addAppData(storage, category, data) {

if (!storage[category]) {

storage[category] = []

}

storage[category].push(data)

}

async function validateAppData(data, pageType) {

if (pageType.includes('permissions')) {

for (const value of Object.values(data)) {

const { isValid, errors } = validateJson(permissionSchema, value)

if (!isValid) {

console.error(JSON.stringify(errors, null, 2))

throw new Error('GitHub Apps permission schema validation failed')

}

} else {

for (const arrayItems of Object.values(data)) {

for (const item of arrayItems) {

const { isValid, errors } = validateJson(enabledSchema, item)

if (!isValid) {

console.error(JSON.stringify(errors, null, 2))

throw new Error('GitHub Apps enabled apps schema validation failed')

}

// When getting files from the GitHub repo locally (or in a Codespace)

// you can pass the full or relative path to the `github` repository

// directory on disk.

// When the source directory is `rest-api-description` (which is more common)

// you can pass the `owner`, `repo`, `branch`, and `path` (repository path)

async function getProgActorResourceContent({

owner,

repo,

branch,

path,

gitHubSourceDirectory = null,

}) {

// Get files either locally from disk or from the GitHub remote repo

let files

if (gitHubSourceDirectory) {

files = await getProgActorContentFromDisk(gitHubSourceDirectory)

} else {

files = await getDirectoryContents(owner, repo, branch, path)

}

// We need to format the file content into a single object. Each file

// contains a single key and a single value that needs to be added

// to the object.

const progActorResources = {}

for (const file of files) {

const fileContent = yaml.load(file)

// Each file should only contain a single key and value.

if (Object.keys(fileContent).length !== 1) {

throw new Error(`Error: The file ${JSON.stringify(fileContent)} must only have one key.`)

}

Object.entries(fileContent).forEach(([key, value]) => {

progActorResources[key] = value

})

}

return progActorResources

}

async function getProgActorContentFromDisk(directory) {

const files = walk(directory, {

includeBasePath: true,

directories: false,

})

const promises = files.map(async (file) => await readFile(file, 'utf8'))

return await Promise.all(promises)

}

github-docs/src/github-apps/scripts/sync.js at main · Fryguy/github-docs · GitHub

Expand file tree

Breadcrumbs

sync.js

Latest commit

History

Breadcrumbs

sync.js

File metadata and controls