Content meta is not merged with paginated data meta

[lindyhopchris]

@lindyhopchris Are there any concrete plans on tackling this in the foreseeable future?

I'm currently struggling using the searched hook to add/update a top-level meta field when having paginated results.

e.g. I currently have some response with top-level pagination meta "magically" (to my current knowledge) added:

{
  "meta": {
    "page": {
      "current-page": 1,
      "per-page": 100,
      "from": 1,
      "to": 100,
      "total": 21781,
      "last-page": 218
    }
  },
 "links": {},
 "data": {}
}

Without finding the time yet to delve into the code, it seems that data in a LengthAwarePaginator somehow result in pagination information being included in the top level meta.

Now my problem is, that I didn't find an obvious way to get my hands on that pagination meta data within the searched hook to extend it with some custom data.

My current implementation looks something like this and loses the page metadata:

public function searched($paginatedData)
{
    $meta = ['some' => 'data'];

    return $this->reply()
        ->content(
            $paginatedData,
            [],  // links
           $meta  // <-- how can I add my own meta without overriding the pagination meta?
        );
}

What I would like to have is something like this (note the "some": "data" next to page):

{
  "meta": {
    "some": "data",
    "page": {
      "current-page": 1,
      "per-page": 100,
      "from": 1,
      "to": 100,
      "total": 21781,
      "last-page": 218
    }
  },
 "links": {},
 "data": {}
}

Originally posted by @tsterker in #225 (comment)

[lindyhopchris]

The bug is basically that:

$this->reply()->content($paginatedData, [], $meta);

should merge the supplied meta with the paginated data's meta.

[lindyhopchris]

Problem with this is these lines:

laravel-json-api/src/Http/Controllers/JsonApiController.php

Lines 338 to 342 in 2e51f0d

	$records = ($found instanceof PageInterface) ? $found->getData() : $found;
	if ($result = $this->invoke('searched', $records, $request)) {
	return $result;
	}

Because the page interface is converted to the underlying records, there's no way for the searched hook to return the page metadata.

This is a design problem... I didn't pass through the page interface because my thinking was the page interface might have to change as part of sorting all the meta out for 2.0. Ideally we need the adapter to return some sort of document interface as really the adapter should be capable of returning a data/meta/links combination that can then be passed on to the encoder. That adapter result could then be passed to the hooks, providing a consistent interface for interacting with an adapter result.

So ultimately I can't fix this on 1.x as the fix will involve a breaking change to the searched hook. Need to sort all this out for 2.0.

[lindyhopchris]

Closing this, as this is solved in the new laravel-json-api/laravel package.