Merge pull request #12839 from google/enhancement/12631-pdf-orchestrator-sidesheet-registry

Register and render first data into PDF report.

Author: eugene-manuilov

assets/js/components/DashboardMainApp.js

@@ -89,9 +89,9 @@ import MetricsSelectionPanel from './KeyMetrics/MetricsSelectionPanel';
 import ModuleDashboardEffects from './ModuleDashboardEffects';
 import Notifications from './notifications/Notifications';
 import OfflineNotification from './notifications/OfflineNotification';
+import PDFDownloadButton from './pdf-export/PDFDownloadButton';
 import PDFExportRoot from './pdf-export/PDFExportRoot';
-import PDFDownloadButton from './pdf-generation/PDFDownloadButton';
-import PDFSectionsSelectionPanel from './pdf-generation/PDFSectionsSelectionPanel';
+import PDFSectionsSelectionPanel from './pdf-export/PDFSectionsSelectionPanel';
 import CurrentSurveyPortal from './surveys/CurrentSurveyPortal';
 import SurveyViewTrigger from './surveys/SurveyViewTrigger';
 import WelcomeModal from './WelcomeModal';

assets/js/components/PDFExport/components/PDFMetricTile.tsx

@@ -19,7 +19,7 @@
 /**
  * Internal dependencies
  */
-import { PDF_DOWNLOAD_PANEL_OPENED_KEY } from '@/js/components/pdf-generation/constants';
+import { PDF_DOWNLOAD_PANEL_OPENED_KEY } from '@/js/components/pdf-export/constants';
 import { CORE_UI } from '@/js/googlesitekit/datastore/ui/constants';
 import { createTestRegistry, fireEvent, render } from '@tests/js/test-utils';
 import PDFDownloadButton from './PDFDownloadButton';

…df-generation/PDFDownloadButton.test.tsx …ts/pdf-export/PDFDownloadButton.test.tsxassets/js/components/pdf-generation/PDFDownloadButton.test.tsx renamed to assets/js/components/pdf-export/PDFDownloadButton.test.tsx assets/js/components/pdf-generation/PDFDownloadButton.test.tsx renamed to assets/js/components/pdf-export/PDFDownloadButton.test.tsx

@@ -32,7 +32,7 @@ import { __ } from '@wordpress/i18n';
  */
 import { Button } from 'googlesitekit-components';
 import { Select, useDispatch, useSelect } from 'googlesitekit-data';
-import { PDF_DOWNLOAD_PANEL_OPENED_KEY } from '@/js/components/pdf-generation/constants';
+import { PDF_DOWNLOAD_PANEL_OPENED_KEY } from '@/js/components/pdf-export/constants';
 import { CORE_UI } from '@/js/googlesitekit/datastore/ui/constants';
 import DownloadIcon from '@/svg/icons/download.svg';
 

…nts/pdf-generation/PDFDownloadButton.tsx …ponents/pdf-export/PDFDownloadButton.tsxassets/js/components/pdf-generation/PDFDownloadButton.tsx renamed to assets/js/components/pdf-export/PDFDownloadButton.tsx assets/js/components/pdf-generation/PDFDownloadButton.tsx renamed to assets/js/components/pdf-export/PDFDownloadButton.tsx

@@ -0,0 +1,165 @@
+/**
+ * PDFExportOrchestrator tests.
+ *
+ * Site Kit by Google, Copyright 2026 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * External dependencies
+ */
+import { pdf } from '@react-pdf/renderer';
+
+/**
+ * Internal dependencies
+ */
+import { VIEW_CONTEXT_MAIN_DASHBOARD } from '@/js/googlesitekit/constants';
+import { CORE_PDF } from '@/js/googlesitekit/datastore/pdf/constants';
+import { CORE_USER } from '@/js/googlesitekit/datastore/user/constants';
+import { CORE_WIDGETS } from '@/js/googlesitekit/widgets/datastore/constants';
+import { CONTEXT_MAIN_DASHBOARD_TRAFFIC } from '@/js/googlesitekit/widgets/default-contexts';
+import {
+	createTestRegistry,
+	provideSiteInfo,
+	provideUserInfo,
+	render,
+	waitFor,
+} from '@tests/js/test-utils';
+import PDFExportOrchestrator from './PDFExportOrchestrator';
+
+// Stub the download trigger so the anchor click does not attempt a JSDOM
+// navigation; the filename helper stays real.
+jest.mock( './pdf-utils', () => ( {
+	...jest.requireActual( './pdf-utils' ),
+	triggerDownload: jest.fn(),
+} ) );
+
+function NullComponent() {
+	return null;
+}
+
+describe( 'PDFExportOrchestrator', () => {
+	let registry: ReturnType< typeof createTestRegistry >;
+
+	beforeEach( () => {
+		registry = createTestRegistry();
+		provideSiteInfo( registry, { siteName: 'Example Site' } );
+		provideUserInfo( registry );
+		registry.dispatch( CORE_USER ).setReferenceDate( '2021-01-10' );
+		registry.dispatch( CORE_USER ).setDateRange( 'last-28-days' );
+
+		( pdf as jest.Mock ).mockClear();
+
+		global.URL.createObjectURL = jest.fn( () => 'blob:mock-url' );
+		global.URL.revokeObjectURL = jest.fn();
+	} );
+
+	function registerPDFWidget(
+		areaSlug: string,
+		widgetSlug: string,
+		getData: jest.Mock
+	) {
+		const dispatch = registry.dispatch( CORE_WIDGETS );
+		dispatch.registerWidgetArea( areaSlug, {
+			title: 'Area',
+			pdfTitle: 'Traffic',
+			style: 'boxes',
+			priority: 1,
+		} );
+		dispatch.assignWidgetArea( areaSlug, CONTEXT_MAIN_DASHBOARD_TRAFFIC );
+		dispatch.registerWidget( widgetSlug, {
+			Component: NullComponent,
+			pdf: { Component: NullComponent, getData },
+		} );
+		dispatch.assignWidget( widgetSlug, areaSlug );
+	}
+
+	function renderOrchestrator() {
+		return render( <PDFExportOrchestrator onComplete={ () => {} } />, {
+			registry,
+			viewContext: VIEW_CONTEXT_MAIN_DASHBOARD,
+		} );
+	}
+
+	it( 'loads the selected widget data with PDF-adjusted dates and builds the PDF', async () => {
+		const getData: jest.Mock = jest.fn( () =>
+			Promise.resolve( { data: { totalUsers: 100 } } )
+		);
+		registerPDFWidget( 'trafficArea', 'trafficWidget', getData );
+		registry.dispatch( CORE_PDF ).setSelection( {
+			contextSlugs: [ CONTEXT_MAIN_DASHBOARD_TRAFFIC ],
+			widgetSlugs: [],
+		} );
+
+		renderOrchestrator();
+
+		await waitFor( () => {
+			expect( registry.select( CORE_PDF ).getStatus() ).toBe( 'success' );
+		} );
+
+		expect( getData ).toHaveBeenCalledTimes( 1 );
+
+		const { dates, signal } = getData.mock.calls[ 0 ][ 0 ];
+		// End date is shifted back one day from the reference date.
+		expect( dates.endDate ).toBe( '2021-01-09' );
+		expect( dates.compareStartDate ).toBeDefined();
+		expect( signal ).toBeInstanceOf( AbortSignal );
+
+		expect( pdf ).toHaveBeenCalledTimes( 1 );
+	} );
+
+	it( 'transitions to error and does not build a PDF when the only widget fails', async () => {
+		const getData = jest.fn( () =>
+			Promise.reject( new Error( 'report failed' ) )
+		);
+		registerPDFWidget( 'trafficArea', 'trafficWidget', getData );
+		registry.dispatch( CORE_PDF ).setSelection( {
+			contextSlugs: [ CONTEXT_MAIN_DASHBOARD_TRAFFIC ],
+			widgetSlugs: [],
+		} );
+
+		renderOrchestrator();
+
+		await waitFor( () => {
+			expect( registry.select( CORE_PDF ).getStatus() ).toBe( 'error' );
+		} );
+
+		expect( pdf ).not.toHaveBeenCalled();
+	} );
+
+	it( 'isolates a failing widget when another widget succeeds', async () => {
+		const failing = jest.fn( () =>
+			Promise.reject( new Error( 'report failed' ) )
+		);
+		const succeeding = jest.fn( () =>
+			Promise.resolve( { data: { totalUsers: 100 } } )
+		);
+		registerPDFWidget( 'trafficAreaA', 'trafficWidgetA', failing );
+		registerPDFWidget( 'trafficAreaB', 'trafficWidgetB', succeeding );
+		registry.dispatch( CORE_PDF ).setSelection( {
+			contextSlugs: [ CONTEXT_MAIN_DASHBOARD_TRAFFIC ],
+			widgetSlugs: [],
+		} );
+
+		renderOrchestrator();
+
+		await waitFor( () => {
+			expect( registry.select( CORE_PDF ).getStatus() ).toBe( 'success' );
+		} );
+
+		expect( failing ).toHaveBeenCalledTimes( 1 );
+		expect( succeeding ).toHaveBeenCalledTimes( 1 );
+		expect( pdf ).toHaveBeenCalledTimes( 1 );
+	} );
+} );