Merge pull request #656 from US-EPA-CAMD/fix/json-hijack-v2

mark-hayward-erg · web-flow · commit f559142a4f25 · 2025-05-12T16:03:57.000-04:00
fixed endpoints that still returned an Array []
diff --git a/src/app-e-correlation-test-run-workspace/app-e-correlation-test-run-workspace.controller.spec.ts b/src/app-e-correlation-test-run-workspace/app-e-correlation-test-run-workspace.controller.spec.ts
@@ -93,7 +93,7 @@ describe('AppECorrelationTestRunWorkspaceController', () => {
         testSumId,
         appECorrTestSumId,
       );
-      expect(results).toEqual(appECorrelationTestRuns);
+      expect(results).toEqual({ items: appECorrelationTestRuns });
       expect(service.getAppECorrelationTestRuns).toHaveBeenCalled();
     });
   });
diff --git a/src/app-e-correlation-test-run-workspace/app-e-correlation-test-run-workspace.controller.ts b/src/app-e-correlation-test-run-workspace/app-e-correlation-test-run-workspace.controller.ts
@@ -22,6 +22,7 @@ import { AppECorrelationTestRunWorkspaceService } from './app-e-correlation-test
 import { AppECorrelationTestRunChecksService } from './app-e-correlation-test-run-checks.service';
 import { LookupType } from '@us-epa-camd/easey-common/enums';
 import { ApiExcludeControllerByEnv } from '../decorators/swagger-decorator';
+import { ArrayResponse } from '@us-epa-camd/easey-common/interfaces/common.interface';
 
 @Controller()
 @ApiSecurity('APIKey')
@@ -56,8 +57,10 @@ export class AppECorrelationTestRunWorkspaceController {
     @Param('locId') _locationId: string,
     @Param('testSumId') _testSumId: string,
     @Param('appECorrTestSumId') appECorrTestSumId: string,
-  ) {
-    return this.service.getAppECorrelationTestRuns(appECorrTestSumId);
+  ) : Promise<ArrayResponse<AppECorrelationTestRunBaseDTO>> {
+    const appECorrelationTestRunBaseDTOS = await this.service.getAppECorrelationTestRuns(appECorrTestSumId);
+
+    return { items: appECorrelationTestRunBaseDTOS };
   }
 
   @Get(':id')
diff --git a/src/app-e-correlation-test-run/app-e-correlation-test-run.controller.spec.ts b/src/app-e-correlation-test-run/app-e-correlation-test-run.controller.spec.ts
@@ -49,7 +49,7 @@ describe('AppECorrelationTestRunController', () => {
         testSumId,
         appECorrTestSumId,
       );
-      expect(results).toEqual(appECorrelationTestRuns);
+      expect(results).toEqual({ items: appECorrelationTestRuns });
       expect(service.getAppECorrelationTestRuns).toHaveBeenCalled();
     });
   });
diff --git a/src/app-e-correlation-test-run/app-e-correlation-test-run.controller.ts b/src/app-e-correlation-test-run/app-e-correlation-test-run.controller.ts
@@ -1,7 +1,9 @@
 import { Controller, Get, Param } from '@nestjs/common';
 import { ApiOkResponse, ApiSecurity, ApiTags } from '@nestjs/swagger';
-import { AppECorrelationTestRunRecordDTO } from '../dto/app-e-correlation-test-run.dto';
+import { AppECorrelationTestRunBaseDTO, AppECorrelationTestRunRecordDTO } from '../dto/app-e-correlation-test-run.dto';
 import { AppECorrelationTestRunService } from './app-e-correlation-test-run.service';
+import { ArrayResponse } from '@us-epa-camd/easey-common/interfaces/common.interface';
+import { TestExtensionExemptionRecordDTO } from '../dto/test-extension-exemption.dto';
 
 @Controller()
 @ApiSecurity('APIKey')
@@ -20,8 +22,10 @@ export class AppECorrelationTestRunController {
     @Param('locId') _locationId: string,
     @Param('testSumId') _testSumId: string,
     @Param('appECorrTestSumId') appECorrTestSumId: string,
-  ) {
-    return this.service.getAppECorrelationTestRuns(appECorrTestSumId);
+  ) : Promise<ArrayResponse<AppECorrelationTestRunBaseDTO>> {
+    const appECorrelationTestRunBaseDTOS = await this.service.getAppECorrelationTestRuns(appECorrTestSumId);
+
+    return { items: appECorrelationTestRunBaseDTOS };
   }
 
   @Get(':id')
diff --git a/src/app-e-heat-input-from-gas-workspace/app-e-heat-input-from-gas-workspace.controller.ts b/src/app-e-heat-input-from-gas-workspace/app-e-heat-input-from-gas-workspace.controller.ts
@@ -23,6 +23,7 @@ import { AppEHeatInputFromGasWorkspaceService } from './app-e-heat-input-from-ga
 import { AppEHeatInputFromGasChecksService } from './app-e-heat-input-from-gas-checks.service';
 import { LookupType } from '@us-epa-camd/easey-common/enums';
 import { ApiExcludeControllerByEnv } from '../decorators/swagger-decorator';
+import { ArrayResponse } from '@us-epa-camd/easey-common/interfaces/common.interface';
 
 @Controller()
 @ApiSecurity('APIKey')
@@ -58,8 +59,10 @@ export class AppEHeatInputFromGasWorkspaceController {
     @Param('testSumId') _testSumId: string,
     @Param('appECorrTestSumId') _appECorrTestSumId: string,
     @Param('appECorrTestRunId') appECorrTestRunId: string,
-  ) {
-    return this.service.getAppEHeatInputFromGases(appECorrTestRunId);
+  ) : Promise<ArrayResponse<AppEHeatInputFromGasRecordDTO>> {
+    const appEHeatInputFromGasRecordDTOS = await this.service.getAppEHeatInputFromGases(appECorrTestRunId);
+
+    return { items: appEHeatInputFromGasRecordDTOS };
   }
 
   @Get(':id')
diff --git a/src/app-e-heat-input-from-gas/app-e-heat-input-from-gas.controller.spec.ts b/src/app-e-heat-input-from-gas/app-e-heat-input-from-gas.controller.spec.ts
@@ -57,7 +57,7 @@ describe('AppEHeatInputFromGasController', () => {
           appECorrTestSumId,
           appECorrTestRunId,
         ),
-      ).toBe(appEHIGasRecords);
+      ).toStrictEqual( { items: appEHIGasRecords } );
     });
   });
 
diff --git a/src/app-e-heat-input-from-gas/app-e-heat-input-from-gas.controller.ts b/src/app-e-heat-input-from-gas/app-e-heat-input-from-gas.controller.ts
@@ -10,6 +10,7 @@ import {
 import { ApiOkResponse, ApiSecurity, ApiTags } from '@nestjs/swagger';
 import { AppEHeatInputFromGasRecordDTO } from '../dto/app-e-heat-input-from-gas.dto';
 import { AppEHeatInputFromGasService } from './app-e-heat-input-from-gas.service';
+import { ArrayResponse } from '@us-epa-camd/easey-common/interfaces/common.interface';
 
 @Controller()
 @ApiSecurity('APIKey')
@@ -29,8 +30,10 @@ export class AppEHeatInputFromGasController {
     @Param('testSumId') _testSumId: string,
     @Param('appECorrTestSumId') _appECorrTestSumId: string,
     @Param('appECorrTestRunId') appECorrTestRunId: string,
-  ) {
-    return this.service.getAppEHeatInputFromGases(appECorrTestRunId);
+  ) : Promise<ArrayResponse<AppEHeatInputFromGasRecordDTO>> {
+    const appEHeatInputFromGasRecordDTOS = await this.service.getAppEHeatInputFromGases(appECorrTestRunId);
+
+    return { items: appEHeatInputFromGasRecordDTOS };
   }
 
   @Get(':id')
diff --git a/src/online-offline-calibration-workspace/online-offline-calibration.controller.spec.ts b/src/online-offline-calibration-workspace/online-offline-calibration.controller.spec.ts
@@ -95,7 +95,7 @@ describe('Online Offline Calibration Workspace Controller', () => {
         locId,
         testSumId,
       );
-      expect(result).toEqual(onlineOfflineCalibrations);
+      expect(result).toStrictEqual( { items: onlineOfflineCalibrations } );
       expect(service.getOnlineOfflineCalibrations).toHaveBeenCalled();
     });
   });
diff --git a/src/online-offline-calibration-workspace/online-offline-calibration.controller.ts b/src/online-offline-calibration-workspace/online-offline-calibration.controller.ts
@@ -17,11 +17,12 @@ import { AuditLog, RoleGuard, User } from '@us-epa-camd/easey-common/decorators'
 import { CurrentUser } from '@us-epa-camd/easey-common/interfaces';
 import { OnlineOfflineCalibrationWorkspaceService } from '../online-offline-calibration-workspace/online-offline-calibration.service';
 import {
-  OnlineOfflineCalibrationBaseDTO,
+  OnlineOfflineCalibrationBaseDTO, OnlineOfflineCalibrationDTO,
   OnlineOfflineCalibrationRecordDTO,
 } from '../dto/online-offline-calibration.dto';
 import { LookupType } from '@us-epa-camd/easey-common/enums';
 import { ApiExcludeControllerByEnv } from '../decorators/swagger-decorator';
+import { ArrayResponse } from '@us-epa-camd/easey-common/interfaces/common.interface';
 
 @Controller()
 @ApiSecurity('APIKey')
@@ -51,11 +52,13 @@ export class OnlineOfflineCalibrationWorkspaceController {
     label: 'Retrieved online offline calibration records for test summary',
     requestParamsOutFields: ['locId', 'testSumId']
   })
-  getOnlineOfflineCalibrations(
+  async getOnlineOfflineCalibrations(
     @Param('locId') _locationId: string,
     @Param('testSumId') testSumId: string,
-  ) {
-    return this.service.getOnlineOfflineCalibrations(testSumId);
+  ) : Promise<ArrayResponse<OnlineOfflineCalibrationDTO>>  {
+    const onlineOfflineCalibrationDTOS = await  this.service.getOnlineOfflineCalibrations(testSumId);
+
+    return { items: onlineOfflineCalibrationDTOS };
   }
 
   @Get(':id')
diff --git a/src/online-offline-calibration/online-offline-calibration.controller.spec.ts b/src/online-offline-calibration/online-offline-calibration.controller.spec.ts
@@ -51,7 +51,7 @@ describe('Online Offline Calibration Controller', () => {
         locId,
         testSumId,
       );
-      expect(result).toEqual(onlineOfflineCalibrations);
+      expect(result).toStrictEqual( { items: onlineOfflineCalibrations } );
       expect(service.getOnlineOfflineCalibrations).toHaveBeenCalled();
     });
   });
diff --git a/src/online-offline-calibration/online-offline-calibration.controller.ts b/src/online-offline-calibration/online-offline-calibration.controller.ts
@@ -2,7 +2,8 @@ import { Controller, Get, Param } from '@nestjs/common';
 import { ApiOkResponse, ApiSecurity, ApiTags } from '@nestjs/swagger';
 
 import { OnlineOfflineCalibrationService } from './online-offline-calibration.service';
-import { OnlineOfflineCalibrationRecordDTO } from '../dto/online-offline-calibration.dto';
+import { OnlineOfflineCalibrationDTO, OnlineOfflineCalibrationRecordDTO } from '../dto/online-offline-calibration.dto';
+import { ArrayResponse } from '@us-epa-camd/easey-common/interfaces/common.interface';
 
 @Controller()
 @ApiSecurity('APIKey')
@@ -17,11 +18,13 @@ export class OnlineOfflineCalibrationController {
     description:
       'Retrieves official Online Offline Calibration records by Test Summary Id',
   })
-  getOnlineOfflineCalibrations(
+  async getOnlineOfflineCalibrations(
     @Param('locId') _locationId: string,
     @Param('testSumId') testSumId: string,
-  ) {
-    return this.service.getOnlineOfflineCalibrations(testSumId);
+  ) : Promise<ArrayResponse<OnlineOfflineCalibrationDTO>>  {
+    const onlineOfflineCalibrationDTOS = await this.service.getOnlineOfflineCalibrations(testSumId);
+
+    return { items: onlineOfflineCalibrationDTOS };
   }
 
   @Get(':id')
diff --git a/src/protocol-gas/protocol-gas.controller.ts b/src/protocol-gas/protocol-gas.controller.ts
@@ -1,7 +1,8 @@
 import { Controller, Get, Param } from '@nestjs/common';
 import { ApiOkResponse, ApiSecurity, ApiTags } from '@nestjs/swagger';
-import { ProtocolGasRecordDTO } from '../dto/protocol-gas.dto';
+import { ProtocolGasDTO, ProtocolGasRecordDTO } from '../dto/protocol-gas.dto';
 import { ProtocolGasService } from './protocol-gas.service';
+import { ArrayResponse } from '@us-epa-camd/easey-common/interfaces/common.interface';
 
 @ApiTags('Protocol Gas')
 @ApiSecurity('APIKey')
@@ -15,11 +16,13 @@ export class ProtocolGasController {
     type: ProtocolGasRecordDTO,
     description: 'Retrieves official Protocol Gas records by Test Summary Id',
   })
-  getProtocolGases(
+  async getProtocolGases(
     @Param('locId') _locationId: string,
     @Param('testSumId') testSumId: string,
-  ) {
-    return this.service.getProtocolGases(testSumId);
+  ) : Promise<ArrayResponse<ProtocolGasDTO>>  {
+    const protocolGasDTOS = await this.service.getProtocolGases(testSumId);
+
+    return { items: protocolGasDTOS };
   }
 
   @Get(':id')
diff --git a/src/rata-summary-workspace/rata-summary-workspace.controller.ts b/src/rata-summary-workspace/rata-summary-workspace.controller.ts
@@ -16,12 +16,13 @@ import { AuditLog, RoleGuard, User } from '@us-epa-camd/easey-common/decorators'
 import { LookupType } from '@us-epa-camd/easey-common/enums';
 import { CurrentUser } from '@us-epa-camd/easey-common/interfaces';
 import {
-  RataSummaryBaseDTO,
+  RataSummaryBaseDTO, RataSummaryDTO,
   RataSummaryRecordDTO,
 } from '../dto/rata-summary.dto';
 import { RataSummaryChecksService } from './rata-summary-checks.service';
 import { RataSummaryWorkspaceService } from './rata-summary-workspace.service';
 import { ApiExcludeControllerByEnv } from '../decorators/swagger-decorator';
+import { ArrayResponse } from '@us-epa-camd/easey-common/interfaces/common.interface';
 
 @Controller()
 @ApiSecurity('APIKey')
@@ -51,12 +52,14 @@ export class RataSummaryWorkspaceController {
     label: 'Retrieved RATA summary records for test summary',
     requestParamsOutFields: ['locId', 'testSumId', 'rataId']
   })
-  getRataSummaryes(
+  async getRataSummaryes(
     @Param('locId') _locationId: string,
     @Param('testSumId') _testSumId: string,
     @Param('rataId') rataId: string,
-  ) {
-    return this.service.getRataSummaries(rataId);
+  ) : Promise<ArrayResponse<RataSummaryDTO>> {
+    const rataSummaryDTOS = await this.service.getRataSummaries(rataId);
+
+    return { items: rataSummaryDTOS };
   }
 
   @Get(':id')
diff --git a/src/rata-summary/rata-summary.controller.ts b/src/rata-summary/rata-summary.controller.ts
@@ -1,7 +1,8 @@
 import { Controller, Get, Param } from '@nestjs/common';
 import { ApiOkResponse, ApiSecurity, ApiTags } from '@nestjs/swagger';
-import { RataSummaryRecordDTO } from '../dto/rata-summary.dto';
+import { RataSummaryDTO, RataSummaryRecordDTO } from '../dto/rata-summary.dto';
 import { RataSummaryService } from './rata-summary.service';
+import { ArrayResponse } from '@us-epa-camd/easey-common/interfaces/common.interface';
 
 @ApiTags('Rata Summary')
 @ApiSecurity('APIKey')
@@ -15,12 +16,14 @@ export class RataSummaryController {
     type: RataSummaryRecordDTO,
     description: 'Retrieves official Rata Summary records.',
   })
-  getRataSummaries(
+  async etRataSummaries(
     @Param('locId') _locationId: string,
     @Param('testSumId') _testSumId: string,
     @Param('rataId') rataId: string,
-  ) {
-    return this.service.getRataSummaries(rataId);
+  ) : Promise<ArrayResponse<RataSummaryDTO>>  {
+    const rataSummaryDTOS = await this.service.getRataSummaries(rataId);
+
+    return { items: rataSummaryDTOS };
   }
 
   @Get(':id')
