Merge pull request #259 from shamanec/feature/remove-appium-reports

Remove Appium reports

Author: shamanec

appium-plugin/config-ios.json

@@ -1,6 +1,5 @@
 {
     "providerUrl": "http://192.168.1.16:10001",
     "heartbeatIntervalMs": 2000,
-    "udid": "00008030-000418C136FB802E",
-    "minioEnabled": true
+    "udid": ""
 }

appium-plugin/config.json

@@ -1,6 +1,5 @@
 {
     "providerUrl": "http://192.168.1.16:10001",
     "heartbeatIntervalMs": 2000,
-    "udid": "WCR7N18B14002300",
-    "minioEnabled": true
+    "udid": ""
 }

appium-plugin/gads-appium-plugin.js

@@ -2,33 +2,6 @@ import { BasePlugin } from '@appium/base-plugin';
 import { logger } from '@appium/support';
 import { loadConfig } from './src/config/loader.js';
 import { createApiClient, GadsApiClient } from './src/api/client.js';
-import { classify } from './src/utils/classifier.js';
-import { handleArgs } from './src/utils/commandArgsHandler.js';
-import { takeBeforeScreenshot, takeAfterScreenshot } from './src/utils/screenshots.js';
-
-/**
- * This function redacts sensitive data from logs like when typing text
- * @param {*} payload the log payload
- * @returns 
- */
-function redact(payload) {
-    const KEYS = new Set(['text', 'value']);
-    const seen = new WeakSet();
-    const walk = (v) => {
-        if (v && typeof v === 'object') {
-            if (seen.has(v)) return v;
-            seen.add(v);
-            if (Array.isArray(v)) return v.map(walk);
-            const out = {};
-            for (const [k, val] of Object.entries(v)) {
-                out[k] = KEYS.has(k) ? '[REDACTED]' : walk(val);
-            }
-            return out;
-        }
-        return v;
-    };
-    return walk(payload);
-}
 
 // Plugin constants
 const NAME = 'GADS';
@@ -45,16 +18,6 @@ class GadsAppium extends BasePlugin {
     static apiClient = null;
     // Static property to hold the current Appium session ID
     static currentSessionId = "";
-    // Static property to hold the current driver
-    static activeDriver = null;
-
-    // Static properties for the action logs we send to GADS
-    static actionLogSequence = 0; // Unique step counter per session so we can properly order logs
-    static actionLogTenant = ''; // The tenant of the user creating the session for report filtering and access
-    static actionLogBuildId = ''; // The ID of the current build run - comes from session capabilities
-    static actionLogTestName = ''; // The name of the current test - comes from session capabilities
-    static actionLogPlatformName = ''; // Name of the platform where tests are executed - Android, iOS, Tizen, etc
-    static actionLogDeviceName = ''; // The name of the device on which the current session runs - comes from GADS in session capabilities
 
     // New endpoints on the Appium server from the plugin itself
     static newMethodMap = {
@@ -63,17 +26,6 @@ class GadsAppium extends BasePlugin {
         },
     };
 
-
-    // Clear the action log data on session end or whatever
-    async clearActionLogData() {
-        GadsAppium.actionLogSequence = 0;
-        GadsAppium.actionLogTenant = '';
-        GadsAppium.actionLogBuildId = '';
-        GadsAppium.actionLogTestName = '';
-        GadsAppium.actionLogPlatformName = '';
-        GadsAppium.actionLogDeviceName = '';
-    }
-
     /**
      * updateServer
      *
@@ -157,48 +109,13 @@ class GadsAppium extends BasePlugin {
         // Call through to the driver’s createSession
         const createSessionResult = await driver.createSession?.(jsonwpCaps, reqCaps, w3cCapabilities)
 
-        // Store the active driver in case we need it for something
-        GadsAppium.activeDriver = driver
-
         // Extract the sessionId
         const sessionId = createSessionResult?.value?.[0]
         if (sessionId) {
             GadsAppium.currentSessionId = sessionId;
             await GadsAppium.apiClient.addSession(GadsAppium.currentSessionId)
         }
 
-        // Get the test run build ID from capabilities
-        const buildId = w3cCapabilities?.alwaysMatch?.['gads:buildId']
-        if (buildId) {
-            // Store the build ID for the report logs
-            GadsAppium.actionLogBuildId = buildId
-            log.info(`GADS: Build ID set to: ${buildId}`)
-        } else {
-            // If we don't have a build ID we preventively clear the static action log data
-            // So we don't save logs
-            this.clearActionLogData()
-        }
-
-        // On a new session reset the action log sequence number
-        GadsAppium.actionLogSequence = 0
-        // Get the additional capabilities for extending the log information
-        const tenant = w3cCapabilities?.alwaysMatch?.['gads:tenant']
-        if (tenant) {
-            GadsAppium.actionLogTenant = tenant
-        }
-        const testName = w3cCapabilities?.alwaysMatch?.['gads:testName']
-        if (testName) {
-            GadsAppium.actionLogTestName = testName
-        }
-        const platformName = w3cCapabilities?.alwaysMatch?.['platformName']
-        if (platformName) {
-            GadsAppium.actionLogPlatformName = platformName
-        }
-        const deviceName = w3cCapabilities?.alwaysMatch?.['gads:deviceName']
-        if (deviceName) {
-            GadsAppium.actionLogDeviceName = deviceName
-        }
-
         return createSessionResult
     }
 
@@ -212,15 +129,10 @@ class GadsAppium extends BasePlugin {
      * @param {string} sessionId    The sessionId to delete
    */
     async deleteSession(next, driver, sessionId) {
-        // Clear all action log properties
-        this.clearActionLogData()
-
         // If we’re deleting the active session, clear it from the properties
         if (GadsAppium.currentSessionId === sessionId) {
             GadsAppium.currentSessionId = ''
         }
-        // Reset the active driver object
-        GadsAppium.activeDriver = null;
 
         // Call through to the driver's deleteSession
         const deleteSessionResult = await driver.deleteSession?.(sessionId)
@@ -240,115 +152,7 @@ class GadsAppium extends BasePlugin {
      * @returns 
      */
     async handle(next, driver, commandName, ...args) {
-        // Do not handle the commands below at all, directly call through to next()
-        if (['createSession', 'deleteSession', 'getSessions'].includes(commandName)) {
-            return await next()
-        }
-
-        // Get the command start timestamp
-        const commandStartTS = Date.now()
-        let result, error;
-
-        // Take screenshot BEFORE command execution for specific commands
-        const hasBeforeScreenshot = takeBeforeScreenshot(GadsAppium, commandName, GadsAppium.apiClient)
-
-        // Execute the command, saving result and/or error
-        if (commandName === 'execute' && args?.[0] && typeof args[0] === 'string' && args[0].includes('gads:testResult')) {
-            // Skip calling next() for test result commands to avoid unimplemented execute
-            result = { value: 'Test result processed' }
-        } else {
-            try {
-                result = await next()
-            } catch (e) {
-                error = e
-            }
-        }
-
-        try {
-            const cfg = GadsAppium.cfg || this.cfg
-            if (cfg?.providerUrl && cfg?.udid) {
-                // Classify the command turning the Appium command name into a human-readable report-friendly command name
-                const info = classify(commandName, args)
-
-                // We log actions only if command was classified and `gads:buildId` capability is provided
-                if (info && GadsAppium.actionLogBuildId) {
-                    // Increment the sequence number on each command we log
-                    GadsAppium.actionLogSequence += 1
-
-                    // Parse element locator data for findElement/findElements commands
-                    let findElementUsing = null;
-                    let findElementSelector = null;
-                    if (commandName === 'findElement' || commandName === 'findElements') {
-                        findElementUsing = args?.[0]
-                        findElementSelector = args?.[1]
-                    }
-
-                    // Parse specific commands arguments into human readable output
-                    const commandAdditionalInfo = handleArgs(commandName, args)
-
-                    // Check if this is a test result execute command
-                    let testStatus = null;
-                    let testMessage = null;
-                    if (commandName === 'execute' && args?.[0] && typeof args[0] === 'string' && args[0].includes('gads:testResult')) {
-                        const scriptArgs = args?.[1];
-                        const testResult = Array.isArray(scriptArgs) ? scriptArgs[0] : scriptArgs;
-                        if (testResult && typeof testResult === 'object') {
-                            testStatus = testResult.status || 'unknown';
-                            testMessage = testResult.message || testResult.error || '';
-                        }
-                    }
-
-                    // Take screenshot for any failed command
-                    let hasAfterScreenshot = false
-                    if (error) {
-                        hasAfterScreenshot = takeAfterScreenshot(GadsAppium, commandName, GadsAppium.apiClient)
-                    }
-
-                    // Build the body of the log we send to GADS
-                    const body = {
-                        timestamp: commandStartTS, // Start time of the command
-                        session_id: GadsAppium.currentSessionId || null, // Appium current session id
-                        udid: cfg.udid, // Target device UDID
-                        action: info.action, // Use "Test Result" for test result logs
-                        command: commandName, // Actual Appium command name
-                        duration_ms: Date.now() - commandStartTS, // Time taken to execute the command
-                        success: !error, // Is the command successful or not
-                        error: error ? String(error.message || error) : null, // Error string if any
-                        sequence_number: GadsAppium.actionLogSequence, // Log sequence number for proper logs ordering
-                        tenant: GadsAppium.actionLogTenant, // Test execution target tenant name from GADS - `gads:tenant`
-                        build_id: GadsAppium.actionLogBuildId, // Test execution build identifier - `gads:buildId`
-                        test_name: GadsAppium.actionLogTestName, // Name of target test if any - `gads:testName`
-                        locator_using: findElementUsing, // Type of target element locator for findElement/findElements
-                        locator_value: findElementSelector, // Value of the target element locator for findElement/findElements
-                        device_name: GadsAppium.actionLogDeviceName, // Target device name from GADS
-                        platform_name: GadsAppium.actionLogPlatformName, // Target test platform name - iOS/Android/Tizen/WebOS
-                        additional_info: commandAdditionalInfo, // Use test message for test result logs
-                        has_screenshot: hasBeforeScreenshot, // Whether a screenshot was taken before the command
-                        has_screenshot_after: hasAfterScreenshot, // Whether a screenshot was taken after the command
-                    }
-
-                    // Add test result fields only if they have values (to avoid empty fields in mongo)
-                    if (testStatus) {
-                        body.test_status = testStatus
-                        body.action = 'Test Result'
-                    }
-                    if (testMessage) {
-                        body.test_message = testMessage;
-                        body.additional_info = testMessage
-                    }
-
-                    // Send the log to GADS
-                    await GadsAppium.apiClient.sendSessionLog(body)
-                }
-
-            }
-        } catch (e) {
-            log.error(`Something failed - ${e}`)
-        }
-
-        // Keep the usual Appium handling - throw error or return result
-        if (error) throw error
-        return result
+        return await next()
     }
 
     /**
@@ -362,10 +166,8 @@ class GadsAppium extends BasePlugin {
     async onUnexpectedShutdown(driver, cause) {
         log.warn(`GADS: Session ${GadsAppium.currentSessionId} crashed unexpectedly`)
 
-        // Clear the session id, active driver and the static action log properties
+        // Clear the session id and the static action log properties
         GadsAppium.currentSessionId = ""
-        GadsAppium.activeDriver = null
-        this.clearActionLogData()
 
         // Notify GADS the driver crashed by clearing the session on GADS side
         await GadsAppium.apiClient.removeSession()

appium-plugin/package.json

@@ -1,6 +1,6 @@
 {
     "name": "appium-gads",
-    "version": "0.0.10",
+    "version": "0.0.11",
     "type": "module",
     "main": "gads-appium-plugin.js",
     "keywords": [

appium-plugin/src/api/client.js

@@ -60,25 +60,6 @@ export class GadsApiClient {
         }
     }
 
-    // Send Appium action log to provider instance
-    async sendSessionLog(sessionLogData) {
-        try {
-            await this.api.post('/log-session', sessionLogData)
-        } catch (e) {
-            // Silent fail for session logs to avoid disrupting main flow
-        }
-    }
-
-    // Send screenshot request to provider instance
-    async sendScreenshotRequest(screenshotData) {
-        try {
-            await this.api.post('/screenshot', screenshotData)
-        } catch (e) {
-            // Silent fail for screenshots to avoid disrupting main flow
-        }
-    }
-
-
     // Ping to notify provider that the Appium server is live and running
     async sendPing(pingData) {
         try {