From b088eaa91f78d6fd057edd53a91cdbad09b56f72 Mon Sep 17 00:00:00 2001 From: BrennanConroy Date: Mon, 22 Jan 2018 16:05:51 -0800 Subject: [PATCH] Rename JwtBearer to AccessToken in C# Client (#1333) --- samples/JwtClientSample/Program.cs | 2 +- .../HubConnectionBuilderHttpExtensions.cs | 16 ++++++++-------- .../HttpOptions.cs | 4 ++-- .../SendUtils.cs | 4 ++-- .../WebSocketsTransport.cs | 4 ++-- .../HubConnectionTests.cs | 2 +- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/samples/JwtClientSample/Program.cs b/samples/JwtClientSample/Program.cs index 5f2553645e..a330cbe795 100644 --- a/samples/JwtClientSample/Program.cs +++ b/samples/JwtClientSample/Program.cs @@ -31,7 +31,7 @@ namespace JwtClientSample var hubConnection = new HubConnectionBuilder() .WithUrl(ServerUrl + "/broadcast") .WithTransport(transportType) - .WithJwtBearer(() => _tokens[userId]) + .WithAccessToken(() => _tokens[userId]) .Build(); var closedTcs = new TaskCompletionSource(); diff --git a/src/Microsoft.AspNetCore.SignalR.Client/HubConnectionBuilderHttpExtensions.cs b/src/Microsoft.AspNetCore.SignalR.Client/HubConnectionBuilderHttpExtensions.cs index 1333f83380..93589fee3a 100644 --- a/src/Microsoft.AspNetCore.SignalR.Client/HubConnectionBuilderHttpExtensions.cs +++ b/src/Microsoft.AspNetCore.SignalR.Client/HubConnectionBuilderHttpExtensions.cs @@ -17,7 +17,7 @@ namespace Microsoft.AspNetCore.SignalR.Client public static readonly string TransportTypeKey = "TransportType"; public static readonly string HttpMessageHandlerKey = "HttpMessageHandler"; public static readonly string HeadersKey = "Headers"; - public static readonly string JwtBearerTokenFactoryKey = "JwtBearerTokenFactory"; + public static readonly string AccessTokenFactoryKey = "AccessTokenFactory"; public static readonly string WebSocketOptionsKey = "WebSocketOptions"; public static IHubConnectionBuilder WithUrl(this IHubConnectionBuilder hubConnectionBuilder, string url) @@ -44,7 +44,7 @@ namespace Microsoft.AspNetCore.SignalR.Client { HttpMessageHandler = hubConnectionBuilder.GetMessageHandler(), Headers = headers != null ? new ReadOnlyDictionary(headers) : null, - JwtBearerTokenFactory = hubConnectionBuilder.GetJwtBearerTokenFactory(), + AccessTokenFactory = hubConnectionBuilder.GetAccessTokenFactory(), WebSocketOptions = hubConnectionBuilder.GetWebSocketOptions(), }; @@ -87,14 +87,14 @@ namespace Microsoft.AspNetCore.SignalR.Client return hubConnectionBuilder; } - public static IHubConnectionBuilder WithJwtBearer(this IHubConnectionBuilder hubConnectionBuilder, Func jwtBearerTokenFactory) + public static IHubConnectionBuilder WithAccessToken(this IHubConnectionBuilder hubConnectionBuilder, Func accessTokenFactory) { - if (jwtBearerTokenFactory == null) + if (accessTokenFactory == null) { - throw new ArgumentNullException(nameof(jwtBearerTokenFactory)); + throw new ArgumentNullException(nameof(accessTokenFactory)); } - hubConnectionBuilder.AddSetting(JwtBearerTokenFactoryKey, jwtBearerTokenFactory); + hubConnectionBuilder.AddSetting(AccessTokenFactoryKey, accessTokenFactory); return hubConnectionBuilder; } @@ -137,9 +137,9 @@ namespace Microsoft.AspNetCore.SignalR.Client return null; } - public static Func GetJwtBearerTokenFactory(this IHubConnectionBuilder hubConnectionBuilder) + public static Func GetAccessTokenFactory(this IHubConnectionBuilder hubConnectionBuilder) { - if (hubConnectionBuilder.TryGetSetting>(JwtBearerTokenFactoryKey, out var factory)) + if (hubConnectionBuilder.TryGetSetting>(AccessTokenFactoryKey, out var factory)) { return factory; } diff --git a/src/Microsoft.AspNetCore.Sockets.Client.Http/HttpOptions.cs b/src/Microsoft.AspNetCore.Sockets.Client.Http/HttpOptions.cs index 9dc47da2a2..196ab681cf 100644 --- a/src/Microsoft.AspNetCore.Sockets.Client.Http/HttpOptions.cs +++ b/src/Microsoft.AspNetCore.Sockets.Client.Http/HttpOptions.cs @@ -12,14 +12,14 @@ namespace Microsoft.AspNetCore.Sockets.Client.Http { public HttpMessageHandler HttpMessageHandler { get; set; } public IReadOnlyCollection> Headers { get; set; } - public Func JwtBearerTokenFactory { get; set; } + public Func AccessTokenFactory { get; set; } /// /// Gets or sets a delegate that will be invoked with the object used /// by the to configure the WebSocket. /// /// - /// This delegate is invoked after headers from and the JWT bearer token from + /// This delegate is invoked after headers from and the access token from /// has been applied. /// public Action WebSocketOptions { get; set; } diff --git a/src/Microsoft.AspNetCore.Sockets.Client.Http/SendUtils.cs b/src/Microsoft.AspNetCore.Sockets.Client.Http/SendUtils.cs index 7c5e6b7d1e..0e1771b52c 100644 --- a/src/Microsoft.AspNetCore.Sockets.Client.Http/SendUtils.cs +++ b/src/Microsoft.AspNetCore.Sockets.Client.Http/SendUtils.cs @@ -119,9 +119,9 @@ namespace Microsoft.AspNetCore.Sockets.Client } request.Headers.UserAgent.Add(Constants.UserAgentHeader); - if (httpOptions?.JwtBearerTokenFactory != null) + if (httpOptions?.AccessTokenFactory != null) { - request.Headers.Add("Authorization", $"Bearer {httpOptions.JwtBearerTokenFactory()}"); + request.Headers.Add("Authorization", $"Bearer {httpOptions.AccessTokenFactory()}"); } } } diff --git a/src/Microsoft.AspNetCore.Sockets.Client.Http/WebSocketsTransport.cs b/src/Microsoft.AspNetCore.Sockets.Client.Http/WebSocketsTransport.cs index 377f9c2db6..d1eadab32d 100644 --- a/src/Microsoft.AspNetCore.Sockets.Client.Http/WebSocketsTransport.cs +++ b/src/Microsoft.AspNetCore.Sockets.Client.Http/WebSocketsTransport.cs @@ -44,9 +44,9 @@ namespace Microsoft.AspNetCore.Sockets.Client } } - if (httpOptions?.JwtBearerTokenFactory != null) + if (httpOptions?.AccessTokenFactory != null) { - _webSocket.Options.SetRequestHeader("Authorization", $"Bearer {httpOptions.JwtBearerTokenFactory()}"); + _webSocket.Options.SetRequestHeader("Authorization", $"Bearer {httpOptions.AccessTokenFactory()}"); } httpOptions?.WebSocketOptions?.Invoke(_webSocket.Options); diff --git a/test/Microsoft.AspNetCore.SignalR.Client.FunctionalTests/HubConnectionTests.cs b/test/Microsoft.AspNetCore.SignalR.Client.FunctionalTests/HubConnectionTests.cs index fcf46dbf41..e9aa363f13 100644 --- a/test/Microsoft.AspNetCore.SignalR.Client.FunctionalTests/HubConnectionTests.cs +++ b/test/Microsoft.AspNetCore.SignalR.Client.FunctionalTests/HubConnectionTests.cs @@ -672,7 +672,7 @@ namespace Microsoft.AspNetCore.SignalR.Client.FunctionalTests .WithUrl(_serverFixture.Url + "/authorizedhub") .WithTransport(transportType) .WithLoggerFactory(loggerFactory) - .WithJwtBearer(() => token) + .WithAccessToken(() => token) .Build(); try {