@salesforcedevs/sfdocs-e2e 1.0.11 → 1.0.12-e2e-topic-version-2

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

@@ -85,7 +85,7 @@ describe('Docs content type', () => {
         await parentTile.click();
         await page.waitPageLoad();
 
-        expect(await browser.getUrl()).toContain('parent-with-refs.html');
+        expect(await browser.getUrl()).toContain('errors-and-rate-limits.html');
         expect(await (await page.getContentHeading()).getText()).toContain(
             'Errors and Rate Limits',
         );
@@ -197,7 +197,7 @@ describe('Docs content type > internal links', () => {
 
 describe('Docs content type > spec (Redoc) topic', () => {
     beforeEach(async () => {
-        page = new DocsPage('/docs/docs-content-type-example/sample-api');
+        page = new DocsPage('/docs/docs-content-type-example/widgets-api-reference');
         page.open();
         await page.waitForRedocLoad();
     });
@@ -218,7 +218,7 @@ describe('Docs content type > spec (Redoc) topic', () => {
 
     it('falls back to the landing topic when the back link is clicked on a directly opened spec', async () => {
         await browser.reloadSession();
-        page = new DocsPage('/docs/docs-content-type-example/sample-api');
+        page = new DocsPage('/docs/docs-content-type-example/widgets-api-reference');
         page.open();
         await page.waitForRedocLoad();
 
@@ -245,7 +245,7 @@ describe('Docs content type > locale picker', () => {
     });
 
     it('shows the language picker on a spec topic of a localized project', async () => {
-        page = new DocsPage('/docs/docs-content-type-example/sample-api');
+        page = new DocsPage('/docs/docs-content-type-example/widgets-api-reference');
         page.open();
         await page.waitForRedocLoad();
 
@@ -256,7 +256,7 @@ describe('Docs content type > locale picker', () => {
     });
 
     it('re-renders the spec in the selected locale when switching language on a spec page', async () => {
-        page = new DocsPage('/docs/docs-content-type-example/sample-api');
+        page = new DocsPage('/docs/docs-content-type-example/widgets-api-reference');
         page.open();
         await page.waitForRedocLoad();
 
@@ -290,6 +290,292 @@ describe('Docs content type > locale picker', () => {
     });
 });
 
+describe('Docs content type > localized (ja-jp) rendering', () => {
+    it('renders the Japanese body and sidebar on a ja-jp markdown topic', async () => {
+        page = new DocsPage('/docs/ja-jp/docs-content-type-example/get-started.html');
+        page.open();
+        await page.waitPageLoad();
+        await page.waitForSidebar();
+
+        expect(await (await page.getContentHeading()).getText()).toContain(
+            'ウィジェット サービスを始める',
+        );
+        // Sidebar tiles are localized — the Japanese "Widget Concepts" label resolves.
+        const tile = await page.getSidebarTile('ウィジェットの概念');
+        expect(await tile.isExisting()).toBe(true);
+    });
+
+    it('renders the Redoc view from a ja-jp spec URL', async () => {
+        page = new DocsPage('/docs/ja-jp/docs-content-type-example/widgets-api-reference');
+        page.open();
+        await page.waitForRedocLoad();
+
+        expect(await browser.getUrl()).toContain('/ja-jp/');
+        expect(await (await page.getRedocApiTitle()).getText()).not.toBe('');
+    });
+});
+
+describe('Docs content type > englishonly filter', () => {
+    it('serves the englishonly topic in English', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/us-compliance-notes.html');
+        page.open();
+        await page.waitPageLoad();
+
+        expect(await (await page.getContentHeading()).getText()).toContain('US Compliance Notes');
+    });
+});
+
+describe('Docs content type > language picker round-trip', () => {
+    it('switches a markdown topic between English and Japanese and back', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/get-started.html');
+        page.open();
+        await page.waitPageLoad();
+        await page.waitForSidebar();
+
+        await page.selectLanguage('日本語');
+        await page.waitPageLoad();
+        expect(await browser.getUrl()).toContain('/ja-jp/');
+        expect(await browser.getUrl()).toContain('get-started.html');
+        expect(await (await page.getContentHeading()).getText()).toContain(
+            'ウィジェット サービスを始める',
+        );
+
+        await page.selectLanguage('English');
+        await page.waitPageLoad();
+        expect(await browser.getUrl()).not.toContain('/ja-jp/');
+        expect(await browser.getUrl()).toContain('get-started.html');
+        expect(await (await page.getContentHeading()).getText()).toContain('Get Started');
+    });
+});
+
+describe('Docs content type > external link', () => {
+    it('exposes the real href and opens the external link in a new tab', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/get-started.html');
+        page.open();
+        await page.waitPageLoad();
+        await page.waitForSidebar();
+
+        const anchor = await page.getTileAnchor('Salesforce Developers');
+        expect(await anchor.getAttribute('href')).toContain('https://developer.salesforce.com');
+        expect(await anchor.getAttribute('target')).toBe('_blank');
+    });
+});
+
+describe('Docs content type > Liquid templating', () => {
+    beforeEach(async () => {
+        page = new DocsPage('/docs/docs-content-type-example/liquid-widgets.html');
+        page.open();
+        await page.waitPageLoad();
+    });
+
+    it('resolves frontmatter assigns and liquid.data values in the body', async () => {
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('Widget Automation');
+        expect(text).toContain('Hello from the docs liquid data file');
+        expect(html).not.toContain('{% assign');
+        expect(html).not.toContain('{{ feature }}');
+        expect(html).not.toContain('{{ data.tagline }}');
+    });
+
+    it('resolves repository-level variables from content-config.yml', async () => {
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('Salesforce Platform');
+        expect(text).toContain('62.0');
+        expect(html).not.toContain('{{ variables.platform');
+    });
+
+    it('renders a loop over a liquid.data array', async () => {
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('createWidget()');
+        expect(text).toContain('updateWidget()');
+        expect(text).toContain('deleteWidget()');
+        expect(html).not.toContain('for operation in data.operations');
+    });
+
+    it('resolves output expressions inside code blocks but keeps tags literal', async () => {
+        const codeBlockElement = await $('>>>.code-block-content');
+        const codeBlock = await codeBlockElement.shadow$('code');
+
+        expect(await codeBlock.isExisting()).toBeTruthy();
+
+        const codeText = await codeBlock.getText();
+        // {{ }} outputs resolve even inside code blocks.
+        expect(codeText).not.toContain('{{ data.tagline }}');
+        expect(codeText).toContain('Hello from the docs liquid data file');
+        expect(codeText).toContain('Widget Automation');
+        // {% %} tags stay literal inside code blocks.
+        expect(codeText).toContain('for op in ops');
+    });
+
+    it('renders a shared partial pulled in via include and its capture blocks', async () => {
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('Reusable Tip');
+        expect(text).toContain('Widgets are created and managed through the Widgets API');
+        expect(text).toContain('Reusable Note');
+        expect(text).toContain('Every widget has a unique identifier');
+        // Dash-form tags are the fixture's real (resolved) tags; the bare "{% include %}"
+        // in the prose renders as literal inline code, so assert on the dash form only.
+        expect(html).not.toContain('{%- include');
+        expect(html).not.toContain('{%- capture');
+        expect(html).not.toContain('{{ liquid-widgets-reuse-tip }}');
+    });
+});
+
+describe('Docs content type > Liquid data object format', () => {
+    it('loads multiple data files each under a named key', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/liquid-multi-data.html');
+        page.open();
+        await page.waitPageLoad();
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('Hello from the docs liquid data file');
+        expect(text).toContain('Second data file loaded under a named key');
+        expect(html).not.toContain('{{ data.one.tagline }}');
+        expect(html).not.toContain('{{ two.summary }}');
+    });
+});
+
+describe('Docs content type > Liquid templating (ja-jp)', () => {
+    let jaLiquidEnabled = false;
+    const widgetsPath = '/docs/ja-jp/docs-content-type-example/liquid-widgets.html';
+
+    before(async () => {
+        try {
+            page = new DocsPage(widgetsPath);
+            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(
+                'ドキュメント Liquid データ ファイルからこんにちは',
+            );
+            const hasRawSyntax = html.includes('{% assign') || html.includes('{{ data.tagline }}');
+
+            jaLiquidEnabled = hasLiquidOutput && !hasRawSyntax;
+        } catch (e) {
+            jaLiquidEnabled = false;
+        }
+    });
+
+    beforeEach(async () => {
+        if (jaLiquidEnabled) {
+            page = new DocsPage(widgetsPath);
+            page.open();
+            await page.waitPageLoad();
+        }
+    });
+
+    it('resolves frontmatter assigns and liquid.data values in a localized topic', async function () {
+        if (!jaLiquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('ウィジェット オートメーション');
+        expect(text).toContain('ドキュメント Liquid データ ファイルからこんにちは');
+        expect(html).not.toContain('{% assign');
+        expect(html).not.toContain('{{ data.tagline }}');
+    });
+
+    it('resolves repository-level variables in a localized topic', async function () {
+        if (!jaLiquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('Salesforce Platform');
+        expect(text).toContain('62.0');
+        expect(html).not.toContain('{{ variables.platform');
+    });
+
+    it('renders a loop and an included partial capture block in a localized topic', async function () {
+        if (!jaLiquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('createWidget()');
+        expect(text).toContain('再利用可能なヒント');
+        expect(text).toContain('ウィジェットは Widgets API を通じて作成および管理されます');
+        expect(html).not.toContain('for operation in data.operations');
+        expect(html).not.toContain('{%- include');
+        expect(html).not.toContain('{%- capture');
+    });
+});
+
+describe('Docs content type > Liquid data object format (ja-jp)', () => {
+    let jaLiquidEnabled = false;
+    const multiDataPath = '/docs/ja-jp/docs-content-type-example/liquid-multi-data.html';
+
+    before(async () => {
+        try {
+            page = new DocsPage(multiDataPath);
+            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(
+                'ドキュメント Liquid データ ファイルからこんにちは',
+            );
+            const hasRawSyntax =
+                html.includes('{{ data.one.tagline }}') || html.includes('{{ two.summary }}');
+
+            jaLiquidEnabled = hasLiquidOutput && !hasRawSyntax;
+        } catch (e) {
+            jaLiquidEnabled = false;
+        }
+    });
+
+    it('loads multiple data files each under a named key in a localized topic', async function () {
+        if (!jaLiquidEnabled) {
+            this.skip();
+        }
+
+        page = new DocsPage(multiDataPath);
+        page.open();
+        await page.waitPageLoad();
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('ドキュメント Liquid データ ファイルからこんにちは');
+        expect(text).toContain('名前付きキーの下に読み込まれる 2 番目のデータ ファイル');
+        expect(html).not.toContain('{{ data.one.tagline }}');
+        expect(html).not.toContain('{{ two.summary }}');
+    });
+});
+
 describe('Docs content type > error routes', () => {
     const expectNotFoundPage = async (): Promise<void> => {
         const errorComponent = await $('dx-error');

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

@@ -1,3 +1,4 @@
+import DocsPage from '../pageobjects/docs.page';
 import GuidePage from '../pageobjects/guide.page';
 
 let page: GuidePage;
@@ -54,3 +55,56 @@ describe('Liquid Template Rendering — Advanced', () => {
         expect(text.includes('previewFuture')).toBeTruthy();
     });
 });
+
+describe('Docs content type > future filter', () => {
+    let docsFutureEnabled = false;
+    const overviewPath = '/docs/docs-content-type-example/get-started.html';
+
+    before(async () => {
+        try {
+            const docsPage = new DocsPage(overviewPath);
+            docsPage.open();
+            await docsPage.waitPageLoad();
+
+            const content = await $('>>>doc-content-layout');
+            const text = await content.getText();
+
+            docsFutureEnabled = text.includes(
+                'hidden in production and excluded from localization unless',
+            );
+        } catch (e) {
+            docsFutureEnabled = false;
+        }
+    });
+
+    it('renders an inline future block when previewFuture is enabled', async function () {
+        if (!docsFutureEnabled) {
+            this.skip();
+        }
+
+        const docsPage = new DocsPage(overviewPath);
+        docsPage.open();
+        await docsPage.waitPageLoad();
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text).toContain('hidden in production and excluded from localization unless');
+        expect(html).not.toContain('{% future');
+    });
+
+    it('renders the future topic page when previewFuture is enabled', async function () {
+        if (!docsFutureEnabled) {
+            this.skip();
+        }
+
+        const docsPage = new DocsPage('/docs/docs-content-type-example/upcoming-graphql.html');
+        docsPage.open();
+        await docsPage.waitPageLoad();
+
+        expect(await (await docsPage.getContentHeading()).getText()).toContain(
+            'Upcoming: GraphQL API',
+        );
+    });
+});

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

@@ -222,3 +222,100 @@ describe('Liquid Template Rendering', () => {
         expect(text.includes('Liquid is a templating language supported in SFDocs')).toBeTruthy();
     });
 });
+
+describe('Liquid Template Rendering — Localized (ja-jp)', () => {
+    let jaLiquidEnabled = false;
+    const quickstartPath = '/docs/ja-jp/liquid-project/guide/liquid-quickstart.html';
+
+    before(async () => {
+        try {
+            page = new GuidePage(quickstartPath);
+            await browser.url(page.path);
+            await page.waitPageLoad();
+
+            const content = await $('>>>doc-content-layout');
+            const text = await content.getText();
+            const html = await content.getHTML();
+
+            const hasLiquidOutput = text.includes('data.yaml からこんにちは');
+            const hasRawSyntax =
+                html.includes('{% assign topic') || html.includes('{{ data.greeting }}');
+
+            jaLiquidEnabled = hasLiquidOutput && !hasRawSyntax;
+        } catch (e) {
+            jaLiquidEnabled = false;
+        }
+    });
+
+    beforeEach(async () => {
+        if (jaLiquidEnabled) {
+            page = new GuidePage(quickstartPath);
+            await browser.url(page.path);
+            await page.waitPageLoad();
+        }
+    });
+
+    it('Should render frontmatter assigns and data.yaml values in Japanese', async function () {
+        if (!jaLiquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+
+        expect(text.includes('ライターのための GitHub')).toBeTruthy();
+        expect(text.includes('data.yaml からこんにちは')).toBeTruthy();
+    });
+
+    it('Should render repository-level variables in a localized topic', async function () {
+        if (!jaLiquidEnabled) {
+            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(html.includes('{{ variables.platform')).toBeFalsy();
+    });
+
+    it('Should render a loop and an included partial capture block in Japanese', async function () {
+        if (!jaLiquidEnabled) {
+            this.skip();
+        }
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text.includes('create()')).toBeTruthy();
+        expect(text.includes('再利用可能なヒント')).toBeTruthy();
+        expect(
+            text.includes('ウィジェットは Widgets API を通じて作成および管理されます'),
+        ).toBeTruthy();
+        // Dash-form tags are the fixture's real (resolved) tags; the bare "{% include %}"
+        // in the prose renders as literal inline code, so assert on the dash form only.
+        expect(html.includes('{%- include')).toBeFalsy();
+        expect(html.includes('{%- capture')).toBeFalsy();
+    });
+
+    it('Should render liquid.data object format in a localized topic', async function () {
+        if (!jaLiquidEnabled) {
+            this.skip();
+        }
+
+        const multiDataPage = new GuidePage('/docs/ja-jp/liquid-project/guide/multi-data.html');
+        await browser.url(multiDataPage.path);
+        await multiDataPage.waitPageLoad();
+
+        const content = await $('>>>doc-content-layout');
+        const text = await content.getText();
+        const html = await content.getHTML();
+
+        expect(text.includes('小売店舗や顧客サイト')).toBeTruthy();
+        expect(html.includes('{{ data.one.summary }}')).toBeFalsy();
+        expect(html.includes('{{ two.summary }}')).toBeFalsy();
+    });
+});

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

@@ -187,11 +187,9 @@ describe('Redoc API Reference page', () => {
 
             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$(
+                const treeItem = await sideBarContent[1].shadow$('dx-tree-item');
+                const tile = await refPage.getTreeItemTile(treeItem);
+                const arrowIcon = await tile.shadow$(
                     'a > div[role="heading"] > div.tile-forward-arrow',
                 );
 

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

@@ -106,7 +106,7 @@ describe('Reference Versioning', () => {
         const versionBtn = await $('>>>.version-picker-button');
         await versionBtn.waitForDisplayed();
         await versionBtn.click();
-        const versionOptions = await $$('>>>doc-version-picker dx-dropdown-option');
+        const versionOptions = await referencePage.getVersionOptions();
 
         expect(versionOptions.length).toEqual(2);
         expect(await (await versionOptions[0].shadow$('div>div')).getText()).toEqual('0.1.3');
@@ -131,7 +131,7 @@ describe('Reference Versioning', () => {
         await versionBtn.waitForDisplayed();
         await versionBtn.click();
 
-        const versionOptions = await $$('>>>doc-version-picker dx-dropdown-option');
+        const versionOptions = await referencePage.getVersionOptions();
 
         await versionOptions[1].waitForClickable();
         await versionOptions[1].click();
@@ -150,7 +150,7 @@ describe('Reference Versioning', () => {
         await versionPicker.waitForDisplayed();
         await versionPicker.click();
 
-        const versionOptions = await $$('>>>doc-version-picker dx-dropdown-option');
+        const versionOptions = await referencePage.getVersionOptions();
         const selectedVersionText = await (await versionOptions[1].shadow$('div>div')).getText();
 
         await versionOptions[1].click();