Set up Cloudinary integration for listing image uploads

- Add Cloudinary configuration to .env.example
- Install Cloudinary package and add it to dependencies
- Create CloudinaryService for image uploads
- Implement ListingConsumer to handle image upload jobs
- Update ListingService to use queue for image uploads
- Add Cloudinary config to main configuration file

Author: jfjuanmiguel

.env.example

@@ -12,4 +12,8 @@ REDIS_HOST="localhost"
 REDIS_PORT="6379" # Needs to match the port in docker-compose.yml
 REDIS_USERNAME=""
 REDIS_PASSWORD=""
-REDIS_URL="redis://${REDIS_USERNAME}:${REDIS_PASSWORD}@${REDIS_HOST}:${REDIS_PORT}"
+REDIS_URL="redis://${REDIS_USERNAME}:${REDIS_PASSWORD}@${REDIS_HOST}:${REDIS_PORT}"
+
+CLOUDINARY_CLOUD_NAME="your_cloud_name"
+CLOUDINARY_API_KEY="your_api_key"
+CLOUDINARY_API_SECRET="your_api_secret"

package.json

@@ -45,6 +45,7 @@
     "cache-manager-redis-store": "2",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
+    "cloudinary": "^2.4.0",
     "helmet": "^7.1.0",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1",

pnpm-lock.yaml

@@ -6,4 +6,9 @@ export default () => ({
     username: process.env.REDIS_USERNAME,
     password: process.env.REDIS_PASSWORD,
   },
+  cloudinary: {
+    cloudName: process.env.CLOUDINARY_CLOUD_NAME,
+    apiKey: process.env.CLOUDINARY_API_KEY,
+    apiSecret: process.env.CLOUDINARY_API_SECRET,
+  },
 });

src/config/index.ts

@@ -0,0 +1,13 @@
+-- CreateTable
+CREATE TABLE "ListingImage" (
+    "id" SERIAL NOT NULL,
+    "url" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+    "listingId" INTEGER NOT NULL,
+
+    CONSTRAINT "ListingImage_pkey" PRIMARY KEY ("id")
+);
+
+-- AddForeignKey
+ALTER TABLE "ListingImage" ADD CONSTRAINT "ListingImage_listingId_fkey" FOREIGN KEY ("listingId") REFERENCES "Listing"("id") ON DELETE RESTRICT ON UPDATE CASCADE;

src/database/migrations/20240905202207_add_image_url_to_listing/migration.sql

@@ -19,6 +19,16 @@ model Listing {
   bathrooms       Int
   bedrooms        Int
   squareMeters    Int
+  images          ListingImage[]
   createdAt       DateTime  @default(now())
   updatedAt       DateTime  @updatedAt
 }
+
+model ListingImage {
+  id          Int       @id @default(autoincrement())
+  url         String
+  createdAt   DateTime  @default(now())
+  updatedAt   DateTime  @updatedAt
+  listing     Listing @relation(fields: [listingId], references: [id])
+  listingId   Int
+}

src/database/schema.prisma

@@ -22,13 +22,15 @@ export class ListingService {
     const listing = await this.databaseService.listing.create({
       data,
     });
+
     for (const image of images) {
       await this.listingQueue.uploadListingImage({
         base64File: this.fileService.bufferToBase64(image.buffer),
         mimeType: image.mimetype,
         listingId: listing.id,
       });
     }
+
     return listing;
   }
 }

src/modules/listing/listing.service.ts

@@ -5,20 +5,38 @@ import { LISTING_QUEUE } from '../../../core/queue/queue.constants';
 import { BaseConsumer } from '../../../core/queue/base.consumer';
 import { LoggerService } from '../../../core/logger/logger.service';
 import { FileService } from '../../../utilities/file/file.service';
+import { CloudinaryService } from '../../../utilities/cloudinary/cloudinary.service';
+import { DatabaseService } from '../../../database/database.service';
 
 @Processor(LISTING_QUEUE)
 export class ListingConsumer extends BaseConsumer {
   constructor(
     logger: LoggerService,
     private readonly fileService: FileService,
+    private readonly cloudinaryService: CloudinaryService,
+    private readonly databaseService: DatabaseService,
   ) {
     super(logger);
   }
 
   @Process(`createListingImage`)
   async createListingImage(job: Job<UploadListingImageDto>) {
     const buffer = this.fileService.base64ToBuffer(job.data.base64File);
-    // TODO: upload file to Google Cloud Storage
-    // TODO: store respective Google Cloud Storage URL in database
+    const cloudinaryUrl = await this.cloudinaryService.uploadImage(
+      buffer,
+      'listings',
+    );
+
+    // Create a new ListingImage record
+    await this.databaseService.listingImage.create({
+      data: {
+        url: cloudinaryUrl,
+        listing: {
+          connect: { id: job.data.listingId },
+        },
+      },
+    });
+
+    return cloudinaryUrl;
   }
 }

src/modules/listing/queue/listing.consumer.ts

@@ -0,0 +1,25 @@
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { v2 as cloudinary } from 'cloudinary';
+
+@Injectable()
+export class CloudinaryService {
+  constructor(private configService: ConfigService) {
+    cloudinary.config({
+      cloud_name: this.configService.get('cloudinary.cloudName'),
+      api_key: this.configService.get('cloudinary.apiKey'),
+      api_secret: this.configService.get('cloudinary.apiSecret'),
+    });
+  }
+
+  async uploadImage(file: Buffer, folder: string): Promise<string> {
+    return new Promise((resolve, reject) => {
+      cloudinary.uploader
+        .upload_stream({ folder }, (error, result) => {
+          if (error) return reject(error);
+          resolve(result?.secure_url || '');
+        })
+        .end(file);
+    });
+  }
+}

src/utilities/cloudinary/cloudinary.service.ts

@@ -1,8 +1,9 @@
 import { Module } from '@nestjs/common';
 import { FileService } from './file/file.service';
+import { CloudinaryService } from './cloudinary/cloudinary.service';
 
 @Module({
-  providers: [FileService],
-  exports: [FileService],
+  providers: [FileService, CloudinaryService],
+  exports: [FileService, CloudinaryService],
 })
 export class UtilitiesModule {}