Merge pull request #243 from OpenPathfinder/ulises/v1-add-gh-org

Author: UlisesGascon

__tests__/httpServer/apiV1.test.js

@@ -34,6 +34,8 @@ let serverStop
 let app
 let knex
 let getAllProjects
+let addProject
+let getAllGithubOrganizationsByProjectsId
 
 beforeAll(async () => {
   // Initialize server asynchronously
@@ -43,7 +45,9 @@ beforeAll(async () => {
   app = request(server)
   knex = knexInit(dbSettings);
   ({
-    getAllProjects
+    getAllProjects,
+    addProject,
+    getAllGithubOrganizationsByProjectsId
   } = initializeStore(knex))
 })
 
@@ -222,4 +226,165 @@ describe('HTTP Server API V1', () => {
 
     test.todo('should return 500 when workflow execution times out')
   })
+
+  describe('POST /api/v1/project/:projectId/gh-org', () => {
+    let projectId
+
+    beforeEach(async () => {
+      // Create a test project for each test
+      const project = await addProject({ name: 'test-project' })
+      projectId = project.id
+    })
+
+    test('should return 201 and add a new GitHub organization', async () => {
+      const githubOrgUrl = 'https://github.com/expressjs'
+
+      const response = await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl })
+
+      expect(response.status).toBe(201)
+      expect(response.body).toHaveProperty('id')
+      expect(response.body).toHaveProperty('login', 'expressjs')
+      expect(response.body).toHaveProperty('html_url', githubOrgUrl.toLowerCase())
+      expect(response.body).toHaveProperty('project_id', projectId)
+
+      // Verify the Location header is set correctly
+      expect(response.headers).toHaveProperty('location', `/api/v1/project/${projectId}/gh-org/${response.body.id}`)
+
+      // Verify organization was added to the database
+      const orgs = await getAllGithubOrganizationsByProjectsId([projectId])
+      expect(orgs.length).toBe(1)
+      expect(orgs[0].html_url).toBe(githubOrgUrl.toLowerCase())
+    })
+
+    test('should correctly extract organization login from URL with trailing slash', async () => {
+      const githubOrgUrl = 'https://github.com/expressjs/'
+
+      const response = await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl })
+
+      expect(response.status).toBe(201)
+      expect(response.body).toHaveProperty('login', 'expressjs')
+      expect(response.body).toHaveProperty('html_url', githubOrgUrl.toLowerCase().replace(/\/$/, ''))
+    })
+
+    test('should correctly extract organization login from URL with query parameters', async () => {
+      const githubOrgUrl = 'https://github.com/expressjs?tab=repositories'
+
+      const response = await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl })
+
+      expect(response.status).toBe(201)
+      expect(response.body).toHaveProperty('login', 'expressjs')
+      // The stored URL should be normalized without query parameters
+      expect(response.body.html_url).not.toContain('?')
+    })
+
+    test('should return 400 for invalid project ID', async () => {
+      const response = await app
+        .post('/api/v1/project/invalid/gh-org')
+        .send({ githubOrgUrl: 'https://github.com/expressjs' })
+
+      expect(response.status).toBe(400)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'must be integer')
+    })
+
+    test('should return 400 for zero project ID', async () => {
+      const response = await app
+        .post('/api/v1/project/0/gh-org')
+        .send({ githubOrgUrl: 'https://github.com/expressjs' })
+
+      expect(response.status).toBe(400)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'Invalid project ID. Must be a positive integer.')
+    })
+
+    test('should return 400 for negative project ID', async () => {
+      const response = await app
+        .post('/api/v1/project/-1/gh-org')
+        .send({ githubOrgUrl: 'https://github.com/expressjs' })
+
+      expect(response.status).toBe(400)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'Invalid project ID. Must be a positive integer.')
+    })
+
+    test('should return 400 for invalid GitHub organization URL', async () => {
+      const response = await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl: 'https://invalid-url.com/org' })
+
+      expect(response.status).toBe(400)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'must match pattern "^https://github.com/[^/]+"')
+    })
+
+    test('should return 404 for project not found', async () => {
+      const nonExistentProjectId = 9999999
+
+      const response = await app
+        .post(`/api/v1/project/${nonExistentProjectId}/gh-org`)
+        .send({ githubOrgUrl: 'https://github.com/expressjs' })
+
+      expect(response.status).toBe(404)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'Project not found')
+    })
+
+    test('should return 409 for duplicate GitHub organization', async () => {
+      const githubOrgUrl = 'https://github.com/expressjs'
+
+      // First add the organization
+      await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl })
+
+      // Try to add it again
+      const response = await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl })
+
+      expect(response.status).toBe(409)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'GitHub organization already exists for this project')
+    })
+
+    test('should return 409 for duplicate GitHub organization with different case', async () => {
+      // First add the organization with lowercase
+      await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl: 'https://github.com/expressjs' })
+
+      // Try to add it again with uppercase
+      const response = await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl: 'https://github.com/ExpressJS' })
+
+      expect(response.status).toBe(409)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'GitHub organization already exists for this project')
+    })
+
+    test('should return 409 for duplicate GitHub organization with trailing slash', async () => {
+      // First add the organization without trailing slash
+      await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl: 'https://github.com/expressjs' })
+
+      // Try to add it again with trailing slash
+      const response = await app
+        .post(`/api/v1/project/${projectId}/gh-org`)
+        .send({ githubOrgUrl: 'https://github.com/expressjs/' })
+
+      expect(response.status).toBe(409)
+      expect(response.body).toHaveProperty('errors')
+      expect(response.body.errors[0]).toHaveProperty('message', 'GitHub organization already exists for this project')
+    })
+
+    test.todo('should return 500 for internal server error')
+  })
 })

src/httpServer/routers/apiV1.js

@@ -1,5 +1,5 @@
 const pkg = require('../../../package.json')
-const { logger } = require('../../utils')
+const { logger, validateGithubUrl } = require('../../utils')
 const { initializeStore } = require('../../store')
 const _ = require('lodash')
 const { isSlug } = require('validator')
@@ -27,14 +27,72 @@ const runWorkflow = ({ workflowName, knex, data } = {}) => new Promise((resolve,
 })
 
 function createApiRouter (knex, express) {
-  const { addProject, getProjectByName } = initializeStore(knex)
+  const { addProject, getProjectByName, addGithubOrganization, getProjectById, getAllGithubOrganizationsByProjectsId } = initializeStore(knex)
 
   const router = express.Router()
 
   router.get('/__health', (req, res) => {
     res.json({ status: 'ok', timestamp: new Date().toISOString(), version: pkg.version, name: pkg.name })
   })
 
+  router.post('/project/:projectId/gh-org', async (req, res) => {
+    // Parse projectId with explicit radix 10 to avoid issues with leading zeros
+    const projectId = parseInt(req.params.projectId, 10)
+    const { githubOrgUrl } = req.body
+
+    // Stricter validation: check for NaN, non-integers, and non-positive values
+    if (isNaN(projectId) || !Number.isInteger(projectId) || projectId <= 0) {
+      return res.status(400).json({ errors: [{ message: 'Invalid project ID. Must be a positive integer.' }] })
+    }
+    if (!githubOrgUrl || !validateGithubUrl(githubOrgUrl)) {
+      return res.status(400).json({ errors: [{ message: 'Invalid GitHub organization name' }] })
+    }
+
+    const project = await getProjectById(projectId)
+    if (!project) {
+      return res.status(404).json({ errors: [{ message: 'Project not found' }] })
+    }
+
+    // Normalize the input URL by parsing it with URL object
+    // This allows us to handle different protocols, query parameters, and trailing slashes
+    const urlObj = new URL(githubOrgUrl)
+    // Create a normalized URL: lowercase, no trailing slash, no query parameters
+    const normalizedGithubOrgUrl = `${urlObj.protocol}//${urlObj.host}${urlObj.pathname.replace(/\/$/, '')}`.toLowerCase()
+
+    const existingGhOrg = await getAllGithubOrganizationsByProjectsId([projectId])
+    if (existingGhOrg.some(org => {
+      try {
+        // Apply the same normalization to stored URLs for consistent comparison
+        const storedUrl = new URL(org.html_url)
+        const normalizedStoredUrl = `${storedUrl.protocol}//${storedUrl.host}${storedUrl.pathname.replace(/\/$/, '')}`.toLowerCase()
+        return normalizedStoredUrl === normalizedGithubOrgUrl
+      } catch (e) {
+        // Fallback to simple comparison if URL parsing fails
+        return org.html_url.toLowerCase().replace(/\/$/, '') === normalizedGithubOrgUrl
+      }
+    })) {
+      return res.status(409).json({ errors: [{ message: 'GitHub organization already exists for this project' }] })
+    }
+
+    try {
+      // Get the pathname from the already created URL object, remove leading/trailing slashes, and take the first segment
+      const login = urlObj.pathname.replace(/^\/|\/$/, '').split('/')[0]
+
+      const org = await addGithubOrganization({
+        html_url: normalizedGithubOrgUrl,
+        login,
+        project_id: project.id
+      })
+
+      return res.status(201)
+        .header('Location', `/api/v1/project/${projectId}/gh-org/${org.id}`)
+        .json(org)
+    } catch (err) {
+      logger.error(err)
+      return res.status(500).json({ errors: [{ message: 'Internal server error' }] })
+    }
+  })
+
   router.post('/project', async (req, res) => {
     try {
       // Validate request body