throw more helpful errors from filtering transformer

Chris Santero · Chris Santero · commit fd406f71f3dd · 2015-12-03T20:18:13.000-05:00
diff --git a/JSONAPI.Tests/ActionFilters/DefaultFilteringTransformerTests.cs b/JSONAPI.Tests/ActionFilters/DefaultFilteringTransformerTests.cs
@@ -9,6 +9,7 @@
 using FluentAssertions;
 using JSONAPI.ActionFilters;
 using JSONAPI.Core;
+using JSONAPI.Documents.Builders;
 using JSONAPI.QueryableTransformers;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
@@ -1147,7 +1148,7 @@ public void Filters_by_missing_nullable_double_property()
         public void Does_not_filter_unknown_type()
         {
             Action action = () => GetArray("http://api.example.com/dummies?filter[unknownTypeField]=asdfasd");
-            action.ShouldThrow<HttpResponseException>().Which.Response.StatusCode.Should().Be(HttpStatusCode.BadRequest);
+            action.ShouldThrow<JsonApiException>().Which.Error.Status.Should().Be(HttpStatusCode.BadRequest);
         }
 
         #endregion
diff --git a/JSONAPI/QueryableTransformers/DefaultFilteringTransformer.cs b/JSONAPI/QueryableTransformers/DefaultFilteringTransformer.cs
@@ -8,6 +8,7 @@
 using System.Web.Http;
 using JSONAPI.ActionFilters;
 using JSONAPI.Core;
+using JSONAPI.Documents.Builders;
 
 namespace JSONAPI.QueryableTransformers
 {
@@ -79,11 +80,14 @@ private Expression GetPredicateBody(HttpRequestMessage request, ParameterExpress
                 }
                 catch (TypeRegistrationNotFoundException)
                 {
-                    throw new HttpResponseException(HttpStatusCode.BadRequest);
+                    throw JsonApiException.CreateForBadRequest("No registration exists for the specified type");
                 }
 
                 var resourceTypeField = registration.GetFieldByName(filterField);
-                
+                if (resourceTypeField == null)
+                    throw JsonApiException.CreateForBadRequest(
+                        string.Format("No attribute {0} exists on the specified type.", filterField));
+
                 var queryValue = queryPair.Value;
                 if (string.IsNullOrWhiteSpace(queryValue))
                     queryValue = null;
@@ -100,7 +104,8 @@ private Expression GetPredicateBody(HttpRequestMessage request, ParameterExpress
                 if (relationshipModelProperty != null)
                     expr = GetPredicateBodyForRelationship(relationshipModelProperty, queryValue, param);
 
-                if (expr == null) throw new HttpResponseException(HttpStatusCode.BadRequest);
+                if (expr == null) throw JsonApiException.CreateForBadRequest(
+                    string.Format("The attribute {0} is unsupported for filtering.", filterField));
 
                 workingExpr = workingExpr == null ? expr : Expression.AndAlso(workingExpr, expr);
             }
@@ -344,7 +349,7 @@ private Expression GetPredicateBodyForRelationship(ResourceTypeRelationship reso
             }
             catch (TypeRegistrationNotFoundException)
             {
-                throw new HttpResponseException(HttpStatusCode.BadRequest);
+                throw JsonApiException.CreateForBadRequest("No registration exists for the specified type");
             }
 
             var prop = resourceTypeProperty.Property;

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`using FluentAssertions;`
`10`	`10`	`using JSONAPI.ActionFilters;`
`11`	`11`	`using JSONAPI.Core;`
	`12`	`+using JSONAPI.Documents.Builders;`
`12`	`13`	`using JSONAPI.QueryableTransformers;`
`13`	`14`	`using Microsoft.VisualStudio.TestTools.UnitTesting;`
`14`	`15`
`@@ -1147,7 +1148,7 @@ public void Filters_by_missing_nullable_double_property()`
`1147`	`1148`	`public void Does_not_filter_unknown_type()`
`1148`	`1149`	`{`
`1149`	`1150`	`Action action = () => GetArray("http://api.example.com/dummies?filter[unknownTypeField]=asdfasd");`
`1150`		`- action.ShouldThrow<HttpResponseException>().Which.Response.StatusCode.Should().Be(HttpStatusCode.BadRequest);`
	`1151`	`+ action.ShouldThrow<JsonApiException>().Which.Error.Status.Should().Be(HttpStatusCode.BadRequest);`
`1151`	`1152`	`}`
`1152`	`1153`
`1153`	`1154`	`#endregion`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`using System.Web.Http;`
`9`	`9`	`using JSONAPI.ActionFilters;`
`10`	`10`	`using JSONAPI.Core;`
	`11`	`+using JSONAPI.Documents.Builders;`
`11`	`12`
`12`	`13`	`namespace JSONAPI.QueryableTransformers`
`13`	`14`	`{`
`@@ -79,11 +80,14 @@ private Expression GetPredicateBody(HttpRequestMessage request, ParameterExpress`
`79`	`80`	`}`
`80`	`81`	`catch (TypeRegistrationNotFoundException)`
`81`	`82`	`{`
`82`		`- throw new HttpResponseException(HttpStatusCode.BadRequest);`
	`83`	`+ throw JsonApiException.CreateForBadRequest("No registration exists for the specified type");`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`var resourceTypeField = registration.GetFieldByName(filterField);`
`86`		`-`
	`87`	`+ if (resourceTypeField == null)`
	`88`	`+ throw JsonApiException.CreateForBadRequest(`
	`89`	`+ string.Format("No attribute {0} exists on the specified type.", filterField));`
	`90`	`+`
`87`	`91`	`var queryValue = queryPair.Value;`
`88`	`92`	`if (string.IsNullOrWhiteSpace(queryValue))`
`89`	`93`	`queryValue = null;`
`@@ -100,7 +104,8 @@ private Expression GetPredicateBody(HttpRequestMessage request, ParameterExpress`
`100`	`104`	`if (relationshipModelProperty != null)`
`101`	`105`	`expr = GetPredicateBodyForRelationship(relationshipModelProperty, queryValue, param);`
`102`	`106`
`103`		`- if (expr == null) throw new HttpResponseException(HttpStatusCode.BadRequest);`
	`107`	`+ if (expr == null) throw JsonApiException.CreateForBadRequest(`
	`108`	`+ string.Format("The attribute {0} is unsupported for filtering.", filterField));`
`104`	`109`
`105`	`110`	`workingExpr = workingExpr == null ? expr : Expression.AndAlso(workingExpr, expr);`
`106`	`111`	`}`
`@@ -344,7 +349,7 @@ private Expression GetPredicateBodyForRelationship(ResourceTypeRelationship reso`
`344`	`349`	`}`
`345`	`350`	`catch (TypeRegistrationNotFoundException)`
`346`	`351`	`{`
`347`		`- throw new HttpResponseException(HttpStatusCode.BadRequest);`
	`352`	`+ throw JsonApiException.CreateForBadRequest("No registration exists for the specified type");`
`348`	`353`	`}`
`349`	`354`
`350`	`355`	`var prop = resourceTypeProperty.Property;`