Improve error reporting in DataStreamWebSocketServer
This commit is contained in:
1 parent
43735ed42e
commit
debaaa0d04
4 files changed
+29
-22
No files matched your search
@@ -58,16 +58,15 @@ public class DataStreamWebSocketServer : IDisposable, IAsyncDisposable {
|
||||
async Task onSubscribe(JsonRpcRequest<JsonNode> req, CancellationToken cancellationToken) {
|
||||
ArgumentNullException.ThrowIfNull(req.Id);
|
||||
ArgumentException.ThrowIfNullOrEmpty(req.Method);
|
||||
if (!SubscribeRequest.ParseQuery(req, out var vs, out var subId, out var errMsg, out var errCode)) {
|
||||
logger.LogError("Invalid 'subscribe' request: {Reason}", errMsg);
|
||||
var rpcError = new JsonRpcError<JsonNode>() {
|
||||
Code = (long)errCode,
|
||||
Message = $"{errCode}: {errMsg}",
|
||||
};
|
||||
if (!SubscribeRequest.ParseQuery(req, out var vs, out var subId, out var parseErr, out var errCode)) {
|
||||
logger.LogError("Invalid 'subscribe' request: {Reason}", parseErr);
|
||||
var rpcError = JsonRpcResponse.CreateError<QueryParseError>(
|
||||
req.Id, new() { Code = (long)errCode, Message = "Failed to parse subscription request", Data = parseErr });
|
||||
await send(rpcError, cancellationToken);
|
||||
return;
|
||||
}
|
||||
if (subscriptions.TryGetValue(subId, out var oldSub)) {
|
||||
logger.LogInformation("Disposing existing subscription with id {SubscriptionId}", subId);
|
||||
oldSub.Dispose();
|
||||
}
|
||||
var sub = new DataStreamSubscription(subId, req.Id.Value, vs, webSocket, logger);
|
||||
@@ -90,10 +89,6 @@ public class DataStreamWebSocketServer : IDisposable, IAsyncDisposable {
|
||||
await sendSubscriptionStatus(req.Id.Value, subId, req.Method, SubscriptionStatus.Unsubscribed, cancellationToken);
|
||||
}
|
||||
|
||||
async Task unsubscribe(JsonRpcId requestId, string subscriptionId, CancellationToken cancellationToken) {
|
||||
await sendSubscriptionStatus(requestId, subscriptionId, "unsubscribe", SubscriptionStatus.Unsubscribed, cancellationToken);
|
||||
}
|
||||
|
||||
Task sendSubscriptionStatus(JsonRpcId reqId, string subId, string method, SubscriptionStatus status, CancellationToken cancellationToken) {
|
||||
logger.LogInformation("Sending {Method} ack. SubscriptionId = {SubscriptionId}", method, subId);
|
||||
var response = JsonRpcResponse.Create(reqId, new SubscriptionStatusMessage() {
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
namespace Bts.DataStreamWebApp.Server.Messages;
|
||||
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
public class QueryParseError {
|
||||
[JsonPropertyName("error_message")]
|
||||
public string? ErrorMessage { get; set; }
|
||||
|
||||
[JsonPropertyName("stack_trace")]
|
||||
public List<string>? StackTrace { get; set; }
|
||||
}
|
||||
@@ -18,47 +18,48 @@ public class SubscribeRequest {
|
||||
[JsonPropertyName("subscription_id")]
|
||||
public string? SubscriptionId { get; set; }
|
||||
|
||||
internal static bool ParseQuery(JsonRpcRequest<JsonNode> req, [NotNullWhen(true)] out ViewStream? stream, [NotNullWhen(true)] out string? subscriptionId, [NotNullWhen(false)] out string? errorMessage, out ErrorCode errorCode) {
|
||||
internal static bool ParseQuery(JsonRpcRequest<JsonNode> req, [NotNullWhen(true)] out ViewStream? stream, [NotNullWhen(true)] out string? subscriptionId, [NotNullWhen(false)] out QueryParseError? error, out ErrorCode errorCode) {
|
||||
stream = null;
|
||||
subscriptionId = null;
|
||||
errorCode = ErrorCode.None;
|
||||
var paramsJsonObj = req.Params?.AsObject();
|
||||
error = null;
|
||||
if (paramsJsonObj is null) {
|
||||
errorCode = ErrorCode.InvalidSubscriptionRequest;
|
||||
errorMessage = "'params' object not found";
|
||||
error = new() { ErrorMessage = "'params' object not found" };
|
||||
return false;
|
||||
}
|
||||
var subReq = paramsJsonObj.Deserialize<SubscribeRequest>();
|
||||
if (subReq is null) {
|
||||
errorCode = ErrorCode.InvalidSubscriptionRequest;
|
||||
errorMessage = "'params' object invalid";
|
||||
error = new() { ErrorMessage = "'params' object invalid" };
|
||||
return false;
|
||||
}
|
||||
subscriptionId = subReq.SubscriptionId ?? string.Empty;
|
||||
var query = subReq.Query;
|
||||
if (query is null) {
|
||||
errorCode = ErrorCode.InvalidSubscriptionRequest;
|
||||
errorMessage = "'params.query' field not found (expected a string)";
|
||||
error = new() { ErrorMessage = "'params.query' field not found (expected a string)" };
|
||||
return false;
|
||||
}
|
||||
errorMessage = null;
|
||||
var exp = DataStreamExpressionsInterpreter.Evaluate(query);
|
||||
if (exp is null) {
|
||||
errorCode = ErrorCode.InvalidSubscriptionRequest;
|
||||
errorMessage = "'params.query' expression has invalid syntax";
|
||||
error = new() { ErrorMessage = "'params.query' expression has invalid syntax" };
|
||||
return false;
|
||||
}
|
||||
string? exceptionMsg = null;
|
||||
Exception? exception = null;
|
||||
try {
|
||||
stream = exp.getView(new Dictionary<string, StatementExpression>(0));
|
||||
} catch (Exception ex) {
|
||||
exceptionMsg = ex.ToString();
|
||||
exception = ex;
|
||||
}
|
||||
if (stream is null) {
|
||||
errorCode = ErrorCode.InvalidSubscriptionRequest;
|
||||
errorMessage = "Failed to create ViewStream from 'params.query' expression (check for typos in arguments/typenames)";
|
||||
if (exceptionMsg is not null) {
|
||||
errorMessage += ". Error" + exceptionMsg;
|
||||
error = new() { ErrorMessage = "Failed to create ViewStream from 'params.query' expression (check for typos in arguments/typenames)" };
|
||||
if (exception is not null) {
|
||||
error.ErrorMessage += ". " + exception.Message;
|
||||
error.StackTrace = exception.StackTrace?.Split("\n")?.ToList();
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
@@ -12,7 +12,7 @@ public static class JsonRpcResponse {
|
||||
public static JsonRpcResponse<T, JsonObject?> Create<T>(JsonRpcId id, T result) =>
|
||||
new() { Id = id, Result = result };
|
||||
|
||||
public static JsonRpcResponse<JsonObject?, T> CreateError<T>(JsonRpcId id, JsonRpcError<T> error) =>
|
||||
public static JsonRpcResponse<JsonObject?, T> CreateError<T>(JsonRpcId? id, JsonRpcError<T> error) =>
|
||||
new() { Id = id, Error = error };
|
||||
}
|
||||
|
||||
|
||||
Reference in new issue
Block a user