Merge pull request #364 from piaste/improve_trace_string

Improve trace string which was failing for several parameter types.

Author: smoothdeveloper

src/SqlClient/ISqlCommand.fs

@@ -134,7 +134,11 @@ type ``ISqlCommand Implementation``(cfg: DesignTimeConfig, connection: Connectio
         member this.ToTraceString parameters =  
             ``ISqlCommand Implementation``.SetParameters(cmd, parameters)
             let parameterDefinition (p : SqlParameter) =
-                if p.Size <> 0 then
+                // tinyint and Xml have size 1 and -1 respectively, but MSSQL will throw if they are specified
+                if p.Size <> 0 && 
+                   p.SqlDbType <> SqlDbType.Xml && 
+                   p.SqlDbType <> SqlDbType.TinyInt then
+                   
                     sprintf "%s %A(%d)" p.ParameterName p.SqlDbType p.Size
                 else
                     sprintf "%s %A" p.ParameterName p.SqlDbType 
@@ -153,7 +157,17 @@ type ``ISqlCommand Implementation``(cfg: DesignTimeConfig, connection: Connectio
                 if parameters.Length > 0 
                 then 
                     yield parameters
-                        |> Seq.map(fun (name,value) -> sprintf "%s='%O'" name value) 
+                        |> Seq.map(fun (name,value) ->                             
+                            let printedValue =                                 
+                                match value with
+                                // print dates in roundtrip ISO8601 format "O"
+                                | :? System.DateTime as d -> d.ToString("O")
+                                // print timespans in constant format "c
+                                | :? System.TimeSpan as t -> t.ToString("c")
+                                | v -> sprintf "%O" v
+                            // escapes the resulting value
+                            sprintf "%s='%s'" name (printedValue.Replace("'", "''"))
+                        )                            
                         |> String.concat ","
             } |> String.concat "," //Using string.concat to handle annoying case with no parameters
 

tests/SqlClient.Tests/CreateCommand.fs

@@ -85,8 +85,9 @@ let columnsShouldNotBeNull2() =
 [<Fact>]
 let toTraceString() =
     let now = System.DateTime.Now
+    let universalNow = now.ToString("O")
     let num = 42
-    let expected = sprintf "exec sp_executesql N'SELECT CAST(@Date AS DATE), CAST(@Number AS INT)',N'@Date Date,@Number Int',@Date='%A',@Number='%d'" now num
+    let expected = sprintf "exec sp_executesql N'SELECT CAST(@Date AS DATE), CAST(@Number AS INT)',N'@Date Date,@Number Int',@Date='%s',@Number='%d'" universalNow num
     let cmd = DB.CreateCommand<"SELECT CAST(@Date AS DATE), CAST(@Number AS INT)", ResultType.Tuples>()
     Assert.Equal<string>(
         expected, 
@@ -170,4 +171,4 @@ let ``connection is properly disposed`` () =
     use reader = cmd.Execute()
     ()
 
-  Assert.True isDisposed
+  Assert.True isDisposed

tests/SqlClient.Tests/TypeProviderTest.fs

@@ -89,13 +89,47 @@ let singleRowOption() =
 [<Fact>]
 let ToTraceString() =
     let now = DateTime.Now
+    let universalPrintedNow = now.ToString("O")
     let num = 42
-    let expected = sprintf "exec sp_executesql N'SELECT CAST(@Date AS DATE), CAST(@Number AS INT)',N'@Date Date,@Number Int',@Date='%A',@Number='%d'" now num
+    let expected = sprintf "exec sp_executesql N'SELECT CAST(@Date AS DATE), CAST(@Number AS INT)',N'@Date Date,@Number Int',@Date='%s',@Number='%d'" universalPrintedNow num
     let cmd = new SqlCommandProvider<"SELECT CAST(@Date AS DATE), CAST(@Number AS INT)", ConnectionStrings.AdventureWorksNamed, ResultType.Tuples>()
     Assert.Equal<string>(
         expected, 
         actual = cmd.ToTraceString( now, num)
     )
+    
+let runString query = 
+    use conn = new SqlConnection(ConnectionStrings.AdventureWorks)
+    conn.Open()
+    use cmd = new System.Data.SqlClient.SqlCommand()
+    cmd.Connection <- conn  
+    cmd.CommandText <- query
+    cmd.ExecuteNonQuery()
+    
+[<Fact>]
+let ``ToTraceString for dates``() =    
+    let cmd = new SqlCommandProvider<"SELECT CAST(@Date AS DATE)", ConnectionStrings.AdventureWorksNamed>()
+    runString <| cmd.ToTraceString(System.DateTime.Now)
+    
+[<Fact>]
+let ``ToTraceString for times``() =    
+    let cmd = new SqlCommandProvider<"SELECT CAST(@Time AS Time)", ConnectionStrings.AdventureWorksNamed>()
+    runString <| cmd.ToTraceString(System.DateTime.Now.TimeOfDay)
+    
+[<Fact>]
+let ``ToTraceString for tinyint``() =    
+    let cmd = new SqlCommandProvider<"SELECT CAST(@ti AS TINYINT)", ConnectionStrings.AdventureWorksNamed>()
+    runString <| cmd.ToTraceString(0uy)
+    
+[<Fact>]
+let ``ToTraceString for xml``() =    
+    let cmd = new SqlCommandProvider<"SELECT CAST(@x AS XML)", ConnectionStrings.AdventureWorksNamed>()
+    runString <| cmd.ToTraceString("<foo>bar</foo>")
+    
+[<Fact>]
+let ``ToTraceString for xml with single quotes``() =    
+    let cmd = new SqlCommandProvider<"SELECT CAST(@x AS XML)", ConnectionStrings.AdventureWorksNamed>()
+    runString <| cmd.ToTraceString("<foo>b'ar</foo>")    
 
 [<Fact>]
 let ``ToTraceString for CRUD``() =    
@@ -121,6 +155,15 @@ let ``ToTraceString double-quotes``() =
     let trace = cmd.ToTraceString()
     Assert.Equal<string>("exec sp_executesql N'SELECT OBJECT_ID(''Sales.Currency'')'", trace)
 
+    
+[<Fact>]
+let ``ToTraceString double-quotes in parameter``() =    
+    use cmd = new SqlCommandProvider<"SELECT * FROM Sales.Currency WHERE CurrencyCode = @CurrencyCode", ConnectionStrings.AdventureWorksNamed>()    
+    Assert.Equal<string>(
+        expected = "exec sp_executesql N'SELECT * FROM Sales.Currency WHERE CurrencyCode = @CurrencyCode',N'@CurrencyCode NChar(3)',@CurrencyCode='A''B'",
+        actual = cmd.ToTraceString("A'B")
+    )
+    
 [<Fact(
     Skip = "Don't execute for usual runs. Too slow."
     )>]