Can't use variables in Command callback if options exist

[Amdingo]

• Operating System: Win10
• Cypress Version:
• Browser Version:

Is this a Feature or Bug?

Bug

Current behavior:

variables in Command callback are ignored when {prevSubject: <options>} exists
i.e.:

Cypress.Commands.add('clickNavLink', { prevSubject: 'optional' }, (name) => {
  cy.get(`[data-test="${name}-nav-link"]`).click()
});

cy.clickNavLink('sales') returns GET [data-test="undefined-home-tile"]

but

Cypress.Commands.add('clickNavLink', (name) => {
  cy.get(`[data-test="${name}-nav-link"]`).click()
});

cy.clickNavLink('sales') returns GET [data-test="sales-home-tile"]

Desired behavior:

variables in a callback are respected when prevSubject is present

How to reproduce:

create a Cypress.Command with prevSubject: 'optional' variable and variable in callback.

Test code:

./support/commands.js

Cypress.Commands.add('testClickNavLink', { prevSubject: 'optional' }, (name) => {
  cy.get(`a[href="/commands/${name}"]`).click()
});

./integration/test_example_links.js

describe('Run through traversal links', function() {
  beforeEach(() => cy.visit('https://example.cypress.io'));

  ['querying', 'traversal', 'actions'].forEach((n) => {
    it('fails', () => {
    cy.testClickNavLink(n);
    })
  })
});

I know the test will fail because there's multiple, but really you just need to see that it returns undefined instead of the variable passed into the callback.

I'll throw a repo together tonight if needed but this is pretty straightforward to test.

Additional Info (images, stack traces, etc)

[brian-mann]

This is not a bug, it's the correct implementation.

Setting the prevSubject to optional will always yield you the current subject as the first argument (because it may or may not exist).

The second argument will be what you invoked the command with.

https://docs.cypress.io/api/cypress-api/custom-commands.html#Dual-Commands

[Amdingo]

This is what I get for reading docs while exhausted. Sorry!

On Mon, Dec 18, 2017 at 7:16 PM Brian Mann ***@***.***> wrote: This is not a bug, it's the correct implementation. Setting the prevSubject to optional will always yield you the current subject as the first argument (because it may or may not exist). The second argument will be what you invoked the command with. https://docs.cypress.io/api/cypress-api/custom-commands.html#Dual-Commands — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1089 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AF7eGLM4Yji3rDUKQTAexjlSDyplFVEDks5tBwBZgaJpZM4RGOpL> .

-- Sent from MetroMail