Implement improved file sequence optimization

First ensures files are grouped by DiskId. Then files are sequenced by
target directory order to optimize MSI installation behavior. Finally,
files are alphabetized in the directory. Additional optimizations could
be considered in the future from here.

Fixes wixtoolset/issues#4409
Fixes wixtoolset/issues#4708

7 files changed, 95 insertions, 1 deletions

diff --git a/src/test/WixToolsetTest.CoreIntegration/CabFixture.cs b/src/test/WixToolsetTest.CoreIntegration/CabFixture.cs
index 5aef148e..ad62dea6 100644
--- a/src/test/WixToolsetTest.CoreIntegration/CabFixture.cs
+++ b/src/test/WixToolsetTest.CoreIntegration/CabFixture.cs
@@ -42,7 +42,7 @@ namespace WixToolsetTest.CoreIntegration
                 var fileRows = fileTable.Select(r => new FileRow(r)).OrderBy(f => f.Sequence).ToList();
 
                 Assert.Equal(new[] { 1, 2 }, fileRows.Select(f => f.Sequence).ToArray());
-                Assert.Equal(new[] { "test.txt", "Notepad.exe" }, fileRows.Select(f => f.Name).ToArray());
+                Assert.Equal(new[] { "Notepad.exe", "test.txt" }, fileRows.Select(f => f.Name).ToArray());
 
                 var files = Query.GetCabinetFiles(cabPath);
                 Assert.Equal(fileRows.Select(f => f.Id).ToArray(), files.Select(f => f.Name).ToArray());
diff --git a/src/test/WixToolsetTest.CoreIntegration/MediaFixture.cs b/src/test/WixToolsetTest.CoreIntegration/MediaFixture.cs
new file mode 100644
index 00000000..de18e30c
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/MediaFixture.cs
@@ -0,0 +1,62 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+
+namespace WixToolsetTest.CoreIntegration
+{
+    using System.IO;
+    using System.Linq;
+    using WixBuildTools.TestSupport;
+    using WixToolset.Core.TestPackage;
+    using WixToolset.Data;
+    using Xunit;
+
+    public class MediaFixture
+    {
+        [Fact]
+        public void CanBuildMultiMedia()
+        {
+            var folder = TestData.Get(@"TestData");
+
+            using (var fs = new DisposableFileSystem())
+            {
+                var baseFolder = fs.GetFolder();
+                var intermediateFolder = Path.Combine(baseFolder, "obj");
+                var msiPath = Path.Combine(baseFolder, @"bin\test.msi");
+
+                var result = WixRunner.Execute(new[]
+                {
+                    "build",
+                    Path.Combine(folder, "Media", "MultiMedia.wxs"),
+                    "-bindpath", Path.Combine(folder, "Media", "data"),
+                    "-intermediateFolder", intermediateFolder,
+                    "-o", msiPath
+                });
+
+                result.AssertSuccess();
+
+                var intermediate = Intermediate.Load(Path.Combine(baseFolder, @"bin\test.wixpdb"));
+                var section = intermediate.Sections.Single();
+
+                var mediaSymbols = section.Symbols.OfType<WixToolset.Data.Symbols.MediaSymbol>().OrderBy(m => m.DiskId).ToList();
+                var fileSymbols = section.Symbols.OfType<WixToolset.Data.Symbols.FileSymbol>().OrderBy(f => f.Sequence).ToList();
+                Assert.Equal(1, mediaSymbols[0].DiskId);
+                Assert.Equal(2, mediaSymbols[0].LastSequence);
+                Assert.Equal(2, mediaSymbols[1].DiskId);
+                Assert.Equal(4, mediaSymbols[1].LastSequence);
+                Assert.Equal(new[]
+                {
+                    "a1.txt",
+                    "a2.txt",
+                    "b1.txt",
+                    "b2.txt",
+                }, fileSymbols.Select(f => f.Name).ToArray());
+                Assert.Equal(new[]
+                {
+                    1,
+                    2,
+                    3,
+                    4,
+                }, fileSymbols.Select(f => f.Sequence).ToArray());
+            }
+        }
+    }
+}
diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/Media/MultiMedia.wxs b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/MultiMedia.wxs
new file mode 100644
index 00000000..8a555bda
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/MultiMedia.wxs
@@ -0,0 +1,28 @@
+<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
+    <Package Name="~MultiMedia" Codepage="1252" Language="1033" Version="1.0.0.0" Manufacturer="Example Corporation"
+             UpgradeCode="12E4699F-E774-4D05-8A01-5BDD41BBA127">
+
+        <MajorUpgrade DowngradeErrorMessage="A newer version of [ProductName] is already installed." />
+
+        <Media Id="1" Cabinet="cab1.cab" />
+        <Media Id="2" Cabinet="cab2.cab" />
+        
+        <Feature Id="ProductFeature" Title="MsiPackageTitle">
+            <Component Directory="ProgramFilesFolder:\~MultiMedia" DiskId="1">
+                <File Source="a1.txt" />
+            </Component>
+
+            <Component Directory="ProgramFilesFolder:\~MultiMedia" DiskId="1">
+                <File Source="a2.txt" />
+            </Component>
+
+            <Component Directory="ProgramFilesFolder:\~MultiMedia" DiskId="2">
+                <File Source="b2.txt" />
+            </Component>
+
+            <Component Directory="ProgramFilesFolder:\~MultiMedia" DiskId="2">
+                <File Source="b1.txt" />
+            </Component>
+        </Feature>
+    </Package>
+</Wix>
diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/a1.txt b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/a1.txt
new file mode 100644
index 00000000..ad9cdcb5
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/a1.txt
@@ -0,0 +1 @@
+This is a1.txt
\ No newline at end of file
diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/a2.txt b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/a2.txt
new file mode 100644
index 00000000..d5de23de
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/a2.txt
@@ -0,0 +1 @@
+This is a2.txt
\ No newline at end of file
diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/b1.txt b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/b1.txt
new file mode 100644
index 00000000..88bc4a56
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/b1.txt
@@ -0,0 +1 @@
+This is b1.txt
\ No newline at end of file
diff --git a/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/b2.txt b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/b2.txt
new file mode 100644
index 00000000..38525276
--- /dev/null
+++ b/src/test/WixToolsetTest.CoreIntegration/TestData/Media/data/b2.txt
@@ -0,0 +1 @@
+This is b2.txt
\ No newline at end of file