gnezim
119 lines
5.0 KiB
JavaScript
119 lines
5.0 KiB
JavaScript
// Licensed to the .NET Foundation under one or more agreements.
|
|
// The .NET Foundation licenses this file to you under the MIT license.
|
|
import { MessageType } from "./IHubProtocol";
|
|
import { LogLevel } from "./ILogger";
|
|
import { TransferFormat } from "./ITransport";
|
|
import { NullLogger } from "./Loggers";
|
|
import { TextMessageFormat } from "./TextMessageFormat";
|
|
const JSON_HUB_PROTOCOL_NAME = "json";
|
|
/** Implements the JSON Hub Protocol. */
|
|
export class JsonHubProtocol {
|
|
constructor() {
|
|
/** @inheritDoc */
|
|
this.name = JSON_HUB_PROTOCOL_NAME;
|
|
/** @inheritDoc */
|
|
this.version = 2;
|
|
/** @inheritDoc */
|
|
this.transferFormat = TransferFormat.Text;
|
|
}
|
|
/** Creates an array of {@link @microsoft/signalr.HubMessage} objects from the specified serialized representation.
|
|
*
|
|
* @param {string} input A string containing the serialized representation.
|
|
* @param {ILogger} logger A logger that will be used to log messages that occur during parsing.
|
|
*/
|
|
parseMessages(input, logger) {
|
|
// The interface does allow "ArrayBuffer" to be passed in, but this implementation does not. So let's throw a useful error.
|
|
if (typeof input !== "string") {
|
|
throw new Error("Invalid input for JSON hub protocol. Expected a string.");
|
|
}
|
|
if (!input) {
|
|
return [];
|
|
}
|
|
if (logger === null) {
|
|
logger = NullLogger.instance;
|
|
}
|
|
// Parse the messages
|
|
const messages = TextMessageFormat.parse(input);
|
|
const hubMessages = [];
|
|
for (const message of messages) {
|
|
const parsedMessage = JSON.parse(message);
|
|
if (typeof parsedMessage.type !== "number") {
|
|
throw new Error("Invalid payload.");
|
|
}
|
|
switch (parsedMessage.type) {
|
|
case MessageType.Invocation:
|
|
this._isInvocationMessage(parsedMessage);
|
|
break;
|
|
case MessageType.StreamItem:
|
|
this._isStreamItemMessage(parsedMessage);
|
|
break;
|
|
case MessageType.Completion:
|
|
this._isCompletionMessage(parsedMessage);
|
|
break;
|
|
case MessageType.Ping:
|
|
// Single value, no need to validate
|
|
break;
|
|
case MessageType.Close:
|
|
// All optional values, no need to validate
|
|
break;
|
|
case MessageType.Ack:
|
|
this._isAckMessage(parsedMessage);
|
|
break;
|
|
case MessageType.Sequence:
|
|
this._isSequenceMessage(parsedMessage);
|
|
break;
|
|
default:
|
|
// Future protocol changes can add message types, old clients can ignore them
|
|
logger.log(LogLevel.Information, "Unknown message type '" + parsedMessage.type + "' ignored.");
|
|
continue;
|
|
}
|
|
hubMessages.push(parsedMessage);
|
|
}
|
|
return hubMessages;
|
|
}
|
|
/** Writes the specified {@link @microsoft/signalr.HubMessage} to a string and returns it.
|
|
*
|
|
* @param {HubMessage} message The message to write.
|
|
* @returns {string} A string containing the serialized representation of the message.
|
|
*/
|
|
writeMessage(message) {
|
|
return TextMessageFormat.write(JSON.stringify(message));
|
|
}
|
|
_isInvocationMessage(message) {
|
|
this._assertNotEmptyString(message.target, "Invalid payload for Invocation message.");
|
|
if (message.invocationId !== undefined) {
|
|
this._assertNotEmptyString(message.invocationId, "Invalid payload for Invocation message.");
|
|
}
|
|
}
|
|
_isStreamItemMessage(message) {
|
|
this._assertNotEmptyString(message.invocationId, "Invalid payload for StreamItem message.");
|
|
if (message.item === undefined) {
|
|
throw new Error("Invalid payload for StreamItem message.");
|
|
}
|
|
}
|
|
_isCompletionMessage(message) {
|
|
if (message.result && message.error) {
|
|
throw new Error("Invalid payload for Completion message.");
|
|
}
|
|
if (!message.result && message.error) {
|
|
this._assertNotEmptyString(message.error, "Invalid payload for Completion message.");
|
|
}
|
|
this._assertNotEmptyString(message.invocationId, "Invalid payload for Completion message.");
|
|
}
|
|
_isAckMessage(message) {
|
|
if (typeof message.sequenceId !== 'number') {
|
|
throw new Error("Invalid SequenceId for Ack message.");
|
|
}
|
|
}
|
|
_isSequenceMessage(message) {
|
|
if (typeof message.sequenceId !== 'number') {
|
|
throw new Error("Invalid SequenceId for Sequence message.");
|
|
}
|
|
}
|
|
_assertNotEmptyString(value, errorMessage) {
|
|
if (typeof value !== "string" || value === "") {
|
|
throw new Error(errorMessage);
|
|
}
|
|
}
|
|
}
|
|
//# sourceMappingURL=JsonHubProtocol.js.map
|