@financial-times/cp-content-pipeline-schema 2.7.0 → 2.8.0

package/src/generated/index.ts

@@ -1,5 +1,6 @@
 import type { GraphQLResolveInfo, GraphQLScalarType, GraphQLScalarTypeConfig } from 'graphql';
 import type { Concept as ConceptModel } from '../model/Concept';
+import type { Person as PersonModel } from '../model/Person';
 import type { CapiResponse } from '../model/CapiResponse';
 import type { Image as ImageModel } from '../model/Image';
 import type { Clip as ClipModel } from '../model/Clip';
@@ -990,6 +991,7 @@ export type LiveBlogPost = Content & {
   readonly altTitle?: Maybe<AltTitle>;
   /** An array of concepts related to the article, eg. organisations or topics. */
   readonly annotations?: Maybe<ReadonlyArray<Maybe<Concept>>>;
+  readonly authors?: Maybe<ReadonlyArray<Maybe<Person>>>;
   /** An abstract syntax tree of the article content. */
   readonly body?: Maybe<RichText>;
   /** The raw string of the XML as returned from ContentAPI. */
@@ -1108,6 +1110,19 @@ export type OpinionTopper = Topper & TopperWithHeadshot & TopperWithTheme & {
 
 
 export type OpinionTopperHeadshotArgs = {
+  dpr?: InputMaybe<Scalars['Int']['input']>;
+  url?: InputMaybe<Scalars['String']['input']>;
+  width?: InputMaybe<Scalars['Int']['input']>;
+};
+
+export type Person = {
+  readonly headshot?: Maybe<Scalars['String']['output']>;
+  readonly prefLabel?: Maybe<Scalars['String']['output']>;
+  readonly streamPage?: Maybe<Scalars['String']['output']>;
+};
+
+
+export type PersonHeadshotArgs = {
   dpr?: InputMaybe<Scalars['Int']['input']>;
   width?: InputMaybe<Scalars['Int']['input']>;
 };
@@ -1277,6 +1292,7 @@ export type PodcastTopper = Topper & TopperWithBrand & TopperWithHeadshot & Topp
 
 export type PodcastTopperHeadshotArgs = {
   dpr?: InputMaybe<Scalars['Int']['input']>;
+  url?: InputMaybe<Scalars['String']['input']>;
   width?: InputMaybe<Scalars['Int']['input']>;
 };
 
@@ -1454,6 +1470,7 @@ export type TopperWithHeadshot = {
 
 export type TopperWithHeadshotHeadshotArgs = {
   dpr?: InputMaybe<Scalars['Int']['input']>;
+  url?: InputMaybe<Scalars['String']['input']>;
   width?: InputMaybe<Scalars['Int']['input']>;
 };
 
@@ -1697,6 +1714,7 @@ export type ResolversTypes = ResolversObject<{
   Mutation: ResolverTypeWrapper<{}>;
   OpinionTopper: ResolverTypeWrapper<TopperModel>;
   PackageDesign: ResolverTypeWrapper<Scalars['PackageDesign']['output']>;
+  Person: ResolverTypeWrapper<PersonModel>;
   Picture: ResolverTypeWrapper<PictureModel>;
   PictureFullBleed: ResolverTypeWrapper<PictureModel>;
   PictureInline: ResolverTypeWrapper<PictureModel>;
@@ -1783,6 +1801,7 @@ export type ResolversParentTypes = ResolversObject<{
   Mutation: {};
   OpinionTopper: TopperModel;
   PackageDesign: Scalars['PackageDesign']['output'];
+  Person: PersonModel;
   Picture: PictureModel;
   PictureFullBleed: PictureModel;
   PictureInline: PictureModel;
@@ -2341,6 +2360,7 @@ export type LiveBlogPostResolvers<ContextType = QueryContext, ParentType extends
   altStandfirst: Resolver<Maybe<ResolversTypes['AltStandfirst']>, ParentType, ContextType>;
   altTitle: Resolver<Maybe<ResolversTypes['AltTitle']>, ParentType, ContextType>;
   annotations: Resolver<Maybe<ReadonlyArray<Maybe<ResolversTypes['Concept']>>>, ParentType, ContextType>;
+  authors: Resolver<Maybe<ReadonlyArray<Maybe<ResolversTypes['Person']>>>, ParentType, ContextType>;
   body: Resolver<Maybe<ResolversTypes['RichText']>, ParentType, ContextType>;
   bodyXML: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   byline: Resolver<Maybe<ResolversTypes['StructuredContent']>, ParentType, ContextType, Partial<LiveBlogPostBylineArgs>>;
@@ -2409,6 +2429,13 @@ export interface PackageDesignScalarConfig extends GraphQLScalarTypeConfig<Resol
   name: 'PackageDesign';
 }
 
+export type PersonResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['Person'] = ResolversParentTypes['Person']> = ResolversObject<{
+  headshot: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType, Partial<PersonHeadshotArgs>>;
+  prefLabel: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
+  streamPage: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
+  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
+}>;
+
 export type PictureResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['Picture'] = ResolversParentTypes['Picture']> = ResolversObject<{
   __resolveType?: TypeResolveFn<'PictureFullBleed' | 'PictureInline' | 'PictureStandard', ParentType, ContextType>;
   alt: Resolver<ResolversTypes['String'], ParentType, ContextType>;
@@ -2725,6 +2752,7 @@ export type Resolvers<ContextType = QueryContext> = ResolversObject<{
   Mutation: MutationResolvers<ContextType>;
   OpinionTopper: OpinionTopperResolvers<ContextType>;
   PackageDesign: GraphQLScalarType;
+  Person: PersonResolvers<ContextType>;
   Picture: PictureResolvers<ContextType>;
   PictureFullBleed: PictureFullBleedResolvers<ContextType>;
   PictureInline: PictureInlineResolvers<ContextType>;

package/src/model/CapiResponse.ts

@@ -14,6 +14,7 @@ import sortBy from 'lodash.sortby'
 
 import { CAPIImage } from './Image'
 import { Concept } from './Concept'
+import { Person } from './Person'
 import isError from '../helpers/isError'
 import { uuidFromUrl } from '../helpers/metadata'
 import { schemas } from './schemas/capi'
@@ -302,6 +303,12 @@ export class CapiResponse {
     if ('topper' in this.capiData) return this.capiData.topper
     return null
   }
+  authors(): Person[] | null {
+    const authors = this.getAuthors()
+    return authors.length === 0
+      ? null
+      : authors.map((author: Concept) => new Person(author, this, this.context))
+  }
   accessLevel(): LiteralUnionScalarValues<typeof AccessLevel> {
     return this.capiData.accessLevel ?? 'subscribed'
   }

package/src/model/Concept.test.ts

@@ -1,7 +1,6 @@
 import { Concept } from './Concept'
 import { jest } from '@jest/globals'
 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'
@@ -32,19 +31,6 @@ const topic = {
   ],
 }
 
-const author = {
-  apiUrl: 'http://api.ft.com/people/4076f4fd-723b-4ce5-9934-fb29416554fa',
-  directType: 'http://www.ft.com/ontology/person/Person',
-  id: 'http://api.ft.com/things/4076f4fd-723b-4ce5-9934-fb29416554fa',
-  predicate: 'http://www.ft.com/ontology/annotation/hasAuthor',
-  prefLabel: 'Robert Shrimsley',
-  type: 'PERSON',
-  types: [
-    'http://www.ft.com/ontology/core/Thing',
-    'http://www.ft.com/ontology/concept/Concept',
-    'http://www.ft.com/ontology/person/Person',
-  ],
-}
 describe('Concept model', () => {
   beforeEach(() => {
     jest.resetAllMocks()
@@ -88,39 +74,4 @@ describe('Concept model', () => {
       )
     })
   })
-
-  describe('headshot()', () => {
-    it('returns null if the concept is not for an author', async () => {
-      const model = new Concept(topic, context)
-      expect(await model.headshot()).toEqual(null)
-    })
-
-    it('returns the headshot for an author', async () => {
-      getPersonMock.mockResolvedValue(capiPerson)
-      const model = new Concept(author, context)
-      expect(await model.headshot()).toEqual(
-        'https://www.ft.com/__origami/service/image/v2/images/raw/https%3A%2F%2Fd1e00ek4ebabms.cloudfront.net%2Fproduction%2Fuploaded-files%2Ffthead-v1_robert-shrimsley-cc467908-15d6-474d-94d8-171594ceabb9.png?source=image-test&fit=scale-down&quality=highest&width=150&dpr=1'
-      )
-    })
-
-    it('can resize headshot and provide high resolution version', async () => {
-      getPersonMock.mockResolvedValue(capiPerson)
-      const model = new Concept(author, context)
-      expect(await model.headshot({ width: 300, dpr: 2 })).toEqual(
-        'https://www.ft.com/__origami/service/image/v2/images/raw/https%3A%2F%2Fd1e00ek4ebabms.cloudfront.net%2Fproduction%2Fuploaded-files%2Ffthead-v1_robert-shrimsley-cc467908-15d6-474d-94d8-171594ceabb9.png?source=image-test&fit=scale-down&quality=highest&width=300&dpr=2'
-      )
-    })
-
-    it('returns null if there is an error getting the person data', async () => {
-      getPersonMock.mockRejectedValue(new Error('error getting person'))
-      const model = new Concept(author, context)
-      expect(await model.headshot({ width: 300, dpr: 2 })).toEqual(null)
-    })
-
-    it("returns null if the author doesn't have a headshot", async () => {
-      getPersonMock.mockResolvedValue({ ...capiPerson, _imageUrl: undefined })
-      const model = new Concept(author, context)
-      expect(await model.headshot()).toEqual(null)
-    })
-  })
 })

package/src/model/Concept.ts

@@ -1,11 +1,8 @@
 import type { Annotation } from '../types/internal-content'
 import type { QueryContext } from '..'
 import { uuidFromUrl } from '../helpers/metadata'
-import imageServiceUrl from '../helpers/imageService'
 import isError from '../helpers/isError'
 import conceptIds from '@financial-times/n-concept-ids'
-import decorateHeadshotUrl, { UUID_REGEX } from '../helpers/decorateHeadshotUrl'
-import type { TopperWithHeadshotHeadshotArgs } from '../generated'
 
 const CAPI_ID_PREFIX = /^https?:\/\/(?:www|api)\.ft\.com\/things?\//
 const BASE_URL = 'https://www.ft.com/stream/'
@@ -170,32 +167,4 @@ export class Concept {
     }
     return url
   }
-
-  async headshot(args?: TopperWithHeadshotHeadshotArgs) {
-    const uuid = this.apiUrl().match(UUID_REGEX)?.[0]
-
-    if (!this.isAuthor() || !uuid) return null
-
-    try {
-      const person = await this.context.dataSources.capi.getPerson(uuid)
-      const url = decorateHeadshotUrl(person)
-
-      return url
-        ? imageServiceUrl({
-            url,
-            systemCode: this.#systemCode,
-            width: args?.width || 150,
-            dpr: args?.dpr ?? undefined,
-          })
-        : null
-    } catch (error) {
-      if (isError(error)) {
-        this.context.logger.error({
-          event: 'RECOVERABLE_ERROR',
-          error,
-        })
-      }
-      return null
-    }
-  }
 }

package/src/model/Person.test.ts

@@ -0,0 +1,110 @@
+import { Person } from './Person'
+import { jest } from '@jest/globals'
+import type { QueryContext } from '..'
+import { Concept } from './Concept'
+import { CapiResponse } from './CapiResponse'
+import { baseCapiObject } from '../fixtures/capiObject'
+import { capiPerson } from '../fixtures/capiPerson'
+import cloneDeep from 'clone-deep'
+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']>()
+const context = {
+  dataSources: {
+    origami: {},
+    capi: { getPerson: getPersonMock },
+    vanityUrls: { get: vanityMock },
+  },
+  systemCode: 'image-test',
+  logger: new Logger(),
+} as unknown as QueryContext
+
+const topic = {
+  apiUrl: 'http://api.ft.com/things/6b32f2c1-da43-4e19-80b9-8aef4ab640d7',
+  directType: 'http://www.ft.com/ontology/Topic',
+  id: 'http://api.ft.com/things/6b32f2c1-da43-4e19-80b9-8aef4ab640d7',
+  predicate: 'http://www.ft.com/ontology/annotation/about',
+  prefLabel: 'Technology sector',
+  type: 'TOPIC',
+  types: [
+    'http://www.ft.com/ontology/core/Thing',
+    'http://www.ft.com/ontology/concept/Concept',
+    'http://www.ft.com/ontology/Topic',
+  ],
+}
+
+const author = {
+  apiUrl: 'http://api.ft.com/people/4076f4fd-723b-4ce5-9934-fb29416554fa',
+  directType: 'http://www.ft.com/ontology/person/Person',
+  id: 'http://api.ft.com/things/4076f4fd-723b-4ce5-9934-fb29416554fa',
+  predicate: 'http://www.ft.com/ontology/annotation/hasAuthor',
+  prefLabel: 'Robert Shrimsley',
+  type: 'PERSON',
+  types: [
+    'http://www.ft.com/ontology/core/Thing',
+    'http://www.ft.com/ontology/concept/Concept',
+    'http://www.ft.com/ontology/person/Person',
+  ],
+}
+describe('Person model', () => {
+  let clonedBase: typeof baseCapiObject
+  let capiResponse: CapiResponse
+  let topicConcept: Concept
+  let authorConcept: Concept
+
+  beforeEach(() => {
+    jest.resetAllMocks()
+
+    clonedBase = cloneDeep(baseCapiObject)
+    capiResponse = new CapiResponse(clonedBase, context)
+    topicConcept = new Concept(topic, context)
+    authorConcept = new Concept(author, context)
+  })
+
+  describe('headshot()', () => {
+    it('returns null if the concept is not for an author', async () => {
+      const model = new Person(topicConcept, capiResponse, context)
+      expect(await model.headshot()).toEqual(null)
+    })
+
+    it('returns the headshot for an author', async () => {
+      getPersonMock.mockResolvedValue(capiPerson)
+      const model = new Person(authorConcept, capiResponse, context)
+      expect(await model.headshot()).toEqual(
+        'https://www.ft.com/__origami/service/image/v2/images/raw/https%3A%2F%2Fd1e00ek4ebabms.cloudfront.net%2Fproduction%2Fuploaded-files%2Ffthead-v1_robert-shrimsley-cc467908-15d6-474d-94d8-171594ceabb9.png?source=image-test&fit=scale-down&quality=highest&width=150&dpr=1'
+      )
+    })
+
+    it('can resize headshot and provide high resolution version', async () => {
+      getPersonMock.mockResolvedValue(capiPerson)
+      const model = new Person(authorConcept, capiResponse, context)
+      expect(await model.headshot({ width: 300, dpr: 2 })).toEqual(
+        'https://www.ft.com/__origami/service/image/v2/images/raw/https%3A%2F%2Fd1e00ek4ebabms.cloudfront.net%2Fproduction%2Fuploaded-files%2Ffthead-v1_robert-shrimsley-cc467908-15d6-474d-94d8-171594ceabb9.png?source=image-test&fit=scale-down&quality=highest&width=300&dpr=2'
+      )
+    })
+
+    it('returns null if there is an error getting the person data', async () => {
+      getPersonMock.mockRejectedValue(new Error('error getting person'))
+      const model = new Person(authorConcept, capiResponse, context)
+      expect(await model.headshot({ width: 300, dpr: 2 })).toEqual(null)
+    })
+
+    it("returns null if the author doesn't have a headshot", async () => {
+      getPersonMock.mockResolvedValue({ ...capiPerson, _imageUrl: undefined })
+      const model = new Person(authorConcept, capiResponse, context)
+      expect(await model.headshot()).toEqual(null)
+    })
+  })
+
+  describe('streamPage()', () => {
+    it('returns the stream URL', () => {
+      const model = new Person(authorConcept, capiResponse, context)
+      expect(model.streamPage()).toEqual(
+        'https://www.ft.com/stream/4076f4fd-723b-4ce5-9934-fb29416554fa'
+      )
+    })
+  })
+})

package/src/model/Person.ts

@@ -0,0 +1,74 @@
+import type { QueryContext } from '..'
+import { Concept } from './Concept'
+import { CapiResponse } from './CapiResponse'
+import imageServiceUrl from '../helpers/imageService'
+import isError from '../helpers/isError'
+import decorateHeadshotUrl, { UUID_REGEX } from '../helpers/decorateHeadshotUrl'
+
+type HeadshotArguments = {
+  width?: number | null
+  dpr?: number | null
+}
+
+const predicates = {
+  hasAuthor: 'http://www.ft.com/ontology/annotation/hasAuthor',
+} as const
+
+export class Person {
+  #systemCode: string
+
+  constructor(
+    private concept: Concept,
+    private capiResponse: CapiResponse,
+    private context: QueryContext
+  ) {
+    this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
+  }
+
+  prefLabel() {
+    return this.concept.prefLabel()
+  }
+
+  uuid() {
+    return this.concept.uuid()
+  }
+
+  streamPage() {
+    const uuid = this.uuid()
+    return `https://www.ft.com/stream/${uuid}`
+  }
+
+  apiUrl() {
+    return this.concept.apiUrl()
+  }
+
+  isAuthor() {
+    return this.concept.predicate() === predicates.hasAuthor
+  }
+
+  async headshot(args?: HeadshotArguments) {
+    try {
+      const uuid = this.apiUrl().match(UUID_REGEX)?.[0]
+      if (!this.isAuthor() || !uuid || !this.capiResponse) return null
+      const person = await this.context.dataSources.capi.getPerson(uuid)
+      const url = decorateHeadshotUrl(person)
+
+      return url
+        ? imageServiceUrl({
+            url,
+            systemCode: this.#systemCode,
+            width: args?.width || 150,
+            dpr: args?.dpr ?? undefined,
+          })
+        : null
+    } catch (error) {
+      if (isError(error)) {
+        this.context.logger.error({
+          event: 'RECOVERABLE_ERROR',
+          error,
+        })
+      }
+      return null
+    }
+  }
+}

package/src/model/Topper.test.ts

@@ -1,4 +1,5 @@
 import { Topper } from './Topper'
+import { Person } from './Person'
 import { baseCapiObject } from '../fixtures/capiObject'
 import { CapiResponse } from './CapiResponse'
 import { predicates } from './Concept'
@@ -426,3 +427,39 @@ describe('produces the correct metadata tags', () => {
     expect(brandConcept?.prefLabel()).toEqual('Lex')
   })
 })
+
+describe('headshot method', () => {
+  let topper: Topper
+  let capiResponse: CapiResponse
+
+  beforeEach(() => {
+    const clonedBase = cloneDeep(baseCapiObject)
+    capiResponse = new CapiResponse(clonedBase, context)
+    topper = new Topper(capiResponse, context)
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('returns null if the content is not opinion genre', () => {
+    jest.spyOn(capiResponse, 'isPodcast').mockReturnValue(false)
+    jest.spyOn(capiResponse, 'isOpinion').mockReturnValue(false)
+
+    const result = topper.headshot({})
+
+    expect(result).toBeNull()
+  })
+
+  it('attempts to return the author headshot if the content is opinion genre', async () => {
+    jest.spyOn(capiResponse, 'isPodcast').mockReturnValue(false)
+    jest.spyOn(capiResponse, 'isOpinion').mockReturnValue(true)
+    jest.spyOn(capiResponse, 'getAuthors').mockReturnValue([])
+    jest
+      .spyOn(Person.prototype, 'headshot')
+      .mockReturnValue(Promise.resolve(null))
+
+    await topper.headshot({})
+    expect(Person.prototype.headshot).toHaveBeenCalledTimes(1)
+  })
+})

package/src/model/Topper.ts

@@ -1,4 +1,5 @@
 import { CapiResponse } from './CapiResponse'
+import { Person } from './Person'
 import { CAPIImage } from './Image'
 import type { QueryContext } from '..'
 import {
@@ -299,31 +300,25 @@ export class Topper {
     return this.capiResponse.design()
   }
 
-  async headshot(args: TopperWithHeadshotHeadshotArgs) {
-    let headshotUrl: string | undefined
+  imageService(args: TopperWithHeadshotHeadshotArgs) {
+    if (args.url)
+      return imageServiceUrl({
+        url: args.url,
+        systemCode: this.#systemCode,
+        width: args.width ?? undefined,
+        dpr: args.dpr ?? undefined,
+      })
+    return null
+  }
 
+  headshot(args: TopperWithHeadshotHeadshotArgs) {
     if (this.capiResponse.isPodcast()) {
-      headshotUrl = this.capiResponse.mainImage()?.url()
-    }
-
-    if (this.capiResponse.isOpinion()) {
-      const authors = this.capiResponse.getAuthors()
-      const headshotUrls: (string | null)[] = await Promise.all(
-        authors.map(async (author) => author.headshot(args))
-      ).then((res) => res.filter(Boolean))
-
-      headshotUrl = headshotUrls[0] ?? undefined
+      args.url = this.capiResponse.mainImage()?.url()
+      return this.imageService(args)
     }
-
-    if (!headshotUrl) {
-      return null
-    }
-
-    return imageServiceUrl({
-      url: headshotUrl,
-      systemCode: this.#systemCode,
-      width: args.width ?? undefined,
-      dpr: args.dpr ?? undefined,
-    })
+    if (!this.capiResponse.isOpinion()) return null
+    const author = this.capiResponse.getAuthors()[0]
+    const person = new Person(author, this.capiResponse, this.context)
+    return person.headshot(args)
   }
 }

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

@@ -162,6 +162,7 @@ export const CapiPerson = z.object({
   emailAddress: z.string().optional(),
   twitterHandle: z.string().optional(),
   descriptionXML: z.string().optional(),
+  headshot: z.string().optional(),
   _imageUrl: z.string().optional(),
 })
 

package/src/resolvers/content.ts

@@ -80,6 +80,7 @@ const resolvers = {
       }
     },
     isPinned: (parent) => parent.isPinned(),
+    authors: (parent) => parent.authors(),
   },
 
   LiveBlogPackage: {

package/src/resolvers/index.ts

@@ -9,6 +9,7 @@ import { default as richText } from './richText'
 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 { resolvers as references } from './content-tree/references'
 import { Resolvers } from '../generated'
 
@@ -25,6 +26,7 @@ const resolvers = {
   ...scalars,
   ...teaser,
   ...topper,
+  ...person,
 } satisfies Resolvers
 
 export default resolvers

package/src/resolvers/person.ts

@@ -0,0 +1,12 @@
+import { PersonResolvers } from '../generated'
+const resolvers = {
+  Person: {
+    headshot: (parent) => parent.headshot(),
+    prefLabel: (parent) => parent.prefLabel(),
+    streamPage: (parent) => parent.streamPage(),
+  },
+} satisfies {
+  Person: PersonResolvers
+}
+
+export default resolvers