Switch from int to long, use invariant culture, use singleton codec

bkoelman · bkoelman · commit 325a39cdf669 · 2025-08-23T16:01:33.000+02:00
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/BankAccountsController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/BankAccountsController.cs
@@ -5,5 +5,5 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.IdObfuscation;
 
 public sealed class BankAccountsController(
-    IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IResourceService<BankAccount, int> resourceService)
+    IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IResourceService<BankAccount, long> resourceService)
     : ObfuscatedIdentifiableController<BankAccount>(options, resourceGraph, loggerFactory, resourceService);
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/DebitCardsController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/DebitCardsController.cs
@@ -5,5 +5,5 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.IdObfuscation;
 
 public sealed class DebitCardsController(
-    IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IResourceService<DebitCard, int> resourceService)
+    IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IResourceService<DebitCard, long> resourceService)
     : ObfuscatedIdentifiableController<DebitCard>(options, resourceGraph, loggerFactory, resourceService);
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/HexadecimalCodec.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/HexadecimalCodec.cs
@@ -10,8 +10,13 @@ internal sealed class HexadecimalCodec
 {
     // This implementation is deliberately simple for demonstration purposes.
     // Consider using something more robust, such as https://github.com/sqids/sqids-dotnet.
+    public static HexadecimalCodec Instance { get; } = new();
 
-    public int Decode(string? value)
+    private HexadecimalCodec()
+    {
+    }
+
+    public long Decode(string? value)
     {
         if (value == null)
         {
@@ -28,7 +33,7 @@ public int Decode(string? value)
         }
 
         string stringValue = FromHexString(value[1..]);
-        return int.Parse(stringValue);
+        return long.Parse(stringValue, CultureInfo.InvariantCulture);
     }
 
     private static string FromHexString(string hexString)
@@ -38,22 +43,22 @@ private static string FromHexString(string hexString)
         for (int index = 0; index < hexString.Length; index += 2)
         {
             string hexChar = hexString.Substring(index, 2);
-            byte bt = byte.Parse(hexChar, NumberStyles.HexNumber);
+            byte bt = byte.Parse(hexChar, NumberStyles.HexNumber, CultureInfo.InvariantCulture);
             bytes.Add(bt);
         }
 
         char[] chars = Encoding.ASCII.GetChars([.. bytes]);
         return new string(chars);
     }
 
-    public string? Encode(int value)
+    public string? Encode(long value)
     {
         if (value == 0)
         {
             return null;
         }
 
-        string stringValue = value.ToString();
+        string stringValue = value.ToString(CultureInfo.InvariantCulture);
         return $"x{ToHexString(stringValue)}";
     }
 
@@ -63,7 +68,7 @@ private static string ToHexString(string value)
 
         foreach (byte bt in Encoding.ASCII.GetBytes(value))
         {
-            builder.Append(bt.ToString("X2"));
+            builder.Append(bt.ToString("X2", CultureInfo.InvariantCulture));
         }
 
         return builder.ToString();
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/IdObfuscationTests.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/IdObfuscationTests.cs
@@ -13,7 +13,6 @@ public sealed class IdObfuscationTests : IClassFixture<IntegrationTestContext<Te
 {
     private readonly IntegrationTestContext<TestableStartup<ObfuscationDbContext>, ObfuscationDbContext> _testContext;
     private readonly ObfuscationFakers _fakers = new();
-    private readonly HexadecimalCodec _codec = new();
 
     public IdObfuscationTests(IntegrationTestContext<TestableStartup<ObfuscationDbContext>, ObfuscationDbContext> testContext)
     {
@@ -34,7 +33,7 @@ public void Encodes_resource_ID()
         account.Id = 123;
 
         // Act
-        string? stringId = _codec.Encode(account.Id);
+        string? stringId = HexadecimalCodec.Instance.Encode(account.Id);
 
         // Assert
         stringId.Should().Be(account.StringId);
@@ -48,7 +47,7 @@ public void Decodes_resource_ID()
         account.Id = 123;
 
         // Act
-        int id = _codec.Decode(account.StringId);
+        long id = HexadecimalCodec.Instance.Decode(account.StringId);
 
         // Assert
         id.Should().Be(account.Id);
@@ -123,7 +122,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             await dbContext.SaveChangesAsync();
         });
 
-        string route = $"/bankAccounts?filter=any(id,'{accounts[1].StringId}','{_codec.Encode(Unknown.TypedId.Int32)}')";
+        string route = $"/bankAccounts?filter=any(id,'{accounts[1].StringId}','{HexadecimalCodec.Instance.Encode(Unknown.TypedId.Int64)}')";
 
         // Act
         (HttpResponseMessage httpResponse, Document responseDocument) = await _testContext.ExecuteGetAsync<Document>(route);
@@ -362,7 +361,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
             value.Links.Related.Should().Be($"/debitCards/{newCardStringId}/account");
         });
 
-        int newCardId = _codec.Decode(responseDocument.Data.SingleValue.Id);
+        long newCardId = HexadecimalCodec.Instance.Decode(responseDocument.Data.SingleValue.Id);
 
         await _testContext.RunOnDatabaseAsync(async dbContext =>
         {
@@ -568,7 +567,7 @@ await _testContext.RunOnDatabaseAsync(async dbContext =>
     public async Task Cannot_delete_unknown_resource()
     {
         // Arrange
-        string? stringId = _codec.Encode(Unknown.TypedId.Int32);
+        string stringId = HexadecimalCodec.Instance.Encode(Unknown.TypedId.Int64)!;
 
         string route = $"/bankAccounts/{stringId}";
 
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/ObfuscatedIdentifiable.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/ObfuscatedIdentifiable.cs
@@ -2,17 +2,15 @@
 
 namespace JsonApiDotNetCoreTests.IntegrationTests.IdObfuscation;
 
-public abstract class ObfuscatedIdentifiable : Identifiable<int>
+public abstract class ObfuscatedIdentifiable : Identifiable<long>
 {
-    private static readonly HexadecimalCodec Codec = new();
-
-    protected override string? GetStringId(int value)
+    protected override string? GetStringId(long value)
     {
-        return value == 0 ? null : Codec.Encode(value);
+        return value == 0 ? null : HexadecimalCodec.Instance.Encode(value);
     }
 
-    protected override int GetTypedId(string? value)
+    protected override long GetTypedId(string? value)
     {
-        return value == null ? 0 : Codec.Decode(value);
+        return value == null ? 0 : HexadecimalCodec.Instance.Decode(value);
     }
 }
diff --git a/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/ObfuscatedIdentifiableController.cs b/test/JsonApiDotNetCoreTests/IntegrationTests/IdObfuscation/ObfuscatedIdentifiableController.cs
@@ -11,12 +11,10 @@
 namespace JsonApiDotNetCoreTests.IntegrationTests.IdObfuscation;
 
 public abstract class ObfuscatedIdentifiableController<TResource>(
-    IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IResourceService<TResource, int> resourceService)
-    : BaseJsonApiController<TResource, int>(options, resourceGraph, loggerFactory, resourceService)
-    where TResource : class, IIdentifiable<int>
+    IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IResourceService<TResource, long> resourceService)
+    : BaseJsonApiController<TResource, long>(options, resourceGraph, loggerFactory, resourceService)
+    where TResource : class, IIdentifiable<long>
 {
-    private readonly HexadecimalCodec _codec = new();
-
     [HttpGet]
     [HttpHead]
     public override Task<IActionResult> GetAsync(CancellationToken cancellationToken)
@@ -28,7 +26,7 @@ public override Task<IActionResult> GetAsync(CancellationToken cancellationToken
     [HttpHead("{id}")]
     public Task<IActionResult> GetAsync([Required] string id, CancellationToken cancellationToken)
     {
-        int idValue = _codec.Decode(id);
+        long idValue = HexadecimalCodec.Instance.Decode(id);
         return base.GetAsync(idValue, cancellationToken);
     }
 
@@ -37,7 +35,7 @@ public Task<IActionResult> GetAsync([Required] string id, CancellationToken canc
     public Task<IActionResult> GetSecondaryAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,
         CancellationToken cancellationToken)
     {
-        int idValue = _codec.Decode(id);
+        long idValue = HexadecimalCodec.Instance.Decode(id);
         return base.GetSecondaryAsync(idValue, relationshipName, cancellationToken);
     }
 
@@ -46,7 +44,7 @@ public Task<IActionResult> GetSecondaryAsync([Required] string id, [Required] [P
     public Task<IActionResult> GetRelationshipAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,
         CancellationToken cancellationToken)
     {
-        int idValue = _codec.Decode(id);
+        long idValue = HexadecimalCodec.Instance.Decode(id);
         return base.GetRelationshipAsync(idValue, relationshipName, cancellationToken);
     }
 
@@ -60,14 +58,14 @@ public override Task<IActionResult> PostAsync([FromBody] [Required] TResource re
     public Task<IActionResult> PostRelationshipAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,
         [FromBody] [Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)
     {
-        int idValue = _codec.Decode(id);
+        long idValue = HexadecimalCodec.Instance.Decode(id);
         return base.PostRelationshipAsync(idValue, relationshipName, rightResourceIds, cancellationToken);
     }
 
     [HttpPatch("{id}")]
     public Task<IActionResult> PatchAsync([Required] string id, [FromBody] [Required] TResource resource, CancellationToken cancellationToken)
     {
-        int idValue = _codec.Decode(id);
+        long idValue = HexadecimalCodec.Instance.Decode(id);
         return base.PatchAsync(idValue, resource, cancellationToken);
     }
 
@@ -76,22 +74,22 @@ public Task<IActionResult> PatchAsync([Required] string id, [FromBody] [Required
     public Task<IActionResult> PatchRelationshipAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,
         [FromBody] [Required] object? rightValue, CancellationToken cancellationToken)
     {
-        int idValue = _codec.Decode(id);
+        long idValue = HexadecimalCodec.Instance.Decode(id);
         return base.PatchRelationshipAsync(idValue, relationshipName, rightValue, cancellationToken);
     }
 
     [HttpDelete("{id}")]
     public Task<IActionResult> DeleteAsync([Required] string id, CancellationToken cancellationToken)
     {
-        int idValue = _codec.Decode(id);
+        long idValue = HexadecimalCodec.Instance.Decode(id);
         return base.DeleteAsync(idValue, cancellationToken);
     }
 
     [HttpDelete("{id}/relationships/{relationshipName}")]
     public Task<IActionResult> DeleteRelationshipAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,
         [FromBody] [Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)
     {
-        int idValue = _codec.Decode(id);
+        long idValue = HexadecimalCodec.Instance.Decode(id);
         return base.DeleteRelationshipAsync(idValue, relationshipName, rightResourceIds, cancellationToken);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,13 @@ internal sealed class HexadecimalCodec`
`10`	`10`	`{`
`11`	`11`	`// This implementation is deliberately simple for demonstration purposes.`
`12`	`12`	`// Consider using something more robust, such as https://github.com/sqids/sqids-dotnet.`
	`13`	`+ public static HexadecimalCodec Instance { get; } = new();`
`13`	`14`
`14`		`- public int Decode(string? value)`
	`15`	`+ private HexadecimalCodec()`
	`16`	`+ {`
	`17`	`+ }`
	`18`	`+`
	`19`	`+ public long Decode(string? value)`
`15`	`20`	`{`
`16`	`21`	`if (value == null)`
`17`	`22`	`{`
`@@ -28,7 +33,7 @@ public int Decode(string? value)`
`28`	`33`	`}`
`29`	`34`
`30`	`35`	`string stringValue = FromHexString(value[1..]);`
`31`		`- return int.Parse(stringValue);`
	`36`	`+ return long.Parse(stringValue, CultureInfo.InvariantCulture);`
`32`	`37`	`}`
`33`	`38`
`34`	`39`	`private static string FromHexString(string hexString)`
`@@ -38,22 +43,22 @@ private static string FromHexString(string hexString)`
`38`	`43`	`for (int index = 0; index < hexString.Length; index += 2)`
`39`	`44`	`{`
`40`	`45`	`string hexChar = hexString.Substring(index, 2);`
`41`		`- byte bt = byte.Parse(hexChar, NumberStyles.HexNumber);`
	`46`	`+ byte bt = byte.Parse(hexChar, NumberStyles.HexNumber, CultureInfo.InvariantCulture);`
`42`	`47`	`bytes.Add(bt);`
`43`	`48`	`}`
`44`	`49`
`45`	`50`	`char[] chars = Encoding.ASCII.GetChars([.. bytes]);`
`46`	`51`	`return new string(chars);`
`47`	`52`	`}`
`48`	`53`
`49`		`- public string? Encode(int value)`
	`54`	`+ public string? Encode(long value)`
`50`	`55`	`{`
`51`	`56`	`if (value == 0)`
`52`	`57`	`{`
`53`	`58`	`return null;`
`54`	`59`	`}`
`55`	`60`
`56`		`- string stringValue = value.ToString();`
	`61`	`+ string stringValue = value.ToString(CultureInfo.InvariantCulture);`
`57`	`62`	`return $"x{ToHexString(stringValue)}";`
`58`	`63`	`}`
`59`	`64`
`@@ -63,7 +68,7 @@ private static string ToHexString(string value)`
`63`	`68`
`64`	`69`	`foreach (byte bt in Encoding.ASCII.GetBytes(value))`
`65`	`70`	`{`
`66`		`- builder.Append(bt.ToString("X2"));`
	`71`	`+ builder.Append(bt.ToString("X2", CultureInfo.InvariantCulture));`
`67`	`72`	`}`
`68`	`73`
`69`	`74`	`return builder.ToString();`
Original file line number	Diff line number	Diff line change
`@@ -2,17 +2,15 @@`
`2`	`2`
`3`	`3`	`namespace JsonApiDotNetCoreTests.IntegrationTests.IdObfuscation;`
`4`	`4`
`5`		`-public abstract class ObfuscatedIdentifiable : Identifiable<int>`
	`5`	`+public abstract class ObfuscatedIdentifiable : Identifiable<long>`
`6`	`6`	`{`
`7`		`- private static readonly HexadecimalCodec Codec = new();`
`8`		`-`
`9`		`- protected override string? GetStringId(int value)`
	`7`	`+ protected override string? GetStringId(long value)`
`10`	`8`	`{`
`11`		`- return value == 0 ? null : Codec.Encode(value);`
	`9`	`+ return value == 0 ? null : HexadecimalCodec.Instance.Encode(value);`
`12`	`10`	`}`
`13`	`11`
`14`		`- protected override int GetTypedId(string? value)`
	`12`	`+ protected override long GetTypedId(string? value)`
`15`	`13`	`{`
`16`		`- return value == null ? 0 : Codec.Decode(value);`
	`14`	`+ return value == null ? 0 : HexadecimalCodec.Instance.Decode(value);`
`17`	`15`	`}`
`18`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,12 +11,10 @@`
`11`	`11`	`namespace JsonApiDotNetCoreTests.IntegrationTests.IdObfuscation;`
`12`	`12`
`13`	`13`	`public abstract class ObfuscatedIdentifiableController<TResource>(`
`14`		`- IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IResourceService<TResource, int> resourceService)`
`15`		`- : BaseJsonApiController<TResource, int>(options, resourceGraph, loggerFactory, resourceService)`
`16`		`- where TResource : class, IIdentifiable<int>`
	`14`	`+ IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IResourceService<TResource, long> resourceService)`
	`15`	`+ : BaseJsonApiController<TResource, long>(options, resourceGraph, loggerFactory, resourceService)`
	`16`	`+ where TResource : class, IIdentifiable<long>`
`17`	`17`	`{`
`18`		`- private readonly HexadecimalCodec _codec = new();`
`19`		`-`
`20`	`18`	`[HttpGet]`
`21`	`19`	`[HttpHead]`
`22`	`20`	`public override Task<IActionResult> GetAsync(CancellationToken cancellationToken)`
`@@ -28,7 +26,7 @@ public override Task<IActionResult> GetAsync(CancellationToken cancellationToken`
`28`	`26`	`[HttpHead("{id}")]`
`29`	`27`	`public Task<IActionResult> GetAsync([Required] string id, CancellationToken cancellationToken)`
`30`	`28`	`{`
`31`		`- int idValue = _codec.Decode(id);`
	`29`	`+ long idValue = HexadecimalCodec.Instance.Decode(id);`
`32`	`30`	`return base.GetAsync(idValue, cancellationToken);`
`33`	`31`	`}`
`34`	`32`
`@@ -37,7 +35,7 @@ public Task<IActionResult> GetAsync([Required] string id, CancellationToken canc`
`37`	`35`	`public Task<IActionResult> GetSecondaryAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,`
`38`	`36`	`CancellationToken cancellationToken)`
`39`	`37`	`{`
`40`		`- int idValue = _codec.Decode(id);`
	`38`	`+ long idValue = HexadecimalCodec.Instance.Decode(id);`
`41`	`39`	`return base.GetSecondaryAsync(idValue, relationshipName, cancellationToken);`
`42`	`40`	`}`
`43`	`41`
`@@ -46,7 +44,7 @@ public Task<IActionResult> GetSecondaryAsync([Required] string id, [Required] [P`
`46`	`44`	`public Task<IActionResult> GetRelationshipAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,`
`47`	`45`	`CancellationToken cancellationToken)`
`48`	`46`	`{`
`49`		`- int idValue = _codec.Decode(id);`
	`47`	`+ long idValue = HexadecimalCodec.Instance.Decode(id);`
`50`	`48`	`return base.GetRelationshipAsync(idValue, relationshipName, cancellationToken);`
`51`	`49`	`}`
`52`	`50`
`@@ -60,14 +58,14 @@ public override Task<IActionResult> PostAsync([FromBody] [Required] TResource re`
`60`	`58`	`public Task<IActionResult> PostRelationshipAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,`
`61`	`59`	`[FromBody] [Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)`
`62`	`60`	`{`
`63`		`- int idValue = _codec.Decode(id);`
	`61`	`+ long idValue = HexadecimalCodec.Instance.Decode(id);`
`64`	`62`	`return base.PostRelationshipAsync(idValue, relationshipName, rightResourceIds, cancellationToken);`
`65`	`63`	`}`
`66`	`64`
`67`	`65`	`[HttpPatch("{id}")]`
`68`	`66`	`public Task<IActionResult> PatchAsync([Required] string id, [FromBody] [Required] TResource resource, CancellationToken cancellationToken)`
`69`	`67`	`{`
`70`		`- int idValue = _codec.Decode(id);`
	`68`	`+ long idValue = HexadecimalCodec.Instance.Decode(id);`
`71`	`69`	`return base.PatchAsync(idValue, resource, cancellationToken);`
`72`	`70`	`}`
`73`	`71`
`@@ -76,22 +74,22 @@ public Task<IActionResult> PatchAsync([Required] string id, [FromBody] [Required`
`76`	`74`	`public Task<IActionResult> PatchRelationshipAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,`
`77`	`75`	`[FromBody] [Required] object? rightValue, CancellationToken cancellationToken)`
`78`	`76`	`{`
`79`		`- int idValue = _codec.Decode(id);`
	`77`	`+ long idValue = HexadecimalCodec.Instance.Decode(id);`
`80`	`78`	`return base.PatchRelationshipAsync(idValue, relationshipName, rightValue, cancellationToken);`
`81`	`79`	`}`
`82`	`80`
`83`	`81`	`[HttpDelete("{id}")]`
`84`	`82`	`public Task<IActionResult> DeleteAsync([Required] string id, CancellationToken cancellationToken)`
`85`	`83`	`{`
`86`		`- int idValue = _codec.Decode(id);`
	`84`	`+ long idValue = HexadecimalCodec.Instance.Decode(id);`
`87`	`85`	`return base.DeleteAsync(idValue, cancellationToken);`
`88`	`86`	`}`
`89`	`87`
`90`	`88`	`[HttpDelete("{id}/relationships/{relationshipName}")]`
`91`	`89`	`public Task<IActionResult> DeleteRelationshipAsync([Required] string id, [Required] [PreserveEmptyString] string relationshipName,`
`92`	`90`	`[FromBody] [Required] ISet<IIdentifiable> rightResourceIds, CancellationToken cancellationToken)`
`93`	`91`	`{`
`94`		`- int idValue = _codec.Decode(id);`
	`92`	`+ long idValue = HexadecimalCodec.Instance.Decode(id);`
`95`	`93`	`return base.DeleteRelationshipAsync(idValue, relationshipName, rightResourceIds, cancellationToken);`
`96`	`94`	`}`
`97`	`95`	`}`