Rename MongoIdentifiable to HexStringMongoIdentifiable, extract interface IMongoIdentifiable

Author: Bart Koelman

src/Examples/GettingStarted/Models/Book.cs

@@ -6,7 +6,7 @@ namespace GettingStarted.Models;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource]
-public sealed class Book : MongoIdentifiable
+public sealed class Book : HexStringMongoIdentifiable
 {
     [Attr]
     public string Title { get; set; } = null!;

src/Examples/JsonApiDotNetCoreMongoDbExample/Models/TodoItem.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbExample.Models;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource]
-public sealed class TodoItem : MongoIdentifiable
+public sealed class TodoItem : HexStringMongoIdentifiable
 {
     [Attr]
     public string Description { get; set; } = null!;

src/JsonApiDotNetCore.MongoDb/Queries/Internal/HideRelationshipsSparseFieldSetCache.cs

@@ -1,5 +1,6 @@
 using System.Collections.Immutable;
 using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.MongoDb.Resources;
 using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Internal;
 using JsonApiDotNetCore.Resources;
@@ -38,6 +39,11 @@ public IImmutableSet<ResourceFieldAttribute> GetSparseFieldSetForSerializer(Reso
     {
         IImmutableSet<ResourceFieldAttribute> fieldSet = _innerCache.GetSparseFieldSetForSerializer(resourceType);
 
+        return resourceType.ClrType.IsAssignableTo(typeof(IMongoIdentifiable)) ? RemoveRelationships(fieldSet) : fieldSet;
+    }
+
+    private static IImmutableSet<ResourceFieldAttribute> RemoveRelationships(IImmutableSet<ResourceFieldAttribute> fieldSet)
+    {
         ResourceFieldAttribute[] relationships = fieldSet.Where(field => field is RelationshipAttribute).ToArray();
         return fieldSet.Except(relationships);
     }

src/JsonApiDotNetCore.MongoDb/Repositories/MongoRepository.cs

@@ -5,6 +5,7 @@
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.MongoDb.Errors;
 using JsonApiDotNetCore.MongoDb.Queries.Internal.QueryableBuilding;
+using JsonApiDotNetCore.MongoDb.Resources;
 using JsonApiDotNetCore.Queries;
 using JsonApiDotNetCore.Queries.Expressions;
 using JsonApiDotNetCore.Queries.Internal.QueryableBuilding;
@@ -52,9 +53,9 @@ public MongoRepository(IMongoDataAccess mongoDataAccess, ITargetedFields targete
         _constraintProviders = constraintProviders;
         _resourceDefinitionAccessor = resourceDefinitionAccessor;
 
-        if (typeof(TId) != typeof(string))
+        if (!typeof(TResource).IsAssignableTo(typeof(IMongoIdentifiable)))
         {
-            throw new InvalidConfigurationException("MongoDB can only be used for resources with an 'Id' property of type 'string'.");
+            throw new InvalidConfigurationException("MongoDB can only be used with resources that implement 'IMongoIdentifiable'.");
         }
     }
 

src/JsonApiDotNetCore.MongoDb/Resources/MongoIdentifiable.cs renamed to src/JsonApiDotNetCore.MongoDb/Resources/HexStringMongoIdentifiable.cs

@@ -1,13 +1,12 @@
-using JsonApiDotNetCore.Resources;
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Attributes;
 
 namespace JsonApiDotNetCore.MongoDb.Resources;
 
 /// <summary>
-/// A convenient basic implementation of <see cref="IIdentifiable" /> for use with MongoDB models.
+/// Basic implementation of a JSON:API resource whose Id is stored as a 12-byte hexadecimal ObjectId in MongoDB.
 /// </summary>
-public abstract class MongoIdentifiable : IIdentifiable<string?>
+public abstract class HexStringMongoIdentifiable : IMongoIdentifiable
 {
     /// <inheritdoc />
     [BsonId]

src/JsonApiDotNetCore.MongoDb/Resources/IMongoIdentifiable.cs

@@ -0,0 +1,10 @@
+using JsonApiDotNetCore.Resources;
+
+namespace JsonApiDotNetCore.MongoDb.Resources;
+
+/// <summary>
+/// Marker interface to indicate a resource that is stored in MongoDB.
+/// </summary>
+public interface IMongoIdentifiable : IIdentifiable<string?>
+{
+}

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/Lyric.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations")]
-public sealed class Lyric : MongoIdentifiable
+public sealed class Lyric : HexStringMongoIdentifiable
 {
     [Attr]
     public string? Format { get; set; }

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/MusicTrack.cs

@@ -8,7 +8,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations")]
-public sealed class MusicTrack : MongoIdentifiable
+public sealed class MusicTrack : HexStringMongoIdentifiable
 {
     [RegularExpression(@"^[a-fA-F\d]{24}$")]
     public override string? Id { get; set; }

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/Performer.cs

@@ -6,7 +6,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations")]
-public sealed class Performer : MongoIdentifiable
+public sealed class Performer : HexStringMongoIdentifiable
 {
     [Attr]
     public string? ArtistName { get; set; }

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/Playlist.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations")]
-public sealed class Playlist : MongoIdentifiable
+public sealed class Playlist : HexStringMongoIdentifiable
 {
     [Attr]
     public string Name { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/RecordCompany.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations")]
-public sealed class RecordCompany : MongoIdentifiable
+public sealed class RecordCompany : HexStringMongoIdentifiable
 {
     [Attr]
     public string Name { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/TextLanguage.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations")]
-public sealed class TextLanguage : MongoIdentifiable
+public sealed class TextLanguage : HexStringMongoIdentifiable
 {
     [Attr]
     public string? IsoCode { get; set; }

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/Meta/SupportTicket.cs

@@ -6,7 +6,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.Meta;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.Meta")]
-public sealed class SupportTicket : MongoIdentifiable
+public sealed class SupportTicket : HexStringMongoIdentifiable
 {
     [Attr]
     public string Description { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/AccountPreferences.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-public sealed class AccountPreferences : MongoIdentifiable
+public sealed class AccountPreferences : HexStringMongoIdentifiable
 {
     [Attr]
     public bool UseDarkTheme { get; set; }

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/Blog.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings")]
-public sealed class Blog : MongoIdentifiable
+public sealed class Blog : HexStringMongoIdentifiable
 {
     [Attr]
     public string Title { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/BlogPost.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings")]
-public sealed class BlogPost : MongoIdentifiable
+public sealed class BlogPost : HexStringMongoIdentifiable
 {
     [Attr]
     public string Caption { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/Comment.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings")]
-public sealed class Comment : MongoIdentifiable
+public sealed class Comment : HexStringMongoIdentifiable
 {
     [Attr]
     public string Text { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/Filtering/FilterableResource.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings.Filtering;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings.Filtering")]
-public sealed class FilterableResource : MongoIdentifiable
+public sealed class FilterableResource : HexStringMongoIdentifiable
 {
     [Attr]
     public string SomeString { get; set; } = string.Empty;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/Label.cs

@@ -6,7 +6,7 @@
 namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-public sealed class Label : MongoIdentifiable
+public sealed class Label : HexStringMongoIdentifiable
 {
     [Attr]
     public string Name { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/LoginAttempt.cs

@@ -5,7 +5,7 @@
 namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-public sealed class LoginAttempt : MongoIdentifiable
+public sealed class LoginAttempt : HexStringMongoIdentifiable
 {
     [Attr]
     public DateTimeOffset TriedAt { get; set; }

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/QueryStrings/WebAccount.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.QueryStrings")]
-public sealed class WebAccount : MongoIdentifiable
+public sealed class WebAccount : HexStringMongoIdentifiable
 {
     [Attr]
     public string UserName { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/Creating/CreateResourceTests.cs

@@ -98,7 +98,7 @@ public async Task Cannot_create_resource_with_int_ID()
         ErrorObject error = responseDocument.Errors[0];
         error.StatusCode.Should().Be(HttpStatusCode.InternalServerError);
         error.Title.Should().Be("An unhandled error occurred while processing this request.");
-        error.Detail.Should().Be("MongoDB can only be used for resources with an 'Id' property of type 'string'.");
+        error.Detail.Should().Be("MongoDB can only be used with resources that implement 'IMongoIdentifiable'.");
     }
 
     [Fact]

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/RgbColor.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.ReadWrite;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.ReadWrite")]
-public sealed class RgbColor : MongoIdentifiable
+public sealed class RgbColor : HexStringMongoIdentifiable
 {
     [Attr]
     public string DisplayName { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/UserAccount.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.ReadWrite;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.ReadWrite")]
-public sealed class UserAccount : MongoIdentifiable
+public sealed class UserAccount : HexStringMongoIdentifiable
 {
     [Attr]
     public string FirstName { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/WorkItem.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.ReadWrite;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.ReadWrite")]
-public sealed class WorkItem : MongoIdentifiable
+public sealed class WorkItem : HexStringMongoIdentifiable
 {
     [Attr]
     public string? Description { get; set; }

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/WorkItemGroup.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.ReadWrite;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.ReadWrite")]
-public sealed class WorkItemGroup : MongoIdentifiable
+public sealed class WorkItemGroup : HexStringMongoIdentifiable
 {
     [Attr]
     public string Name { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ReadWrite/WorkTag.cs

@@ -6,7 +6,7 @@
 namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.ReadWrite;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-public sealed class WorkTag : MongoIdentifiable
+public sealed class WorkTag : HexStringMongoIdentifiable
 {
     [Attr]
     public string Text { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ResourceDefinitions/Reading/Moon.cs

@@ -6,7 +6,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.ResourceDefinitions.Rea
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.ResourceDefinitions.Reading")]
-public sealed class Moon : MongoIdentifiable
+public sealed class Moon : HexStringMongoIdentifiable
 {
     [Attr]
     public string Name { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ResourceDefinitions/Reading/Planet.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.ResourceDefinitions.Rea
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.ResourceDefinitions.Reading")]
-public sealed class Planet : MongoIdentifiable
+public sealed class Planet : HexStringMongoIdentifiable
 {
     [Attr]
     public string PublicName { get; set; } = null!;

test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/ResourceDefinitions/Reading/Star.cs

@@ -6,7 +6,7 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.ResourceDefinitions.Rea
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
 [Resource(ControllerNamespace = "JsonApiDotNetCoreMongoDbTests.IntegrationTests.ResourceDefinitions.Reading")]
-public sealed class Star : MongoIdentifiable
+public sealed class Star : HexStringMongoIdentifiable
 {
     [Attr]
     public string Name { get; set; } = null!;

test/TestBuildingBlocks/MongoDbContextShim.cs

@@ -18,7 +18,7 @@ protected MongoDbContextShim(IMongoDatabase database)
     }
 
     protected MongoDbSetShim<TEntity> Set<TEntity>()
-        where TEntity : MongoIdentifiable
+        where TEntity : IMongoIdentifiable
     {
         IMongoCollection<TEntity> collection = _database.GetCollection<TEntity>(typeof(TEntity).Name);
         var dbSetShim = new MongoDbSetShim<TEntity>(collection);
@@ -28,7 +28,7 @@ protected MongoDbSetShim<TEntity> Set<TEntity>()
     }
 
     public async Task ClearTableAsync<TEntity>()
-        where TEntity : MongoIdentifiable
+        where TEntity : IMongoIdentifiable
     {
         await _database.DropCollectionAsync(typeof(TEntity).Name);
     }

test/TestBuildingBlocks/MongoDbSetShim.cs

@@ -15,7 +15,7 @@ public abstract class MongoDbSetShim
 /// repository.
 /// </summary>
 public sealed class MongoDbSetShim<TEntity> : MongoDbSetShim
-    where TEntity : MongoIdentifiable
+    where TEntity : IMongoIdentifiable
 {
     private readonly IMongoCollection<TEntity> _collection;
     private readonly List<TEntity> _entitiesToInsert = new();
@@ -64,21 +64,19 @@ public async Task ExecuteAsync(Func<IMongoCollection<TEntity>, Task> action)
 
     public async Task<TEntity> FirstWithIdAsync(string? id, CancellationToken cancellationToken = default)
     {
-        MongoIdentifiable? firstOrDefault = await _collection.AsQueryable().FirstOrDefaultAsync(document => Equals(document.Id, id), cancellationToken);
+        TEntity entity = await _collection.AsQueryable().FirstOrDefaultAsync(document => Equals(document.Id, id), cancellationToken);
 
-        if (Equals(firstOrDefault, default(MongoIdentifiable)))
+        if (entity is null)
         {
             throw new InvalidOperationException($"Resource with ID '{id}' was not found.");
         }
 
-        return (TEntity)firstOrDefault;
+        return entity;
     }
 
     public async Task<TEntity?> FirstWithIdOrDefaultAsync(string? id, CancellationToken cancellationToken = default)
     {
-        MongoIdentifiable? entity = await _collection.AsQueryable().FirstOrDefaultAsync(document => Equals(document.Id, id), cancellationToken);
-
-        return (TEntity?)entity;
+        return await _collection.AsQueryable().FirstOrDefaultAsync(document => Equals(document.Id, id), cancellationToken);
     }
 
     public async Task<List<TEntity>> ToListAsync(CancellationToken cancellationToken = default)