Merge pull request #1835 from CVEProject/af-1715

david-rocca · web-flow · commit d371eb3872c1 · 2026-06-16T14:38:33.000-04:00
Resolves Issue #1715, Add expanded user map to registry org response
diff --git a/api-docs/openapi.json b/api-docs/openapi.json
@@ -2318,6 +2318,18 @@
             },
             "description": "The shortname or UUID of the registry organization"
           },
+          {
+            "name": "expand",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "users"
+              ]
+            },
+            "description": "Optional expanded related data. Accepted value: users."
+          },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
           },
@@ -7751,4 +7763,4 @@
       }
     }
   }
-}
+}
diff --git a/schemas/registry-org/get-registry-org-response.json b/schemas/registry-org/get-registry-org-response.json
@@ -220,6 +220,49 @@
         }
       },
       "description": "List of conversation messages associated with the organization"
+    },
+    "_userMap": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "username": {
+            "type": "string",
+            "description": "User's identifier or username"
+          },
+          "name": {
+            "type": "object",
+            "properties": {
+              "first": {
+                "type": "string",
+                "description": "User's first name"
+              },
+              "last": {
+                "type": "string",
+                "description": "User's last name"
+              },
+              "middle": {
+                "type": "string",
+                "description": "User's middle name"
+              },
+              "suffix": {
+                "type": "string",
+                "description": "User's name suffix"
+              }
+            }
+          },
+          "org": {
+            "type": "object",
+            "properties": {
+              "short_name": {
+                "type": "string",
+                "description": "Short name of the organization associated with the user"
+              }
+            }
+          }
+        }
+      },
+      "description": "Map of expanded user UUIDs to display metadata, included when expand=users is requested"
     }
   }
 }
diff --git a/src/controller/org.controller/index.js b/src/controller/org.controller/index.js
@@ -280,6 +280,15 @@ router.get('/registry/org/:identifier',
         <p><b>Regular, CNA & Admin Users:</b> Retrieves registry organization record for the specified shortname or UUID if it is the user's organization</p>
         <p><b>Secretariat:</b> Retrieves information about any registry organization</p>"
   #swagger.parameters['identifier'] = { description: 'The shortname or UUID of the registry organization' }
+  #swagger.parameters['expand'] = {
+    in: 'query',
+    description: 'Optional expanded related data. Accepted value: users.',
+    required: false,
+    schema: {
+      type: 'string',
+      enum: ['users']
+    }
+  }
   #swagger.parameters['$ref'] = [
     '#/components/parameters/apiEntityHeader',
     '#/components/parameters/apiUserHeader',
@@ -338,7 +347,9 @@ router.get('/registry/org/:identifier',
   */
   mw.useRegistry(),
   mw.validateUser,
-  query().custom((query) => { return mw.validateQueryParameterNames(query, ['']) }),
+  query().custom((query) => { return mw.validateQueryParameterNames(query, ['expand']) }),
+  query(['expand']).custom((val) => { return mw.containsNoInvalidCharacters(val) }),
+  query(['expand']).optional().isIn(['users']),
   parseError,
   parseGetParams,
   registryOrgController.SINGLE_ORG
diff --git a/src/controller/org.controller/org.middleware.js b/src/controller/org.controller/org.middleware.js
@@ -376,7 +376,7 @@ function parsePostParams (req, res, next) {
 
 function parseGetParams (req, res, next) {
   utils.reqCtxMapping(req, 'params', ['shortname', 'username', 'identifier'])
-  utils.reqCtxMapping(req, 'query', ['page'])
+  utils.reqCtxMapping(req, 'query', ['page', 'expand'])
   next()
 }
 
diff --git a/src/controller/registry-org.controller/registry-org.controller.js b/src/controller/registry-org.controller/registry-org.controller.js
@@ -9,6 +9,89 @@ const convoError = new conversationErrors.ConversationControllerError()
 const validateUUID = require('uuid').validate
 const authContext = require('../../utils/authContext')
 
+function addUUIDsToSet (uuidSet, values) {
+  if (!Array.isArray(values)) return
+  values.filter(Boolean).forEach(uuid => uuidSet.add(uuid))
+}
+
+function addConversationAuthorUUIDsToSet (uuidSet, conversations) {
+  if (!Array.isArray(conversations)) return
+  conversations.forEach(conversation => {
+    if (conversation.author_id) {
+      uuidSet.add(conversation.author_id)
+    }
+  })
+}
+
+function asPlainObject (value) {
+  return typeof value?.toObject === 'function' ? value.toObject() : value
+}
+
+function buildOrgShortNameByUserUUID (orgs, requestedUserUUIDs) {
+  const orgShortNameByUserUUID = {}
+  orgs.forEach(org => {
+    const orgObject = asPlainObject(org)
+    if (!Array.isArray(orgObject.users)) return
+
+    orgObject.users.forEach(userUUID => {
+      if (requestedUserUUIDs.has(userUUID)) {
+        orgShortNameByUserUUID[userUUID] = orgObject.short_name
+      }
+    })
+  })
+  return orgShortNameByUserUUID
+}
+
+async function buildUserMapForUUIDs (userUUIDs, userRepo, orgRepo) {
+  if (userUUIDs.size === 0) {
+    return {}
+  }
+
+  const userUUIDList = Array.from(userUUIDs)
+  const users = await userRepo.findUsersByUUIDs(userUUIDList)
+  const orgs = await orgRepo.findOrgsByUserUUIDs(userUUIDList)
+  const orgShortNameByUserUUID = buildOrgShortNameByUserUUID(orgs, userUUIDs)
+
+  return users.reduce((userMap, user) => {
+    const userObject = asPlainObject(user)
+    if (!userUUIDs.has(userObject.UUID)) return userMap
+    const orgShortName = orgShortNameByUserUUID[userObject.UUID]
+    userMap[userObject.UUID] = _.omitBy({
+      username: userObject.username,
+      name: userObject.name,
+      org: orgShortName ? { short_name: orgShortName } : undefined
+    }, _.isUndefined)
+    return userMap
+  }, {})
+}
+
+async function buildOrgUserMap (org, userRepo, orgRepo) {
+  const orgObject = asPlainObject(org)
+  const userUUIDs = new Set()
+  addUUIDsToSet(userUUIDs, orgObject.users)
+  addUUIDsToSet(userUUIDs, orgObject.admins)
+  addUUIDsToSet(userUUIDs, orgObject.contact_info?.additional_contacts)
+
+  return buildUserMapForUUIDs(userUUIDs, userRepo, orgRepo)
+}
+
+async function buildUserMap (org, userRepo, orgRepo) {
+  const orgObject = asPlainObject(org)
+  const userUUIDs = new Set()
+  addUUIDsToSet(userUUIDs, orgObject.users)
+  addUUIDsToSet(userUUIDs, orgObject.admins)
+  addUUIDsToSet(userUUIDs, orgObject.contact_info?.additional_contacts)
+  addConversationAuthorUUIDsToSet(userUUIDs, orgObject.conversation)
+
+  return buildUserMapForUUIDs(userUUIDs, userRepo, orgRepo)
+}
+
+function removeUserUUIDFields (org) {
+  delete org.users
+  delete org.admins
+  _.unset(org, 'contact_info.additional_contacts')
+}
+
 /**
  * Retrieves information about all registry organizations.
  *
@@ -101,7 +184,21 @@ async function getOrg (req, res, next) {
         if (isSecretariat) {
           returnValue.conversation = conversation?.length ? _.map(conversation, c => _.omit(c, ['__v', '_id', 'previous_conversation_uuid', 'next_conversation_uuid', 'target_uuid'])) : undefined
         } else {
-          returnValue.conversation = conversation?.length ? _.map(conversation, c => _.omit(c, ['__v', '_id', 'UUID', 'previous_conversation_uuid', 'next_conversation_uuid', 'target_uuid', 'visibility'])) : undefined
+          returnValue.conversation = conversation?.length ? _.map(conversation, c => _.omit(c, ['__v', '_id', 'UUID', 'previous_conversation_uuid', 'next_conversation_uuid', 'target_uuid', 'visibility', 'author_id'])) : undefined
+        }
+
+        if (req.ctx.query?.expand === 'users') {
+          const userRepo = req.ctx.repositories.getBaseUserRepository()
+          const isAdminOfRequestedOrg = !isSecretariat && await userRepo.isAdmin(req.ctx.user, returnValue.short_name, {})
+          if (isSecretariat) {
+            returnValue._userMap = await buildUserMap(returnValue, userRepo, repo)
+          } else if (isAdminOfRequestedOrg) {
+            returnValue._userMap = await buildOrgUserMap(requesterOrg, userRepo, repo)
+          }
+        }
+
+        if (!isSecretariat) {
+          removeUserUUIDFields(returnValue)
         }
       }
     } catch (error) {
diff --git a/src/repositories/baseOrgRepository.js b/src/repositories/baseOrgRepository.js
@@ -243,6 +243,18 @@ class BaseOrgRepository extends BaseRepository {
     return null
   }
 
+  async findOrgsByUserUUIDs (userUUIDs, options = {}) {
+    if (!Array.isArray(userUUIDs) || userUUIDs.length === 0) {
+      return []
+    }
+
+    return await BaseOrgModel.find(
+      { users: { $in: userUUIDs } },
+      { _id: 0, UUID: 1, short_name: 1, users: 1 },
+      options
+    )
+  }
+
   /**
    * @function hasRole
    * @description Checks if an organization object has the requested role.
diff --git a/src/repositories/baseUserRepository.js b/src/repositories/baseUserRepository.js
@@ -204,6 +204,18 @@ class BaseUserRepository extends BaseRepository {
     return user || null
   }
 
+  async findUsersByUUIDs (uuids, options = {}) {
+    if (!Array.isArray(uuids) || uuids.length === 0) {
+      return []
+    }
+
+    return await BaseUser.find(
+      { UUID: { $in: uuids } },
+      { _id: 0, UUID: 1, username: 1, name: 1 },
+      options
+    )
+  }
+
   /**
    * @async
    * @function isUserAdminOfOrgUUID
diff --git a/src/repositories/conversationRepository.js b/src/repositories/conversationRepository.js
@@ -2,6 +2,15 @@ const uuid = require('uuid')
 const ConversationModel = require('../model/conversation')
 const BaseRepository = require('./baseRepository')
 
+const SECRETARIAT_AUTHOR_NAME = 'Secretariat'
+
+function normalizeConversationAuthorName (conversation) {
+  if (conversation.author_role === 'Secretariat') {
+    conversation.author_name = SECRETARIAT_AUTHOR_NAME
+  }
+  return conversation
+}
+
 class ConversationRepository extends BaseRepository {
   constructor () {
     super(ConversationModel)
@@ -23,7 +32,11 @@ class ConversationRepository extends BaseRepository {
       }
     ]
     const pg = await this.aggregatePaginate(agt, options)
-    const data = { conversations: pg.itemsList }
+    const data = {
+      conversations: pg.itemsList.map(conversation => normalizeConversationAuthorName(
+        typeof conversation.toObject === 'function' ? conversation.toObject() : conversation
+      ))
+    }
     if (pg.itemCount >= options.limit) {
       data.totalCount = pg.itemCount
       data.itemsPerPage = pg.itemsPerPage
@@ -48,6 +61,7 @@ class ConversationRepository extends BaseRepository {
       }
     })
     return conversations.map(convo => convo.toObject()).filter(conv => isSecretariat || conv.visibility === 'public').map(conv => {
+      normalizeConversationAuthorName(conv)
       if (!isSecretariat && conv.author_role === 'Secretariat') {
         delete conv.author_id
         delete conv.author_name
@@ -89,7 +103,7 @@ class ConversationRepository extends BaseRepository {
       previous_conversation_uuid: latestConversation?.UUID || null,
       next_conversation_uuid: null,
       author_id: user.UUID,
-      author_name: getUserFullName(user),
+      author_name: isSecretariat ? SECRETARIAT_AUTHOR_NAME : getUserFullName(user),
       author_role: isSecretariat ? 'Secretariat' : 'Partner',
       edited_at: null,
       visibility: !isSecretariat ? 'public' : (['public', 'private'].includes(body.visibility?.toLowerCase()) ? body.visibility.toLowerCase() : 'private'),
diff --git a/test/integration-tests/conversation/conversationTest.js b/test/integration-tests/conversation/conversationTest.js
diff --git a/test/integration-tests/registry-org/registryOrgCRUDTest.js b/test/integration-tests/registry-org/registryOrgCRUDTest.js
diff --git a/test/unit-tests/conversation/conversationRepositoryTest.js b/test/unit-tests/conversation/conversationRepositoryTest.js
diff --git a/test/unit-tests/org/registryOrgGetSingleTest.js b/test/unit-tests/org/registryOrgGetSingleTest.js

Original file line number	Diff line number	Diff line change
`@@ -2318,6 +2318,18 @@`
`2318`	`2318`	`},`
`2319`	`2319`	`"description": "The shortname or UUID of the registry organization"`
`2320`	`2320`	`},`
	`2321`	`+ {`
	`2322`	`+ "name": "expand",`
	`2323`	`+ "in": "query",`
	`2324`	`+ "required": false,`
	`2325`	`+ "schema": {`
	`2326`	`+ "type": "string",`
	`2327`	`+ "enum": [`
	`2328`	`+ "users"`
	`2329`	`+ ]`
	`2330`	`+ },`
	`2331`	`+ "description": "Optional expanded related data. Accepted value: users."`
	`2332`	`+ },`
`2321`	`2333`	`{`
`2322`	`2334`	`"$ref": "#/components/parameters/apiEntityHeader"`
`2323`	`2335`	`},`
`@@ -7751,4 +7763,4 @@`
`7751`	`7763`	`}`
`7752`	`7764`	`}`
`7753`	`7765`	`}`
`7754`		`-}`
	`7766`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -376,7 +376,7 @@ function parsePostParams (req, res, next) {`
`376`	`376`
`377`	`377`	`function parseGetParams (req, res, next) {`
`378`	`378`	`utils.reqCtxMapping(req, 'params', ['shortname', 'username', 'identifier'])`
`379`		`- utils.reqCtxMapping(req, 'query', ['page'])`
	`379`	`+ utils.reqCtxMapping(req, 'query', ['page', 'expand'])`
`380`	`380`	`next()`
`381`	`381`	`}`
`382`	`382`