Google IDX Live icon

Google IDX Live

Google IDX Live

Overview

This node, named "Google IDX Live," interacts with Google IDX workspaces and related services through browser automation using Puppeteer with stealth mode. It supports multiple operations including running a workspace, resetting a workspace, checking live device statuses, listing all workspaces, creating new workspaces, and running commands in a workspace environment.

Typical use cases include:

  • Automating interactions with Google IDX workspaces for development or testing.
  • Capturing screenshots of workspace states.
  • Resetting workspaces programmatically.
  • Monitoring device statuses via an API.
  • Running terminal commands inside a workspace remotely.

For example, a user can run the "Run WorkSpace" operation to open specified workspaces, optionally capture screenshots, and retrieve workspace metadata such as IDs, names, URLs, and tokens.

Properties

Name Meaning
Options Collection of additional options. For "Run WorkSpace" operation, includes:
- Browser WebSocket Endpoint The WebSocket endpoint URL to connect to an existing browser instance for Puppeteer.
Binary File Boolean flag (true/false). If true, the node uploads data from a binary field (e.g., screenshot image). Only shown for "runWorkSpace" and "resetWorkSpace" operations.
Workspace ID Fixed collection allowing multiple entries. Each entry contains:
- Workspace ID String identifier of the workspace to operate on. Required for "runWorkSpace" and "resetWorkSpace".

Output

The node outputs JSON data describing the results of the selected operation. The structure varies by operation:

  • Run WorkSpace: Outputs an array of objects each containing:

    • workspace: Workspace identifier string.
    • id: Workspace internal ID.
    • name: Workspace name.
    • url: Workspace URL.
    • token: Authentication token related to the workspace.
    • account: Account associated with the workspace.
    • profile: Profile information from credentials.
    • screen or screenshot: Boolean indicating if a screenshot was captured.
    • Binary data field containing the screenshot image (PNG) keyed by workspace ID if Binary File is enabled.
  • Reset WorkSpace: Outputs status of reset operations per workspace including timestamps and profile info.

  • Check Live: Outputs device status arrays grouped by filters such as hostname prefix or IP prefix, with online/offline status and last seen timestamps.

  • Other operations: Return relevant JSON data such as workspace lists or command execution status.

If binary data is output, it represents PNG screenshots of the workspace pages captured during execution.

Dependencies

  • Requires an API key credential for authenticating with Google IDX services.
  • Uses Puppeteer Extra with Stealth plugin to automate Chromium-based browser sessions.
  • Optionally connects to an existing browser instance via a WebSocket endpoint.
  • Network access to Google IDX URLs and related Google services.
  • Node requires permission to handle binary data for screenshots.

Troubleshooting

  • No token given: The node requires valid credentials with profile and cookie data; ensure these are configured correctly.
  • Failed to launch/connect to browser: Check that the WebSocket endpoint is correct and accessible, or that Puppeteer can launch a local browser.
  • Detached frame or connection closed errors during screenshot: These indicate unstable browser connections; the node retries once but may return null screenshot if failure persists.
  • Timeouts waiting for page selectors: Network issues or changes in target page structure can cause failures; verify network connectivity and page element selectors.
  • Errors during workspace reset or run: Ensure workspace IDs are valid and accessible under the authenticated account.
  • WebSocket disconnection during long operations: The node attempts to reconnect automatically; if persistent, check browser stability and network reliability.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion