Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@

<ItemGroup>
<None Update="persistence.manifest" CopyToOutputDirectory="PreserveNewest" />
<None Update="index-definitions.manifest" CopyToOutputDirectory="PreserveNewest" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
{
"Indexes": [
{
"Name": "FailedAuditImportIndex",
"Maps": [
"docs.FailedAuditImports.Select(cc => new {\n Id = Id(cc)\n})"
],
"Fields": {},
"AdditionalSources": {},
"AdditionalAssemblies": []
},
{
"Name": "MessagesViewIndex",
"Maps": [
"docs.ProcessedMessages.Select(message => new {\n MessageId = ((string) message.MessageMetadata[\"MessageId\"]),\n MessageType = ((string) message.MessageMetadata[\"MessageType\"]),\n IsSystemMessage = ((bool) message.MessageMetadata[\"IsSystemMessage\"]),\n Status = ((bool) message.MessageMetadata[\"IsRetried\"]) ? 4 : 3,\n TimeSent = ((DateTime) message.MessageMetadata[\"TimeSent\"]),\n ProcessedAt = message.ProcessedAt,\n ReceivingEndpointName = ((message.MessageMetadata[\"ReceivingEndpoint\"])).Name,\n SendingEndpointName = ((message.MessageMetadata[\"SendingEndpoint\"])).Name,\n CriticalTime = ((TimeSpan ? ) message.MessageMetadata[\"CriticalTime\"]),\n ProcessingTime = ((TimeSpan ? ) message.MessageMetadata[\"ProcessingTime\"]),\n DeliveryTime = ((TimeSpan ? ) message.MessageMetadata[\"DeliveryTime\"]),\n Query = Enumerable.ToArray(DynamicEnumerable.Union(message.MessageMetadata.ToDictionary(e1 => e1.Key, e1 => e1.Value).Select(_ => _.Value.ToString()), new string[] {\n String.Join(\" \", message.Headers.ToDictionary(e1 => e1.Key, e1 => e1.Value).Select(x => x.Value))\n })),\n ConversationId = ((string) message.MessageMetadata[\"ConversationId\"])\n})"
],
"Fields": {
"Query": {
"Indexing": "Search",
"Analyzer": "Lucene.Net.Analysis.Standard.StandardAnalyzer, Lucene.Net, Version=3.0.3.0, Culture=neutral, PublicKeyToken=85089178b9ac3181"
}
},
"AdditionalSources": {},
"AdditionalAssemblies": []
},
{
"Name": "MessagesViewIndexWithFullTextSearch",
"Maps": [
"docs.ProcessedMessages.Select(message => new {\n MessageId = ((string) message.MessageMetadata[\"MessageId\"]),\n MessageType = ((string) message.MessageMetadata[\"MessageType\"]),\n IsSystemMessage = ((bool) message.MessageMetadata[\"IsSystemMessage\"]),\n Status = ((bool) message.MessageMetadata[\"IsRetried\"]) ? 4 : 3,\n TimeSent = ((DateTime) message.MessageMetadata[\"TimeSent\"]),\n ProcessedAt = message.ProcessedAt,\n ReceivingEndpointName = ((message.MessageMetadata[\"ReceivingEndpoint\"])).Name,\n SendingEndpointName = ((message.MessageMetadata[\"SendingEndpoint\"])).Name,\n CriticalTime = ((TimeSpan ? ) message.MessageMetadata[\"CriticalTime\"]),\n ProcessingTime = ((TimeSpan ? ) message.MessageMetadata[\"ProcessingTime\"]),\n DeliveryTime = ((TimeSpan ? ) message.MessageMetadata[\"DeliveryTime\"]),\n Query = Enumerable.ToArray(DynamicEnumerable.Union(message.MessageMetadata.ToDictionary(e1 => e1.Key, e1 => e1.Value).Select(_ => _.Value.ToString()), new string[] {\n String.Join(\" \", message.Headers.ToDictionary(e1 => e1.Key, e1 => e1.Value).Select(x => x.Value)),\n this.LoadAttachment(message, \"body\").GetContentAsString()\n })),\n ConversationId = ((string) message.MessageMetadata[\"ConversationId\"])\n})"
],
"Fields": {
"Query": {
"Indexing": "Search",
"Analyzer": "Lucene.Net.Analysis.Standard.StandardAnalyzer, Lucene.Net, Version=3.0.3.0, Culture=neutral, PublicKeyToken=85089178b9ac3181"
}
},
"AdditionalSources": {},
"AdditionalAssemblies": []
},
{
"Name": "SagaDetailsIndex",
"Maps": [
"docs.SagaHistories.Select(doc => new {\n SagaId = doc.SagaId,\n Id = doc.SagaId,\n SagaType = doc.SagaType,\n Changes = doc.Changes\n})",
"docs.SagaSnapshots.Select(doc => new {\n SagaId = doc.SagaId,\n Id = doc.SagaId,\n SagaType = doc.SagaType,\n Changes = new[] {\n new {\n Endpoint = doc.Endpoint,\n FinishTime = doc.FinishTime,\n InitiatingMessage = doc.InitiatingMessage,\n OutgoingMessages = doc.OutgoingMessages,\n StartTime = doc.StartTime,\n StateAfterChange = doc.StateAfterChange,\n Status = doc.Status\n }\n }\n})"
],
"Reduce": "results.GroupBy(result => result.SagaId).Select(g => new {\n g = g,\n first = DynamicEnumerable.FirstOrDefault(g)\n}).Select(this0 => new {\n Id = this0.first.SagaId,\n SagaId = this0.first.SagaId,\n SagaType = this0.first.SagaType,\n Changes = Enumerable.ToList(DynamicEnumerable.OrderByDescending(this0.g.SelectMany(x => x.Changes), x0 => x0.FinishTime).Take(50000))\n})",
"Fields": {
"Changes": {
"Indexing": "No"
},
"SagaId": {
"Indexing": "Exact"
},
"SagaType": {
"Indexing": "No"
}
},
"AdditionalSources": {},
"AdditionalAssemblies": []
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
namespace ServiceControl.Audit.Persistence.Tests;

using System.IO;
using System.Linq;
using System.Net.Http;
using System.Threading.Tasks;
using NUnit.Framework;
using Persistence.RavenDB;
using ServiceControl.RavenDB;
using ServiceControlInstaller.Engine.Validation;
using TestHelper;

// The installer compares index-definitions.manifest with the index definitions on the server before an upgrade.
[TestFixture]
class IndexDefinitionManifestTests : CleanDatabaseFixture
{
[Test]
public void Manifest_is_current()
{
var rendered = IndexDefinitionManifest.Render(IndexDeployment.FindIndexes(typeof(DatabaseSetup).Assembly));

if (IndexDefinitionManifest.NormalizeLineEndings(File.ReadAllText(ManifestPath)) != rendered)
{
var receivedPath = Path.Combine(TestContext.CurrentContext.WorkDirectory, IndexDefinitionManifest.FileName + ".received");
File.WriteAllText(receivedPath, rendered);
Assert.Fail($"{IndexDefinitionManifest.FileName} in ServiceControl.Audit.Persistence.RavenDB does not match the index definitions. Replace it with {receivedPath}.");
}
}

[Test]
public async Task Deployed_indexes_have_no_changes()
{
var changes = await DeployAndDetect(File.ReadAllText(ManifestPath));

Assert.That(changes.Changes, Is.Empty);
}

[Test]
public async Task Changed_map_is_reported()
{
var changes = await DeployAndDetect(File.ReadAllText(ManifestPath).Replace("ProcessedAt = ", "ProcessedAtChanged = "));

Assert.That(changes.Changes, Is.Not.Empty);
Assert.That(changes.Changes.Select(change => change.Database).Distinct(), Is.EqualTo(new[] { Store.Database }));
Assert.That(changes.Changes.SelectMany(change => change.Differences).Distinct(), Is.EqualTo(new[] { "Maps" }));
Assert.That(changes.Changes.All(change => change.Entries == 0 && !change.IsLocked), Is.True);
}

async Task<RavenDBIndexChanges> DeployAndDetect(string manifest)
{
var indexes = IndexDeployment.FindIndexes(typeof(DatabaseSetup).Assembly).ToList();
await IndexDeployment.CreateIndexesAsync(indexes, Store, cancellationToken: TestTimeoutCancellationToken);

using var http = new HttpClient();
var changes = await RavenDBIndexChanges.Detect("instance", RavenDBIndexDefinitions.Parse(manifest), (path, token) => http.GetStringAsync(Store.Urls[0] + path, token), TestTimeoutCancellationToken);

// The shared server also holds the databases of other tests.
return new RavenDBIndexChanges { InstanceName = changes.InstanceName, Changes = changes.Changes.Where(change => change.Database == Store.Database).ToList() };
}

static string ManifestPath => Path.Combine(TestContext.CurrentContext.TestDirectory, IndexDefinitionManifest.FileName);
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,9 @@
<Compile Remove="..\ServiceControl.Audit.Persistence.Tests\EFCore\**\*.cs" />
</ItemGroup>

<ItemGroup>
<!-- The installer check for index changes, compiled here to verify it against a real RavenDB server -->
<Compile Include="..\ServiceControlInstaller.Engine\Validation\RavenDBIndexChanges.cs" LinkBase="Installer" />
</ItemGroup>

</Project>
9 changes: 9 additions & 0 deletions src/ServiceControl.Config/Commands/ScmuCommandChecks.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using ServiceControlInstaller.Engine;
using ServiceControlInstaller.Engine.Configuration.ServiceControl;
using ServiceControlInstaller.Engine.Instances;
using ServiceControlInstaller.Engine.Validation;

public class ScmuCommandChecks : AbstractCommandChecks
{
Expand Down Expand Up @@ -94,6 +95,14 @@ protected override Task<bool> PromptToStopRunningInstance(BaseService instance,
"Yes, I want to proceed", "No", cancellationToken);
}

protected override Task<bool> PromptForRavenDBIndexRebuild(RavenDBIndexChanges indexChanges, CancellationToken cancellationToken = default)
{
return windowManager.ShowYesNoDialog("UPGRADE REBUILDS INDEXES",
indexChanges.Describe(),
"Do you want to proceed?",
"Yes, upgrade and rebuild the indexes", "No, cancel the upgrade", cancellationToken);
}

protected override Task<bool> PromptToContinueWithForcedUpgrade(CancellationToken cancellationToken = default)
{
return windowManager.ShowMessage("Forced migration",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ static class AcknowledgementValues
{
public const string RabbitMQBrokerVersion310 = "RabbitMQBrokerVersion310";
public const string RabbitMQManagementApi = "RabbitMQManagementApi";
public const string RavenDBIndexRebuild = "RavenDBIndexRebuild";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
using ServiceControlInstaller.Engine;
using ServiceControlInstaller.Engine.Configuration.ServiceControl;
using ServiceControlInstaller.Engine.Instances;
using ServiceControlInstaller.Engine.Validation;

class PowerShellCommandChecks : AbstractCommandChecks
{
Expand Down Expand Up @@ -97,6 +98,18 @@ protected override Task<bool> PromptToStopRunningInstance(BaseService instance,
return Task.FromResult(true);
}

protected override Task<bool> PromptForRavenDBIndexRebuild(RavenDBIndexChanges indexChanges, CancellationToken cancellationToken = default)
{
if (acknowledgements.Any(ack => ack.Equals(AcknowledgementValues.RavenDBIndexRebuild, StringComparison.OrdinalIgnoreCase)))
{
cmdlet.WriteWarning(indexChanges.Describe());
return Task.FromResult(true);
}

Terminate($"{indexChanges.Describe()}{Environment.NewLine}{Environment.NewLine}Use -Acknowledgements {AcknowledgementValues.RavenDBIndexRebuild} to upgrade and rebuild the indexes.", "Install Error", ErrorCategory.InvalidArgument);
return Task.FromResult(false);
}

protected override Task<bool> PromptToContinueWithForcedUpgrade(CancellationToken cancellationToken = default)
{
// In PowerShell, you passed the -Force parameter to get here in the first place
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@

<ItemGroup>
<None Update="persistence.manifest" CopyToOutputDirectory="PreserveNewest" />
<None Update="index-definitions.manifest" CopyToOutputDirectory="PreserveNewest" />
</ItemGroup>

<ItemGroup>
Expand Down
Loading
Loading