Contributing: fixed some typos #18494

MaherJendoubi · 2020-01-21T23:44:03Z

deleted some extra spaces
fixed some typos

BrennanConroy · 2020-01-21T23:47:10Z

src/SignalR/common/Http.Connections/ref/Microsoft.AspNetCore.Http.Connections.netcoreapp.cs

@@ -30,7 +30,7 @@ public partial class ConnectionOptions
    }
    public partial class ConnectionOptionsSetup : Microsoft.Extensions.Options.IConfigureOptions<Microsoft.AspNetCore.Http.Connections.ConnectionOptions>
    {
-        public static System.TimeSpan DefaultDisconectTimeout;
+        public static System.TimeSpan DefaultDisconnectTimeout;


Well that's unfortunate...

We can't really change that arbitrarily
cc @anurse

Yeah, unfortunately it's a breaking change. That doesn't mean we can't take it though :). Let's raise this in an API review. I'll set things up for that.

Currently it isn't readonly.

analogrelay · 2020-01-22T04:34:19Z

API Review Summary

Ref Assembly Changes

We have a typo in a public API. The API is a static readonly value that contains the default disconnect timeout value. It's not the API that a user would use to change the timeout value, or to set the timeout value. It's just a constant that a user can use to get our recommended default value.

The disconnect timeout is the amount of time a long-polling connection can be idle for before it will be considered terminated.

Since there's no functional change (it's just a typo in the name) I'm not really sure this meets the bar for breaking changes, but it does suck that we have a typo here :(. The scenarios for consuming this API are fairly minimal. It basically just allows someone to access the original default value even after the value has changed.

MaherJendoubi · 2020-01-22T07:59:04Z

@anurse First, thank you for your precious feedback. I totally agree with you that this change doesn't meet the bar for breaking changes but it could be if you wish an enhancement. I also understand that is not internal but public API. I suggest discarding that change for now.

MaherJendoubi · 2020-01-22T08:21:24Z

@anurse as @campersau said, it is not readonly yet for the DefaultDisconectTimeout and it should be.

analogrelay · 2020-01-22T17:32:30Z

src/SignalR/common/Http.Connections/ref/Microsoft.AspNetCore.Http.Connections.netcoreapp.cs

@@ -30,7 +30,7 @@ public partial class ConnectionOptions
    }
    public partial class ConnectionOptionsSetup : Microsoft.Extensions.Options.IConfigureOptions<Microsoft.AspNetCore.Http.Connections.ConnectionOptions>
    {
-        public static System.TimeSpan DefaultDisconectTimeout;
+        public static readonly System.TimeSpan DefaultDisconectTimeout;


This is also a breaking change. In general, anything that modifies code in a ref/ directory will be a breaking change. I'm a little disappointed this wasn't readonly to begin with but again, we need to be cautious here.

That doesn't mean we can't take it! It just means we have to get some consensus among the team about it.

Can we obsolete the API? This probably should have been internal to begin with.

That's one option. We could just phase it out starting in 5.0.

Let's leave this be. We don't think it's worth while obsoleting or changing this.

Still needs to be reverted.

analogrelay · 2020-01-22T17:33:09Z

@MaherJendoubi I'll bring this up with some other folks on the team to see how they feel (since I don't want to speak unilaterally for the team). I'd like to feel like we can fix typos like this eventually, but of course, we have to balance that against the desire to avoid breaking changes that don't bring value.

The change to make the field readonly (while absolutely correct) is also breaking so we should have a quick conversation about it within the team.

pranavkm · 2020-02-03T18:33:40Z

src/SignalR/common/Http.Connections/ref/Microsoft.AspNetCore.Http.Connections.netcoreapp.cs

@@ -28,9 +28,9 @@ public partial class ConnectionOptions
        public ConnectionOptions() { }
        public System.TimeSpan? DisconnectTimeout { [System.Runtime.CompilerServices.CompilerGeneratedAttribute] get { throw null; } [System.Runtime.CompilerServices.CompilerGeneratedAttribute] set { } }
    }
-    public partial class ConnectionOptionsSetup : Microsoft.Extensions.Options.IConfigureOptions<Microsoft.AspNetCore.Http.Connections.ConnectionOptions>
+    internal partial class ConnectionOptionsSetup : Microsoft.Extensions.Options.IConfigureOptions<Microsoft.AspNetCore.Http.Connections.ConnectionOptions>


This would need to be undone.

I reverted that change.

pranavkm · 2020-02-03T18:34:02Z

src/SignalR/common/Http.Connections/ref/Microsoft.AspNetCore.Http.Connections.netcoreapp.cs

@@ -30,7 +30,7 @@ public partial class ConnectionOptions
    }
    public partial class ConnectionOptionsSetup : Microsoft.Extensions.Options.IConfigureOptions<Microsoft.AspNetCore.Http.Connections.ConnectionOptions>
    {
-        public static System.TimeSpan DefaultDisconectTimeout;
+        public static readonly System.TimeSpan DefaultDisconectTimeout;


Let's leave this be. We don't think it's worth while obsoleting or changing this.

This reverts commit 90f94d2.

Tratcher · 2020-02-14T19:24:00Z

src/SignalR/common/Http.Connections/src/Internal/HttpConnectionDispatcher.Log.cs

@@ -44,7 +44,7 @@ internal static class Log
                LoggerMessage.Define<HttpTransportType>(LogLevel.Trace, new EventId(11, "ReceivedDeleteRequestForUnsupportedTransport"), "Received DELETE request for unsupported transport: {TransportType}.");

            private static readonly Action<ILogger, Exception> _terminatingConnection =
-                LoggerMessage.Define(LogLevel.Trace, new EventId(12, "TerminatingConection"), "Terminating Long Polling connection due to a DELETE request.");
+                LoggerMessage.Define(LogLevel.Trace, new EventId(12, "TerminatingConnection"), "Terminating Long Polling connection due to a DELETE request.");


Log IDs can't be changed, they're effectively public.

I have just reverted it.

BrennanConroy · 2020-02-18T16:15:00Z

src/SignalR/common/Http.Connections/src/ConnectionOptionsSetup.cs

@@ -8,7 +8,7 @@ namespace Microsoft.AspNetCore.Http.Connections
 {
    public class ConnectionOptionsSetup : IConfigureOptions<ConnectionOptions>
    {
-        public static TimeSpan DefaultDisconectTimeout = TimeSpan.FromSeconds(15);
+        public static readonly TimeSpan DefaultDisconectTimeout = TimeSpan.FromSeconds(15);


src/SignalR/common/Http.Connections/ref/Microsoft.AspNetCore.Http.Connections.netcoreapp.cs

src/SignalR/common/Http.Connections/src/ConnectionOptionsSetup.cs

ghost · 2020-02-25T01:16:01Z

Hello @BrennanConroy!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

BrennanConroy · 2020-02-25T02:29:34Z

Thanks for the contribution @MaherJendoubi !

Contributing: fixed some typos

c91d4f0

MaherJendoubi requested review from analogrelay, BrennanConroy, halter73 and Tratcher as code owners January 21, 2020 23:44

BrennanConroy reviewed Jan 21, 2020

View reviewed changes

analogrelay added api-ready-for-review API is ready for formal API review - https://github.com/dotnet/apireviews area-signalr Includes: SignalR clients and servers labels Jan 22, 2020

Spotted another typo

272e9be

this will cause a breaking change

4bab07d

made DefaultDisconetTimout readonly

1696e09

analogrelay reviewed Jan 22, 2020

View reviewed changes

made ConnectionOptionsSetup class internal

90f94d2

pranavkm reviewed Feb 3, 2020

View reviewed changes

pranavkm added api-approved API was approved in API review, it can be implemented and removed api-ready-for-review API is ready for formal API review - https://github.com/dotnet/apireviews labels Feb 3, 2020

Revert "made ConnectionOptionsSetup class internal"

62decb8

This reverts commit 90f94d2.

Tratcher reviewed Feb 14, 2020

View reviewed changes

Update HttpConnectionDispatcher.Log.cs

c46f84d

BrennanConroy reviewed Feb 18, 2020

View reviewed changes

halter73 assigned BrennanConroy Feb 24, 2020

BrennanConroy reviewed Feb 25, 2020

View reviewed changes

src/SignalR/common/Http.Connections/ref/Microsoft.AspNetCore.Http.Connections.netcoreapp.cs Outdated Show resolved Hide resolved

src/SignalR/common/Http.Connections/src/ConnectionOptionsSetup.cs Outdated Show resolved Hide resolved

Apply suggestions from code review

a18a927

BrennanConroy approved these changes Feb 25, 2020

View reviewed changes

BrennanConroy removed the api-approved API was approved in API review, it can be implemented label Feb 25, 2020

BrennanConroy added this to the 5.0.0-preview2 milestone Feb 25, 2020

BrennanConroy added the auto-merge label Feb 25, 2020

ghost merged commit 1a4dbb7 into dotnet:master Feb 25, 2020

MaherJendoubi deleted the misc-misspellings branch February 25, 2020 05:41

BrennanConroy mentioned this pull request Mar 2, 2021

fix 'conect' typo #30558

Closed

martincostello mentioned this pull request Apr 22, 2024

Add unit to execution time in telemetry events App-vNext/Polly#2069

Merged

4 tasks

This pull request was closed.

Contributing: fixed some typos #18494

Contributing: fixed some typos #18494

Uh oh!

Conversation

MaherJendoubi commented Jan 21, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

analogrelay commented Jan 22, 2020

API Review Summary

Uh oh!

MaherJendoubi commented Jan 22, 2020

Uh oh!

MaherJendoubi commented Jan 22, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

analogrelay commented Jan 22, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ghost commented Feb 25, 2020

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

Uh oh!

BrennanConroy commented Feb 25, 2020

Uh oh!

Uh oh!

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.