RI-7091 - add an environment variable to skip the eula screen

configs/webpack.config.main.prod.ts

@@ -68,6 +68,7 @@ export default merge(baseConfig, {
       RI_APP_HOST: '127.0.0.1',
       RI_BUILD_TYPE: 'ELECTRON',
       RI_APP_VERSION: version,
+      RI_ACCEPT_TERMS_AND_CONDITIONS: process.env.RI_ACCEPT_TERMS_AND_CONDITIONS || 'false',
       RI_SEGMENT_WRITE_KEY:
         'RI_SEGMENT_WRITE_KEY' in process.env
           ? process.env.RI_SEGMENT_WRITE_KEY

redisinsight/api/config/default.ts

@@ -94,6 +94,8 @@ export default {
     secretStoragePassword: process.env.RI_SECRET_STORAGE_PASSWORD,
     agreementsPath: process.env.RI_AGREEMENTS_PATH,
     encryptionKey: process.env.RI_ENCRYPTION_KEY,
+    acceptTermsAndConditions:
+      process.env.RI_ACCEPT_TERMS_AND_CONDITIONS === 'true',
     tlsCert: process.env.RI_SERVER_TLS_CERT,
     tlsKey: process.env.RI_SERVER_TLS_KEY,
     staticContent: !!process.env.RI_SERVE_STATICS || true,

redisinsight/api/src/constants/agreements-spec.json

@@ -11,7 +11,7 @@
       "since": "1.0.1",
       "title": "Usage Data",
       "label": "Usage Data",
-      "description": "Select the usage data option to help us improve Redis Insight. We use such usage data to understand how Redis Insight features are used, prioritize new features, and enhance the user experience."
+      "description": "Help improve Redis Insight by sharing anonymous usage data. This helps us understand feature usage and make the app better. By enabling this, you agree to our "
     },
     "notifications": {
       "defaultValue": false,

redisinsight/api/src/modules/settings/dto/settings.dto.ts

@@ -114,6 +114,15 @@ export class GetAppSettingsResponse {
   @Default(WORKBENCH_CONFIG.countBatch)
   batchSize: number = WORKBENCH_CONFIG.countBatch;
 
+  @ApiProperty({
+    description: 'Flag indicating that terms and conditions are accepted via environment variable',
+    type: Boolean,
+    example: false,
+  })
+  @Expose()
+  @Default(false)
+  acceptTermsAndConditionsOverwritten: boolean = false;
+
   @ApiProperty({
     description: 'Agreements set by the user.',
     type: GetUserAgreementsResponse,

redisinsight/api/src/modules/settings/repositories/agreements.repository.ts

@@ -1,8 +1,12 @@
 import { Agreements } from 'src/modules/settings/models/agreements';
 import { SessionMetadata } from 'src/common/models';
 
+export interface DefaultAgreementsOptions {
+  data?: Record<string, boolean>;
+}
+
 export abstract class AgreementsRepository {
-  abstract getOrCreate(sessionMetadata: SessionMetadata): Promise<Agreements>;
+  abstract getOrCreate(defaultOptions?: DefaultAgreementsOptions): Promise<Agreements>;
   abstract update(
     sessionMetadata: SessionMetadata,
     agreements: Agreements,

redisinsight/api/src/modules/settings/repositories/local.agreements.repository.spec.ts

@@ -72,6 +72,18 @@ describe('LocalAgreementsRepository', () => {
 
       await expect(service.getOrCreate()).rejects.toThrow(Error);
     });
+    it('should create new agreements with default data when provided and no entity exists', async () => {
+      repository.findOneBy.mockResolvedValueOnce(null);
+      const defaultData = { eula: true, analytics: false };
+
+      await service.getOrCreate({ data: defaultData });
+
+      expect(repository.create).toHaveBeenCalledWith({
+        id: 1,
+        data: JSON.stringify(defaultData),
+      });
+      expect(repository.save).toHaveBeenCalled();
+    });
   });
 
   describe('update', () => {

redisinsight/api/src/modules/settings/repositories/local.agreements.repository.ts

@@ -1,7 +1,7 @@
 import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
 import { classToClass } from 'src/utils';
-import { AgreementsRepository } from 'src/modules/settings/repositories/agreements.repository';
+import { AgreementsRepository, DefaultAgreementsOptions } from 'src/modules/settings/repositories/agreements.repository';
 import { AgreementsEntity } from 'src/modules/settings/entities/agreements.entity';
 import { Agreements } from 'src/modules/settings/models/agreements';
 import { SessionMetadata } from 'src/common/models';
@@ -14,12 +14,22 @@ export class LocalAgreementsRepository extends AgreementsRepository {
     super();
   }
 
-  async getOrCreate(): Promise<Agreements> {
+  async getOrCreate(
+    defaultOptions?: DefaultAgreementsOptions
+  ): Promise<Agreements> {
     let entity = await this.repository.findOneBy({});
-
     if (!entity) {
       try {
-        entity = await this.repository.save(this.repository.create({ id: 1 }));
+        if (defaultOptions?.data) {
+          entity = await this.repository.save(
+            this.repository.create({
+              id: 1,
+              data: JSON.stringify(defaultOptions.data),
+            })
+          );
+        } else {
+          entity = await this.repository.save(this.repository.create({ id: 1 }));
+        }
       } catch (e) {
         if (e.code === 'SQLITE_CONSTRAINT') {
           return this.getOrCreate();

redisinsight/api/src/modules/settings/settings.analytics.spec.ts

@@ -131,6 +131,7 @@ describe('SettingsAnalytics', () => {
 
   describe('sendSettingsUpdatedEvent', () => {
     const defaultSettings: GetAppSettingsResponse = {
+      acceptTermsAndConditionsOverwritten: false,
       agreements: null,
       scanThreshold: 10000,
       batchSize: 5,

redisinsight/api/src/modules/settings/settings.service.spec.ts

@@ -29,6 +29,9 @@ import { FeatureServerEvents } from 'src/modules/feature/constants';
 import { KeyEncryptionStrategy } from 'src/modules/encryption/strategies/key-encryption.strategy';
 import { DatabaseDiscoveryService } from 'src/modules/database-discovery/database-discovery.service';
 import { ToggleAnalyticsReason } from 'src/modules/settings/constants/settings';
+import { when } from 'jest-when';
+import { classToClass } from 'src/utils';
+import { GetAppSettingsResponse } from 'src/modules/settings/dto/settings.dto';
 
 const REDIS_SCAN_CONFIG = config.get('redis_scan');
 const WORKBENCH_CONFIG = config.get('workbench');
@@ -48,6 +51,7 @@ describe('SettingsService', () => {
 
   beforeEach(async () => {
     jest.clearAllMocks();
+
     const module: TestingModule = await Test.createTestingModule({
       providers: [
         SettingsService,
@@ -107,6 +111,7 @@ describe('SettingsService', () => {
         dateFormat: null,
         timezone: null,
         agreements: null,
+        acceptTermsAndConditionsOverwritten: false,
       });
 
       expect(eventEmitter.emit).not.toHaveBeenCalled();
@@ -120,13 +125,41 @@ describe('SettingsService', () => {
 
       expect(result).toEqual({
         ...mockSettings.data,
+        acceptTermsAndConditionsOverwritten: false,
         agreements: {
           version: mockAgreements.version,
           ...mockAgreements.data,
         },
       });
     });
 
+    it('should verify expected pre-accepted agreements format', async () => {
+      const preselectedAgreements = {
+        analytics: false,
+        encryption: true,
+        eula: true,
+        notifications: false,
+        acceptTermsAndConditionsOverwritten: true,
+      };
+      settingsRepository.getOrCreate.mockResolvedValue(mockSettings);
+
+      // Create a custom instance of the service with an override method
+      const customService = {
+        // Preserve the same data structure expected from the method
+        getAppSettings: async () => classToClass(GetAppSettingsResponse, {
+          ...mockSettings.data,
+          agreements: preselectedAgreements,
+        }),
+      };
+
+      // Call the customized method
+      const result = await customService.getAppSettings();
+
+      // Verify the result matches the expected format when acceptTermsAndConditions is true
+      expect(result).toHaveProperty('agreements');
+      expect(result.agreements).toEqual(preselectedAgreements);
+    });
+
     it('should throw InternalServerError', async () => {
       agreementsRepository.getOrCreate.mockRejectedValue(
         new Error('some error'),

redisinsight/api/src/modules/settings/settings.service.ts

@@ -56,16 +56,40 @@ export class SettingsService {
   ): Promise<GetAppSettingsResponse> {
     this.logger.debug('Getting application settings.', sessionMetadata);
     try {
-      const agreements =
-        await this.agreementRepository.getOrCreate(sessionMetadata);
       const settings =
         await this.settingsRepository.getOrCreate(sessionMetadata);
+
+      let agreements;
+      if (SERVER_CONFIG.acceptTermsAndConditions) {
+        const isEncryptionAvailable =
+          (await this.keyEncryptionStrategy.isAvailable()) ||
+          (await this.keytarEncryptionStrategy.isAvailable());
+
+        const defaultOptions = {
+          data: {
+            analytics: false,
+            encryption: isEncryptionAvailable,
+            eula: true,
+            notifications: false,
+          }
+        };
+
+        agreements = await this.agreementRepository.getOrCreate(
+          defaultOptions
+        );
+      } else {
+        agreements = await this.agreementRepository.getOrCreate();
+      }
+
       this.logger.debug(
         'Succeed to get application settings.',
         sessionMetadata,
       );
+
+
       return classToClass(GetAppSettingsResponse, {
         ...settings?.data,
+        acceptTermsAndConditionsOverwritten: SERVER_CONFIG.acceptTermsAndConditions,
         agreements: agreements?.version
           ? {
               ...agreements?.data,

redisinsight/ui/src/components/config/Config.spec.tsx

@@ -332,4 +332,35 @@ describe('Config', () => {
       ]),
     )
   })
+
+  it('should not show consent popup when acceptTermsAndConditionsOverwritten is true, regardless of consent differences', () => {
+    const userSettingsSelectorMock = jest.fn().mockReturnValue({
+      config: {
+        acceptTermsAndConditionsOverwritten: true,
+        agreements: {}, // Empty agreements - would normally cause a popup
+      },
+      spec: {
+        agreements: {
+          eula: {
+            defaultValue: false,
+            required: true,
+            editable: false,
+            since: '1.0.0',
+            title: 'EULA: Redis Insight License Terms',
+            label: 'Label',
+          },
+        },
+      },
+    })
+    userSettingsSelector.mockImplementation(userSettingsSelectorMock)
+
+    render(<Config />)
+
+    // Check that setSettingsPopupState is called with false
+    expect(store.getActions()).toEqual(
+      expect.arrayContaining([
+        setSettingsPopupState(false),
+      ])
+    )
+  })
 })

redisinsight/ui/src/components/config/Config.tsx

@@ -201,10 +201,9 @@ const Config = () => {
   const checkSettingsToShowPopup = () => {
     const specConsents = spec?.agreements
     const appliedConsents = config?.agreements
-
     dispatch(
       setSettingsPopupState(
-        isDifferentConsentsExists(specConsents, appliedConsents),
+        config?.acceptTermsAndConditionsOverwritten ? false : isDifferentConsentsExists(specConsents, appliedConsents),
       ),
     )
   }

redisinsight/ui/src/components/consents-settings/ConsentOption/ConsentOption.tsx

@@ -1,5 +1,5 @@
 import React from 'react'
-import { EuiSwitch, EuiText } from '@elastic/eui'
+import { EuiLink, EuiSwitch, EuiText } from '@elastic/eui'
 import parse from 'html-react-parser'
 
 import { FlexItem, Row } from 'uiSrc/components/base/layout/flex'
@@ -14,6 +14,7 @@ interface Props {
   checked: boolean
   isSettingsPage?: boolean
   withoutSpacer?: boolean
+  linkToPrivacyPolicy?: boolean
 }
 
 const ConsentOption = (props: Props) => {
@@ -23,7 +24,27 @@ const ConsentOption = (props: Props) => {
     checked,
     isSettingsPage = false,
     withoutSpacer = false,
+    linkToPrivacyPolicy = false,
   } = props
+
+  const getText = () => (
+    <>
+      {consent.description && parse(consent.description)}
+      {linkToPrivacyPolicy && (
+        <>
+          <EuiLink
+            external={false}
+            target="_blank"
+            href="https://redis.io/legal/privacy-policy/?utm_source=redisinsight&utm_medium=app&utm_campaign=telemetry"
+          >
+            Privacy Policy
+          </EuiLink>
+          .
+        </>
+      )}
+    </>
+  )
+
   return (
     <FlexItem key={consent.agreementName} grow>
       {isSettingsPage && consent.description && (
@@ -34,7 +55,7 @@ const ConsentOption = (props: Props) => {
             color="subdued"
             style={{ marginTop: '12px' }}
           >
-            {parse(consent.description)}
+            {getText()}
           </EuiText>
           <Spacer size="m" />
         </>
@@ -62,7 +83,7 @@ const ConsentOption = (props: Props) => {
               color="subdued"
               style={{ marginTop: '12px' }}
             >
-              {parse(consent.description)}
+              {getText()}
             </EuiText>
           )}
         </FlexItem>

redisinsight/ui/src/components/consents-settings/ConsentsPrivacy/ConsentsPrivacy.tsx

@@ -97,6 +97,7 @@ const ConsentsPrivacy = () => {
             onChangeAgreement={onChangeAgreement}
             isSettingsPage
             key={consent.agreementName}
+            linkToPrivacyPolicy
           />
         ))}
       </div>

redisinsight/ui/src/components/consents-settings/ConsentsSettings.tsx

@@ -287,6 +287,7 @@ const ConsentsSettings = ({ onSubmitted }: Props) => {
             checked={formik.values[consent.agreementName] ?? false}
             onChangeAgreement={onChangeAgreement}
             key={consent.agreementName}
+            linkToPrivacyPolicy
           />
         ))}
         {!!notificationConsents.length && (
@@ -312,7 +313,15 @@ const ConsentsSettings = ({ onSubmitted }: Props) => {
           <HorizontalRule margin="l" className={styles.requiredHR} />
           <Spacer size="m" />
           <EuiText color="subdued" size="s" className={styles.smallText}>
-            To use Redis Insight, please accept the terms and conditions:{' '}
+            Use of Redis Insight is governed by your signed agreement with Redis, or, if none, by the{' '}
+            <EuiLink
+              external={false}
+              target="_blank"
+              href="https://redis.io/software-subscription-agreement/?utm_source=redisinsight&utm_medium=app&utm_campaign=EULA"
+            >
+              Redis Enterprise Software Subscription Agreement
+            </EuiLink>
+            . If no agreement applies, use is subject to the{' '}
             <EuiLink
               external={false}
               target="_blank"

redisinsight/ui/src/utils/comparisons/compareConsents.ts

@@ -2,8 +2,7 @@ import { has } from 'lodash'
 import { isVersionHigher } from 'uiSrc/utils/comparisons/compareVersions'
 
 // returns true if has different consents
-export const isDifferentConsentsExists = (specs: any, applied: any) =>
-  !!compareConsents(specs, applied).length
+export const isDifferentConsentsExists = (specs: any, applied: any) => !!compareConsents(specs, applied).length
 
 export const compareConsents = (
   specs: any = {},