Merge pull request #3023 from dotnet-maestro-bot/merge/release/2.2-to-master
[automated] Merge branch 'release/2.2' => 'master'
This commit is contained in:
commit
370702f1a2
207
LICENSE.txt
207
LICENSE.txt
|
|
@ -1,14 +1,201 @@
|
||||||
Copyright (c) .NET Foundation and Contributors
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
All rights reserved.
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
1. Definitions.
|
||||||
this file except in compliance with the License. You may obtain a copy of the
|
|
||||||
License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software distributed
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
the copyright owner that is granting the License.
|
||||||
CONDITIONS OF ANY KIND, either express or implied. See the License for the
|
|
||||||
specific language governing permissions and limitations under the License.
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright (c) .NET Foundation and Contributors
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
|
||||||
|
|
@ -118,10 +118,13 @@ public class HubConnection {
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
private NegotiateResponse handleNegotiate() throws IOException {
|
private NegotiateResponse handleNegotiate() throws IOException, HubException {
|
||||||
accessToken = (negotiateResponse == null) ? null : negotiateResponse.getAccessToken();
|
accessToken = (negotiateResponse == null) ? null : negotiateResponse.getAccessToken();
|
||||||
negotiateResponse = Negotiate.processNegotiate(url, accessToken);
|
negotiateResponse = Negotiate.processNegotiate(url, accessToken);
|
||||||
|
|
||||||
|
if (negotiateResponse.getError() != null) {
|
||||||
|
throw new HubException(negotiateResponse.getError());
|
||||||
|
}
|
||||||
if (negotiateResponse.getConnectionId() != null) {
|
if (negotiateResponse.getConnectionId() != null) {
|
||||||
if (url.contains("?")) {
|
if (url.contains("?")) {
|
||||||
url = url + "&id=" + negotiateResponse.getConnectionId();
|
url = url + "&id=" + negotiateResponse.getConnectionId();
|
||||||
|
|
|
||||||
|
|
@ -3,34 +3,74 @@
|
||||||
|
|
||||||
package com.microsoft.aspnet.signalr;
|
package com.microsoft.aspnet.signalr;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.StringReader;
|
||||||
import java.util.HashSet;
|
import java.util.HashSet;
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
|
|
||||||
import com.google.gson.JsonArray;
|
import com.google.gson.stream.JsonReader;
|
||||||
import com.google.gson.JsonObject;
|
|
||||||
import com.google.gson.JsonParser;
|
|
||||||
|
|
||||||
class NegotiateResponse {
|
class NegotiateResponse {
|
||||||
private String connectionId;
|
private String connectionId;
|
||||||
private Set<String> availableTransports = new HashSet<>();
|
private Set<String> availableTransports = new HashSet<>();
|
||||||
private String redirectUrl;
|
private String redirectUrl;
|
||||||
private String accessToken;
|
private String accessToken;
|
||||||
private JsonParser jsonParser = new JsonParser();
|
private String error;
|
||||||
|
|
||||||
public NegotiateResponse(String negotiatePayload) {
|
public NegotiateResponse(String negotiatePayload) throws IOException {
|
||||||
JsonObject negotiateResponse = jsonParser.parse(negotiatePayload).getAsJsonObject();
|
JsonReader reader = new JsonReader(new StringReader(negotiatePayload));
|
||||||
if (negotiateResponse.has("url")) {
|
reader.beginObject();
|
||||||
this.redirectUrl = negotiateResponse.get("url").getAsString();
|
|
||||||
if (negotiateResponse.has("accessToken")) {
|
do {
|
||||||
this.accessToken = negotiateResponse.get("accessToken").getAsString();
|
String name = reader.nextName();
|
||||||
|
switch (name) {
|
||||||
|
case "error":
|
||||||
|
this.error = reader.nextString();
|
||||||
|
break;
|
||||||
|
case "url":
|
||||||
|
this.redirectUrl = reader.nextString();
|
||||||
|
break;
|
||||||
|
case "accessToken":
|
||||||
|
this.accessToken = reader.nextString();
|
||||||
|
break;
|
||||||
|
case "availableTransports":
|
||||||
|
reader.beginArray();
|
||||||
|
while (reader.hasNext()) {
|
||||||
|
reader.beginObject();
|
||||||
|
while (reader.hasNext()) {
|
||||||
|
String transport = null;
|
||||||
|
String property = reader.nextName();
|
||||||
|
switch (property) {
|
||||||
|
case "transport":
|
||||||
|
transport = reader.nextString();
|
||||||
|
break;
|
||||||
|
case "transferFormats":
|
||||||
|
// transfer formats aren't supported currently
|
||||||
|
reader.skipValue();
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
// Skip unknown property, allows new clients to still work with old protocols
|
||||||
|
reader.skipValue();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
this.availableTransports.add(transport);
|
||||||
|
}
|
||||||
|
reader.endObject();
|
||||||
|
}
|
||||||
|
reader.endArray();
|
||||||
|
break;
|
||||||
|
case "connectionId":
|
||||||
|
this.connectionId = reader.nextString();
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
// Skip unknown property, allows new clients to still work with old protocols
|
||||||
|
reader.skipValue();
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
return;
|
} while (reader.hasNext());
|
||||||
}
|
|
||||||
this.connectionId = negotiateResponse.get("connectionId").getAsString();
|
reader.endObject();
|
||||||
JsonArray transports = (JsonArray) negotiateResponse.get("availableTransports");
|
reader.close();
|
||||||
for (int i = 0; i < transports.size(); i++) {
|
|
||||||
availableTransports.add(transports.get(i).getAsJsonObject().get("transport").getAsString());
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public String getConnectionId() {
|
public String getConnectionId() {
|
||||||
|
|
@ -48,4 +88,8 @@ class NegotiateResponse {
|
||||||
public String getAccessToken() {
|
public String getAccessToken() {
|
||||||
return accessToken;
|
return accessToken;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public String getError() {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -5,13 +5,14 @@ package com.microsoft.aspnet.signalr;
|
||||||
|
|
||||||
import static org.junit.jupiter.api.Assertions.*;
|
import static org.junit.jupiter.api.Assertions.*;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
|
|
||||||
|
|
||||||
class NegotiateResponseTest {
|
class NegotiateResponseTest {
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
public void VerifyNegotiateResponse() {
|
public void VerifyNegotiateResponse() throws IOException {
|
||||||
String stringNegotiateResponse = "{\"connectionId\":\"bVOiRPG8-6YiJ6d7ZcTOVQ\",\"" +
|
String stringNegotiateResponse = "{\"connectionId\":\"bVOiRPG8-6YiJ6d7ZcTOVQ\",\"" +
|
||||||
"availableTransports\":[{\"transport\":\"WebSockets\",\"transferFormats\":[\"Text\",\"Binary\"]}," +
|
"availableTransports\":[{\"transport\":\"WebSockets\",\"transferFormats\":[\"Text\",\"Binary\"]}," +
|
||||||
"{\"transport\":\"ServerSentEvents\",\"transferFormats\":[\"Text\"]}," +
|
"{\"transport\":\"ServerSentEvents\",\"transferFormats\":[\"Text\"]}," +
|
||||||
|
|
@ -26,7 +27,7 @@ class NegotiateResponseTest {
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
public void VerifyRedirectNegotiateResponse() {
|
public void VerifyRedirectNegotiateResponse() throws IOException {
|
||||||
String stringNegotiateResponse = "{\"url\":\"www.example.com\"," +
|
String stringNegotiateResponse = "{\"url\":\"www.example.com\"," +
|
||||||
"\"accessToken\":\"some_access_token\"," +
|
"\"accessToken\":\"some_access_token\"," +
|
||||||
"\"availableTransports\":[]}";
|
"\"availableTransports\":[]}";
|
||||||
|
|
@ -37,4 +38,20 @@ class NegotiateResponseTest {
|
||||||
assertEquals("www.example.com", negotiateResponse.getRedirectUrl());
|
assertEquals("www.example.com", negotiateResponse.getRedirectUrl());
|
||||||
assertNull(negotiateResponse.getConnectionId());
|
assertNull(negotiateResponse.getConnectionId());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void NegotiateResponseIgnoresExtraProperties() throws IOException {
|
||||||
|
String stringNegotiateResponse = "{\"connectionId\":\"bVOiRPG8-6YiJ6d7ZcTOVQ\"," +
|
||||||
|
"\"extra\":\"something\"}";
|
||||||
|
NegotiateResponse negotiateResponse = new NegotiateResponse(stringNegotiateResponse);
|
||||||
|
assertEquals("bVOiRPG8-6YiJ6d7ZcTOVQ", negotiateResponse.getConnectionId());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void NegotiateResponseIgnoresExtraComplexProperties() throws IOException {
|
||||||
|
String stringNegotiateResponse = "{\"connectionId\":\"bVOiRPG8-6YiJ6d7ZcTOVQ\"," +
|
||||||
|
"\"extra\":[\"something\"]}";
|
||||||
|
NegotiateResponse negotiateResponse = new NegotiateResponse(stringNegotiateResponse);
|
||||||
|
assertEquals("bVOiRPG8-6YiJ6d7ZcTOVQ", negotiateResponse.getConnectionId());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -25,6 +25,7 @@ export interface INegotiateResponse {
|
||||||
availableTransports?: IAvailableTransport[];
|
availableTransports?: IAvailableTransport[];
|
||||||
url?: string;
|
url?: string;
|
||||||
accessToken?: string;
|
accessToken?: string;
|
||||||
|
error?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @private */
|
/** @private */
|
||||||
|
|
@ -169,6 +170,10 @@ export class HttpConnection implements IConnection {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (negotiateResponse.error) {
|
||||||
|
throw Error(negotiateResponse.error);
|
||||||
|
}
|
||||||
|
|
||||||
if ((negotiateResponse as any).ProtocolVersion) {
|
if ((negotiateResponse as any).ProtocolVersion) {
|
||||||
throw Error("Detected a connection attempt to an ASP.NET SignalR Server. This client only supports connecting to an ASP.NET Core SignalR Server. See https://aka.ms/signalr-core-differences for details.");
|
throw Error("Detected a connection attempt to an ASP.NET SignalR Server. This client only supports connecting to an ASP.NET Core SignalR Server. See https://aka.ms/signalr-core-differences for details.");
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -554,6 +554,26 @@ describe("HttpConnection", () => {
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("throws error if negotiate response has error", async () => {
|
||||||
|
await VerifyLogger.run(async (logger) => {
|
||||||
|
const httpClient = new TestHttpClient()
|
||||||
|
.on("POST", /negotiate$/, () => ({ error: "Negotiate error." }));
|
||||||
|
|
||||||
|
const options: IHttpConnectionOptions = {
|
||||||
|
...commonOptions,
|
||||||
|
httpClient,
|
||||||
|
logger,
|
||||||
|
transport: HttpTransportType.LongPolling,
|
||||||
|
} as IHttpConnectionOptions;
|
||||||
|
|
||||||
|
const connection = new HttpConnection("http://tempuri.org", options);
|
||||||
|
await expect(connection.start(TransferFormat.Text))
|
||||||
|
.rejects
|
||||||
|
.toThrow("Negotiate error.");
|
||||||
|
},
|
||||||
|
"Failed to start the connection: Error: Negotiate error.");
|
||||||
|
});
|
||||||
|
|
||||||
it("authorization header removed when token factory returns null and using LongPolling", async () => {
|
it("authorization header removed when token factory returns null and using LongPolling", async () => {
|
||||||
await VerifyLogger.run(async (logger) => {
|
await VerifyLogger.run(async (logger) => {
|
||||||
const availableTransport = { transport: "LongPolling", transferFormats: ["Text"] };
|
const availableTransport = { transport: "LongPolling", transferFormats: ["Text"] };
|
||||||
|
|
|
||||||
|
|
@ -18,13 +18,13 @@ Throughout this document, the term `[endpoint-base]` is used to refer to the rou
|
||||||
|
|
||||||
## `POST [endpoint-base]/negotiate` request
|
## `POST [endpoint-base]/negotiate` request
|
||||||
|
|
||||||
The `POST [endpoint-base]/negotiate` request is used to establish a connection between the client and the server. The content type of the response is `application/json`. The response to the `POST [endpoint-base]/negotiate` request contains one of two types of responses:
|
The `POST [endpoint-base]/negotiate` request is used to establish a connection between the client and the server. The content type of the response is `application/json`. The response to the `POST [endpoint-base]/negotiate` request contains one of three types of responses:
|
||||||
|
|
||||||
1. A response that contains the `id` which will be used to identify the connection on the server and the list of the transports supported by the server.
|
1. A response that contains the `connectionId` which will be used to identify the connection on the server and the list of the transports supported by the server.
|
||||||
|
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
"id":"807809a5-31bf-470d-9e23-afaee35d8a0d",
|
"connectionId":"807809a5-31bf-470d-9e23-afaee35d8a0d",
|
||||||
"availableTransports":[
|
"availableTransports":[
|
||||||
{
|
{
|
||||||
"transport": "WebSockets",
|
"transport": "WebSockets",
|
||||||
|
|
@ -44,7 +44,7 @@ The `POST [endpoint-base]/negotiate` request is used to establish a connection b
|
||||||
|
|
||||||
The payload returned from this endpoint provides the following data:
|
The payload returned from this endpoint provides the following data:
|
||||||
|
|
||||||
* The `id` which is **required** by the Long Polling and Server-Sent Events transports (in order to correlate sends and receives).
|
* The `connectionId` which is **required** by the Long Polling and Server-Sent Events transports (in order to correlate sends and receives).
|
||||||
* The `availableTransports` list which describes the transports the server supports. For each transport, the name of the transport (`transport`) is listed, as is a list of "transfer formats" supported by the transport (`transferFormats`)
|
* The `availableTransports` list which describes the transports the server supports. For each transport, the name of the transport (`transport`) is listed, as is a list of "transfer formats" supported by the transport (`transferFormats`)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -62,6 +62,19 @@ The `POST [endpoint-base]/negotiate` request is used to establish a connection b
|
||||||
* The `url` which is the URL the client should connect to.
|
* The `url` which is the URL the client should connect to.
|
||||||
* The `accessToken` which is an optional bearer token for accessing the specified url.
|
* The `accessToken` which is an optional bearer token for accessing the specified url.
|
||||||
|
|
||||||
|
|
||||||
|
3. A response that contains an `error` which should stop the connection attempt.
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"error": "This connection is not allowed."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The payload returned from this endpoint provides the following data:
|
||||||
|
|
||||||
|
* The `error` that gives details about why the negotiate failed.
|
||||||
|
|
||||||
## Transfer Formats
|
## Transfer Formats
|
||||||
|
|
||||||
ASP.NET Endpoints support two different transfer formats: `Text` and `Binary`. `Text` refers to UTF-8 text, and `Binary` refers to any arbitrary binary data. The transfer format serves two purposes. First, in the WebSockets transport, it is used to determine if `Text` or `Binary` WebSocket frames should be used to carry data. This is useful in debugging as most browser Dev Tools only show the content of `Text` frames. When using a text-based protocol like JSON, it is preferable for the WebSockets transport to use `Text` frames. How a client/server indicate the transfer format currently being used is implementation-defined.
|
ASP.NET Endpoints support two different transfer formats: `Text` and `Binary`. `Text` refers to UTF-8 text, and `Binary` refers to any arbitrary binary data. The transfer format serves two purposes. First, in the WebSockets transport, it is used to determine if `Text` or `Binary` WebSocket frames should be used to carry data. This is useful in debugging as most browser Dev Tools only show the content of `Text` frames. When using a text-based protocol like JSON, it is preferable for the WebSockets transport to use `Text` frames. How a client/server indicate the transfer format currently being used is implementation-defined.
|
||||||
|
|
|
||||||
|
|
@ -169,9 +169,9 @@ namespace Microsoft.AspNetCore.Http.Connections.Client
|
||||||
/// A connection cannot be restarted after it has stopped. To restart a connection
|
/// A connection cannot be restarted after it has stopped. To restart a connection
|
||||||
/// a new instance should be created using the same options.
|
/// a new instance should be created using the same options.
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
public async Task StartAsync(CancellationToken cancellationToken = default)
|
public Task StartAsync(CancellationToken cancellationToken = default)
|
||||||
{
|
{
|
||||||
await StartAsync(TransferFormat.Binary, cancellationToken);
|
return StartAsync(TransferFormat.Binary, cancellationToken);
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
@ -428,6 +428,10 @@ namespace Microsoft.AspNetCore.Http.Connections.Client
|
||||||
{
|
{
|
||||||
negotiateResponse = NegotiateProtocol.ParseResponse(responseStream);
|
negotiateResponse = NegotiateProtocol.ParseResponse(responseStream);
|
||||||
}
|
}
|
||||||
|
if (!string.IsNullOrEmpty(negotiateResponse.Error))
|
||||||
|
{
|
||||||
|
throw new Exception(negotiateResponse.Error);
|
||||||
|
}
|
||||||
Log.ConnectionEstablished(_logger, negotiateResponse.ConnectionId);
|
Log.ConnectionEstablished(_logger, negotiateResponse.ConnectionId);
|
||||||
return negotiateResponse;
|
return negotiateResponse;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -18,6 +18,7 @@ namespace Microsoft.AspNetCore.Http.Connections
|
||||||
private const string AvailableTransportsPropertyName = "availableTransports";
|
private const string AvailableTransportsPropertyName = "availableTransports";
|
||||||
private const string TransportPropertyName = "transport";
|
private const string TransportPropertyName = "transport";
|
||||||
private const string TransferFormatsPropertyName = "transferFormats";
|
private const string TransferFormatsPropertyName = "transferFormats";
|
||||||
|
private const string ErrorPropertyName = "error";
|
||||||
// Used to detect ASP.NET SignalR Server connection attempt
|
// Used to detect ASP.NET SignalR Server connection attempt
|
||||||
private const string ProtocolVersionPropertyName = "ProtocolVersion";
|
private const string ProtocolVersionPropertyName = "ProtocolVersion";
|
||||||
|
|
||||||
|
|
@ -99,6 +100,7 @@ namespace Microsoft.AspNetCore.Http.Connections
|
||||||
string url = null;
|
string url = null;
|
||||||
string accessToken = null;
|
string accessToken = null;
|
||||||
List<AvailableTransport> availableTransports = null;
|
List<AvailableTransport> availableTransports = null;
|
||||||
|
string error = null;
|
||||||
|
|
||||||
var completed = false;
|
var completed = false;
|
||||||
while (!completed && JsonUtils.CheckRead(reader))
|
while (!completed && JsonUtils.CheckRead(reader))
|
||||||
|
|
@ -136,6 +138,9 @@ namespace Microsoft.AspNetCore.Http.Connections
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
|
case ErrorPropertyName:
|
||||||
|
error = JsonUtils.ReadAsString(reader, ErrorPropertyName);
|
||||||
|
break;
|
||||||
case ProtocolVersionPropertyName:
|
case ProtocolVersionPropertyName:
|
||||||
throw new InvalidOperationException("Detected a connection attempt to an ASP.NET SignalR Server. This client only supports connecting to an ASP.NET Core SignalR Server. See https://aka.ms/signalr-core-differences for details.");
|
throw new InvalidOperationException("Detected a connection attempt to an ASP.NET SignalR Server. This client only supports connecting to an ASP.NET Core SignalR Server. See https://aka.ms/signalr-core-differences for details.");
|
||||||
default:
|
default:
|
||||||
|
|
@ -151,9 +156,9 @@ namespace Microsoft.AspNetCore.Http.Connections
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (url == null)
|
if (url == null && error == null)
|
||||||
{
|
{
|
||||||
// if url isn't specified, connectionId and available transports are required
|
// if url isn't specified or there isn't an error, connectionId and available transports are required
|
||||||
if (connectionId == null)
|
if (connectionId == null)
|
||||||
{
|
{
|
||||||
throw new InvalidDataException($"Missing required property '{ConnectionIdPropertyName}'.");
|
throw new InvalidDataException($"Missing required property '{ConnectionIdPropertyName}'.");
|
||||||
|
|
@ -170,7 +175,8 @@ namespace Microsoft.AspNetCore.Http.Connections
|
||||||
ConnectionId = connectionId,
|
ConnectionId = connectionId,
|
||||||
Url = url,
|
Url = url,
|
||||||
AccessToken = accessToken,
|
AccessToken = accessToken,
|
||||||
AvailableTransports = availableTransports
|
AvailableTransports = availableTransports,
|
||||||
|
Error = error,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -11,5 +11,6 @@ namespace Microsoft.AspNetCore.Http.Connections
|
||||||
public string AccessToken { get; set; }
|
public string AccessToken { get; set; }
|
||||||
public string ConnectionId { get; set; }
|
public string ConnectionId { get; set; }
|
||||||
public IList<AvailableTransport> AvailableTransports { get; set; }
|
public IList<AvailableTransport> AvailableTransports { get; set; }
|
||||||
|
public string Error { get; set; }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -8,8 +8,10 @@ using System.Net.Http;
|
||||||
using System.Threading.Tasks;
|
using System.Threading.Tasks;
|
||||||
using Microsoft.AspNetCore.Connections;
|
using Microsoft.AspNetCore.Connections;
|
||||||
using Microsoft.AspNetCore.Http.Connections;
|
using Microsoft.AspNetCore.Http.Connections;
|
||||||
|
using Microsoft.AspNetCore.Http.Connections.Client;
|
||||||
using Microsoft.AspNetCore.Http.Connections.Client.Internal;
|
using Microsoft.AspNetCore.Http.Connections.Client.Internal;
|
||||||
using Microsoft.AspNetCore.SignalR.Tests;
|
using Microsoft.AspNetCore.SignalR.Tests;
|
||||||
|
using Microsoft.Extensions.Logging.Testing;
|
||||||
using Moq;
|
using Moq;
|
||||||
using Newtonsoft.Json;
|
using Newtonsoft.Json;
|
||||||
using Xunit;
|
using Xunit;
|
||||||
|
|
@ -380,6 +382,37 @@ namespace Microsoft.AspNetCore.SignalR.Client.Tests
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[Fact]
|
||||||
|
public async Task NegotiateThatReturnsErrorThrowsFromStart()
|
||||||
|
{
|
||||||
|
bool ExpectedError(WriteContext writeContext)
|
||||||
|
{
|
||||||
|
return writeContext.LoggerName == typeof(HttpConnection).FullName &&
|
||||||
|
writeContext.EventId.Name == "ErrorWithNegotiation";
|
||||||
|
}
|
||||||
|
|
||||||
|
var testHttpHandler = new TestHttpMessageHandler(autoNegotiate: false);
|
||||||
|
testHttpHandler.OnNegotiate((request, cancellationToken) =>
|
||||||
|
{
|
||||||
|
return ResponseUtils.CreateResponse(HttpStatusCode.OK,
|
||||||
|
JsonConvert.SerializeObject(new
|
||||||
|
{
|
||||||
|
error = "Test error."
|
||||||
|
}));
|
||||||
|
});
|
||||||
|
|
||||||
|
using (var noErrorScope = new VerifyNoErrorsScope(expectedErrorsFilter: ExpectedError))
|
||||||
|
{
|
||||||
|
await WithConnectionAsync(
|
||||||
|
CreateConnection(testHttpHandler, loggerFactory: noErrorScope.LoggerFactory),
|
||||||
|
async (connection) =>
|
||||||
|
{
|
||||||
|
var exception = await Assert.ThrowsAsync<Exception>(() => connection.StartAsync(TransferFormat.Text).OrTimeout());
|
||||||
|
Assert.Equal("Test error.", exception.Message);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
private async Task RunInvalidNegotiateResponseTest<TException>(string negotiatePayload, string expectedExceptionMessage) where TException : Exception
|
private async Task RunInvalidNegotiateResponseTest<TException>(string negotiatePayload, string expectedExceptionMessage) where TException : Exception
|
||||||
{
|
{
|
||||||
var testHttpHandler = new TestHttpMessageHandler(autoNegotiate: false);
|
var testHttpHandler = new TestHttpMessageHandler(autoNegotiate: false);
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue