Merge pull request #18 from AppiumTestDistribution/feature/sniff

Add functionality to listen network traffic during the session

Author: sudharsan-selvaraj

docs/commands.md

@@ -45,7 +45,7 @@ Add a new mock specification for intercepting and updating the request. The comm
 ```javascript
  const authorizationMock = await driver.execute("interceptor: addMock", [{
     config: {
-        url "*reqres.in*",
+        url "**/reqres.in/**",
         headers: {
             "Authorization" : "Bearer bearertoken"
         }
@@ -54,7 +54,7 @@ Add a new mock specification for intercepting and updating the request. The comm
 
   const userListGetMock = await driver.execute("interceptor: addMock", [{
     config: {
-        url "**reqres.in/api/users",
+        url "**/reqres.in/api/users",
         method: "GET",
         responseBody: JSON.stringify({
             page: 2,
@@ -84,7 +84,7 @@ Given a mockId return during addMock command, will remove the mock configuration
 ```javascript
  const authorizationMock = await driver.execute("interceptor: addMock", [{
     config: {
-        url "*reqres.in*",
+        url "**/reqres.in/**",
         headers: {
             "Authorization" : "Bearer bearertoken"
         }
@@ -103,3 +103,146 @@ Given a mockId return during addMock command, will remove the mock configuration
  // authorizationMock will not be active after this point and the test will proceed with normal flow
 ```
 
+### interceptor: startListening
+
+Start listening for all network traffic (API calls) made by the device during a session
+
+#### Example:
+
+```javascript
+  await driver.execute("interceptor: startListening");
+  // perform some action
+  // ...
+```
+
+It also supports filtering the request based on the url. `include` will only listents for requests that macthes the given url pattern and `exclude` will listen for all api's that doesn't match the url pattern.
+
+```javascript
+  await driver.execute("interceptor: startListening", [{
+    config: {
+      "include" : {
+        url "**/reqres.in/**",
+      }
+    }
+ }]);
+  // perform some action
+  // ...
+```
+
+```javascript
+  await driver.execute("interceptor: startListening", [{
+    config: {
+      "exclude" : {
+        url "**/reqres.in/**",
+      }
+    }
+ }]);
+  // perform some action
+  // ...
+```
+
+### interceptor: stopListening
+
+Stops listening for networks traffic and return all previously recorded api calls.
+
+#### Example:
+
+```javascript
+  await driver.execute("interceptor: startListening");
+  // perform some action
+  // ...
+  const apiRequests = await driver.execute("interceptor: stopListening");
+```
+
+#### Returns:
+
+stopListening command will retunrs an array of network details in the below JSON format
+
+```javascript
+[
+  {
+      "requestBody": "",
+      "requestHeaders": {
+        "host": "reqres.in",
+        "connection": "keep-alive",
+        "content-length": "41",
+        "sec-ch-ua": "\" Not;A Brand\";v=\"99\", \"Google Chrome\";v=\"91\", \"Chromium\";v=\"91\"",
+        "sec-ch-ua-mobile": "?1",
+        "user-agent": "Mozilla/5.0 (Linux; Android 12; sdk_gphone64_arm64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Mobile Safari/537.36",
+        "content-type": "application/json",
+        "accept": "*/*",
+        "origin": "https://reqres.in",
+        "sec-fetch-site": "same-origin",
+        "sec-fetch-mode": "cors",
+        "sec-fetch-dest": "empty",
+        "referer": "https://reqres.in/",
+        "accept-encoding": "gzip, deflate, br",
+        "accept-language": "en-US,en;q=0.9",
+        "cookie": "_gid=GA1.2.1828776619.1706164095; __stripe_mid=3d0fd295-9d68-4d75-bdb2-55b809fb49ed8dba35; __stripe_sid=466b9d3a-2d7b-4f48-9c66-ca859c8d342f06a86f; _gat=1; _gat_gtag_UA_174008107_1=1; _ga_CESXN06JTW=GS1.1.1706164096.1.1.1706166680.0.0.0; _ga=GA1.1.546181777.1706164095; _ga_WSM10MMEKC=GS1.2.1706164097.1.1.1706166681.0.0.0"
+      },
+      "url": "https://reqres.in/api/users/2",
+      "method": "PUT",
+      "responseBody": "{\"name\":\"morpheus\",\"job\":\"zion resident\",\"updatedAt\":\"2024-01-25T07:24:58.607Z\"}",
+      "responseHeaders": {
+        "http/1.1 200 ok": "HTTP/1.1 200 OK",
+        "date": "Thu, 25 Jan 2024 07:24:58 GMT",
+        "content-type": "application/json; charset=utf-8",
+        "transfer-encoding": "chunked",
+        "connection": "close",
+        "report-to": "{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1706167498&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=OTZf6wqjMxJtlD7uxpJC1eBUfbrlcO7RrUKeTeefoG0%3D\"}]}",
+        "reporting-endpoints": "heroku-nel=https://nel.heroku.com/reports?ts=1706167498&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=OTZf6wqjMxJtlD7uxpJC1eBUfbrlcO7RrUKeTeefoG0%3D",
+        "nel": "{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}",
+        "x-powered-by": "Express",
+        "access-control-allow-origin": "*",
+        "etag": "W/\"50-XmcMaub9BFf/y9879X3p35X0L4c\"",
+        "via": "1.1 vegur",
+        "cf-cache-status": "DYNAMIC",
+        "vary": "Accept-Encoding",
+        "server": "cloudflare",
+        "cf-ray": "84aec7909fed601c-SIN"
+      },
+      "statusCode": 200
+    },
+    {
+      "requestBody": "",
+      "requestHeaders": {
+        "host": "reqres.in",
+        "connection": "keep-alive",
+        "sec-ch-ua": "\" Not;A Brand\";v=\"99\", \"Google Chrome\";v=\"91\", \"Chromium\";v=\"91\"",
+        "sec-ch-ua-mobile": "?1",
+        "user-agent": "Mozilla/5.0 (Linux; Android 12; sdk_gphone64_arm64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Mobile Safari/537.36",
+        "content-type": "application/json",
+        "accept": "*/*",
+        "origin": "https://reqres.in",
+        "sec-fetch-site": "same-origin",
+        "sec-fetch-mode": "cors",
+        "sec-fetch-dest": "empty",
+        "referer": "https://reqres.in/",
+        "accept-encoding": "gzip, deflate, br",
+        "accept-language": "en-US,en;q=0.9",
+        "cookie": "_gid=GA1.2.1828776619.1706164095; __stripe_mid=3d0fd295-9d68-4d75-bdb2-55b809fb49ed8dba35; __stripe_sid=466b9d3a-2d7b-4f48-9c66-ca859c8d342f06a86f; _gat=1; _gat_gtag_UA_174008107_1=1; _ga_CESXN06JTW=GS1.1.1706164096.1.1.1706166680.0.0.0; _ga=GA1.1.546181777.1706164095; _ga_WSM10MMEKC=GS1.2.1706164097.1.1.1706166681.0.0.0"
+      },
+      "url": "https://reqres.in/api/users/2",
+      "method": "DELETE",
+      "responseBody": "",
+      "responseHeaders": {
+        "http/1.1 204 no content": "HTTP/1.1 204 No Content",
+        "date": "Thu, 25 Jan 2024 07:24:59 GMT",
+        "content-length": "0",
+        "connection": "close",
+        "report-to": "{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1706167499&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=GzTutDCgQC4QQ%2BomNat%2BqJScD%2BtwfgViqmG7fz6%2F9yk%3D\"}]}",
+        "reporting-endpoints": "heroku-nel=https://nel.heroku.com/reports?ts=1706167499&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=GzTutDCgQC4QQ%2BomNat%2BqJScD%2BtwfgViqmG7fz6%2F9yk%3D",
+        "nel": "{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}",
+        "x-powered-by": "Express",
+        "access-control-allow-origin": "*",
+        "etag": "W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\"",
+        "via": "1.1 vegur",
+        "cf-cache-status": "DYNAMIC",
+        "server": "cloudflare",
+        "cf-ray": "84aec7977f6c9f77-SIN"
+      },
+      "statusCode": 204
+    }
+]
+```
+

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-interceptor",
-  "version": "1.0.0-beta.5",
+  "version": "1.0.0-beta.6",
   "description": "Appium 2.0 plugin to mock api calls for android apps",
   "main": "./lib/index.js",
   "scripts": {
@@ -13,7 +13,7 @@
     "uninstall": "export APPIUM_HOME=/tmp/some-temp-dir && (appium plugin uninstall appium-interceptor || exit 0)",
     "install-plugin": "export APPIUM_HOME=/tmp/some-temp-dir && npm run build && appium plugin install --source=local $(pwd)",
     "reinstall-plugin": "export APPIUM_HOME=/tmp/some-temp-dir && (appium plugin uninstall appium-interceptor || exit 0) && npm run install-plugin",
-    "run-server": "export APPIUM_HOME=/tmp/some-temp-dir && appium server -ka 800 --use-plugins=appium-interceptor -pa /wd/hub "
+    "run-server": "export APPIUM_HOME=/tmp/some-temp-dir && appium server -ka 800 --use-plugins=appium-interceptor -pa /wd/hub"
   },
   "contributors": [
     {
@@ -110,6 +110,7 @@
     "jsonpath": "^1.1.1",
     "lodash": "^4.17.21",
     "minimatch": "^9.0.3",
+    "parse-headers": "^2.0.5",
     "regex-parser": "^2.3.0",
     "uuid": "^9.0.1",
     "yargs": "^17.7.2",

package.json

@@ -0,0 +1,33 @@
+import { RequestInfo, SniffConfig } from './types';
+import { doesUrlMatch } from './utils/proxy';
+
+export class ApiSniffer {
+  private readonly requests: RequestInfo[] = [];
+
+  constructor(private id: string, private config: SniffConfig) {}
+
+  getId() {
+    return this.id;
+  }
+
+  onApiRequest(request: RequestInfo) {
+    if (this.doesRequestMatchesConfig(request)) {
+      this.requests.push(request);
+    }
+  }
+
+  getRequests() {
+    return this.requests;
+  }
+
+  private doesRequestMatchesConfig(request: RequestInfo) {
+    const doesIncludeRuleMatches = !this.config.include
+      ? true
+      : this.config.include.some((config) => doesUrlMatch(config.url, request.url));
+    const doesExcludeRuleMatches = !this.config.exclude
+      ? true
+      : !this.config.exclude.some((config) => doesUrlMatch(config.url, request.url));
+
+    return doesIncludeRuleMatches && doesExcludeRuleMatches;
+  }
+}

src/api-sniffer.ts

@@ -0,0 +1,61 @@
+import { ErrorCallback, IContext } from 'http-mitm-proxy';
+import stream from 'stream';
+import { constructURLFromHttpRequest } from './utils/proxy';
+import responseDecoder from './response-decoder';
+import parseHeader from 'parse-headers';
+
+function readBodyFromStream(writable: stream.Writable | undefined, callback: (value: any) => void) {
+  if (!writable) {
+    return callback(null);
+  }
+  const [originalWrite, originalEnd] = [writable.write, writable.end];
+  const chunks: Buffer[] = [];
+
+  (writable.write as unknown) = function (...args: any) {
+    chunks.push(typeof args[0] === 'string' ? Buffer.from(args[0]) : args[0]);
+    originalWrite.apply(writable, args);
+  };
+
+  (writable.end as unknown) = async function (...args: any) {
+    if (args[0]) {
+      chunks.push(typeof args[0] === 'string' ? Buffer.from(args[0]) : args[0]);
+    }
+    originalEnd.apply(writable, args);
+    callback(Buffer.concat(chunks).toString('utf8'));
+  };
+}
+
+function RequestInterceptor(requestCompletionCallback: (value: any) => void) {
+  return function (ctx: IContext, callback: ErrorCallback) {
+    ctx.use(responseDecoder);
+    const requestData = {} as any;
+    ctx.onRequestEnd((ctx, callback) => {
+      readBodyFromStream(ctx.proxyToServerRequest, (requestBody) => {
+        requestData['requestBody'] = requestBody;
+        requestData['requestHeaders'] = ctx.proxyToServerRequest?.getHeaders();
+      });
+      callback();
+    });
+
+    readBodyFromStream(ctx.proxyToClientResponse, (response) => {
+      const { headers, url } = ctx.clientToProxyRequest;
+      const protocol = ctx.isSSL ? 'https://' : 'http://';
+      const _url = constructURLFromHttpRequest({
+        host: headers.host!,
+        path: url!,
+        protocol,
+      });
+      const responseHeaders = parseHeader((ctx.proxyToClientResponse as any)?._header || '');
+      requestData['url'] = _url.toString();
+      requestData['method'] = ctx.clientToProxyRequest.method;
+      requestData['responseBody'] = response;
+      requestData['responseHeaders'] = responseHeaders;
+      requestData['statusCode'] = ctx.proxyToClientResponse.statusCode;
+
+      requestCompletionCallback(requestData);
+    });
+    callback();
+  };
+}
+
+export { RequestInterceptor };