跳到主要內容

RESTEasy - Connection Pool的Request Timeout沒有作用

Problem

REST API的開發者,大都會非常頻繁的存取REST服務提供者;Connection Pool是其中一個增進存取效率的方式。然而,這陣子在使用RESTEasy + Apache Connection Pool後,發現ConnectionRequestTimeout並沒作用。本篇文章主要分享目前的解決方法。

Version Info

由於某些限制,我們目前還沒使用最新版本的RESTEasy,版本資訊如下:

resteasy-client: 3.0.14.Final
httpcore: 4.3.3
httpclient: 4.3.6

Test RESTClient

我寫了一個測試去確認ConnectionRequestTimeout是否有作用,方法如下:

  1. 將Pool大小設定為1。
  2. 設定ConnectionRequestTimeout為2秒。
  3. 依序發起兩個HTTP Get,但第一個請求不關閉。
  4. 接著發起第二個HTTP Get,由於沒有有效的連線可以使用,會Block。
  5. 在2秒後,Client會收到Exception,Root Cause為ConnectionPoolTimeoutException。

首先是HttpEngine設定的部分,由於這個版本ResteasyClientBuilder內建的PoolManager有些問題,因此我是另外產生的,程式碼大致如下:

// 這是自己寫的Builder,產生的實體是PoolingHttpClientConnectionManager
private HttpClientConnectionManager initConnectionManager(int poolSize, int perRoute) {
	HttpClientConnectionManagerBuilder builder = new HttpClientConnectionManagerBuilder();
	return builder.withMaxTotal(poolSize).withDefaultMaxPerRoute(perRoute).build();
}
 
// TestCase的timeout設定為20秒,避免有問題時會卡很久
@Test(timeout=20000)
public void testRequestTimeoutWithCustomHttpEngine() throws Exception {
	int expectTimeout = 2*1000;
 
	connectionManager = initConnectionManager(20 , 1);
 
	RequestConfig requestConfig = RequestConfig.custom()
			.setConnectionRequestTimeout(expectTimeout)
			.build();
 
	ClientHttpEngine httpEngin = new ClientHttpEngineBuilder()
			.withRequestConfig(requestConfig)
			.withConnectionManager(connectionManager).build();
 
	ResteasyClientBuilder clientBuilder = (ResteasyClientBuilder)ResteasyClientBuilder.newBuilder();
	clientBuilder.httpEngine(httpEngin);
	// 以下略

接著是發出兩個請求,第一個請求沒執行close,接著執行第二個請求:

	// 延續httpEngine的初始化
	Client client = clientBuilder.build();
 
	Response leak_repsonse = client.target(target).request().get();
	Response second_response = null;
 
	long before = System.currentTimeMillis();
	try {
		second_response = client.target(target).request().get();
		fail("should be timeout");
	} catch (Exception e) {
		assertNotNull(e.getCause());
		assertTrue(e.getCause() instanceof ConnectionPoolTimeoutException);
		assertEquals(expectTimeout, System.currentTimeMillis() - before, 500);
	} finally {
		leak_repsonse.close();
		if( second_response != null )
			second_response.close();
	}
}

在執行以上測試後,會因為第二個請求block直到Test case 20秒timeout而錯誤;此測試並沒發生預期的ConnectionPoolTimeoutException。

Test HttpClient

由於前一個測試沒達到預期效果,因此繼續確認PoolingHttpClientConnectionManager是否有問題。測試流程與前一個測試大同小異,差別只在於是直接對HttpClient做操作:

@Test(timeout=20*1000)
public void testRequestTimeout() throws Exception {
	int expect_timeout = 2*1000;
	connectionManager = new HttpClientConnectionManagerBuilder().build();
	RequestConfig requestConfig = RequestConfig.custom()
			.setConnectionRequestTimeout(expect_timeout)
			.build();
 
	HttpClient httpClient = HttpClients.custom().setConnectionManager(connectionManager)
			.setDefaultRequestConfig(requestConfig)
			.build();
 
	HttpUriRequest uriRequest = new HttpGet(target);
	HttpResponse response = httpClient.execute(uriRequest);
	assertEquals(200, response.getStatusLine().getStatusCode());
 
	long before = System.currentTimeMillis();
	try {
		uriRequest = new HttpGet(target);
		response = httpClient.execute(uriRequest);
	} catch( ConnectionPoolTimeoutException e ) {
		assertEquals("Timeout waiting for connection from pool", e.getMessage());
	}
	long duration = System.currentTimeMillis() - before;
	assertEquals(expect_timeout, duration, 500);
}

這個測試最後會因為第二個連線無法在2秒內取得而拋出ConnectionPoolTimeoutException。

How to fix?

根據這兩個測試,懷疑是RESTEasy與HttpClient整合起來的問題。測試過更新RESTEasy與HttpClient的libraries後,確認只要將HttpClient的library升級至4.5.3以上就可以解決問題:

resteasy-client: 3.0.14.Final
httpcore: 4.3.3
httpclient: 4.5.3

留言

這個網誌中的熱門文章

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後,安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數,以前試驗過是可以安裝完成的。因此在發生這個問題後,我檢查了它的debug console: 從console得知,eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認,有問題的是有接網路線的網卡,且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制,因此發現在Anaconda的說明文件中( link ),有提到dhcptimeout這個boot參數。看了一些人的使用範例,應該是可以直接串在isolinux.cfg中,如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串,問問Google大師,想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ,關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中;在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知,它讀取的檔案是answer file而不是boot command line。因此我接下來的測試,就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --...

解決RobotFramework從3.1.2升級到3.2.2之後,Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護,我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情,主要先把明確的runtime語法錯誤與deprecate item處理好,這部分內容可以參考: link 。 直到最近才發現,透過SeleniumLibrary執行Choose File去上傳檔案的動作,會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法,我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住,有些測試案例是可以執行的,但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作,因為我使用 Remote Selenium ,所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現,在3.2.2的最後一個TCP封包,比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容,還有HTTP Content-Length的計算,我都確認過沒有問題。 最後發現問題是出在socket API的使用上,就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料,但沒處理到尚未送完的資料內容,而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方,在他們出新的版本之前,我是將改完的_socket.py放在我們自己的Lib底下,好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)

Robot Framework - Evaluate該怎麼用?

Evaluate該怎麼用? 前言 Builtin的RobotFramework Library提供了Evaluate Keyword。它所提供的功能是「執行Python描述句」。但實際上到底有什麼用途呢?原本我僅僅拿來將string轉為int的功用,經過一些查詢與試驗,我將心得整理給大家。 Builtin Builtin的function可以參考Library Doc for Evaluate。我以有使用過的function做說明。 數字轉換 Python提供了int、long、float與complex等function讓你可以將字串轉為數字,也可以透過它們做四則運算。首先以字串轉數字為例,我將8設於${num_str}中,再透過Evaluate+int轉為數字。這裡必須注意的是: 「int()中放變數必須以單引號'括起」。否則,假如你設定的數字為08,在轉換int時會出現Syntax Error。 ${num_str} | Set Variable | 8 ${num} | Evaluate | int('${num_str}') 其中int與long的第二個參數為base,這是根據你的input所決定: Comment | num = 9 ${num} | Evaluate | int('11', 8) Comment | num = 11 ${num} | Evaluate | int('11', 10) Comment | num = 17 ${num} | Evaluate | int('11', 16) 其它還有像bin、oct、hex,可以將整數轉為2、8、16進位。 運算 四則運算: 直接將運算子加上即可: ${num} | Evaluate | int('${hour}')*60 + int('${min}') 指數: 可以用pow。以下面兩個例子來說,第一個是2的3次方為8,第二個是2的3次方再mod 7為1。需注意的是: 「傳入值必須是數字不可為字串」。 ${num} | Evaluate | pow(2,3) ${num} | Evaluate | pow(2,3,7) 取最大最小值: 使用max/min,可以選擇丟一個array的方式...