@financial-times/cp-content-pipeline-schema 3.13.0 → 3.14.0

package/src/datasources/url-management.test.ts

@@ -9,6 +9,7 @@ import nUrlManagementApiReadClient from '@financial-times/n-url-management-api-r
 import type { QueryContext } from '..'
 import { InMemoryLRUCache } from '@apollo/utils.keyvaluecache'
 import { jest } from '@jest/globals'
+import { BaseError, HttpError } from '@dotcom-reliability-kit/errors'
 
 const getMock = nUrlManagementApiReadClient.get as jest.Mock<
   typeof import('@financial-times/n-url-management-api-read-client')['get']
@@ -95,4 +96,129 @@ describe('URL management data source', () => {
     expect(different).toEqual('different.url.vanity')
     expect(nUrlManagementApiReadClient.get).toHaveBeenCalledTimes(2)
   })
+
+  describe('error handling', () => {
+    it('wraps 4xx errors in HttpError', async () => {
+      getMock.mockRejectedValueOnce(
+        new HttpError({
+          statusCode: 400,
+          code: 'UnrecognisedClientException',
+        })
+      )
+
+      const datasource = new URLManagementDataSource({
+        context,
+        cache: new InMemoryLRUCache(),
+      })
+
+      await expect(datasource.get('original.url')).rejects
+        .toMatchInlineSnapshot(`
+        HttpError: "Internal Server Error" {
+          "cause": "HttpError: "Bad Request" {
+          "cause": null,
+          "code": "UNRECOGNISEDCLIENTEXCEPTION",
+          "data": {},
+        }",
+          "code": "URL_MANAGEMENT_CLIENT_ERROR",
+          "data": {
+            "upstreamStatusCode": 400,
+          },
+        }
+      `)
+    })
+
+    it('wraps 5xx errors in UpstreamError', async () => {
+      getMock.mockRejectedValueOnce(
+        new HttpError({
+          statusCode: 500,
+          code: 'InternalServerException',
+        })
+      )
+
+      const datasource = new URLManagementDataSource({
+        context,
+        cache: new InMemoryLRUCache(),
+      })
+
+      await expect(datasource.get('original.url')).rejects
+        .toMatchInlineSnapshot(`
+        UpstreamServiceError: "Bad Gateway" {
+          "cause": "HttpError: "Internal Server Error" {
+          "cause": null,
+          "code": "INTERNALSERVEREXCEPTION",
+          "data": {},
+        }",
+          "code": "URL_MANAGEMENT_SERVER_ERROR",
+          "data": {
+            "upstreamStatusCode": 500,
+          },
+        }
+      `)
+    })
+
+    it('wraps other HTTP errors in HttpError', async () => {
+      const error = new BaseError({
+        code: 'SomethingElseException',
+      })
+
+      Object.assign(error, {
+        // HttpError normalises status codes to the 400-599 range
+        statusCode: 137,
+      })
+
+      getMock.mockRejectedValueOnce(error)
+
+      const datasource = new URLManagementDataSource({
+        context,
+        cache: new InMemoryLRUCache(),
+      })
+
+      await expect(datasource.get('original.url')).rejects
+        .toMatchInlineSnapshot(`
+        HttpError: "Internal Server Error" {
+          "cause": "BaseError: "An error occurred" {
+          "cause": null,
+          "code": "SOMETHINGELSEEXCEPTION",
+          "data": {},
+        }",
+          "code": "URL_MANAGEMENT_UNKNOWN_ERROR",
+          "data": {
+            "upstreamStatusCode": 137,
+          },
+        }
+      `)
+    })
+
+    it('rethrows unknown errors', async () => {
+      getMock.mockRejectedValueOnce('not an error')
+
+      const datasource = new URLManagementDataSource({
+        context,
+        cache: new InMemoryLRUCache(),
+      })
+
+      await expect(
+        datasource.get('original.url')
+      ).rejects.toMatchInlineSnapshot(`"not an error"`)
+    })
+
+    it("doesn't cache error responses", async () => {
+      getMock.mockRejectedValueOnce(new Error())
+
+      const datasource = new URLManagementDataSource({
+        context,
+        cache: new InMemoryLRUCache(),
+      })
+
+      await expect(datasource.get('original.url')).rejects.toThrow()
+
+      getMock.mockImplementation((fromURL) =>
+        Promise.resolve({ fromURL, toURL: `${fromURL}.vanity`, code: 0 })
+      )
+
+      await expect(datasource.get('original.url')).resolves.toEqual(
+        `original.url.vanity`
+      )
+    })
+  })
 })

package/src/datasources/url-management.ts

@@ -7,6 +7,8 @@ import nUrlManagementApiReadClient from '@financial-times/n-url-management-api-r
 import type { ResolvedVanityURL } from '@financial-times/n-url-management-api-read-client'
 import { QueryContext } from '..'
 import { BaseDataSource, BaseDataSourceOptions } from './base'
+import { HttpError, UpstreamServiceError } from '@dotcom-reliability-kit/errors'
+import isError from '../helpers/isError'
 
 const CACHE_PREFIX = 'nurlmgmtapi:'
 const DEFAULT_TTL_IN_SECONDS = 60 * 60 // one hour
@@ -53,16 +55,54 @@ export class URLManagementDataSource implements BaseDataSource {
       return fromDynamoDB.toURL
     }
 
-    let promise = this.memoizedResults.get(fromURL)
+    try {
+      let promise = this.memoizedResults.get(fromURL)
 
-    if (promise) {
-      return promise
-    }
+      if (promise) {
+        return await promise
+      }
+
+      promise = getVanity()
+      this.memoizedResults.set(fromURL, promise)
+
+      this.calls.push(fromURL)
+      return await promise
+    } catch (error) {
+      this.memoizedResults.delete(fromURL)
+      await this.cache.delete(fromURL)
 
-    promise = getVanity()
-    this.memoizedResults.set(fromURL, promise)
+      if (
+        isError(error) &&
+        'statusCode' in error &&
+        typeof error.statusCode === 'number'
+      ) {
+        const baseErrorOptions = {
+          cause: error,
+          relatesToSystems: ['next-url-management-db'],
+          upstreamStatusCode: error.statusCode,
+        }
 
-    this.calls.push(fromURL)
-    return promise
+        if (error.statusCode >= 400 && error.statusCode < 500) {
+          throw new HttpError({
+            code: 'URL_MANAGEMENT_CLIENT_ERROR',
+            statusCode: 500,
+            ...baseErrorOptions,
+          })
+        } else if (error.statusCode >= 500 && error.statusCode < 600) {
+          throw new UpstreamServiceError({
+            code: 'URL_MANAGEMENT_SERVER_ERROR',
+            ...baseErrorOptions,
+          })
+        }
+
+        throw new HttpError({
+          code: 'URL_MANAGEMENT_UNKNOWN_ERROR',
+          statusCode: 500,
+          ...baseErrorOptions,
+        })
+      } else {
+        throw error
+      }
+    }
   }
 }

package/src/model/Concept.ts

@@ -3,6 +3,7 @@ import type { QueryContext } from '..'
 import { uuidFromUrl } from '../helpers/metadata'
 import isError from '../helpers/isError'
 import conceptIds from '@financial-times/n-concept-ids'
+import { OperationalError } from '@dotcom-reliability-kit/errors'
 
 const CAPI_ID_PREFIX = /^https?:\/\/(?:www|api)\.ft\.com\/things?\//
 const BASE_URL = 'https://www.ft.com/stream/'
@@ -155,7 +156,12 @@ export class Concept {
         if (isError(error)) {
           this.context.logger.warn({
             event: 'RECOVERABLE_ERROR',
-            error,
+            error: new OperationalError({
+              code: 'CONCEPT_VANITY_ERROR',
+              message: `Could not get vanity URL for concept. This means we'll be displaying the underlying URL instead of the vanity, which will cause additional redirects.`,
+              uuid: this.id(),
+              cause: error,
+            }),
           })
         }
       }

package/src/model/Content.ts

@@ -252,7 +252,12 @@ export class Content {
         if (isError(error)) {
           this.context.logger.warn({
             event: 'RECOVERABLE_ERROR',
-            error,
+            error: new OperationalError({
+              code: 'CONTENT_VANITY_ERROR',
+              message: `Could not get vanity URL for content. This means we'll be displaying the underlying URL instead of the vanity, which will cause additional redirects.`,
+              uuid: this.id(),
+              cause: error,
+            }),
           })
         }
       }

package/src/model/Image.test.ts

@@ -148,13 +148,13 @@ describe('Image', () => {
       })
       it('returns an image service URL with the requested width and max DPR 2', () => {
         expect(sourceSet).toMatchInlineSnapshot(`
-          Array [
-            Object {
+          [
+            {
               "dpr": 1,
               "url": "https://images.ft.com/v3/image/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://images.ft.com/v3/image/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=3000&dpr=2",
               "width": 3000,

package/src/model/RichText.test.ts

@@ -15,12 +15,12 @@ describe('RichText resolver', () => {
       'The UK’s first ID Buzz campervan is available to rent. On a test-drive in Sussex, it charms both passengers and passers-by'
     )
     expect(await model.structured()).toMatchInlineSnapshot(`
-      Object {
-        "references": Array [],
+      {
+        "references": [],
         "text": "",
-        "tree": Object {
-          "children": Array [
-            Object {
+        "tree": {
+          "children": [
+            {
               "type": "text",
               "value": "The UK’s first ID Buzz campervan is available to rent. On a test-drive in Sussex, it charms both passengers and passers-by",
             },
@@ -35,11 +35,11 @@ describe('RichText resolver', () => {
   it('should handle nulls', async () => {
     const model = new RichText('standfirst', null)
     expect(await model.structured()).toMatchInlineSnapshot(`
-      Object {
-        "references": Array [],
+      {
+        "references": [],
         "text": "",
-        "tree": Object {
-          "children": Array [],
+        "tree": {
+          "children": [],
           "type": "body",
           "version": 1,
         },

package/src/model/__snapshots__/Byline.test.ts.snap

@@ -1,18 +1,18 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`byline transformation adds a link around a single known author 1`] = `
-Object {
-  "references": Array [
-    Object {
+{
+  "references": [
+    {
       "contentApiData": undefined,
-      "reference": Object {
-        "children": Array [
-          Object {
+      "reference": {
+        "children": [
+          {
             "type": "text",
             "value": "Chris Giles",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
@@ -20,22 +20,22 @@ Object {
       },
     },
   ],
-  "tree": Object {
-    "children": Array [
-      Object {
-        "children": Array [
-          Object {
+  "tree": {
+    "children": [
+      {
+        "children": [
+          {
             "type": "text",
             "value": "Chris Giles",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
         "type": "author",
       },
-      Object {
+      {
         "type": "text",
         "value": " in London",
       },
@@ -46,34 +46,34 @@ Object {
 `;
 
 exports[`byline transformation adds links around multiple known authors 1`] = `
-Object {
-  "references": Array [
-    Object {
+{
+  "references": [
+    {
       "contentApiData": undefined,
-      "reference": Object {
-        "children": Array [
-          Object {
+      "reference": {
+        "children": [
+          {
             "type": "text",
             "value": "Chris Giles",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
         "type": "author",
       },
     },
-    Object {
+    {
       "contentApiData": undefined,
-      "reference": Object {
-        "children": Array [
-          Object {
+      "reference": {
+        "children": [
+          {
             "type": "text",
             "value": "Martin Wolf",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 1,
         },
         "id": "7c1e1e72-57ae-4461-862a-f8d24dd42e22",
@@ -81,39 +81,39 @@ Object {
       },
     },
   ],
-  "tree": Object {
-    "children": Array [
-      Object {
-        "children": Array [
-          Object {
+  "tree": {
+    "children": [
+      {
+        "children": [
+          {
             "type": "text",
             "value": "Chris Giles",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
         "type": "author",
       },
-      Object {
+      {
         "type": "text",
         "value": " and ",
       },
-      Object {
-        "children": Array [
-          Object {
+      {
+        "children": [
+          {
             "type": "text",
             "value": "Martin Wolf",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 1,
         },
         "id": "7c1e1e72-57ae-4461-862a-f8d24dd42e22",
         "type": "author",
       },
-      Object {
+      {
         "type": "text",
         "value": " in London",
       },
@@ -124,18 +124,18 @@ Object {
 `;
 
 exports[`byline transformation converts straight apostrophes in byline 1`] = `
-Object {
-  "references": Array [
-    Object {
+{
+  "references": [
+    {
       "contentApiData": undefined,
-      "reference": Object {
-        "children": Array [
-          Object {
+      "reference": {
+        "children": [
+          {
             "type": "text",
             "value": "Sarah O’Connor",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
@@ -143,22 +143,22 @@ Object {
       },
     },
   ],
-  "tree": Object {
-    "children": Array [
-      Object {
-        "children": Array [
-          Object {
+  "tree": {
+    "children": [
+      {
+        "children": [
+          {
             "type": "text",
             "value": "Sarah O’Connor",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
         "type": "author",
       },
-      Object {
+      {
         "type": "text",
         "value": " in Bali",
       },
@@ -169,11 +169,11 @@ Object {
 `;
 
 exports[`byline transformation handles bylines without any matching authors 1`] = `
-Object {
-  "references": Array [],
-  "tree": Object {
-    "children": Array [
-      Object {
+{
+  "references": [],
+  "tree": {
+    "children": [
+      {
         "type": "text",
         "value": "Chris Giles and Nick Ramsbottom in London",
       },
@@ -184,18 +184,18 @@ Object {
 `;
 
 exports[`byline transformation ignores extra authors in annotations array 1`] = `
-Object {
-  "references": Array [
-    Object {
+{
+  "references": [
+    {
       "contentApiData": undefined,
-      "reference": Object {
-        "children": Array [
-          Object {
+      "reference": {
+        "children": [
+          {
             "type": "text",
             "value": "Martin Wolf",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "7c1e1e72-57ae-4461-862a-f8d24dd42e22",
@@ -203,22 +203,22 @@ Object {
       },
     },
   ],
-  "tree": Object {
-    "children": Array [
-      Object {
-        "children": Array [
-          Object {
+  "tree": {
+    "children": [
+      {
+        "children": [
+          {
             "type": "text",
             "value": "Martin Wolf",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "7c1e1e72-57ae-4461-862a-f8d24dd42e22",
         "type": "author",
       },
-      Object {
+      {
         "type": "text",
         "value": " in London",
       },
@@ -229,18 +229,18 @@ Object {
 `;
 
 exports[`byline transformation ignores unknown authors in byline text 1`] = `
-Object {
-  "references": Array [
-    Object {
+{
+  "references": [
+    {
       "contentApiData": undefined,
-      "reference": Object {
-        "children": Array [
-          Object {
+      "reference": {
+        "children": [
+          {
             "type": "text",
             "value": "Chris Giles",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
@@ -248,22 +248,22 @@ Object {
       },
     },
   ],
-  "tree": Object {
-    "children": Array [
-      Object {
-        "children": Array [
-          Object {
+  "tree": {
+    "children": [
+      {
+        "children": [
+          {
             "type": "text",
             "value": "Chris Giles",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
         "type": "author",
       },
-      Object {
+      {
         "type": "text",
         "value": " and Nick Ramsbottom in London",
       },
@@ -274,18 +274,18 @@ Object {
 `;
 
 exports[`byline transformation leaves curly apostrophes in byline 1`] = `
-Object {
-  "references": Array [
-    Object {
+{
+  "references": [
+    {
       "contentApiData": undefined,
-      "reference": Object {
-        "children": Array [
-          Object {
+      "reference": {
+        "children": [
+          {
             "type": "text",
             "value": "Sarah O’Connor",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
@@ -293,22 +293,22 @@ Object {
       },
     },
   ],
-  "tree": Object {
-    "children": Array [
-      Object {
-        "children": Array [
-          Object {
+  "tree": {
+    "children": [
+      {
+        "children": [
+          {
             "type": "text",
             "value": "Sarah O’Connor",
           },
         ],
-        "data": Object {
+        "data": {
           "referenceIndex": 0,
         },
         "id": "1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
         "type": "author",
       },
-      Object {
+      {
         "type": "text",
         "value": " in Bali",
       },