nightwatch/lib/api/client-commands/cookies/set.js

Easy to use Node.js based end-to-end testing solution for web applications using the W3C WebDriver API.

const ClientCommand = require('../_base-command.js');
const Utils = require('../../../utils/index.js');

/**
 * Set a cookie, specified as a cookie JSON object, with properties as defined [here](https://www.w3.org/TR/webdriver/#dfn-table-for-cookie-conversion).
 *
 * @example
 * module.exports = {
 *   'set a cookie': function (browser) {
 *     browser
 *       .cookies.set({
 *         name: "test_cookie",
 *         value: "test_value",
 *         path: "/", // (Optional)
 *         domain: "example.org", // (Optional)
 *         secure: false, // (Optional)
 *         httpOnly: false, // (Optional)
 *         expiry: 1395002765 // (Optional) time in seconds since midnight, January 1, 1970 UTC
 *       });
 *   },
 *
 *   'set a cookie with ES6 async/await': async function (browser) {
 *     await browser.cookies.set({
 *       name: 'test_cookie',
 *       value: 'test_value',
 *       domain: 'example.org', // (Optional)
 *       sameSite: 'Lax' // (Optional)
 *     });
 *   }
 * };
 *
 * @syntax .cookies.set(cookie, [callback])
 * @method cookies.set
 * @param {object} cookie The cookie object.
 * @param {function} [callback] Optional callback function to be called when the command finishes.
 * @see cookies.get
 * @see cookies.getAll
 * @see cookies.delete
 * @see cookies.deleteAll
 * @api protocol.cookies
 */
class SetCookie extends ClientCommand {
  static get isTraceable() {
    return true;
  }

  performAction(callback) {
    const {cookie} = this;

    this.transportActions.addCookie(cookie, callback);
  }

  command(cookie, callback) {
    if (!Utils.isObject(cookie)) {
      throw new Error(`First argument passed to .cookies.set() must be an object; received: ${typeof cookie} (${cookie}).`);
    }

    this.cookie = cookie;

    return super.command(callback);
  }
}

module.exports = SetCookie;