[charts] Benchmark charts using a real browser

[bernardobelchior]

This PR replaces the current charts benchmarks, which use Codspeed, with two custom GitHub Actions.

The action "Update Charts Benchmark Baseline" runs when commits are merged to master or next and upload an artifact named charts-benchmarks-results-${{ github.ref_name }}.json containing the results of the performance tests. It also includes the commit, so we can link in later.

The action "Performance Test" runs on pull requests (using the same rules as the Codspeed workflow) and runs the performance tests again. It then downloads the charts-benchmarks-results-${{ github.base_ref }}.json results, which are the results of the branch the PR is pointing to, and compares them, logging a comment like this.

The GitHub Action uses the minimum value of each benchmark to compare against the baseline. If there is a performance degradation greater than 8% (the defined threshold, same as Codspeed), it will fail the GitHub Action.

Stacked PRs, i.e., PRs pointing to another branch that isn't master or next won't have a baseline as baselines aren't uploaded for branches other than master or next. This is solvable by always uploading a baseline and maybe using a lower retention time to avoid uploading too many artifacts, but I didn't want to do it unless there's a need.

The action can fail in two cases:

1. The tests failed, e.g., because an exception was thrown;
2. The benchmarks resulted in a regression that surpassed the defined threshold.

For the former, tests need to be fixed so the action succeeds.
For the latter, there's two options:

1. Improve performance, so that the results are within the threshold, or;
2. Merge with the failing action: this will update the baseline when running the action in master, basically acknowledging the performance degradation and making it the new baseline.

Testing

These actions and scripts were tested in my personal repo.

• Commit to master, which shows the baseline action running
• PR with a successful benchmark, which compares the result with commit from master
• PR with a failing benchmark

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[mui-bot]

Deploy preview: https://deploy-preview-18801--material-ui-x.netlify.app/

Bundle size report

Total Size Change: 0B^(0.00%) - Total Gzip Change: 0B^(0.00%)
Files: 122 total (0 added, 0 removed, 0 changed)

Show details for 100 more bundles (22 more not shown)

@mui/x-charts parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/BarChartPro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/ChartContainerPro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/ChartDataProviderPro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/ChartsToolbarPro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/ChartZoomSlider parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/FunnelChart parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/Heatmap parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/LineChartPro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/PieChartPro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/RadarChartPro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts-pro/ScatterChartPro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/BarChart parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartContainer parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartDataProvider parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsAxis parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsAxisHighlight parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsClipPath parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsGrid parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsLabel parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsLegend parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsLocalizationProvider parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsOverlay parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsReferenceLine parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsSurface parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsText parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsTooltip parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsXAxis parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ChartsYAxis parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/Gauge parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/LineChart parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/PieChart parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/RadarChart parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/ScatterChart parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/SparkLineChart parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-charts/Toolbar parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-data-grid parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-data-grid-premium parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-data-grid-premium/DataGridPremium parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-data-grid-pro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-data-grid-pro/DataGridPro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-data-grid/DataGrid parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/AdapterDateFns parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/AdapterDateFnsJalali parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/AdapterDayjs parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/AdapterLuxon parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/AdapterMoment parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/AdapterMomentHijri parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/AdapterMomentJalaali parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/DateRangeCalendar parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/DateRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/DateRangePickerDay parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/DateRangePickerDay2 parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/DateTimeRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/DesktopDateRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/DesktopDateTimeRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/DesktopTimeRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/LocalizationProvider parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/MobileDateRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/MobileDateTimeRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/MobileTimeRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/MultiInputDateRangeField parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/MultiInputDateTimeRangeField parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/MultiInputTimeRangeField parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/PickersRangeCalendarHeader parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/SingleInputDateRangeField parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/SingleInputDateTimeRangeField parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/SingleInputTimeRangeField parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/StaticDateRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers-pro/TimeRangePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/AdapterDateFns parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/AdapterDateFnsBase parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/AdapterDateFnsJalali parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/AdapterDayjs parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/AdapterLuxon parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/AdapterMoment parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/AdapterMomentHijri parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/AdapterMomentJalaali parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DateCalendar parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DateField parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DatePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DateTimeField parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DateTimePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DayCalendarSkeleton parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DesktopDatePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DesktopDateTimePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DesktopTimePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/DigitalClock parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/LocalizationProvider parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/MobileDatePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/MobileDateTimePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/MobileTimePicker parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/MonthCalendar parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/MultiSectionDigitalClock parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/PickerDay2 parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/PickersActionBar parsed: 0B^(0.00%) gzip: 0B^(0.00%)
@mui/x-date-pickers/PickersCalendarHeader parsed: 0B^(0.00%) gzip: 0B^(0.00%)

Details of bundle changes

Generated by 🚫 dangerJS against 6838431

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.