#RI-5190 - hide sentinel password

Author: AmirAllayarovSofteq

redisinsight/api/src/modules/database/dto/database.response.ts

@@ -1,10 +1,11 @@
 import { ApiPropertyOptional, OmitType } from '@nestjs/swagger';
 import { Database } from 'src/modules/database/models/database';
-import { SshOptionsResponse } from 'src/modules/ssh/dto/ssh-options.response.';
+import { SshOptionsResponse } from 'src/modules/ssh/dto/ssh-options.response';
+import { SentinelMasterResponse } from 'src/modules/redis-sentinel/dto/sentinel.master.response.dto';
 import { Expose, Type } from 'class-transformer';
 import { HiddenField } from 'src/common/decorators/hidden-field.decorator';
 
-export class DatabaseResponse extends OmitType(Database, ['password', 'sshOptions'] as const) {
+export class DatabaseResponse extends OmitType(Database, ['password', 'sshOptions', 'sentinelMaster'] as const) {
   @ApiPropertyOptional({
     description: 'The database password flag (true if password was set)',
     type: Boolean,
@@ -20,4 +21,12 @@ export class DatabaseResponse extends OmitType(Database, ['password', 'sshOption
   @Expose()
   @Type(() => SshOptionsResponse)
   sshOptions?: SshOptionsResponse;
+
+  @ApiPropertyOptional({
+    description: 'Sentinel master',
+    type: SentinelMasterResponse,
+  })
+  @Expose()
+  @Type(() => SentinelMasterResponse)
+  sentinelMaster?: SentinelMasterResponse;
 }

redisinsight/api/src/modules/database/dto/update.database.dto.ts

@@ -6,10 +6,11 @@ import {
   IsInt, IsNotEmpty, IsNotEmptyObject, IsOptional, Max, Min, ValidateNested, ValidateIf, IsString, MaxLength,
 } from 'class-validator';
 import { UpdateSshOptionsDto } from 'src/modules/ssh/dto/update.ssh-options.dto';
+import { UpdateSentinelMasterDto } from 'src/modules/redis-sentinel/dto/update.sentinel.master.dto';
 import { CreateDatabaseDto } from 'src/modules/database/dto/create.database.dto';
 
 export class UpdateDatabaseDto extends PartialType(OmitType(CreateDatabaseDto, [
-  'sshOptions', 'timeout',
+  'sshOptions', 'timeout', 'sentinelMaster',
 ] as const)) {
   @ValidateIf((object, value) => value !== undefined)
   @IsString({ always: true })
@@ -45,4 +46,14 @@ export class UpdateDatabaseDto extends PartialType(OmitType(CreateDatabaseDto, [
   @Max(1_000_000_000)
   @IsInt({ always: true })
   timeout?: number;
+
+  @ApiPropertyOptional({
+    description: 'Updated sentinel master fields',
+  })
+  @Expose()
+  @IsOptional()
+  @IsNotEmptyObject()
+  @Type(() => UpdateSentinelMasterDto)
+  @ValidateNested()
+  sentinelMaster?: UpdateSentinelMasterDto;
 }

redisinsight/api/src/modules/redis-sentinel/dto/sentinel.master.response.dto.ts

@@ -0,0 +1,16 @@
+import { ApiPropertyOptional, OmitType } from '@nestjs/swagger';
+import { SentinelMaster } from 'src/modules/redis-sentinel/models/sentinel-master';
+import { Expose } from 'class-transformer';
+import { HiddenField } from 'src/common/decorators/hidden-field.decorator';
+
+export class SentinelMasterResponse extends OmitType(SentinelMaster, ['password'] as const) {
+  @ApiPropertyOptional({
+    description:
+    'The password for your Redis Sentinel master. '
+      + 'If your master doesn’t require a password, leave this field empty.',
+    type: Boolean,
+  })
+  @Expose()
+  @HiddenField(true)
+  password?: boolean;
+}

redisinsight/api/src/modules/redis-sentinel/dto/update.sentinel.master.dto.ts

@@ -0,0 +1,4 @@
+import { PickType } from '@nestjs/swagger';
+import { SentinelMaster } from 'src/modules/redis-sentinel/models/sentinel-master';
+
+export class UpdateSentinelMasterDto extends PickType(SentinelMaster, ['username', 'password'] as const) {}

redisinsight/api/src/modules/ssh/dto/ssh-options.response..ts renamed to redisinsight/api/src/modules/ssh/dto/ssh-options.response.ts

@@ -23,7 +23,7 @@ import {
   validatePortNumber,
   validateTimeoutNumber,
 } from 'uiSrc/utils'
-import { DbConnectionInfo, IPasswordType } from 'uiSrc/pages/home/interfaces'
+import { DbConnectionInfo } from 'uiSrc/pages/home/interfaces'
 
 interface IShowFields {
   alias: boolean
@@ -39,7 +39,6 @@ export interface Props {
   onHostNamePaste: (content: string) => boolean
   showFields: IShowFields
   autoFocus?: boolean
-  passwordType?: IPasswordType
 }
 
 const DatabaseForm = (props: Props) => {
@@ -50,7 +49,6 @@ const DatabaseForm = (props: Props) => {
     onHostNamePaste,
     autoFocus = false,
     showFields,
-    passwordType = IPasswordType.Password,
   } = props
 
   const { server } = useSelector(appInfoSelector)
@@ -185,7 +183,7 @@ const DatabaseForm = (props: Props) => {
         <EuiFlexItem className={flexItemClassName}>
           <EuiFormRow label="Password">
             <EuiFieldPassword
-              type={passwordType}
+              type="password"
               name="password"
               id="password"
               data-testid="password"

redisinsight/ui/src/pages/home/components/form/DatabaseForm.tsx

@@ -11,7 +11,9 @@ import {
 import { FormikProps } from 'formik'
 
 import { Nullable } from 'uiSrc/utils'
+import { SECURITY_FIELD } from 'uiSrc/constants'
 import { DbConnectionInfo } from 'uiSrc/pages/home/interfaces'
+
 import styles from '../../styles.module.scss'
 
 export interface Props {
@@ -53,16 +55,24 @@ const SentinelMasterDatabase = (props: Props) => {
         <EuiFlexItem className={flexItemClassName}>
           <EuiFormRow label="Password">
             <EuiFieldPassword
-              type="dual"
+              type="password"
               name="sentinelMasterPassword"
               id="sentinelMasterPassword"
               data-testid="sentinel-master-password"
               fullWidth
               className="passwordField"
               maxLength={200}
               placeholder="Enter Password"
-              value={formik.values.sentinelMasterPassword ?? ''}
+              value={formik.values.sentinelMasterPassword === true ? SECURITY_FIELD : formik.values.sentinelMasterPassword ?? ''}
               onChange={formik.handleChange}
+              onFocus={() => {
+                if (formik.values.sentinelMasterPassword === true) {
+                  formik.setFieldValue(
+                    'sentinelMasterPassword',
+                    '',
+                  )
+                }
+              }}
               dualToggleProps={{ color: 'text' }}
               autoComplete="new-password"
             />

redisinsight/ui/src/pages/home/components/form/sentinel/SentinelMasterDatabase.tsx

@@ -17,7 +17,7 @@ import {
   fieldDisplayNames,
 } from 'uiSrc/pages/home/constants'
 import { getFormErrors, getSubmitButtonContent } from 'uiSrc/pages/home/utils'
-import { DbConnectionInfo, ISubmitButton, IPasswordType } from 'uiSrc/pages/home/interfaces'
+import { DbConnectionInfo, ISubmitButton } from 'uiSrc/pages/home/interfaces'
 import {
   MessageSentinel,
   TlsDetails,
@@ -171,7 +171,6 @@ const SentinelConnectionForm = (props: Props) => {
             formik={formik}
             flexItemClassName={flexItemClassName}
             flexGroupClassName={flexGroupClassName}
-            passwordType={IPasswordType.dual}
             showFields={{ host: true, port: true, alias: false, timeout: false }}
             onHostNamePaste={onHostNamePaste}
           />

redisinsight/ui/src/pages/home/components/sentinel-connection/sentinel-connection-form/SentinelConnectionForm.tsx

@@ -23,7 +23,7 @@ export interface DbConnectionInfo extends Instance {
   showCompressor?: boolean
   sni?: boolean
   sentinelMasterUsername?: string
-  sentinelMasterPassword?: string
+  sentinelMasterPassword?: string | true
   sentinelMasterName?: string
   ssh?: boolean
   sshPassType?: string
@@ -40,8 +40,3 @@ export interface ISubmitButton {
   text?: string
   submitIsDisabled?: boolean
 }
-
-export enum IPasswordType {
-  Password = 'password',
-  Dual = 'dual',
-}