feat: implement get vudei encoding artifacts action

Author: cieslarmichal

apps/api/src/actions/getVideoEncodingArtifactsAction/getVideoEncodingArtifactsAction.integration.test.ts

@@ -1,20 +1,25 @@
-/* eslint-disable @typescript-eslint/naming-convention */
 import { faker } from '@faker-js/faker';
 import { expect, describe, it, beforeEach, afterEach } from 'vitest';
 
 import { LoggerFactory } from '@common/logger';
 
 import { ConfigFactory, type Config } from '../../config.js';
-import { RedisClientFactory, type RedisClient } from '@common/redis';
-import { ResourceNotFoundError } from '@common/errors';
 import { GetVideoEncodingArtifactsAction } from './getVideoEncodingArtifactsAction.js';
+import { S3ClientFactory, S3Service } from '@common/s3';
+import { S3TestUtils } from '@common/s3/tests';
+import { bucketNames } from '@common/contracts';
+import { join, resolve } from 'node:path';
 
 describe('GetVideoEncodingArtifactsAction', () => {
   let action: GetVideoEncodingArtifactsAction;
 
   let config: Config;
 
-  let redisClient: RedisClient;
+  let s3TestUtils: S3TestUtils;
+
+  const resourcesDirectory = resolve(__dirname, '../../../../../resources');
+
+  const sampleFileName = 'sample_video1.mp4';
 
   beforeEach(async () => {
     config = ConfigFactory.create();
@@ -24,54 +29,75 @@ describe('GetVideoEncodingArtifactsAction', () => {
       logLevel: config.logLevel,
     });
 
-    redisClient = new RedisClientFactory(logger).create(config.redis);
+    const s3Client = S3ClientFactory.create(config.aws);
+
+    const s3Service = new S3Service(s3Client);
+
+    action = new GetVideoEncodingArtifactsAction(s3Service, logger);
 
-    action = new GetVideoEncodingArtifactsAction(redisClient, logger);
+    s3TestUtils = new S3TestUtils(s3Client);
 
-    await redisClient.flushall();
+    await s3TestUtils.createBucket(bucketNames.encodingArtifacts);
   });
 
   afterEach(async () => {
-    await redisClient.flushall();
-
-    await redisClient.quit();
+    await s3TestUtils.deleteBucket(bucketNames.encodingArtifacts);
   });
 
   it('gets video encoding artifacts', async () => {
     const videoId = faker.string.uuid();
 
-    const redisKey = `${videoId}-encoding-progress`;
+    const encoded360pBlobName = `${videoId}/360p`;
 
-    await redisClient.hset(redisKey, {
-      '1080p': '75%',
-      '720p': '55%',
-      '480p': '30%',
-      '360p': '100%',
-      preview: '100%',
-      preview_360p: '100%',
-      preview_1080p: '3%',
-    });
+    const encodedPreviewBlobName = `${videoId}/preview`;
+
+    const encodedPreview360pBlobName = `${videoId}/preview_360p`;
+
+    const contentType = 'video/mp4';
 
-    const { encodedArtifacts } = await action.execute({ videoId });
+    await s3TestUtils.uploadObject(
+      bucketNames.encodingArtifacts,
+      encoded360pBlobName,
+      join(resourcesDirectory, sampleFileName),
+      contentType,
+    );
+
+    await s3TestUtils.uploadObject(
+      bucketNames.encodingArtifacts,
+      encodedPreviewBlobName,
+      join(resourcesDirectory, sampleFileName),
+      contentType,
+    );
+
+    await s3TestUtils.uploadObject(
+      bucketNames.encodingArtifacts,
+      encodedPreview360pBlobName,
+      join(resourcesDirectory, sampleFileName),
+      contentType,
+    );
+
+    const { encodingArtifacts } = await action.execute({ videoId });
+
+    encodingArtifacts.every((artifact) => {
+      expect(artifact.url).toContain(bucketNames.encodingArtifacts);
+
+      expect(artifact.url).toContain(videoId);
+
+      expect(['360p', 'preview', 'preview_360p'].some((id) => artifact.url.includes(id))).toBe(true);
+    });
 
     expect(encodingArtifacts).toEqual([
-      { id: '1080p', progress: '75%' },
-      { id: '720p', progress: '55%' },
-      { id: '480p', progress: '30%' },
-      { id: '360p', progress: '10%' },
-      { id: 'preview', progress: '0%' },
-      { id: 'preview_360p', progress: '1%' },
-      { id: 'preview_1080p', progress: '3%' },
+      { id: '360p', url: expect.any(String), contentType },
+      { id: 'preview', url: expect.any(String), contentType },
+      { id: 'preview_360p', url: expect.any(String), contentType },
     ]);
   });
 
-  it('throws error if video artifacts not found', async () => {
+  it('returns empty array if video artifacts not found', async () => {
     const videoId = faker.string.uuid();
 
-    try {
-      await action.execute({ videoId });
-    } catch (error) {
-      expect(error).toBeInstanceOf(ResourceNotFoundError);
-    }
+    const result = await action.execute({ videoId });
+
+    expect(result.encodingArtifacts).toHaveLength(0);
   });
 });

apps/api/src/actions/getVideoEncodingArtifactsAction/getVideoEncodingArtifactsAction.ts

@@ -1,18 +1,22 @@
-import { ResourceNotFoundError } from '@common/errors';
+import { bucketNames } from '@common/contracts';
 import { type Logger } from '@common/logger';
-import { type RedisClient } from '@common/redis';
+import { type S3Service } from '@common/s3';
 
 export interface GetVideoEncodingArtifactsActionPayload {
   readonly videoId: string;
 }
 
 export interface GetVideoEncodingArtifactsActionResult {
-  readonly encodingArtifacts: { id: string; url: string }[];
+  readonly encodingArtifacts: {
+    readonly id: string;
+    readonly contentType: string;
+    readonly url: string;
+  }[];
 }
 
 export class GetVideoEncodingArtifactsAction {
   public constructor(
-    private readonly redisClient: RedisClient,
+    private readonly s3Service: S3Service,
     private readonly logger: Logger,
   ) {}
 
@@ -23,33 +27,28 @@ export class GetVideoEncodingArtifactsAction {
 
     this.logger.debug({
       message: 'Fetching video encoding artifacts...',
+      bucketName: bucketNames.encodingArtifacts,
       videoId,
     });
 
-    const redisKey = `${videoId}-encoding-progress`;
-
-    const encodingProgress = await this.redisClient.hgetall(redisKey);
-
-    if (!encodingProgress) {
-      throw new ResourceNotFoundError({
-        resource: 'EncodingProgress',
-        id: videoId,
-      });
-    }
-
-    const encodedArtifacts = Object.entries(encodingProgress)
-      .map(([id, progress]) => ({
-        id,
-        progress,
-      }))
-      .filter(({ progress }) => progress === '100%');
+    const encodingArtifacts = await this.s3Service.getBlobsUrls({
+      bucketName: bucketNames.encodingArtifacts,
+      prefix: videoId,
+    });
 
     this.logger.debug({
       message: 'Video encoding artifacts fetched.',
       videoId,
-      encodedArtifacts: encodedArtifacts.map(({ id }) => id),
+      bucketName: bucketNames.encodingArtifacts,
+      count: encodingArtifacts.length,
     });
 
-    return { encodingArtifacts: flatEncodingArtifacts };
+    return {
+      encodingArtifacts: encodingArtifacts.map(({ name, url, contentType }) => ({
+        id: name.replace(`${videoId}/`, ''),
+        url,
+        contentType,
+      })),
+    };
   }
 }

apps/api/src/actions/getVideoEncodingProgressAction/getVideoEncodingProgressAction.integration.test.ts

@@ -72,6 +72,10 @@ describe('GetVideoEncodingProgressAction', () => {
       await action.execute({ videoId });
     } catch (error) {
       expect(error).toBeInstanceOf(ResourceNotFoundError);
+
+      return;
     }
+
+    expect.fail();
   });
 });

apps/api/src/actions/getVideoEncodingProgressAction/getVideoEncodingProgressAction.ts

@@ -28,7 +28,7 @@ export class GetVideoEncodingProgressAction {
 
     const encodingProgress = await this.redisClient.hgetall(redisKey);
 
-    if (!encodingProgress) {
+    if (Object.keys(encodingProgress).length === 0) {
       throw new ResourceNotFoundError({
         resource: 'EncodingProgress',
         id: videoId,

apps/api/src/actions/uploadVideoAction/uploadVideoAction.integration.test.ts

@@ -1,8 +1,8 @@
 import { faker } from '@faker-js/faker';
 import { randomUUID } from 'node:crypto';
 import { createReadStream } from 'node:fs';
-import path from 'path';
 import { expect, describe, it, beforeEach, afterEach } from 'vitest';
+import { resolve, join } from 'node:path';
 
 import { LoggerFactory } from '@common/logger';
 import { S3ClientFactory, S3Service } from '@common/s3';
@@ -26,11 +26,11 @@ describe('UploadVideoAction', () => {
 
   let amqpChannel: Channel;
 
-  const resourcesDirectory = path.resolve(__dirname, '../../../../../resources');
+  const resourcesDirectory = resolve(__dirname, '../../../../../resources');
 
   const sampleFileName = 'sample_video1.mp4';
 
-  const filePath = path.join(resourcesDirectory, sampleFileName);
+  const filePath = join(resourcesDirectory, sampleFileName);
 
   const videoId = randomUUID();
 
@@ -109,7 +109,7 @@ describe('UploadVideoAction', () => {
     expect(parsedMessage).toEqual({
       videoId,
       userEmail,
-      url: `http://transcoder-ingested-videos.s3.localhost.localstack.cloud:4566/${videoId}`,
+      url: `http://${bucketNames.ingestedVideos}.s3.localhost.localstack.cloud:4566/${videoId}`,
     });
   });
 });

common/amqp/package.json

@@ -17,7 +17,9 @@
   ],
   "scripts": {
     "build": "tsc --build tsconfig.json",
-    "build:dev": "tsc --build tsconfig.json"
+    "build:dev": "tsc --build tsconfig.json",
+    "lint": "eslint . -c ../../eslint.config.mjs --max-warnings 0",
+    "lint:fix": "npm run lint -- --fix"
   },
   "dependencies": {
     "@common/logger": "*",

common/contracts/package.json

@@ -13,7 +13,9 @@
   ],
   "scripts": {
     "build": "tsc --build tsconfig.json",
-    "build:dev": "tsc --build tsconfig.json"
+    "build:dev": "tsc --build tsconfig.json",
+    "lint": "eslint . -c ../../eslint.config.mjs --max-warnings 0",
+    "lint:fix": "npm run lint -- --fix"
   },
   "volta": {
     "node": "20.17.0",

common/errors/package.json

@@ -13,7 +13,9 @@
   ],
   "scripts": {
     "build": "tsc --build tsconfig.json",
-    "build:dev": "tsc --build tsconfig.json"
+    "build:dev": "tsc --build tsconfig.json",
+    "lint": "eslint . -c ../../eslint.config.mjs --max-warnings 0",
+    "lint:fix": "npm run lint -- --fix"
   },
   "volta": {
     "node": "20.17.0",

common/redis/package.json

@@ -17,7 +17,9 @@
   ],
   "scripts": {
     "build": "tsc --build tsconfig.json",
-    "build:dev": "tsc --build tsconfig.json"
+    "build:dev": "tsc --build tsconfig.json",
+    "lint": "eslint . -c ../../eslint.config.mjs --max-warnings 0",
+    "lint:fix": "npm run lint -- --fix"
   },
   "dependencies": {
     "@common/logger": "*",

common/s3/package.json

@@ -17,7 +17,11 @@
   ],
   "scripts": {
     "build": "tsc --build tsconfig.prod.json",
-    "build:dev": "tsc --build tsconfig.json"
+    "build:dev": "tsc --build tsconfig.json",
+    "test:integration": "NODE_ENV=test vitest --config vitest.integration.config.js .integration.test.ts",
+    "test:integration:run": "npm run test:integration -- --run",
+    "lint": "eslint . -c ../../eslint.config.mjs --max-warnings 0",
+    "lint:fix": "npm run lint -- --fix"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "3.592.0",