Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -99,12 +99,15 @@ const AIDrawer = () => {
);
};

const searchParams = new URL(location.hash.substring(1), location.href).searchParams;

export const leftDrawerPayload: DrawerPayload = {
id: 'ai-panel',
resizable: true,
isExpandable: true,
defaultSize: DEFAULT_SIZE,
preserveInactiveContent: true,
defaultActive: searchParams.get('leftDrawerDefaultActive') === 'true',

ariaLabels: {
closeButton: 'Close AI Panel drawer',
Expand Down
6 changes: 6 additions & 0 deletions pages/app/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ interface GlobalFlags {
appLayoutWidget?: boolean;
appLayoutToolbar?: boolean;
appLayoutHideToolbarBreadcrumbs?: boolean;
appLayoutHideToolbar?: boolean;
appLayoutSimplifiedView?: boolean;
oneTheme?: boolean;
}
// used for local dev / testing
Expand Down Expand Up @@ -107,6 +109,8 @@ const {
appLayoutWidget,
appLayoutToolbar,
appLayoutHideToolbarBreadcrumbs,
appLayoutHideToolbar,
appLayoutSimplifiedView,
appLayoutDelayedWidget,
} = parseQuery(history.location.search);
const oneTheme = theme === Theme.OneTheme;
Expand All @@ -125,6 +129,8 @@ if (!window[awsuiCustomFlagsSymbol]) {
window[awsuiGlobalFlagsSymbol].appLayoutWidget = appLayoutWidget;
window[awsuiGlobalFlagsSymbol].appLayoutToolbar = appLayoutToolbar;
window[awsuiGlobalFlagsSymbol].appLayoutHideToolbarBreadcrumbs = appLayoutHideToolbarBreadcrumbs;
window[awsuiGlobalFlagsSymbol].appLayoutHideToolbar = appLayoutHideToolbar;
window[awsuiGlobalFlagsSymbol].appLayoutSimplifiedView = appLayoutSimplifiedView;
window[awsuiCustomFlagsSymbol].appLayoutDelayedWidget = appLayoutDelayedWidget;
window[awsuiGlobalFlagsSymbol].oneTheme = oneTheme;

Expand Down
107 changes: 107 additions & 0 deletions src/app-layout/__integ__/hide-toolbar.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { BasePageObject } from '@cloudscape-design/browser-test-tools/page-objects';
import useBrowser from '@cloudscape-design/browser-test-tools/use-browser';

import createWrapper from '../../../lib/components/test-utils/selectors';
import { getUrlParams } from './utils';

const appLayout = createWrapper().findAppLayout();
const toolbar = appLayout.findToolbar();
const appLayoutBreadcrumbs = appLayout.findBreadcrumbs().findBreadcrumbGroup();
const consumerBreadcrumbs = createWrapper().find('[data-testid="global-nav-header"]').findBreadcrumbGroup();

class HideToolbarPage extends BasePageObject {
clickTestId(testId: string) {
return this.click(`[data-testid="${testId}"]`);
}

/**
* Distance from the top of App Layout to the first header of the page content.
* The content region itself is `display: contents` and has no box to measure.
*/
async getContentOffset() {
const { top: rootTop } = await this.getBoundingBox(appLayout.toSelector());
const { top: contentTop } = await this.getBoundingBox(appLayout.findContentRegion().findHeader().toSelector());
return contentTop - rootTop;
}
}

function setupTest(params: Record<string, string>, testFn: (page: HideToolbarPage) => Promise<void>) {
return useBrowser(async browser => {
const page = new HideToolbarPage(browser);
await browser.url(`#/app-layout/global-nav-breadcrumbs?${getUrlParams('refresh-toolbar', params)}`);
await page.waitForVisible(appLayout.findContentRegion().toSelector());
await testFn(page);
});
}

const hiddenToolbarParams = { appLayoutHideToolbar: 'true' };

describe('appLayoutHideToolbar flag', () => {
test(
'renders a visible toolbar without the flag',
setupTest({}, async page => {
await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(true);
await expect(page.isDisplayed(appLayoutBreadcrumbs.toSelector())).resolves.toBe(true);
})
);

test(
'keeps the toolbar and its breadcrumbs in the DOM but not displayed',
setupTest(hiddenToolbarParams, async page => {
await expect(page.isExisting(toolbar.toSelector())).resolves.toBe(true);
await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(false);
await expect(page.isExisting(appLayoutBreadcrumbs.toSelector())).resolves.toBe(true);
await expect(page.isDisplayed(appLayoutBreadcrumbs.toSelector())).resolves.toBe(false);
})
);

// Global flags are read once on page load, so each toolbar state is measured in its own browser session
// instead of switching the URL (and relying on a reload) within one session.
test('does not reserve space for the hidden toolbar', async () => {
let toolbarHeight = 0;
let offsetWithToolbar = 0;
let offsetWithHiddenToolbar = 0;

await setupTest({}, async page => {
await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(true);
({ height: toolbarHeight } = await page.getBoundingBox(toolbar.toSelector()));
offsetWithToolbar = await page.getContentOffset();
})();

await setupTest(hiddenToolbarParams, async page => {
await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(false);
offsetWithHiddenToolbar = await page.getContentOffset();
})();

expect(toolbarHeight).toBeGreaterThan(0);
// allow 1px for sub-pixel rounding
expect(Math.abs(offsetWithToolbar - toolbarHeight - offsetWithHiddenToolbar)).toBeLessThanOrEqual(1);
});

test(
'publishes breadcrumbs to registerBreadcrumbsConsumer and keeps them updated',

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The connection between the registerBreadcrumbsConsumer and hidden toolbar is that the breadcrumbs that are rendered within the toolbar produce events with breadcrumbs items which a higher level than AppLayout (details in DM) consume and render breadcrumbs in a different place. The purpose of this and further tests is to make sure this mechanism isn't broken

setupTest(hiddenToolbarParams, async page => {
await page.clickTestId('toggle-nav-header');
await page.waitForVisible(consumerBreadcrumbs.toSelector());
await expect(page.getText(consumerBreadcrumbs.toSelector())).resolves.toContain('Resource');
await expect(page.getText(consumerBreadcrumbs.toSelector())).resolves.not.toContain('Level 3');

await page.clickTestId('append-breadcrumb');
await page.waitForAssertion(() =>
expect(page.getText(consumerBreadcrumbs.toSelector())).resolves.toContain('Level 3')
);
await expect(page.isDisplayed(toolbar.toSelector())).resolves.toBe(false);
})
);

test(
'publishes breadcrumbs to a consumer that registers after App Layout rendered',
setupTest(hiddenToolbarParams, async page => {
await page.clickTestId('delay-nav-header');
await page.waitForVisible(consumerBreadcrumbs.toSelector());
await expect(page.getText(consumerBreadcrumbs.toSelector())).resolves.toContain('Resource');
})
);
});
149 changes: 149 additions & 0 deletions src/app-layout/__tests__/hide-toolbar.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import React from 'react';
import { cleanup, render, waitFor } from '@testing-library/react';

import AppLayout from '../../../lib/components/app-layout';
import { isAppLayoutHideToolbar } from '../../../lib/components/app-layout/utils/feature-flags';
import BreadcrumbGroup, { BreadcrumbGroupProps } from '../../../lib/components/breadcrumb-group';
import { clearInitialMessages } from '../../../lib/components/internal/plugins/widget/core';
import * as widgetPlugins from '../../../lib/components/plugins';
import { describeEachAppLayout, renderComponent, setPendingGlobalFlag } from './utils';

import skeletonStyles from '../../../lib/components/app-layout/visual-refresh-toolbar/skeleton/styles.css.js';
import toolbarStyles from '../../../lib/components/app-layout/visual-refresh-toolbar/toolbar/styles.css.js';

const breadcrumbItems: BreadcrumbGroupProps['items'] = [
{ text: 'Home', href: '/home' },
{ text: 'Resource', href: '/resource' },
];

function isToolbarHidden(toolbar: HTMLElement) {
return toolbar.classList.contains(toolbarStyles['toolbar-hidden']);
}

afterEach(() => setPendingGlobalFlag('appLayoutHideToolbar', undefined));

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll replace setPendingGlobalFlag with feature flags from component-toolkit once they are released: cloudscape-design/component-toolkit#274


describe('isAppLayoutHideToolbar', () => {
test('returns false when the flag is not set', () => {
expect(isAppLayoutHideToolbar()).toBe(false);
});

test('returns false when the flag is false', () => {
setPendingGlobalFlag('appLayoutHideToolbar', false);
expect(isAppLayoutHideToolbar()).toBe(false);
});

test('returns true when the flag is true', () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
expect(isAppLayoutHideToolbar()).toBe(true);
});
});

describeEachAppLayout({ themes: ['refresh-toolbar'] }, () => {
test('renders a visible toolbar when the flag is not set', () => {
const { wrapper } = renderComponent(<AppLayout navigation="nav" />);
expect(wrapper.findToolbar()).toBeTruthy();
expect(isToolbarHidden(wrapper.findToolbar()!.getElement())).toBe(false);
});

test('keeps the toolbar mounted but hidden when the flag is set', () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
const { wrapper } = renderComponent(<AppLayout navigation="nav" tools="tools" />);
expect(wrapper.findToolbar()).toBeTruthy();
expect(isToolbarHidden(wrapper.findToolbar()!.getElement())).toBe(true);
// toggles are rendered inside the hidden toolbar
expect(wrapper.findToolbar()!.getElement()).toContainElement(wrapper.findNavigationToggle()!.getElement());
expect(wrapper.findToolbar()!.getElement()).toContainElement(wrapper.findToolsToggle()!.getElement());
});

test('renders a top border for the content area in place of the hidden toolbar', () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
const { wrapper } = renderComponent(<AppLayout navigation="nav" />);
const toolbar = wrapper.findToolbar()!.getElement();
const border = toolbar.nextElementSibling;
expect(border).toHaveClass(skeletonStyles['hidden-toolbar-border']);
expect(wrapper.findAllByClassName(skeletonStyles['hidden-toolbar-border'])).toHaveLength(1);
});

test('does not render the content area top border when the flag is not set', () => {
const { wrapper } = renderComponent(<AppLayout navigation="nav" />);
expect(wrapper.findByClassName(skeletonStyles['hidden-toolbar-border'])).toBeNull();
});

test('keeps rendering breadcrumbs inside the hidden toolbar', () => {

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The purpose is the same - make sure that global breadcrumbs keep working when the toolbar is hidden

setPendingGlobalFlag('appLayoutHideToolbar', true);
const { wrapper } = renderComponent(<AppLayout breadcrumbs={<BreadcrumbGroup items={breadcrumbItems} />} />);
const breadcrumbs = wrapper.findBreadcrumbs()!.findBreadcrumbGroup()!;
expect(breadcrumbs.findBreadcrumbLinks().map(link => link.getElement().textContent)).toEqual(['Home', 'Resource']);
expect(wrapper.findToolbar()!.getElement()).toContainElement(breadcrumbs.getElement());
});

test('keeps rendering the content and open navigation when the flag is set', () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
const { wrapper } = renderComponent(
<AppLayout navigation="nav" navigationOpen={true} onNavigationChange={() => {}} content="main content" />
);
expect(isToolbarHidden(wrapper.findToolbar()!.getElement())).toBe(true);
expect(wrapper.findContentRegion().getElement()).toHaveTextContent('main content');
expect(wrapper.findNavigation().getElement()).toHaveTextContent('nav');
});

test('keeps rendering an open tools drawer when the flag is set', () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
const { wrapper } = renderComponent(<AppLayout tools="tools content" toolsOpen={true} onToolsChange={() => {}} />);
expect(isToolbarHidden(wrapper.findToolbar()!.getElement())).toBe(true);
expect(wrapper.findTools().getElement()).toHaveTextContent('tools content');
});
});

describeEachAppLayout({ themes: ['refresh-toolbar'], sizes: ['desktop'] }, () => {

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also considered moving these tests to this file: https://github.com/cloudscape-design/components/blob/main/src/app-layout/__tests__/runtime-breadcrumbs-widgetized.test.tsx

but decided to keep them here since they help prevent regressions related to this feature

beforeEach(() => clearInitialMessages());
afterEach(() => {
cleanup();
clearInitialMessages();
});

test('reports breadcrumbs to registerBreadcrumbsConsumer when the flag is set', async () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
const onBreadcrumbsChange = jest.fn();
const registration = widgetPlugins.registerBreadcrumbsConsumer({ onBreadcrumbsChange });
const onFollow = jest.fn();

render(<AppLayout breadcrumbs={<BreadcrumbGroup items={breadcrumbItems} onFollow={onFollow} />} />);

await waitFor(() =>
expect(onBreadcrumbsChange).toHaveBeenLastCalledWith(
expect.objectContaining({ items: breadcrumbItems, onFollow })
)
);
registration.unregister();
});

test('reports breadcrumb updates to registerBreadcrumbsConsumer when the flag is set', async () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
const onBreadcrumbsChange = jest.fn();
const registration = widgetPlugins.registerBreadcrumbsConsumer({ onBreadcrumbsChange });

const { rerender } = render(<AppLayout breadcrumbs={<BreadcrumbGroup items={breadcrumbItems} />} />);
await waitFor(() =>
expect(onBreadcrumbsChange).toHaveBeenLastCalledWith(expect.objectContaining({ items: breadcrumbItems }))
);

const updatedItems = [...breadcrumbItems, { text: 'Details', href: '/details' }];
rerender(<AppLayout breadcrumbs={<BreadcrumbGroup items={updatedItems} />} />);
await waitFor(() =>
expect(onBreadcrumbsChange).toHaveBeenLastCalledWith(expect.objectContaining({ items: updatedItems }))
);
registration.unregister();
});
});

describeEachAppLayout({ themes: ['classic', 'refresh'] }, () => {
test('does not affect non-toolbar designs', () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
const { wrapper } = renderComponent(<AppLayout navigation="nav" content="main content" />);
expect(wrapper.findNavigation().getElement()).toHaveTextContent('nav');
expect(wrapper.findContentRegion().getElement()).toHaveTextContent('main content');
});
});
56 changes: 54 additions & 2 deletions src/app-layout/__tests__/skeleton.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@ import { render } from '@testing-library/react';
import { isThemeActive } from '@cloudscape-design/component-toolkit/internal';

import AppLayout from '../../../lib/components/app-layout';
import { BeforeMainSlotSkeleton } from '../../../lib/components/app-layout/visual-refresh-toolbar/skeleton/skeleton-parts';
import {
BeforeMainSlotSkeleton,
ToolbarSkeleton,
} from '../../../lib/components/app-layout/visual-refresh-toolbar/skeleton/skeleton-parts';
import AppLayoutToolbar from '../../../lib/components/app-layout-toolbar';
import BreadcrumbGroup from '../../../lib/components/breadcrumb-group';
import { getFunnelKeySelector } from '../../../lib/components/internal/analytics/selectors';
import { getIconHTML } from '../../icon/__tests__/utils';
import { describeEachAppLayout, renderComponent } from './utils';
import { describeEachAppLayout, renderComponent, setPendingGlobalFlag } from './utils';

import testutilStyles from '../../../lib/components/app-layout/test-classes/styles.selectors.js';
import navStyles from '../../../lib/components/app-layout/visual-refresh-toolbar/navigation/styles.selectors.js';
Expand Down Expand Up @@ -181,6 +184,55 @@ describeEachAppLayout({ themes: ['refresh-toolbar'] }, () => {
expect(toolbarContainer!.getElement()).toHaveClass(toolbarStyles['universal-toolbar']);
expect(toolbarContainer!.getElement()).toHaveClass(testutilStyles.toolbar);
});

describe('with appLayoutHideToolbar flag', () => {
afterEach(() => setPendingGlobalFlag('appLayoutHideToolbar', undefined));

it('renders a visible skeleton toolbar when the flag is not set', () => {
const { wrapper } = renderComponent(<AppLayout navigation="test nav" breadcrumbs="test breadcrumbs" />);
const toolbar = wrapper.findByClassName(skeletonStyles['toolbar-container'])!.getElement();
expect(toolbar).not.toHaveClass(toolbarStyles['toolbar-hidden']);
expect(wrapper.findByClassName(skeletonStyles['hidden-toolbar-border'])).toBeNull();
});

it('keeps the skeleton toolbar mounted but hidden when the flag is set', () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
const { wrapper } = renderComponent(
<AppLayout navigation="test nav" breadcrumbs={<BreadcrumbGroup items={[{ text: 'Home', href: '' }]} />} />
);
const toolbar = wrapper.findByClassName(skeletonStyles['toolbar-container'])!.getElement();
expect(toolbar).toHaveClass(toolbarStyles['toolbar-hidden']);
// breadcrumbs and toggles still render inside, needed for SSR and breadcrumbs reporting
expect(toolbar).toContainElement(wrapper.findBreadcrumbs()!.getElement());
expect(toolbar).toContainElement(wrapper.findNavigationToggle()!.getElement());
// the content area keeps a top border in place of the hidden toolbar
expect(toolbar.nextElementSibling).toHaveClass(skeletonStyles['hidden-toolbar-border']);
});
});
});
});

describe('ToolbarSkeleton', () => {
const appLayoutInternals = { breadcrumbs: <div>test breadcrumbs</div> } as any;

afterEach(() => setPendingGlobalFlag('appLayoutHideToolbar', undefined));

function findToolbar(container: HTMLElement) {
return container.querySelector(`.${skeletonStyles['toolbar-container']}`)!;
}

it('is visible by default', () => {
const { container } = render(<ToolbarSkeleton appLayoutInternals={appLayoutInternals} toolbarProps={{}} />);
expect(findToolbar(container)).not.toHaveClass(toolbarStyles['toolbar-hidden']);
expect(container.querySelector(`.${skeletonStyles['hidden-toolbar-border']}`)).toBeNull();
});

it('is hidden but keeps its content when the appLayoutHideToolbar flag is set', () => {
setPendingGlobalFlag('appLayoutHideToolbar', true);
const { container } = render(<ToolbarSkeleton appLayoutInternals={appLayoutInternals} toolbarProps={{}} />);
expect(findToolbar(container)).toHaveClass(toolbarStyles['toolbar-hidden']);
expect(findToolbar(container)).toHaveTextContent('test breadcrumbs');
expect(findToolbar(container).nextElementSibling).toHaveClass(skeletonStyles['hidden-toolbar-border']);
});
});

Expand Down
Loading
Loading