@financial-times/cp-content-pipeline-schema 3.4.0 → 3.5.1

package/src/model/FlourishSource.test.ts

@@ -45,7 +45,7 @@ describe('FlourishSource', () => {
 
   it('should return the correct flourishUrl', () => {
     expect(flourishSource.flourishUrl()).toBe(
-      'https://public.flourish.studio/test-type/1234/thumbnail?cacheBuster=5717196'
+      'https://public.flourish.studio/test-type/1234/thumbnail?cacheBuster=952866'
     )
   })
 
@@ -70,9 +70,9 @@ describe('FlourishSource', () => {
     expect(decodeURIComponent(url)).toMatch(flourishImageUrlRegex)
   })
 
-  it('should bust the cache of the fallback image every five minutes', async () => {
-    const oldCacheBuster = '5717196'
-    const newCacheBuster = '5717197'
+  it('should bust the cache of the fallback image every thirty minutes', async () => {
+    const oldCacheBuster = '952866'
+    const newCacheBuster = '952867'
 
     expect(flourishSource.flourishUrl()).toBe(
       `https://public.flourish.studio/test-type/1234/thumbnail?cacheBuster=${oldCacheBuster}`
@@ -85,7 +85,7 @@ describe('FlourishSource', () => {
     )
 
     newFlourishSource = new FlourishSource(mockFlourishData, context)
-    jest.spyOn(Date, 'now').mockImplementation(() => 1715159100000) // 8 May 2024 09:05:00
+    jest.spyOn(Date, 'now').mockImplementation(() => 1715160840000) // 8 May 2024 09:34:00
     expect(newFlourishSource.flourishUrl()).toBe(
       `https://public.flourish.studio/test-type/1234/thumbnail?cacheBuster=${newCacheBuster}`
     )

package/src/model/FlourishSource.ts

@@ -8,19 +8,37 @@ type ImageMetadata = {
   height: number
 }
 
-type FlourishData =
-  | {
-      id: string
-      type?: string
-      description?: string
-    }
-  | null
-  | undefined
+type FlourishData = {
+  id: string
+  type?: string
+  description?: string
+  width?: number
+  height?: number
+}
+
+const DEFAULT_WIDTH = 2626
+const DEFAULT_HEIGHT = 1459
 
 export class FlourishSource {
   #systemCode: string
   private imageMetadata?: ImageMetadata
 
+  static async createWithMetadata(data: FlourishData, context: QueryContext) {
+    const { width, height } = await FlourishSource.getImageMetadata(
+      data,
+      context
+    )
+
+    return new FlourishSource(
+      {
+        ...data,
+        width,
+        height,
+      },
+      context
+    )
+  }
+
   constructor(
     private flourishData: FlourishData,
     private context: QueryContext
@@ -29,11 +47,11 @@ export class FlourishSource {
   }
 
   id() {
-    return this.flourishData?.id || ''
+    return this.flourishData.id
   }
 
   type() {
-    return this.flourishData?.type || 'flourish'
+    return this.flourishData.type ?? 'flourish'
   }
 
   format() {
@@ -41,63 +59,63 @@ export class FlourishSource {
   }
 
   flourishUrl() {
-    // Timestamp rounded to the nearest 5 minutes to bust the cache every five minutes
-    const cacheBusterTimestamp = Math.floor(Date.now() / (5 * 60 * 1000))
-
-    return `https://public.flourish.studio/${this.type()}/${this.id()}/thumbnail?cacheBuster=${cacheBusterTimestamp}`
+    return FlourishSource.fallbackUrl(this.flourishData)
   }
 
-  private async getImageMetadata(): Promise<ImageMetadata> {
-    const DEFAULT_WIDTH = 2626
-    const DEFAULT_HEIGHT = 1459
+  private static fallbackUrl(data: FlourishData) {
+    // Timestamp rounded to the nearest 30 minutes to bust the cache every half an hour
+    const cacheBusterTimestamp = Math.floor(Date.now() / (30 * 60 * 1000))
 
-    if (this.imageMetadata) {
-      return this.imageMetadata
-    }
+    return `https://public.flourish.studio/${data.type ?? 'flourish'}/${
+      data.id
+    }/thumbnail?cacheBuster=${cacheBusterTimestamp}`
+  }
+
+  static async getImageMetadata(
+    data: FlourishData,
+    context: QueryContext
+  ) {
+    const url = FlourishSource.fallbackUrl(data)
 
     try {
-      const metadata = await this.context.dataSources.origami.getImageMetadata(
-        this.flourishUrl()
-      )
-      this.imageMetadata = {
+      const metadata = await context.dataSources.origami.getImageMetadata(url)
+
+      return {
         width: metadata?.width || DEFAULT_WIDTH,
         height: metadata?.height || DEFAULT_HEIGHT,
       }
     } catch (error) {
       if (isError(error)) {
-        this.context.logger.warn({
+        context.logger.warn({
           event: 'RECOVERABLE_ERROR',
           error: new OperationalError({
             code: 'FLOURISH_IMAGE_METADATA_ERROR',
-            message: `Error getting image dimensions for Flourish fallback image ${this.flourishUrl()}`,
+            message: `Error getting image dimensions for Flourish fallback image ${url}`,
             cause: error,
           }),
         })
       }
-      this.imageMetadata = {
+
+      return {
         width: DEFAULT_WIDTH,
         height: DEFAULT_HEIGHT,
       }
     }
-    return this.imageMetadata
   }
-  async width() {
-    const imageMetadata = await this.getImageMetadata()
-    return imageMetadata.width
+
+  width() {
+    return this.flourishData.width ?? DEFAULT_WIDTH
   }
 
-  async height() {
-    const imageMetadata = await this.getImageMetadata()
-    return imageMetadata.height
+  height() {
+    return this.flourishData.height ?? DEFAULT_HEIGHT
   }
 
-  async url() {
-    const width = await this.width()
-    const imageServiceWrappedUrl = imageServiceUrl({
+  url() {
+    return imageServiceUrl({
       url: this.flourishUrl(),
       systemCode: 'cp-content-pipeline',
-      width,
+      width: this.width(),
     })
-    return imageServiceWrappedUrl
   }
 }

package/src/model/Image.ts

@@ -157,6 +157,21 @@ export class CAPIImage implements Image {
         height: this.capiImage.pixelHeight,
       }
     }
+
+    // HACK:KB:20241029 graphics don't publish pixelWidth/pixelHeight due to a
+    // known issue in Spark. we want to avoid calling Image Service to improve
+    // performance. skip calling Image Service for graphics for the time being
+    // https://financialtimes.slack.com/archives/C02NXHEEN7J/p1729770129991129
+    if(this.type() === 'graphic') {
+      this.context.logger.warn({
+        event: 'SKIPPING_GRAPHICS_DIMENSIONS',
+        message: 'Not calling Image Service to get graphics dimensions',
+        url: this.capiImage.binaryUrl
+      })
+
+      return null
+    }
+
     try {
       const imageMetadata = await this.#dataSources.origami.getImageMetadata(
         this.capiImage.binaryUrl
@@ -174,6 +189,7 @@ export class CAPIImage implements Image {
           }),
         })
       }
+
       return null
     }
   }

package/src/model/LeadFlourish.test.ts

@@ -7,18 +7,13 @@ import cloneDeep from 'clone-deep'
 
 const context = {} as unknown as QueryContext
 
-jest.mock('./FlourishSource', () => {
-  return {
-    FlourishSource: jest.fn().mockImplementation(() => ({})),
-  }
-})
-
 const leadFlourishData = {
   id: 'test-id',
   description: 'test-description',
   type: 'test-type',
 }
 
+
 describe('LeadFlourish', () => {
   let leadFlourish: LeadFlourish
 
@@ -30,15 +25,17 @@ describe('LeadFlourish', () => {
       layoutWidth: 'full-width',
       backgroundColour: 'paper',
     }
+    jest.spyOn(FlourishSource, 'getImageMetadata').mockResolvedValue({
+      width: 800,
+      height: 600
+    })
     const capiResponse = new CapiResponse(clonedBase, context)
     leadFlourish = new LeadFlourish(capiResponse, context)
   })
 
   describe('fallbackImage', () => {
     it('should instantiate a new FlourishSource', async () => {
-      await leadFlourish.fallbackImage()
-
-      expect(FlourishSource).toHaveBeenCalledWith(leadFlourishData, context)
+      await expect(leadFlourish.fallbackImage()).resolves.toBeInstanceOf(FlourishSource)
     })
   })
 

package/src/model/LeadFlourish.ts

@@ -13,7 +13,11 @@ export class LeadFlourish {
 
   async fallbackImage() {
     const flourishData = this.capiResponse.leadFlourish()
-    return new FlourishSource(flourishData, this.context)
+    if (!flourishData) {
+      return null
+    }
+
+    return FlourishSource.createWithMetadata(flourishData, this.context)
   }
 
   id() {

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

@@ -147,7 +147,7 @@ export const ClipSet = z.object({
 const DataSource = z.object({
   binaryUrl: z.string(),
   duration: z.number(),
-  filesize: z.number(),
+  filesize: z.number().optional(),
   mediaType: z.string(),
 })
 

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

@@ -23,7 +23,7 @@ import { contentPackageSchema } from './content-package'
 
 export type Article = z.infer<typeof articleSchema>
 type Placeholder = z.infer<typeof placeholderSchema>
-type LiveBlogPackage = z.infer<typeof liveBlogPackageSchema>
+export type LiveBlogPackage = z.infer<typeof liveBlogPackageSchema>
 type ContentPackage = z.infer<typeof contentPackageSchema>
 type Audio = z.infer<typeof audioSchema>
 type Video = z.infer<typeof videoSchema>

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

@@ -30,6 +30,7 @@ describe('Flourish Model', () => {
           timestamp: '2022-01-06T14:41:01.102Z',
           description: 'Example description',
         }
+
         const fallbackResponse = await Flourish.fallbackImage(
           { reference },
           {},
@@ -42,7 +43,7 @@ describe('Flourish Model', () => {
           /https:\/\/public.flourish.studio\/.*\/.*\/thumbnail/
         )
 
-        expect(decodeURIComponent(fallbackResponse.url as string)).toMatch(
+        expect(decodeURIComponent(fallbackResponse?.url() as string)).toMatch(
           flourishImageUrlRegex
         )
       })
@@ -66,7 +67,7 @@ describe('Flourish Model', () => {
           /https:\/\/public.flourish.studio\/.*\/example-id/
         )
 
-        expect(decodeURIComponent(fallbackResponse.url as string)).toMatch(
+        expect(decodeURIComponent(fallbackResponse?.url() as string)).toMatch(
           flourishImageUrlRegex
         )
       })
@@ -88,7 +89,7 @@ describe('Flourish Model', () => {
 
         const flourishImageUrl = 'https://public.flourish.studio/example-type'
 
-        expect(fallbackResponse.url).toContain(
+        expect(fallbackResponse?.url() ?? '').toContain(
           encodeURIComponent(flourishImageUrl)
         )
       })

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

@@ -1,38 +1,25 @@
-import imageServiceUrl from '../../../helpers/imageService'
 import {
-  FlourishFallbackResolvers,
   FlourishResolvers,
+  FlourishSourceResolvers,
 } from '../../../generated'
-import { FlourishSource } from '../../../model/FlourishSource'
+import { FlourishSource as FlourishSourceModel } from '../../../model/FlourishSource'
 
 export const Flourish = {
   async fallbackImage(parent, _args, context) {
     if (!parent.reference) {
-      return {}
+      return null
     }
+
     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: flourishSource.flourishUrl(),
-      systemCode: context.systemCode ?? 'cp-content-pipeline',
-      width,
-    })
 
-    return {
-      url: imageServiceWrappedUrl,
-      type: flourishSource.type(),
-      format: flourishSource.format(),
-      sourceSet: [],
-      width,
-      height,
-    }
+    return FlourishSourceModel.createWithMetadata(
+      flourishData,
+      context
+    )
   },
 
   type(parent) {
@@ -40,14 +27,11 @@ export const Flourish = {
   },
 } satisfies FlourishResolvers
 
-export const FlourishFallback = {
-  async height(parent) {
-    return parent.height ?? null
-  },
-  async width(parent) {
-    return parent.width ?? null
-  },
-  async url(parent) {
-    return parent.url ?? null
-  },
-} satisfies FlourishFallbackResolvers
+export const FlourishSource = {
+  id: (parent) => parent.id(),
+  url: (parent) => parent.flourishUrl(),
+  type: (parent) => parent.type(),
+  width: (parent) => parent.width(),
+  height: (parent) => parent.height(),
+  format: (parent) => parent.format(),
+} satisfies FlourishSourceResolvers

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

@@ -8,7 +8,7 @@ import { ImageSet } from './ImageSet'
 import { ClipSet, Accessibility, Caption } from './ClipSet'
 import { CustomCodeComponent } from './CustomCodeComponent'
 import { Video } from './Video'
-import { Flourish, FlourishFallback } from './Flourish'
+import { Flourish, FlourishSource } from './Flourish'
 import { Recommended } from './Recommended'
 import { LayoutImage } from './LayoutImage'
 import { RawImage } from './RawImage'
@@ -27,8 +27,8 @@ import {
   VideoReferenceResolvers,
   CaptionResolvers,
   AccessibilityResolvers,
-  FlourishFallbackResolvers,
   AuthorReferenceResolvers,
+  FlourishSourceResolvers,
 } from '../../../generated'
 import { AnyNode } from '../Workarounds'
 import { Author } from './Author'
@@ -46,6 +46,7 @@ export const resolvers: {
   CustomCodeComponent: CustomCodeComponentResolvers
   VideoReference: VideoReferenceResolvers
   Flourish: FlourishResolvers
+  FlourishSource: FlourishSourceResolvers
   Recommended: RecommendedResolvers
   LayoutImage: LayoutImageResolvers
   RawImage: RawImageResolvers
@@ -53,7 +54,6 @@ export const resolvers: {
   MainImage: ImageSetResolvers
   Caption: CaptionResolvers
   Accessibility: AccessibilityResolvers
-  FlourishFallback: FlourishFallbackResolvers
   AuthorReference: AuthorReferenceResolvers
 } = {
   Reference,
@@ -63,6 +63,7 @@ export const resolvers: {
   CustomCodeComponent,
   VideoReference: Video,
   Flourish,
+  FlourishSource,
   Recommended,
   LayoutImage,
   RawImage,
@@ -70,7 +71,6 @@ export const resolvers: {
   MainImage: ImageSet,
   Caption,
   Accessibility,
-  FlourishFallback,
   AuthorReference: Author,
 }
 

package/src/resolvers/content.ts

@@ -5,6 +5,9 @@ import {
   AudioResolvers,
   ContentPackageResolvers,
   ContentResolvers,
+  ContentConnectionResolvers,
+  ContentEdgeResolvers,
+  PageInfoResolvers,
   LiveBlogPackageResolvers,
   LiveBlogPostResolvers,
   VideoResolvers,
@@ -70,6 +73,23 @@ const resolvers = {
     ...contentResolvers,
   },
 
+  ContentConnection: {
+    edges: (parent) => parent.edges,
+    pageInfo: (parent) => parent.pageInfo,
+  },
+
+  ContentEdge: {
+    node: (parent) => parent.node,
+    cursor: (parent) => parent.cursor,
+  },
+
+  PageInfo: {
+    hasPreviousPage: (parent) => parent.hasPreviousPage,
+    hasNextPage: (parent) => parent.hasNextPage,
+    startCursor: (parent) => parent.startCursor ?? null,
+    endCursor: (parent) => parent.endCursor ?? null,
+  },
+
   Article: {
     ...contentResolvers,
     containedIn: (parent) => parent.containedIn(),
@@ -101,7 +121,14 @@ const resolvers = {
 
   LiveBlogPackage: {
     ...contentResolvers,
-    liveBlogPosts: (parent) => parent.liveBlogPosts(),
+    liveBlogPosts: (parent, args) => parent.liveBlogPosts(args),
+    liveBlogPostsConnection: (parent, args) =>
+      parent.liveBlogPostsConnection({
+        first: args.first ?? undefined,
+        after: args.after ?? undefined,
+        last: args.last ?? undefined,
+        before: args.before ?? undefined,
+      }),
     pinnedPost: (parent) => parent.pinnedPost(),
     realtime: (parent) => parent.realtime(),
   },
@@ -161,6 +188,9 @@ const resolvers = {
   Placeholder: PlaceholderResolvers
   LiveBlogPost: LiveBlogPostResolvers
   Content: ContentResolvers
+  ContentConnection: ContentConnectionResolvers
+  ContentEdge: ContentEdgeResolvers
+  PageInfo: PageInfoResolvers
   LiveBlogPackage: LiveBlogPackageResolvers
   ContentPackage: ContentPackageResolvers
   Audio: AudioResolvers

package/src/types/connection.ts

@@ -0,0 +1,28 @@
+// Types to aid the implementation of a Connection type, as specified in
+// https://relay.dev/graphql/connections.htm
+
+export type ConnectionCursor = string
+
+export interface ConnectionPageInfo {
+  hasPreviousPage: boolean
+  hasNextPage: boolean
+  startCursor?: ConnectionCursor
+  endCursor?: ConnectionCursor
+}
+
+export interface ConnectionEdge<T> {
+  node: T
+  cursor: ConnectionCursor
+}
+
+export interface Connection<T> {
+  edges: ConnectionEdge<T>[]
+  pageInfo: ConnectionPageInfo
+}
+
+export interface ConnectionArguments {
+  first?: number
+  after?: ConnectionCursor
+  last?: number
+  before?: ConnectionCursor
+}