Google IDX Live icon

Google IDX Live

Google IDX Live
Join our community

Actions7

Overview

This node, named "Google IDX Live," interacts with Google IDX workspaces through browser automation using Puppeteer. It supports multiple operations including resetting a workspace, running a workspace, creating new workspaces, checking live status, and running commands inside a workspace environment.

The Reset WorkSpace operation specifically automates the process of resetting one or more Google IDX workspaces by navigating to their web interface, triggering the reset action, and optionally capturing screenshots of the process.

Common scenarios where this node is beneficial:

  • Automating maintenance tasks on Google IDX workspaces without manual intervention.
  • Resetting workspaces programmatically as part of a CI/CD pipeline or scheduled workflow.
  • Capturing visual confirmation (screenshots) of workspace states before or after reset.
  • Managing multiple workspaces in bulk efficiently.

Practical example:

You have several Google IDX workspaces used for development or testing. After certain tests, you want to reset these workspaces automatically to a clean state. Using this node’s Reset WorkSpace operation, you provide the workspace IDs, and it will navigate to each workspace’s page, perform the reset action, and return a summary of the reset status along with timestamps.

Properties

Name Meaning
Options Collection of optional settings. Currently supports:
- Browser WebSocket Endpoint (string): URL to connect to an existing browser instance.
Binary File Boolean flag indicating whether to upload data from a binary field. Used in runWorkSpace and resetWorkSpace operations.
Workspace ID Fixed collection allowing multiple workspace IDs to be specified. Each entry requires:
- Workspace ID (string): The identifier of the workspace to operate on.

Output

For the Reset WorkSpace operation, the output JSON structure includes:

  • resetStatus (boolean): Indicates if the reset was successful (true).
  • profile (string): Profile information from the authenticated user credentials.
  • workspace (array of strings): List of workspace IDs that were reset.
  • id (array of strings): Same as workspace IDs, repeated for clarity.
  • name (array of strings): Names of the workspaces reset.
  • timeReset (array of ISO date strings): Timestamps when each workspace was reset.

If the operation involves capturing images (screenshots), the node can also output binary data representing the screenshot of the workspace page after reset.

Dependencies

  • Requires an API key credential for authenticating with Google IDX services.
  • Uses Puppeteer Extra with the Stealth plugin to automate Chromium-based browser interactions.
  • Optionally connects to an existing browser instance via a WebSocket endpoint if provided.
  • Network access to Google IDX web pages and related Google authentication URLs.
  • n8n environment must support Puppeteer and allow headless browser execution.

Troubleshooting

Common Issues

  • Failed to launch/connect to browser:
    This error occurs if Puppeteer cannot start or connect to the browser instance. Ensure the WebSocket endpoint URL is correct and accessible, or that Puppeteer dependencies are properly installed.

  • Workspace not found or invalid workspace ID:
    If the workspace ID provided does not exist or is incorrect, the reset operation may fail silently or throw errors. Verify workspace IDs before running.

  • Timeouts waiting for page elements:
    The node waits for specific selectors on the IDX web pages. Changes in the web UI or slow network responses might cause timeouts. Adjust timeout durations or verify page structure.

  • Screenshot capture failures:
    Errors like "detached frame" or "connection closed" during screenshot attempts indicate unstable browser connections. The node retries once but may assign null if unsuccessful.

Error Messages and Resolutions

  • "Failed to launch/connect to browser: ..."
    Check browser availability and WebSocket endpoint correctness.

  • "Error taking screenshot for [workspace]: ..."
    Retry the operation or disable screenshot capture if not needed.

  • "No token given."
    The node requires valid authentication credentials; ensure API keys or tokens are configured.

Links and References

Discussion