fix: http-server: add '/list' endpoint, that displays a HTML page with a list of the packages

nytamin · nytamin · commit 1acfb0c21d0b · 2024-07-02T12:51:43.000+02:00
diff --git a/apps/http-server/packages/generic/src/server.ts b/apps/http-server/packages/generic/src/server.ts
@@ -8,7 +8,7 @@ import cors from '@koa/cors'
 import bodyParser from 'koa-bodyparser'
 
 import { HTTPServerConfig, LoggerInstance, stringifyError, first } from '@sofie-package-manager/api'
-import { BadResponse, Storage, isBadResponse } from './storage/storage'
+import { BadResponse, PackageInfo, Storage, isBadResponse } from './storage/storage'
 import { FileStorage } from './storage/fileStorage'
 import { CTX, PACKAGE_JSON_VERSION, valueOrFirst } from './lib'
 import { parseFormData } from 'pechkin'
@@ -90,6 +90,9 @@ export class PackageProxyServer {
 		this.router.get('/packages', async (ctx) => {
 			await this.handleStorage(ctx, async () => this.storage.listPackages(ctx))
 		})
+		this.router.get('/list', async (ctx) => {
+			await this.handleStorageHTMLList(ctx, async () => this.storage.listPackages(ctx))
+		})
 		this.router.get('/package/:path+', async (ctx) => {
 			await this.handleStorage(ctx, async () => this.storage.getPackage(ctx.params.path, ctx))
 		})
@@ -175,4 +178,50 @@ export class PackageProxyServer {
 			ctx.body = 'Internal server error'
 		}
 	}
+	private async handleStorageHTMLList(
+		ctx: CTX,
+		storageFcn: () => Promise<{ packages: PackageInfo[] } | BadResponse>
+	) {
+		try {
+			const result = await storageFcn()
+			if (isBadResponse(result)) {
+				ctx.response.status = result.code
+				ctx.body = result.reason
+			} else {
+				const packages = result.packages
+
+				ctx.set('Content-Type', 'text/html')
+				ctx.body = `<!DOCTYPE html>
+<html>
+<head>
+<style>
+  body { font-family: Arial, sans-serif; }
+  table { border-collapse: collapse; width: 100%; }
+  th, td { border: 1px solid #ddd; padding: 8px; }
+
+</style>
+</head>
+<body>
+<h1>Packages</h1>
+<table>
+${packages
+	.map(
+		(pkg) =>
+			`<tr>
+		<td><a href="/package/${pkg.path}">${pkg.path}</a></td>
+		<td>${pkg.size}</td>
+		<td>${pkg.modified}</td>
+	</tr>`
+	)
+	.join('')}
+</table>
+</body>
+</html>`
+			}
+		} catch (err) {
+			this.logger.error(`Error in handleStorage: ${stringifyError(err)} `)
+			ctx.response.status = 500
+			ctx.body = 'Internal server error'
+		}
+	}
 }
diff --git a/apps/http-server/packages/generic/src/storage/fileStorage.ts b/apps/http-server/packages/generic/src/storage/fileStorage.ts
@@ -46,12 +46,7 @@ export class FileStorage extends Storage {
 		await fsMkDir(this._basePath, { recursive: true })
 	}
 
-	async listPackages(ctx: CTX): Promise<true | BadResponse> {
-		type PackageInfo = {
-			path: string
-			size: string
-			modified: string
-		}
+	async listPackages(ctx: CTX): Promise<{ packages: PackageInfo[] } | BadResponse> {
 		const packages: PackageInfo[] = []
 
 		const getAllFiles = async (basePath: string, dirPath: string) => {
@@ -84,9 +79,8 @@ export class FileStorage extends Storage {
 			return 0
 		})
 
-		ctx.body = { packages: packages }
-
-		return true
+		ctx.body = { packages }
+		return { packages }
 	}
 	private async getFileInfo(paramPath: string): Promise<
 		| {
diff --git a/apps/http-server/packages/generic/src/storage/storage.ts b/apps/http-server/packages/generic/src/storage/storage.ts
@@ -4,7 +4,7 @@ import { CTX, CTXPost } from '../lib'
 export abstract class Storage {
 	abstract init(): Promise<void>
 	abstract getInfo(): string
-	abstract listPackages(ctx: CTX): Promise<true | BadResponse>
+	abstract listPackages(ctx: CTX): Promise<{ packages: PackageInfo[] } | BadResponse>
 	abstract headPackage(path: string, ctx: CTX): Promise<true | BadResponse>
 	abstract getPackage(path: string, ctx: CTX): Promise<true | BadResponse>
 	abstract postPackage(
