feat: add actor interface (#4255)

Signed-off-by: Umberto Sgueglia <usgueglia@contractor.linuxfoundation.org>

Author: ulemons

backend/src/api/public/v1/ossprey/activityFeed.ts

@@ -25,8 +25,7 @@ export async function activityFeedHandler(req: Request, res: Response): Promise<
       packagePurl: r.packagePurl,
       packageName: r.packageName,
       packageEcosystem: r.packageEcosystem,
-      actorUserId: r.actorUserId,
-      actorName: r.actorUserId, // TODO: resolve display name from crowd.dev users/members table by actorUserId
+      actor: r.actor,
       actorType: r.actorType,
       activityType: r.activityType,
       content: r.content,

backend/src/api/public/v1/stewardships/actorSchema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod'
+
+export const actorInputSchema = z.object({
+  username: z.string().trim().min(1).optional().nullable(),
+  displayName: z.string().trim().min(1).optional().nullable(),
+  avatarUrl: z.string().url().optional().nullable(),
+})

backend/src/api/public/v1/stewardships/assignSteward.ts

@@ -8,39 +8,44 @@ import { getPackagesQx } from '@/db/packagesDb'
 import { ok } from '@/utils/api'
 import { validateOrThrow } from '@/utils/validation'
 
+import { actorInputSchema } from './actorSchema'
+
 const paramsSchema = z.object({
   id: z.coerce.number().int().positive(),
 })
 
-const bodySchema = z
-  .object({
-    userId: z.string().trim().min(1),
-    username: z.string().trim().min(1).optional().nullable(),
-    displayName: z.string().trim().min(1).optional().nullable(),
-    role: z.enum(['lead', 'co_steward']),
-    note: z.string().trim().min(1).optional(),
-    moveToAssessing: z.boolean().optional().default(false),
-  })
-  .refine((d) => (d.username == null) === (d.displayName == null), {
-    message: 'username and displayName must both be provided or both be absent',
-    path: ['displayName'],
-  })
+const bodySchema = z.object({
+  steward: z
+    .object({
+      userId: z.string().trim().min(1),
+      username: z.string().trim().min(1).optional().nullable(),
+      displayName: z.string().trim().min(1).optional().nullable(),
+      role: z.enum(['lead', 'co_steward']),
+    })
+    .refine((d) => (d.username == null) === (d.displayName == null), {
+      message: 'username and displayName must both be provided or both be absent',
+      path: ['displayName'],
+    }),
+  note: z.string().trim().min(1).optional(),
+  moveToAssessing: z.boolean().optional().default(false),
+  actor: actorInputSchema,
+})
 
 export async function assignStewardHandler(req: Request, res: Response): Promise<void> {
   const { id } = validateOrThrow(paramsSchema, req.params)
-  const { userId, username, displayName, role, note, moveToAssessing } = validateOrThrow(
-    bodySchema,
-    req.body,
-  )
+  const { steward, note, moveToAssessing, actor } = validateOrThrow(bodySchema, req.body)
 
   const qx = await getPackagesQx()
   const result = await assignSteward(qx, id, {
-    userId,
-    username,
-    displayName,
-    role,
+    userId: steward.userId,
+    username: steward.username,
+    displayName: steward.displayName,
+    role: steward.role,
     note,
     assignedBy: req.actor.id,
+    actorUsername: actor.username ?? null,
+    actorDisplayName: actor.displayName ?? null,
+    actorAvatarUrl: actor.avatarUrl ?? null,
     moveToAssessing,
   })
 

backend/src/api/public/v1/stewardships/escalate.ts

@@ -8,24 +8,30 @@ import { getPackagesQx } from '@/db/packagesDb'
 import { ok } from '@/utils/api'
 import { validateOrThrow } from '@/utils/validation'
 
+import { actorInputSchema } from './actorSchema'
+
 const paramsSchema = z.object({
   id: z.coerce.number().int().positive(),
 })
 
 const bodySchema = z.object({
   resolutionPath: z.enum(ESCALATION_RESOLUTION_PATHS),
   notes: z.string().trim().min(1).optional(),
+  actor: actorInputSchema,
 })
 
 export async function escalateHandler(req: Request, res: Response): Promise<void> {
   const { id } = validateOrThrow(paramsSchema, req.params)
-  const { resolutionPath, notes } = validateOrThrow(bodySchema, req.body)
+  const { resolutionPath, notes, actor } = validateOrThrow(bodySchema, req.body)
 
   const qx = await getPackagesQx()
   const stewardship = await escalateStewardship(qx, id, {
     resolutionPath,
     notes,
     actorUserId: req.actor.id,
+    actorUsername: actor.username ?? null,
+    actorDisplayName: actor.displayName ?? null,
+    actorAvatarUrl: actor.avatarUrl ?? null,
   })
 
   if (!stewardship) {

backend/src/api/public/v1/stewardships/getMyActivity.ts

@@ -63,6 +63,7 @@ export async function getMyActivityHandler(req: Request, res: Response): Promise
       stewardshipStatus: r.stewardshipStatus,
       activityType: r.activityType,
       description: r.content,
+      actor: r.actor,
       createdAt: r.createdAt,
       suggestedAction: SUGGESTED_ACTIONS[r.stewardshipStatus] ?? null,
     })),

backend/src/api/public/v1/stewardships/getMyPackages.ts

@@ -1,11 +1,7 @@
 import type { Request, Response } from 'express'
 import { z } from 'zod'
 
-import {
-  computeHealthBand,
-  listMyPackages,
-  translateActivityContent,
-} from '@crowd/data-access-layer'
+import { computeHealthBand, listMyPackages } from '@crowd/data-access-layer'
 
 import { getPackagesQx } from '@/db/packagesDb'
 import { ok } from '@/utils/api'
@@ -42,11 +38,7 @@ export async function getMyPackagesHandler(req: Request, res: Response): Promise
       healthBand: computeHealthBand(r.scorecardScore),
       openVulns: r.openVulns,
       vulnSeverity: r.maxVulnSeverity,
-      lastActivityDescription: translateActivityContent(
-        r.lastActivityContent,
-        r.lastActivityType,
-        r.lastActivityMetadata,
-      ),
+      lastActivityDescription: r.lastActivityDescription,
       lastActivityAt: r.lastActivityAt ? r.lastActivityAt.toISOString() : null,
       stewardshipId: r.stewardshipId,
       stewardshipStatus: r.stewardshipStatus,

backend/src/api/public/v1/stewardships/openStewardship.ts

@@ -10,15 +10,25 @@ import { validateOrThrow } from '@/utils/validation'
 
 import { purlFieldSchema } from '../packages/purl'
 
+import { actorInputSchema } from './actorSchema'
+
 const bodySchema = z.object({
   purl: purlFieldSchema,
+  actor: actorInputSchema,
 })
 
 export async function openStewardship(req: Request, res: Response): Promise<void> {
-  const { purl } = validateOrThrow(bodySchema, req.body)
+  const { purl, actor } = validateOrThrow(bodySchema, req.body)
 
   const qx = await getPackagesQx()
-  const stewardship = await openStewardshipByPurl(qx, purl, req.actor.id)
+  const stewardship = await openStewardshipByPurl(
+    qx,
+    purl,
+    req.actor.id,
+    actor.username ?? null,
+    actor.displayName ?? null,
+    actor.avatarUrl ?? null,
+  )
 
   if (!stewardship) {
     throw new NotFoundError(`Package not found: ${purl}`)