Merged in feature/SW-3572-hotel-data-endpoint (pull request #3051)

SW-3572 API route for listing hotels per city or country

* wip hotel data endpoint

* Correct route params type

* wip

* skip static paths call

* timeout when getting destinations take too long

* call noStore when we get a timeout

* add cache-control headers

* .

* .

* .

* wip

* wip

* wip

* wip

* add route for getting hotels per country

* include city when listing by country

* fix distance SI unit

* fix sorting

* Merge branch 'master' of bitbucket.org:scandic-swap/web into feature/SW-3572-hotel-data-endpoint

* packages/tracking passWithNoTests

* revalidate must be static value

* remove oxc reference

* cleanup

* cleanup hotel api route

* feat(SW-3572): cleanup error handling


Approved-by: Anton Gunnarsson

packages/trpc/lib/errors.ts

@@ -1,5 +1,13 @@
 import { TRPCError } from "@trpc/server"
 
+export function gatewayTimeout(cause?: unknown) {
+  return new TRPCError({
+    code: "GATEWAY_TIMEOUT",
+    message: `Gateway Timeout`,
+    cause,
+  })
+}
+
 export function unauthorizedError(cause?: unknown) {
   return new TRPCError({
     code: "UNAUTHORIZED",
@@ -76,6 +84,28 @@ export function publicUnauthorizedError() {
   })
 }
 
+export function httpStatusByErrorCode(error: TRPCError) {
+  switch (error.code) {
+    case "BAD_REQUEST":
+      return 400
+    case "UNAUTHORIZED":
+      return 401
+    case "FORBIDDEN":
+      return 403
+    case "NOT_FOUND":
+      return 404
+    case "CONFLICT":
+      return 409
+    case "UNPROCESSABLE_CONTENT":
+      return 422
+    case "GATEWAY_TIMEOUT":
+      return 504
+    case "INTERNAL_SERVER_ERROR":
+    default:
+      return 500
+  }
+}
+
 export function serverErrorByStatus(status: number, cause?: unknown) {
   switch (status) {
     case 401:

packages/trpc/lib/routers/autocomplete/destinations.ts

@@ -10,10 +10,10 @@ import { safeProtectedServiceProcedure } from "../../procedures"
 import { getCityPageUrls } from "../../routers/contentstack/destinationCityPage/utils"
 import { getCountryPageUrls } from "../../routers/contentstack/destinationCountryPage/utils"
 import { getHotelPageUrls } from "../../routers/contentstack/hotelPage/utils"
-import { getLocations } from "../../routers/hotels/utils"
 import { ApiCountry, type Country } from "../../types/country"
 import { getCitiesByCountry } from "../hotels/services/getCitiesByCountry"
 import { getCountries } from "../hotels/services/getCountries"
+import { getLocationsByCountries } from "../hotels/services/getLocationsByCountries"
 import { filterAndCategorizeAutoComplete } from "./util/filterAndCategorizeAutoComplete"
 import { mapLocationToAutoCompleteLocation } from "./util/mapLocationToAutoCompleteLocation"
 
@@ -136,7 +136,7 @@ export async function getAutoCompleteDestinationsData({
       }
 
       const [locations, locationsError] = await safeTry(
-        getLocations({
+        getLocationsByCountries({
           lang: lang,
           serviceToken: serviceToken,
           citiesByCountry: citiesByCountry,

packages/trpc/lib/routers/hotels/input.ts

@@ -143,16 +143,9 @@ export const getAdditionalDataInputSchema = z.object({
 
 export const getHotelsByCountryInput = z.object({
   country: z.nativeEnum(Country),
+  lang: z.nativeEnum(Lang).optional(),
 })
 
 export const getHotelsByCityIdentifierInput = z.object({
   cityIdentifier: z.string(),
 })
-
-export const getLocationsInput = z.object({
-  lang: z.nativeEnum(Lang),
-})
-
-export const getLocationsUrlsInput = z.object({
-  lang: z.nativeEnum(Lang),
-})

packages/trpc/lib/routers/hotels/locations/get.ts

@@ -0,0 +1,52 @@
+import { z } from "zod"
+
+import { Lang } from "@scandic-hotels/common/constants/language"
+import { getCacheClient } from "@scandic-hotels/common/dataCache"
+
+import { serviceProcedure } from "../../../procedures"
+import { getCitiesByCountry } from "../services/getCitiesByCountry"
+import { getCountries } from "../services/getCountries"
+import { getLocationsByCountries } from "../services/getLocationsByCountries"
+
+const getLocationsInput = z.object({
+  lang: z.nativeEnum(Lang),
+})
+
+export const get = serviceProcedure
+  .input(getLocationsInput)
+  .query(async function ({ ctx, input }) {
+    const lang = input.lang ?? ctx.lang
+    const cacheClient = await getCacheClient()
+    return await cacheClient.cacheOrGet(
+      `${lang}:getLocations`,
+      async () => {
+        const countries = await getCountries({
+          lang: lang,
+          serviceToken: ctx.serviceToken,
+        })
+
+        if (!countries) {
+          throw new Error("Unable to fetch countries")
+        }
+        const countryNames = countries.data.map((country) => country.name)
+        const citiesByCountry = await getCitiesByCountry({
+          countries: countryNames,
+          serviceToken: ctx.serviceToken,
+          lang,
+        })
+
+        const locations = await getLocationsByCountries({
+          lang,
+          serviceToken: ctx.serviceToken,
+          citiesByCountry,
+        })
+
+        if (!locations) {
+          throw new Error("Unable to fetch locations")
+        }
+
+        return locations
+      },
+      "max"
+    )
+  })

packages/trpc/lib/routers/hotels/locations/index.ts

@@ -0,0 +1,8 @@
+import { router } from "../../.."
+import { get } from "./get"
+import { urls } from "./urls"
+
+export const locationsRouter = router({
+  get,
+  urls,
+})

packages/trpc/lib/routers/hotels/locations/urls.ts

@@ -0,0 +1,49 @@
+import { z } from "zod"
+
+import { Lang } from "@scandic-hotels/common/constants/language"
+import { createCounter } from "@scandic-hotels/common/telemetry"
+
+import { publicProcedure } from "../../../procedures"
+import { getCityPageUrls } from "../../contentstack/destinationCityPage/utils"
+import { getHotelPageUrls } from "../../contentstack/hotelPage/utils"
+
+const getLocationsUrlsInput = z.object({
+  lang: z.nativeEnum(Lang),
+})
+
+export const urls = publicProcedure
+  .input(getLocationsUrlsInput)
+  .query(async ({ input }) => {
+    const { lang } = input
+
+    const locationsUrlsCounter = createCounter("trpc.hotel.locations", "urls")
+    const metricsLocationsUrls = locationsUrlsCounter.init({
+      lang,
+    })
+
+    metricsLocationsUrls.start()
+
+    const [hotelPageUrlsResult, cityPageUrlsResult] = await Promise.allSettled([
+      getHotelPageUrls(lang),
+      getCityPageUrls(lang),
+    ])
+
+    if (
+      hotelPageUrlsResult.status === "rejected" ||
+      cityPageUrlsResult.status === "rejected"
+    ) {
+      metricsLocationsUrls.dataError(`Failed to get data for page URLs`, {
+        hotelPageUrlsResult,
+        cityPageUrlsResult,
+      })
+
+      return null
+    }
+
+    metricsLocationsUrls.success()
+
+    return {
+      hotels: hotelPageUrlsResult.value,
+      cities: cityPageUrlsResult.value,
+    }
+  })

packages/trpc/lib/routers/hotels/query.ts

@@ -11,11 +11,9 @@ import { BreakfastPackageEnum } from "../../enums/breakfast"
 import { badRequestError } from "../../errors"
 import {
   contentStackBaseWithServiceProcedure,
-  publicProcedure,
   safeProtectedServiceProcedure,
   serviceProcedure,
 } from "../../procedures"
-import { getCityPageUrls } from "../../routers/contentstack/destinationCityPage/utils"
 import { getHotelPageUrls } from "../../routers/contentstack/hotelPage/utils"
 import {
   ancillaryPackageInputSchema,
@@ -26,8 +24,6 @@ import {
   getHotelsByCityIdentifierInput,
   getHotelsByCountryInput,
   getHotelsByCSFilterInput,
-  getLocationsInput,
-  getLocationsUrlsInput,
   getMeetingRoomsInputSchema,
   hotelInputSchema,
   nearbyHotelIdsInput,
@@ -38,22 +34,22 @@ import {
   breakfastPackagesSchema,
   getNearbyHotelIdsSchema,
 } from "../../routers/hotels/output"
+import { isCityLocation } from "../../types/locations"
 import { toApiLang } from "../../utils"
 import { additionalDataSchema } from "./schemas/hotel/include/additionalData"
 import { meetingRoomsSchema } from "./schemas/meetingRoom"
-import { getCitiesByCountry } from "./services/getCitiesByCountry"
 import { getHotelIdsByCityIdentifier } from "./services/getCityByCityIdentifier"
 import { getCountries } from "./services/getCountries"
 import { getHotel } from "./services/getHotel"
 import { getHotelIdsByCityId } from "./services/getHotelIdsByCityId"
 import { getHotelIdsByCountry } from "./services/getHotelIdsByCountry"
 import { getHotelsByHotelIds } from "./services/getHotelsByHotelIds"
+import { getLocationsByCountries } from "./services/getLocationsByCountries"
 import { getPackages } from "./services/getPackages"
 import { availability } from "./availability"
-import { getLocations } from "./utils"
+import { locationsRouter } from "./locations"
 
 import type { HotelListingHotelData } from "../../types/hotel"
-import type { CityLocation } from "../../types/locations"
 
 const hotelQueryLogger = createLogger("hotelQueryRouter")
 
@@ -82,9 +78,11 @@ export const hotelQueryRouter = router({
       get: contentStackBaseWithServiceProcedure
         .input(getHotelsByCountryInput)
         .query(async ({ ctx, input }) => {
-          const { lang, serviceToken } = ctx
+          const { serviceToken } = ctx
           const { country } = input
 
+          const lang = input.lang ?? ctx.lang
+
           const hotelIds = await getHotelIdsByCountry({
             country,
             serviceToken: ctx.serviceToken,
@@ -133,20 +131,18 @@ export const hotelQueryRouter = router({
             hotelsToFetch = hotelsToInclude
             shouldSortByDistance = false
           } else if (locationFilter?.city) {
-            const locations = await getLocations({
+            const locations = await getLocationsByCountries({
               lang: language,
               serviceToken: ctx.serviceToken,
               citiesByCountry: null,
             })
-            if (!locations || "error" in locations) {
+
+            if (!locations || locations.length === 0) {
               return []
             }
 
             const cityId = locations
-              .filter(
-                (loc): loc is CityLocation =>
-                  "type" in loc && loc.type === "cities"
-              )
+              .filter(isCityLocation)
               .find((loc) => loc.cityIdentifier === locationFilter.city)?.id
 
             if (!cityId) {
@@ -339,87 +335,7 @@ export const hotelQueryRouter = router({
         env.CACHE_TIME_HOTELS
       )
     }),
-  locations: router({
-    get: serviceProcedure.input(getLocationsInput).query(async function ({
-      ctx,
-      input,
-    }) {
-      const lang = input.lang ?? ctx.lang
-      const cacheClient = await getCacheClient()
-      return await cacheClient.cacheOrGet(
-        `${lang}:getLocations`,
-        async () => {
-          const countries = await getCountries({
-            lang: lang,
-            serviceToken: ctx.serviceToken,
-          })
-
-          if (!countries) {
-            throw new Error("Unable to fetch countries")
-          }
-          const countryNames = countries.data.map((country) => country.name)
-          const citiesByCountry = await getCitiesByCountry({
-            countries: countryNames,
-            serviceToken: ctx.serviceToken,
-            lang,
-          })
-
-          const locations = await getLocations({
-            lang,
-            serviceToken: ctx.serviceToken,
-            citiesByCountry,
-          })
-
-          if (!locations || "error" in locations) {
-            throw new Error("Unable to fetch locations")
-          }
-
-          return locations
-        },
-        "max"
-      )
-    }),
-    urls: publicProcedure
-      .input(getLocationsUrlsInput)
-      .query(async ({ input }) => {
-        const { lang } = input
-
-        const locationsUrlsCounter = createCounter(
-          "trpc.hotel.locations",
-          "urls"
-        )
-        const metricsLocationsUrls = locationsUrlsCounter.init({
-          lang,
-        })
-
-        metricsLocationsUrls.start()
-
-        const [hotelPageUrlsResult, cityPageUrlsResult] =
-          await Promise.allSettled([
-            getHotelPageUrls(lang),
-            getCityPageUrls(lang),
-          ])
-
-        if (
-          hotelPageUrlsResult.status === "rejected" ||
-          cityPageUrlsResult.status === "rejected"
-        ) {
-          metricsLocationsUrls.dataError(`Failed to get data for page URLs`, {
-            hotelPageUrlsResult,
-            cityPageUrlsResult,
-          })
-
-          return null
-        }
-
-        metricsLocationsUrls.success()
-
-        return {
-          hotels: hotelPageUrlsResult.value,
-          cities: cityPageUrlsResult.value,
-        }
-      }),
-  }),
+  locations: locationsRouter,
   map: router({
     city: serviceProcedure
       .input(cityCoordinatesInputSchema)

packages/trpc/lib/routers/hotels/schemas/location/hotel.ts

@@ -1,6 +1,9 @@
 import { z } from "zod"
 
 export const locationHotelSchema = z.object({
+  id: z.string().optional().default(""),
+  type: z.literal("hotels"),
+
   attributes: z.object({
     distanceToCentre: z.number().optional(),
     images: z
@@ -17,7 +20,7 @@ export const locationHotelSchema = z.object({
     name: z.string().optional().default(""),
     operaId: z.coerce.string().optional(),
   }),
-  id: z.string().optional().default(""),
+
   relationships: z
     .object({
       city: z
@@ -31,5 +34,4 @@ export const locationHotelSchema = z.object({
         .optional(),
     })
     .optional(),
-  type: z.literal("hotels"),
 })

packages/trpc/lib/routers/hotels/services/getCityByCityIdentifier.ts

@@ -1,7 +1,8 @@
 import { Lang } from "@scandic-hotels/common/constants/language"
 
-import { getLocations } from "../utils"
+import { isCityLocation } from "../../../types/locations"
 import { getHotelIdsByCityId } from "./getHotelIdsByCityId"
+import { getLocationsByCountries } from "./getLocationsByCountries"
 
 export async function getCityByCityIdentifier({
   cityIdentifier,
@@ -12,17 +13,18 @@ export async function getCityByCityIdentifier({
   lang: Lang
   serviceToken: string
 }) {
-  const locations = await getLocations({
+  const locations = await getLocationsByCountries({
     lang,
     citiesByCountry: null,
     serviceToken,
   })
-  if (!locations || "error" in locations) {
+
+  if (!locations || locations.length === 0) {
     return null
   }
 
   const city = locations
-    .filter((loc) => loc.type === "cities")
+    .filter(isCityLocation)
     .find((loc) => loc.cityIdentifier === cityIdentifier)
 
   return city ?? null
@@ -46,5 +48,6 @@ export async function getHotelIdsByCityIdentifier(
     cityId: city.id,
     serviceToken,
   })
+
   return hotelIds
 }

packages/trpc/lib/routers/hotels/services/getLocationsByCountries.test.ts

@@ -0,0 +1,398 @@
+import { beforeEach, describe, expect, it, type Mock, vi } from "vitest"
+
+import { Lang } from "@scandic-hotels/common/constants/language"
+import { getCacheClient } from "@scandic-hotels/common/dataCache"
+
+import * as api from "../../../api"
+import { getCity } from "./getCity"
+import { getLocationsByCountries } from "./getLocationsByCountries"
+
+import type { CitiesGroupedByCountry } from "../../../types/locations"
+
+// Mocks
+vi.mock("@scandic-hotels/common/dataCache", () => {
+  return {
+    getCacheClient: vi.fn(),
+  }
+})
+vi.mock("../../../api", () => {
+  return {
+    get: vi.fn(),
+    endpoints: {
+      v1: {
+        Hotel: {
+          locations: "/locations",
+        },
+      },
+    },
+  }
+})
+vi.mock("./getCity", () => {
+  return {
+    getCity: vi.fn(),
+  }
+})
+vi.mock("@scandic-hotels/common/logger/createLogger", () => {
+  return {
+    createLogger: () => ({
+      error: vi.fn(),
+      info: vi.fn(),
+    }),
+  }
+})
+
+const mockedGetCacheClient = getCacheClient as unknown as Mock
+const mockedApiGet = api.get as unknown as Mock
+const mockedGetCity = getCity as unknown as Mock
+
+describe("getLocationsByCountries", () => {
+  const mockedCacheClient = {
+    cacheOrGet: vi.fn().mockImplementation(async (_key: string, cb: any) => {
+      return cb()
+    }),
+  }
+
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it("returns cached value when cache has data", async () => {
+    const cacheClient = {
+      cacheOrGet: vi.fn().mockResolvedValueOnce("CACHED_VALUE"),
+    }
+    mockedGetCacheClient.mockResolvedValueOnce(cacheClient)
+
+    const result = await getLocationsByCountries({
+      lang: Lang.en,
+      citiesByCountry: null,
+      serviceToken: "token",
+    } as any)
+
+    expect(result).toBe("CACHED_VALUE")
+    expect(cacheClient.cacheOrGet).toHaveBeenCalled()
+    expect(mockedApiGet).not.toHaveBeenCalled()
+  })
+
+  it("throws unauthorized on 401 response", async () => {
+    mockedGetCacheClient.mockResolvedValueOnce(mockedCacheClient)
+
+    mockedApiGet.mockResolvedValueOnce({
+      ok: false,
+      status: 401,
+      json: async () => ({}),
+    })
+
+    await expect(
+      getLocationsByCountries({
+        lang: Lang.en,
+        citiesByCountry: null,
+        serviceToken: "token",
+      })
+    ).rejects.toThrow("Unauthorized")
+
+    expect(mockedApiGet).toHaveBeenCalled()
+  })
+
+  it("throws forbidden on 403 response", async () => {
+    mockedGetCacheClient.mockResolvedValueOnce(mockedCacheClient)
+
+    mockedApiGet.mockResolvedValueOnce({
+      ok: false,
+      status: 403,
+      json: async () => ({}),
+    })
+
+    await expect(
+      getLocationsByCountries({
+        lang: Lang.en,
+        citiesByCountry: null,
+        serviceToken: "token",
+      })
+    ).rejects.toThrow("Forbidden")
+  })
+
+  it("parses locations and enriches city country and hotel city via getCity", async () => {
+    mockedGetCacheClient.mockResolvedValueOnce(mockedCacheClient)
+
+    const apiPayload = mockApiData({
+      numberOfCities: 1,
+      numberOfHotels: 1,
+    })
+
+    mockedApiGet.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: async () => apiPayload,
+    })
+
+    // getCity returns enriched city object for hotel relationship
+    const mockedCity: Awaited<ReturnType<typeof getCity>> = {
+      cityIdentifier: "remote-ci-1",
+      ianaTimeZoneId: "Europe/Stockholm",
+      id: "remote-city-id",
+      isPublished: true,
+      keywords: [],
+      name: "RemoteCity",
+      timeZoneId: "Europe/Stockholm",
+      type: "cities",
+    }
+
+    mockedGetCity.mockResolvedValueOnce(mockedCity)
+
+    const citiesByCountry = {
+      CountryX: [{ name: "CityAA" }],
+    } as unknown as CitiesGroupedByCountry
+
+    const result = await getLocationsByCountries({
+      lang: Lang.en,
+      citiesByCountry,
+      serviceToken: "token",
+    })
+
+    // Result should be an array with two entries
+    expect(Array.isArray(result)).toBe(true)
+    expect(result).toHaveLength(2)
+
+    const cityNode = result
+      .filter((n) => n.type === "cities")
+      .find((n) => n.name === "City1")
+    const hotelNode = result
+      .filter((n) => n.type === "hotels")
+      .find((n) => n.name === "Hotel1")
+
+    expect(cityNode).toBeDefined()
+    expect(cityNode!.country).toBe("CountryX") // country assigned based on citiesByCountry
+
+    expect(hotelNode).toBeDefined()
+    expect(mockedGetCity).toHaveBeenCalledWith({
+      cityUrl: "https://api/cities/city1",
+      serviceToken: "token",
+    })
+    // hotel relationships.city should be the object returned by getCity (merged)
+    expect(hotelNode?.relationships).toBeDefined()
+    expect(hotelNode?.relationships.city).toEqual(
+      expect.objectContaining({
+        id: mockedCity.id,
+        name: mockedCity.name,
+      })
+    )
+  })
+
+  it("parses locations and enriches city country and hotel city via getCity", async () => {
+    mockedGetCacheClient.mockResolvedValueOnce(mockedCacheClient)
+
+    const apiPayload = mockApiData({
+      numberOfCities: 2,
+      numberOfHotels: 2,
+    })
+
+    mockedApiGet.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: async () => apiPayload,
+    })
+
+    // getCity returns enriched city object for hotel relationship
+    const mockedCity: Awaited<ReturnType<typeof getCity>> = {
+      cityIdentifier: "remote-ci-1",
+      ianaTimeZoneId: "Europe/Stockholm",
+      id: "remote-city-id",
+      isPublished: true,
+      keywords: [],
+      name: "RemoteCity",
+      timeZoneId: "Europe/Stockholm",
+      type: "cities",
+    }
+    mockedGetCity.mockResolvedValue(mockedCity)
+
+    const citiesByCountry = {
+      CountryX: [{ name: "CityAA" }],
+    } as unknown as CitiesGroupedByCountry
+
+    const result = await getLocationsByCountries({
+      lang: Lang.en,
+      citiesByCountry,
+      serviceToken: "token",
+    })
+
+    // Result should be an array with two entries
+    expect(Array.isArray(result)).toBe(true)
+    expect(result).toHaveLength(4)
+
+    const city1 = result
+      .filter((n) => n.type === "cities")
+      .find((n) => n.name === "City1")
+
+    expect(city1).toBeDefined()
+    expect(city1?.country).toBe("CountryX")
+
+    const hotel1 = result
+      .filter((n) => n.type === "hotels")
+      .find((n) => n.name === "Hotel1")
+    expect(hotel1).toBeDefined()
+    expect(mockedGetCity).toHaveBeenCalledWith({
+      cityUrl: "https://api/cities/city1",
+      serviceToken: "token",
+    })
+
+    // hotel relationships.city should be the object returned by getCity (merged)
+    expect(hotel1?.relationships).toBeDefined()
+    expect(hotel1?.relationships.city).toEqual(
+      expect.objectContaining({
+        id: mockedCity.id,
+        name: mockedCity.name,
+      })
+    )
+
+    const hotel2 = result
+      .filter((n) => n.type === "hotels")
+      .find((n) => n.name === "Hotel2")
+    expect(hotel2).toBeDefined()
+    expect(mockedGetCity).toHaveBeenCalledWith({
+      cityUrl: "https://api/cities/city2",
+      serviceToken: "token",
+    })
+    // hotel relationships.city should be the object returned by getCity (merged)
+    expect(hotel2?.relationships).toBeDefined()
+    expect(hotel2?.relationships.city).toEqual(
+      expect.objectContaining({
+        id: mockedCity.id,
+        name: mockedCity.name,
+      })
+    )
+
+    expect(mockedGetCity).toHaveBeenCalledTimes(2)
+  })
+
+  it("filters out unpublished cities", async () => {
+    mockedGetCacheClient.mockResolvedValueOnce(mockedCacheClient)
+
+    const apiPayload = mockApiData({
+      numberOfCities: 2,
+      numberOfHotels: 2,
+    })
+
+    apiPayload.data[0].attributes.isPublished = false
+
+    mockedApiGet.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: async () => apiPayload,
+    })
+
+    const citiesByCountry = {
+      CountryX: [{ name: "CityAA" }],
+    } as unknown as CitiesGroupedByCountry
+
+    const result = await getLocationsByCountries({
+      lang: Lang.en,
+      citiesByCountry,
+      serviceToken: "token",
+    })
+
+    // Result should be an array with two entries
+    expect(Array.isArray(result)).toBe(true)
+    expect(result).toHaveLength(3)
+
+    const city1 = result
+      .filter((n) => n.type === "cities")
+      .find((n) => n.name === "City1")
+
+    expect(city1).toBeUndefined()
+
+    const hotel1 = result
+      .filter((n) => n.type === "hotels")
+      .find((n) => n.name === "Hotel1")
+    expect(hotel1).toBeDefined()
+
+    const hotel2 = result
+      .filter((n) => n.type === "hotels")
+      .find((n) => n.name === "Hotel2")
+    expect(hotel2).toBeDefined()
+  })
+
+  it("sorts the result with cities first", async () => {
+    mockedGetCacheClient.mockResolvedValueOnce(mockedCacheClient)
+
+    const apiPayload = mockApiData({
+      numberOfCities: 9,
+      numberOfHotels: 9,
+    })
+    apiPayload.data = apiPayload.data.sort(() => Math.random() - 0.5) // shuffle
+    mockedApiGet.mockResolvedValueOnce({
+      ok: true,
+      status: 200,
+      json: async () => apiPayload,
+    })
+
+    const citiesByCountry = {
+      CountryX: [{ name: "CityAA" }],
+    } as unknown as CitiesGroupedByCountry
+
+    const result = await getLocationsByCountries({
+      lang: Lang.en,
+      citiesByCountry,
+      serviceToken: "token",
+    })
+
+    expect(result.at(0)?.type).toBe("cities")
+    expect(result.at(-1)?.type).toBe("hotels")
+
+    expect(result[0].type === "cities" ? result[0].name : undefined).toBe(
+      "City1"
+    )
+    expect(result[1].type === "cities" ? result[1].name : undefined).toBe(
+      "City2"
+    )
+
+    expect(result[9].type === "hotels" ? result[9].name : undefined).toBe(
+      "Hotel1"
+    )
+    expect(result[10].type === "hotels" ? result[10].name : undefined).toBe(
+      "Hotel2"
+    )
+  })
+})
+
+function mockApiData({
+  numberOfCities,
+  numberOfHotels,
+}: {
+  numberOfCities: number
+  numberOfHotels: number
+}) {
+  const cities = Array.from({ length: numberOfCities }, (_, i) => ({
+    id: `city${i + 1}`,
+    type: "cities" as const,
+    attributes: {
+      name: `City${i + 1}`,
+      countryName: `CountryX`,
+      cityIdentifier: `ci-${i + 1}`,
+      isPublished: true,
+    },
+  }))
+
+  const hotels = Array.from({ length: numberOfHotels }, (_, i) => ({
+    id: `hotel${i + 1}`,
+    type: "hotels" as const,
+    attributes: {
+      isActive: true,
+      name: `Hotel${i + 1}`,
+      operaId: `op-${i + 1}`,
+      isPublished: true,
+    },
+    relationships: {
+      city: {
+        links: {
+          related: `https://api/cities/city${i + 1}`,
+        },
+      },
+    },
+  }))
+
+  const apiPayload = {
+    data: [...cities, ...hotels],
+  }
+
+  return apiPayload
+}

packages/trpc/lib/routers/hotels/services/getLocationsByCountries.ts

@@ -0,0 +1,226 @@
+import deepmerge from "deepmerge"
+import { z } from "zod"
+
+import { getCacheClient } from "@scandic-hotels/common/dataCache"
+import { createLogger } from "@scandic-hotels/common/logger/createLogger"
+import { chunk } from "@scandic-hotels/common/utils/chunk"
+
+import * as api from "../../../api"
+import { serverErrorByStatus } from "../../../errors"
+import { toApiLang } from "../../../utils"
+import { locationCitySchema } from "../schemas/location/city"
+import { locationHotelSchema } from "../schemas/location/hotel"
+import { getCity } from "./getCity"
+
+import type { Lang } from "@scandic-hotels/common/constants/language"
+
+import type { Country } from "../../../types/country"
+
+const hotelUtilsLogger = createLogger("getLocationsByCountries")
+
+type CitiesNamesByCountry = Record<
+  Country | (string & {}),
+  Array<{ name: string }>
+> | null
+
+export async function getLocationsByCountries({
+  lang,
+  citiesByCountry,
+  serviceToken,
+}: {
+  lang: Lang
+  citiesByCountry: CitiesNamesByCountry | null
+  serviceToken: string
+}) {
+  const cacheClient = await getCacheClient()
+  const countryKeys = Object.keys(citiesByCountry ?? {})
+  let cacheKey = `${lang}:locations`
+
+  if (countryKeys.length > 0) {
+    cacheKey += `:${countryKeys.toSorted().join(",")}`
+  }
+
+  return await cacheClient.cacheOrGet(
+    cacheKey.toLowerCase(),
+    async () => {
+      const apiResponse = await api.get(
+        api.endpoints.v1.Hotel.locations,
+        {
+          headers: {
+            Authorization: `Bearer ${serviceToken}`,
+          },
+        },
+        {
+          language: toApiLang(lang),
+        }
+      )
+
+      if (!apiResponse.ok) {
+        throw serverErrorByStatus(apiResponse.status, { apiResponse })
+      }
+
+      const apiJson = await apiResponse.json()
+      const verifiedLocations = locationsSchema.safeParse(apiJson)
+      if (!verifiedLocations.success) {
+        hotelUtilsLogger.error(
+          `Locations Verification Failed`,
+          verifiedLocations.error
+        )
+        throw new Error("Unable to parse api response for locations", {
+          cause: verifiedLocations.error,
+        })
+      }
+
+      const data = cleanData(verifiedLocations.data.data)
+      const cities = data
+        .filter((x) => x.type === "cities")
+        .map((x) => enrichCity(x, citiesByCountry))
+
+      const chunkedHotels = chunk(
+        data.filter((x) => x.type === "hotels"),
+        10
+      )
+      const hotels = (
+        await Promise.all(
+          chunkedHotels.flatMap(async (chunk) => {
+            return await Promise.all(
+              chunk.flatMap(async (hotel) => enrichHotel(hotel, serviceToken))
+            )
+          })
+        )
+      ).flat()
+
+      let locations: z.infer<typeof locationsSchema>["data"] = [
+        ...cities,
+        ...hotels,
+      ]
+
+      return locations
+    },
+    "1d"
+  )
+}
+
+async function enrichHotel(
+  hotel: Extract<
+    z.infer<typeof locationsSchema>["data"][number],
+    { type: "hotels" }
+  >,
+  serviceToken: string
+): Promise<
+  Extract<z.infer<typeof locationsSchema>["data"][number], { type: "hotels" }>
+> {
+  if (hotel.type !== "hotels") {
+    return hotel
+  }
+
+  if (!hotel.relationships.city?.url) {
+    return hotel
+  }
+  const city = await getCity({
+    cityUrl: hotel.relationships.city.url,
+    serviceToken,
+  })
+
+  if (!city) {
+    return hotel
+  }
+
+  return deepmerge(hotel, {
+    relationships: {
+      city,
+    },
+  })
+}
+
+function enrichCity(
+  city: Extract<
+    z.infer<typeof locationsSchema>["data"][number],
+    { type: "cities" }
+  >,
+  citiesByCountry: CitiesNamesByCountry | null
+): Extract<
+  z.infer<typeof locationsSchema>["data"][number],
+  { type: "cities" }
+> {
+  if (!citiesByCountry) {
+    return city
+  }
+
+  const country = Object.keys(citiesByCountry).find((country) =>
+    citiesByCountry[country].find((loc) => loc.name === city.name)
+  )
+  if (!country) {
+    hotelUtilsLogger.error(
+      `Location cannot be found in any of the countries cities`,
+      city
+    )
+
+    return city
+  }
+
+  return {
+    ...city,
+    country,
+  }
+}
+
+function cleanData(data: z.infer<typeof locationsSchema>["data"]) {
+  return data
+    .filter((node) => {
+      if (node?.isPublished !== true) {
+        return false
+      }
+      if (node.type === "hotels" && !node.operaId) {
+        return false
+      }
+      if (node.type === "cities" && !node.cityIdentifier) {
+        return false
+      }
+
+      return true
+    })
+    .toSorted((a, b) => {
+      if (a.type === b.type) {
+        return a.name.localeCompare(b.name)
+      } else {
+        return a.type === "cities" ? -1 : 1
+      }
+    })
+}
+
+export const locationsSchema = z.object({
+  data: z.array(
+    z
+      .discriminatedUnion("type", [locationCitySchema, locationHotelSchema])
+      .transform((location) => {
+        if (location.type === "cities") {
+          return {
+            ...location.attributes,
+            country: location.attributes.countryName || "",
+            id: location.id,
+            type: location.type,
+          }
+        }
+        return {
+          ...location.attributes,
+          id: location.id,
+          relationships: {
+            city: {
+              cityIdentifier: "",
+              ianaTimeZoneId: "",
+              id: "",
+              isPublished: false,
+              keywords: [],
+              name: "",
+              timeZoneId: "",
+              type: "cities",
+              url: location?.relationships?.city?.links?.related ?? "",
+            },
+          },
+          type: location.type,
+          operaId: location.attributes.operaId ?? "",
+        }
+      })
+  ),
+})

packages/trpc/lib/routers/hotels/utils.ts

@@ -1,24 +1,11 @@
-import deepmerge from "deepmerge"
-
 import { selectRate } from "@scandic-hotels/common/constants/routes/hotelReservation"
-import { getCacheClient } from "@scandic-hotels/common/dataCache"
-import { createLogger } from "@scandic-hotels/common/logger/createLogger"
-import { chunk } from "@scandic-hotels/common/utils/chunk"
 
-import * as api from "../../api"
 import { BookingErrorCodeEnum } from "../../enums/bookingErrorCode"
 import { AvailabilityEnum } from "../../enums/selectHotel"
-import { toApiLang } from "../../utils"
 import { sortRoomConfigs } from "../../utils/sortRoomConfigs"
-import { getCity } from "./services/getCity"
-import { locationsSchema } from "./output"
-
-import type { Lang } from "@scandic-hotels/common/constants/language"
-import type { z } from "zod"
 
 import type { BedTypeSelection } from "../../types/bedTypeSelection"
 import type { Room as RoomCategory } from "../../types/hotel"
-import type { CitiesGroupedByCountry } from "../../types/locations"
 import type {
   Product,
   Products,
@@ -29,114 +16,6 @@ import type {
 import type { RoomsAvailabilityExtendedInputSchema } from "./availability/enterDetails"
 export const locationsAffix = "locations"
 
-const hotelUtilsLogger = createLogger("hotelUtils")
-
-export async function getLocations({
-  lang,
-  citiesByCountry,
-  serviceToken,
-}: {
-  lang: Lang
-  citiesByCountry: CitiesGroupedByCountry | null
-  serviceToken: string
-}) {
-  const cacheClient = await getCacheClient()
-  const countryKeys = Object.keys(citiesByCountry ?? {})
-  let cacheKey = `${lang}:locations`
-
-  if (countryKeys.length) {
-    cacheKey += `:${countryKeys.join(",")}`
-  }
-
-  return await cacheClient.cacheOrGet(
-    cacheKey.toLowerCase(),
-    async () => {
-      const params = new URLSearchParams({
-        language: toApiLang(lang),
-      })
-
-      const apiResponse = await api.get(
-        api.endpoints.v1.Hotel.locations,
-        {
-          headers: {
-            Authorization: `Bearer ${serviceToken}`,
-          },
-        },
-        params
-      )
-      if (!apiResponse.ok) {
-        if (apiResponse.status === 401) {
-          throw new Error("unauthorized")
-        } else if (apiResponse.status === 403) {
-          throw new Error("forbidden")
-        }
-        throw new Error("downstream error")
-      }
-
-      const apiJson = await apiResponse.json()
-      const verifiedLocations = locationsSchema.safeParse(apiJson)
-      if (!verifiedLocations.success) {
-        hotelUtilsLogger.error(
-          `Locations Verification Failed`,
-          verifiedLocations.error
-        )
-        throw new Error("Unable to parse locations")
-      }
-      const chunkedLocations = chunk(verifiedLocations.data.data, 10)
-
-      let locations: z.infer<typeof locationsSchema>["data"] = []
-
-      for (const chunk of chunkedLocations) {
-        const chunkLocations = await Promise.all(
-          chunk.map(async (location) => {
-            if (location.type === "cities") {
-              if (citiesByCountry) {
-                const country = Object.keys(citiesByCountry).find((country) =>
-                  citiesByCountry[country].find(
-                    (loc) => loc.name === location.name
-                  )
-                )
-                if (country) {
-                  return {
-                    ...location,
-                    country,
-                  }
-                } else {
-                  hotelUtilsLogger.error(
-                    `Location cannot be found in any of the countries cities`,
-                    location
-                  )
-                }
-              }
-            } else if (location.type === "hotels") {
-              if (location.relationships.city?.url) {
-                const city = await getCity({
-                  cityUrl: location.relationships.city.url,
-                  serviceToken,
-                })
-                if (city) {
-                  return deepmerge(location, {
-                    relationships: {
-                      city,
-                    },
-                  })
-                }
-              }
-            }
-
-            return location
-          })
-        )
-
-        locations.push(...chunkLocations)
-      }
-
-      return locations
-    },
-    "1d"
-  )
-}
-
 export const TWENTYFOUR_HOURS = 60 * 60 * 24
 
 function findProduct(product: Products, rateDefinition: RateDefinition) {

packages/trpc/lib/types/locations.ts

@@ -5,6 +5,7 @@ import type {
   countriesSchema,
   locationsSchema,
 } from "../routers/hotels/output"
+import type { Country } from "./country"
 
 export interface LocationSchema extends z.output<typeof locationsSchema> {}
 
@@ -18,8 +19,17 @@ export function isHotelLocation(
 ): location is HotelLocation {
   return location?.type === "hotels"
 }
+
+export function isCityLocation(
+  location: Location | null
+): location is CityLocation {
+  return location?.type === "cities"
+}
 export interface CitiesByCountry
   extends z.output<typeof citiesByCountrySchema> {}
-export type CitiesGroupedByCountry = Record<string, CitiesByCountry["data"]>
+export type CitiesGroupedByCountry = Record<
+  Country | (string & {}),
+  NonNullable<CitiesByCountry["data"]>
+>
 
 export interface Countries extends z.output<typeof countriesSchema> {}