fix: adding steward details (#4254)

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

Author: ulemons

backend/src/api/public/v1/packages/listPackages.ts

@@ -68,7 +68,15 @@ export async function listPackages(req: Request, res: Response): Promise<void> {
 
   const qx = await getPackagesQx()
   const [{ rows, total }, statusCounts] = await Promise.all([
-    listPackagesForApi(qx, { page, pageSize, status, sortBy, sortDir, ...filterOpts }),
+    listPackagesForApi(qx, {
+      page,
+      pageSize,
+      status,
+      sortBy,
+      sortDir,
+      ...filterOpts,
+      includeStewards: true,
+    }),
     getPackageStatusCounts(qx, filterOpts),
   ])
 
@@ -83,7 +91,7 @@ export async function listPackages(req: Request, res: Response): Promise<void> {
     openVulns: r.openVulns,
     stewardshipId: r.stewardshipId ?? null,
     stewardship: (r.stewardshipStatus ?? 'unassigned') as StewardshipStatus,
-    stewards: null,
+    stewards: r.stewards ?? [],
   }))
 
   ok(res, {

backend/src/api/public/v1/packages/openapi.yaml

@@ -91,7 +91,13 @@ components:
           type: string
           description: Auth0 sub of the assigned steward.
           example: abc123
-        name:
+        username:
+          type:
+            - string
+            - 'null'
+          description: Username of the steward. Null if not available.
+          example: jrodriguez
+        displayName:
           type:
             - string
             - 'null'
@@ -206,12 +212,10 @@ components:
         stewardship:
           $ref: '#/components/schemas/StewardshipStatus'
         stewards:
-          description: Assigned stewards or null.
-          oneOf:
-            - type: array
-              items:
-                $ref: '#/components/schemas/Steward'
-            - type: 'null'
+          description: Assigned stewards. Empty array if none.
+          type: array
+          items:
+            $ref: '#/components/schemas/Steward'
 
     # ── Package detail ───────────────────────────────────────────────────────────
 

services/libs/data-access-layer/src/osspckgs/api.ts

@@ -1,5 +1,11 @@
 import { QueryExecutor } from '../queryExecutor'
 
+import {
+  SEVERITY_RANK_EXPR,
+  STEWARD_DISPLAY_NAME_METADATA,
+  STEWARD_MENTIONED_JOIN,
+} from './sqlFragments'
+
 export interface PackageMetrics {
   totalPackages: number
   criticalPackages: number
@@ -167,16 +173,9 @@ export interface ListPackagesOptions {
   sortDir: 'asc' | 'desc'
 }
 
-const STALE_MONTHS = 18
+export { SEVERITY_RANK_EXPR } from './sqlFragments'
 
-// Severity stored as uppercase in advisories table.
-// Ranks: CRITICAL=4, HIGH=3, MEDIUM=2, LOW=1
-export const SEVERITY_RANK_EXPR = `MAX(CASE a.severity
-    WHEN 'CRITICAL' THEN 4
-    WHEN 'HIGH'     THEN 3
-    WHEN 'MEDIUM'   THEN 2
-    WHEN 'LOW'      THEN 1
-    ELSE 0 END)::int`
+const STALE_MONTHS = 18
 
 export interface PackageStatusCounts {
   all: number
@@ -512,8 +511,10 @@ export async function listPackagesForApi(
     opts.includeLastActivity === true
       ? `
     LEFT JOIN LATERAL (
-      SELECT sa.activity_type, sa.content, sa.metadata, sa.created_at
+      SELECT sa.activity_type, sa.content, sa.created_at,
+        ${STEWARD_DISPLAY_NAME_METADATA} AS metadata
       FROM stewardship_activity sa
+      ${STEWARD_MENTIONED_JOIN}
       WHERE sa.stewardship_id = s.id
       ORDER BY sa.created_at DESC
       LIMIT 1
@@ -545,7 +546,7 @@ export async function listPackagesForApi(
       r_sc.scorecard_score AS "scorecardScore",
       p.latest_release_at AS "latestReleaseAt",
       ${opts.includeLastActivity === true ? `last_act.activity_type AS "lastActivityType", last_act.content AS "lastActivityContent", last_act.metadata AS "lastActivityMetadata", last_act.created_at AS "lastActivityAt",` : ''}
-      ${opts.includeStewards === true ? "COALESCE(ss_agg.stewards, '[]'::json) AS stewards," : ''}
+      ${opts.includeStewards === true ? 'ss_agg.stewards AS stewards,' : ''}
       COUNT(*) OVER() AS total
     FROM packages p
     ${laterals}

services/libs/data-access-layer/src/osspckgs/index.ts

@@ -3,5 +3,6 @@ export * from './packages'
 export * from './maintainers'
 export * from './versions'
 export * from './repos'
+export * from './sqlFragments'
 export * from './stewardships'
 export * from './api'

services/libs/data-access-layer/src/osspckgs/sqlFragments.ts

@@ -0,0 +1,19 @@
+// Severity stored as uppercase in advisories table.
+// Ranks: CRITICAL=4, HIGH=3, MEDIUM=2, LOW=1
+export const SEVERITY_RANK_EXPR = `MAX(CASE a.severity
+    WHEN 'CRITICAL' THEN 4
+    WHEN 'HIGH'     THEN 3
+    WHEN 'MEDIUM'   THEN 2
+    WHEN 'LOW'      THEN 1
+    ELSE 0 END)::int`
+
+export const STEWARD_MENTIONED_JOIN = `
+  LEFT JOIN stewards st_mentioned
+    ON sa.activity_type = 'steward_added'
+    AND st_mentioned.user_id = (sa.metadata->>'userId')`
+
+export const STEWARD_DISPLAY_NAME_METADATA = `CASE
+        WHEN sa.activity_type = 'steward_added' AND st_mentioned.display_name IS NOT NULL
+        THEN COALESCE(sa.metadata, '{}'::jsonb) || jsonb_build_object('stewardDisplayName', st_mentioned.display_name)
+        ELSE sa.metadata
+      END`

services/libs/data-access-layer/src/osspckgs/stewardships.ts

@@ -1,6 +1,10 @@
 import { QueryExecutor } from '../queryExecutor'
 
-import { SEVERITY_RANK_EXPR } from './api'
+import {
+  SEVERITY_RANK_EXPR,
+  STEWARD_DISPLAY_NAME_METADATA,
+  STEWARD_MENTIONED_JOIN,
+} from './sqlFragments'
 
 export interface StewardshipRecord {
   id: string
@@ -261,6 +265,7 @@ export async function assignSteward(
         metadata: JSON.stringify({
           userId: data.userId,
           role: data.role,
+          ...(data.displayName != null ? { stewardDisplayName: data.displayName } : {}),
           ...(data.note ? { note: data.note } : {}),
         }),
       },
@@ -350,6 +355,8 @@ export interface ActivityFeedRow {
   total: string
 }
 
+export { STEWARD_DISPLAY_NAME_METADATA, STEWARD_MENTIONED_JOIN } from './sqlFragments'
+
 export async function listStewardshipActivity(
   qx: QueryExecutor,
   opts: { page: number; pageSize: number },
@@ -366,13 +373,14 @@ export async function listStewardshipActivity(
       sa.actor_type                      AS "actorType",
       sa.activity_type                   AS "activityType",
       sa.content                         AS content,
-      sa.metadata                        AS metadata,
+      ${STEWARD_DISPLAY_NAME_METADATA}   AS metadata,
       s.status                           AS "stewardshipStatus",
       sa.created_at                      AS "createdAt",
       COUNT(*) OVER()::text              AS total
     FROM stewardship_activity sa
     JOIN stewardships s ON s.id = sa.stewardship_id
     JOIN packages p ON p.id = s.package_id
+    ${STEWARD_MENTIONED_JOIN}
     ORDER BY sa.created_at DESC, sa.id DESC
     LIMIT $(limit) OFFSET $(offset)
     `,
@@ -430,16 +438,17 @@ export async function listPackageHistory(
   stewardshipId: string,
 ): Promise<PackageHistoryEvent[]> {
   const rows: Array<Record<string, unknown>> = await qx.select(
-    `SELECT id::text             AS id,
-            actor_user_id        AS "actorUserId",
-            actor_type           AS "actorType",
-            activity_type        AS "activityType",
-            content,
-            metadata,
-            created_at           AS "createdAt"
-     FROM stewardship_activity
-     WHERE stewardship_id = $(stewardshipId)::bigint
-     ORDER BY created_at DESC`,
+    `SELECT sa.id::text             AS id,
+            sa.actor_user_id        AS "actorUserId",
+            sa.actor_type           AS "actorType",
+            sa.activity_type        AS "activityType",
+            sa.content,
+            ${STEWARD_DISPLAY_NAME_METADATA} AS metadata,
+            sa.created_at           AS "createdAt"
+     FROM stewardship_activity sa
+     ${STEWARD_MENTIONED_JOIN}
+     WHERE sa.stewardship_id = $(stewardshipId)::bigint
+     ORDER BY sa.created_at DESC`,
     { stewardshipId },
   )
   return rows.map((r) => ({
@@ -593,8 +602,10 @@ export async function listMyPackages(
 
   const displayLaterals = `
     LEFT JOIN LATERAL (
-      SELECT sa.content, sa.activity_type, sa.metadata, sa.created_at
+      SELECT sa.content, sa.activity_type, sa.created_at,
+        ${STEWARD_DISPLAY_NAME_METADATA} AS metadata
       FROM stewardship_activity sa
+      ${STEWARD_MENTIONED_JOIN}
       WHERE sa.stewardship_id = s.id
       ORDER BY sa.created_at DESC
       LIMIT 1
@@ -688,7 +699,11 @@ export async function listMyPackages(
       scorecardScore: row.scorecardScore != null ? Number(row.scorecardScore) : null,
       openVulns: Number(row.openVulns),
       maxVulnSeverity: row.maxVulnSeverity ?? null,
-      lastActivityContent: row.lastActivityContent ?? null,
+      lastActivityContent: translateActivityContent(
+        row.lastActivityContent ?? null,
+        row.lastActivityType,
+        row.lastActivityMetadata as Record<string, unknown> | null,
+      ),
       lastActivityType: row.lastActivityType ?? null,
       lastActivityMetadata: row.lastActivityMetadata ?? null,
       lastActivityAt: row.lastActivityAt ?? null,
@@ -753,12 +768,13 @@ export async function listMyActivity(
         sa.actor_type                      AS "actorType",
         sa.activity_type                   AS "activityType",
         sa.content                         AS content,
-        sa.metadata                        AS metadata,
+        ${STEWARD_DISPLAY_NAME_METADATA}   AS metadata,
         s.status                           AS "stewardshipStatus",
         sa.created_at                      AS "createdAt"
       FROM stewardship_activity sa
       JOIN stewardships s ON s.id = sa.stewardship_id
       JOIN packages p ON p.id = s.package_id
+      ${STEWARD_MENTIONED_JOIN}
       WHERE s.id IN (
         SELECT stewardship_id FROM stewardship_stewards
         WHERE user_id = $(userId) AND deleted_at IS NULL
@@ -845,6 +861,13 @@ export function translateActivityContent(
   metadata?: Record<string, unknown> | null,
 ): string | null {
   if (!content) return content
+  if (activityType === 'steward_added') {
+    const displayName = metadata?.stewardDisplayName as string | undefined
+    const role = metadata?.role as string | undefined
+    if (displayName && role) {
+      return `Assigned steward ${displayName} as ${role}`
+    }
+  }
   if (activityType === 'escalation' && metadata?.resolutionPath) {
     const label =
       ESCALATION_RESOLUTION_PATH_LABELS[metadata.resolutionPath as EscalationResolutionPath]