fix(Export): display address text for "location" fields in csv exports

fixes #2802

src/app/core/common-components/entities-table/value-accessor/value-accessor.ts

@@ -1,5 +1,6 @@
 import { ConfigurableEnumValue } from "../../../basic-datatypes/configurable-enum/configurable-enum.interface";
 import moment from "moment/moment";
+import { GeoLocation } from "../../../../features/location/location.datatype";
 
 /**
  * Transform a whole object into a readable format.
@@ -27,20 +28,31 @@ export function transformToReadableFormat(obj: any) {
  * @param value the object for which a readable string should be returned
  */
 export function getReadableValue(value: any): any {
-  if (isConfigurableEnum(value)) {
-    return value.label;
-  } else if (Array.isArray(value)) {
+  if (Array.isArray(value)) {
     if (value.length > 0 && value.every((val) => value.indexOf(val) === 0)) {
       // only return a single value if all elements in array are same
       return getReadableValue(value[0]);
     } else {
       return value.map((v) => getReadableValue(v));
     }
-  } else {
-    return value;
   }
+
+  // TODO: refactor this into an extendable system where each Datatype defines their transformation instead of implementing it here
+
+  if (isConfigurableEnum(value)) {
+    return value.label;
+  }
+  if (isGeoLocation(value)) {
+    return value.locationString;
+  }
+
+  return value;
 }
 
 export function isConfigurableEnum(value: any): value is ConfigurableEnumValue {
   return typeof value === "object" && value && "label" in value;
 }
+
+function isGeoLocation(value: any): value is GeoLocation {
+  return typeof value === "object" && value && "locationString" in value;
+}

src/app/core/export/download-service/download.service.spec.ts

@@ -10,6 +10,7 @@ import { EntityMapperService } from "app/core/entity/entity-mapper/entity-mapper
 import { mockEntityMapper } from "app/core/entity/entity-mapper/mock-entity-mapper-service";
 import { EntityDatatype } from "../../basic-datatypes/entity/entity.datatype";
 import { TestEntity } from "../../../utils/test-utils/TestEntity";
+import { GeoLocation } from "../../../features/location/location.datatype";
 
 describe("DownloadService", () => {
   let service: DownloadService;
@@ -130,6 +131,7 @@ describe("DownloadService", () => {
       @DatabaseField({ dataType: "entity", label: "referenced entity 2" })
       relatedEntity2: string;
     }
+
     const relatedEntity = testSchool;
     const relatedEntity2 = testChild;
 
@@ -158,6 +160,7 @@ describe("DownloadService", () => {
       })
       relatedEntitiesArray: string[];
     }
+
     const testEntity = new EntityRefDownloadTestEntity();
     testEntity.relatedEntitiesArray = [testSchool.getId(), testChild.getId()];
 
@@ -179,6 +182,7 @@ describe("DownloadService", () => {
       })
       relatedEntitiesArray: string[];
     }
+
     const testEntity = new EntityRefDownloadTestEntity();
     testEntity.relatedEntitiesArray = ["undefined-id", testChild.getId()];
 
@@ -265,4 +269,25 @@ describe("DownloadService", () => {
       `"${dateString}","10","someString"`,
     ]);
   });
+
+  it("should export a location as its locationString only", async () => {
+    const locationObject: GeoLocation = {
+      locationString: "Test Location",
+      geoLookup: { lat: 0, lon: 0, display_name: "lookup location" },
+    };
+
+    const exportData = [
+      {
+        address: locationObject,
+      },
+    ];
+
+    const csv = await service.createCsv(exportData);
+
+    const results = csv.split(DownloadService.SEPARATOR_ROW);
+    expect(results).toEqual([
+      '"address"',
+      `"${locationObject.locationString}"`,
+    ]);
+  });
 });