Code

Error handling and logging#714

Code

Merged

bart-degreed merged 60 commits intojson-api-dotnet:masterjson-api-dotnet/JsonApiDotNetCore:masterfrom

bart-degreed:extensibilityCopy head branch name to clipboard

Apr 8, 2020

Commits

Commits on Apr 1, 2020

• Made some types which are not intended to be instantiated abstract

  

  Bart Koelman

  committed
  b894993

  Copy full SHA for b894993

• Added members to Error as described at https://jsonapi.org/format/#errors

  

  Bart Koelman

  committed
  07b9f1d

  Copy full SHA for 07b9f1d

• Replaced numeric HTTP status codes with HttpStatusCode enum

  

  Bart Koelman

  committed
  726a8e8

  Copy full SHA for 726a8e8

• Expose HttpStatusCode on Error object

  

  Bart Koelman

  committed
  00c6af8

  Copy full SHA for 00c6af8

• Replaced static error class with custom exception

  

  Bart Koelman

  committed
  10afd16

  Copy full SHA for 10afd16

• Moved Error type to non-internal namespace

  

  Bart Koelman

  committed
  eb76b0d

  Copy full SHA for eb76b0d

• Cleanup errors produced from model state validation

  

  Bart Koelman

  committed
  940bb1d

  Copy full SHA for 940bb1d

• Renamed ErrorCollection to ErrorDocument, because it *contains* a collection of errors, instead of *being* one.

  Show description for 8660887
  

  Bart Koelman

  committed
  8660887

  Copy full SHA for 8660887

• Removed custom error object; made json:api objects sealed

  

  Bart Koelman

  committed
  4f44a19

  Copy full SHA for 4f44a19

• Removed ErrorSource from constructors and options, because it is almost always inappropriate to set. Note it is intended to indicate on which query string parameter the error applies or on which js…

  Show description for 99c2502
  

  Bart Koelman

  committed
  99c2502

  Copy full SHA for 99c2502

• Added error documentation from json:api spec.

  

  Bart Koelman

  committed
  bc89762

  Copy full SHA for bc89762

• Changed Error.Meta to contain multiple key/value pairs. Replaced static method.

  

  Bart Koelman

  committed
  f7f58db

  Copy full SHA for f7f58db

• Cleanup Error constructor overloads (only accept required parameter)

  

  Bart Koelman

  committed
  f9ad031

  Copy full SHA for f9ad031

• Fixed broken modelstate validation; converted unit tests into TestServer tests

  

  Bart Koelman

  committed
  16c1448

  Copy full SHA for 16c1448

• Major rewrite for error handling:

  Show description for e0012fd
  

  Bart Koelman

  committed
  e0012fd

  Copy full SHA for e0012fd

Commits on Apr 2, 2020

• Fixed: use enum instead of magic numbers

  

  Bart Koelman

  committed
  602adad

  Copy full SHA for 602adad

• Fixed: setting MaxLength on attribute is picked up by EF Core and translated into a database constraint. This makes it impossible to toggle per test. So using regex constraint instead.

  

  Bart Koelman

  committed
  ef88938

  Copy full SHA for ef88938

• Fixed spelling error in comment

  

  Bart Koelman

  committed
  03117a2

  Copy full SHA for 03117a2

• Changes on the flow of parsing query strings, in order to throw better errors.

  Show description for 46d23e0
  

  Bart Koelman

  committed
  46d23e0

  Copy full SHA for 46d23e0

Commits on Apr 3, 2020

• Query strings: moved the check for empty value up the call stack, created custom exception, updated Errors to match with json:api spec and added error details validation to tests. Fixed missing low…

  Show description for a6fef14
  

  Bart Koelman

  committed
  a6fef14

  Copy full SHA for a6fef14

• Removed wrong usage of UnauthorizedAccessException: "The exception that is thrown when the operating system denies access because of...."

  Show description for a6302d9
  

  Bart Koelman

  committed
  a6302d9

  Copy full SHA for a6302d9

• Moved exceptions into public namespace

  

  Bart Koelman

  committed
  2a24757

  Copy full SHA for 2a24757

• Added ObjectCreationException with a unit test. Redirected parameterless object construction to central place.

  

  Bart Koelman

  committed
  d57ff7a

  Copy full SHA for d57ff7a

• Added exception + test for resource type mismatch between endpoint url and request body.

  

  Bart Koelman

  committed
  1a7130e

  Copy full SHA for 1a7130e

• Wrap errors returned from ActionResults, to help being json:api compliant

  

  Bart Koelman

  committed
  3bc5bc6

  Copy full SHA for 3bc5bc6

• Fixed: respect casing convention when serializing error responses

  

  Bart Koelman

  committed
  f66c7ee

  Copy full SHA for f66c7ee

• Another conversion from generic exception to typed exception + test

  

  Bart Koelman

  committed
  b688192

  Copy full SHA for b688192

• Reuse error for method not allowed + unit tests

  

  Bart Koelman

  committed
  fc9c295

  Copy full SHA for fc9c295

• Added test for using DisableQueryAttribute

  

  Bart Koelman

  committed
  c7ce364

  Copy full SHA for c7ce364

• Added AttributeUsage on attributes

  

  Bart Koelman

  committed
  a84d15f

  Copy full SHA for a84d15f

• Better messages and tests for more query string errors

  

  Bart Koelman

  committed
  2f920da

  Copy full SHA for 2f920da

Commits on Apr 4, 2020

• Fixed copy/paste error

  

  Bart Koelman

  committed
  80cd4bf

  Copy full SHA for 80cd4bf

• More query string exception usage with tests

  

  Bart Koelman

  committed
  2024d51

  Copy full SHA for 2024d51

• Updated comments

  

  Bart Koelman

  committed
  cd79fa5

  Copy full SHA for cd79fa5

• More cleanup of errors

  

  Bart Koelman

  committed
  08c4266

  Copy full SHA for 08c4266

• More converted exceptions with tests

  

  Bart Koelman

  committed
  52ee7b8

  Copy full SHA for 52ee7b8

Commits on Apr 6, 2020

• Reverted some exceptions because there are not user-facing but helping the developer identify wrong setup.

  

  Bart Koelman

  committed
  a99cc59

  Copy full SHA for a99cc59

• Fixed: broke dependency between action results and json:api error document structure

  

  Bart Koelman

  committed
  7c40384

  Copy full SHA for 7c40384

• Fixed: use status code from error; unwrap reflection errors

  

  Bart Koelman

  committed
  9676990

  Copy full SHA for 9676990

• Tweaks in error logging

  

  Bart Koelman

  committed
  6fae6f8

  Copy full SHA for 6fae6f8

• Include request body in logged exception when available

  

  Bart Koelman

  committed
  d92b3b9

  Copy full SHA for d92b3b9

• More assertions on non-success status codes and exceptions. Removed empty string check from CurrentRequestMiddleware because I found now way to get there. The unit-test was misleading: throwing Jso…

  Show description for f0df15b
  

  Bart Koelman

  committed
  f0df15b

  Copy full SHA for f0df15b

• Removed exception for unable to serialize response

  

  Bart Koelman

  committed
  d7a81d0

  Copy full SHA for d7a81d0

Commits on Apr 7, 2020

• Lowered log level in example

  

  Bart Koelman

  committed
  0d5b897

  Copy full SHA for 0d5b897

• Tweaks in log formatting

  

  Bart Koelman

  committed
  cad4834

  Copy full SHA for cad4834

• Added logging for query string parsing

  

  Bart Koelman

  committed
  6c2a659

  Copy full SHA for 6c2a659

• Added JSON request/response logging

  

  Bart Koelman

  committed
  d5dbf72

  Copy full SHA for d5dbf72

• Added trace-level logging for the controller > service > repository chain

  

  Bart Koelman

  committed
  674668e

  Copy full SHA for 674668e

• Fixed: allow unpaged result when no maximum page size is set

  Show description for 3697967
  

  Bart Koelman

  committed
  3697967

  Copy full SHA for 3697967

• Fixed: duplicate tests

  

  Bart Koelman

  committed
  5680190

  Copy full SHA for 5680190

• separate constructors (easier to derive)

  

  Bart Koelman

  committed
  e553070

  Copy full SHA for e553070

• Replaced ActionResults with rich exceptions

  Show description for 8f96c22
  

  Bart Koelman

  committed
  8f96c22

  Copy full SHA for 8f96c22

• Removed unused usings

  

  Bart Koelman

  committed
  a5dddad

  Copy full SHA for a5dddad

• Various small fixes

  

  Bart Koelman

  committed
  f889c90

  Copy full SHA for f889c90

• Fixed: update file name to match with class

  

  Bart Koelman

  committed
  2b65e32

  Copy full SHA for 2b65e32

• Added tests for using ActionResult without [ApiController]

  

  Bart Koelman

  committed
  1439d4f

  Copy full SHA for 1439d4f

Commits on Apr 8, 2020

• Fixed: De-duplicate field names in sparse fieldset; do not ignore case

  Show description for ef8d650
  

  Bart Koelman

  committed
  ef8d650

  Copy full SHA for ef8d650

• Removed more case-insensitive string comparisons. They are tricky, because they hide potential usages of property names instead of resource names, which only works with the default camel-case conve…

  Show description for e0a139b
  

  Bart Koelman

  committed
  e0a139b

  Copy full SHA for e0a139b

• Inlined casing conversions

  

  Bart Koelman

  committed
  6969ce3

  Copy full SHA for 6969ce3

• More casing-related updates

  

  Bart Koelman

  committed
  05a9dbe

  Copy full SHA for 05a9dbe