Merge pull request #3957 from RedisInsight/be/feature/RI-6154-updates-in-cloud-session

RI-6154 updates in cloud session

Author: mariasergeenko

redisinsight/api/config/ormconfig.ts

@@ -21,6 +21,7 @@ import { CloudDatabaseDetailsEntity } from 'src/modules/cloud/database/entities/
 import { CloudCapiKeyEntity } from 'src/modules/cloud/capi-key/entity/cloud-capi-key.entity';
 import { RdiEntity } from 'src/modules/rdi/entities/rdi.entity';
 import { AiQueryMessageEntity } from 'src/modules/ai/query/entities/ai-query.message.entity';
+import { CloudSessionEntity } from 'src/modules/cloud/session/entities/cloud.session.entity';
 import migrations from '../migration';
 import * as config from '../src/utils/config';
 
@@ -52,6 +53,7 @@ const ormConfig = {
     CloudCapiKeyEntity,
     RdiEntity,
     AiQueryMessageEntity,
+    CloudSessionEntity,
   ],
   migrations,
 };

redisinsight/api/migration/1729085495444-cloud-session.ts

@@ -0,0 +1,14 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class CloudSession1729085495444 implements MigrationInterface {
+    name = 'CloudSession1729085495444'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`CREATE TABLE "cloud_session" ("id" varchar PRIMARY KEY NOT NULL, "data" varchar, "encryption" varchar)`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP TABLE "cloud_session"`);
+    }
+
+}

redisinsight/api/migration/index.ts

@@ -42,6 +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 { CloudSession1729085495444 } from './1729085495444-cloud-session';
 import { CommandExecution1726058563737 } from './1726058563737-command-execution';
 
 export default [
@@ -89,5 +90,6 @@ export default [
   AiHistorySteps1714501203616,
   Rdi1716370509836,
   AiHistory1718260230164,
+  CloudSession1729085495444,
   CommandExecution1726058563737,
 ];

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),

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');

redisinsight/api/src/modules/cloud/auth/cloud-auth.service.spec.ts

@@ -41,7 +41,7 @@ import { CloudSsoFeatureStrategy } from 'src/modules/cloud/cloud-sso.feature.fla
 import { CloudApiUnauthorizedException } from 'src/modules/cloud/common/exceptions';
 import { SsoIdpCloudAuthStrategy } from 'src/modules/cloud/auth/auth-strategy/sso-idp.cloud.auth-strategy';
 import {
-  CloudOauthSsoUnsupportedEmailException
+  CloudOauthSsoUnsupportedEmailException,
 } from 'src/modules/cloud/auth/exceptions/cloud-oauth.sso-unsupported-email.exception';
 
 const mockedAxios = axios as jest.Mocked<typeof axios>;
@@ -255,7 +255,9 @@ describe('CloudAuthService', () => {
           error: 'access_denied',
           error_description: 'Some required properties are missing: email and lastName',
         },
-      )).rejects.toThrow(new CloudOauthMissedRequiredDataException('Some required properties are missing: email and lastName'));
+      )).rejects.toThrow(
+        new CloudOauthMissedRequiredDataException('Some required properties are missing: email and lastName'),
+      );
     });
     it('should throw an error if request not found', async () => {
       expect(service['authRequests'].size).toEqual(1);
@@ -343,6 +345,7 @@ describe('CloudAuthService', () => {
         {
           accessToken: mockCloudAccessTokenNew,
           refreshToken: mockCloudRefreshTokenNew,
+          idpType: mockCloudApiAuthDto.idpType,
           csrf: null,
           apiSessionId: null,
         },

redisinsight/api/src/modules/cloud/auth/cloud-auth.service.ts

@@ -204,7 +204,6 @@ export class CloudAuthService {
   private async revokeRefreshToken(sessionMetadata: SessionMetadata): Promise<void> {
     try {
       const session = await this.sessionService.getSession(sessionMetadata.sessionId);
-
       if (!session?.refreshToken) {
         return;
       }
@@ -274,6 +273,7 @@ export class CloudAuthService {
       await this.sessionService.updateSessionData(sessionMetadata.sessionId, {
         accessToken: data.access_token,
         refreshToken: data.refresh_token,
+        idpType,
         csrf: null,
         apiSessionId: null,
       });

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,

redisinsight/api/src/modules/cloud/session/cloud-session.module.ts

@@ -1,8 +1,23 @@
-import { Module } 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({
-  providers: [CloudSessionService],
-  exports: [CloudSessionService],
-})
-export class CloudSessionModule {}
+@Global()
+export class CloudSessionModule {
+  static register(
+    cloudSessionRepository: Type<CloudSessionRepository> = LocalCloudSessionRepository,
+  ) {
+    return {
+      module: CloudSessionModule,
+      providers: [
+        CloudSessionService,
+        {
+          provide: CloudSessionRepository,
+          useClass: cloudSessionRepository,
+        },
+      ],
+      exports: [CloudSessionService],
+    };
+  }
+}

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 });
     });
   });