[libsoup] SoupConnection: fix up states during connection

[Dan Winship <danw src gnome org>]

commit 2e775bd7f8648fad7395cd0f63aa234bbb04675f
Author: Dan Winship <danw gnome org>
Date:   Tue Aug 14 15:35:03 2012 -0400

    SoupConnection: fix up states during connection
    
    In particular, when doing an https CONNECT, make sure the connection
    never observably switches to the "IDLE" state. Add a test for this.

 libsoup/soup-connection.c    |   14 +++--
 libsoup/soup-session-async.c |    5 +-
 tests/connection-test.c      |  133 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 142 insertions(+), 10 deletions(-)
---
diff --git a/libsoup/soup-connection.c b/libsoup/soup-connection.c
index 48c3d00..3c5c516 100644
--- a/libsoup/soup-connection.c
+++ b/libsoup/soup-connection.c
@@ -432,6 +432,10 @@ clear_current_item (SoupConnection *conn)
 			/* We're now effectively no longer proxying */
 			soup_uri_free (priv->proxy_uri);
 			priv->proxy_uri = NULL;
+
+			/* Nor are we actually IDLE... */
+			if (priv->state == SOUP_CONNECTION_IDLE)
+				priv->state = SOUP_CONNECTION_IN_USE;
 		}
 
 		if (!soup_message_is_keepalive (item->msg) || !priv->reusable)
@@ -936,7 +940,6 @@ void
 soup_connection_set_state (SoupConnection *conn, SoupConnectionState state)
 {
 	SoupConnectionPrivate *priv;
-	SoupConnectionState old_state;
 
 	g_return_if_fail (SOUP_IS_CONNECTION (conn));
 	g_return_if_fail (state >= SOUP_CONNECTION_NEW &&
@@ -945,14 +948,13 @@ soup_connection_set_state (SoupConnection *conn, SoupConnectionState state)
 	g_object_freeze_notify (G_OBJECT (conn));
 
 	priv = SOUP_CONNECTION_GET_PRIVATE (conn);
-	old_state = priv->state;
 	priv->state = state;
-	if ((state == SOUP_CONNECTION_IDLE ||
-	     state == SOUP_CONNECTION_DISCONNECTED) &&
-	    old_state == SOUP_CONNECTION_IN_USE)
+	if (state == SOUP_CONNECTION_IDLE ||
+	    state == SOUP_CONNECTION_DISCONNECTED)
 		clear_current_item (conn);
 
-	g_object_notify (G_OBJECT (conn), "state");
+	if (priv->state == state)
+		g_object_notify (G_OBJECT (conn), "state");
 	g_object_thaw_notify (G_OBJECT (conn));
 }
 
diff --git a/libsoup/soup-session-async.c b/libsoup/soup-session-async.c
index 53cd8e4..90534e3 100644
--- a/libsoup/soup-session-async.c
+++ b/libsoup/soup-session-async.c
@@ -139,7 +139,6 @@ tunnel_complete (SoupMessageQueueItem *tunnel_item)
 
 	do_idle_run_queue (session);
 	soup_message_queue_item_unref (item);
-	soup_session_unqueue_item (session, tunnel_item);
 	soup_message_queue_item_unref (tunnel_item);
 }
 
@@ -152,9 +151,6 @@ ssl_tunnel_completed (SoupConnection *conn, guint status, gpointer user_data)
 	if (SOUP_STATUS_IS_SUCCESSFUL (status)) {
 		g_signal_connect (item->conn, "disconnected",
 				  G_CALLBACK (connection_closed), item->session);
-		soup_connection_set_state (item->conn, SOUP_CONNECTION_IDLE);
-		soup_connection_set_state (item->conn, SOUP_CONNECTION_IN_USE);
-
 		item->state = SOUP_MESSAGE_READY;
 	} else {
 		if (item->conn)
@@ -185,6 +181,7 @@ tunnel_message_completed (SoupMessage *tunnel_msg, gpointer user_data)
 	}
 
 	tunnel_item->state = SOUP_MESSAGE_FINISHED;
+	soup_session_unqueue_item (session, tunnel_item);
 
 	if (!SOUP_STATUS_IS_SUCCESSFUL (tunnel_msg->status_code)) {
 		if (item->conn)
diff --git a/tests/connection-test.c b/tests/connection-test.c
index f8ff7c1..f0a1703 100644
--- a/tests/connection-test.c
+++ b/tests/connection-test.c
@@ -5,6 +5,8 @@
 
 #include "test-utils.h"
 
+#include "libsoup/soup-connection.h"
+
 SoupServer *server;
 SoupURI *base_uri;
 GMutex server_mutex;
@@ -679,10 +681,138 @@ do_non_idempotent_connection_test (void)
 	soup_test_session_abort_unref (session);
 }
 
+#ifdef HAVE_APACHE
+
+#define HTTP_SERVER  "http://127.0.0.1:47524";
+#define HTTPS_SERVER "https://127.0.0.1:47525";
+#define HTTP_PROXY   "http://127.0.0.1:47526";
+
+static SoupConnectionState state_transitions[] = {
+	/* NEW -> */        SOUP_CONNECTION_CONNECTING,
+	/* CONNECTING -> */ SOUP_CONNECTION_IN_USE,
+	/* IDLE -> */       SOUP_CONNECTION_DISCONNECTED,
+	/* IN_USE -> */     SOUP_CONNECTION_IDLE,
+
+	/* REMOTE_DISCONNECTED */ -1,
+	/* DISCONNECTED */        -1,
+};
+
+static const char *state_names[] = {
+	"NEW", "CONNECTING", "IDLE", "IN_USE",
+	"REMOTE_DISCONNECTED", "DISCONNECTED"
+};
+
+static void
+connection_state_changed (GObject *object, GParamSpec *param,
+			  gpointer user_data)
+{
+	SoupConnection *conn = SOUP_CONNECTION (object);
+	SoupConnectionState *state = user_data;
+	SoupConnectionState new_state;
+
+	new_state = soup_connection_get_state (conn);
+	if (state_transitions[*state] != new_state) {
+		debug_printf (1, "      Unexpected transition: %s -> %s\n",
+			      state_names[*state], state_names[new_state]);
+		errors++;
+	} else {
+		debug_printf (2, "      %s -> %s\n",
+			      state_names[*state], state_names[new_state]);
+	}
+
+	*state = new_state;
+}
+
+static void
+connection_created (SoupSession *session, SoupConnection *conn,
+		    gpointer user_data)
+{
+	SoupConnectionState *state = user_data;
+
+	*state = soup_connection_get_state (conn);
+	if (*state != SOUP_CONNECTION_NEW) {
+		debug_printf (1, "      Unexpected initial state: %d\n",
+			      *state);
+		errors++;
+	}
+
+	g_signal_connect (conn, "notify::state",
+			  G_CALLBACK (connection_state_changed),
+			  state);
+}
+
+static void
+do_one_connection_state_test (SoupSession *session, const char *uri)
+{
+	SoupMessage *msg;
+
+	msg = soup_message_new ("GET", uri);
+	soup_session_send_message (session, msg);
+	if (msg->status_code != SOUP_STATUS_OK) {
+		debug_printf (1, "      Unexpected response: %d %s\n",
+			      msg->status_code, msg->reason_phrase);
+		errors++;
+	}
+	g_object_unref (msg);
+	soup_session_abort (session);
+}
+
+static void
+do_connection_state_test_for_session (SoupSession *session)
+{
+	SoupConnectionState state;
+	SoupURI *proxy_uri;
+
+	g_signal_connect (session, "connection-created",
+			  G_CALLBACK (connection_created),
+			  &state);
+
+	debug_printf (1, "    http\n");
+	do_one_connection_state_test (session, HTTP_SERVER);
+
+	debug_printf (1, "    https\n");
+	do_one_connection_state_test (session, HTTPS_SERVER);
+
+	proxy_uri = soup_uri_new (HTTP_PROXY);
+	g_object_set (G_OBJECT (session),
+		      SOUP_SESSION_PROXY_URI, proxy_uri,
+		      NULL);
+	soup_uri_free (proxy_uri);
+
+	debug_printf (1, "    http with proxy\n");
+	do_one_connection_state_test (session, HTTP_SERVER);
+
+	debug_printf (1, "    https with proxy\n");
+	do_one_connection_state_test (session, HTTPS_SERVER);
+}
+
+static void
+do_connection_state_test (void)
+{
+	SoupSession *session;
+
+	debug_printf (1, "\nConnection states\n");
+
+	debug_printf (1, "  Async session\n");
+	session = soup_test_session_new (SOUP_TYPE_SESSION_ASYNC, NULL);
+	do_connection_state_test_for_session (session);
+	soup_test_session_abort_unref (session);
+
+	debug_printf (1, "  Sync session\n");
+	session = soup_test_session_new (SOUP_TYPE_SESSION_SYNC, NULL);
+	do_connection_state_test_for_session (session);
+	soup_test_session_abort_unref (session);
+}
+
+#endif
+
 int
 main (int argc, char **argv)
 {
 	test_init (argc, argv, NULL);
+#ifdef HAVE_APACHE
+	apache_init ();
+#endif
 
 	server = soup_test_server_new (TRUE);
 	soup_server_add_handler (server, NULL, server_callback, "http", NULL);
@@ -694,6 +824,9 @@ main (int argc, char **argv)
 	do_max_conns_test ();
 	do_non_persistent_connection_test ();
 	do_non_idempotent_connection_test ();
+#ifdef HAVE_APACHE
+	do_connection_state_test ();
+#endif
 
 	soup_uri_free (base_uri);
 	soup_test_server_quit_unref (server);