#RI-4759 - Display detailed statuses for the progress

Author: egor-zalenski

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

@@ -1,12 +1,13 @@
 import { v4 as uuidv4 } from 'uuid';
 import config from 'src/utils/config';
-import { CloudJobInfo, CloudJobStatus } from 'src/modules/cloud/job/models/cloud-job-info';
+import { CloudJobInfo, CloudJobStatus, CloudJobStep } from 'src/modules/cloud/job/models/cloud-job-info';
 import { HttpException, Logger } from '@nestjs/common';
 import { ClassType } from 'class-transformer/ClassTransformer';
 import { CloudJobAbortedException, wrapCloudJobError } from 'src/modules/cloud/job/exceptions';
 import { SessionMetadata } from 'src/common/models';
 import { CloudJobName } from 'src/modules/cloud/job/constants';
 import { CloudRequestUtm } from 'src/modules/cloud/common/models';
+import { debounce } from 'lodash';
 
 const cloudConfig = config.get('cloud');
 
@@ -31,6 +32,8 @@ export abstract class CloudJob {
 
   protected status = CloudJobStatus.Initializing;
 
+  protected step = CloudJobStep.Credentials;
+
   protected error?: HttpException;
 
   protected child?: CloudJob;
@@ -41,18 +44,33 @@ export abstract class CloudJob {
 
   protected dependencies: any;
 
+  private readonly debounce: any;
+
   protected constructor(options: CloudJobOptions) {
     this.options = options;
 
     if (!this.options.stateCallbacks) {
       this.options.stateCallbacks = [];
     }
+
+    this.debounce = debounce(() => {
+      try {
+        (this.options?.stateCallbacks || []).forEach((cb) => {
+          cb?.(this)?.catch?.(() => {});
+        });
+      } catch (e) {
+        // silently ignore callback
+      }
+    }, 1_000, {
+      maxWait: 1_000,
+    });
   }
 
   public async run() {
     try {
       this.changeState({
         status: CloudJobStatus.Running,
+        step: CloudJobStep.Initializing,
       });
 
       return await this.iteration();
@@ -83,6 +101,7 @@ export abstract class CloudJob {
       result: this.result,
       error: this.error ? wrapCloudJobError(this.error).getResponse() : undefined,
       child: this.child?.getState(),
+      step: this.step,
     };
   }
 
@@ -116,13 +135,8 @@ export abstract class CloudJob {
 
   protected changeState(state = {}) {
     Object.entries(state).forEach(([key, value]) => { this[key] = value; });
-    try {
-      (this.options?.stateCallbacks || []).forEach((cb) => {
-        cb?.(this)?.catch?.(() => {});
-      });
-    } catch (e) {
-      // silently ignore callback
-    }
+
+    this.debounce();
   }
 
   protected checkSignal() {

redisinsight/api/src/modules/cloud/job/jobs/create-free-database.cloud-job.ts

@@ -10,7 +10,7 @@ import { CreateFreeSubscriptionCloudJob } from 'src/modules/cloud/job/jobs/creat
 import { CloudDatabaseCapiService } from 'src/modules/cloud/database/cloud-database.capi.service';
 import { WaitForActiveDatabaseCloudJob } from 'src/modules/cloud/job/jobs/wait-for-active-database.cloud-job';
 import { CloudJobName } from 'src/modules/cloud/job/constants';
-import { CloudJobStatus } from 'src/modules/cloud/job/models';
+import { CloudJobStatus, CloudJobStep } from 'src/modules/cloud/job/models';
 import {
   CloudDatabaseAlreadyExistsFreeException, CloudJobUnexpectedErrorException,
   CloudTaskNoResourceIdException,
@@ -54,11 +54,15 @@ export class CreateFreeDatabaseCloudJob extends CloudJob {
 
       this.logger.debug('Generating capi credentials');
 
+      this.changeState({ step: CloudJobStep.Credentials });
+
       this.data.capiCredentials = await this.dependencies.cloudUserApiService.getCapiKeys(
         this.options.sessionMetadata,
         this.options.utm,
       );
 
+      this.changeState({ step: CloudJobStep.Subscription });
+
       this.logger.debug('Get or create free subscription');
 
       freeSubscription = await this.runChildJob(
@@ -70,6 +74,8 @@ export class CreateFreeDatabaseCloudJob extends CloudJob {
 
       this.checkSignal();
 
+      this.changeState({ step: CloudJobStep.Database });
+
       const databases = await this.dependencies.cloudDatabaseCapiService.getDatabases(
         this.data.capiCredentials,
         {

redisinsight/api/src/modules/cloud/job/models/cloud-job-info.ts

@@ -15,6 +15,13 @@ export enum CloudJobStatus {
   Failed = 'failed',
 }
 
+export enum CloudJobStep {
+  Initializing = 'initializing',
+  Credentials = 'credentials',
+  Subscription = 'subscription',
+  Database = 'database',
+}
+
 export class CloudJobInfo {
   @ApiProperty({
     type: String,
@@ -54,4 +61,10 @@ export class CloudJobInfo {
   })
   @Expose()
   result?: any;
+
+  @ApiPropertyOptional({
+    description: 'Job step',
+  })
+  @Expose()
+  step?: CloudJobStep;
 }