Realm Set support

.vscode/launch.json

@@ -52,6 +52,15 @@
             "program": "test/realm_test.dart",
             "cwd": "${workspaceFolder}",
             "args": ["--name", ""]
-        }
+        },
+        {
+            "name": "Debug Generator Tests",
+            "type": "dart",
+            "request": "launch",
+            // "program": "test/good_test.dart",
+            "program": "test/error_test.dart",
+            "args": ["-p", "vm", "-n", "unsupported_realm_set_with_default_values.dart"],
+            "cwd": "generator",
+        },
     ]
 }

CHANGELOG.md

@@ -3,10 +3,10 @@
 **This project is in Release Candidate stage.**
 
 ### Enhancements
-* None
+* Add supoprt for Realm set data type ([#1102](https://github.com/realm/realm-dart/pull/1102))
 
 ### Fixed
-* None
+* Added an error for default values for Realm object references in the Realm generator ([#1102](https://github.com/realm/realm-dart/pull/1102))
 
 ### Compatibility
 * Realm Studio: 13.0.0 or later.

common/lib/src/realm_types.dart

@@ -69,6 +69,7 @@ enum RealmCollectionType {
   none,
   list,
   set,
+  _3, // ignore: unused_field, constant_identifier_names
   dictionary,
 }
 

flutter/realm_flutter/tests/test_driver/realm_test.dart

@@ -20,6 +20,7 @@ import '../test/session_test.dart' as session_test;
 import '../test/subscription_test.dart' as subscription_test;
 import '../test/user_test.dart' as user_test;
 import '../test/client_reset_test.dart' as client_reset_test;
+import '../test/realm_set_test.dart' as realm_set_test;
 
 Future<String> main(List<String> args) async {
   final Completer<String> completer = Completer<String>();
@@ -41,6 +42,7 @@ Future<String> main(List<String> args) async {
     await subscription_test.main(args);
     await user_test.main(args);
     await client_reset_test.main(args);
+    await realm_set_test.main(args);
 
     tearDown(() {
       if (Invoker.current?.liveTest.state.result == test_api.Result.error || Invoker.current?.liveTest.state.result == test_api.Result.failure) {

generator/README.md

@@ -60,12 +60,6 @@ class _Car {
 
 # Debugging
 
-* On first use .dart_tool/build/entrypoint/build.dart needs to be generated with pub run build_runer build
-
-* Use a terminal to launch a debuggee with command
-
-  ```
-  dart run --observe --pause-isolates-on-start  --enable-vm-service:5858/127.0.0.1  --disable-service-auth-codes .dart_tool/build/entrypoint/build.dart build
-  ```
+* Use the Debug Generator Tests launch config in VS Code. The launch config also has an arg for filtering specifc tests.
 
 ##### The "Dart" name and logo and the "Flutter" name and logo are trademarks owned by Google.

generator/lib/src/dart_type_ex.dart

@@ -32,6 +32,7 @@ extension DartTypeEx on DartType {
 
   bool get isRealmValue => const TypeChecker.fromRuntime(RealmValue).isAssignableFromType(this);
   bool get isRealmCollection => realmCollectionType != RealmCollectionType.none;
+  bool get isRealmSet => realmCollectionType == RealmCollectionType.set;
   bool get isRealmModel => element2 != null ? realmModelChecker.annotationsOfExact(element2!).isNotEmpty : false;
 
   bool get isNullable => session.typeSystem.isNullable(this);
@@ -110,7 +111,6 @@ extension DartTypeEx on DartType {
     if (isExactly<Uint8List>()) return RealmPropertyType.binary;
     if (isRealmValue) return RealmPropertyType.mixed;
     if (isExactly<DateTime>()) return RealmPropertyType.timestamp;
-    if (isExactly<Float>()) return RealmPropertyType.float;
     if (isDartCoreNum || isDartCoreDouble) return RealmPropertyType.double;
     if (isExactly<Decimal128>()) return RealmPropertyType.decimal128;
     if (isRealmModel) return RealmPropertyType.object;

generator/lib/src/field_element_ex.dart

@@ -37,6 +37,8 @@ import 'session.dart';
 import 'type_checkers.dart';
 
 extension FieldElementEx on FieldElement {
+  static const realmSetUnsupportedRealmTypes = [RealmPropertyType.binary, RealmPropertyType.linkingObjects];
+
   FieldDeclaration get declarationAstNode => getDeclarationFromElement(this)!.node.parent!.parent as FieldDeclaration;
 
   AnnotationValue? get ignoredInfo => annotationInfoOfExact(ignoredChecker);
@@ -59,6 +61,14 @@ extension FieldElementEx on FieldElement {
         [span!],
       );
 
+  FileSpan? initializerExpressionSpan(SourceFile file, Expression initializerExpression) => ExpandedContextSpan(
+        ExpandedContextSpan(
+          (initializerExpression).span(file),
+          [span!],
+        ),
+        [span!],
+      );
+
   DartType get modelType => typeAnnotation?.type?.nullIfDynamic ?? initializerExpression?.staticType ?? PseudoType(typeAnnotation.toString());
 
   String get modelTypeName => modelType.getDisplayString(withNullability: true);
@@ -82,9 +92,7 @@ extension FieldElementEx on FieldElement {
       final backlink = backlinkInfo;
 
       // Check for as-of-yet unsupported type
-      if (type.isDartCoreSet || //
-          type.isDartCoreMap ||
-          type.isExactly<Decimal128>()) {
+      if (type.isDartCoreMap || type.isExactly<Decimal128>()) {
         throw RealmInvalidGenerationSourceError(
           'Field type not supported yet',
           element: this,
@@ -186,7 +194,7 @@ extension FieldElementEx on FieldElement {
       } else {
         // Validate collections and backlinks
         if (type.isRealmCollection || backlink != null) {
-          final typeDescription = type.isRealmCollection ? 'collections' : 'backlinks';
+          final typeDescription = type.isRealmCollection ? (type.isRealmSet ? 'sets' : 'collections') : 'backlinks';
           if (type.isNullable) {
             throw RealmInvalidGenerationSourceError(
               'Realm $typeDescription cannot be nullable',
@@ -204,6 +212,34 @@ extension FieldElementEx on FieldElement {
                 element: this,
                 todo: 'Ensure element type is non-nullable');
           }
+
+          if (type.isRealmSet) {
+            final typeArgument = (type as ParameterizedType).typeArguments.first;
+            if (realmSetUnsupportedRealmTypes.contains(realmType)) {
+              throw RealmInvalidGenerationSourceError('$type is not supported',
+                  primarySpan: typeSpan(file),
+                  primaryLabel: 'Set element type is not supported',
+                  element: this,
+                  todo: 'Ensure set element type ${typeArgument} is a type supported by RealmSet.');
+            }
+
+            if (realmType == RealmPropertyType.mixed && typeArgument.isNullable) {
+              throw RealmInvalidGenerationSourceError('$type is not supported',
+                  primarySpan: typeSpan(file),
+                  primaryLabel: 'Set of nullable RealmValues is not supported',
+                  element: this,
+                  todo: 'Did you mean to use Set<RealmValue> instead?');
+            }
+
+            final initExpression = initializerExpression;
+            if (initExpression != null) {
+              throw RealmInvalidGenerationSourceError('Default values for set are not supported.',
+                  primarySpan: initializerExpressionSpan(file, initExpression),
+                  primaryLabel: 'Remove the default value.',
+                  element: this,
+                  todo: 'Remove the default value for field $displayName.');
+            }
+          }
         }
 
         // Validate backlinks
@@ -260,6 +296,17 @@ extension FieldElementEx on FieldElement {
               element: this,
             );
           }
+
+          final intiExpression = initializerExpression;
+          if (intiExpression != null) {
+            throw RealmInvalidGenerationSourceError(
+              'Realm object references should not have default values',
+              primarySpan: initializerExpressionSpan(file, intiExpression),
+              primaryLabel: ' Remove the default value',
+              todo: 'Remove the default value for field "$displayName"',
+              element: this,
+            );
+          }
         }
 
         // Validate mixed (RealmValue)

generator/lib/src/realm_field_info.dart

@@ -44,6 +44,7 @@ class RealmFieldInfo {
 
   bool get isFinal => fieldElement.isFinal;
   bool get isRealmCollection => type.isRealmCollection;
+  bool get isDartCoreSet => type.isDartCoreSet;
   bool get isLate => fieldElement.isLate;
   bool get hasDefaultValue => fieldElement.hasInitializer;
   bool get optional => type.basicType.isNullable || realmType == RealmPropertyType.mixed;
@@ -68,8 +69,9 @@ class RealmFieldInfo {
 
   String get initializer {
     if (type.isDartCoreList) return ' = const []';
-    if (isMixed) return ' = const RealmValue.nullValue()';
+    if (isMixed && !type.isRealmCollection) return ' = const RealmValue.nullValue()';
     if (hasDefaultValue) return ' = ${fieldElement.initializerExpression}';
+    if (type.isDartCoreSet) return ' = const {}';
     return ''; // no initializer
   }
 

generator/lib/src/realm_model_info.dart

@@ -48,11 +48,13 @@ class RealmModelInfo {
         yield* required.map((f) => '${f.mappedTypeName} ${f.name},');
 
         final notRequired = allSettable.where((f) => !f.isRequired && !f.isPrimaryKey);
-        final collections = fields.where((f) => f.isRealmCollection).toList();
-        if (notRequired.isNotEmpty || collections.isNotEmpty) {
+        final collections = fields.where((f) => f.isRealmCollection && !f.isDartCoreSet).toList();
+        final sets = fields.where((f) => f.isDartCoreSet).toList();
+        if (notRequired.isNotEmpty || collections.isNotEmpty || sets.isNotEmpty) {
           yield '{';
           yield* notRequired.map((f) => '${f.mappedTypeName} ${f.name}${f.initializer},');
           yield* collections.map((c) => 'Iterable<${c.type.basicMappedName}> ${c.name}${c.initializer},');
+          yield* sets.map((c) => 'Set<${c.type.basicMappedName}> ${c.name}${c.initializer},');
           yield '}';
         }
 
@@ -73,6 +75,10 @@ class RealmModelInfo {
         yield* collections.map((c) {
           return "RealmObjectBase.set<${c.mappedTypeName}>(this, '${c.realmName}', ${c.mappedTypeName}(${c.name}));";
         });
+
+        yield* sets.map((c) {
+          return "RealmObjectBase.set<${c.mappedTypeName}>(this, '${c.realmName}', ${c.mappedTypeName}(${c.name}));";
+        });
       }
       yield '}';
       yield '';

generator/test/error_test.dart

@@ -6,16 +6,17 @@ void main() {
   const directory = 'test/error_test_data';
   getListOfTestFiles(directory).forEach((inputFile, outputFile) {
     executeTest(getTestName(inputFile), () async {
+      final expectedContent = await readFileAsErrorFormattedString(directory, outputFile); 
       expectLater(
         generatorTestBuilder(directory, inputFile),
         throwsA(
           isA<RealmInvalidGenerationSourceError>().having(
             (e) => e.format(),
-            'format()',
-            await readFileAsErrorFormattedString(directory, outputFile),
+            '',
+            LinesEqualsMatcher(expectedContent),
           ),
         ),
       );
     });
   });
-}
+}

generator/test/error_test_data/nullable_set.dart

@@ -0,0 +1,11 @@
+import 'package:realm_common/realm_common.dart';
+
+//part 'nullable_set.g.dart';
+
+@RealmModel()
+class _Bad {
+  @PrimaryKey()
+  late int id;
+
+  Set<int>? wrong;
+}

generator/test/error_test_data/nullable_set.expected

@@ -0,0 +1,11 @@
+Realm sets cannot be nullable
+
+in: asset:pkg/test/error_test_data/nullable_set.dart:10:3
+    ╷
+5   │ @RealmModel()
+6   │ class _Bad {
+    │       ━━━━ in realm model for 'Bad'
+... │
+10  │   Set<int>? wrong;
+    │   ^^^^^^^^^ is nullable
+    ╵

generator/test/error_test_data/set_unsupported.dart → generator/test/error_test_data/realm_object_reference_default_values.dart

@@ -1,8 +1,9 @@
-import 'package:realm_common/realm_common.dart';
+import 'dart:typed_data';
 
-//part 'set_unsupported.g.dart';
+import 'package:realm_common/realm_common.dart';
 
 @RealmModel()
 class _Person {
-  late Set<_Person> children;
+  int x = 0;
+  late _Person? parent = Person();
 }

generator/test/error_test_data/realm_object_reference_default_values.expected

@@ -0,0 +1,13 @@
+Realm object references should not have default values
+
+in: asset:pkg/test/error_test_data/realm_object_reference_default_values.dart:8:26
+    ╷
+5   │ @RealmModel()
+6   │ class _Person {
+    │       ━━━━━━━ in realm model for 'Person'
+... │
+8   │   late _Person? parent = Person();
+    │                          ^^^^^^^^  Remove the default value
+    ╵
+Remove the default value for field "parent"
+

generator/test/error_test_data/unsupported_non_realm_type_set.dart

@@ -0,0 +1,11 @@
+import 'package:realm_common/realm_common.dart';
+
+//part 'unsupported_non_realm_type_set.g.dart';
+
+@RealmModel()
+class _Bad {
+  @PrimaryKey()
+  late int id;
+
+  late Set<RealmStateError> wrong;
+}

generator/test/error_test_data/unsupported_non_realm_type_set.expected

@@ -0,0 +1,13 @@
+Not a realm type
+
+in: asset:pkg/test/error_test_data/unsupported_non_realm_type_set.dart:10:8
+    ╷
+5   │ @RealmModel()
+6   │ class _Bad {
+    │       ━━━━ in realm model for 'Bad'
+... │
+10  │   late Set<RealmStateError> wrong;
+    │        ^^^^^^^^^^^^^^^^^^^^ Set<RealmStateError> is not a realm model type
+    ╵
+Remove the invalid field or add an @Ignored annotation on 'wrong'.
+

generator/test/error_test_data/unsupported_realm_set_of_nullable_realmobject.dart

@@ -0,0 +1,11 @@
+import 'package:realm_common/realm_common.dart';
+
+//part 'unsupported_realm_set_of_nullable_realmvalue.g.dart';
+
+@RealmModel()
+class _Bad {
+  @PrimaryKey()
+  late int id;
+
+  late Set<_Bad?> wrong1;
+}

generator/test/error_test_data/unsupported_realm_set_of_nullable_realmobject.expected

@@ -0,0 +1,13 @@
+Nullable realm objects are not allowed in sets
+
+in: asset:pkg/test/error_test_data/unsupported_realm_set_of_nullable_realmobject.dart:10:8
+    ╷
+5   │ @RealmModel()
+6   │ class _Bad {
+    │       ━━━━ in realm model for 'Bad'
+... │
+10  │   late Set<_Bad?> wrong1;
+    │        ^^^^^^^^^^ which has a nullable realm object element type
+    ╵
+Ensure element type is non-nullable
+

generator/test/error_test_data/unsupported_realm_set_of_nullable_realmvalue.dart

@@ -0,0 +1,11 @@
+import 'package:realm_common/realm_common.dart';
+
+//part 'unsupported_realm_set_of_nullable_realmvalue.g.dart';
+
+@RealmModel()
+class _Bad {
+  @PrimaryKey()
+  late int id;
+
+  late Set<RealmValue?> wrong1;
+}

generator/test/error_test_data/unsupported_realm_set_of_nullable_realmvalue.expected

@@ -0,0 +1,13 @@
+Set<RealmValue?> is not supported
+
+in: asset:pkg/test/error_test_data/unsupported_realm_set_of_nullable_realmvalue.dart:10:8
+    ╷
+5   │ @RealmModel()
+6   │ class _Bad {
+    │       ━━━━ in realm model for 'Bad'
+... │
+10  │   late Set<RealmValue?> wrong1;
+    │        ^^^^^^^^^^^^^^^^ Set of nullable RealmValues is not supported
+    ╵
+Did you mean to use Set<RealmValue> instead?
+