Merge pull request #32 from dedoc/fix/issue-31

Fix circular references in resources and improved `whenLoaded` support
dedoc · Sep 23, 2022 · 811c9ba · 811c9ba
2 parents 6d5e598 + 6efcf47
commit 811c9ba
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/src/Support/Generator/Components.php b/src/Support/Generator/Components.php
@@ -87,4 +87,9 @@ public static function slug(string $name)
     {
         return Str::replace('\\', '.', $name);
     }
+
+    public function removeSchema(string $schemaName): void
+    {
+        unset($this->schemas[$schemaName]);
+    }
 }
diff --git a/src/Support/Generator/TypeTransformer.php b/src/Support/Generator/TypeTransformer.php
@@ -13,6 +13,7 @@
 use Dedoc\Scramble\Support\Generator\Types\NumberType;
 use Dedoc\Scramble\Support\Generator\Types\ObjectType;
 use Dedoc\Scramble\Support\Generator\Types\StringType;
+use Dedoc\Scramble\Support\Generator\Types\UnknownType;
 use Dedoc\Scramble\Support\Type\ArrayItemType_;
 use Dedoc\Scramble\Support\Type\Type;
 use Dedoc\Scramble\Support\Type\Union;
@@ -166,6 +167,10 @@ function ($acc, $extensionClass) use ($type) {
                     return $reference;
                 }
 
+                if ($reference) {
+                    $this->components->addSchema($reference->fullName, Schema::fromType(new UnknownType('Reference is being analyzed.')));
+                }
+
                 if ($handledType = $extension->toSchema($type, $acc)) {
                     if ($reference) {
                         return $this->components->addSchema($reference->fullName, Schema::fromType($handledType));
@@ -174,6 +179,13 @@ function ($acc, $extensionClass) use ($type) {
                     return $handledType;
                 }
 
+                /*
+                 * If we couldn't handle a type, the reference is removed.
+                 */
+                if ($reference) {
+                    $this->components->removeSchema($reference->fullName);
+                }
+
                 return $acc;
             }
         );

diff --git a/src/Support/InferExtensions/JsonResourceTypeInfer.php b/src/Support/InferExtensions/JsonResourceTypeInfer.php
@@ -78,11 +78,12 @@ public function getType(Expr $node, Scope $scope): ?Type
         }
 
         /*
-         * new JsonResource($this->whenLoaded)
+         * new JsonResource($this->whenLoaded('?'))
+         * JsonResource::make($this->whenLoaded('?'))
+         * JsonResource::collection($this->whenLoaded('?'))
          */
         if (
             $node instanceof Node\Expr\ArrayItem
-            && $node->value instanceof Node\Expr\New_
             && $scope->getType($node->value)->isInstanceOf(JsonResource::class)
             && $this->isMethodCallToThis(optional($node->value->args[0])->value, ['whenLoaded'])
         ) {