Add includeDemographics query param to CSV exporter

backend/core/src/applications/applications.controller.ts

@@ -34,12 +34,8 @@ import { IsBoolean, IsOptional, IsString } from "class-validator"
 import { PaginationQueryParams } from "../shared/dto/pagination.dto"
 import { ValidationsGroupsEnum } from "../shared/validations-groups.enum"
 import { defaultValidationPipeOptions } from "../shared/default-validation-pipe-options"
-import {
-  applicationFormattingMetadataAggregateFactory,
-  CSVFormattingType,
-} from "../csv/formatting/application-formatting-metadata-factory"
-import { CsvBuilder } from "../csv/csv-builder.service"
 import { applicationPreferenceExtraModels } from "./entities/application-preferences.entity"
+import { ApplicationCsvExporter } from "../csv/application-csv-exporter"
 
 export class ApplicationsListQueryParams extends PaginationQueryParams {
   @Expose()
@@ -94,6 +90,17 @@ export class ApplicationsCsvListQueryParams {
   @Transform((value: string | undefined) => value === "true", { toClassOnly: true })
   includeHeaders?: boolean
 
+  @Expose()
+  @ApiProperty({
+    type: Boolean,
+    example: true,
+    required: false,
+  })
+  @IsOptional({ groups: [ValidationsGroupsEnum.default] })
+  @IsBoolean({ groups: [ValidationsGroupsEnum.default] })
+  @Transform((value: string | undefined) => value === "true", { toClassOnly: true })
+  includeDemographics?: boolean
+
   @Expose()
   @ApiProperty({
     type: String,
@@ -123,7 +130,7 @@ export class ApplicationsController {
     private readonly emailService: EmailService,
     private readonly listingsService: ListingsService,
     private readonly authzService: AuthzService,
-    private readonly csvBuilder: CsvBuilder
+    private readonly applicationCsvExporter: ApplicationCsvExporter
   ) {}
 
   @Get()
@@ -154,12 +161,10 @@ export class ApplicationsController {
         await this.authorizeUserAction(req.user, application, authzActions.read)
       })
     )
-    return this.csvBuilder.build(
+    return this.applicationCsvExporter.export(
       applications,
-      applicationFormattingMetadataAggregateFactory,
-      // Every application points to the same listing
-      applications.length ? applications[0].listing.CSVFormattingType : CSVFormattingType.basic,
-      queryParams.includeHeaders
+      queryParams.includeHeaders,
+      queryParams.includeDemographics
     )
   }
 

backend/core/src/applications/applications.module.ts

@@ -11,6 +11,7 @@ import { ListingsModule } from "../listings/listings.module"
 import { Address } from "../shared/entities/address.entity"
 import { Applicant } from "./entities/applicant.entity"
 import { ApplicationsSubmissionController } from "./applications-submission.controller"
+import { ApplicationCsvExporter } from "../csv/application-csv-exporter"
 
 @Module({
   imports: [
@@ -19,7 +20,7 @@ import { ApplicationsSubmissionController } from "./applications-submission.cont
     SharedModule,
     ListingsModule,
   ],
-  providers: [ApplicationsService, CsvEncoder, CsvBuilder],
+  providers: [ApplicationsService, CsvEncoder, CsvBuilder, ApplicationCsvExporter],
   exports: [ApplicationsService],
   controllers: [ApplicationsController, ApplicationsSubmissionController],
 })

backend/core/src/csv/application-csv-exporter.ts

@@ -0,0 +1,41 @@
+import { Injectable } from "@nestjs/common"
+import { CsvBuilder } from "./csv-builder.service"
+import { Application } from "../applications/entities/application.entity"
+import {
+  applicationFormattingMetadataAggregateFactory,
+  CSVFormattingType,
+} from "./formatting/application-formatting-metadata-factory"
+import {
+  formatDemographicsEthnicity,
+  formatDemographicsGender,
+  formatDemographicsHowDidYouHear,
+  formatDemographicsRace,
+  formatDemographicsSexualOrientation,
+} from "./formatting/format-blocks"
+
+@Injectable()
+export class ApplicationCsvExporter {
+  constructor(private readonly csvBuilder: CsvBuilder) {}
+  export(
+    applications: Application[],
+    includeHeaders?: boolean,
+    includeDemographics?: boolean
+  ): string {
+    return this.csvBuilder.build(
+      applications,
+      applicationFormattingMetadataAggregateFactory,
+      // Every application points to the same listing
+      applications.length ? applications[0].listing.CSVFormattingType : CSVFormattingType.basic,
+      includeHeaders,
+      includeDemographics
+        ? [
+            formatDemographicsEthnicity,
+            formatDemographicsRace,
+            formatDemographicsGender,
+            formatDemographicsSexualOrientation,
+            formatDemographicsHowDidYouHear,
+          ]
+        : []
+    )
+  }
+}

backend/core/src/csv/csv-builder.service.ts

@@ -157,12 +157,16 @@ export class CsvBuilder {
     arr: any[],
     formattingMetadataAggregateFactory: FormattingMetadataAggregateFactory,
     csvFormattingType: CSVFormattingType,
-    includeHeaders?: boolean
+    includeHeaders?: boolean,
+    extraFormatters?: Array<FormattingMetadata>
   ): string {
-    const formattingMetadataAggregate = formattingMetadataAggregateFactory(csvFormattingType)
+    let formattingMetadataAggregate = formattingMetadataAggregateFactory(csvFormattingType)
     if (!formattingMetadataAggregate) {
       return ""
     }
+    if (extraFormatters) {
+      formattingMetadataAggregate = formattingMetadataAggregate.concat(extraFormatters)
+    }
     const normalizedMetadataAggregate = this.normalizeMetadataArrays(
       arr,
       formattingMetadataAggregate

backend/core/src/csv/formatting/format-blocks.ts

@@ -507,3 +507,43 @@ export const formatApplicationType = {
     return defaultFormatter(application.submissionType)
   },
 }
+
+export const formatDemographicsEthnicity = {
+  label: "Demographics Ethnicity",
+  discriminator: "",
+  formatter: (application: Application) => {
+    return defaultFormatter(application.demographics.ethnicity)
+  },
+}
+
+export const formatDemographicsRace = {
+  label: "Demographics Race",
+  discriminator: "",
+  formatter: (application: Application) => {
+    return defaultFormatter(application.demographics.race)
+  },
+}
+
+export const formatDemographicsGender = {
+  label: "Demographics Gender",
+  discriminator: "",
+  formatter: (application: Application) => {
+    return defaultFormatter(application.demographics.gender)
+  },
+}
+
+export const formatDemographicsSexualOrientation = {
+  label: "Demographics Sexual Orientation",
+  discriminator: "",
+  formatter: (application: Application) => {
+    return defaultFormatter(application.demographics.sexualOrientation)
+  },
+}
+
+export const formatDemographicsHowDidYouHear = {
+  label: "Demographics How Did You Hear About Us",
+  discriminator: "",
+  formatter: (application: Application) => {
+    return joinArrayFormatter(application.demographics.howDidYouHear)
+  },
+}