webdriverio-workflo/lib/protocol/gridProxyDetails.js

This is a customized version of webdriverio for use with workflo framework.

/**
 *
 * Get the details of the Selenium Grid node running a session
 *
 * <example>
    :grid.js
    it('should get grid proxy details', function () {
        var details = browser.gridProxyDetails(proxyId)
        console.log(details);
        // {
        //     success: true,
        //     msg: "proxy found !",
        //     id: "MacMiniA10",
        //     request: {
        //         ...
        //         configuration: {
        //             ...
        //         },
        //         capabilities: [
        //             {
        //                 ...
        //             }
        //         ]
        //     }
        // }
    });
 * </example>
 *
 * @type grid
 */

import { ProtocolError } from '../utils/ErrorHandler'

export default function gridProxyDetails (proxyId) {
    /*!
     * parameter check
     */
    if (typeof proxyId !== 'string') {
        throw new ProtocolError('The gridProxyDetails command needs a proxyId to work with.')
    }

    return this.requestHandler.create({
        path: `/proxy?id=${proxyId}`,
        method: 'GET',
        requiresSession: false,
        gridCommand: true
    })
}