Skip to content

Commit

Permalink
fix(iot-device): Update PayloadCollection to accept dictionary of val…
Browse files Browse the repository at this point in the history 
…ues (#2171)
  • Loading branch information
@abhipsaMisra
abhipsaMisra authored Sep 20, 2021
1 parent fc774ff commit 0be2fe7
Show file tree
Hide file tree
Showing 4 changed files with 658 additions and 8 deletions.
66 changes: 58 additions & 8 deletions iothub/device/src/ClientPropertyCollection.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,16 @@ public void AddRootProperty(string propertyName, object propertyValue)
/// <param name="componentName">The component with the property to add.</param>
/// <param name="propertyName">The name of the property to add.</param>
/// <param name="propertyValue">The value of the property to add.</param>
/// <exception cref="ArgumentNullException"><paramref name="componentName"/> or <paramref name="propertyName"/> is <c>null</c>.</exception>
public void AddComponentProperty(string componentName, string propertyName, object propertyValue)
=> AddInternal(new Dictionary<string, object> { { propertyName, propertyValue } }, componentName, false);
{
if (componentName == null)
{
throw new ArgumentNullException(nameof(componentName));
}

AddInternal(new Dictionary<string, object> { { propertyName, propertyValue } }, componentName, false);
}

/// <inheritdoc path="/remarks" cref="AddRootProperty(string, object)" />
/// <inheritdoc path="/seealso" cref="AddInternal(IDictionary{string, object}, string, bool)" />
Expand All @@ -55,8 +63,16 @@ public void AddComponentProperty(string componentName, string propertyName, obje
/// <param name="componentName">The component with the properties to add.</param>
/// <param name="properties">A collection of properties to add.</param>
/// <exception cref="ArgumentException">A property name in <paramref name="properties"/> already exists in the collection.</exception>
/// <exception cref="ArgumentNullException"><paramref name="componentName"/> or a property name in <paramref name="properties"/> is <c>null</c>.</exception>
public void AddComponentProperties(string componentName, IDictionary<string, object> properties)
=> AddInternal(properties, componentName, true);
{
if (componentName == null)
{
throw new ArgumentNullException(nameof(componentName));
}

AddInternal(properties, componentName, false);
}

/// <inheritdoc path="/seealso" cref="AddInternal(IDictionary{string, object}, string, bool)" />
/// <inheritdoc path="/exception" cref="AddRootProperty(string, object)" />
Expand Down Expand Up @@ -100,9 +116,16 @@ public void AddOrUpdateRootProperty(string propertyName, object propertyValue)
/// <param name="componentName">The component with the property to add or update.</param>
/// <param name="propertyName">The name of the property to add or update.</param>
/// <param name="propertyValue">The value of the property to add or update.</param>
/// <exception cref="ArgumentNullException"><paramref name="propertyName"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="componentName"/> or <paramref name="propertyName"/> is <c>null</c>.</exception>
public void AddOrUpdateComponentProperty(string componentName, string propertyName, object propertyValue)
=> AddInternal(new Dictionary<string, object> { { propertyName, propertyValue } }, componentName, true);
{
if (componentName == null)
{
throw new ArgumentNullException(nameof(componentName));
}

AddInternal(new Dictionary<string, object> { { propertyName, propertyValue } }, componentName, true);
}

/// <inheritdoc path="/summary" cref="AddInternal(IDictionary{string, object}, string, bool)" />
/// <inheritdoc path="/seealso" cref="AddInternal(IDictionary{string, object}, string, bool)" />
Expand All @@ -116,8 +139,16 @@ public void AddOrUpdateComponentProperty(string componentName, string propertyNa
/// </remarks>
/// <param name="componentName">The component with the properties to add or update.</param>
/// <param name="properties">A collection of properties to add or update.</param>
/// <exception cref="ArgumentNullException"><paramref name="componentName"/> or a property name in <paramref name="properties"/> is <c>null</c>.</exception>
public void AddOrUpdateComponentProperties(string componentName, IDictionary<string, object> properties)
=> AddInternal(properties, componentName, true);
{
if (componentName == null)
{
throw new ArgumentNullException(nameof(componentName));
}

AddInternal(properties, componentName, true);
}

/// <inheritdoc path="/summary" cref="AddInternal(IDictionary{string, object}, string, bool)" />
/// <inheritdoc path="/seealso" cref="AddInternal(IDictionary{string, object}, string, bool)" />
Expand All @@ -133,9 +164,16 @@ public void AddOrUpdateComponentProperties(string componentName, IDictionary<str
/// <param name="properties">A collection of properties to add or update.</param>
/// <exception cref="ArgumentNullException"><paramref name="properties"/> is <c>null</c>.</exception>
public void AddOrUpdateRootProperties(IDictionary<string, object> properties)
=> properties
{
if (properties == null)
{
throw new ArgumentNullException(nameof(properties));
}

properties
.ToList()
.ForEach(entry => Collection[entry.Key] = entry.Value);
}

/// <summary>
/// Determines whether the specified property is present.
Expand Down Expand Up @@ -426,14 +464,14 @@ internal static ClientPropertyCollection FromClientPropertiesAsDictionary(IDicti
/// <param name="componentName">The component with the properties to add or update.</param>
/// <param name="forceUpdate">Forces the collection to use the Add or Update behavior.
/// Setting to true will simply overwrite the value. Setting to false will use <see cref="IDictionary{TKey, TValue}.Add(TKey, TValue)"/></param>
/// <exception cref="ArgumentNullException"><paramref name="properties"/> is <c>null</c> for a top-level property operation.</exception>
/// <exception cref="ArgumentNullException"><paramref name="properties"/> is <c>null</c>.</exception>
private void AddInternal(IDictionary<string, object> properties, string componentName = default, bool forceUpdate = false)
{
// If the componentName is null then simply add the key-value pair to Collection dictionary.
// This will either insert a property or overwrite it if it already exists.
if (componentName == null)
{
// If both the component name and properties collection are null then throw a ArgumentNullException.
// If both the component name and properties collection are null then throw an ArgumentNullException.
// This is not a valid use-case.
if (properties == null)
{
Expand All @@ -442,6 +480,12 @@ private void AddInternal(IDictionary<string, object> properties, string componen

foreach (KeyValuePair<string, object> entry in properties)
{
// A null property key is not allowed. Throw an ArgumentNullException.
if (entry.Key == null)
{
throw new ArgumentNullException(nameof(entry.Key));
}

if (forceUpdate)
{
Collection[entry.Key] = entry.Value;
Expand Down Expand Up @@ -471,6 +515,12 @@ private void AddInternal(IDictionary<string, object> properties, string componen

foreach (KeyValuePair<string, object> entry in properties)
{
// A null property key is not allowed. Throw an ArgumentNullException.
if (entry.Key == null)
{
throw new ArgumentNullException(nameof(entry.Key));
}

if (forceUpdate)
{
componentProperties[entry.Key] = entry.Value;
Expand Down
39 changes: 39 additions & 0 deletions iothub/device/src/TelemetryCollection.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System;
using System.Collections.Generic;
using System.Linq;

namespace Microsoft.Azure.Devices.Client
{
Expand Down Expand Up @@ -32,5 +34,42 @@ public override void AddOrUpdate(string telemetryName, object telemetryValue)
{
base.AddOrUpdate(telemetryName, telemetryValue);
}

/// <summary>
/// Adds the telemetry values to the telemetry collection.
/// </summary>
/// <inheritdoc cref="AddOrUpdate(string, object)" path="/param['telemetryName']"/>
/// <inheritdoc cref="AddOrUpdate(string, object)" path="/param['telemetryValue']"/>
/// <exception cref="ArgumentException">An element with the same key already exists in the collection.</exception>
/// <exception cref="ArgumentNullException"><paramref name="telemetryValues"/> is <c>null</c>.</exception>
public void Add(IDictionary<string, object> telemetryValues)
{
if (telemetryValues == null)
{
throw new ArgumentNullException(nameof(telemetryValues));
}

telemetryValues
.ToList()
.ForEach(entry => base.Add(entry.Key, entry.Value));
}

/// <summary>
/// Adds or updates the telemetry values in the telemetry collection.
/// </summary>
/// <inheritdoc cref="AddOrUpdate(string, object)" path="/param['telemetryName']"/>
/// <inheritdoc cref="AddOrUpdate(string, object)" path="/param['telemetryValue']"/>
/// <exception cref="ArgumentNullException"><paramref name="telemetryValues"/> is <c>null</c>.</exception>
public void AddOrUpdate(IDictionary<string, object> telemetryValues)
{
if (telemetryValues == null)
{
throw new ArgumentNullException(nameof(telemetryValues));
}

telemetryValues
.ToList()
.ForEach(entry => base.AddOrUpdate(entry.Key, entry.Value));
}
}
}
Loading

0 comments on commit 0be2fe7

Please sign in to comment.