aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Data.Caching/src/ClientExtensions.cs
diff options
context:
space:
mode:
authorLibravatar vnugent <public@vaughnnugent.com>2024-03-24 21:26:44 -0400
committerLibravatar vnugent <public@vaughnnugent.com>2024-03-24 21:26:44 -0400
commit49c3641def5ae1b7557ed61ed7bb28bbf425ccc9 (patch)
tree4eb1bd863074e64922e35ff730f354ac40528698 /lib/VNLib.Data.Caching/src/ClientExtensions.cs
parente5bb0ee302e789cb96e7ecfe839cbbcc8e3fd5d7 (diff)
Squashed commit of the following:
commit a504435151efbe1d19404fa44859b15c629f6d5d Author: vnugent <public@vaughnnugent.com> Date: Sun Mar 24 20:55:01 2024 -0400 chore: Updated compose and added some more logging commit c74440ff12daa03cc4b7792d0c3baad46a11a465 Author: vnugent <public@vaughnnugent.com> Date: Mon Mar 18 21:57:57 2024 -0400 feat: message checksum support & dynamic serializers commit 9983582db08d3e6c456295ea96e482cbb4f31f42 Author: vnugent <public@vaughnnugent.com> Date: Sun Mar 10 21:58:28 2024 -0400 source tree project location updated commit 60f09bde87b5c59ef937c62ef64b7745bc3711b5 Merge: 2f75659 e5bb0ee Author: vnugent <public@vaughnnugent.com> Date: Sun Mar 10 16:50:09 2024 -0400 Merge remote-tracking branch 'origin/master' into develop commit 2f7565976472f0f056db60520bf253a776112c10 Merge: 323ff67 6b87785 Author: vnugent <public@vaughnnugent.com> Date: Sun Mar 10 16:45:23 2024 -0400 merge master commit 323ff67badfc46ad638d75f059d60d9425ccb2fa Author: vnugent <public@vaughnnugent.com> Date: Sun Mar 10 15:50:07 2024 -0400 ci(server): Conainerize and add vncache server packages commit 5d4192880654fd6e00e587814169415b42621327 Author: vnugent <public@vaughnnugent.com> Date: Sat Mar 9 19:13:21 2024 -0500 chore: #2 Minor fixes and polish before release commit a4b3504bb891829074d1efde0433eae010862181 Author: vnugent <public@vaughnnugent.com> Date: Sat Mar 9 16:30:44 2024 -0500 package updates commit 4d8cfc10382105b0acbd94df93ad3d05ff91db54 Author: vnugent <public@vaughnnugent.com> Date: Wed Mar 6 21:30:58 2024 -0500 refactor: #2 Centralize server state, default discovery endpoints & more commit 016a96a80cce025a86c6cf26707738f6a2eb2658 Author: vnugent <public@vaughnnugent.com> Date: Thu Feb 29 21:22:38 2024 -0500 feat: add future support for memory diagnostics, and some docs commit 456ead9bc8b0f61357bae93152ad0403c4940101 Author: vnugent <public@vaughnnugent.com> Date: Tue Feb 13 14:46:35 2024 -0500 fix: #1 shared cluster index on linux & latested core updates commit a481d63f964a5d5204cac2e95141f37f9a28d573 Author: vnugent <public@vaughnnugent.com> Date: Tue Jan 23 15:43:50 2024 -0500 cache extension api tweaks
Diffstat (limited to 'lib/VNLib.Data.Caching/src/ClientExtensions.cs')
-rw-r--r--lib/VNLib.Data.Caching/src/ClientExtensions.cs63
1 files changed, 57 insertions, 6 deletions
diff --git a/lib/VNLib.Data.Caching/src/ClientExtensions.cs b/lib/VNLib.Data.Caching/src/ClientExtensions.cs
index e0aa744..bfc8ddc 100644
--- a/lib/VNLib.Data.Caching/src/ClientExtensions.cs
+++ b/lib/VNLib.Data.Caching/src/ClientExtensions.cs
@@ -37,7 +37,7 @@ using VNLib.Data.Caching.Exceptions;
using static VNLib.Data.Caching.Constants;
namespace VNLib.Data.Caching
-{
+{
/// <summary>
/// Provides caching extension methods for <see cref="FBMClient"/>
@@ -212,11 +212,11 @@ namespace VNLib.Data.Caching
return ExecAsync(client, request, objectId, cancellationToken);
}
- catch
+ catch(Exception e)
{
//Return the request(clears data and reset)
client.ReturnRequest(request);
- throw;
+ return Task.FromException(e);
}
static async Task ExecAsync(FBMClient client, FBMRequest request, string objectId, CancellationToken cancellationToken)
@@ -239,6 +239,10 @@ namespace VNLib.Data.Caching
{
throw new ObjectNotFoundException($"object {objectId} not found on remote server");
}
+ else if(status.ValueEquals(ResponseCodes.InvalidChecksum, StringComparison.OrdinalIgnoreCase))
+ {
+ throw new InvalidChecksumException($"The server rejected the message {objectId} due to an invalid checksum");
+ }
//Invalid status
throw new InvalidStatusException("Invalid status code recived for object upsert request", status.ToString());
@@ -256,6 +260,7 @@ namespace VNLib.Data.Caching
/// Gets an object from the server if it exists
/// </summary>
/// <typeparam name="T"></typeparam>
+ /// <typeparam name="TState"></typeparam>
/// <param name="client"></param>
/// <param name="objectId">The id of the object to get</param>
/// <param name="cancellationToken">A token to cancel the operation</param>
@@ -368,18 +373,35 @@ namespace VNLib.Data.Caching
response.ThrowIfNotSet();
//Get the status code
- FBMMessageHeader status = response.Headers.FirstOrDefault(static a => a.Header == HeaderCommand.Status);
+ FBMMessageHeader status = response.Headers.FirstOrDefault(static a => a.Header == HeaderCommand.Status);
//Check ok status code, then its safe to deserialize
- if (status.Value.Equals(ResponseCodes.Okay, StringComparison.Ordinal))
+ if (status.ValueEquals(ResponseCodes.Okay, StringComparison.Ordinal))
{
+ //Add message integrity check
+ FBMMessageHeader checksumType = response.Headers.FirstOrDefault(static a => a.Header == ChecksumType);
+ FBMMessageHeader checksum = response.Headers.FirstOrDefault(static a => a.Header == ChecksumValue);
+
+ if(checksumType.ValueEquals(ChecksumTypes.Fnv1a, StringComparison.OrdinalIgnoreCase))
+ {
+ //Verify the checksum
+ if (!FbmMessageChecksum.VerifyFnv1aChecksum(checksum.Value, response.ResponseBody))
+ {
+ throw new InvalidChecksumException(
+ $"The response data integrety check failed. The message data was corrupted for id: {checksum.GetValueString()}"
+ );
+ }
+
+ //Valid checksum, continue
+ }
+
//Write the object data
setter(state, response.ResponseBody);
return true;
}
//Object may not exist on the server yet
- if (status.Value.Equals(ResponseCodes.NotFound, StringComparison.Ordinal))
+ if (status.ValueEquals(ResponseCodes.NotFound, StringComparison.Ordinal))
{
return false;
}
@@ -540,5 +562,34 @@ namespace VNLib.Data.Caching
return new (worker, retryDelay, serverUri);
}
+ /// <summary>
+ /// Determines if the the client sent a message checksum, and if so, verifies the checksum
+ /// if the checksum type is supported.
+ /// </summary>
+ /// <param name="message"></param>
+ /// <returns>
+ /// -1 if the checksum type or value is not set,
+ /// -2 if the checksum type is not supported,
+ /// 0 if the checksum is invalid,
+ /// 1 if the checksum is valid
+ /// </returns>
+ public static int IsClientChecksumValid(this FBMRequestMessage message)
+ {
+ string? type = message.Headers.FirstOrDefault(static h => h.Header == ChecksumType).GetValueString();
+ ReadOnlySpan<char> value = message.Headers.FirstOrDefault(static h => h.Header == ChecksumValue).Value;
+
+ if (type == null || value.IsEmpty)
+ {
+ return -1;
+ }
+
+ if(type.Equals(ChecksumTypes.Fnv1a, StringComparison.OrdinalIgnoreCase))
+ {
+ //Verify the checksum
+ return FbmMessageChecksum.VerifyFnv1aChecksum(value, message.BodyData) ? 1 : 0;
+ }
+
+ return -2;
+ }
}
}