feat: add some basic logging

src/artifacts/artifacts.controller.ts

@@ -4,6 +4,7 @@ import {
   Get,
   Head,
   HttpCode,
+  Logger,
   NotFoundException,
   Param,
   Post,
@@ -18,10 +19,13 @@ import { ArtifactQueryTeamPipe } from "./artifacts.pipe";
 
 @Controller({ path: "artifacts", version: "8" })
 export class ArtifactsController {
+  private readonly logger = new Logger(ArtifactsController.name);
+
   constructor(private readonly storageService: StorageService) {}
 
   @Get("status")
   getStatus(): StatusRO {
+    this.logger.log("GET /status");
     return { status: "enabled" };
   }
 
@@ -30,6 +34,7 @@ export class ArtifactsController {
     @Param("hash") hash: string,
     @Query(new ArtifactQueryTeamPipe()) team: string,
   ): Promise<void> {
+    this.logger.log(`HEAD /${hash} team: ${team}`);
     const exists = await this.storageService.exists(team, hash);
     if (!exists) throw new NotFoundException("Artifact not found");
   }
@@ -39,6 +44,7 @@ export class ArtifactsController {
     @Param("hash") hash: string,
     @Query(new ArtifactQueryTeamPipe()) team: string,
   ): Promise<GetArtifactRO> {
+    this.logger.log(`GET /${hash} team: ${team}`);
     const exists = await this.storageService.exists(team, hash);
     if (!exists) throw new NotFoundException("Artifact not found");
 
@@ -52,20 +58,23 @@ export class ArtifactsController {
     @Query(new ArtifactQueryTeamPipe()) team: string,
     @Body() body: Buffer,
   ): Promise<PutArtifactRO> {
+    this.logger.log(`PUT /${hash} team: ${team} body.length: ${body.length}`);
     await this.storageService.write(team, hash, Readable.from(body));
     return { urls: [`${team}/${hash}`] };
   }
 
   @Post()
   @HttpCode(501)
   queryArtifact(): void {
+    this.logger.log(`POST /`);
     // Documented in OpenAPI but currently unused
     return;
   }
 
   @Post("events")
   @HttpCode(200)
   postEvents(): void {
+    this.logger.log(`POST /events`);
     // We currently dont't record any events
     return;
   }

src/artifacts/artifacts.pipe.ts

@@ -1,7 +1,10 @@
-import { BadRequestException, PipeTransform } from "@nestjs/common";
+import { BadRequestException, Logger, PipeTransform } from "@nestjs/common";
 
 export class ArtifactQueryTeamPipe implements PipeTransform<any, string> {
+  private readonly logger = new Logger(ArtifactQueryTeamPipe.name);
+
   transform(value: any) {
+    this.logger.debug(`value: ${JSON.stringify(value)}`);
     const team = value.teamId ?? value.slug; // sometimes slug is sent instead of teamId
     if (!team) throw new BadRequestException("Missing teamId or slug");
     return team;

src/storage/providers/local.driver.ts

@@ -1,4 +1,4 @@
-import { Injectable } from "@nestjs/common";
+import { Injectable, Logger } from "@nestjs/common";
 import { createReadStream, createWriteStream } from "fs";
 import { access, mkdir } from "fs/promises";
 import { join } from "path";
@@ -8,9 +8,12 @@ import { StorageDriver } from "../storage.interface";
 
 @Injectable()
 export class LocalStorageDriver implements StorageDriver {
+  private readonly logger = new Logger(LocalStorageDriver.name);
+
   constructor(private readonly basePath: string) {}
 
   async write(team: string, hash: string, contents: Readable): Promise<void> {
+    this.logger.debug(`write path: ${join(this.basePath, team, hash)}`);
     await mkdir(join(this.basePath, team), { recursive: true });
     await pipeline(
       contents,
@@ -19,10 +22,12 @@ export class LocalStorageDriver implements StorageDriver {
   }
 
   async read(team: string, hash: string): Promise<Readable> {
+    this.logger.debug(`read path: ${join(this.basePath, team, hash)}`);
     return createReadStream(join(this.basePath, team, hash));
   }
 
   async exists(team: string, hash: string): Promise<boolean> {
+    this.logger.debug(`exists path: ${join(this.basePath, team, hash)}`);
     return access(join(this.basePath, team, hash))
       .then(() => true)
       .catch(() => false);

src/storage/providers/s3.driver.ts

@@ -4,12 +4,14 @@ import {
   S3Client,
 } from "@aws-sdk/client-s3";
 import { Upload } from "@aws-sdk/lib-storage";
-import { Injectable } from "@nestjs/common";
+import { Injectable, Logger } from "@nestjs/common";
 import { Readable } from "stream";
 import { StorageDriver } from "../storage.interface";
 
 @Injectable()
 export class S3StorageDriver implements StorageDriver {
+  private readonly logger = new Logger(S3StorageDriver.name);
+
   constructor(
     private readonly bucket: string,
     private readonly s3Client: S3Client,
@@ -21,6 +23,7 @@ export class S3StorageDriver implements StorageDriver {
       Bucket: this.bucket,
       Key: `${team}/${hash}`,
     };
+    this.logger.debug(`write params: ${JSON.stringify(params)}`);
     const upload = new Upload({ client: this.s3Client, params });
     await upload.done();
   }
@@ -30,6 +33,7 @@ export class S3StorageDriver implements StorageDriver {
       Bucket: this.bucket,
       Key: `${team}/${hash}`,
     };
+    this.logger.debug(`read params: ${JSON.stringify(params)}`);
     const getCommand = new GetObjectCommand(params);
     const response = await this.s3Client.send(getCommand);
     return response.Body as Readable;
@@ -40,6 +44,7 @@ export class S3StorageDriver implements StorageDriver {
       Bucket: this.bucket,
       Key: `${team}/${hash}`,
     };
+    this.logger.debug(`exists params: ${JSON.stringify(params)}`);
     const headCommand = new HeadObjectCommand(params);
     try {
       await this.s3Client.send(headCommand);

src/storage/storage.service.ts

@@ -1,5 +1,5 @@
 import { S3Client } from "@aws-sdk/client-s3";
-import { Injectable } from "@nestjs/common";
+import { Injectable, Logger } from "@nestjs/common";
 import { ConfigService } from "@nestjs/config";
 import { ConfigurationSchema } from "src/config/configuration";
 import { Readable } from "stream";
@@ -9,12 +9,14 @@ import { StorageDriver } from "./storage.interface";
 
 @Injectable()
 export class StorageService {
+  private readonly logger = new Logger(StorageService.name);
   private readonly driver: StorageDriver;
 
   constructor(
     readonly configService: ConfigService<ConfigurationSchema, true>,
   ) {
     const storageConfig = configService.get("storage", { infer: true });
+    this.logger.debug(`storageConfig: ${JSON.stringify(storageConfig)}`);
 
     if (storageConfig.provider === "local") {
       const { basePath } = storageConfig;
@@ -33,14 +35,17 @@ export class StorageService {
   }
 
   write(team: string, hash: string, contents: Readable): Promise<void> {
+    this.logger.debug(`write team: ${team} hash: ${hash}`);
     return this.driver.write(team, hash, contents);
   }
 
   read(team: string, hash: string): Promise<Readable> {
+    this.logger.debug(`read team: ${team} hash: ${hash}`);
     return this.driver.read(team, hash);
   }
 
   exists(team: string, hash: string): Promise<boolean> {
+    this.logger.debug(`exists team: ${team} hash: ${hash}`);
     return this.driver.exists(team, hash);
   }
 }