Merge branch 'master' into content-negotiation-tests

Bart Koelman · Bart Koelman · commit cec1ead55188 · 2020-11-30T09:43:04.000+01:00
diff --git a/docs/generate-examples.ps1 b/docs/generate-examples.ps1
@@ -3,11 +3,19 @@
 # This script generates response documents for ./request-examples
 
 function Kill-WebServer {
-    $tcpConnections = Get-NetTCPConnection -LocalPort 14141 -ErrorAction SilentlyContinue
-    if ($tcpConnections -ne $null) {
+    $processId = $null
+    if ($IsMacOs || $IsLinux) {
+        $processId = $(lsof -ti:8080)
+    }
+    elseif ($IsWindows) {
+        $processId = $(Get-NetTCPConnection -LocalPort 14141 -ErrorAction SilentlyContinue).OwningProcess
+    }
+
+    if ($processId -ne $null) {
         Write-Output "Stopping web server"
-        Get-Process -Id $tcpConnections.OwningProcess | Stop-Process
+        Get-Process -Id $processId | Stop-Process
     }
+
 }
 
 function Start-Webserver {
diff --git a/docs/home/index.html b/docs/home/index.html
@@ -3,7 +3,7 @@
    <head>
       <meta charset="utf-8">
       <meta content="width=device-width, initial-scale=1.0" name="viewport">
-      <title>JsonApiDotNetCore</title>
+      <title>JSON:API .NET Core</title>
       <meta content="" name="descriptison">
       <meta content="" name="keywords">
       <link href="favicon.ico" rel="icon">
@@ -213,6 +213,10 @@ <h4 class="title">Response</h4>
           "links": {
             "self": "/articles/1/relationships/author",
             "related": "/articles/1/author"
+          },
+          "data": {
+            "type": "people",
+            "id": "1"
           }
         }
       },
diff --git a/docs/usage/extensibility/controllers.md b/docs/usage/extensibility/controllers.md
@@ -51,15 +51,15 @@ public class ArticlesController : BaseJsonApiController<Article>
     { }
 
     [HttpGet]
-    public override async Task<IActionResult> GetAsync()
+    public override async Task<IActionResult> GetAsync(CancellationToken cancellationToken)
     {
-        return await base.GetAsync();
+        return await base.GetAsync(cancellationToken);
     }
 
     [HttpGet("{id}")]
-    public override async Task<IActionResult> GetAsync(int id)
+    public override async Task<IActionResult> GetAsync(int id, CancellationToken cancellationToken)
     {
-        return await base.GetAsync(id);
+        return await base.GetAsync(id, cancellationToken);
     }
 }
 ```
@@ -108,9 +108,9 @@ public class ReportsController : BaseJsonApiController<Report>
     { }
 
     [HttpGet]
-    public override async Task<IActionResult> GetAsync()
+    public override async Task<IActionResult> GetAsync(CancellationToken cancellationToken)
     {
-        return await base.GetAsync();
+        return await base.GetAsync(cancellationToken);
     }
 }
 ```
diff --git a/docs/usage/extensibility/repositories.md b/docs/usage/extensibility/repositories.md
@@ -51,9 +51,10 @@ public class ArticleRepository : EntityFrameworkCoreRepository<Article>
         _authenticationService = authenticationService;
     }
 
-    public override IQueryable<Article> GetAll()
+    public override IQueryable<Article> GetAll(CancellationToken cancellationToken)
     {
-        return base.Get().Where(article => article.UserId == _authenticationService.UserId);
+        return base.GetAll(cancellationToken)
+            .Where(article => article.UserId == _authenticationService.UserId);
     }
 }
 ```
diff --git a/docs/usage/extensibility/services.md b/docs/usage/extensibility/services.md
@@ -16,28 +16,28 @@ public class TodoItemService : JsonApiResourceService<TodoItem>
     private readonly INotificationService _notificationService;
 
     public TodoItemService(
-        IResourceRepository<TodoItem> repository,
+        IResourceRepositoryAccessor repositoryAccessor,
         IQueryLayerComposer queryLayerComposer,
         IPaginationContext paginationContext,
         IJsonApiOptions options,
         ILoggerFactory loggerFactory,
         IJsonApiRequest request,
         IResourceChangeTracker<TodoItem> resourceChangeTracker,
         IResourceFactory resourceFactory,
-        IResourceHookExecutor hookExecutor = null)
-        : base(repository, queryLayerComposer, paginationContext, options, loggerFactory,
+        IResourceHookExecutorFacade hookExecutor)
+        : base(repositoryAccessor, queryLayerComposer, paginationContext, options, loggerFactory,
             request, resourceChangeTracker, resourceFactory, hookExecutor)
     {
         _notificationService = notificationService;
     }
 
-    public override async Task<TodoItem> CreateAsync(TodoItem resource)
+    public override async Task<TodoItem> CreateAsync(TodoItem resource, CancellationToken cancellationToken)
     {
         // Call the base implementation
-        var newResource = await base.CreateAsync(resource);
+        var newResource = await base.CreateAsync(resource, cancellationToken);
 
         // Custom code
-        _notificationService.Notify($"Resource created: {newResource.StringId}");
+        await _notificationService.NotifyAsync($"Resource created: {newResource.StringId}");
 
         return newResource;
     }
@@ -70,9 +70,9 @@ public class ProductService : IResourceService<Product>
         _dao = dao;
     }
 
-    public Task<IEnumerable<Product>> GetAsync()
+    public async Task<IReadOnlyCollection<Product>> GetAsync(CancellationToken cancellationToken)
     {
-        return await _dao.GetProductsAsync();
+        return await _dao.GetProductsAsync(cancellationToken);
     }
 }
 ```
@@ -162,15 +162,15 @@ public class ArticlesController : BaseJsonApiController<Article>
     { }
 
     [HttpPost]
-    public override async Task<IActionResult> PostAsync([FromBody] Article resource)
+    public override async Task<IActionResult> PostAsync([FromBody] Article resource, CancellationToken cancellationToken)
     {
-        return await base.PostAsync(resource);
+        return await base.PostAsync(resource, cancellationToken);
     }
 
     [HttpDelete("{id}")]
-    public override async Task<IActionResult>DeleteAsync(int id)
+    public override async Task<IActionResult>DeleteAsync(int id, CancellationToken cancellationToken)
     {
-        return await base.DeleteAsync(id);
+        return await base.DeleteAsync(id, cancellationToken);
     }
 }
 ```

Original file line number	Diff line number	Diff line change
`@@ -51,15 +51,15 @@ public class ArticlesController : BaseJsonApiController<Article>`
`51`	`51`	`{ }`
`52`	`52`
`53`	`53`	`[HttpGet]`
`54`		`- public override async Task<IActionResult> GetAsync()`
	`54`	`+ public override async Task<IActionResult> GetAsync(CancellationToken cancellationToken)`
`55`	`55`	`{`
`56`		`- return await base.GetAsync();`
	`56`	`+ return await base.GetAsync(cancellationToken);`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`[HttpGet("{id}")]`
`60`		`- public override async Task<IActionResult> GetAsync(int id)`
	`60`	`+ public override async Task<IActionResult> GetAsync(int id, CancellationToken cancellationToken)`
`61`	`61`	`{`
`62`		`- return await base.GetAsync(id);`
	`62`	`+ return await base.GetAsync(id, cancellationToken);`
`63`	`63`	`}`
`64`	`64`	`}`
`65`	`65`	```
`@@ -108,9 +108,9 @@ public class ReportsController : BaseJsonApiController<Report>`
`108`	`108`	`{ }`
`109`	`109`
`110`	`110`	`[HttpGet]`
`111`		`- public override async Task<IActionResult> GetAsync()`
	`111`	`+ public override async Task<IActionResult> GetAsync(CancellationToken cancellationToken)`
`112`	`112`	`{`
`113`		`- return await base.GetAsync();`
	`113`	`+ return await base.GetAsync(cancellationToken);`
`114`	`114`	`}`
`115`	`115`	`}`
`116`	`116`	```
Original file line number	Diff line number	Diff line change
`@@ -51,9 +51,10 @@ public class ArticleRepository : EntityFrameworkCoreRepository<Article>`
`51`	`51`	`_authenticationService = authenticationService;`
`52`	`52`	`}`
`53`	`53`
`54`		`- public override IQueryable<Article> GetAll()`
	`54`	`+ public override IQueryable<Article> GetAll(CancellationToken cancellationToken)`
`55`	`55`	`{`
`56`		`- return base.Get().Where(article => article.UserId == _authenticationService.UserId);`
	`56`	`+ return base.GetAll(cancellationToken)`
	`57`	`+ .Where(article => article.UserId == _authenticationService.UserId);`
`57`	`58`	`}`
`58`	`59`	`}`
`59`	`60`	```
Original file line number	Diff line number	Diff line change
`@@ -16,28 +16,28 @@ public class TodoItemService : JsonApiResourceService<TodoItem>`
`16`	`16`	`private readonly INotificationService _notificationService;`
`17`	`17`
`18`	`18`	`public TodoItemService(`
`19`		`- IResourceRepository<TodoItem> repository,`
	`19`	`+ IResourceRepositoryAccessor repositoryAccessor,`
`20`	`20`	`IQueryLayerComposer queryLayerComposer,`
`21`	`21`	`IPaginationContext paginationContext,`
`22`	`22`	`IJsonApiOptions options,`
`23`	`23`	`ILoggerFactory loggerFactory,`
`24`	`24`	`IJsonApiRequest request,`
`25`	`25`	`IResourceChangeTracker<TodoItem> resourceChangeTracker,`
`26`	`26`	`IResourceFactory resourceFactory,`
`27`		`- IResourceHookExecutor hookExecutor = null)`
`28`		`- : base(repository, queryLayerComposer, paginationContext, options, loggerFactory,`
	`27`	`+ IResourceHookExecutorFacade hookExecutor)`
	`28`	`+ : base(repositoryAccessor, queryLayerComposer, paginationContext, options, loggerFactory,`
`29`	`29`	`request, resourceChangeTracker, resourceFactory, hookExecutor)`
`30`	`30`	`{`
`31`	`31`	`_notificationService = notificationService;`
`32`	`32`	`}`
`33`	`33`
`34`		`- public override async Task<TodoItem> CreateAsync(TodoItem resource)`
	`34`	`+ public override async Task<TodoItem> CreateAsync(TodoItem resource, CancellationToken cancellationToken)`
`35`	`35`	`{`
`36`	`36`	`// Call the base implementation`
`37`		`- var newResource = await base.CreateAsync(resource);`
	`37`	`+ var newResource = await base.CreateAsync(resource, cancellationToken);`
`38`	`38`
`39`	`39`	`// Custom code`
`40`		`- _notificationService.Notify($"Resource created: {newResource.StringId}");`
	`40`	`+ await _notificationService.NotifyAsync($"Resource created: {newResource.StringId}");`
`41`	`41`
`42`	`42`	`return newResource;`
`43`	`43`	`}`
`@@ -70,9 +70,9 @@ public class ProductService : IResourceService<Product>`
`70`	`70`	`_dao = dao;`
`71`	`71`	`}`
`72`	`72`
`73`		`- public Task<IEnumerable<Product>> GetAsync()`
	`73`	`+ public async Task<IReadOnlyCollection<Product>> GetAsync(CancellationToken cancellationToken)`
`74`	`74`	`{`
`75`		`- return await _dao.GetProductsAsync();`
	`75`	`+ return await _dao.GetProductsAsync(cancellationToken);`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`	```
`@@ -162,15 +162,15 @@ public class ArticlesController : BaseJsonApiController<Article>`
`162`	`162`	`{ }`
`163`	`163`
`164`	`164`	`[HttpPost]`
`165`		`- public override async Task<IActionResult> PostAsync([FromBody] Article resource)`
	`165`	`+ public override async Task<IActionResult> PostAsync([FromBody] Article resource, CancellationToken cancellationToken)`
`166`	`166`	`{`
`167`		`- return await base.PostAsync(resource);`
	`167`	`+ return await base.PostAsync(resource, cancellationToken);`
`168`	`168`	`}`
`169`	`169`
`170`	`170`	`[HttpDelete("{id}")]`
`171`		`- public override async Task<IActionResult>DeleteAsync(int id)`
	`171`	`+ public override async Task<IActionResult>DeleteAsync(int id, CancellationToken cancellationToken)`
`172`	`172`	`{`
`173`		`- return await base.DeleteAsync(id);`
	`173`	`+ return await base.DeleteAsync(id, cancellationToken);`
`174`	`174`	`}`
`175`	`175`	`}`
`176`	`176`	```