// Copyright (c) .NET Foundation. All rights reserved. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. import { DataReceived, TransportClosed } from "./Common" import { IHttpClient } from "./HttpClient" import { HttpError } from "./HttpError" import { ILogger, LogLevel } from "./ILogger" import { IConnection } from "./IConnection" export enum TransportType { WebSockets, ServerSentEvents, LongPolling } export const enum TransferMode { Text = 1, Binary } export interface ITransport { connect(url: string, requestedTransferMode: TransferMode, connection: IConnection): Promise; send(data: any): Promise; stop(): void; onreceive: DataReceived; onclose: TransportClosed; } export class WebSocketTransport implements ITransport { private readonly logger: ILogger; private readonly jwtBearer: () => string; private webSocket: WebSocket; constructor(jwtBearer: () => string, logger: ILogger) { this.logger = logger; this.jwtBearer = jwtBearer; } connect(url: string, requestedTransferMode: TransferMode, connection: IConnection): Promise { return new Promise((resolve, reject) => { url = url.replace(/^http/, "ws"); if (this.jwtBearer) { let token = this.jwtBearer(); url += (url.indexOf("?") < 0 ? "?" : "&") + `signalRTokenHeader=${token}`; } let webSocket = new WebSocket(url); if (requestedTransferMode == TransferMode.Binary) { webSocket.binaryType = "arraybuffer"; } webSocket.onopen = (event: Event) => { this.logger.log(LogLevel.Information, `WebSocket connected to ${url}`); this.webSocket = webSocket; resolve(requestedTransferMode); }; webSocket.onerror = (event: Event) => { reject(); }; webSocket.onmessage = (message: MessageEvent) => { this.logger.log(LogLevel.Trace, `(WebSockets transport) data received: ${message.data}`); if (this.onreceive) { this.onreceive(message.data); } } webSocket.onclose = (event: CloseEvent) => { // webSocket will be null if the transport did not start successfully if (this.onclose && this.webSocket) { if (event.wasClean === false || event.code !== 1000) { this.onclose(new Error(`Websocket closed with status code: ${event.code} (${event.reason})`)); } else { this.onclose(); } } } }); } send(data: any): Promise { if (this.webSocket && this.webSocket.readyState === WebSocket.OPEN) { this.webSocket.send(data); return Promise.resolve(); } return Promise.reject("WebSocket is not in the OPEN state"); } stop(): void { if (this.webSocket) { this.webSocket.close(); this.webSocket = null; } } onreceive: DataReceived; onclose: TransportClosed; } export class ServerSentEventsTransport implements ITransport { private readonly httpClient: IHttpClient; private readonly jwtBearer: () => string; private readonly logger: ILogger; private eventSource: EventSource; private url: string; constructor(httpClient: IHttpClient, jwtBearer: () => string, logger: ILogger) { this.httpClient = httpClient; this.jwtBearer = jwtBearer; this.logger = logger; } connect(url: string, requestedTransferMode: TransferMode, connection: IConnection): Promise { if (typeof (EventSource) === "undefined") { Promise.reject("EventSource not supported by the browser."); } this.url = url; return new Promise((resolve, reject) => { if (this.jwtBearer) { let token = this.jwtBearer(); url += (url.indexOf("?") < 0 ? "?" : "&") + `signalRTokenHeader=${token}`; } let eventSource = new EventSource(url); try { eventSource.onmessage = (e: MessageEvent) => { if (this.onreceive) { try { this.logger.log(LogLevel.Trace, `(SSE transport) data received: ${e.data}`); this.onreceive(e.data); } catch (error) { if (this.onclose) { this.onclose(error); } return; } } }; eventSource.onerror = (e: ErrorEvent) => { reject(); // don't report an error if the transport did not start successfully if (this.eventSource && this.onclose) { this.onclose(new Error(e.message || "Error occurred")); } } eventSource.onopen = () => { this.logger.log(LogLevel.Information, `SSE connected to ${this.url}`); this.eventSource = eventSource; // SSE is a text protocol resolve(TransferMode.Text); } } catch (e) { return Promise.reject(e); } }); } async send(data: any): Promise { return send(this.httpClient, this.url, this.jwtBearer, data); } stop(): void { if (this.eventSource) { this.eventSource.close(); this.eventSource = null; } } onreceive: DataReceived; onclose: TransportClosed; } export class LongPollingTransport implements ITransport { private readonly httpClient: IHttpClient; private readonly jwtBearer: () => string; private readonly logger: ILogger; private url: string; private pollXhr: XMLHttpRequest; private shouldPoll: boolean; constructor(httpClient: IHttpClient, jwtBearer: () => string, logger: ILogger) { this.httpClient = httpClient; this.jwtBearer = jwtBearer; this.logger = logger; } connect(url: string, requestedTransferMode: TransferMode, connection: IConnection): Promise { this.url = url; this.shouldPoll = true; // Set a flag indicating we have inherent keep-alive in this transport. connection.features.inherentKeepAlive = true; if (requestedTransferMode === TransferMode.Binary && (typeof new XMLHttpRequest().responseType !== "string")) { // This will work if we fix: https://github.com/aspnet/SignalR/issues/742 throw new Error("Binary protocols over XmlHttpRequest not implementing advanced features are not supported."); } this.poll(this.url, requestedTransferMode); return Promise.resolve(requestedTransferMode); } private poll(url: string, transferMode: TransferMode): void { if (!this.shouldPoll) { return; } let pollXhr = new XMLHttpRequest(); pollXhr.onload = () => { if (pollXhr.status == 200) { if (this.onreceive) { try { let response = transferMode === TransferMode.Text ? pollXhr.responseText : pollXhr.response; if (response) { this.logger.log(LogLevel.Trace, `(LongPolling transport) data received: ${response}`); this.onreceive(response); } else { this.logger.log(LogLevel.Information, "(LongPolling transport) timed out"); } } catch (error) { if (this.onclose) { this.onclose(error); } return; } } this.poll(url, transferMode); } else if (this.pollXhr.status == 204) { if (this.onclose) { this.onclose(); } } else { if (this.onclose) { this.onclose(new HttpError(pollXhr.statusText, pollXhr.status)); } } }; pollXhr.onerror = () => { if (this.onclose) { // network related error or denied cross domain request this.onclose(new Error("Sending HTTP request failed.")); } }; pollXhr.ontimeout = () => { this.poll(url, transferMode); } this.pollXhr = pollXhr; this.pollXhr.open("GET", `${url}&_=${Date.now()}`, true); if (this.jwtBearer) { this.pollXhr.setRequestHeader("Authorization", `Bearer ${this.jwtBearer()}`); } if (transferMode === TransferMode.Binary) { this.pollXhr.responseType = "arraybuffer"; } // TODO: consider making timeout configurable this.pollXhr.timeout = 120000; this.pollXhr.send(); } async send(data: any): Promise { return send(this.httpClient, this.url, this.jwtBearer, data); } stop(): void { this.shouldPoll = false; if (this.pollXhr) { this.pollXhr.abort(); this.pollXhr = null; } } onreceive: DataReceived; onclose: TransportClosed; } async function send(httpClient: IHttpClient, url: string, jwtBearer: () => string, data: any): Promise { let headers; if (jwtBearer) { headers = new Map(); headers.set("Authorization", `Bearer ${jwtBearer()}`) } await httpClient.post(url, data, headers); }