Extract resource identifier schema generator

Author: bkoelman

src/JsonApiDotNetCore.OpenApi/ServiceCollectionExtensions.cs

@@ -118,7 +118,7 @@ private static void SetSchemaIdSelector(SwaggerGenOptions swaggerGenOptions, IRe
     private static void AddCustomSwaggerComponents(IServiceCollection services)
     {
         services.TryAddSingleton<SwaggerGenerator>();
-        services.TryAddSingleton<ISwaggerProvider, CachingSwaggerGenerator>();
+        services.TryAddSingleton<ISwaggerProvider, CachingSwaggerProvider>();
 
         services.TryAddSingleton<ISerializerDataContractResolver, JsonApiDataContractResolver>();
     }

src/JsonApiDotNetCore.OpenApi/SwaggerComponents/CachingSwaggerGenerator.cs renamed to src/JsonApiDotNetCore.OpenApi/SwaggerComponents/CachingSwaggerProvider.cs

@@ -9,12 +9,12 @@ namespace JsonApiDotNetCore.OpenApi.SwaggerComponents;
 /// The default <see cref="ISwaggerProvider" /> implementation re-renders the OpenApiDocument every time it is requested, which is redundant in our case.
 /// This implementation provides a very basic caching layer.
 /// </summary>
-internal sealed class CachingSwaggerGenerator : ISwaggerProvider
+internal sealed class CachingSwaggerProvider : ISwaggerProvider
 {
     private readonly SwaggerGenerator _defaultSwaggerGenerator;
     private readonly ConcurrentDictionary<string, OpenApiDocument> _openApiDocumentCache = new();
 
-    public CachingSwaggerGenerator(SwaggerGenerator defaultSwaggerGenerator)
+    public CachingSwaggerProvider(SwaggerGenerator defaultSwaggerGenerator)
     {
         ArgumentGuard.NotNull(defaultSwaggerGenerator);
 

src/JsonApiDotNetCore.OpenApi/SwaggerComponents/JsonApiSchemaGenerator.cs

@@ -63,7 +63,7 @@ public JsonApiSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IResourceG
         _defaultSchemaGenerator = defaultSchemaGenerator;
         _options = options;
 
-        _resourceObjectSchemaGenerator = new ResourceObjectSchemaGenerator(defaultSchemaGenerator, resourceGraph, options, _schemaRepositoryAccessor,
+        _resourceObjectSchemaGenerator = new ResourceObjectSchemaGenerator(defaultSchemaGenerator, _schemaRepositoryAccessor, resourceGraph, options,
             resourceFieldValidationMetadataProvider);
     }
 

src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceFieldObjectSchemaBuilder.cs

@@ -1,5 +1,4 @@
 using System.Reflection;
-using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.OpenApi.JsonApiMetadata;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
@@ -31,31 +30,31 @@ internal sealed class ResourceFieldObjectSchemaBuilder
         JsonApiPropertyName.Meta
     ];
 
-    private readonly ResourceTypeInfo _resourceTypeInfo;
-    private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;
     private readonly SchemaGenerator _defaultSchemaGenerator;
-    private readonly ResourceTypeSchemaGenerator _resourceTypeSchemaGenerator;
-    private readonly SchemaRepository _resourceSchemaRepository = new();
-    private readonly IDictionary<string, OpenApiSchema> _schemasForResourceFields;
+    private readonly ResourceIdentifierObjectSchemaGenerator _resourceIdentifierObjectSchemaGenerator;
+    private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;
+    private readonly ResourceTypeInfo _resourceTypeInfo;
     private readonly ResourceFieldValidationMetadataProvider _resourceFieldValidationMetadataProvider;
+    private readonly SchemaRepository _resourceSchemaRepository = new();
     private readonly RelationshipTypeFactory _relationshipTypeFactory;
+    private readonly IDictionary<string, OpenApiSchema> _schemasForResourceFields;
     private readonly NullabilityInfoContext _nullabilityInfoContext = new();
     private readonly ResourceObjectDocumentationReader _resourceObjectDocumentationReader;
 
-    public ResourceFieldObjectSchemaBuilder(ResourceTypeInfo resourceTypeInfo, ISchemaRepositoryAccessor schemaRepositoryAccessor,
-        SchemaGenerator defaultSchemaGenerator, ResourceTypeSchemaGenerator resourceTypeSchemaGenerator,
-        ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider)
+    public ResourceFieldObjectSchemaBuilder(SchemaGenerator defaultSchemaGenerator,
+        ResourceIdentifierObjectSchemaGenerator resourceIdentifierObjectSchemaGenerator, ISchemaRepositoryAccessor schemaRepositoryAccessor,
+        ResourceTypeInfo resourceTypeInfo, ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider)
     {
-        ArgumentGuard.NotNull(resourceTypeInfo);
-        ArgumentGuard.NotNull(schemaRepositoryAccessor);
         ArgumentGuard.NotNull(defaultSchemaGenerator);
-        ArgumentGuard.NotNull(resourceTypeSchemaGenerator);
+        ArgumentGuard.NotNull(resourceIdentifierObjectSchemaGenerator);
+        ArgumentGuard.NotNull(schemaRepositoryAccessor);
+        ArgumentGuard.NotNull(resourceTypeInfo);
         ArgumentGuard.NotNull(resourceFieldValidationMetadataProvider);
 
-        _resourceTypeInfo = resourceTypeInfo;
-        _schemaRepositoryAccessor = schemaRepositoryAccessor;
         _defaultSchemaGenerator = defaultSchemaGenerator;
-        _resourceTypeSchemaGenerator = resourceTypeSchemaGenerator;
+        _resourceIdentifierObjectSchemaGenerator = resourceIdentifierObjectSchemaGenerator;
+        _schemaRepositoryAccessor = schemaRepositoryAccessor;
+        _resourceTypeInfo = resourceTypeInfo;
         _resourceFieldValidationMetadataProvider = resourceFieldValidationMetadataProvider;
 
         _relationshipTypeFactory = new RelationshipTypeFactory(resourceFieldValidationMetadataProvider);
@@ -160,38 +159,12 @@ public void SetMembersOfRelationshipsObject(OpenApiSchema fullSchemaForRelations
 
             if (matchingRelationship != null)
             {
-                EnsureResourceIdentifierObjectSchemaExists(matchingRelationship);
+                _ = _resourceIdentifierObjectSchemaGenerator.GenerateSchema(matchingRelationship.RightType);
                 AddRelationshipSchemaToResourceObject(matchingRelationship, fullSchemaForRelationshipsObject);
             }
         }
     }
 
-    private void EnsureResourceIdentifierObjectSchemaExists(RelationshipAttribute relationship)
-    {
-        Type resourceIdentifierObjectType = typeof(ResourceIdentifierObject<>).MakeGenericType(relationship.RightType.ClrType);
-
-        if (!ResourceIdentifierObjectSchemaExists(resourceIdentifierObjectType))
-        {
-            GenerateResourceIdentifierObjectSchema(resourceIdentifierObjectType, relationship.RightType);
-        }
-    }
-
-    private bool ResourceIdentifierObjectSchemaExists(Type resourceIdentifierObjectType)
-    {
-        return _schemaRepositoryAccessor.Current.TryLookupByType(resourceIdentifierObjectType, out _);
-    }
-
-    private void GenerateResourceIdentifierObjectSchema(Type resourceIdentifierObjectType, ResourceType resourceType)
-    {
-        OpenApiSchema referenceSchemaForResourceIdentifierObject =
-            _defaultSchemaGenerator.GenerateSchema(resourceIdentifierObjectType, _schemaRepositoryAccessor.Current);
-
-        OpenApiSchema fullSchemaForResourceIdentifierObject =
-            _schemaRepositoryAccessor.Current.Schemas[referenceSchemaForResourceIdentifierObject.Reference.Id];
-
-        fullSchemaForResourceIdentifierObject.Properties[JsonApiPropertyName.Type] = _resourceTypeSchemaGenerator.Get(resourceType);
-    }
-
     private void AddRelationshipSchemaToResourceObject(RelationshipAttribute relationship, OpenApiSchema fullSchemaForRelationshipsObject)
     {
         Type relationshipSchemaType = GetRelationshipSchemaType(relationship, _resourceTypeInfo.ResourceObjectOpenType);

src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceIdentifierObjectSchemaGenerator.cs

@@ -0,0 +1,45 @@
+using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace JsonApiDotNetCore.OpenApi.SwaggerComponents;
+
+internal sealed class ResourceIdentifierObjectSchemaGenerator
+{
+    private readonly SchemaGenerator _defaultSchemaGenerator;
+    private readonly ResourceTypeSchemaGenerator _resourceTypeSchemaGenerator;
+    private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;
+
+    public ResourceIdentifierObjectSchemaGenerator(SchemaGenerator defaultSchemaGenerator, ResourceTypeSchemaGenerator resourceTypeSchemaGenerator,
+        ISchemaRepositoryAccessor schemaRepositoryAccessor)
+    {
+        ArgumentGuard.NotNull(defaultSchemaGenerator);
+        ArgumentGuard.NotNull(resourceTypeSchemaGenerator);
+        ArgumentGuard.NotNull(schemaRepositoryAccessor);
+
+        _defaultSchemaGenerator = defaultSchemaGenerator;
+        _resourceTypeSchemaGenerator = resourceTypeSchemaGenerator;
+        _schemaRepositoryAccessor = schemaRepositoryAccessor;
+    }
+
+    public OpenApiSchema GenerateSchema(ResourceType resourceType)
+    {
+        ArgumentGuard.NotNull(resourceType);
+
+        Type resourceIdentifierObjectType = typeof(ResourceIdentifierObject<>).MakeGenericType(resourceType.ClrType);
+
+        if (!_schemaRepositoryAccessor.Current.TryLookupByType(resourceIdentifierObjectType, out OpenApiSchema? referenceSchemaForResourceIdentifierObject))
+        {
+            referenceSchemaForResourceIdentifierObject =
+                _defaultSchemaGenerator.GenerateSchema(resourceIdentifierObjectType, _schemaRepositoryAccessor.Current);
+
+            OpenApiSchema fullSchemaForResourceIdentifierObject =
+                _schemaRepositoryAccessor.Current.Schemas[referenceSchemaForResourceIdentifierObject.Reference.Id];
+
+            fullSchemaForResourceIdentifierObject.Properties[JsonApiPropertyName.Type] = _resourceTypeSchemaGenerator.Get(resourceType);
+        }
+
+        return referenceSchemaForResourceIdentifierObject;
+    }
+}

src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceObjectSchemaGenerator.cs

@@ -18,30 +18,33 @@ internal sealed class ResourceObjectSchemaGenerator
     ];
 
     private readonly SchemaGenerator _defaultSchemaGenerator;
+    private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;
     private readonly IResourceGraph _resourceGraph;
     private readonly IJsonApiOptions _options;
-    private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;
     private readonly ResourceTypeSchemaGenerator _resourceTypeSchemaGenerator;
     private readonly Func<ResourceTypeInfo, ResourceFieldObjectSchemaBuilder> _resourceFieldObjectSchemaBuilderFactory;
     private readonly ResourceObjectDocumentationReader _resourceObjectDocumentationReader;
 
-    public ResourceObjectSchemaGenerator(SchemaGenerator defaultSchemaGenerator, IResourceGraph resourceGraph, IJsonApiOptions options,
-        ISchemaRepositoryAccessor schemaRepositoryAccessor, ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider)
+    public ResourceObjectSchemaGenerator(SchemaGenerator defaultSchemaGenerator, ISchemaRepositoryAccessor schemaRepositoryAccessor,
+        IResourceGraph resourceGraph, IJsonApiOptions options, ResourceFieldValidationMetadataProvider resourceFieldValidationMetadataProvider)
     {
         ArgumentGuard.NotNull(defaultSchemaGenerator);
+        ArgumentGuard.NotNull(schemaRepositoryAccessor);
         ArgumentGuard.NotNull(resourceGraph);
         ArgumentGuard.NotNull(options);
-        ArgumentGuard.NotNull(schemaRepositoryAccessor);
         ArgumentGuard.NotNull(resourceFieldValidationMetadataProvider);
 
         _defaultSchemaGenerator = defaultSchemaGenerator;
+        _schemaRepositoryAccessor = schemaRepositoryAccessor;
         _resourceGraph = resourceGraph;
         _options = options;
-        _schemaRepositoryAccessor = schemaRepositoryAccessor;
         _resourceTypeSchemaGenerator = new ResourceTypeSchemaGenerator(schemaRepositoryAccessor, options.SerializerOptions.PropertyNamingPolicy);
 
-        _resourceFieldObjectSchemaBuilderFactory = resourceTypeInfo => new ResourceFieldObjectSchemaBuilder(resourceTypeInfo, schemaRepositoryAccessor,
-            defaultSchemaGenerator, _resourceTypeSchemaGenerator, resourceFieldValidationMetadataProvider);
+        var resourceIdentifierObjectSchemaGenerator =
+            new ResourceIdentifierObjectSchemaGenerator(defaultSchemaGenerator, _resourceTypeSchemaGenerator, schemaRepositoryAccessor);
+
+        _resourceFieldObjectSchemaBuilderFactory = resourceTypeInfo => new ResourceFieldObjectSchemaBuilder(defaultSchemaGenerator,
+            resourceIdentifierObjectSchemaGenerator, schemaRepositoryAccessor, resourceTypeInfo, resourceFieldValidationMetadataProvider);
 
         _resourceObjectDocumentationReader = new ResourceObjectDocumentationReader();
     }

src/JsonApiDotNetCore.OpenApi/SwaggerComponents/ResourceTypeSchemaGenerator.cs

@@ -9,6 +9,7 @@ namespace JsonApiDotNetCore.OpenApi.SwaggerComponents;
 internal sealed class ResourceTypeSchemaGenerator
 {
     private const string ResourceTypeSchemaIdTemplate = "[ResourceName] Resource Type";
+
     private readonly ISchemaRepositoryAccessor _schemaRepositoryAccessor;
     private readonly JsonNamingPolicy? _namingPolicy;
     private readonly Dictionary<Type, OpenApiSchema> _resourceClrTypeSchemaCache = [];