Issue 53431: Data Class and Sample Type data doesn't round-trip via folder export/import for field names with special char (#6840)

- use ColumnHeaderType.ImportField instead of FieldKey for writing folder archive tsv data column headers
- PlateManager.exportPlateData / ListWriter / DatasetDataWriter to use ColumnHeaderType.ImportField
- remove comment re: ColumnHeaderType.FieldKey being "useful for import/export round-tripping" since that isn't the case
- StudyDatasetsTest test case for 53431

---------

Co-authored-by: labkey-susanh <susanh@labkey.com>

Author: cnathe

api/src/org/labkey/api/data/ColumnHeaderType.java

@@ -109,7 +109,7 @@ public String getText(DisplayColumn dc)
         }
     },
 
-    // Use the ColumnInfo's FieldKey with FieldKey escaping. Useful for import/export round-tripping, but can lead to ugly names.
+    // Use the ColumnInfo's FieldKey with FieldKey escaping.
     FieldKey("Field Key", "The column name rendered with FieldKey encoding; unambiguous and canonical, useful for exporting and re-importing.") {
         @Override
         public String getText(DisplayColumn dc)

assay/src/org/labkey/assay/plate/PlateManager.java

@@ -3768,7 +3768,7 @@ public List<PlateFileBytes> exportPlateData(Container c, User user, ContainerFil
                 try (TSVGridWriter writer = new TSVGridWriter(plateQueryView::getResults, displayColumns, Collections.singletonMap(sampleIdNameFieldKey.toString(), "Sample ID")))
                 {
                     writer.setDelimiterCharacter(delim);
-                    writer.setColumnHeaderType(ColumnHeaderType.FieldKey);
+                    writer.setColumnHeaderType(ColumnHeaderType.ImportField); // Issue 53431
                     writer.write(plateFileBytes.bytes);
                 }
 

experiment/src/org/labkey/experiment/samples/AbstractExpFolderWriter.java

@@ -96,7 +96,7 @@ protected void writeTsv(TableInfo tinfo, Collection<ColumnInfo> columns, SimpleF
         try (TSVGridWriter tsvWriter = new TSVGridWriter(factory))
         {
             tsvWriter.setApplyFormats(false);
-            tsvWriter.setColumnHeaderType(ColumnHeaderType.FieldKey);
+            tsvWriter.setColumnHeaderType(ColumnHeaderType.ImportField); // Issue 53431
             PrintWriter out = dir.getPrintWriter(baseName + ".tsv");
             tsvWriter.write(out);
         }

list/src/org/labkey/list/model/ListWriter.java

@@ -189,7 +189,7 @@ private void writeLists(List<Pair<String, ListDefinition>> listsToExport, Virtua
                     try (TSVGridWriter tsvWriter = new TSVGridWriter(()->QueryService.get().getSelectBuilder(ti).columns(columns).sort(sort).select(null, false), displayColumns))
                     {
                         tsvWriter.setApplyFormats(false);
-                        tsvWriter.setColumnHeaderType(ColumnHeaderType.DisplayFieldKey); // CONSIDER: Use FieldKey instead
+                        tsvWriter.setColumnHeaderType(ColumnHeaderType.ImportField); // Issue 53431
                         PrintWriter out = listsDir.getPrintWriter( def.getName() + ".tsv");
                         tsvWriter.write(out);
                     }

study/src/org/labkey/study/writer/DatasetDataWriter.java

@@ -179,7 +179,7 @@ private void writeResultsToTSV(ResultsFactory factory, VirtualFile vf, String fi
         try (TSVGridWriter tsvWriter = new TSVGridWriter(factory))
         {
             tsvWriter.setApplyFormats(false);
-            tsvWriter.setColumnHeaderType(ColumnHeaderType.DisplayFieldKey); // CONSIDER: Use FieldKey instead
+            tsvWriter.setColumnHeaderType(ColumnHeaderType.ImportField); // Issue 53431
             PrintWriter out = vf.getPrintWriter(fileName);
             tsvWriter.write(out);
         }

study/test/src/org/labkey/test/tests/study/StudyDatasetsTest.java

@@ -33,6 +33,7 @@
 import org.labkey.test.pages.ImportDataPage;
 import org.labkey.test.pages.TimeChartWizard;
 import org.labkey.test.pages.study.DatasetDesignerPage;
+import org.labkey.test.params.FieldInfo;
 import org.labkey.test.util.AuditLogHelper;
 import org.labkey.test.util.DataRegionTable;
 import org.labkey.test.util.LogMethod;
@@ -41,6 +42,7 @@
 import org.labkey.test.util.TestDataGenerator;
 import org.openqa.selenium.WebElement;
 
+import java.io.File;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -212,6 +214,40 @@ public void testDatasetSubjectId()
         clickTab("Overview");
     }
 
+    @Test
+    public void testDatasetRoundTripWithSpecialChars() // Issue 53431
+    {
+        goToManageStudy();
+        String datasetName = "Issue 53431";
+        FieldInfo fieldInfo = FieldInfo.random("test,./field");
+        DatasetDesignerPage definitionPage = _studyHelper.goToManageDatasets()
+                .clickCreateNewDataset()
+                .setName(datasetName);
+        DomainFormPanel panel = definitionPage.getFieldsPanel();
+        panel.manuallyDefineFields(fieldInfo.getFieldDefinition());
+        definitionPage.clickSave();
+        importDatasetData(datasetName, "mouseId\tsequenceNum\t\"" + fieldInfo.getName() + "\"\n", "a1\t1\ttest123", "All data");
+
+        File exportedFolder = exportFolderAsZip(null, false, false, false, false);
+        deleteStudy();
+        importFolderFromZip(exportedFolder, false, 2, false);
+        _studyHelper.goToManageDatasets()
+                .selectDatasetByName(datasetName)
+                .clickViewData();
+        DataRegionTable drt = new DataRegionTable("Dataset", getDriver());
+        checker().verifyEquals("Field data didn't import as expected", "test123",
+                drt.getDataAsText(0, fieldInfo));
+    }
+
+    private void deleteStudy()
+    {
+        clickTab("Manage");
+        clickButton("Delete Study");
+        checkCheckbox(Locator.checkboxByName("confirm"));
+        clickButton("Delete", WAIT_FOR_PAGE * 2);
+    }
+
+
     @LogMethod
     protected void createDataset(@LoggedParam String name, @Nullable String error)
     {