Support for Incognito session

[saikrishna321]

Address: #862 #921 #560

#818 (comment)

[zabil]

Amazing work and feature to be working with multiple browsers!

Before doing the technical review here are some API thoughts.

One use case for this feature is supporting different user roles in the same workflow. For e.g. consider a hypothetical admin and non admin system

• User logs in
• User requests creates and submits and item
• Admin logs in
• Admin approves the item
• Use checks if the item if approved

A readable api for this workflow would be

openBrowser({profile: ‘user’})
write("user", into(‘Username:’))
write("password", into(‘Password:’))
click(“Sign In”)
click(“Submit Item”)
openBrowser({profile: ‘admin’))
write(‘admin’, into(‘Username:’))
write(‘password’, into(‘Password:’))
click(“Sign In”)
click(‘approve’)
switchTo({profile: ‘user”)
text(“approved”).exists()
closeBrowser({profile: "user"})
closeBrowser({profile: "admin"})

Notice that there is no incognito mode. If the user wants to launch incognito mode it can be

openBrowser({profile: ‘user’, incognito: true})

This way the user can also pass arguments to openBrowser()

It's better not to have a seperate incognito mode api.
Does that make sense?

More details about profiles at #921

[saikrishna321]

@zabil @negiDharmendra Can you please review now?

Docstring is pending.

[zabil]

It's better to handle support for profiles in another PR using the profile directory of chrome.
For this feature the recommendation is an API as follows.

openWindow(url, { name: "new window"});

This opens a window by default. If the user wants to open it in incognito mode

openWindow(url, { name: "private", incognito: true})

For switching windows

switchTo("new window")
switchTo("private")

For closing the window

closeWindow("name") // or can be a regex to close multiple windows with the same pattern

A representative use case could look like

openBrowser()
goto("example.com")
write("user", into(‘Username:’))
write("password", into(‘Password:’))
click(“Sign In”)
click(“Submit Item”)

openWindow("example.com", {name: "admin", incognito: true})
write(‘admin’, into(‘Username:’))
write(‘password’, into(‘Password:’))
click(“Sign In”)
click(‘approve’)

switchTo("User: Item lists") // Assuming title of the page
text(“approved”).exists()
closeWindow("admin") // name of the incognito window
closeBrowser() // Also closes all open windows.

[saikrishna321]

@zabil I have fixed all the feedbacks.

[negiDharmendra]

should await newCritarget

[Debashis9012]

@saikrishna321,

1. observation of Test Case 5: For duplicate usage of window name { name : "gauge"} currently we are providing the warning message to the user but the problem in this case closeWindow functionality breaks as it will not able to close all the window with the same duplicate window name.

   For this first time closeWindow works successfully:

   closeWindow("gauge")
   ✔ Window with name gauge closed

   afterwards, it's throwing below error:

   > closeWindow("gauge")
   ✘ Error: Cannot read property 'targetId' of undefined, run `.trace` for more info.
   

   We had discussed this in the stand up, all of us agreed on switching to the existing window with
   the provided name and printing the warning message.

2. Most of the time openWindowis not able to load the url and repl hangs where open window with incognito mode works fine. So we agreed on changing the behaviour of openWindow to open window in incognito mode by default and if the user wants to open normal window then they can pass incognito with false parameter.
   openWindow(url, { name: "private", incognito: false})

[zabil]

We had discussed this in the stand up, all of us agreed on switching to the existing window with
the provided name and printing the warning message.

For example

> openWindow({name: "unique"})
> click("login")
> openWindow({name: "unique"})
A window with the name "unique" is already open, switching to it.

This is a warning and not an error.

[saikrishna321]

We had discussed this in the stand up, all of us agreed on switching to the existing window with
the provided name and printing the warning message.

For example

> openWindow({name: "unique"})
> click("login")
> openWindow({name: "unique"})
A window with the name "unique" is already open, switching to it.

This is a warning and not an error.

@zabil #996 (comment) we decided previosuly to open a new window with random name. I'm getting confused now.

[zabil]

we decided previosuly to open a new window with random name. I'm getting confused now.

So sorry for the confusion. I did say that, but I did not consider the effect that it may have on the closeWindow or managing the windows. Hence the new recommendation.

[saikrishna321]

@zabil @Debashis9012 Please review. Fixed all the comments