Merge pull request #2574 from RedisInsight/feature/RI-4926-send_utm_parameters

vlad-dargel · web-flow · commit 6d6b4db7ec33 · 2023-09-20T09:28:12.000+02:00
Feature/ri 4926 send utm parameters
diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
     "start:web:public": "cross-env PUBLIC_DEV=true NODE_ENV=development TS_NODE_TRANSPILE_ONLY=true webpack serve --config ./configs/webpack.config.web.dev.ts",
     "test": "jest ./redisinsight/ui -w 1",
     "test:watch": "jest ./redisinsight/ui --watch -w 1",
-    "test:cov": "jest ./redisinsight/ui --coverage -w 1",
+    "test:cov": "jest ./redisinsight/ui --coverage --runInBand",
     "test:cov:unit": "jest ./redisinsight/ui --group=-component --coverage -w 1",
     "test:cov:component": "jest ./redisinsight/ui --group=component --coverage -w 1",
     "type-check:ui": "tsc --project redisinsight/ui --noEmit"
diff --git a/redisinsight/api/src/modules/cloud/common/models/cloud-request-utm.ts b/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,
diff --git a/redisinsight/api/src/modules/cloud/common/providers/cloud.api.provider.spec.ts b/redisinsight/api/src/modules/cloud/common/providers/cloud.api.provider.spec.ts
@@ -10,16 +10,12 @@ const generateUtmQueryTests = [
     input: { source: 'source' },
     expected: new URLSearchParams([
       ['utm_source', 'source'],
-      ['utm_medium', 'undefined'],
-      ['utm_campaign', 'undefined'],
     ]),
   },
   {
     input: { medium: 'medium' },
     expected: new URLSearchParams([
-      ['utm_source', 'undefined'],
       ['utm_medium', 'medium'],
-      ['utm_campaign', 'undefined'],
     ]),
   },
   {
@@ -33,8 +29,6 @@ const generateUtmQueryTests = [
   {
     input: { campaign: 'campaign' },
     expected: new URLSearchParams([
-      ['utm_source', 'undefined'],
-      ['utm_medium', 'undefined'],
       ['utm_campaign', 'campaign'],
     ]),
   },
diff --git a/redisinsight/api/src/modules/cloud/common/providers/cloud.api.provider.ts b/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) {
diff --git a/redisinsight/api/src/modules/cloud/job/cloud-job.controller.ts b/redisinsight/api/src/modules/cloud/job/cloud-job.controller.ts
@@ -4,13 +4,15 @@ import {
   Controller, Get, Param, Post, UseInterceptors, UsePipes, ValidationPipe,
 } from '@nestjs/common';
 import { RequestSessionMetadata } from 'src/common/decorators';
-import { ApiTags } from '@nestjs/swagger';
+import { ApiExtraModels, ApiTags } from '@nestjs/swagger';
 import { ApiEndpoint } from 'src/decorators/api-endpoint.decorator';
 import { CloudJobService } from 'src/modules/cloud/job/cloud-job.service';
-import { CreateCloudJobDto } from 'src/modules/cloud/job/dto';
+import { CreateDatabaseCloudJobDataDto } from 'src/modules/cloud/job/dto/create-database.cloud-job.data.dto';
+import { CreateCloudJobDto } from 'src/modules/cloud/job/dto/create.cloud-job.dto';
 import { CloudJobInfo } from 'src/modules/cloud/job/models';
 import { CloudRequestUtm } from 'src/modules/cloud/common/models';
 
+@ApiExtraModels(CreateDatabaseCloudJobDataDto)
 @ApiTags('Cloud Jobs')
 @UseInterceptors(ClassSerializerInterceptor)
 @Controller('cloud/me/jobs')
diff --git a/redisinsight/api/src/modules/cloud/job/cloud-job.gateway.ts b/redisinsight/api/src/modules/cloud/job/cloud-job.gateway.ts
@@ -5,12 +5,12 @@ import {
   WebSocketServer, WsException,
 } from '@nestjs/websockets';
 import {
-  Logger, ValidationPipe
+  Logger, ValidationPipe,
 } from '@nestjs/common';
 import config from 'src/utils/config';
 import { CloudJobEvents } from 'src/modules/cloud/common/constants';
 import { CloudJobService } from 'src/modules/cloud/job/cloud-job.service';
-import { MonitorCloudJobDto } from 'src/modules/cloud/job/dto';
+import { MonitorCloudJobDto } from 'src/modules/cloud/job/dto/monitor.cloud-job.dto';
 import { Validator } from 'class-validator';
 import { plainToClass } from 'class-transformer';
 import { DEFAULT_SESSION_ID, DEFAULT_USER_ID } from 'src/common/constants';
diff --git a/redisinsight/api/src/modules/cloud/job/cloud-job.provider.ts b/redisinsight/api/src/modules/cloud/job/cloud-job.provider.ts
@@ -1,7 +1,7 @@
 import { filter } from 'lodash';
 import { CloudJob } from 'src/modules/cloud/job/jobs';
 import { SessionMetadata } from 'src/common/models';
-import { CreateCloudJobDto } from 'src/modules/cloud/job/dto';
+import { CreateCloudJobDto } from 'src/modules/cloud/job/dto/create.cloud-job.dto';
 import { CloudJobInfo, CloudJobRunMode } from 'src/modules/cloud/job/models';
 import { CloudJobFactory } from 'src/modules/cloud/job/cloud-job.factory';
 import { wrapHttpError } from 'src/common/utils';
diff --git a/redisinsight/api/src/modules/cloud/job/cloud-job.service.ts b/redisinsight/api/src/modules/cloud/job/cloud-job.service.ts
@@ -1,6 +1,7 @@
 import { ForbiddenException, Injectable } from '@nestjs/common';
 import { SessionMetadata } from 'src/common/models';
-import { CreateCloudJobDto, MonitorCloudJobDto } from 'src/modules/cloud/job/dto';
+import { CreateCloudJobDto } from 'src/modules/cloud/job/dto/create.cloud-job.dto';
+import { MonitorCloudJobDto } from 'src/modules/cloud/job/dto/monitor.cloud-job.dto';
 import { wrapHttpError } from 'src/common/utils';
 import { CloudJobProvider } from 'src/modules/cloud/job/cloud-job.provider';
 import { CloudJobInfo } from 'src/modules/cloud/job/models';
diff --git a/redisinsight/api/src/modules/cloud/job/dto/create-database.cloud-job.data.dto.ts b/redisinsight/api/src/modules/cloud/job/dto/create-database.cloud-job.data.dto.ts
@@ -0,0 +1,12 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsNumber } from 'class-validator';
+
+export class CreateDatabaseCloudJobDataDto {
+  @ApiProperty({
+    description: 'Plan id for create a subscription.',
+    type: Number,
+  })
+  @IsNumber()
+  @IsNotEmpty()
+  planId: number;
+}
diff --git a/redisinsight/api/src/modules/cloud/job/dto/create.cloud-job.dto.ts b/redisinsight/api/src/modules/cloud/job/dto/create.cloud-job.dto.ts
@@ -1,27 +1,20 @@
-import { ApiProperty, ApiPropertyOptional, getSchemaPath } from '@nestjs/swagger';
+import {
+  ApiExtraModels, ApiProperty, ApiPropertyOptional, getSchemaPath,
+} from '@nestjs/swagger';
 import {
   IsEnum,
   IsNotEmpty,
-  IsNumber,
+  IsNotEmptyObject,
   IsOptional,
   ValidateNested,
 } from 'class-validator';
-import { Expose } from 'class-transformer';
+import { Expose, Type } from 'class-transformer';
+import { cloudJobDataTransformer } from 'src/modules/cloud/job/transformers/cloud-job-data.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';
-
-export class CreateDatabaseCloudJobDataDto {
-  @ApiProperty({
-    description: 'Plan id for create a subscription.',
-    type: Number,
-  })
-  @IsNumber()
-  @IsNotEmpty()
-  planId: number;
-}
+import { CreateDatabaseCloudJobDataDto } from 'src/modules/cloud/job/dto/create-database.cloud-job.data.dto';
 
+@ApiExtraModels(CreateDatabaseCloudJobDataDto)
 export class CreateCloudJobDto {
   @ApiProperty({
     description: 'Job name to create',
@@ -45,13 +38,12 @@ export class CreateCloudJobDto {
     description: 'Any data for create a job.',
     oneOf: [
       { $ref: getSchemaPath(CreateDatabaseCloudJobDataDto) },
-      { $ref: getSchemaPath(undefined) },
     ],
-    type: cloudJobDataTransformer,
   })
-  @ValidateNested()
   @Expose()
-  @IsNotEmpty()
   @IsOptional()
-  data: CreateDatabaseCloudJobDataDto | undefined;
+  @IsNotEmptyObject()
+  @Type(cloudJobDataTransformer)
+  @ValidateNested()
+  data?: CreateDatabaseCloudJobDataDto;
 }
diff --git a/redisinsight/api/src/modules/cloud/job/dto/index.ts b/redisinsight/api/src/modules/cloud/job/dto/index.ts
diff --git a/redisinsight/api/src/modules/cloud/job/transformers/cloud-job-data.transformer.spec.ts b/redisinsight/api/src/modules/cloud/job/transformers/cloud-job-data.transformer.spec.ts
@@ -1,8 +1,7 @@
 import { TypeHelpOptions } from 'class-transformer';
 import { CloudJobName } from 'src/modules/cloud/job/constants';
-import { CreateDatabaseCloudJobDataDto } from '../dto';
-
-import { cloudJobDataTransformer } from './cloud-job-data.transformer';
+import { CreateDatabaseCloudJobDataDto } from 'src/modules/cloud/job/dto/create-database.cloud-job.data.dto';
+import { cloudJobDataTransformer } from 'src/modules/cloud/job/transformers/cloud-job-data.transformer';
 
 describe('cloudJobDataTransformer', () => {
   [
diff --git a/redisinsight/api/src/modules/cloud/job/transformers/cloud-job-data.transformer.ts b/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/create-database.cloud-job.data.dto';
+import { CloudJobName } from 'src/modules/cloud/job/constants';
 
 export const cloudJobDataTransformer = (data: TypeHelpOptions) => {
   const jobName = get(data?.object, 'name');
diff --git a/redisinsight/api/src/modules/cloud/user/cloud-user.controller.ts b/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')
diff --git a/redisinsight/api/src/modules/cloud/user/providers/cloud-user.api.provider.spec.ts b/redisinsight/api/src/modules/cloud/user/providers/cloud-user.api.provider.spec.ts
@@ -58,7 +58,50 @@ describe('CloudUserApiProvider', () => {
       mockedAxios.post.mockResolvedValue(response);
 
       expect(await service.getApiSessionId(mockCloudSession)).toEqual(mockCloudApiAuthDto.apiSessionId);
-      expect(mockedAxios.post).toHaveBeenCalledWith('login', {}, mockCloudApiHeaders);
+      expect(mockedAxios.post).toHaveBeenCalledWith('login', {}, {
+        ...mockCloudApiHeaders,
+        params: null,
+      });
+    });
+    it('successfully get api session id (login to api) with utm parameters', async () => {
+      const response = {
+        status: 200,
+        headers: { 'set-cookie': [`anything;JSESSIONID=${mockCloudApiAuthDto.apiSessionId};anything;`] },
+      };
+      mockedAxios.post.mockResolvedValue(response);
+
+      expect(await service.getApiSessionId(
+        mockCloudSession,
+        { source: 's', medium: 'm', campaign: 'c' },
+      )).toEqual(mockCloudApiAuthDto.apiSessionId);
+
+      expect(mockedAxios.post).toHaveBeenCalledWith('login', {}, {
+        ...mockCloudApiHeaders,
+        params: new URLSearchParams([
+          ['utm_source', 's'],
+          ['utm_medium', 'm'],
+          ['utm_campaign', 'c'],
+        ]),
+      });
+    });
+    it('successfully get api session id (login to api) with defined only utm parameters', async () => {
+      const response = {
+        status: 200,
+        headers: { 'set-cookie': [`anything;JSESSIONID=${mockCloudApiAuthDto.apiSessionId};anything;`] },
+      };
+      mockedAxios.post.mockResolvedValue(response);
+
+      expect(await service.getApiSessionId(
+        mockCloudSession,
+        { medium: 'm' },
+      )).toEqual(mockCloudApiAuthDto.apiSessionId);
+
+      expect(mockedAxios.post).toHaveBeenCalledWith('login', {}, {
+        ...mockCloudApiHeaders,
+        params: new URLSearchParams([
+          ['utm_medium', 'm'],
+        ]),
+      });
     });
     it('throw CloudApiUnauthorizedException exception', async () => {
       mockedAxios.post.mockRejectedValue(mockCapiUnauthorizedError);
diff --git a/redisinsight/api/src/modules/cloud/user/providers/cloud-user.api.provider.ts b/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(
diff --git a/redisinsight/ui/src/slices/interfaces/cloud.ts b/redisinsight/ui/src/slices/interfaces/cloud.ts
@@ -73,3 +73,15 @@ export enum OAuthSocialSource {
   TriggersAndFunctions = 'triggers_and_functions',
   'triggers and functions' = 'workbench triggers_and_functions',
 }
+
+export enum CloudSsoUtmCampaign {
+  ListOfDatabases = 'list_of_databases',
+  Workbench = 'redisinsight_workbench',
+  WelcomeScreen = 'welcome_screen',
+  BrowserSearch = 'redisinsight_browser_search',
+  BrowserOverview = 'redisinsight_browser_overview',
+  BrowserFilter = 'browser_filter',
+  GuidesAndTutorials = 'redisinsight_doc_guide',
+  TriggersAndFunctions = 'redisinsight_triggers_and_functions',
+  Unknown = 'other',
+}
diff --git a/redisinsight/ui/src/slices/oauth/cloud.ts b/redisinsight/ui/src/slices/oauth/cloud.ts
@@ -32,6 +32,7 @@ import {
 } from '../app/notifications'
 import { checkConnectToInstanceAction, setConnectedInstanceId } from '../instances/instances'
 import { setAppContextInitialState } from '../app/context'
+import { getCloudSsoUtmParams } from 'uiSrc/utils/oauth/cloudSsoUtm';
 
 export const initialState: StateAppOAuth = {
   loading: false,
@@ -261,11 +262,16 @@ export function createFreeDbSuccess(id: string, history: any) {
 
 // Asynchronous thunk action
 export function fetchUserInfo(onSuccessAction?: (isMultiAccount: boolean) => void, onFailAction?: () => void) {
-  return async (dispatch: AppDispatch) => {
+  return async (dispatch: AppDispatch, getState: () => RootState) => {
     dispatch(getUserInfo())
 
     try {
-      const { data, status } = await apiService.get<CloudUser>(ApiEndpoints.CLOUD_ME)
+      const { data, status } = await apiService.get<CloudUser>(
+        ApiEndpoints.CLOUD_ME,
+        {
+          params: getCloudSsoUtmParams(getState().oauth?.cloud?.source),
+        },
+      )
 
       if (isStatusSuccessful(status)) {
         const isMultiAccount = (data?.accounts?.length ?? 0) > 1
diff --git a/redisinsight/ui/src/utils/oauth/cloudSsoUtm.tsx b/redisinsight/ui/src/utils/oauth/cloudSsoUtm.tsx
diff --git a/redisinsight/ui/src/utils/tests/oauth/cloudSsoUtm.spec.tsx b/redisinsight/ui/src/utils/tests/oauth/cloudSsoUtm.spec.tsx
