make 308 redirects on non canonical urls optional

thefringeninja · thefringeninja · commit 451322aef7ff · 2018-09-20T17:42:21.000+02:00
diff --git a/src/SqlStreamStore.HAL/AllStreamOptionsMiddleware.cs b/src/SqlStreamStore.HAL/AllStreamOptionsMiddleware.cs
@@ -15,7 +15,7 @@ internal static class AllStreamOptionsMiddleware
     {
         public static IApplicationBuilder UseAllStreamOptions(this IApplicationBuilder builder, IStreamStore streamStore)
         {
-            var allStream = new AllStreamResource(streamStore);
+            var allStream = new AllStreamResource(streamStore, false);
             var allStreamMessages = new AllStreamMessageResource(streamStore);
 
             return builder
diff --git a/src/SqlStreamStore.HAL/AppendStreamMiddleware.cs b/src/SqlStreamStore.HAL/AppendStreamMiddleware.cs
@@ -13,7 +13,7 @@ internal static class AppendStreamMiddleware
     {
         public static IApplicationBuilder UseAppendStream(this IApplicationBuilder builder, IStreamStore streamStore)
         {
-            var stream = new StreamResource(streamStore);
+            var stream = new StreamResource(streamStore, false);
             
             return builder.MapWhen(IsStream, inner => inner.Use(AppendStream(stream)));
         }
diff --git a/src/SqlStreamStore.HAL/DeleteStreamMiddleware.cs b/src/SqlStreamStore.HAL/DeleteStreamMiddleware.cs
@@ -13,7 +13,7 @@ internal static class DeleteStreamMiddleware
     {
         public static IApplicationBuilder UseDeleteStream(this IApplicationBuilder builder, IStreamStore streamStore)
         {
-            var streams = new StreamResource(streamStore);
+            var streams = new StreamResource(streamStore, false);
             var streamMessages = new StreamMessageResource(streamStore);
             
             return builder
diff --git a/src/SqlStreamStore.HAL/ReadAllStreamMiddleware.cs b/src/SqlStreamStore.HAL/ReadAllStreamMiddleware.cs
@@ -11,9 +11,12 @@ namespace SqlStreamStore.HAL
 
     internal static class ReadAllStreamMiddleware
     {
-        public static IApplicationBuilder UseReadAllStream(this IApplicationBuilder builder, IStreamStore streamStore)
+        public static IApplicationBuilder UseReadAllStream(
+            this IApplicationBuilder builder,
+            IStreamStore streamStore,
+            SqlStreamStoreMiddlewareOptions options)
         {
-            var allStream = new AllStreamResource(streamStore);
+            var allStream = new AllStreamResource(streamStore, options.UseCanonicalUrls);
             var allStreamMessages = new AllStreamMessageResource(streamStore);
 
             return builder
diff --git a/src/SqlStreamStore.HAL/ReadStreamMiddleware.cs b/src/SqlStreamStore.HAL/ReadStreamMiddleware.cs
@@ -11,9 +11,12 @@ namespace SqlStreamStore.HAL
 
     internal static class ReadStreamMiddleware
     {
-        public static IApplicationBuilder UseReadStream(this IApplicationBuilder builder, IStreamStore streamStore)
+        public static IApplicationBuilder UseReadStream(
+            this IApplicationBuilder builder,
+            IStreamStore streamStore, 
+            SqlStreamStoreMiddlewareOptions options)
         {
-            var streams = new StreamResource(streamStore);
+            var streams = new StreamResource(streamStore, options.UseCanonicalUrls);
             var streamMessages = new StreamMessageResource(streamStore);
 
             return builder
diff --git a/src/SqlStreamStore.HAL/Resources/AllStreamResource.cs b/src/SqlStreamStore.HAL/Resources/AllStreamResource.cs
@@ -12,6 +12,7 @@
     internal class AllStreamResource : IResource
     {
         private readonly IStreamStore _streamStore;
+        private readonly bool _useCanonicalUrls;
 
         public HttpMethod[] Allowed { get; } =
         {
@@ -20,18 +21,19 @@ internal class AllStreamResource : IResource
             HttpMethod.Options
         };
 
-        public AllStreamResource(IStreamStore streamStore)
+        public AllStreamResource(IStreamStore streamStore, bool useCanonicalUrls)
         {
             if(streamStore == null)
                 throw new ArgumentNullException(nameof(streamStore));
             _streamStore = streamStore;
+            _useCanonicalUrls = useCanonicalUrls;
         }
 
         public async Task<Response> Get(
             ReadAllStreamOperation operation,
             CancellationToken cancellationToken)
         {
-            if(!operation.IsUriCanonical)
+            if(_useCanonicalUrls && !operation.IsUriCanonical)
             {
                 return new Response(new HALResponse(null), 308)
                 {
diff --git a/src/SqlStreamStore.HAL/Resources/StreamResource.cs b/src/SqlStreamStore.HAL/Resources/StreamResource.cs
@@ -12,6 +12,7 @@ namespace SqlStreamStore.HAL.Resources
     internal class StreamResource : IResource
     {
         private readonly IStreamStore _streamStore;
+        private readonly bool _useCanonicalUris;
 
         public HttpMethod[] Allowed { get; } =
         {
@@ -22,11 +23,12 @@ internal class StreamResource : IResource
             HttpMethod.Delete
         };
 
-        public StreamResource(IStreamStore streamStore)
+        public StreamResource(IStreamStore streamStore, bool useCanonicalUris)
         {
             if(streamStore == null)
                 throw new ArgumentNullException(nameof(streamStore));
             _streamStore = streamStore;
+            _useCanonicalUris = useCanonicalUris;
         }
 
         public async Task<Response> Post(
diff --git a/src/SqlStreamStore.HAL/SqlStreamStoreHalMiddleware.cs b/src/SqlStreamStore.HAL/SqlStreamStoreHalMiddleware.cs
@@ -16,18 +16,6 @@
 
     public static class SqlStreamStoreHalMiddleware
     {
-        private static readonly string[] s_NoCache =
-        {
-            "max-age=0",
-            "no-cache",
-            "must-revalidate"
-        };
-
-        private static readonly string[] s_CacheForOneYear =
-        {
-            "max-age=31536000"
-        };
-
         private static MidFunc CaseSensitiveQueryStrings => (context, next) =>
         {
             if(context.Request.QueryString != QueryString.Empty)
@@ -81,36 +69,43 @@ private static MidFunc MethodsNotAllowed(params string[] methods) => (context, n
 
         public static IApplicationBuilder UseSqlStreamStoreHal(
             this IApplicationBuilder builder,
-            IStreamStore streamStore)
+            IStreamStore streamStore,
+            SqlStreamStoreMiddlewareOptions options = default)
         {
             if(builder == null)
                 throw new ArgumentNullException(nameof(builder));
             if(streamStore == null)
                 throw new ArgumentNullException(nameof(streamStore));
 
+            options = options ?? new SqlStreamStoreMiddlewareOptions();
+
             return builder
                 .UseExceptionHandling()
                 .Use(CaseSensitiveQueryStrings)
                 .Use(AcceptHalJson)
                 .Use(HeadRequests)
                 .UseIndex()
-                .Map("/stream", UseAllStream(streamStore))
-                .Map("/streams", UseStream(streamStore));
+                .Map("/stream", UseAllStream(streamStore, options))
+                .Map("/streams", UseStream(streamStore, options));
         }
 
-        private static Action<IApplicationBuilder> UseStream(IStreamStore streamStore)
+        private static Action<IApplicationBuilder> UseStream(
+            IStreamStore streamStore,
+            SqlStreamStoreMiddlewareOptions options)
             => builder => builder
                 .MapWhen(IsOptions, inner => inner.UseStreamOptions(streamStore))
                 .UseStreamMetadata(streamStore)
-                .UseReadStream(streamStore)
+                .UseReadStream(streamStore, options)
                 .UseAppendStream(streamStore)
                 .UseDeleteStream(streamStore)
                 .Use(MethodsNotAllowed("TRACE", "PATCH"));
 
-        private static Action<IApplicationBuilder> UseAllStream(IStreamStore streamStore)
+        private static Action<IApplicationBuilder> UseAllStream(
+            IStreamStore streamStore,
+            SqlStreamStoreMiddlewareOptions options)
             => builder => builder
                 .MapWhen(IsOptions, inner => inner.UseAllStreamOptions(streamStore))
-                .UseReadAllStream(streamStore)
+                .UseReadAllStream(streamStore, options)
                 .Use(MethodsNotAllowed("POST", "PUT", "DELETE", "TRACE", "PATCH"));
 
         private static bool IsOptions(HttpContext context) => context.IsOptions();
diff --git a/src/SqlStreamStore.HAL/SqlStreamStoreMiddlewareOptions.cs b/src/SqlStreamStore.HAL/SqlStreamStoreMiddlewareOptions.cs
@@ -0,0 +1,7 @@
+﻿namespace SqlStreamStore.HAL
+{
+    public class SqlStreamStoreMiddlewareOptions
+    {
+        public bool UseCanonicalUrls { get; set; } = true;
+    }
+}
diff --git a/src/SqlStreamStore.HAL/StreamOptionsMiddleware.cs b/src/SqlStreamStore.HAL/StreamOptionsMiddleware.cs
@@ -15,7 +15,7 @@ internal static class StreamOptionsMiddleware
     {
         public static IApplicationBuilder UseStreamOptions(this IApplicationBuilder builder, IStreamStore streamStore)
         {
-            var streams = new StreamResource(streamStore);
+            var streams = new StreamResource(streamStore, false);
             var streamMessages = new StreamMessageResource(streamStore);
             var streamsMetadata = new StreamMetadataResource(streamStore);
 

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ internal static class AllStreamOptionsMiddleware`
`15`	`15`	`{`
`16`	`16`	`public static IApplicationBuilder UseAllStreamOptions(this IApplicationBuilder builder, IStreamStore streamStore)`
`17`	`17`	`{`
`18`		`- var allStream = new AllStreamResource(streamStore);`
	`18`	`+ var allStream = new AllStreamResource(streamStore, false);`
`19`	`19`	`var allStreamMessages = new AllStreamMessageResource(streamStore);`
`20`	`20`
`21`	`21`	`return builder`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ internal static class AppendStreamMiddleware`
`13`	`13`	`{`
`14`	`14`	`public static IApplicationBuilder UseAppendStream(this IApplicationBuilder builder, IStreamStore streamStore)`
`15`	`15`	`{`
`16`		`- var stream = new StreamResource(streamStore);`
	`16`	`+ var stream = new StreamResource(streamStore, false);`
`17`	`17`
`18`	`18`	`return builder.MapWhen(IsStream, inner => inner.Use(AppendStream(stream)));`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,12 @@ namespace SqlStreamStore.HAL`
`11`	`11`
`12`	`12`	`internal static class ReadAllStreamMiddleware`
`13`	`13`	`{`
`14`		`- public static IApplicationBuilder UseReadAllStream(this IApplicationBuilder builder, IStreamStore streamStore)`
	`14`	`+ public static IApplicationBuilder UseReadAllStream(`
	`15`	`+ this IApplicationBuilder builder,`
	`16`	`+ IStreamStore streamStore,`
	`17`	`+ SqlStreamStoreMiddlewareOptions options)`
`15`	`18`	`{`
`16`		`- var allStream = new AllStreamResource(streamStore);`
	`19`	`+ var allStream = new AllStreamResource(streamStore, options.UseCanonicalUrls);`
`17`	`20`	`var allStreamMessages = new AllStreamMessageResource(streamStore);`
`18`	`21`
`19`	`22`	`return builder`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`internal class AllStreamResource : IResource`
`13`	`13`	`{`
`14`	`14`	`private readonly IStreamStore _streamStore;`
	`15`	`+ private readonly bool _useCanonicalUrls;`
`15`	`16`
`16`	`17`	`public HttpMethod[] Allowed { get; } =`
`17`	`18`	`{`
`@@ -20,18 +21,19 @@ internal class AllStreamResource : IResource`
`20`	`21`	`HttpMethod.Options`
`21`	`22`	`};`
`22`	`23`
`23`		`- public AllStreamResource(IStreamStore streamStore)`
	`24`	`+ public AllStreamResource(IStreamStore streamStore, bool useCanonicalUrls)`
`24`	`25`	`{`
`25`	`26`	`if(streamStore == null)`
`26`	`27`	`throw new ArgumentNullException(nameof(streamStore));`
`27`	`28`	`_streamStore = streamStore;`
	`29`	`+ _useCanonicalUrls = useCanonicalUrls;`
`28`	`30`	`}`
`29`	`31`
`30`	`32`	`public async Task<Response> Get(`
`31`	`33`	`ReadAllStreamOperation operation,`
`32`	`34`	`CancellationToken cancellationToken)`
`33`	`35`	`{`
`34`		`- if(!operation.IsUriCanonical)`
	`36`	`+ if(_useCanonicalUrls && !operation.IsUriCanonical)`
`35`	`37`	`{`
`36`	`38`	`return new Response(new HALResponse(null), 308)`
`37`	`39`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ namespace SqlStreamStore.HAL.Resources`
`12`	`12`	`internal class StreamResource : IResource`
`13`	`13`	`{`
`14`	`14`	`private readonly IStreamStore _streamStore;`
	`15`	`+ private readonly bool _useCanonicalUris;`
`15`	`16`
`16`	`17`	`public HttpMethod[] Allowed { get; } =`
`17`	`18`	`{`
`@@ -22,11 +23,12 @@ internal class StreamResource : IResource`
`22`	`23`	`HttpMethod.Delete`
`23`	`24`	`};`
`24`	`25`
`25`		`- public StreamResource(IStreamStore streamStore)`
	`26`	`+ public StreamResource(IStreamStore streamStore, bool useCanonicalUris)`
`26`	`27`	`{`
`27`	`28`	`if(streamStore == null)`
`28`	`29`	`throw new ArgumentNullException(nameof(streamStore));`
`29`	`30`	`_streamStore = streamStore;`
	`31`	`+ _useCanonicalUris = useCanonicalUris;`
`30`	`32`	`}`
`31`	`33`
`32`	`34`	`public async Task<Response> Post(`