Merge branch 'main' into feature/RI-1868-change-fonts

Author: Roman.Sergeenko

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,7 +2,7 @@
 name: Bug report
 about: Create a report to help us improve
 title: "[Bug]:"
-labels: ''
+labels: bug
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,7 +2,7 @@
 name: Feature request
 about: Request a feature or submit an idea
 title: "[Feature Request]:"
-labels: ''
+labels: feature
 assignees: ''
 
 ---

.github/redisinsight_browser.png

@@ -1,7 +1,7 @@
                      Server Side Public License
                      VERSION 1, OCTOBER 16, 2018
 
-                    Copyright © 2018 MongoDB, Inc.
+                    Copyright © 2021 Redis, Inc.
 
   Everyone is permitted to copy and distribute verbatim copies of this
   license document, but changing it is not allowed.
@@ -500,7 +500,7 @@
 
   14. Revised Versions of this License.
 
-  MongoDB, Inc. may publish revised and/or new versions of the Server Side
+  Redis, Inc. may publish revised and/or new versions of the Server Side
   Public License from time to time. Such new versions will be similar in
   spirit to the present version, but may differ in detail to address new
   problems or concerns.
@@ -509,9 +509,9 @@
   specifies that a certain numbered version of the Server Side Public
   License “or any later version” applies to it, you have the option of
   following the terms and conditions either of that numbered version or of
-  any later version published by MongoDB, Inc. If the Program does not
+  any later version published by Redis, Inc. If the Program does not
   specify a version number of the Server Side Public License, you may
-  choose any version ever published by MongoDB, Inc.
+  choose any version ever published by Redis, Inc.
 
   If the Program specifies that a proxy can decide which future versions of
   the Server Side Public License can be used, that proxy's public statement

LICENSE

@@ -1,233 +1,71 @@
-# RedisInsight
+[![Forum](https://img.shields.io/badge/Forum-RedisInsight-red)](https://forum.redis.com/c/redisinsight/65)
+[![Discord](https://img.shields.io/discord/697882427875393627?style=flat-square)](https://discord.gg/QUkjSsk)
 
-[![CircleCI](https://circleci.com/gh/RedisInsight/RedisInsight/tree/latest.svg?style=svg)](https://circleci.com/gh/RedisInsight/RedisInsight/tree/latest)
+# <img src="https://redis.com/wp-content/uploads/2019/11/ico-redisinsight.svg" alt="logo" width="25"/>  RedisInsight
 
-Awesome Redis GUI written in Electron, NodeJS and React
+**Best in class Redis developer GUI to view and interact with your data! [Download it from here](https://redis.com/redis-enterprise/redis-insight/#insight-form)!**
 
-## Directory Structure
+![RedisInsight Browser screenshot](/.github/redisinsight_browser.png)
 
-- `redisinsight/ui` - Contains the frontend code
-- `redisinsight/api` - Contains the backend code
-- `docs` - Contains the documentation
-- `scripts` - Build scripts and other build-related files
-- `configs` - Webpack configuration files and other build-related files
-- `tests` - Contains the e2e
+Built with love using [Electron](https://www.electronjs.org/), [Elastic UI](https://elastic.github.io/eui/#/), [Monaco Editor](https://microsoft.github.io/monaco-editor/) and NodeJS.
 
-## Plugins documentation
+## Overview
 
-* [Introduction](docs/plugins/introduction.md)
-* [Installation and Usage](docs/plugins/installation.md)
-* [Plugin Development](docs/plugins/development.md)
+RedisInsight is an intuitive and efficient GUI for Redis, allowing you to interact with your databases and manage your data—with built-in support for Redis modules.
 
-## Prerequisites
+### RedisInsight Highlights:
 
-Make sure you have installed following packages:
-* [Node](https://nodejs.org/en/download/) >=14.x and <16
-* [yarn](https://www.npmjs.com/package/yarn) >=1.21.3
+* Browse, filter and visualise your key-value Redis data structures
+* CRUD support for Lists, Hashes, Strings, Sets, Sorted Sets 
+* CRUD support for [RedisJSON](https://oss.redis.com/redisjson/)
+* Introducing Workbench - advanced command line interface with intelligent command auto-complete and complex data visualizations
+* Command auto-complete support for [RediSearch](https://oss.redis.com/redisearch/), [RedisJSON](https://oss.redis.com/redisjson/), [RedisGraph](https://oss.redis.com/redisgraph/), [RedisTimeSeries](https://oss.redis.com/redistimeseries/), [RedisAI](https://oss.redis.com/redisai/)
+* Visualizations of your [RediSearch](https://oss.redis.com/redisearch/) index queries and aggregations
+* Ability to build your own data visualization plugins
+* Built-in click-through guides for Redis capabilities
+* Oficially supported for Redis OSS, [Redis Cloud](https://redis.com/try-free/). Works with Microsoft Azure Cache for Redis (official support upcoming).
+* Available for macOS, Windows and Linux 
 
-## Installation
+Check out the [release notes](https://docs.redis.com/latest/ri/release-notes/). 
 
-Before development or build you have to install required dependencies
+## Get started with RedisInsight
 
-```bash
-$ yarn install
-$ yarn --cwd redisinsight/api/
-```
+This repository includes the code for the newly released in public preview RedisInsight 2.0. Check out the [blogpost](https://redis.com/blog/introducing-redisinsight-2/) announcing it. 
 
-## Development
+The current GA version of RedisInsight is 1.11. You can install RedisInsight 2.0 along with the GA version. 
 
-There are 2 ways to develop:
+### Installable 
+Available to download for free from [here](https://redis.com/redis-enterprise/redis-insight/#insight-form). 
 
-### Developing using electron app
+### Build 
+Alternatively you can also build from source. See our wiki for instructions.
 
-After you have installed all dependencies you can now run the app.
-Run `yarn start` to start an electron application that will watch and build for you.
+* [How to build](https://github.com/RedisInsight/RedisInsight/wiki/How-to-build-and-contribute)
 
-```bash
-# Development
-$ yarn start
-```
+## Feedback
 
-### Developing using web
+* Request a new [feature](https://github.com/RedisInsight/RedisInsight/issues/new?assignees=&labels=&template=feature_request.md&title=%5BFeature+Request%5D%3A)
+* Upvote [popular feature requests](https://github.com/RedisInsight/RedisInsight/issues?q=is%3Aopen+is%3Aissue+label%3Afeature+sort%3Areactions-%2B1-desc)
+* File a [bug](https://github.com/RedisInsight/RedisInsight/issues/new?assignees=&labels=&template=bug_report.md&title=%5BBug%5D%3A)
 
-#### Running backend part of the app
 
-Run `yarn --cwd redisinsight/api/ start:dev` to start a local API at `localhost:5000`.
+## RedisInsight Plugins
 
-```bash
-# Development
-$ yarn --cwd redisinsight/api/ start:dev
-```
+With RedisInsight you can now also extend the core functionality by building your own data visualizations. See our wiki for more information.
 
-While the API is running, open your browser and navigate to http://localhost:5000/api/docs. You should see the Swagger UI.
+* [Plugin Documentation](https://github.com/RedisInsight/RedisInsight/wiki/Plugin-Documentation)
 
-#### Running frontend part of the app
+## Contributing
 
-Run `yarn start:web` to start a local server for UI.
+If you would like to contribute to the code base or fix and issue, please consult the wiki.
 
-```bash
-# Development
-$ yarn start:web
-```
+* [How to build and contribute](https://github.com/RedisInsight/RedisInsight/wiki/How-to-build-and-contribute)
 
-Web interface will be available at http://localhost:8080
+## Telemetry
 
-Now servers will watch for changes and automatically build for you
+RedisInsight includes an opt-in telemetry system, that is leveraged to help improve the developer experience (DX) within the app. We value your privacy, so stay assured, that all the data collected is anonymised.
 
-## Build
+## License 
 
-### Packaging the desktop app
+RedisInsight is licensed under [SSPL](/LICENSE) license.
 
-#### Building statics for enablement area and default plugins
-
-Run `yarn build:statics` or `yarn build:statics:win` for Windows
-
-After you have installed all dependencies you can package the app.
-Run `yarn package:prod` to package app for the local platform:
-
-```bash
-# Production
-$ yarn package:prod
-```
-
-And packaged installer will be in the folder _./release_
-
-### Create docker image
-
-There are 2 different docker images available
-
-- Image with API and UI
-- Image with API only
-
-#### Build Docker image with UI
-
-```bash
-  docker build .
-```
-
-Image exposes 5000 port
-
-Api docs - /api/docs
-
-Main UI - /
-
-Example:
-
-```bash
-  docker build -t redisinsight .
-```
-
-```bash
-  docker run -p 5000:5000 -d --cap-add ipc_lock redisinsight
-```
-
-Then api docs and main ui should be available on http://localhost:5000/api/docs and http://localhost:5000
-
-#### Build Docker with API only
-
-Image exposes 5000 port
-
-Api docs - /api/docs
-
-Example:
-
-```bash
-  docker build -f api.Dockerfile -t api.redisinsight .
-```
-
-```bash
-  docker run -p 5000:5000 -d --cap-add ipc_lock api.redisinsight
-```
-
-Then api docs and main ui should be available on http://localhost:5000/api/docs
-
-## Tests
-
-### Running frontend tests
-
-#### Run UI unit tests 
-
-```bash
-  yarn test
-```
-
-### Running backend tests
-
-#### Run backend unit tests
-
-```bash
-  # Plain tests
-  yarn --cwd redisinsight/api test
-  
-  # Tests with coverage
-  yarn --cwd redisinsight/api test:cov
-```
-
-### Run backend integration tests (using local server)
-
-```bash
-  # Plain tests
-  yarn --cwd redisinsight/api test:api
-  
-  # Tests with coverage
-  yarn --cwd redisinsight/api test:api:cov
-```
-
-> **_NOTE_**: Using `yarn test:api*` scripts you should have redis server up and running.  
-By default tests will look on `localhost:6379` without any auth  
-To customize tests configs you should run test with proper environment variables
-
-Example:
-
-If you have redis server running on a different host or port `somehost:7777` with default user pass `somepass`
-
-You should run test commands with such environment variables
-
-```bash
-  # Plain tests
-  TEST_REDIS_HOST=somehost \ 
-  TEST_REDIS_PORT=7777 \
-  TEST_REDIS_PASSWORD-somepass \
-  yarn --cwd redisinsight/api test:api
-```
-
-You can find all possible environment variable available in the [constants.ts](redisinsight/api/test/helpers/constants.ts) file
-
-### Run backend integration tests (using docker)
-
-Here you should not care about tests and local redis database configuration
-
-We will spin up server inside docker container and run tests over it
-
-```bash
-  # run this this command
-  ./redisinsight/api/test/test-runs/start-test-run.sh -r oss-st-6
-```
-- -r - is the Redis Test Environment name
-
-We are supporting several test environments to run tests on various Redis databases:
-- **oss-st-5**            - _OSS Standalone v5_
-- **oss-st-5-pass**       - _OSS Standalone v5 with admin pass required_
-- **oss-st-6**            - _OSS Standalone v6 and all modules_
-- **oss-st-6-tls**        - _OSS Standalone v6 with TLS enabled_
-- **oss-st-6-tls-auth**   - _OSS Standalone v6 with TLS auth required_
-- **oss-clu**             - _OSS Cluster_
-- **oss-clu-tls**         - _OSS Cluster with TLS enabled_
-- **oss-sent**            - _OSS Sentinel_
-- **re-st**               - _Redis Enterprise with Standalone inside_
-- **re-clu**              - _Redis Enterprise with Cluster inside_
-
-
-### Running E2E tests
-
-Install E2E tests deps
-
-```bash
-  yarn --cwd tests/e2e 
-```
-
-Run E2E tests
-
-```bash
-  yarn --cwd tests/e2e test:chrome
-```

README.md

@@ -9,9 +9,9 @@ authors to avoid automatic execution of malicious code.
 
 1. Download the plugin for the Workbench.
 2. Open the `plugins` folder with the following path
-   * For MacOs: `<usersHomeDir>/.redisinsight-v2.0/plugins`
-   * For Windows: `C:\Users\{Username}\.redisinsight-v2.0\plugins`
-   * For Linux: `<usersHomeDir>/.redisinsight-v2.0/plugins`
+   * For MacOs: `<usersHomeDir>/.redisinsight-preview/plugins`
+   * For Windows: `C:/Users/{Username}/.redisinsight-preview/plugins`
+   * For Linux: `<usersHomeDir>/.redisinsight-preview/plugins`
 3. Add the folder with plugin to the `plugins` folder
 
 To see the uploaded plugin visualizations in the command results, reload the Workbench 

docs/plugins/installation.md

@@ -1,4 +1,5 @@
 export const mockInstancesAnalyticsService = () => ({
+  sendInstanceListReceivedEvent: jest.fn(),
   sendInstanceAddedEvent: jest.fn(),
   sendInstanceAddFailedEvent: jest.fn(),
   sendInstanceEditedEvent: jest.fn(),

redisinsight/api/src/__mocks__/analytics.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',