webdriver-reuse-session - npm Package Compare versions

Comparing version 0.0.1 to 0.0.3

bin/webdriver-reuse-session.js

@@ -6,4 +6,2 @@ #!/usr/bin/env node
 
-const wrs = require('../dist/webdriver-session');
-
-wrs.getChromeSessionId();
+const wrs = require('../dist/webdriver-reuse-session');

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const webdriver_session_1 = require("./webdriver-session");
-exports.getChromeSessionId = webdriver_session_1.getChromeSessionId;
-exports.getSessionIdFromFileSync = webdriver_session_1.getSessionIdFromFileSync;
+const webdriver_reuse_session_1 = require("./webdriver-reuse-session");
+exports.getChromeSessionId = webdriver_reuse_session_1.getChromeSessionId;
+exports.getSessionIdFromFileSync = webdriver_reuse_session_1.getSessionIdFromFileSync;

package.json

 {
   "name": "webdriver-reuse-session",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Manage Webdriver sessions and make sessions id's available for e.g. Protractor and other TDD and BBD tools",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,6 +0,28 @@
-# webdriver-reuse-session
-Manage Webdriver/Selenium/Chromedriver sessions and make sessions id's available for e.g. Protractor and other TDD and BBD tools. 
+# WebDriver Reuse Session
 
+## TL;DR
+
+1) run 'webdriver-reuse-browser' - get the session id from a browser that can be reused
+2) insert the session id in the config file or via the command line
+
+## The Why?
+
+*If you want better, faster and more enjoyable test, then this is the place to be*
+
+ * **Better** - because the more times you run your test, the more bugs you can find
+ * **Faster** - because browser start-up time, cache warm-up (loading of images and static JS), authentication and similar is removed or reduced
+ * **More Enjoyable** - because slow test and long feedback times, is the oposite of [Flow and Programmer Happiness](https://www.youtube.com/watch?v=AJ7u_Z-TS-A&feature=youtu.be&t=116). 
+
+Protractor is a nice an well-behaving tool, so it closes the browsers it creates, but sometimes you want to keep it open for debugging purposes or for speeding up the next test. 
+
+And Protractor actually supports attaching to browsers, but it needs some manual to start the browser. 
+
+This tool can.. 
+
+Start Webdriver, Selenium or ChromeDriver sessions and make sessions id's available for [Protractor](https://www.protractortest.org) and similar Web Browser Test Automation Frameworks
+
 ## Speed up your tests
 
+The normal approach is that every test run starts a new browser, which often takes between 5 to 10 seconds. 
+Using [webdriver-reuse-session]()
 Using this can take between 5-10 seconds of your start-up time, and sometimes even more. 
@@ -37,6 +59,10 @@ If you have an authentication step, then this can be added.
 
-### Start a browser or find a Chrome Browser
+The 'webdriver-reuse-session' script can be used both in a manual mode and in an automatic mode.
 
-1. Start Webdriver-manager or a raw selenium
+### Manual Approach
 
+#### Start a browser or find a Chrome Browser, in the manual approach
+
+1. Start Webdriver-manager or a raw selenium instance
+
 ```sh
@@ -52,8 +78,25 @@ npm webdriver-manager start
 
-### From your test tool
+3. Take a note of the session id
 
+#### From your test tool
+
+1. Setup your script to use a local host Selenium
+  
+    ```javascript
+    /** in your protractor.conf.js or similar config object*/
+    directConnect: undefined,  // can be omitted, but just to show that directConnect must not be set
+    seleniumAddress: 'http://localhost:4444/wd/hub',
+    ```
+
+2. Use the SessionID in the command line
+
+    protractor --seleniumSessionId=6aec0d5861daa54d0b9be17ec47bea70
+   
+    
+### The automatic approach
+
 1. Get the SessionID
   
     ```javascript
-    const sessionId = fs.readFileSync('.seleniumSessionId.dat')
+    const sessionIdFromFile = fs.readFileSync('.seleniumSessionId.txt')
     ```
@@ -72,2 +115,12 @@
 
+## Questions and Answers
+
+### What Test runners will this work with
+
+It is independent of the test runner, it depends on how you define your Selenium Session ID. 
+
+### Does this work with Cucumber
+
+You can use this with Cucumber, Mocha, Jest and other test automation frameworks
+
 ## Feedback and Issues
@@ -74,0 +127,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24765

increased by11.45%

Number of package files

8

increased by14.29%

Lines of code

318

increased by1.27%

Number of lines in readme file

131

increased by67.95%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes