List API does better validation of metadata, sorts invalid docs

Author: ericvicenti

frontend/apps/web/app/routes/api.list.$.tsx

@@ -8,29 +8,52 @@ import {
 import {ListAPIResponse} from '@shm/shared/api-types'
 import {BIG_INT} from '@shm/shared/constants'
 
+const processDocuments = (docs: any[]) => {
+  const invalidDocuments: ListAPIResponse['invalidDocuments'] = []
+  const documents: ListAPIResponse['documents'] = []
+
+  docs.forEach((doc) => {
+    const id = hmId(
+      'd',
+      doc.account,
+      doc.path ? {path: entityQueryPathToHmIdPath(doc.path)} : undefined,
+    )
+    const rawMetadata = doc.metadata?.toJson()
+    const metadataParsed = HMDocumentMetadataSchema.safeParse(rawMetadata)
+
+    if (!metadataParsed.success) {
+      invalidDocuments.push({
+        id,
+        error: metadataParsed.error,
+        metadata: rawMetadata,
+      })
+    } else {
+      documents.push({
+        id,
+        metadata: metadataParsed.data,
+      })
+    }
+  })
+
+  return {invalidDocuments, documents}
+}
+
 export const loader = apiGetter(async (req) => {
   const pathParts = req.pathParts
   const [_api, _list, uid] = pathParts
+
   if (uid) {
     const docs = await queryClient.documents.listDocuments({
       account: uid,
       pageSize: BIG_INT,
     })
-    return {
-      documents: docs.documents.map((doc) => ({
-        id: hmId('d', doc.account, {path: entityQueryPathToHmIdPath(doc.path)}),
-        metadata: HMDocumentMetadataSchema.parse(doc.metadata?.toJson()),
-      })),
-    } satisfies ListAPIResponse
+    const {invalidDocuments, documents} = processDocuments(docs.documents)
+    return {invalidDocuments, documents} satisfies ListAPIResponse
   } else {
     const rootDocs = await queryClient.documents.listRootDocuments({
       pageSize: BIG_INT,
     })
-    return {
-      documents: rootDocs.documents.map((doc) => ({
-        id: hmId('d', doc.account),
-        metadata: HMDocumentMetadataSchema.parse(doc.metadata?.toJson()),
-      })),
-    } satisfies ListAPIResponse
+    const {invalidDocuments, documents} = processDocuments(rootDocs.documents)
+    return {invalidDocuments, documents} satisfies ListAPIResponse
   }
 })

frontend/apps/web/app/routes/hm.$.tsx

@@ -73,6 +73,5 @@ function produceHmId(
 
 export default function HypermediaDocument() {
   const data = unwrap<SiteDocumentPayload>(useLoaderData())
-  console.log('~~~ data', data)
   return <DocumentPage {...data} />
 }

frontend/packages/shared/src/api-types.ts

@@ -1,5 +1,10 @@
-import {HMMetadataPayload} from './hm-types'
+import {HMMetadataPayload, UnpackedHypermediaId} from './hm-types'
 
 export type ListAPIResponse = {
   documents: HMMetadataPayload[]
+  invalidDocuments: {
+    id: UnpackedHypermediaId
+    error: any
+    metadata: any
+  }[]
 }