#!/usr/bin/env bash
# Integration: progress-aware timeout extension.
# Tests that tools emitting progress survive past nominal timeout,
# while tools without progress timeout as expected.
# shellcheck disable=SC2034 # Used by test runner for reporting.
TEST_DESC="Progress-aware timeout extension for long-running tools."
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck source=../common/env.sh
# shellcheck disable=SC1091
. "${SCRIPT_DIR}/../common/env.sh"
# shellcheck source=../common/assert.sh
# shellcheck disable=SC1091
. "${SCRIPT_DIR}/../common/assert.sh"
test_require_command jq
test_create_tmpdir
WORKSPACE="${TEST_TMPDIR}/progress-timeout"
test_stage_workspace "${WORKSPACE}"
# Copy test fixtures from examples/99-test-fixtures
FIXTURES_SRC="${MCPBASH_HOME}/examples/99-test-fixtures"
if [ ! -d "${FIXTURES_SRC}" ]; then
test_fail "test fixtures not found: ${FIXTURES_SRC}"
fi
cp -a "${FIXTURES_SRC}/tools/." "${WORKSPACE}/tools/"
RESPONSES="${WORKSPACE}/responses.ndjson"
# --- Test 1: Tool with progress survives past nominal timeout ---
# The slow-with-progress tool has timeoutSecs=5 but runs for 8s with progress.
# With MCPBASH_PROGRESS_EXTENDS_TIMEOUT=true, it should complete successfully.
cat <<'JSON' >"${WORKSPACE}/requests-with-progress.ndjson"
{"jsonrpc":"2.0","id":"init","method":"initialize","params":{}}
{"jsonrpc":"2.0","method":"notifications/initialized"}
{"jsonrpc":"2.0","id":"progress-tool","method":"tools/call","params":{"name":"slow-with-progress","arguments":{"duration":8},"_meta":{"progressToken":"pt-1"}}}
JSON
(
cd "${WORKSPACE}" || exit 1
MCPBASH_PROJECT_ROOT="${WORKSPACE}" \
MCPBASH_PROGRESS_EXTENDS_TIMEOUT=true \
MCPBASH_MAX_TIMEOUT_SECS=60 \
./bin/mcp-bash <"${WORKSPACE}/requests-with-progress.ndjson" >"${RESPONSES}" 2>/dev/null
) || true
assert_json_lines "${RESPONSES}"
progress_resp="$(jq -c 'select(.id=="progress-tool")' "${RESPONSES}")"
if [ -z "${progress_resp}" ]; then
test_fail "missing progress-tool response"
fi
# Check for successful result (no error)
if echo "${progress_resp}" | jq -e '.error' >/dev/null 2>&1; then
error_msg="$(echo "${progress_resp}" | jq -r '.error.message // "unknown"')"
test_fail "slow-with-progress should complete successfully but got error: ${error_msg}"
fi
# Verify result contains expected completion message
result_text="$(echo "${progress_resp}" | jq -r '.result.content[0].text // empty')"
if [[ "${result_text}" != *"Completed"* ]]; then
test_fail "slow-with-progress result should contain 'Completed': ${result_text}"
fi
printf 'Test 1 passed: tool with progress survives past nominal timeout.\n'
# --- Test 2: Tool without progress times out as expected ---
# The slow-no-progress tool has timeoutSecs=5 but runs for 10s without progress.
# Even with MCPBASH_PROGRESS_EXTENDS_TIMEOUT=true, it should timeout after 5s idle.
cat <<'JSON' >"${WORKSPACE}/requests-no-progress.ndjson"
{"jsonrpc":"2.0","id":"init","method":"initialize","params":{}}
{"jsonrpc":"2.0","method":"notifications/initialized"}
{"jsonrpc":"2.0","id":"no-progress-tool","method":"tools/call","params":{"name":"slow-no-progress","arguments":{"duration":10}}}
JSON
(
cd "${WORKSPACE}" || exit 1
MCPBASH_PROJECT_ROOT="${WORKSPACE}" \
MCPBASH_PROGRESS_EXTENDS_TIMEOUT=true \
MCPBASH_MAX_TIMEOUT_SECS=60 \
./bin/mcp-bash <"${WORKSPACE}/requests-no-progress.ndjson" >"${WORKSPACE}/responses-no-progress.ndjson" 2>/dev/null
) || true
assert_json_lines "${WORKSPACE}/responses-no-progress.ndjson"
no_progress_resp="$(jq -c 'select(.id=="no-progress-tool")' "${WORKSPACE}/responses-no-progress.ndjson")"
if [ -z "${no_progress_resp}" ]; then
test_fail "missing no-progress-tool response"
fi
# Check for timeout as tool execution error (isError: true)
if ! echo "${no_progress_resp}" | jq -e '.result.isError == true' >/dev/null 2>&1; then
test_fail "slow-no-progress should timeout with isError:true but got: $(echo "${no_progress_resp}" | jq -c '.result // .error // "no response"')"
fi
# Verify structured error has type: "timeout"
error_type="$(echo "${no_progress_resp}" | jq -r '.result.structuredContent.error.type // empty')"
test_assert_eq "${error_type}" "timeout"
# Verify error message in content mentions timeout
error_msg="$(echo "${no_progress_resp}" | jq -r '.result.content[0].text // empty')"
if [[ "${error_msg}" != *"timed out"* ]]; then
test_fail "error message should mention timeout: ${error_msg}"
fi
# Verify reason is "idle" (no progress reported)
error_reason="$(echo "${no_progress_resp}" | jq -r '.result.structuredContent.error.reason // empty')"
test_assert_eq "${error_reason}" "idle"
printf 'Test 2 passed: tool without progress times out as expected.\n'
# --- Test 3: Hard cap is enforced despite continuous progress ---
# Use a very low hard cap to test that max_timeout is enforced.
cat <<'JSON' >"${WORKSPACE}/requests-hard-cap.ndjson"
{"jsonrpc":"2.0","id":"init","method":"initialize","params":{}}
{"jsonrpc":"2.0","method":"notifications/initialized"}
{"jsonrpc":"2.0","id":"hard-cap-tool","method":"tools/call","params":{"name":"slow-with-progress","arguments":{"duration":20},"_meta":{"progressToken":"pt-3"}}}
JSON
(
cd "${WORKSPACE}" || exit 1
MCPBASH_PROJECT_ROOT="${WORKSPACE}" \
MCPBASH_PROGRESS_EXTENDS_TIMEOUT=true \
MCPBASH_MAX_TIMEOUT_SECS=8 \
./bin/mcp-bash <"${WORKSPACE}/requests-hard-cap.ndjson" >"${WORKSPACE}/responses-hard-cap.ndjson" 2>/dev/null
) || true
assert_json_lines "${WORKSPACE}/responses-hard-cap.ndjson"
hard_cap_resp="$(jq -c 'select(.id=="hard-cap-tool")' "${WORKSPACE}/responses-hard-cap.ndjson")"
if [ -z "${hard_cap_resp}" ]; then
test_fail "missing hard-cap-tool response"
fi
# Check for timeout as tool execution error (isError: true)
if ! echo "${hard_cap_resp}" | jq -e '.result.isError == true' >/dev/null 2>&1; then
test_fail "slow-with-progress should hit hard cap with isError:true but got: $(echo "${hard_cap_resp}" | jq -c '.result // .error // "no response"')"
fi
# Verify structured error has type: "timeout"
hard_cap_type="$(echo "${hard_cap_resp}" | jq -r '.result.structuredContent.error.type // empty')"
test_assert_eq "${hard_cap_type}" "timeout"
# Verify reason is "max_exceeded" (hit hard cap despite progress)
hard_cap_reason="$(echo "${hard_cap_resp}" | jq -r '.result.structuredContent.error.reason // empty')"
test_assert_eq "${hard_cap_reason}" "max_exceeded"
printf 'Test 3 passed: hard cap is enforced despite continuous progress.\n'
# --- Test 4: Tool with pattern-matching events (no .progress) survives ---
# The slow-with-events tool emits structured JSON events that match the pattern
# but lack the .progress field. The touch-on-pattern-match should extend timeout.
cat <<'JSON' >"${WORKSPACE}/requests-with-events.ndjson"
{"jsonrpc":"2.0","id":"init","method":"initialize","params":{}}
{"jsonrpc":"2.0","method":"notifications/initialized"}
{"jsonrpc":"2.0","id":"events-tool","method":"tools/call","params":{"name":"slow-with-events","arguments":{"duration":8},"_meta":{"progressToken":"pt-4"}}}
JSON
(
cd "${WORKSPACE}" || exit 1
MCPBASH_PROJECT_ROOT="${WORKSPACE}" \
MCPBASH_PROGRESS_EXTENDS_TIMEOUT=true \
MCPBASH_MAX_TIMEOUT_SECS=60 \
./bin/mcp-bash <"${WORKSPACE}/requests-with-events.ndjson" >"${WORKSPACE}/responses-with-events.ndjson" 2>/dev/null
) || true
assert_json_lines "${WORKSPACE}/responses-with-events.ndjson"
events_resp="$(jq -c 'select(.id=="events-tool")' "${WORKSPACE}/responses-with-events.ndjson")"
if [ -z "${events_resp}" ]; then
test_fail "missing events-tool response"
fi
# Check for successful result (no error) - pattern match should have extended timeout
if echo "${events_resp}" | jq -e '.error' >/dev/null 2>&1; then
error_msg="$(echo "${events_resp}" | jq -r '.error.message // "unknown"')"
test_fail "slow-with-events should complete successfully (pattern match extends timeout) but got error: ${error_msg}"
fi
# Check not a tool execution error
if echo "${events_resp}" | jq -e '.result.isError == true' >/dev/null 2>&1; then
error_msg="$(echo "${events_resp}" | jq -r '.result.content[0].text // "unknown"')"
test_fail "slow-with-events should complete successfully but got isError: ${error_msg}"
fi
# Verify result contains expected completion message
events_result_text="$(echo "${events_resp}" | jq -r '.result.content[0].text // empty')"
if [[ "${events_result_text}" != *"Completed"* ]]; then
test_fail "slow-with-events result should contain 'Completed': ${events_result_text}"
fi
printf 'Test 4 passed: tool with pattern-matching events (no .progress) survives timeout.\n'
printf 'Progress-aware timeout tests passed.\n'
