update: update list env vars can be set for upload video

Signed-off-by: Viet Nguyen Duc <[email protected]>
SeleniumHQ · Aug 23, 2024 · fdc9fe2 · fdc9fe2
1 parent 49eb45d
commit fdc9fe2
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -687,17 +687,17 @@ services:
 `SE_VIDEO_FILE_NAME=auto` will use the session id as the video file name. This ensures that the video file name is unique to upload.
 Video file name construction automatically works based on Node endpoint `/status` (and optional GraphQL endpoint) to get session ID, capabilities.
 
-|                                          | Hub/Nodes         | Standalone roles | Dynamic Grid   |
+`SE_VIDEO_UPLOAD_ENABLED=true` will enable the video upload feature. In the background, it will create a pipefile with file and destination for uploader to consume and proceed.
+
+`SE_VIDEO_INTERNAL_UPLOAD=true` will use RCLONE installed in the container for upload. If you want to use another sidecar container for upload, set it to `false`.
+
+| ENV variables per mode                   | Hub/Nodes         | Standalone roles | Dynamic Grid   |
 |------------------------------------------|-------------------|------------------|----------------|
-| `SE_VIDEO_RECORD_STANDALONE` (mandatory) | `false` (default) | `true`           | user input     |
+| `SE_VIDEO_RECORD_STANDALONE` (mandatory) | `false` (default) | `true`           | `true`         |
 | `DISPLAY_CONTAINER_NAME` (mandatory)     | user input        | user input       | (not required) |
 | `SE_NODE_PORT` (optional)                | `5555`            | `4444`           | (not required) |
 | `SE_NODE_GRID_URL` (optional)            | user input        | (not required)   | (not required) |
 
-`SE_VIDEO_UPLOAD_ENABLED=true` will enable the video upload feature. In the background, it will create a pipefile with file and destination for uploader to consume and proceed.
-
-`SE_VIDEO_INTERNAL_UPLOAD=true` will use RCLONE installed in the container for upload. If you want to use another container for upload, set it to `false`.
-
 For environment variables with prefix `RCLONE_` is used to pass remote configuration to RCLONE. You can find more information about RCLONE configuration [here](https://rclone.org/docs/).
 When using in Dynamic Grid, those variables should be combined with the prefix `SE_`, for example `SE_RCLONE_`. See below reference for more details.
 
@@ -710,6 +710,16 @@ When using in Dynamic Grid, those variables should be combined with the prefix `
 
 - Configure video recording and uploading for Dynamic Grid standalone (standalone-docker): [tests/docker-compose-v3-test-standalone-docker.yaml](tests/docker-compose-v3-test-standalone-docker.yaml)
 
+### Environment variables and default values for upload feature
+
+| Environment variable          | Default value                      | Description                                                                               |
+|-------------------------------|------------------------------------|-------------------------------------------------------------------------------------------|
+| `SE_UPLOAD_RETAIN_LOCAL_FILE` | `false`                            | Keep local file after uploading successfully                                              |
+| `SE_UPLOAD_COMMAND`           | `copy`                             | RCLONE command is used to transfer file. Enforce `move` when retain local file is `false` |
+| `SE_UPLOAD_OPTS`              | `-P --cutoff-mode SOFT --metadata` | Other options belong to RCLONE command can be set.                                        |
+| `SE_UPLOAD_CONFIG_FILE_NAME`  | `upload.conf`                      | Config file for remote host instead of set via env variable prefix SE_RCLONE_*            |
+| `SE_UPLOAD_CONFIG_DIRECTORY`  | `/opt/bin`                         | Directory of config file (change it when conf file in another directory is mounted)       |
+
 ___
 
 ## Dynamic Grid

diff --git a/Video/upload.sh b/Video/upload.sh
@@ -1,14 +1,15 @@
 #!/usr/bin/env bash
 
 VIDEO_FOLDER=${VIDEO_FOLDER}
-UPLOAD_CONFIG_DIRECTORY=${UPLOAD_CONFIG_DIRECTORY:-"/opt/bin"}
-UPLOAD_CONFIG_FILE_NAME=${UPLOAD_CONFIG_FILE_NAME:-"upload.conf"}
-UPLOAD_COMMAND=${UPLOAD_COMMAND:-"copy"}
+UPLOAD_CONFIG_DIRECTORY=${SE_UPLOAD_CONFIG_DIRECTORY:-"/opt/bin"}
+UPLOAD_CONFIG_FILE_NAME=${SE_UPLOAD_CONFIG_FILE_NAME:-"upload.conf"}
+UPLOAD_COMMAND=${SE_UPLOAD_COMMAND:-"copy"}
+UPLOAD_OPTS=${SE_UPLOAD_OPTS:-"-P --cutoff-mode SOFT --metadata"}
 UPLOAD_RETAIN_LOCAL_FILE=${SE_UPLOAD_RETAIN_LOCAL_FILE:-"false"}
-UPLOAD_PIPE_FILE_NAME=${UPLOAD_PIPE_FILE_NAME:-"uploadpipe"}
+UPLOAD_PIPE_FILE_NAME=${SE_UPLOAD_PIPE_FILE_NAME:-"uploadpipe"}
 SE_VIDEO_INTERNAL_UPLOAD=${SE_VIDEO_INTERNAL_UPLOAD:-"false"}
-VIDEO_UPLOAD_ENABLED=${VIDEO_UPLOAD_ENABLED:-SE_VIDEO_UPLOAD_ENABLED}
-SE_VIDEO_UPLOAD_BATCH_CHECK=${SE_VIDEO_UPLOAD_BATCH_CHECK:-"10"}
+VIDEO_UPLOAD_ENABLED=${SE_VIDEO_UPLOAD_ENABLED:-"false"}
+VIDEO_UPLOAD_BATCH_CHECK=${SE_VIDEO_UPLOAD_BATCH_CHECK:-"10"}
 process_name="video.uploader"
 
 if [ "${SE_VIDEO_INTERNAL_UPLOAD}" = "true" ];
@@ -64,7 +65,7 @@ function consume_pipe_file() {
 list_rclone_pid=()
 function check_and_clear_background() {
     # Wait for a batch rclone processes to finish
-    if [ ${#list_rclone_pid[@]} -eq ${SE_VIDEO_UPLOAD_BATCH_CHECK} ]; then
+    if [ ${#list_rclone_pid[@]} -eq ${VIDEO_UPLOAD_BATCH_CHECK} ]; then
         for pid in "${list_rclone_pid[@]}";
         do
             wait ${pid}
@@ -78,7 +79,7 @@ function rclone_upload() {
     local source=$1
     local target=$2
     echo "$(date +%FT%T%Z) [${process_name}] - Uploading ${source} to ${target}"
-    exec rclone --config ${UPLOAD_CONFIG_DIRECTORY}/${UPLOAD_CONFIG_FILE_NAME} ${UPLOAD_COMMAND} --cutoff-mode SOFT --metadata ${UPLOAD_OPTS} "${source}" "${target}" &
+    exec rclone --config ${UPLOAD_CONFIG_DIRECTORY}/${UPLOAD_CONFIG_FILE_NAME} ${UPLOAD_COMMAND} ${UPLOAD_OPTS} "${source}" "${target}" &
 }
 
 function graceful_exit() {