Merge pull request #27 from secure-dashboards/feat/add-gh-response-va…

…lidation
OpenPathfinder · Dec 5, 2024 · eea9838 · eea9838
2 parents d23033b + 6acb57c
commit eea9838
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/src/schemas/githubOrganization.json b/src/schemas/githubOrganization.json
@@ -82,13 +82,19 @@
         ]
       },
       "name": {
-        "type": "string",
+        "type": [
+          "string", 
+          "null"
+        ],
         "examples": [
           "github"
         ]
       },
       "company": {
-        "type": "string",
+        "type": [
+          "string",
+          "null"
+        ],
         "examples": [
           "GitHub"
         ]
@@ -101,13 +107,19 @@
         ]
       },
       "location": {
-        "type": "string",
+        "type": [
+          "string",
+          "null"
+        ],
         "examples": [
           "San Francisco"
         ]
       },
       "email": {
-        "type": "string",
+        "type": [
+          "string",
+          "null"
+        ],
         "format": "email",
         "examples": [
           "[email protected]"

diff --git a/src/schemas/index.js b/src/schemas/index.js
@@ -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
 }

diff --git a/src/workflows/index.js b/src/workflows/index.js
@@ -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, {
@@ -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')