Merge pull request #1052 from Open-Earth-Foundation/fix/emissions-for…

…ecast-tests
Open-Earth-Foundation · Jan 10, 2025 · 82ce9e0 · 82ce9e0
2 parents 40f7009 + 63ba131
commit 82ce9e0
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 35 deletions.
diff --git a/app/src/backend/GlobalAPIService.ts b/app/src/backend/GlobalAPIService.ts
@@ -4,24 +4,29 @@ import { logger } from "@/services/logger";
 
 export type GrowthRatesResponse = Omit<EmissionsForecastData, "forecast">;
 
-export const getGrowthRatesFromOC = async (
-  locode: string,
-  forecastYear: number,
-): Promise<GrowthRatesResponse | undefined> => {
-  try {
-    const URL = `${GLOBAL_API_URL}/api/v0/ghgi/emissions_forecast/city/${encodeURIComponent(locode)}/${forecastYear}`;
-    const response = await fetch(URL);
-    logger.info(`${URL} Response Status: ${response.status}`);
-    const data = await response.json();
-    if (response.status !== 200) {
+export class GlobalAPIService {
+  public static async fetchGrowthRates(
+    locode: string,
+    forecastYear: number,
+  ): Promise<GrowthRatesResponse | undefined> {
+    try {
+      const URL = `${GLOBAL_API_URL}/api/v0/ghgi/emissions_forecast/city/${encodeURIComponent(locode)}/${forecastYear}`;
+      const response = await fetch(URL);
+      logger.info(`${URL} Response Status: ${response.status}`);
+      if (response.status !== 200) {
+        return undefined;
+      }
+
+      const data = await response.json();
+      return {
+        ...data,
+        growthRates: data.growth_rates,
+      };
+    } catch (error) {
+      logger.error(`Error fetching growth rates: ${error}`);
       return undefined;
     }
-    return {
-      ...data,
-      growthRates: data.growth_rates,
-    };
-  } catch (error) {
-    console.error(`Error fetching growth rates: ${error}`);
-    return undefined;
   }
-};
+}
+
+export default GlobalAPIService;
diff --git a/app/src/backend/ResultsService.ts b/app/src/backend/ResultsService.ts
@@ -8,7 +8,7 @@ import { ActivityDataByScope, GroupedActivity } from "@/util/types";
 import Decimal from "decimal.js";
 import { bigIntToDecimal } from "@/util/big_int";
 import createHttpError from "http-errors";
-import { getGrowthRatesFromOC } from "./GlobalAPIService";
+import GlobalAPIService from "./GlobalAPIService";
 import { Inventory } from "@/models/Inventory";
 
 function multiplyBigIntByFraction(
@@ -751,7 +751,7 @@ export async function getEmissionResults(inventory: string): Promise<{
 }
 
 export const getEmissionsForecasts = async (inventoryData: Inventory) => {
-  const OCResponse = await getGrowthRatesFromOC(
+  const OCResponse = await GlobalAPIService.fetchGrowthRates(
     inventoryData.city.locode!,
     inventoryData.created!.getFullYear(),
   );
@@ -782,7 +782,13 @@ export const getEmissionsForecasts = async (inventoryData: Inventory) => {
     totalEmissionsBySector.forEach((emissionsInSector) => {
       const previousYear = year - 1;
       const referenceNumber = emissionsInSector.reference_number;
-      const growthRate = growthRates[year][referenceNumber];
+      const growthRate = growthRates?.[year]?.[referenceNumber];
+      if (!growthRate) {
+        throw new createHttpError.InternalServerError(
+          `Failed to find growth rate for sector ${referenceNumber} in year ${year} in city ${inventoryData.city.locode!}`,
+        );
+      }
+
       projectedEmissions[year][referenceNumber] = multiplyBigIntByFraction(
         projectedEmissions[previousYear][referenceNumber],
         1 + growthRate,

diff --git a/app/tests/api/emissions_forecast.jest.ts b/app/tests/api/emissions_forecast.jest.ts
@@ -15,13 +15,22 @@ import {
 } from "@/util/enums";
 import { City } from "@/models/City";
 import { Inventory } from "@/models/Inventory";
+import { GrowthRatesResponse } from "@/backend/GlobalAPIService";
+import GlobalAPIService from "@/backend/GlobalAPIService";
 
 const locode = "XX_SUBCATEGORY_CITY";
 
-// TODO UNSKIP when we can mock getGrowthRatesFromOC
-describe.skip("Emissions Forecast API", () => {
+describe("Emissions Forecast API", () => {
   let city: City;
   let inventory: Inventory;
+  let mockGrowthRates: GrowthRatesResponse | undefined;
+
+  jest
+    .spyOn(GlobalAPIService, "fetchGrowthRates")
+    .mockImplementation((locode, forecastYear) => {
+      return Promise.resolve(mockGrowthRates);
+    });
+
   beforeAll(async () => {
     setupTests();
     await db.initialize();
@@ -51,13 +60,7 @@ describe.skip("Emissions Forecast API", () => {
   });
 
   it("should calculate projected emissions correctly", async () => {
-    jest.mock("@/backend/GlobalAPIService", () => {
-      return {
-        getGrowthRatesFromOC: jest
-          .fn()
-          .mockImplementation(() => growth_rates_response),
-      };
-    });
+    mockGrowthRates = growth_rates_response;
     const req = mockRequest();
     const result = await getResults(req, {
       params: { inventory: inventory.inventoryId },
@@ -67,11 +70,7 @@ describe.skip("Emissions Forecast API", () => {
   });
 
   it("should handle empty growth factors", async () => {
-    jest.mock("@/backend/GlobalAPIService", () => {
-      return {
-        getGrowthRatesFromOC: jest.fn().mockImplementation(() => undefined),
-      };
-    });
+    mockGrowthRates = undefined;
     const req = mockRequest();
     const result = await getResults(req, {
       params: { inventory: inventory.inventoryId },