Add IgnoredAttribute, update errors and error messages

Author: LucDeCaf

PowerSync/PowerSync.Common/DB/Schema/Attributes/AttributeParser.cs

@@ -41,13 +41,18 @@ public Dictionary<string, ColumnType> ParseColumns()
 
         foreach (var prop in _type.GetProperties())
         {
+            if (prop.GetCustomAttribute<IgnoredAttribute>() != null) continue;
+
             var columnAttr = prop.GetCustomAttribute<ColumnAttribute>();
             var columnName = columnAttr?.Name ?? prop.Name;
 
             // Handle 'id' field separately
-            // TODO prevent defining multiple id columns (eg. 'id', 'Id', 'ID')
             if (columnName.ToLowerInvariant() == "id")
             {
+                if (idProperty != null)
+                {
+                    throw new InvalidOperationException($"Cannot define multiple ID columns for table '{_tableAttr.Name}'.");
+                }
                 idProperty = prop;
                 continue;
             }
@@ -64,11 +69,11 @@ public Dictionary<string, ColumnType> ParseColumns()
         // Validate 'id' property exists and is a string
         if (idProperty == null)
         {
-            throw new InvalidOperationException("A public string 'id' property is required.");
+            throw new InvalidOperationException($"An 'id' property is required for table '{_tableAttr.Name}'.");
         }
         if (idProperty.PropertyType != typeof(string))
         {
-            throw new InvalidOperationException($"Property '{idProperty.Name}' must be of type string.");
+            throw new InvalidOperationException($"ID Property '{idProperty.Name}' must be of type string.");
         }
         var idAttr = idProperty.GetCustomAttribute<ColumnAttribute>();
         if (idAttr != null)
@@ -78,7 +83,7 @@ public Dictionary<string, ColumnType> ParseColumns()
             {
                 throw new InvalidOperationException
                 (
-                    $"Property '{idProperty.Name}' must have ColumnType set to either ColumnType.Text or ColumnType.Inferred."
+                    $"ID Property '{idProperty.Name}' must have ColumnType set to ColumnType.Text or ColumnType.Inferred."
                 );
             }
         }
@@ -135,8 +140,7 @@ private ColumnType PropertyTypeToColumnType(Type propertyType)
             _ when propertyType == typeof(double) => ColumnType.Real,
 
             // Fallback
-            // TODO: Maybe raise a console warning / throw an error if unable to infer type?
-            _ => ColumnType.Text
+            _ => throw new InvalidOperationException($"Unable to automatically infer ColumnType of property type '{propertyType.Name}'."),
         };
     }
 

PowerSync/PowerSync.Common/DB/Schema/Attributes/IgnoredAttribute.cs

@@ -1,5 +1,5 @@
 namespace PowerSync.Common.DB.Schema.Attributes;
 
-[AttributeUsage(AttributeTargets.Property)]
+[AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
 public class IgnoredAttribute : Attribute { }
 

PowerSync/PowerSync.Common/DB/Schema/Attributes/TableAttribute.cs

@@ -3,7 +3,6 @@ namespace PowerSync.Common.DB.Schema.Attributes;
 [Flags]
 public enum TrackPrevious
 {
-    // TODO: Consider finding a method that can't represent invalid states (eg. TrackPrevious.Table | TrackPrevious.Columns)
     None = 0,
     Table = 1 << 0,
     Columns = 1 << 1,

PowerSync/PowerSync.Common/DB/Schema/ColumnJSON.cs

@@ -26,8 +26,7 @@ class ColumnJSON(ColumnJSONOptions options)
 
     public object ToJSONObject()
     {
-        // TODO find good exception type / message, or catch/throw somewhere else
-        if (Type == ColumnType.Inferred) throw new InvalidOperationException("Attempted to serialise Inferred column.");
+        if (Type == ColumnType.Inferred) throw new InvalidOperationException("Attempted to serialise Inferred column. ColumnType.Inferred is only valid as an argument to ColumnAttribute.");
 
         return new
         {