feat: add new 4 endpoints (CM-1236) (#4218)

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

Author: ulemons

backend/src/api/public/v1/index.ts

@@ -15,6 +15,7 @@ import { staticApiKeyMiddleware } from '../middlewares/staticApiKeyMiddleware'
 import { memberOrganizationAffiliationsRouter } from './affiliations'
 import { membersRouter } from './members'
 import { organizationsRouter } from './organizations'
+import { osspreyRouter } from './ossprey'
 import { packagesRouter } from './packages'
 import { batchGetStewardship } from './packages/batchGetStewardship'
 import { stewardshipsRouter } from './stewardships'
@@ -38,6 +39,7 @@ export function v1Router(): Router {
   )
   router.use('/packages', oauth2Middleware(AUTH0_CONFIG), packagesRouter())
   router.use('/stewardships', oauth2Middleware(AUTH0_CONFIG), stewardshipsRouter())
+  router.use('/ossprey', oauth2Middleware(AUTH0_CONFIG), osspreyRouter())
 
   router.use(() => {
     throw new NotFoundError()

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

@@ -0,0 +1,41 @@
+import type { Request, Response } from 'express'
+import { z } from 'zod'
+
+import { listStewardshipActivity } from '@crowd/data-access-layer'
+
+import { getPackagesQx } from '@/db/packagesDb'
+import { ok } from '@/utils/api'
+import { validateOrThrow } from '@/utils/validation'
+
+const querySchema = z.object({
+  page: z.coerce.number().int().min(1).default(1),
+  pageSize: z.coerce.number().int().min(1).max(100).default(25),
+})
+
+export async function activityFeedHandler(req: Request, res: Response): Promise<void> {
+  const { page, pageSize } = validateOrThrow(querySchema, req.query)
+
+  const qx = await getPackagesQx()
+  const { rows, total } = await listStewardshipActivity(qx, { page, pageSize })
+
+  ok(res, {
+    rows: rows.map((r) => ({
+      id: r.id,
+      stewardshipId: r.stewardshipId,
+      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
+      actorType: r.actorType,
+      activityType: r.activityType,
+      content: r.content,
+      metadata: r.metadata,
+      stewardshipStatus: r.stewardshipStatus,
+      createdAt: r.createdAt,
+    })),
+    total,
+    page,
+    pageSize,
+  })
+}

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

@@ -0,0 +1,20 @@
+import { Router } from 'express'
+
+import { safeWrap } from '@/middlewares/errorMiddleware'
+
+import { activityFeedHandler } from './activityFeed'
+import { metricsHandler } from './metrics'
+import { packageListHandler } from './packageList'
+import { packageScatterHandler } from './packageScatter'
+
+export function osspreyRouter(): Router {
+  const router = Router()
+
+  router.get('/metrics', safeWrap(metricsHandler))
+  // /packages/scatter must be registered before /packages to avoid Express treating 'scatter' as a path param
+  router.get('/packages/scatter', safeWrap(packageScatterHandler))
+  router.get('/packages', safeWrap(packageListHandler))
+  router.get('/activity', safeWrap(activityFeedHandler))
+
+  return router
+}

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

@@ -0,0 +1,12 @@
+import type { Request, Response } from 'express'
+
+import { getOsspreyMetrics } from '@crowd/data-access-layer'
+
+import { getPackagesQx } from '@/db/packagesDb'
+import { ok } from '@/utils/api'
+
+export async function metricsHandler(req: Request, res: Response): Promise<void> {
+  const qx = await getPackagesQx()
+  const metrics = await getOsspreyMetrics(qx)
+  ok(res, metrics)
+}