Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
763afc7
Add test for handling invalid JSON in receive_message function and pr…
Jun 9, 2026
5bceb29
update changelog message
Jun 9, 2026
96d1b91
add error_description
JC-wk Jun 9, 2026
c760652
Update changelog and improve test assertions for JSON handling in rec…
Jun 9, 2026
59a309a
Merge branch 'main' into fix-json-decode
JC-wk Jun 9, 2026
60c0f31
Merge branch 'main' into fix-json-decode
JC-wk Jun 24, 2026
e7218a4
Merge branch 'main' into fix-json-decode
JC-wk Jun 24, 2026
a1883ee
Merge branch 'main' into fix-json-decode
JC-wk Jun 30, 2026
ba891e2
Merge branch 'main' into fix-json-decode
JC-wk Jul 3, 2026
4daad81
Merge branch 'main' into fix-json-decode
JC-wk Jul 20, 2026
7905301
Merge branch 'main' into fix-json-decode
JC-wk Jul 31, 2026
0a23b62
Merge branch 'main' into fix-json-decode
JC-wk Aug 10, 2026
7074322
copilot fix
Aug 10, 2026
d0bd1fd
Implemented complete resource-request validation in runner.py.
Aug 10, 2026
978e793
address PR feedback
Aug 10, 2026
20dd814
Merge branch 'main' into fix-json-decode
JC-wk Aug 17, 2026
f1286b3
Handle invalid resource request JSON by separating decode vs schema v…
Aug 17, 2026
7a95e15
bump version
Aug 17, 2026
d8956bc
Merge branch 'main' into fix-json-decode
JC-wk Sep 4, 2026
34c7f9f
Apply batched suggestions from code review
JC-wk Sep 4, 2026
f1a0d2e
Update CHANGELOG.md to remove a bug fix entry
JC-wk Sep 4, 2026
b594697
Bump version to 0.13.10
JC-wk Sep 9, 2026
99df578
Merge branch 'main' into fix-json-decode
JC-wk Sep 9, 2026
1d715f7
Enhance error handling in receive_message function to raise exception…
JC-wk Sep 9, 2026
9b72171
Downgrade version from 0.13.10 to 0.13.9
JC-wk Sep 9, 2026
067adda
Add sleep assertion in receive_message test for dead-letter failure l…
JC-wk Sep 9, 2026
a9ae7cb
Merge branch 'main' into fix-json-decode
JC-wk Sep 11, 2026
0c97da0
Merge main into fix-json-decode and resolve changelog conflict
JayDoubleu Oct 6, 2026
3235712
Merge branch 'main' into fix-json-decode
JayDoubleu Oct 6, 2026
b0828b7
Add ValueError to exception handling in runner.py
JayDoubleu Oct 6, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ See [Legacy Airlock & migration](docs/azure-tre-overview/airlock.md#legacy-airlo
* Add weekly and manual builds for Dockerfiles and Porter bundles, with selected pull request builds. Retry a failed target once and report final results. ([#5088](https://github.com/microsoft/AzureTRE/issues/5088))

BUG FIXES:
* Dead-letter malformed Service Bus resource-request payloads instead of retrying them indefinitely. ([#4976](https://github.com/microsoft/AzureTRE/issues/4976))
* Patch vulnerable npm dependencies in the UI (`ui` 0.9.1) and GitHub workflow scripts (`build-scripts` 1.0.1) ([#5108](https://github.com/microsoft/AzureTRE/issues/5108))
* Check blob read, write, lease and metadata access before Terraform initialisation. Recover empty, unowned bootstrap leases only in verified PR CI backends with no other active workflows. Preserve state-lock errors and share bounded readiness retries with management deployment. (`devops` 0.6.8) ([#5091](https://github.com/microsoft/AzureTRE/issues/5091))
* Renew E2E authentication tokens during operation polling and teardown to prevent failures caused by token expiry. ([#5097](https://github.com/microsoft/AzureTRE/issues/5097))
Expand Down
2 changes: 1 addition & 1 deletion resource_processor/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.13.8"
__version__ = "0.13.9"
148 changes: 145 additions & 3 deletions resource_processor/tests_rp/test_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,15 @@ async def test_receive_message(mock_invoke_porter_action, mock_service_bus_clien
mock_receiver.__aexit__.return_value = None
mock_receiver.session.session_id = "test_session_id"
mock_receiver.__aiter__.return_value = [AsyncMock()]
mock_receiver.__aiter__.return_value[0] = json.dumps({"id": "test_id", "action": "install", "stepId": "test_step_id", "operationId": "test_operation_id"})
mock_receiver.__aiter__.return_value[0] = json.dumps({
"id": "test_id",
"action": "install",
"stepId": "test_step_id",
"operationId": "test_operation_id",
"name": "test_bundle",
"version": "1.0.0",
"parameters": {},
})

mock_service_bus_client_instance.get_queue_receiver.return_value.__aenter__.return_value = mock_receiver

Expand All @@ -161,10 +169,136 @@ async def test_receive_message(mock_invoke_porter_action, mock_service_bus_clien
config = {"resource_request_queue": "test_queue"}

await receive_message(mock_service_bus_client_instance, config, keep_running=run_once)
mock_receiver.complete_message.assert_called_once()
mock_receiver.complete_message.assert_awaited_once()
mock_service_bus_client_instance.get_queue_receiver.assert_called_once_with(queue_name="test_queue", max_wait_time=1, session_id=ServiceBusSessionFilter.NEXT_AVAILABLE)


@pytest.mark.asyncio
async def test_receive_message_bad_json(mock_service_bus_client, mock_auto_lock_renewer):
mock_service_bus_client_instance = mock_service_bus_client.return_value

# Set up the lock renewer mock correctly
mock_renewer = AsyncMock()
mock_renewer.register = Mock()
mock_auto_lock_renewer.return_value.__aenter__.return_value = mock_renewer

mock_receiver = AsyncMock()
mock_receiver.__aenter__.return_value = mock_receiver
mock_receiver.__aexit__.return_value = None
mock_receiver.session.session_id = "test_session_id"
mock_receiver.__aiter__.return_value = ["invalid_json_string"]

mock_service_bus_client_instance.get_queue_receiver.return_value.__aenter__.return_value = mock_receiver

run_once = Mock(side_effect=[True, False])

config = {"resource_request_queue": "test_queue"}

await receive_message(mock_service_bus_client_instance, config, keep_running=run_once)
mock_receiver.dead_letter_message.assert_awaited_once()
dead_letter_args, dead_letter_kwargs = mock_receiver.dead_letter_message.await_args
assert dead_letter_args == ("invalid_json_string",)
assert dead_letter_kwargs["reason"] == "InvalidJSON"
assert dead_letter_kwargs["error_description"]
mock_receiver.complete_message.assert_not_awaited()


@pytest.mark.asyncio
@pytest.mark.parametrize(
"message, expected_log",
[
("invalid_json_string", "Failed to dead-letter malformed message"),
("null", "Failed to dead-letter invalid resource request message"),
],
)
async def test_receive_message_dead_letter_failure_is_logged(
message, expected_log, mock_service_bus_client, mock_auto_lock_renewer, mock_logger
):
mock_service_bus_client_instance = mock_service_bus_client.return_value

mock_renewer = AsyncMock()
mock_renewer.register = Mock()
mock_auto_lock_renewer.return_value.__aenter__.return_value = mock_renewer

mock_receiver = AsyncMock()
mock_receiver.__aenter__.return_value = mock_receiver
mock_receiver.__aexit__.return_value = None
mock_receiver.session.session_id = "test_session_id"
mock_receiver.__aiter__.return_value = [message]
mock_receiver.dead_letter_message.side_effect = RuntimeError("lock lost")

mock_service_bus_client_instance.get_queue_receiver.return_value.__aenter__.return_value = mock_receiver

run_once = Mock(side_effect=[True, False])
config = {"resource_request_queue": "test_queue"}

with patch("vmss_porter.runner.asyncio.sleep", new_callable=AsyncMock) as mock_sleep:
await receive_message(mock_service_bus_client_instance, config, keep_running=run_once)

mock_sleep.assert_awaited_once_with(10)

assert mock_logger.exception.call_args_list == [
((expected_log,), {}),
(("Unknown exception. Will retry...",), {}),
]
mock_receiver.complete_message.assert_not_awaited()


@pytest.mark.asyncio
@pytest.mark.parametrize(
"message, error_description",
[
("null", "Resource request message must be a JSON object"),
("[]", "Resource request message must be a JSON object"),
("\"text\"", "Resource request message must be a JSON object"),
(
'{"id": "test_id"}',
"Resource request message is missing fields: ['action', 'name', 'operationId', 'parameters', 'stepId', 'version']",
),
(
'{"id": "test_id", "action": [], "stepId": "test_step_id", "operationId": "test_operation_id", "name": "test_bundle", "version": "1.0.0", "parameters": {}}',
"Resource request message has invalid field types: ['action']",
),
(
'{"id": "test_id", "action": "install", "stepId": "test_step_id", "operationId": "test_operation_id", "name": "test_bundle", "version": "1.0.0", "parameters": null}',
"Resource request message has invalid field types: ['parameters']",
),
(
'{"id": "test_id", "action": "install", "stepId": "test_step_id", "operationId": "test_operation_id", "name": "test_bundle", "version": "1.0.0", "parameters": {}, "user": []}',
"Resource request message has invalid field types: ['user']",
),
],
)
async def test_receive_message_invalid_json_structure(
message, error_description, mock_service_bus_client, mock_auto_lock_renewer
):
mock_service_bus_client_instance = mock_service_bus_client.return_value

mock_renewer = AsyncMock()
mock_renewer.register = Mock()
mock_auto_lock_renewer.return_value.__aenter__.return_value = mock_renewer

mock_receiver = AsyncMock()
mock_receiver.__aenter__.return_value = mock_receiver
mock_receiver.__aexit__.return_value = None
mock_receiver.session.session_id = "test_session_id"
mock_receiver.__aiter__.return_value = [message]

mock_service_bus_client_instance.get_queue_receiver.return_value.__aenter__.return_value = mock_receiver

run_once = Mock(side_effect=[True, False])
config = {"resource_request_queue": "test_queue"}

await receive_message(mock_service_bus_client_instance, config, keep_running=run_once)

mock_receiver.dead_letter_message.assert_awaited_once_with(
message,
reason="InvalidResourceRequest",
error_description=error_description,
)
mock_receiver.complete_message.assert_not_awaited()


@pytest.mark.asyncio
async def test_receive_message_unknown_exception(mock_auto_lock_renewer, mock_service_bus_client, mock_logger):
"""Test receiving a message with an unknown exception."""
Expand All @@ -180,7 +314,15 @@ async def test_receive_message_unknown_exception(mock_auto_lock_renewer, mock_se
mock_receiver.__aexit__.return_value = None
mock_receiver.session.session_id = "test_session_id"
mock_receiver.__aiter__.return_value = [AsyncMock()]
mock_receiver.__aiter__.return_value[0] = json.dumps({"id": "test_id", "action": "install", "stepId": "test_step_id", "operationId": "test_operation_id"})
mock_receiver.__aiter__.return_value[0] = json.dumps({
"id": "test_id",
"action": "install",
"stepId": "test_step_id",
"operationId": "test_operation_id",
"name": "test_bundle",
"version": "1.0.0",
"parameters": {},
})

mock_service_bus_client_instance.get_queue_receiver.return_value.__aenter__.return_value = mock_receiver

Expand Down
56 changes: 55 additions & 1 deletion resource_processor/vmss_porter/runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,43 @@
from azure.identity.aio import DefaultAzureCredential


RESOURCE_REQUEST_FIELD_TYPES = {
"id": str,
"action": str,
"stepId": str,
"operationId": str,
"name": str,
"version": str,
"parameters": dict,
}
OPTIONAL_RESOURCE_REQUEST_FIELD_TYPES = {"user": dict}


def validate_resource_request(message: object) -> None:
if not isinstance(message, dict):
raise ValueError("Resource request message must be a JSON object")

missing_fields = set(RESOURCE_REQUEST_FIELD_TYPES) - message.keys()
if missing_fields:
raise ValueError(f"Resource request message is missing fields: {sorted(missing_fields)}")

invalid_fields = [
field_name
for field_name, field_type in RESOURCE_REQUEST_FIELD_TYPES.items()
if not isinstance(message[field_name], field_type)
]
if invalid_fields:
raise ValueError(f"Resource request message has invalid field types: {sorted(invalid_fields)}")

invalid_optional_fields = [
field_name
for field_name, field_type in OPTIONAL_RESOURCE_REQUEST_FIELD_TYPES.items()
if field_name in message and not isinstance(message[field_name], field_type)
]
if invalid_optional_fields:
raise ValueError(f"Resource request message has invalid field types: {sorted(invalid_optional_fields)}")


def set_up_config() -> Optional[dict]:
try:
config = get_config()
Expand Down Expand Up @@ -73,8 +110,25 @@ async def receive_message(service_bus_client, config: dict, keep_running=lambda:

try:
message = json.loads(str(msg))
except (json.JSONDecodeError) as e:
except (json.JSONDecodeError, UnicodeDecodeError, ValueError) as e:
logger.error(f"Received bad service bus resource request message: {e}")
try:
await receiver.dead_letter_message(msg, reason="InvalidJSON", error_description=str(e))
except Exception:
logger.exception("Failed to dead-letter malformed message")
raise
continue

try:
validate_resource_request(message)
except ValueError as e:
logger.error(f"Received invalid service bus resource request message: {e}")
try:
await receiver.dead_letter_message(msg, reason="InvalidResourceRequest", error_description=str(e))
except Exception:
logger.exception("Failed to dead-letter invalid resource request message")
raise
continue
Comment thread
JayDoubleu marked this conversation as resolved.
Resolved

with tracer.start_as_current_span("receive_message") as current_span:
current_span.set_attribute("resource_id", message["id"])
Expand Down