@salesforcedevs/sfdocs-e2e 1.0.10-alpha → 1.0.11-toolbar.0

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

@@ -0,0 +1,615 @@
+import DocsPage from '../pageobjects/docs.page';
+import layoutTest from './layout-tests';
+
+let page: DocsPage;
+
+describe('Docs content type', () => {
+    beforeEach(async () => {
+        page = new DocsPage('/docs/docs-content-type-example/get-started.html');
+        page.open();
+        await page.waitPageLoad();
+    });
+
+    layoutTest(page, 'doc-header');
+
+    it('should render all the sidebar tree items properly', async () => {
+        await page.waitForSidebar();
+        const trees = await page.getSidebarTrees();
+
+        expect(trees.length).toBeGreaterThan(10);
+    });
+
+    it('shows a forward-arrow icon on the spec entry but not on a markdown topic', async () => {
+        await page.waitForSidebar();
+        const specArrow = await page.getTileForwardArrow('Widgets API Reference');
+        const markdownArrow = await page.getTileForwardArrow('Widget Concepts');
+
+        expect(await specArrow.isExisting()).toBe(true);
+        expect(await markdownArrow.isExisting()).toBe(false);
+    });
+
+    it('shows a new-window icon on the external-link sidebar entry', async () => {
+        await page.waitForSidebar();
+        const externalIcon = await page.getTileExternalLinkIcon('Salesforce Developers');
+
+        expect(await externalIcon.isExisting()).toBe(true);
+    });
+
+    it('navigates to a topic whose URL slug is overridden by its TOC id', async () => {
+        await page.waitForSidebar();
+        const tile = await page.getSidebarTile('Widget Concepts');
+        await tile.click();
+        await page.waitPageLoad();
+
+        expect(await browser.getUrl()).toContain('widget-concepts.html');
+        expect(await (await page.getContentHeading()).getText()).toContain('Widget Concepts');
+    });
+
+    it('expands a parent-only section and navigates to its child topic', async () => {
+        await page.waitForSidebar();
+        const parentTile = await page.getSidebarTile('Authentication');
+        await parentTile.click();
+
+        const childTile = await page.getSidebarTile('Generate API Tokens');
+        await childTile.waitForDisplayed();
+        await childTile.click();
+        await page.waitPageLoad();
+
+        expect(await browser.getUrl()).toContain('child-one.html');
+        expect(await (await page.getContentHeading()).getText()).toContain('Generate API Tokens');
+    });
+
+    it('navigates to a parent topic that has its own content, then to its nested child', async () => {
+        await page.waitForSidebar();
+        const parentTile = await page.getSidebarTile('Use the Widgets API');
+        await parentTile.click();
+        await page.waitPageLoad();
+
+        expect(await browser.getUrl()).toContain('parent-overview.html');
+        expect(await (await page.getContentHeading()).getText()).toContain('Use the Widgets API');
+
+        const childTile = await page.getSidebarTile('List and Search Widgets');
+        await childTile.waitForDisplayed();
+        await childTile.click();
+        await page.waitPageLoad();
+
+        expect(await browser.getUrl()).toContain('subtopic-one.html');
+        expect(await (await page.getContentHeading()).getText()).toContain(
+            'List and Search Widgets',
+        );
+    });
+
+    it('navigates to a nested topic and a nested spec that are pulled in via tocRefs in the TOC', async () => {
+        await page.waitForSidebar();
+        const parentTile = await page.getSidebarTile('Errors and Rate Limits');
+        await parentTile.click();
+        await page.waitPageLoad();
+
+        expect(await browser.getUrl()).toContain('parent-with-refs.html');
+        expect(await (await page.getContentHeading()).getText()).toContain(
+            'Errors and Rate Limits',
+        );
+
+        const topicTile = await page.getSidebarTile('Common Error Codes');
+        await topicTile.waitForDisplayed();
+        await topicTile.click();
+        await page.waitPageLoad();
+
+        expect(await browser.getUrl()).toContain('extra-child-a.html');
+        expect(await (await page.getContentHeading()).getText()).toContain('Common Error Codes');
+
+        const specTile = await page.getSidebarTile('Another Spec API');
+        await specTile.click();
+        await page.waitForRedocLoad();
+
+        expect(await (await page.getRedocApiTitle()).getText()).toContain('Widget Errors API');
+    });
+
+    it('resolves a markdown topic requested without the .html extension', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/get-started');
+        page.open();
+        await page.waitPageLoad();
+
+        expect(await (await page.getContentHeading()).getText()).toContain('Get Started');
+    });
+
+    it('renders a topic nested several levels deep in the TOC', async () => {
+        page = new DocsPage('/docs/docs-deep-nesting-example/introduction.html');
+        page.open();
+        await page.waitPageLoad();
+
+        expect(await (await page.getContentHeading()).getText()).toContain('Introduction');
+    });
+
+    it('sets the current page as the last breadcrumb in the hierarchy', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/child-one.html');
+        page.open();
+        await page.waitPageLoad();
+
+        expect(await page.getCurrentBreadcrumbLabel()).toBe('Generate API Tokens');
+    });
+
+    it('returns to the originating topic when the redoc back link is clicked', async () => {
+        await page.waitForSidebar();
+        const parentTile = await page.getSidebarTile('Use the Widgets API');
+        await parentTile.click();
+        await page.waitPageLoad();
+
+        const childTile = await page.getSidebarTile('List and Search Widgets');
+        await childTile.waitForDisplayed();
+        await childTile.click();
+        await page.waitPageLoad();
+        expect(await browser.getUrl()).toContain('subtopic-one.html');
+
+        const specTile = await page.getSidebarTile('Widgets API Reference');
+        await specTile.click();
+        await page.waitForRedocLoad();
+
+        const backLink = await page.getRedocBackLink();
+        await backLink.waitForDisplayed();
+        await backLink.click();
+        await page.waitPageLoad();
+
+        expect(await browser.getUrl()).toContain('subtopic-one.html');
+    });
+
+    it('renders the beta banner on a topic with releasePhase set to beta', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/beta-bulk-import.html');
+        page.open();
+        await page.waitPageLoad();
+
+        const docPhase = await $('>>>doc-phase');
+        const title = await docPhase.shadow$('.doc-phase-title');
+        const body = await docPhase.shadow$('.doc-phase-body');
+
+        expect(await title.getText()).toBe('Beta');
+        expect(await body.getText()).toContain(
+            'This beta feature is made available on an AS IS basis',
+        );
+    });
+});
+
+describe('Docs content type > internal links', () => {
+    beforeEach(async () => {
+        page = new DocsPage('/docs/docs-content-type-example/internal-linking.html');
+        page.open();
+        await page.waitPageLoad();
+    });
+
+    it('rewrites a relative .md link to its published .html url', async () => {
+        const link = await $('>>>a.internal-link-guide[href*="get-started"]');
+        await link.waitForDisplayed();
+        const href = await link.getAttribute('href');
+
+        expect(href).not.toContain('.md');
+        expect(href).toContain('get-started.html');
+    });
+
+    it('rewrites a link to an id-overridden topic to its overridden slug', async () => {
+        const link = await $('>>>a.internal-link-guide[href*="widget-concepts"]');
+        await link.waitForDisplayed();
+        const href = await link.getAttribute('href');
+
+        expect(href).not.toContain('clickable-topic');
+        expect(href).toContain('widget-concepts.html');
+    });
+});
+
+describe('Docs content type > spec (Redoc) topic', () => {
+    beforeEach(async () => {
+        page = new DocsPage('/docs/docs-content-type-example/sample-api');
+        page.open();
+        await page.waitForRedocLoad();
+    });
+
+    it('renders the spec title in the Redoc view', async () => {
+        const apiTitle = await page.getRedocApiTitle();
+
+        expect(await apiTitle.getText()).toContain('Sample Widgets API');
+    });
+
+    it('shows a back link labelled with the project title', async () => {
+        const backLink = await page.getRedocBackLink();
+        await backLink.waitForDisplayed();
+
+        expect(await backLink.isDisplayed()).toBeTruthy();
+        expect(await (await page.getRedocProjectTitle()).getText()).not.toBe('');
+    });
+
+    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.open();
+        await page.waitForRedocLoad();
+
+        const backLink = await page.getRedocBackLink();
+        await backLink.waitForDisplayed();
+        await backLink.click();
+        await page.waitPageLoad();
+
+        expect(await browser.getUrl()).toContain('get-started.html');
+    });
+});
+
+describe('Docs content type > locale picker', () => {
+    it('shows the language picker on a markdown topic of a localized project', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/widget-concepts.html');
+        page.open();
+        await page.waitPageLoad();
+        await page.waitForSidebar();
+
+        const languagePicker = await page.getLanguagePicker();
+        await languagePicker.waitForDisplayed();
+
+        expect(await languagePicker.isDisplayed()).toBeTruthy();
+    });
+
+    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.open();
+        await page.waitForRedocLoad();
+
+        const languagePicker = await page.getLanguagePicker();
+        await languagePicker.waitForDisplayed();
+
+        expect(await languagePicker.isDisplayed()).toBeTruthy();
+    });
+
+    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.open();
+        await page.waitForRedocLoad();
+
+        await page.selectLanguage('日本語');
+        await page.waitForRedocLoad();
+
+        expect(await browser.getUrl()).toContain('/ja-jp/');
+        expect(await (await page.getRedocApiTitle()).getText()).not.toBe('');
+    });
+
+    it('keeps the selected locale when navigating to the spec view 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/');
+
+        const specTile = await page.getSidebarTile('ウィジェット API リファレンス');
+        await specTile.click();
+        await page.waitForRedocLoad();
+        expect(await browser.getUrl()).toContain('/ja-jp/');
+
+        const backLink = await page.getRedocBackLink();
+        await backLink.waitForDisplayed();
+        await backLink.click();
+        await page.waitPageLoad();
+        expect(await browser.getUrl()).toContain('/ja-jp/');
+    });
+});
+
+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/sample-api');
+        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 tile = await page.getSidebarTile('Salesforce Developers');
+        const anchor = await tile.shadow$('a');
+        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');
+        await errorComponent.waitForDisplayed();
+
+        expect(await browser.getTitle()).toEqual('404 Error | Salesforce Developers');
+    };
+
+    it('renders the 404 page for a markdown topic that does not exist', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/no-such-topic.html');
+        page.open();
+
+        await expectNotFoundPage();
+    });
+
+    it('renders the 404 page for a spec topic that does not exist', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/no-such-spec');
+        page.open();
+
+        await expectNotFoundPage();
+    });
+
+    it('renders the 404 page for the original filename of an id-overridden topic', async () => {
+        page = new DocsPage('/docs/docs-content-type-example/clickable-topic.html');
+        page.open();
+
+        await expectNotFoundPage();
+    });
+
+    it('renders the 404 page for an unknown docs project', async () => {
+        page = new DocsPage('/docs/no-such-docs-project/get-started.html');
+        page.open();
+
+        await expectNotFoundPage();
+    });
+});

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')