Allow to merge AjaxCommands inside of AjaxResponse

The Needs Review Queue Bot → tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.

enaznin → made their first commit to this issue’s fork.

There is an addCommand method that does much more than a simple array_merge so there is bound to be issues doing it this way.

MR should be against 10.1.x since that is the current dev version

Naming of the new function is not ideal. It's not about setting commands, I'd be more of a mergeCommands method
At the moment commands can be added the addCommand method, so what the issue raised could be worked around @Mschudders would that be enough?

@nod thanks for the information.

Indeed the naming was crappy.

Created a new branch against 10.1.x with the bot fixes + naming changes to the function.

Let me elaborate why this is usefull:

I have overridden MediaLibraryWidget so that I can attach an extra Ajax command to the callback of updateWidget:

  public static function updateWidget(array $form, FormStateInterface $form_state) {
    $response = parent::updateWidget($form, $form_state);

    $lb = new LayoutBuilderExtras();
    $responseLbExtraLiveUpdates = $lb->blockAjaxSave($form, $form_state);
    $commandsLiveUpdate = $responseLbExtraLiveUpdates->getCommands();
    $response->mergeCommands($commandsLiveUpdate);

    return $response;
  }

Since updateWidget returns an AjaxReponse already it isn't easy to add an additional command to it.
If you retrieve the commands from AjaxReponse it's already an rendered array and you cannot set them again. That's why I have added a mergeCommands function so that you can merge the commands.
I hope this clarifies things.

Rebased to be up-to-date.

Can the MR be updated for 11.x as that's the current development branch.

Also could use a simple test assertion to show it's working.

Still needs test.

The module Layout Builder Extras - live update → requires this patch.