Wrapping inconsistencies

[mdietger]

In my config I have wrappig enabled

<?php

return [
    ...
    'wrap' => 'data',
    ...
]

I have a DTO like this

<?php

#[TypeScript]
#[MapInputName(SnakeCaseMapper::class)]
class OrderData extends Data
{
    public function __construct(
        ...
        #[DataCollectionOf(DeliveryData::class)]
        public ?DataCollection $deliveries,
        ...
    ) {
    }
}

Now I have 2 controllers. 1 to get a specific order and 1 to get list of orders as such

<?php

class GetOrderController extends Controller
{
    public function __invoke(
        Order $order
    ): OrderData {
        Gate::authorize('view', $order);
        
        return OrderData::from($order);
    }
}

<?php

class ListOrdersController extends Controller
{
    public function __invoke(): PaginatedDataCollection
    {
        Gate::authorize('viewAny', Order::class);
        
        $user = auth()->user();
        $orders = QueryBuilder::for(Order::query()->withCompany($user->company))
            ->allowedFilters(['order_status'])
            ->allowedIncludes(['customer', 'handler'])
            ->simplePaginate()
            ->appends(request()->query());

        return OrderData::collect($orders, PaginatedDataCollection::class);
    }
}

But the result differs in the way it wraps the data.

Result for a single order

{
	"data": {
                ...
		"deliveries": {
			"data": [ <-- this one is added for a single order result
				{
					"origin": ...
					"destination": ...
				}
			]
		},
                ...
	}
}

Result for multiple orders

{
	"data": [
		{
			...
			"deliveries": [
				{
					"origin": ...,
					"destination": ...
				}
			],
			...
		}
	],
	"links": [],
	"meta": {
            ...
	}
}

While deliveries are in both cases an array of object, for a single order they are wrapped inside a data object but for a list of order they aren't while using the same OrderData class to return the data.

[rubenvanassche]

When I try to reproduce this using this test it works:

it('is weird sometimes', function () {
    config()->set('data.wrap', 'data');

    class TestData extends Data
    {
        public string $string;

        #[DataCollectionOf(SimpleData::class)]
        public array $array;
    }

    $dataA = TestData::from([
        'string' => 'Hello World',
        'array' => [
            ['string' => 'A'],
            ['string' => 'B'],
        ],
    ]);

    $dataB = TestData::from([
        'string' => 'Hello World',
        'array' => [
            ['string' => 'A'],
            ['string' => 'B'],
        ],
    ]);

    dd(
        $dataA->toResponse(request())->getData(true),
        (new PaginatedDataCollection(
            TestData::class,
            new LengthAwarePaginator([$dataA, $dataB], 2, 2)
        ))->toResponse(request())->getData(true)
    );
});

DD:

array:1 [
  "data" => array:2 [
    "string" => "Hello World"
    "array" => array:1 [
      "data" => array:2 [
        0 => array:1 [
          "string" => "A"
        ]
        1 => array:1 [
          "string" => "B"
        ]
      ]
    ]
  ]
] // /Users/ruben/Spatie/laravel-data/tests/DataTest.php:113
array:3 [
  "data" => array:2 [
    0 => array:2 [
      "string" => "Hello World"
      "array" => array:1 [
        "data" => array:2 [
          0 => array:1 [
            "string" => "A"
          ]
          1 => array:1 [
            "string" => "B"
          ]
        ]
      ]
    ]
    1 => array:2 [
      "string" => "Hello World"
      "array" => array:1 [
        "data" => array:2 [
          0 => array:1 [
            "string" => "A"
          ]
          1 => array:1 [
            "string" => "B"
          ]
        ]
      ]
    ]
  ]
  "links" => array:3 [
    0 => array:3 [
      "url" => null
      "label" => "« Previous"
      "active" => false
    ]
    1 => array:3 [
      "url" => "/?page=1"
      "label" => "1"
      "active" => true
    ]
    2 => array:3 [
      "url" => null
      "label" => "Next »"
      "active" => false
    ]
  ]
  "meta" => array:11 [
    "current_page" => 1
    "first_page_url" => "/?page=1"
    "from" => 1
    "last_page" => 1
    "last_page_url" => "/?page=1"
    "next_page_url" => null
    "path" => "/"
    "per_page" => 2
    "prev_page_url" => null
    "to" => 2
    "total" => 2
  ]
] 

[mdietger]

I see, I used

#[DataCollectionOf(DeliveryData::class)]
public ?DataCollection $deliveries

but when using

#[DataCollectionOf(DeliveryData::class)]
public array $deliveries

the results are more consistant.