@financial-times/cp-content-pipeline-schema 2.13.1 → 2.14.1

package/src/datasources/instrumented.ts

@@ -18,11 +18,14 @@ export class InstrumentedRESTDataSource
   implements BaseDataSource
 {
   startTime?: bigint
-  backendSystemCode: string | undefined
   context: QueryContext
   calls: string[] = []
   errorHandler: FetchErrorHandler
 
+  get backendSystemCode(): string | undefined {
+    return undefined
+  }
+
   constructor({ cache, context }: BaseDataSourceOptions) {
     const wrappedCache = new PrefixingKeyValueCache(
       isContextableCache(cache) ? cache.withContext(context) : cache,
@@ -100,7 +103,7 @@ export class InstrumentedRESTDataSource
     } catch (error) {
       if (error instanceof BaseError) {
         const status =
-          error.code === 'FETCH_ABORT_ERROR'
+          error.code === 'FETCH_TIMEOUT_ERROR'
             ? 408
             : Number(error.data.upstreamStatusCode ?? 0)
         const duration = (process.hrtime.bigint() - startTime) / BigInt(1e6)

package/src/datasources/origami-image.ts

@@ -1,3 +1,4 @@
+import TimeoutError from '../helpers/timeout-error'
 import { InstrumentedRESTDataSource } from './instrumented'
 import { AugmentedRequest, CacheOptions } from '@apollo/datasource-rest'
 
@@ -7,7 +8,9 @@ const REQUEST_TIMEOUT = process.env.ORIGAMI_DATASOURCE_REQUEST_TIMEOUT
 
 export class OrigamiImageDataSource extends InstrumentedRESTDataSource {
   baseURL = 'https://www.ft.com/__origami/service/image/v2/'
-  backendSystemCode = 'origami-image-service-v2'
+  get backendSystemCode() {
+    return 'origami-image-service-v2'
+  }
 
   abortController = new AbortController()
   timeout: ReturnType<typeof setTimeout> | undefined = undefined
@@ -21,7 +24,7 @@ export class OrigamiImageDataSource extends InstrumentedRESTDataSource {
 
     request.signal = this.abortController.signal
     this.timeout = setTimeout(
-      () => this.abortController.abort(),
+      () => this.abortController.abort(new TimeoutError(REQUEST_TIMEOUT)),
       REQUEST_TIMEOUT
     )
   }

package/src/datasources/twitter.ts

@@ -1,5 +1,6 @@
 import { AugmentedRequest, CacheOptions } from '@apollo/datasource-rest'
 import { InstrumentedRESTDataSource } from './instrumented'
+import TimeoutError from '../helpers/timeout-error'
 
 const REQUEST_TIMEOUT = process.env.TWITTER_DATASOURCE_REQUEST_TIMEOUT
   ? parseInt(process.env.TWITTER_DATASOURCE_REQUEST_TIMEOUT)
@@ -7,7 +8,9 @@ const REQUEST_TIMEOUT = process.env.TWITTER_DATASOURCE_REQUEST_TIMEOUT
 
 export class TwitterDataSource extends InstrumentedRESTDataSource {
   baseURL = 'https://publish.twitter.com'
-  backendSystemCode = 'twitter-oembed-api'
+  get backendSystemCode() {
+    return 'twitter-oembed-api'
+  }
 
   abortController = new AbortController()
   timeout: ReturnType<typeof setTimeout> | undefined = undefined
@@ -17,7 +20,7 @@ export class TwitterDataSource extends InstrumentedRESTDataSource {
 
     request.signal = this.abortController.signal
     this.timeout = setTimeout(
-      () => this.abortController.abort(),
+      () => this.abortController.abort(new TimeoutError(REQUEST_TIMEOUT)),
       REQUEST_TIMEOUT
     )
   }

package/src/generated/index.ts

@@ -1520,7 +1520,7 @@ export type TopperWithBrand = {
   readonly genreConcept?: Maybe<Concept>;
 };
 
-export type TopperWithFlourish = Topper & {
+export type TopperWithFlourish = Topper & TopperWithTheme & {
   /** Whether the topper should have a background box. */
   readonly backgroundBox?: Maybe<Scalars['Boolean']['output']>;
   /** The background colour of the topper. */
@@ -1535,6 +1535,8 @@ export type TopperWithFlourish = Topper & {
   readonly headline: Scalars['String']['output'];
   /** An abstract syntax tree of the introduction text. */
   readonly intro?: Maybe<RichText>;
+  /** Whether the headline should be large. */
+  readonly isLargeHeadline?: Maybe<Scalars['Boolean']['output']>;
   /** The layout type of the topper, eg. 'flourish'. */
   readonly layout?: Maybe<Scalars['String']['output']>;
   /** The layout width of the topper, eg. 'full-grid'. */
@@ -1740,7 +1742,7 @@ export type ResolversInterfaceTypes<RefType extends Record<string, unknown>> = R
   TopperWithHeadshot: ( TopperModel ) | ( TopperModel );
   TopperWithImages: ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel );
   TopperWithPackage: ( TopperModel );
-  TopperWithTheme: ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel );
+  TopperWithTheme: ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel );
 }>;
 
 /** Mapping between all available schema types and the resolvers types */
@@ -2775,6 +2777,7 @@ export type TopperWithFlourishResolvers<ContextType = QueryContext, ParentType e
   genreConcept: Resolver<Maybe<ResolversTypes['Concept']>, ParentType, ContextType>;
   headline: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   intro: Resolver<Maybe<ResolversTypes['RichText']>, ParentType, ContextType>;
+  isLargeHeadline: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   layout: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   layoutWidth: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   leadFlourish: Resolver<Maybe<ResolversTypes['LeadFlourish']>, ParentType, ContextType>;
@@ -2799,7 +2802,7 @@ export type TopperWithPackageResolvers<ContextType = QueryContext, ParentType ex
 }>;
 
 export type TopperWithThemeResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['TopperWithTheme'] = ResolversParentTypes['TopperWithTheme']> = ResolversObject<{
-  __resolveType?: TypeResolveFn<'BrandedTopper' | 'DeepLandscapeTopper' | 'DeepPortraitTopper' | 'FullBleedTopper' | 'OpinionTopper' | 'PodcastTopper' | 'SplitTextTopper', ParentType, ContextType>;
+  __resolveType?: TypeResolveFn<'BrandedTopper' | 'DeepLandscapeTopper' | 'DeepPortraitTopper' | 'FullBleedTopper' | 'OpinionTopper' | 'PodcastTopper' | 'SplitTextTopper' | 'TopperWithFlourish', ParentType, ContextType>;
   isLargeHeadline: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   layout: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
 }>;

package/src/helpers/timeout-error.ts

@@ -0,0 +1,13 @@
+import { OperationalError } from '@dotcom-reliability-kit/errors'
+
+export default class TimeoutError extends OperationalError {
+  name = 'TimeoutError'
+  code = 'TIMEOUT_ERROR'
+
+  constructor(timeout: number) {
+    super({
+      message: `Missed the timeout of ${timeout}ms`,
+      timeout,
+    })
+  }
+}

package/src/model/CapiResponse.ts

@@ -7,7 +7,7 @@ import type {
 import conceptIds from '@financial-times/n-concept-ids'
 import metadata from '@financial-times/n-display-metadata'
 import cloneDeep from 'clone-deep'
-import { OperationalError } from '@dotcom-reliability-kit/errors'
+import { BaseError, OperationalError } from '@dotcom-reliability-kit/errors'
 
 import type { QueryContext } from '..'
 import sortBy from 'lodash.sortby'
@@ -127,24 +127,28 @@ function flattenFormattedZodIssues(
 }
 
 function getContentType(
-  content: { type?: string; types: string[] },
+  content: BaselineContent,
   validate?: true
 ): LiteralUnionScalarValues<typeof ContentType>
 function getContentType(
-  content: { type?: string; types: string[] },
+  content: BaselineContent,
   validate: false
 ): LiteralUnionScalarValues<typeof ContentType> | string
-function getContentType(
-  content: { type?: string; types: string[] },
-  validate = true
-) {
+function getContentType(content: BaselineContent, validate = true) {
   const TYPE_REGEX = /https?:\/\/www.ft.com\/ontology\/content\//
   const useType =
     'type' in content && content.type ? content.type : content.types[0]
   const type = useType?.replace(TYPE_REGEX, '')
 
   if (validate && !validLiteralUnionValue(type, ContentType.values)) {
-    throw new Error('Content type is invalid: ' + useType)
+    // if we get a request for a content type we can't (and shouldn't)
+    // handle, such as Image, there's nothing else we can do, so throw
+    throw new BaseError({
+      message: `Content type is invalid: ${useType}`,
+      code: 'UNEXPECTED_CONTENT_TYPE',
+      type: useType,
+      id: content.id,
+    })
   }
 
   return type
@@ -156,6 +160,8 @@ const baselineContentSchema = z.object({
   types: z.array(z.string()),
 })
 
+type BaselineContent = z.infer<typeof baselineContentSchema>
+
 export class CapiResponse {
   constructor(
     private capiData: ContentTypeSchemas,

package/src/model/Topper.ts

@@ -138,7 +138,8 @@ export class Topper {
       type === 'SplitTextTopper' ||
       type === 'FullBleedTopper' ||
       type === 'DeepPortraitTopper' ||
-      type === 'DeepLandscapeTopper'
+      type === 'DeepLandscapeTopper' ||
+      type === 'TopperWithFlourish'
     )
   }
 

package/src/resolvers/core.ts

@@ -17,16 +17,25 @@ const resolvers = {
       try {
         return await context.dataSources.capi.getContent(args.uuid)
       } catch (error) {
-        if (
-          error instanceof BaseError &&
-          error.data.upstreamStatusCode === 404
-        ) {
-          throw new HttpError({
-            code: 'CONTENT_NOT_FOUND',
-            message: `Content ${args.uuid} not found in Content API`,
-            statusCode: 404,
-            relatesToSystems: ['up-ica'],
-          })
+        if (error instanceof BaseError) {
+          if (error.data.upstreamStatusCode === 404) {
+            throw new HttpError({
+              code: 'CONTENT_NOT_FOUND',
+              message: 'Content not found in Content API',
+              cause: error,
+              uuid: args.uuid,
+              statusCode: 404,
+              relatesToSystems: ['up-ica'],
+            })
+          }
+          if (error.code === 'UNEXPECTED_CONTENT_TYPE') {
+            throw new HttpError({
+              code: error.code,
+              cause: error,
+              message: `Requested a content type we don't handle`,
+              statusCode: 404,
+            })
+          }
         }
 
         throw error

package/src/resolvers/topper.ts

@@ -105,6 +105,7 @@ const resolvers = {
 
   TopperWithFlourish: {
     ...topperResolvers,
+    isLargeHeadline: (topper) => topper.isLargeHeadline(),
     layout: (topper) => topper.layout(),
     layoutWidth: (topper) => topper.layoutWidth(),
     leadFlourish: (topper) => topper.leadFlourish(),