Add http cookies (micronaut-projects#4000)

* Add support for retrieving cookies from non mutable responses

Author: cassadyj

http-client/src/main/java/io/micronaut/http/client/netty/FullNettyClientHttpResponse.java

@@ -31,8 +31,11 @@
 import io.micronaut.http.MediaType;
 import io.micronaut.http.codec.MediaTypeCodec;
 import io.micronaut.http.codec.MediaTypeCodecRegistry;
+import io.micronaut.http.cookie.Cookie;
+import io.micronaut.http.cookie.Cookies;
 import io.micronaut.http.netty.NettyHttpHeaders;
 import io.micronaut.http.netty.NettyHttpResponseBuilder;
+import io.micronaut.http.netty.cookies.NettyCookies;
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.ByteBufAllocator;
 import io.netty.buffer.ByteBufUtil;
@@ -60,6 +63,7 @@ public class FullNettyClientHttpResponse<B> implements HttpResponse<B>, Completa
 
     private final HttpStatus status;
     private final NettyHttpHeaders headers;
+    private final NettyCookies nettyCookies;
     private final MutableConvertibleValues<Object> attributes;
     private final FullHttpResponse nettyHttpResponse;
     private final Map<Argument, Optional> convertedBodies = new HashMap<>();
@@ -91,6 +95,7 @@ public class FullNettyClientHttpResponse<B> implements HttpResponse<B>, Completa
         this.nettyHttpResponse = fullHttpResponse;
         this.mediaTypeCodecRegistry = mediaTypeCodecRegistry;
         this.byteBufferFactory = byteBufferFactory;
+        this.nettyCookies = new NettyCookies(fullHttpResponse.headers(), ConversionService.SHARED);
         Class<?> rawBodyType = bodyType != null ? bodyType.getType() : null;
         if (rawBodyType != null && !HttpStatus.class.isAssignableFrom(rawBodyType)) {
             if (HttpResponse.class.isAssignableFrom(bodyType.getType())) {
@@ -124,6 +129,16 @@ public HttpHeaders getHeaders() {
         return headers;
     }
 
+    @Override
+    public Cookies getCookies() {
+        return nettyCookies;
+    }
+
+    @Override
+    public Optional<Cookie> getCookie(String name) {
+        return nettyCookies.findCookie(name);
+    }
+
     @Override
     public MutableConvertibleValues<Object> getAttributes() {
         return attributes;

http-client/src/main/java/io/micronaut/http/client/netty/NettyStreamedHttpResponse.java

@@ -23,9 +23,11 @@
 import io.micronaut.core.convert.value.MutableConvertibleValuesMap;
 import io.micronaut.http.*;
 import io.micronaut.http.cookie.Cookie;
+import io.micronaut.http.cookie.Cookies;
 import io.micronaut.http.netty.NettyHttpHeaders;
 import io.micronaut.http.netty.NettyHttpResponseBuilder;
 import io.micronaut.http.netty.cookies.NettyCookie;
+import io.micronaut.http.netty.cookies.NettyCookies;
 import io.micronaut.http.netty.stream.StreamedHttpResponse;
 import io.netty.handler.codec.http.FullHttpResponse;
 import io.netty.handler.codec.http.HttpHeaderNames;
@@ -47,6 +49,7 @@ class NettyStreamedHttpResponse<B> implements MutableHttpResponse<B>, NettyHttpR
     private final StreamedHttpResponse nettyResponse;
     private HttpStatus status;
     private final NettyHttpHeaders headers;
+    private final NettyCookies nettyCookies;
     private B body;
     private MutableConvertibleValues<Object> attributes;
 
@@ -58,6 +61,7 @@ class NettyStreamedHttpResponse<B> implements MutableHttpResponse<B>, NettyHttpR
         this.nettyResponse = response;
         this.status = httpStatus;
         this.headers = new NettyHttpHeaders(response.headers(), ConversionService.SHARED);
+        this.nettyCookies = new NettyCookies(response.headers(), ConversionService.SHARED);
     }
 
     /**
@@ -146,6 +150,16 @@ public MutableHttpResponse<B> cookie(Cookie cookie) {
         return this;
     }
 
+    @Override
+    public Cookies getCookies() {
+        return nettyCookies;
+    }
+
+    @Override
+    public Optional<Cookie> getCookie(String name) {
+        return nettyCookies.findCookie(name);
+    }
+
     @Override
     public <T> MutableHttpResponse<T> body(@Nullable T body) {
         this.body = (B) body;

http-client/src/test/groovy/io/micronaut/http/client/netty/FullNettyClientHttpResponseSpec.groovy

@@ -0,0 +1,33 @@
+package io.micronaut.http.client.netty
+
+import io.micronaut.http.HttpStatus
+import io.micronaut.http.cookie.Cookie
+import io.micronaut.http.cookie.Cookies
+import io.netty.handler.codec.http.*
+import spock.lang.Specification
+
+class FullNettyClientHttpResponseSpec extends Specification {
+
+    void "test cookies"() {
+        given:
+          String cookieDef = "simple-cookie=avalue; max-age=60; path=/; domain=.micronaut.io";
+          HttpHeaders httpHeaders = new DefaultHttpHeaders(false).add(HttpHeaderNames.SET_COOKIE, cookieDef);
+          FullHttpResponse fullHttpResponse = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK);
+          fullHttpResponse.headers().set(httpHeaders);
+
+        when:
+          FullNettyClientHttpResponse response = new FullNettyClientHttpResponse(fullHttpResponse, HttpStatus.OK, null, null, null, false);
+
+        then:
+            Cookies cookies = response.getCookies();
+            cookies != null;
+            cookies.size() == 4;
+            cookies.contains("simple-cookie");
+            Optional<Cookie> oCookie = response.getCookie("simple-cookie");
+            oCookie.isPresent();
+            oCookie.get().getValue().equals("avalue");
+
+    }
+
+}
+

http-client/src/test/groovy/io/micronaut/http/client/netty/NettyStreamedHttpResponseSpec.groovy

@@ -0,0 +1,35 @@
+package io.micronaut.http.client.netty
+
+import io.micronaut.http.HttpStatus
+import io.micronaut.http.cookie.Cookie
+import io.micronaut.http.cookie.Cookies
+import io.micronaut.http.netty.stream.DefaultStreamedHttpResponse
+import io.micronaut.http.netty.stream.StreamedHttpResponse
+import io.netty.handler.codec.http.*
+import spock.lang.Specification
+
+class NettyStreamedHttpResponseSpec extends Specification {
+
+
+    void "test cookies"() {
+        given:
+        String cookieDef = "simple-cookie=avalue; max-age=60; path=/; domain=.micronaut.io";
+        HttpHeaders httpHeaders = new DefaultHttpHeaders(false).add(HttpHeaderNames.SET_COOKIE, cookieDef);
+        StreamedHttpResponse streamedHttpResponse = new DefaultStreamedHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK, null);
+        streamedHttpResponse.headers().set(httpHeaders);
+
+        when:
+        NettyStreamedHttpResponse response = new NettyStreamedHttpResponse(streamedHttpResponse, HttpStatus.OK);
+
+        then:
+        Cookies cookies = response.getCookies();
+        cookies != null;
+        cookies.size() == 4;
+        cookies.contains("simple-cookie");
+        Optional<Cookie> oCookie = response.getCookie("simple-cookie");
+        oCookie.isPresent();
+        oCookie.get().getValue().equals("avalue");
+
+    }
+
+}

http-netty/src/main/java/io/micronaut/http/netty/cookies/NettyCookies.java

@@ -68,6 +68,28 @@ public NettyCookies(String path, HttpHeaders nettyHeaders, ConversionService con
         }
     }
 
+    /**
+     * @param nettyHeaders      The Netty HTTP headers
+     * @param conversionService The conversion service
+     */
+    public NettyCookies(HttpHeaders nettyHeaders, ConversionService conversionService) {
+        this.conversionService = conversionService;
+        if (nettyHeaders != null) {
+            String value = nettyHeaders.get(HttpHeaderNames.SET_COOKIE);
+            if (value != null) {
+                cookies = new LinkedHashMap<>();
+                Set<io.netty.handler.codec.http.cookie.Cookie> nettyCookies = ServerCookieDecoder.STRICT.decode(value);
+                for (io.netty.handler.codec.http.cookie.Cookie nettyCookie : nettyCookies) {
+                    cookies.put(nettyCookie.name(), new NettyCookie(nettyCookie));
+                }
+            } else {
+                cookies = Collections.emptyMap();
+            }
+        } else {
+            cookies = Collections.emptyMap();
+        }
+    }
+
     @Override
     public Set<Cookie> getAll() {
         return new HashSet<>(cookies.values());

http-netty/src/test/groovy/io/micronaut/http/netty/cookies/NettyCookiesSpec.groovy

@@ -0,0 +1,28 @@
+package io.micronaut.http.netty.cookies
+
+import io.micronaut.core.convert.ConversionService
+import io.micronaut.http.cookie.Cookie
+import io.netty.handler.codec.http.DefaultHttpHeaders
+import io.netty.handler.codec.http.HttpHeaderNames
+import io.netty.handler.codec.http.HttpHeaders
+import spock.lang.Specification
+
+class NettyCookiesSpec extends Specification {
+
+
+    void "test ctor creates cookies from headers and ConversionSpecification"() {
+        given:
+        String cookieDef = "simple-cookie=avalue; max-age=60; path=/; domain=.micronaut.io";
+        HttpHeaders httpHeaders = new DefaultHttpHeaders(false).add(HttpHeaderNames.SET_COOKIE, cookieDef);
+
+        when:
+            NettyCookies nettyCookies = new NettyCookies(httpHeaders, ConversionService.SHARED);
+
+        then:
+          Cookie cookie = nettyCookies.get("simple-cookie");
+          cookie != null;
+          cookie.getValue().equals("avalue");
+
+    }
+
+}

http/src/main/java/io/micronaut/http/HttpResponse.java

@@ -15,11 +15,14 @@
  */
 package io.micronaut.http;
 
+import io.micronaut.http.cookie.Cookie;
+import io.micronaut.http.cookie.Cookies;
 import io.micronaut.http.exceptions.UriSyntaxException;
 
 import edu.umd.cs.findbugs.annotations.Nullable;
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.Optional;
 import java.util.Set;
 
 /**
@@ -398,4 +401,21 @@ static URI uri(CharSequence uri) {
             throw new UriSyntaxException(e);
         }
     }
+
+    /**
+     * Helper method for retrieving all Cookies on a response.
+     * @return The cookies on the response
+     */
+    default Cookies getCookies() {
+        throw new UnsupportedOperationException("Operation not supported on a " + this.getClass() + " response.");
+    }
+
+    /**
+     * Helper method for retrieving a single Cookie on a response.
+     * @param name The name of the Cookie
+     * @return The Cookie
+     */
+    default Optional<Cookie> getCookie(String name) {
+        throw new UnsupportedOperationException("Operation not supported on a " + this.getClass() + " response.");
+    }
 }

http/src/main/java/io/micronaut/http/bind/binders/QueryValueArgumentBinder.java

@@ -31,7 +31,7 @@
 import java.util.Collections;
 
 /**
- * A binder for binding arguments annotated with @QueryValue
+ * A binder for binding arguments annotated with @QueryValue.
  *
  * @param <T> The argument type
  * @author James Kleeh