Merge pull request #189 from RedisInsight/main

vlad-dargel · web-flow · commit 975f4b843218 · 2024-08-26T09:32:10.000+02:00
main to release
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -401,7 +401,7 @@ workflows:
 
       - e2e-app-image:
           name: E2ETest (linux)
-          parallelism: 1
+          parallelism: 2
           requires:
             - Build extension - Linux (stage)
 
@@ -510,7 +510,7 @@ workflows:
       # e2e tests on linux build
       - e2e-app-image:
           name: E2ETest (linux)
-          parallelism: 1
+          parallelism: 2
           requires:
             - Build extension - Linux (stage)
 
@@ -545,10 +545,10 @@ workflows:
           env: prod
           <<: *prodFilter
 
-      # e2e desktop tests on linux build
+      # e2e tests on linux build
       - e2e-app-image:
           name: E2ETest (Linux)
-          parallelism: 1
+          parallelism: 2
           requires:
             - Build extension - Linux (prod)
 
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: ''
+assignees: ''
+
+---
+
+**Preconditions** (Any important steps we need to know)
+
+
+**Steps to reproduce** (How to reproduce what you found step by step)
+
+
+**Actual behavior** (A short description of what you found)
+
+
+**Expected behavior** (A short description of what you expected to find)
+
+
+**Screenshots** (Paste or drag-and-drop a screenshot or a link to a recording)
+
+
+**Additional context** (Operating system, version of Redis Insight, Redis database version, Redis module version, database type, connection type, logs, or any other information)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Request a feature or submit an idea
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Problem description** (Describe the problem you would like to solve with this feature request or suggested idea).
+
+
+**How often do you encounter this problem** (Describe how frequently this problem occurs).
+
+
+**Alternatives considered** (Describe any alternative features or products you've considered).
+
+
+**Additional information** (Add any other context or details here).
diff --git a/.github/Redis_for_VS_Code_main_screen.png b/.github/Redis_for_VS_Code_main_screen.png
diff --git a/README.md b/README.md
@@ -1,63 +1,33 @@
-# Redis for Visual Studio Code
-
-Temporary repository to work on the VS Code extension  
-
-### yarn is required
-1. `npm i -g yarn`
-1. `yarn install`
-1. Download backend for your platform using `yarn download:backend`
-1. Click on the VSCode sidebar `Run and Debug` icon
-1. Chose one of the options in the select control and click on the green play icon. Options:  
-  a. `Run Dev Extension` - start 2 background dev tasks and the debug vscode instance with extension  
-  b. `Run only Extension` - start only the debug vscode instance with extension  
-1. In the opened Visual studio code instance, click the Redis for VS Code icon in the sidebar  
-
-
-
-### Scripts:  
-`download:backend` - download backend for current platform   
-`dev` - run web server with custom router in the `RI_DATA_ROUTE` env variable. Like `RI_DATA_ROUTE=settings yarn dev`
-`dev:sidebar` - run web server with sidebar router   
-`l10n:collect` - auto find all new strings and add them to `./l10n/bundle.l10n.json`  
-`storybook:dev` - run web storybook dev server  
-`package:prod` - package plugin as *.vsix file for prod  
-`package:stage` - package plugin as *.vsix file as prerelease build   
-
-`watch` - start node part of the plugin in dev mode   
-`build` - build web part of the plugin and run in dev mode  
-
-### Docs for all people:
-[vsc toolkit storybook](https://microsoft.github.io/vscode-webview-ui-toolkit/)  
-[vsc toolkit figma](https://www.figma.com/file/PYCyGCOqN7gCFRnoPnbgqH/Visual-Studio-Code-Toolkit-(Community)?type=design&node-id=1-2&mode=design&t=IfTmvBc9Bh8KuMTy-0) 
-
-### Docs for developers
-#### Technologies:
-[tailwind](https://tailwindcss.com/)  
-[msw](https://mswjs.io/) (mock be responses)  
-[storybook ](https://storybook.js.org/)  
-[storybook + msw](https://github.com/mswjs/msw-storybook-addon) (mock BE response)   
-[storybook + vitest](https://storybook.js.org/addons/@storybook/testing-react) (use stories as component for tests)   
-[vsc icons](https://react-icons.github.io/react-icons/icons?name=vsc)  
-
-[vite](https://vitejs.dev/)  
-[vitest](https://vitest.dev/)  
-
-#### Visual studio code
-[vsc extension overview](https://code.visualstudio.com/api/extension-guides/overview)  
-[vsc extension webview ](https://code.visualstudio.com/api/extension-guides/webview)  
-[How to Code a VSCode Extension](https://youtu.be/a5DX5pQ9p5M) (youtube)   
- 
-
-#### Visual studio code plugins
-[tailwind vsc plugin](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)   
-[vitest vcs plugin](https://marketplace.visualstudio.com/items?itemName=ZixuanChen.vitest-explorer)  
-
-The `F5` command starts 3 tasks:  
-  * dev mode for node vsc  
-  * dev mode for web view  
-  * open a new vsc instance with the plugin  
-
-`F5` is a shortcut to start the "Run and Debug" => "Run Dev Extension" task  
-
-To run only vsc instance without background dev tasks chose:  
-  "Run and Debug" => "Run only Extension"  
+# <img src="https://github.com/RedisInsight/Redis-for-VS-Code/blob/main/src/resources/256x256.png" alt="logo" width="25"/>  Redis for VS Code
+
+Redis for VS Code is the official Visual Studio Code extension that provides an intuitive and efficient GUI for Redis databases, developed by Redis.
+
+![Redis for VS Code](.github/Redis_for_VS_Code_main_screen.png)
+
+## Key features:
+* Universal Redis Support: Connect to any Redis instance, including Redis Community Edition, Redis Cloud, Redis Software, and Redis on Azure Cache.
+* Advanced Connectivity: Supports TLS certificates and SSH tunnels, with an option for automatic data decompression for GZIP, SNAPPY, Brotli, and more.
+* Data types: Supports strings, hashes, lists, sets, sorted sets, and JSON.
+* Human-readable data representation: Offers formatters like ASCII, JSON, Binary, Hex, 32-bit, and 64-bit vectors, and other.
+* Integrated Redis CLI: Leverage Redis CLI with syntax preview as you type commands.
+
+For more details, check out the [release notes](https://github.com/RedisInsight/Redis-for-VS-Code/releases). 
+
+## Get started with Redis for VS Code
+
+This repository contains the source code for the Redis for VS Code extension. To start using the extension, install it from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/vscode).
+
+## Feedback
+
+We welcome your feedback and contributions to make Redis for VS Code even better. Here’s how you can get involved:
+
+* Suggest a new [feature](https://github.com/RedisInsight/Redis-for-VS-Code/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=)
+* Upvote [popular feature requests](https://github.com/RedisInsight/Redis-for-VS-Code/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc)
+* Report a [bug](https://github.com/RedisInsight/Redis-for-VS-Code/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=%5BBUG%5D)
+
+## Telemetry
+
+Redis for VS Code includes an opt-in telemetry system to help us improve the developer experience. We respect your privacy — any data collected is anonymized. You can disable telemetry at any time via the extension’s settings page.
+
+## License 
+Redis for VS Code is licensed under the [SSPL](/LICENSE).
diff --git a/Redis_for_VS_Code_main_screen.png b/Redis_for_VS_Code_main_screen.png
diff --git a/tests/e2e/.mocharc.js b/tests/e2e/.mocharc.js
@@ -20,7 +20,7 @@ module.exports = {
       toConsole: false,
     },
   },
-  retries: 0,
+  retries: 1,
   timeout: 100_000,
   ui: 'bdd',
 }
diff --git a/tests/e2e/src/helpers/api/Eula.ts b/tests/e2e/src/helpers/api/Eula.ts
@@ -6,7 +6,7 @@ export class Eula {
    * Accept eula
    */
   static async accept(): Promise<void> {
-    const spec = { agreements: { analytics: true, notifications: true, eula: true } }
+    const spec = { agreements: { analytics: true, notifications: true, eula: true, encryption: false } }
     const response = await CommonAPIRequests.sendPatchRequest(
       `/settings`,
       spec,
diff --git a/tests/e2e/src/helpers/common-actions/DatabasesActions.ts b/tests/e2e/src/helpers/common-actions/DatabasesActions.ts
@@ -11,7 +11,7 @@ import { TreeView } from '@e2eSrc/page-objects/components'
 import { InnerViews } from '@e2eSrc/page-objects/components/WebView'
 import { AddNewDatabaseParameters } from '../types/types'
 import { DatabaseAPIRequests } from '../api'
-import { NotificationActions } from './actions'
+import { InputActions, NotificationActions } from './actions'
 import { KeyDetailsActions } from './KeyDetailsActions'
 import { ServerActions } from './ServerActions'
 import { Eula } from '../api/Eula'
@@ -85,6 +85,7 @@ export class DatabasesActions extends CommonDriverExtension {
       await treeView.clickDatabaseByName(databaseParameters.databaseName!)
       await super.driverSleep(200)
     }
+    await InputActions.hoverElement(treeView.getCLIDatabaseBtnByName(databaseParameters.databaseName!),1000)
   }
 
   /**
diff --git a/tests/e2e/src/helpers/common-actions/TreeViewActions.ts b/tests/e2e/src/helpers/common-actions/TreeViewActions.ts
@@ -51,7 +51,7 @@ export class TreeViewActions extends CommonDriverExtension {
   ): Promise<void> {
     let treeView = new TreeView()
     // Wait for key refresh
-    await TreeViewActions.driverSleep(1000)
+    await TreeViewActions.driverSleep(2000)
     // Verify not patterned keys
     await this.verifyNotPatternedKeys(delimiter)
 
diff --git a/tests/e2e/src/page-objects/components/bottom-bar/CliViewPanel.ts b/tests/e2e/src/page-objects/components/bottom-bar/CliViewPanel.ts
@@ -77,6 +77,7 @@ export class CliViewPanel extends WebView {
       await input.sendKeys(command.charAt(i))
     }
     await input.sendKeys(Key.ENTER)
+    await InputActions.driver.sleep(300)
   }
 
   /**
diff --git a/tests/e2e/src/page-objects/components/editor-view/SettingsView.ts b/tests/e2e/src/page-objects/components/editor-view/SettingsView.ts
@@ -1,13 +1,22 @@
 import { By } from 'selenium-webdriver'
 import { WebView } from '@e2eSrc/page-objects/components/WebView'
-import { CheckboxActions } from '@e2eSrc/helpers/common-actions'
+import {
+  ButtonActions,
+  CheckboxActions,
+  InputActions,
+} from '@e2eSrc/helpers/common-actions'
+import { InputWithButtons } from '../common/InputWithButtons'
 
 /**
  * Settings view
  */
 export class SettingsView extends WebView {
-  switchAnalyticsOption = By.xpath(`//*[@data-testid='check-option-analytics']/..`)
-  switchAnalyticsCheckbox = By.xpath(`//input[@data-testid='check-option-analytics']/../../div[contains(@class, 'checkmarkContainer')]`)
+  switchAnalyticsOption = By.xpath(
+    `//*[@data-testid='check-option-analytics']/..`,
+  )
+  switchAnalyticsCheckbox = By.xpath(
+    `//input[@data-testid='check-option-analytics']/../../div[contains(@class, 'checkmarkContainer')]`,
+  )
   delimiterInput = By.xpath(`//input[@data-testid='input-delimiter']`)
 
   /**
@@ -17,4 +26,12 @@ export class SettingsView extends WebView {
     const switcherElement = await super.getElement(this.switchAnalyticsOption)
     return await CheckboxActions.getCheckboxState(switcherElement)
   }
+
+  /**
+   * Set delimiter default value
+   */
+  async setDelimiterDefaultValue(): Promise<void> {
+    await InputActions.slowType(this.delimiterInput, ':')
+    await ButtonActions.clickElement(InputWithButtons.applyInput)
+  }
 }
diff --git a/tests/e2e/src/tests/browser/edit-key-value.ts b/tests/e2e/src/tests/browser/edit-key-value.ts
@@ -78,6 +78,7 @@ describe('Edit Key values verification', () => {
       Config.ossStandaloneConfig.databaseName,
     )
     await new EditorView().closeAllEditors()
+    await NotificationActions.closeAllNotifications()
     await keyDetailsView.switchToInnerViewFrame(InnerViews.TreeInnerView)
     // Refresh database
     await treeView.refreshDatabaseByName(
diff --git a/tests/e2e/src/tests/browser/filtering.ts b/tests/e2e/src/tests/browser/filtering.ts
@@ -428,7 +428,7 @@ describe('Filtering per key name in DB with 10 millions of keys', () => {
     for (let i = 0; i < keyTypes.length - 1; i++) {
       await treeView.selectFilterGroupType(keyTypes[i].keyName)
       // Waiting for long db loading
-      CommonDriverExtension.driverSleep(1000)
+      CommonDriverExtension.driverSleep(2000)
       // Verify that all results have the same type as in filter
       expect(
         await treeView.getElementText(treeView.getTreeViewItemByIndex(i + 1)),
diff --git a/tests/e2e/src/tests/browser/verify-key-details.ts b/tests/e2e/src/tests/browser/verify-key-details.ts
@@ -22,6 +22,7 @@ import {
   DatabasesActions,
   InputActions,
   KeyDetailsActions,
+  NotificationActions,
 } from '@e2eSrc/helpers/common-actions'
 import { AddStringKeyView } from '@e2eSrc/page-objects/components/editor-view/AddStringKeyView'
 import { KeyTypesShort } from '@e2eSrc/helpers/constants'
@@ -97,6 +98,7 @@ describe('Key Details verifications', () => {
     )
 
     await InputActions.typeText(addStringKeyView.keyNameInput, keyName)
+    await NotificationActions.closeAllNotifications()
 
     await ButtonActions.clickElement(addStringKeyView.addButton)
     await addStringKeyView.switchBack()
diff --git a/tests/e2e/src/tests/cli/cli.ts b/tests/e2e/src/tests/cli/cli.ts
@@ -2,7 +2,6 @@ import { expect } from 'chai'
 import { describe, it } from 'mocha'
 import { before, beforeEach, after, afterEach } from 'vscode-extension-tester'
 import {
-  BottomBar,
   CliViewPanel,
   TreeView,
 } from '@e2eSrc/page-objects/components'
@@ -16,14 +15,12 @@ import { ButtonActions } from '@e2eSrc/helpers/common-actions'
 import { InnerViews } from '@e2eSrc/page-objects/components/WebView'
 
 describe('CLI critical', () => {
-  let bottomBar: BottomBar
   let cliViewPanel: CliViewPanel
   let treeView: TreeView
 
   let keyName = Common.generateWord(20)
 
   before(async () => {
-    bottomBar = new BottomBar()
     cliViewPanel = new CliViewPanel()
     treeView = new TreeView()
 
@@ -40,6 +37,7 @@ describe('CLI critical', () => {
     await treeView.switchBack()
     await CommonDriverExtension.driverSleep(1000)
     await cliViewPanel.switchToInnerViewFrame(InnerViews.CliInnerView)
+    await cliViewPanel.executeCommand('clear')
   })
   afterEach(async () => {
     await KeyAPIRequests.deleteKeyIfExistsApi(
diff --git a/tests/e2e/src/tests/settings/settings.ts b/tests/e2e/src/tests/settings/settings.ts
@@ -34,6 +34,7 @@ describe('Settings', () => {
     // Go to Settings page
     await ButtonActions.clickElement(treeView.settingsButton)
     await settingsView.switchToInnerViewFrame(InnerViews.SettingsInnerView)
+    await settingsView.setDelimiterDefaultValue()
   })
   beforeEach(async () => {
     await treeView.switchBack()
diff --git a/tests/e2e/src/tests/setup.ts b/tests/e2e/src/tests/setup.ts
@@ -134,7 +134,7 @@ describe('Agreements Verification', () => {
 
   it('Verify that user can accept User Agreements', async () => {
     const expectedWelcomeLinks = [
-      'https://redis.io/docs/latest/develop/connect/insight/?utm_source=redisinsight&utm_medium=vscode&utm_campaign=empty_database',
+      'https://redis.io/try-free/?utm_source=redisinsight&utm_medium=vscode&utm_campaign=empty_database',
       'https://hub.docker.com/r/redis/redis-stack-server',
     ]
     await CheckboxActions.toggleCheckbox(eulaView.useRecommendedCheckbox, true)
diff --git a/tests/e2e/src/tests/tree-view/empty-db-list.ts b/tests/e2e/src/tests/tree-view/empty-db-list.ts
@@ -31,7 +31,7 @@ describe('Empty database', () => {
   })
 
   it('Verify that form to add database can be opened from empty db page', async function () {
-    const expectedWelcomeLinks = ['https://redis.io/docs/latest/develop/connect/insight/?utm_source=redisinsight&utm_medium=vscode&utm_campaign=empty_database', 'https://hub.docker.com/r/redis/redis-stack-server']
+    const expectedWelcomeLinks = ['https://redis.io/try-free/?utm_source=redisinsight&utm_medium=vscode&utm_campaign=empty_database', 'https://hub.docker.com/r/redis/redis-stack-server']
 
     await ButtonActions.clickElement(emptyView.connectDatabaseButton)
 
diff --git a/tests/e2e/src/tests/tree-view/tree-view.ts b/tests/e2e/src/tests/tree-view/tree-view.ts
@@ -106,7 +106,7 @@ describe('Tree view verifications', () => {
 
     // Verify that user can change the sorting ASC-DESC
     await ButtonActions.clickElement(treeView.sortKeysBtn)
-    await CommonDriverExtension.driverSleep(500)
+    await CommonDriverExtension.driverSleep(1000)
     await treeView.openTreeFolders([`${keyNames[2]}`.split(':')[0]])
     await treeView.openTreeFolders([`${keyNames[0]}`.split(':')[0]])
     expect(

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ module.exports = {`
`20`	`20`	`toConsole: false,`
`21`	`21`	`},`
`22`	`22`	`},`
`23`		`- retries: 0,`
	`23`	`+ retries: 1,`
`24`	`24`	`timeout: 100_000,`
`25`	`25`	`ui: 'bdd',`
`26`	`26`	`}`