Merge pull request #421 from Open-Earth-Foundation/fix/iea-population…

…-missing fix(api): population missing error for IEA source
Open-Earth-Foundation · Apr 8, 2024 · 79c10ff · 79c10ff
2 parents 369f0eb + 38bd22c
commit 79c10ff
Show file tree

Hide file tree

Showing 3 changed files with 142 additions and 83 deletions.
diff --git a/app/src/app/[lng]/onboarding/setup/page.tsx b/app/src/app/[lng]/onboarding/setup/page.tsx
@@ -14,7 +14,11 @@ import {
   useGetOCCityQuery,
   useSetUserInfoMutation,
 } from "@/services/api";
-import { getShortenNumberUnit, shortenNumber } from "@/util/helpers";
+import {
+  findClosestYear,
+  getShortenNumberUnit,
+  shortenNumber,
+} from "@/util/helpers";
 import { OCCityAttributes } from "@/util/types";
 import {
   ArrowBackIcon,
@@ -85,31 +89,6 @@ type OnboardingData = {
 
 const numberOfYearsDisplayed = 10;
 
-/// Finds entry which has the year closest to the selected inventory year
-function findClosestYear(
-  populationData: PopulationEntry[] | undefined,
-  year: number,
-): PopulationEntry | null {
-  if (!populationData || populationData?.length === 0) {
-    return null;
-  }
-  return populationData.reduce(
-    (prev, curr) => {
-      // don't allow years outside of dropdown range
-      if (curr.year < year - numberOfYearsDisplayed + 1) {
-        return prev;
-      }
-      if (!prev) {
-        return curr;
-      }
-      let prevDelta = Math.abs(year - prev.year);
-      let currDelta = Math.abs(year - curr.year);
-      return prevDelta < currDelta ? prev : curr;
-    },
-    null as PopulationEntry | null,
-  );
-}
-
 function SetupStep({
   errors,
   register,
@@ -208,38 +187,50 @@ function SetupStep({
   // react to API data changes and different year selections
   useEffect(() => {
     if (cityData && year) {
-      const population = findClosestYear(cityData.population, year);
+      const population = findClosestYear(
+        cityData.population,
+        year,
+        numberOfYearsDisplayed,
+      );
       if (!population) {
         console.error("Failed to find population data for city");
         return;
       }
-      setValue("cityPopulation", population?.population);
-      setValue("cityPopulationYear", population?.year);
+      setValue("cityPopulation", population.population);
+      setValue("cityPopulationYear", population.year);
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [cityData, year, setValue]);
 
   useEffect(() => {
     if (regionData && year) {
-      const population = findClosestYear(regionData.population, year);
+      const population = findClosestYear(
+        regionData.population,
+        year,
+        numberOfYearsDisplayed,
+      );
       if (!population) {
         console.error("Failed to find population data for region");
         return;
       }
-      setValue("regionPopulation", population?.population);
-      setValue("regionPopulationYear", population?.year);
+      setValue("regionPopulation", population.population);
+      setValue("regionPopulationYear", population.year);
     }
   }, [regionData, year, setValue]);
 
   useEffect(() => {
     if (countryData && year) {
-      const population = findClosestYear(countryData.population, year);
+      const population = findClosestYear(
+        countryData.population,
+        year,
+        numberOfYearsDisplayed,
+      );
       if (!population) {
         console.error("Failed to find population data for region");
         return;
       }
-      setValue("countryPopulation", population?.population);
-      setValue("countryPopulationYear", population?.year);
+      setValue("countryPopulation", population.population);
+      setValue("countryPopulationYear", population.year);
     }
   }, [countryData, year, setValue]);
 

diff --git a/app/src/app/api/v0/datasource/[inventoryId]/route.ts b/app/src/app/api/v0/datasource/[inventoryId]/route.ts
@@ -13,6 +13,9 @@ import { Op } from "sequelize";
 import { z } from "zod";
 import { logger } from "@/services/logger";
 import { Publisher } from "@/models/Publisher";
+import { PopulationEntry, findClosestYear } from "@/util/helpers";
+import { PopulationAttributes } from "@/models/Population";
+import { Inventory } from "@/models/Inventory";
 
 const maxPopulationYearDifference = 5;
 const downscaledByCountryPopulation = "global_api_downscaled_by_population";
@@ -23,6 +26,68 @@ const populationScalingRetrievalMethods = [
   downscaledByRegionPopulation,
 ];
 
+async function findPopulationScaleFactors(
+  inventory: Inventory,
+  sources: DataSource[],
+) {
+  let countryPopulationScaleFactor = 1;
+  let regionPopulationScaleFactor = 1;
+  let populationIssue: string | null = null;
+  if (
+    sources.some((source) =>
+      populationScalingRetrievalMethods.includes(source.retrievalMethod ?? ""),
+    )
+  ) {
+    const populations = await db.models.Population.findAll({
+      where: {
+        cityId: inventory.cityId,
+        year: {
+          [Op.between]: [
+            inventory.year! - maxPopulationYearDifference,
+            inventory.year! + maxPopulationYearDifference,
+          ],
+        },
+      },
+      order: [["year", "DESC"]], // favor more recent population entries
+    });
+    const cityPopulations = populations.filter((pop) => !!pop.population);
+    const cityPopulation = findClosestYear(
+      cityPopulations as PopulationEntry[],
+      inventory.year!,
+    );
+    const countryPopulations = populations.filter(
+      (pop) => !!pop.countryPopulation,
+    );
+    const countryPopulation = findClosestYear(
+      countryPopulations as PopulationEntry[],
+      inventory.year!,
+    ) as PopulationAttributes;
+    const regionPopulations = populations.filter(
+      (pop) => !!pop.regionPopulation,
+    );
+    const regionPopulation = findClosestYear(
+      regionPopulations as PopulationEntry[],
+      inventory.year!,
+    ) as PopulationAttributes;
+    // TODO allow country downscaling to work if there is no region population?
+    if (!cityPopulation || !countryPopulation || !regionPopulation) {
+      // City is missing population/ region population/ country population for a year close to the inventory year
+      populationIssue = "missing-population"; // translation key
+    } else {
+      countryPopulationScaleFactor =
+        cityPopulation.population / countryPopulation.countryPopulation!;
+      regionPopulationScaleFactor =
+        cityPopulation.population / regionPopulation.regionPopulation!;
+    }
+  }
+
+  return {
+    countryPopulationScaleFactor,
+    regionPopulationScaleFactor,
+    populationIssue,
+  };
+}
+
 export const GET = apiHandler(async (_req: NextRequest, { params }) => {
   const inventory = await db.models.Inventory.findOne({
     where: { inventoryId: params.inventoryId },
@@ -80,42 +145,11 @@ export const GET = apiHandler(async (_req: NextRequest, { params }) => {
   const applicableSources = DataSourceService.filterSources(inventory, sources);
 
   // determine scaling factor for downscaled sources
-  let countryPopulationScaleFactor = 1;
-  let regionPopulationScaleFactor = 1;
-  let populationIssue: string | null = null;
-  if (
-    sources.some((source) =>
-      populationScalingRetrievalMethods.includes(source.retrievalMethod ?? ""),
-    )
-  ) {
-    const population = await db.models.Population.findOne({
-      where: {
-        cityId: inventory.cityId,
-        year: {
-          [Op.between]: [
-            inventory.year! - maxPopulationYearDifference,
-            inventory.year! + maxPopulationYearDifference,
-          ],
-        },
-      },
-      order: [["year", "DESC"]], // favor more recent population entries
-    });
-    // TODO allow country downscaling to work if there is no region population?
-    if (
-      !population ||
-      !population.population ||
-      !population.countryPopulation ||
-      !population.regionPopulation
-    ) {
-      // City is missing population/ region population/ country population for a year close to the inventory year
-      populationIssue = "missing-population"; // translation key
-    } else {
-      countryPopulationScaleFactor =
-        population.population / population.countryPopulation;
-      regionPopulationScaleFactor =
-        population.population / population.regionPopulation;
-    }
-  }
+  const {
+    countryPopulationScaleFactor,
+    regionPopulationScaleFactor,
+    populationIssue,
+  } = await findPopulationScaleFactors(inventory, applicableSources);
 
   // TODO add query parameter to make this optional?
   const sourceData = (
@@ -192,6 +226,12 @@ export const POST = apiHandler(async (req: NextRequest, { params }) => {
   // TODO check if the user has made manual edits that would be overwritten
   // TODO create new versioning record
 
+  const {
+    countryPopulationScaleFactor,
+    regionPopulationScaleFactor,
+    populationIssue,
+  } = await findPopulationScaleFactors(inventory, applicableSources);
+
   // download source data and apply in database
   const sourceResults = await Promise.all(
     applicableSources.map(async (source) => {
@@ -211,22 +251,19 @@ export const POST = apiHandler(async (req: NextRequest, { params }) => {
           result.success = false;
         }
       } else if (
-        source.retrievalMethod === "global_api_downscaled_by_population"
+        populationScalingRetrievalMethods.includes(source.retrievalMethod ?? "")
       ) {
-        const population = await db.models.Population.findOne({
-          where: {
-            cityId: inventory.cityId,
-            year: inventory.year,
-          },
-        });
-        if (!population?.population || !population?.countryPopulation) {
-          result.issue =
-            "City is missing population/ country population for the inventory year";
+        if (populationIssue) {
+          result.issue = populationIssue;
           result.success = false;
           return result;
         }
-        const scaleFactor =
-          population.population / population.countryPopulation;
+        let scaleFactor = 1.0;
+        if (source.retrievalMethod === downscaledByCountryPopulation) {
+          scaleFactor = countryPopulationScaleFactor;
+        } else if (source.retrievalMethod === downscaledByRegionPopulation) {
+          scaleFactor = regionPopulationScaleFactor;
+        }
         const sourceStatus = await DataSourceService.applyGlobalAPISource(
           source,
           inventory,

diff --git a/app/src/util/helpers.ts b/app/src/util/helpers.ts
@@ -125,3 +125,34 @@ export function keyBy<T>(
     {} as Record<string, T>,
   );
 }
+
+export interface PopulationEntry {
+  year: number;
+  population: number;
+}
+
+/// Finds entry which has the year closest to the selected inventory year
+export function findClosestYear(
+  populationData: PopulationEntry[] | undefined,
+  year: number,
+  maxYearDifference: number = 10,
+): PopulationEntry | null {
+  if (!populationData || populationData?.length === 0) {
+    return null;
+  }
+  return populationData.reduce(
+    (prev, curr) => {
+      // don't allow years outside of range
+      if (Math.abs(curr.year - year) > maxYearDifference) {
+        return prev;
+      }
+      if (!prev) {
+        return curr;
+      }
+      let prevDelta = Math.abs(year - prev.year);
+      let currDelta = Math.abs(year - curr.year);
+      return prevDelta < currDelta ? prev : curr;
+    },
+    null as PopulationEntry | null,
+  );
+}