Skip to content

API updates #19250

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
JoshLove-msft merged 6 commits into from
Mar 5, 2021
Merged

API updates #19250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1c8c7e7
API updates
JoshLove-msft Mar 5, 2021
73b2ba9
Export API
JoshLove-msft Mar 5, 2021
92bd5b6
Use parse
JoshLove-msft Mar 5, 2021
a22f0d0
PR FB
JoshLove-msft Mar 5, 2021
33c7fb3
Fix exception message
JoshLove-msft Mar 5, 2021
841787f
fix
JoshLove-msft Mar 5, 2021
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
10 changes: 5 additions & 5 deletions sdk/core/Azure.Core/api/Azure.Core.net461.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,13 +582,13 @@ public CloudEvent(string source, string type, object? jsonSerializableData, Syst
public string? DataContentType { get { throw null; } set { } }
public string? DataSchema { get { throw null; } set { } }
public System.Collections.Generic.IDictionary<string, object?> ExtensionAttributes { get { throw null; } }
public string? Id { get { throw null; } set { } }
public string? Source { get { throw null; } set { } }
public string Id { get { throw null; } set { } }
public string Source { get { throw null; } set { } }
public string? Subject { get { throw null; } set { } }
public System.DateTimeOffset? Time { get { throw null; } set { } }
public string? Type { get { throw null; } set { } }
public static Azure.Messaging.CloudEvent? Parse(System.BinaryData jsonEvent, bool skipValidation = false) { throw null; }
public static Azure.Messaging.CloudEvent[] ParseEvents(string jsonContent, bool skipValidation = false) { throw null; }
public string Type { get { throw null; } set { } }
public static Azure.Messaging.CloudEvent? Parse(System.BinaryData json, bool skipValidation = false) { throw null; }
public static Azure.Messaging.CloudEvent[] ParseMany(System.BinaryData json, bool skipValidation = false) { throw null; }
}
public enum CloudEventDataFormat
{
Expand Down
10 changes: 5 additions & 5 deletions sdk/core/Azure.Core/api/Azure.Core.net5.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,13 +582,13 @@ public CloudEvent(string source, string type, object? jsonSerializableData, Syst
public string? DataContentType { get { throw null; } set { } }
public string? DataSchema { get { throw null; } set { } }
public System.Collections.Generic.IDictionary<string, object?> ExtensionAttributes { get { throw null; } }
public string? Id { get { throw null; } set { } }
public string? Source { get { throw null; } set { } }
public string Id { get { throw null; } set { } }
public string Source { get { throw null; } set { } }
public string? Subject { get { throw null; } set { } }
public System.DateTimeOffset? Time { get { throw null; } set { } }
public string? Type { get { throw null; } set { } }
public static Azure.Messaging.CloudEvent? Parse(System.BinaryData jsonEvent, bool skipValidation = false) { throw null; }
public static Azure.Messaging.CloudEvent[] ParseEvents(string jsonContent, bool skipValidation = false) { throw null; }
public string Type { get { throw null; } set { } }
public static Azure.Messaging.CloudEvent? Parse(System.BinaryData json, bool skipValidation = false) { throw null; }
public static Azure.Messaging.CloudEvent[] ParseMany(System.BinaryData json, bool skipValidation = false) { throw null; }
}
public enum CloudEventDataFormat
{
Expand Down
10 changes: 5 additions & 5 deletions sdk/core/Azure.Core/api/Azure.Core.netstandard2.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,13 +582,13 @@ public CloudEvent(string source, string type, object? jsonSerializableData, Syst
public string? DataContentType { get { throw null; } set { } }
public string? DataSchema { get { throw null; } set { } }
public System.Collections.Generic.IDictionary<string, object?> ExtensionAttributes { get { throw null; } }
public string? Id { get { throw null; } set { } }
public string? Source { get { throw null; } set { } }
public string Id { get { throw null; } set { } }
public string Source { get { throw null; } set { } }
public string? Subject { get { throw null; } set { } }
public System.DateTimeOffset? Time { get { throw null; } set { } }
public string? Type { get { throw null; } set { } }
public static Azure.Messaging.CloudEvent? Parse(System.BinaryData jsonEvent, bool skipValidation = false) { throw null; }
public static Azure.Messaging.CloudEvent[] ParseEvents(string jsonContent, bool skipValidation = false) { throw null; }
public string Type { get { throw null; } set { } }
public static Azure.Messaging.CloudEvent? Parse(System.BinaryData json, bool skipValidation = false) { throw null; }
public static Azure.Messaging.CloudEvent[] ParseMany(System.BinaryData json, bool skipValidation = false) { throw null; }
}
public enum CloudEventDataFormat
{
Expand Down
72 changes: 45 additions & 27 deletions sdk/core/Azure.Core/src/Messaging/CloudEvent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ public class CloudEvent
/// <param name="jsonSerializableData"> Event data specific to the event type. </param>
/// <param name="dataSerializationType">The type to use when serializing the data.
/// If not specified, <see cref="object.GetType()"/> will be used on <paramref name="jsonSerializableData"/>.</param>
/// <exception cref="ArgumentNullException">
/// <paramref name="source"/> or <paramref name="type"/> was null.
/// </exception>
public CloudEvent(string source, string type, object? jsonSerializableData, Type? dataSerializationType = default)
{
if (jsonSerializableData is BinaryData)
Expand All @@ -38,7 +41,11 @@ public CloudEvent(string source, string type, object? jsonSerializableData, Type
/// <param name="type"> Type of event related to the originating occurrence. For example, "Contoso.Items.ItemReceived". </param>
/// <param name="data"> Binary event data specific to the event type. </param>
/// <param name="dataContentType"> Content type of the payload. A content type different from "application/json" should be specified if payload is not JSON. </param>
/// <param name="dataFormat"></param>
/// <param name="dataFormat">The format that the data of a <see cref="CloudEvent"/> should be sent in
/// when using the JSON envelope format.</param>
/// <exception cref="ArgumentNullException">
/// <paramref name="source"/> or <paramref name="type"/> was null.
/// </exception>
public CloudEvent(string source, string type, BinaryData? data, string? dataContentType, CloudEventDataFormat dataFormat = CloudEventDataFormat.Binary)
{
Source = source;
Expand All @@ -62,11 +69,11 @@ internal CloudEvent() { }
/// Gets or sets an identifier for the event. The combination of <see cref="Id"/> and <see cref="Source"/> must be unique for each distinct event.
/// If not explicitly set, this will default to a <see cref="Guid"/>.
/// </summary>
public string? Id
public string Id
{
get
{
return _id;
return _id!;
Copy link
Contributor

@pakrym pakrym Mar 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we decided on throwing, no?

Copy link
Member Author

@JoshLove-msft JoshLove-msft Mar 5, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the decision was to say that this could be null, if using skipValidation, i.e. if customers have nullable references enabled AND they are skipping validation, we no longer guarantee that the nullability is 100% accurate. There is no reason to throw if the customer wants to get the Id though.

Copy link
Member Author

@JoshLove-msft JoshLove-msft Mar 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/cc @KrzysztofCwalina

}
set
{
Expand All @@ -80,11 +87,11 @@ public string? Id

/// <summary>Gets or sets the context in which an event happened. The combination of <see cref="Id"/>
/// and <see cref="Source"/> must be unique for each distinct event.</summary>
public string? Source
public string Source
{
get
{
return _source;
return _source!;
}
set
{
Expand All @@ -95,11 +102,11 @@ public string? Source
private string? _source;

/// <summary>Gets or sets the type of event related to the originating occurrence.</summary>
public string? Type
public string Type
{
get
{
return _type;
return _type!;
}
set
{
Expand Down Expand Up @@ -142,19 +149,18 @@ public string? Type
/// By default, if the event is missing required properties, an exception is thrown though this can be relaxed
/// by setting the <paramref name="skipValidation"/> parameter.
/// </summary>
/// <param name="jsonContent"> The JSON-encoded representation of either a single event or an array or events,
/// in the CloudEvent schema.</param>
/// <param name="json">An instance of <see cref="BinaryData"/> containing the JSON for one or more CloudEvents.</param>
/// <param name="skipValidation">Set to <see langword="true"/> to allow missing or invalid properties to still parse into a CloudEvent.
/// In particular, by setting strict to <see langword="true"/>, the source, id, specversion and type properties are no longer required
/// to be present in the JSON. Additionally, the casing requirements of the extension attribute names are relaxed.
/// </param>
/// <returns> A list of <see cref="CloudEvent"/>. </returns>
public static CloudEvent[] ParseEvents(string jsonContent, bool skipValidation = false)
/// <returns> An array of <see cref="CloudEvent"/> instances.</returns>
public static CloudEvent[] ParseMany(BinaryData json, bool skipValidation = false)
{
Argument.AssertNotNull(jsonContent, nameof(jsonContent));
Argument.AssertNotNull(json, nameof(json));

CloudEvent[]? cloudEvents = null;
JsonDocument requestDocument = JsonDocument.Parse(jsonContent);
JsonDocument requestDocument = JsonDocument.Parse(json);

// Parse JsonElement into separate events, deserialize event envelope properties
if (requestDocument.RootElement.ValueKind == JsonValueKind.Object)
Expand All @@ -180,30 +186,42 @@ public static CloudEvent[] ParseEvents(string jsonContent, bool skipValidation =
/// By default, if the event is missing required properties, an exception is thrown though this can be relaxed
/// by setting the <paramref name="skipValidation"/> parameter.
/// </summary>
/// <param name="jsonEvent">Specifies the instance of <see cref="BinaryData"/>.</param>
/// <param name="json">An instance of <see cref="BinaryData"/> containing the JSON for the CloudEvent.</param>
/// <param name="skipValidation">Set to <see langword="true"/> to allow missing or invalid properties to still parse into a CloudEvent.
/// In particular, by setting strict to <see langword="true"/>, the source, id, specversion and type properties are no longer required
/// to be present in the JSON. Additionally, the casing requirements of the extension attribute names are relaxed.
/// </param>
/// <returns> A <see cref="CloudEvent"/>. </returns>
public static CloudEvent? Parse(BinaryData jsonEvent, bool skipValidation = false)
/// <exception cref="ArgumentException">
/// <paramref name="json"/> contained multiple events. <see cref="ParseMany"/> should be used instead.
/// </exception>
public static CloudEvent? Parse(BinaryData json, bool skipValidation = false)
{
Argument.AssertNotNull(jsonEvent, nameof(jsonEvent));
CloudEvent[]? events = ParseEvents(jsonEvent.ToString(), skipValidation);
if (events.Length == 0)
Argument.AssertNotNull(json, nameof(json));

JsonDocument requestDocument = JsonDocument.Parse(json);
CloudEvent? cloudEvent = null;
if (requestDocument.RootElement.ValueKind == JsonValueKind.Object)
{
return null;
cloudEvent = CloudEventConverter.DeserializeCloudEvent(requestDocument.RootElement, skipValidation);
}
if (events.Length > 1)
else if (requestDocument.RootElement.ValueKind == JsonValueKind.Array)
{
throw new ArgumentException(
"The BinaryData instance contains JSON from multiple cloud events. This method " +
"should only be used with BinaryData containing a single cloud event. " +
Environment.NewLine +
"To parse multiple events, call ToString on the BinaryData and use the " +
"Parse overload that takes a string.");
if (requestDocument.RootElement.GetArrayLength() > 1)
{
throw new ArgumentException(
"The BinaryData instance contains JSON from multiple cloud events. This method " +
"should only be used with BinaryData containing a single cloud event. " +
Environment.NewLine +
$"To parse multiple events, use the {nameof(ParseMany)} overload.");
}
foreach (JsonElement property in requestDocument.RootElement.EnumerateArray())
{
cloudEvent = CloudEventConverter.DeserializeCloudEvent(property, skipValidation);
break;
}
}
return events[0];
return cloudEvent;
}
}
}
Loading