[8.15] [Reporting] fix dashboard "Copy Post URL" action (#192530) (#1…

…96928) # Backport This will backport the following commits from `main` to `8.15`: - [[Reporting] fix dashboard "Copy Post URL" action (#192530)](#192530)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) \n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n\n\nCo-authored-by: Tim Sullivan <[email protected]>"}},{"branch":"8.15","label":"v8.15.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
elastic · Oct 22, 2024 · fde6d27 · fde6d27
1 parent ff9ee2b
commit fde6d27
Show file tree

Hide file tree

Showing 24 changed files with 306 additions and 253 deletions.
diff --git a/examples/share_examples/public/plugin.tsx b/examples/share_examples/public/plugin.tsx
@@ -21,7 +21,7 @@ export class ShareDemoPlugin implements Plugin<void, void, SetupDeps, StartDeps>
   public setup(core: CoreSetup<StartDeps>, { share }: SetupDeps) {
     share.register({
       id: 'demo',
-      getShareMenuItems: (context) => [
+      getShareMenuItemsLegacy: (context) => [
         {
           panel: {
             id: 'demo',

diff --git a/packages/kbn-reporting/public/reporting_api_client.ts b/packages/kbn-reporting/public/reporting_api_client.ts
@@ -226,6 +226,9 @@ export class ReportingAPIClient implements IReportingAPI {
     });
   }
 
+  /**
+   * Adds the browserTimezone and kibana version to report job params
+   */
   public getDecoratedJobParams<T extends AppParams>(baseParams: T): BaseParams {
     // If the TZ is set to the default "Browser", it will not be useful for
     // server-side export. We need to derive the timezone and pass it as a param

diff --git a/packages/kbn-reporting/public/share/share_context_menu/index.ts b/packages/kbn-reporting/public/share/share_context_menu/index.ts
@@ -10,7 +10,6 @@ import * as Rx from 'rxjs';
 
 import type { ApplicationStart, CoreStart } from '@kbn/core/public';
 import { ILicense } from '@kbn/licensing-plugin/public';
-import type { LayoutParams } from '@kbn/screenshotting-plugin/common';
 
 import type { ReportingAPIClient } from '../../reporting_api_client';
 
@@ -46,13 +45,16 @@ export interface ExportPanelShareOpts {
 
 export interface ReportingSharingData {
   title: string;
-  layout: LayoutParams;
   reportingDisabled?: boolean;
-  [key: string]: unknown;
+  locatorParams: {
+    id: string;
+    params: unknown;
+  };
 }
 
 export interface JobParamsProviderOptions {
   sharingData: ReportingSharingData;
   shareableUrl?: string;
   objectType: string;
+  optimizedForPrinting?: boolean;
 }
diff --git a/packages/kbn-reporting/public/share/share_context_menu/register_csv_modal_reporting.tsx b/packages/kbn-reporting/public/share/share_context_menu/register_csv_modal_reporting.tsx
@@ -15,7 +15,7 @@ import { CSV_JOB_TYPE, CSV_JOB_TYPE_V2 } from '@kbn/reporting-export-types-csv-c
 
 import type { SearchSourceFields } from '@kbn/data-plugin/common';
 import { FormattedMessage, InjectedIntl } from '@kbn/i18n-react';
-import { ShareContext, ShareMenuItem } from '@kbn/share-plugin/public';
+import { ShareContext, ShareMenuItemV2 } from '@kbn/share-plugin/public';
 import type { ExportModalShareOpts } from '.';
 import { checkLicense } from '../..';
 
@@ -68,7 +68,7 @@ export const reportingCsvShareProvider = ({
       };
     };
 
-    const shareActions: ShareMenuItem[] = [];
+    const shareActions: ShareMenuItemV2[] = [];
 
     const licenseCheck = checkLicense(license.check('reporting', 'basic'));
     const licenseToolTipContent = licenseCheck.message;
@@ -176,8 +176,8 @@ export const reportingCsvShareProvider = ({
           />
         ),
         generateExport: generateReportingJobCSV,
+        generateExportUrl: () => absoluteUrl,
         generateCopyUrl: reportingUrl,
-        absoluteUrl,
         renderCopyURLButton: true,
       });
     }

diff --git a/packages/kbn-reporting/public/share/share_context_menu/register_pdf_png_modal_reporting.tsx b/packages/kbn-reporting/public/share/share_context_menu/register_pdf_png_modal_reporting.tsx
@@ -7,31 +7,28 @@
  */
 
 import { i18n } from '@kbn/i18n';
-import { FormattedMessage, InjectedIntl } from '@kbn/i18n-react';
+import { FormattedMessage } from '@kbn/i18n-react';
 import { toMountPoint } from '@kbn/react-kibana-mount';
-import { ShareContext, ShareMenuItem, ShareMenuProvider } from '@kbn/share-plugin/public';
+import { ShareContext, ShareMenuItemV2, ShareMenuProvider } from '@kbn/share-plugin/public';
 import React from 'react';
 import { firstValueFrom } from 'rxjs';
-import {
-  ExportModalShareOpts,
-  ExportPanelShareOpts,
-  JobParamsProviderOptions,
-  ReportingSharingData,
-} from '.';
+import { ScreenshotExportOpts } from '@kbn/share-plugin/public/types';
+import { ExportModalShareOpts, JobParamsProviderOptions, ReportingSharingData } from '.';
 import { checkLicense } from '../../license_check';
-import { ScreenCapturePanelContent } from './screen_capture_panel_content_lazy';
 
 const getJobParams = (opts: JobParamsProviderOptions, type: 'pngV2' | 'printablePdfV2') => () => {
   const {
     objectType,
-    sharingData: { title, layout, locatorParams },
+    sharingData: { title, locatorParams },
+    optimizedForPrinting,
   } = opts;
 
-  const baseParams = {
-    objectType,
-    layout,
-    title,
-  };
+  const el = document.querySelector('[data-shared-items-container]');
+  const { height, width } = el ? el.getBoundingClientRect() : { height: 768, width: 1024 };
+  const dimensions = { height, width };
+  const layoutId = optimizedForPrinting ? ('print' as const) : ('preserve_layout' as const);
+  const layout = { id: layoutId, dimensions };
+  const baseParams = { objectType, layout, title };
 
   if (type === 'printablePdfV2') {
     // multi locator for PDF V2
@@ -42,154 +39,8 @@ const getJobParams = (opts: JobParamsProviderOptions, type: 'pngV2' | 'printable
 };
 
 /**
- * This is used by Canvas
+ * This is used by Dashboard and Visualize apps (sharing modal)
  */
-export const reportingScreenshotShareProvider = ({
-  apiClient,
-  license,
-  application,
-  usesUiCapabilities,
-  startServices$,
-}: ExportPanelShareOpts): ShareMenuProvider => {
-  const getShareMenuItems = ({
-    objectType,
-    objectId,
-    isDirty,
-    onClose,
-    shareableUrl,
-    shareableUrlForSavedObject,
-    ...shareOpts
-  }: ShareContext) => {
-    const { enableLinks, showLinks, message } = checkLicense(license.check('reporting', 'gold'));
-    const licenseToolTipContent = message;
-    const licenseHasScreenshotReporting = showLinks;
-    const licenseDisabled = !enableLinks;
-
-    let capabilityHasDashboardScreenshotReporting = false;
-    let capabilityHasVisualizeScreenshotReporting = false;
-    if (usesUiCapabilities) {
-      capabilityHasDashboardScreenshotReporting =
-        application.capabilities.dashboard?.generateScreenshot === true;
-      capabilityHasVisualizeScreenshotReporting =
-        application.capabilities.visualize?.generateScreenshot === true;
-    } else {
-      // deprecated
-      capabilityHasDashboardScreenshotReporting = true;
-      capabilityHasVisualizeScreenshotReporting = true;
-    }
-
-    if (!licenseHasScreenshotReporting) {
-      return [];
-    }
-    const isSupportedType = ['dashboard', 'visualization', 'lens'].includes(objectType);
-
-    if (!isSupportedType) {
-      return [];
-    }
-
-    if (objectType === 'dashboard' && !capabilityHasDashboardScreenshotReporting) {
-      return [];
-    }
-
-    if (
-      isSupportedType &&
-      !capabilityHasVisualizeScreenshotReporting &&
-      !capabilityHasDashboardScreenshotReporting
-    ) {
-      return [];
-    }
-
-    const { sharingData } = shareOpts as unknown as { sharingData: ReportingSharingData };
-    const shareActions: ShareMenuItem[] = [];
-
-    const pngPanelTitle = i18n.translate('reporting.share.contextMenu.pngReportsButtonLabel', {
-      defaultMessage: 'PNG Reports',
-    });
-
-    const jobProviderOptions: JobParamsProviderOptions = {
-      shareableUrl: isDirty ? shareableUrl : shareableUrlForSavedObject ?? shareableUrl,
-      objectType,
-      sharingData,
-    };
-    const isJobV2Params = ({
-      sharingData: _sharingData,
-    }: {
-      sharingData: Record<string, unknown>;
-    }) => _sharingData.locatorParams != null;
-
-    const isV2Job = isJobV2Params(jobProviderOptions);
-    const requiresSavedState = !isV2Job;
-
-    const panelPng = {
-      shareMenuItem: {
-        name: pngPanelTitle,
-        icon: 'document',
-        toolTipContent: licenseToolTipContent,
-        disabled: licenseDisabled || sharingData.reportingDisabled,
-        ['data-test-subj']: 'PNGReports',
-        sortOrder: 10,
-      },
-      panel: {
-        id: 'reportingPngPanel',
-        title: pngPanelTitle,
-        content: (
-          <ScreenCapturePanelContent
-            apiClient={apiClient}
-            startServices$={startServices$}
-            reportType={'pngV2'}
-            objectId={objectId}
-            requiresSavedState={requiresSavedState}
-            getJobParams={getJobParams(jobProviderOptions, 'pngV2')}
-            isDirty={isDirty}
-            onClose={onClose}
-          />
-        ),
-      },
-    };
-
-    const pdfPanelTitle = i18n.translate('reporting.share.contextMenu.pdfReportsButtonLabel', {
-      defaultMessage: 'PDF Reports',
-    });
-
-    const panelPdf = {
-      shareMenuItem: {
-        name: pdfPanelTitle,
-        icon: 'document',
-        toolTipContent: licenseToolTipContent,
-        disabled: licenseDisabled || sharingData.reportingDisabled,
-        ['data-test-subj']: 'PDFReports',
-        sortOrder: 10,
-      },
-      panel: {
-        id: 'reportingPdfPanel',
-        title: pdfPanelTitle,
-        content: (
-          <ScreenCapturePanelContent
-            apiClient={apiClient}
-            startServices$={startServices$}
-            reportType={'printablePdfV2'}
-            objectId={objectId}
-            requiresSavedState={requiresSavedState}
-            layoutOption={objectType === 'dashboard' ? 'print' : undefined}
-            getJobParams={getJobParams(jobProviderOptions, 'printablePdfV2')}
-            isDirty={isDirty}
-            onClose={onClose}
-          />
-        ),
-      },
-    };
-
-    shareActions.push(panelPng);
-    shareActions.push(panelPdf);
-    return shareActions;
-  };
-
-  return {
-    id: 'screenCaptureReports',
-    getShareMenuItems,
-  };
-};
-
 export const reportingExportModalProvider = ({
   apiClient,
   license,
@@ -248,7 +99,7 @@ export const reportingExportModalProvider = ({
     }
 
     const { sharingData } = shareOpts as unknown as { sharingData: ReportingSharingData };
-    const shareActions: ShareMenuItem[] = [];
+    const shareActions: ShareMenuItemV2[] = [];
 
     const jobProviderOptions: JobParamsProviderOptions = {
       shareableUrl: isDirty ? shareableUrl : shareableUrlForSavedObject ?? shareableUrl,
@@ -258,32 +109,9 @@ export const reportingExportModalProvider = ({
 
     const requiresSavedState = sharingData.locatorParams === null;
 
-    const relativePathPDF = apiClient.getReportingPublicJobPath(
-      'printablePdfV2',
-      apiClient.getDecoratedJobParams(getJobParams(jobProviderOptions, 'printablePdfV2')())
-    );
-
-    const relativePathPNG = apiClient.getReportingPublicJobPath(
-      'pngV2',
-      apiClient.getDecoratedJobParams(getJobParams(jobProviderOptions, 'pngV2')())
-    );
-
-    const generateReportPDF = ({
-      intl,
-      optimizedForPrinting = false,
-    }: {
-      intl: InjectedIntl;
-      optimizedForPrinting?: boolean;
-    }) => {
-      const el = document.querySelector('[data-shared-items-container]');
-      const { height, width } = el ? el.getBoundingClientRect() : { height: 768, width: 1024 };
-      const dimensions = { height, width };
-
+    const generateReportPDF = ({ intl, optimizedForPrinting = false }: ScreenshotExportOpts) => {
       const decoratedJobParams = apiClient.getDecoratedJobParams({
-        ...getJobParams(jobProviderOptions, 'printablePdfV2')(),
-        layout: { id: optimizedForPrinting ? 'print' : 'preserve_layout', dimensions },
-        objectType,
-        title: sharingData.title,
+        ...getJobParams({ ...jobProviderOptions, optimizedForPrinting }, 'printablePdfV2')(),
       });
 
       return apiClient
@@ -329,19 +157,27 @@ export const reportingExportModalProvider = ({
         });
     };
 
-    const generateReportPNG = ({ intl }: { intl: InjectedIntl }) => {
-      const { layout: outerLayout } = getJobParams(jobProviderOptions, 'pngV2')();
-      let dimensions = outerLayout?.dimensions;
-      if (!dimensions) {
-        const el = document.querySelector('[data-shared-items-container]');
-        const { height, width } = el ? el.getBoundingClientRect() : { height: 768, width: 1024 };
-        dimensions = { height, width };
-      }
+    const generateExportUrlPDF = ({ optimizedForPrinting }: ScreenshotExportOpts) => {
+      const jobParams = apiClient.getDecoratedJobParams(
+        getJobParams({ ...jobProviderOptions, optimizedForPrinting }, 'printablePdfV2')()
+      );
+      const relativePathPDF = apiClient.getReportingPublicJobPath('printablePdfV2', jobParams);
+
+      return new URL(relativePathPDF, window.location.href).toString();
+    };
+
+    const generateExportUrlPNG = () => {
+      const jobParams = apiClient.getDecoratedJobParams(
+        getJobParams(jobProviderOptions, 'pngV2')()
+      );
+      const relativePathPNG = apiClient.getReportingPublicJobPath('pngV2', jobParams);
+
+      return new URL(relativePathPNG, window.location.href).toString();
+    };
+
+    const generateReportPNG = ({ intl }: ScreenshotExportOpts) => {
       const decoratedJobParams = apiClient.getDecoratedJobParams({
         ...getJobParams(jobProviderOptions, 'pngV2')(),
-        layout: { id: 'preserve_layout', dimensions },
-        objectType,
-        title: sharingData.title,
       });
       return apiClient
         .createReportingJob('pngV2', decoratedJobParams)
@@ -397,6 +233,7 @@ export const reportingExportModalProvider = ({
       },
       label: 'PDF' as const,
       generateExport: generateReportPDF,
+      generateExportUrl: generateExportUrlPDF,
       reportType: 'printablePdfV2',
       requiresSavedState,
       helpText: (
@@ -414,7 +251,6 @@ export const reportingExportModalProvider = ({
       layoutOption: objectType === 'dashboard' ? ('print' as const) : undefined,
       renderLayoutOptionSwitch: objectType === 'dashboard',
       renderCopyURLButton: true,
-      absoluteUrl: new URL(relativePathPDF, window.location.href).toString(),
     });
 
     shareActions.push({
@@ -428,6 +264,7 @@ export const reportingExportModalProvider = ({
       },
       label: 'PNG' as const,
       generateExport: generateReportPNG,
+      generateExportUrl: generateExportUrlPNG,
       reportType: 'pngV2',
       requiresSavedState,
       helpText: (
@@ -441,7 +278,6 @@ export const reportingExportModalProvider = ({
       ),
       layoutOption: objectType === 'dashboard' ? ('print' as const) : undefined,
       renderCopyURLButton: true,
-      absoluteUrl: new URL(relativePathPNG, window.location.href).toString(),
     });
 
     return shareActions;