@wdio/shared-store-service

What is @wdio/shared-store-service?

@wdio/shared-store-service is a service for WebdriverIO that allows you to share data between different browser sessions and processes. This can be particularly useful for end-to-end testing scenarios where you need to maintain state or share information across different test runs.

What are @wdio/shared-store-service's main functionalities?

Set Data in Shared Store

This feature allows you to set a key-value pair in the shared store. The data can then be accessed by other browser sessions or processes.

await browser.sharedStore.set('key', 'value');

Get Data from Shared Store

This feature allows you to retrieve a value from the shared store using a key. This is useful for accessing data that was set in a different session or process.

const value = await browser.sharedStore.get('key');

Delete Data from Shared Store

This feature allows you to delete a key-value pair from the shared store. This can be useful for cleaning up data after tests have run.

await browser.sharedStore.delete('key');

Other packages similar to @wdio/shared-store-service

webdriverio

WebdriverIO is a popular testing framework for Node.js. While it does not have built-in shared store functionality, it offers a wide range of plugins and services that can be used to extend its capabilities, including state management and data sharing.

selenium-webdriver

Selenium WebDriver is a widely-used tool for automating web applications. It does not natively support shared stores, but you can implement similar functionality using external storage solutions like Redis or a database.

cypress

Cypress is an end-to-end testing framework that offers a different approach to testing compared to WebdriverIO. While it does not have a built-in shared store, it provides various ways to manage state and share data between tests, such as using environment variables or custom commands.

README

WebdriverIO Shared Store Service

Exchange data between main process and workers (specs).

Installation

The easiest way is to keep @wdio/shared-store-service as a dev dependency in your package.json, via:

npm install @wdio/shared-store-service --save-dev

Instructions on how to install WebdriverIO can be found here.

Usage

Get/set a value (a plain object) to/from the store by key (string). The key can be any arbitrary string except * which is reserved as it allows you to fetch the whole store.

Set Values

To set values to the store call:

await browser.sharedStore.set('key', 'foobar123')

Get Values

To get values from the store call:

const value = await browser.sharedStore.get('key')
console.log(value) // returns "foobar123"

You can also fetch all key values by using the * key:

const store = await browser.sharedStore.get('*')
console.log(value) // returns `{ key: "foobar" }`

Access Store in WDIO Hooks

You could also directly access to setValue and getValue async handlers. Make sure you properly call them with the await keyword.

// wdio.conf.js
import { setValue, getValue } from '@wdio/shared-store-service'

export const config = {
    // ...
    onPrepare: [async function (config, capabilities) {
        await setValue('foo', 'bar')
    }],
    // ...
    after: async () => {
        const value = await getValue('foo')
        // ...
    }

IMPORTANT! Every spec file should be atomic and isolated from others' specs. The idea of the service is to deal with very specific environment setup issues. Please avoid sharing test execution data!

Resource Pools

If the worker threads are competing for resources that must be assigned for each worker, you can use Resource Pool API:

// wdio.conf.js
import { setResourcePool, getValueFromPool, addValueToPool } from '@wdio/shared-store-service'

export const config = {
    maxInstances: 2,
    // ...
    onPrepare: async function (config, capabilities) {
        await setResourcePool('availableUrls', ['url01.com', 'url02.com'])
    },
    // ...
    beforeSession: async (conf) => {
        conf.baseUrl = await getValueFromPool('availableUrls');
    },
    // ...
    afterSession: async (conf) => {
        // worker returns the used resource for next workers to use
        await addValueToPool('availableUrls', conf.baseUrl);
    }

This example ensures that both workers never use the same baseUrl. A unique url is only assigned to one worker until it's released by it.

Configuration

Add shared-store to the services list and the sharedStore object will be accessible to you on the browser scope in your test.

// wdio.conf.js
export const config = {
    // ...
    services: ['shared-store'],
    // ...
};

If you are using typescript, make sure to add @wdio/shared-store-service to your compilerOptions.types:

{
    "compilerOptions": {
        "types": ["node", "@wdio/globals/types", "@wdio/shared-store-service"],
    }
}

Changelog

v9.5.2 (2025-01-09)

:bug: Bug Fix

• webdriverio
  • #14025 fix(webdriverio): better handle window switching in webdriver classic (@navin772)
  • #14037 fix(webdriverio): define getProperty return type as 'unknown' (@christian-bromann)
• wdio-testingbot-service
  • #14033 Add setAnnotation to TestingBot service (@jochen-testingbot)
• wdio-appium-service
  • #14032 fix(@wdio/appium-service): start Appium server with multiremote capabilities (@christian-bromann)

:memo: Documentation

• #14040 docs: document how to retrive browser logs (@christian-bromann)

:house: Internal

• #14026 update pnpm-lock.yaml (@navin772)

Committers: 3

• Christian Bromann (@christian-bromann)
• Jochen (@jochen-testingbot)
• Navin Chandra (@navin772)