@salesforcedevs/sfdocs-e2e 1.0.12-fix-redoc-topic-v-2 → 1.0.12-fix-redoc-topic-v-4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/sfdocs-e2e",
-  "version": "1.0.12-fix-redoc-topic-v-2",
+  "version": "1.0.12-fix-redoc-topic-v-4",
   "description": "E2E test suite for SFDocs static portal pages (SSG)",
   "license": "ISC",
   "bin": {

package/src/shared/pageobjects/page.ts

@@ -112,14 +112,23 @@ export default class Page {
     }
 
     /**
-     * Toggles a parent tree item open without navigating — the expand icon's own click handler
-     * calls preventDefault/stopPropagation, unlike the tile's main link. Needed to reach a child
-     * row (e.g. a nested Redoc spec) that isn't rendered in the DOM until its parent is expanded.
+     * Opens a parent row without navigating. The icon toggles, so skip the click when
+     * the row is already open. WebDriver's click throws on the SVG inside dx-icon, so
+     * click through the DOM instead.
      */
     async expandTreeItem(treeItem: WebdriverIO.Element): Promise<void> {
         const tile = await this.getTreeItemTile(treeItem);
         const icon = await tile.shadow$('.tile-expand-icon dx-icon');
-        await icon.click();
+        if ((await icon.getAttribute('aria-expanded')) !== 'true') {
+            await browser.execute((expandIcon: { click: () => void }) => {
+                expandIcon.click();
+            }, icon);
+        }
+
+        await browser.waitUntil(async () => (await treeItem.shadow$$('dx-tree-item')).length > 0, {
+            timeout: 5000,
+            timeoutMsg: 'Expected the tree item to expand and render its children',
+        });
     }
 
     async findTreeItemByLabel(

package/src/shared/pageobjects/topic-version.page.ts

@@ -63,21 +63,18 @@ export default class TopicVersionPage extends Page {
         return wrapper.$('doc-version-picker');
     }
 
-    /** Clicks a sidebar tree item and waits for the Redoc page it opens to load. */
     async openRedocFromSidebar(label: string): Promise<void> {
         const item = await this.getSidebarTreeItem(label);
         await item.click();
         await this.waitForRedocTopicLoad();
     }
 
-    /** Selects a version on the Redoc page's own picker and waits for the new spec to load. */
     async selectRedocVersionByLabel(label: string): Promise<void> {
         const picker = await this.getRedocPicker();
         await this.selectVersionByLabel(picker!, label);
         await this.waitForRedocTopicLoad();
     }
 
-    /** Clicks the Redoc back link and waits for the markdown page it returns to load. */
     async goBackFromRedoc(): Promise<void> {
         await (await this.getRedocBackLink()).click();
         await this.waitForMarkdownTopicLoad();
@@ -149,12 +146,17 @@ export default class TopicVersionPage extends Page {
     }
 
     async getOptionLabel(option: WebdriverIO.Element): Promise<string> {
-        const label = await option.shadow$('div>div');
+        const label = await option.shadow$('.option_label');
         return (await label.getText()).trim();
     }
 
     async selectVersionByLabel(picker: WebdriverIO.Element, label: string): Promise<void> {
         await this.openPicker(picker);
+        // The menu fades in. isDisplayed is false while its opacity is still 0.
+        await browser.waitUntil(async () => (await this.getVersionOptions()).length > 0, {
+            timeout: 5000,
+            timeoutMsg: 'Expected the version menu to show its options',
+        });
         const options = await this.getVersionOptions();
         for (const option of options) {
             if ((await this.getOptionLabel(option)) === label) {

package/src/shared/specs/topicVersioning.test.ts

@@ -235,8 +235,8 @@ describe('Topic-level versioning > versioned parent with own content, subtopics
         page.open();
         await page.waitForMarkdownTopicLoad();
 
-        // "Another Spec API" isn't rendered in the DOM until its parent is expanded — expanding
-        // doesn't navigate, so Get Started stays the referrer once we click into the spec below.
+        // The spec row is absent until its parent is expanded. Expanding does not
+        // navigate, so Get Started stays the referrer.
         const parent = await page.getSidebarTreeItem('Errors and Rate Limits');
         await page.expandTreeItem(parent);
 
@@ -249,9 +249,8 @@ describe('Topic-level versioning > versioned parent with own content, subtopics
     });
 
     it('should fall back to the project landing page when the Redoc page is opened with no referrer', async () => {
-        // Simulates a fresh direct visit: no stored back target, and `page.open()` (a WebDriver
-        // navigation, not a link click) never sets document.referrer either. Routes through
-        // globalThis since the tsconfig's lib list omits "DOM" (see readSessionVersionSelections).
+        // No stored back target. WebDriver navigation also leaves document.referrer empty.
+        // globalThis: this package's tsconfig lib list omits DOM.
         await browser.execute(() =>
             (globalThis as any).sessionStorage.removeItem('redoc-back-target'),
         );
@@ -263,8 +262,7 @@ describe('Topic-level versioning > versioned parent with own content, subtopics
         await page.selectRedocVersionByLabel(ERRORS_V1_LABEL);
         await page.goBackFromRedoc();
 
-        // Get Started is the first topic in the TOC, so it's the project's landing page
-        // (headerHref) — and it's unversioned, so no version segment should leak onto it either.
+        // With no back target, Back goes to the first TOC topic. That topic is unversioned.
         await page.waitForUrlToContain(`${BASE}/get-started.html`);
         expect(await browser.getUrl()).not.toContain('/v1/');
     });