Merge pull request #36 from germanbisogno/develop

Develop

Author: germanbisogno

README.md

@@ -26,7 +26,7 @@ The following example shows how to use the Tracing class with Selenium Webdriver
 
 ```js
 
-import { CDPSession, Tracing } from "cdp-utils";
+import { CDPClient, Tracing } from "cdp-utils";
 
 test('Test tracing', async () => {
     const options = new chrome.Options();
@@ -40,11 +40,11 @@ test('Test tracing', async () => {
     const googlePage = new GooglePage(driver);
 
     // Initializes the CDP client connection
-    const cdpSession = new CDPSession();
-    await cdpSession.init(port);
+    const cdpClient = new CDPClient();
+    await cdpClient.init(port);
 
     // Instantiates the class and produces a file as result of the trace
-    const tracing = new Tracing(cdpSession, 'tracing.json');
+    const tracing = new Tracing(cdpClient, 'tracing.json');
 
     // start tracing
     await tracing.startTrace();
@@ -57,7 +57,7 @@ test('Test tracing', async () => {
     // do whatever with trace
 
     // Close the CDP client connection
-    await cdpSession.close()
+    await cdpClient.close()
 
     await driver.quit();
 
@@ -71,7 +71,7 @@ An example using the Performance class with Selenium Webdriver.
 
 ```js
 
-import { CDPSession, Performance } from "cdp-utils";
+import { CDPClient, Performance } from "cdp-utils";
 
 test('Test performance', async () => {
     const options = new chrome.Options();
@@ -85,11 +85,11 @@ test('Test performance', async () => {
     const googlePage = new GooglePage(driver);
 
     // Initializes the CDP client connection
-    const cdpSession = new CDPSession();
-    await cdpSession.init(port);
+    const cdpClient = new CDPClient();
+    await cdpClient.init(port);
 
     // Instantiates the class and produces two files as result of the trace
-    const performance = new Performance(cdpSession, 'startTrace.json', 'endTrace.json');
+    const performance = new Performance(cdpClient, 'startTrace.json', 'endTrace.json');
 
     // start tracing
     const perfStartResults = await performance.startTrace();
@@ -103,7 +103,7 @@ test('Test performance', async () => {
     // Perform assertions or do whatever with perfStartResults or perfEndResults
 
     // Close the CDP client connection
-    await cdpSession.close()
+    await cdpClient.close()
 
     await driver.quit();
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gbisogno/cdp-utils",
-  "version": "1.3.5",
+  "version": "1.3.6",
   "description": "A set of utilities/wrapper for Test Automation or Performance testing on top of Chrome DevTools Protocol",
   "repository": {
     "type": "git",

src/__tests__/network.test.ts

@@ -3,7 +3,7 @@ import * as chrome from "selenium-webdriver/chrome";
 import 'chromedriver';
 import { GooglePage } from '../pages/googlePage';
 import { Network } from '../network';
-import { CDPSession } from '../cdpSession';
+import { CDPClient } from '../cdpClient';
 import { config } from "../config/config";
 import { getFreePort } from 'endpoint-utils';
 import { Har } from "har-format";
@@ -23,10 +23,10 @@ test('Test Network', async () => {
 
     const googlePage = new GooglePage(driver);
 
-    const cdpSession = new CDPSession();
-    await cdpSession.init(port);
+    const cdpClient = new CDPClient();
+    await cdpClient.init(port);
 
-    const network = new Network(cdpSession, 'network.har');
+    const network = new Network(cdpClient, 'network.har');
 
     await network.startTrace();
 
@@ -37,7 +37,7 @@ test('Test Network', async () => {
     const networkResults: Har = await network.stopTrace();
     expect(networkResults.log.entries.length).toBeGreaterThan(0);
 
-    await cdpSession.close();
+    await cdpClient.close();
 
     await driver.quit()
 

src/__tests__/performance.test.ts

@@ -3,7 +3,7 @@ import * as chrome from "selenium-webdriver/chrome";
 import 'chromedriver';
 import { GooglePage } from '../pages/googlePage';
 import { Performance } from '../performance';
-import { CDPSession } from '../cdpSession';
+import { CDPClient } from '../cdpClient';
 import { config } from "../config/config";
 import { getFreePort } from 'endpoint-utils';
 
@@ -22,10 +22,10 @@ test('Test Performance', async () => {
 
     const googlePage = new GooglePage(driver);
 
-    const cdpSession = new CDPSession();
-    await cdpSession.init(port);
+    const cdpClient = new CDPClient();
+    await cdpClient.init(port);
 
-    const performance = new Performance(cdpSession, 'startTrace.json', 'endTrace.json');
+    const performance = new Performance(cdpClient, 'startTrace.json', 'endTrace.json');
 
     const perfStartResults = await performance.startTrace();
 
@@ -38,7 +38,7 @@ test('Test Performance', async () => {
     expect(perfStartResults.metrics.length).toBeGreaterThan(0);
     expect(perfEndResults.metrics.length).toBeGreaterThan(0);
 
-    await cdpSession.close();
+    await cdpClient.close();
 
     await driver.quit()
 

src/__tests__/runtime.test.ts

@@ -3,7 +3,7 @@ import * as chrome from "selenium-webdriver/chrome";
 import 'chromedriver';
 import { GooglePage } from '../pages/googlePage';
 import { Runtime } from '../runtime';
-import { CDPSession } from '../cdpSession';
+import { CDPClient } from '../cdpClient';
 import { config } from "../config/config";
 import { getFreePort } from 'endpoint-utils';
 
@@ -22,10 +22,10 @@ test('Test Runtime', async () => {
 
     const googlePage = new GooglePage(driver);
 
-    const cdpSession = new CDPSession();
-    await cdpSession.init(port);
+    const cdpClient = new CDPClient();
+    await cdpClient.init(port);
 
-    const runtime = new Runtime(cdpSession, 'console.json');
+    const runtime = new Runtime(cdpClient, 'console.json');
 
     await runtime.startTrace();
 
@@ -45,7 +45,7 @@ test('Test Runtime', async () => {
     expect(consoleResults.find(x => x.type === 'warning')).toBeDefined();
     expect(consoleResults.find(x => x.type === 'log')).toBeDefined();
 
-    await cdpSession.close();
+    await cdpClient.close();
 
     await driver.quit()
 

src/__tests__/tracing.test.ts

@@ -1,7 +1,7 @@
 import { Builder } from "selenium-webdriver";
 import * as chrome from "selenium-webdriver/chrome";
 import 'chromedriver';
-import { CDPSession } from '../cdpSession';
+import { CDPClient } from '../cdpClient';
 import { GooglePage } from '../pages/googlePage';
 import { Tracing } from '../tracing';
 import { config } from "../config/config";
@@ -22,10 +22,10 @@ test('Test Tracing', async () => {
 
     const googlePage = new GooglePage(driver);
 
-    const cdpSession = new CDPSession();
-    await cdpSession.init(port);
+    const cdpClient = new CDPClient();
+    await cdpClient.init(port);
 
-    const tracing = new Tracing(cdpSession, 'tracing.json');
+    const tracing = new Tracing(cdpClient, 'tracing.json');
 
     await driver.get("https://www.google.com");
 
@@ -37,7 +37,7 @@ test('Test Tracing', async () => {
 
     expect(tracingResults.length).toBeGreaterThan(0);
 
-    await cdpSession.close();
+    await cdpClient.close();
 
     await driver.quit();
 });

src/cdpSession.ts src/cdpClient.tssrc/cdpSession.ts renamed to src/cdpClient.ts

@@ -1,7 +1,7 @@
 import CDP from "chrome-remote-interface";
 import { logger } from "./utils/logger";
 
-export class CDPSession{
+export class CDPClient {
     private _client: CDP.Client;
 
     /**
@@ -23,7 +23,7 @@ export class CDPSession{
     /**
      * Gets the CDP client connection
      */
-    public get client(): CDP.Client {
+    public get(): CDP.Client {
         return this._client;
     }
 

src/geoLocation.ts

@@ -1,14 +1,14 @@
 import * as CDP from 'chrome-remote-interface';
-import { CDPSession } from './cdpSession';
+import { CDPClient } from './cdpClient';
 
 import { Coordinates } from './interfaces/coordinates'
 import { logger } from "./utils/logger";
 
 export class GeoLocation {
     private _client: CDP.Client;
 
-    constructor(cdpSession: CDPSession) {
-        this._client = cdpSession.client;
+    constructor(cdpClient: CDPClient) {
+        this._client = cdpClient.get();
     }
     /**
      * Emulates a geo location by coordinates

src/index.ts

@@ -5,5 +5,5 @@ export { Lighthouse } from './lighthouse';
 export { Tracing } from './tracing';
 export { Runtime } from './runtime';
 export { GeoLocation } from './geoLocation';
-export { CDPSession } from './cdpSession';
+export { CDPClient } from './cdpClient';
 export { config } from './config/config';

src/network.ts

@@ -4,7 +4,7 @@ import { TraceOperations } from './traceOperations'
 import { logger } from "./utils/logger";
 import { NetworkConditions } from './interfaces/networkConditions';
 import { Har } from 'har-format';
-import { CDPSession } from './cdpSession';
+import { CDPClient } from './cdpClient';
 import CDP from 'chrome-remote-interface';
 
 // event types to observe
@@ -79,9 +79,9 @@ export class Network extends TraceOperations {
     protected _events: any[] = [];
     private _client: CDP.Client;
 
-    constructor(cdpSession: CDPSession, traceFileName: string = '') {
+    constructor(cdpClient: CDPClient, traceFileName: string = '') {
         super();
-        this._client = cdpSession.client;
+        this._client = cdpClient.get();
         this._traceFileName = traceFileName;
     }