Merge pull request #672 from danactive/fix

Standardize API errors

Author: danactive

package-lock.json

@@ -19,7 +19,7 @@
   },
   "dependencies": {
     "@emotion/react": "^11.14.0",
-    "@emotion/styled": "^11.14.0",
+    "@emotion/styled": "^11.14.1",
     "@hello-pangea/dnd": "^18.0.1",
     "@mui/joy": "^5.0.0-beta.52",
     "camelcase": "^6.3.0",
@@ -42,26 +42,26 @@
   "devDependencies": {
     "@eslint/js": "^9.28.0",
     "@next/eslint-plugin-next": "^15.3.3",
-    "@playwright/test": "^1.53.1",
+    "@playwright/test": "^1.53.2",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.3.0",
     "@types/boom": "^7.3.5",
     "@types/geojson": "^7946.0.16",
     "@types/heic-convert": "^2.1.0",
     "@types/jest": "^30.0.0",
     "@types/mime-types": "^3.0.1",
-    "@types/node": "^22.15.33",
+    "@types/node": "^22.16.0",
     "@types/react": "19.1.8",
     "@types/react-dom": "19.1.6",
     "@types/react-image-gallery": "^1.2.4",
     "@types/xml2js": "^0.4.14",
-    "@typescript-eslint/eslint-plugin": "^8.35.0",
-    "@typescript-eslint/parser": "^8.35.0",
-    "eslint": "^9.29.0",
+    "@typescript-eslint/eslint-plugin": "^8.35.1",
+    "@typescript-eslint/parser": "^8.35.1",
+    "eslint": "^9.30.1",
     "eslint-config-next": "^15.3.4",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jest-dom": "^5.5.0",
-    "eslint-plugin-jsdoc": "^51.2.3",
+    "eslint-plugin-jsdoc": "^51.3.2",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-testing-library": "^7.5.3",
     "jest": "^30.0.3",

package.json

@@ -80,7 +80,7 @@ export default function AdminAlbumClient(
           </Select>
         </Stack>
         {error && <div>{JSON.stringify(error)}</div>}
-        {!error && album ? <Thumbs album={data?.album} setItem={setItem} /> : <div>Select an album</div>}
+        {!error && data && data.album ? <Thumbs album={data.album} setItem={setItem} /> : <div>Select an album</div>}
       </form>
   )
 }

src/components/AdminAlbum/AdminAlbumClient.tsx

@@ -2,6 +2,7 @@ import transformAlbumSchema, { errorSchema, type ErrorOptionalMessage } from '..
 import type { Album, AlbumMeta } from '../types/common'
 import getGalleries from './galleries'
 import getPersons from './persons'
+import { handleLibraryError } from './utils'
 import { readAlbum } from './xml'
 
 type Envelope = { body: Album, status: number }
@@ -53,15 +54,9 @@ async function get(
     }
 
     return body
-  } catch (e) {
+  } catch (err) {
     const message = `No album was found; gallery=${gallery}; album=${album};`
-    if (returnEnvelope) {
-      return { body: errorSchema(message), status: 404 }
-    }
-
-
-    console.error('ERROR', message, e)
-    throw e
+    return handleLibraryError(err, message, returnEnvelope, errorSchema)
   }
 }
 

src/lib/album.ts

@@ -7,7 +7,7 @@ import type {
   XmlGalleryAlbum,
 } from '../types/common'
 import getGalleries from './galleries'
-import utilsFactory, { isValidStringArray } from './utils'
+import utilsFactory, { handleLibraryError, isValidStringArray } from './utils'
 import { readGallery } from './xml'
 
 type ErrorOptionalMessage = { albums: object[]; error?: { message: string } }
@@ -111,15 +111,9 @@ async function get(galleryOrGalleries: AlbumMeta['gallery'] | AlbumMeta['gallery
     }
 
     return fullOut
-  } catch (e) {
+  } catch (err) {
     const message = `No albums was found; gallery=${galleryOrGalleries};`
-    if (returnEnvelope) {
-      return { body: errorSchema(message), status: 404 }
-    }
-
-
-    console.error('ERROR', message, e)
-    throw e
+    return handleLibraryError(err, message, returnEnvelope, errorSchema)
   }
 }
 

src/lib/albums.ts

@@ -1,7 +1,7 @@
 import { glob } from 'glob'
 import path from 'node:path'
 
-import utilsFactory from './utils'
+import utilsFactory, { handleLibraryError } from './utils'
 import transform, { type Filesystem } from '../models/filesystems'
 
 type ResponseBody = {
@@ -70,12 +70,9 @@ async function get(
 
     const body = { files: sortedFiles, destinationPath }
     return (returnEnvelope ? { body, status: 200 } : body)
-  } catch (e) {
-    if (returnEnvelope) {
-      return { body: errorSchema('No files or folders are found'), status: 404 }
-    }
-
-    throw e
+  } catch (err) {
+    const message = 'No files or folders are found'
+    return handleLibraryError(err, message, returnEnvelope, errorSchema)
   }
 }
 

src/lib/filesystems.ts

@@ -2,6 +2,7 @@ import type { Dirent } from 'node:fs'
 import fs from 'node:fs/promises'
 
 import { type Gallery } from '../types/common'
+import { handleLibraryError } from './utils'
 
 type ErrorOptionalMessage = { galleries: object[]; error?: { message: string } }
 const errorSchema = (message?: string) => {
@@ -43,12 +44,9 @@ async function get(returnEnvelope = false): Promise<
     }
 
     return body
-  } catch (e) {
-    if (returnEnvelope) {
-      return { body: errorSchema('No galleries are found'), status: 404 }
-    }
-
-    return errorSchema()
+  } catch (err) {
+    const message = 'No galleries were found'
+    return handleLibraryError(err, message, returnEnvelope, errorSchema)
   }
 }
 

src/lib/galleries.ts

@@ -2,7 +2,7 @@ import convert from 'heic-convert'
 import { readFile, writeFile } from 'node:fs/promises'
 import { basename } from 'node:path'
 import type { Filesystem } from './filesystems'
-import utilsFactory, { isStandardError } from './utils'
+import utilsFactory, { handleLibraryError, isStandardError } from './utils'
 
 type ResponseBody = {
   created: string[];
@@ -86,16 +86,9 @@ async function post(
     }
 
     return body
-  } catch (e) {
-    if (returnEnvelope && isStandardError(e)) {
-      return { body: errorSchema(e.message), status: 400 }
-    }
-
-    if (returnEnvelope) {
-      return { body: errorSchema('Fail to process HEIFs'), status: 400 }
-    }
-
-    throw e
+  } catch (err) {
+    const message = 'No HEIF files were found'
+    return handleLibraryError(err, message, returnEnvelope, errorSchema)
   }
 }
 

src/lib/heifs.ts

@@ -1,5 +1,6 @@
 import transformJsonSchema, { errorSchema, type ErrorOptionalMessage } from '../models/person'
 import type { Gallery, Person } from '../types/common'
+import { handleLibraryError } from './utils'
 import { readPersons } from './xml'
 
 type Envelope = { body: Person[], status: number }
@@ -33,15 +34,9 @@ async function get(
     }
 
     return body
-  } catch (e) {
+  } catch (err) {
     const message = `No person file was found; gallery=${gallery};`
-    if (returnEnvelope) {
-      return { body: errorSchema(message), status: 404 }
-    }
-
-
-    console.error('ERROR', message, e)
-    throw e
+    return handleLibraryError(err, message, returnEnvelope, errorSchema)
   }
 }
 

src/lib/persons.ts

@@ -101,6 +101,18 @@ function simplifyZodMessages(error: z.core.$ZodError) {
   }, '')
 }
 
+function handleLibraryError(err: unknown, message: string, returnEnvelope: boolean, errorSchema: any) {
+  if (returnEnvelope) {
+    if (isStandardError(err)) {
+      return { body: errorSchema(err.message), status: 500 }
+    }
+    return { body: errorSchema(message), status: 404 }
+  }
+
+  console.error('ERROR', message, err)
+  throw err
+}
+
 function isValidStringArray<T extends string = string>(arr: unknown): arr is T[] {
   return (
     Array.isArray(arr) &&
@@ -197,5 +209,5 @@ function utils() {
 }
 
 export default utils
-export { isStandardError, isValidStringArray, isZodError, simplifyZodMessages }
+export { isStandardError, isValidStringArray, isZodError, simplifyZodMessages, handleLibraryError }