Skip to content

Commit e735bbf

Browse files
GarrettBeattyGarrettBeatty
authored
Refactor serialization logic and remove JsonSerializer.Deserialize use for entire envelope (#192)
1 parent 6d1fe2f commit e735bbf

15 files changed

+1682
-208
lines changed

‎src/AWS.Messaging/EventBridgeMetadata.cs

-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
22
// SPDX-License-Identifier: Apache-2.0
33

4-
using System;
5-
using System.Collections.Generic;
6-
using System.Linq;
7-
using System.Text;
8-
using System.Threading.Tasks;
94

105
namespace AWS.Messaging
116
{

‎src/AWS.Messaging/Serialization/EnvelopeSerializer.cs

+174-169
Large diffs are not rendered by default.

‎src/AWS.Messaging/Serialization/Handlers/MessageMetadataHandler.cs

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
using System.Text.Json;
5+
using Amazon.SQS.Model;
6+
using AWS.Messaging.Internal;
7+
using AWS.Messaging.Serialization.Helpers;
8+
using MessageAttributeValue = Amazon.SimpleNotificationService.Model.MessageAttributeValue;
9+
10+
namespace AWS.Messaging.Serialization.Handlers;
11+
12+
/// <summary>
13+
/// Handles the creation of metadata objects from various AWS messaging services.
14+
/// </summary>
15+
internal static class MessageMetadataHandler
16+
{
17+
/// <summary>
18+
/// Creates SQS metadata from an SQS message.
19+
/// </summary>
20+
/// <param name="message">The SQS message containing metadata information.</param>
21+
/// <returns>An SQSMetadata object containing the extracted metadata.</returns>
22+
public static SQSMetadata CreateSQSMetadata(Message message)
23+
{
24+
var metadata = new SQSMetadata
25+
{
26+
MessageID = message.MessageId,
27+
ReceiptHandle = message.ReceiptHandle,
28+
MessageAttributes = message.MessageAttributes,
29+
};
30+
31+
if (message.Attributes != null)
32+
{
33+
metadata.MessageGroupId = JsonPropertyHelper.GetAttributeValue(message.Attributes, "MessageGroupId");
34+
metadata.MessageDeduplicationId = JsonPropertyHelper.GetAttributeValue(message.Attributes, "MessageDeduplicationId");
35+
}
36+
37+
return metadata;
38+
}
39+
40+
/// <summary>
41+
/// Creates SNS metadata from a JSON element representing an SNS message.
42+
/// </summary>
43+
/// <param name="root">The root JSON element containing SNS metadata information.</param>
44+
/// <returns>An SNSMetadata object containing the extracted metadata.</returns>
45+
public static SNSMetadata CreateSNSMetadata(JsonElement root)
46+
{
47+
var metadata = new SNSMetadata
48+
{
49+
MessageId = JsonPropertyHelper.GetStringProperty(root, "MessageId"),
50+
TopicArn = JsonPropertyHelper.GetStringProperty(root, "TopicArn"),
51+
Timestamp = JsonPropertyHelper.GetDateTimeOffsetProperty(root, "Timestamp") ?? default,
52+
UnsubscribeURL = JsonPropertyHelper.GetStringProperty(root, "UnsubscribeURL"),
53+
Subject = JsonPropertyHelper.GetStringProperty(root, "Subject"),
54+
};
55+
56+
if (root.TryGetProperty("MessageAttributes", out var messageAttributes))
57+
{
58+
metadata.MessageAttributes = messageAttributes.Deserialize(MessagingJsonSerializerContext.Default.DictionarySNSMessageAttributeValue);
59+
60+
}
61+
62+
return metadata;
63+
}
64+
65+
/// <summary>
66+
/// Creates EventBridge metadata from a JSON element representing an EventBridge event.
67+
/// </summary>
68+
/// <param name="root">The root JSON element containing EventBridge metadata information.</param>
69+
/// <returns>An EventBridgeMetadata object containing the extracted metadata.</returns>
70+
public static EventBridgeMetadata CreateEventBridgeMetadata(JsonElement root)
71+
{
72+
var metadata = new EventBridgeMetadata
73+
{
74+
EventId = JsonPropertyHelper.GetStringProperty(root, "id"),
75+
DetailType = JsonPropertyHelper.GetStringProperty(root, "detail-type"),
76+
Source = JsonPropertyHelper.GetStringProperty(root, "source"),
77+
AWSAccount = JsonPropertyHelper.GetStringProperty(root, "account"),
78+
Time = JsonPropertyHelper.GetDateTimeOffsetProperty(root, "time") ?? default,
79+
AWSRegion = JsonPropertyHelper.GetStringProperty(root, "region"),
80+
};
81+
82+
if (root.TryGetProperty("resources", out var resources))
83+
{
84+
metadata.Resources = resources.EnumerateArray()
85+
.Select(x => x.GetString())
86+
.Where(x => x != null)
87+
.ToList()!;
88+
}
89+
90+
return metadata;
91+
}
92+
}

‎src/AWS.Messaging/Serialization/Helpers/JsonPropertyHelper.cs

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
using System.Text.Json;
5+
6+
namespace AWS.Messaging.Serialization.Helpers;
7+
8+
/// <summary>
9+
/// Provides helper methods for safely extracting values from JsonElement and Dictionary objects.
10+
/// </summary>
11+
internal static class JsonPropertyHelper
12+
{
13+
/// <summary>
14+
/// Safely extracts a value from a JsonElement using the provided conversion function.
15+
/// </summary>
16+
/// <typeparam name="T">The type to convert the property value to.</typeparam>
17+
/// <param name="root">The root JsonElement containing the property.</param>
18+
/// <param name="propertyName">The name of the property to extract.</param>
19+
/// <param name="getValue">The function to convert the property value to type T.</param>
20+
/// <returns>The converted value or default if the property doesn't exist.</returns>
21+
public static T? GetPropertyValue<T>(JsonElement root, string propertyName, Func<JsonElement, T> getValue)
22+
{
23+
if (getValue == null)
24+
{
25+
throw new ArgumentNullException(nameof(getValue));
26+
}
27+
28+
29+
return root.TryGetProperty(propertyName, out var property) ? getValue(property) : default;
30+
}
31+
32+
/// <summary>
33+
/// Extracts a required value from a JsonElement using the provided conversion function.
34+
/// </summary>
35+
/// <typeparam name="T">The type to convert the property value to.</typeparam>
36+
/// <param name="root">The root JsonElement containing the property.</param>
37+
/// <param name="propertyName">The name of the property to extract.</param>
38+
/// <param name="getValue">The function to convert the property value to type T.</param>
39+
/// <returns>The converted value.</returns>
40+
/// <exception cref="InvalidDataException">Thrown when the property is missing or conversion fails.</exception>
41+
public static T GetRequiredProperty<T>(JsonElement root, string propertyName, Func<JsonElement, T> getValue)
42+
{
43+
if (root.TryGetProperty(propertyName, out var property))
44+
{
45+
try
46+
{
47+
return getValue(property);
48+
}
49+
catch (Exception ex)
50+
{
51+
throw new InvalidDataException($"Failed to get or convert property '{propertyName}'", ex);
52+
}
53+
}
54+
throw new InvalidDataException($"Required property '{propertyName}' is missing");
55+
}
56+
57+
/// <summary>
58+
/// Safely extracts a string value from a JsonElement.
59+
/// </summary>
60+
/// <param name="root">The root JsonElement containing the property.</param>
61+
/// <param name="propertyName">The name of the property to extract.</param>
62+
/// <returns>The string value or null if the property doesn't exist.</returns>
63+
public static string? GetStringProperty(JsonElement root, string propertyName)
64+
=> GetPropertyValue(root, propertyName, element => element.GetString());
65+
66+
/// <summary>
67+
/// Safely extracts a DateTimeOffset value from a JsonElement.
68+
/// </summary>
69+
/// <param name="root">The root JsonElement containing the property.</param>
70+
/// <param name="propertyName">The name of the property to extract.</param>
71+
/// <returns>The DateTimeOffset value or null if the property doesn't exist.</returns>
72+
public static DateTimeOffset? GetDateTimeOffsetProperty(JsonElement root, string propertyName)
73+
=> GetPropertyValue(root, propertyName, element => element.GetDateTimeOffset());
74+
75+
/// <summary>
76+
/// Safely extracts a Uri value from a JsonElement.
77+
/// </summary>
78+
/// <param name="root">The root JsonElement containing the property.</param>
79+
/// <param name="propertyName">The name of the property to extract.</param>
80+
/// <returns>The Uri value or null if the property doesn't exist.</returns>
81+
public static Uri? GetUriProperty(JsonElement root, string propertyName)
82+
=> GetPropertyValue(root, propertyName, element => new Uri(element.GetString()!, UriKind.RelativeOrAbsolute));
83+
84+
/// <summary>
85+
/// Safely extracts a value from a dictionary.
86+
/// </summary>
87+
/// <param name="attributes">The dictionary containing the value.</param>
88+
/// <param name="key">The key of the value to extract.</param>
89+
/// <returns>The value or null if the key doesn't exist.</returns>
90+
public static string? GetAttributeValue(Dictionary<string, string> attributes, string key)
91+
{
92+
return attributes.TryGetValue(key, out var value) ? value : null;
93+
}
94+
}

‎src/AWS.Messaging/Serialization/MessageMetadata.cs

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
namespace AWS.Messaging.Serialization;
2+
3+
/// <summary>
4+
/// Represents metadata associated with a message, including SQS, SNS, and EventBridge specific information.
5+
/// </summary>
6+
internal class MessageMetadata
7+
{
8+
/// <summary>
9+
/// Gets or sets the SQS-specific metadata.
10+
/// </summary>
11+
public SQSMetadata? SQSMetadata { get; set; }
12+
13+
/// <summary>
14+
/// Gets or sets the SNS-specific metadata.
15+
/// </summary>
16+
public SNSMetadata? SNSMetadata { get; set; }
17+
18+
/// <summary>
19+
/// Gets or sets the EventBridge-specific metadata.
20+
/// </summary>
21+
public EventBridgeMetadata? EventBridgeMetadata { get; set; }
22+
23+
/// <summary>
24+
/// Initializes a new instance of the MessageMetadata class.
25+
/// </summary>
26+
public MessageMetadata()
27+
{
28+
}
29+
30+
/// <summary>
31+
/// Initializes a new instance of the MessageMetadata class with specified metadata.
32+
/// </summary>
33+
/// <param name="sqsMetadata">The SQS metadata.</param>
34+
/// <param name="snsMetadata">The SNS metadata.</param>
35+
/// <param name="eventBridgeMetadata">The EventBridge metadata.</param>
36+
public MessageMetadata(
37+
SQSMetadata? sqsMetadata = null,
38+
SNSMetadata? snsMetadata = null,
39+
EventBridgeMetadata? eventBridgeMetadata = null)
40+
{
41+
SQSMetadata = sqsMetadata;
42+
SNSMetadata = snsMetadata;
43+
EventBridgeMetadata = eventBridgeMetadata;
44+
}
45+
}

‎src/AWS.Messaging/Serialization/Parsers/EventBridgeMessageParser.cs

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
using System.Text.Json;
5+
using Amazon.SQS.Model;
6+
using AWS.Messaging.Serialization.Handlers;
7+
8+
namespace AWS.Messaging.Serialization.Parsers
9+
{
10+
/// <summary>
11+
/// Parser for messages originating from Amazon EventBridge.
12+
/// </summary>
13+
internal class EventBridgeMessageParser : IMessageParser
14+
{
15+
/// <summary>
16+
/// Determines if the JSON element represents an EventBridge message by checking for required properties.
17+
/// </summary>
18+
/// <param name="root">The root JSON element to examine.</param>
19+
/// <returns>True if the message can be parsed as an EventBridge message; otherwise, false.</returns>
20+
public bool CanParse(JsonElement root)
21+
{
22+
return root.TryGetProperty("detail", out _) &&
23+
root.TryGetProperty("detail-type", out _) &&
24+
root.TryGetProperty("source", out _) &&
25+
root.TryGetProperty("time", out _);
26+
}
27+
28+
/// <summary>
29+
/// Parses an EventBridge message, extracting the message body and metadata.
30+
/// </summary>
31+
/// <param name="root">The root JSON element containing the EventBridge message.</param>
32+
/// <param name="originalMessage">The original SQS message.</param>
33+
/// <returns>A tuple containing the message body and associated metadata.</returns>
34+
/// <exception cref="InvalidOperationException">Thrown when the EventBridge message does not contain a valid detail property.</exception>
35+
public (string MessageBody, MessageMetadata Metadata) Parse(JsonElement root, Message originalMessage)
36+
{
37+
// The detail property can be either a string or an object
38+
var detailElement = root.GetProperty("detail");
39+
40+
// Add explicit check for null detail
41+
if (detailElement.ValueKind == JsonValueKind.Null)
42+
{
43+
throw new InvalidOperationException("EventBridge message does not contain a valid detail property");
44+
}
45+
46+
var messageBody = detailElement.ValueKind == JsonValueKind.String
47+
? detailElement.GetString()
48+
: detailElement.GetRawText();
49+
50+
if (string.IsNullOrEmpty(messageBody))
51+
{
52+
throw new InvalidOperationException("EventBridge message does not contain a valid detail property");
53+
}
54+
55+
var metadata = new MessageMetadata
56+
{
57+
EventBridgeMetadata = MessageMetadataHandler.CreateEventBridgeMetadata(root)
58+
};
59+
60+
return (messageBody, metadata);
61+
}
62+
}
63+
}

‎src/AWS.Messaging/Serialization/Parsers/IMessageParser.cs

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
using System.Text.Json;
5+
using Amazon.SQS.Model;
6+
using AWS.Messaging.Serialization;
7+
8+
namespace AWS.Messaging.Serialization.Parsers;
9+
10+
/// <summary>
11+
/// Defines the contract for message parsers capable of handling different message formats.
12+
/// </summary>
13+
internal interface IMessageParser
14+
{
15+
/// <summary>
16+
/// Determines if the parser can handle the given JSON element.
17+
/// </summary>
18+
/// <param name="root">The root JSON element to examine.</param>
19+
/// <returns>True if the parser can handle the message; otherwise, false.</returns>
20+
bool CanParse(JsonElement root);
21+
22+
/// <summary>
23+
/// Parses the message, extracting the message body and associated metadata.
24+
/// </summary>
25+
/// <param name="root">The root JSON element containing the message to parse.</param>
26+
/// <param name="originalMessage">The original SQS message.</param>
27+
/// <returns>A tuple containing the extracted message body and associated metadata.</returns>
28+
(string MessageBody, MessageMetadata Metadata) Parse(JsonElement root, Message originalMessage);
29+
}

‎src/AWS.Messaging/Serialization/Parsers/SNSMessageParser.cs

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
using System.Text.Json;
5+
using Amazon.SQS.Model;
6+
using AWS.Messaging.Serialization.Handlers;
7+
8+
namespace AWS.Messaging.Serialization.Parsers
9+
{
10+
/// <summary>
11+
/// Parser for messages originating from Amazon Simple Notification Service (SNS).
12+
/// </summary>
13+
internal class SNSMessageParser : IMessageParser
14+
{
15+
/// <summary>
16+
/// Determines if the JSON element represents an SNS message by checking for required properties.
17+
/// </summary>
18+
/// <param name="root">The root JSON element to examine.</param>
19+
/// <returns>True if the message can be parsed as an SNS message; otherwise, false.</returns>
20+
public bool CanParse(JsonElement root)
21+
{
22+
return root.TryGetProperty("Type", out var type) &&
23+
type.GetString() == "Notification" &&
24+
root.TryGetProperty("MessageId", out _) &&
25+
root.TryGetProperty("TopicArn", out _);
26+
}
27+
28+
/// <summary>
29+
/// Parses an SNS message, extracting the inner message body and metadata.
30+
/// </summary>
31+
/// <param name="root">The root JSON element containing the SNS message.</param>
32+
/// <param name="originalMessage">The original SQS message.</param>
33+
/// <returns>A tuple containing the extracted message body and associated metadata.</returns>
34+
/// <exception cref="InvalidOperationException">Thrown when the SNS message does not contain a valid Message property.</exception>
35+
public (string MessageBody, MessageMetadata Metadata) Parse(JsonElement root, Message originalMessage)
36+
{
37+
// Extract the inner message from the SNS wrapper
38+
var messageBody = root.GetProperty("Message").GetString()
39+
?? throw new InvalidOperationException("SNS message does not contain a valid Message property");
40+
41+
var metadata = new MessageMetadata
42+
{
43+
SNSMetadata = MessageMetadataHandler.CreateSNSMetadata(root)
44+
};
45+
46+
return (messageBody, metadata);
47+
}
48+
}
49+
}

0 commit comments

Comments
 (0)