Skip to content

chore(protocol): bump submodule to v1.46.4 (DebugMessage) and regenerate stubs#689

Open
toubatbrian wants to merge 6 commits into
mainfrom
brian/custom-event-proto
Open

chore(protocol): bump submodule to v1.46.4 (DebugMessage) and regenerate stubs#689
toubatbrian wants to merge 6 commits into
mainfrom
brian/custom-event-proto

Conversation

@toubatbrian
Copy link
Copy Markdown

@toubatbrian toubatbrian commented May 26, 2026

Summary

Bumps the livekit-protocol/protocol submodule pointer to v1.46.4 and the package version to 1.1.10 so the next livekit-protocol PyPI release ships:

  • AgentSessionEvent.debug_message (field 21) — replaces the never-shipped custom_event from v1.46.3
  • DebugMessage (Struct payload, no type field) — replaces CustomEvent

The build-protocol.yml bot regenerates livekit-protocol/livekit/protocol/agent_pb/agent_session* against the new pointer.

Why a new release

livekit-protocol==1.1.9 (current PyPI) was tagged before livekit/protocol#1593 (the DebugMessage rename) merged, so it ships the now-removed CustomEvent symbol. Downstream consumers (livekit/agents#5855) need DebugMessage to land their refactor.

Test plan

  • Submodule pointer matches v1.46.4 tag (4b09446)
  • Bot regenerates livekit/protocol/agent_pb/agent_session.pyiDebugMessage symbol present, CustomEvent symbol absent
  • Once merged + published, livekit/agents#5855 will pin >=1.1.10

Submodule livekit-protocol/protocol: 0bb4e41 -> b89c3a7 (v1.46.3).

Notable additions picked up in the regen:
- agent_session: CustomEvent message + AgentSessionEvent.custom_event
  field (livekit/protocol#1588).
- analytics: FeatureUsageInfo.KRISP_VIVA enum value.
- room: RoomParticipantIdentity.revoke_token_ts field.
- sip: CreateSIPParticipantRequest.{sip_request_uri,sip_to_header,
  sip_from_header} fields.

Generated with protoc 25.1 to match build-protocol.yml.
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

toubatbrian and others added 2 commits May 26, 2026 19:18
The previous commit (3c7bae2) hand-regenerated the .py/.pyi stubs but
never staged the submodule pointer bump itself. The build-protocol.yml
bot then re-ran generate_proto.sh against the still-recorded 0bb4e41
submodule and overwrote my CustomEvent stubs (because they didn't
match the actually-committed submodule state). Bot was right; my
commit was internally inconsistent.

Bump the submodule pointer for real (0bb4e41 -> b89c3a7, v1.46.3) so
the bot's next regen produces stubs that actually include
AgentSessionEvent.custom_event + CustomEvent.

Co-authored-by: Cursor <cursoragent@cursor.com>
…9 -> 1.1.10

Picks up livekit/protocol#1593 which renames
AgentSessionEvent.custom_event (field 21) -> AgentSessionEvent.debug_message
and renames CustomEvent -> DebugMessage (drops the `type` field; payload
only). Field number is unchanged.

Bot will regenerate the Python stubs against the new submodule pointer.

Co-authored-by: Cursor <cursoragent@cursor.com>
@toubatbrian toubatbrian changed the title chore(protocol): bump submodule to v1.46.3 and regenerate stubs chore(protocol): bump submodule to v1.46.4 (DebugMessage) and regenerate stubs May 27, 2026
toubatbrian added a commit to livekit/agents that referenced this pull request May 27, 2026
…_emit_debug_message

Picks up livekit/protocol#1593 which renamed the agent-session event
before any consumer shipped it. The message is repositioned as an
internal debug/trace channel surfaced only to the debugger/recorder
(e.g. agents-cli), not to user code.

Proto change (mechanical rename):
- AgentSessionEvent.custom_event -> AgentSessionEvent.debug_message (field 21)
- agent_pb.CustomEvent (str type, Struct payload) -> agent_pb.DebugMessage (Struct payload)

Surface change:
- AgentSession.emit_custom_event(event_type, payload) ->
  AgentSession._emit_debug_message(payload)
  - underscore prefix + `:meta private:` docstring marker signal: not for user code
  - type discriminator dropped; callers just emit a JSON payload
- EventTypes literal "custom_event" -> "debug_message"
- SessionHost._on_custom_event -> _on_debug_message

Pin bump: `livekit-protocol>=1.1.9` -> `>=1.1.10` to pick up DebugMessage.
(CI type-check is blocked until livekit/python-sdks#689 merges and a new
livekit-protocol release is cut to PyPI.)

Drive-by deslop on the helper body:
- `from google.protobuf...` imports lifted to module scope (avoids the
  no-inline-imports convention warning).
- Dropped the defensive `if payload:` + `dict(payload)` cast and the
  `ignore_unknown_fields=True` kwarg (Struct fields aren't user fields).
- Trimmed the 12-line docstring + 3-line inline comment down to the one
  non-obvious line that documents *why* we use `super().emit`.

ruff check + ruff format --check clean.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants