Translate enum string name to underlying enum type (#137)

* Add !=, In, IsNull, starts/endswith, fix contains and test * default for default sort * initial changes for enum translation * add test cases, remove error since default sort added * update container tests, formatting, fix enum parse logic * typo! * fix column type, add reader for enum column * Update code with revisions from autocomplete --------- Co-authored-by: Charlie Taylor <[email protected]> Co-authored-by: Charlie Taylor <[email protected]> Co-authored-by: Charlie Taylor <[email protected]> Co-authored-by: Ted Spence <[email protected]>
tspence · Sep 10, 2023 · 70b0e0d · 70b0e0d
1 parent 01785ef
commit 70b0e0d
Show file tree

Hide file tree

Showing 17 changed files with 327 additions and 169 deletions.
diff --git a/Searchlight.nuspec b/Searchlight.nuspec
@@ -2,7 +2,7 @@
 <package >
 	<metadata>
 		<id>Searchlight</id>
-		<version>1.0.1</version>
+		<version>1.0.2</version>
 		<title>Searchlight</title>
 		<authors>Ted Spence</authors>
 		<owners>Ted Spence</owners>
@@ -17,12 +17,11 @@
 		<summary>A friendly and readable domain specific query language for your API.</summary>
 		<icon>docs/icons8-searchlight-90.png</icon>
 		<releaseNotes>
-			# 1.0.1
-			July 30, 2023
+			# 1.0.2
+			September 10, 2023
 
-			Added test containers for MySQL.
-			Revised some tests for clock drift.
-			Improved overall testing for clause string conversion.
+			* Added support for autocomplete.
+			* Fixed issues with handling of enum clauses in queries.
 		</releaseNotes>
 		<copyright>Copyright 2013 - 2023</copyright>
     	<tags>REST query language abstract syntax tree parser sql-injection protection friendly readable domain-specific DSL</tags>

diff --git a/src/Searchlight/Autocomplete/CompletionList.cs b/src/Searchlight/Autocomplete/CompletionList.cs
@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 namespace Searchlight.Autocomplete
 {

diff --git a/src/Searchlight/DataSource.cs b/src/Searchlight/DataSource.cs
@@ -65,15 +65,15 @@ public class DataSource
         /// <returns></returns>
         public DataSource WithColumn(string columnName, Type columnType)
         {
-            return WithRenamingColumn(columnName, columnName, null, columnType, null);
+            return WithRenamingColumn(columnName, columnName, null, columnType, null, null);
         }
 
         /// <summary>
         /// Add a column to this definition
         /// </summary>
-        public DataSource WithRenamingColumn(string filterName, string columnName, string[] aliases, Type columnType, string description)
+        public DataSource WithRenamingColumn(string filterName, string columnName, string[] aliases, Type columnType, Type enumType, string description)
         {
-            var columnInfo = new ColumnInfo(filterName, columnName, aliases, columnType, description);
+            var columnInfo = new ColumnInfo(filterName, columnName, aliases, columnType, enumType, description);
             _columns.Add(columnInfo);
 
             // Allow the API caller to either specify either the model name or one of the aliases
@@ -200,9 +200,10 @@ public static DataSource Create(SearchlightEngine engine, Type modelType, Attrib
                         if (filter != null)
                         {
                             // If this is a renaming column, add it appropriately
-                            Type t = filter.FieldType ?? pi.PropertyType;
-                            src.WithRenamingColumn(pi.Name, filter.OriginalName ?? pi.Name,
-                                filter.Aliases ?? Array.Empty<string>(), t, filter.Description);
+                            var t = filter.FieldType ?? pi.PropertyType;
+                            var columnName = filter.OriginalName ?? pi.Name;
+                            var aliases = filter.Aliases ?? Array.Empty<string>();
+                            src.WithRenamingColumn(pi.Name, columnName, aliases, t, filter.EnumType, filter.Description);
                         }
 
                         var collection = pi.GetCustomAttributes<SearchlightCollection>().FirstOrDefault();

diff --git a/src/Searchlight/Exceptions/TableNotFoundException.cs b/src/Searchlight/Exceptions/TableNotFoundException.cs
@@ -1,4 +1,6 @@
-namespace Searchlight.Exceptions
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace Searchlight.Exceptions
 {
     public class TableNotFoundException : SearchlightException
     {

diff --git a/src/Searchlight/LinqExecutor.cs b/src/Searchlight/LinqExecutor.cs
@@ -163,6 +163,12 @@ private static Expression BuildOneExpression<T>(ParameterExpression select, Base
                     // Set up LINQ expressions for this object
                     var valueType = criteria.Column.FieldType;
                     field = Expression.Property(select, criteria.Column.FieldName);
+                    if (field.Type.IsEnum)
+                    {
+                        valueType = field.Type;
+                        rawValue = Enum.Parse(valueType, rawValue.ToString());
+                    }
+
                     value = Expression.Constant(rawValue, valueType);
                     switch (criteria.Operation)
                     {

diff --git a/src/Searchlight/Parsing/ColumnInfo.cs b/src/Searchlight/Parsing/ColumnInfo.cs
@@ -14,12 +14,20 @@ public class ColumnInfo
         /// <param name="columnName">The name of the column in the database</param>
         /// <param name="aliases">If this field is known by other names, list them here</param>
         /// <param name="columnType">The raw type of the column in the database</param>
-        public ColumnInfo(string filterName, string columnName, string[] aliases, Type columnType, string description)
+        /// <param name="enumType">The type of the enum that the column is mapped to</param>
+        /// <param name="description">A description of the column for autocomplete</param>
+        public ColumnInfo(string filterName, string columnName, string[] aliases, Type columnType, Type enumType, string description)
         {
             FieldName = filterName;
             OriginalName = columnName;
             FieldType = columnType;
             Aliases = aliases;
+            if (enumType != null && !enumType.IsEnum)
+            {
+                throw new ArgumentException("Must specify an enum type", nameof(enumType));
+            }
+
+            EnumType = enumType;
             Description = description;
         }
 
@@ -43,6 +51,12 @@ public ColumnInfo(string filterName, string columnName, string[] aliases, Type c
         /// </summary>
         public Type FieldType { get; private set; }
 
+        /// <summary>
+        /// When the user specifies a field to be an enum, the parameter must be mapped by this type
+        /// ex. The field type is int and enum is CarType { Sedan = 0, SUV = 1 } so "Sedan" should translate to 0
+        /// </summary>
+        public Type EnumType { get; private set; }
+
         /// <summary>
         /// Detailed field documentation for autocomplete, if provided.
         /// </summary>

diff --git a/src/Searchlight/Parsing/SyntaxParser.cs b/src/Searchlight/Parsing/SyntaxParser.cs
@@ -8,6 +8,9 @@
 
 namespace Searchlight.Parsing
 {
+    /// <summary>
+    /// Static class for syntax parsing
+    /// </summary>
     public static class SyntaxParser
     {
         /// <summary>
@@ -517,7 +520,27 @@ private static IExpressionValue ParseParameter(SyntaxTree syntax, ColumnInfo col
                         return computedValue;
                     }
                 }
-
+
+                // Special case for enum types
+                if (column.EnumType != null || fieldType.IsEnum)
+                {
+                    try
+                    {
+                        var parsed = Enum.Parse(column.EnumType ?? fieldType, valueToken);
+                        return ConstantValue.From(Convert.ChangeType(parsed, fieldType));
+                    }
+                    catch
+                    {
+                        syntax.AddError(new InvalidToken
+                        {
+                            BadToken = valueToken,
+                            ExpectedTokens = Enum.GetNames(column.EnumType ?? fieldType),
+                            OriginalFilter = tokens.OriginalText,
+                        });
+                        return null;
+                    }
+                }
+
                 // All other types use a basic type changer
                 return ConstantValue.From(Convert.ChangeType(valueToken, fieldType));
             }

diff --git a/src/Searchlight/Parsing/Token.cs b/src/Searchlight/Parsing/Token.cs
@@ -1,4 +1,6 @@
-namespace Searchlight.Parsing
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace Searchlight.Parsing
 {
     public class Token
     {

diff --git a/src/Searchlight/Query/MalformedClause.cs b/src/Searchlight/Query/MalformedClause.cs
@@ -1,4 +1,6 @@
-namespace Searchlight.Query
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace Searchlight.Query
 {
     public class MalformedClause : BaseClause
     {

diff --git a/tests/Searchlight.Tests/Executors/EmployeeTestSuite.cs b/tests/Searchlight.Tests/Executors/EmployeeTestSuite.cs
@@ -56,6 +56,7 @@ public static async Task BasicTestSuite(DataSource src, List<EmployeeObj> list,
             await suite.PageNumberNoPageSize();
             await suite.PageSizeNoPageNumber();
             await suite.PageSizeAndPageNumber();
+            await suite.EnumTranslation();
         }
 
         /// <summary>
@@ -630,5 +631,21 @@ private async Task PageSizeAndPageNumber()
 
             Assert.AreEqual(result.records.Length, 1);
         }
+
+        private async Task EnumTranslation()
+        {
+            var syntax = _src.ParseFilter("employeetype eq FullTime");
+            var result = await _executor(syntax);
+            Assert.AreEqual(8, result.records.Length);
+
+            // Both string name and underlying type work
+            syntax = _src.ParseFilter("employeetype eq 0");
+            result = await _executor(syntax);
+            Assert.AreEqual(8, result.records.Length);
+
+            syntax = _src.ParseFilter("employeetype eq Contract");
+            result = await _executor(syntax);
+            Assert.AreEqual(1, result.records.Length);
+        }
     }
 }
diff --git a/tests/Searchlight.Tests/Executors/LinqExecutorTests.cs b/tests/Searchlight.Tests/Executors/LinqExecutorTests.cs
@@ -27,7 +27,7 @@ public class LinqExecutorTests
         public void SetupTests()
         {
             _list = EmployeeObj.GetTestList();
-            _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Loose);
+            _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Strict);
             _linq = async tree => 
             {
                 await Task.CompletedTask;

diff --git a/tests/Searchlight.Tests/Executors/MongoDBExecutorTests.cs b/tests/Searchlight.Tests/Executors/MongoDBExecutorTests.cs
@@ -25,7 +25,7 @@ public class MongoDbExecutorTests
         [TestInitialize]
         public async Task SetupMongoClient()
         {
-            _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Loose);
+            _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Strict);
             var options = new MongoRunnerOptions();
             _runner = MongoRunner.Run(options);
 

diff --git a/tests/Searchlight.Tests/Executors/MysqlExecutorTests.cs b/tests/Searchlight.Tests/Executors/MysqlExecutorTests.cs
@@ -21,7 +21,7 @@ public class MysqlExecutorTests
     [TestInitialize]
     public async Task SetupClient()
     {
-        _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Loose);
+        _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Strict);
         _container = new MySqlBuilder()
             .Build();
         await _container.StartAsync();
@@ -33,21 +33,25 @@ public async Task SetupClient()
             await connection.OpenAsync();
 
             // Create basic table
-            await using (var command = new MySqlCommand("CREATE TABLE EmployeeObj (name text null, id int not null, hired timestamp, paycheck decimal, onduty bit)", connection))
+            await using (var command =
+                         new MySqlCommand(
+                             "CREATE TABLE EmployeeObj (name text null, id int not null, hired timestamp, paycheck decimal, onduty bit, employeetype int not null)",
+                             connection))
             {
                 await command.ExecuteNonQueryAsync();
             }
 
             // Insert rows
             foreach (var record in EmployeeObj.GetTestList())
             {
-                await using (var command = new MySqlCommand("INSERT INTO EmployeeObj (name, id, hired, paycheck, onduty) VALUES (@name, @id, @hired, @paycheck, @onduty)", connection))
+                await using (var command = new MySqlCommand("INSERT INTO EmployeeObj (name, id, hired, paycheck, onduty, employeetype) VALUES (@name, @id, @hired, @paycheck, @onduty, @employeetype)", connection))
                 {
                     command.Parameters.AddWithValue("@name", (object)record.name ?? DBNull.Value);
                     command.Parameters.AddWithValue("@id", record.id);
                     command.Parameters.AddWithValue("@hired", record.hired);
                     command.Parameters.AddWithValue("@paycheck", record.paycheck);
                     command.Parameters.AddWithValue("@onduty", record.onduty);
+                    command.Parameters.AddWithValue("@employeetype", record.employeeType);
                     await command.ExecuteNonQueryAsync();
                 }
             }
@@ -82,6 +86,7 @@ public async Task SetupClient()
                                 hired = reader.GetDateTime(2),
                                 paycheck = reader.GetDecimal(3),
                                 onduty = reader.GetBoolean(4),
+                                employeeType = (EmployeeObj.EmployeeType)reader.GetInt32(5),
                             });
                         }
                     }

diff --git a/tests/Searchlight.Tests/Executors/PostgresExecutorTests.cs b/tests/Searchlight.Tests/Executors/PostgresExecutorTests.cs
@@ -22,7 +22,7 @@ public class PostgresExecutorTests
     [TestInitialize]
     public async Task SetupClient()
     {
-        _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Loose);
+        _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Strict);
         _container = new PostgreSqlBuilder()
             .Build();
         await _container.StartAsync();
@@ -34,21 +34,25 @@ public async Task SetupClient()
             await connection.OpenAsync();
 
             // Create basic table
-            await using (var command = new NpgsqlCommand("CREATE TABLE employeeobj (name text null, id int not null, hired timestamp with time zone, paycheck numeric, onduty bool)", connection))
+            await using (var command =
+                         new NpgsqlCommand(
+                             "CREATE TABLE employeeobj (name text null, id int not null, hired timestamp with time zone, paycheck numeric, onduty bool, employeetype int not null)",
+                             connection))
             {
                 await command.ExecuteNonQueryAsync();
             }
 
             // Insert rows
             foreach (var record in EmployeeObj.GetTestList())
             {
-                await using (var command = new NpgsqlCommand("INSERT INTO employeeobj (name, id, hired, paycheck, onduty) VALUES (@name, @id, @hired, @paycheck, @onduty)", connection))
+                await using (var command = new NpgsqlCommand("INSERT INTO employeeobj (name, id, hired, paycheck, onduty, employeetype) VALUES (@name, @id, @hired, @paycheck, @onduty, @employeetype)", connection))
                 {
                     command.Parameters.AddWithValue("@name", NpgsqlDbType.Text, (object)record.name ?? DBNull.Value);
                     command.Parameters.AddWithValue("@id", NpgsqlDbType.Integer, record.id);
                     command.Parameters.AddWithValue("@hired", NpgsqlDbType.TimestampTz, record.hired);
                     command.Parameters.AddWithValue("@paycheck", NpgsqlDbType.Numeric, record.paycheck);
                     command.Parameters.AddWithValue("@onduty", NpgsqlDbType.Boolean, record.onduty);
+                    command.Parameters.AddWithValue("@employeetype", NpgsqlDbType.Integer, (int)record.employeeType);
                     await command.ExecuteNonQueryAsync();
                 }
             }
@@ -84,6 +88,7 @@ public async Task SetupClient()
                                 hired = reader.GetDateTime(2),
                                 paycheck = reader.GetDecimal(3),
                                 onduty = reader.GetBoolean(4),
+                                employeeType = (EmployeeObj.EmployeeType)reader.GetInt32(5),
                             });
                         }
                     }
@@ -108,19 +113,19 @@ private NpgsqlDbType ConvertNpgsqlType(Type parameterType)
         {
             return NpgsqlDbType.Boolean;
         }
-        else if (parameterType == typeof(string))
+        if (parameterType == typeof(string))
         {
             return NpgsqlDbType.Text;
         }
-        else if (parameterType == typeof(Int32))
+        if (parameterType == typeof(Int32))
         {
             return NpgsqlDbType.Integer;
         }
-        else if (parameterType == typeof(decimal))
+        if (parameterType == typeof(decimal))
         {
             return NpgsqlDbType.Numeric;
         }
-        else if (parameterType == typeof(DateTime))
+        if (parameterType == typeof(DateTime))
         {
             return NpgsqlDbType.TimestampTz;
         }

diff --git a/tests/Searchlight.Tests/Executors/SqlServerExecutorTests.cs b/tests/Searchlight.Tests/Executors/SqlServerExecutorTests.cs
@@ -22,7 +22,7 @@ public class SqlServerExecutorTests
     [TestInitialize]
     public async Task SetupClient()
     {
-        _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Loose);
+        _src = DataSource.Create(null, typeof(EmployeeObj), AttributeMode.Strict);
         _container = new MsSqlBuilder()
             .Build();
         await _container.StartAsync();
@@ -32,23 +32,27 @@ public async Task SetupClient()
         using (var connection = new SqlConnection(_connectionString))
         {
             await connection.OpenAsync();
-            
+
             // Create basic table
-            using (var command = new SqlCommand("CREATE TABLE employeeobj (name nvarchar(255) null, id int not null, hired datetime not null, paycheck decimal not null, onduty bit not null)", connection))
+            using (var command =
+                   new SqlCommand(
+                       "CREATE TABLE employeeobj (name nvarchar(255) null, id int not null, hired datetime not null, paycheck decimal not null, onduty bit not null, employeetype int null DEFAULT 0)",
+                       connection))
             {
                 await command.ExecuteNonQueryAsync();
             }
 
             // Insert rows
             foreach (var record in EmployeeObj.GetTestList())
             {
-                using (var command = new SqlCommand("INSERT INTO employeeobj (name, id, hired, paycheck, onduty) VALUES (@name, @id, @hired, @paycheck, @onduty)", connection))
+                using (var command = new SqlCommand("INSERT INTO employeeobj (name, id, hired, paycheck, onduty, employeetype) VALUES (@name, @id, @hired, @paycheck, @onduty, @employeetype)", connection))
                 {
                     command.Parameters.AddWithValue("@name", (object)record.name ?? DBNull.Value);
                     command.Parameters.AddWithValue("@id", record.id);
                     command.Parameters.AddWithValue("@hired", record.hired);
                     command.Parameters.AddWithValue("@paycheck", record.paycheck);
                     command.Parameters.AddWithValue("@onduty", record.onduty);
+                    command.Parameters.AddWithValue("@employeetype", record.employeeType);
                     await command.ExecuteNonQueryAsync();
                 }
             }
@@ -96,6 +100,7 @@ public async Task SetupClient()
                                 hired = reader.GetDateTime("hired"),
                                 paycheck = reader.GetDecimal("paycheck"),
                                 onduty = reader.GetBoolean("onduty"),
+                                employeeType = (EmployeeObj.EmployeeType)reader.GetInt32(5),
                             });
                         }
                     }