azure_iot_operations_protocol/rpc_command/invoker.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
use std::{collections::HashMap, marker::PhantomData, str::FromStr, sync::Arc, time::Duration};
use azure_iot_operations_mqtt::control_packet::{Publish, PublishProperties, QoS};
use azure_iot_operations_mqtt::interface::{ManagedClient, PubReceiver};
use bytes::Bytes;
use iso8601_duration;
use tokio::{
sync::{
Mutex, Notify,
broadcast::{Sender, error::RecvError},
},
task, time,
};
use uuid::Uuid;
use crate::common::user_properties::{PARTITION_KEY, validate_invoker_user_properties};
use crate::{
ProtocolVersion,
application::{ApplicationContext, ApplicationHybridLogicalClock},
common::{
aio_protocol_error::{AIOProtocolError, AIOProtocolErrorKind, Value},
hybrid_logical_clock::HybridLogicalClock,
is_invalid_utf8,
payload_serialize::{
DeserializationError, FormatIndicator, PayloadSerialize, SerializedPayload,
},
topic_processor::{TopicPattern, contains_invalid_char},
user_properties::UserProperty,
},
parse_supported_protocol_major_versions,
rpc_command::{DEFAULT_RPC_COMMAND_PROTOCOL_VERSION, RPC_COMMAND_PROTOCOL_VERSION, StatusCode},
};
const SUPPORTED_PROTOCOL_VERSIONS: &[u16] = &[1];
/// Command Request struct.
/// Used by the [`Invoker`]
#[derive(Builder, Clone, Debug)]
#[builder(setter(into), build_fn(validate = "Self::validate"))]
pub struct Request<TReq>
where
TReq: PayloadSerialize,
{
/// Payload of the command request.
#[builder(setter(custom))]
serialized_payload: SerializedPayload,
/// Strongly link `Request` with type `TReq`
#[builder(private)]
request_payload_type: PhantomData<TReq>,
/// User data that will be set as custom MQTT User Properties on the Request message.
/// Can be used to pass additional metadata to the executor.
/// Default is an empty vector.
#[builder(default)]
custom_user_data: Vec<(String, String)>,
/// Topic token keys/values to be replaced into the publish topic of the request.
#[builder(default)]
topic_tokens: HashMap<String, String>,
/// Timeout for the command, must be one second or greater. Will also be used as the `message_expiry_interval`
/// to give the executor information on when the invoke request might expire.
#[builder(setter(custom))]
timeout: Duration,
}
impl<TReq: PayloadSerialize> RequestBuilder<TReq> {
/// Add a payload to the command request. Validates successful serialization of the payload.
///
/// # Errors
/// [`AIOProtocolError`] of kind [`PayloadInvalid`](crate::common::aio_protocol_error::AIOProtocolErrorKind::PayloadInvalid) if serialization of the payload fails
///
/// [`AIOProtocolError`] of kind [`ConfigurationInvalid`](crate::common::aio_protocol_error::AIOProtocolErrorKind::ConfigurationInvalid) if the content type is not valid utf-8
pub fn payload(&mut self, payload: TReq) -> Result<&mut Self, AIOProtocolError> {
match payload.serialize() {
Err(e) => Err(AIOProtocolError::new_payload_invalid_error(
true,
false,
Some(e.into()),
Some("Payload serialization error".to_string()),
None,
)),
Ok(serialized_payload) => {
// Validate content type of command request is valid UTF-8
if is_invalid_utf8(&serialized_payload.content_type) {
return Err(AIOProtocolError::new_configuration_invalid_error(
None,
"content_type",
Value::String(serialized_payload.content_type.to_string()),
Some(format!(
"Content type '{}' of command request is not valid UTF-8",
serialized_payload.content_type
)),
None,
));
}
self.serialized_payload = Some(serialized_payload);
self.request_payload_type = Some(PhantomData);
Ok(self)
}
}
}
/// Set the timeout for the command
///
/// Note: Will be rounded up to the nearest second.
pub fn timeout(&mut self, timeout: Duration) -> &mut Self {
self.timeout = Some(if timeout.subsec_nanos() != 0 {
Duration::from_secs(timeout.as_secs().saturating_add(1))
} else {
timeout
});
self
}
/// Validate the command request.
///
/// # Errors
/// Returns a `String` describing the error if
/// - any of `custom_user_data`'s keys or values are invalid utf-8 or the key is reserved
/// - timeout is zero or > `u32::max`
fn validate(&self) -> Result<(), String> {
if let Some(custom_user_data) = &self.custom_user_data {
validate_invoker_user_properties(custom_user_data)?;
}
if let Some(timeout) = &self.timeout {
if timeout.as_secs() == 0 {
return Err("Timeout must not be 0".to_string());
}
match <u64 as TryInto<u32>>::try_into(timeout.as_secs()) {
Ok(_) => {}
Err(_) => {
return Err("Timeout in seconds must be less than or equal to u32::max to be used as message_expiry_interval".to_string());
}
}
}
Ok(())
}
}
/// Command Response struct.
/// Used by the [`Invoker`]
#[derive(Debug)]
pub struct Response<TResp>
where
TResp: PayloadSerialize,
{
/// Payload of the command response. Must implement [`PayloadSerialize`].
pub payload: TResp,
/// Content Type of the command response.
pub content_type: Option<String>,
/// Format Indicator of the command response.
pub format_indicator: FormatIndicator,
/// Custom user data set as custom MQTT User Properties on the Response message.
pub custom_user_data: Vec<(String, String)>,
/// Timestamp of the command response.
pub timestamp: Option<HybridLogicalClock>,
}
/// Command Invoker Options struct
#[derive(Builder, Clone)]
#[builder(setter(into))]
pub struct Options {
/// Topic pattern for the command request.
/// Must align with [topic-structure.md](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/topic-structure.md)
request_topic_pattern: String,
/// Topic pattern for the command response.
/// Must align with [topic-structure.md](https://github.com/Azure/iot-operations-sdks/blob/main/doc/reference/topic-structure.md).
/// If all response topic options are `None`, the response topic will be generated
/// based on the request topic in the form: `clients/<client_id>/<request_topic>`
#[builder(default = "None")]
response_topic_pattern: Option<String>,
/// Command name
command_name: String,
/// Optional Topic namespace to be prepended to the topic patterns
#[builder(default = "None")]
topic_namespace: Option<String>,
/// Topic token keys/values to be permanently replaced in the topic pattern
#[builder(default)]
topic_token_map: HashMap<String, String>,
/// Prefix for the response topic.
/// If all response topic options are `None`, the response topic will be generated
/// based on the request topic in the form: `clients/<client_id>/<request_topic>`
#[builder(default = "None")]
response_topic_prefix: Option<String>,
/// Suffix for the response topic.
/// If all response topic options are `None`, the response topic will be generated
/// based on the request topic in the form: `clients/<client_id>/<request_topic>`
#[builder(default = "None")]
response_topic_suffix: Option<String>,
}
/// Command Invoker struct
/// # Example
/// ```
/// # use std::{collections::HashMap, time::Duration};
/// # use tokio_test::block_on;
/// # use azure_iot_operations_mqtt::MqttConnectionSettingsBuilder;
/// # use azure_iot_operations_mqtt::session::{Session, SessionOptionsBuilder};
/// # use azure_iot_operations_protocol::rpc_command;
/// # use azure_iot_operations_protocol::application::ApplicationContextBuilder;
/// # let mut connection_settings = MqttConnectionSettingsBuilder::default()
/// # .client_id("test_client")
/// # .hostname("mqtt://localhost")
/// # .tcp_port(1883u16)
/// # .build().unwrap();
/// # let mut session_options = SessionOptionsBuilder::default()
/// # .connection_settings(connection_settings)
/// # .build().unwrap();
/// # let mqtt_session = Session::new(session_options).unwrap();
/// # let application_context = ApplicationContextBuilder::default().build().unwrap();;
/// let invoker_options = rpc_command::invoker::OptionsBuilder::default()
/// .request_topic_pattern("test/request")
/// .response_topic_pattern("test/response".to_string())
/// .command_name("test_command")
/// .topic_namespace("test_namespace".to_string())
/// .topic_token_map(HashMap::from([("invokerClientId".to_string(), "test_client".to_string())]))
/// .response_topic_prefix("custom/{invokerClientId}".to_string())
/// .build().unwrap();
/// # tokio_test::block_on(async {
/// let invoker: rpc_command::Invoker<Vec<u8>, Vec<u8>, _> = rpc_command::Invoker::new(application_context, mqtt_session.create_managed_client(), invoker_options).unwrap();
/// let request = rpc_command::invoker::RequestBuilder::default()
/// .payload(Vec::new()).unwrap()
/// .timeout(Duration::from_secs(2))
/// .topic_tokens(HashMap::from([("executorId".to_string(), "test_executor".to_string())]))
/// .build().unwrap();
/// let result = invoker.invoke(request);
/// //let response: Response<Vec<u8>> = result.await.unwrap();
/// # })
/// ```
pub struct Invoker<TReq, TResp, C>
where
TReq: PayloadSerialize + 'static,
TResp: PayloadSerialize + 'static,
C: ManagedClient + Clone + Send + Sync + 'static,
C::PubReceiver: Send + Sync + 'static,
{
// static properties of the invoker
application_hlc: Arc<ApplicationHybridLogicalClock>,
mqtt_client: C,
command_name: String,
request_topic_pattern: TopicPattern,
response_topic_pattern: TopicPattern,
request_payload_type: PhantomData<TReq>,
response_payload_type: PhantomData<TResp>,
// Describes state
invoker_state_mutex: Arc<Mutex<State>>,
// Used to send information to manage state
shutdown_notifier: Arc<Notify>,
response_tx: Sender<Option<Publish>>,
}
/// Describes state of invoker to know whether to subscribe/unsubscribe/reject invokes
enum State {
New,
Subscribed,
ShutdownInitiated,
ShutdownSuccessful,
}
/// Implementation of Command Invoker.
impl<TReq, TResp, C> Invoker<TReq, TResp, C>
where
TReq: PayloadSerialize + 'static,
TResp: PayloadSerialize + 'static,
C: ManagedClient + Clone + Send + Sync + 'static,
C::PubReceiver: Send + Sync + 'static,
{
/// Creates a new [`Invoker`].
///
/// # Arguments
/// * `application_context` - [`ApplicationContext`] that the command invoker is part of.
/// * `client` - The MQTT client to use for communication.
/// * `invoker_options` - Configuration options.
///
/// Returns Ok([`Invoker`]) on success, otherwise returns [`AIOProtocolError`].
/// # Errors
/// [`AIOProtocolError`] of kind [`ConfigurationInvalid`](AIOProtocolErrorKind::ConfigurationInvalid) if:
/// - [`command_name`](OptionsBuilder::command_name) is empty, whitespace or invalid
/// - [`request_topic_pattern`](OptionsBuilder::request_topic_pattern) is empty or whitespace
/// - [`response_topic_pattern`](OptionsBuilder::response_topic_pattern) is Some and empty or whitespace
/// - [`response_topic_pattern`](OptionsBuilder::response_topic_pattern) is None and
/// [`response_topic_prefix`](OptionsBuilder::response_topic_prefix) or
/// [`response_topic_suffix`](OptionsBuilder::response_topic_suffix) are Some and empty or whitespace
/// - [`request_topic_pattern`](OptionsBuilder::request_topic_pattern),
/// [`response_topic_pattern`](OptionsBuilder::response_topic_pattern),
/// [`topic_namespace`](OptionsBuilder::topic_namespace),
/// [`response_topic_prefix`](OptionsBuilder::response_topic_prefix),
/// [`response_topic_suffix`](OptionsBuilder::response_topic_suffix),
/// are Some and invalid or contain a token with no valid replacement
/// - [`topic_token_map`](OptionsBuilder::topic_token_map) isn't empty and contains invalid key(s)/token(s)
pub fn new(
application_context: ApplicationContext,
client: C,
invoker_options: Options,
) -> Result<Self, AIOProtocolError> {
// Validate function parameters. request_topic_pattern will be validated by topic parser
if invoker_options.command_name.is_empty()
|| contains_invalid_char(&invoker_options.command_name)
{
return Err(AIOProtocolError::new_configuration_invalid_error(
None,
"command_name",
Value::String(invoker_options.command_name.clone()),
None,
Some(invoker_options.command_name),
));
}
// If no response_topic_pattern is specified, generate one based on the request_topic_pattern, response_topic_prefix, and response_topic_suffix
let mut response_topic_pattern;
if let Some(pattern) = invoker_options.response_topic_pattern {
response_topic_pattern = pattern;
} else {
response_topic_pattern = invoker_options.request_topic_pattern.clone();
// If no options around the response topic have been specified
// (no response topic or prefix/suffix), default to a well-known
// pattern of clients/<client_id>/<request_topic>. This ensures
// that the response topic is different from the request topic and lets
// us document this pattern for auth configuration. Note that this does
// not use any topic tokens, since we cannot guarantee their existence.
if invoker_options.response_topic_prefix.is_none()
&& invoker_options.response_topic_suffix.is_none()
{
response_topic_pattern =
"clients/".to_owned() + client.client_id() + "/" + &response_topic_pattern;
} else {
if let Some(prefix) = invoker_options.response_topic_prefix {
// Validity check will be done within the topic processor
response_topic_pattern = prefix + "/" + &response_topic_pattern;
}
if let Some(suffix) = invoker_options.response_topic_suffix {
// Validity check will be done within the topic processor
response_topic_pattern = response_topic_pattern + "/" + &suffix;
}
}
}
// Generate the request and response topics
let request_topic_pattern = TopicPattern::new(
&invoker_options.request_topic_pattern,
None,
invoker_options.topic_namespace.as_deref(),
&invoker_options.topic_token_map,
)
.map_err(|e| {
AIOProtocolError::config_invalid_from_topic_pattern_error(
e,
"invoker_options.request_topic_pattern",
)
})?;
let response_topic_pattern = TopicPattern::new(
&response_topic_pattern,
None,
invoker_options.topic_namespace.as_deref(),
&invoker_options.topic_token_map,
)
.map_err(|e| {
AIOProtocolError::config_invalid_from_topic_pattern_error(e, "response_topic_pattern")
})?;
// Create mutex to track invoker state
let invoker_state_mutex = Arc::new(Mutex::new(State::New));
// Create a filtered receiver from the Managed Client
let mqtt_receiver = match client
.create_filtered_pub_receiver(&response_topic_pattern.as_subscribe_topic())
{
Ok(receiver) => receiver,
Err(e) => {
return Err(AIOProtocolError::new_configuration_invalid_error(
Some(Box::new(e)),
"response_topic_pattern",
Value::String(response_topic_pattern.as_subscribe_topic()),
Some("Could not parse response topic pattern".to_string()),
Some(invoker_options.command_name),
));
}
};
// Create the channel to send responses on
let response_tx = Sender::new(5);
// Create the shutdown notifier for the receiver loop
let shutdown_notifier = Arc::new(Notify::new());
// Start the receive response loop
task::spawn({
let response_tx_clone = response_tx.clone();
let shutdown_notifier_clone = shutdown_notifier.clone();
let command_name_clone = invoker_options.command_name.clone();
async move {
Self::receive_response_loop(
mqtt_receiver,
response_tx_clone,
shutdown_notifier_clone,
command_name_clone,
)
.await;
}
});
Ok(Self {
application_hlc: application_context.application_hlc,
mqtt_client: client,
command_name: invoker_options.command_name,
request_topic_pattern,
response_topic_pattern,
request_payload_type: PhantomData,
response_payload_type: PhantomData,
invoker_state_mutex,
shutdown_notifier,
response_tx,
})
}
/// Invokes a command.
///
/// Returns Ok([`Response`]) on success, otherwise returns [`AIOProtocolError`].
/// # Arguments
/// * `request` - [`Request`] to invoke
/// # Errors
///
/// [`AIOProtocolError`] of kind [`ConfigurationInvalid`](AIOProtocolErrorKind::ConfigurationInvalid) if
/// - any [`topic_tokens`](RequestBuilder::topic_tokens) are invalid
///
/// [`AIOProtocolError`] of kind [`PayloadInvalid`](AIOProtocolErrorKind::PayloadInvalid) if
/// - [`response_payload`][Response::payload] deserialization fails
/// - The response has a [`UserProperty::Status`] of [`StatusCode::NoContent`] but the payload isn't empty
/// - The response has a [`UserProperty::Status`] of [`StatusCode::BadRequest`] and there is no [`UserProperty::InvalidPropertyName`] or [`UserProperty::InvalidPropertyValue`] specified
///
/// [`AIOProtocolError`] of kind [`Timeout`](AIOProtocolErrorKind::Timeout) if
/// - Command invoke timed out
/// - The response has a [`UserProperty::Status`] of [`StatusCode::RequestTimeout`]
///
/// [`AIOProtocolError`] of kind [`ClientError`](AIOProtocolErrorKind::ClientError) if
/// - The subscribe fails
/// - The suback reason code doesn't indicate success.
/// - The publish fails
/// - The puback reason code doesn't indicate success.
///
/// [`AIOProtocolError`] of kind [`Cancellation`](AIOProtocolErrorKind::Cancellation) if the [`Invoker`] has been dropped
///
/// [`AIOProtocolError`] of kind [`HeaderInvalid`](AIOProtocolErrorKind::HeaderInvalid) if
/// - The response's `content_type` isn't supported
/// - The response has a [`UserProperty::Timestamp`] that is malformed
/// - The response has a [`UserProperty::Status`] that can't be parsed as an integer
/// - The response has a [`UserProperty::Status`] of [`StatusCode::BadRequest`] and a [`UserProperty::InvalidPropertyValue`] is specified
/// - The response has a [`UserProperty::Status`] of [`StatusCode::UnsupportedMediaType`]
///
/// [`AIOProtocolError`] of kind [`HeaderMissing`](AIOProtocolErrorKind::HeaderMissing) if
/// - The response has a [`UserProperty::Status`] of [`StatusCode::BadRequest`] and [`UserProperty::InvalidPropertyName`] is specified, but [`UserProperty::InvalidPropertyValue`] isn't specified
/// - The response doesn't specify a [`UserProperty::Status`]
///
/// [`AIOProtocolError`] of kind [`UnknownError`](AIOProtocolErrorKind::UnknownError) if
/// - The response has a [`UserProperty::Status`] that isn't one of [`StatusCode`]
/// - The response has a [`UserProperty::Status`] of [`StatusCode::InternalServerError`], the [`UserProperty::IsApplicationError`] is false, and a [`UserProperty::InvalidPropertyName`] isn't provided
///
/// [`AIOProtocolError`] of kind [`ExecutionException`](AIOProtocolErrorKind::ExecutionException) if the response has a [`UserProperty::Status`] of [`StatusCode::InternalServerError`] and the [`UserProperty::IsApplicationError`] is true
///
/// [`AIOProtocolError`] of kind [`InternalLogicError`](AIOProtocolErrorKind::InternalLogicError) if
/// - the [`ApplicationHybridLogicalClock`]'s counter would be incremented and overflow beyond [`u64::MAX`]
/// - the response has a [`UserProperty::Status`] of [`StatusCode::InternalServerError`], the [`UserProperty::IsApplicationError`] is false, and a [`UserProperty::InvalidPropertyName`] is provided
///
/// [`AIOProtocolError`] of kind [`StateInvalid`](AIOProtocolErrorKind::StateInvalid) if
/// - the [`ApplicationHybridLogicalClock`] or the received timestamp on the response is too far in the future
/// - the response has a [`UserProperty::Status`] of [`StatusCode::ServiceUnavailable`]
pub async fn invoke(
&self,
request: Request<TReq>,
) -> Result<Response<TResp>, AIOProtocolError> {
// Get the timeout duration to use
let command_timeout = request.timeout;
// Call invoke, wrapped within a timeout
let invoke_result = time::timeout(request.timeout, self.invoke_internal(request)).await;
// Return the timeout error or the result from the command invocation.
match invoke_result {
Ok(result) => match result {
Ok(response) => Ok(response),
Err(e) => Err(e),
},
Err(e) => {
log::error!(
"[{command_name}] Command invoke timed out after {command_timeout:?}",
command_name = self.command_name,
);
Err(AIOProtocolError::new_timeout_error(
false,
Some(Box::new(e)),
&self.command_name,
command_timeout,
None,
Some(self.command_name.clone()),
))
}
}
}
/// Subscribes to the response topic filter.
///
/// Returns `Ok()` on success, otherwise returns [`AIOProtocolError`].
/// # Errors
/// [`AIOProtocolError`] of kind [`ClientError`](AIOProtocolErrorKind::ClientError) if the subscribe fails or if the suback reason code doesn't indicate success.
async fn subscribe_to_response_filter(&self) -> Result<(), AIOProtocolError> {
let response_subscribe_topic = self.response_topic_pattern.as_subscribe_topic();
// Send subscribe
let subscribe_result = self
.mqtt_client
.subscribe(response_subscribe_topic, QoS::AtLeastOnce)
.await;
match subscribe_result {
Ok(suback) => {
// Wait for suback
match suback.await {
Ok(()) => { /* Success */ }
Err(e) => {
log::error!("[ERROR] suback error: {e}");
return Err(AIOProtocolError::new_mqtt_error(
Some("MQTT Error on command invoker suback".to_string()),
Box::new(e),
Some(self.command_name.clone()),
));
}
}
}
Err(e) => {
log::error!("[ERROR] client error while subscribing: {e}");
return Err(AIOProtocolError::new_mqtt_error(
Some("Client error on command invoker subscribe".to_string()),
Box::new(e),
Some(self.command_name.clone()),
));
}
}
Ok(())
}
async fn invoke_internal(
&self,
mut request: Request<TReq>,
) -> Result<Response<TResp>, AIOProtocolError> {
// Validate parameters. Custom user data, timeout, and payload serialization have already been validated in RequestBuilder
// Validate message expiry interval
let message_expiry_interval: u32 = match request.timeout.as_secs().try_into() {
Ok(val) => val,
Err(_) => {
// should be validated in RequestBuilder
unreachable!();
}
};
// Get request topic. Validates dynamic topic tokens
let request_topic = self
.request_topic_pattern
.as_publish_topic(&request.topic_tokens)
.map_err(|e| {
AIOProtocolError::config_invalid_from_topic_pattern_error(
e,
"request_topic_pattern",
)
})?;
// Get response topic. Validates dynamic topic tokens
let response_topic = self
.response_topic_pattern
.as_publish_topic(&request.topic_tokens)
.map_err(|e| {
AIOProtocolError::config_invalid_from_topic_pattern_error(
e,
"response_topic_pattern",
)
})?;
// Create correlation id
let correlation_id = Uuid::new_v4();
let correlation_data = Bytes::from(correlation_id.as_bytes().to_vec());
// Get updated timestamp
let timestamp_str = self.application_hlc.update_now()?;
// Add internal user properties
request.custom_user_data.push((
UserProperty::SourceId.to_string(),
self.mqtt_client.client_id().to_string(),
));
request
.custom_user_data
.push((UserProperty::Timestamp.to_string(), timestamp_str));
request.custom_user_data.push((
UserProperty::ProtocolVersion.to_string(),
RPC_COMMAND_PROTOCOL_VERSION.to_string(),
));
request.custom_user_data.push((
PARTITION_KEY.to_string(),
self.mqtt_client.client_id().to_string(),
));
// Create MQTT Properties
let publish_properties = PublishProperties {
correlation_data: Some(correlation_data.clone()),
response_topic: Some(response_topic),
payload_format_indicator: Some(request.serialized_payload.format_indicator as u8),
content_type: Some(request.serialized_payload.content_type.to_string()),
message_expiry_interval: Some(message_expiry_interval),
user_properties: request.custom_user_data,
topic_alias: None,
subscription_identifiers: Vec::new(),
};
// Subscribe to the response topic if we're not already subscribed and the invoker hasn't been shutdown
{
let mut invoker_state = self.invoker_state_mutex.lock().await;
match *invoker_state {
State::New => {
self.subscribe_to_response_filter().await?;
*invoker_state = State::Subscribed;
}
State::Subscribed => { /* No-op, already subscribed */ }
State::ShutdownInitiated | State::ShutdownSuccessful => {
return Err(AIOProtocolError::new_cancellation_error(
false,
None,
Some(
"Command Invoker has been shutdown and can no longer invoke commands"
.to_string(),
),
Some(self.command_name.clone()),
));
}
}
// Allow other concurrent invoke commands to acquire the invoker_state lock
}
// Create receiver for response
let mut response_rx = self.response_tx.subscribe();
// Send publish
let publish_result = self
.mqtt_client
.publish_with_properties(
request_topic,
QoS::AtLeastOnce,
false,
request.serialized_payload.payload,
publish_properties,
)
.await;
match publish_result {
Ok(publish_completion_token) => {
// Wait for and handle the puback
match publish_completion_token.await {
// if puback is Ok, continue and wait for the response
Ok(()) => {}
Err(e) => {
log::error!("[ERROR] puback error: {e}");
return Err(AIOProtocolError::new_mqtt_error(
Some("MQTT Error on command invoke puback".to_string()),
Box::new(e),
Some(self.command_name.clone()),
));
}
}
}
Err(e) => {
log::error!("[ERROR] client error while publishing: {e}");
return Err(AIOProtocolError::new_mqtt_error(
Some("Client error on command invoker request publish".to_string()),
Box::new(e),
Some(self.command_name.clone()),
));
}
}
// Wait for a response where the correlation id matches
loop {
// wait for incoming pub
match response_rx.recv().await {
Ok(rsp_pub) => {
if let Some(rsp_pub) = rsp_pub {
// check correlation id for match, otherwise loop again
if let Some(ref rsp_properties) = rsp_pub.properties {
if let Some(ref response_correlation_data) =
rsp_properties.correlation_data
{
if *response_correlation_data == correlation_data {
// This is implicit validation of the correlation data - if it's malformed it won't match the request
// This is the response for this request, validate and parse it and send it back to the application
return validate_and_parse_response(
&self.application_hlc,
self.command_name.clone(),
&rsp_pub.payload,
rsp_properties.clone(),
);
}
}
}
} else {
log::error!(
"Command Invoker has been shutdown and will no longer receive a response"
);
return Err(AIOProtocolError::new_cancellation_error(
false,
None,
Some(
"Command Invoker has been shutdown and will no longer receive a response"
.to_string(),
),
Some(self.command_name.clone()),
));
}
// If the publish doesn't have properties, correlation_data, or the correlation data doesn't match, keep waiting for the next one
}
Err(RecvError::Lagged(e)) => {
log::error!(
"[ERROR] Invoker response receiver lagged. Response may not be received: {e}"
);
// Keep waiting for response even though it may have gotten overwritten.
continue;
}
Err(RecvError::Closed) => {
log::error!(
"[ERROR] MQTT Receiver has been cleaned up and will no longer send a response"
);
return Err(AIOProtocolError::new_cancellation_error(
false,
None,
Some(
"MQTT Receiver has been cleaned up and will no longer send a response"
.to_string(),
),
Some(self.command_name.clone()),
));
}
}
}
}
async fn receive_response_loop(
mut mqtt_receiver: C::PubReceiver,
response_tx: Sender<Option<Publish>>,
shutdown_notifier: Arc<Notify>,
command_name: String,
) {
loop {
tokio::select! {
// on shutdown/drop, we will be notified so that we can stop receiving any more messages
// The loop will continue to receive any more publishes that are already in the queue
() = shutdown_notifier.notified() => {
mqtt_receiver.close();
log::info!("[{command_name}] MQTT Receiver closed");
},
recv_result = mqtt_receiver.recv_manual_ack() => {
if let Some((m, ack_token)) = recv_result {
// Send to pending command listeners
match response_tx.send(Some(m)) {
Ok(_) => { },
Err(e) => {
log::debug!("[{command_name}] Message ignored, no pending commands: {e}");
}
}
// Manually ack
if let Some(ack_token) = ack_token {
match ack_token.ack().await {
Ok(_) => { },
Err(e) => {
log::error!("[{command_name}] Error acking message: {e}");
}
}
}
} else {
// if this fails, it's just because there are no more pending commands, which is fine
_ = response_tx.send(None);
log::info!("[{command_name}] No more command responses will be received.");
break;
}
}
}
}
}
/// Shutdown the [`Invoker`]. Unsubscribes from the response topic and closes the
/// MQTT receiver to stop receiving messages.
///
/// Note: If this method is called, the [`Invoker`] should not be used again.
/// If the method returns an error, it may be called again to attempt the unsubscribe again.
///
/// Returns Ok(()) on success, otherwise returns [`AIOProtocolError`].
/// # Errors
/// [`AIOProtocolError`] of kind [`ClientError`](crate::common::aio_protocol_error::AIOProtocolErrorKind::ClientError) if the unsubscribe fails or if the unsuback reason code doesn't indicate success.
pub async fn shutdown(&self) -> Result<(), AIOProtocolError> {
// Notify the receiver loop to close the MQTT Receiver
self.shutdown_notifier.notify_one();
let mut invoker_state_mutex_guard = self.invoker_state_mutex.lock().await;
match *invoker_state_mutex_guard {
State::New | State::ShutdownSuccessful => {
/* If we didn't call subscribe or shutdown has already been called successfully, skip unsubscribing */
}
State::ShutdownInitiated | State::Subscribed => {
// if anything causes this to fail, we should still consider the invoker shutdown, but unsuccessfully, so that no more invocations can be made
*invoker_state_mutex_guard = State::ShutdownInitiated;
let unsubscribe_result = self
.mqtt_client
.unsubscribe(self.response_topic_pattern.as_subscribe_topic())
.await;
match unsubscribe_result {
Ok(unsub_completion_token) => {
match unsub_completion_token.await {
Ok(()) => { /* Success */ }
Err(e) => {
log::error!("[{}] Unsuback error: {e}", self.command_name);
return Err(AIOProtocolError::new_mqtt_error(
Some("MQTT error on command invoker unsuback".to_string()),
Box::new(e),
Some(self.command_name.clone()),
));
}
}
}
Err(e) => {
log::error!(
"[{}] Client error while unsubscribing: {e}",
self.command_name
);
return Err(AIOProtocolError::new_mqtt_error(
Some("Client error on command invoker unsubscribe".to_string()),
Box::new(e),
Some(self.command_name.clone()),
));
}
}
}
}
log::info!("[{}] Shutdown", self.command_name);
// If we successfully unsubscribed or did not need to, we can consider the invoker successfully shutdown
*invoker_state_mutex_guard = State::ShutdownSuccessful;
Ok(())
}
}
fn validate_and_parse_response<TResp: PayloadSerialize>(
application_hlc: &Arc<ApplicationHybridLogicalClock>,
command_name: String,
response_payload: &Bytes,
response_properties: PublishProperties,
) -> Result<Response<TResp>, AIOProtocolError> {
// Create a default response error so we can update details as we parse
let mut response_error = AIOProtocolError {
kind: AIOProtocolErrorKind::UnknownError, // should be overwritten
message: None, // should be overwritten
is_shallow: false, // this is always false here
is_remote: true, // this should be overwritten as needed
nested_error: None,
header_name: None,
header_value: None,
timeout_name: None,
timeout_value: None,
property_name: None,
property_value: None,
command_name: Some(command_name.clone()), // correct for all errors here
protocol_version: None,
supported_protocol_major_versions: None,
};
let mut is_application_error = false;
// parse user properties
let mut response_custom_user_data = vec![];
let mut status: Option<StatusCode> = None;
let mut invalid_property_name: Option<String> = None;
let mut invalid_property_value: Option<String> = None;
// unused beyond validation, but may be used in the future to determine how to handle other fields. Can be moved higher in the future if needed.
let mut response_protocol_version = DEFAULT_RPC_COMMAND_PROTOCOL_VERSION; // assume default version if none is provided
if let Some((_, protocol_version)) = response_properties
.user_properties
.iter()
.find(|(key, _)| UserProperty::from_str(key) == Ok(UserProperty::ProtocolVersion))
{
if let Some(response_version) = ProtocolVersion::parse_protocol_version(protocol_version) {
response_protocol_version = response_version;
} else {
return Err(AIOProtocolError::new_unsupported_version_error(
Some(format!(
"Received a response with an unparsable protocol version number: {protocol_version}"
)),
protocol_version.to_string(),
SUPPORTED_PROTOCOL_VERSIONS.to_vec(),
Some(command_name),
false,
false,
));
}
}
// Check that the version (or the default version if one isn't provided) is supported
if !response_protocol_version.is_supported(SUPPORTED_PROTOCOL_VERSIONS) {
return Err(AIOProtocolError::new_unsupported_version_error(
None,
response_protocol_version.to_string(),
SUPPORTED_PROTOCOL_VERSIONS.to_vec(),
Some(command_name),
false,
false,
));
}
let mut unknown_status_error: Option<AIOProtocolError> = None;
let mut timestamp = None;
for (key, value) in response_properties.user_properties {
match UserProperty::from_str(&key) {
Ok(UserProperty::Timestamp) => {
match HybridLogicalClock::from_str(&value) {
Ok(ts) => {
// Update application HLC against received __ts
if let Err(e) = application_hlc.update(&ts) {
let mut aio_error: AIOProtocolError = e.into();
// update error to include command name
aio_error.command_name = Some(command_name);
return Err(aio_error);
}
timestamp = Some(ts);
}
Err(e) => {
// update error to include more specific header name
let mut aio_error: AIOProtocolError = e.into();
aio_error.header_name = Some(key);
aio_error.command_name = Some(command_name);
return Err(aio_error);
}
}
}
Ok(UserProperty::Status) => {
// validate that status is one of valid values. Must be present
match StatusCode::from_str(&value) {
Ok(code) => {
status = Some(code);
}
Err(mut e) => {
e.command_name = Some(command_name.clone());
if e.kind == AIOProtocolErrorKind::UnknownError {
// if the error is that the status code isn't recognized, we want to include the status message before returning it to the application
unknown_status_error = Some(e);
} else {
// any other parsing errors can be returned immediately
return Err(e);
}
}
}
}
Ok(UserProperty::StatusMessage) => {
// Nothing to validate, but save info
response_error.message = Some(value);
}
Ok(UserProperty::IsApplicationError) => {
// Nothing to validate, but save info
// IsApplicationError is interpreted as false if the property is omitted, or has no value, or has a value that case-insensitively equals "false". Otherwise, the property is interpreted as true.
is_application_error = value.eq_ignore_ascii_case("true");
}
Ok(UserProperty::InvalidPropertyName) => {
// Nothing to validate, but save info
invalid_property_name = Some(value);
}
Ok(UserProperty::InvalidPropertyValue) => {
// Nothing to validate, but save info
invalid_property_value = Some(value);
}
Ok(UserProperty::ProtocolVersion) => {
// skip, already processed
}
Ok(UserProperty::RequestProtocolVersion) => {
// Nothing to validate, but save info
response_error.protocol_version = Some(value);
}
Ok(UserProperty::SupportedMajorVersions) => {
// Nothing to validate (any invalid entries will be skipped), but save info
response_error.supported_protocol_major_versions =
Some(parse_supported_protocol_major_versions(&value));
}
Ok(_) => {
// UserProperty::CommandInvokerId
// Don't return error, although these properties shouldn't be present on a response
log::warn!(
"Response should not contain MQTT user property '{key}'. Value is '{value}'",
);
response_custom_user_data.push((key, value));
}
Err(()) => {
response_custom_user_data.push((key, value));
}
}
}
// If status isn't one of the `StatusCode` enums, return an error
if let Some(mut e) = unknown_status_error {
if let Some(m) = response_error.message {
e.message = Some(m);
// if property name/value information was included, include it in the error returned
e.property_name = invalid_property_name;
e.property_value = invalid_property_value.map(Value::String);
}
return Err(e);
}
'block: {
// status is present
if let Some(status_code) = status {
// if status code isn't ok or no content, form `AIOProtocolError` about response
match status_code {
StatusCode::Ok => {
// Continue to form success Command Response
break 'block;
}
StatusCode::NoContent => {
// If status code is no content, an error will be returned if there is content
if response_payload.is_empty() {
// continue to form success Command Response
break 'block;
}
// If there is content, return an error
response_error.kind = AIOProtocolErrorKind::PayloadInvalid;
response_error.is_remote = false;
response_error.message =
Some("Status code 204 (No Content) should not have a payload".to_string());
}
StatusCode::BadRequest => {
if let Some(property_value) = invalid_property_value {
response_error.kind = AIOProtocolErrorKind::HeaderInvalid;
response_error.header_name = invalid_property_name;
response_error.header_value = Some(property_value);
} else if let Some(property_name) = invalid_property_name {
response_error.kind = AIOProtocolErrorKind::HeaderMissing;
response_error.header_name = Some(property_name);
} else {
response_error.kind = AIOProtocolErrorKind::PayloadInvalid;
}
}
StatusCode::RequestTimeout => {
response_error.kind = AIOProtocolErrorKind::Timeout;
response_error.timeout_name = invalid_property_name;
response_error.timeout_value =
invalid_property_value.and_then(|timeout| match timeout
.parse::<iso8601_duration::Duration>(
) {
Ok(val) => val.to_std(),
Err(_) => None,
});
}
StatusCode::UnsupportedMediaType => {
response_error.kind = AIOProtocolErrorKind::HeaderInvalid;
response_error.header_name = invalid_property_name;
response_error.header_value = invalid_property_value;
}
StatusCode::InternalServerError => {
response_error.property_value = invalid_property_value.map(Value::String);
response_error.property_name = invalid_property_name;
if is_application_error {
response_error.kind = AIOProtocolErrorKind::ExecutionException;
} else if response_error.property_name.is_some() {
response_error.kind = AIOProtocolErrorKind::InternalLogicError;
} else {
response_error.kind = AIOProtocolErrorKind::UnknownError;
// Should be None anyways, but clearing it just to be safe
response_error.property_value = None;
}
}
StatusCode::ServiceUnavailable => {
response_error.kind = AIOProtocolErrorKind::StateInvalid;
response_error.is_remote = true;
response_error.property_name = invalid_property_name;
response_error.property_value = invalid_property_value.map(Value::String);
}
StatusCode::VersionNotSupported => {
response_error.kind = AIOProtocolErrorKind::UnsupportedVersion;
}
}
response_error.ensure_error_message();
return Err(response_error);
}
// status is not present
return Err(AIOProtocolError::new_header_missing_error(
"__stat",
false,
Some(format!(
"Response missing MQTT user property '{}'",
UserProperty::Status
)),
Some(command_name),
));
}
// response payload deserialization
let format_indicator = match response_properties.payload_format_indicator.try_into() {
Ok(format_indicator) => format_indicator,
Err(e) => {
log::error!(
"Received invalid payload format indicator: {e}. This should not be possible to receive from the broker."
);
// Use default format indicator
FormatIndicator::default()
}
};
let deserialized_response_payload = match TResp::deserialize(
response_payload,
response_properties.content_type.as_ref(),
&format_indicator,
) {
Ok(payload) => payload,
Err(e) => match e {
DeserializationError::InvalidPayload(deserialization_e) => {
return Err(AIOProtocolError::new_payload_invalid_error(
false,
false,
Some(deserialization_e.into()),
None,
Some(command_name),
));
}
DeserializationError::UnsupportedContentType(message) => {
return Err(AIOProtocolError::new_header_invalid_error(
"Content Type",
&response_properties
.content_type
.unwrap_or("None".to_string()),
false,
Some(message),
Some(command_name),
));
}
},
};
Ok(Response {
payload: deserialized_response_payload,
content_type: response_properties.content_type,
format_indicator,
custom_user_data: response_custom_user_data,
timestamp,
})
}
impl<TReq, TResp, C> Drop for Invoker<TReq, TResp, C>
where
TReq: PayloadSerialize + 'static,
TResp: PayloadSerialize + 'static,
C: ManagedClient + Clone + Send + Sync + 'static,
C::PubReceiver: Send + Sync + 'static,
{
fn drop(&mut self) {
// drop can't be async, but we can spawn a task to unsubscribe
tokio::spawn({
let invoker_state_mutex = self.invoker_state_mutex.clone();
let unsubscribe_filter = self.response_topic_pattern.as_subscribe_topic();
let mqtt_client = self.mqtt_client.clone();
async move { drop_unsubscribe(mqtt_client, invoker_state_mutex, unsubscribe_filter).await }
});
// Notify the receiver loop to close the MQTT receiver
self.shutdown_notifier.notify_one();
log::info!("[{}] Invoker has been dropped", self.command_name);
}
}
async fn drop_unsubscribe<C: ManagedClient + Clone + Send + Sync + 'static>(
mqtt_client: C,
invoker_state_mutex: Arc<Mutex<State>>,
unsubscribe_filter: String,
) {
let mut invoker_state_mutex_guard = invoker_state_mutex.lock().await;
match *invoker_state_mutex_guard {
State::New | State::ShutdownSuccessful => {
/* If we didn't call subscribe or shutdown has already been called successfully, skip unsubscribing */
}
State::ShutdownInitiated | State::Subscribed => {
// if anything causes this to fail, we should still consider the invoker shutdown, but unsuccessfully, so that no more invocations can be made
*invoker_state_mutex_guard = State::ShutdownInitiated;
match mqtt_client.unsubscribe(unsubscribe_filter.clone()).await {
Ok(_) => {
log::debug!(
"Unsubscribe sent on topic {unsubscribe_filter}. Unsuback may still be pending."
);
}
Err(e) => {
log::error!("Unsubscribe error on topic {unsubscribe_filter}: {e}");
}
}
}
}
// If we successfully unsubscribed or did not need to, we can consider the invoker successfully shutdown
*invoker_state_mutex_guard = State::ShutdownSuccessful;
}
#[cfg(test)]
mod tests {
use test_case::test_case;
// TODO: This dependency on MqttConnectionSettingsBuilder should be removed in lieu of using a true mock
use azure_iot_operations_mqtt::MqttConnectionSettingsBuilder;
use azure_iot_operations_mqtt::session::{Session, SessionOptionsBuilder};
use super::*;
use crate::application::ApplicationContextBuilder;
use crate::common::{
aio_protocol_error::AIOProtocolErrorKind,
payload_serialize::{DESERIALIZE_MTX, FormatIndicator, MockPayload},
};
// TODO: This should return a mock ManagedClient instead.
// Until that's possible, need to return a Session so that the Session doesn't go out of
// scope and render the ManagedClient unable to to be used correctly.
fn create_session() -> Session {
let connection_settings = MqttConnectionSettingsBuilder::default()
.hostname("localhost")
.client_id("test_client")
.build()
.unwrap();
let session_options = SessionOptionsBuilder::default()
.connection_settings(connection_settings)
.build()
.unwrap();
Session::new(session_options).unwrap()
}
fn create_topic_tokens() -> HashMap<String, String> {
HashMap::from([
("commandName".to_string(), "test_command_name".to_string()),
("invokerClientId".to_string(), "test_client".to_string()),
])
}
#[tokio::test]
async fn test_new_defaults() {
let session = create_session();
let managed_client = session.create_managed_client();
let invoker_options = OptionsBuilder::default()
.request_topic_pattern("test/{commandName}/{executorId}/request")
.command_name("test_command_name")
.topic_token_map(create_topic_tokens())
.build()
.unwrap();
let invoker: Invoker<MockPayload, MockPayload, _> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
)
.unwrap();
assert_eq!(
invoker.response_topic_pattern.as_subscribe_topic(),
"clients/test_client/test/test_command_name/+/request"
);
}
#[tokio::test]
async fn test_new_override_defaults() {
let session = create_session();
let managed_client = session.create_managed_client();
let invoker_options = OptionsBuilder::default()
.request_topic_pattern("test/{commandName}/{executorId}/request")
.response_topic_pattern("test/{commandName}/{executorId}/response".to_string())
.command_name("test_command_name")
.topic_namespace("test_namespace".to_string())
.topic_token_map(create_topic_tokens())
.response_topic_prefix("custom/{invokerClientId}".to_string())
.response_topic_suffix("custom/response".to_string())
.build()
.unwrap();
let invoker: Invoker<MockPayload, MockPayload, _> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
)
.unwrap();
// prefix and suffix should be ignored if response_topic_pattern is provided
assert_eq!(
invoker.response_topic_pattern.as_subscribe_topic(),
"test_namespace/test/test_command_name/+/response"
);
}
#[test_case("command_name", ""; "new_empty_command_name")]
#[test_case("command_name", " "; "new_whitespace_command_name")]
#[test_case("request_topic_pattern", ""; "new_empty_request_topic_pattern")]
#[test_case("request_topic_pattern", " "; "new_whitespace_request_topic_pattern")]
#[test_case("response_topic_pattern", ""; "new_empty_response_topic_pattern")]
#[test_case("response_topic_pattern", " "; "new_whitespace_response_topic_pattern")]
#[test_case("response_topic_prefix", ""; "new_empty_response_topic_prefix")]
#[test_case("response_topic_prefix", " "; "new_whitespace_response_topic_prefix")]
#[test_case("response_topic_suffix", ""; "new_empty_response_topic_suffix")]
#[test_case("response_topic_suffix", " "; "new_whitespace_response_topic_suffix")]
#[tokio::test]
async fn test_new_empty_args(property_name: &str, property_value: &str) {
let session = create_session();
let managed_client = session.create_managed_client();
let mut command_name = "test_command_name".to_string();
let mut request_topic_pattern = "test/req/topic".to_string();
let mut response_topic_pattern = None;
let mut response_topic_prefix = "custom/prefix".to_string();
let mut response_topic_suffix = "custom/suffix".to_string();
let error_property_name;
let mut error_property_value = property_value.to_string();
match property_name {
"command_name" => {
command_name = property_value.to_string();
error_property_name = "command_name";
}
"request_topic_pattern" => {
request_topic_pattern = property_value.to_string();
error_property_name = "invoker_options.request_topic_pattern";
}
"response_topic_pattern" => {
response_topic_pattern = Some(property_value.to_string());
error_property_name = "response_topic_pattern";
}
"response_topic_prefix" => {
response_topic_prefix = property_value.to_string();
error_property_name = "response_topic_pattern";
error_property_value.push_str("/test/req/topic/custom/suffix");
}
"response_topic_suffix" => {
response_topic_suffix = property_value.to_string();
error_property_name = "response_topic_pattern";
error_property_value = "custom/prefix/test/req/topic/".to_string();
error_property_value.push_str(&response_topic_suffix);
}
_ => panic!("Invalid property_name"),
}
let invoker_options = OptionsBuilder::default()
.request_topic_pattern(request_topic_pattern)
.response_topic_pattern(response_topic_pattern)
.response_topic_prefix(response_topic_prefix)
.response_topic_suffix(response_topic_suffix)
.command_name(command_name)
.build()
.unwrap();
let invoker: Result<Invoker<MockPayload, MockPayload, _>, AIOProtocolError> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
);
match invoker {
Ok(_) => panic!("Expected error"),
Err(e) => {
assert_eq!(e.kind, AIOProtocolErrorKind::ConfigurationInvalid);
assert!(e.is_shallow);
assert!(!e.is_remote);
assert_eq!(e.property_name, Some(error_property_name.to_string()));
assert!(e.property_value == Some(Value::String(error_property_value.to_string())));
}
}
}
// Happy scenario tests for response topic prefix and suffix
// For a null response topic, valid provided and null prefixes and suffixes all are okay
#[test_case(Some("custom/prefix".to_string()), Some("custom/suffix".to_string()), "custom/prefix/test/req/topic/custom/suffix"; "new_response_topic_prefix_and_suffix")]
#[test_case(None, Some("custom/suffix".to_string()), "test/req/topic/custom/suffix"; "new_none_response_topic_prefix")]
#[test_case(Some("custom/prefix".to_string()), None, "custom/prefix/test/req/topic"; "new_none_response_topic_suffix")]
#[test_case(None, None, "clients/test_client/test/req/topic"; "new_none_response_topic_prefix_and_suffix")]
#[tokio::test]
async fn test_new_response_pattern_prefix_suffix_args(
response_topic_prefix: Option<String>,
response_topic_suffix: Option<String>,
expected_response_topic_subscribe_pattern: &str,
) {
let session = create_session();
let managed_client = session.create_managed_client();
let command_name = "test_command_name".to_string();
let request_topic_pattern = "test/req/topic".to_string();
let invoker_options = OptionsBuilder::default()
.request_topic_pattern(request_topic_pattern)
.command_name(command_name)
.response_topic_prefix(response_topic_prefix)
.response_topic_suffix(response_topic_suffix)
.build()
.unwrap();
let invoker: Result<Invoker<MockPayload, MockPayload, _>, AIOProtocolError> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
);
assert!(invoker.is_ok());
assert_eq!(
invoker.unwrap().response_topic_pattern.as_subscribe_topic(),
expected_response_topic_subscribe_pattern
);
}
// If response pattern prefix/suffix are not specified, the default response topic prefix is used
#[tokio::test]
async fn test_new_response_pattern_default_prefix() {
let session = create_session();
let managed_client = session.create_managed_client();
let command_name = "test_command_name";
let request_topic_pattern = "test/req/topic";
let invoker_options = OptionsBuilder::default()
.request_topic_pattern(request_topic_pattern)
.command_name(command_name)
.topic_token_map(create_topic_tokens())
.build()
.unwrap();
let invoker: Result<Invoker<MockPayload, MockPayload, _>, AIOProtocolError> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
);
assert!(invoker.is_ok());
assert_eq!(
invoker.unwrap().response_topic_pattern.as_subscribe_topic(),
"clients/test_client/test/req/topic"
);
}
// If response pattern suffix is specified, there is no prefix added
#[tokio::test]
async fn test_new_response_pattern_only_suffix() {
let session = create_session();
let managed_client = session.create_managed_client();
let command_name = "test_command_name";
let request_topic_pattern = "test/req/topic";
let response_topic_suffix = "custom/suffix";
let invoker_options = OptionsBuilder::default()
.request_topic_pattern(request_topic_pattern)
.command_name(command_name)
.topic_token_map(create_topic_tokens())
.response_topic_suffix(response_topic_suffix.to_string())
.build()
.unwrap();
let invoker: Result<Invoker<MockPayload, MockPayload, _>, AIOProtocolError> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
);
assert!(invoker.is_ok());
assert_eq!(
invoker.unwrap().response_topic_pattern.as_subscribe_topic(),
"test/req/topic/custom/suffix"
);
}
/// Tests success: Timeout specified on invoke and there is no error
#[tokio::test]
#[ignore] // test ignored because waiting for the suback hangs forever. Leaving the test for now until we have a full testing framework
async fn test_invoke_timeout_parameter() {
// Get mutexes for checking static PayloadSerialize calls
let _deserialize_mutex = DESERIALIZE_MTX.lock();
let session = create_session();
let managed_client = session.create_managed_client();
let invoker_options = OptionsBuilder::default()
.request_topic_pattern("test/req/topic")
.command_name("test_command_name")
.topic_token_map(create_topic_tokens())
.build()
.unwrap();
let invoker: Invoker<MockPayload, MockPayload, _> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
)
.unwrap();
let mut mock_request_payload = MockPayload::new();
mock_request_payload
.expect_serialize()
.returning(|| {
Ok(SerializedPayload {
payload: Vec::new(),
content_type: "application/json".to_string(),
format_indicator: FormatIndicator::Utf8EncodedCharacterData,
})
})
.times(1);
// TODO: Check for
// sub sent (suback received)?
// pub sent (puback received)
// pub received (puback sent)
// Mock context to track deserialize calls
let mock_payload_deserialize_ctx = MockPayload::deserialize_context();
// Deserialize should be called on the incoming response payload
mock_payload_deserialize_ctx
.expect()
.returning(|_, _, _| {
let mut mock_response_payload = MockPayload::default();
// The deserialized payload should be cloned to return to the application
mock_response_payload
.expect_clone()
.returning(MockPayload::default)
.times(1);
Ok(mock_response_payload)
})
.once();
// Mock invoker being subscribed already so we don't wait for suback
let mut invoker_state = invoker.invoker_state_mutex.lock().await;
*invoker_state = State::Subscribed;
drop(invoker_state);
let response = invoker
.invoke(
RequestBuilder::default()
.payload(mock_request_payload)
.unwrap()
.timeout(Duration::from_secs(5))
.build()
.unwrap(),
)
.await;
assert!(response.is_ok());
}
// Tests failure: Invocation times out (valid timeout value specified on invoke) and a `Timeout` error is returned
#[tokio::test]
async fn test_invoke_times_out() {
let session = create_session();
let managed_client = session.create_managed_client();
let invoker_options = OptionsBuilder::default()
.request_topic_pattern("test/req/topic")
.command_name("test_command_name")
.topic_token_map(create_topic_tokens())
.build()
.unwrap();
let invoker: Invoker<MockPayload, MockPayload, _> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
)
.unwrap();
let mut mock_request_payload = MockPayload::new();
mock_request_payload
.expect_serialize()
.returning(|| {
Ok(SerializedPayload {
payload: Vec::new(),
content_type: "application/json".to_string(),
format_indicator: FormatIndicator::Utf8EncodedCharacterData,
})
})
.times(1);
// TODO: Check for
// sub sent (suback received)
// pub sent (puback received)
// pub not received
let response = invoker
.invoke(
RequestBuilder::default()
.payload(mock_request_payload)
.unwrap()
.timeout(Duration::from_secs(1))
.build()
.unwrap(),
)
.await;
match response {
Ok(_) => panic!("Expected error"),
Err(e) => {
assert_eq!(e.kind, AIOProtocolErrorKind::Timeout);
assert!(!e.is_shallow);
assert!(!e.is_remote);
assert_eq!(e.timeout_name, Some("test_command_name".to_string()));
assert!(e.timeout_value == Some(Duration::from_secs(1)));
}
}
}
// Tests failure: Invocation times out (valid timeout value less than a second but not zero specified on invoke)
// and a `Timeout` error is returned
#[tokio::test]
async fn test_invoke_times_out_timeout_rounded() {
let session = create_session();
let managed_client = session.create_managed_client();
let invoker_options = OptionsBuilder::default()
.request_topic_pattern("test/req/topic")
.command_name("test_command_name")
.topic_token_map(create_topic_tokens())
.build()
.unwrap();
let invoker: Invoker<MockPayload, MockPayload, _> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
)
.unwrap();
let mut mock_request_payload = MockPayload::new();
mock_request_payload
.expect_serialize()
.returning(|| {
Ok(SerializedPayload {
payload: Vec::new(),
content_type: "application/json".to_string(),
format_indicator: FormatIndicator::Utf8EncodedCharacterData,
})
})
.times(1);
// TODO: Check for
// sub sent (suback received)
// pub sent (puback received)
// pub not received
let response = invoker
.invoke(
RequestBuilder::default()
.payload(mock_request_payload)
.unwrap()
.timeout(Duration::from_nanos(1))
.build()
.unwrap(),
)
.await;
match response {
Ok(_) => panic!("Expected error"),
Err(e) => {
assert_eq!(e.kind, AIOProtocolErrorKind::Timeout);
assert!(!e.is_shallow);
assert!(!e.is_remote);
assert_eq!(e.timeout_name, Some("test_command_name".to_string()));
assert!(e.timeout_value == Some(Duration::from_secs(1)));
}
}
}
#[tokio::test]
#[ignore] // test ignored because waiting for the suback hangs forever. Leaving the test for now until we have a full testing framework
async fn test_invoke_deserialize_error() {
// Get mutexes for checking static PayloadSerialize calls
let _deserialize_mutex = DESERIALIZE_MTX.lock();
let session = create_session();
let managed_client = session.create_managed_client();
let invoker_options = OptionsBuilder::default()
.request_topic_pattern("test/req/topic")
.command_name("test_command_name")
.topic_token_map(create_topic_tokens())
.build()
.unwrap();
let invoker: Invoker<MockPayload, MockPayload, _> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
)
.unwrap();
let mut mock_request_payload = MockPayload::new();
mock_request_payload
.expect_serialize()
.returning(|| {
Ok(SerializedPayload {
payload: Vec::new(),
content_type: "application/json".to_string(),
format_indicator: FormatIndicator::Utf8EncodedCharacterData,
})
})
.times(1);
// TODO: Check for
// sub sent (suback received)?
// pub sent (puback received)
// pub received (puback sent)
// Mock context to track deserialize calls
let mock_payload_deserialize_ctx = MockPayload::deserialize_context();
// Deserialize should be called on the incoming response payload
mock_payload_deserialize_ctx
.expect()
.returning(|_, _, _| {
Err(DeserializationError::InvalidPayload(
"dummy error".to_string(),
))
})
.once();
// Mock invoker being subscribed already so we don't wait for suback
let mut invoker_state = invoker.invoker_state_mutex.lock().await;
*invoker_state = State::Subscribed;
drop(invoker_state);
let response = invoker
.invoke(
RequestBuilder::default()
.payload(mock_request_payload)
.unwrap()
.timeout(Duration::from_millis(2))
.build()
.unwrap(),
)
.await;
match response {
Ok(_) => panic!("Expected error"),
Err(e) => {
assert_eq!(e.kind, AIOProtocolErrorKind::PayloadInvalid);
assert!(!e.is_shallow);
assert!(!e.is_remote);
assert!(e.nested_error.is_some());
}
}
}
#[tokio::test]
async fn test_invoke_executor_id_invalid_value() {
let session = create_session();
let managed_client = session.create_managed_client();
let invoker_options = OptionsBuilder::default()
.request_topic_pattern("test/req/{executorId}/topic")
.command_name("test_command_name")
.topic_token_map(create_topic_tokens())
.build()
.unwrap();
let invoker: Invoker<MockPayload, MockPayload, _> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
)
.unwrap();
let mut mock_request_payload = MockPayload::new();
mock_request_payload
.expect_serialize()
.returning(|| {
Ok(SerializedPayload {
payload: Vec::new(),
content_type: "application/json".to_string(),
format_indicator: FormatIndicator::Utf8EncodedCharacterData,
})
})
.times(1);
let response = invoker
.invoke(
RequestBuilder::default()
.payload(mock_request_payload)
.unwrap()
.timeout(Duration::from_secs(2))
.topic_tokens(HashMap::from([(
"executorId".to_string(),
"+++".to_string(),
)]))
.build()
.unwrap(),
)
.await;
match response {
Ok(_) => panic!("Expected error"),
Err(e) => {
assert_eq!(e.kind, AIOProtocolErrorKind::ConfigurationInvalid);
assert!(e.is_shallow);
assert!(!e.is_remote);
assert_eq!(e.property_name, Some("executorId".to_string()));
assert!(e.property_value == Some(Value::String("+++".to_string())));
}
}
}
#[tokio::test]
async fn test_invoke_missing_token() {
let session = create_session();
let managed_client = session.create_managed_client();
let invoker_options = OptionsBuilder::default()
.request_topic_pattern("test/req/{executorId}/topic")
.command_name("test_command_name")
.topic_token_map(create_topic_tokens())
.build()
.unwrap();
let invoker: Invoker<MockPayload, MockPayload, _> = Invoker::new(
ApplicationContextBuilder::default().build().unwrap(),
managed_client,
invoker_options,
)
.unwrap();
let mut mock_request_payload = MockPayload::new();
mock_request_payload
.expect_serialize()
.returning(|| {
Ok(SerializedPayload {
payload: Vec::new(),
content_type: "application/json".to_string(),
format_indicator: FormatIndicator::Utf8EncodedCharacterData,
})
})
.times(1);
let response = invoker
.invoke(
RequestBuilder::default()
.payload(mock_request_payload)
.unwrap()
.timeout(Duration::from_secs(2))
.topic_tokens(HashMap::new())
.build()
.unwrap(),
)
.await;
match response {
Ok(_) => panic!("Expected error"),
Err(e) => {
assert_eq!(e.kind, AIOProtocolErrorKind::ConfigurationInvalid);
assert!(e.is_shallow);
assert!(!e.is_remote);
assert_eq!(e.property_name, Some("executorId".to_string()));
assert_eq!(e.property_value, Some(Value::String(String::new())));
}
}
}
#[test]
fn test_request_serialization_error() {
let mut mock_request_payload = MockPayload::new();
mock_request_payload
.expect_serialize()
.returning(|| Err("dummy error".to_string()))
.times(1);
let mut binding = RequestBuilder::default();
let req_builder = binding.payload(mock_request_payload);
match req_builder {
Err(e) => {
assert_eq!(e.kind, AIOProtocolErrorKind::PayloadInvalid);
}
Ok(_) => {
panic!("Expected error");
}
}
}
#[test]
fn test_request_serialization_bad_content_type_error() {
let mut mock_request_payload = MockPayload::new();
mock_request_payload
.expect_serialize()
.returning(|| {
Ok(SerializedPayload {
payload: Vec::new(),
content_type: "application/json\u{0000}".to_string(),
format_indicator: FormatIndicator::Utf8EncodedCharacterData,
})
})
.times(1);
let mut binding = RequestBuilder::default();
let req_builder = binding.payload(mock_request_payload);
match req_builder {
Err(e) => {
assert_eq!(e.kind, AIOProtocolErrorKind::ConfigurationInvalid);
assert!(e.is_shallow);
assert!(!e.is_remote);
assert_eq!(e.property_name, Some("content_type".to_string()));
assert!(
e.property_value == Some(Value::String("application/json\u{0000}".to_string()))
);
}
Ok(_) => {
panic!("Expected error");
}
}
}
/// Tests failure: Timeout specified as 0 (invalid value) on invoke and an `ArgumentInvalid` error is returned
#[test_case(Duration::from_secs(0); "invoke_timeout_0")]
/// Tests failure: Timeout specified as > u32::max (invalid value) on invoke and an `ArgumentInvalid` error is returned
#[test_case(Duration::from_secs(u64::from(u32::MAX) + 1); "invoke_timeout_u32_max")]
fn test_request_timeout_invalid_value(timeout: Duration) {
let mut mock_request_payload = MockPayload::new();
mock_request_payload
.expect_serialize()
.returning(|| {
Ok(SerializedPayload {
payload: Vec::new(),
content_type: "application/json".to_string(),
format_indicator: FormatIndicator::Utf8EncodedCharacterData,
})
})
.times(1);
let request_builder_result = RequestBuilder::default()
.payload(mock_request_payload)
.unwrap()
.timeout(timeout)
.build();
assert!(request_builder_result.is_err());
}
}
// Command Request tests
// Test cases for subscribe
// Tests success:
// Subscribe is called on first invoke request and suback is received
// Subscribe is not called on subsequent invoke requests
// Subscribe fails on first invoke request, so subscribe is called again on second invoke request
// Tests failure:
// subscribe call fails (invalid filter or failure on sending outbound sub async) and an `ClientError` error is returned (first error scenario should not be possible with topic parsing checks)
// suback returns bad reason code and an `ClientError` error is returned
// Test cases for invoke create publish, publish, get puback
// Tests success:
// Publish is called on invoke request and puback is received
// custom user data property doesn't start with __ and is added to the publish properties
// invalid executor id when it's not in either topic pattern
// payload is successfully serialized
// invoker client id is correctly added to user properties on message
// Tests failure:
// x timeout is > u32::max (invalid value) and an `ArgumentInvalid` error is returned
// x custom user data property starts with __
// x custom user data property key or value is malformed utf-8
// x invalid executor id
// x payload fails serialization
// x serializer sets invalid content_type
// puback returns bad reason code and an `ClientError` error is returned
// publish call fails (invalid topic or failure on sending outbound pub async) and an `ClientError` error is returned (first error scenario should not be possible with topic parsing checks)
// Test cases for invoke receive
// Receive response loop
// Tests success:
// publish received on the correct topic, gets sent to pending command requests
// publish received on a different topic, message ignored
// publish received on the correct topic, no pending commands. Message ignored
// shutdown notifier is notified and the MQTT receiver is closed
// mqtt_receiver sends a lagged error
// mqtt_receiver sends a closed error
// Tests failure:
// should never fail
//
// validation
// Tests success:
// content type isn't present
// format indicator not present, 0, or (1 and TResp format indicator is 1)
// valid timestamp present and is returned on the Command Response
// no timestamp is present
// status is a number and is one of StatusCode's enum values
// in_application is interpreted as false if it is anything other than "true" and there are no errors parsing this
// custom user properties are correctly passed to the application.
// status code is no content and the payload is empty
// test matrix for different statuses and fields present for an error response - see possible return values from invoke for full list
// response payload deserializes successfully
// Tests failure:
// content type isn't supported. 'HeaderInvalid' error returned
// format indicator is 1 and TResp format indicator is 0. 'HeaderInvalid' error returned
// timestamp cannot be parsed (more or less than 3 sections, invalid section values for each of the three sections)
// status can't be parsed as a number
// status isn't one of StatusCode's enum values
// status is missing
// status code is no content, but the payload isn't empty
// failure deserializing response payload
//
// Wait for/match response
// Tests success:
// response with correct correlation_id received. Parsing begins
// response with incorrect correlation_id received. Message ignored
// response with missing properties received. Message ignored
// response with missing correlation data received. Message ignored
// response_rx returns lagged error. Error logged and continue waiting for the response
// Tests failure:
// response_rx returns closed error. Returns cancellation error