[PnP] Update PayloadCollection to accept dictionary of values #2171
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abhipsaMisra
requested review from
azabbasi,
drwill-ms,
jamdavi,
timtay-microsoft and
vinagesh
as code owners
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
| throw new ArgumentNullException(nameof(componentName)); | ||
| } | ||
|
|
||
| AddInternal(properties, componentName, false); |
There was a problem hiding this comment.
Should the final parameter here be true? If not, why is it being changed from its previous behavior here?
There was a problem hiding this comment.
The final parameter here determines if the operation is a "force" update. This is set to false for the "Add" APIs and is set to true for the "AddOrUpdate" APIs.
This was incorrectly set to true previously.
timtay-microsoft
approved these changes
Sep 20, 2021
jamdavi
reviewed
Sep 20, 2021
| @@ -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) | |||
There was a problem hiding this comment.
As an aside, a dictionary will not allow you to have a null value as a key. Might be overkill to check for this unless we're thinking that someone will violate the IDictionary<> Add method.
There was a problem hiding this comment.
That makes sense; however, our public API does take in an IDictionary (and not a Dictionary), so this might be worth holding on to. What do you think?
There was a problem hiding this comment.
It will likely save us from some headache since we don't want to be in a position where we would try to serialize a null key
jamdavi
approved these changes
Sep 20, 2021
abhipsaMisra
added a commit
that referenced
this pull request
Oct 8, 2021
* feat(shared): Add common resources for convention-based operations * feat(iot-device): Add support for convention-based telemetry operation * feat(iot-device): Add support for convention-based command operations * * feat(iot-device): Add support for convention-based properties operations * feat(iot-device): Add support for convention-based properties operations Co-authored-by: James Davis ⛺️🏔 <jamdavi@microsoft.com> * feat(e2e-tests): Add telemetry E2E tests * feat(e2e-tests): Add command E2E tests * fix(iot-device): Updating client property collection to handle no convention * feat(samples): Add thermostat and temperature controller sample * fix(doc, samples): Update API design doc and move SystemTextJson helper to samples * fix(iot-device): Separate out root-level and component-level property addition operations * feat(tests): Add unit tests for ClientPropertyCollection feat(tests): Add unit tests for ClientPropertyCollection Co-authored-by: Abhipsa Misra <abhipsa.misra@microsoft.com> * feat(e2e-tests): Add properties E2E tests Co-authored-by: Abhipsa Misra <abhipsa.misra@microsoft.com> * feat(e2e-tests): Add fault injection tests for properties operations (#2001) * fix(iot-device, shared, samples): Rename StatusCodes to CommonClientResponseCodes and add a comment to highlight ClientOptions behavior * fix(iot-device): Fix enumerator implementation to return key-value pairs * fix(iot-device): Make ClientOptions.PayloadConvention readonly * fix(shared): Fix from merge conflict * fix(samples): Update the pnp samples readme (#2025) * Rename E2ETests.Configuration to TestConfiguration to avoid SDK type name conflict * Revert "Rename E2ETests.Configuration to TestConfiguration to avoid SDK type name conflict" This reverts commit 75034e5. * Rename E2ETests.Configuration to TestConfiguration to avoid SDK type name conflict * feat(service): add support for DeviceScope to import/export job * fix(iot-device): Update IoT Hub CONNACK timeout to be 60 seconds * feat(provisioning-device, prov-amqp, prov-mqtt, prov-https): Add support for timespan timeouts to provisioning device client (#2041) As discussed in #2036, AMQP provisioning device clients have no way to configure the timeout given to the AMQP library for operations like opening links. This adds overloads to the existing provisioning device client's registerAsync methods that allow for users to configure this timespan timeout. * fix(iot-device): Update doc comments for MqttTransportSettings * Add documentation to repo about which platforms this SDK supports (#2046) fixes #2032 * readme: Update readme to have LTS patch reference * doc(readme): Updated readme with details on support for device streaming feature. (#2054) * fix(iot-device): Update the amqp layer to inspect the inner exception for an amqp error code (#2053) * refactor(samples): Move preview samples to samples repository (#2057) * fix(e2e-tests): Fix file renaming Configutaion to TestConfiguration * fix(iot-device): Update connection string validation param * Update team codeowners * fix(e2e-tests): Update resource generation script to generate resources for samples * initial changeS (#2060) Co-authored-by: Sindhu Nagesh <vinagesh@microsoft.com> * Adding readme to explain authentication, retry and timeouts in DeviceClient (#2096) * refactor(iot-device): Rename property add method * Last of error codes documentation (#2110) (#2074) refactor(iot-service): Add API example for DeviceAlreadyExists error (#2101) fix(iot-service): Hide unreferenced error code (#2094) a few misc errors (#2092) * a few misc errors * fixup Document ArgumentNull (#2091) Document InvalidOperation and ArgumentInvalid (#2089) Updating exception details for IotHubThrottledException (#2088) refactor(iot-service): Add comments for service returned error codes (#2083) Fix build error (#2087) Updating exception details for IotHubSuspendedException (#2086) Updating exception details for IotHubCommunicationException (#2085) Fix InvalidProtocolVersion documentation. (#2084) More codes doc'd and code cleanup (#2082) * More codes doc'd, code clean up * Update license * Random is static * License header * More codes doc'd, code clean up More updates to exceptions thrown (#2081) More error code doc comments Remove ref to ExponentialBackoff [Error Codes] Update ThrottleBacklogLimitExceeded error code (#2078) [Error Codes] Update PreconditionFailed error description (#2077) * [Error Codes] Update PreconditionFailed error description * Remove space [Error Codes] Updated MessageTooLarge (#2073) * [Error Codes] Updated MessageTooLarge * Removed en-us where seen * Remove en-us * REmove en-us [Error Codes] Updating UnauthorizedException (#2072) * [Error Codes] Updating UnauthorizedException * Remove en-us * Remove en-us * Update UnauthorizedException.cs * Update UnauthorizedException.cs [Error Codes] Updated ServerErrorException (#2071) * [Error Codes] Updated ServerErrorException * Update ServerErrorException.cs * Update ServerErrorException.cs * Update ServerErrorException.cs * Update ServerErrorException.cs * Update ServerErrorException.cs [Error Codes] Updated QuotaExceededException (#2070) * Updated QuotaExceededException classes * Update QuotaExceededException.cs * Update QuotaExceededException.cs Updated ServerBusyException (#2069) [Error Codes] Update PartitionNotFound error code (#2075) * [Error Codes] Update PartitionNotFound error code * remove double lines * remove double lines Obsolete error codes that are not throw by the service (#2079) Fix deprecation messages. Notes for and deprecation of BlobContainerValidationError, BulkRegistryOperationFailure, and JobQuotaExceeded Document errors and remove unreferenced file * Rename readme per style and update reference (#2113) * * fix(iot-device): TryGetValue methods should check for the component identifier when applicable and should not throw any exceptions (#2111) * refactor(iot-device): Separate client reported properties into a separate accessor * fix(iot-device): Add checks to verify that client property update response has version and requestId (#2115) * refactor(iot-service) Make all clients mockable (#2117) * refactor(job-client): Make job client easy to mock (#1875) * refactor(service-client): Make service client easy to mock (#1878) * refactor(registry-manager): Make registry manager mockable (#1881) * refactor(digital-twin-client): Make the DigitalTwin client mockable. (#1892) * refactor(iot-service): Move direct method request file out of JobClient folder into root * refactor(prov-amqp, prov-mqtt, prov-http): Fix timeout tests failing occasionally (#2121) * fix(tools): Fix readme for ConsoleEventListener usage (#2123) * fix(tools): Fix readme for ConsoleEventListener usage * doc(all): Add documentation for the upcoming service TLS changes for user awareness (#2112) * fix(doc): Fix typo is readme * Remove barustum from CODEOWNERS (#2126) * refactor(ado): Update area paths for analyzers pipeline (#2136) * refactor(tools-logs): Update log capture script to be configurable and use powershell (#2141) * refactor(iot-device, prov-mqtt): Target new DotNetty version when not net451 (#2129) * refactor(doc): Add additional comments to log capture readme * Bump versions for 2021-08-12 release (#2143) * fix(readme): Update the LTS support dates readme (#2147) * fix(e2e): get values from create call to avoid timing issues * refactor(iot-device): Update the internal method names as per functionality * refactor(e2e): Remove unnecessary value in keyvault from setup file (#2153) * fix(e2e): Fix e2e setup script to choose the correct dps endpoint based on region of the resource (#2134) * fix(readme): Update readme to specify preview strategy * Removing vinagesh from codebase owners list * feat(iot-device): Add convenience method for acknowledging writable property update requests * fix(iot-device): Fix params passed into ObjectDisposedException * fix(githib): Update github issues template * Add support for .NET 5 (#2169) * feat(all): Add support for .NET 5.0 * refactor(all): Update APIs to follow .NET 5.0 patterns * refactor(e2e-tests): Update E2E tests to follow .NET 5.0 patterns * refactor(all): Simplify disposal of IDisposable X509Certificate * fix(vsts): Update the location for log analytics workspace resource * refactor(e2e-tests): Dispose IDisposable types * fix(e2e-tests): Dispose IDisposable types created - hmac * fix(iot-device): Update PayloadCollection to accept dictionary of values (#2171) * Wrong reference to Device Streaming Sample (#2173) * Fix link to Device Streaming Sample * Update iothub/service/samples/readme.md Co-authored-by: David R. Williamson <drwill@microsoft.com> * fix(dps-service): Remove client side validation of x509 CA references format (#2172) * Add Andy to the repos (#2179) * Default Branch update: Update master branch to main. (#2183) * Update master branch to main. * Update horton-e2e.yaml * fix(iot-serv): Fix bug where device scope and parent scopes set to device weren't used in bulk add operations (#2189) #2184 * fix(iot-svc): Cleanup and deprecation warning of code in CryptoKeyGenerator (#2187) * fix(iot-svc): Add support for GeneratePassword to other targets * Don't add net472 support, but keep code cleanup * Add deprecated attribute * Fix test references by making a local copy for tests * Add XML docs for exceptions that can be thrown by ModuleClient.SendEventAsync and DeviceClient.SendEventAsync (#2178) * Add XML docs for exceptions that can be thrown by ModuleClient.SendEventAsync and DeviceClient.SendEventAsync * Add more XML docs for exceptions for ModuleClient.SendEventAsync and DeviceClient.SendEventAsync * Update iothub/device/src/DeviceClient.cs Co-authored-by: David R. Williamson <drwill@microsoft.com> * Add using for exceptions Co-authored-by: David R. Williamson <drwill@microsoft.com> * refactor(iot-device): Merge flows for twin and client property operations (#2180) * fix(e2e-tests): Update E2E tests to initialize and dispose resources correctly * fix Co-authored-by: James Davis ⛺️🏔 <jamdavi@microsoft.com> Co-authored-by: jamdavi <73593426+jamdavi@users.noreply.github.com> Co-authored-by: David R. Williamson <drwill@microsoft.com> Co-authored-by: timtay-microsoft <timtay@microsoft.com> Co-authored-by: Sindhu Nagesh <vinagesh@microsoft.com> Co-authored-by: bikamani <41314966+bikamani@users.noreply.github.com> Co-authored-by: Bommas <5359504+scb01@users.noreply.github.com> Co-authored-by: Basel Rustum <barustum@microsoft.com> Co-authored-by: Roman Marusyk <Marusyk@users.noreply.github.com> Co-authored-by: Azad Abbasi <azabbasi@microsoft.com>
abhipsaMisra
added a commit
that referenced
this pull request
Feb 14, 2022
* feat(shared): Add common resources for convention-based operations * feat(iot-device): Add support for convention-based telemetry operation * feat(iot-device): Add support for convention-based command operations * * feat(iot-device): Add support for convention-based properties operations * feat(iot-device): Add support for convention-based properties operations Co-authored-by: James Davis ⛺️🏔 <jamdavi@microsoft.com> * feat(e2e-tests): Add telemetry E2E tests * feat(e2e-tests): Add command E2E tests * fix(iot-device): Updating client property collection to handle no convention * feat(samples): Add thermostat and temperature controller sample * fix(doc, samples): Update API design doc and move SystemTextJson helper to samples * fix(iot-device): Separate out root-level and component-level property addition operations * feat(tests): Add unit tests for ClientPropertyCollection feat(tests): Add unit tests for ClientPropertyCollection Co-authored-by: Abhipsa Misra <abhipsa.misra@microsoft.com> * feat(e2e-tests): Add properties E2E tests Co-authored-by: Abhipsa Misra <abhipsa.misra@microsoft.com> * feat(e2e-tests): Add fault injection tests for properties operations (#2001) * fix(iot-device, shared, samples): Rename StatusCodes to CommonClientResponseCodes and add a comment to highlight ClientOptions behavior * fix(iot-device): Fix enumerator implementation to return key-value pairs * fix(iot-device): Make ClientOptions.PayloadConvention readonly * fix(shared): Fix from merge conflict * fix(samples): Update the pnp samples readme (#2025) * refactor(samples): Move preview samples to samples repository (#2057) * fix(e2e-tests): Fix file renaming Configutaion to TestConfiguration * refactor(iot-device): Rename property add method * * fix(iot-device): TryGetValue methods should check for the component identifier when applicable and should not throw any exceptions (#2111) * refactor(iot-device): Separate client reported properties into a separate accessor * fix(iot-device): Add checks to verify that client property update response has version and requestId (#2115) * refactor(iot-device): Update the internal method names as per functionality * feat(iot-device): Add convenience method for acknowledging writable property update requests * fix(iot-device): Update PayloadCollection to accept dictionary of values (#2171) * refactor(iot-device): Merge flows for twin and client property operations (#2180) * fix(e2e-tests): Update E2E tests to initialize and dispose resources correctly * doc(client, service): Update documents about the Proxy property for various clients (#2248) Update our code docs to better explain proxy settings * Cleanup IDE warnings. From 442 down to 31. (#2254) * Fix documented exception types thrown by methods in device client. (#2256) * (Fix: DeviceClient): Fix the concurrency issue in MQTT stack (#2234) * Update RegistryManager bulk API unit tests (#2258) * feat(hub-svc): add support and tests for configurations export (#2250) * Temporarily disable import devices/configs test (#2263) * fix(iot-svc): update debug assert (#2264) * fix(iot-svc): update debug assert * Temporarily disable import devices/configs test (#2263) * fix(iot-svc): update debug assert * Reduce modules in ModulesClient_GetModulesOnDevice to 2 * Consolidate keyvault writes, and fix error about null (#2266) * Cleanup code in Hub RTAC (#2268) * fix(deviceClient): Fix issue with AMQP connection pool and TokenReferesher disposal. (#2260) * Fix issue with AMQP connection pool * Dispose the connection holder appropriately * Add unit testing capability to connection pool * Move more LA steps under conditional (#2270) * Disable import/export of config until bug fix (#2273) * Adding RBAC support for provisioning SDK (#2262) * Added types for different credentials * Altered code to work with new types * Fixed Managers * removed unneeded #if !NET451 * Filled in method summaries * refactored GetHeaderProvider * Added documentation * Formatting fixes to address comments * Adding Common 0.7.1 (#2272) * Fix doc comment list bullets (#2275) * Fix doc comment list bullets * Change to use description tag * sdl(all): Create SBOM for net packages (#2261) * Streamline an RBAC test (#2274) * Exclude low pri .net targets in PR builds (#2277) * fix(tests): Fix device client test to use updated API * Update IDeviceIdentity interface to add doc comments. (#2282) * PnP doc comment updates (#2278) * Fix remaining doc comment bullets (#2285) * Give e2e appId permission on the DPS instance (#2283) * fix(DeviceClient): Avoid NRE after client dispose (#2286) * refactor(iot-device): Update API surface for property callback API * refactor(iot-device): Update API surface for command callback API * fix(e2e-tests): Update E2E tests to use fluent assertions * fix(iot-device): Update API surface to remove redundant private setters * Revert "Adding RBAC support for provisioning SDK (#2262)" (#2289) This reverts commit 7a26eda. * Version bump for 2021-01-26 release (#2291) * Update service clients instantiation doc comments (#2290) * Update RegistryManager instantiation doc comments * Update other service client doc comments. * Fix class field constants casing (#2292) * Disable checks for config in import e2e test (#2293) * Update iteration path in vsts.yaml (#2296) Co-authored-by: James Davis ⛺️🏔 <jamdavi@microsoft.com> Co-authored-by: jamdavi <73593426+jamdavi@users.noreply.github.com> Co-authored-by: Azad Abbasi <azabbasi@microsoft.com> Co-authored-by: David R. Williamson <drwill@microsoft.com> Co-authored-by: dylanbulfinMS <95251881+dylanbulfinMS@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This update allows users to pass in a collection of values for TelemetryPayload and PropertyPayload.
While we currently don't have an implementation to accept raw classes as payload values, it can easily be achieved by serializing the raw class and deserializing it into a dictionary.
We'll can add support for it if customers ask for it.