feat: return FetchError if request fails

coderbyheart · coderbyheart · commit 4745889a1d5d · 2024-06-11T19:06:34.000+02:00
diff --git a/src/api/FetchError.ts b/src/api/FetchError.ts
@@ -0,0 +1,16 @@
+export class FetchError extends Error {
+	public readonly statusCode: number
+	constructor(statusCode: number, message: string) {
+		super(message)
+		this.statusCode = statusCode
+		this.name = 'FetchError'
+	}
+}
+
+export const toFetchError = async (response: Response): Promise<FetchError> =>
+	new FetchError(
+		response.status,
+		parseInt(response.headers.get('content-length') ?? '0', 10) > 0
+			? await response.text()
+			: 'No content returned from server',
+	)
diff --git a/src/api/bulkOps.ts b/src/api/bulkOps.ts
@@ -1,5 +1,6 @@
 import { Type, type Static } from '@sinclair/typebox'
 import { type ValidationError, validatedFetch } from './validatedFetch.js'
+import type { FetchError } from './FetchError.js'
 
 /**
  * @link https://api.nrfcloud.com/v1/#tag/Bulk-Ops-Requests/operation/FetchBulkOpsRequest
@@ -28,7 +29,7 @@ export const bulkOpsRequests =
 	async (
 		bulkOpsId: string,
 	): Promise<
-		| { error: Error | ValidationError }
+		| { error: FetchError | ValidationError }
 		| { result: Static<typeof BulkOpsRequestType> }
 	> => {
 		const vf = validatedFetch({ endpoint, apiKey }, fetchImplementation)
diff --git a/src/api/createFOTAJob.ts b/src/api/createFOTAJob.ts
@@ -1,6 +1,7 @@
 import { Type, type Static } from '@sinclair/typebox'
+import type { ValidationError } from './validatedFetch.js'
 import { JSONPayload, validatedFetch } from './validatedFetch.js'
-import type { ValidationError } from 'ajv'
+import type { FetchError } from './FetchError.js'
 
 export const CreatedFOTAJobType = Type.Object(
 	{
@@ -35,7 +36,7 @@ export const createFOTAJob =
 		deviceId: string
 		bundleId: string
 	}): Promise<
-		| { error: Error | ValidationError }
+		| { error: FetchError | ValidationError }
 		| { result: Static<typeof CreatedFOTAJobType> }
 	> => {
 		const maybeJob = await validatedFetch(
diff --git a/src/api/devices.ts b/src/api/devices.ts
@@ -2,6 +2,8 @@ import { Type, type TSchema, type Static } from '@sinclair/typebox'
 import { slashless } from './slashless.js'
 import { type ValidationError, validatedFetch } from './validatedFetch.js'
 import { DeviceShadow } from './DeviceShadow.js'
+import type { FetchError } from './FetchError.js'
+import { toFetchError } from './FetchError.js'
 
 const Page = <T extends TSchema>(Item: T) =>
 	Type.Object({
@@ -40,20 +42,21 @@ export const devices = (
 	fetchImplementation?: typeof fetch,
 ): {
 	list: () => Promise<
-		{ error: Error | ValidationError } | { result: Static<typeof Devices> }
+		{ error: FetchError | ValidationError } | { result: Static<typeof Devices> }
 	>
 	get: (
 		id: string,
 	) => Promise<
-		{ error: Error | ValidationError } | { result: Static<typeof DeviceShadow> }
+		| { error: FetchError | ValidationError }
+		| { result: Static<typeof DeviceShadow> }
 	>
 	updateState: (
 		id: string,
 		state: {
 			desired?: Record<string, any>
 			reported?: Record<string, any>
 		},
-	) => Promise<{ error: Error } | { success: boolean }>
+	) => Promise<{ error: FetchError | ValidationError } | { success: boolean }>
 	register: (
 		devices: {
 			// A globally unique device id (UUIDs are highly recommended)	/^[a-z0-9:_-]{1,128}$/i
@@ -73,7 +76,9 @@ export const devices = (
 			 */
 			fwTypes?: FwType[]
 		}[],
-	) => Promise<{ error: Error } | { bulkOpsRequestId: string }>
+	) => Promise<
+		{ error: FetchError | ValidationError } | { bulkOpsRequestId: string }
+	>
 } => {
 	const headers = {
 		Authorization: `Bearer ${apiKey}`,
@@ -105,9 +110,8 @@ export const devices = (
 					method: 'PATCH',
 					body: JSON.stringify(state),
 				},
-			).then((res) => {
-				if (res.status >= 400)
-					return { error: new Error(`Update failed: ${res.status}`) }
+			).then(async (res) => {
+				if (res.status >= 400) return { error: await toFetchError(res) }
 				return { success: true }
 			}),
 		register: async (devices) => {
@@ -138,11 +142,7 @@ export const devices = (
 				ProvisionDevice,
 			)
 
-			if ('error' in maybeResult) {
-				return {
-					error: maybeResult.error,
-				}
-			}
+			if ('error' in maybeResult) return maybeResult
 
 			return { bulkOpsRequestId: maybeResult.result.bulkOpsRequestId }
 		},
diff --git a/src/api/getAccountInfo.ts b/src/api/getAccountInfo.ts
@@ -1,6 +1,7 @@
 import { Type, type Static } from '@sinclair/typebox'
+import type { ValidationError } from './validatedFetch.js'
 import { validatedFetch } from './validatedFetch.js'
-import type { ValidationError } from 'ajv'
+import type { FetchError } from './FetchError.js'
 
 const AccountInfoType = Type.Object({
 	mqttEndpoint: Type.String(), // e.g. 'mqtt.nrfcloud.com'
@@ -21,7 +22,9 @@ export const getAccountInfo = async (
 		endpoint: URL
 	},
 	fetchImplementation?: typeof fetch,
-): Promise<{ error: Error | ValidationError } | { result: AccountInfo }> => {
+): Promise<
+	{ error: FetchError | ValidationError } | { result: AccountInfo }
+> => {
 	const maybeAccount = await validatedFetch(
 		{
 			endpoint,
diff --git a/src/api/getCurrentMonthlyCosts.ts b/src/api/getCurrentMonthlyCosts.ts
@@ -1,6 +1,7 @@
-import type { ValidationError } from 'ajv'
+import type { ValidationError } from './validatedFetch.js'
 import { validatedFetch } from './validatedFetch.js'
 import { Type } from '@sinclair/typebox'
+import type { FetchError } from './FetchError.js'
 
 export const getCurrentMonthlyCosts =
 	(
@@ -15,7 +16,7 @@ export const getCurrentMonthlyCosts =
 	) =>
 	async (): Promise<
 		| {
-				error: Error | ValidationError
+				error: FetchError | ValidationError
 		  }
 		| { currentMonthTotalCost: number }
 	> => {
diff --git a/src/api/getDeviceShadow.ts b/src/api/getDeviceShadow.ts
@@ -1,7 +1,8 @@
 import { Type, type Static } from '@sinclair/typebox'
+import type { ValidationError } from './validatedFetch.js'
 import { validatedFetch } from './validatedFetch.js'
 import { DeviceShadow } from './DeviceShadow.js'
-import type { ValidationError } from 'ajv'
+import type { FetchError } from './FetchError.js'
 
 const DeviceShadows = Type.Array(DeviceShadow)
 
@@ -26,7 +27,8 @@ export const getDeviceShadow = (
 ): ((
 	devices: string[],
 ) => Promise<
-	{ shadows: Static<typeof DeviceShadows> } | { error: Error | ValidationError }
+	| { shadows: Static<typeof DeviceShadows> }
+	| { error: FetchError | ValidationError }
 >) => {
 	const vf = validatedFetch({ endpoint, apiKey }, fetchImplementation)
 
diff --git a/src/api/getFOTABundles.ts b/src/api/getFOTABundles.ts
@@ -1,7 +1,8 @@
 import { Type, type Static } from '@sinclair/typebox'
-import type { ValidationError } from 'ajv'
+import type { ValidationError } from './validatedFetch.js'
 import { validatedFetch } from './validatedFetch.js'
 import { FwType } from './devices.js'
+import type { FetchError } from './FetchError.js'
 
 export const FOTABundle = Type.Object({
 	bundleId: Type.String({
@@ -83,7 +84,7 @@ export const getFOTABundles =
 		fetchImplementation?: typeof fetch,
 	) =>
 	async (): Promise<
-		| { error: Error | ValidationError }
+		| { error: FetchError | ValidationError }
 		| { bundles: Array<Static<typeof FOTABundle>> }
 	> => {
 		const vf = validatedFetch(
@@ -101,7 +102,7 @@ const paginateFirmwares = async (
 	bundles: Array<Static<typeof FOTABundle>> = [],
 	pageNextToken: string | undefined = undefined,
 ): Promise<
-	| { error: Error | ValidationError }
+	| { error: FetchError | ValidationError }
 	| { bundles: Array<Static<typeof FOTABundle>> }
 > => {
 	const query = new URLSearchParams({ pageLimit: '100' })
diff --git a/src/api/getFOTAJob.ts b/src/api/getFOTAJob.ts
@@ -1,7 +1,9 @@
 import { Type, type Static } from '@sinclair/typebox'
-import type { ValidationError } from 'ajv'
+
+import type { ValidationError } from './validatedFetch.js'
 import { validatedFetch } from './validatedFetch.js'
 import { FwType } from './devices.js'
+import type { FetchError } from './FetchError.js'
 
 export enum FOTAJobStatus {
 	CREATED = 'CREATED',
@@ -101,7 +103,8 @@ export const getFOTAJob =
 	}: {
 		jobId: string
 	}): Promise<
-		{ error: Error | ValidationError } | { result: Static<typeof FOTAJobType> }
+		| { error: FetchError | ValidationError }
+		| { result: Static<typeof FOTAJobType> }
 	> => {
 		const maybeJob = await validatedFetch(
 			{
diff --git a/src/api/getLocationHistory.ts b/src/api/getLocationHistory.ts
@@ -1,6 +1,7 @@
 import { Type, type Static } from '@sinclair/typebox'
+import type { ValidationError } from './validatedFetch.js'
 import { validatedFetch } from './validatedFetch.js'
-import type { ValidationError } from 'ajv'
+import type { FetchError } from './FetchError.js'
 
 export enum LocationHistoryServiceType {
 	ANCHOR = 'ANCHOR',
@@ -118,7 +119,7 @@ export const getLocationHistory =
 		start?: Date
 		end?: Date
 	}): Promise<
-		| { error: Error | ValidationError }
+		| { error: FetchError | ValidationError }
 		| { result: Static<typeof LocationHistoryType> }
 	> => {
 		const query = new URLSearchParams({
diff --git a/src/api/groundFix.ts b/src/api/groundFix.ts
@@ -4,6 +4,7 @@ import {
 	type ValidationError,
 	validatedFetch,
 } from './validatedFetch.js'
+import type { FetchError } from './FetchError.js'
 
 export const lat = Type.Number({
 	minimum: -90,
@@ -48,7 +49,7 @@ export const groundFix =
 		tac: number
 		rsrp?: number
 	}): Promise<
-		| { error: Error | ValidationError }
+		| { error: FetchError | ValidationError }
 		| { result: Static<typeof GroundFixType> }
 	> => {
 		const vf = validatedFetch({ endpoint, apiKey }, fetchImplementation)
diff --git a/src/api/index.ts b/src/api/index.ts
@@ -14,3 +14,4 @@ export * from './bulkOps.js'
 export * from './createFOTAJob.js'
 export * from './getFOTAJob.js'
 export * from './getFOTABundles.js'
+export * from './FetchError.js'
diff --git a/src/api/serviceToken.ts b/src/api/serviceToken.ts
@@ -1,5 +1,6 @@
 import { Type } from '@sinclair/typebox'
 import { type ValidationError, validatedFetch } from './validatedFetch.js'
+import type { FetchError } from './FetchError.js'
 
 /**
  * @link https://api.nrfcloud.com/v1/#tag/Account/operation/GetServiceToken
@@ -18,7 +19,9 @@ export const serviceToken =
 			endpoint: URL
 		},
 		fetchImplementation?: typeof fetch,
-	): (() => Promise<{ error: Error | ValidationError } | { token: string }>) =>
+	): (() => Promise<
+		{ error: FetchError | ValidationError } | { token: string }
+	>) =>
 	async () => {
 		const vf = validatedFetch({ endpoint, apiKey }, fetchImplementation)
 		const maybeResult = await vf(
diff --git a/src/api/validatedFetch.spec.ts b/src/api/validatedFetch.spec.ts
@@ -2,6 +2,7 @@ import { describe, it, mock } from 'node:test'
 import assert from 'node:assert/strict'
 import { Type } from '@sinclair/typebox'
 import { JSONPayload, validatedFetch } from './validatedFetch.js'
+import { FetchError } from './FetchError.js'
 
 void describe('validatedFetch()', () => {
 	void it('should call an nRF Cloud API endpoint and validate the response', async () => {
@@ -122,6 +123,31 @@ void describe('validatedFetch()', () => {
 			},
 		])
 	})
+
+	void it('should return an error if the response is not OK', async () => {
+		const mockFetch = mock.fn(() => ({
+			ok: false,
+			status: 400,
+			text: async () => Promise.resolve('Bad Request'),
+			headers: new Map([[`content-length`, 'Bad Request'.length.toString()]]),
+		}))
+		const vf = validatedFetch(
+			{
+				endpoint: new URL('https://example.com/'),
+				apiKey: 'some-key',
+			},
+			mockFetch as any,
+		)
+
+		const res = await vf({ resource: 'foo' }, Type.Object({}))
+
+		assert.equal('error' in res, true)
+		assert.equal('result' in res, false)
+		assert.deepEqual(
+			'error' in res && res.error,
+			new FetchError(400, 'Bad Request'),
+		)
+	})
 })
 
 void describe('JSONPayload()', () => {
diff --git a/src/api/validatedFetch.ts b/src/api/validatedFetch.ts
@@ -2,6 +2,8 @@ import { type Static, type TObject } from '@sinclair/typebox'
 import { slashless } from './slashless.js'
 import { validateWithTypeBox } from '@hello.nrfcloud.com/proto'
 import type { ValueError } from '@sinclair/typebox/compiler'
+import type { FetchError } from './FetchError.js'
+import { toFetchError } from './FetchError.js'
 
 export class ValidationError extends Error {
 	public errors: ValueError[]
@@ -31,9 +33,7 @@ const fetchData =
 	(fetchImplementation?: typeof fetch) =>
 	async (...args: Parameters<typeof fetch>): ReturnType<typeof fetch> => {
 		const response = await (fetchImplementation ?? fetch)(...args)
-		if (!response.ok)
-			throw new Error(`Error fetching status: ${response.status}`)
-
+		if (!response.ok) throw await toFetchError(response)
 		return response.json()
 	}
 
@@ -58,7 +58,7 @@ export const validatedFetch =
 		) & { query?: URLSearchParams },
 		schema: Schema,
 	): Promise<
-		{ error: Error | ValidationError } | { result: Static<Schema> }
+		{ error: FetchError | ValidationError } | { result: Static<Schema> }
 	> => {
 		const { resource, query } = params
 		const args: Parameters<typeof fetch>[1] = {
@@ -77,7 +77,7 @@ export const validatedFetch =
 			args,
 		)
 			.then((res) => ({ result: validate(schema, res) }))
-			.catch((error: Error): { error: Error | ValidationError } => ({
+			.catch((error: FetchError): { error: FetchError | ValidationError } => ({
 				error,
 			}))
 	}
