fix crash when calling highlight on an xpath locator

DetachHead · Jul 4, 2024 · 6cd5def · 6cd5def
1 parent f06685c
commit 6cd5def
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/src/browser/xpath.ts b/src/browser/xpath.ts
@@ -126,7 +126,9 @@ const createXmlDom = (node: Element | Document) => {
         return undefined
     }
     const result = new DOMParser().parseFromString(createXml(root), 'text/xml')
-    return node instanceof Element ? result.getElementById(node.id) : result
+    // if it's an html element where its id exists in the xml dom too, then return the element
+    // in the dom matching that id, as it can be used as the context (.) for xpath selectors
+    return node instanceof Element ? result.getElementById(node.id) ?? result : result
 }
 
 const matchXmlElementToHtmlElement = (root: Element | Document, element: Element) =>
@@ -148,6 +150,7 @@ export default {
             if (!isUi5()) {
                 return []
             }
+            debugger
             return evaluateXPathToNodes<Element>(
                 fixSelectorContext(root, selector),
                 createXmlDom(root),
@@ -166,6 +169,7 @@ export default {
             if (!isUi5()) {
                 return undefined
             }
+            debugger
             const node = getRootElement(root)
             if (node === null) {
                 return undefined

diff --git a/tests/testUtils.ts b/tests/testUtils.ts
@@ -11,7 +11,7 @@ export class Ui5Tester {
         this.selectorEngineId = `ui5_${selectorEngineName}`
     }
     navigateToUi5DocsPage = async (page: Page, path: `/${string}`) => {
-        await page.goto(`https://ui5.sap.com/1.112.3${path}`)
+        await page.goto(`https://ui5.sap.com/1.125.1${path}`)
         await page.waitForSelector(
             `${this.selectorEngineId}=${
                 this.selectorEngineName === 'css' ? '*' : '//*'
@@ -22,7 +22,7 @@ export class Ui5Tester {
     navigateToControlSample = (page: Page, lib: string, sampleId: string) =>
         this.navigateToUi5DocsPage(
             page,
-            `/resources/sap/ui/documentation/sdk/index.html?sap-ui-xx-sample-id=${sampleId}&sap-ui-xx-sample-lib=${lib}&sap-ui-xx-sample-origin=.&sap-ui-xx-dk-origin=https://ui5.sap.com`,
+            `/resources/sap/ui/documentation/sdk/index.html?sap-ui-xx-sample-id=${sampleId}&sap-ui-xx-sample-lib=${lib}&sap-ui-xx-sample-origin=.&sap-ui-xx-dk-origin=https%3A%2F%2Fui5.sap.com&sap-ui-theme=sap_horizon_dark&sap-ui-rtl=false&sap-ui-density=sapUiSizeCompact`,
         )
 
     registerSelectorEngine = async () =>

diff --git a/tests/xpath.spec.ts b/tests/xpath.spec.ts
@@ -73,6 +73,10 @@ test.describe('ui5 site', () => {
                     page.locator('#__toolbar0').locator('ui5_xpath=./following-sibling::*').first(),
                 ).toHaveAttribute('id', '__toolbar1'))
         })
+        test.only('highlight', ({ page }) =>
+            // highlighting causes the root node to be the root html element instead of the document object for some reason,
+            // which we need to have handling for
+            page.locator('ui5_xpath=//sap.m.Button[1]').highlight())
     })
     test.describe('demo apps', () => {
         test('multiple root nodes', async ({ page }) => {