Skip to content

Added check to allow non spec compliant consumers to send us null for… #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 10, 2018
Merged

Added check to allow non spec compliant consumers to send us null for… #57

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
201d765
Added check to allow non spec compliant consumers to send us null for…
david-driscoll Jan 10, 2018
3d1e56d
shutdown is a request, not a notification
david-driscoll Jan 10, 2018
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/JsonRpc/Reciever.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,18 @@ protected virtual Renor GetRenor(JToken @object)
}

var hasParams = request.TryGetValue("params", out var @params);
if (hasParams && @params?.Type != JTokenType.Array && @params?.Type != JTokenType.Object)
if (hasParams && @params?.Type != JTokenType.Array && @params?.Type != JTokenType.Object && @params?.Type != JTokenType.Null)
{
return new InvalidRequest(requestId, "Invalid params");
}

// Special case params such that if we get a null value (from a non spec compliant system)
// that we don't fall over and throw an error.
if (@params?.Type == JTokenType.Null)
Copy link
Collaborator

@tintoy tintoy Jan 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch - I would have forgotten to do this bit :)
Copy link
Member Author

@david-driscoll david-driscoll Jan 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah we don't want to try to deserialize the value.
{
@params = null;
}

// id == request
// !id == notification
if (!hasRequestId)
Expand Down
33 changes: 31 additions & 2 deletions test/JsonRpc.Tests/Server/SpecifictionRecieverTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using System;
using System;
using System.Collections.Generic;
using System.Linq;
using FluentAssertions;
Expand Down Expand Up @@ -56,6 +56,24 @@ public override IEnumerable<ValueTuple<string, Renor[]>> GetValues()
new Request(4, "subtract", JObject.FromObject(new {minuend = 42, subtrahend = 23}))
});

yield return (
@"{""jsonrpc"": ""2.0"", ""method"": ""subtract"", ""id"": 4}",
new Renor[]
{
new Request(4, "subtract", null)
});

// http://www.jsonrpc.org/specification says:
// If present, parameters for the rpc call MUST be provided as a Structured value.
// Some clients may serialize params as null, instead of omitting it
// We're going to pretend we never got the null in the first place.
yield return (
@"{""jsonrpc"": ""2.0"", ""method"": ""subtract"", ""params"": null, ""id"": 4}",
new Renor[]
{
new Request(4, "subtract", null)
});

yield return (
@"{""jsonrpc"": ""2.0"", ""method"": ""update"", ""params"": [1,2,3,4,5]}",
new Renor[]
Expand All @@ -70,6 +88,17 @@ public override IEnumerable<ValueTuple<string, Renor[]>> GetValues()
new Notification("foobar", null)
});

// http://www.jsonrpc.org/specification says:
// If present, parameters for the rpc call MUST be provided as a Structured value.
// Some clients may serialize params as null, instead of omitting it
// We're going to pretend we never got the null in the first place.
yield return (
@"{""jsonrpc"": ""2.0"", ""method"": ""foobar"", ""params"": null}",
new Renor[]
{
new Notification("foobar", null)
});

yield return (
@"{""jsonrpc"": ""2.0"", ""method"": 1, ""params"": ""bar""}",
new Renor[]
Expand Down Expand Up @@ -144,4 +173,4 @@ public override IEnumerable<ValueTuple<string, bool>> GetValues()
}
}
}
}
}