SOFIE-295 | make the api error more generic

Author: anteeek

meteor/server/api/rest/v1/index.ts

@@ -117,6 +117,7 @@ interface APIRequestError {
 	status: number
 	message: string
 	details?: string[]
+	additionalInfo?: Record<string, unknown>
 }
 
 function sofieAPIRequest<API, Params, Body, Response>(
@@ -133,6 +134,7 @@ function sofieAPIRequest<API, Params, Body, Response>(
 	) => Promise<ClientAPI.ClientResponse<Response>>
 ) {
 	koaRouter[method](route, async (ctx, next) => {
+		let responseAdditionalInfo: Record<string, unknown> | undefined
 		try {
 			const context = new APIContext()
 			const serverAPI = serverAPIFactory.createServerAPI(context)
@@ -144,6 +146,7 @@ function sofieAPIRequest<API, Params, Body, Response>(
 				ctx.request.body as unknown as Body
 			)
 			if (ClientAPI.isClientResponseError(response)) {
+				responseAdditionalInfo = response.additionalInfo
 				throw UserError.fromSerialized(response.error)
 			}
 			ctx.body = JSON.stringify({ status: response.success, result: response.result })
@@ -176,7 +179,8 @@ function sofieAPIRequest<API, Params, Body, Response>(
 			ctx.type = 'application/json'
 			const bodyObj: APIRequestError = { status: errCode, message: errMsg }
 			const details = extractErrorDetails(e)
-			if (details) bodyObj['details'] = details
+			if (details) bodyObj.details = details
+			if (responseAdditionalInfo) bodyObj.additionalInfo = responseAdditionalInfo
 			ctx.body = JSON.stringify(bodyObj)
 			ctx.status = errCode
 		}

packages/meteor-lib/src/api/__tests__/client.test.ts

@@ -50,7 +50,7 @@ describe('ClientAPI', () => {
 			})
 		}
 	})
-	it('Extracts nextAllowedTakeTime from error args', () => {
+	it('Extracts additionalInfo from error args', () => {
 		const error = ClientAPI.responseError(
 			UserError.create(
 				UserErrorMessage.TakeRateLimit,
@@ -61,12 +61,12 @@ describe('ClientAPI', () => {
 				429
 			)
 		)
-		expect(error.nextAllowedTakeTime).toBe(1234567890)
+		expect(error.additionalInfo).toEqual({ duration: 1000, nextAllowedTakeTime: 1234567890 })
 		expect(error.errorCode).toBe(429)
 	})
-	it('Does not include nextAllowedTakeTime when not in args', () => {
+	it('Does not include additionalInfo when no args', () => {
 		const error = ClientAPI.responseError(UserError.create(UserErrorMessage.InactiveRundown))
-		expect(error.nextAllowedTakeTime).toBeUndefined()
+		expect(error.additionalInfo).toBeUndefined()
 	})
 	describe('isClientResponseSuccess', () => {
 		it('Correctly recognizes a responseSuccess object', () => {

packages/meteor-lib/src/api/client.ts

@@ -50,8 +50,8 @@ export namespace ClientAPI {
 		errorCode: number
 		/** On error, provide a human-readable error message */
 		error: SerializedUserError
-		/** For blocked TAKE operations, the next allowed take time (Unix timestamp ms) */
-		nextAllowedTakeTime?: number
+		/** Optional additional information about the error, forwarded from UserError args */
+		additionalInfo?: Record<string, unknown>
 	}
 
 	/**
@@ -61,11 +61,11 @@ export namespace ClientAPI {
 	 * @returns A `ClientResponseError` object containing the error and the resolved error code.
 	 */
 	export function responseError(userError: UserError): ClientResponseError {
-		const nextAllowedTakeTime = userError.userMessage.args?.nextAllowedTakeTime as number | undefined
+		const args = userError.userMessage.args
 		return {
 			error: UserError.serialize(userError),
 			errorCode: userError.errorCode,
-			...(nextAllowedTakeTime !== undefined && { nextAllowedTakeTime }),
+			...(args !== undefined && Object.keys(args).length > 0 && { additionalInfo: args }),
 		}
 	}
 	export interface ClientResponseSuccess<Result> {

packages/openapi/api/definitions/playlists.yaml

@@ -633,10 +633,10 @@ resources:
                   message:
                     type: string
                     example: Cannot take during a transition
-                  nextAllowedTakeTime:
-                    type: number
-                    description: Unix timestamp (ms) of when the next take will be allowed.
-                    example: 1707024000000
+                  additionalInfo:
+                    type: object
+                    description: Additional error details, e.g. includes nextAllowedTakeTime (Unix timestamp ms) for blocked takes.
+                    additionalProperties: true
         429:
           description: Take rate limit exceeded - takes are happening too quickly.
           content:
@@ -650,10 +650,10 @@ resources:
                   message:
                     type: string
                     example: Ignoring TAKES that are too quick after eachother (1000 ms)
-                  nextAllowedTakeTime:
-                    type: number
-                    description: Unix timestamp (ms) of when the next take will be allowed.
-                    example: 1707024000000
+                  additionalInfo:
+                    type: object
+                    description: Additional error details, e.g. includes nextAllowedTakeTime (Unix timestamp ms) for blocked takes.
+                    additionalProperties: true
         500:
           $ref: '#/components/responses/internalServerError'