Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[5.0.x] SqlServer: Add Cast to (n)varchar(max) when injecting Concat for multi-line seed data #24944

Merged
merged 1 commit into from
Jun 1, 2021
Merged

[5.0.x] SqlServer: Add Cast to (n)varchar(max) when injecting Concat for multi-line seed data #24944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
117 changes: 116 additions & 1 deletion src/EFCore.SqlServer/Migrations/SqlServerMigrationsSqlGenerator.cs
View file
Open in desktop
Expand Up @@ -1877,6 +1877,7 @@ protected override void ForeignKeyAction(ReferentialAction referentialAction, Mi
bool omitVariableDeclarations = false)
{
var stringTypeMapping = Dependencies.TypeMappingSource.GetMapping(typeof(string));
var useOldBehavior = AppContext.TryGetSwitch("Microsoft.EntityFrameworkCore.Issue24112", out var enabled) && enabled;

string schemaLiteral;
if (schema == null)
Expand Down Expand Up @@ -1923,7 +1924,121 @@ protected override void ForeignKeyAction(ReferentialAction referentialAction, Mi
builder.AppendLine(Dependencies.SqlGenerationHelper.StatementTerminator);

string Literal(string s)
=> stringTypeMapping.GenerateSqlLiteral(s);
=> useOldBehavior
? stringTypeMapping.GenerateSqlLiteral(s)
: SqlLiteral(s);

static string SqlLiteral(string value)
{
var builder = new StringBuilder();

var start = 0;
int i;
int length;
var openApostrophe = false;
var lastConcatStartPoint = 0;
var concatCount = 1;
var concatStartList = new List<int>();
for (i = 0; i < value.Length; i++)
{
var lineFeed = value[i] == '\n';
var carriageReturn = value[i] == '\r';
var apostrophe = value[i] == '\'';
if (lineFeed || carriageReturn || apostrophe)
{
length = i - start;
if (length != 0)
{
if (!openApostrophe)
{
AddConcatOperatorIfNeeded();
builder.Append("N\'");
openApostrophe = true;
}

builder.Append(value.AsSpan().Slice(start, length));
}

if (lineFeed || carriageReturn)
{
if (openApostrophe)
{
builder.Append('\'');
openApostrophe = false;
}

AddConcatOperatorIfNeeded();
builder
.Append("NCHAR(")
.Append(lineFeed ? "10" : "13")
.Append(')');
}
else if (apostrophe)
{
if (!openApostrophe)
{
AddConcatOperatorIfNeeded();
builder.Append("N'");
openApostrophe = true;
}
builder.Append("''");
}
start = i + 1;
}
}
length = i - start;
if (length != 0)
{
if (!openApostrophe)
{
AddConcatOperatorIfNeeded();
builder.Append("N\'");
openApostrophe = true;
}

builder.Append(value.AsSpan().Slice(start, length));
}

if (openApostrophe)
{
builder.Append('\'');
}

for (var j = concatStartList.Count - 1; j >= 0; j--)
{
builder.Insert(concatStartList[j], "CONCAT(");
builder.Append(')');
}

if (builder.Length == 0)
{
builder.Append("N''");
}

var result = builder.ToString();

return result;

void AddConcatOperatorIfNeeded()
{
if (builder.Length != 0)
{
builder.Append(", ");
concatCount++;

if (concatCount == 2)
{
concatStartList.Add(lastConcatStartPoint);
}

if (concatCount == 254)
{
lastConcatStartPoint = builder.Length;
concatCount = 1;
}
}
}
}
}

/// <summary>
Expand Down
26 changes: 22 additions & 4 deletions src/EFCore.SqlServer/Storage/Internal/SqlServerStringTypeMapping.cs
View file
Open in desktop
Expand Up @@ -176,6 +176,8 @@ protected override string GenerateNonNullSqlLiteral(object value)
var concatCount = 1;
var concatStartList = new List<int>();
var useOldBehavior = AppContext.TryGetSwitch("Microsoft.EntityFrameworkCore.Issue23518", out var enabled) && enabled;
var useOldBehavior2 = AppContext.TryGetSwitch("Microsoft.EntityFrameworkCore.Issue24112", out var enabled2) && enabled2;
var castApplied = false;
for (i = 0; i < stringValue.Length; i++)
{
var lineFeed = stringValue[i] == '\n';
Expand Down Expand Up @@ -214,11 +216,11 @@ protected override string GenerateNonNullSqlLiteral(object value)

if (IsUnicode)
{
builder.Append('N');
builder.Append('n');
}

builder
.Append("CHAR(")
.Append("char(")
.Append(lineFeed ? "10" : "13")
.Append(')');
}
Expand Down Expand Up @@ -277,8 +279,12 @@ protected override string GenerateNonNullSqlLiteral(object value)
{
for (var j = concatStartList.Count - 1; j >= 0; j--)
{
builder.Insert(concatStartList[j], "CONCAT(")
.Append(')');
if (castApplied && j == 0)
{
builder.Insert(concatStartList[j], "CAST(");
}
builder.Insert(concatStartList[j], "CONCAT(");
builder.Append(')');
}
}

Expand All @@ -298,6 +304,18 @@ void AddConcatOperatorIfNeeded()
{
if (builder.Length != 0)
{
if (!useOldBehavior2
&& !castApplied)
{
builder.Append(" AS ");
if (IsUnicode)
{
builder.Append("n");
}
builder.Append("varchar(max))");
castApplied = true;
}

builder.Append(", ");
if (useOldBehavior)
{
Expand Down
3 changes: 2 additions & 1 deletion test/EFCore.SqlServer.Tests/Migrations/SqlServerMigrationsSqlGeneratorTest.cs
View file
Open in desktop
Expand Up @@ -962,8 +962,9 @@ public override void DefaultValue_with_line_breaks(bool isUnicode)

var storeType = isUnicode ? "nvarchar(max)" : "varchar(max)";
var unicodePrefix = isUnicode ? "N" : string.Empty;
var unicodePrefixForType = isUnicode ? "n" : string.Empty;
var expectedSql = @$"CREATE TABLE [dbo].[TestLineBreaks] (
[TestDefaultValue] {storeType} NOT NULL DEFAULT CONCAT({unicodePrefix}CHAR(13), {unicodePrefix}CHAR(10), {unicodePrefix}'Various Line', {unicodePrefix}CHAR(13), {unicodePrefix}'Breaks', {unicodePrefix}CHAR(10))
[TestDefaultValue] {storeType} NOT NULL DEFAULT CONCAT(CAST({unicodePrefixForType}char(13) AS {storeType}), {unicodePrefixForType}char(10), {unicodePrefix}'Various Line', {unicodePrefixForType}char(13), {unicodePrefix}'Breaks', {unicodePrefixForType}char(10))
);
";
AssertSql(expectedSql);
Expand Down
40 changes: 20 additions & 20 deletions test/EFCore.SqlServer.Tests/Storage/SqlServerStringTypeMappingTest.cs
View file
Open in desktop
Expand Up @@ -17,16 +17,16 @@ public class SqlServerStringTypeMappingTest
[InlineData("''", "''''''")]
[InlineData("I'm lovin'", "'I''m lovin'''")]
[InlineData("I'm lovin' it", "'I''m lovin'' it'")]
[InlineData("\r", "CHAR(13)")]
[InlineData("\n", "CHAR(10)")]
[InlineData("\r\n", "CONCAT(CHAR(13), CHAR(10))")]
[InlineData("\n'sup", "CONCAT(CHAR(10), '''sup')")]
[InlineData("I'm\n", "CONCAT('I''m', CHAR(10))")]
[InlineData("lovin'\n", "CONCAT('lovin''', CHAR(10))")]
[InlineData("it\n", "CONCAT('it', CHAR(10))")]
[InlineData("\nit", "CONCAT(CHAR(10), 'it')")]
[InlineData("\nit\n", "CONCAT(CHAR(10), 'it', CHAR(10))")]
[InlineData("'\n", "CONCAT('''', CHAR(10))")]
[InlineData("\r", "char(13)")]
[InlineData("\n", "char(10)")]
[InlineData("\r\n", "CONCAT(CAST(char(13) AS varchar(max)), char(10))")]
[InlineData("\n'sup", "CONCAT(CAST(char(10) AS varchar(max)), '''sup')")]
[InlineData("I'm\n", "CONCAT(CAST('I''m' AS varchar(max)), char(10))")]
[InlineData("lovin'\n", "CONCAT(CAST('lovin''' AS varchar(max)), char(10))")]
[InlineData("it\n", "CONCAT(CAST('it' AS varchar(max)), char(10))")]
[InlineData("\nit", "CONCAT(CAST(char(10) AS varchar(max)), 'it')")]
[InlineData("\nit\n", "CONCAT(CAST(char(10) AS varchar(max)), 'it', char(10))")]
[InlineData("'\n", "CONCAT(CAST('''' AS varchar(max)), char(10))")]
public void GenerateProviderValueSqlLiteral_works(string value, string expected)
{
var mapping = new SqlServerStringTypeMapping("varchar(max)");
Expand All @@ -43,16 +43,16 @@ public void GenerateProviderValueSqlLiteral_works(string value, string expected)
[InlineData("''", "N''''''")]
[InlineData("I'm lovin'", "N'I''m lovin'''")]
[InlineData("I'm lovin' it", "N'I''m lovin'' it'")]
[InlineData("\r", "NCHAR(13)")]
[InlineData("\n", "NCHAR(10)")]
[InlineData("\r\n", "CONCAT(NCHAR(13), NCHAR(10))")]
[InlineData("\n'sup", "CONCAT(NCHAR(10), N'''sup')")]
[InlineData("I'm\n", "CONCAT(N'I''m', NCHAR(10))")]
[InlineData("lovin'\n", "CONCAT(N'lovin''', NCHAR(10))")]
[InlineData("it\n", "CONCAT(N'it', NCHAR(10))")]
[InlineData("\nit", "CONCAT(NCHAR(10), N'it')")]
[InlineData("\nit\n", "CONCAT(NCHAR(10), N'it', NCHAR(10))")]
[InlineData("'\n", "CONCAT(N'''', NCHAR(10))")]
[InlineData("\r", "nchar(13)")]
[InlineData("\n", "nchar(10)")]
[InlineData("\r\n", "CONCAT(CAST(nchar(13) AS nvarchar(max)), nchar(10))")]
[InlineData("\n'sup", "CONCAT(CAST(nchar(10) AS nvarchar(max)), N'''sup')")]
[InlineData("I'm\n", "CONCAT(CAST(N'I''m' AS nvarchar(max)), nchar(10))")]
[InlineData("lovin'\n", "CONCAT(CAST(N'lovin''' AS nvarchar(max)), nchar(10))")]
[InlineData("it\n", "CONCAT(CAST(N'it' AS nvarchar(max)), nchar(10))")]
[InlineData("\nit", "CONCAT(CAST(nchar(10) AS nvarchar(max)), N'it')")]
[InlineData("\nit\n", "CONCAT(CAST(nchar(10) AS nvarchar(max)), N'it', nchar(10))")]
[InlineData("'\n", "CONCAT(CAST(N'''' AS nvarchar(max)), nchar(10))")]
public void GenerateProviderValueSqlLiteral_works_unicode(string value, string expected)
{
var mapping = new SqlServerStringTypeMapping("nvarchar(max)", unicode: true);
Expand Down