Stable stanza ID #4633

bartekgorny · 2026-01-27T16:05:20Z

This PR addresses the need for stable stanza ids by implementing XEP-0359.

When a user sends a message, we generate a unique id and store it in accumulator. That id is then used by message archive. Finally we attached a stanza-id element to the outgoing message so that the recipients (or all of them in case of MUC) use the same id.

mongoose-im · 2026-01-27T16:18:05Z

CircleCI results for 8ceaa0f

elasticsearch_and_cassandra_latest / elasticsearch_and_cassandra_mnesia / b447414
Status: 🟢 Passed
Reports root/ big
OK: 683 / Failed: 0 / User-skipped: 72 / Auto-skipped: 0

small_tests_latest / small_tests / b447414
Reports root / small

small_tests_legacy / small_tests / b447414
Reports root / small

small_tests_latest_arm64 / small_tests / b447414
Reports root / small

ldap_mnesia_legacy / ldap_mnesia / b447414
Status: 🟢 Passed
Reports root/ big
OK: 2396 / Failed: 0 / User-skipped: 1420 / Auto-skipped: 0

ldap_mnesia_latest / ldap_mnesia / b447414
Status: 🟢 Passed
Reports root/ big
OK: 2396 / Failed: 0 / User-skipped: 1420 / Auto-skipped: 0

internal_mnesia_latest / internal_mnesia / b447414
Status: 🟢 Passed
Reports root/ big
OK: 2544 / Failed: 0 / User-skipped: 1272 / Auto-skipped: 0

dynamic_domains_mysql_redis_latest / mysql_redis / b447414
Status: 🟢 Passed
Reports root/ big
OK: 5277 / Failed: 0 / User-skipped: 158 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_latest / pgsql_mnesia / b447414
Status: 🟢 Passed
Reports root/ big
OK: 5313 / Failed: 0 / User-skipped: 122 / Auto-skipped: 0

dynamic_domains_pgsql_mnesia_legacy / pgsql_mnesia / b447414
Status: 🟢 Passed
Reports root/ big
OK: 5313 / Failed: 0 / User-skipped: 122 / Auto-skipped: 0

pgsql_cets_latest / pgsql_cets / b447414
Status: 🟢 Passed
Reports root/ big
OK: 274 / Failed: 0 / User-skipped: 16 / Auto-skipped: 0

pgsql_mnesia_legacy / pgsql_mnesia / b447414
Status: 🟢 Passed
Reports root/ big
OK: 5706 / Failed: 0 / User-skipped: 142 / Auto-skipped: 0

cockroachdb_cets_latest / cockroachdb_cets / b447414
Status: 🟢 Passed
Reports root/ big
OK: 5402 / Failed: 0 / User-skipped: 203 / Auto-skipped: 0

pgsql_mnesia_latest / pgsql_mnesia / b447414
Status: 🟢 Passed
Reports root/ big
OK: 5706 / Failed: 0 / User-skipped: 142 / Auto-skipped: 0

mysql_redis_latest / mysql_redis / b447414
Status: 🟢 Passed
Reports root/ big
OK: 5698 / Failed: 0 / User-skipped: 150 / Auto-skipped: 0

codecov · 2026-01-27T16:18:20Z

Codecov Report

❌ Patch coverage is 92.50000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.03%. Comparing base (acf8d0e) to head (b447414).

Files with missing lines	Patch %	Lines
src/muc/mod_muc_room.erl	66.66%	2 Missing ⚠️
src/mod_stanzaid.erl	95.83%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4633      +/-   ##
==========================================
- Coverage   86.09%   86.03%   -0.06%     
==========================================
  Files         566      567       +1     
  Lines       33936    33968      +32     
==========================================
+ Hits        29216    29224       +8     
- Misses       4720     4744      +24

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot

Pull request overview

This PR implements XEP-0359 (Unique and Stable Stanza ID) to provide stable message IDs across the XMPP system. When a user sends a message, mod_stanzaid generates a unique ID and stores it in the accumulator. This ID is then used by the message archive (MAM) and attached as a stanza-id element to outgoing messages, ensuring all recipients see the same ID.

Changes:

Introduces mod_stanzaid module to generate and attach stable stanza IDs to messages
Updates MAM (PM and MUC) to use stable stanza IDs when available instead of generating new ones
Modifies MUC and MUC Light message routing to preserve and propagate stable stanza IDs through EventData
Adds comprehensive test coverage for PM, MUC, and MUC Light scenarios with and without MAM

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
src/mod_stanzaid.erl	New module implementing XEP-0359; generates IDs on send, adds stanza-id elements to messages
src/muc/mod_muc_room.erl	Updates routed_message record to include stable_stanza_id; extracts from accumulator and passes through routing
src/muc/mod_muc.erl	Adds optional stable_stanza_id field to room_event_data type definition
src/muc_light/mod_muc_light_codec_modern.erl	Retrieves stable_stanza_id from accumulator and includes in EventData
src/muc_light/mod_muc_light_codec_legacy.erl	Retrieves stable_stanza_id from accumulator and includes in EventData
src/mam/mod_mam_pm.erl	Uses stable_stanza_id when available; prevents overwriting with mam_id when stable ID is used
src/mam/mod_mam_muc.erl	Uses stable_stanza_id from EventData when available for MUC message archiving
doc/modules/mod_stanzaid.md	Documentation for the new module including configuration and MAM interaction notes
doc/modules/mod_mam.md	Updates noting that certain settings may be overridden by mod_stanzaid
doc/configuration/Modules.md	Adds mod_stanzaid to the modules list
big_tests/tests/mod_stanzaid_SUITE.erl	Comprehensive test suite covering PM, MUC, and MUC Light with and without MAM
big_tests/dynamic_domains.spec	Adds mod_stanzaid_SUITE to test spec
big_tests/default.spec	Adds mod_stanzaid_SUITE to test spec

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

big_tests/tests/mod_stanzaid_SUITE.erl

doc/configuration/Modules.md

src/muc_light/mod_muc_light_codec_legacy.erl

Copilot · 2026-01-30T14:40:53Z

src/mod_stanzaid.erl

+    has_stanza_id(Ch);
+has_stanza_id([]) ->
+    false;
+has_stanza_id([#xmlel{name = <<"stanza-id">>, attrs = #{<<"id">> := _,


The has_stanza_id function checks for the presence of a stanza-id element but doesn't verify the "by" attribute. According to XEP-0359, a stanza-id element must have both "id" and "by" attributes. The function should check for the "by" attribute to ensure it's a valid stanza-id element, preventing false positives from malformed elements.

Suggested change

has_stanza_id([#xmlel{name = <<"stanza-id">>, attrs = #{<<"id">> := _,

has_stanza_id([#xmlel{name = <<"stanza-id">>, attrs = #{<<"id">> := _,

<<"by">> := _,

Do we care?

big_tests/tests/mod_stanzaid_SUITE.erl

Copilot · 2026-01-30T14:40:54Z

doc/modules/mod_stanzaid.md

+Activating this module implicitly sets:
+
+`modules.mod_mam.pm.same_mam_id_for_peers = true`
+
+`modules.mod_mam.no_stanzaid_element = false`
+
+overriding any custom MAM settings.


The documentation states that activating mod_stanzaid implicitly sets modules.mod_mam.pm.same_mam_id_for_peers = true and modules.mod_mam.no_stanzaid_element = false, but there's no code in mod_stanzaid.erl that actually configures these settings. Either implement the configuration override mechanism or update the documentation to reflect that users must manually configure these MAM settings for proper integration with mod_stanzaid.

Suggested change

Activating this module implicitly sets:

`modules.mod_mam.pm.same_mam_id_for_peers = true`

`modules.mod_mam.no_stanzaid_element = false`

overriding any custom MAM settings.

For proper integration with [mod_mam](mod_mam.md), you should configure the following options:

`modules.mod_mam.pm.same_mam_id_for_peers = true`

`modules.mod_mam.no_stanzaid_element = false`

These options are not set automatically by `mod_stanzaid`; they must be configured explicitly in your MAM settings.

I don't think this one is a valid concern.

…addresses PR review made by AI, namely Copilot. Welcome to the future.

bartekgorny force-pushed the stable_stanza_id branch from 8ceaa0f to be18199 Compare January 28, 2026 10:01

bartekgorny marked this pull request as ready for review January 28, 2026 11:59

bartekgorny force-pushed the stable_stanza_id branch 2 times, most recently from 2075e45 to 5ffeb28 Compare January 29, 2026 09:27

bartekgorny marked this pull request as draft January 29, 2026 09:34

bartekgorny force-pushed the stable_stanza_id branch 2 times, most recently from bb7ae5d to f49cb84 Compare January 29, 2026 16:18

bartekgorny added 2 commits January 29, 2026 18:01

Stable stanza id

8de0eb3

Documentation for stable stanza id

64cc062

bartekgorny force-pushed the stable_stanza_id branch from f49cb84 to 64cc062 Compare January 29, 2026 17:01

bartekgorny marked this pull request as ready for review January 29, 2026 19:12

fen-pl requested a review from Copilot January 30, 2026 14:31

Copilot started reviewing on behalf of fen-pl January 30, 2026 14:31 View session

Copilot AI reviewed Jan 30, 2026

View reviewed changes

This commit is a historical landmark - it is the first one here that …

b447414

…addresses PR review made by AI, namely Copilot. Welcome to the future.

pawlooss1 self-requested a review February 3, 2026 09:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Stable stanza ID #4633

Stable stanza ID #4633

Uh oh!

bartekgorny commented Jan 27, 2026 •

edited

Loading

Uh oh!

mongoose-im commented Jan 27, 2026 •

edited

Loading

Uh oh!

codecov bot commented Jan 27, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

bartekgorny Feb 3, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 30, 2026

Uh oh!

bartekgorny Feb 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	has_stanza_id([#xmlel{name = <<"stanza-id">>, attrs = #{<<"id">> := _,
	has_stanza_id([#xmlel{name = <<"stanza-id">>, attrs = #{<<"id">> := _,
	<<"by">> := _,

Stable stanza ID #4633

Are you sure you want to change the base?

Stable stanza ID #4633

Uh oh!

Conversation

bartekgorny commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mongoose-im commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

bartekgorny Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

bartekgorny Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bartekgorny commented Jan 27, 2026 •

edited

Loading

mongoose-im commented Jan 27, 2026 •

edited

Loading

codecov bot commented Jan 27, 2026 •

edited

Loading