lidavidm commented on a change in pull request #8554: URL: https://github.com/apache/arrow/pull/8554#discussion_r518471847
########## File path: java/flight/flight-core/src/main/java/org/apache/arrow/flight/client/ClientCookieMiddleware.java ########## @@ -0,0 +1,106 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.arrow.flight.client; + +import java.net.HttpCookie; +import java.util.List; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentMap; +import java.util.function.Consumer; +import java.util.stream.Collectors; + +import org.apache.arrow.flight.CallHeaders; +import org.apache.arrow.flight.CallInfo; +import org.apache.arrow.flight.CallStatus; +import org.apache.arrow.flight.FlightClientMiddleware; +import org.apache.arrow.util.VisibleForTesting; + +/** + * A client middleware for receiving and sending cookie information. + * Note that this class will not persist permanent cookies beyond the lifetime + * of this session. + */ +public class ClientCookieMiddleware implements FlightClientMiddleware { + private static final String SET_COOKIE_HEADER = "Set-Cookie"; + private static final String COOKIE_HEADER = "Cookie"; + private final Factory factory; + + @VisibleForTesting + ClientCookieMiddleware(Factory factory) { + this.factory = factory; + } + + /** + * Factory used within FlightClient. + */ + public static class Factory implements FlightClientMiddleware.Factory { + // Use a map to track the most recent version of a cookie from the server. + // Note that cookie names are case-sensitive (but header names aren't). + private ConcurrentMap<String, HttpCookie> cookies = new ConcurrentHashMap<>(); + + @Override + public ClientCookieMiddleware onCallStarted(CallInfo info) { + return new ClientCookieMiddleware(this); + } + } + + @Override + public void onBeforeSendingHeaders(CallHeaders outgoingHeaders) { + final String cookieValue = getValidCookiesAsString(); + if (!cookieValue.isEmpty()) { + outgoingHeaders.insert(COOKIE_HEADER, cookieValue); + } + } + + @Override + public void onHeadersReceived(CallHeaders incomingHeaders) { + // Note: A cookie defined once will continue to be used in all subsequent + // requests on the client instance. The server can send the same cookie again + // with a different value and the client will use the new value in future requests. + // The server can also update a cookie to have an Expiry in the past or negative age + // to signal that the client should stop using the cookie immediately. + final Consumer<String> handleSetCookieHeader = (headerValue) -> { + final List<HttpCookie> parsedCookies = HttpCookie.parse(headerValue); Review comment: Also instead of a lambda it may be clearer to define Factory#updateFromSetCookieHeader or something like that. ########## File path: java/flight/flight-core/src/main/java/org/apache/arrow/flight/client/ClientCookieMiddleware.java ########## @@ -0,0 +1,106 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.arrow.flight.client; + +import java.net.HttpCookie; +import java.util.List; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentMap; +import java.util.function.Consumer; +import java.util.stream.Collectors; + +import org.apache.arrow.flight.CallHeaders; +import org.apache.arrow.flight.CallInfo; +import org.apache.arrow.flight.CallStatus; +import org.apache.arrow.flight.FlightClientMiddleware; +import org.apache.arrow.util.VisibleForTesting; + +/** + * A client middleware for receiving and sending cookie information. + * Note that this class will not persist permanent cookies beyond the lifetime + * of this session. + */ +public class ClientCookieMiddleware implements FlightClientMiddleware { + private static final String SET_COOKIE_HEADER = "Set-Cookie"; + private static final String COOKIE_HEADER = "Cookie"; + private final Factory factory; + + @VisibleForTesting + ClientCookieMiddleware(Factory factory) { + this.factory = factory; + } + + /** + * Factory used within FlightClient. + */ + public static class Factory implements FlightClientMiddleware.Factory { + // Use a map to track the most recent version of a cookie from the server. + // Note that cookie names are case-sensitive (but header names aren't). + private ConcurrentMap<String, HttpCookie> cookies = new ConcurrentHashMap<>(); + + @Override + public ClientCookieMiddleware onCallStarted(CallInfo info) { + return new ClientCookieMiddleware(this); + } + } + + @Override + public void onBeforeSendingHeaders(CallHeaders outgoingHeaders) { + final String cookieValue = getValidCookiesAsString(); + if (!cookieValue.isEmpty()) { + outgoingHeaders.insert(COOKIE_HEADER, cookieValue); + } + } + + @Override + public void onHeadersReceived(CallHeaders incomingHeaders) { + // Note: A cookie defined once will continue to be used in all subsequent + // requests on the client instance. The server can send the same cookie again + // with a different value and the client will use the new value in future requests. + // The server can also update a cookie to have an Expiry in the past or negative age + // to signal that the client should stop using the cookie immediately. + final Consumer<String> handleSetCookieHeader = (headerValue) -> { + final List<HttpCookie> parsedCookies = HttpCookie.parse(headerValue); Review comment: Should we handle IllegalArgumentException here from HttpCookie.parse? ########## File path: java/flight/flight-core/src/test/java/org/apache/arrow/flight/client/TestCookieHandling.java ########## @@ -0,0 +1,252 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.arrow.flight.client; + +import java.io.IOException; + +import org.apache.arrow.flight.CallHeaders; +import org.apache.arrow.flight.CallInfo; +import org.apache.arrow.flight.CallStatus; +import org.apache.arrow.flight.Criteria; +import org.apache.arrow.flight.ErrorFlightMetadata; +import org.apache.arrow.flight.FlightClient; +import org.apache.arrow.flight.FlightInfo; +import org.apache.arrow.flight.FlightProducer; +import org.apache.arrow.flight.FlightServer; +import org.apache.arrow.flight.FlightServerMiddleware; +import org.apache.arrow.flight.FlightTestUtil; +import org.apache.arrow.flight.NoOpFlightProducer; +import org.apache.arrow.flight.RequestContext; +import org.apache.arrow.memory.BufferAllocator; +import org.apache.arrow.memory.RootAllocator; +import org.apache.arrow.util.AutoCloseables; +import org.junit.After; +import org.junit.Assert; +import org.junit.Before; +import org.junit.Ignore; +import org.junit.Test; + +/** + * Tests for correct handling of cookies from the FlightClient using {@link ClientCookieMiddleware}. + */ +public class TestCookieHandling { + private static final String SET_COOKIE_HEADER = "Set-Cookie"; + private static final String COOKIE_HEADER = "Cookie"; + private BufferAllocator allocator; + private FlightServer server; + private FlightClient client; + + private ClientCookieMiddlewareTestFactory testFactory = new ClientCookieMiddlewareTestFactory(); + private ClientCookieMiddleware cookieMiddleware = new ClientCookieMiddleware(testFactory); + + @Before + public void setup() throws Exception { + allocator = new RootAllocator(Long.MAX_VALUE); + startServerAndClient(); + } + + @After + public void cleanup() throws Exception { + cookieMiddleware = new ClientCookieMiddleware(testFactory); + AutoCloseables.close(client, server, allocator); + client = null; + server = null; + allocator = null; + } + + @Test + public void basicCookie() { + CallHeaders headersToSend = new ErrorFlightMetadata(); + headersToSend.insert(SET_COOKIE_HEADER, "k=v"); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=v", cookieMiddleware.getValidCookiesAsString()); + } + + @Test + public void cookieStaysAfterMultipleRequests() { + CallHeaders headersToSend = new ErrorFlightMetadata(); + headersToSend.insert(SET_COOKIE_HEADER, "k=v"); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=v", cookieMiddleware.getValidCookiesAsString()); + + headersToSend = new ErrorFlightMetadata(); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=v", cookieMiddleware.getValidCookiesAsString()); + + headersToSend = new ErrorFlightMetadata(); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=v", cookieMiddleware.getValidCookiesAsString()); + } + + @Test + public void cookieAutoExpires() { + CallHeaders headersToSend = new ErrorFlightMetadata(); + headersToSend.insert(SET_COOKIE_HEADER, "k=v; Max-Age=2"); + cookieMiddleware.onHeadersReceived(headersToSend); + // Note: using max-age changes cookie version from 0->1, which quotes values. + Assert.assertEquals("k=\"v\"", cookieMiddleware.getValidCookiesAsString()); + + headersToSend = new ErrorFlightMetadata(); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=\"v\"", cookieMiddleware.getValidCookiesAsString()); + + try { + Thread.sleep(5000); Review comment: This is a little icky, though it appears there's no way to mock time for HttpCookie. ########## File path: java/flight/flight-core/src/test/java/org/apache/arrow/flight/client/TestCookieHandling.java ########## @@ -0,0 +1,252 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.arrow.flight.client; + +import java.io.IOException; + +import org.apache.arrow.flight.CallHeaders; +import org.apache.arrow.flight.CallInfo; +import org.apache.arrow.flight.CallStatus; +import org.apache.arrow.flight.Criteria; +import org.apache.arrow.flight.ErrorFlightMetadata; +import org.apache.arrow.flight.FlightClient; +import org.apache.arrow.flight.FlightInfo; +import org.apache.arrow.flight.FlightProducer; +import org.apache.arrow.flight.FlightServer; +import org.apache.arrow.flight.FlightServerMiddleware; +import org.apache.arrow.flight.FlightTestUtil; +import org.apache.arrow.flight.NoOpFlightProducer; +import org.apache.arrow.flight.RequestContext; +import org.apache.arrow.memory.BufferAllocator; +import org.apache.arrow.memory.RootAllocator; +import org.apache.arrow.util.AutoCloseables; +import org.junit.After; +import org.junit.Assert; +import org.junit.Before; +import org.junit.Ignore; +import org.junit.Test; + +/** + * Tests for correct handling of cookies from the FlightClient using {@link ClientCookieMiddleware}. + */ +public class TestCookieHandling { + private static final String SET_COOKIE_HEADER = "Set-Cookie"; + private static final String COOKIE_HEADER = "Cookie"; + private BufferAllocator allocator; + private FlightServer server; + private FlightClient client; + + private ClientCookieMiddlewareTestFactory testFactory = new ClientCookieMiddlewareTestFactory(); + private ClientCookieMiddleware cookieMiddleware = new ClientCookieMiddleware(testFactory); + + @Before + public void setup() throws Exception { + allocator = new RootAllocator(Long.MAX_VALUE); + startServerAndClient(); + } + + @After + public void cleanup() throws Exception { + cookieMiddleware = new ClientCookieMiddleware(testFactory); + AutoCloseables.close(client, server, allocator); + client = null; + server = null; + allocator = null; + } + + @Test + public void basicCookie() { + CallHeaders headersToSend = new ErrorFlightMetadata(); + headersToSend.insert(SET_COOKIE_HEADER, "k=v"); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=v", cookieMiddleware.getValidCookiesAsString()); + } + + @Test + public void cookieStaysAfterMultipleRequests() { + CallHeaders headersToSend = new ErrorFlightMetadata(); + headersToSend.insert(SET_COOKIE_HEADER, "k=v"); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=v", cookieMiddleware.getValidCookiesAsString()); + + headersToSend = new ErrorFlightMetadata(); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=v", cookieMiddleware.getValidCookiesAsString()); + + headersToSend = new ErrorFlightMetadata(); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=v", cookieMiddleware.getValidCookiesAsString()); + } + + @Test + public void cookieAutoExpires() { + CallHeaders headersToSend = new ErrorFlightMetadata(); + headersToSend.insert(SET_COOKIE_HEADER, "k=v; Max-Age=2"); + cookieMiddleware.onHeadersReceived(headersToSend); + // Note: using max-age changes cookie version from 0->1, which quotes values. + Assert.assertEquals("k=\"v\"", cookieMiddleware.getValidCookiesAsString()); + + headersToSend = new ErrorFlightMetadata(); + cookieMiddleware.onHeadersReceived(headersToSend); + Assert.assertEquals("k=\"v\"", cookieMiddleware.getValidCookiesAsString()); + + try { + Thread.sleep(5000); + } catch (InterruptedException ignored) { + } + + // Verify that the k cookie was discarded because it expired. + Assert.assertTrue(cookieMiddleware.getValidCookiesAsString().isEmpty()); + } + + @Test + public void cookieExplicitlyExpires() { + CallHeaders headersToSend = new ErrorFlightMetadata(); + headersToSend.insert(SET_COOKIE_HEADER, "k=v; Max-Age=2"); + cookieMiddleware.onHeadersReceived(headersToSend); + // Note: using max-age changes cookie version from 0->1, which quotes values. + Assert.assertEquals("k=\"v\"", cookieMiddleware.getValidCookiesAsString()); + + headersToSend = new ErrorFlightMetadata(); + headersToSend.insert(SET_COOKIE_HEADER, "k=v; Max-Age=-2"); + cookieMiddleware.onHeadersReceived(headersToSend); + + // Verify that the k cookie was discarded because the server told the client it is expired. + Assert.assertTrue(cookieMiddleware.getValidCookiesAsString().isEmpty()); Review comment: It seems this test doesn't always succeed. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
