@financial-times/cp-content-pipeline-schema 1.3.8 → 1.3.9

package/src/model/CapiResponse.ts

@@ -8,7 +8,6 @@ import conceptIds from '@financial-times/n-concept-ids'
 import metadata, { TeaserMetadata } from '@financial-times/n-display-metadata'
 import cloneDeep from 'clone-deep'
 import { ConditionalKeys } from 'type-fest'
-import { logRecoverableError } from '@dotcom-reliability-kit/log-error'
 import { OperationalError } from '@dotcom-reliability-kit/errors'
 
 import type { QueryContext } from '..'
@@ -138,8 +137,8 @@ export class CapiResponse {
      * Don't let this failure block this system from continuing to try and handle the request
      */
     if (!schemaResponse.success) {
-      logRecoverableError({
-        logger: context.logger,
+      context.logger.error({
+        event: 'RECOVERABLE_ERROR',
         error: new OperationalError({
           message:
             'The data received from the CAPI data source does not match our data source schema. It is likely that our schema will require updating to handle all possible responses from CAPI.',
@@ -219,8 +218,8 @@ export class CapiResponse {
         return vanityUrl ?? url
       } catch (error) {
         if (isError(error)) {
-          logRecoverableError({
-            logger: this.context.logger,
+          this.context.logger.error({
+            event: 'RECOVERABLE_ERROR',
             error,
           })
         }

package/src/model/Concept.test.ts

@@ -4,6 +4,7 @@ import type { QueryContext } from '..'
 import { capiPerson } from '../fixtures/capiPerson'
 import { URLManagementDataSource } from '../datasources/url-management'
 import { CapiDataSource } from '../datasources/capi'
+import { Logger } from '@dotcom-reliability-kit/logger'
 
 const vanityMock = jest.fn<URLManagementDataSource['get']>()
 const getPersonMock = jest.fn<CapiDataSource['getPerson']>()
@@ -14,6 +15,7 @@ const context = {
     vanityUrls: { get: vanityMock },
   },
   systemCode: 'image-test',
+  logger: new Logger(),
 } as unknown as QueryContext
 
 const topic = {

package/src/model/Concept.ts

@@ -3,7 +3,6 @@ import type { QueryContext } from '..'
 import { uuidFromUrl } from '../helpers/metadata'
 import imageServiceUrl from '../helpers/imageService'
 import isError from '../helpers/isError'
-import { logRecoverableError } from '@dotcom-reliability-kit/log-error'
 import conceptIds from '@financial-times/n-concept-ids'
 import decorateHeadshotUrl, { UUID_REGEX } from '../helpers/decorateHeadshotUrl'
 
@@ -151,8 +150,8 @@ export class Concept {
         }
       } catch (error) {
         if (isError(error)) {
-          logRecoverableError({
-            logger: this.context.logger,
+          this.context.logger.error({
+            event: 'RECOVERABLE_ERROR',
             error,
           })
         }
@@ -184,8 +183,8 @@ export class Concept {
         : null
     } catch (error) {
       if (isError(error)) {
-        logRecoverableError({
-          logger: this.context.logger,
+        this.context.logger.error({
+          event: 'RECOVERABLE_ERROR',
           error,
         })
       }

package/src/model/Image.ts

@@ -6,7 +6,6 @@ import type {
   LeadImage,
 } from '../types/internal-content'
 import type { QueryContext } from '..'
-import { logRecoverableError } from '@dotcom-reliability-kit/log-error/lib'
 import {
   LiteralUnionScalarValues,
   validLiteralUnionValue,
@@ -60,7 +59,8 @@ export class CAPIImage implements Image {
     }
 
     // we shouldn't be here. but just in case,
-    logRecoverableError({
+    this.context.logger.error({
+      event: 'RECOVERABLE_ERROR',
       error: new BaseError({
         code: 'INVALID_IMAGE_TYPE',
         type: this.capiImage['type'], // capiImage is `never` here because we've exhausted all the "possible" types in the switch
@@ -169,9 +169,9 @@ export class CAPIImage implements Image {
       return imageMetadata
     } catch (error) {
       if (isError(error)) {
-        logRecoverableError({
+        this.context.logger.error({
+          event: 'RECOVERABLE_ERROR',
           error,
-          logger: this.context.logger,
         })
       }
       return null

package/src/resolvers/content-tree/bodyXMLToTree.test.ts

@@ -1,18 +1,20 @@
-jest.mock('@dotcom-reliability-kit/log-error', () => ({
-  logRecoverableError: jest.fn(),
-}))
-
 import { ContentTree } from '@financial-times/content-tree'
 import bodyXMLToTree, { TagMappings } from './bodyXMLToTree'
 import tags from './tagMappings'
+import { Logger } from '@dotcom-reliability-kit/logger'
+import { QueryContext } from '../..'
+
+const mockLogger = new Logger()
+const mockLogError = jest.spyOn(mockLogger, 'error')
 
-import * as logError from '@dotcom-reliability-kit/log-error'
-const logRecoverableErrorMock = logError.logRecoverableError as jest.Mock
+const mockContext = {
+  logger: mockLogger,
+} as QueryContext
 
 describe('bodyXMLToTree', () => {
   it('converts XML to tree', () => {
     const xml = `<body><p>Hello world</p></body>`
-    expect(bodyXMLToTree(xml, tags)).toMatchInlineSnapshot(`
+    expect(bodyXMLToTree(xml, tags, mockContext)).toMatchInlineSnapshot(`
       Object {
         "children": Array [
           Object {
@@ -218,14 +220,14 @@ describe('bodyXMLToTree', () => {
           "version": 1,
         }
       `)
-      expect(logRecoverableErrorMock).not.toBeCalled()
+      expect(mockLogError).not.toBeCalled()
     })
 
     it('should handle heading and slots', () => {
       const xml =
         '<body><div class="n-content-layout"><h3></h3><div class="n-content-layout__slot"></div><div class="n-content-layout__slot"></div></body>'
 
-      expect(bodyXMLToTree(xml, tags)).toMatchInlineSnapshot(`
+      expect(bodyXMLToTree(xml, tags, mockContext)).toMatchInlineSnapshot(`
         Object {
           "children": Array [
             Object {
@@ -253,14 +255,14 @@ describe('bodyXMLToTree', () => {
           "version": 1,
         }
       `)
-      expect(logRecoverableErrorMock).not.toBeCalled()
+      expect(mockLogError).not.toBeCalled()
     })
 
     it('should log an error on unexpected child after heading', () => {
       const xml =
         '<body><div class="n-content-layout"><h3></h3><div class="n-content-layout__slot"></div><p></p></body>'
 
-      expect(bodyXMLToTree(xml, tags)).toMatchInlineSnapshot(`
+      expect(bodyXMLToTree(xml, tags, mockContext)).toMatchInlineSnapshot(`
         Object {
           "children": Array [
             Object {
@@ -288,12 +290,12 @@ describe('bodyXMLToTree', () => {
           "version": 1,
         }
       `)
-      expect(logRecoverableErrorMock).toBeCalled()
-      expect(logRecoverableErrorMock.mock.lastCall).toMatchInlineSnapshot(`
+      expect(mockLogError).toBeCalled()
+      expect(mockLogError.mock.lastCall).toMatchInlineSnapshot(`
         Array [
           Object {
             "error": [OperationalError: Unexpected children types for layout],
-            "logger": undefined,
+            "event": "RECOVERABLE_ERROR",
           },
         ]
       `)
@@ -303,7 +305,7 @@ describe('bodyXMLToTree', () => {
       const xml =
         '<body><div class="n-content-layout"><div class="n-content-layout__slot"></div><p></p></body>'
 
-      expect(bodyXMLToTree(xml, tags)).toMatchInlineSnapshot(`
+      expect(bodyXMLToTree(xml, tags, mockContext)).toMatchInlineSnapshot(`
         Object {
           "children": Array [
             Object {
@@ -326,12 +328,12 @@ describe('bodyXMLToTree', () => {
           "version": 1,
         }
       `)
-      expect(logRecoverableErrorMock).toBeCalled()
-      expect(logRecoverableErrorMock.mock.lastCall).toMatchInlineSnapshot(`
+      expect(mockLogError).toBeCalled()
+      expect(mockLogError.mock.lastCall).toMatchInlineSnapshot(`
         Array [
           Object {
             "error": [OperationalError: Unexpected children types for layout],
-            "logger": undefined,
+            "event": "RECOVERABLE_ERROR",
           },
         ]
       `)
@@ -343,7 +345,7 @@ describe('bodyXMLToTree', () => {
       const xml =
         '<table class="data-table" data-table-collapse-rownum="" data-table-layout-largescreen="auto" data-table-layout-smallscreen="auto" data-table-theme="auto"><caption>Nulla iaculis tempus augue</caption><thead><tr><th data-column-hidden="none" data-column-sortable="false" data-column-type="string">libero mollis</th><th data-column-hidden="none" data-column-sortable="false" data-column-type="string">pretium nunc</th><th data-column-hidden="none" data-column-sortable="false" data-column-type="string">euismod nunc</th></tr></thead><tbody><tr><td>Aenean </td><td>14134</td><td>dfdsfd</td></tr><tr><td>lobortis </td><td>3434</td><td>fdsf dsf </td></tr><tr><td>volutpat </td><td>234234</td><td>sd fsd</td></tr><tr><td>vitae </td><td>2423</td><td>s fsdf</td></tr><tr><td>elementumus</td><td>23423</td><td>f sdf</td></tr></tbody><tfoot><tr><td colspan="1000">Aenean sodales sapien</td></tr></tfoot></table>'
 
-      expect(bodyXMLToTree(xml, tags)).toMatchInlineSnapshot(`
+      expect(bodyXMLToTree(xml, tags, mockContext)).toMatchInlineSnapshot(`
         Object {
           "children": Array [
             Object {
@@ -602,7 +604,7 @@ describe('bodyXMLToTree', () => {
       const xml =
         '<table class="data-table" id="U1140244733565W0C"><caption>Emerging markets outlook for 2017</caption><tbody><tr><td colspan="2"><p>Brazil</p><p>Brazilian shares were the best-performing asset globally over the 12 months to the end of January, returning 121 per cent, according to data from BofA Merrill Lynch. Brazilian stocks did very well through January, but investors including Lazard and Eastspring have scaled back their exposure after strong growth last year.</p></td></tr></tbody></table>'
 
-      expect(bodyXMLToTree(xml, tags)).toMatchInlineSnapshot(`
+      expect(bodyXMLToTree(xml, tags, mockContext)).toMatchInlineSnapshot(`
         Object {
           "children": Array [
             Object {

package/src/resolvers/content-tree/nodePredicates.ts

@@ -1,4 +1,3 @@
-import { logRecoverableError } from '@dotcom-reliability-kit/log-error'
 import { OperationalError } from '@dotcom-reliability-kit/errors'
 import { AnyNode } from './Workarounds'
 import { QueryContext } from '../..'
@@ -30,8 +29,8 @@ export const findChildOftype = <NodeType extends AnyNode>(
   const child = nodes.find(predicate)
 
   if (!child) {
-    logRecoverableError({
-      logger: context?.logger,
+    context?.logger.error({
+      event: 'RECOVERABLE_ERROR',
       error: new OperationalError({
         code: 'BODY_XML_UNEXPECTED_STRUCTURE',
         message: `Didn't find expected child type in ${parentType}`,
@@ -54,8 +53,8 @@ export const everyChildIsType = <NodeType extends AnyNode>(
   const allChildrenAreType = nodes.every(predicate)
 
   if (!allChildrenAreType) {
-    logRecoverableError({
-      logger: context?.logger,
+    context?.logger.error({
+      event: 'RECOVERABLE_ERROR',
       error: new OperationalError({
         code: 'BODY_XML_UNEXPECTED_STRUCTURE',
         message: `Unexpected children types for ${parentType}`,
@@ -79,8 +78,8 @@ export const childrenOfTypes = <Types extends readonly AnyNode['type'][]>(
   const allChildrenAreType = nodes.every(predicate)
 
   if (!allChildrenAreType) {
-    logRecoverableError({
-      logger: context?.logger,
+    context?.logger.error({
+      event: 'RECOVERABLE_ERROR',
       error: new OperationalError({
         code: 'BODY_XML_UNEXPECTED_STRUCTURE',
         message: `Unexpected ordered children types for ${parentType}`,
@@ -118,8 +117,8 @@ export const childrenOfOrderedTypes = <
     return nodes
   }
 
-  logRecoverableError({
-    logger: context?.logger,
+  context?.logger.error({
+    event: 'RECOVERABLE_ERROR',
     error: new OperationalError({
       code: 'BODY_XML_UNEXPECTED_STRUCTURE',
       message: `Unexpected children types for ${parentType}`,

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

@@ -2,7 +2,6 @@ import imageServiceUrl from '../../../helpers/imageService'
 import { FlourishResolvers } from '../../../generated'
 import { QueryContext } from '../../..'
 import isError from '../../../helpers/isError'
-import { logRecoverableError } from '@dotcom-reliability-kit/log-error/lib'
 
 export const Flourish = {
   async fallbackImage(parent, _args, context) {
@@ -61,9 +60,9 @@ const getImageMetadata = async (
     }
   } catch (error) {
     if (isError(error)) {
-      logRecoverableError({
+      context.logger.error({
+        event: 'RECOVERABLE_ERROR',
         error,
-        logger: context.logger,
       })
     }
     return {

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

@@ -1,6 +1,5 @@
 import { Image, ImageSourceArgs } from '../../../model/Image'
 import type { QueryContext } from '../../..'
-import { logRecoverableError } from '@dotcom-reliability-kit/log-error/lib'
 import imageServiceUrl from '../../../helpers/imageService'
 import { RawImage as RawImageNode } from '../Workarounds'
 import { RawImageResolvers } from '../../../generated'
@@ -47,9 +46,9 @@ class RawImageModel implements Image {
       return imageMetadata
     } catch (error) {
       if (isError(error)) {
-        logRecoverableError({
+        this.context.logger.error({
+          event: 'RECOVERABLE_ERROR',
           error,
-          logger: this.context.logger,
         })
       }
       return null

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

@@ -1,6 +1,5 @@
 import { uuidFromUrl } from '../../../helpers/metadata'
 import { RecommendedResolvers } from '../../../generated'
-import { logRecoverableError } from '@dotcom-reliability-kit/log-error'
 import { OperationalError } from '@dotcom-reliability-kit/errors'
 
 export const Recommended = {
@@ -16,8 +15,8 @@ export const Recommended = {
       return content
     } catch (error) {
       if (error instanceof Error) {
-        logRecoverableError({
-          logger: context.logger,
+        context.logger.error({
+          event: 'RECOVERABLE_ERROR',
           error: new OperationalError({
             code: 'RECOMMENDED_TEASER_ERROR',
             message: `Couldn't load teaser for recommended article ${parent.reference.id}`,

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

@@ -1,4 +1,3 @@
-import { logRecoverableError } from '@dotcom-reliability-kit/log-error'
 import { TweetResolvers } from '../../../generated'
 import isError from '../../../helpers/isError'
 
@@ -11,9 +10,9 @@ export const Tweet = {
       return tweet.html
     } catch (error) {
       if (isError(error)) {
-        logRecoverableError({
+        context.logger.error({
+          event: 'RECOVERABLE_ERROR',
           error,
-          logger: context.logger,
         })
       }
       return null