-
Notifications
You must be signed in to change notification settings - Fork 625
Expose DelayHelper as a public timing API in the Iot.Device namespace #2585
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.
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
Draft
Copilot
wants to merge
3
commits into
main
Choose a base branch
from
copilot/make-delayhelper-part-of-system-device-gpio
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System; | ||
| using System.Diagnostics; | ||
| using Xunit; | ||
|
|
||
| namespace Iot.Device.Common.Tests | ||
| { | ||
| public class DelayHelperTest | ||
| { | ||
| // Timing tests only verify the guaranteed lower bound (the helper waits for *at least* the | ||
| // requested time). A small, consistent tolerance absorbs the resolution of the underlying | ||
| // timer and the conversion between Stopwatch ticks and TimeSpan ticks. | ||
| private static readonly TimeSpan Tolerance = TimeSpan.FromMilliseconds(1); | ||
|
|
||
| [Theory] | ||
| [InlineData(true)] | ||
| [InlineData(false)] | ||
| public void DelayWaitsAtLeastTheRequestedTime(bool allowThreadYield) | ||
| { | ||
| TimeSpan requested = TimeSpan.FromMilliseconds(20); | ||
|
|
||
| Stopwatch stopwatch = Stopwatch.StartNew(); | ||
| DelayHelper.Delay(requested, allowThreadYield); | ||
| stopwatch.Stop(); | ||
|
|
||
| Assert.True( | ||
| stopwatch.Elapsed >= requested - Tolerance, | ||
| $"Expected to wait at least {requested.TotalMilliseconds}ms but only waited {stopwatch.Elapsed.TotalMilliseconds}ms."); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void DelayMicrosecondsWaitsAtLeastTheRequestedTime() | ||
| { | ||
| const int microseconds = 5000; // 5ms | ||
| TimeSpan requested = TimeSpan.FromMilliseconds(5); | ||
|
|
||
| Stopwatch stopwatch = Stopwatch.StartNew(); | ||
| DelayHelper.DelayMicroseconds(microseconds, allowThreadYield: true); | ||
| stopwatch.Stop(); | ||
|
|
||
| Assert.True( | ||
| stopwatch.Elapsed >= requested - Tolerance, | ||
| $"Expected to wait at least {requested.TotalMilliseconds}ms but only waited {stopwatch.Elapsed.TotalMilliseconds}ms."); | ||
| } | ||
| } | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot changing the namespace without moving the helper in the other assembly raise a problem in terms of binary compatibility for the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed — once
Iot.Device.DelayHelperships as public API ofIot.Device.Bindings, it's locked into that assembly. It can't be forwarded toSystem.Device.Gpiolater (the dependency runs the other way, and the namespace differs), so honoring the original issue ("part ofSystem.Device.Gpio") would then be a binary-breaking change.The clean fix is to give it its permanent home now, before it's public: move
DelayHelperinto theSystem.Device.Gpioproject with theSystem.Devicenamespace (where it already lives today), and drop the namespace change toIot.Device. That does conflict with the earlier triage note to keep it inIot.Device.Bindings, so I don't want to move assemblies unilaterally.Which assembly should be the final home —
System.Device.Gpio(matches the issue, avoids the compat trap) orIot.Device.Bindings(earlier triage)? I'll implement whichever you confirm.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raffaeler As we don't have any plans in moving stuff from Iot.Device.Bindings to System.Device in the near future, I guess the Iot.Device namespace is the better one for this.