Enhance intercept api command

[asirvadAbrahamVarghese]

PR to enhance interceptApi command:

• Option to control wait-if-request-fired logic, this logic is useful for tree navigation flows, but not needed for button actions where requests are always guaranteed.
• Callback for request interception

@miq-bot assign @jrafanie
@miq-bot add-label cypress
@miq-bot add-label enhancement

[jrafanie]

cc @Fryguy do you have any thoughts on this way to do some mock/stubbing the result of an intercepted request?

[jrafanie]

LGTM, merging. I'm not quite sure how to use it yet so I think as you use it, it should probably help demonstrate the usability and help us revise as needed.

[asirvadAbrahamVarghese]

I'm not quite sure how to use it yet

If the request isn't guaranteed to fire for example, in tree navigation where clicking an already-selected node may not trigger a request then you should set the waitOnlyIfRequestIntercepted flag to true like we did from selectAccordionItem

            cy.interceptApi({
              alias: 'treeSelectApi',
              urlPattern: "api/tree_select/text=TestName",
              triggerFn: () => cy.wrap(li).click(),
              waitOnlyIfRequestIntercepted: true,
            });

If the request is guaranteed to fire, such as from a button click, you can leave the waitOnlyIfRequestIntercepted flag as false (its default value) so that it waits without relying on the environment flag.

            cy.interceptApi({
              alias: 'saveApi',
              urlPattern: "api/data/action=save",
              triggerFn: () => cy.get('button').click(),
            });

[jrafanie]

@GilbertCherrie @elsamaryv Please review this PR, especially, the summary of usage on the last comment. Thanks!