SDK-1884: Cypress SDK not wrapping A11Y commands appropriately by osho-20 · Pull Request #949 · browserstack/browserstack-cypress-cli

osho-20 · 2024-12-03T14:35:26Z

Fixed Cypress A11y Scan
Added launch Options

sauravdas1997 · 2024-12-04T05:03:25Z

bin/accessibility-automation/cypress/index.js

  }

 const commandsToWrap = ['visit', 'click', 'type', 'request', 'dblclick', 'rightclick', 'clear', 'check', 'uncheck', 'select', 'trigger', 'selectFile', 'scrollIntoView', 'scroll', 'scrollTo', 'blur', 'focus', 'go', 'reload', 'submit', 'viewport', 'origin'];
+const commandToOverwrite = ['visit', 'click', 'type', 'request', 'dblclick', 'rightclick', 'clear', 'check', 'uncheck', 'select', 'trigger', 'selectFile', 'scrollIntoView', 'scrollTo', 'blur', 'focus', 'go', 'reload', 'submit', 'viewport', 'origin'];


any reason for removing scroll from the list ?

scroll is not a default cypress function. This error was occuring.

is this verified across all supported cy versions ?

sauravdas1997 · 2024-12-04T05:04:59Z

bin/accessibility-automation/cypress/index.js

    }

-    function waitForScannerReadiness(retryCount = 30, retryInterval = 100) {
+    function waitForScannerReadiness(retryCount = 100, retryInterval = 100) {


Is retryCount number intentional ? Why 100 ?

yes a11y team told to retry for 10 sec other framework have same count.

sauravdas1997 · 2024-12-04T05:07:26Z

bin/accessibility-automation/cypress/index.js

        cy.window().then(async (win) => {
            browserStackLog(`Performing accessibility scan`);
-            await performScan(win);
+            cy.wrap(performScan(win), {timeout:40000});


This sets timeout, which can break the test if mochaTimeout is less than 40s. should we also handle mocha timeout ?

if the response from performScan take less time no timeout will occur. Eventually if response does not come and mocha timeout occurs it should be considered as timeout.

sauravdas1997 · 2024-12-05T09:40:58Z

bin/helpers/utils.js

+    }
+    const header = JSON.parse(base64UrlDecode(parts[0]));
+    const payload = JSON.parse(base64UrlDecode(parts[1]));
+    return { header, payload };


why to parse header if we are not using

also let's not return it if not used

i made it a generic function to get used in future if need headers

osho-20 · 2024-12-05T11:08:50Z

RUN_SCA

07souravkunda · 2024-12-05T11:07:45Z

bin/accessibility-automation/cypress/index.js

                    "Accessibility Automation Scanner is not ready on the page."
                )
                );
+				return;


shouldn't promise be resolved?

07souravkunda · 2024-12-05T11:08:38Z

bin/accessibility-automation/cypress/index.js

        function onScanComplete() {
            win.removeEventListener("A11Y_SCAN_FINISHED", onScanComplete);
            resolve();
+			return;


shouldn't promise be resolved?

07souravkunda · 2024-12-05T11:08:59Z

bin/accessibility-automation/cypress/index.js

            .catch((err) => {
            resolve();
-            });
+			return;


resolving do we need return?

07souravkunda · 2024-12-05T11:11:10Z

bin/accessibility-automation/plugin/index.js

          const ally_path = path.dirname(process.env.ACCESSIBILITY_EXTENSION_PATH)
+          const {_, payload} = decodeJWTToken(process.env.ACCESSIBILITY_AUTH);
          launchOptions.extensions.push(ally_path);
+          if(!utils.isUndefined(payload) && !utils.isUndefined(payload.a11y_core_config) && payload.a11y_core_config.domForge === true) {


significance of these?

other ticket SDK-1907

07souravkunda · 2024-12-05T11:15:16Z

bin/accessibility-automation/cypress/index.js


 const commandsToWrap = ['visit', 'click', 'type', 'request', 'dblclick', 'rightclick', 'clear', 'check', 'uncheck', 'select', 'trigger', 'selectFile', 'scrollIntoView', 'scroll', 'scrollTo', 'blur', 'focus', 'go', 'reload', 'submit', 'viewport', 'origin'];
+const commandToOverwrite = ['visit', 'click', 'type', 'request', 'dblclick', 'rightclick', 'clear', 'check', 'uncheck', 'select', 'trigger', 'selectFile', 'scrollIntoView', 'scrollTo', 'blur', 'focus', 'go', 'reload', 'submit', 'viewport', 'origin'];
+const performModifiedScan = (originalFn, Subject, stateType, ...args) => {


please add some comments explaining the below function for future ref

07souravkunda · 2024-12-05T11:18:57Z

bin/accessibility-automation/cypress/index.js

+    function runCutomizedCommand() {
+        if (!Subject) {
+            let orgS1, orgS2, cypressCommandSubject;
+            if((orgS2 = (orgS1 = cy).subject) !==null && orgS2 !== void 0){
+                cypressCommandSubject = orgS2.call(orgS1);
+            }
+            else{
+                cypressCommandSubject = null;
+            }
+            customChaining.then(()=> cypressCommandSubject).then(() => {originalFn(...args)});
+        }
+        else {
+            let orgSC1, orgSC2, timeO1, cypressCommandChain, setTimeout;
+            if((timeO1 = args.find(arg => arg !== null && arg !== void 0 ? arg.timeout : null)) !== null && timeO1 !== void 0) {
+                setTimeout = timeO1.timeout;
+            }
+            else {
+                setTimeout = null;
+            }
+            if((orgSC1 = (orgSC2 = cy).subjectChain) !== null && orgSC1 !== void 0){
+                cypressCommandChain = orgSC1.call(orgSC2);
+            }
+            else {
+                cypressCommandChain = null;
+            }
+            customChaining.performScanSubjectQuery(cypressCommandChain, setTimeout).then({timeout: 30000}, (newSubject) => originalFn(...changeSub(args, stateType, newSubject)));


Suggested change

function runCutomizedCommand() {

if (!Subject) {

let orgS1, orgS2, cypressCommandSubject;

if((orgS2 = (orgS1 = cy).subject) !==null && orgS2 !== void 0){

cypressCommandSubject = orgS2.call(orgS1);

}

else{

cypressCommandSubject = null;

}

customChaining.then(()=> cypressCommandSubject).then(() => {originalFn(...args)});

}

else {

let orgSC1, orgSC2, timeO1, cypressCommandChain, setTimeout;

if((timeO1 = args.find(arg => arg !== null && arg !== void 0 ? arg.timeout : null)) !== null && timeO1 !== void 0) {

setTimeout = timeO1.timeout;

}

else {

setTimeout = null;

}

if((orgSC1 = (orgSC2 = cy).subjectChain) !== null && orgSC1 !== void 0){

cypressCommandChain = orgSC1.call(orgSC2);

}

else {

cypressCommandChain = null;

}

customChaining.performScanSubjectQuery(cypressCommandChain, setTimeout).then({timeout: 30000}, (newSubject) => originalFn(...changeSub(args, stateType, newSubject)));

function runCutomizedCommand() {

if (!Subject) {

let cypressCommandSubject = (cy.subject?.call(cy)) ?? null;

customChaining.then(() => cypressCommandSubject).then(() => { originalFn(...args); });

} else {

let setTimeout = args.find(arg => arg?.timeout)?.timeout ?? null;

let cypressCommandChain = (cy.subjectChain?.call(cy)) ?? null;

customChaining.performScanSubjectQuery(cypressCommandChain, setTimeout).then({ timeout: 30000 }, newSubject => originalFn(...changeSub(args, stateType, newSubject)));

}

}

bin/helpers/utils.js

bin/accessibility-automation/cypress/index.js

The base branch was changed.

pranavj1001

Approved for base branch change

osho-20 added 2 commits December 3, 2024 19:36

SDK-1884: wrapping A11Y commands appropriately

234fcfd

SDK-1884: added error debugging logs.

02ea36a

osho-20 requested a review from sauravdas1997 December 3, 2024 14:52

sauravdas1997 reviewed Dec 4, 2024

View reviewed changes

osho-20 force-pushed the SDK-1884 branch from 3f75880 to f03c489 Compare December 4, 2024 10:56

SDK-1884: fixed scanner started twice.

da5fc16

osho-20 force-pushed the SDK-1884 branch 2 times, most recently from 81e2cc9 to 48c4784 Compare December 4, 2024 16:21

SDK-1907: added launchOptions

e8d4bc9

osho-20 force-pushed the SDK-1884 branch from 48c4784 to e8d4bc9 Compare December 4, 2024 16:22

SDK-1884: improved logic

ccde61e

osho-20 force-pushed the SDK-1884 branch from ae05221 to ccde61e Compare December 5, 2024 09:37

sauravdas1997 reviewed Dec 5, 2024

View reviewed changes

07souravkunda requested changes Dec 5, 2024

View reviewed changes

amaanbs requested changes Dec 5, 2024

View reviewed changes

SDK-1884: resolved reviews.

f96066a

osho-20 force-pushed the SDK-1884 branch from 55c1cad to f96066a Compare December 5, 2024 11:56

amaanbs previously approved these changes Dec 5, 2024

View reviewed changes

SDK-1884: original time to save results

f04069d

osho-20 dismissed amaanbs’s stale review via f04069d December 5, 2024 12:07

amaanbs previously approved these changes Dec 5, 2024

View reviewed changes

SDK-1884: refactored code

deefe01

osho-20 dismissed amaanbs’s stale review via deefe01 December 5, 2024 12:21

SDK-1884: timoute

2148ba1

osho-20 force-pushed the SDK-1884 branch from 78b2cf3 to 2148ba1 Compare December 5, 2024 12:36

07souravkunda previously approved these changes Dec 5, 2024

View reviewed changes

asambstack previously approved these changes Dec 5, 2024

View reviewed changes

osho-20 changed the base branch from master to release_1.32.2 December 6, 2024 05:09

osho-20 changed the base branch from release_1.32.2 to master December 9, 2024 07:57

pranavj1001 approved these changes Dec 9, 2024

View reviewed changes

pranavj1001 merged commit 6a74d96 into master Dec 9, 2024
2 checks passed

pranavj1001 mentioned this pull request Dec 9, 2024

1.32.2 #952

Merged

Conversation

osho-20 commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

osho-20 Dec 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sauravdas1997 Dec 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

osho-20 Dec 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sauravdas1997 Dec 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

osho-20 commented Dec 5, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pranavj1001 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

osho-20 commented Dec 3, 2024 •

edited

Loading

osho-20 Dec 4, 2024 •

edited

Loading

sauravdas1997 Dec 5, 2024 •

edited

Loading

osho-20 Dec 4, 2024 •

edited

Loading

sauravdas1997 Dec 4, 2024 •

edited

Loading