Contrib.social

AlterBodySubscriber error when response HTML does not contain ___storybook_wrapper

Open on Drupal.org →
Created on 12 February 2024, 4 months ago
Updated 13 March 2024, 3 months ago

Problem/Motivation

We have a custom module that calls ContainerAwareEventDispatcher::dispatchRequest() to dispatch a fake request.
This request is caught by AlterBodySubscriber::alter() which fails with this error:

DOMNode::appendChild(): Argument #1 ($node) must be of type DOMNode, null given

Steps to reproduce

    $fakeResponse = new HtmlResponse();
    $fakeResponse->setContent($html);

    $event = new ResponseEvent(
      \Drupal::service('http_kernel'),
      \Drupal::requestStack()->getMainRequest()->duplicate(),
      HttpKernelInterface::SUB_REQUEST,
      $fakeResponse
    );
    $this->eventDispatcher->dispatch($event, KernelEvents::RESPONSE);

Proposed resolution

AlterBodySubscriber should make sure ___storybook_wrapper exists before trying to use it.

🐛 Bug report
Status

Fixed

Version

1.0

Component

Other tooling

Created by

🇫🇷France prudloff Lille

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @prudloff
  • Merge request !4Issue #3420900: AlterBodySubscriber error when response HTML does not contain ___storybook_wrapper → (Merged) created by prudloff
  • Status changed to Needs review 4 months ago
  • Comment 4 months ago →
    🇫🇷France prudloff Lille
  • Pipeline finished with Success
    4 months ago
    Total: 164s
    #93250
  • Status changed to Fixed 4 months ago
  • Comment 4 months ago →
    e0ipso Can Picafort

    I am a bit puzzled by this. This code should only execute when sending a response from the storybook.render_story controller. Which in this case is guaranteed to pass those if statements, right?

    In any case, I am all in for defensive coding. So I will merge this one.

  • Pipeline finished with Skipped
    4 months ago
    #105758
  • Pipeline finished with Skipped
    4 months ago
    #105760
  • Comment 4 months ago →
    System Message
  • Comment 4 months ago →
    e0ipso Can Picafort
  • Comment 4 months ago →
    🇫🇷France prudloff Lille

    I am a bit puzzled by this. This code should only execute when sending a response from the storybook.render_story controller.

    What we do is clearly atypical and an edge-case.
    (Basically we trigger a response event on a fake request in order to trigger response event subscribres on HTML that is rendered separately from the main response, kind of like what big_pipe does.)

    In any case, I am all in for defensive coding. So I will merge this one.

    I normally would have fixed this on our side, but it seemed like a good occasion to make the storybook code more robust; I am glad we agree on this, thanks!

  • Comment 3 months ago →
    System Message

    Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions
Production build 0.69.0 2024