CODEWITHSUNDEEP
promisecypress
msmith1114
msmith1114

Reputation: 3229

Cypress: Returning value in promise within custom command?

So I am trying to use a custom command to reduce the need to write the same thing in multiple files. Specifically this is for logging in and setting a token via JWT.

Here is the current working code (borrowed from JWT login example from cypress examples):

let user;
before(function() {
  cy.request("POST", Cypress.env("auth_url"), {
    username: Cypress.env("auth_username"),
    password: Cypress.env("auth_password")
  })
    .its("body")
    .then(res => {
      user = res;
    });
});
beforeEach(function() {
  console.log(cy.get_auth_token)
  cy.visit("/", {
    onBeforeLoad(win) {
      // set the user object in local storage
      win.localStorage.setItem("token", user.token);
    }
  });
});

So i tried to do something similar via:

Cypress.Commands.add("get_auth_token", () => {
    let user;
    cy.request("POST", Cypress.env("auth_url"), {
        username: Cypress.env("auth_username"),
        password: Cypress.env("auth_password")
      })
        .its("body")
        .then(res => {
          user = res;
        });
    return user;

})

However when I try to call it within my beforeEach function as let user = cy.get_auth_token I get errors about user being undefined. Am I doing something wrong with returning the value? Im not an expert at promises...but this feels like it should be working?

Thanks!

Upvotes: 1

Views: 5715

Answers (2)

user8745435
user8745435

Reputation:

Commands are not like functions, the return value is not assignable to a local variable. Instead they 'yield' it to the next command in the chain, which can be a then(). Also, the value is a 'subject' which is a jquery-wrapped version of the return value.

In short, this should be how you use your custom command:

beforeEach(function() {
  cy.get_auth_token().then($user => {
    console.log($user[0]);
    cy.visit("/", {
      onBeforeLoad(win) {
        // set the user object in local storage
        win.localStorage.setItem("token", $user[0].token);
      }
    });
  });
});

Upvotes: 1

tiagolisalves
tiagolisalves

Reputation: 533

Try to put your code inside a Promise and resolve 'user'. Using Cypress.Promise, it will wait until user is returned:

Cypress.Commands.add("get_auth_token", () => {
  return new Cypress.Promise((resolve, reject) => {

     cy.request("POST", Cypress.env("auth_url"), {
        username: Cypress.env("auth_username"),
        password: Cypress.env("auth_password")
      })
        .its("body")
        .then(user => {
          resolve(user);
      });        
  })

})

Upvotes: 2

Related Questions