fix: cache hotel response

server/routers/booking/output.ts

@@ -2,7 +2,7 @@ import { z } from "zod"
 
 import { ChildBedTypeEnum } from "@/constants/booking"
 
-import { phoneValidator } from "@/utils/phoneValidator"
+import { phoneValidator } from "@/utils/zod/phoneValidator"
 
 // MUTATION
 export const createBookingSchema = z

server/routers/hotels/output.ts

@@ -7,7 +7,7 @@ import { productTypeSchema } from "./schemas/availability/productType"
 import { citySchema } from "./schemas/city"
 import {
   attributesSchema,
-  includesSchema,
+  includedSchema,
   relationshipsSchema as hotelRelationshipsSchema,
 } from "./schemas/hotel"
 import { locationCitySchema } from "./schemas/location/city"
@@ -18,7 +18,13 @@ import { relationshipsSchema } from "./schemas/relationships"
 import { roomConfigurationSchema } from "./schemas/roomAvailability/configuration"
 import { rateDefinitionSchema } from "./schemas/roomAvailability/rateDefinition"
 
-import type { AdditionalData, City, NearbyHotel, Restaurant, Room } from "@/types/hotel"
+import type {
+  AdditionalData,
+  City,
+  NearbyHotel,
+  Restaurant,
+  Room,
+} from "@/types/hotel"
 
 // NOTE: Find schema at: https://aks-test.scandichotels.com/hotel/swagger/v1/index.html
 export const hotelSchema = z
@@ -38,10 +44,13 @@ export const hotelSchema = z
     }),
     // NOTE: We can pass an "include" param to the hotel API to retrieve
     // additional data for an individual hotel.
-    included: includesSchema,
+    included: includedSchema,
   })
   .transform(({ data: { attributes, ...data }, included }) => {
-    const additionalData = included.find((inc): inc is AdditionalData => inc!.type === "additionalData")
+    const additionalData =
+      included.find(
+        (inc): inc is AdditionalData => inc!.type === "additionalData"
+      ) ?? ({} as AdditionalData)
     const cities = included.filter((inc): inc is City => inc!.type === "cities")
     const nearbyHotels = included.filter(
       (inc): inc is NearbyHotel => inc!.type === "hotels"
@@ -262,4 +271,4 @@ export const getNearbyHotelIdsSchema = z
       })
     ),
   })
-  .transform((data) => data.data.map((hotel) => hotel.id))
+  .transform((data) => data.data.map((hotel) => hotel.id))

server/routers/hotels/query.ts

@@ -1,4 +1,7 @@
+import { unstable_cache } from "next/cache"
+
 import { ApiLang } from "@/constants/languages"
+import { env } from "@/env/server"
 import * as api from "@/lib/api"
 import { dt } from "@/lib/dt"
 import { badRequestError } from "@/server/errors/trpc"
@@ -15,6 +18,8 @@ import { cache } from "@/utils/cache"
 
 import { getHotelPageUrl } from "../contentstack/hotelPage/utils"
 import { getVerifiedUser, parsedUser } from "../user/query"
+import { additionalDataSchema } from "./schemas/additionalData"
+import { meetingRoomsSchema } from "./schemas/meetingRoom"
 import {
   breakfastPackageInputSchema,
   cityCoordinatesInputSchema,
@@ -54,133 +59,144 @@ import type { BedTypeSelection } from "@/types/components/hotelReservation/enter
 import { BreakfastPackageEnum } from "@/types/enums/breakfast"
 import { HotelTypeEnum } from "@/types/enums/hotelType"
 import type { RequestOptionsWithOutBody } from "@/types/fetch"
-import type { HotelInput } from "@/types/trpc/routers/hotel/hotel"
 import type { HotelData } from "@/types/hotel"
 import type { HotelPageUrl } from "@/types/trpc/routers/contentstack/hotelPage"
-import { CityLocation } from "@/types/trpc/routers/hotel/locations"
-import { meetingRoomsSchema } from "./schemas/meetingRoom"
-import { env } from "@/env/server"
-import { additionalDataSchema } from "./schemas/additionalData"
+import type { HotelInput } from "@/types/trpc/routers/hotel/hotel"
+import type { CityLocation } from "@/types/trpc/routers/hotel/locations"
 
 export const getHotel = cache(
   async (input: HotelInput, serviceToken: string) => {
-    const { hotelId, isCardOnlyPayment, language } = input
-    /**
-     * Since API expects the params appended and not just
-     * a comma separated string we need to initialize the
-     * SearchParams with a sequence of pairs
-     * (include=City&include=NearbyHotels&include=Restaurants etc.)
-     **/
-    const params = new URLSearchParams([
-      ["hotelId", hotelId],
-      ["include", "AdditionalData"],
-      ["include", "City"],
-      ["include", "NearbyHotels"],
-      ["include", "Restaurants"],
-      ["include", "RoomCategories"],
-      ["language", toApiLang(language)],
-    ])
-    metrics.hotel.counter.add(1, {
-      hotelId,
-      language,
-    })
-    console.info(
-      "api.hotels.hotelData start",
-      JSON.stringify({ query: { hotelId, params } })
-    )
+    const callable = unstable_cache(
+      async function (
+        hotelId: HotelInput["hotelId"],
+        language: HotelInput["language"],
+        isCardOnlyPayment?: HotelInput["isCardOnlyPayment"]
+      ) {
+        /**
+         * Since API expects the params appended and not just
+         * a comma separated string we need to initialize the
+         * SearchParams with a sequence of pairs
+         * (include=City&include=NearbyHotels&include=Restaurants etc.)
+         **/
+        const params = new URLSearchParams([
+          ["include", "AdditionalData"],
+          ["include", "City"],
+          ["include", "NearbyHotels"],
+          ["include", "Restaurants"],
+          ["include", "RoomCategories"],
+          ["language", toApiLang(language)],
+        ])
+        metrics.hotel.counter.add(1, {
+          hotelId,
+          language,
+        })
+        console.info(
+          "api.hotels.hotelData start",
+          JSON.stringify({ query: { hotelId, params } })
+        )
 
-    const apiResponse = await api.get(
-      api.endpoints.v1.Hotel.Hotels.hotel(hotelId),
-      {
-        headers: {
-          Authorization: `Bearer ${serviceToken}`,
-        },
-        // needs to clear default option as only
-        // cache or next.revalidate is permitted
-        cache: undefined,
-        next: {
-          revalidate: env.CACHE_TIME_HOTELDATA,
-          tags: [`${language}:hotel:${hotelId}`],
-        },
-      },
-      params
-    )
-
-    if (!apiResponse.ok) {
-      const text = await apiResponse.text()
-      console.log({ text })
-      metrics.hotel.fail.add(1, {
-        hotelId,
-        language,
-        error_type: "http_error",
-        error: JSON.stringify({
-          status: apiResponse.status,
-          statusText: apiResponse.statusText,
-          text,
-        }),
-      })
-      console.error(
-        "api.hotels.hotelData error",
-        JSON.stringify({
-          query: { hotelId, params },
-          error: {
-            status: apiResponse.status,
-            statusText: apiResponse.statusText,
-            text,
+        const apiResponse = await api.get(
+          api.endpoints.v1.Hotel.Hotels.hotel(hotelId),
+          {
+            headers: {
+              Authorization: `Bearer ${serviceToken}`,
+            },
+            // needs to clear default option as only
+            // cache or next.revalidate is permitted
+            cache: undefined,
+            next: {
+              revalidate: env.CACHE_TIME_HOTELS,
+              tags: [`${language}:hotel:${hotelId}`],
+            },
           },
+          params
+        )
+
+        if (!apiResponse.ok) {
+          const text = await apiResponse.text()
+          metrics.hotel.fail.add(1, {
+            hotelId,
+            language,
+            error_type: "http_error",
+            error: JSON.stringify({
+              status: apiResponse.status,
+              statusText: apiResponse.statusText,
+              text,
+            }),
+          })
+          console.error(
+            "api.hotels.hotelData error",
+            JSON.stringify({
+              query: { hotelId, params },
+              error: {
+                status: apiResponse.status,
+                statusText: apiResponse.statusText,
+                text,
+              },
+            })
+          )
+          return null
+        }
+
+        const apiJson = await apiResponse.json()
+        const validateHotelData = hotelSchema.safeParse(apiJson)
+
+        if (!validateHotelData.success) {
+          metrics.hotel.fail.add(1, {
+            hotelId,
+            language,
+            error_type: "validation_error",
+            error: JSON.stringify(validateHotelData.error),
+          })
+
+          console.error(
+            "api.hotels.hotelData validation error",
+            JSON.stringify({
+              query: { hotelId, params },
+              error: validateHotelData.error,
+            })
+          )
+          throw badRequestError()
+        }
+
+        metrics.hotel.success.add(1, {
+          hotelId,
+          language,
         })
-      )
-      return null
-    }
+        console.info(
+          "api.hotels.hotelData success",
+          JSON.stringify({
+            query: { hotelId, params: params },
+          })
+        )
+        const hotelData = validateHotelData.data
 
-    const apiJson = await apiResponse.json()
-    const validateHotelData = hotelSchema.safeParse(apiJson)
+        if (isCardOnlyPayment) {
+          hotelData.hotel.merchantInformationData.alternatePaymentOptions = []
+        }
 
-    if (!validateHotelData.success) {
-      metrics.hotel.fail.add(1, {
-        hotelId,
-        language,
-        error_type: "validation_error",
-        error: JSON.stringify(validateHotelData.error),
-      })
+        const gallery = hotelData.additionalData?.gallery
+        if (gallery) {
+          const smallerImages = gallery.smallerImages
+          const hotelGalleryImages =
+            hotelData.hotel.hotelType === HotelTypeEnum.Signature
+              ? smallerImages.slice(0, 10)
+              : smallerImages.slice(0, 6)
+          hotelData.hotel.galleryImages = hotelGalleryImages
+        }
 
-      console.error(
-        "api.hotels.hotelData validation error",
-        JSON.stringify({
-          query: { hotelId, params },
-          error: validateHotelData.error,
-        })
-      )
-      throw badRequestError()
-    }
-
-    metrics.hotel.success.add(1, {
-      hotelId,
-      language,
-    })
-    console.info(
-      "api.hotels.hotelData success",
-      JSON.stringify({
-        query: { hotelId, params: params },
-      })
+        return hotelData
+      },
+      [`${input.language}:hotel:${input.hotelId}:${!!input.isCardOnlyPayment}`],
+      {
+        revalidate: env.CACHE_TIME_HOTELS,
+        tags: [
+          `${input.language}:hotel:${input.hotelId}:${!!input.isCardOnlyPayment}`,
+        ],
+      }
     )
-    const hotelData = validateHotelData.data
 
-    if (isCardOnlyPayment) {
-      hotelData.hotel.merchantInformationData.alternatePaymentOptions = []
-    }
-
-    const gallery = hotelData.additionalData?.gallery
-    if (gallery) {
-      const smallerImages = gallery.smallerImages
-      const hotelGalleryImages =
-        hotelData.hotel.hotelType === HotelTypeEnum.Signature
-          ? smallerImages.slice(0, 10)
-          : smallerImages.slice(0, 6)
-      hotelData.hotel.galleryImages = hotelGalleryImages
-    }
-
-    return hotelData
+    return callable(input.hotelId, input.language, input.isCardOnlyPayment)
   }
 )
 
@@ -731,9 +747,9 @@ export const hotelQueryRouter = router({
                 type: matchingRoom.mainBed.type,
                 extraBed: matchingRoom.fixedExtraBed
                   ? {
-                    type: matchingRoom.fixedExtraBed.type,
-                    description: matchingRoom.fixedExtraBed.description,
-                  }
+                      type: matchingRoom.fixedExtraBed.type,
+                      description: matchingRoom.fixedExtraBed.description,
+                    }
                   : undefined,
               }
             }
@@ -861,7 +877,10 @@ export const hotelQueryRouter = router({
           }
 
           const cityId = locations
-            .filter((loc): loc is CityLocation => "type" in loc && loc.type === "cities")
+            .filter(
+              (loc): loc is CityLocation =>
+                "type" in loc && loc.type === "cities"
+            )
             .find((loc) => loc.cityIdentifier === locationFilter.city)?.id
 
           if (!cityId) {
@@ -973,7 +992,10 @@ export const hotelQueryRouter = router({
         const hotels = await Promise.all(
           hotelsToFetch.map(async (hotelId) => {
             const [hotelData, url] = await Promise.all([
-              getHotel({ hotelId, language }, ctx.serviceToken),
+              getHotel(
+                { hotelId, isCardOnlyPayment: false, language },
+                ctx.serviceToken
+              ),
               getHotelPageUrl(language, hotelId),
             ])
 
@@ -1000,7 +1022,8 @@ export const hotelQueryRouter = router({
         )
 
         return hotels.filter(
-          (hotel): hotel is { data: HotelData; url: HotelPageUrl } => !!hotel.data
+          (hotel): hotel is { data: HotelData; url: HotelPageUrl } =>
+            !!hotel.data
         )
       }),
   }),
@@ -1096,7 +1119,7 @@ export const hotelQueryRouter = router({
           Authorization: `Bearer ${ctx.serviceToken}`,
         },
         next: {
-          revalidate: TWENTYFOUR_HOURS,
+          revalidate: env.CACHE_TIME_HOTELS,
         },
       }
 

server/routers/hotels/schemas/availability/occupancy.ts

@@ -9,5 +9,5 @@ export const childrenSchema = z.object({
 
 export const occupancySchema = z.object({
   adults: z.number(),
-  children: z.array(childrenSchema),
+  children: z.array(childrenSchema).default([]),
 })

server/routers/hotels/schemas/hotel.ts

@@ -1,5 +1,7 @@
 import { z } from "zod"
 
+import { nullableNumberValidator } from "@/utils/zod/numberValidator"
+
 import { addressSchema } from "./hotel/address"
 import { contactInformationSchema } from "./hotel/contactInformation"
 import { hotelContentSchema } from "./hotel/content"
@@ -17,8 +19,8 @@ import { rewardNightSchema } from "./hotel/rewardNight"
 import { socialMediaSchema } from "./hotel/socialMedia"
 import { specialAlertsSchema } from "./hotel/specialAlerts"
 import { specialNeedGroupSchema } from "./hotel/specialNeedGroups"
-import { imageSchema } from "./image"
 import { facilitySchema } from "./additionalData"
+import { imageSchema } from "./image"
 
 export const attributesSchema = z.object({
   accessibilityElevatorPitchText: z.string().optional(),
@@ -51,13 +53,23 @@ export const attributesSchema = z.object({
   socialMedia: socialMediaSchema,
   specialAlerts: specialAlertsSchema,
   specialNeedGroups: z.array(specialNeedGroupSchema),
-  vat: z.number(),
+  vat: nullableNumberValidator,
 })
 
-export const includesSchema = z
+export const includedSchema = z
   .array(includeSchema)
   .default([])
-  .transform((data) => data.filter((item) => !!item))
+  .transform((data) =>
+    data.filter((item) => {
+      if (item) {
+        if ("isPublished" in item && item.isPublished === false) {
+          return false
+        }
+        return true
+      }
+      return false
+    })
+  )
 
 const relationshipSchema = z.object({
   links: z.object({

server/routers/hotels/schemas/hotel/include/restaurants.ts

@@ -2,70 +2,92 @@ import { z } from "zod"
 
 import { imageSchema } from "@/server/routers/hotels/schemas/image"
 
+import {
+  nullableIntValidator,
+  nullableNumberValidator,
+} from "@/utils/zod/numberValidator"
+import {
+  nullableStringUrlValidator,
+  nullableStringValidator,
+} from "@/utils/zod/stringValidator"
+
+import { specialAlertsSchema } from "../specialAlerts"
+
 import { CurrencyEnum } from "@/types/enums/currency"
 
+const descriptionSchema = z.object({
+  medium: nullableStringValidator,
+  short: nullableStringValidator,
+})
+
+const textSchema = z.object({
+  descriptions: descriptionSchema,
+  facilityInformation: nullableStringValidator,
+  meetingDescription: descriptionSchema.optional(),
+  surroundingInformation: nullableStringValidator,
+})
+
 const contentSchema = z.object({
   images: z.array(imageSchema).default([]),
-  texts: z.object({
-    descriptions: z.object({
-      medium: z.string().default(""),
-      short: z.string().default(""),
-    }),
-  }),
+  texts: textSchema,
+})
+
+const restaurantPriceSchema = z.object({
+  amount: nullableNumberValidator,
+  currency: z.nativeEnum(CurrencyEnum).default(CurrencyEnum.SEK),
 })
 
 const externalBreakfastSchema = z.object({
   isAvailable: z.boolean().default(false),
-  localPriceForExternalGuests: z.object({
-    amount: z.number().default(0),
-    currency: z.nativeEnum(CurrencyEnum).default(CurrencyEnum.SEK),
-  }),
+  localPriceForExternalGuests: restaurantPriceSchema.optional(),
+  requestedPriceForExternalGuests: restaurantPriceSchema.optional(),
 })
 
 const menuItemSchema = z.object({
-  name: z.string(),
-  url: z.string().url(),
+  name: nullableStringValidator,
+  url: nullableStringUrlValidator,
 })
 
-const daySchema = z.object({
+export const openingHoursDetailsSchema = z.object({
   alwaysOpen: z.boolean().default(false),
-  closingTime: z.string().default(""),
+  closingTime: nullableStringValidator,
   isClosed: z.boolean().default(false),
-  openingTime: z.string().default(""),
-  sortOrder: z.number().int().default(0),
+  openingTime: nullableStringValidator,
+  sortOrder: nullableIntValidator,
+})
+
+export const openingHoursSchema = z.object({
+  friday: openingHoursDetailsSchema.optional(),
+  isActive: z.boolean().default(false),
+  monday: openingHoursDetailsSchema.optional(),
+  name: nullableStringValidator,
+  saturday: openingHoursDetailsSchema.optional(),
+  sunday: openingHoursDetailsSchema.optional(),
+  thursday: openingHoursDetailsSchema.optional(),
+  tuesday: openingHoursDetailsSchema.optional(),
+  wednesday: openingHoursDetailsSchema.optional(),
 })
 
 const openingDetailsSchema = z.object({
-  alternateOpeningHours: z.object({
-    isActive: z.boolean().default(false),
-  }),
-  openingHours: z.object({
-    friday: daySchema,
-    isActive: z.boolean().default(false),
-    monday: daySchema,
-    name: z.string().default(""),
-    saturday: daySchema,
-    sunday: daySchema,
-    thursday: daySchema,
-    tuesday: daySchema,
-    wednesday: daySchema,
-  }),
+  alternateOpeningHours: openingHoursSchema.optional(),
+  openingHours: openingHoursSchema,
+  ordinary: openingHoursSchema.optional(),
+  weekends: openingHoursSchema.optional(),
 })
 
 export const restaurantsSchema = z.object({
   attributes: z.object({
-    bookTableUrl: z.string().default(""),
+    bookTableUrl: nullableStringValidator,
     content: contentSchema,
-    // When using .email().default("") is not sufficent
-    // so .optional also needs to be chained
     email: z.string().email().optional(),
     externalBreakfast: externalBreakfastSchema,
     isPublished: z.boolean().default(false),
     menus: z.array(menuItemSchema).default([]),
     name: z.string().default(""),
     openingDetails: z.array(openingDetailsSchema).default([]),
+    phoneNumber: z.string().optional(),
     restaurantPage: z.boolean().default(false),
-    specialAlerts: z.array(z.object({})).default([]),
+    specialAlerts: specialAlertsSchema,
   }),
   id: z.string(),
   type: z.literal("restaurants"),

server/routers/hotels/schemas/hotel/specialAlerts.ts

@@ -2,15 +2,17 @@ import { z } from "zod"
 
 import { dt } from "@/lib/dt"
 
+import { nullableStringValidator } from "@/utils/zod/stringValidator"
+
 import { AlertTypeEnum } from "@/types/enums/alert"
 
 const specialAlertSchema = z.object({
-  description: z.string().optional(),
-  displayInBookingFlow: z.boolean(),
-  endDate: z.string().optional(),
-  startDate: z.string().optional(),
-  title: z.string().optional(),
-  type: z.string(),
+  description: nullableStringValidator,
+  displayInBookingFlow: z.boolean().default(false),
+  endDate: nullableStringValidator,
+  startDate: nullableStringValidator,
+  title: nullableStringValidator,
+  type: nullableStringValidator,
 })
 
 export const specialAlertsSchema = z

server/routers/hotels/schemas/roomAvailability/configuration.ts

@@ -5,17 +5,19 @@ import { productSchema } from "./product"
 import { RoomPackageCodeEnum } from "@/types/components/hotelReservation/selectRate/roomFilter"
 
 export const roomConfigurationSchema = z.object({
-  features: z.array(
-    z.object({
-      inventory: z.number(),
-      code: z.enum([
-        RoomPackageCodeEnum.PET_ROOM,
-        RoomPackageCodeEnum.ALLERGY_ROOM,
-        RoomPackageCodeEnum.ACCESSIBILITY_ROOM,
-      ]),
-    })
-  ),
-  products: z.array(productSchema),
+  features: z
+    .array(
+      z.object({
+        inventory: z.number(),
+        code: z.enum([
+          RoomPackageCodeEnum.PET_ROOM,
+          RoomPackageCodeEnum.ALLERGY_ROOM,
+          RoomPackageCodeEnum.ACCESSIBILITY_ROOM,
+        ]),
+      })
+    )
+    .default([]),
+  products: z.array(productSchema).default([]),
   roomsLeft: z.number(),
   roomType: z.string(),
   roomTypeCode: z.string(),