gpt-driver-node 1.0.5 → 1.0.7

package/dist/index.cjs

@@ -11,29 +11,6 @@ var winston = require('winston');
 var zod = require('zod');
 var crypto = require('node:crypto');
 
-const delay = async (milliseconds) => {
-  await new Promise((resolve) => setTimeout(resolve, milliseconds));
-};
-function buildUrl(base, extraPath) {
-  let baseUrl = base.toString();
-  if (baseUrl.endsWith("/")) {
-    baseUrl = baseUrl.slice(0, -1);
-  }
-  if (!extraPath.startsWith("/")) {
-    extraPath = "/" + extraPath;
-  }
-  return `${baseUrl}${extraPath}`;
-}
-const getImageDimensions = async (base64) => {
-  const base64Data = base64.replace(/^data:image\/\w+;base64,/, "");
-  const buffer = Buffer.from(base64Data, "base64");
-  const metadata = await sharp(buffer).metadata();
-  if (!metadata.width || !metadata.height) {
-    throw new Error("Unable to get image dimensions");
-  }
-  return { width: metadata.width, height: metadata.height };
-};
-
 const colors = {
   reset: "\x1B[0m",
   bold: "\x1B[1m",
@@ -95,6 +72,75 @@ ${logStyles.gray(stack)}` : logMessage;
   ]
 });
 
+const delay = async (milliseconds) => {
+  await new Promise((resolve) => setTimeout(resolve, milliseconds));
+};
+function isRetryableNetworkError(error) {
+  const retryableCodes = [
+    "ECONNRESET",
+    "ETIMEDOUT",
+    "ECONNREFUSED",
+    "ENOTFOUND",
+    "ENETUNREACH",
+    "EAI_AGAIN",
+    "EPIPE",
+    "ECONNABORTED"
+  ];
+  if (error.code && retryableCodes.includes(error.code)) {
+    return true;
+  }
+  if (error.message?.includes("socket disconnected") || error.message?.includes("TLS") || error.message?.includes("SSL")) {
+    return true;
+  }
+  if (error.code === "ECONNABORTED" && error.message?.includes("timeout")) {
+    return true;
+  }
+  if (error.response?.status >= 500) {
+    return true;
+  }
+  return false;
+}
+async function requestWithRetry(config, maxRetries = 3, baseDelayMs = 1e3) {
+  let lastError;
+  for (let attempt = 1; attempt <= maxRetries; attempt++) {
+    try {
+      const response = await axios.request(config);
+      return response.data;
+    } catch (error) {
+      lastError = error;
+      const isRetryable = isRetryableNetworkError(error);
+      if (!isRetryable || attempt === maxRetries) {
+        throw error;
+      }
+      const delayMs = baseDelayMs * Math.pow(2, attempt - 1);
+      globalLogger.warn(
+        `Request failed (attempt ${attempt}/${maxRetries}): ${error.message}. Retrying in ${delayMs}ms...`
+      );
+      await delay(delayMs);
+    }
+  }
+  throw lastError;
+}
+function buildUrl(base, extraPath) {
+  let baseUrl = base.toString();
+  if (baseUrl.endsWith("/")) {
+    baseUrl = baseUrl.slice(0, -1);
+  }
+  if (!extraPath.startsWith("/")) {
+    extraPath = "/" + extraPath;
+  }
+  return `${baseUrl}${extraPath}`;
+}
+const getImageDimensions = async (base64) => {
+  const base64Data = base64.replace(/^data:image\/\w+;base64,/, "");
+  const buffer = Buffer.from(base64Data, "base64");
+  const metadata = await sharp(buffer).metadata();
+  if (!metadata.width || !metadata.height) {
+    throw new Error("Unable to get image dimensions");
+  }
+  return { width: metadata.width, height: metadata.height };
+};
+
 const waitForStableScreen = async (getScreenshot, options = {}) => {
   const {
     maxTimeoutSec = 5,
@@ -908,6 +954,7 @@ class GptDriver {
   step_number = 1;
   organisationId;
   configFilePath;
+  additionalUserContext;
   // Session Execution Stats
   _stats_startTime = 0;
   _stats_executedSteps = 0;
@@ -943,6 +990,7 @@ class GptDriver {
     this.cachingMode = config.cachingMode ?? "NONE";
     this.organisationId = config.organisationId;
     this.configFilePath = config.configFilePath;
+    this.additionalUserContext = config.additionalUserContext;
     if (config.useGptDriverCloud) {
       if (config.serverConfig.device?.platform == null) {
         throw new Error("Platform is missing. Please specify the platform when using GPTDriver Cloud.");
@@ -1069,7 +1117,8 @@ class GptDriver {
         },
         use_internal_virtual_device: this.useGptDriverCloud,
         build_id: this.buildId,
-        caching_mode: this.cachingMode
+        caching_mode: this.cachingMode,
+        ...this.additionalUserContext && { additional_user_context: this.additionalUserContext }
       }
     );
     this.gptDriverSessionId = response.data.sessionId;
@@ -1571,7 +1620,7 @@ ${"=".repeat(50)}`);
       const smartLoopEndTime = performance.now();
       globalLogger.debug(`[Performance] Smart loop completed in ${(smartLoopEndTime - smartLoopStartTime).toFixed(2)}ms`);
       if (!result.success) {
-        throw new Error(result.error || "Smart loop execution failed");
+        await this.setSessionFailed();
       }
       if (result.cacheHitCount) {
         this._stats_cacheHits += result.cacheHitCount;
@@ -2277,7 +2326,6 @@ ${"=".repeat(50)}`);
       let conditionSucceeded = false;
       while (!conditionSucceeded) {
         let screenshot;
-        let originalScreenshotBase64 = null;
         if (!this.useGptDriverCloud) {
           const stabilityResult = await waitForStableScreen(
             () => this.getScreenshot(this.appiumSessionConfig)
@@ -2288,8 +2336,9 @@ ${"=".repeat(50)}`);
           }
         }
         globalLogger.info("Requesting next action from GPT Driver...");
-        const response = await axios.request(
-          {
+        let responseData;
+        try {
+          responseData = await requestWithRetry({
             url: `${this.gptDriverBaseUrl}/sessions/${this.gptDriverSessionId}/execute`,
             method: "POST",
             data: {
@@ -2299,18 +2348,21 @@ ${"=".repeat(50)}`);
               caching_mode: cachingMode ?? this.cachingMode,
               step_number: this.step_number
             }
-          }
-        );
-        const executeStatus = response.data.status;
+          });
+        } catch (error) {
+          globalLogger.error(`GPT Driver request failed: ${error.message}`);
+          globalLogger.error(`Stack trace: ${error.stack}`);
+          throw error;
+        }
+        const executeStatus = responseData.status;
         if (executeStatus === "failed") {
-          const errorMessage = response.data?.commands?.at(0)?.data;
+          const errorMessage = responseData?.commands?.at(0)?.data;
           globalLogger.error(`Execution failed: ${errorMessage ?? "Unknown error"}`);
           throw new Error(errorMessage ?? "Execution failed");
         }
         conditionSucceeded = executeStatus !== "inProgress";
-        const executeResponse = response.data;
-        globalLogger.debug(`Received ${executeResponse.commands.length} command(s) to execute`);
-        for (const appiumCommand of executeResponse.commands) {
+        globalLogger.debug(`Received ${responseData.commands.length} command(s) to execute`);
+        for (const appiumCommand of responseData.commands) {
           await this.executeCommand(appiumCommand);
         }
       }

package/dist/index.d.cts

@@ -22,6 +22,7 @@ interface GptDriverConfig {
     useGptDriverCloud?: boolean;
     buildId?: string;
     cachingMode?: CachingMode;
+    additionalUserContext?: string;
     organisationId?: string;
     configFilePath?: string;
 }
@@ -512,6 +513,7 @@ declare class GptDriver {
     private step_number;
     private organisationId?;
     private configFilePath?;
+    private additionalUserContext?;
     private _stats_startTime;
     private _stats_executedSteps;
     private _stats_cacheHits;

package/dist/index.mjs

@@ -9,29 +9,6 @@ import winston from 'winston';
 import { z } from 'zod';
 import crypto from 'node:crypto';
 
-const delay = async (milliseconds) => {
-  await new Promise((resolve) => setTimeout(resolve, milliseconds));
-};
-function buildUrl(base, extraPath) {
-  let baseUrl = base.toString();
-  if (baseUrl.endsWith("/")) {
-    baseUrl = baseUrl.slice(0, -1);
-  }
-  if (!extraPath.startsWith("/")) {
-    extraPath = "/" + extraPath;
-  }
-  return `${baseUrl}${extraPath}`;
-}
-const getImageDimensions = async (base64) => {
-  const base64Data = base64.replace(/^data:image\/\w+;base64,/, "");
-  const buffer = Buffer.from(base64Data, "base64");
-  const metadata = await sharp(buffer).metadata();
-  if (!metadata.width || !metadata.height) {
-    throw new Error("Unable to get image dimensions");
-  }
-  return { width: metadata.width, height: metadata.height };
-};
-
 const colors = {
   reset: "\x1B[0m",
   bold: "\x1B[1m",
@@ -93,6 +70,75 @@ ${logStyles.gray(stack)}` : logMessage;
   ]
 });
 
+const delay = async (milliseconds) => {
+  await new Promise((resolve) => setTimeout(resolve, milliseconds));
+};
+function isRetryableNetworkError(error) {
+  const retryableCodes = [
+    "ECONNRESET",
+    "ETIMEDOUT",
+    "ECONNREFUSED",
+    "ENOTFOUND",
+    "ENETUNREACH",
+    "EAI_AGAIN",
+    "EPIPE",
+    "ECONNABORTED"
+  ];
+  if (error.code && retryableCodes.includes(error.code)) {
+    return true;
+  }
+  if (error.message?.includes("socket disconnected") || error.message?.includes("TLS") || error.message?.includes("SSL")) {
+    return true;
+  }
+  if (error.code === "ECONNABORTED" && error.message?.includes("timeout")) {
+    return true;
+  }
+  if (error.response?.status >= 500) {
+    return true;
+  }
+  return false;
+}
+async function requestWithRetry(config, maxRetries = 3, baseDelayMs = 1e3) {
+  let lastError;
+  for (let attempt = 1; attempt <= maxRetries; attempt++) {
+    try {
+      const response = await axios.request(config);
+      return response.data;
+    } catch (error) {
+      lastError = error;
+      const isRetryable = isRetryableNetworkError(error);
+      if (!isRetryable || attempt === maxRetries) {
+        throw error;
+      }
+      const delayMs = baseDelayMs * Math.pow(2, attempt - 1);
+      globalLogger.warn(
+        `Request failed (attempt ${attempt}/${maxRetries}): ${error.message}. Retrying in ${delayMs}ms...`
+      );
+      await delay(delayMs);
+    }
+  }
+  throw lastError;
+}
+function buildUrl(base, extraPath) {
+  let baseUrl = base.toString();
+  if (baseUrl.endsWith("/")) {
+    baseUrl = baseUrl.slice(0, -1);
+  }
+  if (!extraPath.startsWith("/")) {
+    extraPath = "/" + extraPath;
+  }
+  return `${baseUrl}${extraPath}`;
+}
+const getImageDimensions = async (base64) => {
+  const base64Data = base64.replace(/^data:image\/\w+;base64,/, "");
+  const buffer = Buffer.from(base64Data, "base64");
+  const metadata = await sharp(buffer).metadata();
+  if (!metadata.width || !metadata.height) {
+    throw new Error("Unable to get image dimensions");
+  }
+  return { width: metadata.width, height: metadata.height };
+};
+
 const waitForStableScreen = async (getScreenshot, options = {}) => {
   const {
     maxTimeoutSec = 5,
@@ -906,6 +952,7 @@ class GptDriver {
   step_number = 1;
   organisationId;
   configFilePath;
+  additionalUserContext;
   // Session Execution Stats
   _stats_startTime = 0;
   _stats_executedSteps = 0;
@@ -941,6 +988,7 @@ class GptDriver {
     this.cachingMode = config.cachingMode ?? "NONE";
     this.organisationId = config.organisationId;
     this.configFilePath = config.configFilePath;
+    this.additionalUserContext = config.additionalUserContext;
     if (config.useGptDriverCloud) {
       if (config.serverConfig.device?.platform == null) {
         throw new Error("Platform is missing. Please specify the platform when using GPTDriver Cloud.");
@@ -1067,7 +1115,8 @@ class GptDriver {
         },
         use_internal_virtual_device: this.useGptDriverCloud,
         build_id: this.buildId,
-        caching_mode: this.cachingMode
+        caching_mode: this.cachingMode,
+        ...this.additionalUserContext && { additional_user_context: this.additionalUserContext }
       }
     );
     this.gptDriverSessionId = response.data.sessionId;
@@ -1569,7 +1618,7 @@ ${"=".repeat(50)}`);
       const smartLoopEndTime = performance.now();
       globalLogger.debug(`[Performance] Smart loop completed in ${(smartLoopEndTime - smartLoopStartTime).toFixed(2)}ms`);
       if (!result.success) {
-        throw new Error(result.error || "Smart loop execution failed");
+        await this.setSessionFailed();
       }
       if (result.cacheHitCount) {
         this._stats_cacheHits += result.cacheHitCount;
@@ -2275,7 +2324,6 @@ ${"=".repeat(50)}`);
       let conditionSucceeded = false;
       while (!conditionSucceeded) {
         let screenshot;
-        let originalScreenshotBase64 = null;
         if (!this.useGptDriverCloud) {
           const stabilityResult = await waitForStableScreen(
             () => this.getScreenshot(this.appiumSessionConfig)
@@ -2286,8 +2334,9 @@ ${"=".repeat(50)}`);
           }
         }
         globalLogger.info("Requesting next action from GPT Driver...");
-        const response = await axios.request(
-          {
+        let responseData;
+        try {
+          responseData = await requestWithRetry({
             url: `${this.gptDriverBaseUrl}/sessions/${this.gptDriverSessionId}/execute`,
             method: "POST",
             data: {
@@ -2297,18 +2346,21 @@ ${"=".repeat(50)}`);
               caching_mode: cachingMode ?? this.cachingMode,
               step_number: this.step_number
             }
-          }
-        );
-        const executeStatus = response.data.status;
+          });
+        } catch (error) {
+          globalLogger.error(`GPT Driver request failed: ${error.message}`);
+          globalLogger.error(`Stack trace: ${error.stack}`);
+          throw error;
+        }
+        const executeStatus = responseData.status;
         if (executeStatus === "failed") {
-          const errorMessage = response.data?.commands?.at(0)?.data;
+          const errorMessage = responseData?.commands?.at(0)?.data;
           globalLogger.error(`Execution failed: ${errorMessage ?? "Unknown error"}`);
           throw new Error(errorMessage ?? "Execution failed");
         }
         conditionSucceeded = executeStatus !== "inProgress";
-        const executeResponse = response.data;
-        globalLogger.debug(`Received ${executeResponse.commands.length} command(s) to execute`);
-        for (const appiumCommand of executeResponse.commands) {
+        globalLogger.debug(`Received ${responseData.commands.length} command(s) to execute`);
+        for (const appiumCommand of responseData.commands) {
           await this.executeCommand(appiumCommand);
         }
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gpt-driver-node",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",