remove fsPath before storing file

Author: larbish

src/module/src/runtime/host.dev.ts

@@ -1,7 +1,7 @@
 import { useStudioHost as useStudioHostBase } from './host'
 import type { StudioUser, DatabaseItem, Repository } from 'nuxt-studio/app'
 import { getCollectionByFilePath, generateIdFromFsPath, generateFsPathFromId, getCollectionById } from './utils/collection'
-import { populateDocumentbasedOnCollectionInfo } from './utils/document'
+import { normalizeDocument } from './utils/document'
 import { createStorage } from 'unstorage'
 import httpDriver from 'unstorage/drivers/http'
 import { useRuntimeConfig } from '#imports'
@@ -35,9 +35,9 @@ export function useStudioHost(user: StudioUser, repository: Repository) {
     }
 
     const id = generateIdFromFsPath(fsPath, collectionInfo)
-    const doc = populateDocumentbasedOnCollectionInfo(id, collectionInfo, upsertedDocument)
+    const document = normalizeDocument(id, collectionInfo, upsertedDocument)
 
-    const content = await host.document.generate.contentFromDocument(doc)
+    const content = await host.document.generate.contentFromDocument(document)
 
     await devStorage.setItem(fsPath, content, {
       headers: {

src/module/src/runtime/host.ts

@@ -3,7 +3,7 @@ import { ensure } from './utils/ensure'
 import type { CollectionInfo, CollectionItemBase, CollectionSource, DatabaseAdapter } from '@nuxt/content'
 import type { ContentDatabaseAdapter } from '../types/content'
 import { getCollectionByFilePath, generateIdFromFsPath, generateRecordDeletion, generateRecordInsert, generateFsPathFromId, getCollectionById } from './utils/collection'
-import { populateDocumentbasedOnCollectionInfo, isDocumentMatchingContent, normalizeDocument, generateDocumentFromContent, generateContentFromDocument, areDocumentsEqual, pickReservedKeysFromDocument, removeReservedKeysFromDocument } from './utils/document'
+import { normalizeDocument, isDocumentMatchingContent, generateDocumentFromContent, generateContentFromDocument, areDocumentsEqual, pickReservedKeysFromDocument, removeReservedKeysFromDocument } from './utils/document'
 import { kebabCase } from 'scule'
 import type { StudioHost, StudioUser, DatabaseItem, MediaItem, Repository } from 'nuxt-studio/app'
 import type { RouteLocationNormalized, Router } from 'vue-router'
@@ -194,7 +194,14 @@ export function useStudioHost(user: StudioUser, repository: Repository): StudioH
           const id = generateIdFromFsPath(fsPath, collectionInfo)
           const item = await useContentCollectionQuery(collectionInfo.name).where('id', '=', id).first()
 
-          return item ? normalizeDocument(fsPath, item as DatabaseItem) : undefined
+          if (!item) {
+            return undefined
+          }
+
+          return {
+            ...item,
+            fsPath,
+          }
         },
         list: async (): Promise<DatabaseItem[]> => {
           const collections = Object.values(useContentCollections()).filter(collection => collection.name !== 'info')
@@ -205,7 +212,10 @@ export function useStudioHost(user: StudioUser, repository: Repository): StudioH
               const source = getCollectionSourceById(document.id, collection.source)
               const fsPath = generateFsPathFromId(document.id, source!)
 
-              return normalizeDocument(fsPath, document)
+              return {
+                ...document,
+                fsPath,
+              }
             })
           }))
 
@@ -225,11 +235,14 @@ export function useStudioHost(user: StudioUser, repository: Repository): StudioH
           }
 
           const document = await generateDocumentFromContent(id, content)
-          const collectionDocument = populateDocumentbasedOnCollectionInfo(id, collectionInfo, document!)
+          const normalizedDocument = normalizeDocument(id, collectionInfo, document!)
 
-          await host.document.db.upsert(fsPath, collectionDocument)
+          await host.document.db.upsert(fsPath, normalizedDocument)
 
-          return normalizeDocument(fsPath, collectionDocument!)
+          return {
+            ...normalizedDocument,
+            fsPath,
+          }
         },
         upsert: async (fsPath: string, document: CollectionItemBase) => {
           const collectionInfo = getCollectionByFilePath(fsPath, useContentCollections())
@@ -239,10 +252,10 @@ export function useStudioHost(user: StudioUser, repository: Repository): StudioH
 
           const id = generateIdFromFsPath(fsPath, collectionInfo)
 
-          const doc = populateDocumentbasedOnCollectionInfo(id, collectionInfo, document)
+          const normalizedDocument = normalizeDocument(id, collectionInfo, document)
 
           await useContentDatabaseAdapter(collectionInfo.name).exec(generateRecordDeletion(collectionInfo, id))
-          await useContentDatabaseAdapter(collectionInfo.name).exec(generateRecordInsert(collectionInfo, doc))
+          await useContentDatabaseAdapter(collectionInfo.name).exec(generateRecordInsert(collectionInfo, normalizedDocument))
         },
         delete: async (fsPath: string) => {
           const collection = getCollectionByFilePath(fsPath, useContentCollections())

src/module/src/runtime/utils/document.ts

@@ -20,11 +20,43 @@ const reservedKeys = ['id', 'fsPath', 'stem', 'extension', '__hash__', 'path', '
 /*
 ** Normalization utils
 */
-export function normalizeDocument(fsPath: string, document: DatabaseItem): DatabaseItem {
-  return {
-    ...document,
-    fsPath,
+export function normalizeDocument(id: string, collectionInfo: CollectionInfo, document: CollectionItemBase) {
+  const parsedContent = [
+    pathMetaTransform,
+  ].reduce((acc, fn) => collectionInfo.type === 'page' ? fn(acc as PageCollectionItemBase) : acc, { ...document, id } as PageCollectionItemBase)
+  const result = { id } as DatabaseItem
+  const meta = parsedContent.meta as Record<string, unknown>
+
+  const collectionKeys = getOrderedSchemaKeys(collectionInfo.schema)
+  for (const key of Object.keys(parsedContent)) {
+    if (collectionKeys.includes(key)) {
+      result[key] = parsedContent[key as keyof PageCollectionItemBase]
+    }
+    else {
+      meta[key] = parsedContent[key as keyof PageCollectionItemBase]
+    }
+  }
+
+  // Clean fsPath from meta to avoid storing it in the database
+  if (meta.fsPath) {
+    Reflect.deleteProperty(meta, 'fsPath')
   }
+
+  result.meta = meta
+
+  // Storing `content` into `rawbody` field
+  // TODO: handle rawbody
+  // if (collectionKeys.includes('rawbody')) {
+  //   result.rawbody = result.rawbody ?? file.body
+  // }
+
+  if (collectionKeys.includes('seo')) {
+    const seo = result.seo = (result.seo || {}) as PageCollectionItemBase['seo']
+    seo.title = seo.title || result.title as string
+    seo.description = seo.description || result.description as string
+  }
+
+  return result
 }
 
 export function pickReservedKeysFromDocument(document: DatabaseItem): DatabaseItem {
@@ -183,40 +215,6 @@ export function areDocumentsEqual(document1: Record<string, unknown>, document2:
 /*
 ** Generation utils
 */
-export function populateDocumentbasedOnCollectionInfo(id: string, collectionInfo: CollectionInfo, document: CollectionItemBase) {
-  const parsedContent = [
-    pathMetaTransform,
-  ].reduce((acc, fn) => collectionInfo.type === 'page' ? fn(acc as PageCollectionItemBase) : acc, { ...document, id } as PageCollectionItemBase)
-  const result = { id } as DatabaseItem
-  const meta = parsedContent.meta as Record<string, unknown>
-
-  const collectionKeys = getOrderedSchemaKeys(collectionInfo.schema)
-  for (const key of Object.keys(parsedContent)) {
-    if (collectionKeys.includes(key)) {
-      result[key] = parsedContent[key as keyof PageCollectionItemBase]
-    }
-    else {
-      meta[key] = parsedContent[key as keyof PageCollectionItemBase]
-    }
-  }
-
-  result.meta = meta
-
-  // Storing `content` into `rawbody` field
-  // TODO: handle rawbody
-  // if (collectionKeys.includes('rawbody')) {
-  //   result.rawbody = result.rawbody ?? file.body
-  // }
-
-  if (collectionKeys.includes('seo')) {
-    const seo = result.seo = (result.seo || {}) as PageCollectionItemBase['seo']
-    seo.title = seo.title || result.title as string
-    seo.description = seo.description || result.description as string
-  }
-
-  return result
-}
-
 export async function generateDocumentFromContent(id: string, content: string): Promise<DatabaseItem | null> {
   const [_id, _hash] = id.split('#')
   const extension = getFileExtension(id)