sdk: basic support for sending and stopping live location shares

[torrybr]

This MR introduces basic functionality for sending and stopping live location shares, as outlined in the Matrix Spec Proposal #3489. This foundational support allows users to share their live location, setting the stage for further enhancements.

Key Changes

• Live Location Start: Saving and sending an initial beacon_info state event.
• Live Location Stop: Stopping a users existing beacon_info state event from the state store.

These changes were adapted from a previous MR discussion, available for reference here.

Follow-up

Future MRs will expand on this initial implementation, using a layered approach to fully realize the functionality described in the spec above and align with ongoing community discussions.

This does not send any beacon message events. This MR simply introduces beacon_info support with the intention of follow on MRs to build on this basic functionality.

Signed-off-by: Torry Brelsford [email protected]

[codecov]

Codecov Report

Attention: Patch coverage is 79.31034% with 6 lines in your changes missing coverage. Please review.

Project coverage is 83.97%. Comparing base (925c5b2) to head (33f58dd).
Report is 34 commits behind head on main.

Files	Patch %	Lines
crates/matrix-sdk/src/room/mod.rs	82.60%	4 Missing ⚠️
crates/matrix-sdk/src/error.rs	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3741      +/-   ##
==========================================
- Coverage   84.02%   83.97%   -0.06%     
==========================================
  Files         260      260              
  Lines       26712    26725      +13     
==========================================
- Hits        22446    22441       -5     
- Misses       4266     4284      +18     

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

[andybalaam]

Thanks @torrybr please could you sign this off in the PR or commits?

Also it looks like there is a conflict to resolve. I'm happy for you to rebase and force push to resolve this.

In the meantime I will begin trying to understand this PR to review it.

[andybalaam]

I'm happy for you to rebase and force push to resolve this.

Or feel free to leave the merge commit if you prefer. It looks like we will want to squash at the end so either will be fine.

[andybalaam]

This is looking very nice! Just a few changes I am suggesting. @bnjbvr if you have time to do a quick check over, even better.

[andybalaam]

Is it worth having all this hard-coded JSON? Maybe just adding the beacon_info as we do in the previous test and then stopping it would be adequate.

[bnjbvr]

+1 to this. If we could inline the JSON here too, that'd be great.

[torrybr]

After calling room.start_live_location(), how do I resync so that the state store has the beacon_info I need to test? I'm looking for guidance on setting up the mock_sync without using &*LIVE_LOCATION_SHARING_SYNC. This will help me get the other tests in correct shape as well. Any examples would be very helpful! Below is simple example of what im trying to achieve

Updated the start_live_location_share to make use of inline JSON for the sync + check the store for correct saving. Let me know if this is the direction you were thinking and I will update the stop_live_location_test to be more comprehensive. Could I combine these into 1 test (start_and_stop_live_location_share or do you prefer they are separate?

[andybalaam]

Could I combine these into 1 test (start_and_stop_live_location_share or do you prefer they are separate?

I will always recommend separate tests, one for each thing you are testing. It makes it much easier to understand the test, and, critically for me, it makes it easier to see what has gone wrong if a test fails in future.

Feel free to share e.g. test setup code by putting it in a function or even a TestSetup struct if needed.

[torrybr]

Updated with comprehensive testing, I can take a second pass to try a TestSetup if desired

[bnjbvr]

Exciting!

[bnjbvr]

+1 to this. If we could inline the JSON here too, that'd be great.

[andybalaam]

Thanks @torrybr please could you sign this off in the PR or commits?

I don't see the full "Signed-off-by" line in the PR description. See https://github.com/matrix-org/matrix-rust-sdk/blob/main/CONTRIBUTING.md#sign-off and do ask if you have questions.

holidays

[andybalaam]

A couple more tiny comments, but looking good.

We also need sign-off in the description.

[torrybr]

Signed off and ready for final review 👍

[andybalaam]

Looks good! Thank you for all your work on this.