[Controls] [Reporting] Remove controls from reports

[Heenawter]

Closes #133547

Summary

Before this change, controls were not included in print optimized reports, but they were included in non-print-optimized reports. However, this caused a bug where sometimes the reporting states didn't match - more context can be found here.

To fix this, I removed the data-shared-items-count from the control_group_component, because it was found that this was causing the ambiguous state for Reporting since it only expects a single data-shared-items-count for the entire page. This solution removes controls from non-print-optimized reports entirely.

Note that, if we wanted to include controls in reports in the future, we would have to pull the dashboard-shared-items-container class outside to include both the control_group and the DashboardGrid, with something like:

    return (
      <div data-shared-items-container data-title={title} data-description={description}>
        {controlsEnabled && container.getInput().viewMode !== ViewMode.PRINT ? (
          <>
            {isEditMode && panelCount !== 0 && controlGroup?.getPanelCount() === 0 ? (
            ...
        ) : null}
        <div
          data-shared-items-count={panelCount}
          className={useMargins ? 'dshDashboardViewport-withMargins' : 'dshDashboardViewport'}
        >
         ...
        </div>
      </div>
    );

However, since we don't have a strong preference for whether or not controls should be visible in non-print-optimized reports anyway, the simplest and most reliable solution is to simply to not include them at all for now.

How to test:

1. Create a new dashboard
2. Add at least one control
3. Don't save the dashboard
4. Generate a non-print-optimized PDF report
5. Ensure that the report is generated without errors and that controls are not visible in the report

Checklist

• This was checked for cross-browser compatibility

[elasticmachine]

Pinging @elastic/kibana-presentation (Team:Presentation)

[elasticmachine]

Pinging @elastic/kibana-reporting-services (Team:Reporting Services)

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: cebadc8
• Storybooks Preview
• Webpack Bundle Analyzer

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
controls	426.5KB	426.4KB	-35.0B

History

• 💛 Build #50547 was flaky b6a66b7

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @Heenawter

[tsullivan]

LGTM

Thanks for the details notes - I agree with everything you stated!

[ThomThomson]

As we discussed, this fix looks good! I just wonder if the title of the PR reflects what it's actually doing, left a comment to that effect. LGTM!

[ThomThomson]

Does this change actually "Remove controls from reports"? Or does it simply fix the loading issue we were encountering before?

[Heenawter]

I mean, it does remove controls from reports (specifically, non-print-optimized reports) - they used to be screen captured and included in these reports, and now they are not and the reports only include the graphs on the dashboard. I could change the title to reflect that this only impacts non-print-optimized reports?

[ThomThomson]

Oh! I didn't realise that simply removing the data-shared-items-count would actually remove the Controls from the report! In that case the title makes total sense. Thanks for the response!

[kibanamachine]

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add the label auto-backport or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 134240 locally