Merge pull request #2585 from RedisInsight/feature/RI-4717-import_existing_free_cloud_database

Feature/ri 4717 import existing free cloud database

Author: vlad-dargel

redisinsight/api/package.json

@@ -27,7 +27,7 @@
     "start:prod": "cross-env NODE_ENV=production BUILD_TYPE=DOCKER_ON_PREMISE node dist/src/main",
     "test": "cross-env NODE_ENV=test ./node_modules/.bin/jest -w 1",
     "test:watch": "cross-env NODE_ENV=test jest --watch -w 1",
-    "test:cov": "cross-env NODE_ENV=test ./node_modules/.bin/jest --forceExit --coverage -w 1",
+    "test:cov": "cross-env NODE_ENV=test ./node_modules/.bin/jest --forceExit --coverage -w 4",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand -w 1",
     "test:e2e": "jest --config ./test/jest-e2e.json -w 1",
     "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js -d ./config/ormconfig.ts",

redisinsight/api/src/modules/cloud/database/cloud-database.analytics.spec.ts

@@ -73,9 +73,10 @@ describe('CloudDatabaseAnalytics', () => {
     it('should emit error event with selected plan', async () => {
       await service.sendCloudFreeDatabaseFailed(
         httpException,
-        {},
-        cloudSubscriptionCapiService,
-        mockData,
+        {
+          region: mockFreeCloudSubscriptionPlan1.region,
+          provider: mockFreeCloudSubscriptionPlan1.provider,
+        },
       );
 
       expect(sendFailedEventMethod).toHaveBeenCalledWith(
@@ -93,26 +94,19 @@ describe('CloudDatabaseAnalytics', () => {
     await service.sendCloudFreeDatabaseFailed(
       httpException,
       undefined,
-      cloudSubscriptionCapiService,
-      mockData,
     );
 
     expect(sendFailedEventMethod).toHaveBeenCalledWith(
       TelemetryEvents.CloudFreeDatabaseFailed,
       httpException,
-      {
-        region: mockFreeCloudSubscriptionPlan1.region,
-        provider: mockFreeCloudSubscriptionPlan1.provider,
-      },
+      {},
     );
   });
 
   it('should emit error event when free subscription is not exist', async () => {
     await service.sendCloudFreeDatabaseFailed(
       httpException,
       undefined,
-      cloudSubscriptionCapiService,
-      { planId: 123, capiCredentials: mockCloudCapiAuthDto },
     );
 
     expect(sendFailedEventMethod).toHaveBeenCalledWith(

redisinsight/api/src/modules/cloud/database/cloud-database.analytics.ts

@@ -2,9 +2,6 @@ import { HttpException, Injectable } from '@nestjs/common';
 import { TelemetryBaseService } from 'src/modules/analytics/telemetry.base.service';
 import { EventEmitter2 } from '@nestjs/event-emitter';
 import { TelemetryEvents } from 'src/constants';
-import { CloudSubscriptionCapiService } from '../subscription/cloud-subscription.capi.service';
-import { CloudSubscriptionType } from '../subscription/models';
-import { CloudCapiAuthDto } from '../common/dto';
 
 @Injectable()
 export class CloudDatabaseAnalytics extends TelemetryBaseService {
@@ -19,25 +16,12 @@ export class CloudDatabaseAnalytics extends TelemetryBaseService {
   async sendCloudFreeDatabaseFailed(
     exception: HttpException,
     eventData: object = {},
-    cloudSubscriptionCapiService: CloudSubscriptionCapiService,
-    data: { planId: number, capiCredentials: CloudCapiAuthDto },
   ) {
     try {
-      const fixedPlans = await cloudSubscriptionCapiService.getSubscriptionsPlans(
-        data.capiCredentials,
-        CloudSubscriptionType.Fixed,
-      );
-
-      const selectedPlan = CloudSubscriptionCapiService.findFreePlanById(fixedPlans, data.planId);
-
       this.sendFailedEvent(
         TelemetryEvents.CloudFreeDatabaseFailed,
         exception,
-        {
-          ...eventData,
-          region: selectedPlan?.region,
-          provider: selectedPlan?.provider,
-        },
+        eventData,
       );
     } catch (error) {
       // ignore

redisinsight/api/src/modules/cloud/job/cloud-job.factory.ts

@@ -1,5 +1,9 @@
 import { Injectable } from '@nestjs/common';
-import { CloudJob } from 'src/modules/cloud/job/jobs';
+import {
+  CloudJob,
+  CreateFreeSubscriptionAndDatabaseCloudJob,
+  ImportFreeDatabaseCloudJob
+} from 'src/modules/cloud/job/jobs';
 import { CloudJobName } from 'src/modules/cloud/job/constants';
 import { CreateFreeDatabaseCloudJob } from 'src/modules/cloud/job/jobs/create-free-database.cloud-job';
 import { CloudDatabaseCapiService } from 'src/modules/cloud/database/cloud-database.capi.service';
@@ -31,10 +35,26 @@ export class CloudJobFactory {
       sessionMetadata: SessionMetadata,
       utm?: CloudRequestUtm,
       capiCredentials?: CloudCapiAuthDto,
-      stateCallback?: (self: CloudJob) => any,
+      stateCallbacks?: ((self: CloudJob) => any)[],
     },
   ): Promise<CloudJob> {
     switch (name) {
+      case CloudJobName.CreateFreeSubscriptionAndDatabase:
+        return new CreateFreeSubscriptionAndDatabaseCloudJob(
+          {
+            abortController: new AbortController(),
+            ...options,
+          },
+          data,
+          {
+            cloudDatabaseCapiService: this.cloudDatabaseCapiService,
+            cloudSubscriptionCapiService: this.cloudSubscriptionCapiService,
+            cloudTaskCapiService: this.cloudTaskCapiService,
+            cloudDatabaseAnalytics: this.cloudDatabaseAnalytics,
+            databaseService: this.databaseService,
+            cloudCapiKeyService: this.cloudCapiKeyService,
+          },
+        );
       case CloudJobName.CreateFreeDatabase:
         return new CreateFreeDatabaseCloudJob(
           {
@@ -51,6 +71,22 @@ export class CloudJobFactory {
             cloudCapiKeyService: this.cloudCapiKeyService,
           },
         );
+      case CloudJobName.ImportFreeDatabase:
+        return new ImportFreeDatabaseCloudJob(
+          {
+            abortController: new AbortController(),
+            ...options,
+          },
+          data,
+          {
+            cloudDatabaseCapiService: this.cloudDatabaseCapiService,
+            cloudSubscriptionCapiService: this.cloudSubscriptionCapiService,
+            cloudTaskCapiService: this.cloudTaskCapiService,
+            cloudDatabaseAnalytics: this.cloudDatabaseAnalytics,
+            databaseService: this.databaseService,
+            cloudCapiKeyService: this.cloudCapiKeyService,
+          },
+        );
       default:
         throw new CloudJobUnsupportedException();
     }

redisinsight/api/src/modules/cloud/job/constants/index.ts

@@ -1,6 +1,8 @@
 export enum CloudJobName {
+  CreateFreeSubscriptionAndDatabase = 'CREATE_FREE_SUBSCRIPTION_AND_DATABASE',
   CreateFreeDatabase = 'CREATE_FREE_DATABASE',
   CreateFreeSubscription = 'CREATE_FREE_SUBSCRIPTION',
+  ImportFreeDatabase = 'IMPORT_FREE_DATABASE',
   WaitForActiveDatabase = 'WAIT_FOR_ACTIVE_DATABASE',
   WaitForActiveSubscription = 'WAIT_FOR_ACTIVE_SUBSCRIPTION',
   WaitForTask = 'WAIT_FOR_TASK',

redisinsight/api/src/modules/cloud/job/dto/create-database.cloud-job.data.dto.ts

@@ -3,10 +3,10 @@ import { IsNotEmpty, IsNumber } from 'class-validator';
 
 export class CreateDatabaseCloudJobDataDto {
   @ApiProperty({
-    description: 'Plan id for create a subscription.',
+    description: 'Subscription id for create a database.',
     type: Number,
   })
   @IsNumber()
   @IsNotEmpty()
-  planId: number;
+  subscriptionId: number;
 }

redisinsight/api/src/modules/cloud/job/dto/create-subscription-and-database.cloud-job.data.dto.ts

@@ -0,0 +1,12 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsNumber } from 'class-validator';
+
+export class CreateSubscriptionAndDatabaseCloudJobDataDto {
+  @ApiProperty({
+    description: 'Plan id for create a subscription.',
+    type: Number,
+  })
+  @IsNumber()
+  @IsNotEmpty()
+  planId: number;
+}

redisinsight/api/src/modules/cloud/job/dto/create.cloud-job.dto.ts

@@ -13,8 +13,14 @@ import { cloudJobDataTransformer } from 'src/modules/cloud/job/transformers/clou
 import { CloudJobName } from 'src/modules/cloud/job/constants';
 import { CloudJobRunMode } from 'src/modules/cloud/job/models';
 import { CreateDatabaseCloudJobDataDto } from 'src/modules/cloud/job/dto/create-database.cloud-job.data.dto';
+import {
+  CreateSubscriptionAndDatabaseCloudJobDataDto,
+} from 'src/modules/cloud/job/dto/create-subscription-and-database.cloud-job.data.dto';
+import { ImportDatabaseCloudJobDataDto } from 'src/modules/cloud/job/dto/import-database.cloud-job.data.dto';
 
-@ApiExtraModels(CreateDatabaseCloudJobDataDto)
+@ApiExtraModels(
+  CreateDatabaseCloudJobDataDto, CreateSubscriptionAndDatabaseCloudJobDataDto, ImportDatabaseCloudJobDataDto,
+)
 export class CreateCloudJobDto {
   @ApiProperty({
     description: 'Job name to create',
@@ -38,12 +44,14 @@ export class CreateCloudJobDto {
     description: 'Any data for create a job.',
     oneOf: [
       { $ref: getSchemaPath(CreateDatabaseCloudJobDataDto) },
+      { $ref: getSchemaPath(CreateSubscriptionAndDatabaseCloudJobDataDto) },
+      { $ref: getSchemaPath(ImportDatabaseCloudJobDataDto) },
     ],
   })
   @Expose()
   @IsOptional()
   @IsNotEmptyObject()
   @Type(cloudJobDataTransformer)
   @ValidateNested()
-  data?: CreateDatabaseCloudJobDataDto;
+  data?: CreateDatabaseCloudJobDataDto | CreateSubscriptionAndDatabaseCloudJobDataDto | ImportDatabaseCloudJobDataDto;
 }

redisinsight/api/src/modules/cloud/job/dto/import-database.cloud-job.data.dto.ts

@@ -0,0 +1,20 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsNumber } from 'class-validator';
+
+export class ImportDatabaseCloudJobDataDto {
+  @ApiProperty({
+    description: 'Subscription id of database',
+    type: Number,
+  })
+  @IsNumber()
+  @IsNotEmpty()
+  subscriptionId: number;
+
+  @ApiProperty({
+    description: 'Database id to import',
+    type: Number,
+  })
+  @IsNumber()
+  @IsNotEmpty()
+  databaseId: number;
+}

redisinsight/api/src/modules/cloud/job/exceptions/cloud-database-already-exists-free.exception.ts

@@ -3,12 +3,19 @@ import ERROR_MESSAGES from 'src/constants/error-messages';
 import { CustomErrorCodes } from 'src/constants';
 
 export class CloudDatabaseAlreadyExistsFreeException extends HttpException {
-  constructor(message = ERROR_MESSAGES.CLOUD_DATABASE_ALREADY_EXISTS_FREE, options?: HttpExceptionOptions) {
+  constructor(
+    message = ERROR_MESSAGES.CLOUD_DATABASE_ALREADY_EXISTS_FREE,
+    options?: HttpExceptionOptions & { subscriptionId?: number, databaseId?: number },
+  ) {
     const response = {
       message,
       statusCode: HttpStatus.CONFLICT,
       error: 'CloudDatabaseAlreadyExistsFree',
       errorCode: CustomErrorCodes.CloudDatabaseAlreadyExistsFree,
+      resource: {
+        subscriptionId: options?.subscriptionId,
+        databaseId: options?.databaseId,
+      },
     };
 
     super(response, response.statusCode, options);