Skip to content

Set tracing spans for rust client operations #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
richvdh merged 1 commit into from
Aug 7, 2026
Merged

Set tracing spans for rust client operations #264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 66 additions & 1 deletion internal/api/rust/rust.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ type RustRoomInfo struct {
}

type RustClient struct {
// A logging span specific to this client instance; name includes the user ID and device ID.
FFISpan *matrix_sdk_ffi.Span

FFIClient *matrix_sdk_ffi.Client
syncService *matrix_sdk_ffi.SyncService
roomsListener *RoomsListener
Expand All @@ -85,7 +88,12 @@ type RustClient struct {

func NewRustClient(t ct.TestLike, opts api.ClientCreationOpts) (api.Client, error) {
t.Logf("NewRustClient[%s][%s] creating...", opts.UserID, opts.DeviceID)
matrix_sdk_ffi.LogEvent("rust.go", &zero, matrix_sdk_ffi.LogLevelInfo, t.Name(), fmt.Sprintf("NewRustClient[%s][%s] creating...", opts.UserID, opts.DeviceID))

span := matrix_sdk_ffi.NewSpan("rust.go", &zero, matrix_sdk_ffi.LogLevelInfo, LogTarget, fmt.Sprintf("CC[%s][%s]", opts.UserID, opts.DeviceID), nil)
span.Enter()
defer span.Exit()

matrix_sdk_ffi.LogEvent("rust.go", &zero, matrix_sdk_ffi.LogLevelInfo, LogTarget+"::"+t.Name(), fmt.Sprintf("NewRustClient[%s][%s] creating...", opts.UserID, opts.DeviceID))
slidingSyncVersion := matrix_sdk_ffi.SlidingSyncVersionBuilderNative
clientSessionDelegate := NewMemoryClientSessionDelegate()
ab := matrix_sdk_ffi.NewClientBuilder().
Expand Down Expand Up @@ -113,6 +121,7 @@ func NewRustClient(t ct.TestLike, opts api.ClientCreationOpts) (api.Client, erro
return nil, fmt.Errorf("ClientBuilder.Build failed: %s", err)
}
c := &RustClient{
FFISpan: span,
userID: opts.UserID,
FFIClient: client,
roomsListener: NewRoomsListener(),
Expand Down Expand Up @@ -161,6 +170,9 @@ func (c *RustClient) Opts() api.ClientCreationOpts {
}

func (c *RustClient) GetNotification(t ct.TestLike, roomID, eventID string) (*api.Notification, error) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

if c.notifClient == nil {
var err error
c.Logf(t, "creating NotificationClient")
Expand Down Expand Up @@ -218,6 +230,9 @@ func (c *RustClient) GetNotification(t ct.TestLike, roomID, eventID string) (*ap
}

func (c *RustClient) Login(t ct.TestLike, opts api.ClientCreationOpts) error {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

var deviceID *string
if opts.DeviceID != "" {
deviceID = &opts.DeviceID
Expand All @@ -234,6 +249,9 @@ func (c *RustClient) Login(t ct.TestLike, opts api.ClientCreationOpts) error {
}

func (c *RustClient) CurrentAccessToken(t ct.TestLike) string {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

s, err := c.FFIClient.Session()
if err != nil {
ct.Fatalf(t, "error retrieving session: %s", err)
Expand All @@ -246,6 +264,9 @@ func (c *RustClient) ListenForVerificationRequests(t ct.TestLike) chan api.Verif
}

func (c *RustClient) RequestOwnUserVerification(t ct.TestLike) chan api.VerificationStage {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

svc, err := c.FFIClient.GetSessionVerificationController()
if err != nil {
ct.Fatalf(t, "GetSessionVerificationController: %s", err)
Expand Down Expand Up @@ -307,6 +328,9 @@ func (c *RustClient) RequestOwnUserVerification(t ct.TestLike) chan api.Verifica
}

func (c *RustClient) DeletePersistentStorage(t ct.TestLike) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
if c.persistentStoragePath != "" {
err := os.RemoveAll(c.persistentStoragePath)
Expand All @@ -316,11 +340,17 @@ func (c *RustClient) DeletePersistentStorage(t ct.TestLike) {
}
}
func (c *RustClient) ForceClose(t ct.TestLike) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
t.Fatalf("Cannot force close a rust client, use an RPC client instead.")
}

func (c *RustClient) Close(t ct.TestLike) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
c.closed.Store(true)
c.roomsMu.Lock()
Expand Down Expand Up @@ -348,6 +378,9 @@ func (c *RustClient) Close(t ct.TestLike) {
}

func (c *RustClient) GetEvent(t ct.TestLike, roomID, eventID string) (*api.Event, error) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
_, ui_timeline := c.findRoom(t, roomID)
timelineItem, err := ui_timeline.GetEventTimelineItemByEventId(eventID)
Expand All @@ -362,6 +395,9 @@ func (c *RustClient) GetEvent(t ct.TestLike, roomID, eventID string) (*api.Event
}

func (c *RustClient) GetEventShield(t ct.TestLike, roomID, eventID string) (*api.EventShield, error) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
_, uiTimeline := c.findRoom(t, roomID)
timelineItem, err := uiTimeline.GetEventTimelineItemByEventId(eventID)
Expand Down Expand Up @@ -418,6 +454,9 @@ func (c *RustClient) GetEventShield(t ct.TestLike, roomID, eventID string) (*api
// StartSyncing to begin syncing from sync v2 / sliding sync.
// Tests should call stopSyncing() at the end of the test.
func (c *RustClient) StartSyncing(t ct.TestLike) (stopSyncing func(), err error) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
// It's critical that we destroy the sync_service_builder object before we return.
// You might be tempted to chain this function call e.g FFIClient.SyncService().Finish()
Expand All @@ -428,6 +467,7 @@ func (c *RustClient) StartSyncing(t ct.TestLike) (stopSyncing func(), err error)
// where the stack trace doesn't hit any test code, but does start at a `free_` function.
sb := c.FFIClient.SyncService()
defer sb.Destroy()
sb = sb.WithParentSpan(c.FFISpan)
syncService, err := sb.Finish()
if err != nil {
return nil, fmt.Errorf("[%s]failed to make sync service: %s", c.userID, err)
Expand Down Expand Up @@ -536,6 +576,9 @@ func (c *RustClient) StartSyncing(t ct.TestLike) (stopSyncing func(), err error)
//
// StartSyncing must have been called before this function.
func (c *RustClient) SubscribeToRoom(t ct.TestLike, roomID string) error {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
if c.syncService == nil {
return fmt.Errorf("cannot subscribe to room %s: StartSyncing not yet called", roomID)
Expand All @@ -549,6 +592,9 @@ func (c *RustClient) SubscribeToRoom(t ct.TestLike, roomID string) error {
// IsRoomEncrypted returns true if the room is encrypted. May return an error e.g if you
// provide a bogus room ID.
func (c *RustClient) IsRoomEncrypted(t ct.TestLike, roomID string) (bool, error) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
r, _ := c.findRoom(t, roomID)
if r == nil {
Expand All @@ -564,6 +610,9 @@ func (c *RustClient) IsRoomEncrypted(t ct.TestLike, roomID string) (bool, error)
}

func (c *RustClient) BackupKeys(t ct.TestLike) (recoveryKey string, err error) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
genericListener := newGenericStateListener[matrix_sdk_ffi.EnableRecoveryProgress]()
var listener matrix_sdk_ffi.EnableRecoveryProgressListener = genericListener
Expand Down Expand Up @@ -600,13 +649,19 @@ func (c *RustClient) BackupKeys(t ct.TestLike) (recoveryKey string, err error) {
}

func (c *RustClient) LoadBackup(t ct.TestLike, recoveryKey string) error {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
e := c.FFIClient.Encryption()
defer e.Destroy()
return e.Recover(recoveryKey)
}

func (c *RustClient) WaitUntilEventInRoom(t ct.TestLike, roomID string, checker func(api.Event) bool) api.Waiter {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
c.ensureListening(t, roomID)
return &timelineWaiter{
Expand All @@ -621,6 +676,9 @@ func (c *RustClient) Type() api.ClientTypeLang {
}

func (c *RustClient) SendMessage(t ct.TestLike, roomID, text string) (eventID string, err error) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
var isChannelClosed atomic.Bool
ch := make(chan bool)
Expand Down Expand Up @@ -674,12 +732,17 @@ func (c *RustClient) SendMessage(t ct.TestLike, roomID, text string) (eventID st
}

func (c *RustClient) InviteUser(t ct.TestLike, roomID, userID string) error {
c.FFISpan.Enter()
defer c.FFISpan.Exit()
t.Helper()
r, _ := c.findRoom(t, roomID)
return r.InviteUserById(userID)
}

func (c *RustClient) Backpaginate(t ct.TestLike, roomID string, count int) error {
c.FFISpan.Enter()
defer c.FFISpan.Exit()

t.Helper()
_, timeline := c.findRoom(t, roomID)
if timeline == nil {
Expand Down Expand Up @@ -764,6 +827,8 @@ func (c *RustClient) Logf(t ct.TestLike, format string, args ...interface{}) {
}

func (c *RustClient) logToFile(t ct.TestLike, format string, args ...interface{}) {
c.FFISpan.Enter()
defer c.FFISpan.Exit()
matrix_sdk_ffi.LogEvent("rust.go", &zero, matrix_sdk_ffi.LogLevelInfo, LogTarget + "::" + t.Name(), fmt.Sprintf(format, args...))
}

Expand Down
Loading