Skip to content

fix: Use content headers when parsing HTTP requests/responses #222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 26, 2022
Merged

fix: Use content headers when parsing HTTP requests/responses #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions src/CloudNative.CloudEvents/Http/HttpClientExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Mime;
Expand Down Expand Up @@ -36,7 +35,7 @@ public static bool IsCloudEvent(this HttpRequestMessage httpRequestMessage)
{
Validation.CheckNotNull(httpRequestMessage, nameof(httpRequestMessage));
return HasCloudEventsContentType(httpRequestMessage.Content) ||
httpRequestMessage.Headers.Contains(HttpUtilities.SpecVersionHttpHeader);
(MaybeGetVersionId(httpRequestMessage.Headers) ?? MaybeGetVersionId(httpRequestMessage.Content?.Headers)) is not null;
}

/// <summary>
Expand All @@ -48,7 +47,7 @@ public static bool IsCloudEvent(this HttpResponseMessage httpResponseMessage)
{
Validation.CheckNotNull(httpResponseMessage, nameof(httpResponseMessage));
return HasCloudEventsContentType(httpResponseMessage.Content) ||
httpResponseMessage.Headers.Contains(HttpUtilities.SpecVersionHttpHeader);
(MaybeGetVersionId(httpResponseMessage.Headers) ?? MaybeGetVersionId(httpResponseMessage.Content?.Headers)) is not null;
}

/// <summary>
Expand Down Expand Up @@ -143,9 +142,7 @@ private static async Task<CloudEvent> ToCloudEventInternalAsync(HttpHeaders head
}
else
{
string? versionId = headers.Contains(HttpUtilities.SpecVersionHttpHeader)
? headers.GetValues(HttpUtilities.SpecVersionHttpHeader).First()
: null;
string? versionId = MaybeGetVersionId(headers) ?? MaybeGetVersionId(content.Headers);
if (versionId is null)
{
throw new ArgumentException($"Request does not represent a CloudEvent. It has neither a {HttpUtilities.SpecVersionHttpHeader} header, nor a suitable content type.", nameof(paramName));
Expand All @@ -154,7 +151,7 @@ private static async Task<CloudEvent> ToCloudEventInternalAsync(HttpHeaders head
?? throw new ArgumentException($"Unknown CloudEvents spec version '{versionId}'", paramName);

var cloudEvent = new CloudEvent(version, extensionAttributes);
foreach (var header in headers)
foreach (var header in headers.Concat(content.Headers))
{
string? attributeName = HttpUtilities.GetAttributeNameFromHeaderName(header.Key);
if (attributeName is null || attributeName == CloudEventsSpecVersion.SpecVersionAttribute.Name)
Expand Down Expand Up @@ -345,5 +342,10 @@ private static bool HasCloudEventsContentType(HttpContent content) =>

private static bool HasCloudEventsBatchContentType(HttpContent content) =>
MimeUtilities.IsCloudEventsBatchContentType(content?.Headers?.ContentType?.MediaType);

private static string? MaybeGetVersionId(HttpHeaders? headers) =>
headers is not null && headers.Contains(HttpUtilities.SpecVersionHttpHeader)
? headers.GetValues(HttpUtilities.SpecVersionHttpHeader).First()
: null;
}
}
41 changes: 40 additions & 1 deletion test/CloudNative.CloudEvents.UnitTests/Http/HttpClientExtensionsTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Net;
using System.Net.Http;
Expand Down Expand Up @@ -40,6 +39,20 @@ public class HttpClientExtensionsTest : HttpTestBase
"Structured",
new StringContent("content is ignored", Encoding.UTF8, "application/cloudevents+json"),
null
},
{
"Binary with header in content",
new StringContent("header is in the content", Encoding.UTF8, "application/json")
{
Headers =
{
{ "ce-specversion", "1.0" },
{ "ce-type", "test-type" },
{ "ce-id", "test-id" },
{ "ce-source", "//test" }
}
},
null
}
};

Expand Down Expand Up @@ -438,6 +451,32 @@ public async Task ToHttpContent_Batch()
AssertBatchesEqual(batch, parsedBatch);
}

[Theory]
[InlineData(ContentMode.Binary)]
[InlineData(ContentMode.Structured)]
public async Task RoundtripRequest(ContentMode contentMode)
{
var cloudEvent = new CloudEvent().PopulateRequiredAttributes();
var formatter = new JsonEventFormatter();
var content = cloudEvent.ToHttpContent(contentMode, formatter);
var request = new HttpRequestMessage { Content = content };
var parsed = await request.ToCloudEventAsync(formatter);
AssertCloudEventsEqual(cloudEvent, parsed);
}

[Theory]
[InlineData(ContentMode.Binary)]
[InlineData(ContentMode.Structured)]
public async Task RoundtripResponse(ContentMode contentMode)
{
var cloudEvent = new CloudEvent().PopulateRequiredAttributes();
var formatter = new JsonEventFormatter();
var content = cloudEvent.ToHttpContent(contentMode, formatter);
var request = new HttpResponseMessage { Content = content };
var parsed = await request.ToCloudEventAsync(formatter);
AssertCloudEventsEqual(cloudEvent, parsed);
}

internal static void CopyHeaders(IDictionary<string, string>? source, HttpHeaders target)
{
if (source is null)
Expand Down