Release/2.0.4 preview

.circleci/config.yml

@@ -84,19 +84,27 @@ aliases:
     - 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
-    #- mods-preview        # OSS Standalone and all preview modules // todo: uncomment after broken image will be fixed
+    - oss-st-big          # OSS Standalone v6 and all modules and predefined amount of data inside (~3-4M)
+    - mods-preview        # OSS Standalone and all preview 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
+    - re-crdt             # Redis Enterprise with active-active database inside
+  guides-filter: &guidesFilter
+    filters:
+      branches:
+        only:
+          - guides
   dev-filter: &devFilter
     filters:
       branches:
         only:
           - main
+          - /^build\/.*/
   stage-filter: &stageFilter
     filters:
       branches:
@@ -301,6 +309,7 @@ jobs:
             - run:
                 name: Run tests
                 command: |
+                  TEST_BIG_DB_DUMP=$TEST_BIG_DB_DUMP \
                   docker-compose -f tests/e2e/docker-compose.yml -f tests/e2e/docker.docker-compose.yml up --abort-on-container-exit
                 no_output_timeout: 5m
       - when:
@@ -310,6 +319,7 @@ jobs:
             - run:
                 name: Run tests
                 command: |
+                  TEST_BIG_DB_DUMP=$TEST_BIG_DB_DUMP \
                   docker-compose -f tests/e2e/docker-compose.yml up --abort-on-container-exit
                 no_output_timeout: 5m
       - when:
@@ -441,7 +451,7 @@ jobs:
             - release/*-linux.yml
   macosx:
     macos:
-      xcode: 11.3.0
+      xcode: 13.2.1
     parameters:
       env:
         description: Build environment (stage || prod)
@@ -729,6 +739,17 @@ jobs:
 
             done
 
+  release-guides:
+    executor: linux-executor
+    steps:
+      - checkout
+      - run:
+          name: Release guides
+          command: |
+            cd ./redisinsight/ui/src/packages/enablement-area && zip -r data.zip .
+            mkdir -p _build && mv data.zip ./_build
+            echo "{\"timestamp\":$(date +%s)}" > ./_build/build.json
+            aws s3 cp _build/ s3://${AWS_BUCKET_NAME}/public/guides --recursive
 workflows:
   build:
     jobs:
@@ -969,3 +990,13 @@ workflows:
           report: true
           requires:
             - Build docker image
+  guides:
+    jobs:
+      - guides-approve:
+          type: approval
+          name: Approve guides release
+          <<: *guidesFilter
+      - release-guides:
+          name: Build & release
+          requires:
+            - Approve guides release

Dockerfile

@@ -10,6 +10,7 @@ COPY configs ./configs
 COPY scripts ./scripts
 COPY redisinsight ./redisinsight
 RUN SKIP_POSTINSTALL=1 yarn install
+RUN yarn --cwd redisinsight/api
 RUN yarn build:web
 RUN yarn build:statics
 

README.md

@@ -1,5 +1,5 @@
 [![Release](https://img.shields.io/github/v/release/RedisInsight/RedisInsight.svg?sort=semver)](https://github.com/RedisInsight/RedisInsight/releases)
-[![CircleCI](https://circleci.com/gh/RedisInsight/RedisInsight/tree/master.svg?style=svg)](https://circleci.com/gh/RedisInsight/RedisInsighth/tree/master)
+[![CircleCI](https://circleci.com/gh/RedisInsight/RedisInsight/tree/main.svg?style=svg)](https://circleci.com/gh/RedisInsight/RedisInsight/tree/main)
 [![Total alerts](https://img.shields.io/lgtm/alerts/g/RedisInsight/RedisInsight.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/RedisInsight/RedisInsight/alerts/)
 
 # <img src="https://redis.com/wp-content/uploads/2019/11/ico-redisinsight.svg" alt="logo" width="25"/>  RedisInsight - Developer GUI for Redis, by Redis. 

configs/webpack.config.base.js

@@ -61,12 +61,12 @@ export default {
           // 'swagger-ui-express',
           // 'class-transformer',
           // 'class-transformer/storage',
-          '@nestjs/websockets',
+          // '@nestjs/websockets',
           // '@nestjs/core/adapters/http-adapter',
           // '@nestjs/core/helpers/router-method-factory',
           // '@nestjs/core/metadata-scanner',
           '@nestjs/microservices/microservices-module',
-          '@nestjs/websockets/socket-module',
+          // '@nestjs/websockets/socket-module',
         ];
         if (!lazyImports.includes(resource)) {
           return false;

configs/webpack.config.web.common.babel.js

@@ -97,9 +97,9 @@ export default {
           'reflect-metadata',
           'swagger-ui-express',
           'class-transformer/storage',
-          '@nestjs/websockets',
+          // '@nestjs/websockets',
           '@nestjs/microservices/microservices-module',
-          '@nestjs/websockets/socket-module',
+          // '@nestjs/websockets/socket-module',
         ];
         if (!lazyImports.includes(resource)) {
           return false;

docs/plugins/development.md

@@ -103,7 +103,11 @@ The following function receives props of the executed commands:
 ```typescript
 interface Props {
   command: string; // executed command
-  data: string; // result of the executed command
+  data: Result[]; // array of results (one item for Standalone)
+}
+
+interface Result {
+  response: any; // response of the executed command
   status: 'success' | 'fail'; // response status of the executed command
 }
 
@@ -131,10 +135,11 @@ inside of the plugin script.
 
 ```javascript
 const { config, modules } = window.state
-const { baseUrl } = config
+const { baseUrl, appVersion } = config
 
 // modules - the list of modules of the current database
 // baseUrl - url for your plugin folder - can be used to include your assets
+// appVersion - version of the RedisInsight application
 ```
 
 ### Plugin rendering
@@ -146,13 +151,16 @@ Rendered iframe also includes `theme_DARK` or `theme_LIGHT` className on `body`
 _Javascript Example:_
 ```javascript
 const renderVisualization = (props) => {
-    const { command, data } = props;
+    const { command, data = [] } = props;
+    const [{ result, status }] = data
     document.getElementById('app')
       .innerHTML = `
         <h3>Executed command:<h3>
         <p>${command}</p>
         <h4>Result of the command</h4>
-        <p>${data}</p>
+        <p>${result}</p>
+        <h4>Status of the command</h4>
+        <p>${status}</p>
       `
 }
 
@@ -165,9 +173,10 @@ import { render } from 'react-dom'
 import App from './App'
 
 const renderVisualization = (props) => {
-  const { command, status, data = '' } = props
+  const { command, data = [] } = props
+  const [{ result, status }] = data
   render(
-    <App command={command} response={data} status={status} />,
+    <App command={command} response={result} status={status} />,
     document.getElementById('app')
   )
 }

docs/plugins/introduction.md

@@ -1,7 +1,17 @@
 # Introduction to plugins for the Workbench
 
-Plugins allow the customization of visualizations for Redis commands executed 
-in the Workbench inside the RedisInsight.
+## Introduction
+
+Redis can hold a range of different data types. Visualizing these in a 
+format that’s convenient to you for validation and debugging is paramount. 
+You can now easily extend the core functionality of RedisInsight independently by 
+building your own custom visualization plugin.
+
+Data visualization provided by the plugin is rendered within the 
+Workbench results area and is based on the executed command, ie. a certain
+Redis command can generate its own custom data visualization.
+
+We have included the following [plugin package example](https://github.com/RedisInsight/RedisInsight/tree/main/redisinsight/ui/src/packages/clients-list-example) for your reference: running the CLIENT LIST command presents the output in a tabular format for easier reading.
 
 ## Wiki
 

electron-builder.json

@@ -24,7 +24,7 @@
     "gatekeeperAssess": false
   },
   "dmg": {
-    "artifactName": "${productName}-${os}-x64.${ext}",
+    "artifactName": "${productName}-${os}-${arch}.${ext}",
     "contents": [
       {
         "x": 130,

package.json

@@ -79,6 +79,7 @@
       "monaco-editor": "<rootDir>/redisinsight/__mocks__/monacoMock.js",
       "unified": "<rootDir>/redisinsight/__mocks__/unified.js",
       "remark-parse": "<rootDir>/redisinsight/__mocks__/remarkParse.js",
+      "remark-gfm": "<rootDir>/redisinsight/__mocks__/remarkGfm.js",
       "remark-rehype": "<rootDir>/redisinsight/__mocks__/remarkRehype.js",
       "rehype-stringify": "<rootDir>/redisinsight/__mocks__/rehypeStringify.js",
       "unist-util-visit": "<rootDir>/redisinsight/__mocks__/unistUtilsVisit.js"
@@ -205,6 +206,7 @@
     "rimraf": "^3.0.2",
     "sass-loader": "^10.1.0",
     "skip-postinstall": "^1.0.0",
+    "socket.io-mock": "^1.3.2",
     "source-map-support": "^0.5.19",
     "style-loader": "^2.0.0",
     "supertest": "^4.0.2",
@@ -251,8 +253,10 @@
     "react-router-dom": "^5.2.0",
     "react-virtualized": "^9.22.2",
     "rehype-stringify": "^9.0.2",
+    "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.1",
     "remark-rehype": "^10.0.1",
+    "socket.io-client": "^4.4.0",
     "unified": "^10.1.1",
     "unist-util-visit": "^4.1.0"
   },

redisinsight/__mocks__/remarkGfm.js

@@ -0,0 +1 @@
+export default jest.fn()

redisinsight/api/config/default.ts

@@ -21,6 +21,8 @@ export default {
     pluginsAssets: join(staticDir, 'resources', 'plugins'),
     commands: join(homedir, 'commands'),
     defaultCommandsDir: join(defaultsDir, 'commands'),
+    enablementArea: join(homedir, 'enablement-area'),
+    defaultEnablementArea: join(defaultsDir, 'enablement-area'),
     caCertificates: join(homedir, 'ca_certificates'),
     clientCertificates: join(homedir, 'client_certificates'),
   },
@@ -31,6 +33,7 @@ export default {
     globalPrefix: 'api',
     customPluginsUri: '/plugins',
     staticUri: '/static',
+    enablementAreaUri: '/static/workbench',
     defaultPluginsUri: '/static/plugins',
     pluginsAssetsUri: '/static/resources/plugins',
     secretStoragePassword: process.env.SECRET_STORAGE_PASSWORD,
@@ -42,6 +45,10 @@ export default {
     appVersion: process.env.APP_VERSION || '2.0.0',
     requestTimeout: parseInt(process.env.REQUEST_TIMEOUT, 10) || 10000,
   },
+  sockets: {
+    cors: process.env.SOCKETS_CORS ? process.env.SOCKETS_CORS === 'true' : false,
+    serveClient: process.env.SOCKETS_SERVE_CLIENT ? process.env.SOCKETS_SERVE_CLIENT === 'true' : false,
+  },
   db: {
     database: join(homedir, 'redisinsight.db'),
     synchronize: process.env.DB_SYNC ? process.env.DB_SYNC === 'true' : false,
@@ -78,6 +85,20 @@ export default {
     omitSensitiveData: process.env.LOGGER_OMIT_DATA ? process.env.LOGGER_OMIT_DATA === 'true' : true,
     pipelineSummaryLimit: parseInt(process.env.LOGGER_PIPELINE_SUMMARY_LIMIT, 10) || 5,
   },
+  plugins: {
+    stateMaxSize: parseInt(process.env.PLUGIN_STATE_MAX_SIZE, 10) || 1024 * 1024,
+  },
+  enablementArea: {
+    updateUrl: process.env.ENABLEMENT_AREA_UPDATE_URL
+      || 'https://s3.amazonaws.com/redisinsight.download/public/guides',
+    zip: process.env.ENABLEMENT_AREA_ZIP || 'data.zip',
+    buildInfo: process.env.ENABLEMENT_AREA_CHECKSUM || 'build.json',
+  },
+  workbench: {
+    maxResultSize: parseInt(process.env.COMMAND_EXECUTION_MAX_RESULT_SIZE, 10) || 1024 * 1024,
+    maxItemsPerDb: parseInt(process.env.COMMAND_EXECUTION_MAX_ITEMS_PER_DB, 10) || 30,
+    unsupportedCommands: JSON.parse(process.env.WORKBENCH_UNSUPPORTED_COMMANDS || '[]'),
+  },
   commands: [
     {
       name: 'main',
@@ -109,5 +130,15 @@ export default {
       url: process.env.COMMANDS_REDISGRAPH_URL
         || 'https://raw.githubusercontent.com/RedisGraph/RedisGraph/master/commands.json',
     },
+    {
+      name: 'redisgears',
+      url: process.env.COMMANDS_REDISGEARS_URL
+        || 'https://raw.githubusercontent.com/RedisGears/RedisGears/master/commands.json',
+    },
+    {
+      name: 'redisbloom',
+      url: process.env.COMMANDS_REDISBLOOM_URL
+        || 'https://raw.githubusercontent.com/RedisBloom/RedisBloom/master/commands.json',
+    },
   ],
 };

redisinsight/api/config/development.ts

@@ -2,6 +2,9 @@ export default {
   server: {
     tls: process.env.SERVER_TLS ? process.env.SERVER_TLS === 'true' : false,
   },
+  sockets: {
+    cors: true,
+  },
   db: {
     synchronize: process.env.DB_SYNC ? process.env.DB_SYNC === 'true' : true,
     migrationsRun: process.env.DB_MIGRATIONS ? process.env.DB_MIGRATIONS === 'true' : false,

redisinsight/api/config/ormconfig.ts

@@ -5,6 +5,8 @@ import { ClientCertificateEntity } from 'src/modules/core/models/client-certific
 import { DatabaseInstanceEntity } from 'src/modules/core/models/database-instance.entity';
 import { ServerEntity } from 'src/modules/core/models/server.entity';
 import { SettingsEntity } from 'src/modules/core/models/settings.entity';
+import { CommandExecutionEntity } from 'src/modules/workbench/entities/command-execution.entity';
+import { PluginStateEntity } from 'src/modules/workbench/entities/plugin-state.entity';
 import migrations from '../migration';
 import * as config from '../src/utils/config';
 
@@ -21,6 +23,8 @@ const ormConfig: TypeOrmModuleOptions = {
     DatabaseInstanceEntity,
     ServerEntity,
     SettingsEntity,
+    CommandExecutionEntity,
+    PluginStateEntity,
   ],
   migrations,
   cli: {

redisinsight/api/config/production.ts

@@ -8,6 +8,7 @@ export default {
     logs: join(homedir, 'logs'),
     customPlugins: join(homedir, 'plugins'),
     commands: join(homedir, 'commands'),
+    enablementArea: join(homedir, 'enablement-area'),
     caCertificates: join(homedir, 'ca_certificates'),
     clientCertificates: join(homedir, 'client_certificates'),
   },

redisinsight/api/config/staging.ts

@@ -8,6 +8,7 @@ export default {
     logs: join(homedir, 'logs'),
     customPlugins: join(homedir, 'plugins'),
     commands: join(homedir, 'commands'),
+    enablementArea: join(homedir, 'enablement-area'),
     caCertificates: join(homedir, 'ca_certificates'),
     clientCertificates: join(homedir, 'client_certificates'),
   },

redisinsight/api/config/test.ts

@@ -1,18 +1,6 @@
-import { join } from 'path';
-
-const homedir = join(__dirname, '..');
-
-module.exports = {
-  dir_path: {
-    homedir,
-    logs: join(homedir, 'logs'),
-    caCertificates: join(homedir, 'ca_certificates'),
-    clientCertificates: join(homedir, 'client_certificates'),
-  },
+export default {
   server: {
     env: 'test',
-    tls: !!process.env.SERVER_TLS || true,
-    tlsCert: process.env.SERVER_TLS_CERT,
-    tlsKey: process.env.SERVER_TLS_KEY,
+    requestTimeout: 1000,
   },
 };