Define ValidationErrorResult in SpaServices; use it in MusicStore

SteveSandersonMS · SteveSandersonMS · commit 906a17ea3c22 · 2015-12-09T17:30:35.000Z
diff --git a/Microsoft.AspNet.SpaServices/ValidationErrorResult.cs b/Microsoft.AspNet.SpaServices/ValidationErrorResult.cs
@@ -0,0 +1,30 @@
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.AspNet.Mvc;
+using Microsoft.AspNet.Mvc.ModelBinding;
+
+namespace Microsoft.AspNet.SpaServices
+{
+    public class ValidationErrorResult : ObjectResult {
+        public const int DefaultStatusCode = 400;
+
+        public ValidationErrorResult(ModelStateDictionary modelState, int errorStatusCode = DefaultStatusCode)
+            : base(CreateResultObject(modelState))
+        {
+            if (!modelState.IsValid) {
+                this.StatusCode = errorStatusCode;
+            }
+        }
+
+        private static IDictionary<string, IEnumerable<string>> CreateResultObject(ModelStateDictionary modelState)
+        {
+            if (modelState.IsValid) {
+                return null;
+            } else {
+                return modelState
+                    .Where(m => m.Value.Errors.Any())
+                    .ToDictionary(m => m.Key, m => m.Value.Errors.Select(me => me.ErrorMessage));
+            }
+        }
+    }
+}
diff --git a/Microsoft.AspNet.SpaServices/project.json b/Microsoft.AspNet.SpaServices/project.json
@@ -10,6 +10,7 @@
   "projectUrl": "",
   "licenseUrl": "",
   "dependencies": {
+      "Microsoft.AspNet.Mvc": "6.0.0-rc1-*",
       "Microsoft.AspNet.Routing": "1.0.0-rc1-*"
   },
   "frameworks": {
diff --git a/samples/angular/MusicStore/Apis/AlbumsApiController.cs b/samples/angular/MusicStore/Apis/AlbumsApiController.cs
@@ -6,6 +6,7 @@
 using AutoMapper;
 using MusicStore.Models;
 using MusicStore.Infrastructure;
+using Microsoft.AspNet.SpaServices;
 
 namespace MusicStore.Apis
 {
@@ -95,7 +96,7 @@ public async Task<ActionResult> CreateAlbum([FromBody]AlbumChangeDto album)
             if (!ModelState.IsValid)
             {
                 // Return the model errors
-                return new ApiResult(ModelState);
+                return new ValidationErrorResult(ModelState);
             }
 
             // Save the changes to the DB
@@ -105,11 +106,10 @@ public async Task<ActionResult> CreateAlbum([FromBody]AlbumChangeDto album)
 
             // TODO: Handle missing record, key violations, concurrency issues, etc.
 
-            return new ApiResult
-            {
+            return new ObjectResult(new {
                 Data = dbAlbum.AlbumId,
                 Message = "Album created successfully."
-            };
+            });
         }
 
         [HttpPut("{albumId:int}/update")]
@@ -118,18 +118,16 @@ public async Task<ActionResult> UpdateAlbum(int albumId, [FromBody] AlbumChangeD
             if (!ModelState.IsValid)
             {
                 // Return the model errors
-                return new ApiResult(ModelState);
+                return new ValidationErrorResult(ModelState);
             }
 
             var dbAlbum = await _storeContext.Albums.SingleOrDefaultAsync(a => a.AlbumId == albumId);
 
             if (dbAlbum == null)
             {
-                return new ApiResult
-                {
-                    StatusCode = 404,
+                return new ObjectResult(new {
                     Message = string.Format("The album with ID {0} was not found.", albumId)
-                };
+                }) { StatusCode = 404 };
             }
 
             // Save the changes to the DB
@@ -138,10 +136,9 @@ public async Task<ActionResult> UpdateAlbum(int albumId, [FromBody] AlbumChangeD
 
             // TODO: Handle missing record, key violations, concurrency issues, etc.
 
-            return new ApiResult
-            {
+            return new ObjectResult (new {
                 Message = "Album updated successfully."
-            };
+            });
         }
 
         [HttpDelete("{albumId:int}")]
@@ -161,10 +158,9 @@ public async Task<ActionResult> DeleteAlbum(int albumId)
                 // TODO: Handle missing record, key violations, concurrency issues, etc.
             }
 
-            return new ApiResult
-            {
+            return new ObjectResult (new {
                 Message = "Album deleted successfully."
-            };
+            });
         }
     }
 
diff --git a/samples/angular/MusicStore/Infrastructure/ApiResult.cs b/samples/angular/MusicStore/Infrastructure/ApiResult.cs
diff --git a/samples/angular/MusicStore/wwwroot/ng-app/components/admin/album-edit/album-edit.ts b/samples/angular/MusicStore/wwwroot/ng-app/components/admin/album-edit/album-edit.ts
@@ -71,7 +71,7 @@ export class AlbumEdit {
                 if (response.status === 200) {
                     this.changesSaved = true;
                 } else {
-                    var errors = (<ValidationResponse>(response.json())).ModelErrors;
+                    var errors = <ValidationResponse>(response.json());
                     Object.keys(errors).forEach(key => {
                         errors[key].forEach(errorMessage => {
                             // TODO: There has to be a better API for this
@@ -101,6 +101,5 @@ export class AlbumEdit {
 }
 
 interface ValidationResponse {
-    Message: string;
-    ModelErrors: { [key: string]: string[] };
+    [propertyName: string]: string[];
 }

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`using AutoMapper;`
`7`	`7`	`using MusicStore.Models;`
`8`	`8`	`using MusicStore.Infrastructure;`
	`9`	`+using Microsoft.AspNet.SpaServices;`
`9`	`10`
`10`	`11`	`namespace MusicStore.Apis`
`11`	`12`	`{`
`@@ -95,7 +96,7 @@ public async Task<ActionResult> CreateAlbum([FromBody]AlbumChangeDto album)`
`95`	`96`	`if (!ModelState.IsValid)`
`96`	`97`	`{`
`97`	`98`	`// Return the model errors`
`98`		`- return new ApiResult(ModelState);`
	`99`	`+ return new ValidationErrorResult(ModelState);`
`99`	`100`	`}`
`100`	`101`
`101`	`102`	`// Save the changes to the DB`
`@@ -105,11 +106,10 @@ public async Task<ActionResult> CreateAlbum([FromBody]AlbumChangeDto album)`
`105`	`106`
`106`	`107`	`// TODO: Handle missing record, key violations, concurrency issues, etc.`
`107`	`108`
`108`		`- return new ApiResult`
`109`		`- {`
	`109`	`+ return new ObjectResult(new {`
`110`	`110`	`Data = dbAlbum.AlbumId,`
`111`	`111`	`Message = "Album created successfully."`
`112`		`- };`
	`112`	`+ });`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`[HttpPut("{albumId:int}/update")]`
`@@ -118,18 +118,16 @@ public async Task<ActionResult> UpdateAlbum(int albumId, [FromBody] AlbumChangeD`
`118`	`118`	`if (!ModelState.IsValid)`
`119`	`119`	`{`
`120`	`120`	`// Return the model errors`
`121`		`- return new ApiResult(ModelState);`
	`121`	`+ return new ValidationErrorResult(ModelState);`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`var dbAlbum = await _storeContext.Albums.SingleOrDefaultAsync(a => a.AlbumId == albumId);`
`125`	`125`
`126`	`126`	`if (dbAlbum == null)`
`127`	`127`	`{`
`128`		`- return new ApiResult`
`129`		`- {`
`130`		`- StatusCode = 404,`
	`128`	`+ return new ObjectResult(new {`
`131`	`129`	`Message = string.Format("The album with ID {0} was not found.", albumId)`
`132`		`- };`
	`130`	`+ }) { StatusCode = 404 };`
`133`	`131`	`}`
`134`	`132`
`135`	`133`	`// Save the changes to the DB`
`@@ -138,10 +136,9 @@ public async Task<ActionResult> UpdateAlbum(int albumId, [FromBody] AlbumChangeD`
`138`	`136`
`139`	`137`	`// TODO: Handle missing record, key violations, concurrency issues, etc.`
`140`	`138`
`141`		`- return new ApiResult`
`142`		`- {`
	`139`	`+ return new ObjectResult (new {`
`143`	`140`	`Message = "Album updated successfully."`
`144`		`- };`
	`141`	`+ });`
`145`	`142`	`}`
`146`	`143`
`147`	`144`	`[HttpDelete("{albumId:int}")]`
`@@ -161,10 +158,9 @@ public async Task<ActionResult> DeleteAlbum(int albumId)`
`161`	`158`	`// TODO: Handle missing record, key violations, concurrency issues, etc.`
`162`	`159`	`}`
`163`	`160`
`164`		`- return new ApiResult`
`165`		`- {`
	`161`	`+ return new ObjectResult (new {`
`166`	`162`	`Message = "Album deleted successfully."`
`167`		`- };`
	`163`	`+ });`
`168`	`164`	`}`
`169`	`165`	`}`
`170`	`166`