Updates Dart tests to use new notification API #3354

MongoCaleb · 2024-08-01T21:06:20Z

Pull Request Info - SDK Docs Consolidation

Jira ticket: hhttps://jira.mongodb.org/browse/DOCSP-40843

Staging Links

sdk/flutter/sync/manage-sync-session

sdk/flutter/sync/open-synced-realm

Release Notes

Dart/Flutter SDK
- Add new unit test to show progressEstimate SDK addition.
- Run dart fix to clean up all code examples and then re-bluehawk them all.

netlify · 2024-08-01T21:06:40Z

✅ Deploy Preview for device-sdk ready!

Name	Link
🔨 Latest commit	`a2936a0`
🔍 Latest deploy log	https://app.netlify.com/sites/device-sdk/deploys/66b656ee350ef700082ef04c
😎 Deploy Preview	https://deploy-preview-3354--device-sdk.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

…soon

krollins-mdb

Thanks for working on this, @MongoCaleb! I have a couple suggestions for the updated test. And a couple of things beyond my in-line comments:

We may need to update the "Monitor sync progress", in the manage_sync_session_test.dart file. You may have already looked at this, but wanted to make sure.
- It looks like we're already using the correct API for the monitor progress section of the Manage Sync Sessions page. However, we need to confirm that the content around the example describes the behavior and API correctly. Looks like this section was updated for v2.0.0 and probably doesn't account for the changes in the latest version.
Can you add a Release Notes section to the PR? You're doing release notes this time, so it should make your life a bit easier later. 😄

krollins-mdb · 2024-08-02T16:41:09Z

examples/dart/test/open_flexible_sync_realm_test.dart

      });
      // :snippet-end:
      expect(realm.isClosed, false);
-      expect(transferred, transferable);
-      expect(transferred, greaterThanOrEqualTo(0));
+      expect(progress, greaterThanOrEqualTo(-1));


This expect statement will always evaluate to true because we set progress to -1 on line 74. So, sync progress could be nothing or it could be complete. I think we'd want to test that the sync is complete, so should be looking for greater than -1, not equal to.

I think the await on realm open will wait for sync to finish, but I'm not certain of the default behavior for the Flutter SDK. Either way, we'll need to make sure we're waiting for sync to finish so that we can get the expected result.

Alternatively, we could change the type and value of progress. Within the if block on line 80, we could set progress to "Transfer complete" or something. Then assert equality between the expected string and what is actually in progress.

General comment above: I believe the page content around each of the code snippets is correct. However, the one you link (Monitor Progress) shows using getProgressStream. This is not deprecated, so I think it's good to leave in here. Do you think it should be replaced with the other way to do it (as shown in this PR)?

Per the new info from Kaspar, we're good to have both.

Can we add a mention of getProgressStream to the section where the onProgressCallback example is used? We don't talk about the fact that they're really the same thing anywhere. It would be nice to have info about when devs might use one instead of the other. But at least acknowledging that there are two ways to add progress notifications would be great.

Also, thanks for digging into this! I had no idea there were two ways to do this. 😆

krollins-mdb · 2024-08-02T16:42:47Z

examples/dart/test/open_flexible_sync_realm_test.dart

+            progress = syncProgress.progressEstimate;
+            // Percent complete == progress * 100
+          if (syncProgress.progressEstimate == 1.0) {
+             //transfer is complete


Suggested change

//transfer is complete

// Transfer is complete

MongoCaleb · 2024-08-09T16:44:52Z

Note: we are keeping information about both getProgressStream and onProgressCallback because the latter is really a fix to make things simplier for the user, but is, behind the scenes, just a wrapper over the former. As per Kasper Nielsen:

getProgressStream is the most important I think. It can be used throughout the apps lifetime, and can be customized with both direction and mode.
In a sense onProgressCallback exists due to arguably bad design choice of combining setup and open of a realm file in one operation, preventing the user from calling getProgressStream before the realm is opened. But, alas history is history.. and as such it is also important.

krollins-mdb

Thanks for your work on this, @MongoCaleb! LGTM.

I have a couple of comments you should consider before merging, but they're not blocking comments.

This one in particular could help devs navigate this feature a bit: #3354 (comment)

krollins-mdb · 2024-08-09T17:35:06Z

examples/dart/test/open_flexible_sync_realm_test.dart

+Future<void> addSubscriptions(Realm realm, String searchByPrefix) async {
+  final query = realm.query<Tricycle>(r'name BEGINSWITH $0', ["a"]);
+  if (realm.subscriptions.find(query) == null) {
+    realm.subscriptions.update((mutableSubscriptions) => mutableSubscriptions.add(query));
+  }
+  await realm.subscriptions.waitForSynchronization();
+}
+
+Future<Configuration> subscribeForAtlasAddedData(App app, {int itemsCount = 100}) async {
+  final productNamePrefix = "a";
+  final user1 = await app.logIn(Credentials.anonymous(reuseCredentials: false));
+  final config1 = Configuration.flexibleSync(user1, [Tricycle.schema]);
+  final realm1 = Realm(config1);
+  await addSubscriptions(realm1, productNamePrefix);
+  realm1.close();
+
+  final user2 = await app.logIn(Credentials.anonymous(reuseCredentials: false));
+  final config2 = Configuration.flexibleSync(user2, [Tricycle.schema]);
+  final realm2 = Realm(config2);
+
+  await addSubscriptions(realm2, productNamePrefix);
+
+  final trikes = realm2.all<Tricycle>();
+  realm2.write(() {
+    realm2.deleteMany(trikes);
+    realm2.add(Tricycle(1001, "a1001"));
+    realm2.add(Tricycle(2002, "a2002"));
+    realm2.add(Tricycle(3003, "a3003"));
+  });
+
+  await realm2.syncSession.waitForUpload();
+  await realm2.syncSession.waitForDownload();
+  realm2.close();
+  return config1;
+}


Is there a reason to have these functions outside of the "Track upload progress" test that starts on line 106? They're only for that test, right?

github-actions · 2024-08-09T17:51:48Z

Readability for Commit Hash: a2936a0

You can see any previous Readability scores (if they exist) by looking
at the comment's history.

Readability scores for changed documents:

source/sdk/flutter/sync/manage-sync-session: Grade Level: 8.7, Reading Ease: 51.95
source/sdk/flutter/sync/open-synced-realm: Grade Level: 8.1, Reading Ease: 58.89

For Grade Level, aim for 8 or below.

For Reading Ease scores, aim for 60 or above:

Score	Difficulty
90-100	Very Easy
80-89	Easy
70-79	Fairly Easy
60-69	Medium
50-59	Fairly Hard
30-49	Hard
0-29	Very Hard

For help improving readability, try Hemingway App.

MongoCaleb · 2024-08-09T17:53:56Z

@krollins-mdb added notes.

docs-builder-bot · 2024-08-09T18:19:45Z

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/

🪵 Logs

job log: f003a010cbb700891b3652902a6d00a442fa5638

moving from windows to mac for better testing

497a581

MongoCaleb added 4 commits August 2, 2024 08:47

updated tests and action to report failures

4355b1c

revert to run bash script directly, as other method kills output too …

c21f361

…soon

moving grep down the error chain to capture entire error

ef2b8cf

bluehawk the examples

f6e8544

krollins-mdb requested changes Aug 2, 2024

View reviewed changes

MongoCaleb added 5 commits August 2, 2024 10:55

update expected result

b72b15d

WIP

ae3931e

WIP

2627d9d

unit test now working

14d7c0f

comment clean-up

4a18763

MongoCaleb requested a review from krollins-mdb August 8, 2024 21:10

Merge branch 'master' of github.com:mongodb/docs-realm into dart_tests

aa257d0

krollins-mdb approved these changes Aug 9, 2024

View reviewed changes

add notes of corss-reference

a2936a0

MongoCaleb merged commit f003a01 into mongodb:master Aug 9, 2024
12 checks passed

MongoCaleb deleted the dart_tests branch August 9, 2024 18:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates Dart tests to use new notification API #3354

Updates Dart tests to use new notification API #3354

MongoCaleb commented Aug 1, 2024 •

edited by github-actions bot

Loading

netlify bot commented Aug 1, 2024 •

edited

Loading

krollins-mdb left a comment

krollins-mdb Aug 2, 2024

MongoCaleb Aug 8, 2024

krollins-mdb Aug 9, 2024

krollins-mdb Aug 9, 2024

krollins-mdb Aug 2, 2024

MongoCaleb commented Aug 9, 2024 •

edited

Loading

krollins-mdb left a comment

krollins-mdb Aug 9, 2024

github-actions bot commented Aug 9, 2024

MongoCaleb commented Aug 9, 2024

docs-builder-bot commented Aug 9, 2024

Updates Dart tests to use new notification API #3354

Updates Dart tests to use new notification API #3354

Conversation

MongoCaleb commented Aug 1, 2024 • edited by github-actions bot Loading

Pull Request Info - SDK Docs Consolidation

Staging Links

Release Notes

netlify bot commented Aug 1, 2024 • edited Loading

✅ Deploy Preview for device-sdk ready!

krollins-mdb left a comment

Choose a reason for hiding this comment

krollins-mdb Aug 2, 2024

Choose a reason for hiding this comment

MongoCaleb Aug 8, 2024

Choose a reason for hiding this comment

krollins-mdb Aug 9, 2024

Choose a reason for hiding this comment

krollins-mdb Aug 9, 2024

Choose a reason for hiding this comment

krollins-mdb Aug 2, 2024

Choose a reason for hiding this comment

MongoCaleb commented Aug 9, 2024 • edited Loading

krollins-mdb left a comment

Choose a reason for hiding this comment

krollins-mdb Aug 9, 2024

Choose a reason for hiding this comment

github-actions bot commented Aug 9, 2024

MongoCaleb commented Aug 9, 2024

docs-builder-bot commented Aug 9, 2024

🪵 Logs

MongoCaleb commented Aug 1, 2024 •

edited by github-actions bot

Loading

netlify bot commented Aug 1, 2024 •

edited

Loading

MongoCaleb commented Aug 9, 2024 •

edited

Loading