RI-6570 Verify read operations for all key types in the browsers module #4723

valkirilov · 2025-07-16T08:31:09Z

Description

Add new E2E tests to check the read functionality for different key types in the Browsers module. These tests make sure that when you click on a key, all its details show up correctly in the Details Panel (name, value(s), TTL, etc.).

How the tests work

First, prepare the data for the test using the Redis API (it's easier and faster and also, the UI flow for creating keys is already covered in another test suite)
Then we open the Details Panel by clicking on the key we just added (in the table in the UI)
Finally, we check that all the key information is displayed correctly, like "Key name", "Value(s)", "TTL", etc.

Code Changes

Extend the API to support adding various key types, enabling us to easily assemble test data
Extend browser page locators to provide helpers for checking the state of the keys details drawer
Add e2e tests to verify that the information related to the various key types is properly displayed in the details drawer

How to run the tests

You can always refer to the README, but simply running the following command should do the trick for you

# From the root directory
yarn dev:api

# In a new tab, again from the root directory
yarn dev:ui

# In a new tab, but this time go to tests/playwright directory
yarn test:chromium:local-web browser/keys-read 

# The, check the detailed report an all the video recordings
yarn playwright show-report

github-actions · 2025-07-16T08:39:59Z

Code Coverage - Backend unit tests

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	92.34%	13787/14931
🟡	Branches	74%	4147/5604
🟢	Functions	85.82%	2124/2475
🟢	Lines	92.13%	13180/14306

Test suite run success

2941 tests passing in 286 suites.

Report generated by 🧪jest coverage report action from 76052ac

github-actions · 2025-07-16T09:13:52Z

Code Coverage - Frontend unit tests

St.^❔	Category	Percentage	Covered / Total
🟢	Statements	81.37%	18403/22616
🟡	Branches	67%	8068/12042
🟡	Functions	75.14%	4867/6477
🟢	Lines	81.76%	18006/22024

Test suite run success

4792 tests passing in 628 suites.

Report generated by 🧪jest coverage report action from 76052ac

pd-redis · 2025-07-17T07:01:04Z

tests/playwright/helpers/api/api-keys.ts

+        const requestBody = {
+            keyName: Buffer.from(keyParameters.keyName, 'utf-8'),
+            members: keyParameters.members.map((member) => ({
+                name: Buffer.from(member.name, 'utf-8'),


Buffer.from(member.name, 'utf-8') can be probably abstracted as a helper function

pd-redis · 2025-07-17T08:25:05Z

tests/playwright/pageObjects/browser-page.ts

+    async isKeyDetailsClosed(): Promise<boolean> {
+        try {
+            // Give a small moment for UI transitions to complete
+            await this.page.waitForTimeout(100)


this is flaky. Better wait for an element to show

Totally agree, fixed.

pd-redis · 2025-07-17T08:29:05Z

tests/playwright/pageObjects/browser-page.ts

+        }
+    }
+
+    async getKeyTTL(): Promise<string | null> {


there is function declared in constructor with very similar name.

Nice catch, refactored.

* extend the API to support adding string keys * extend browser page locators to provide helper for checking the state of the keys details drawer * added e2e test to verify whether the information related to a string key is proplery displayed in the details drawer re #RI-6570

* extend the API to support adding ttl to the hash keys * extend browser page locators to provide helper for checking the state of the hash keys details drawer * added e2e test to verify whether the information related to a hash key is proplery displayed in the details drawer re #RI-6570

* extend the API to support adding list keys * extend browser page locators to provide helper for checking the state of the list keys details drawer * added e2e test to verify whether the information related to a list key is proplery displayed in the details drawer re #RI-6570

* extend the API to support adding ttl to set keys * extend browser page locators to provide helper for checking the state of the set keys details drawer * added e2e test to verify whether the information related to a set key is proplery displayed in the details drawer re #RI-6570

* extend the API to support adding sorted set keys * extend browser page locators to provide helper for checking the state of the sorted set keys details drawer * added e2e test to verify whether the information related to a sorted set key is proplery displayed in the details drawer re #RI-6570

* extend the API to support adding json keys * added e2e test to verify whether the information related to a json key is proplery displayed in the details drawer re #RI-6570

* extend the API to support adding ttl to stream keys * extend browser page locators to provide helper for checking the state of the stream keys details drawer * added e2e test to verify whether the information related to a stream key is proplery displayed in the details drawer re #RI-6570

… to read re #RI-6570

- remove fixed timeouts causing flaky results sometimes - export common logic for building string buffers and reuse it, as a helper function - cleanup unncesessary helper frunction in the browser objects

valkirilov force-pushed the feature/RI-6570/e2e-playwright-browser-keys-read branch from 1c596e2 to f551b57 Compare July 16, 2025 08:55

valkirilov marked this pull request as ready for review July 16, 2025 10:30

valkirilov requested review from KrumTy, pawelangelow, dantovska, ArtemHoruzhenko, pd-redis and KIvanow as code owners July 16, 2025 10:30

valkirilov mentioned this pull request Jul 16, 2025

RI-6570 Verify update and delete operations for all key types in the browsers module #4724

Closed

valkirilov self-assigned this Jul 17, 2025

pd-redis reviewed Jul 17, 2025

View reviewed changes

valkirilov added the e2e-approved label Jul 22, 2025

pawelangelow closed this Jul 22, 2025

pawelangelow deleted the feature/RI-6570/e2e-playwright-browser-keys-read branch July 22, 2025 14:20

pawelangelow restored the feature/RI-6570/e2e-playwright-browser-keys-read branch July 22, 2025 14:32

pawelangelow reopened this Jul 22, 2025

Base automatically changed from feature/RI-6570/PlayWright to main July 24, 2025 07:24

valkirilov added 4 commits July 25, 2025 11:14

valkirilov added 5 commits July 25, 2025 11:14

test: verify read operation for json keys in browsers module

a813170

* extend the API to support adding json keys * added e2e test to verify whether the information related to a json key is proplery displayed in the details drawer re #RI-6570

test: refactor test to reuse more helper methods and make them easier…

2d44e48

… to read re #RI-6570

refactor: resolve pull requet comments

bc2fd09

- remove fixed timeouts causing flaky results sometimes - export common logic for building string buffers and reuse it, as a helper function - cleanup unncesessary helper frunction in the browser objects

valkirilov force-pushed the feature/RI-6570/e2e-playwright-browser-keys-read branch from 76052ac to bc2fd09 Compare July 25, 2025 08:14

pawelangelow approved these changes Jul 25, 2025

View reviewed changes

valkirilov merged commit 896cf80 into main Jul 25, 2025
4 checks passed

valkirilov deleted the feature/RI-6570/e2e-playwright-browser-keys-read branch July 25, 2025 08:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

RI-6570 Verify read operations for all key types in the browsers module #4723

RI-6570 Verify read operations for all key types in the browsers module #4723

Uh oh!

valkirilov commented Jul 16, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 16, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 16, 2025 •

edited

Loading

Uh oh!

pd-redis Jul 17, 2025

Uh oh!

valkirilov Jul 17, 2025

Uh oh!

pd-redis Jul 17, 2025

Uh oh!

valkirilov Jul 17, 2025

Uh oh!

pd-redis Jul 17, 2025

Uh oh!

valkirilov Jul 17, 2025

Uh oh!

Uh oh!

Uh oh!

RI-6570 Verify read operations for all key types in the browsers module #4723

RI-6570 Verify read operations for all key types in the browsers module #4723

Uh oh!

Conversation

valkirilov commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How the tests work

Code Changes

How to run the tests

Uh oh!

github-actions bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage - Backend unit tests

Test suite run success

Uh oh!

github-actions bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage - Frontend unit tests

Test suite run success

Uh oh!

pd-redis Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

valkirilov Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

pd-redis Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

valkirilov Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

pd-redis Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

valkirilov Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

valkirilov commented Jul 16, 2025 •

edited

Loading

github-actions bot commented Jul 16, 2025 •

edited

Loading

github-actions bot commented Jul 16, 2025 •

edited

Loading