Resolving Migration step conflict for Orchard.Projections too, fixing logic Orchard.Core/Common

This commit is contained in:
Benedek Farkas 2023-07-18 22:05:59 +02:00
parent 37ab0cd8d1
commit 01b3f2429f
2 changed files with 88 additions and 27 deletions

View File

@ -167,7 +167,8 @@ namespace Orchard.Core.Common {
return 6;
}
// When upgrading from version 6 of 1.10.x, we'll just execute the same steps, but in a different order.
// When upgrading from version 6 of 1.10.x (up until version 9), we'll just execute the same steps, but in a
// different order.
public int UpdateFrom6() {
// This is the original step of the dev branch.
AddIndexForIdentityPartRecordIdentifier();
@ -208,7 +209,7 @@ namespace Orchard.Core.Common {
indexName,
nameof(IdentityPartRecord.Identifier)));
_existingIndexNames.Add(indexName);
IndexCreated(nameof(IdentityPartRecord), indexName);
}
// This change was originally UpdateFrom8 on 1.10.x and UpdateFrom7 on dev.
@ -220,22 +221,18 @@ namespace Orchard.Core.Common {
// Container_Id is used in several queries like a foreign key.
SchemaBuilder.AlterTable(nameof(CommonPartRecord), table => table.CreateIndex(indexName, "Container_id"));
_existingIndexNames.Add(indexName);
IndexCreated(nameof(CommonPartRecord), indexName);
}
// This change was originally UpdateFrom6 on 1.10.x and UpdateFrom8 on dev.
private void AddIndexesForCommonPartOwner() {
// Studying SQL Server query execution plans we noticed that when the system
// tries to find content items for requests such as
// "The items of type TTT owned by me, ordered from the most recent"
// the existing indexes are not used. SQL Server does an index scan on the
// Primary key for CommonPartRecord. This may lead to annoying deadlocks when
// there are two concurrent transactions that are doing both this kind of query
// as well as an update (or insert) in the CommonPartRecord.
// Tests show that this can be easily fixed by adding a non-clustered index
// with these keys: OwnerId, {one of PublishedUTC, ModifiedUTC, CreatedUTC}.
// That means we need three indexes (one for each DateTime) to support ordering
// on either of them.
// Studying SQL Server query execution plans we noticed that when the system tries to find content items for
// requests such as "The items of type TTT owned by me, ordered from the most recent" the existing indexes
// are not used. SQL Server does an index scan on the Primary key for CommonPartRecord. This may lead to
// annoying deadlocks when there are two concurrent transactions that are doing both this kind of query as
// well as an update (or insert) in the CommonPartRecord. Tests show that this can be easily fixed by adding
// a non-clustered index with these keys: OwnerId, {one of PublishedUTC, ModifiedUTC, CreatedUTC}. That
// means we need three indexes (one for each DateTime) to support ordering on either of them.
// The queries we analyzed look like (in pseudo sql)
// SELECT TOP (N) *
@ -262,9 +259,9 @@ namespace Orchard.Core.Common {
table.CreateIndex(publishedUtcIndexName, nameof(CommonPartRecord.OwnerId), nameof(CommonPartRecord.PublishedUtc));
});
_existingIndexNames.Add(createdUtcIndexName);
_existingIndexNames.Add(modifiedUtcIndexName);
_existingIndexNames.Add(publishedUtcIndexName);
IndexCreated(nameof(CommonPartRecord), createdUtcIndexName);
IndexCreated(nameof(CommonPartRecord), modifiedUtcIndexName);
IndexCreated(nameof(CommonPartRecord), publishedUtcIndexName);
}
private bool IndexExists(string tableName, string indexName) {
@ -289,5 +286,12 @@ namespace Orchard.Core.Common {
return _existingIndexNames.Contains($"{SchemaBuilder.TableDbName(tableName)}.{tenantTablesPrefix}{indexName}");
}
private void IndexCreated(string tableName, string indexName) {
var tenantTablesPrefix = string.IsNullOrEmpty(_shellSettings.DataTablePrefix)
? string.Empty : $"{_shellSettings.DataTablePrefix}_";
_existingIndexNames.Add($"{SchemaBuilder.TableDbName(tableName)}.{tenantTablesPrefix}{indexName}");
}
}
}

View File

@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using System.Data;
using System.Linq;
using Orchard.ContentManagement.MetaData;
@ -7,6 +8,7 @@ using Orchard.Core.Contents.Extensions;
using Orchard.Core.Title.Models;
using Orchard.Data;
using Orchard.Data.Migration;
using Orchard.Environment.Configuration;
using Orchard.Localization;
using Orchard.Projections.Models;
@ -15,14 +17,22 @@ namespace Orchard.Projections {
private readonly IRepository<MemberBindingRecord> _memberBindingRepository;
private readonly IRepository<LayoutRecord> _layoutRepository;
private readonly IRepository<PropertyRecord> _propertyRecordRepository;
private readonly ISessionFactoryHolder _sessionFactoryHolder;
private readonly ShellSettings _shellSettings;
private HashSet<string> _existingColumnNames = new HashSet<string>();
public Migrations(
IRepository<MemberBindingRecord> memberBindingRepository,
IRepository<LayoutRecord> layoutRepository,
IRepository<PropertyRecord> propertyRecordRepository) {
IRepository<PropertyRecord> propertyRecordRepository,
ISessionFactoryHolder sessionFactoryHolder,
ShellSettings shellSettings) {
_memberBindingRepository = memberBindingRepository;
_layoutRepository = layoutRepository;
_propertyRecordRepository = propertyRecordRepository;
_sessionFactoryHolder = sessionFactoryHolder;
_shellSettings = shellSettings;
T = NullLocalizer.Instance;
}
@ -356,32 +366,79 @@ namespace Orchard.Projections {
return 5;
}
#pragma warning disable CS0618
// disable compiler warning regarding the fact that RewriteOutput is obsolete
// because this migration is handling just that.
// When upgrading from version 5 of 1.10.x (up until version 7), we'll just execute the same steps, but in a
// different order.
public int UpdateFrom5() {
// This is the original step of the dev branch.
MigratePropertyRecordToRewriteOutputCondition();
return 6;
}
public int UpdateFrom6() {
// This is the original step of the dev branch.
AddLayoutRecordGuid();
// When upgrading from version 6 of 1.10.x, this column isn't created yet, so we need to run this step
// "again".
MigratePropertyRecordToRewriteOutputCondition();
return 7;
}
// This change was originally UpdateFrom5 on dev (but didn't exist on 1.10.x).
private void MigratePropertyRecordToRewriteOutputCondition() {
if (ColumnExists("PropertyRecord", "RewriteOutputCondition")) return;
SchemaBuilder.AlterTable("PropertyRecord", table => table
.AddColumn<string>("RewriteOutputCondition", c => c.Unlimited())
);
foreach (var property in _propertyRecordRepository.Table)
#pragma warning disable CS0618 // Type or member is obsolete
// Reading this obsolete property to migrate its data to a new one.
if (property.RewriteOutput) property.RewriteOutputCondition = "true";
#pragma warning restore CS0618 // Type or member is obsolete
return 6;
ColumnAdded("PropertyRecord", "RewriteOutputCondition");
}
#pragma warning restore CS0618
public int UpdateFrom6() {
SchemaBuilder.AlterTable("LayoutRecord", t => t.AddColumn<string>("GUIdentifier",
column => column.WithLength(68)));
// This change was originally UpdateFrom5 on 1.10.x and UpdateFrom6 on dev.
private void AddLayoutRecordGuid() {
if (ColumnExists("LayoutRecord", "GUIdentifier")) return;
SchemaBuilder.AlterTable("LayoutRecord", table =>
table.AddColumn<string>("GUIdentifier", column => column.WithLength(68)));
var layoutRecords = _layoutRepository.Table.Where(l => l.GUIdentifier == null || l.GUIdentifier == "").ToList();
foreach (var layout in layoutRecords) {
layout.GUIdentifier = Guid.NewGuid().ToString();
}
return 7;
ColumnAdded("LayoutRecord", "GUIdentifier");
}
private bool ColumnExists(string tableName, string columnName) {
if (!_existingColumnNames.Any()) {
// Database-agnostic way of checking the existence of a column.
using (var session = _sessionFactoryHolder.GetSessionFactory().OpenSession()) {
var connection = session.Connection ?? throw new InvalidOperationException(
"The database connection object should derive from DbConnection to check if a column exists.");
var columns = connection.GetSchema("Columns").Rows.Cast<DataRow>();
if (!string.IsNullOrEmpty(_shellSettings.DataTablePrefix)) {
columns = columns.Where(row => row["TABLE_NAME"].ToString().StartsWith($"{_shellSettings.DataTablePrefix}_"));
}
_existingColumnNames = columns.Select(row => $"{row["TABLE_NAME"]}.{row["COLUMN_NAME"]}").ToHashSet();
}
}
return _existingColumnNames.Contains($"{SchemaBuilder.TableDbName(tableName)}.{columnName}");
}
private void ColumnAdded(string tableName, string columnName) =>
_existingColumnNames.Add($"{SchemaBuilder.TableDbName(tableName)}.{columnName}");
}
}