Implemented cookie jar and its use in http redirection (#1495), close #1235

Motivation:

Existing implementation doesn't have proper support of cookie jar. It causes problem when requesting http URL that redirects to another location.

Modifications:

Implemented configurable CookieStore and default thread-safe implementation of it. Also modified redirection interceptor to use it.

Result:

Cookie store will be used for all http requests.

Author: unoexperto

client/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java

@@ -20,6 +20,7 @@
 
 import org.asynchttpclient.channel.ChannelPool;
 import org.asynchttpclient.channel.KeepAliveStrategy;
+import org.asynchttpclient.cookie.CookieStore;
 import org.asynchttpclient.filter.IOExceptionFilter;
 import org.asynchttpclient.filter.RequestFilter;
 import org.asynchttpclient.filter.ResponseFilter;
@@ -182,6 +183,13 @@ public interface AsyncHttpClientConfig {
      */
     List<IOExceptionFilter> getIoExceptionFilters();
 
+    /**
+     * Return cookie store that is used to store and retrieve cookies
+     *
+     * @return {@link CookieStore} object
+     */
+    CookieStore getCookieStore();
+
     /**
      * Return the number of time the library will retry when an {@link java.io.IOException} is throw by the remote server
      *

client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClient.java

@@ -18,9 +18,11 @@
 
 import static org.asynchttpclient.util.Assertions.assertNotNull;
 
+import java.util.List;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.function.Predicate;
 
+import io.netty.handler.codec.http.cookie.Cookie;
 import org.asynchttpclient.channel.ChannelPool;
 import org.asynchttpclient.filter.FilterContext;
 import org.asynchttpclient.filter.FilterException;
@@ -180,6 +182,22 @@ public BoundRequestBuilder prepareRequest(RequestBuilder requestBuilder) {
 
     @Override
     public <T> ListenableFuture<T> executeRequest(Request request, AsyncHandler<T> handler) {
+        if (config.getCookieStore() != null) {
+            try {
+                List<Cookie> cookies = config.getCookieStore().get(request.getUri());
+                if (!cookies.isEmpty()) {
+                    RequestBuilder requestBuilder = new RequestBuilder(request);
+                    for (Cookie cookie : cookies)
+                        requestBuilder.addOrReplaceCookie(cookie);
+
+                    request = requestBuilder.build();
+                }
+            } catch (Exception e) {
+                handler.onThrowable(e);
+                return new ListenableFuture.CompletedFailure<>("Failed to set cookies of request", e);
+            }
+        }
+
         if (noRequestFilters) {
             return execute(request, handler);
         } else {

client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClientConfig.java

@@ -26,6 +26,8 @@
 import org.asynchttpclient.channel.ChannelPool;
 import org.asynchttpclient.channel.DefaultKeepAliveStrategy;
 import org.asynchttpclient.channel.KeepAliveStrategy;
+import org.asynchttpclient.cookie.CookieStore;
+import org.asynchttpclient.cookie.ThreadSafeCookieStore;
 import org.asynchttpclient.filter.IOExceptionFilter;
 import org.asynchttpclient.filter.RequestFilter;
 import org.asynchttpclient.filter.ResponseFilter;
@@ -110,6 +112,9 @@ public class DefaultAsyncHttpClientConfig implements AsyncHttpClientConfig {
     private final List<ResponseFilter> responseFilters;
     private final List<IOExceptionFilter> ioExceptionFilters;
 
+    // cookie store
+    private final CookieStore cookieStore;
+
     // internals
     private final String threadPoolName;
     private final int httpClientCodecMaxInitialLineLength;
@@ -186,6 +191,9 @@ private DefaultAsyncHttpClientConfig(//
             List<ResponseFilter> responseFilters,//
             List<IOExceptionFilter> ioExceptionFilters,//
 
+            // cookie store
+            CookieStore cookieStore,
+
             // tuning
             boolean tcpNoDelay,//
             boolean soReuseAddress,//
@@ -263,6 +271,9 @@ private DefaultAsyncHttpClientConfig(//
         this.responseFilters = responseFilters;
         this.ioExceptionFilters = ioExceptionFilters;
 
+        // cookie store
+        this.cookieStore = cookieStore;
+
         // tuning
         this.tcpNoDelay = tcpNoDelay;
         this.soReuseAddress = soReuseAddress;
@@ -502,6 +513,12 @@ public List<IOExceptionFilter> getIoExceptionFilters() {
         return ioExceptionFilters;
     }
 
+    // cookie store
+    @Override
+    public CookieStore getCookieStore() {
+        return cookieStore;
+    }
+
     // tuning
     @Override
     public boolean isTcpNoDelay() {
@@ -676,6 +693,9 @@ public static class Builder {
         private final List<ResponseFilter> responseFilters = new LinkedList<>();
         private final List<IOExceptionFilter> ioExceptionFilters = new LinkedList<>();
 
+        // cookie store
+        private CookieStore cookieStore = new ThreadSafeCookieStore();
+
         // tuning
         private boolean tcpNoDelay = defaultTcpNoDelay();
         private boolean soReuseAddress = defaultSoReuseAddress();
@@ -1017,6 +1037,12 @@ public Builder removeIOExceptionFilter(IOExceptionFilter ioExceptionFilter) {
             return this;
         }
 
+        // cookie store
+        public Builder setCookieStore(CookieStore cookieStore) {
+            this.cookieStore = cookieStore;
+            return this;
+        }
+
         // tuning
         public Builder setTcpNoDelay(boolean tcpNoDelay) {
             this.tcpNoDelay = tcpNoDelay;
@@ -1191,6 +1217,7 @@ public DefaultAsyncHttpClientConfig build() {
                     requestFilters.isEmpty() ? Collections.emptyList() : Collections.unmodifiableList(requestFilters), //
                     responseFilters.isEmpty() ? Collections.emptyList() : Collections.unmodifiableList(responseFilters),//
                     ioExceptionFilters.isEmpty() ? Collections.emptyList() : Collections.unmodifiableList(ioExceptionFilters),//
+                    cookieStore,
                     tcpNoDelay, //
                     soReuseAddress, //
                     soLinger, //

client/src/main/java/org/asynchttpclient/cookie/CookieStore.java

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2017 AsyncHttpClient Project. All rights reserved.
+ *
+ * This program is licensed to you under the Apache License Version 2.0,
+ * and you may not use this file except in compliance with the Apache License Version 2.0.
+ * You may obtain a copy of the Apache License Version 2.0 at
+ *     http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the Apache License Version 2.0 is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+ */
+
+package org.asynchttpclient.cookie;
+
+import io.netty.handler.codec.http.cookie.Cookie;
+import org.asynchttpclient.uri.Uri;
+
+import java.net.CookieManager;
+import java.util.List;
+import java.util.function.Predicate;
+
+/**
+ * This interface represents an abstract store for {@link Cookie} objects.
+ * <p>
+ * <p>{@link CookieManager} will call {@code CookieStore.add} to save cookies
+ * for every incoming HTTP response, and call {@code CookieStore.get} to
+ * retrieve cookie for every outgoing HTTP request. A CookieStore
+ * is responsible for removing HttpCookie instances which have expired.
+ *
+ * @since 2.1
+ */
+public interface CookieStore {
+    /**
+     * Adds one {@link Cookie} to the store. This is called for every incoming HTTP response.
+     * If the given cookie has already expired it will not be added, but existing values will still be removed.
+     * <p>
+     * <p>A cookie to store may or may not be associated with an URI. If it
+     * is not associated with an URI, the cookie's domain and path attribute
+     * will indicate where it comes from. If it is associated with an URI and
+     * its domain and path attribute are not specified, given URI will indicate
+     * where this cookie comes from.
+     * <p>
+     * <p>If a cookie corresponding to the given URI already exists,
+     * then it is replaced with the new one.
+     *
+     * @param uri    the {@link Uri uri} this cookie associated with. if {@code null}, this cookie will not be associated with an URI
+     * @param cookie the {@link Cookie cookie} to be added
+     */
+    void add(Uri uri, Cookie cookie);
+
+    /**
+     * Retrieve cookies associated with given URI, or whose domain matches the given URI. Only cookies that
+     * have not expired are returned. This is called for every outgoing HTTP request.
+     *
+     * @param uri the {@link Uri uri} associated with the cookies to be returned
+     * @return an immutable list of Cookie, return empty list if no cookies match the given URI
+     */
+    List<Cookie> get(Uri uri);
+
+    /**
+     * Get all not-expired cookies in cookie store.
+     *
+     * @return an immutable list of http cookies;
+     * return empty list if there's no http cookie in store
+     */
+    List<Cookie> getAll();
+
+    /**
+     * Remove a cookie from store.
+     *
+     * @param predicate that indicates what cookies to remove
+     * @return {@code true} if this store contained the specified cookie
+     * @throws NullPointerException if {@code cookie} is {@code null}
+     */
+    boolean remove(Predicate<Cookie> predicate);
+
+    /**
+     * Remove all cookies in this cookie store.
+     *
+     * @return true if any cookies were purged.
+     */
+    boolean clear();
+}