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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/sfdocs-e2e",
-  "version": "1.0.6",
+  "version": "1.0.7-liquid-alpha",
   "description": "E2E test suite for SFDocs static portal pages (SSG)",
   "license": "ISC",
   "bin": {

package/portal-wdio.conf.js

@@ -4,4 +4,5 @@ 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/content-repo/specs/homepage.test.ts

@@ -13,7 +13,7 @@ describe('Homepage', () => {
     it('should show the expected number of projects', async () => {
         const projectCards = await HomePage.projectCards;
 
-        expect(projectCards.length).toEqual(20);
+        expect(projectCards.length).toEqual(21);
     });
 
     // it('is accessible', () => {

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

@@ -0,0 +1,59 @@
+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();
+    });
+});

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

@@ -64,7 +64,7 @@ describe('Test Guides page components functionality> ', () => {
         const sidebar = await (await $('doc-content-layout')).shadow$('div > dx-sidebar-old');
         const sideBarContent = await sidebar.shadow$$('div.container div.sidebar-content dx-tree');
 
-        expect(sideBarContent.length).toEqual(4);
+        expect(sideBarContent.length).toEqual(6);
 
         const nextStepOption = await (
             await sideBarContent[3].shadow$('dx-tree-item')

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

@@ -131,6 +131,113 @@ describe('Liquid Template Rendering', () => {
         expect(html.includes('{{ id2 }}')).toBeFalsy();
     });
 
+    it('Should render repository-level variables from content-config.yml', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text.includes('Salesforce Platform')).toBeTruthy();
+        expect(text.includes('62.0')).toBeTruthy();
+        expect(text.includes('sf')).toBeTruthy();
+        expect(html.includes('{{ variables.platform')).toBeFalsy();
+    });
+
+    it('Should render englishonly block content in production', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text.includes('This feature is currently only available in English')).toBeTruthy();
+        expect(html.includes('{% englishonly')).toBeFalsy();
+        expect(html.includes('{% endenglishonly')).toBeFalsy();
+    });
+
+    it('Should render future block content when previewFuture is enabled', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text.includes('Coming Soon')).toBeTruthy();
+        expect(html.includes('{% future')).toBeFalsy();
+        expect(html.includes('{% endfuture')).toBeFalsy();
+    });
+
+    it('Should render liquid.data string format — single YAML file on root context', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text.includes('Hello from data.yaml')).toBeTruthy();
+        expect(html.includes('{{ data.greeting }}')).toBeFalsy();
+    });
+
+    it('Should render liquid.data object format — multiple YAML files each under a named key', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const dataFormatsPage = new GuidePage('/docs/redirects/guide/orders-api-overview.html');
+        dataFormatsPage.open();
+        await dataFormatsPage.waitPageLoad();
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text.includes('Sample data file to check the multi-include')).toBeTruthy();
+        expect(text.includes('Represents a scheduled or completed visit')).toBeTruthy();
+        expect(html.includes('{{ two.summary }}')).toBeFalsy();
+        expect(html.includes('{{ data.one.summary }}')).toBeFalsy();
+    });
+
+    it('Should render the future topic page when previewFuture is enabled', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const futurePage = new GuidePage('/docs/liquid-project/guide/future-topic.html');
+        futurePage.open();
+        await futurePage.waitPageLoad();
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+
+        expect(text.includes('Future Feature')).toBeTruthy();
+        expect(text.includes('previewFuture')).toBeTruthy();
+    });
+
+    it('Should render the englishonly topic page', async function () {
+        if (!liquidEnabled) {
+            this.skip();
+        }
+
+        const englishOnlyPage = new GuidePage('/docs/liquid-project/guide/english-only-topic.html');
+        englishOnlyPage.open();
+        await englishOnlyPage.waitPageLoad();
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+
+        expect(text.includes('English-Only Topic')).toBeTruthy();
+        expect(text.includes('filters: [englishonly]')).toBeTruthy();
+    });
+
     it('Should not process Liquid when frontmatter has liquid.enabled as false', async function () {
         if (!liquidEnabled) {
             this.skip();

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

@@ -18,7 +18,7 @@ exports.config = {
 
     // Exclude tests that require dynamic server features or pages not in static build
     exclude: [
-        './src/shared/specs/liquid.test.ts',
+        // './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,7 @@ exports.config = {
 
     // Exclude tests that require dynamic server features or pages not in static build
     exclude: [
-        './src/shared/specs/liquid.test.ts',
+        // './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,4 +3,5 @@ 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'],
 };