@salesforcedevs/sfdocs-e2e 1.0.6-toolbaralpha2 → 1.0.7-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/sfdocs-e2e",
-  "version": "1.0.6-toolbaralpha2",
+  "version": "1.0.7-alpha",
   "description": "E2E test suite for SFDocs static portal pages (SSG)",
   "license": "ISC",
   "bin": {
@@ -38,14 +38,5 @@
   },
   "devDependencies": {
     "@types/mocha": "^10.0.1"
-  },
-  "engines": {
-    "node": "22.x",
-    "yarn": ">=1.22.22 <2.0.0"
-  },
-  "packageManager": "yarn@1.22.22",
-  "volta": {
-    "node": "22.19.0",
-    "yarn": "1.22.22"
   }
 }

package/portal-wdio.conf.js

@@ -4,5 +4,4 @@ exports.config = {
     ...BASE_CONFIG.config,
     baseUrl: process.env.E2E_BASE_URL || 'http://localhost:3001',
     specs: ['./src/portal/specs/**/*.test.ts', './src/shared/specs/*.test.ts'],
-    exclude: ['./src/shared/specs/contentActionToolbar.test.ts'],
 };

package/src/shared/pageobjects/api-redoc-reference.page.ts

@@ -35,11 +35,6 @@ class ApiRedocReferencePage extends Page {
         const lnbItems = await scrollbarContainer.$$('ul[role="menu"] > li');
         return lnbItems[index];
     }
-
-    async getProjectHeader(): Promise<WebdriverIO.Element> {
-        const sidebar = await this.getSidebar();
-        return sidebar.$('div.redoc-project-header');
-    }
 }
 
 export default ApiRedocReferencePage;

package/src/shared/pageobjects/reference.page.ts

@@ -38,13 +38,4 @@ export class ReferencePage extends Page {
     async getSidebarContent(): Promise<WebdriverIO.Element> {
         return $('>>>div .sidebar-item-selected');
     }
-
-    async getSidebar(): Promise<WebdriverIO.Element> {
-        return (await $('>>>doc-content-layout')).shadow$('div > dx-sidebar-old');
-    }
-
-    async getSidebarItems(): Promise<WebdriverIO.ElementArray> {
-        const sidebar = await this.getSidebar();
-        return sidebar.shadow$$('div.container div.sidebar-content dx-tree');
-    }
 }

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

@@ -6,26 +6,55 @@ let liquidEnabled = false;
 describe('Liquid Template Rendering', () => {
     before(async () => {
         try {
+            // Check frontmatter to determine if Liquid is enabled
+            let frontmatterCheckSucceeded = false;
+
+            try {
+                const fs = require('fs');
+                const path = require('path');
+                const matter = require('gray-matter');
+
+                const contentPath = path.resolve(
+                    __dirname,
+                    '../../../../example-repository/content/en-us/liquid-project/guides/liquid-quickstart.md',
+                );
+
+                if (fs.existsSync(contentPath)) {
+                    const fileContent = fs.readFileSync(contentPath, 'utf-8');
+                    const { data: frontmatter } = matter(fileContent);
+                    liquidEnabled = frontmatter?.liquid?.enabled === true;
+                    frontmatterCheckSucceeded = true;
+                }
+            } catch (frontmatterError) {
+                // Frontmatter check failed (file not found or gray-matter not available)
+                // Fall back to checking rendered output
+                frontmatterCheckSucceeded = false;
+            }
+
+            // Initialize page for tests
             page = new GuidePage('/docs/liquid-project/guide/liquid-quickstart.html');
             page.open();
             await page.waitPageLoad();
 
-            const content = await $('>>>doc-content-layout');
-            const text = await content.getText();
-            const html = await content.getHTML();
-
-            const hasLiquidOutput = text.includes('Hello from data.yaml');
-            const hasRawSyntax =
-                html.includes('{{ data.greeting }}') ||
-                html.includes('{{ topic }}') ||
-                (html.includes('{{') && html.includes('{%'));
-
-            if (hasRawSyntax) {
-                liquidEnabled = false;
-            } else if (hasLiquidOutput) {
-                liquidEnabled = true;
-            } else {
-                liquidEnabled = false;
+            // Fallback: If frontmatter check didn't succeed, check rendered output
+            if (!frontmatterCheckSucceeded) {
+                const content = await $('>>>doc-content-layout');
+                const text = await content.getText();
+                const html = await content.getHTML();
+
+                const hasLiquidOutput = text.includes('Hello from data.yaml');
+                const hasRawSyntax =
+                    html.includes('{{ data.greeting }}') ||
+                    html.includes('{{ topic }}') ||
+                    (html.includes('{{') && html.includes('{%'));
+
+                if (hasRawSyntax) {
+                    liquidEnabled = false;
+                } else if (hasLiquidOutput) {
+                    liquidEnabled = true;
+                } else {
+                    liquidEnabled = false;
+                }
             }
         } catch (e) {
             liquidEnabled = false;

package/src/shared/specs/redoc-reference.test.ts

@@ -1,7 +1,6 @@
 import { it } from 'mocha';
 import RedocApisPage from '../pageobjects/api-redoc-reference.page';
 import OverviewPage from '../pageobjects/overview.page';
-import { ReferencePage } from '../pageobjects/reference.page';
 import {
     waitAndGetDocPhaseParentInRedocReferencesPage,
     assertDocPhaseUnavailability,
@@ -10,7 +9,6 @@ import {
 } from '../pageobjects/doc-phase-config';
 
 let page: RedocApisPage;
-let refPage: ReferencePage;
 describe('Redoc API Reference page', () => {
     describe('check layouts', () => {
         before(async () => {
@@ -169,145 +167,4 @@ describe('Redoc API Reference page', () => {
             expect(await heading.isDisplayedInViewport()).toBe(true);
         });
     });
-
-    describe('Flexible References with Redoc Rendering', () => {
-        describe('All references view', () => {
-            before(async () => {
-                refPage = new ReferencePage('docs/service/multi-oas-redoc/references');
-                refPage.open();
-
-                await refPage.waitForMarkdownBasedReferencePageLoad();
-            });
-
-            it('should display all reference titles in LNB', async () => {
-                const treeItems = await refPage.getSidebarItems();
-
-                expect(treeItems.length).toEqual(3);
-            });
-
-            it('should show arrow button after OAS reference titles', async () => {
-                const sideBarContent = await refPage.getSidebarItems();
-
-                const secondItem = sideBarContent[1];
-                const treeItem = await secondItem.shadow$('dx-tree-item');
-                const treeTile = await treeItem.shadow$('a > dx-tree-tile');
-                const arrowIcon = await treeTile.shadow$(
-                    'a > div[role="heading"] > div.tile-forward-arrow',
-                );
-
-                expect(await arrowIcon.isExisting()).toBeTruthy();
-            });
-        });
-
-        describe('Navigation and content verification', () => {
-            it('should display markdown content when first reference is clicked', async () => {
-                const sideBarContent = await refPage.getSidebarItems();
-                const firstItem = sideBarContent[0];
-                const treeItem = await firstItem.shadow$('dx-tree-item');
-                await treeItem.click();
-
-                const contentLayout = await $('>>>doc-content-layout');
-                await contentLayout.waitForDisplayed();
-
-                expect(await contentLayout.isDisplayed()).toBeTruthy();
-
-                const heading = await $('>>>h1');
-                const headingText = await heading.getText();
-
-                expect(headingText).toEqual('Metamind API references');
-            });
-
-            it('should display Redoc UI when OAS reference is clicked', async () => {
-                await browser.url('/docs/service/multi-oas-redoc/references');
-                await refPage.waitForMarkdownBasedReferencePageLoad();
-
-                const sideBarContent = await refPage.getSidebarItems();
-                const secondItem = sideBarContent[1];
-                const treeItem = await secondItem.shadow$('dx-tree-item');
-                await treeItem.click();
-
-                const redocContainer = await $('doc-redoc-reference > .redoc-container');
-                await redocContainer.waitForDisplayed({ timeout: 30000 });
-
-                expect(await redocContainer.isDisplayed()).toBeTruthy();
-
-                page = new RedocApisPage(
-                    'docs/service/multi-oas-redoc/references/redoc-orders-multiple',
-                );
-            });
-
-            it('should have the correct api info title', async () => {
-                const apiTitle = await page.getApiTitle();
-                const titleText = await apiTitle.getText();
-
-                expect(titleText).toMatch('Einstein Vision and Einstein Language');
-            });
-
-            it('should display current reference title and "All References" with back arrow in LNB', async () => {
-                const projectHeaderContainer = await page.getProjectHeader();
-
-                const backButton = await projectHeaderContainer.$('a.redoc-project-back');
-                const allReference = await backButton.$('span.redoc-project-title');
-                const specTitle = await projectHeaderContainer.$('h2.redoc-spec-title');
-
-                expect(await allReference.getText()).toEqual('All Reference');
-                expect(await backButton.isExisting()).toBeTruthy();
-                expect(await specTitle.getText()).toEqual('Orders API');
-            });
-        });
-
-        describe('Navigation back to all references', () => {
-            before(async () => {
-                page = new RedocApisPage(
-                    'docs/service/multi-oas-redoc/references/redoc-orders-multiple',
-                );
-                page.open();
-                await page.waitPageLoad();
-            });
-
-            it('should navigate back to main URL when back arrow is clicked', async () => {
-                const projectHeaderContainer = await page.getProjectHeader();
-                const backButton = await projectHeaderContainer.$('a.redoc-project-back');
-
-                await backButton.click();
-
-                const contentLayout = await $('>>>doc-content-layout');
-                await contentLayout.waitForDisplayed();
-
-                const currentUrl = await browser.getUrl();
-
-                expect(currentUrl).toContain('/docs/service/multi-oas-redoc/references');
-                expect(currentUrl).not.toContain('redoc-orders-multiple');
-            });
-
-            it('should display all references in LNB after navigating back', async () => {
-                refPage = new ReferencePage('/docs/service/multi-oas-redoc/references');
-                const treeItems = await refPage.getSidebarItems();
-
-                expect(treeItems.length).toEqual(3);
-            });
-
-            it('should navigate to third reference when clicked', async () => {
-                const sideBarContent = await refPage.getSidebarItems();
-                const thirdItem = sideBarContent[2];
-                const treeItem = await thirdItem.shadow$('dx-tree-item');
-                await treeItem.click();
-
-                const redocContainer = await $('doc-redoc-reference > .redoc-container');
-                await redocContainer.waitForDisplayed({ timeout: 30000 });
-
-                expect(await redocContainer.isDisplayed()).toBeTruthy();
-                expect(await browser.getUrl()).toContain('redoc-quip-admin-api');
-
-                page = new RedocApisPage(
-                    'docs/service/multi-oas-redoc/references/redoc-quip-admin-api',
-                );
-
-                const apiTitle = await page.getApiTitle();
-                const titleText = await apiTitle.getText();
-
-                expect(titleText).toMatch('Quip Admin API');
-            });
-        });
-    });
 });

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

@@ -24,11 +24,8 @@ describe('Video Plugin Scenarios ', () => {
         expect(await videoTitle?.getText()).toBe('Video from YouTube');
         const videoContainer = await videoRootElement?.$('.video-plugin-container');
         const iframeElement = await videoContainer?.$('iframe');
-        // The video plugin normalizes the YouTube host to www.youtube.com to
-        // avoid a cross-origin redirect that would drop the iframe's fullscreen
-        // grant (W-23222416). The authored src is `https://youtube.com/...`.
         expect(await iframeElement?.getAttribute('src')).toBe(
-            'https://www.youtube.com/embed/di6iwHhrH6s',
+            'https://youtube.com/embed/di6iwHhrH6s',
         );
     });
 });

package/static-dsc-portal-wdio.conf.js

@@ -18,7 +18,6 @@ exports.config = {
 
     // Exclude tests that require dynamic server features or pages not in static build
     exclude: [
-        './src/shared/specs/liquid.test.ts',
         './src/portal/specs/docs.api.test.ts',
         './src/portal/specs/docs.test.ts',
         './src/shared/specs/banner.test.ts',

package/static-portal-wdio.conf.js

@@ -18,7 +18,6 @@ exports.config = {
 
     // Exclude tests that require dynamic server features or pages not in static build
     exclude: [
-        './src/shared/specs/liquid.test.ts',
         // /docs/apis landing page doesn't exist in static builds
         './src/portal/specs/docs.api.test.ts',
         // /docs landing page doesn't exist in static builds

package/wdio.conf.js

@@ -3,5 +3,4 @@ const BASE_CONFIG = require('./common-wdio.conf');
 exports.config = {
     ...BASE_CONFIG.config,
     specs: ['./src/content-repo/specs/**/*.test.ts', './src/shared/specs/*.test.ts'],
-    exclude: ['./src/shared/specs/contentActionToolbar.test.ts'],
 };

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

@@ -1,59 +0,0 @@
-import GuidePage from '../pageobjects/guide.page';
-import { ReferencePage } from '../pageobjects/reference.page';
-
-const EN_US_GUIDE_PATH = '/docs/service/vscode-maintainer/guide/vscode-overview.html';
-const EN_US_MARKDOWN_REFERENCE_PATH =
-    '/docs/commerce/flexible-references/references/shopper-manual-ref/quick-start.html';
-const NON_MARKDOWN_REFERENCE_PATH = '/docs/test-metamind-oas-api/references/1mkfx9?meta=Summary';
-const NON_EN_US_MARKDOWN_REFERENCE_PATH =
-    '/docs/commerce/ja-jp/flex-references-loc/references/manual-ref/commerce-cloud-api-overview.html';
-
-async function expectToolbarButtons(toolbar: WebdriverIO.Element): Promise<void> {
-    const toolbarButtons = await toolbar.shadow$$('dx-button.toolbar-button');
-    expect(toolbarButtons.length).toBe(3);
-
-    const labels = await Promise.all(
-        toolbarButtons.map(async (button) => (await button.getText()).trim()),
-    );
-    expect(labels).toEqual(
-        expect.arrayContaining(['Copy as Markdown', 'View as Markdown', 'Copy URL to Markdown']),
-    );
-}
-
-describe('Content action toolbar scenarios', () => {
-    it('Markdown guide should have the toolbar', async () => {
-        const page = new GuidePage(EN_US_GUIDE_PATH);
-        page.open();
-        await page.waitPageLoad();
-
-        const toolbar = await $('>>>doc-content-action-toolbar');
-        await toolbar.waitForDisplayed();
-        await expectToolbarButtons(toolbar);
-    });
-
-    it('Markdown reference should have the toolbar', async () => {
-        const referencePage = new ReferencePage(EN_US_MARKDOWN_REFERENCE_PATH);
-        referencePage.open();
-        await referencePage.waitForMarkdownBasedReferencePageLoad();
-
-        const toolbar = await $('>>>doc-content-action-toolbar');
-        await toolbar.waitForDisplayed();
-        await expectToolbarButtons(toolbar);
-    });
-
-    it("Non-markdown reference shouldn't have toolbar", async () => {
-        const referencePage = new ReferencePage(NON_MARKDOWN_REFERENCE_PATH);
-        referencePage.open();
-        await referencePage.waitForSpecBasedReferencePageLoad();
-
-        const toolbar = await $('>>>doc-content-action-toolbar');
-        expect(await toolbar.isExisting()).toBeFalsy();
-    });
-
-    it("Non en-us locale page shouldn't have toolbar", async () => {
-        const nonEnUsReferencePage = new ReferencePage(NON_EN_US_MARKDOWN_REFERENCE_PATH);
-        nonEnUsReferencePage.open();
-        await nonEnUsReferencePage.waitForMarkdownBasedReferencePageLoad();
-        expect(await (await $('>>>doc-content-action-toolbar')).isExisting()).toBeFalsy();
-    });
-});