merge main

.circleci/config.yml

@@ -417,28 +417,36 @@ jobs:
             if [ << parameters.env >> == "prod" ]; then
               echo "Build version: $CURRENT_VERSION"
               cp ./redisinsight/package.json ./electron/package.json
+              echo "$VERSION" > electron/version
               exit 0
             fi
 
             VERSION=$CURRENT_VERSION-<< parameters.env >>-$CIRCLE_BUILD_NUM
             echo "Build version: $VERSION"
+            echo "$VERSION" > electron/version
             echo $(jq ".version=\"$VERSION\"" redisinsight/package.json) > electron/package.json
       - persist_to_workspace:
           root: /root/project
           paths:
             - electron
   linux:
-    docker:
-      - image: circleci/node:15.14.0
+    machine:
+      image: ubuntu-2004:202101-01
     resource_class: large
     parameters:
       env:
         description: Build environment (stage || prod)
         type: enum
         default: stage
         enum: ['stage', 'prod', 'dev']
+      redisstack:
+        description: Build RedisStack archives
+        type: boolean
+        default: true
     steps:
       - checkout
+      - node/install:
+          node-version: '14.17'
       - attach_workspace:
           at: .
       - run:
@@ -465,12 +473,27 @@ jobs:
             fi
 
             UPGRADES_LINK='' SEGMENT_WRITE_KEY='' yarn package:stage
+      - when:
+          condition:
+            equal: [ true, << parameters.redisstack >> ]
+          steps:
+            - run:
+                name: Build sources
+                command: ./.circleci/redisstack/build.sh
+            - run:
+                name: Build modules
+                command: |
+                  PLATFORM=linux ARCH=x64 .circleci/redisstack/build_modules.sh
+                  PLATFORM=linux ARCH=arm64 .circleci/redisstack/build_modules.sh
+                  PLATFORM=darwin ARCH=x64 .circleci/redisstack/build_modules.sh
+                  PLATFORM=darwin ARCH=arm64 .circleci/redisstack/build_modules.sh
       - persist_to_workspace:
           root: .
           paths:
             - release/RedisInsight*.deb
             - release/RedisInsight*.AppImage
             - release/*-linux.yml
+            - release/redisstack
   macosx:
     macos:
       xcode: 13.2.1
@@ -773,17 +796,6 @@ 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:
@@ -1039,13 +1051,3 @@ workflows:
           report: true
           requires:
             - Build app - Linux (stage)
-  guides:
-    jobs:
-      - guides-approve:
-          type: approval
-          name: Approve guides release
-          <<: *guidesFilter
-      - release-guides:
-          name: Build & release
-          requires:
-            - Approve guides release

.circleci/redisstack/build.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# install deps
+yarn
+yarn --cwd redisinsight/api
+
+# build
+yarn build:statics
+yarn build:web
+yarn --cwd ./redisinsight/api build:prod

.circleci/redisstack/build_modules.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+PLATFORM=${PLATFORM:-'linux'}
+ELECTRON_VERSION=$(cat electron/version)
+VERSION=${ELECTRON_VERSION:-'redisstack'}
+ARCH=${ARCH:-'x64'}
+FILENAME="RedisInsight-$PLATFORM.$VERSION.$ARCH.zip"
+
+# reinstall backend prod dependencies only (optimise space)
+rm -rf redisinsight/api/node_modules
+
+npm_config_arch="$ARCH" \
+npm_config_target_arch="$ARCH" \
+npm_config_platform="$PLATFORM" \
+npm_config_target_platform="$PLATFORM" \
+npm_config_keytar_binary_host_mirror="$KEYTAR_MIRROR" \
+npm_config_node_sqlite3_binary_host_mirror="$SQLITE_MIRROR" \
+yarn --cwd ./redisinsight/api install --production
+
+cp redisinsight/api/.yarnclean.prod redisinsight/api/.yarnclean
+yarn --cwd ./redisinsight/api autoclean --force
+
+rm -rf redisinsight/build.zip
+cd redisinsight && zip -r build.zip \
+api/node_modules \
+api/dist \
+ui/dist \
+&& cd ..
+
+mkdir -p release/redisstack
+cp redisinsight/build.zip release/redisstack/"$FILENAME"

redisinsight/api/config/default.ts

@@ -21,8 +21,10 @@ export default {
     pluginsAssets: join(staticDir, 'resources', 'plugins'),
     commands: join(homedir, 'commands'),
     defaultCommandsDir: join(defaultsDir, 'commands'),
-    enablementArea: join(homedir, 'enablement-area'),
+    enablementArea: process.env.GUIDES_DEV_PATH || join(homedir, 'enablement-area'),
     defaultEnablementArea: join(defaultsDir, 'enablement-area'),
+    content: process.env.CONTENT_DEV_PATH || join(homedir, 'content'),
+    defaultContent: join(defaultsDir, 'content'),
     caCertificates: join(homedir, 'ca_certificates'),
     clientCertificates: join(homedir, 'client_certificates'),
   },
@@ -34,6 +36,7 @@ export default {
     customPluginsUri: '/plugins',
     staticUri: '/static',
     enablementAreaUri: '/static/workbench',
+    contentUri: '/static/content',
     defaultPluginsUri: '/static/plugins',
     pluginsAssetsUri: '/static/resources/plugins',
     secretStoragePassword: process.env.SECRET_STORAGE_PASSWORD,
@@ -44,6 +47,7 @@ export default {
     buildType: process.env.BUILD_TYPE || 'ELECTRON',
     appVersion: process.env.APP_VERSION || '2.0.0',
     requestTimeout: parseInt(process.env.REQUEST_TIMEOUT, 10) || 10000,
+    excludeRoutes: [],
   },
   sockets: {
     cors: process.env.SOCKETS_CORS ? process.env.SOCKETS_CORS === 'true' : false,
@@ -90,9 +94,17 @@ export default {
   },
   enablementArea: {
     updateUrl: process.env.ENABLEMENT_AREA_UPDATE_URL
-      || 'https://s3.amazonaws.com/redisinsight.download/public/guides',
+      || 'https://github.com/RedisInsight/Guides/releases/download/latest',
     zip: process.env.ENABLEMENT_AREA_ZIP || 'data.zip',
     buildInfo: process.env.ENABLEMENT_AREA_CHECKSUM || 'build.json',
+    devMode: !!process.env.GUIDES_DEV_PATH,
+  },
+  content: {
+    updateUrl: process.env.CONTENT_UPDATE_URL
+      || 'https://github.com/RedisInsight/Statics/releases/download/latest',
+    zip: process.env.CONTENT_ZIP || 'data.zip',
+    buildInfo: process.env.CONTENT_CHECKSUM || 'build.json',
+    devMode: !!process.env.CONTENT_DEV_PATH,
   },
   workbench: {
     maxResultSize: parseInt(process.env.COMMAND_EXECUTION_MAX_RESULT_SIZE, 10) || 1024 * 1024,
@@ -141,4 +153,10 @@ export default {
         || 'https://raw.githubusercontent.com/RedisBloom/RedisBloom/master/commands.json',
     },
   ],
+  redisStack: {
+    id: process.env.BUILD_TYPE === 'REDIS_STACK' ? process.env.REDIS_STACK_DATABASE_ID || 'redis-stack' : undefined,
+    name: process.env.REDIS_STACK_DATABASE_NAME,
+    host: process.env.REDIS_STACK_DATABASE_HOST,
+    port: process.env.REDIS_STACK_DATABASE_PORT,
+  },
 };

redisinsight/api/config/production.ts

@@ -8,7 +8,8 @@ export default {
     logs: join(homedir, 'logs'),
     customPlugins: join(homedir, 'plugins'),
     commands: join(homedir, 'commands'),
-    enablementArea: join(homedir, 'enablement-area'),
+    enablementArea: process.env.GUIDES_DEV_PATH || join(homedir, 'enablement-area'),
+    content: process.env.CONTENT_DEV_PATH || join(homedir, 'content'),
     caCertificates: join(homedir, 'ca_certificates'),
     clientCertificates: join(homedir, 'client_certificates'),
   },

redisinsight/api/config/stack.ts

@@ -0,0 +1,15 @@
+import { RequestMethod } from '@nestjs/common';
+
+export default {
+  server: {
+    excludeRoutes: [
+      'redis-enterprise/*',
+      'instance/redis-enterprise-dbs',
+      'instance/redis-cloud-dbs',
+      'instance/sentinel-masters',
+      { path: 'instance', method: RequestMethod.POST },
+      { path: 'instance', method: RequestMethod.DELETE },
+      { path: 'instance/:id', method: RequestMethod.DELETE },
+    ],
+  },
+};

redisinsight/api/config/staging.ts

@@ -8,7 +8,8 @@ export default {
     logs: join(homedir, 'logs'),
     customPlugins: join(homedir, 'plugins'),
     commands: join(homedir, 'commands'),
-    enablementArea: join(homedir, 'enablement-area'),
+    enablementArea: process.env.GUIDES_DEV_PATH || join(homedir, 'enablement-area'),
+    content: process.env.CONTENT_DEV_PATH || join(homedir, 'content'),
     caCertificates: join(homedir, 'ca_certificates'),
     clientCertificates: join(homedir, 'client_certificates'),
   },

redisinsight/api/package.json

@@ -51,6 +51,7 @@
     "body-parser": "^1.19.0",
     "class-transformer": "^0.2.3",
     "class-validator": "^0.12.2",
+    "dotenv": "^16.0.0",
     "express": "^4.17.1",
     "fs-extra": "^10.0.0",
     "ioredis": "^4.27.1",

redisinsight/api/src/app.module.ts

@@ -1,5 +1,7 @@
 import * as fs from 'fs';
-import { Module, OnModuleInit } from '@nestjs/common';
+import {
+  MiddlewareConsumer, Module, NestModule, OnModuleInit,
+} from '@nestjs/common';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { ServeStaticModule } from '@nestjs/serve-static';
 import { EventEmitterModule } from '@nestjs/event-emitter';
@@ -9,16 +11,17 @@ import config from 'src/utils/config';
 import { PluginModule } from 'src/modules/plugin/plugin.module';
 import { CommandsModule } from 'src/modules/commands/commands.module';
 import { WorkbenchModule } from 'src/modules/workbench/workbench.module';
-import { EnablementAreaModule } from 'src/modules/enablement-area/enablement-area.module';
 import { SharedModule } from './modules/shared/shared.module';
 import { InstancesModule } from './modules/instances/instances.module';
 import { BrowserModule } from './modules/browser/browser.module';
 import { RedisEnterpriseModule } from './modules/redis-enterprise/redis-enterprise.module';
 import { RedisSentinelModule } from './modules/redis-sentinel/redis-sentinel.module';
 import { MonitorModule } from './modules/monitor/monitor.module';
 import { CliModule } from './modules/cli/cli.module';
+import { StaticsManagementModule } from './modules/statics-management/statics-management.module';
 import { SettingsController } from './controllers/settings.controller';
 import { ServerInfoController } from './controllers/server-info.controller';
+import { ExcludeRouteMiddleware } from './middleware/exclude-route.middleware';
 import { routes } from './app.routes';
 import ormConfig from '../config/ormconfig';
 
@@ -64,12 +67,12 @@ const PATH_CONFIG = config.get('dir_path');
         fallthrough: false,
       },
     }),
-    EnablementAreaModule,
+    StaticsManagementModule,
   ],
   controllers: [SettingsController, ServerInfoController],
   providers: [],
 })
-export class AppModule implements OnModuleInit {
+export class AppModule implements OnModuleInit, NestModule {
   onModuleInit() {
     // creating required folders
     const foldersToCreate = [
@@ -83,4 +86,12 @@ export class AppModule implements OnModuleInit {
       }
     });
   }
+
+  configure(consumer: MiddlewareConsumer) {
+    consumer
+      .apply(ExcludeRouteMiddleware)
+      .forRoutes(
+        ...SERVER_CONFIG.excludeRoutes,
+      );
+  }
 }

redisinsight/api/src/decorators/api-endpoint.decorator.ts

@@ -1,19 +1,27 @@
 import { applyDecorators, HttpCode } from '@nestjs/common';
-import { ApiOperation, ApiResponse } from '@nestjs/swagger';
+import { ApiExcludeEndpoint, ApiOperation, ApiResponse } from '@nestjs/swagger';
 import { ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator';
+import config from 'src/utils/config';
+import { BuildType } from 'src/modules/core/models/server-provider.interface';
+
+const SERVER_CONFIG = config.get('server');
 
 export interface IApiEndpointOptions {
   description: string;
   statusCode?: number;
   responses?: ApiResponseOptions[];
+  excludeFor?: BuildType[]
 }
 
 export function ApiEndpoint(
   options: IApiEndpointOptions,
 ): MethodDecorator & ClassDecorator {
-  const { description, statusCode, responses = [] } = options;
+  const {
+    description, statusCode, responses = [], excludeFor = [],
+  } = options;
   return applyDecorators(
     ApiOperation({ description }),
+    ApiExcludeEndpoint(excludeFor.includes(SERVER_CONFIG.buildType)),
     HttpCode(statusCode),
     ...responses?.map((response) => ApiResponse(response)),
   );

redisinsight/api/src/dto/server.dto.ts

@@ -1,4 +1,4 @@
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 
 export class GetServerInfoResponse {
   @ApiProperty({
@@ -36,6 +36,12 @@ export class GetServerInfoResponse {
   })
   buildType: string;
 
+  @ApiPropertyOptional({
+    description: 'Fixed Redis database id.',
+    type: String,
+  })
+  fixedDatabaseId?: string;
+
   @ApiProperty({
     description: 'List of available encryption strategies',
     type: [String],

redisinsight/api/src/main.ts

@@ -1,3 +1,4 @@
+import 'dotenv/config'
 import { NestFactory } from '@nestjs/core';
 import { SwaggerModule } from '@nestjs/swagger';
 import { NestApplicationOptions } from '@nestjs/common';

redisinsight/api/src/middleware/exclude-route.middleware.ts

@@ -0,0 +1,9 @@
+import { Injectable, NestMiddleware, NotFoundException } from '@nestjs/common';
+import { Request } from 'express';
+
+@Injectable()
+export class ExcludeRouteMiddleware implements NestMiddleware {
+  use(req: Request) {
+    throw new NotFoundException(`Cannot ${req.method} ${req.originalUrl}`);
+  }
+}

redisinsight/api/src/modules/core/models/server-provider.interface.ts

@@ -1,5 +1,11 @@
 import { GetServerInfoResponse } from 'src/dto/server.dto';
 
+export enum BuildType {
+  RedisStack = 'REDIS_STACK',
+  Electron = 'ELECTRON',
+  DockerOnPremise = 'DOCKER_ON_PREMISE',
+}
+
 export interface IServerProvider {
   getInfo(): Promise<GetServerInfoResponse>;
 }

redisinsight/api/src/modules/core/providers/server-on-premise/server-on-premise.service.ts

@@ -15,6 +15,7 @@ import { ServerInfoNotFoundException } from 'src/constants/exceptions';
 import { EncryptionService } from 'src/modules/core/encryption/encryption.service';
 
 const SERVER_CONFIG = config.get('server');
+const REDIS_STACK_CONFIG = config.get('redisStack');
 
 @Injectable()
 export class ServerOnPremiseService
@@ -90,6 +91,7 @@ implements OnApplicationBootstrap, IServerProvider {
         osPlatform: process.platform,
         buildType: SERVER_CONFIG.buildType,
         encryptionStrategies: await this.encryptionService.getAvailableEncryptionStrategies(),
+        fixedDatabaseId: REDIS_STACK_CONFIG?.id,
       };
       this.logger.log('Succeed to get server info.');
       return result;