Skip to content

Add JSON schema validation to the GH API responses #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
UlisesGascon merged 3 commits into from
Dec 5, 2024
Merged

Add JSON schema validation to the GH API responses #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42decf6
feat: add json schema validation to the GH API responses
UlisesGascon Dec 5, 2024
f3897c9
feat: Improve schema errors for human readability
UlisesGascon Dec 5, 2024
6acb57c
feat: align the GitHub schema to the current API responses
UlisesGascon Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions src/schemas/githubOrganization.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,19 @@
]
},
"name": {
"type": "string",
"type": [
"string",
"null"
],
"examples": [
"github"
]
},
"company": {
"type": "string",
"type": [
"string",
"null"
],
"examples": [
"GitHub"
]
Expand All @@ -101,13 +107,19 @@
]
},
"location": {
"type": "string",
"type": [
"string",
"null"
],
"examples": [
"San Francisco"
]
},
"email": {
"type": "string",
"type": [
"string",
"null"
],
"format": "email",
"examples": [
"octocat@github.com"
Expand Down
3 changes: 2 additions & 1 deletion src/schemas/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ const validateGithubOrg = (data) => {
const validate = ajv.compile(githubOrganizationSchema)
const valid = validate(data)
if (!valid) {
throw new Error(validate.errors.map((error) => error.message).join('\n'))
const readableErrors = validate.errors.map((error) => `[ERROR: ${error.keyword}]${error.schemaPath}: ${error.message}`).join('\n')
throw new Error(`Error when validating the Github org response from API: ${readableErrors}`)
}
return null
}
Expand Down
3 changes: 3 additions & 0 deletions src/workflows/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const { simplifyObject } = require('@ulisesgascon/simplify-object')
const { github } = require('../providers')
const { initializeStore } = require('../store')
const { logger } = require('../utils')
const { validateGithubOrg } = require('../schemas')

const mapOrgData = (data) => {
const mappedData = simplifyObject(data, {
Expand Down Expand Up @@ -47,6 +48,8 @@ const updateGithubOrgs = async (knex) => {
await Promise.all(organizations.map(async (org) => {
debug(`Fetching details for org (${org.login})`)
const data = await github.fetchOrgByLogin(org.login)
debug('Validating data')
validateGithubOrg(data)
debug('Transforming data')
const mappedData = mapOrgData(data)
debug('Updating organization in database')
Expand Down