Merge pull request #458 from Open-Earth-Foundation/fix/region-country…

…-locode feat(api): add countryLocode and regionLocode to city
Open-Earth-Foundation · Apr 24, 2024 · f5e9a6e · f5e9a6e
2 parents 346ef1a + c618060
commit f5e9a6e
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 16 deletions.
diff --git a/app/migrations/20240424131954-add-country-region-locode.cjs b/app/migrations/20240424131954-add-country-region-locode.cjs
@@ -0,0 +1,35 @@
+"use strict";
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.sequelize.transaction(async (transaction) => {
+      await queryInterface.addColumn(
+        "City",
+        "country_locode",
+        Sequelize.STRING,
+        { transaction },
+      );
+
+      await queryInterface.addColumn(
+        "City",
+        "region_locode",
+        Sequelize.STRING,
+        {
+          transaction,
+        },
+      );
+    });
+  },
+
+  async down(queryInterface) {
+    await queryInterface.sequelize.transaction(async (transaction) => {
+      await queryInterface.removeColumn("City", "country_locode", {
+        transaction,
+      });
+      await queryInterface.removeColumn("City", "region_locode", {
+        transaction,
+      });
+    });
+  },
+};
diff --git a/app/src/app/[lng]/onboarding/setup/page.tsx b/app/src/app/[lng]/onboarding/setup/page.tsx
@@ -717,31 +717,35 @@ export default function OnboardingSetup({
   const regionPopulationYear = watch("regionPopulationYear");
   const countryPopulationYear = watch("countryPopulationYear");
 
-  const { data: cityArea, isLoading: isCityAreaLoading } = api.useGetCityBoundaryQuery(data.locode!, {
-    skip: !data.locode,
-  });
+  const { data: cityArea, isLoading: isCityAreaLoading } =
+    api.useGetCityBoundaryQuery(data.locode!, {
+      skip: !data.locode,
+    });
 
   const onConfirm = async () => {
     // save data in backend
     setConfirming(true);
     let city: CityAttributes | null = null;
 
-    let area = ocCityData?.area ?? 0;
-    let region =
-      ocCityData?.root_path_geo.filter((item: any) => item.type === "adm1")[0]
-        ?.name ?? "";
-    let country =
-      ocCityData?.root_path_geo.filter(
-        (item: any) => item.type === "country",
-      )[0]?.name ?? "";
+    const area = cityArea?.area ?? ocCityData?.area ?? undefined;
+    const region = ocCityData?.root_path_geo.filter(
+      (item: any) => item.type === "adm1",
+    )[0];
+    const regionName = region?.name ?? "";
+    const country = ocCityData?.root_path_geo.filter(
+      (item: any) => item.type === "country",
+    )[0];
+    const countryName = country?.name ?? "";
 
     try {
       city = await addCity({
         name: data.name,
         locode: data.locode!,
-        area: Math.round(cityArea?.area!),
-        region,
-        country,
+        area,
+        region: regionName,
+        country: countryName,
+        regionLocode: region?.actor_id ?? undefined,
+        countryLocode: country?.actor_id ?? undefined,
       }).unwrap();
       await addCityPopulation({
         cityId: city.cityId,

diff --git a/app/src/models/City.ts b/app/src/models/City.ts
@@ -12,6 +12,8 @@ export interface CityAttributes {
   shape?: object;
   country?: string;
   region?: string;
+  countryLocode?: string;
+  regionLocode?: string;
   area?: number;
   created?: Date;
   lastUpdated?: Date;
@@ -25,6 +27,8 @@ export type CityOptionalAttributes =
   | "shape"
   | "country"
   | "region"
+  | "countryLocode"
+  | "regionLocode"
   | "area"
   | "created"
   | "lastUpdated";
@@ -43,6 +47,8 @@ export class City
   shape?: object;
   country?: string;
   region?: string;
+  countryLocode?: string;
+  regionLocode?: string;
   area?: number;
   created?: Date;
   lastUpdated?: Date;
@@ -162,6 +168,16 @@ export class City
           type: DataTypes.STRING(255),
           allowNull: true,
         },
+        countryLocode: {
+          type: DataTypes.STRING(255),
+          allowNull: true,
+          field: "country_locode",
+        },
+        regionLocode: {
+          type: DataTypes.STRING(255),
+          allowNull: true,
+          field: "region_locode",
+        },
         area: {
           type: DataTypes.BIGINT,
           allowNull: true,

diff --git a/app/src/services/api.ts b/app/src/services/api.ts
@@ -49,7 +49,7 @@ export const api = createApi({
       transformResponse: (response: {
         data: GeoJSON;
         boundingBox: BoundingBox;
-        area: number
+        area: number;
       }) => response,
     }),
     getInventory: builder.query<InventoryResponse, string>({
@@ -68,9 +68,11 @@ export const api = createApi({
       {
         name: string;
         locode: string;
-        area: number;
+        area: number | undefined;
         region: string;
         country: string;
+        regionLocode: string;
+        countryLocode: string;
       }
     >({
       query: (data) => ({

diff --git a/app/src/util/validation.ts b/app/src/util/validation.ts
@@ -22,6 +22,8 @@ export const createCityRequest = z.object({
   shape: geoJSON.optional(),
   country: z.string().optional(),
   region: z.string().optional(),
+  countryLocode: z.string().optional(),
+  regionLocode: z.string().optional(),
   area: z.number().int().optional(),
 });
 export type CreateCityRequest = z.infer<typeof createCityRequest>;