Merge pull request #64 from RedisInsight/main

egor-zalenski · web-flow · commit b131809f3e04 · 2021-11-30T14:32:25.000+03:00
New candidate release
diff --git a/redisinsight/api/src/__mocks__/analytics.ts b/redisinsight/api/src/__mocks__/analytics.ts
@@ -1,4 +1,5 @@
 export const mockInstancesAnalyticsService = () => ({
+  sendInstanceListReceivedEvent: jest.fn(),
   sendInstanceAddedEvent: jest.fn(),
   sendInstanceAddFailedEvent: jest.fn(),
   sendInstanceEditedEvent: jest.fn(),
diff --git a/redisinsight/api/src/constants/commands/redistimeseries.json b/redisinsight/api/src/constants/commands/redistimeseries.json
@@ -122,6 +122,8 @@
         "multiple": true,
         "optional": true
       }
-    ]
+    ],
+    "since": "1.0.0",
+    "group": "timeseries"
   }
 }
diff --git a/redisinsight/api/src/constants/telemetry-events.ts b/redisinsight/api/src/constants/telemetry-events.ts
@@ -11,6 +11,7 @@ export enum TelemetryEvents {
   RedisInstanceDeleted = 'CONFIG_DATABASES_DATABASE_DELETED',
   RedisInstanceEditedByUser = 'CONFIG_DATABASES_DATABASE_EDITED_BY_USER',
   RedisInstanceConnectionFailed = 'DATABASE_CONNECTION_FAILED',
+  RedisInstanceListReceived = 'CONFIG_DATABASES_DATABASE_LIST_DISPLAYED',
 
   // Events for autodiscovery flows
   REClusterDiscoverySucceed = 'CONFIG_DATABASES_RE_CLUSTER_AUTODISCOVERY_SUCCEEDED',
diff --git a/redisinsight/api/src/modules/shared/services/instances-business/instances-analytics.service.spec.ts b/redisinsight/api/src/modules/shared/services/instances-business/instances-analytics.service.spec.ts
@@ -53,6 +53,51 @@ describe('InstancesAnalytics', () => {
     );
   });
 
+  describe('sendInstanceListReceivedEvent', () => {
+    const instance = mockDatabaseInstanceDto;
+    it('should emit event with one db in the list', () => {
+      service.sendInstanceListReceivedEvent([instance]);
+
+      expect(sendEventMethod).toHaveBeenCalledWith(
+        TelemetryEvents.RedisInstanceListReceived,
+        {
+          numberOfDatabases: 1,
+        },
+      );
+    });
+    it('should emit event with several dbs in the list', () => {
+      service.sendInstanceListReceivedEvent([instance, instance, instance]);
+
+      expect(sendEventMethod).toHaveBeenCalledWith(
+        TelemetryEvents.RedisInstanceListReceived,
+        {
+          numberOfDatabases: 3,
+        },
+      );
+    });
+    it('should emit event with several empty in the list', () => {
+      service.sendInstanceListReceivedEvent([]);
+
+      expect(sendEventMethod).toHaveBeenCalledWith(
+        TelemetryEvents.RedisInstanceListReceived,
+        {
+          numberOfDatabases: 0,
+        },
+      );
+    });
+    it('should emit event with additional data', () => {
+      service.sendInstanceListReceivedEvent([], { data: 'data' });
+
+      expect(sendEventMethod).toHaveBeenCalledWith(
+        TelemetryEvents.RedisInstanceListReceived,
+        {
+          numberOfDatabases: 0,
+          data: 'data',
+        },
+      );
+    });
+  });
+
   describe('sendInstanceAddedEvent', () => {
     it('should emit event with enabled tls', () => {
       const instance = mockDatabaseInstanceDto;
@@ -72,6 +117,8 @@ describe('InstancesAnalytics', () => {
           numberOfKeysRange: '0 - 500 000',
           totalMemory: mockRedisGeneralInfo.usedMemory,
           numberedDatabases: mockRedisGeneralInfo.databases,
+          numberOfModules: 0,
+          modules: [],
         },
       );
     });
@@ -96,11 +143,13 @@ describe('InstancesAnalytics', () => {
           numberOfKeysRange: '0 - 500 000',
           totalMemory: mockRedisGeneralInfo.usedMemory,
           numberedDatabases: mockRedisGeneralInfo.databases,
+          numberOfModules: 0,
+          modules: [],
         },
       );
     });
     it('should emit event without additional info', () => {
-      const instance = mockDatabaseInstanceDto;
+      const instance = { ...mockDatabaseInstanceDto, modules: [{ name: 'search', version: 20000 }] };
       service.sendInstanceAddedEvent(instance, {
         version: mockRedisGeneralInfo.version,
       });
@@ -119,6 +168,8 @@ describe('InstancesAnalytics', () => {
           numberOfKeysRange: undefined,
           totalMemory: undefined,
           numberedDatabases: undefined,
+          numberOfModules: 1,
+          modules: [{ name: 'search', version: 20000 }],
         },
       );
     });
diff --git a/redisinsight/api/src/modules/shared/services/instances-business/instances-analytics.service.ts b/redisinsight/api/src/modules/shared/services/instances-business/instances-analytics.service.ts
@@ -12,6 +12,23 @@ export class InstancesAnalyticsService extends TelemetryBaseService {
     super(eventEmitter);
   }
 
+  sendInstanceListReceivedEvent(
+    instances: DatabaseInstanceResponse[],
+    additionalData: object = {},
+  ): void {
+    try {
+      this.sendEvent(
+        TelemetryEvents.RedisInstanceListReceived,
+        {
+          numberOfDatabases: instances.length,
+          ...additionalData,
+        },
+      );
+    } catch (e) {
+      // continue regardless of error
+    }
+  }
+
   sendInstanceAddedEvent(
     instance: DatabaseInstanceResponse,
     additionalInfo: RedisDatabaseInfoResponse,
@@ -35,6 +52,8 @@ export class InstancesAnalyticsService extends TelemetryBaseService {
           numberOfKeysRange: getRangeForNumber(additionalInfo.totalKeys, TOTAL_KEYS_BREAKPOINTS),
           totalMemory: additionalInfo.usedMemory,
           numberedDatabases: additionalInfo.databases,
+          numberOfModules: instance.modules.length,
+          modules: instance.modules,
         },
       );
     } catch (e) {
diff --git a/redisinsight/api/src/modules/shared/services/instances-business/instances-business.service.ts b/redisinsight/api/src/modules/shared/services/instances-business/instances-business.service.ts
@@ -92,7 +92,9 @@ export class InstancesBusinessService {
 
   async getAll(): Promise<DatabaseInstanceResponse[]> {
     try {
-      return (await this.databasesProvider.getAll()).map(convertEntityToDto);
+      const result = (await this.databasesProvider.getAll()).map(convertEntityToDto);
+      this.instancesAnalyticsService.sendInstanceListReceivedEvent(result);
+      return result;
     } catch (error) {
       this.logger.error('Failed to get database instance list.', error);
       throw new InternalServerErrorException();
diff --git a/redisinsight/ui/src/components/consents-settings/ConsentsSettings.tsx b/redisinsight/ui/src/components/consents-settings/ConsentsSettings.tsx
@@ -12,7 +12,9 @@ import {
   EuiToolTip,
   EuiForm,
   EuiHorizontalRule,
+  EuiCallOut,
 } from '@elastic/eui'
+import cx from 'classnames'
 import parse from 'html-react-parser'
 
 import { compareConsents } from 'uiSrc/utils'
@@ -149,34 +151,38 @@ const ConsentsSettings = ({ liveEditMode = false }: Props) => {
 
   return (
     <EuiForm component="form" onSubmit={formik.handleSubmit} data-testid="consents-settings-form">
-      {!!nonRequiredConsents.length && (
-        <>
-          <EuiSpacer size="s" />
-          <EuiText size="s" color="subdued">
-            To improve your experience, we use third party tools in RedisInsight. All data collected
-            are completely anonymized, but we will not use these data for any purpose that you do
-            not consent to.
-          </EuiText>
-          <EuiSpacer size="xl" />
-        </>
-      )}
-      {
-        nonRequiredConsents
-          .map((consent: IConsent) => renderConsentOption(consent, nonRequiredConsents.length > 1))
-      }
-
-      {!liveEditMode && (
-        <>
-          <EuiText size="s" color="subdued">
-            While adding new plugins for Workbench, use files only from trusted authors
-            to avoid automatic execution of malicious code.
-          </EuiText>
-          <EuiHorizontalRule margin="l" />
-        </>
-      )}
-
+      <div className={styles.consentsWrapper}>
+        {!!nonRequiredConsents.length && (
+          <>
+            <EuiSpacer size="s" />
+            <EuiText size="s" color="subdued">
+              To improve your experience, we use third party tools in RedisInsight. All data collected
+              are completely anonymized, but we will not use these data for any purpose that you do
+              not consent to.
+            </EuiText>
+            <EuiSpacer size="xl" />
+          </>
+        )}
+        {
+          nonRequiredConsents
+            .map((consent: IConsent) => renderConsentOption(consent, nonRequiredConsents.length > 1))
+        }
+
+        {!liveEditMode && (
+          <>
+            <EuiCallOut>
+              <EuiText size="s">
+                While adding new visualization plugins, use files only from trusted authors
+                to avoid automatic execution of malicious code.
+              </EuiText>
+            </EuiCallOut>
+            <EuiHorizontalRule margin="l" className={cx({ [styles.pluginWarningHR]: !!requiredConsents.length })} />
+          </>
+        )}
+      </div>
       {!!requiredConsents.length && (
         <>
+          <EuiSpacer size="l" />
           <EuiText color="subdued" size="s">
             To use RedisInsight, please accept the terms and conditions:
           </EuiText>
@@ -185,39 +191,42 @@ const ConsentsSettings = ({ liveEditMode = false }: Props) => {
       )}
 
       {requiredConsents.map((consent: IConsent) => renderConsentOption(consent))}
+
       {!liveEditMode && (
-        <EuiFlexGroup justifyContent="flexEnd" responsive={false}>
-          <EuiSpacer size="l" />
-          <EuiFlexItem grow={false}>
-            <EuiToolTip
-              position="top"
-              anchorClassName="euiToolTip__btn-disabled"
-              content={
-                submitIsDisabled() ? (
-                  <span className="euiToolTip__content">
-                    {Object.values(errors).map((err) => [
-                      spec?.agreements[err as string]?.requiredText,
-                      <br key={err} />,
-                    ])}
-                  </span>
-                ) : null
-              }
-            >
-              <EuiButton
-                fill
-                color="secondary"
-                className="btn-add"
-                type="submit"
-                onClick={() => {}}
-                disabled={submitIsDisabled()}
-                iconType={submitIsDisabled() ? 'iInCircle' : undefined}
-                data-testid="btn-submit"
+        <>
+          {!requiredConsents.length && (<EuiSpacer size="l" />)}
+          <EuiFlexGroup justifyContent="flexEnd" responsive={false}>
+            <EuiFlexItem grow={false}>
+              <EuiToolTip
+                position="top"
+                anchorClassName="euiToolTip__btn-disabled"
+                content={
+                  submitIsDisabled() ? (
+                    <span className="euiToolTip__content">
+                      {Object.values(errors).map((err) => [
+                        spec?.agreements[err as string]?.requiredText,
+                        <br key={err} />,
+                      ])}
+                    </span>
+                  ) : null
+                }
               >
-                Submit
-              </EuiButton>
-            </EuiToolTip>
-          </EuiFlexItem>
-        </EuiFlexGroup>
+                <EuiButton
+                  fill
+                  color="secondary"
+                  className="btn-add"
+                  type="submit"
+                  onClick={() => {}}
+                  disabled={submitIsDisabled()}
+                  iconType={submitIsDisabled() ? 'iInCircle' : undefined}
+                  data-testid="btn-submit"
+                >
+                  Submit
+                </EuiButton>
+              </EuiToolTip>
+            </EuiFlexItem>
+          </EuiFlexGroup>
+        </>
       )}
     </EuiForm>
   )
diff --git a/redisinsight/ui/src/components/consents-settings/ConsentsSettingsPopup/ConsentsSettingsPopup.tsx b/redisinsight/ui/src/components/consents-settings/ConsentsSettingsPopup/ConsentsSettingsPopup.tsx
@@ -8,8 +8,6 @@ import {
   EuiFlexGroup,
   EuiFlexItem,
   EuiTitle,
-  EuiSpacer,
-  EuiText,
 } from '@elastic/eui'
 
 import { Theme } from 'uiSrc/constants'
@@ -35,7 +33,12 @@ const ConsentsSettingsPopup = () => {
     <EuiOverlayMask>
       <EuiModal className={styles.consentsPopup} onClose={() => {}} data-testid="consents-settings-popup">
         <EuiModalHeader className={styles.modalHeader}>
-          <EuiFlexGroup justifyContent="flexEnd">
+          <EuiFlexGroup justifyContent="spaceBetween">
+            <EuiFlexItem grow={false}>
+              <EuiTitle size="s">
+                <h3 className={styles.consentsPopupTitle}>EULA and Privacy Settings</h3>
+              </EuiTitle>
+            </EuiFlexItem>
             <EuiFlexItem grow={false}>
               <EuiIcon
                 className={styles.redisIcon}
@@ -46,11 +49,6 @@ const ConsentsSettingsPopup = () => {
           </EuiFlexGroup>
         </EuiModalHeader>
         <EuiModalBody>
-          <EuiTitle size="xs">
-            <EuiText className={styles.consentsPopupTitle}>EULA and Privacy Settings</EuiText>
-          </EuiTitle>
-          <EuiSpacer size="xl" />
-
           <ConsentsSettings />
         </EuiModalBody>
       </EuiModal>
diff --git a/redisinsight/ui/src/components/consents-settings/styles.module.scss b/redisinsight/ui/src/components/consents-settings/styles.module.scss
@@ -1,3 +1,6 @@
+@import '@elastic/eui/src/global_styling/mixins/helpers';
+@import '@elastic/eui/src/global_styling/index';
+
 .redisIcon {
   width: 140px;
   height: auto;
@@ -13,6 +16,9 @@
     .euiModal__closeIcon {
       display: none;
     }
+    .euiModal__flex {
+      max-height: 84vh !important;
+    }
   }
 
   a {
@@ -28,9 +34,21 @@
   padding-bottom: 4px;
 }
 
+.consentsWrapper {
+  @include euiScrollBar;
+  overflow-x: hidden;
+  overflow-y: auto;
+  max-height: calc(84vh - 260px);
+}
+
+.pluginWarningHR {
+  margin-bottom: 0 !important;
+}
+
 .consentsPopupTitle {
   color: var(--euiTextSubduedColorHover);
   font-weight: 500 !important;
+  font-size: 18px !important;
 }
 
 .switchOption {
diff --git a/redisinsight/ui/src/slices/app/redis-commands.ts b/redisinsight/ui/src/slices/app/redis-commands.ts
@@ -1,5 +1,5 @@
 import { createSlice } from '@reduxjs/toolkit'
-import { uniqBy } from 'lodash'
+import { isString, uniqBy } from 'lodash'
 import { apiService } from 'uiSrc/services'
 import { ApiEndpoints, ICommand, ICommands } from 'uiSrc/constants'
 import { getApiErrorMessage, isStatusSuccessful } from 'uiSrc/utils'
@@ -30,6 +30,7 @@ const appRedisCommandsSlice = createSlice({
       state.commandsArray = Object.keys(state.spec).sort()
       state.commandGroups = uniqBy(Object.values(payload), 'group')
         .map((item: ICommand) => item.group)
+        .filter((group: string) => isString(group))
     },
     getRedisCommandsFailure: (state, { payload }) => {
       state.loading = false
diff --git a/redisinsight/ui/src/styles/base/_overrides.scss b/redisinsight/ui/src/styles/base/_overrides.scss
@@ -47,3 +47,7 @@
     margin-bottom: 0 !important;
   }
 }
+
+.euiOverlayMask {
+  padding-bottom: 0 !important;
+}
diff --git a/redisinsight/ui/src/styles/components/_callout.scss b/redisinsight/ui/src/styles/components/_callout.scss
diff --git a/redisinsight/ui/src/styles/components/_components.scss b/redisinsight/ui/src/styles/components/_components.scss
diff --git a/tests/e2e/pageObjects/cli-page.ts b/tests/e2e/pageObjects/cli-page.ts
diff --git a/tests/e2e/tests/regression/cli/cli-command-helper.e2e.ts b/tests/e2e/tests/regression/cli/cli-command-helper.e2e.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`export const mockInstancesAnalyticsService = () => ({`
	`2`	`+ sendInstanceListReceivedEvent: jest.fn(),`
`2`	`3`	`sendInstanceAddedEvent: jest.fn(),`
`3`	`4`	`sendInstanceAddFailedEvent: jest.fn(),`
`4`	`5`	`sendInstanceEditedEvent: jest.fn(),`
Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,8 @@`
`122`	`122`	`"multiple": true,`
`123`	`123`	`"optional": true`
`124`	`124`	`}`
`125`		`- ]`
	`125`	`+ ],`
	`126`	`+ "since": "1.0.0",`
	`127`	`+ "group": "timeseries"`
`126`	`128`	`}`
`127`	`129`	`}`