fix: React to config changes

[archmoj]

Description

Use newPlot if config has changed instead of _doPlot inside Plotly.react.

Closes #7551.
Supersedes #6395.

Changes

• Adds check to determine if newPlot should be used
• Updates tests per above change

Testing

• Be on master
• Launch Plotly DevTools
• Open mock line_scatter (other mocks could work, but I know this one does)
• Run the following snippet to update the mode bar buttons:

  let toggle = true
  
  Plotly.react(
    gd,
    gd.data,
    gd.layout,
    {
      displaylogo: false,
      modeBarButtonsToAdd: [
        {
          name: 'custombutton',
          title: toggle ? 'Take PICTURE' : 'Record MOVIE',
          icon: toggle ? Plotly.Icons.camera : Plotly.Icons.movie,
          click: () => {}
        },
      ],
      modeBarButtonsToRemove: [
        "autoscale",
        "pan2d",
        "lasso2d",
        "resetScale2d",
        "select2d",
        "toImage",
        "zoom",
        "zoomIn2d",
        "zoomOut2d"
      ]
    }
  )

• Run this other snippet to update the label of the custom button:

  toggle = false
  
  Plotly.react(
    gd,
    gd.data,
    gd.layout,
    {
      displaylogo: false,
      modeBarButtonsToAdd: [
        {
          name: 'custombutton',
          title: toggle ? 'Take PICTURE' : 'Record MOVIE',
          icon: toggle ? Plotly.Icons.camera : Plotly.Icons.movie,
          click: () => {}
        },
      ],
      modeBarButtonsToRemove: [
        "autoscale",
        "pan2d",
        "lasso2d",
        "resetScale2d",
        "select2d",
        "toImage",
        "zoom",
        "zoomIn2d",
        "zoomOut2d"
      ]
    }
  )

• Note that the button title and icon have not updated
• Switch to this branch
• Reload the mock
• Run the two snippets again
• Note that the button title and icon have changed

Notes

• This PR was originally created by @archmoj, but @camdecoster updated the OP with testing details
• Though this change fixes the issue with some config updates not being reflected in the new plot, it doesn't add the original config to the graph div like gd.data or gd.layout. For that reason, I don't think that this PR fixes the original issue in enable updating the config of a plot without changing other parameters #6394 so I'm not going to close that issue once this merges.

[camdecoster]

This seems okay, but before I approve could you please provide a description and some steps to reproduce the issue? Then I can test before/after changes and see the fix in action.

[emilykl]

@camdecoster This is intended to address #6394, correct?

Never mind, just saw your comment in the PR description. In that case, would it make sense to open another issue which can be closed by this PR?

[emilykl]

Looks reasonable to me.

[camdecoster]

@camdecoster This is intended to address #6394, correct?

Never mind, just saw your comment in the PR description. In that case, would it make sense to open another issue which can be closed by this PR?

Yes. I have a comment drafted about that, but never submitted it. 🤦

[emilykl]

@camdecoster Is there a reason we don't want to emit a plotly_react event if the config changed?

[camdecoster]

It will emit twice for one call to react without that check. This is because we call newPlot and then react again after that, all within the first call to react.