@financial-times/cp-content-pipeline-schema 3.7.0 → 3.7.2

package/src/model/Image.test.ts

@@ -1,8 +1,10 @@
 import { CAPIImage } from './Image'
-import logger from '@dotcom-reliability-kit/logger'
+import { jest } from '@jest/globals'
 import type { QueryContext } from '..'
 import { Image } from './schemas/capi/internal-content'
+import { OrigamiImageDataSource } from '../datasources/origami-image'
 import { MAX_IMAGE_WIDTH } from '../helpers/imageService'
+import type { ImageSource } from '../generated'
 
 describe('Image', () => {
   const mockImage = {
@@ -11,8 +13,6 @@ describe('Image', () => {
     title: 'title',
     description: 'description',
     binaryUrl: 'cloudfront.com/image',
-    pixelWidth: 5000,
-    pixelHeight: 1000,
   }
 
   const graphic = {
@@ -20,17 +20,34 @@ describe('Image', () => {
     type: 'http://www.ft.com/ontology/content/Graphic' as const,
   }
 
+  const getImageMetadata = jest.fn<OrigamiImageDataSource['getImageMetadata']>()
+
   const context = {
-    logger,
+    dataSources: {
+      origami: {
+        getImageMetadata,
+      },
+      capi: {},
+      vanityUrls: {},
+    },
     systemCode: 'image-test',
   } as unknown as QueryContext
 
+  beforeEach(() => {
+    getImageMetadata.mockReset()
+  })
+
   describe('sourceSet', () => {
     describe('An image that is provided with a high resolution', () => {
-      it('transforms the URL to use the Origami Image Service', async () => {
+      let sourceSet: ImageSource[]
+
+      beforeAll(async () => {
+        getImageMetadata.mockResolvedValue({ width: 5000, height: 1000 })
         const model = new CAPIImage(mockImage, context)
-        const sourceSet = await model.sourceSet({ width: 1000 })
+        sourceSet = await model.sourceSet({ width: 1000 })
+      })
 
+      it('transforms the URL to use the Origami Image Service', () => {
         expect(
           sourceSet.every((source) =>
             source.url.startsWith(
@@ -40,10 +57,7 @@ describe('Image', () => {
         ).toBeTruthy()
       })
 
-      it('resizes the image to the requested width', async () => {
-        const model = new CAPIImage(mockImage, context)
-        const sourceSet = await model.sourceSet({ width: 1000 })
-
+      it('resizes the image to the requested width', () => {
         expect(
           sourceSet.every(
             (source) =>
@@ -52,9 +66,7 @@ describe('Image', () => {
         ).toBeTruthy()
       })
 
-      it('includes sourceSet for all the possible resolutions we can display the image at, given the requested width and the original source width', async () => {
-        const model = new CAPIImage(mockImage, context)
-        const sourceSet = await model.sourceSet({ width: 1000 })
+      it('includes sourceSet for all the possible resolutions we can display the image at, given the requested width and the original source width', () => {
         expect(sourceSet.length).toEqual(5)
         expect(sourceSet[0]?.dpr).toEqual(1)
         expect(sourceSet[0]?.url).toMatch(/dpr=1/)
@@ -65,10 +77,8 @@ describe('Image', () => {
 
     describe("An image that that isn't wide enough to generate high-resolution sourceSet for", () => {
       it('returns an array with a single resolution iamge service UR', async () => {
-        const model = new CAPIImage(
-          { ...mockImage, pixelWidth: 1500, pixelHeight: 500 },
-          context
-        )
+        getImageMetadata.mockResolvedValue({ width: 1500, height: 500 })
+        const model = new CAPIImage(mockImage, context)
         const sourceSet = await model.sourceSet({ width: 1000 })
         expect(sourceSet.length).toEqual(1)
         expect(sourceSet[0]).toEqual({
@@ -81,10 +91,8 @@ describe('Image', () => {
 
     describe('An image that that is smaller than the width that was requested', () => {
       it('returns the image at the same width as the original', async () => {
-        const model = new CAPIImage(
-          { ...mockImage, pixelWidth: 500, pixelHeight: 500 },
-          context
-        )
+        getImageMetadata.mockResolvedValue({ width: 500, height: 500 })
+        const model = new CAPIImage(mockImage, context)
         const sourceSet = await model.sourceSet({ width: 1000 })
         expect(sourceSet.length).toEqual(1)
         expect(sourceSet[0]).toEqual({
@@ -97,10 +105,8 @@ describe('Image', () => {
 
     describe('An image that that is bigger than the maximum width that was requested', () => {
       it('returns the image at the same width as the maximum width', async () => {
-        const model = new CAPIImage(
-          { ...mockImage, pixelWidth: 4000, pixelHeight: 4000 },
-          context
-        )
+        getImageMetadata.mockResolvedValue({ width: 4000, height: 4000 })
+        const model = new CAPIImage(mockImage, context)
         const sourceSet = await model.sourceSet({ width: MAX_IMAGE_WIDTH })
         expect(sourceSet.length).toEqual(1)
         expect(sourceSet[0]?.width).toEqual(MAX_IMAGE_WIDTH)
@@ -109,10 +115,8 @@ describe('Image', () => {
 
     describe('A large image with the maxDpr argumet passed', () => {
       it('only returns sourceSet up to and including the maxDpr', async () => {
-        const model = new CAPIImage(
-          { ...mockImage, pixelWidth: 5000, pixelHeight: 500 },
-          context
-        )
+        getImageMetadata.mockResolvedValue({ width: 5000, height: 500 })
+        const model = new CAPIImage(mockImage, context)
         const sourceSet = await model.sourceSet({ width: 1000, maxDpr: 2 })
         expect(sourceSet.length).toEqual(2)
         expect(sourceSet[0]?.dpr).toEqual(1)
@@ -133,6 +137,32 @@ describe('Image', () => {
         await expect(
           model.sourceSet({ width: 1000, maxDpr: 2 })
         ).rejects.toThrow('not-a-uuid is not a valid Content API Image ID')
+        expect(getImageMetadata).not.toHaveBeenCalled()
+      })
+    })
+
+    describe('When the image service fails to return metadata', () => {
+      let sourceSet: ImageSource[]
+      beforeEach(async () => {
+        getImageMetadata.mockRejectedValue(null)
+        const model = new CAPIImage(mockImage, context)
+        sourceSet = await model.sourceSet({ width: 3000 })
+      })
+      it('returns an image service URL with the requested width and max DPR 2', () => {
+        expect(sourceSet).toMatchInlineSnapshot(`
+          Array [
+            Object {
+              "dpr": 1,
+              "url": "https://www.ft.com/__origami/service/image/v2/images/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=3000&dpr=1",
+              "width": 3000,
+            },
+            Object {
+              "dpr": 2,
+              "url": "https://www.ft.com/__origami/service/image/v2/images/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=3000&dpr=2",
+              "width": 3000,
+            },
+          ]
+        `)
       })
     })
   })
@@ -211,18 +241,17 @@ describe('Image', () => {
   })
 
   describe('width/height', () => {
-    it('returns the original width and height from capi data', async () => {
+    it('returns the original width and height from the image service metadata', async () => {
+      getImageMetadata.mockResolvedValue({ width: 100, height: 200 })
       const model = new CAPIImage(mockImage, context)
       const { width, height } = (await model.dimensions()) || {}
-      expect(width).toEqual(5000)
-      expect(height).toEqual(1000)
+      expect(width).toEqual(100)
+      expect(height).toEqual(200)
     })
 
-    it('returns null if no width and height in capi data', async () => {
-      const model = new CAPIImage(
-        { ...mockImage, pixelHeight: undefined, pixelWidth: undefined },
-        context
-      )
+    it('returns null if the image service metadata call fails', async () => {
+      getImageMetadata.mockRejectedValue(null)
+      const model = new CAPIImage(mockImage, context)
       const dimensions = await model.dimensions()
       expect(dimensions).toEqual(null)
     })

package/src/model/Image.ts

@@ -11,7 +11,8 @@ import {
   validLiteralUnionValue,
 } from '../resolvers/literal-union'
 import { ImageFormat, ImageType } from '../resolvers/scalars'
-import { BaseError } from '@dotcom-reliability-kit/errors'
+import isError from '../helpers/isError'
+import { BaseError, OperationalError } from '@dotcom-reliability-kit/errors'
 import type { ImageSource } from '../generated'
 
 export type ImageSourceArgs = {
@@ -156,18 +157,25 @@ export class CAPIImage implements Image {
         height: this.capiImage.pixelHeight,
       }
     }
-
-    // HACK:KB:20241029 graphics and images in layouts don't have pixelWidth/
-    // pixelHeight because of reasons. we want to avoid calling Image Service
-    // to improve performance. skip calling Image Service for the time being
-    this.context.logger.warn({
-      event: 'SKIPPING_IMAGE_DIMENSIONS',
-      message: 'Not calling Image Service to get graphics dimensions',
-      url: this.capiImage.binaryUrl,
-      type: this.type(),
-    })
-
-    return null
+    try {
+      const imageMetadata = await this.#dataSources.origami.getImageMetadata(
+        this.capiImage.binaryUrl
+      )
+      return imageMetadata
+    } catch (error) {
+      if (isError(error)) {
+        this.context.logger.warn({
+          event: 'RECOVERABLE_ERROR',
+          error: new OperationalError({
+            code: 'IMAGE_DIMENSIONS_ERROR',
+            message: `Failed to get dimensions for ${this.capiImage.binaryUrl}`,
+            url: this.capiImage.binaryUrl,
+            cause: error,
+          }),
+        })
+      }
+      return null
+    }
   }
 
   credit() {

package/src/model/Topper.test.ts

@@ -95,6 +95,25 @@ describe('produces the correct types', () => {
     expect(desiredColour).toEqual(actualColour)
   })
 
+  it('full bleed left topper', () => {
+    const splitTopper = {
+      headline: '',
+      standfirst: '',
+      backgroundColour: 'auto',
+      layout: 'full-bleed-left',
+    }
+
+    const clonedBase = cloneDeep(baseCapiObject)
+    clonedBase.topper = splitTopper
+    const capiResponse = new CapiResponse(clonedBase, context)
+    const topper = new Topper(capiResponse, context)
+
+    const desired = 'FullBleedTopper'
+    const actual = topper.type()
+
+    expect(actual).toEqual(desired)
+  })
+
   it('opinion topper, is normal headline, sky background', () => {
     const clonedBase = cloneDeep(baseCapiObject)
     clonedBase.annotations.push({

package/src/model/Topper.ts

@@ -79,10 +79,6 @@ export class Topper {
       return 'SplitTextTopper'
     }
 
-    if (this.capiResponse.topper()?.layout === 'full-bleed-image-left') {
-      return 'SplitTextTopper'
-    }
-
     if (this.capiResponse.topper()?.layout === 'flourish') {
       return 'TopperWithFlourish'
     }