Dimension must also be inferred from headers #1509

abdelr · 2022-02-22T13:18:33Z

Fixes #1427 (Dimension should also be inferred from headers)

msevestre · 2022-02-22T13:32:39Z

src/OSPSuite.Presentation/Presenters/Importer/ColumnMappingPresenter.cs

@@ -515,6 +515,18 @@ public ToolTipDescription ToolTipDescriptionFor(int index)
         };
      }

+      private void setUnitAndDimension(ColumnMappingDTO model)
+      {
+         var supportedDimensions = _columnInfos.First(x => x.DisplayName == model.MappingName).SupportedDimensions;


I feel that I have seens this code
_columnInfos.First(x => x.DisplayName == model.MappingName e.g. finding a column by display name so many times, that I am believe it needs to be refactored.
What about you create cache with DisplayName keys instead of IREadOnlyList. That way you can simply do columnInfos[model.MappingName].

There are indeed several places on tests. On code is only here and three on the DataImporterTask. Refactoring to a cache for this might be unnecessary since the _columnInfos is used in several places in the code and test code should not drive our development. Besides, it is also used as _columnInfos.First(ci => !(ci.IsAuxiliary() || ci.IsBase())) which will not benefit from a cache. I would think on creating maybe some extension methods if it keeps popping up.

Cache is a ienumerable by default. It will be the same code everywhere except where you can simplify it drastically

msevestre · 2022-02-22T13:32:52Z

src/OSPSuite.Presentation/Presenters/Importer/ColumnMappingPresenter.cs

+      {
+         var supportedDimensions = _columnInfos.First(x => x.DisplayName == model.MappingName).SupportedDimensions;
+         var unit = _format.ExtractUnitDescriptions(model.ExcelColumn, supportedDimensions);
+         if (unit.SelectedUnit != UnitDescription.InvalidUnit)


if equal, return. Exit early

msevestre · 2022-02-22T13:35:15Z

src/OSPSuite.Presentation/Presenters/Importer/ColumnMappingPresenter.cs

+         var unit = _format.ExtractUnitDescriptions(model.ExcelColumn, supportedDimensions);
+         if (unit.SelectedUnit != UnitDescription.InvalidUnit)
+         {
+            var mappingDataFormatParameter = (model.Source as MappingDataFormatParameter);


are we sure this is a MappingDataFormatParameter. If yes, explain why as comment
I am seeing this type of casting with as also a lot in the code. This is very unusual to always know what to cast to and I believe there is a need for refactoring here as well

(but not for this PR...it's a general observation)

I think you are right. We definitely need a refactoring. The thing is DataFormatParameters have a lot of common use but some special features are concrete for mappings (time, measurement and error). I would say there could be a refactoring missing but I would like to postpone it for now.

msevestre · 2022-02-22T13:37:22Z

tests/OSPSuite.Presentation.Tests/Importer/Presenters/ColumnMappingPresenterSpecs.cs

-         (_model.Source as MappingDataFormatParameter).MappedColumn.Unit.SelectedUnit.ShouldBeEqualTo(shouldUpdate ? newUnitDescription : oldUnitDescription);
+         var mappingDataFormat = (_model.Source as MappingDataFormatParameter);
+         mappingDataFormat.MappedColumn.Unit.SelectedUnit.ShouldBeEqualTo(shouldUpdate ? newUnitDescription : oldUnitDescription);
+         if (shouldUpdate && newUnitDescription != "?")


what's with the ? Don't we have a constant for it

msevestre · 2022-02-22T13:38:18Z

tests/OSPSuite.Presentation.Tests/Importer/Presenters/ColumnMappingPresenterSpecs.cs

+         var mappingDataFormat = (_model.Source as MappingDataFormatParameter);
+         mappingDataFormat.MappedColumn.Unit.SelectedUnit.ShouldBeEqualTo(shouldUpdate ? newUnitDescription : oldUnitDescription);
+         if (shouldUpdate && newUnitDescription != "?")
+            mappingDataFormat.MappedColumn.Dimension.HasUnit(mappingDataFormat.MappedColumn.Unit.SelectedUnit).ShouldBeTrue();


mappingDataFormat.MappedColumn : create a variable and use it. It's referenced 3 times. This is going to make the test easier to understand

abdelr · 2022-02-23T08:16:19Z

@msevestre, @georgeDaskalakis ColumnInfos is now a Cache<string, ColumnInfo> and it is always created as new Cache<string, ColumnInfo>(getKey: : x => x.DisplayName). This way we do not write anymore _columnInfos.First(x => x.DisplayName == "Time") but _columnInfos["Time"]. Notice there are several files touched so please, take a look and merge as soon as possible if the change is approved so we avoid collisions later.

msevestre · 2022-02-23T08:30:52Z

I meant in the presenter. The columnInfo otherwise could have stayed as is.

msevestre · 2022-02-23T08:36:16Z

tests/OSPSuite.Infrastructure.Tests/Import/DataSourceSpecs.cs

@@ -186,7 +186,7 @@ protected override void Context()
                     Name = "Time",
                     Unit = new UnitDescription("s")
                  },
-                  ColumnInfo = _columnInfos[0]
+                  ColumnInfo = _columnInfos.ElementAt(0)


I think those indexes here should use keys instead. Also what is the displaName of the column info defined on line 175. It it name ? You are using it as key and it's not defined

msevestre · 2022-02-23T08:37:43Z

tests/OSPSuite.Presentation.Tests/Importer/Presenters/ImporterPresenterSpecs.cs

@@ -169,7 +169,7 @@ protected static MetaDataCategory createMetaDataCategory<T>(string descriptiveNa

   public class When_setting_settings : concern_for_ImporterPresenter
   {
-      protected IReadOnlyList<ColumnInfo> _columnInfos = A.Fake<IReadOnlyList<ColumnInfo>>();
+      protected Cache<string, ColumnInfo> _columnInfos = A.Fake<Cache<string, ColumnInfo>>();


Why a fake here? This does not make sense.

msevestre · 2022-02-23T08:38:31Z

tests/OSPSuite.Starter/Tasks/ImporterConfigurationDataGenerator.cs

      {
-         var columns = new List<ColumnInfo>();
+         var columns = new Cache<string, ColumnInfo>(getKey: x => x.DisplayName);


Why do we have name and display name in columnInfo. I am getting a bit confused

I think they are not both needed since we always have them assigned to the same value. So we could create an issue to remove one of them (DisplayName I would say)

msevestre · 2022-02-23T08:38:54Z

tests/OSPSuite.UI.Tests/ColumnMappingControlSpecs.cs

@@ -709,7 +709,7 @@
 //             base.GlobalContext();
 //
 //             var dataRepositoryMapper = A.Fake<IImportDataTableToDataRepositoryMapper>();
-//             var columnInfos = A.Fake<IReadOnlyList<ColumnInfo>>();
+//             var columnInfos = A.Fake<Cache<string, ColumnInfo>>();


Why are those tests commented out?

Test file was left, removing it.

Dimension must also be inferred from headers

51817fe

abdelr added the Importer-Redesign Redesign of observed data import label Feb 22, 2022

abdelr requested review from msevestre, Yuri05 and georgeDaskalakis February 22, 2022 13:18

abdelr self-assigned this Feb 22, 2022

msevestre reviewed Feb 22, 2022

View reviewed changes

abdelr added 3 commits February 22, 2022 20:50

exit early

cc99fcb

Using constant

d9f32ac

Creating variable for easier reading

8f16321

abdelr requested a review from msevestre February 22, 2022 20:05

ColumnInfos is now a cache

abd1cbc

msevestre reviewed Feb 23, 2022

View reviewed changes

Some code cleaning up

994beda

abdelr requested a review from msevestre February 23, 2022 09:34

msevestre merged commit 1469a20 into develop Feb 23, 2022

msevestre deleted the 1427_dimension_must_also_be_inferred_from_headers branch February 23, 2022 10:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dimension must also be inferred from headers #1509

Dimension must also be inferred from headers #1509

abdelr commented Feb 22, 2022

msevestre Feb 22, 2022

abdelr Feb 22, 2022

msevestre Feb 22, 2022

msevestre Feb 22, 2022

msevestre Feb 22, 2022

msevestre Feb 22, 2022

abdelr Feb 22, 2022

msevestre Feb 22, 2022

msevestre Feb 22, 2022

abdelr commented Feb 23, 2022

msevestre commented Feb 23, 2022

msevestre Feb 23, 2022

msevestre Feb 23, 2022

msevestre Feb 23, 2022

abdelr Feb 23, 2022

msevestre Feb 23, 2022

abdelr Feb 23, 2022

Dimension must also be inferred from headers #1509

Dimension must also be inferred from headers #1509

Conversation

abdelr commented Feb 22, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abdelr commented Feb 23, 2022

msevestre commented Feb 23, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment