Replace int with long for ID (#1879)

* Replace int with long for resource identifiers in benchmarks

* Replace int with long for resource identifiers across models and repositories

* Refactor Identifiable base class to use long instead of int for ID types across various resource models and tests

* Update documentation to use long instead of int for Identifiable types across various resource models

* Refactor PrivateResourceRepository to maintain consistent formatting in constructor parameters

* Update documentation to replace int with long

---------

Co-authored-by: Nitesh Singhal <nitesh.singhal@siemens.com>

Author: niteshsinghal85

benchmarks/Deserialization/DeserializationBenchmarkBase.cs

@@ -21,15 +21,15 @@ public abstract class DeserializationBenchmarkBase : IDisposable
     protected DeserializationBenchmarkBase()
     {
         var options = new JsonApiOptions();
-        IResourceGraph resourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<IncomingResource, int>().Build();
+        IResourceGraph resourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<IncomingResource, long>().Build();
         options.SerializerOptions.Converters.Add(new ResourceObjectConverter(resourceGraph));
         SerializerReadOptions = ((IJsonApiOptions)options).SerializerReadOptions;
 
         var resourceFactory = new ResourceFactory(_serviceProvider);
         var resourceDefinitionAccessor = new ResourceDefinitionAccessor(resourceGraph, _serviceProvider);
 
         _serviceProvider.AddService(typeof(IResourceDefinitionAccessor), resourceDefinitionAccessor);
-        _serviceProvider.AddService(typeof(IResourceDefinition<IncomingResource, int>), new JsonApiResourceDefinition<IncomingResource, int>(resourceGraph));
+        _serviceProvider.AddService(typeof(IResourceDefinition<IncomingResource, long>), new JsonApiResourceDefinition<IncomingResource, long>(resourceGraph));
 
         // ReSharper disable once VirtualMemberCallInConstructor
         JsonApiRequest request = CreateJsonApiRequest(resourceGraph);
@@ -71,7 +71,7 @@ private void Dispose(bool disposing)
     }
 
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class IncomingResource : Identifiable<int>
+    public sealed class IncomingResource : Identifiable<long>
     {
         [Attr]
         public bool Attribute01 { get; set; }

benchmarks/QueryString/QueryStringParserBenchmarks.cs

@@ -27,7 +27,7 @@ public QueryStringParserBenchmarks()
             EnableLegacyFilterNotation = true
         };
 
-        IResourceGraph resourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<QueryableResource, int>("alt-resource-name").Build();
+        IResourceGraph resourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<QueryableResource, long>("alt-resource-name").Build();
 
         var request = new JsonApiRequest
         {

benchmarks/QueryString/QueryableResource.cs

@@ -5,7 +5,7 @@
 namespace Benchmarks.QueryString;
 
 [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-public sealed class QueryableResource : Identifiable<int>
+public sealed class QueryableResource : Identifiable<long>
 {
     [Attr(PublicName = "alt-attr-name")]
     public string? Name { get; set; }

benchmarks/Serialization/SerializationBenchmarkBase.cs

@@ -31,7 +31,7 @@ protected SerializationBenchmarkBase()
             }
         };
 
-        ResourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<OutgoingResource, int>().Build();
+        ResourceGraph = new ResourceGraphBuilder(options, NullLoggerFactory.Instance).Add<OutgoingResource, long>().Build();
         SerializerWriteOptions = ((IJsonApiOptions)options).SerializerWriteOptions;
 
         // ReSharper disable VirtualMemberCallInConstructor
@@ -55,7 +55,7 @@ protected SerializationBenchmarkBase()
     protected abstract IEvaluatedIncludeCache CreateEvaluatedIncludeCache(IResourceGraph resourceGraph);
 
     [UsedImplicitly(ImplicitUseTargetFlags.Members)]
-    public sealed class OutgoingResource : Identifiable<int>
+    public sealed class OutgoingResource : Identifiable<long>
     {
         [Attr]
         public bool Attribute01 { get; set; }

docs/usage/errors.md

@@ -34,9 +34,9 @@ This handler is also the place to choose the log level and message, based on the
 ```c#
 public class ProductOutOfStockException : Exception
 {
-    public int ProductId { get; }
+    public long ProductId { get; }
 
-    public ProductOutOfStockException(int productId)
+    public ProductOutOfStockException(long productId)
     {
         ProductId = productId;
     }

docs/usage/extensibility/controllers.md

@@ -126,10 +126,10 @@ You can even make your own mix of allowed routes by calling the alternate constr
 In some cases, resources may be an aggregation of entities or a view on top of the underlying entities. In these cases, there may not be a writable `IResourceService` implementation, so simply inject the implementation that is available.
 
 ```c#
-public class ReportsController : JsonApiController<Report, int>
+public class ReportsController : JsonApiController<Report, long>
 {
     public ReportsController(IJsonApiOptions options, IResourceGraph resourceGraph,
-        ILoggerFactory loggerFactory, IGetAllService<Report, int> getAllService)
+        ILoggerFactory loggerFactory, IGetAllService<Report, long> getAllService)
         : base(options, resourceGraph, loggerFactory, getAll: getAllService)
     {
     }

docs/usage/extensibility/repositories.md

@@ -5,9 +5,9 @@ If you only need minor changes you can override the methods defined in `EntityFr
 
 ```c#
 // Program.cs
-builder.Services.AddScoped<IResourceRepository<Article, int>, ArticleRepository>();
-builder.Services.AddScoped<IResourceReadRepository<Article, int>, ArticleRepository>();
-builder.Services.AddScoped<IResourceWriteRepository<Article, int>, ArticleRepository>();
+builder.Services.AddScoped<IResourceRepository<Article, long>, ArticleRepository>();
+builder.Services.AddScoped<IResourceReadRepository<Article, long>, ArticleRepository>();
+builder.Services.AddScoped<IResourceWriteRepository<Article, long>, ArticleRepository>();
 ```
 
 In v4.0 we introduced an extension method that you can use to register a resource repository on all of its JsonApiDotNetCore interfaces.
@@ -26,7 +26,7 @@ A sample implementation that performs authorization might look like this.
 All of the methods in EntityFrameworkCoreRepository will use the `GetAll()` method to get the `DbSet<TResource>`, so this is a good method to apply filters such as user or tenant authorization.
 
 ```c#
-public class ArticleRepository : EntityFrameworkCoreRepository<Article, int>
+public class ArticleRepository : EntityFrameworkCoreRepository<Article, long>
 {
     private readonly IAuthenticationService _authenticationService;
 

docs/usage/extensibility/resource-definitions.md

@@ -18,7 +18,7 @@ builder.Services.AddResourceDefinition<ArticleDefinition>();
 > [!NOTE]
 > Prior to the introduction of auto-discovery (in v3), you needed to register the resource definition on the container yourself:
 > ```c#
-> builder.Services.AddScoped<ResourceDefinition<Article, int>, ArticleDefinition>();
+> builder.Services.AddScoped<ResourceDefinition<Article, long>, ArticleDefinition>();
 > ```
 
 ## Customizing queries
@@ -41,7 +41,7 @@ For example, you may accept some sensitive data that should only be exposed to a
 > To exclude fields unconditionally, [attribute capabilities](~/usage/resources/attributes.md#capabilities) and [relationship capabilities](~/usage/resources/relationships.md#capabilities) can be used instead.
 
 ```c#
-public class UserDefinition : JsonApiResourceDefinition<User, int>
+public class UserDefinition : JsonApiResourceDefinition<User, long>
 {
     public UserDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -100,7 +100,7 @@ Content-Type: application/vnd.api+json
 You can define the default sort order if no `sort` query string parameter is provided.
 
 ```c#
-public class AccountDefinition : JsonApiResourceDefinition<Account, int>
+public class AccountDefinition : JsonApiResourceDefinition<Account, long>
 {
     public AccountDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -128,7 +128,7 @@ public class AccountDefinition : JsonApiResourceDefinition<Account, int>
 You may want to enforce pagination on large database tables.
 
 ```c#
-public class AccessLogDefinition : JsonApiResourceDefinition<AccessLog, int>
+public class AccessLogDefinition : JsonApiResourceDefinition<AccessLog, long>
 {
     public AccessLogDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -159,7 +159,7 @@ public class AccessLogDefinition : JsonApiResourceDefinition<AccessLog, int>
 The next example filters out `Account` resources that are suspended.
 
 ```c#
-public class AccountDefinition : JsonApiResourceDefinition<Account, int>
+public class AccountDefinition : JsonApiResourceDefinition<Account, long>
 {
     public AccountDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -188,7 +188,7 @@ public class AccountDefinition : JsonApiResourceDefinition<Account, int>
 In the example below, an error is returned when a user tries to include the manager of an employee.
 
 ```c#
-public class EmployeeDefinition : JsonApiResourceDefinition<Employee, int>
+public class EmployeeDefinition : JsonApiResourceDefinition<Employee, long>
 {
     public EmployeeDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)
@@ -224,7 +224,7 @@ If the key is present in a query string, the supplied LINQ expression will be ad
 But it only works on primary resource endpoints (for example: /articles, but not on /blogs/1/articles or /blogs?include=articles).
 
 ```c#
-public class ItemDefinition : JsonApiResourceDefinition<Item, int>
+public class ItemDefinition : JsonApiResourceDefinition<Item, long>
 {
     public ItemDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)

docs/usage/extensibility/services.md

@@ -12,7 +12,7 @@ In simple cases, you can also just wrap the base implementation with your custom
 A simple example would be to send notifications when a resource gets created.
 
 ```c#
-public class TodoItemService : JsonApiResourceService<TodoItem, int>
+public class TodoItemService : JsonApiResourceService<TodoItem, long>
 {
     private readonly INotificationService _notificationService;
 
@@ -51,14 +51,14 @@ If you'd like to use another ORM that does not provide what JsonApiResourceServi
 // Program.cs
 
 // Add the service override for Product.
-builder.Services.AddScoped<IResourceService<Product, int>, ProductService>();
+builder.Services.AddScoped<IResourceService<Product, long>, ProductService>();
 
 // Add your own Data Access Object.
 builder.Services.AddScoped<IProductDao, ProductDao>();
 
 // ProductService.cs
 
-public class ProductService : IResourceService<Product, int>
+public class ProductService : IResourceService<Product, long>
 {
     private readonly IProductDao _dao;
 
@@ -114,14 +114,14 @@ IResourceCommandService <|-- IRemoveFromRelationshipService
 In order to take advantage of these interfaces you first need to register the service for each implemented interface.
 
 ```c#
-public class ArticleService : ICreateService<Article, int>, IDeleteService<Article, int>
+public class ArticleService : ICreateService<Article, long>, IDeleteService<Article, long>
 {
     // ...
 }
 
 // Program.cs
-builder.Services.AddScoped<ICreateService<Article, int>, ArticleService>();
-builder.Services.AddScoped<IDeleteService<Article, int>, ArticleService>();
+builder.Services.AddScoped<ICreateService<Article, long>, ArticleService>();
+builder.Services.AddScoped<IDeleteService<Article, long>, ArticleService>();
 ```
 
 In v3.0 we introduced an extension method that you can use to register a resource service on all of its JsonApiDotNetCore interfaces.
@@ -140,7 +140,7 @@ Then on your model, pass in the set of endpoints to expose (the ones that you've
 ```c#
 [Resource(GenerateControllerEndpoints =
     JsonApiEndpoints.Create | JsonApiEndpoints.Delete)]
-public class Article : Identifiable<int>
+public class Article : identifiable<long>
 {
     // ...
 }
@@ -149,11 +149,11 @@ public class Article : Identifiable<int>
 Alternatively, when using a hand-written controller, you should inherit from the JSON:API controller and pass the services into the named, optional base parameters:
 
 ```c#
-public class ArticlesController : JsonApiController<Article, int>
+public class ArticlesController : JsonApiController<Article, long>
 {
     public ArticlesController(IJsonApiOptions options, IResourceGraph resourceGraph,
-        ILoggerFactory loggerFactory, ICreateService<Article, int> create,
-        IDeleteService<Article, int> delete)
+        ILoggerFactory loggerFactory, ICreateService<Article, long> create,
+        IDeleteService<Article, long> delete)
         : base(options, resourceGraph, loggerFactory, create: create, delete: delete)
     {
     }

docs/usage/meta.md

@@ -47,7 +47,7 @@ Resource-specific metadata can be added by implementing `IResourceDefinition<TRe
 ```c#
 #nullable enable
 
-public class PersonDefinition : JsonApiResourceDefinition<Person, int>
+public class PersonDefinition : JsonApiResourceDefinition<Person, long>
 {
     public PersonDefinition(IResourceGraph resourceGraph)
         : base(resourceGraph)