RI-6154 added tests

kchepikava · kchepikava · commit ea6fdca4eeed · 2024-10-16T23:00:55.000+02:00
diff --git a/redisinsight/api/migration/1729085495444-cloud-session.ts b/redisinsight/api/migration/1729085495444-cloud-session.ts
@@ -1,10 +1,10 @@
 import { MigrationInterface, QueryRunner } from "typeorm";
 
-export class CloudSession1729024196797 implements MigrationInterface {
-    name = 'CloudSession1729024196797'
+export class CloudSession1729085495444 implements MigrationInterface {
+    name = 'CloudSession1729085495444'
 
     public async up(queryRunner: QueryRunner): Promise<void> {
-        await queryRunner.query(`CREATE TABLE "cloud_session" ("id" integer PRIMARY KEY NOT NULL, "data" varchar, "encryption" varchar)`);
+        await queryRunner.query(`CREATE TABLE "cloud_session" ("id" varchar PRIMARY KEY NOT NULL, "data" varchar, "encryption" varchar)`);
     }
 
     public async down(queryRunner: QueryRunner): Promise<void> {
diff --git a/redisinsight/api/migration/index.ts b/redisinsight/api/migration/index.ts
@@ -42,7 +42,7 @@ import { AiHistory1713515657364 } from './1713515657364-ai-history';
 import { AiHistorySteps1714501203616 } from './1714501203616-ai-history-steps';
 import { Rdi1716370509836 } from './1716370509836-rdi';
 import { AiHistory1718260230164 } from './1718260230164-ai-history';
-import { CloudSession1729024196797 } from './1729024196797-cloud-session';
+import { CloudSession1729085495444 } from './1729085495444-cloud-session';
 
 export default [
   initialMigration1614164490968,
@@ -89,5 +89,5 @@ export default [
   AiHistorySteps1714501203616,
   Rdi1716370509836,
   AiHistory1718260230164,
-  CloudSession1729024196797,
+  CloudSession1729085495444,
 ];
diff --git a/redisinsight/api/src/__mocks__/cloud-session.ts b/redisinsight/api/src/__mocks__/cloud-session.ts
@@ -1,6 +1,9 @@
 import { ICloudApiCredentials } from 'src/modules/cloud/common/models';
 import { CloudAuthIdpType } from 'src/modules/cloud/auth/models';
 import { ICloudApiCsrfToken } from 'src/modules/cloud/user/models';
+import { CloudSessionData } from 'src/modules/cloud/session/models/cloud-session';
+import { CloudSessionEntity } from 'src/modules/cloud/session/entities/cloud.session.entity';
+import { EncryptionStrategy } from 'src/modules/encryption/models';
 
 export const mockCloudApiCsrfToken: ICloudApiCsrfToken = {
   csrf_token: 'csrf_p6vA6A5tF36Jf6twH2cBOqtt7n',
@@ -14,6 +17,17 @@ export const mockCloudApiAuthDto: ICloudApiCredentials = {
   apiSessionId: 'asid_p6v-A6A5tF36J-f6twH2cB!@#$_^&*()Oqtt7n',
 };
 
+export const mockCloudSessionData = Object.assign(new CloudSessionData(), {
+  id: '1',
+  data: { idpType: CloudAuthIdpType.Google },
+});
+
+export const mockCloudSessionEntity = Object.assign(new CloudSessionEntity(), {
+  ...mockCloudSessionData,
+  data: 'encryptedCloudSessionData',
+  encryption: EncryptionStrategy.KEYTAR,
+});
+
 export const mockCloudSession = {
   ...mockCloudApiAuthDto,
   user: {
@@ -32,6 +46,11 @@ export const mockCloudSession = {
   },
 };
 
+export const mockCloudSessionRepository = jest.fn(() => ({
+  get: jest.fn().mockResolvedValue(null),
+  save: jest.fn(),
+}));
+
 export const mockCloudSessionService = jest.fn(() => ({
   getSession: jest.fn().mockResolvedValue(mockCloudSession),
   updateSessionData: jest.fn().mockResolvedValue(mockCloudSession),
diff --git a/redisinsight/api/src/modules/cloud/auth/auth-strategy/sso-idp.cloud.auth-strategy.spec.ts b/redisinsight/api/src/modules/cloud/auth/auth-strategy/sso-idp.cloud.auth-strategy.spec.ts
@@ -7,7 +7,7 @@ import { OktaAuth } from '@okta/okta-auth-js';
 import { SsoIdpCloudAuthStrategy } from 'src/modules/cloud/auth/auth-strategy/sso-idp.cloud.auth-strategy';
 import { CloudAuthIdpType } from 'src/modules/cloud/auth/models';
 import {
-  CloudOauthSsoUnsupportedEmailException
+  CloudOauthSsoUnsupportedEmailException,
 } from 'src/modules/cloud/auth/exceptions/cloud-oauth.sso-unsupported-email.exception';
 
 jest.mock('@okta/okta-auth-js');
diff --git a/redisinsight/api/src/modules/cloud/auth/cloud-auth.module.ts b/redisinsight/api/src/modules/cloud/auth/cloud-auth.module.ts
@@ -8,7 +8,7 @@ import { CloudAuthController } from 'src/modules/cloud/auth/cloud-auth.controlle
 import { CloudAuthAnalytics } from 'src/modules/cloud/auth/cloud-auth.analytics';
 
 @Module({
-  imports: [CloudSessionModule.register()],
+  imports: [CloudSessionModule],
   providers: [
     GoogleIdpCloudAuthStrategy,
     GithubIdpCloudAuthStrategy,
diff --git a/redisinsight/api/src/modules/cloud/auth/cloud-auth.service.spec.ts b/redisinsight/api/src/modules/cloud/auth/cloud-auth.service.spec.ts
@@ -345,6 +345,7 @@ describe('CloudAuthService', () => {
         {
           accessToken: mockCloudAccessTokenNew,
           refreshToken: mockCloudRefreshTokenNew,
+          idpType: mockCloudApiAuthDto.idpType,
           csrf: null,
           apiSessionId: null,
         },
diff --git a/redisinsight/api/src/modules/cloud/capi-key/cloud-capi-key.module.ts b/redisinsight/api/src/modules/cloud/capi-key/cloud-capi-key.module.ts
@@ -11,7 +11,7 @@ import { CloudCapiKeyAnalytics } from 'src/modules/cloud/capi-key/cloud-capi-key
 @Module({
   imports: [
     CloudUserModule,
-    CloudSessionModule.register(),
+    CloudSessionModule,
   ],
   controllers: [CloudCapiKeyController],
   providers: [
diff --git a/redisinsight/api/src/modules/cloud/cloud.module.ts b/redisinsight/api/src/modules/cloud/cloud.module.ts
@@ -5,13 +5,15 @@ import { CloudUserModule } from 'src/modules/cloud/user/cloud-user.module';
 import { CloudTaskModule } from 'src/modules/cloud/task/cloud-task.module';
 import { CloudJobModule } from 'src/modules/cloud/job/cloud-job.module';
 import { CloudCapiKeyModule } from 'src/modules/cloud/capi-key/cloud-capi-key.module';
+import { CloudSessionModule } from './session/cloud-session.module';
 
 @Module({})
 export class CloudModule {
   static register() {
     return {
       module: CloudModule,
       imports: [
+        CloudSessionModule.register(),
         CloudAuthModule,
         CloudUserModule,
         CloudAutodiscoveryModule,
diff --git a/redisinsight/api/src/modules/cloud/session/cloud-session.module.ts b/redisinsight/api/src/modules/cloud/session/cloud-session.module.ts
@@ -1,9 +1,9 @@
-import { Module, Type } from '@nestjs/common';
+import { Global, Type } from '@nestjs/common';
 import { CloudSessionService } from 'src/modules/cloud/session/cloud-session.service';
 import { CloudSessionRepository } from './repositories/cloud.session.repository';
 import { LocalCloudSessionRepository } from './repositories/local.cloud.session.repository';
 
-@Module({})
+@Global()
 export class CloudSessionModule {
   static register(
     cloudSessionRepository: Type<CloudSessionRepository> = LocalCloudSessionRepository,
diff --git a/redisinsight/api/src/modules/cloud/session/cloud-session.service.spec.ts b/redisinsight/api/src/modules/cloud/session/cloud-session.service.spec.ts
@@ -4,11 +4,13 @@ import {
 } from 'src/__mocks__';
 import { SessionService } from 'src/modules/session/session.service';
 import { CloudSessionService } from 'src/modules/cloud/session/cloud-session.service';
-import { mockCloudSession } from 'src/__mocks__/cloud-session';
+import { mockCloudSession, mockCloudSessionRepository } from 'src/__mocks__/cloud-session';
+import { CloudSessionRepository } from './repositories/cloud.session.repository';
 
 describe('CloudSessionService', () => {
   let service: CloudSessionService;
   let sessionService: MockType<SessionService>;
+  let cloudSessionRepository: MockType<CloudSessionRepository>;
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
@@ -18,11 +20,16 @@ describe('CloudSessionService', () => {
           provide: SessionService,
           useFactory: mockSessionService,
         },
+        {
+          provide: CloudSessionRepository,
+          useFactory: mockCloudSessionRepository,
+        },
       ],
     }).compile();
 
     service = module.get(CloudSessionService);
     sessionService = module.get(SessionService);
+    cloudSessionRepository = module.get(CloudSessionRepository);
   });
 
   describe('getSession', () => {
@@ -32,6 +39,18 @@ describe('CloudSessionService', () => {
       expect(result).toEqual(null);
     });
 
+    it('should take some additional data in repository if it is not in session', async () => {
+      cloudSessionRepository.get.mockResolvedValueOnce({ id: 1, data: { idpType: 'test' } });
+      const result = await service.getSession(mockInitSession.id);
+      expect(result.idpType).toBe('test');
+    });
+
+    it('should not fail if data in repository is null', async () => {
+      cloudSessionRepository.get.mockResolvedValueOnce({ id: 1, data: null });
+      const result = await service.getSession(mockInitSession.id);
+      expect(result).toEqual(null);
+    });
+
     it('Should return cloud data only', async () => {
       sessionService.getSession.mockResolvedValueOnce({
         data: {
@@ -60,6 +79,14 @@ describe('CloudSessionService', () => {
         cloud: mockCloudSession,
       });
     });
+
+    it('Should update data in cloud sesssion repository when necessary fields included', async () => {
+      sessionService.updateSessionData.mockResolvedValue({ data: { cloud: mockCloudSession } });
+      await service.updateSessionData(mockInitSession.id, mockCloudSession);
+
+      expect(cloudSessionRepository.save).toHaveBeenCalled();
+    });
+
     it('Should merge and update cloud data', async () => {
       sessionService.getSession.mockResolvedValueOnce({
         data: {
@@ -93,9 +120,10 @@ describe('CloudSessionService', () => {
   });
 
   describe('deleteSession', () => {
-    it('should delete cloud session data by id', async () => {
+    it('should delete cloud session data by id and clear cloud session repository data', async () => {
       await service.deleteSessionData(mockInitSession.id);
       expect(sessionService.updateSessionData).toHaveBeenCalledWith(mockInitSession.id, { cloud: null });
+      expect(cloudSessionRepository.save).toHaveBeenCalledWith({ data: null });
     });
   });
 
diff --git a/redisinsight/api/src/modules/cloud/session/cloud-session.service.ts b/redisinsight/api/src/modules/cloud/session/cloud-session.service.ts
@@ -31,7 +31,7 @@ export class CloudSessionService {
         // ignore
       }
     }
-    return cloud;
+    return cloud || null;
   }
 
   async updateSessionData(id: string, cloud: any): Promise<CloudSession> {
diff --git a/redisinsight/api/src/modules/cloud/session/entities/cloud.session.entity.ts b/redisinsight/api/src/modules/cloud/session/entities/cloud.session.entity.ts
@@ -6,7 +6,7 @@ import { Column, Entity } from 'typeorm';
 export class CloudSessionEntity {
   @Column({ nullable: false, primary: true })
   @Expose()
-  id: number;
+  id: string;
 
   @Column({ nullable: true })
   @DataAsJsonString()
diff --git a/redisinsight/api/src/modules/cloud/session/models/cloud-session.ts b/redisinsight/api/src/modules/cloud/session/models/cloud-session.ts
@@ -1,18 +1,24 @@
 import { CloudUser } from 'src/modules/cloud/user/models';
 import { CloudAuthIdpType } from 'src/modules/cloud/auth/models';
-import { Expose } from 'class-transformer';
+import { Expose, Type } from 'class-transformer';
 
 export class CloudSession {
+  @Expose()
   accessToken?: string;
 
+  @Expose()
   refreshToken?: string;
 
+  @Expose()
   idpType?: CloudAuthIdpType;
 
+  @Expose()
   csrf?: string;
 
+  @Expose()
   apiSessionId?: string;
 
+  @Expose()
   user?: CloudUser;
 }
 
@@ -21,5 +27,6 @@ export class CloudSessionData {
   id: number;
 
   @Expose()
+  @Type(() => CloudSession)
   data: CloudSession;
 }
diff --git a/redisinsight/api/src/modules/cloud/session/repositories/local.cloud.session.repository.spec.ts b/redisinsight/api/src/modules/cloud/session/repositories/local.cloud.session.repository.spec.ts
@@ -1 +1,78 @@
-// TODO
+import {
+  MockType, mockCloudSessionData, mockCloudSessionEntity, mockEncryptionService, mockRepository,
+} from 'src/__mocks__';
+import { Repository } from 'typeorm';
+import { EncryptionService } from 'src/modules/encryption/encryption.service';
+import { Test, TestingModule } from '@nestjs/testing';
+import { getRepositoryToken } from '@nestjs/typeorm';
+import { when } from 'jest-when';
+import { LocalCloudSessionRepository } from './local.cloud.session.repository';
+import { CloudSessionEntity } from '../entities/cloud.session.entity';
+import { CloudAuthIdpType } from '../../auth/models';
+
+describe('LocalCloudSessionRepository', () => {
+  let service: LocalCloudSessionRepository;
+  let repository: MockType<Repository<CloudSessionEntity>>;
+  let encryptionService: MockType<EncryptionService>;
+
+  beforeEach(async () => {
+    jest.clearAllMocks();
+
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        LocalCloudSessionRepository,
+        {
+          provide: getRepositoryToken(CloudSessionEntity),
+          useFactory: mockRepository,
+        },
+        {
+          provide: EncryptionService,
+          useFactory: mockEncryptionService,
+        },
+      ],
+    }).compile();
+
+    service = module.get(LocalCloudSessionRepository);
+    encryptionService = module.get(EncryptionService);
+    repository = module.get(getRepositoryToken(CloudSessionEntity));
+
+    encryptionService.decrypt.mockImplementation((value) => value);
+    when(encryptionService.decrypt)
+      .calledWith(mockCloudSessionEntity.data, jasmine.anything())
+      .mockResolvedValue(JSON.stringify(mockCloudSessionData.data));
+
+    encryptionService.encrypt.mockImplementation((value) => value);
+    when(encryptionService.encrypt)
+      .calledWith(JSON.stringify(mockCloudSessionData.data))
+      .mockResolvedValue({ data: mockCloudSessionEntity.data, encryption: mockCloudSessionEntity.encryption });
+  });
+
+  describe('get', () => {
+    it('should return null if no cloud session data in the repository', async () => {
+      await expect(service.get()).resolves.toEqual(null);
+    });
+
+    it('should return cloudSession data if it is in the repository', async () => {
+      repository.findOneBy.mockResolvedValue(mockCloudSessionEntity);
+      await expect(service.get()).resolves.toEqual(mockCloudSessionData);
+    });
+  });
+
+  describe('save', () => {
+    it('should upsert data into repository', async () => {
+      repository.upsert.mockResolvedValue(mockCloudSessionEntity);
+
+      await expect(service.save({ data: { idpType: CloudAuthIdpType.Google } })).resolves.toEqual(undefined);
+    });
+
+    it('encrypts the data before upsertion', async () => {
+      await service.save({ data: { idpType: CloudAuthIdpType.Google } });
+
+      expect(repository.upsert).toHaveBeenCalledWith(mockCloudSessionEntity, ['id']);
+    });
+
+    it('not fail when null data is stored', async () => {
+      await expect(service.save({ data: null })).resolves.toEqual(undefined);
+    });
+  });
+});
diff --git a/redisinsight/api/src/modules/cloud/session/repositories/local.cloud.session.repository.ts b/redisinsight/api/src/modules/cloud/session/repositories/local.cloud.session.repository.ts
@@ -1,14 +1,14 @@
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
 import { classToClass } from 'src/utils';
-// import { SessionMetadata } from 'src/common/models';
 import { EncryptionService } from 'src/modules/encryption/encryption.service';
 import { ModelEncryptor } from 'src/modules/encryption/model.encryptor';
+import { plainToClass } from 'class-transformer';
 import { CloudSessionRepository } from './cloud.session.repository';
 import { CloudSessionEntity } from '../entities/cloud.session.entity';
 import { CloudSessionData } from '../models/cloud-session';
 
-const SESSION_ID = 1;
+const SESSION_ID = '1';
 
 export class LocalCloudSessionRepository extends CloudSessionRepository {
   private readonly modelEncryptor: ModelEncryptor;
@@ -30,12 +30,13 @@ export class LocalCloudSessionRepository extends CloudSessionRepository {
     }
 
     const decrypted = await this.modelEncryptor.decryptEntity(entity, false);
+
     return classToClass(CloudSessionData, decrypted);
   }
 
   async save(cloudAuth: Partial<CloudSessionData>): Promise<void> {
     const entity = await this.modelEncryptor.encryptEntity(
-      classToClass(CloudSessionEntity, { id: SESSION_ID, ...cloudAuth }),
+      plainToClass(CloudSessionEntity, { ...cloudAuth, id: SESSION_ID }),
     );
 
     await this.repository.upsert(entity, ['id']);
diff --git a/redisinsight/api/src/modules/cloud/subscription/cloud-subscription.module.ts b/redisinsight/api/src/modules/cloud/subscription/cloud-subscription.module.ts
@@ -11,7 +11,7 @@ import { CloudSubscriptionCapiProvider } from './providers/cloud-subscription.ca
 @Module({
   imports: [
     CloudUserModule,
-    CloudSessionModule.register(),
+    CloudSessionModule,
     CloudCapiKeyModule,
   ],
   providers: [
diff --git a/redisinsight/api/src/modules/cloud/user/cloud-user.module.ts b/redisinsight/api/src/modules/cloud/user/cloud-user.module.ts
@@ -11,7 +11,7 @@ import { CloudAuthModule } from 'src/modules/cloud/auth/cloud-auth.module';
 
 @Global()
 @Module({
-  imports: [CloudSessionModule.register(), CloudAuthModule],
+  imports: [CloudSessionModule, CloudAuthModule],
   providers: [
     CloudUserApiProvider,
     CloudUserCapiProvider,
diff --git a/redisinsight/api/src/modules/cloud/user/utils/token.spec.ts b/redisinsight/api/src/modules/cloud/user/utils/token.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -345,6 +345,7 @@ describe('CloudAuthService', () => {`
`345`	`345`	`{`
`346`	`346`	`accessToken: mockCloudAccessTokenNew,`
`347`	`347`	`refreshToken: mockCloudRefreshTokenNew,`
	`348`	`+ idpType: mockCloudApiAuthDto.idpType,`
`348`	`349`	`csrf: null,`
`349`	`350`	`apiSessionId: null,`
`350`	`351`	`},`