Add support for specifying column variants in a ColumnConfiguration (#…

…379)

* Add support for specifying column variants in a ColumnConfiguration

* Consolidate ctors

* Fix typo

* Refactor upgrade logic

* Rename namespace to Latest

* Add typecast to while loop

* Remove cycle check

* Add check to PreviousPrebuiltConfigurationBase

src/Microsoft.Performance.SDK.Runtime.Tests/TableConfigurationSerializationTests.cs

@@ -10,6 +10,7 @@
 using Microsoft.Performance.Testing;
 using Microsoft.Performance.Testing.SDK;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using ColumnConfiguration = Microsoft.Performance.SDK.Runtime.DTO.Latest.ColumnConfiguration;
 using TableConfiguration = Microsoft.Performance.SDK.Processing.TableConfiguration;
 
 namespace Microsoft.Performance.SDK.Runtime.Tests
@@ -286,7 +287,7 @@ private DTO.PreV1.TableConfiguration BuildPreV1TableConfig()
                     StartTimeColumnGuid = Guid.NewGuid(),
                     StartTimeColumnName = testStr()
                 }, 3).ToArray(),
-                Columns = Enumerable.Repeat(new DTO.ColumnConfiguration()
+                Columns = Enumerable.Repeat(new DTO.V1_0.ColumnConfiguration()
                 {
                     Metadata = new DTO.ColumnMetadata()
                     {

src/Microsoft.Performance.SDK.Runtime/DTO/DTOExtensions.cs

@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.Performance.SDK.Runtime.DTO.Enums;
+using Microsoft.Performance.SDK.Runtime.DTO.Latest;
 
 namespace Microsoft.Performance.SDK.Runtime.DTO
 {
@@ -431,7 +432,8 @@ private static Microsoft.Performance.SDK.Processing.ColumnConfiguration ConvertT
 
             var columnConfiguration = new Microsoft.Performance.SDK.Processing.ColumnConfiguration(
                     dto.Metadata.ConvertToSdk(),
-                    dto.DisplayHints.ConvertToSdk());
+                    dto.DisplayHints.ConvertToSdk(),
+                    dto.VariantGuid);
             return columnConfiguration;
         }
 

src/Microsoft.Performance.SDK.Runtime/DTO/ColumnConfiguration.cs → src/Microsoft.Performance.SDK.Runtime/DTO/Latest/ColumnConfiguration.cs

@@ -1,9 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System;
 using System.Runtime.Serialization;
 
-namespace Microsoft.Performance.SDK.Runtime.DTO
+namespace Microsoft.Performance.SDK.Runtime.DTO.Latest
 {
     [DataContract]
     internal class ColumnConfiguration
@@ -14,6 +15,12 @@ internal class ColumnConfiguration
         [DataMember]
         public ColumnMetadata Metadata { get; set;  }
 
+        /// <summary>
+        ///     The unique identifier of the column variant to use.
+        /// </summary>
+        [DataMember]
+        public Guid? VariantGuid { get; set;  }
+
         /// <summary>
         ///     UI hints for displaying the column.
         /// </summary>

src/Microsoft.Performance.SDK.Runtime/DTO/PrebuiltConfigurations.cs → src/Microsoft.Performance.SDK.Runtime/DTO/Latest/PrebuiltConfigurations.cs

@@ -3,13 +3,13 @@
 
 using System.Runtime.Serialization;
 
-namespace Microsoft.Performance.SDK.Runtime.DTO
+namespace Microsoft.Performance.SDK.Runtime.DTO.Latest
 {
     [DataContract]
     internal class PrebuiltConfigurations
         : PrebuiltConfigurationsBase
     {
-        internal static readonly double DTOVersion = 1.0;
+        internal static readonly double DTOVersion = 1.3;
 
         public PrebuiltConfigurations()
         {

src/Microsoft.Performance.SDK.Runtime/DTO/TableConfiguration.cs → src/Microsoft.Performance.SDK.Runtime/DTO/Latest/TableConfiguration.cs

@@ -6,7 +6,7 @@
 using System.Runtime.Serialization;
 using Microsoft.Performance.SDK.Runtime.DTO.Enums;
 
-namespace Microsoft.Performance.SDK.Runtime.DTO
+namespace Microsoft.Performance.SDK.Runtime.DTO.Latest
 {
     [DataContract]
     internal class TableConfiguration
@@ -93,7 +93,7 @@ internal class TableConfiguration
         ///     Columns that may appear in the table.
         /// </summary>
         [DataMember(Order = 14)]
-        public IEnumerable<Runtime.DTO.ColumnConfiguration> Columns { get; set; }
+        public IEnumerable<ColumnConfiguration> Columns { get; set; }
 
         /// <summary>
         ///     The roles and their associated column entries.

src/Microsoft.Performance.SDK.Runtime/DTO/TableConfigurations.cs → src/Microsoft.Performance.SDK.Runtime/DTO/Latest/TableConfigurations.cs

@@ -4,7 +4,7 @@
 using System;
 using System.Runtime.Serialization;
 
-namespace Microsoft.Performance.SDK.Runtime.DTO
+namespace Microsoft.Performance.SDK.Runtime.DTO.Latest
 {
     [DataContract]
     internal class TableConfigurations

src/Microsoft.Performance.SDK.Runtime/DTO/PreV1/PrebuiltConfigurations.cs

@@ -8,8 +8,7 @@ namespace Microsoft.Performance.SDK.Runtime.DTO.PreV1
 {
     [DataContract]
     internal class PrebuiltConfigurations
-        : PrebuiltConfigurationsBase,
-          ISupportUpgrade<DTO.PrebuiltConfigurations>
+        : PreviousPrebuiltConfigurationBase<V1_0.PrebuiltConfigurations>
     {
         internal static readonly double DTOVersion = 0.1;
 
@@ -21,9 +20,9 @@ public PrebuiltConfigurations()
         [DataMember(Order = 2)]
         public TableConfigurations[] Tables { get; set; }
 
-        public DTO.PrebuiltConfigurations Upgrade()
+        protected override V1_0.PrebuiltConfigurations UpgradeToNext()
         {
-            return new DTO.PrebuiltConfigurations()
+            return new V1_0.PrebuiltConfigurations()
             {
                 Tables = this.Tables.Select(configs => configs.Upgrade()).ToArray()
             };

src/Microsoft.Performance.SDK.Runtime/DTO/PreV1/TableConfiguration.cs

@@ -10,7 +10,7 @@ namespace Microsoft.Performance.SDK.Runtime.DTO.PreV1
 {
     [DataContract]
     internal class TableConfiguration
-        : ISupportUpgrade<DTO.TableConfiguration>
+        : ISupportUpgrade<V1_0.TableConfiguration>
     {
         /// <summary>
         ///     The table name.
@@ -100,15 +100,15 @@ internal class TableConfiguration
         ///     Columns that may appear in the table.
         /// </summary>
         [DataMember(Order = 15)]
-        public IEnumerable<Runtime.DTO.ColumnConfiguration> Columns { get; set; }
+        public IEnumerable<V1_0.ColumnConfiguration> Columns { get; set; }
 
         /// <summary>
         ///     The roles and their associated column entries.
         /// </summary>
         [DataMember(Order = 16)]
         public IDictionary<ColumnRole, ColumnRoleEntry> ColumnRoles { get; set; }
 
-        public DTO.TableConfiguration Upgrade()
+        public V1_0.TableConfiguration Upgrade()
         {
             var newColumnRoles = new Dictionary<string, ColumnRoleEntry>(this.ColumnRoles.Count);
 
@@ -163,7 +163,7 @@ public DTO.TableConfiguration Upgrade()
                 }                
             }
 
-            return new DTO.TableConfiguration()
+            return new V1_0.TableConfiguration()
             {
                 Name = this.Name,
                 ChartType = this.ChartType,

src/Microsoft.Performance.SDK.Runtime/DTO/PreV1/TableConfigurations.cs

@@ -9,7 +9,7 @@ namespace Microsoft.Performance.SDK.Runtime.DTO.PreV1
 {
     [DataContract]
     internal class TableConfigurations
-        : ISupportUpgrade<DTO.TableConfigurations>
+        : ISupportUpgrade<V1_0.TableConfigurations>
     {
         [DataMember(Order = 1)]
         public Guid TableId { get; set; }
@@ -20,9 +20,9 @@ internal class TableConfigurations
         [DataMember(Order = 3)]
         public TableConfiguration[] Configurations { get; set; }
 
-        public DTO.TableConfigurations Upgrade()
+        public V1_0.TableConfigurations Upgrade()
         {
-            return new DTO.TableConfigurations()
+            return new V1_0.TableConfigurations()
             {
                 TableId = this.TableId,
                 DefaultConfigurationName = this.DefaultConfigurationName,

src/Microsoft.Performance.SDK.Runtime/DTO/PreviousPrebuiltConfigurationBase`1.cs

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using System.Runtime.Serialization;
+
+namespace Microsoft.Performance.SDK.Runtime.DTO;
+
+[DataContract]
+internal abstract class PreviousPrebuiltConfigurationBase<TNext>
+    : PrebuiltConfigurationsBase,
+      ISupportUpgrade<PrebuiltConfigurationsBase>
+    where TNext : PrebuiltConfigurationsBase
+{
+    public PrebuiltConfigurationsBase Upgrade()
+    {
+        var next = UpgradeToNext();
+        if (next.Version <= this.Version)
+        {
+            throw new InvalidOperationException(
+                $"Cannot upgrade to a version less than or equal to the current version. Current version: {this.Version}, Next version: {next.Version}");
+        }
+
+        return next;
+    }
+
+    /// <summary>
+    ///     Upgrade the current configuration to the next version. The version number
+    ///     of the returned configuration MUST be greater than this instance's version number.
+    /// </summary>
+    /// <returns>
+    ///     The upgraded configuration.
+    /// </returns>
+    protected abstract TNext UpgradeToNext();
+}

src/Microsoft.Performance.SDK.Runtime/DTO/TableConfigurationsSerializer.cs

@@ -9,6 +9,8 @@
 using System.Runtime.Serialization.Json;
 using System.Text;
 using Microsoft.Performance.SDK.Processing;
+using Microsoft.Performance.SDK.Runtime.DTO.Latest;
+using TableConfigurations = Microsoft.Performance.SDK.Runtime.DTO.Latest.TableConfigurations;
 
 namespace Microsoft.Performance.SDK.Runtime.DTO
 {
@@ -27,6 +29,7 @@ public class TableConfigurationsSerializer
 
                 return assembly.GetTypes()
                                .Where(type => type.IsSubclassOf(typeof(PrebuiltConfigurationsBase)))
+                               .Where(type => type.IsConcrete())
                                .Select(type => (((PrebuiltConfigurationsBase)Activator.CreateInstance(type)).Version, type)).ToArray();
             });
 
@@ -94,15 +97,19 @@ public class TableConfigurationsSerializer
 
                 var desrailizedObject = serializer.ReadObject(stream);
 
-                if (desrailizedObject is ISupportUpgrade<PrebuiltConfigurations> supportUpgrade)
+                if (desrailizedObject is not PrebuiltConfigurationsBase configurationsBase)
                 {
-                    prebuiltConfigurations = supportUpgrade.Upgrade();
+                    return Enumerable.Empty<Processing.TableConfigurations>();
                 }
-                else if (desrailizedObject is PrebuiltConfigurations latestConfigs)
+
+                while (configurationsBase is not PrebuiltConfigurations &&
+                       configurationsBase is ISupportUpgrade<PrebuiltConfigurationsBase> upgradeable)
                 {
-                    prebuiltConfigurations = latestConfigs;
+                    configurationsBase = upgradeable.Upgrade();
                 }
 
+                prebuiltConfigurations = configurationsBase as PrebuiltConfigurations;
+
                 if (prebuiltConfigurations == null)
                 {
                     return Enumerable.Empty<Processing.TableConfigurations>();

src/Microsoft.Performance.SDK.Runtime/DTO/V1_0/ColumnConfiguration.cs

@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.Runtime.Serialization;
+
+namespace Microsoft.Performance.SDK.Runtime.DTO.V1_0
+{
+    [DataContract]
+    internal class ColumnConfiguration
+        : ISupportUpgrade<Latest.ColumnConfiguration>
+    {
+        /// <summary>
+        ///     Metadata describing the column.
+        /// </summary>
+        [DataMember]
+        public ColumnMetadata Metadata { get; set;  }
+
+        /// <summary>
+        ///     UI hints for displaying the column.
+        /// </summary>
+        [DataMember]
+        public UIHints DisplayHints { get; set;  }
+
+        public Latest.ColumnConfiguration Upgrade()
+        {
+            return new Latest.ColumnConfiguration()
+            {
+                Metadata = this.Metadata,
+                VariantGuid = null,
+                DisplayHints = this.DisplayHints,
+            };
+        }
+    }
+}

src/Microsoft.Performance.SDK.Runtime/DTO/V1_0/PrebuiltConfigurations.cs

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.Linq;
+using System.Runtime.Serialization;
+
+namespace Microsoft.Performance.SDK.Runtime.DTO.V1_0
+{
+    [DataContract]
+    internal class PrebuiltConfigurations
+        : PreviousPrebuiltConfigurationBase<Latest.PrebuiltConfigurations>
+    {
+        internal static readonly double DTOVersion = 1.0;
+
+        public PrebuiltConfigurations()
+        {
+            this.Version = DTOVersion;
+        }
+
+        [DataMember(Order = 2)]
+        public TableConfigurations[] Tables { get; set; }
+
+        protected override Latest.PrebuiltConfigurations UpgradeToNext()
+        {
+            return new Latest.PrebuiltConfigurations()
+            {
+                Tables = this.Tables.Select(configs => configs.Upgrade()).ToArray()
+            };
+        }
+    }
+}