Merged in feat/rework-contentstack (pull request #3493)

Feat(SW-3708): refactor contentstack fetching (removing all refs) and cache invalidation

* Remove all REFS

* Revalidate correct language

* PR fixes

* PR fixes

* Throw when errors from contentstack api


Approved-by: Joakim Jäderberg

packages/trpc/lib/routers/contentstack/campaignPage/output.ts

@@ -5,20 +5,11 @@ import { removeMultipleSlashes } from "@scandic-hotels/common/utils/url"
 
 import { CampaignPageEnum } from "../../../types/campaignPage"
 import { discriminatedUnionArray } from "../../../utils/discriminatedUnion"
-import {
-  accordionRefsSchema,
-  accordionSchema,
-} from "../schemas/blocks/accordion"
-import {
-  carouselCardsRefsSchema,
-  carouselCardsSchema,
-} from "../schemas/blocks/carouselCards"
+import { accordionSchema } from "../schemas/blocks/accordion"
+import { carouselCardsSchema } from "../schemas/blocks/carouselCards"
 import { essentialsBlockSchema } from "../schemas/blocks/essentials"
 import { campaignPageHotelListingSchema } from "../schemas/blocks/hotelListing"
-import {
-  linkConnectionRefs,
-  linkConnectionSchema,
-} from "../schemas/linkConnection"
+import { linkConnectionSchema } from "../schemas/linkConnection"
 import { systemSchema } from "../schemas/system"
 import { getCarouselCardsBlockWithBookingCodeLinks } from "./utils"
 
@@ -258,46 +249,3 @@ export const campaignPagesByHotelUidSchema = z
     }),
   })
   .transform((data) => data.all_campaign_page.items)
-
-/** REFS */
-const campaignPageCarouselCardsRef = z
-  .object({
-    __typename: z.literal(CampaignPageEnum.ContentStack.blocks.CarouselCards),
-  })
-  .merge(carouselCardsRefsSchema)
-
-const campaignPageAccordionRefs = z
-  .object({
-    __typename: z.literal(CampaignPageEnum.ContentStack.blocks.Accordion),
-  })
-  .merge(accordionRefsSchema)
-
-const campaignPageBlockRefsItem = z.discriminatedUnion("__typename", [
-  campaignPageCarouselCardsRef,
-  campaignPageAccordionRefs,
-])
-const heroRefsSchema = z.object({
-  button: linkConnectionRefs,
-})
-
-export const campaignPageRefsSchema = z.object({
-  campaign_page: z.object({
-    hero: heroRefsSchema,
-    blocks: discriminatedUnionArray(
-      campaignPageBlockRefsItem.options
-    ).nullable(),
-    system: systemSchema,
-  }),
-})
-
-export const campaignPagesByHotelUidRefsSchema = z
-  .object({
-    all_campaign_page: z.object({
-      items: z.array(
-        z.object({
-          system: systemSchema,
-        })
-      ),
-    }),
-  })
-  .transform((data) => data.all_campaign_page.items.map((item) => item.system))

packages/trpc/lib/routers/contentstack/campaignPage/query.ts

@@ -2,64 +2,20 @@ import { createCounter } from "@scandic-hotels/common/telemetry"
 
 import { router } from "../../.."
 import { notFoundError } from "../../../errors"
-import {
-  GetCampaignPage,
-  GetCampaignPageRefs,
-} from "../../../graphql/Query/CampaignPage/CampaignPage.graphql"
+import { GetCampaignPage } from "../../../graphql/Query/CampaignPage/CampaignPage.graphql"
 import { request } from "../../../graphql/request"
 import { contentStackUidWithServiceProcedure } from "../../../procedures"
-import { generateRefsResponseTag } from "../../../utils/generateTag"
-import { campaignPageRefsSchema, campaignPageSchema } from "./output"
-import { generatePageTags } from "./utils"
+import { generateTag } from "../../../utils/generateTag"
+import { campaignPageSchema } from "./output"
 
-import type {
-  GetCampaignPageData,
-  GetCampaignPageRefsData,
-} from "../../../types/campaignPage"
+import type { GetCampaignPageData } from "../../../types/campaignPage"
 import type { TrackingPageData } from "../../types"
 
 export const campaignPageQueryRouter = router({
   get: contentStackUidWithServiceProcedure.query(async ({ ctx }) => {
     const { lang, uid } = ctx
 
-    const getCampaignPageRefsCounter = createCounter(
-      "trpc.contentstack.campaignPage.get.refs"
-    )
-    const metricsGetCampaignPageRefs = getCampaignPageRefsCounter.init({
-      lang,
-      uid,
-    })
-
-    metricsGetCampaignPageRefs.start()
-
-    const refVariables = { locale: lang, uid }
-    const refsResponse = await request<GetCampaignPageRefsData>(
-      GetCampaignPageRefs,
-      refVariables,
-      {
-        key: generateRefsResponseTag(lang, uid),
-        ttl: "max",
-      }
-    )
-    if (!refsResponse.data) {
-      metricsGetCampaignPageRefs.noDataError()
-      throw notFoundError({
-        message: "GetCampaignPageRefs returned no data",
-        errorDetails: refVariables,
-      })
-    }
-
-    const validatedRefsData = campaignPageRefsSchema.safeParse(
-      refsResponse.data
-    )
-    if (!validatedRefsData.success) {
-      metricsGetCampaignPageRefs.validationError(validatedRefsData.error)
-      return null
-    }
-
-    metricsGetCampaignPageRefs.success()
-
-    const tags = generatePageTags(validatedRefsData.data, lang)
+    const cacheKey = generateTag(lang, uid)
 
     const getCampaignPageCounter = createCounter(
       "trpc.contentstack.campaignPage.get"
@@ -76,7 +32,7 @@ export const campaignPageQueryRouter = router({
       GetCampaignPage,
       variables,
       {
-        key: tags,
+        key: `${cacheKey}:campaignPage`,
         ttl: "max",
       }
     )

packages/trpc/lib/routers/contentstack/campaignPage/utils.ts

@@ -1,72 +1,17 @@
 import { dt } from "@scandic-hotels/common/dt"
 import { createCounter } from "@scandic-hotels/common/telemetry"
 
-import { notFoundError } from "../../../errors"
-import {
-  GetCampaignPagesByHotelUid,
-  GetCampaignPagesByHotelUidRefs,
-} from "../../../graphql/Query/CampaignPage/CampaignPagesByHotelUid.graphql"
+import { GetCampaignPagesByHotelUid } from "../../../graphql/Query/CampaignPage/CampaignPagesByHotelUid.graphql"
 import { request } from "../../../graphql/request"
-import {
-  CampaignPageEnum,
-  type CampaignPageRefs,
-} from "../../../types/campaignPage"
-import {
-  generateRefsResponseTag,
-  generateTag,
-  generateTagsFromSystem,
-} from "../../../utils/generateTag"
-import {
-  campaignPagesByHotelUidRefsSchema,
-  campaignPagesByHotelUidSchema,
-} from "./output"
+import { generateTag } from "../../../utils/generateTag"
+import { campaignPagesByHotelUidSchema } from "./output"
 
 import type { Lang } from "@scandic-hotels/common/constants/language"
 
 import type {
   CarouselCardsBlock,
   GetCampaignPagesByHotelUidData,
-  GetCampaignPagesByHotelUidRefsData,
 } from "../../../types/campaignPage"
-import type { System } from "../schemas/system"
-
-export function generatePageTags(
-  validatedData: CampaignPageRefs,
-  lang: Lang
-): string[] {
-  const connections = getConnections(validatedData)
-  return [
-    generateTagsFromSystem(lang, connections),
-    generateTag(lang, validatedData.campaign_page.system.uid),
-  ].flat()
-}
-
-export function getConnections({ campaign_page }: CampaignPageRefs) {
-  const connections: System["system"][] = [campaign_page.system]
-
-  if (campaign_page.blocks) {
-    campaign_page.blocks.forEach((block) => {
-      switch (block.__typename) {
-        case CampaignPageEnum.ContentStack.blocks.CarouselCards: {
-          block.carousel_cards.card_groups.forEach((group) => {
-            group.cardConnection.edges.forEach(({ node }) => {
-              connections.push(node.system)
-            })
-          })
-          break
-        }
-        case CampaignPageEnum.ContentStack.blocks.Accordion: {
-          if (block.accordion.length) {
-            connections.push(...block.accordion.filter((c) => !!c))
-          }
-          break
-        }
-      }
-    })
-  }
-
-  return connections
-}
 
 export function getCarouselCardsBlockWithBookingCodeLinks(
   block: CarouselCardsBlock,
@@ -105,57 +50,6 @@ export async function getCampaignPagesByHotelPageUid(
   lang: Lang
 ) {
   const today = dt().format("YYYY-MM-DD")
-  const getCampaignPagesByHotelUidRefsCounter = createCounter(
-    "trpc.contentstack.campaignPage.byHotelUid.get.refs"
-  )
-  const metricsGetCampaignPagesByHotelUidRefs =
-    getCampaignPagesByHotelUidRefsCounter.init({
-      lang,
-      hotelPageUid,
-      today,
-    })
-
-  metricsGetCampaignPagesByHotelUidRefs.start()
-  const refsTag = generateRefsResponseTag(
-    lang,
-    `${hotelPageUid}-${today}`,
-    "hotel_page_campaigns"
-  )
-  const variables = {
-    locale: lang,
-    hotelPageUid,
-    today,
-  }
-  const refsResponse = await request<GetCampaignPagesByHotelUidRefsData>(
-    GetCampaignPagesByHotelUidRefs,
-    variables,
-    {
-      key: refsTag,
-      ttl: "1d",
-    }
-  )
-
-  if (!refsResponse.data) {
-    metricsGetCampaignPagesByHotelUidRefs.noDataError()
-    throw notFoundError({
-      message: "GetCampaignPagesByHotelUidRefs returned no data",
-      errorDetails: variables,
-    })
-  }
-
-  const validatedRefsData = campaignPagesByHotelUidRefsSchema.safeParse(
-    refsResponse.data
-  )
-  if (!validatedRefsData.success) {
-    metricsGetCampaignPagesByHotelUidRefs.validationError(
-      validatedRefsData.error
-    )
-    return null
-  }
-
-  metricsGetCampaignPagesByHotelUidRefs.success()
-
-  const tags = generateTagsFromSystem(lang, validatedRefsData.data)
 
   const getCampaignPagesByHotelUidCounter = createCounter(
     "trpc.contentstack.campaignPage.byHotelUid.get"
@@ -169,15 +63,17 @@ export async function getCampaignPagesByHotelPageUid(
 
   metricsGetCampaignPagesByHotelUid.start()
 
+  const variables = {
+    locale: lang,
+    hotelPageUid,
+    today,
+  }
+
   const response = await request<GetCampaignPagesByHotelUidData>(
     GetCampaignPagesByHotelUid,
+    variables,
     {
-      locale: lang,
-      hotelPageUid,
-      today,
-    },
-    {
-      key: [...tags, refsTag],
+      key: generateTag(lang, `${hotelPageUid}-${today}`),
       ttl: "1d",
     }
   )