Async script execution in Selenium Java

Introduction

Async script execution lets your test wait for a task in the browser to finish before moving on. This helps test things that take time, like loading data.

When you want to wait for a timer or delay in the web page before checking results.

When testing a page that loads data slowly and you need to wait for it.

When you want to run JavaScript that calls a callback after some work is done.

When you need to test animations or transitions that finish after some time.

Syntax

Selenium Java

Object result = ((JavascriptExecutor)driver).executeAsyncScript(
    "var callback = arguments[arguments.length - 1]; window.setTimeout(function(){ callback('done'); }, 1000);"
);

The last argument in the script is always a callback function you must call to finish.

executeAsyncScript waits until the callback is called or timeout happens.

Examples

This waits 500ms then returns 'hello' to Java.

Selenium Java

Object result = ((JavascriptExecutor)driver).executeAsyncScript(
    "var callback = arguments[arguments.length - 1]; window.setTimeout(function(){ callback('hello'); }, 500);"
);

This runs a fetch call and returns the data when ready.

Selenium Java

Object result = ((JavascriptExecutor)driver).executeAsyncScript(
    "var callback = arguments[arguments.length - 1]; fetch('https://api.example.com/data').then(response => response.json()).then(data => callback(data));"
);

Sample Program

This test opens a page, runs an async script that waits 1 second, then returns 'Async Done'. The result is printed.

Selenium Java

import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;

public class AsyncScriptExample {
    public static void main(String[] args) {
        System.setProperty("webdriver.chrome.driver", "path/to/chromedriver");
        WebDriver driver = new ChromeDriver();
        try {
            driver.get("https://www.example.com");
            JavascriptExecutor js = (JavascriptExecutor) driver;
            Object result = js.executeAsyncScript(
                "var callback = arguments[arguments.length - 1];"
                + "window.setTimeout(function() { callback('Async Done'); }, 1000);"
            );
            System.out.println("Result from async script: " + result);
        } finally {
            driver.quit();
        }
    }
}

Important Notes

Always call the callback in your async script to avoid timeout errors.

Timeout for async scripts can be set in Selenium to control max wait time.

Async scripts help test real user waits like loading or animations.

Summary

Async script execution waits for JavaScript tasks to finish before continuing.

Use executeAsyncScript with a callback to handle delayed or async browser actions.

This helps test dynamic web pages that load or change over time.

Practice

1. What is the main purpose of using executeAsyncScript in Selenium Java?

easy

A. To execute JavaScript code only once when the browser starts.

B. To execute synchronous JavaScript code instantly without waiting.

C. To pause the entire Selenium test execution for a fixed time.

D. To run JavaScript code that waits for asynchronous tasks to complete before returning.

Solution

1. Step 1: Understand async JavaScript in Selenium

   Async scripts allow waiting for tasks like AJAX calls or timers to finish before continuing.

2. Step 2: Role of executeAsyncScript

   This method runs JavaScript that signals completion via a callback, so Selenium waits properly.

3. Final Answer:

   To run JavaScript code that waits for asynchronous tasks to complete before returning. -> Option D

4. Quick Check:

   Async script waits for tasks = A [OK]

Hint: Async scripts wait for callback before continuing [OK]

Common Mistakes:

• Confusing async with synchronous script execution
• Thinking it pauses test for fixed time
• Assuming it runs only once at browser start

2. Which of the following is the correct syntax to execute an async script in Selenium Java?

easy

A. driver.executeAsyncScript("var callback = arguments[0]; setTimeout(() => callback(10), 1000);");

B. driver.executeAsyncScript("return 5 + 5;");

C. driver.executeScript("var callback = arguments[0]; callback(10);");

D. driver.executeAsyncScript(() -> { return 10; });

Solution

1. Step 1: Identify async script syntax

   Async scripts require a callback function as the last argument to signal completion.

2. Step 2: Check each option

   driver.executeAsyncScript("var callback = arguments[0]; setTimeout(() => callback(10), 1000);"); correctly defines a callback and calls it after 1 second delay. driver.executeAsyncScript("return 5 + 5;"); lacks callback, C uses executeScript (sync), D uses wrong syntax.

3. Final Answer:

   driver.executeAsyncScript("var callback = arguments[0]; setTimeout(() => callback(10), 1000);"); -> Option A

4. Quick Check:

   Callback with setTimeout = A [OK]

Hint: Async scripts need callback as last argument [OK]

Common Mistakes:

• Not passing or calling the callback function
• Using executeScript instead of executeAsyncScript
• Wrong Java syntax for async scripts

3. What will be the output of the following Selenium Java code snippet?

Object result = driver.executeAsyncScript(
  "var callback = arguments[0]; setTimeout(() => callback('done'), 500);");
System.out.println(result);

medium

A. TimeoutException

B. null

C. done

D. undefined

Solution

1. Step 1: Understand the async script behavior

   The script waits 500ms then calls callback with 'done'. Selenium waits for this callback and returns its value.

2. Step 2: Check what is printed

   The returned value from executeAsyncScript is 'done', so System.out.println prints 'done'.

3. Final Answer:

   done -> Option C

4. Quick Check:

   Callback returns 'done' = C [OK]

Hint: Callback value is returned and printed [OK]

Common Mistakes:

• Expecting null before callback runs
• Confusing async script with synchronous
• Assuming timeout error without delay

4. Identify the error in this Selenium Java async script usage:

driver.executeAsyncScript("setTimeout(() => { return 'done'; }, 1000);");

medium

A. Missing callback argument and not calling it to signal completion.

B. Using arrow function inside executeAsyncScript is not allowed.

C. Timeout value should be zero for async scripts.

D. executeAsyncScript cannot run setTimeout functions.

Solution

1. Step 1: Check async script requirements

   Async scripts must accept a callback argument and call it to signal completion.

2. Step 2: Analyze the given code

   The code uses setTimeout but does not accept or call any callback, so Selenium never knows when to continue.

3. Final Answer:

   Missing callback argument and not calling it to signal completion. -> Option A

4. Quick Check:

   Callback must be called = D [OK]

Hint: Always pass and call callback in async scripts [OK]

Common Mistakes:

• Forgetting to pass callback as argument
• Returning value instead of calling callback
• Thinking arrow functions are disallowed

5. You want to test a web page that loads data dynamically after 3 seconds. Which async script approach correctly waits for the data load before continuing?

driver.executeAsyncScript(
  "var callback = arguments[0];
   var checkData = () => {
     if(document.querySelector('#data').innerText !== '') {
       callback('loaded');
     } else {
       setTimeout(checkData, 500);
     }
   };
   checkData();
");

hard

A. This script will timeout immediately because callback is never called.

B. This script correctly polls for data and calls callback when ready.

C. This script blocks the browser and never calls callback.

D. This script should use executeScript instead of executeAsyncScript.

Solution

1. Step 1: Understand polling in async scripts

   The script repeatedly checks if '#data' element has text, calling callback only when data is loaded.

2. Step 2: Verify callback usage and waiting

   Callback is called only after data is ready, so Selenium waits properly for dynamic content.

3. Final Answer:

   This script correctly polls for data and calls callback when ready. -> Option B

4. Quick Check:

   Polling with callback = B [OK]

Hint: Poll and call callback when ready to wait dynamically [OK]

Common Mistakes:

• Not calling callback after data loads
• Using executeScript which does not wait
• Blocking browser with infinite loops