@financial-times/cp-content-pipeline-schema 2.9.2 → 2.10.0

package/src/model/schemas/capi/base-schema.ts

@@ -21,6 +21,7 @@ const Topper = z.object({
   backgroundBox: z.boolean().optional(),
   textShadow: z.boolean().optional(),
   layout: z.string(),
+  layoutWidth: z.string().optional(),
 })
 
 const BaseImage = z.object({
@@ -88,6 +89,12 @@ const AlternativeImage = z.object({
   promotionalImage: BaseImage,
 })
 
+export const LeadFlourish = z.object({
+    id: z.string(),
+    type: z.string(),
+    description: z.string(),
+  })
+
 const ClipSource = z.object({
   audioCodec: z.string().optional(),
   binaryUrl: z.string().optional(),
@@ -261,6 +268,7 @@ export const baseMediaSchema = z.object({
   mainImage: MainImage.optional(),
   leadImages: LeadImage.array().optional(),
   alternativeImages: AlternativeImage.optional(),
+  leadFlourish: LeadFlourish.optional(),
   embeds: z.array(z.union([ImageSet, ClipSet])).optional(),
   dataSource: DataSource.array().optional(),
 })

package/src/model/schemas/capi/content-package.ts

@@ -44,6 +44,7 @@ const contentPackageMetadataSchema = baseMetadataSchema.pick({
 const contentPackageMediaSchema = baseMediaSchema.pick({
   mainImage: true,
   leadImages: true,
+  leadFlourish: true,
 })
 
 export const contentPackageSchema = contentPackageContentSchema

package/src/resolvers/content-tree/references/Flourish.test.ts

@@ -42,7 +42,7 @@ describe('Flourish Model', () => {
           /https:\/\/public.flourish.studio\/.*\/.*\/thumbnail/
         )
 
-        expect(decodeURIComponent(fallbackResponse.url)).toMatch(
+        expect(decodeURIComponent(fallbackResponse.url as string)).toMatch(
           flourishImageUrlRegex
         )
       })
@@ -66,7 +66,7 @@ describe('Flourish Model', () => {
           /https:\/\/public.flourish.studio\/.*\/example-id/
         )
 
-        expect(decodeURIComponent(fallbackResponse.url)).toMatch(
+        expect(decodeURIComponent(fallbackResponse.url as string)).toMatch(
           flourishImageUrlRegex
         )
       })
@@ -92,53 +92,6 @@ describe('Flourish Model', () => {
           encodeURIComponent(flourishImageUrl)
         )
       })
-      describe('the flourish timestamp is present', () => {
-        it('The Flourish cache buster is appended to the flourish image url', async () => {
-          const reference: ContentTree.Flourish = {
-            type: 'flourish',
-            id: 'example-id',
-            flourishType: 'example-type',
-            layoutWidth: 'grid',
-            timestamp: '2022-01-06T14:41:01.102Z',
-            description: 'Example description',
-          }
-          const fallbackResponse = await Flourish.fallbackImage(
-            { reference },
-            {},
-            context
-          )
-
-          const flourishImageCacheBuster =
-            '?cacheBuster=2022-01-06T14:41:01.102Z'
-
-          expect(fallbackResponse.url).toContain(
-            encodeURIComponent(flourishImageCacheBuster)
-          )
-        })
-      })
-      describe('the flourish timestamp is missing', () => {
-        it('The Flourish cache buster is not appended to the flourish image url', async () => {
-          const reference: ContentTree.Flourish = {
-            type: 'flourish',
-            id: 'example-id',
-            flourishType: 'example-type',
-            layoutWidth: 'grid',
-            timestamp: '',
-            description: 'Example description',
-          }
-          const fallbackResponse = await Flourish.fallbackImage(
-            { reference },
-            {},
-            context
-          )
-
-          const flourishImageCacheBuster = '?cacheBuster='
-
-          expect(fallbackResponse.url).not.toContain(
-            encodeURIComponent(flourishImageCacheBuster)
-          )
-        })
-      })
     })
   })
 })

package/src/resolvers/content-tree/references/Flourish.ts

@@ -3,37 +3,32 @@ import {
   FlourishFallbackResolvers,
   FlourishResolvers,
 } from '../../../generated'
-import { QueryContext } from '../../..'
-import isError from '../../../helpers/isError'
-import { OperationalError } from '@dotcom-reliability-kit/errors'
+import { FlourishSource } from '../../../model/FlourishSource'
 
 export const Flourish = {
   async fallbackImage(parent, _args, context) {
-    const type = parent.reference.flourishType
-    const timestamp =
-      typeof parent.reference.timestamp === 'string'
-        ? parent.reference.timestamp
-        : false
-
-    const flourishUrl = `https://public.flourish.studio/${type}/${
-      parent.reference.id
-    }/thumbnail${timestamp ? '?cacheBuster=' + timestamp : ''}`
-
-    const imageMetadata = await getImageMetadata(context, flourishUrl)
-
-    const width = imageMetadata.width
-    const height = imageMetadata.height
+    if (!parent.reference) {
+      return {}
+    }
+    const flourishData = {
+      id: parent.reference.id,
+      type: parent.reference.flourishType,
+      description: parent.reference.description,
+    }
+    const flourishSource = new FlourishSource(flourishData, context)
+    const width = await flourishSource.width()
+    const height = await flourishSource.height()
 
     const imageServiceWrappedUrl = imageServiceUrl({
-      url: flourishUrl,
+      url: flourishSource.flourishUrl(),
       systemCode: context.systemCode ?? 'cp-content-pipeline',
       width,
     })
 
     return {
       url: imageServiceWrappedUrl,
-      type: 'image',
-      format: 'standard',
+      type: flourishSource.type(),
+      format: flourishSource.format(),
       sourceSet: [],
       width,
       height,
@@ -56,42 +51,3 @@ export const FlourishFallback = {
     return parent.url ?? null
   },
 } satisfies FlourishFallbackResolvers
-
-type ImageMetadata = {
-  width: number
-  height: number
-}
-
-const getImageMetadata = async (
-  context: QueryContext,
-  flourishUrl: string
-): Promise<ImageMetadata> => {
-  const DEFAULT_WIDTH = 2626
-  const DEFAULT_HEIGHT = 1459
-
-  try {
-    const imageMetadata = await context.dataSources.origami.getImageMetadata(
-      flourishUrl
-    )
-
-    return {
-      width: imageMetadata?.width || DEFAULT_WIDTH,
-      height: imageMetadata?.height || DEFAULT_HEIGHT,
-    }
-  } catch (error) {
-    if (isError(error)) {
-      context.logger.warn({
-        event: 'RECOVERABLE_ERROR',
-        error: new OperationalError({
-          code: 'FLOURISH_IMAGE_METADATA_ERROR',
-          message: `Error getting image dimensions for Flourish fallback image ${flourishUrl}`,
-          cause: error,
-        }),
-      })
-    }
-    return {
-      width: DEFAULT_WIDTH,
-      height: DEFAULT_HEIGHT,
-    }
-  }
-}

package/src/resolvers/index.ts

@@ -10,6 +10,7 @@ import { default as scalars } from './scalars'
 import { default as teaser } from './teaser'
 import { default as topper } from './topper'
 import { default as person } from './person'
+import { default as leadFlourish } from './leadFlourish'
 import { resolvers as references } from './content-tree/references'
 import { Resolvers } from '../generated'
 
@@ -27,6 +28,7 @@ const resolvers = {
   ...teaser,
   ...topper,
   ...person,
+  ...leadFlourish,
 } satisfies Resolvers
 
 export default resolvers

package/src/resolvers/leadFlourish.ts

@@ -0,0 +1,31 @@
+import { LeadFlourishResolvers, FlourishSourceResolvers } from '../generated'
+
+const resolvers = {
+  LeadFlourish: {
+    type: (flourish) => flourish.type(),
+    id: (flourish) => flourish.id(),
+    description: (flourish) => flourish.description(),
+    fallbackImage: (flourish) => flourish.fallbackImage(),
+  },
+  FlourishSource: {
+    url: async (parent) => {
+      const url = await parent.url()
+      return url
+    },
+    height: async (parent) => {
+      const height = await parent.height()
+      return height
+    },
+    width: async (parent) => {
+      const width = await parent.width()
+      return width
+    },
+    type: (parent) => parent.type(),
+    format: (parent) => parent.format(),
+  },
+} satisfies {
+  LeadFlourish: LeadFlourishResolvers
+  FlourishSource: FlourishSourceResolvers
+}
+
+export default resolvers

package/src/resolvers/topper.ts

@@ -5,6 +5,7 @@ import {
   TopperWithImagesResolvers,
   TopperWithPackageResolvers,
   TopperWithThemeResolvers,
+  TopperWithFlourishResolvers,
   PodcastTopperResolvers,
   TopperWithHeadshotResolvers,
   BasicTopperResolvers,
@@ -101,6 +102,13 @@ const resolvers = {
     images: (topper) => topper.images(),
   },
 
+  TopperWithFlourish: {
+    ...topperResolvers,
+    layout: (topper) => topper.layout(),
+    layoutWidth: (topper) => topper.layoutWidth(),
+    leadFlourish: (topper) => topper.leadFlourish(),
+  },
+
   FullBleedTopper: {
     ...topperResolvers,
     brandConcept: (topper) => topper.brandConcept(),
@@ -119,10 +127,12 @@ const resolvers = {
     fallbackImage: (topper) => topper.fallbackImage(),
     images: (topper) => topper.images(),
   },
+
 } satisfies {
   Topper: TopperResolvers
   TopperWithImages: TopperWithImagesResolvers
   TopperWithTheme: TopperWithThemeResolvers
+  TopperWithFlourish: TopperWithFlourishResolvers
   TopperWithBrand: TopperWithBrandResolvers
   TopperWithHeadshot: TopperWithHeadshotResolvers
   TopperWithPackage: TopperWithPackageResolvers

package/src/types/internal-content.d.ts

@@ -11,6 +11,7 @@ import {
   ClipSet,
   MainImage,
   LeadImage,
+  LeadFlourish,
   capiNotificationResponse,
 } from '../model/schemas/capi/base-schema'
 
@@ -40,6 +41,7 @@ type Annotation = z.infer<typeof Annotation>
 type Image = z.infer<typeof Image>
 type LeadImage = z.infer<typeof LeadImage>
 type ImageSet = z.infer<typeof ImageSet>
+type LeadFlourish = z.infer<typeof LeadFlourish>
 type MainImage = z.infer<typeof MainImage>
 type Clip = z.infer<typeof Clip>
 type ClipSet = z.infer<typeof ClipSet>