Merge branch 'uri-templates'

thefringeninja · thefringeninja · commit ea05d76d673b · 2018-09-03T15:39:23.000+02:00
diff --git a/src/SqlStreamStore.HAL.Tests/AllStreamMessageTests.cs b/src/SqlStreamStore.HAL.Tests/AllStreamMessageTests.cs
@@ -15,7 +15,7 @@ public AllStreamMessageTests()
 
         public void Dispose() => _fixture.Dispose();
         private readonly SqlStreamStoreHalMiddlewareFixture _fixture;
-        private const string HeadOfAll = "../stream?d=b&m=20&p=-1";
+        private const string HeadOfAll = "../stream?d=b&m=20&p=-1&e=0";
 
         [Fact]
         public async Task read_single_message_all_stream()
@@ -33,12 +33,14 @@ public async Task read_single_message_all_stream()
                 {
                     Constants.Relations.Self, 
                     Constants.Relations.Message, 
-                    Constants.Relations.Feed
+                    Constants.Relations.Feed,
+                    Constants.Relations.Find
                 });
 
                 resource.ShouldLink(Constants.Relations.Self, "0");
                 resource.ShouldLink(Constants.Relations.Message, "0");
                 resource.ShouldLink(Constants.Relations.Feed, HeadOfAll);
+                resource.ShouldLink(Constants.Relations.Find, "../streams/{streamId}", "Find a Stream");
             }
         }
 
@@ -51,9 +53,14 @@ public async Task read_single_message_does_not_exist_all_stream()
 
                 var resource = await response.AsHal();
 
-                resource.Links.Keys.ShouldBe(new[] { Constants.Relations.Feed });
+                resource.Links.Keys.ShouldBe(new[]
+                {
+                    Constants.Relations.Feed,
+                    Constants.Relations.Find
+                });
 
                 resource.ShouldLink(Constants.Relations.Feed, HeadOfAll);
+                resource.ShouldLink(Constants.Relations.Find, "../streams/{streamId}", "Find a Stream");
             }
         }
     }
diff --git a/src/SqlStreamStore.HAL.Tests/CanonicalUrlTests.cs b/src/SqlStreamStore.HAL.Tests/CanonicalUrlTests.cs
@@ -31,7 +31,7 @@ IEnumerable<string[]> GetPermutations(string[] items, int length)
 
             var d = $"d={(forward ? 'f' : 'b')}";
             var m = "m=20";
-            var e = prefetch ? "e" : null;
+            var e = $"e={(prefetch ? '1' : '0')}";
             var p = "p=0";
 
             var parameters = new[]
diff --git a/src/SqlStreamStore.HAL.Tests/SqlStreamStore.HAL.Tests.csproj b/src/SqlStreamStore.HAL.Tests/SqlStreamStore.HAL.Tests.csproj
@@ -20,10 +20,9 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="2.1.1" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.7.2" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.8.0" />
     <PackageReference Include="Shouldly" Version="3.0.0" />
-    <PackageReference Include="xunit" Version="2.3.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" />
-    <DotNetCliToolReference Include="dotnet-xunit" Version="2.3.1" />
+    <PackageReference Include="xunit" Version="2.4.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />
   </ItemGroup>
 </Project>
diff --git a/src/SqlStreamStore.HAL.Tests/StreamMessageTests.cs b/src/SqlStreamStore.HAL.Tests/StreamMessageTests.cs
@@ -15,7 +15,7 @@ public StreamMessageTests()
 
         public void Dispose() => _fixture.Dispose();
         private readonly SqlStreamStoreHalMiddlewareFixture _fixture;
-        private const string HeadOfStream = "../a-stream?d=b&m=20&p=-1";
+        private const string HeadOfStream = "../a-stream?d=b&m=20&p=-1&e=0";
 
         [Fact]
         public async Task read_single_message_stream()
@@ -36,7 +36,8 @@ public async Task read_single_message_stream()
                     Constants.Relations.Next,
                     Constants.Relations.Last,
                     Constants.Relations.Feed,
-                    Constants.Relations.Message
+                    Constants.Relations.Message,
+                    Constants.Relations.Find
                 });
 
                 resource.ShouldLink(Constants.Relations.Self, "0");
@@ -45,6 +46,7 @@ public async Task read_single_message_stream()
                 resource.ShouldLink(Constants.Relations.Last, "-1");
                 resource.ShouldLink(Constants.Relations.Feed, HeadOfStream);
                 resource.ShouldLink(Constants.Relations.Message, "0");
+                resource.ShouldLink(Constants.Relations.Find, "../../streams/{streamId}", "Find a Stream");
             }
         }
 
@@ -63,14 +65,16 @@ public async Task read_single_message_does_not_exist_stream()
                     Constants.Relations.First,
                     Constants.Relations.Last,
                     Constants.Relations.Feed,
-                    Constants.Relations.Message
+                    Constants.Relations.Message,
+                    Constants.Relations.Find
                 });
 
                 resource.ShouldLink(Constants.Relations.Self, "0");
                 resource.ShouldLink(Constants.Relations.First, "0");
                 resource.ShouldLink(Constants.Relations.Last, "-1");
                 resource.ShouldLink(Constants.Relations.Feed, HeadOfStream);
                 resource.ShouldLink(Constants.Relations.Message, "0");
+                resource.ShouldLink(Constants.Relations.Find, "../../streams/{streamId}", "Find a Stream");
             }
         }
 
diff --git a/src/SqlStreamStore.HAL.Tests/StreamNavigationTests.cs b/src/SqlStreamStore.HAL.Tests/StreamNavigationTests.cs
@@ -10,8 +10,8 @@
 
     public class StreamNavigationTests : IDisposable
     {
-        private const string FirstLinkQuery = "d=f&m=20&p=0";
-        private const string LastLinkQuery = "d=b&m=20&p=-1";
+        private const string FirstLinkQuery = "d=f&m=20&p=0&e=0";
+        private const string LastLinkQuery = "d=b&m=20&p=-1&e=0";
 
         private readonly SqlStreamStoreHalMiddlewareFixture _fixture;
 
@@ -81,7 +81,7 @@ await _fixture.HttpClient.GetAsync($"{baseAddress}{firstResponse.Headers.Locatio
 
                     resource.ShouldLink(Constants.Relations.Last, $"{stream}?{LastLinkQuery}");
 
-                    resource.ShouldLink(Constants.Relations.Previous, $"{stream}?d=b&m=20&p=9");
+                    resource.ShouldLink(Constants.Relations.Previous, $"{stream}?d=b&m=20&p=9&e=0");
 
                     resource.ShouldLink(Constants.Relations.First, $"{stream}?{FirstLinkQuery}");
 
@@ -136,7 +136,7 @@ public async Task read_first_link_when_multiple_pages(string stream, string base
 
                 resource.ShouldLink(Constants.Relations.Last, $"{stream}?{LastLinkQuery}");
 
-                resource.ShouldLink(Constants.Relations.Next, $"{stream}?d=f&m=20&p=20");
+                resource.ShouldLink(Constants.Relations.Next, $"{stream}?d=f&m=20&p=20&e=0");
 
                 resource.ShouldLink(Constants.Relations.First, $"{stream}?{FirstLinkQuery}");
 
diff --git a/src/SqlStreamStore.HAL/Constants.cs b/src/SqlStreamStore.HAL/Constants.cs
@@ -30,6 +30,7 @@ public static class Relations
             public const string Metadata = "streamStore:metadata";
             public const string AppendToStream = "streamStore:append";
             public const string Delete = "streamStore:delete";
+            public const string Find = "streamStore:find";
         }
 
         public static class Streams
diff --git a/src/SqlStreamStore.HAL/IndexMiddleware.cs b/src/SqlStreamStore.HAL/IndexMiddleware.cs
@@ -0,0 +1,34 @@
+namespace SqlStreamStore.HAL
+{
+    using Halcyon.HAL;
+    using Microsoft.AspNetCore.Builder;
+    using Microsoft.AspNetCore.Http;
+    using MidFunc = System.Func<
+        Microsoft.AspNetCore.Http.HttpContext,
+        System.Func<System.Threading.Tasks.Task>,
+        System.Threading.Tasks.Task
+    >;
+
+    internal static class IndexMiddleware
+    {
+        public static IApplicationBuilder UseIndex(this IApplicationBuilder builder)
+            => builder.MapWhen(IsIndex, inner => inner.Use(Index));
+
+        private static bool IsIndex(HttpContext context)
+            => (context.Request.Path.Value ?? "/") == "/";
+
+        private static MidFunc Index => async (context, next) =>
+        {
+            var response = new Response(new HALResponse(null)
+                .AddLinks(new Link(Constants.Relations.Feed, "stream"))
+                .AddLinks(new Link(Constants.Relations.Self, string.Empty))
+                .AddLinks(Links.Index(string.Empty))
+                .AddLinks(Links.Find("streams/{streamId}")));
+
+            using(new OptionalHeadRequestWrapper(context))
+            {
+                await context.WriteHalResponse(response);
+            }
+        };
+    }
+}
diff --git a/src/SqlStreamStore.HAL/Links.cs b/src/SqlStreamStore.HAL/Links.cs
@@ -0,0 +1,10 @@
+namespace SqlStreamStore.HAL
+{
+    using Halcyon.HAL;
+
+    internal static class Links
+    {
+        public static Link Find(string href) => new Link(Constants.Relations.Find, href, "Find a Stream", replaceParameters: false);
+        public static Link Index(string href) => new Link(Constants.Relations.Index, href, "Index", replaceParameters: false);
+    }
+}
diff --git a/src/SqlStreamStore.HAL/Resources/AllStreamMessageResource.cs b/src/SqlStreamStore.HAL/Resources/AllStreamMessageResource.cs
@@ -35,7 +35,8 @@ public async Task<Response> Get(
             {
                 return new Response(
                     new HALResponse(new HALModelConfig())
-                        .AddLinks(Links.Feed()),
+                        .AddLinks(Links.Feed())
+                        .AddLinks(Links.Find()),
                     404);
             }
 
@@ -55,11 +56,14 @@ public async Task<Response> Get(
                 }).AddLinks(
                     Links.Self(message),
                     Links.Message(message),
-                    Links.Feed()));
+                    Links.Feed(),
+                    Links.Find()));
         }
 
         private static class Links
         {
+            public static Link Find() => SqlStreamStore.HAL.Links.Find("../streams/{streamId}");
+
             public static Link Last()
                 => new Link(
                     Constants.Relations.Last,
diff --git a/src/SqlStreamStore.HAL/Resources/AllStreamResource.cs b/src/SqlStreamStore.HAL/Resources/AllStreamResource.cs
@@ -60,6 +60,7 @@ public async Task<Response> Get(
                     .AddLinks(Links.Self(operation))
                     .AddLinks(Links.Navigation(page, operation))
                     .AddLinks(Links.Feed(operation))
+                    .AddLinks(Links.Find())
                     .AddEmbeddedCollection(
                         Constants.Relations.Message,
                         streamMessages.Zip(
@@ -93,6 +94,8 @@ public async Task<Response> Get(
 
         private static class Links
         {
+            public static Link Find() => SqlStreamStore.HAL.Links.Find("../streams/{streamId}");
+
             public static Link Self(ReadAllStreamOperation operation)
                 => new Link(Constants.Relations.Self, operation.Self);
 
diff --git a/src/SqlStreamStore.HAL/Resources/LinkFormatter.cs b/src/SqlStreamStore.HAL/Resources/LinkFormatter.cs
@@ -3,7 +3,7 @@ namespace SqlStreamStore.HAL.Resources
     internal static class LinkFormatter
     {
         private static string FormatLink(string baseAddress, string direction, int maxCount, long position, bool prefetch)
-            => $"{baseAddress}?d={direction}&m={maxCount}&p={position}{(prefetch ? "&e" : string.Empty)}";
+            => $"{baseAddress}?d={direction}&m={maxCount}&p={position}&e={(prefetch ? 1 : 0)}";
 
         public static string FormatForwardLink(string baseAddress, int maxCount, long position, bool prefetch)
             => FormatLink(baseAddress, "f", maxCount, position, prefetch);
diff --git a/src/SqlStreamStore.HAL/Resources/ReadAllStreamOperation.cs b/src/SqlStreamStore.HAL/Resources/ReadAllStreamOperation.cs
@@ -12,7 +12,8 @@ internal class ReadAllStreamOperation : IStreamStoreOperation<ReadAllPage>
 
         public ReadAllStreamOperation(HttpRequest request)
         {
-            EmbedPayload = request.Query.TryGetValueCaseInsensitive('e', out _);
+            EmbedPayload = request.Query.TryGetValueCaseInsensitive('e', out var embedPayload)
+                           && embedPayload == "1";
 
             ReadDirection = request.Query.TryGetValueCaseInsensitive('d', out var readDirection)
                             && readDirection == "f" || readDirection == "F"
diff --git a/src/SqlStreamStore.HAL/Resources/ReadStreamOperation.cs b/src/SqlStreamStore.HAL/Resources/ReadStreamOperation.cs
@@ -14,7 +14,8 @@ public ReadStreamOperation(HttpRequest request)
         {
             StreamId = request.Path.Value.Remove(0, 1);
 
-            EmbedPayload = request.Query.TryGetValueCaseInsensitive('e', out _);
+            EmbedPayload = request.Query.TryGetValueCaseInsensitive('e', out var embedPayload)
+                           && embedPayload == "1";
 
             ReadDirection = request.Query.TryGetValueCaseInsensitive('d', out var readDirection)
                             && readDirection == "f" || readDirection == "F"
diff --git a/src/SqlStreamStore.HAL/Resources/StreamMessageResource.cs b/src/SqlStreamStore.HAL/Resources/StreamMessageResource.cs
@@ -43,7 +43,8 @@ public async Task<Response> Get(
                         })
                         .AddLinks(Links.Self(operation))
                         .AddLinks(Links.Navigation(operation))
-                        .AddLinks(Links.Message(operation)),
+                        .AddLinks(Links.Message(operation))
+                        .AddLinks(Links.Find()),
                     404);
             }
 
@@ -77,7 +78,8 @@ public async Task<Response> Get(
                         Schemas.DeleteStreamMessage)
                     .AddLinks(Links.Self(operation))
                     .AddLinks(Links.Navigation(operation, message))
-                    .AddLinks(Links.Message(operation)));
+                    .AddLinks(Links.Message(operation))
+                    .AddLinks(Links.Find()));
         }
 
         public async Task<Response> DeleteMessage(
@@ -92,6 +94,8 @@ public async Task<Response> DeleteMessage(
 
         private static class Links
         {
+            public static Link Find() => SqlStreamStore.HAL.Links.Find("../../streams/{streamId}");
+
             public static Link Self(ReadStreamMessageByStreamVersionOperation operation) => new Link(
                 Constants.Relations.Self,
                 $"{operation.StreamVersion}");
diff --git a/src/SqlStreamStore.HAL/Resources/StreamMetadataResource.cs b/src/SqlStreamStore.HAL/Resources/StreamMetadataResource.cs
@@ -74,6 +74,7 @@ public async Task<Response> Post(
 
         private static class Links
         {
+            public static Link Find() => SqlStreamStore.HAL.Links.Find("../{streamId}");
             public static Link Self() => new Link(Constants.Relations.Self, Constants.Streams.Metadata);
             public static Link Metadata() => new Link(Constants.Relations.Metadata, Constants.Streams.Metadata);
             public static Link Feed(GetStreamMetadataOperation operation) => Link(operation.StreamId);
diff --git a/src/SqlStreamStore.HAL/Resources/StreamResource.cs b/src/SqlStreamStore.HAL/Resources/StreamResource.cs
@@ -38,7 +38,8 @@ public async Task<Response> Post(
             var response = new Response(
                 new HALResponse(result)
                     .AddLinks(Links.Self(operation))
-                    .AddLinks(Links.Feed(operation)),
+                    .AddLinks(Links.Feed(operation))
+                    .AddLinks(Links.Find()),
                 result.CurrentVersion == 0
                     ? 201
                     : 200);
@@ -85,6 +86,7 @@ public async Task<Response> Get(ReadStreamOperation operation, CancellationToken
                     .AddLinks(Links.Feed(operation))
                     .AddLinks(Links.Metadata(operation))
                     .AddLinks(Links.Index())
+                    .AddLinks(Links.Find())
                     .AddEmbeddedResource(
                         Constants.Relations.AppendToStream,
                         Schemas.AppendToStream)
@@ -121,6 +123,8 @@ public async Task<Response> Delete(DeleteStreamOperation operation, Cancellation
 
         private static class Links
         {
+            public static Link Find() => SqlStreamStore.HAL.Links.Find("../streams/{streamId}");
+            
             public static Link First(ReadStreamPage page, ReadStreamOperation operation)
                 => new Link(
                     Constants.Relations.First,
diff --git a/src/SqlStreamStore.HAL/SqlStreamStoreHalMiddleware.cs b/src/SqlStreamStore.HAL/SqlStreamStoreHalMiddleware.cs
@@ -57,21 +57,6 @@ private static MidFunc MethodsNotAllowed(params string[] methods) => (context, n
                     406));
         };
 
-        private static MidFunc Index => (context, next) =>
-        {
-            if((context.Request.Path.Value ?? "/") != "/")
-            {
-                return next();
-            }
-
-            var response = new Response(new HALResponse(null)
-                .AddLinks(new Link(Constants.Relations.Feed, "stream"))
-                .AddLinks(new Link(Constants.Relations.Self, string.Empty))
-                .AddLinks(new Link(Constants.Relations.Index, string.Empty)));
-
-            return context.WriteHalResponse(response);
-        };
-
         public static IApplicationBuilder UseSqlStreamStoreHal(
             this IApplicationBuilder builder,
             IStreamStore streamStore)
@@ -85,7 +70,7 @@ public static IApplicationBuilder UseSqlStreamStoreHal(
                 .Use(ExceptionHandlingMiddleware.HandleExceptions)
                 .Use(CaseSensitiveQueryStrings)
                 .Use(AcceptHalJson)
-                .Use(Index)
+                .UseIndex()
                 .Map("/stream", UseAllStream(streamStore))
                 .Map("/streams", UseStream(streamStore));
         }

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public AllStreamMessageTests()`
`15`	`15`
`16`	`16`	`public void Dispose() => _fixture.Dispose();`
`17`	`17`	`private readonly SqlStreamStoreHalMiddlewareFixture _fixture;`
`18`		`- private const string HeadOfAll = "../stream?d=b&m=20&p=-1";`
	`18`	`+ private const string HeadOfAll = "../stream?d=b&m=20&p=-1&e=0";`
`19`	`19`
`20`	`20`	`[Fact]`
`21`	`21`	`public async Task read_single_message_all_stream()`
`@@ -33,12 +33,14 @@ public async Task read_single_message_all_stream()`
`33`	`33`	`{`
`34`	`34`	`Constants.Relations.Self,`
`35`	`35`	`Constants.Relations.Message,`
`36`		`- Constants.Relations.Feed`
	`36`	`+ Constants.Relations.Feed,`
	`37`	`+ Constants.Relations.Find`
`37`	`38`	`});`
`38`	`39`
`39`	`40`	`resource.ShouldLink(Constants.Relations.Self, "0");`
`40`	`41`	`resource.ShouldLink(Constants.Relations.Message, "0");`
`41`	`42`	`resource.ShouldLink(Constants.Relations.Feed, HeadOfAll);`
	`43`	`+ resource.ShouldLink(Constants.Relations.Find, "../streams/{streamId}", "Find a Stream");`
`42`	`44`	`}`
`43`	`45`	`}`
`44`	`46`
`@@ -51,9 +53,14 @@ public async Task read_single_message_does_not_exist_all_stream()`
`51`	`53`
`52`	`54`	`var resource = await response.AsHal();`
`53`	`55`
`54`		`- resource.Links.Keys.ShouldBe(new[] { Constants.Relations.Feed });`
	`56`	`+ resource.Links.Keys.ShouldBe(new[]`
	`57`	`+ {`
	`58`	`+ Constants.Relations.Feed,`
	`59`	`+ Constants.Relations.Find`
	`60`	`+ });`
`55`	`61`
`56`	`62`	`resource.ShouldLink(Constants.Relations.Feed, HeadOfAll);`
	`63`	`+ resource.ShouldLink(Constants.Relations.Find, "../streams/{streamId}", "Find a Stream");`
`57`	`64`	`}`
`58`	`65`	`}`
`59`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ public static class Relations`
`30`	`30`	`public const string Metadata = "streamStore:metadata";`
`31`	`31`	`public const string AppendToStream = "streamStore:append";`
`32`	`32`	`public const string Delete = "streamStore:delete";`
	`33`	`+ public const string Find = "streamStore:find";`
`33`	`34`	`}`
`34`	`35`
`35`	`36`	`public static class Streams`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,8 @@ public async Task<Response> Get(`
`35`	`35`	`{`
`36`	`36`	`return new Response(`
`37`	`37`	`new HALResponse(new HALModelConfig())`
`38`		`- .AddLinks(Links.Feed()),`
	`38`	`+ .AddLinks(Links.Feed())`
	`39`	`+ .AddLinks(Links.Find()),`
`39`	`40`	`404);`
`40`	`41`	`}`
`41`	`42`
`@@ -55,11 +56,14 @@ public async Task<Response> Get(`
`55`	`56`	`}).AddLinks(`
`56`	`57`	`Links.Self(message),`
`57`	`58`	`Links.Message(message),`
`58`		`- Links.Feed()));`
	`59`	`+ Links.Feed(),`
	`60`	`+ Links.Find()));`
`59`	`61`	`}`
`60`	`62`
`61`	`63`	`private static class Links`
`62`	`64`	`{`
	`65`	`+ public static Link Find() => SqlStreamStore.HAL.Links.Find("../streams/{streamId}");`
	`66`	`+`
`63`	`67`	`public static Link Last()`
`64`	`68`	`=> new Link(`
`65`	`69`	`Constants.Relations.Last,`