RDART-866: Minimal web support #1699

nielsenko · 2024-05-29T09:50:40Z

The aim of this PR is to allow package realm to be included in flutter web projects without breaking compilation. It is not intended to actually make realm work runtime with flutter web.

It is safe to use unmanaged realm object in web projects, except if they include Decimal128 fields.

Fixes: #1374

coveralls-official · 2024-05-31T08:33:40Z

Pull Request Test Coverage Report for Build 9405734587

Details

330 of 376 (87.77%) changed or added relevant lines in 36 files are covered.
6 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.2%) to 86.797%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
packages/realm_dart/lib/src/configuration.dart	5	6	83.33%
packages/realm_dart/lib/src/handles/native/results_handle.dart	9	10	90.0%
packages/realm_dart/lib/src/handles/native/session_handle.dart	14	15	93.33%
packages/realm_dart/lib/src/handles/native/set_handle.dart	11	12	91.67%
packages/realm_dart/lib/src/handles/native/app_handle.dart	22	24	91.67%
packages/realm_dart/lib/src/handles/native/http_transport_handle.dart	17	19	89.47%
packages/realm_dart/lib/src/handles/native/map_handle.dart	14	16	87.5%
packages/realm_dart/lib/src/handles/native/mutable_subscription_set_handle.dart	6	8	75.0%
packages/realm_dart/lib/src/handles/object_handle.dart	0	2	0.0%
packages/realm_dart/lib/src/realm_object.dart	1	3	33.33%

Files with Coverage Reduction	New Missed Lines	%
packages/realm_dart/lib/src/app.dart	2	91.3%
packages/realm_dart/lib/src/configuration.dart	4	74.58%

Totals
Change from base Build 9404164866:	-0.2%
Covered Lines:	5943
Relevant Lines:	6847

💛 - Coveralls

nirinchev

Looks good - I skimmed over large portions of repetitive changes, but those seem to be covered in tests, so they seem to work. One thing to consider is extracting the web exception somewhere so we don't have to repeat it 58329529 times.

CHANGELOG.md

nirinchev · 2024-06-06T08:57:38Z

packages/realm_dart/lib/src/handles/native/collection_handle_base.dart

 void createCollection(Realm realm, RealmValue value, Pointer<realm_list> Function() createList, Pointer<realm_dictionary> Function() createMap) {
  CollectionHandleBase? collectionHandle;
  try {
    switch (value.collectionType) {
      case RealmCollectionType.list:
-        final listHandle = ListHandle(createList(), realm.handle);
+        final listHandle = ListHandle(createList(), realm.handle as RealmHandle);


Rather than cast here, should we move the cast to the ListHandle/MapHandle ctor?

Not fan of that.. I prefer all methods on the platform specific handles (including ctors) to traffic in platform specific handles. The problem is more in the handle extension method on Realm.

packages/realm_dart/lib/src/handles/native/init.dart

packages/realm_dart/lib/src/realm_class.dart

packages/realm_dart/lib/src/realm_web.dart

packages/realm_dart/test/utils/native/platform_util.dart

nielsenko · 2024-06-06T10:10:11Z

Looks good - I skimmed over large portions of repetitive changes, but those seem to be covered in tests, so they seem to work. One thing to consider is extracting the web exception somewhere so we don't have to repeat it 58329529 times.

I have add a base-class on all web handles, and have it implement noSuchMethod. Also the actual throw has been refactored into the support function webNotSupported.

nirinchev · 2024-06-06T12:51:27Z

No, Decimal128 won't be supported because it relies on a native implementation. Unfortunately, this type is not implemented in pure dart and it's not obvious that such an implementation would be easy/possible with the primitives we have there.

dotjon0 · 2024-06-06T12:56:39Z

No, Decimal128 won't be supported because it relies on a native implementation. Unfortunately, this type is not implemented in pure dart and it's not obvious that such an implementation would be easy/possible with the primitives we have there.

could we fallback to a String in the case the RealmModel has a Decimal128 type then (for web only)? We can then deal with it there onwards. Otherwise we are going to have lots of Realm Models we cant use in 'web'.

Are there any other 'Realm' types that will not be supported in 'web'? Or any other limitations (granted Device Sync does not work in web).

nielsenko · 2024-06-06T13:05:20Z

could we fallback to a String in the case the RealmModel has a Decimal128 type then (for web only)? We can then deal with it there onwards. Otherwise we are going to have lots of Realm Models we cant use in 'web'.

No. The generator run before we know if the model will be used on web or not.

dotjon0 · 2024-06-06T13:06:56Z

could we fallback to a String in the case the RealmModel has a Decimal128 type then (for web only)? We can then deal with it there onwards. Otherwise we are going to have lots of Realm Models we cant use in 'web'.

No. The generator run before we know if the model will be used on web or not.

this package (which I think you use?) https://pub.dev/packages/bson supports Decimal128 and web?

how about property annotations that takes into account the Flutter target web VS anything else (native) to conditionally build the models, for example:

@RealmModel
class _SalesOrder {

  @PrimaryKey()
  late ObjectId id;

  @IgnoredWeb() /// this property is not included for 'web'
  late ObjectId salesOrderTotalPrice;

  @IgoredNative() /// this property is not included for 'native' (macOs/Windows/iOS/Android/etc)
  late String salesOrderTotalPrice;
}

Other than this, if we Realm cant conditionally build based on flutter target we are going to get lots of models with type issues...so web will not work...

nielsenko · 2024-06-06T13:38:22Z

Other than this, if we Realm cant conditionally build based on flutter target we are going to get lots of models with type issues...so web will not work...

We will add web support for Decimal128 based on https://pub.dev/packages/decimal

dotjon0 · 2024-06-06T13:45:17Z

Other than this, if we Realm cant conditionally build based on flutter target we are going to get lots of models with type issues...so web will not work...

We will add web support for Decimal128 based on https://pub.dev/packages/decimal

Thank you sooooo much @nielsenko - are they any other limitations in 'web' for Realm that we should be aware of? Obviously DeviceSync will not work in 'web'.

- AppConfiguration.baseFilePath is now a String instead of a Directory. - AppConfiguration.httpClient is now a Client instead of a HttpClient. This is to avoid a dependency on dart:io in order to be compatible with package web. This is still work in progress. Missing is: - Support for timeout on web requests - Custom certificate for windows.

nielsenko · 2024-06-07T15:46:12Z

This is now released with realm: ^3.0.0

* main: Add vNext Changelog header (#1717) [Release 3.0.0] (#1716) libraryVersion moved to realm_libary.dart (take 2) libraryVersion moved to realm_libary.dart Update CHANGELOG (#1715) Github composite action for setting up flutter on runner (#1710) RDART-866: kn/decimal128 web support (#1713) Reduce expected gain of memEquals for test stability Refresh after awaiting download to stabilize tests RDART-866: Minimal web support (#1699) RDART-1052: Update realm-core to v14.9.0 (#1704) RDART-1020: Fix writeAsync behaviour (#1666) RDART-999: Fix flutter test dlopen (#1623) RDART-1045: Expose setrlimit ios (#1700) RDART-962: Use xcode 15.4 (#1548) RDART-1039: Drop catalyst support. Flutter doesn't support it (#1696) # Conflicts: # packages/realm_dart/src/realm-core

cla-bot bot added the cla: yes label May 29, 2024

github-actions bot assigned nielsenko May 29, 2024

nielsenko force-pushed the kn/minimal-web-support branch 4 times, most recently from 39418d8 to ffd860d Compare May 31, 2024 08:23

nielsenko force-pushed the kn/minimal-web-support branch 4 times, most recently from 461fecd to 7cc3038 Compare May 31, 2024 16:27

nielsenko requested a review from nirinchev June 1, 2024 10:22

nielsenko changed the title ~~Minimal web support~~ RDART-866: Minimal web support Jun 1, 2024

nielsenko force-pushed the kn/minimal-web-support branch 8 times, most recently from b88120f to 4b9fd3d Compare June 3, 2024 13:42

nielsenko marked this pull request as ready for review June 3, 2024 13:45

nielsenko deployed to Staging June 3, 2024 14:44 — with GitHub Actions View deployment

nielsenko had a problem deploying to Production June 3, 2024 14:46 — with GitHub Actions Failure

nirinchev approved these changes Jun 6, 2024

View reviewed changes

nielsenko force-pushed the kn/minimal-web-support branch 4 times, most recently from 0826f58 to e84d2bd Compare June 6, 2024 10:53

nielsenko added 16 commits June 6, 2024 18:15

Take 1

597fe3c

Take 2

8d9528e

Avoid SyncErrorCode dep on realm_binding.dart

5310308

Avoid dep on realm_library.dart

74f6a64

Avoid dep on from_native.dart

d867a95

Split convert.dart to avoid dart:ffi dep

04f381d

Refactor test to avoid direct deps on dart:io and dart:ffi

355d37c

Avoid dart:ffi dep on Scheduler

967fc1b

Split decimal128.dart for web and native

6105f28

Split realm_core.dart for web and native

2c56670

Move int literals with more than 53 bit into platform_util.dart

c6f73d6

Add compile for web CI job

1941736

Split defaultClient

711c924

Update CHANGELOG

27453bc

Drop some default icons for web tests

fd71ad6

nielsenko force-pushed the kn/minimal-web-support branch from c1145f5 to 4d9f2ce Compare June 6, 2024 16:23

PR feedback

1e8e180

nielsenko force-pushed the kn/minimal-web-support branch from 4d9f2ce to 1e8e180 Compare June 6, 2024 18:07

nielsenko merged commit abb8ed1 into main Jun 6, 2024
57 checks passed

nielsenko deleted the kn/minimal-web-support branch June 6, 2024 20:58

github-actions bot locked as resolved and limited conversation to collaborators Jul 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RDART-866: Minimal web support #1699

RDART-866: Minimal web support #1699

nielsenko commented May 29, 2024 •

edited

Loading

coveralls-official bot commented May 31, 2024 •

edited

Loading

nirinchev left a comment

nirinchev Jun 6, 2024

nielsenko Jun 6, 2024

nielsenko commented Jun 6, 2024 •

edited

Loading

nirinchev commented Jun 6, 2024

dotjon0 commented Jun 6, 2024 •

edited

Loading

nielsenko commented Jun 6, 2024

dotjon0 commented Jun 6, 2024 •

edited

Loading

nielsenko commented Jun 6, 2024

dotjon0 commented Jun 6, 2024

nielsenko commented Jun 7, 2024

RDART-866: Minimal web support #1699

RDART-866: Minimal web support #1699

Conversation

nielsenko commented May 29, 2024 • edited Loading

coveralls-official bot commented May 31, 2024 • edited Loading

Pull Request Test Coverage Report for Build 9405734587

Details

💛 - Coveralls

nirinchev left a comment

Choose a reason for hiding this comment

nirinchev Jun 6, 2024

Choose a reason for hiding this comment

nielsenko Jun 6, 2024

Choose a reason for hiding this comment

nielsenko commented Jun 6, 2024 • edited Loading

nirinchev commented Jun 6, 2024

dotjon0 commented Jun 6, 2024 • edited Loading

nielsenko commented Jun 6, 2024

dotjon0 commented Jun 6, 2024 • edited Loading

nielsenko commented Jun 6, 2024

dotjon0 commented Jun 6, 2024

nielsenko commented Jun 7, 2024

nielsenko commented May 29, 2024 •

edited

Loading

coveralls-official bot commented May 31, 2024 •

edited

Loading

nielsenko commented Jun 6, 2024 •

edited

Loading

dotjon0 commented Jun 6, 2024 •

edited

Loading

dotjon0 commented Jun 6, 2024 •

edited

Loading