expose sync user subscribe in the c-api #7302

nicola-cab · 2024-01-30T10:45:36Z

What, How & Why?

☑️ ToDos

📝 Changelog update
🚦 Tests (or not relevant)
C-API, if public C++ API changed
bindgen/spec.yml, if public C++ API changed

coveralls-official · 2024-01-30T13:16:54Z

Pull Request Test Coverage Report for Build nicola.cabiddu_1344

0 of 22 (100.0%) changed or added relevant lines in 4 files are covered.
81 unchanged lines in 12 files lost coverage.
Overall coverage decreased (-0.01%) to 91.855%

Files with Coverage Reduction	New Missed Lines	%
src/realm/array_key.cpp	1	97.53%
src/realm/sync/network/network.cpp	1	89.66%
test/test_index_string.cpp	1	94.13%
src/realm/table_view.cpp	2	94.18%
test/test_lang_bind_helper.cpp	2	93.31%
src/realm/sync/noinst/client_impl_base.cpp	3	85.85%
test/test_thread.cpp	3	66.67%
src/realm/sync/transform.cpp	4	63.08%
src/realm/sync/network/network.hpp	7	85.41%
src/realm/sync/noinst/server/server_history.cpp	7	67.66%

Totals
Change from base Build 2001:	-0.01%
Covered Lines:	235334
Relevant Lines:	256203

💛 - Coveralls

danieltabacaru · 2024-02-01T06:41:36Z

test/object-store/c_api/c_api.cpp

@@ -615,6 +615,9 @@ TEST_CASE("C API (non-database)", "[c_api]") {
            },
            &sync_user, user_data_free);

+        auto user_state = [](realm_userdata_t, realm_user_state_e) {};


we should check the user logs in (and other state changes)

danieltabacaru · 2024-02-01T06:42:17Z

src/realm.h

+
+// register callback for tracking user status.
+RLM_API realm_user_subscription_token_t*
+realm_user_state_change_register_callback(realm_user_t*, realm_user_changed_callback_t, realm_userdata_t userdata,


realm_sync_user_register_state_changed_callback?

danieltabacaru · 2024-02-01T06:42:47Z

src/realm.h

 typedef struct realm_async_open_task_progress_notification_token realm_async_open_task_progress_notification_token_t;
 typedef struct realm_sync_session_connection_state_notification_token
    realm_sync_session_connection_state_notification_token_t;
+typedef struct realm_user_subscription_token realm_user_subscription_token_t;


danieltabacaru · 2024-02-01T06:43:01Z

src/realm.h

@@ -3495,9 +3495,13 @@ typedef enum realm_flx_sync_subscription_set_state {
 typedef void (*realm_sync_on_subscription_state_changed_t)(realm_userdata_t userdata,
                                                           realm_flx_sync_subscription_set_state_e state);

+typedef void (*realm_user_changed_callback_t)(realm_userdata_t userdata, realm_user_state_e s);


realm_sync_user_state_changed_t?

danieltabacaru · 2024-02-01T06:43:04Z

CHANGELOG.md

@@ -2,6 +2,7 @@

 ### Enhancements
 * <New feature description> (PR [#????](https://github.com/realm/realm-core/pull/????))
+* Add support in the C API for receiving a notification when sync user status changes. ([#7302](https://github.com/realm/realm-core/pull/7302))


nit: status -> state

danieltabacaru · 2024-02-01T06:44:57Z

src/realm.h

@@ -3894,6 +3898,12 @@ RLM_API realm_sync_session_connection_state_notification_token_t* realm_sync_ses
    realm_sync_session_t*, realm_sync_progress_func_t, realm_sync_progress_direction_e, bool is_streaming,
    realm_userdata_t userdata, realm_free_userdata_func_t userdata_free) RLM_API_NOEXCEPT;

+
+// register callback for tracking user status.


// @return a notification token object. Dispose it to stop receiving notifications.

danieltabacaru · 2024-02-01T06:56:57Z

src/realm.h

@@ -3495,9 +3495,13 @@ typedef enum realm_flx_sync_subscription_set_state {
 typedef void (*realm_sync_on_subscription_state_changed_t)(realm_userdata_t userdata,
                                                           realm_flx_sync_subscription_set_state_e state);

+typedef void (*realm_user_changed_callback_t)(realm_userdata_t userdata, realm_user_state_e s);


I wonder if realm_user_t* should be an argument to be able to easily distinguish between different user notifications. I guess realm_userdata_t could be used for that?

yes, the sdks can pass whatever they want in there.

danieltabacaru · 2024-02-01T06:59:50Z

bindgen spec exposes unregister too. I know one can unregister by destroying the token (should be documented), so maybe that's good enough.

nicola-cab · 2024-02-01T08:49:26Z

bindgen spec exposes unregister too. I know one can unregister by destroying the token (should be documented), so maybe that's good enough.

There is no C-API in the bingen (AFAIK), also all the tokens that we expose are destroyed via realm_release and that automatically stops the notifications. I think this is the general pattern we follow in the C-API.
Once we get to the point of generating a new C-API we can revisit this, I would say.

danieltabacaru · 2024-02-01T09:06:58Z

There is no C-API in the bingen (AFAIK)

I meant that you can unregister if you don't use the c-api, and I was thinking how well they both should align (I agree we have different patterns in the c-api, such as stopping notifications if the token is destroyed)

danieltabacaru

LGTM

cla-bot bot added the cla: yes label Jan 30, 2024

github-actions bot assigned nicola-cab Jan 30, 2024

nicola-cab force-pushed the nc/expose_sync_user_subscribe branch 3 times, most recently from c24d7d4 to d743f57 Compare January 30, 2024 12:14

expose sync user subscribe in the c-api

20bc08a

nicola-cab force-pushed the nc/expose_sync_user_subscribe branch from d743f57 to 20bc08a Compare January 30, 2024 12:37

nirinchev mentioned this pull request Jan 30, 2024

Expose User.changes realm/realm-dart#1500

Merged

some fixes

4fbe0d2

nicola-cab requested review from fealebenpae, jbreams and danieltabacaru January 31, 2024 15:07

changelog + fix test

560155a

nicola-cab force-pushed the nc/expose_sync_user_subscribe branch from b021e56 to 560155a Compare January 31, 2024 15:13

lint

cd5dd2d

danieltabacaru reviewed Feb 1, 2024

View reviewed changes

nicola-cab added 2 commits February 1, 2024 10:18

code review

6c6b789

lint

d410533

nicola-cab requested a review from danieltabacaru February 1, 2024 10:01

danieltabacaru approved these changes Feb 1, 2024

View reviewed changes

nicola-cab merged commit d12c38d into master Feb 1, 2024
36 checks passed

nicola-cab deleted the nc/expose_sync_user_subscribe branch February 1, 2024 12:06

rorbech mentioned this pull request Mar 6, 2024

Add specific exception for auth errors being sent to to the Sync Session error handler realm/realm-kotlin#1643

Draft

3 tasks

github-actions bot locked as resolved and limited conversation to collaborators Mar 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

expose sync user subscribe in the c-api #7302

expose sync user subscribe in the c-api #7302

nicola-cab commented Jan 30, 2024 •

edited by danieltabacaru

coveralls-official bot commented Jan 30, 2024 •

edited

danieltabacaru Feb 1, 2024

danieltabacaru Feb 1, 2024

danieltabacaru Feb 1, 2024

danieltabacaru Feb 1, 2024

danieltabacaru Feb 1, 2024

danieltabacaru Feb 1, 2024

danieltabacaru Feb 1, 2024

nicola-cab Feb 1, 2024 •

edited

danieltabacaru commented Feb 1, 2024 •

edited

nicola-cab commented Feb 1, 2024

danieltabacaru commented Feb 1, 2024

danieltabacaru left a comment

expose sync user subscribe in the c-api #7302

expose sync user subscribe in the c-api #7302

Conversation

nicola-cab commented Jan 30, 2024 • edited by danieltabacaru

What, How & Why?

☑️ ToDos

coveralls-official bot commented Jan 30, 2024 • edited

Pull Request Test Coverage Report for Build nicola.cabiddu_1344

💛 - Coveralls

danieltabacaru Feb 1, 2024

Choose a reason for hiding this comment

danieltabacaru Feb 1, 2024

Choose a reason for hiding this comment

danieltabacaru Feb 1, 2024

Choose a reason for hiding this comment

danieltabacaru Feb 1, 2024

Choose a reason for hiding this comment

danieltabacaru Feb 1, 2024

Choose a reason for hiding this comment

danieltabacaru Feb 1, 2024

Choose a reason for hiding this comment

danieltabacaru Feb 1, 2024

Choose a reason for hiding this comment

nicola-cab Feb 1, 2024 • edited

Choose a reason for hiding this comment

danieltabacaru commented Feb 1, 2024 • edited

nicola-cab commented Feb 1, 2024

danieltabacaru commented Feb 1, 2024

danieltabacaru left a comment

Choose a reason for hiding this comment

nicola-cab commented Jan 30, 2024 •

edited by danieltabacaru

coveralls-official bot commented Jan 30, 2024 •

edited

nicola-cab Feb 1, 2024 •

edited

danieltabacaru commented Feb 1, 2024 •

edited