@wdio/shared-store-service 7.20.7 → 7.20.8-alpha.504

package/README.md

@@ -15,11 +15,33 @@ Instructions on how to install `WebdriverIO` can be found [here.](https://webdri
 
 ## Usage
 
-Get/set a value (plain object) to/from the store by key (string).
+Get/set a value (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.
 
-`browser.sharedStore.set('key', 'value')` set value to store
+### Set Values
 
-`browser.sharedStore.get('key')` get value from store (returns `'value'`)
+To set values to the store call:
+
+```js
+await browser.sharedStore.set('key', 'foobar123')
+```
+
+### Get Values
+
+To get values from the store call:
+
+```js
+const value = await browser.sharedStore.get('key')
+console.log(value) // returns "foobar123"
+```
+
+You can also fetch all key values by using the `*` key:
+
+```js
+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.

package/build/client.d.ts

@@ -1,6 +1,6 @@
 import { Response } from 'got';
 import type { JsonCompatible, JsonPrimitive, JsonObject, JsonArray } from '@wdio/types';
-export declare const setPort: (port: string) => void;
+export declare const setPort: (port: number) => void;
 /**
  * make a request to the server to get a value from the store
  * @param   {string} key

package/build/client.js

@@ -1,41 +1,33 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setValue = exports.getValue = exports.setPort = void 0;
-const got_1 = __importDefault(require("got"));
-const logger_1 = __importDefault(require("@wdio/logger"));
-const log = (0, logger_1.default)('@wdio/shared-store-service');
+import got from 'got';
+import logger from '@wdio/logger';
+const log = logger('@wdio/shared-store-service');
 const WAIT_INTERVAL = 100;
 const pendingValues = new Map();
 let waitTimeout;
 let baseUrl;
-const setPort = (port) => { baseUrl = `http://localhost:${port}`; };
-exports.setPort = setPort;
+export const setPort = (port) => { baseUrl = `http://localhost:${port}`; };
 /**
  * make a request to the server to get a value from the store
  * @param   {string} key
  * @returns {*}
  */
-const getValue = async (key) => {
-    const res = await got_1.default.post(`${baseUrl}/get`, { json: { key }, responseType: 'json' }).catch(errHandler);
-    return (res === null || res === void 0 ? void 0 : res.body) ? res.body.value : undefined;
+export const getValue = async (key) => {
+    const res = await got.post(`${baseUrl}/get`, { json: { key }, responseType: 'json' }).catch(errHandler);
+    return res?.body ? res.body.value : undefined;
 };
-exports.getValue = getValue;
 /**
  * make a request to the server to set a value to the store
  * @param {string}  key
  * @param {*}       value `store[key]` value (plain object)
  */
-const setValue = async (key, value) => {
+export const setValue = async (key, value) => {
     /**
      * if someone calls `setValue` in `onPrepare` we don't have a base url
      * set as the launcher is called after user hooks. In this case we need
      * to wait until it is set and flush all messages.
      */
     if (baseUrl) {
-        return got_1.default.post(`${baseUrl}/set`, { json: { key, value } }).catch(errHandler);
+        return got.post(`${baseUrl}/set`, { json: { key, value } }).catch(errHandler);
     }
     log.info('Shared store server not yet started, collecting value');
     pendingValues.set(key, value);
@@ -50,12 +42,11 @@ const setValue = async (key, value) => {
         log.info(`Shared store server started, flushing ${pendingValues.size} values`);
         clearInterval(waitTimeout);
         await Promise.all([...pendingValues.entries()].map(async ([key, value]) => {
-            await got_1.default.post(`${baseUrl}/set`, { json: { key, value } }).catch(errHandler);
+            await got.post(`${baseUrl}/set`, { json: { key, value } }).catch(errHandler);
             pendingValues.delete(key);
         })).then(() => log.info('All pending values were successfully stored'), (err) => log.error(`Failed to store all values: ${err.stack}`));
     }, WAIT_INTERVAL);
 };
-exports.setValue = setValue;
 const errHandler = (err) => {
     log.warn(err.statusCode, err.statusMessage, err.url, err.body);
 };

package/build/index.d.ts

@@ -1,7 +1,7 @@
 import type { JsonPrimitive, JsonCompatible } from '@wdio/types';
-import SharedStoreLauncher from './launcher';
-import SharedStoreService from './service';
-export { getValue, setValue } from './client';
+import SharedStoreLauncher from './launcher.js';
+import SharedStoreService from './service.js';
+export { getValue, setValue } from './client.js';
 export default SharedStoreService;
 export declare const launcher: typeof SharedStoreLauncher;
 export interface BrowserExtension {

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEhE,OAAO,mBAAmB,MAAM,YAAY,CAAA;AAC5C,OAAO,kBAAkB,MAAM,WAAW,CAAA;AAE1C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAC7C,eAAe,kBAAkB,CAAA;AACjC,eAAO,MAAM,QAAQ,4BAAsB,CAAA;AAE3C,MAAM,WAAW,gBAAgB;IAC7B,WAAW,EAAE;QACT,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,aAAa,GAAG,cAAc,CAAC;QACrD,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,cAAc,KAAK,IAAI,CAAC;KACrE,CAAA;CACJ;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,gBAAgB,CAAC;QACvB,UAAU,OAAQ,SAAQ,gBAAgB;SAAI;QAC9C,UAAU,kBAAmB,SAAQ,gBAAgB;SAAI;KAC5D;IAED,UAAU,eAAe,CAAC;QACtB,UAAU,OAAQ,SAAQ,gBAAgB;SAAI;QAC9C,UAAU,kBAAmB,SAAQ,gBAAgB;SAAI;KAC5D;CACJ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEhE,OAAO,mBAAmB,MAAM,eAAe,CAAA;AAC/C,OAAO,kBAAkB,MAAM,cAAc,CAAA;AAE7C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAChD,eAAe,kBAAkB,CAAA;AACjC,eAAO,MAAM,QAAQ,4BAAsB,CAAA;AAE3C,MAAM,WAAW,gBAAgB;IAC7B,WAAW,EAAE;QACT,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,aAAa,GAAG,cAAc,CAAC;QACrD,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,GAAG,cAAc,KAAK,IAAI,CAAC;KACrE,CAAA;CACJ;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,gBAAgB,CAAC;QACvB,UAAU,OAAQ,SAAQ,gBAAgB;SAAI;QAC9C,UAAU,kBAAmB,SAAQ,gBAAgB;SAAI;KAC5D;IAED,UAAU,eAAe,CAAC;QACtB,UAAU,OAAQ,SAAQ,gBAAgB;SAAI;QAC9C,UAAU,kBAAmB,SAAQ,gBAAgB;SAAI;KAC5D;CACJ"}

package/build/index.js

@@ -1,13 +1,5 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.launcher = exports.setValue = exports.getValue = void 0;
-const launcher_1 = __importDefault(require("./launcher"));
-const service_1 = __importDefault(require("./service"));
-var client_1 = require("./client");
-Object.defineProperty(exports, "getValue", { enumerable: true, get: function () { return client_1.getValue; } });
-Object.defineProperty(exports, "setValue", { enumerable: true, get: function () { return client_1.setValue; } });
-exports.default = service_1.default;
-exports.launcher = launcher_1.default;
+import SharedStoreLauncher from './launcher.js';
+import SharedStoreService from './service.js';
+export { getValue, setValue } from './client.js';
+export default SharedStoreService;
+export const launcher = SharedStoreLauncher;

package/build/launcher.d.ts

@@ -1,5 +1,7 @@
 import type { SharedStoreServiceCapabilities } from './types';
 export default class SharedStoreLauncher {
+    private _app?;
     onPrepare(_: never, capabilities: SharedStoreServiceCapabilities[]): Promise<void>;
+    onComplete(): Promise<void>;
 }
 //# sourceMappingURL=launcher.d.ts.map

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,SAAS,CAAA;AAM7D,MAAM,CAAC,OAAO,OAAO,mBAAmB;IAC9B,SAAS,CAAE,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,8BAA8B,EAAE;CAQ5E"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,SAAS,CAAA;AAM7D,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACpC,OAAO,CAAC,IAAI,CAAC,CAAe;IAEtB,SAAS,CAAE,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,8BAA8B,EAAE;IAenE,UAAU;CAQnB"}

package/build/launcher.js

@@ -1,19 +1,28 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const logger_1 = __importDefault(require("@wdio/logger"));
-const client_1 = require("./client");
-const log = (0, logger_1.default)('@wdio/shared-store-service');
+import logger from '@wdio/logger';
+import { setPort } from './client.js';
+const log = logger('@wdio/shared-store-service');
 let server;
-class SharedStoreLauncher {
+export default class SharedStoreLauncher {
+    _app;
     async onPrepare(_, capabilities) {
-        server = require('./server').default;
-        const result = await server.startServer();
-        (0, client_1.setPort)(result.port);
-        capabilities.forEach(capability => { capability['wdio:sharedStoreServicePort'] = result.port; });
-        log.info(`Started shared server on port ${result.port}`);
+        /**
+         * import during runtime to avoid unnecessary dependency loading
+         */
+        server = (await import('./server.js'));
+        const { port, app } = await server.startServer();
+        this._app = app;
+        setPort(port);
+        capabilities.forEach((capability) => {
+            capability['wdio:sharedStoreServicePort'] = port;
+        });
+        log.info(`Started shared server on port ${port}`);
+    }
+    async onComplete() {
+        return new Promise((resolve) => {
+            if (this._app && this._app.server.close) {
+                this._app.server.close(() => resolve());
+            }
+            return resolve();
+        });
     }
 }
-exports.default = SharedStoreLauncher;

package/build/server.d.ts

@@ -1,3 +1,10 @@
-declare const _default: SharedStoreServer;
-export default _default;
+import type { JsonObject } from '@wdio/types';
+/**
+ * @private
+ */
+export declare const __store: JsonObject;
+export declare const startServer: () => Promise<{
+    port: number;
+    app: PolkaInstance;
+}>;
 //# sourceMappingURL=server.d.ts.map

package/build/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":";AA2DA,wBAA+E"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAiC,UAAU,EAAE,MAAM,aAAa,CAAA;AAG5E;;GAEG;AACH,eAAO,MAAM,OAAO,YAAQ,CAAA;AAY5B,eAAO,MAAM,WAAW;UAA6B,MAAM;SAAO,aAAa;EAwC7E,CAAA"}

package/build/server.js

@@ -1,11 +1,10 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const polka_1 = __importDefault(require("polka"));
-const parse_1 = require("@polka/parse");
+import polka from 'polka';
+import { json } from '@polka/parse';
 const store = {};
+/**
+ * @private
+ */
+export const __store = store;
 const validateBody = (req, res, next) => {
     if (!req.path.endsWith('/get') && !req.path.endsWith('/set')) {
         return next();
@@ -15,21 +14,29 @@ const validateBody = (req, res, next) => {
     }
     next();
 };
-const app = (0, polka_1.default)()
-    /**
-     * middleware
-     * `json` middleware transforms body to json for every request or returns empty object
-     */
-    .use((0, parse_1.json)(), validateBody)
-    // routes
-    .post('/get', (req, res) => {
-    res.end(JSON.stringify({ value: store[req.body.key] }));
-})
-    .post('/set', (req, res) => {
-    store[req.body.key] = req.body.value;
-    return res.end();
-});
-const startServer = () => new Promise((resolve, reject) => {
+export const startServer = () => new Promise((resolve, reject) => {
+    const app = polka()
+        /**
+         * middleware
+         * `json` middleware transforms body to json for every request or returns empty object
+         */
+        .use(json(), validateBody)
+        // routes
+        .post('/get', (req, res) => {
+        const key = req.body.key;
+        const value = key === '*'
+            ? store
+            : store[key];
+        res.end(JSON.stringify({ value }));
+    })
+        .post('/set', (req, res) => {
+        const key = req.body.key;
+        if (key === '*') {
+            throw new Error('You can\'t set a value with key "*" as this is a reserved key');
+        }
+        store[key] = req.body.value;
+        return res.end();
+    });
     /**
      * run server on a random port, `0` stands for random port
      * > If port is omitted or is 0, the operating system will assign
@@ -41,15 +48,6 @@ const startServer = () => new Promise((resolve, reject) => {
         if (err) {
             return reject(err);
         }
-        resolve({
-            port: app.server.address().port
-        });
+        resolve({ app, port: app.server.address().port });
     });
 });
-const stopServer = () => new Promise((resolve) => {
-    if (app.server.close) {
-        return app.server.close(() => resolve());
-    }
-    resolve();
-});
-exports.default = { startServer, stopServer, __store: store };

package/build/service.d.ts

@@ -1,6 +1,6 @@
-import { Browser } from 'webdriverio';
-import { BrowserExtension } from './index';
+import type { Browser } from 'webdriverio';
 import type { Services } from '@wdio/types';
+import { BrowserExtension } from './index.js';
 import type { SharedStoreServiceCapabilities } from './types';
 /**
  * ToDo(Christian): make this public accessible
@@ -10,7 +10,7 @@ interface ServiceBrowser extends Browser<'async'>, BrowserExtension {
 export default class SharedStoreService implements Services.ServiceInstance {
     private _browser?;
     constructor(_: never, caps: SharedStoreServiceCapabilities);
-    before(caps: unknown, specs: unknown, browser: ServiceBrowser): void;
+    before(caps: never, specs: never, browser: ServiceBrowser): void;
 }
 export {};
 //# sourceMappingURL=service.d.ts.map

package/build/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAG1C,OAAO,KAAK,EAAiC,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC1E,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,SAAS,CAAA;AAE7D;;GAEG;AACH,UAAU,cAAe,SAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB;CAAI;AAEvE,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,QAAQ,CAAC,eAAe;IACvE,OAAO,CAAC,QAAQ,CAAC,CAAgB;gBAErB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,8BAA8B;IAI1D,MAAM,CACF,IAAI,EAAE,OAAO,EACb,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,cAAc;CAiB9B"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAiC,QAAQ,EAAE,MAAM,aAAa,CAAA;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAE7C,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,SAAS,CAAA;AAE7D;;GAEG;AACH,UAAU,cAAe,SAAQ,OAAO,CAAC,OAAO,CAAC,EAAE,gBAAgB;CAAI;AAEvE,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,QAAQ,CAAC,eAAe;IACvE,OAAO,CAAC,QAAQ,CAAC,CAAgB;gBAErB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,8BAA8B;IAI1D,MAAM,CACF,IAAI,EAAE,KAAK,EACX,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,cAAc;CAiB9B"}

package/build/service.js

@@ -1,21 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("./client");
-class SharedStoreService {
+import { getValue, setValue, setPort } from './client.js';
+export default class SharedStoreService {
+    _browser;
     constructor(_, caps) {
-        (0, client_1.setPort)(caps['wdio:sharedStoreServicePort']);
+        setPort(caps['wdio:sharedStoreServicePort']);
     }
     before(caps, specs, browser) {
         this._browser = browser;
         const sharedStore = Object.create({}, {
             get: {
-                value: (key) => { var _a; return (_a = this._browser) === null || _a === void 0 ? void 0 : _a.call(() => (0, client_1.getValue)(key)); }
+                value: (key) => this._browser?.call(() => getValue(key))
             },
             set: {
-                value: (key, value) => { var _a; return (_a = this._browser) === null || _a === void 0 ? void 0 : _a.call(() => (0, client_1.setValue)(key, value)); }
+                value: (key, value) => this._browser?.call(() => setValue(key, value))
             }
         });
         this._browser.sharedStore = sharedStore;
     }
 }
-exports.default = SharedStoreService;

package/build/types.d.ts

@@ -1,5 +1,5 @@
-import { Capabilities } from '@wdio/types';
+import type { Capabilities } from '@wdio/types';
 export interface SharedStoreServiceCapabilities extends Capabilities.Capabilities {
-    'wdio:sharedStoreServicePort': string;
+    'wdio:sharedStoreServicePort': number;
 }
 //# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1C,MAAM,WAAW,8BAA+B,SAAQ,YAAY,CAAC,YAAY;IAC7E,6BAA6B,EAAE,MAAM,CAAA;CACxC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,MAAM,WAAW,8BAA+B,SAAQ,YAAY,CAAC,YAAY;IAC7E,6BAA6B,EAAE,MAAM,CAAA;CACxC"}

package/build/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@wdio/shared-store-service",
-  "version": "7.20.7",
+  "version": "7.20.8-alpha.504+428a9d729",
   "description": "A WebdriverIO service to exchange data across processes",
   "author": "Mykola Grybyk <mykola.grybyk@gmail.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-shared-store-service",
   "license": "MIT",
-  "main": "./build",
   "engines": {
-    "node": ">=12.0.0"
+    "node": "^16.13 || >=18"
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/webdriverio/webdriverio.git"
+    "url": "git://github.com/webdriverio/webdriverio.git",
+    "directory": "packages/wdio-shared-store-service"
   },
   "keywords": [
     "webdriver",
@@ -22,17 +22,20 @@
   "bugs": {
     "url": "https://github.com/webdriverio/webdriverio/issues"
   },
+  "type": "module",
+  "exports": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "typeScriptVersion": "3.8.3",
   "dependencies": {
     "@polka/parse": "^1.0.0-next.0",
-    "@wdio/logger": "7.19.0",
-    "@wdio/types": "7.20.7",
-    "got": "^11.0.2",
+    "@wdio/logger": "7.20.8-alpha.504+428a9d729",
+    "@wdio/types": "7.20.8-alpha.504+428a9d729",
+    "got": "^12.1.0",
     "polka": "^0.5.2",
-    "webdriverio": "7.20.7"
+    "webdriverio": "7.20.8-alpha.504+428a9d729"
   },
   "publishConfig": {
     "access": "public"
   },
-  "types": "./build/index.d.ts",
-  "gitHead": "21b8b61453f4749d87eca3e4d7d6e5e2cb60f043"
+  "gitHead": "428a9d729ae6231968a60908732fa3f607d195e9"
 }

package/.eslintrc.js

@@ -1,8 +0,0 @@
-module.exports = {
-    globals: {
-        WebdriverIO: true,
-        NextFn: true,
-        Polka: true,
-        SharedStoreServer: true
-    }
-}