Unable to do nested eager loading using #[ResponseFromApiResource]

[issakujitsuk]

Scribe version

4.29.0

PHP version

8.2.8

Framework

Laravel

Framework version

10.17.0

Scribe config

try_it_out.enabled => false
auth.enabled => true
auth.default => true
postman.enabled => false
openapi.enabled => false
last_updated => "Last updated: {date:Y-m-d}"
strategies.urlParameters => added Knuckles\Scribe\Extracting\Strategies\UrlParameters\GetFromLumenAPI
strategies.headers => added Knuckles\Scribe\Extracting\Strategies\Headers\GetFromRouteRules: removed [
    'override',
    [
        'Content-Type' => 'application/json',
        'Accept' => 'application/json',
    ],
]
strategies.responses => added Knuckles\Scribe\Extracting\Strategies\Responses\ResponseCalls: removed [
    'Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls',
    [
        'only' => [
            'GET *',
        ],
    ],
]

What happened?

Thanks for Scribe.

I declared an attribute like this.

#[ResponseFromApiResource(
    BookResource::class, 
    Book::class,
    with: ["author.contacts"],
)]

Expected (at BookResource):

$this->resource->relationLoaded("author"); // true
$this->resource->author->relationLoaded("contacts"); // true

As is:

$this->resource->relationLoaded("author"); // 👍 true
$this->resource->author->relationLoaded("contacts"); // 🆖 false

I see a problem here.

scribe/src/Extracting/InstantiatesExampleModels.php

Line 72 in 695c2a9

return $factory->create()->load($relations)->refresh();

I am able to load nested relations as expected until $factory->create()->load($relations),
but the contacts relation is lost in refresh().

Sorry if my language is poor and rude.

Docs

• I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

[shalvah]

Not to worry, your language isn't poor or rude.

First off, disclaimer: I don't have much experience with API resources, so I can't help much.
But here's the PR where we added refresh: #753
I don't fully understand, but it looks like there was a good reason. Maybe the refresh should be before the load?🤔

[issakujitsuk]

Hi, @shalvah. Thanks for your reply.

As you guessed, $factory->create()->refresh()->load($relations) worked fine for me 😃
The issues fixed in #753 may have been as follows.

Book table:

CREATE TABLE `books` (
  `id` bigint unsigned NOT NULL AUTO_INCREMENT,
  `title` varchar(255) COLLATE utf8mb4_bin NOT NULL,
  `volume` tinyint unsigned NOT NULL DEFAULT '1',   -- ⚠ volume has default value
  `updated_at` datetime NOT NULL,
  `created_at` datetime NOT NULL,
  PRIMARY KEY (`id`)
)

BookFactory:

public function definition(): array
{
    return [
        "title" => fake()->sentence(),
        // ⚠ volume is undefined.
    ];
}

Creating a model from a factory:

$book = Book::factory()->create();
/*
= App\Models\Book {
    title: "Eveniet nihil temporibus aut.",
    updated_at: "2024-01-18 00:00:00",
    created_at: "2024-01-18 00:00:00",
    id: 1,
  }
*/
// ⚠ volume is missing

$book->refresh();
/*
= App\Models\Book {
    id: 1,
    title: "Eveniet nihil temporibus aut.",
    volume: 1,
    updated_at: "2024-01-18 00:00:00",
    created_at: "2024-01-18 00:00:00",
  }
*/