跳到主要內容

RESTEasy - How to fetch raw message after the request is failed?

Problem

RESTEasy jackson provider讓我們可以輕鬆的將第三方服務回應的json內容,轉成我們自己的物件,讓程式碼只專注於資源物件的操作;然而,第三方服務並非永遠都如你預期,它可能突然更新而吐出無法處理的訊息:

javax.ws.rs.ProcessingException: RESTEASY003145: Unable to find a MessageBodyReader of content-type text/html;charset=iso-8859-1

我有幸遇到這樣的問題,也讓我思考著該如何將原始資料記錄下來以回報第三方服務提供者。本篇文章分享可能的作法,可依照你的需求自行挑選。

(完整程式內容可以從github上clone: link)

How to resolve?

ReadInterceptor & InputStreamSniffer

一開始遇到這個問題時,我的想法是: 是否可以透過interceptor去處理? 我所提供的第一個方法,是註冊一個ReadInterceptor,並且wrap原始的InputStream,將讀取的內容給記錄下來。首先是ReaderInterceptor,它會從Context中取出InputStream,並將其wrap成InputStreamSniffer,待讀取流程執行後,就可以透過getReadContent去拿到讀取的內容:

@Provider
public class SnifferReadInterceptor implements ReaderInterceptor {
 
	private InputStreamSniffer inputStreamSniffer = null;
 
	@Override
	public Object aroundReadFrom(ReaderInterceptorContext context) throws IOException, WebApplicationException {
		InputStream inputStream = context.getInputStream();
 
		inputStreamSniffer = new InputStreamSniffer(inputStream);
		context.setInputStream(inputStreamSniffer);
 
		return context.proceed();
	}
 
	public String getReadContent(){
		return inputStreamSniffer.getContent();
	}
}

InputStreamSniffer則是將讀取的動作delegate給原始的InputStream,並悄悄地記下讀取內容:

public class InputStreamSniffer extends InputStream {
 
	private InputStream srcInputStream;
	private StringBuilder contentStringBuilder;
 
	public InputStreamSniffer(InputStream inputStream){
		srcInputStream = inputStream;
		contentStringBuilder = new StringBuilder();
	}
 
	@Override
	public int read() throws IOException {
		int read_c = srcInputStream.read();
		contentStringBuilder.append((char)read_c);
		return read_c;
	}
	// .. skip

我簡單的寫了一個測試,想要確認將message轉為json物件發生問題時,readInterceptor是否可以拿到message:

@Test
public void testSnifferReadInterceptorWithReadFailed(){
	Invocation invocation = initInvocation();
 
	Response response = null;
	try {
		response =  invocation.invoke();
		response.readEntity(TestModel.class);
		fail("should be failed	");
	} catch( ProcessingException e ) {
		// Can't find valid messageBodyReader
		assertTrue(readInterceptor.getReadContent().isEmpty());
	} finally {
		response.close();
	}
}

答案是不行,這是由於RESTEasy在讀取訊息前,會先根據Response Header中宣告的MediaType去找尋是否有對應的MessageBodyRead。

Read All Content of ReadInterceptor

由於我們無法於執行過程中解決這個問題,因此改在ReadInterceptor中,先將所有內容讀出來:

public class DebugReadInterceptor  implements ReaderInterceptor{
 
	private String content;
 
	@Override
	public Object aroundReadFrom(ReaderInterceptorContext context) throws IOException, WebApplicationException {
		InputStream inputStream = context.getInputStream();
		content = IOUtils.toString(inputStream);
 
		context.setInputStream(new ByteArrayInputStream(content.getBytes()));
		return context.proceed();
	} 
 
	public String getContent(){
		return content;
	}
}

這個方法是可以解決目前遇到的問題,但缺點是每次請求都一定會多處理一次內容。於是我把腦筋動到了MessageBodyReader身上。

Customized MessageBodyReader

我新增一個名為CompositeMessageBodyProvider的類別,去implement MessageBodyReader;isReadable永遠回傳true,將搜尋合適MessageBodyReader動作交由readFrom處理,如果找不到就丟ProcessingException上去。Client可以攔截此例外決定要處理的方式:

@Provider
@Consumes(MediaType.WILDCARD)
@Produces(MediaType.WILDCARD)
public class CompositeMessageBodyProvider implements MessageBodyReader<Object>, MessageBodyWriter<Object> {
 
	private List<MessageBodyReader<Object>> messageBodyReaders = new ArrayList<>();
 
	@Override
	public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
		return true;
	}
 
	private Optional<MessageBodyReader<Object>> findReader(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType){
		return messageBodyReaders.stream().filter(writter->writter.isReadable(type, genericType, annotations, mediaType)).findAny();
	}
 
	@Override
	public Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType,
			MultivaluedMap<String, String> httpHeaders, InputStream entityStream)
			throws IOException, WebApplicationException {
 
		Optional<MessageBodyReader<Object>> reader = findReader(type, genericType, annotations, mediaType);
		if(reader.isPresent()){
			return reader.get().readFrom(type, genericType, annotations, mediaType, httpHeaders, entityStream);
		}
 
		String output = IOUtils.toString(entityStream);
		throw new ProcessingException("Unexpected content: " + output);
	}
	// .. skip

Summary

以parse error、unexpected media type與unexpected json content(parse ok)三種錯誤來說:

  1. ReadInterceptor & InputStreamSniffer: 適用於parse error與unexpected json content。
  2. Read All Content of ReadInterceptor: 適用於以上提及的所有錯誤情形,但效率較差。
  3. Customized MessageBodyReader: 適用於unexpected media type。

要使用哪種方式,可仔細評估後再決定。

留言

這個網誌中的熱門文章

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 --dhcptimeo

解決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而產生的樣子..)

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。