#RI-4937 add utm parameters support for /me endpoint + fix schema

Author: Artem

redisinsight/api/src/modules/cloud/common/models/cloud-request-utm.ts

@@ -19,7 +19,8 @@ export class CloudRequestUtm {
   @IsOptional()
   @IsString()
   @IsNotEmpty()
-  medium?: string;
+  @Default('app')
+  medium? = 'app';
 
   @ApiPropertyOptional({
     type: String,

redisinsight/api/src/modules/cloud/common/providers/cloud.api.provider.ts

@@ -18,18 +18,28 @@ export class CloudApiProvider {
       return null;
     }
 
-    return new URLSearchParams([
-      ['utm_source', utm?.source],
-      ['utm_medium', utm?.medium],
-      ['utm_campaign', utm?.campaign],
-    ]);
+    const params = new URLSearchParams();
+
+    if (utm?.source) {
+      params.append('utm_source', utm.source);
+    }
+
+    if (utm?.medium) {
+      params.append('utm_medium', utm.medium);
+    }
+
+    if (utm?.campaign) {
+      params.append('utm_campaign', utm.campaign);
+    }
+
+    return params;
   }
 
   /**
    * Prepare header for authorized requests
    * @param credentials
    */
-  static getHeaders(credentials: ICloudApiCredentials) {
+  static getHeaders(credentials: ICloudApiCredentials): { headers: {} } {
     const headers = {};
 
     if (credentials?.accessToken) {

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

@@ -1,16 +1,17 @@
-import { ApiProperty, ApiPropertyOptional, getSchemaPath } from '@nestjs/swagger';
+import {
+  ApiExtraModels, ApiProperty, ApiPropertyOptional, getSchemaPath,
+} from '@nestjs/swagger';
 import {
   IsEnum,
   IsNotEmpty,
   IsNumber,
   IsOptional,
   ValidateNested,
 } from 'class-validator';
-import { Expose } from 'class-transformer';
+import { Expose, Type } from 'class-transformer';
 import { CloudJobName } from 'src/modules/cloud/job/constants';
 import { CloudJobRunMode } from 'src/modules/cloud/job/models';
-// eslint-disable-next-line import/no-cycle
-import { cloudJobDataTransformer } from '../transformers/cloud-job-data.transformer';
+import { cloudJobDataTransformer } from 'src/modules/cloud/job/transformers/cloud-job-data.transformer';
 
 export class CreateDatabaseCloudJobDataDto {
   @ApiProperty({
@@ -22,6 +23,7 @@ export class CreateDatabaseCloudJobDataDto {
   planId: number;
 }
 
+@ApiExtraModels(CreateDatabaseCloudJobDataDto)
 export class CreateCloudJobDto {
   @ApiProperty({
     description: 'Job name to create',
@@ -45,13 +47,12 @@ export class CreateCloudJobDto {
     description: 'Any data for create a job.',
     oneOf: [
       { $ref: getSchemaPath(CreateDatabaseCloudJobDataDto) },
-      { $ref: getSchemaPath(undefined) },
     ],
-    type: cloudJobDataTransformer,
   })
   @ValidateNested()
   @Expose()
   @IsNotEmpty()
   @IsOptional()
+  @Type(cloudJobDataTransformer)
   data: CreateDatabaseCloudJobDataDto | undefined;
 }

redisinsight/api/src/modules/cloud/job/transformers/cloud-job-data.transformer.ts

@@ -1,8 +1,7 @@
 import { get } from 'lodash';
 import { TypeHelpOptions } from 'class-transformer';
-// eslint-disable-next-line import/no-cycle
-import { CreateDatabaseCloudJobDataDto } from '../dto';
-import { CloudJobName } from '../constants';
+import { CreateDatabaseCloudJobDataDto } from 'src/modules/cloud/job/dto';
+import { CloudJobName } from 'src/modules/cloud/job/constants';
 
 export const cloudJobDataTransformer = (data: TypeHelpOptions) => {
   const jobName = get(data?.object, 'name');

redisinsight/api/src/modules/cloud/user/cloud-user.controller.ts

@@ -1,12 +1,13 @@
 import {
   ClassSerializerInterceptor,
-  Controller, Get, Param, Put, UseInterceptors, UsePipes, ValidationPipe,
+  Controller, Get, Param, Put, Query, UseInterceptors, UsePipes, ValidationPipe,
 } from '@nestjs/common';
 import { RequestSessionMetadata } from 'src/common/decorators';
 import { ApiParam, ApiTags } from '@nestjs/swagger';
 import { ApiEndpoint } from 'src/decorators/api-endpoint.decorator';
 import { CloudUser } from 'src/modules/cloud/user/models';
 import { CloudUserApiService } from 'src/modules/cloud/user/cloud-user.api.service';
+import { CloudRequestUtm } from 'src/modules/cloud/common/models';
 
 @ApiTags('Cloud User')
 @UseInterceptors(ClassSerializerInterceptor)
@@ -23,8 +24,11 @@ export class CloudUserController {
     statusCode: 200,
     responses: [{ type: CloudUser }],
   })
-  async me(@RequestSessionMetadata() sessionMetadata): Promise<CloudUser> {
-    return this.service.me(sessionMetadata);
+  async me(
+    @RequestSessionMetadata() sessionMetadata,
+      @Query() utm: CloudRequestUtm,
+  ): Promise<CloudUser> {
+    return this.service.me(sessionMetadata, false, utm);
   }
 
   @Put('/accounts/:id/current')

redisinsight/api/src/modules/cloud/user/providers/cloud-user.api.provider.ts

@@ -37,13 +37,13 @@ export class CloudUserApiProvider extends CloudApiProvider {
    */
   async getApiSessionId(credentials: ICloudApiCredentials, utm?: CloudRequestUtm): Promise<string> {
     try {
-      const queryParameters = CloudApiProvider.generateUtmQuery(utm);
-      const query = queryParameters ? `?${queryParameters.toString()}` : '';
-
       const { headers } = await this.api.post(
-        `login${query}`,
+        'login',
         {},
-        CloudApiProvider.getHeaders(credentials),
+        {
+          ...CloudApiProvider.getHeaders(credentials),
+          params: CloudApiProvider.generateUtmQuery(utm),
+        },
       );
 
       return get(headers, 'set-cookie', []).find(