mirror of
https://github.com/esphome/esphome.git
synced 2026-09-09 22:38:48 +00:00
Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
455e1d6374 | ||
|
|
3af1d50bce | ||
|
|
842f354a05 | ||
|
|
af9b59d4bd | ||
|
|
55fc5a10de | ||
|
|
79927b918b | ||
|
|
1b070629bc |
@@ -345,11 +345,7 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
/// Returns false as soon as the TCP buffer is full. Marked nodiscard so we
|
/// Returns false as soon as the TCP buffer is full. Marked nodiscard so we
|
||||||
/// have no silent failures: every caller must handle (or log) a refusal.
|
/// have no silent failures: every caller must handle (or log) a refusal.
|
||||||
template<typename T> [[nodiscard]] bool send_message(const T &msg) {
|
template<typename T> [[nodiscard]] bool send_message(const T &msg) {
|
||||||
if constexpr (T::ESTIMATED_SIZE == 0) {
|
return this->send_message_(T::calc_size_msg(&msg), T::MESSAGE_TYPE, &T::encode_msg, &msg);
|
||||||
return this->send_message_(0, T::MESSAGE_TYPE, &encode_msg_noop, &msg);
|
|
||||||
} else {
|
|
||||||
return this->send_message_(msg.calculate_size(), T::MESSAGE_TYPE, &proto_encode_msg<T>, &msg);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Clear the shared write buffer and reserve space for the first message.
|
/// Clear the shared write buffer and reserve space for the first message.
|
||||||
@@ -405,16 +401,6 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
void process_state_subscriptions_();
|
void process_state_subscriptions_();
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// Size thunk — converts void* back to concrete type for direct calculate_size() call
|
|
||||||
template<typename T> static uint32_t calc_size(const void *msg) {
|
|
||||||
return static_cast<const T *>(msg)->calculate_size();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Shared no-op encode thunk for empty messages (ESTIMATED_SIZE == 0)
|
|
||||||
static uint8_t *encode_msg_noop(const void *, ProtoWriteBuffer &buf PROTO_ENCODE_DEBUG_PARAM) {
|
|
||||||
return buf.get_pos();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Non-template buffer management for send_message
|
// Non-template buffer management for send_message
|
||||||
bool send_message_(uint32_t payload_size, uint16_t message_type, MessageEncodeFn encode_fn, const void *msg);
|
bool send_message_(uint32_t payload_size, uint16_t message_type, MessageEncodeFn encode_fn, const void *msg);
|
||||||
|
|
||||||
@@ -433,11 +419,7 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
// Hot paths (state/info) go through fill_and_encode_entity_state/info instead.
|
// Hot paths (state/info) go through fill_and_encode_entity_state/info instead.
|
||||||
// batch_message_type_ is already set by dispatch_message_ before reaching here.
|
// batch_message_type_ is already set by dispatch_message_ before reaching here.
|
||||||
template<typename T> static uint16_t encode_message_to_buffer(T &msg, APIConnection *conn, uint32_t remaining_size) {
|
template<typename T> static uint16_t encode_message_to_buffer(T &msg, APIConnection *conn, uint32_t remaining_size) {
|
||||||
if constexpr (T::ESTIMATED_SIZE == 0) {
|
return encode_to_buffer_slow(T::calc_size_msg(&msg), &T::encode_msg, &msg, conn, remaining_size);
|
||||||
return encode_to_buffer_slow(0, &encode_msg_noop, &msg, conn, remaining_size);
|
|
||||||
} else {
|
|
||||||
return encode_to_buffer_slow(msg.calculate_size(), &proto_encode_msg<T>, &msg, conn, remaining_size);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Non-template core — fills state fields and encodes
|
// Non-template core — fills state fields and encodes
|
||||||
@@ -449,7 +431,7 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
template<typename T>
|
template<typename T>
|
||||||
static uint16_t fill_and_encode_entity_state(EntityBase *entity, T &msg, APIConnection *conn,
|
static uint16_t fill_and_encode_entity_state(EntityBase *entity, T &msg, APIConnection *conn,
|
||||||
uint32_t remaining_size) {
|
uint32_t remaining_size) {
|
||||||
return fill_and_encode_entity_state(entity, msg, &calc_size<T>, &proto_encode_msg<T>, conn, remaining_size);
|
return fill_and_encode_entity_state(entity, msg, &T::calc_size_msg, &T::encode_msg, conn, remaining_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Non-template core — fills info fields, allocates buffers, and encodes
|
// Non-template core — fills info fields, allocates buffers, and encodes
|
||||||
@@ -461,7 +443,7 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
template<typename T>
|
template<typename T>
|
||||||
static uint16_t fill_and_encode_entity_info(EntityBase *entity, T &msg, APIConnection *conn,
|
static uint16_t fill_and_encode_entity_info(EntityBase *entity, T &msg, APIConnection *conn,
|
||||||
uint32_t remaining_size) {
|
uint32_t remaining_size) {
|
||||||
return fill_and_encode_entity_info(entity, msg, &calc_size<T>, &proto_encode_msg<T>, conn, remaining_size);
|
return fill_and_encode_entity_info(entity, msg, &T::calc_size_msg, &T::encode_msg, conn, remaining_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Non-template core — fills device_class, then delegates to fill_and_encode_entity_info
|
// Non-template core — fills device_class, then delegates to fill_and_encode_entity_info
|
||||||
@@ -475,8 +457,8 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
static uint16_t fill_and_encode_entity_info_with_device_class(EntityBase *entity, T &msg,
|
static uint16_t fill_and_encode_entity_info_with_device_class(EntityBase *entity, T &msg,
|
||||||
StringRef &device_class_field, APIConnection *conn,
|
StringRef &device_class_field, APIConnection *conn,
|
||||||
uint32_t remaining_size) {
|
uint32_t remaining_size) {
|
||||||
return fill_and_encode_entity_info_with_device_class(entity, msg, device_class_field, &calc_size<T>,
|
return fill_and_encode_entity_info_with_device_class(entity, msg, device_class_field, &T::calc_size_msg,
|
||||||
&proto_encode_msg<T>, conn, remaining_size);
|
&T::encode_msg, conn, remaining_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
#ifdef USE_VOICE_ASSISTANT
|
#ifdef USE_VOICE_ASSISTANT
|
||||||
|
|||||||
+1526
-1306
File diff suppressed because it is too large
Load Diff
+594
-198
File diff suppressed because it is too large
Load Diff
@@ -692,11 +692,12 @@ class DumpBuffer {
|
|||||||
|
|
||||||
class ProtoMessage {
|
class ProtoMessage {
|
||||||
public:
|
public:
|
||||||
// Non-virtual defaults for messages with no fields.
|
// Non-virtual defaults for messages with no fields; generated classes hide all four. The
|
||||||
// Concrete message classes hide these with their own implementations.
|
// static encode_msg/calc_size_msg take const void * so &T::encode_msg needs no thunk.
|
||||||
// All call sites use templates to preserve the concrete type, so virtual
|
static uint8_t *encode_msg(const void *self, ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) {
|
||||||
// dispatch is not needed. This eliminates per-message vtable entries for
|
return buffer.get_pos();
|
||||||
// encode/calculate_size, saving ~1.3 KB of flash across all message types.
|
}
|
||||||
|
static uint32_t calc_size_msg(const void *self) { return 0; }
|
||||||
uint8_t *encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const { return buffer.get_pos(); }
|
uint8_t *encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const { return buffer.get_pos(); }
|
||||||
uint32_t calculate_size() const { return 0; }
|
uint32_t calculate_size() const { return 0; }
|
||||||
#ifdef HAS_PROTO_MESSAGE_DUMP
|
#ifdef HAS_PROTO_MESSAGE_DUMP
|
||||||
@@ -944,19 +945,14 @@ class ProtoSize {
|
|||||||
|
|
||||||
// Implementation of methods that depend on ProtoSize being fully defined
|
// Implementation of methods that depend on ProtoSize being fully defined
|
||||||
|
|
||||||
// Encode thunk — converts void* back to concrete type for direct encode() call
|
|
||||||
template<typename T> uint8_t *proto_encode_msg(const void *msg, ProtoWriteBuffer &buf PROTO_ENCODE_DEBUG_PARAM) {
|
|
||||||
return static_cast<const T *>(msg)->encode(buf PROTO_ENCODE_DEBUG_ARG);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Thin template wrapper; delegates to non-template core in proto.cpp.
|
// Thin template wrapper; delegates to non-template core in proto.cpp.
|
||||||
template<typename T> inline void ProtoWriteBuffer::encode_sub_message(uint32_t field_id, const T &value) {
|
template<typename T> inline void ProtoWriteBuffer::encode_sub_message(uint32_t field_id, const T &value) {
|
||||||
this->encode_sub_message(field_id, &value, &proto_encode_msg<T>);
|
this->encode_sub_message(field_id, &value, &T::encode_msg);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Thin template wrapper; delegates to non-template core.
|
// Thin template wrapper; delegates to non-template core.
|
||||||
template<typename T> inline void ProtoWriteBuffer::encode_optional_sub_message(uint32_t field_id, const T &value) {
|
template<typename T> inline void ProtoWriteBuffer::encode_optional_sub_message(uint32_t field_id, const T &value) {
|
||||||
this->encode_optional_sub_message(field_id, value.calculate_size(), &value, &proto_encode_msg<T>);
|
this->encode_optional_sub_message(field_id, T::calc_size_msg(&value), &value, &T::encode_msg);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Template decode_to_message - preserves concrete type so decode() resolves statically
|
// Template decode_to_message - preserves concrete type so decode() resolves statically
|
||||||
|
|||||||
@@ -2841,28 +2841,36 @@ def build_message_type(
|
|||||||
)
|
)
|
||||||
for line in encode
|
for line in encode
|
||||||
]
|
]
|
||||||
o = f"{speed_attr}uint8_t *{desc.name}::encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const {{\n"
|
o = f"{speed_attr}uint8_t *{desc.name}::encode_msg(const void *self, ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) {{\n"
|
||||||
|
o += f" const auto &msg = *static_cast<const {desc.name} *>(self);\n"
|
||||||
o += " uint8_t *__restrict__ pos = buffer.get_pos();\n"
|
o += " uint8_t *__restrict__ pos = buffer.get_pos();\n"
|
||||||
o += indent("\n".join(encode_debug)) + "\n"
|
o += indent("\n".join(encode_debug)).replace("this->", "msg.") + "\n"
|
||||||
o += " return pos;\n"
|
o += " return pos;\n"
|
||||||
o += "}\n"
|
o += "}\n"
|
||||||
cpp += o
|
cpp += o
|
||||||
prot = (
|
public_content.append(
|
||||||
"uint8_t *encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const;"
|
"static uint8_t *encode_msg(const void *self, ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM);"
|
||||||
|
)
|
||||||
|
public_content.append(
|
||||||
|
"uint8_t *encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const {\n"
|
||||||
|
" return encode_msg(this, buffer PROTO_ENCODE_DEBUG_ARG);\n"
|
||||||
|
"}"
|
||||||
)
|
)
|
||||||
public_content.append(prot)
|
|
||||||
# If no fields to encode or message doesn't need encoding, the default implementation in ProtoMessage will be used
|
# If no fields to encode or message doesn't need encoding, the default implementation in ProtoMessage will be used
|
||||||
|
|
||||||
# Add calculate_size method only if this message needs encoding and has fields
|
# Add calculate_size method only if this message needs encoding and has fields
|
||||||
if needs_encode and size_calc and not is_inline_only:
|
if needs_encode and size_calc and not is_inline_only:
|
||||||
o = f"{speed_attr}uint32_t {desc.name}::calculate_size() const {{\n"
|
o = f"{speed_attr}uint32_t {desc.name}::calc_size_msg(const void *self) {{\n"
|
||||||
|
o += f" const auto &msg = *static_cast<const {desc.name} *>(self);\n"
|
||||||
o += " uint32_t size = 0;\n"
|
o += " uint32_t size = 0;\n"
|
||||||
o += indent("\n".join(size_calc)) + "\n"
|
o += indent("\n".join(size_calc)).replace("this->", "msg.") + "\n"
|
||||||
o += " return size;\n"
|
o += " return size;\n"
|
||||||
o += "}\n"
|
o += "}\n"
|
||||||
cpp += o
|
cpp += o
|
||||||
prot = "uint32_t calculate_size() const;"
|
public_content.append("static uint32_t calc_size_msg(const void *self);")
|
||||||
public_content.append(prot)
|
public_content.append(
|
||||||
|
"uint32_t calculate_size() const { return calc_size_msg(this); }"
|
||||||
|
)
|
||||||
# If no fields to calculate size for or message doesn't need encoding, the default implementation in ProtoMessage will be used
|
# If no fields to calculate size for or message doesn't need encoding, the default implementation in ProtoMessage will be used
|
||||||
|
|
||||||
# dump_to method declaration in header
|
# dump_to method declaration in header
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
esphome:
|
||||||
|
name: api-empty-message-test
|
||||||
|
host:
|
||||||
|
api:
|
||||||
|
logger:
|
||||||
|
level: DEBUG
|
||||||
|
|
||||||
|
switch:
|
||||||
|
- platform: template
|
||||||
|
name: "Empty Message Switch"
|
||||||
|
optimistic: true
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
"""Messages without fields go through the shared ProtoMessage entry points on both directions."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from aioesphomeapi import api_pb2
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from .raw_api_client import MESSAGE_TYPE_OF, RawApiClient
|
||||||
|
from .types import RunCompiledFunction
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_api_empty_message_roundtrip(
|
||||||
|
yaml_config: str,
|
||||||
|
run_compiled: RunCompiledFunction,
|
||||||
|
unused_tcp_port: int,
|
||||||
|
) -> None:
|
||||||
|
async with run_compiled(yaml_config), RawApiClient(unused_tcp_port) as client:
|
||||||
|
await client.connect()
|
||||||
|
|
||||||
|
# Field free request and reply on the plain send path
|
||||||
|
await client.send_message(api_pb2.PingRequest())
|
||||||
|
await client.read_until_frame(MESSAGE_TYPE_OF[api_pb2.PingResponse])
|
||||||
|
|
||||||
|
# Field free request answered by a message with fields, and a list that ends with
|
||||||
|
# the field free ListEntitiesDoneResponse through the batching path
|
||||||
|
await client.send_message(api_pb2.DeviceInfoRequest())
|
||||||
|
await client.read_until_frame(MESSAGE_TYPE_OF[api_pb2.DeviceInfoResponse])
|
||||||
|
await client.send_message(api_pb2.ListEntitiesRequest())
|
||||||
|
await client.read_until_frame(MESSAGE_TYPE_OF[api_pb2.ListEntitiesDoneResponse])
|
||||||
|
assert (
|
||||||
|
client.frame_counts[MESSAGE_TYPE_OF[api_pb2.ListEntitiesSwitchResponse]]
|
||||||
|
== 1
|
||||||
|
)
|
||||||
|
|
||||||
|
await client.send_message(api_pb2.DisconnectRequest())
|
||||||
|
await client.read_until_frame(MESSAGE_TYPE_OF[api_pb2.DisconnectResponse])
|
||||||
@@ -194,17 +194,17 @@ def test_superseded_device_info_fields_still_declared_in_header() -> None:
|
|||||||
|
|
||||||
def test_superseded_device_info_fields_still_encoded_and_sized() -> None:
|
def test_superseded_device_info_fields_still_encoded_and_sized() -> None:
|
||||||
"""Each superseded field must still be touched by DeviceInfoResponse's
|
"""Each superseded field must still be touched by DeviceInfoResponse's
|
||||||
generated encode() and calculate_size(), i.e. it is still put on the wire.
|
generated encode_msg() and calc_size_msg(), i.e. it is still put on the wire.
|
||||||
"""
|
"""
|
||||||
encode_body = _extract_function_body(CPP_TEXT, "DeviceInfoResponse::encode")
|
encode_body = _extract_function_body(CPP_TEXT, "DeviceInfoResponse::encode_msg")
|
||||||
size_body = _extract_function_body(CPP_TEXT, "DeviceInfoResponse::calculate_size")
|
size_body = _extract_function_body(CPP_TEXT, "DeviceInfoResponse::calc_size_msg")
|
||||||
for field_name in SUPERSEDED_FIELDS:
|
for field_name in SUPERSEDED_FIELDS:
|
||||||
assert f"this->{field_name}" in encode_body, (
|
assert f"msg.{field_name}" in encode_body, (
|
||||||
f"DeviceInfoResponse::encode() no longer references {field_name}. "
|
f"DeviceInfoResponse::encode_msg() no longer references {field_name}. "
|
||||||
f"{DEPRECATED_FIELD_TRAP}"
|
f"{DEPRECATED_FIELD_TRAP}"
|
||||||
)
|
)
|
||||||
assert f"this->{field_name}" in size_body, (
|
assert f"msg.{field_name}" in size_body, (
|
||||||
f"DeviceInfoResponse::calculate_size() no longer references "
|
f"DeviceInfoResponse::calc_size_msg() no longer references "
|
||||||
f"{field_name}. {DEPRECATED_FIELD_TRAP}"
|
f"{field_name}. {DEPRECATED_FIELD_TRAP}"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user