Merged in feat/SW-1381-new-startpage-page (pull request #1197)

feat(SW-1381): add initial start page

* feat(SW-1381): add initial start page

* fix: remove unused startpage template

remove translation key for middleware error page

* fix(SW-1381): add tracking SDK and feature flag to hide start page


Approved-by: Erik Tiekstra
Approved-by: Matilda Landström
Approved-by: Chuma Mcphoy (We Ahead)

server/routers/contentstack/bookingwidget/output.ts

@@ -18,6 +18,7 @@ export const validateBookingWidgetToggleSchema = z.object({
   destination_city_page: bookingWidgetToggleSchema,
   hotel_page: bookingWidgetToggleSchema,
   loyalty_page: bookingWidgetToggleSchema,
+  start_page: bookingWidgetToggleSchema,
 })
 
 export type ValidateBookingWidgetToggleType = z.infer<

server/routers/contentstack/index.ts

@@ -16,6 +16,7 @@ import { loyaltyPageRouter } from "./loyaltyPage"
 import { metadataRouter } from "./metadata"
 import { myPagesRouter } from "./myPages"
 import { rewardRouter } from "./reward"
+import { startPageRouter } from "./startPage"
 
 export const contentstackRouter = router({
   accountPage: accountPageRouter,
@@ -34,4 +35,5 @@ export const contentstackRouter = router({
   metadata: metadataRouter,
   rewards: rewardRouter,
   loyaltyLevels: loyaltyLevelRouter,
+  startPage: startPageRouter,
 })

server/routers/contentstack/languageSwitcher/query.ts

@@ -39,6 +39,10 @@ import {
   GetDaDeEnUrlsLoyaltyPage,
   GetFiNoSvUrlsLoyaltyPage,
 } from "@/lib/graphql/Query/LoyaltyPage/LoyaltyPage.graphql"
+import {
+  GetDaDeEnUrlsStartPage,
+  GetFiNoSvUrlsStartPage,
+} from "@/lib/graphql/Query/StartPage/StartPage.graphql"
 import { internalServerError } from "@/server/errors/trpc"
 import { publicProcedure, router } from "@/server/trpc"
 
@@ -120,6 +124,10 @@ async function getLanguageSwitcher(options: LanguageSwitcherVariables) {
       daDeEnDocument = GetDaDeEnUrlsDestinationCityPage
       fiNoSvDocument = GetFiNoSvUrlsDestinationCityPage
       break
+    case PageContentTypeEnum.startPage:
+      daDeEnDocument = GetDaDeEnUrlsStartPage
+      fiNoSvDocument = GetFiNoSvUrlsStartPage
+      break
     default:
       console.error(`type: [${options.contentType}]`)
       console.error(`Trying to get a content type that is not supported`)

server/routers/contentstack/startPage/index.ts

@@ -0,0 +1,5 @@
+import { mergeRouters } from "@/server/trpc"
+
+import { startPageQueryRouter } from "./query"
+
+export const startPageRouter = mergeRouters(startPageQueryRouter)

server/routers/contentstack/startPage/output.ts

@@ -0,0 +1,25 @@
+import { z } from "zod"
+
+import { systemSchema } from "../schemas/system"
+
+export const startPageSchema = z.object({
+  start_page: z.object({
+    title: z.string(),
+    system: systemSchema.merge(
+      z.object({
+        created_at: z.string(),
+        updated_at: z.string(),
+      })
+    ),
+  }),
+  trackingProps: z.object({
+    url: z.string(),
+  }),
+})
+
+/** REFS */
+export const startPageRefsSchema = z.object({
+  start_page: z.object({
+    system: systemSchema,
+  }),
+})

server/routers/contentstack/startPage/query.ts

@@ -0,0 +1,182 @@
+import {
+  GetStartPage,
+  GetStartPageRefs,
+} from "@/lib/graphql/Query/StartPage/StartPage.graphql"
+import { request } from "@/lib/graphql/request"
+import { notFound } from "@/server/errors/trpc"
+import { contentstackExtendedProcedureUID, router } from "@/server/trpc"
+
+import { generateTag } from "@/utils/generateTag"
+
+import { startPageRefsSchema, startPageSchema } from "./output"
+import {
+  getStartPageCounter,
+  getStartPageFailCounter,
+  getStartPageRefsCounter,
+  getStartPageRefsFailCounter,
+  getStartPageRefsSuccessCounter,
+  getStartPageSuccessCounter,
+} from "./telemetry"
+
+import {
+  TrackingChannelEnum,
+  type TrackingSDKPageData,
+} from "@/types/components/tracking"
+import type {
+  GetStartPageData,
+  GetStartPageRefsSchema,
+} from "@/types/trpc/routers/contentstack/startPage"
+
+export const startPageQueryRouter = router({
+  get: contentstackExtendedProcedureUID.query(async ({ ctx }) => {
+    const { lang, uid } = ctx
+
+    getStartPageRefsCounter.add(1, { lang, uid: `${uid}` })
+    console.info(
+      "contentstack.startPage.refs start",
+      JSON.stringify({
+        query: { lang, uid },
+      })
+    )
+    const refsResponse = await request<GetStartPageRefsSchema>(
+      GetStartPageRefs,
+      {
+        locale: lang,
+        uid,
+      },
+      {
+        cache: "force-cache",
+        next: {
+          tags: [generateTag(lang, uid)],
+        },
+      }
+    )
+    if (!refsResponse.data) {
+      const notFoundError = notFound(refsResponse)
+      getStartPageRefsFailCounter.add(1, {
+        lang,
+        uid,
+        error_type: "not_found",
+        error: JSON.stringify({ code: notFoundError.code }),
+      })
+      console.error(
+        "contentstack.startPage.refs not found error",
+        JSON.stringify({
+          query: { lang, uid },
+          error: { code: notFoundError.code },
+        })
+      )
+      throw notFoundError
+    }
+
+    const validatedRefsData = startPageRefsSchema.safeParse(refsResponse.data)
+
+    if (!validatedRefsData.success) {
+      getStartPageRefsFailCounter.add(1, {
+        lang,
+        uid,
+        error_type: "validation_error",
+        error: JSON.stringify(validatedRefsData.error),
+      })
+      console.error(
+        "contentstack.startPage.refs validation error",
+        JSON.stringify({
+          query: { lang, uid },
+          error: validatedRefsData.error,
+        })
+      )
+      return null
+    }
+
+    getStartPageRefsSuccessCounter.add(1, { lang, uid: `${uid}` })
+    console.info(
+      "contentstack.startPage.refs success",
+      JSON.stringify({
+        query: { lang, uid },
+      })
+    )
+
+    getStartPageCounter.add(1, { lang, uid: `${uid}` })
+    console.info(
+      "contentstack.startPage start",
+      JSON.stringify({
+        query: { lang, uid },
+      })
+    )
+    const response = await request<GetStartPageData>(
+      GetStartPage,
+      {
+        locale: lang,
+        uid,
+      },
+      {
+        cache: "force-cache",
+        next: {
+          tags: [generateTag(lang, uid)],
+        },
+      }
+    )
+    if (!response.data) {
+      const notFoundError = notFound(response)
+      getStartPageFailCounter.add(1, {
+        lang,
+        uid: `${uid}`,
+        error_type: "not_found",
+        error: JSON.stringify({ code: notFoundError.code }),
+      })
+      console.error(
+        "contentstack.startPage not found error",
+        JSON.stringify({
+          query: { lang, uid },
+          error: { code: notFoundError.code },
+        })
+      )
+      throw notFoundError
+    }
+
+    const startPage = startPageSchema.safeParse(response.data)
+
+    if (!startPage.success) {
+      getStartPageFailCounter.add(1, {
+        lang,
+        uid: `${uid}`,
+        error_type: "validation_error",
+        error: JSON.stringify(startPage.error),
+      })
+      console.error(
+        "contentstack.startPage validation error",
+        JSON.stringify({
+          query: { lang, uid },
+          error: startPage.error,
+        })
+      )
+      return null
+    }
+
+    getStartPageSuccessCounter.add(1, { lang, uid: `${uid}` })
+    console.info(
+      "contentstack.startPage success",
+      JSON.stringify({
+        query: { lang, uid },
+      })
+    )
+
+    const system = startPage.data.start_page.system
+    const tracking: TrackingSDKPageData = {
+      pageId: system.uid,
+      domainLanguage: lang,
+      publishDate: system.updated_at,
+      createDate: system.created_at,
+      channel: TrackingChannelEnum["start-page"],
+      pageType: "start-page",
+      pageName: startPage.data.trackingProps.url,
+      siteSections: startPage.data.trackingProps.url,
+      siteVersion: "new-web",
+    }
+
+    return {
+      startPage: startPage.data.start_page,
+      tracking,
+    }
+  }),
+})

server/routers/contentstack/startPage/telemetry.ts

@@ -0,0 +1,23 @@
+import { metrics } from "@opentelemetry/api"
+
+const meter = metrics.getMeter("trpc.contentstack.startPage")
+
+export const getStartPageRefsCounter = meter.createCounter(
+  "trpc.contentstack.startPage.get"
+)
+export const getStartPageRefsFailCounter = meter.createCounter(
+  "trpc.contentstack.startPage.get-fail"
+)
+export const getStartPageRefsSuccessCounter = meter.createCounter(
+  "trpc.contentstack.startPage.get-success"
+)
+
+export const getStartPageCounter = meter.createCounter(
+  "trpc.contentstack.startPage.get"
+)
+export const getStartPageSuccessCounter = meter.createCounter(
+  "trpc.contentstack.startPage.get-success"
+)
+export const getStartPageFailCounter = meter.createCounter(
+  "trpc.contentstack.startPage.get-fail"
+)