Fix for custom command and video length (#1174)

* Add custom capability to customize video recording length * Add plugin scripts to reset and setup * Fix unknown command issue * refactor troubleshooting * bump version to 8.4.7-rc.40
AppiumTestDistribution · Jun 12, 2024 · 6e231ec · 6e231ec
1 parent d5931db
commit 6e231ec
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 17 deletions.
diff --git a/docs/capabilities.md b/docs/capabilities.md
@@ -3,9 +3,10 @@ title: Capabilities
 ---
 
 | Capability Name              | Description                                                                                                                                                                                                                                                        |
-|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | df:build                     | Allocate a build name in dashboard. Default value is `null`.                                                                                                                                                                                                       |
 | df:recordVideo               | Enable video recording for the session. Default value is `true`.                                                                                                                                                                                                   |
+| df:videoTimeLimit            | Maximum duration of the video recording in seconds. Default value is 1800 seconds (3 minutes).                                                                                                                                                                     |
 | df:iPhoneOnly                | Allocate only iPhone simulators for execution when to true. Default value is `false`.                                                                                                                                                                              |
 | df:iPadOnly                  | Allocate only iPad simulators for execution when to true. Default value is `false`.                                                                                                                                                                                |
 | df:deviceAvailabilityTimeout | When create session requests are more than available connected devices, plugin waits for a certain interval for device availability before it timeout. Default value is `180000` milliseconds.                                                                     |

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -4,19 +4,35 @@ hide:
   - navigation
 ---
 
+### Device Farm
+
+1. Facing errors related to prisma installation?
+
+   - run `appium plugin run device-farm setup`
+   - Check if the script executes without any error
+   - Incase of any error, open a new issue with the complete log from the script execution
+
+2. How to delete all session details and videos?
+
+   - run `appium plugin run device-farm reset`
+   - The above command will delete all the existing data from database and resets the device farm to the original state
+
 ### IOS
 
 1. How do I improve the iOS session startup for real device?
-    - Resign the WDA provided here: [WDA]()
-    - Use the following capabilities:
-        ```json
-      {
-       'appium:usePreinstalledWDA': true,
-        'appium:updatedWDABundleId': wdaBundleID,
-        'appium:updatedWDABundleIdSuffix': '',
-      }
-    - Make sure the iPhone real device is unblocked and enabled developer mode.
+   - Resign the WDA provided here: [WDA]()
+   - Use the following capabilities:
+     ```json
+     {
+     'appium:usePreinstalledWDA': true,
+     'appium:updatedWDABundleId': wdaBundleID,
+     'appium:updatedWDABundleIdSuffix': '',
+     }
+     ```
+   - Make sure the iPhone real device is unblocked and enabled developer mode.
 2. How do I improve the iOS session startup for Simulators?
-    - Provide server argument during the appium server start. `preBuildWDAPath` with the path to the WDA build for Simulators.
+   - Provide server argument during the appium server start. `preBuildWDAPath` with the path to the WDA build for Simulators.
+
 ### Notes
+
 1. If there is no activity on a session for more then 100 seconds, device allocated to respective session would be unblocked and made available for new session requests.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "appium-device-farm",
-  "version": "8.4.7-rc.39",
+  "version": "8.4.7-rc.40",
   "description": "An appium 2.0 plugin that manages and create driver session on available devices",
   "main": "./lib/src/main.js",
   "scripts": {
@@ -288,6 +288,10 @@
       },
       "title": "Appium device farm plugin",
       "type": "object"
+    },
+    "scripts": {
+      "setup": "lib/src/scripts/setup-db.js",
+      "reset": "lib/src/scripts/clear-assets.js"
     }
   },
   "engines": {

diff --git a/src/CapabilityManager.ts b/src/CapabilityManager.ts
@@ -10,6 +10,7 @@ export enum DEVICE_FARM_CAPABILITIES {
   SESSION_NAME = 'name',
   VIDEO_RECORDING = 'recordVideo',
   VIDEO_RESOLUTION = 'videoResolution',
+  VIDEO_TIME_LIMIT = 'videoTimeLimit',
   LIVE_VIDEO = 'liveVideo',
   SCREENSHOT_ON_FAILURE = 'screenshotOnFailure',
   DEVICE_FARM_OPTIONS = 'df:options',

diff --git a/src/modules b/src/modules
diff --git a/src/scripts/clear-assets.ts b/src/scripts/clear-assets.ts
@@ -0,0 +1,14 @@
+import fs from 'fs';
+import { config } from '../config';
+import { executeCmd } from './initialize-database';
+
+async function main() {
+  if (fs.existsSync(config.cacheDir)) {
+    fs.rmdirSync(config.cacheDir, { recursive: true });
+  }
+  fs.mkdirSync(config.cacheDir, { recursive: true });
+
+  executeCmd('npm run run-db-migration');
+}
+
+(async () => await main())();
diff --git a/src/scripts/initialize-database.ts b/src/scripts/initialize-database.ts
@@ -6,7 +6,7 @@ const env = {
   DATABASE_URL: `file:${config.databasePath}`,
 };
 
-function executeCmd(cmd: string) {
+export function executeCmd(cmd: string) {
   try {
     execSync(cmd, {
       env,
@@ -26,4 +26,8 @@ async function main() {
   executeCmd('prisma generate');
 }
 
-(async () => await main())();
+if (require.main === module) {
+  (async () => await main())();
+}
+
+export default main;
diff --git a/src/scripts/setup-db.ts b/src/scripts/setup-db.ts
@@ -0,0 +1,7 @@
+import { executeCmd } from './initialize-database';
+
+async function main() {
+  executeCmd('npm run run-db-migration');
+}
+
+(async () => await main())();