Feat: Enable automation support for VoiceOver/Safari/MacOS (#1101)

* PARTIAL Add VoiceOver Bot * getBotUserByAtId support * updates for frontend * add browser/at keys to server side tests * Add at/browser key to queries for Data Managment and Test Queue * Fix warnings in test suite * fix test for updated development branch * typo * remove logging stub --------- Co-authored-by: Mike Pennisi <[email protected]>
w3c · May 22, 2024 · c1e0688 · c1e0688
1 parent 7b75cbe
commit c1e0688
Show file tree

Hide file tree

Showing 34 changed files with 626 additions and 147 deletions.
diff --git a/client/components/AddTestToQueueWithConfirmation/index.jsx b/client/components/AddTestToQueueWithConfirmation/index.jsx
@@ -323,8 +323,16 @@ function AddTestToQueueWithConfirmation({
 
 AddTestToQueueWithConfirmation.propTypes = {
     testPlanVersion: PropTypes.object,
-    browser: PropTypes.object,
-    at: PropTypes.object,
+    browser: PropTypes.shape({
+        id: PropTypes.string.isRequired,
+        key: PropTypes.string.isRequired,
+        name: PropTypes.string.isRequired
+    }),
+    at: PropTypes.shape({
+        id: PropTypes.string.isRequired,
+        key: PropTypes.string.isRequired,
+        name: PropTypes.string.isRequired
+    }),
     buttonRef: PropTypes.object,
     onFocus: PropTypes.func,
     onBlur: PropTypes.func,

diff --git a/client/components/DataManagement/queries.js b/client/components/DataManagement/queries.js
@@ -9,9 +9,11 @@ export const DATA_MANAGEMENT_PAGE_QUERY = gql`
         }
         ats {
             id
+            key
             name
             browsers {
                 id
+                key
                 name
             }
             atVersions {
@@ -66,10 +68,12 @@ export const DATA_MANAGEMENT_PAGE_QUERY = gql`
                 markedFinalAt
                 at {
                     id
+                    key
                     name
                 }
                 browser {
                     id
+                    key
                     name
                 }
                 issues {
@@ -135,10 +139,12 @@ export const UPDATE_TEST_PLAN_VERSION_PHASE = gql`
                         id
                         at {
                             id
+                            key
                             name
                         }
                         browser {
                             id
+                            key
                             name
                         }
                         issues {
@@ -182,10 +188,12 @@ export const UPDATE_TEST_PLAN_VERSION_RECOMMENDED_TARGET_DATE = gql`
                         id
                         at {
                             id
+                            key
                             name
                         }
                         browser {
                             id
+                            key
                             name
                         }
                         issues {

diff --git a/client/components/ManageBotRunDialog/StopRunningCollectionButton/index.jsx b/client/components/ManageBotRunDialog/StopRunningCollectionButton/index.jsx
@@ -52,7 +52,7 @@ StopRunningCollectionButton.propTypes = {
             'CANCELLED',
             'COMPLETED',
             'ERROR'
-        ])
+        ]).isRequired
     }),
     onClick: PropTypes.func
 };

diff --git a/client/components/ManageTestQueue/index.jsx b/client/components/ManageTestQueue/index.jsx
@@ -738,7 +738,20 @@ const ManageTestQueue = ({
 };
 
 ManageTestQueue.propTypes = {
-    ats: PropTypes.array,
+    ats: PropTypes.arrayOf(
+        PropTypes.shape({
+            id: PropTypes.string.isRequired,
+            key: PropTypes.string.isRequired,
+            name: PropTypes.string.isRequired,
+            browsers: PropTypes.arrayOf(
+                PropTypes.shape({
+                    id: PropTypes.string.isRequired,
+                    key: PropTypes.string.isRequired,
+                    name: PropTypes.string.isRequired
+                })
+            ).isRequired
+        })
+    ).isRequired,
     testPlanVersions: PropTypes.array,
     triggerUpdate: PropTypes.func
 };

diff --git a/client/components/TestQueue/AssignTesterDropdown/index.jsx b/client/components/TestQueue/AssignTesterDropdown/index.jsx
@@ -148,16 +148,28 @@ const AssignTesterDropdown = ({
                 <Dropdown.Menu role="menu" className="assign-menu">
                     {possibleTesters?.length ? (
                         possibleTesters.map(tester => {
-                            const { username } = tester;
+                            const { username, isBot, ats } = tester;
                             const testerIsAssigned = isTesterAssigned(username);
                             const classname = [
                                 testerIsAssigned ? 'assigned' : 'not-assigned',
-                                tester.isBot ? 'bot' : 'human'
+                                isBot ? 'bot' : 'human'
                             ].join(' ');
                             let icon;
                             if (testerIsAssigned) {
                                 icon = faCheck;
-                            } else if (tester.isBot) {
+                            } else if (isBot) {
+                                // if our bot doesn't have a link to the at - hide it from the list
+                                if (
+                                    !ats.find(
+                                        ({ id }) =>
+                                            id ===
+                                            testPlanReportAtBrowserQuery
+                                                ?.testPlanReport.at.id
+                                    )
+                                ) {
+                                    return null;
+                                }
+
                                 const supportedByBot =
                                     isSupportedByResponseCollector(
                                         testPlanReportAtBrowserQuery?.testPlanReport
@@ -211,7 +223,19 @@ const AssignTesterDropdown = ({
 
 AssignTesterDropdown.propTypes = {
     testPlanReportId: PropTypes.string.isRequired,
-    possibleTesters: PropTypes.array.isRequired,
+    possibleTesters: PropTypes.arrayOf(
+        PropTypes.shape({
+            id: PropTypes.string.isRequired,
+            username: PropTypes.string.isRequired,
+            isBot: PropTypes.bool.isRequired,
+            ats: PropTypes.arrayOf(
+                PropTypes.shape({
+                    id: PropTypes.string.isRequired,
+                    key: PropTypes.string.isRequired
+                })
+            )
+        })
+    ).isRequired,
     onChange: PropTypes.func.isRequired,
     testPlanRun: PropTypes.object,
     label: PropTypes.string,

diff --git a/client/components/TestQueue/queries.js b/client/components/TestQueue/queries.js
@@ -12,17 +12,23 @@ export const TEST_QUEUE_PAGE_QUERY = gql`
             username
             roles
             isBot
+            ats {
+                id
+                key
+            }
         }
         ats {
             id
             name
+            key
             atVersions {
                 id
                 name
                 releasedAt
             }
             browsers {
                 id
+                key
                 name
             }
             candidateBrowsers {
@@ -55,10 +61,12 @@ export const TEST_QUEUE_PAGE_QUERY = gql`
             markedFinalAt
             at {
                 id
+                key
                 name
             }
             browser {
                 id
+                key
                 name
             }
             testPlanVersion {
@@ -106,10 +114,12 @@ export const TEST_PLAN_REPORT_QUERY = gql`
             runnableTestsLength
             at {
                 id
+                key
                 name
             }
             browser {
                 id
+                key
                 name
             }
             testPlanVersion {
@@ -151,10 +161,12 @@ export const TEST_PLAN_REPORT_AT_BROWSER_QUERY = gql`
             id
             at {
                 id
+                key
                 name
             }
             browser {
                 id
+                key
                 name
             }
         }

diff --git a/client/tests/AddTestToQueueWithConfirmation.test.jsx b/client/tests/AddTestToQueueWithConfirmation.test.jsx
@@ -35,10 +35,12 @@ const mockTestPlanReportsQueryResult = {
                 },
                 isFinal: false,
                 at: {
-                    id: '1'
+                    id: '1',
+                    key: 'jaws'
                 },
                 browser: {
-                    id: '2'
+                    id: '2',
+                    key: 'firefox'
                 }
             }
         ]
@@ -64,8 +66,8 @@ const setup = (props, mockMutation) => {
 
 const commonSetup = mockMutation => {
     mockTestPlanVersion = { id: 5 };
-    mockBrowser = { id: 2 };
-    mockAt = { id: 3 };
+    mockBrowser = { id: '2', key: 'firefox', name: 'Firefox' };
+    mockAt = { id: '3', key: 'voiceover_macos', name: 'VoiceOver' };
     mockButtonText = 'Add to Test Queue';
 
     const renderResult = setup(