Fixed api blacklist, history, wanted/missing and wanted/cutoff requiring sortKey, now defaulting to an appropriate value (airDateUtc/date desc for most).

Taloth · Taloth · commit 713e109bc92f · 2016-09-10T23:05:34.000+02:00
fixes Sonarr#1452
diff --git a/src/NzbDrone.Api/Blacklist/BlacklistModule.cs b/src/NzbDrone.Api/Blacklist/BlacklistModule.cs
@@ -17,13 +17,7 @@ public BlacklistModule(IBlacklistService blacklistService)
 
         private PagingResource<BlacklistResource> GetBlacklist(PagingResource<BlacklistResource> pagingResource)
         {
-            var pagingSpec = new PagingSpec<Core.Blacklisting.Blacklist>
-                                 {
-                                     Page = pagingResource.Page,
-                                     PageSize = pagingResource.PageSize,
-                                     SortKey = pagingResource.SortKey,
-                                     SortDirection = pagingResource.SortDirection
-                                 };
+            var pagingSpec = pagingResource.MapToPagingSpec<BlacklistResource, Core.Blacklisting.Blacklist>("id", SortDirection.Ascending);
 
             return ApplyToPage(_blacklistService.Paged, pagingSpec, BlacklistResourceMapper.MapToResource);
         }
@@ -33,4 +27,4 @@ private void DeleteBlacklist(int id)
             _blacklistService.Delete(id);
         }
     }
-}
+}
diff --git a/src/NzbDrone.Api/History/HistoryModule.cs b/src/NzbDrone.Api/History/HistoryModule.cs
@@ -47,13 +47,7 @@ private PagingResource<HistoryResource> GetHistory(PagingResource<HistoryResourc
         {
             var episodeId = Request.Query.EpisodeId;
 
-            var pagingSpec = new PagingSpec<Core.History.History>
-                                 {
-                                     Page = pagingResource.Page,
-                                     PageSize = pagingResource.PageSize,
-                                     SortKey = pagingResource.SortKey,
-                                     SortDirection = pagingResource.SortDirection
-                                 };
+            var pagingSpec = pagingResource.MapToPagingSpec<HistoryResource, Core.History.History>("date", SortDirection.Descending);
 
             if (pagingResource.FilterKey == "eventType")
             {
@@ -77,4 +71,4 @@ private Response MarkAsFailed()
             return new object().AsResponse();
         }
     }
-}
+}
diff --git a/src/NzbDrone.Api/PagingResource.cs b/src/NzbDrone.Api/PagingResource.cs
@@ -17,15 +17,26 @@ public class PagingResource<TResource>
 
     public static class PagingResourceMapper
     {
-        public static PagingSpec<TModel> MapToPagingSpec<TResource, TModel>(this PagingResource<TResource> pagingSpec)
+        public static PagingSpec<TModel> MapToPagingSpec<TResource, TModel>(this PagingResource<TResource> pagingResource, string defaultSortKey = "Id", SortDirection defaultSortDirection = SortDirection.Ascending)
         {
-            return new PagingSpec<TModel>
+            var pagingSpec = new PagingSpec<TModel>
             {
-                Page = pagingSpec.Page,
-                PageSize = pagingSpec.PageSize,
-                SortKey = pagingSpec.SortKey,
-                SortDirection = pagingSpec.SortDirection,
+                Page = pagingResource.Page,
+                PageSize = pagingResource.PageSize,
+                SortKey = pagingResource.SortKey,
+                SortDirection = pagingResource.SortDirection,
             };
+
+            if (pagingResource.SortKey == null)
+            {
+                pagingSpec.SortKey = defaultSortKey;
+                if(pagingResource.SortDirection == SortDirection.Default)
+                {
+                    pagingSpec.SortDirection = defaultSortDirection;
+                }
+            }
+
+            return pagingSpec;
         }
     }
 }
diff --git a/src/NzbDrone.Api/Wanted/CutoffModule.cs b/src/NzbDrone.Api/Wanted/CutoffModule.cs
@@ -23,13 +23,7 @@ public CutoffModule(IEpisodeCutoffService episodeCutoffService,
 
         private PagingResource<EpisodeResource> GetCutoffUnmetEpisodes(PagingResource<EpisodeResource> pagingResource)
         {
-            var pagingSpec = new PagingSpec<Episode>
-            {
-                Page = pagingResource.Page,
-                PageSize = pagingResource.PageSize,
-                SortKey = pagingResource.SortKey,
-                SortDirection = pagingResource.SortDirection
-            };
+            var pagingSpec = pagingResource.MapToPagingSpec<EpisodeResource, Episode>("airDateUtc", SortDirection.Descending);
 
             if (pagingResource.FilterKey == "monitored" && pagingResource.FilterValue == "false")
             {
@@ -45,4 +39,4 @@ private PagingResource<EpisodeResource> GetCutoffUnmetEpisodes(PagingResource<Ep
             return resource;
         }
     }
-}
+}
diff --git a/src/NzbDrone.Api/Wanted/MissingModule.cs b/src/NzbDrone.Api/Wanted/MissingModule.cs
@@ -19,13 +19,7 @@ public MissingModule(IEpisodeService episodeService,
 
         private PagingResource<EpisodeResource> GetMissingEpisodes(PagingResource<EpisodeResource> pagingResource)
         {
-            var pagingSpec = new PagingSpec<Episode>
-            {
-                Page = pagingResource.Page,
-                PageSize = pagingResource.PageSize,
-                SortKey = pagingResource.SortKey,
-                SortDirection = pagingResource.SortDirection
-            };
+            var pagingSpec = pagingResource.MapToPagingSpec<EpisodeResource, Episode>("airDateUtc", SortDirection.Descending);
 
             if (pagingResource.FilterKey == "monitored" && pagingResource.FilterValue == "false")
             {
@@ -41,4 +35,4 @@ private PagingResource<EpisodeResource> GetMissingEpisodes(PagingResource<Episod
             return resource;
         }
     }
-}
+}
diff --git a/src/NzbDrone.Core.Test/Datastore/PagingSpecExtensionsTests/ToSortDirectionFixture.cs b/src/NzbDrone.Core.Test/Datastore/PagingSpecExtensionsTests/ToSortDirectionFixture.cs
@@ -8,6 +8,20 @@ namespace NzbDrone.Core.Test.Datastore.PagingSpecExtensionsTests
 {
     public class ToSortDirectionFixture
     {
+        [Test]
+        public void should_convert_default_to_asc()
+        {
+            var pagingSpec = new PagingSpec<Episode>
+            {
+                Page = 1,
+                PageSize = 10,
+                SortDirection = SortDirection.Default,
+                SortKey = "AirDate"
+            };
+
+            pagingSpec.ToSortDirection().Should().Be(Marr.Data.QGen.SortDirection.Asc);
+        }
+
         [Test]
         public void should_convert_ascending_to_asc()
         {
diff --git a/src/NzbDrone.Core/Datastore/PagingSpec.cs b/src/NzbDrone.Core/Datastore/PagingSpec.cs
@@ -17,6 +17,7 @@ public class PagingSpec<TModel>
 
     public enum SortDirection
     {
+        Default,
         Ascending,
         Descending
     }

Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,7 @@ public BlacklistModule(IBlacklistService blacklistService)`
`17`	`17`
`18`	`18`	`private PagingResource<BlacklistResource> GetBlacklist(PagingResource<BlacklistResource> pagingResource)`
`19`	`19`	`{`
`20`		`- var pagingSpec = new PagingSpec<Core.Blacklisting.Blacklist>`
`21`		`- {`
`22`		`- Page = pagingResource.Page,`
`23`		`- PageSize = pagingResource.PageSize,`
`24`		`- SortKey = pagingResource.SortKey,`
`25`		`- SortDirection = pagingResource.SortDirection`
`26`		`- };`
	`20`	`+ var pagingSpec = pagingResource.MapToPagingSpec<BlacklistResource, Core.Blacklisting.Blacklist>("id", SortDirection.Ascending);`
`27`	`21`
`28`	`22`	`return ApplyToPage(_blacklistService.Paged, pagingSpec, BlacklistResourceMapper.MapToResource);`
`29`	`23`	`}`
`@@ -33,4 +27,4 @@ private void DeleteBlacklist(int id)`
`33`	`27`	`_blacklistService.Delete(id);`
`34`	`28`	`}`
`35`	`29`	`}`
`36`		`-}`
	`30`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -47,13 +47,7 @@ private PagingResource<HistoryResource> GetHistory(PagingResource<HistoryResourc`
`47`	`47`	`{`
`48`	`48`	`var episodeId = Request.Query.EpisodeId;`
`49`	`49`
`50`		`- var pagingSpec = new PagingSpec<Core.History.History>`
`51`		`- {`
`52`		`- Page = pagingResource.Page,`
`53`		`- PageSize = pagingResource.PageSize,`
`54`		`- SortKey = pagingResource.SortKey,`
`55`		`- SortDirection = pagingResource.SortDirection`
`56`		`- };`
	`50`	`+ var pagingSpec = pagingResource.MapToPagingSpec<HistoryResource, Core.History.History>("date", SortDirection.Descending);`
`57`	`51`
`58`	`52`	`if (pagingResource.FilterKey == "eventType")`
`59`	`53`	`{`
`@@ -77,4 +71,4 @@ private Response MarkAsFailed()`
`77`	`71`	`return new object().AsResponse();`
`78`	`72`	`}`
`79`	`73`	`}`
`80`		`-}`
	`74`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -17,15 +17,26 @@ public class PagingResource<TResource>`
`17`	`17`
`18`	`18`	`public static class PagingResourceMapper`
`19`	`19`	`{`
`20`		`- public static PagingSpec<TModel> MapToPagingSpec<TResource, TModel>(this PagingResource<TResource> pagingSpec)`
	`20`	`+ public static PagingSpec<TModel> MapToPagingSpec<TResource, TModel>(this PagingResource<TResource> pagingResource, string defaultSortKey = "Id", SortDirection defaultSortDirection = SortDirection.Ascending)`
`21`	`21`	`{`
`22`		`- return new PagingSpec<TModel>`
	`22`	`+ var pagingSpec = new PagingSpec<TModel>`
`23`	`23`	`{`
`24`		`- Page = pagingSpec.Page,`
`25`		`- PageSize = pagingSpec.PageSize,`
`26`		`- SortKey = pagingSpec.SortKey,`
`27`		`- SortDirection = pagingSpec.SortDirection,`
	`24`	`+ Page = pagingResource.Page,`
	`25`	`+ PageSize = pagingResource.PageSize,`
	`26`	`+ SortKey = pagingResource.SortKey,`
	`27`	`+ SortDirection = pagingResource.SortDirection,`
`28`	`28`	`};`
	`29`	`+`
	`30`	`+ if (pagingResource.SortKey == null)`
	`31`	`+ {`
	`32`	`+ pagingSpec.SortKey = defaultSortKey;`
	`33`	`+ if(pagingResource.SortDirection == SortDirection.Default)`
	`34`	`+ {`
	`35`	`+ pagingSpec.SortDirection = defaultSortDirection;`
	`36`	`+ }`
	`37`	`+ }`
	`38`	`+`
	`39`	`+ return pagingSpec;`
`29`	`40`	`}`
`30`	`41`	`}`
`31`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,13 +23,7 @@ public CutoffModule(IEpisodeCutoffService episodeCutoffService,`
`23`	`23`
`24`	`24`	`private PagingResource<EpisodeResource> GetCutoffUnmetEpisodes(PagingResource<EpisodeResource> pagingResource)`
`25`	`25`	`{`
`26`		`- var pagingSpec = new PagingSpec<Episode>`
`27`		`- {`
`28`		`- Page = pagingResource.Page,`
`29`		`- PageSize = pagingResource.PageSize,`
`30`		`- SortKey = pagingResource.SortKey,`
`31`		`- SortDirection = pagingResource.SortDirection`
`32`		`- };`
	`26`	`+ var pagingSpec = pagingResource.MapToPagingSpec<EpisodeResource, Episode>("airDateUtc", SortDirection.Descending);`
`33`	`27`
`34`	`28`	`if (pagingResource.FilterKey == "monitored" && pagingResource.FilterValue == "false")`
`35`	`29`	`{`
`@@ -45,4 +39,4 @@ private PagingResource<EpisodeResource> GetCutoffUnmetEpisodes(PagingResource<Ep`
`45`	`39`	`return resource;`
`46`	`40`	`}`
`47`	`41`	`}`
`48`		`-}`
	`42`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -19,13 +19,7 @@ public MissingModule(IEpisodeService episodeService,`
`19`	`19`
`20`	`20`	`private PagingResource<EpisodeResource> GetMissingEpisodes(PagingResource<EpisodeResource> pagingResource)`
`21`	`21`	`{`
`22`		`- var pagingSpec = new PagingSpec<Episode>`
`23`		`- {`
`24`		`- Page = pagingResource.Page,`
`25`		`- PageSize = pagingResource.PageSize,`
`26`		`- SortKey = pagingResource.SortKey,`
`27`		`- SortDirection = pagingResource.SortDirection`
`28`		`- };`
	`22`	`+ var pagingSpec = pagingResource.MapToPagingSpec<EpisodeResource, Episode>("airDateUtc", SortDirection.Descending);`
`29`	`23`
`30`	`24`	`if (pagingResource.FilterKey == "monitored" && pagingResource.FilterValue == "false")`
`31`	`25`	`{`
`@@ -41,4 +35,4 @@ private PagingResource<EpisodeResource> GetMissingEpisodes(PagingResource<Episod`
`41`	`35`	`return resource;`
`42`	`36`	`}`
`43`	`37`	`}`
`44`		`-}`
	`38`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ public class PagingSpec<TModel>`
`17`	`17`
`18`	`18`	`public enum SortDirection`
`19`	`19`	`{`
	`20`	`+ Default,`
`20`	`21`	`Ascending,`
`21`	`22`	`Descending`
`22`	`23`	`}`