@luxonis/depthai-viewer-common 2.5.1 → 2.5.3

package/benchmark.sh

@@ -3,28 +3,246 @@
 set -euo pipefail
 
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+source "${SCRIPT_DIR}/benchmark-lib.sh"
+benchmark_init_ui
+
 BENCHMARKS_DIR="${SCRIPT_DIR}/src/utils/benchmarks"
 INTER_BENCHMARK_DELAY_SECONDS="${BENCHMARK_INTER_BENCHMARK_DELAY_SECONDS:-5}"
 FINALIZATION_DELAY_SECONDS="${BENCHMARK_FINALIZATION_DELAY_SECONDS:-8}"
-
-BENCHMARKS=(
-	"bgr888i-stream|BGR888i Stream"
-	"encoded-stream|H.264 Stream"
-	"nv12-stream|NV12 Stream"
-	"pointcloud|Point Cloud"
-)
 BENCHMARK_RESOLUTION="${BENCHMARK_RESOLUTION:-1920x1080}"
+MAX_DOWNLOAD_ATTEMPTS="${BENCHMARK_DOWNLOAD_RETRIES:-3}"
+BENCHMARK_CURL_PROGRESS="${BENCHMARK_CURL_PROGRESS:-1}"
+BENCHMARK_SKIP_DOWNLOAD="${BENCHMARK_SKIP_DOWNLOAD:-0}"
+BENCHMARK_COMMAND='run'
+BENCHMARK_PROGRESS_EVENT_PREFIX='__BENCHMARK_PROGRESS__'
 
 trap 'exit 130' INT
 trap 'exit 143' TERM
 
 log() {
-	printf '[benchmark] %s\n' "$1"
+	benchmark_log info "$1"
+}
+
+emit_progress_event() {
+	if [[ "${BENCHMARK_CURL_PROGRESS}" != '0' ]]; then
+		return
+	fi
+
+	printf '%s|%s|%s|%s|%s|%s\n' \
+		"${BENCHMARK_PROGRESS_EVENT_PREFIX}" \
+		"$1" \
+		"$2" \
+		"$3" \
+		"$4" \
+		"$5"
+}
+
+print_usage() {
+	cat <<EOF
+Usage:
+  ./benchmark.sh run [options]
+  ./benchmark.sh download [options]
+  ./benchmark.sh list
+
+Commands:
+  run                         Download the selected benchmarks and run them.
+  download                    Download the selected benchmarks only.
+  list                        Show available benchmark ids.
+
+Options:
+  --benchmark ID              Select a single benchmark id. Can be repeated.
+  --benchmarks ID1,ID2        Select a comma-separated list of benchmark ids.
+  --resolution WIDTHxHEIGHT   Resize image benchmarks before publishing when running.
+  -h, --help                  Show this help message.
+
+Examples:
+  ./benchmark.sh run
+  ./benchmark.sh run --benchmark encoded-stream
+  ./benchmark.sh run --benchmarks bgr888i-stream,nv12-stream
+  ./benchmark.sh download --benchmark pointcloud
+EOF
+}
+
+file_size() {
+	local file_path=$1
+	stat -f%z "${file_path}" 2>/dev/null || stat -c%s "${file_path}"
+}
+
+install_requirements() {
+	local requirements_file="${BENCHMARKS_DIR}/requirements.txt"
+	benchmark_run_with_spinner \
+		"Installing Python dependencies from ${requirements_file}" \
+		python3 -m pip install --quiet -r "${requirements_file}"
+}
+
+get_remote_file_size() {
+	local url=$1
+	curl --head --silent --show-error --location --fail "${url}" |
+		awk 'BEGIN { IGNORECASE = 1 } /^content-length:/ { gsub("\r", "", $2); print $2; exit }'
+}
+
+download_asset() {
+	local benchmark_id=$1
+	local file_name=$2
+	local url=$3
+	local benchmark_dir="${BENCHMARKS_DIR}/${benchmark_id}"
+	local output_path="${benchmark_dir}/${file_name}"
+	local partial_path="${output_path}.part"
+	local expected_size=""
+	local final_size=""
+	local partial_size=""
+	local download_mode='download'
+	local attempt=1
+	local curl_args=(--fail --location --output "${partial_path}" "${url}")
+
+	if [[ "${BENCHMARK_CURL_PROGRESS}" == '1' ]]; then
+		curl_args=(--progress-bar "${curl_args[@]}")
+	else
+		curl_args=(--silent --show-error "${curl_args[@]}")
+	fi
+
+	mkdir -p "${benchmark_dir}"
+	expected_size="$(get_remote_file_size "${url}" || true)"
+
+	if [[ -f "${output_path}" ]]; then
+		if [[ -n "${expected_size}" ]]; then
+			final_size="$(file_size "${output_path}")"
+			if [[ "${final_size}" == "${expected_size}" ]]; then
+				log "Using existing asset ${file_name} for ${benchmark_id}"
+				return
+			fi
+
+			log "Existing file size mismatch for ${file_name}: found ${final_size} bytes, expected ${expected_size} bytes. Preparing to resume..."
+		else
+			log "Using existing asset ${file_name} for ${benchmark_id}"
+			return
+		fi
+
+		if [[ -f "${partial_path}" ]]; then
+			partial_size="$(file_size "${partial_path}")"
+			if [[ "${partial_size}" -lt "${final_size}" ]]; then
+				rm -f "${partial_path}"
+				mv "${output_path}" "${partial_path}"
+			else
+				rm -f "${output_path}"
+			fi
+		else
+			mv "${output_path}" "${partial_path}"
+		fi
+	fi
+
+	if [[ -f "${partial_path}" ]]; then
+		if [[ -n "${expected_size}" ]]; then
+			partial_size="$(file_size "${partial_path}")"
+			if [[ "${partial_size}" == "${expected_size}" ]]; then
+				mv "${partial_path}" "${output_path}"
+				log "Recovered completed asset ${file_name} for ${benchmark_id}"
+				return
+			fi
+
+			if [[ "${partial_size}" -gt "${expected_size}" ]]; then
+				log "Partial download for ${file_name} is larger than expected. Restarting download..."
+				rm -f "${partial_path}"
+			else
+				log "Resuming ${file_name} for ${benchmark_id} from ${partial_size} of ${expected_size} bytes"
+				download_mode='resume'
+			fi
+		else
+			log "Resuming ${file_name} for ${benchmark_id} from existing partial file"
+			download_mode='resume'
+		fi
+
+		curl_args=(--continue-at - "${curl_args[@]}")
+	else
+		log "Downloading ${file_name} for ${benchmark_id}"
+	fi
+
+	emit_progress_event "start" "${benchmark_id}" "${file_name}" "${partial_path}" "${expected_size}" "${download_mode}"
+
+	while (( attempt <= MAX_DOWNLOAD_ATTEMPTS )); do
+		if curl "${curl_args[@]}"; then
+			if [[ -n "${expected_size}" ]]; then
+				partial_size="$(file_size "${partial_path}")"
+				if [[ "${partial_size}" != "${expected_size}" ]]; then
+					log "Downloaded size mismatch for ${file_name}: expected ${expected_size} bytes, got ${partial_size} bytes"
+				else
+					mv "${partial_path}" "${output_path}"
+					emit_progress_event "finish" "${benchmark_id}" "${file_name}" "${output_path}" "${expected_size}" "success"
+					log "Download completed: ${file_name}"
+					return
+				fi
+			else
+				mv "${partial_path}" "${output_path}"
+				emit_progress_event "finish" "${benchmark_id}" "${file_name}" "${output_path}" "" "success"
+				log "Download completed: ${file_name}"
+				return
+			fi
+		fi
+
+		if (( attempt == MAX_DOWNLOAD_ATTEMPTS )); then
+			emit_progress_event "finish" "${benchmark_id}" "${file_name}" "${partial_path}" "${expected_size}" "failed"
+			log "Download failed for ${file_name} after ${MAX_DOWNLOAD_ATTEMPTS} attempts"
+			return 1
+		fi
+
+		log "Retrying ${file_name} (${attempt}/${MAX_DOWNLOAD_ATTEMPTS})..."
+		attempt=$((attempt + 1))
+	done
+}
+
+download_selected_assets() {
+	local benchmark_id benchmark_asset asset_benchmark_id file_name url
+
+	if (( ${#BENCHMARK_SELECTED_IDS[@]} == 0 )); then
+		return
+	fi
+
+	for benchmark_id in "${BENCHMARK_SELECTED_IDS[@]}"; do
+		while IFS= read -r benchmark_asset; do
+			if [[ -z "${benchmark_asset}" ]]; then
+				continue
+			fi
+
+			IFS='|' read -r asset_benchmark_id file_name url <<<"${benchmark_asset}"
+			download_asset "${asset_benchmark_id}" "${file_name}" "${url}"
+		done < <(benchmark_print_assets_for_id "${benchmark_id}")
+	done
 }
 
 parse_args() {
+	if [[ $# -gt 0 ]]; then
+		case "$1" in
+			run|download|list)
+				BENCHMARK_COMMAND="$1"
+				shift
+				;;
+			-h|--help|help)
+				print_usage
+				exit 0
+				;;
+		esac
+	fi
+
+	BENCHMARK_SELECTED_IDS=()
+
 	while [[ $# -gt 0 ]]; do
 		case "$1" in
+			--benchmark)
+				if [[ $# -lt 2 ]]; then
+					log 'Missing value for --benchmark'
+					exit 1
+				fi
+				benchmark_add_selected_id "$2" || exit 1
+				shift 2
+				;;
+			--benchmarks)
+				if [[ $# -lt 2 ]]; then
+					log 'Missing value for --benchmarks'
+					exit 1
+				fi
+				benchmark_add_selected_csv "$2" || exit 1
+				shift 2
+				;;
 			--resolution)
 				if [[ $# -lt 2 ]]; then
 					log 'Missing value for --resolution'
@@ -51,13 +269,12 @@ parse_args() {
 				BENCHMARK_RESOLUTION="$2"
 				shift 2
 				;;
+			list)
+				BENCHMARK_COMMAND='list'
+				shift
+				;;
 			-h|--help)
-				cat <<EOF
-Usage: ./benchmark.sh [--resolution WIDTHxHEIGHT]
-
-Options:
-  --resolution WIDTHxHEIGHT  Resize image benchmarks before publishing.
-EOF
+				print_usage
 				exit 0
 				;;
 			*)
@@ -66,6 +283,8 @@ EOF
 				;;
 		esac
 	done
+
+	benchmark_select_all_if_empty
 }
 
 run_benchmark() {
@@ -93,12 +312,38 @@ run_benchmark() {
 
 parse_args "$@"
 
-for benchmark_index in "${!BENCHMARKS[@]}"; do
-	benchmark_config="${BENCHMARKS[benchmark_index]}"
-	IFS='|' read -r benchmark_id _topic_name <<<"${benchmark_config}"
+if [[ "${BENCHMARK_COMMAND}" == 'list' ]]; then
+	benchmark_print_available
+	exit 0
+fi
+
+if [[ "${BENCHMARK_COMMAND}" == 'run' ]]; then
+	benchmark_print_selection_summary "${BENCHMARK_COMMAND}" "${BENCHMARK_RESOLUTION}"
+else
+	benchmark_print_selection_summary "${BENCHMARK_COMMAND}"
+fi
+if [[ "${BENCHMARK_COMMAND}" == 'download' ]]; then
+	benchmark_run_with_spinner 'Upgrading pip' python3 -m pip install --quiet --upgrade pip
+	install_requirements
+	download_selected_assets
+	benchmark_log success 'Benchmark assets are ready'
+	exit 0
+fi
+
+if [[ "${BENCHMARK_SKIP_DOWNLOAD}" != '1' ]]; then
+	benchmark_run_with_spinner 'Upgrading pip' python3 -m pip install --quiet --upgrade pip
+	install_requirements
+	download_selected_assets
+	benchmark_log success 'Benchmark assets are ready'
+else
+	benchmark_log info 'Skipping benchmark asset preparation'
+fi
+
+for benchmark_index in "${!BENCHMARK_SELECTED_IDS[@]}"; do
+	benchmark_id="${BENCHMARK_SELECTED_IDS[benchmark_index]}"
 	run_benchmark "${benchmark_id}"
 
-	if (( benchmark_index < ${#BENCHMARKS[@]} - 1 )); then
+	if (( benchmark_index < ${#BENCHMARK_SELECTED_IDS[@]} - 1 )); then
 		log "Waiting ${INTER_BENCHMARK_DELAY_SECONDS}s before starting the next benchmark"
 		sleep "${INTER_BENCHMARK_DELAY_SECONDS}"
 	fi
@@ -107,4 +352,4 @@ done
 log "Waiting ${FINALIZATION_DELAY_SECONDS}s for CSV download finalization"
 sleep "${FINALIZATION_DELAY_SECONDS}"
 
-log 'Benchmark run complete'
+benchmark_log success 'Benchmark run complete'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@luxonis/depthai-viewer-common",
-	"version": "2.5.1",
+	"version": "2.5.3",
 	"description": "Common utilities and components for building a frontend application for DepthAI projects",
 	"license": "ISC",
 	"author": "Luxonis Holding Corporation",
@@ -21,8 +21,8 @@
 		"build:clean:win": "if exist ..\\..\\node_modules\\.tmp\\tsconfig-common.tsbuildinfo del /Q ..\\..\\node_modules\\.tmp\\tsconfig-common.tsbuildinfo & if exist dist rmdir /S /Q dist & npm run build:win",
 		"check-deps": "npm run deps:check -w @luxonis/depthai-web-viewer",
 		"prepublishOnly": "npm run check-deps && npm run build:clean",
-		"benchmark": "./benchmark-download.sh && ./benchmark.sh",
-		"benchmark:download": "./benchmark-download.sh"
+		"benchmark:raw": "./benchmark.sh run",
+		"benchmark:download:raw": "./benchmark.sh download"
 	},
 	"publishConfig": {
 		"access": "public"