fixup! implement uuid in query param matcher

Author: maxeoneo

README.md

@@ -52,6 +52,28 @@ To manually process requests:
     }
 ```
 
+For both cases you can choose between different strategies for how the recorded requests (including 
+the body) and the intercepted requests are matched together. By default, only the url is used. If 
+you want to use a different strategy, for example if you have parallel requests to the same url with
+different bodies (e.g. GraphQL queries), you can pass a custom `RequestMatcher` to the constructor 
+of `RequestInspectorWebViewClient`:
+
+```kotlin
+    val webView = WebView(this)
+    webView.webViewClient = RequestInspectorWebViewClient(
+        webView,
+        matcher = RequestUuidInHeaderMatcher()
+    )
+```
+
+Currently available matchers are `RequestUuidInHeaderMatcher` and `RequestUuidInUrlMatcher`, which 
+both create an UUID and add it to the request before it's recorded and sent. They only differ by how
+the attach the UUID to the request, as an additional header or as an additional query param. But 
+both clean up the request before it's been sent. 
+
+If you want to implement your own matching strategy, you can implement the `RequestMatcher` 
+interface and pass an instance of it to the constructor of `RequestInspectorWebViewClient`.
+
 Known limitations
 ===
 

app/src/main/java/com/acsbendi/requestinspectorwebview/RequestInspectorJavaScriptInterface.kt

@@ -122,12 +122,12 @@ class RequestInspectorJavaScriptInterface(webView: WebView, val matcher: Request
 
     @JavascriptInterface
     fun getAdditionalHeaders(url: String): String {
-        return matcher.additionalHeaders(url).toString()
+        return matcher.getAdditionalHeaders(url).toString()
     }
 
     @JavascriptInterface
     fun getAdditionalQueryParam(): String {
-        return matcher.getAdditionalQueryParam()
+        return matcher.getAdditionalQueryParams()
     }
 
     private fun addRecordedRequest(recordedRequest: RecordedRequest) {
@@ -256,7 +256,7 @@ function getFullUrl(url) {
     }
 }
 
-function appendAdditionalQueryParam(url) {
+function appendAdditionalQueryParams(url) {
     try {
         var extraQueryParam = $INTERFACE_NAME.getAdditionalQueryParam();
         if (extraQueryParam) {
@@ -266,7 +266,9 @@ function appendAdditionalQueryParam(url) {
                 url += '&' + extraQueryParam;
             }
         }
-    } catch (e) { console.warn('Failed to inject query param from Kotlin:', e); }
+    } catch (e) { 
+        console.warn('Failed to inject query param from Kotlin:', e); 
+    }
     return url;
 }
 
@@ -290,7 +292,7 @@ function recordFormSubmission(form) {
 
     const path = form.attributes['action'] === undefined ? "/" : form.attributes['action'].nodeValue;
     const method = form.attributes['method'] === undefined ? "GET" : form.attributes['method'].nodeValue;
-    const url = appendAdditionalQueryParam(getFullUrl(path));
+    const url = appendAdditionalQueryParams(getFullUrl(path));
     const encType = form.attributes['enctype'] === undefined ? "application/x-www-form-urlencoded" : form.attributes['enctype'].nodeValue;
     const err = new Error();
     $INTERFACE_NAME.recordFormSubmission(
@@ -322,7 +324,7 @@ let xmlhttpRequestUrl = null;
 XMLHttpRequest.prototype._open = XMLHttpRequest.prototype.open;
 XMLHttpRequest.prototype.open = function (method, url, async, user, password) {
     lastXmlhttpRequestPrototypeMethod = method;
-    xmlhttpRequestUrl = appendAdditionalQueryParam(url);
+    xmlhttpRequestUrl = appendAdditionalQueryParams(url);
     const asyncWithDefault = async === undefined ? true : async;
     this._open(method, xmlhttpRequestUrl, asyncWithDefault, user, password);
 };
@@ -364,7 +366,7 @@ window.fetch = function () {
     const firstArgument = arguments[0];
     let url, method, body, headers;
     if (typeof firstArgument === 'string') {
-        url = appendAdditionalQueryParam(firstArgument);
+        url = appendAdditionalQueryParams(firstArgument);
         if (!arguments[1]) arguments[1] = {};
         method = arguments[1] && 'method' in arguments[1] ? arguments[1]['method'] : "GET";
         body = arguments[1] && 'body' in arguments[1] ? arguments[1]['body'] : "";
@@ -379,7 +381,7 @@ window.fetch = function () {
         arguments[0] = url;
     } else {
         // Request object
-        url = appendAdditionalQueryParam(firstArgument.url);
+        url = appendAdditionalQueryParams(firstArgument.url);
         method = firstArgument.method;
         body = firstArgument.body;
         headers = Object.fromEntries(firstArgument.headers.entries());

app/src/main/java/com/acsbendi/requestinspectorwebview/RequestInspectorWebViewClient.kt

@@ -7,13 +7,13 @@ import android.webkit.WebResourceRequest
 import android.webkit.WebResourceResponse
 import android.webkit.WebView
 import android.webkit.WebViewClient
-import androidx.core.net.toUri
 import com.acsbendi.requestinspectorwebview.matcher.RequestMatcher
 import com.acsbendi.requestinspectorwebview.matcher.RequestUrlMatcher
 
 @SuppressLint("SetJavaScriptEnabled")
 open class RequestInspectorWebViewClient @JvmOverloads constructor(
-    webView: WebView, val matcher: RequestMatcher = RequestUrlMatcher(),
+    webView: WebView,
+    val matcher: RequestMatcher = RequestUrlMatcher(),
     private val options: RequestInspectorOptions = RequestInspectorOptions()
 ) : WebViewClient() {
 
@@ -48,7 +48,7 @@ open class RequestInspectorWebViewClient @JvmOverloads constructor(
 
     override fun onPageStarted(view: WebView, url: String, favicon: Bitmap?) {
         Log.i(LOG_TAG, "Page started loading, enabling request inspection. URL: $url")
-        matcher.setOrigin(url)
+        matcher.onPageStarted(url)
         RequestInspectorJavaScriptInterface.enabledRequestInspection(
             view,
             options.extraJavaScriptToInject

app/src/main/java/com/acsbendi/requestinspectorwebview/matcher/RequestMatcher.kt

@@ -8,8 +8,8 @@ import org.json.JSONObject
 interface RequestMatcher {
     fun addRecordedRequest(recordedRequest: RecordedRequest)
     fun createWebViewRequest(request: WebResourceRequest): WebViewRequest
-    fun additionalHeaders(url: String): JSONObject = JSONObject()
-    fun getAdditionalQueryParam(): String = ""
-    fun setOrigin(url: String) {}
+    fun getAdditionalHeaders(url: String): JSONObject = JSONObject()
+    fun getAdditionalQueryParams(): String = ""
+    fun onPageStarted(url: String) {}
 }
 

app/src/main/java/com/acsbendi/requestinspectorwebview/matcher/RequestUuidInHeaderMatcher.kt

@@ -26,7 +26,7 @@ class RequestUuidInHeaderMatcher() : RequestUuidMatcher() {
     override fun getUuidFromRequest(webResourceRequest: WebResourceRequest): String? =
         webResourceRequest.requestHeaders[REQUEST_INSPECTOR_ID]
 
-    override fun cleanupRequests(request: WebResourceRequest, recordedRequest: RecordedRequest?): Pair<WebResourceRequest, RecordedRequest?> {
+    override fun removeUuidFromRequests(request: WebResourceRequest, recordedRequest: RecordedRequest?): Pair<WebResourceRequest, RecordedRequest?> {
         // Clean up headers by removing REQUEST_ID_HEADER from both requests
         val cleanedRequest = object : WebResourceRequest by request {
             override fun getRequestHeaders(): Map<String, String> =
@@ -38,7 +38,7 @@ class RequestUuidInHeaderMatcher() : RequestUuidMatcher() {
         return cleanedRequest to cleanedRecordedRequest
     }
 
-    override fun additionalHeaders(url: String): JSONObject {
+    override fun getAdditionalHeaders(url: String): JSONObject {
         val headersJson = JSONObject()
         if (getOrigin(url) == origin) {
             val uuid = UUID.randomUUID().toString()
@@ -49,7 +49,7 @@ class RequestUuidInHeaderMatcher() : RequestUuidMatcher() {
         return headersJson
     }
 
-    override fun setOrigin(url: String) {
+    override fun onPageStarted(url: String) {
         origin = getOrigin(url)
     }
 

app/src/main/java/com/acsbendi/requestinspectorwebview/matcher/RequestUuidInQueryParamMatcher.kt

@@ -12,7 +12,7 @@ class RequestUuidInQueryParamMatcher : RequestUuidMatcher() {
     override fun getUuidFromRequest(webResourceRequest: WebResourceRequest): String? =
         webResourceRequest.url.getQueryParameter(REQUEST_INSPECTOR_ID)
 
-    override fun cleanupRequests(
+    override fun removeUuidFromRequests(
         request: WebResourceRequest,
         recordedRequest: RequestInspectorJavaScriptInterface.RecordedRequest?
     ): Pair<WebResourceRequest, RequestInspectorJavaScriptInterface.RecordedRequest?> {
@@ -32,7 +32,7 @@ class RequestUuidInQueryParamMatcher : RequestUuidMatcher() {
         return cleanedWebResourceRequest to cleanedRecordedRequest
     }
 
-    override fun getAdditionalQueryParam(): String {
+    override fun getAdditionalQueryParams(): String {
         val uuid = UUID.randomUUID().toString()
         return "$REQUEST_INSPECTOR_ID=$uuid"
     }

app/src/main/java/com/acsbendi/requestinspectorwebview/matcher/RequestUuidMatcher.kt

@@ -10,7 +10,7 @@ abstract class RequestUuidMatcher : RequestMatcher {
 
     abstract fun getUuidFromRequest(recordedRequest: RecordedRequest): String?
     abstract fun getUuidFromRequest(webResourceRequest: WebResourceRequest): String?
-    abstract fun cleanupRequests(
+    abstract fun removeUuidFromRequests(
         request: WebResourceRequest,
         recordedRequest: RecordedRequest?
     ): Pair<WebResourceRequest, RecordedRequest?>
@@ -25,7 +25,7 @@ abstract class RequestUuidMatcher : RequestMatcher {
 
     override fun createWebViewRequest(request: WebResourceRequest): WebViewRequest {
         val recordedRequest = findRecordedRequest(request)
-        val (cleanedRequest, cleanedRecordedRequest) = cleanupRequests(request, recordedRequest)
+        val (cleanedRequest, cleanedRecordedRequest) = removeUuidFromRequests(request, recordedRequest)
         return WebViewRequest.create(cleanedRequest, cleanedRecordedRequest)
     }
 
@@ -38,7 +38,7 @@ abstract class RequestUuidMatcher : RequestMatcher {
         return recordedRequest
     }
 
-    override fun setOrigin(url: String) {}
+    override fun onPageStarted(url: String) {}
 
     companion object {
         const val REQUEST_INSPECTOR_ID = "x-request-inspector-id"