Cache controller with json response

Question

I want cached a controller that returns a json.. I try this:

$build = array(
  '#cache' => array(
    'contexts' => ['ip'],
  ),
);
return (new CacheableJsonResponse(['test'], 200))->addCacheableDependency(CacheableMetadata::createFromRenderArray($build));

But i get an exception:

LogicException: The controller result claims to be providing relevant cache metadata, but leaked metadata was detected. Please ensure you are not rendering content too early. Returned object class: Drupal\Core\Cache\CacheableJsonResponse. in Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->wrapControllerExecutionInRenderContext() (line 154 of /Applications/MAMP/htdocs/finder-cms/docroot/core/lib/Drupal/Core/EventSubscriber/EarlyRenderingControllerWrapperSubscriber.php).

Answer 1

The controller from your question runs without exception:

public function demo() {
  $build = [
    '#cache' => [
      'contexts' => ['ip'],
    ],
  ];
  return (new CacheableJsonResponse(['test'], 200))->addCacheableDependency(CacheableMetadata::createFromRenderArray($build));
}

Result:

["test"]

To produce the exception you need a controller like this:

public function demo() {

  $build = ['#markup' => 'early rendering'];
  $markup = \Drupal::service('renderer')->render($build);

  $build = [
    '#cache' => [
      'contexts' => ['ip'],
    ],
  ];
  return (new CacheableJsonResponse(['test'], 200))->addCacheableDependency(CacheableMetadata::createFromRenderArray($build));
}

Result:

LogicException: The controller result claims to be providing relevant cache metadata, but leaked metadata was detected. Please ensure you are not rendering content too early.

This may not always be that obvious. Another example is when you try to get an url from an url object, see this answer https://drupal.stackexchange.com/a/187094/47547

---

Add an URL with cacheable metadata to a response

This is how you avoid the exception, when you render an url for a json response, and at the same time add the correct cache metadata to the response:

  $generated_url = $url->toString(TRUE);
  $response = new CacheableJsonResponse(['url' => $generated_url->getGeneratedUrl()], 200);
  $response->addCacheableDependency($generated_url);
  return $response;

Answer 2

After using multiple options, below code worked in my case for returning rest response.

$url = \Drupal\Core\Url::fromRoute('entity.node.canonical', [
  'node' => $node->id(),
], $options);
$url = $url->toString(true)->getGeneratedUrl();

Cheers!