refactor: improve collection source management

farnabaz · farnabaz · commit 53a86aeb6d3b · 2024-11-02T22:43:58.000+01:00
diff --git a/src/presets/cloudflare-pages.ts b/src/presets/cloudflare-pages.ts
@@ -29,7 +29,7 @@ export default definePreset({
     nitroConfig.publicAssets.push({ dir: join(nitroConfig.buildDir!, 'content', 'raw'), maxAge: 60 })
     nitroConfig.handlers.push({
       route: '/api/content/:collection/database.sql',
-      handler: resolver.resolve('./runtime/presets/cloudflare-pages/database.sql'),
+      handler: resolver.resolve('./runtime/presets/cloudflare-pages/database-handler'),
     })
   },
 
diff --git a/src/presets/node.ts b/src/presets/node.ts
@@ -11,7 +11,7 @@ export default definePreset({
     nitroConfig.alias['#content/dump'] = addTemplate(fullDatabaseCompressedDumpTemplate(manifest)).dst
     nitroConfig.handlers.push({
       route: '/api/content/:collection/database.sql',
-      handler: resolver.resolve('./runtime/presets/node/database.sql'),
+      handler: resolver.resolve('./runtime/presets/node/database-handler'),
     })
   },
 })
diff --git a/src/runtime/presets/cloudflare-pages/database-handler.ts b/src/runtime/presets/cloudflare-pages/database-handler.ts
diff --git a/src/runtime/presets/node/database-handler.ts b/src/runtime/presets/node/database-handler.ts
diff --git a/src/types/collection.ts b/src/types/collection.ts
@@ -17,6 +17,7 @@ export type CollectionSource = {
 }
 
 export interface ResolvedCollectionSource extends CollectionSource {
+  _resolved: true
   prepare?: (nuxt: Nuxt) => Promise<void>
   cwd: string
 }
@@ -37,7 +38,7 @@ export type Collection<T extends ZodRawShape = ZodRawShape> = PageCollection<T>
 
 export interface DefinedCollection<T extends ZodRawShape = ZodRawShape> {
   type: CollectionType
-  source: CollectionSource | string | undefined
+  source: ResolvedCollectionSource | undefined
   schema: ZodObject<T>
   extendedSchema: ZodObject<T>
 }
diff --git a/src/utils/collection.ts b/src/utils/collection.ts
@@ -1,17 +1,12 @@
-import { join } from 'node:path'
 import { pascalCase } from 'scule'
 import type { ZodObject, ZodOptionalDef, ZodRawShape, ZodStringDef, ZodType } from 'zod'
 import type { Collection, ResolvedCollection, CollectionSource, DefinedCollection, ResolvedCollectionSource } from '../types/collection'
+import { defineLocalSource, defineGitHubSource } from './source'
 import { metaSchema, pageSchema } from './schema'
 import type { ZodFieldType } from './zod'
 import { getUnderlyingType, ZodToSqlFieldTypes, z } from './zod'
-import { downloadRepository, parseGitHubUrl } from './git'
 import { logger } from './dev'
 
-interface ResolveOptions {
-  rootDir: string
-}
-
 const JSON_FIELDS_TYPES = ['ZodObject', 'ZodArray', 'ZodRecord', 'ZodIntersection', 'ZodUnion', 'ZodAny']
 
 const getTableName = (name: string) => `content_${name}`
@@ -26,13 +21,13 @@ export function defineCollection<T extends ZodRawShape>(collection: Collection<T
 
   return {
     type: collection.type,
-    source: collection.source,
+    source: resolveSource(collection.source),
     schema: collection.schema || z.object({}),
     extendedSchema: schema,
   }
 }
 
-export function resolveCollection(name: string, collection: DefinedCollection, opts: ResolveOptions): ResolvedCollection | undefined {
+export function resolveCollection(name: string, collection: DefinedCollection): ResolvedCollection | undefined {
   if (/^[a-z_]\w*$/i.test(name) === false) {
     logger.warn([
       `Collection name "${name}" is invalid. Collection names must be valid JavaScript identifiers. This collection will be ignored.`,
@@ -46,7 +41,7 @@ export function resolveCollection(name: string, collection: DefinedCollection, o
     name,
     type: collection.type || 'page',
     pascalName: pascalCase(name),
-    source: resolveSource(collection.source, opts),
+    source: collection.source,
     tableName: getTableName(name),
     tableDefinition: generateCollectionTableDefinition(name, collection, { drop: true }),
     generatedFields: {
@@ -62,7 +57,7 @@ export function resolveCollection(name: string, collection: DefinedCollection, o
   }
 }
 
-export function resolveCollections(collections: Record<string, DefinedCollection>, opts: ResolveOptions): ResolvedCollection[] {
+export function resolveCollections(collections: Record<string, DefinedCollection>): ResolvedCollection[] {
   collections._info = defineCollection({
     type: 'data',
     schema: z.object({
@@ -71,39 +66,31 @@ export function resolveCollections(collections: Record<string, DefinedCollection
   })
 
   return Object.entries(collections)
-    .map(([name, collection]) => resolveCollection(name, collection, opts))
+    .map(([name, collection]) => resolveCollection(name, collection))
     .filter(Boolean) as ResolvedCollection[]
 }
 
 /**
  * Process collection source and return refined source
  */
-function resolveSource(source: string | CollectionSource | undefined, opts: ResolveOptions): ResolvedCollectionSource | undefined {
+function resolveSource(source: string | CollectionSource | undefined): ResolvedCollectionSource | undefined {
   if (!source) {
     return undefined
   }
 
-  const result: ResolvedCollectionSource = {
-    cwd: '',
-    ...(typeof source === 'string' ? { path: source } : source),
+  if (typeof source === 'string') {
+    return defineLocalSource({ path: source })
   }
 
-  const repository = result?.repository && parseGitHubUrl(result.repository!)
-  if (repository) {
-    const { org, repo, branch } = repository
-    result.cwd = join(opts.rootDir, '.data', 'content', `github-${org}-${repo}-${branch}`)
-
-    result.prepare = async () => {
-      await downloadRepository(
-        `https://github.com/${org}/${repo}/archive/refs/heads/${branch}.tar.gz`,
-        result.cwd!,
-      )
-    }
+  if ((source as ResolvedCollectionSource)._resolved) {
+    return source as ResolvedCollectionSource
   }
 
-  result.cwd = result.cwd || join(opts.rootDir, 'content')
+  if (source.repository) {
+    return defineGitHubSource(source)
+  }
 
-  return result
+  return defineLocalSource(source)
 }
 
 export function parseSourceBase(source: CollectionSource) {
diff --git a/src/utils/config.ts b/src/utils/config.ts
@@ -14,14 +14,14 @@ const defaultConfig = {
 export async function loadContentConfig(rootDir: string, opts: { defaultFallback?: boolean } = {}) {
   const { config, configFile } = await loadConfig({ name: 'content', cwd: rootDir })
 
-  if (!configFile && opts?.defaultFallback) {
+  if ((!configFile || configFile === 'content.config') && opts.defaultFallback) {
     logger.warn('`content.config.ts` is not found, falling back to default collection. In order to have full control over your collections, create the config file in project root. See: https://content.nuxt.com/getting-started/installation')
     return {
-      collections: resolveCollections(defaultConfig.collections, { rootDir }),
+      collections: resolveCollections(defaultConfig.collections),
     }
   }
 
   return {
-    collections: resolveCollections(config.collections || {}, { rootDir }),
+    collections: resolveCollections(config.collections || {}),
   }
 }
diff --git a/src/utils/source.ts b/src/utils/source.ts
@@ -0,0 +1,36 @@
+import { join } from 'pathe'
+import type { CollectionSource, ResolvedCollectionSource } from '../types/collection'
+import { downloadRepository, parseGitHubUrl } from './git'
+
+export function defineLocalSource(source: CollectionSource): ResolvedCollectionSource {
+  const resolvedSource: ResolvedCollectionSource = {
+    _resolved: true,
+    ...source,
+    cwd: '',
+    prepare: async (nuxt) => {
+      resolvedSource.cwd = source.cwd || join(nuxt.options.rootDir, 'content')
+    },
+  }
+  return resolvedSource
+}
+
+export function defineGitHubSource(source: CollectionSource): ResolvedCollectionSource {
+  const resolvedSource: ResolvedCollectionSource = {
+    _resolved: true,
+    ...source,
+    cwd: '',
+    prepare: async (nuxt) => {
+      const repository = source?.repository && parseGitHubUrl(source.repository!)
+      if (repository) {
+        const { org, repo, branch } = repository
+        resolvedSource.cwd = join(nuxt.options.rootDir, '.data', 'content', `github-${org}-${repo}-${branch}`)
+
+        await downloadRepository(
+          `https://github.com/${org}/${repo}/archive/refs/heads/${branch}.tar.gz`,
+          resolvedSource.cwd!,
+        )
+      }
+    },
+  }
+  return resolvedSource
+}
diff --git a/test/base.test.ts b/test/base.test.ts
@@ -33,6 +33,7 @@ describe('empty', async () => {
     test('Default collection is defined', async () => {
       const rootDir = fileURLToPath(new URL('./fixtures/empty', import.meta.url))
       const config = await loadContentConfig(rootDir, { defaultFallback: true })
+      console.log(config.collections)
 
       // Pages collection + _info collection
       expect(config.collections.length).toBe(2)
diff --git a/test/unit/defineCollection.test.ts b/test/unit/defineCollection.test.ts
@@ -17,7 +17,11 @@ describe('defineCollection', () => {
     })
     expect(collection).toMatchObject({
       type: 'page',
-      source: 'pages/**',
+      source: {
+        _resolved: true,
+        cwd: '',
+        path: 'pages/**',
+      },
     })
 
     expect(collection.schema.shape).not.ownProperty('title')
@@ -81,7 +85,11 @@ describe('defineCollection', () => {
 
     expect(collection).toMatchObject({
       type: 'data',
-      source: 'data/**',
+      source: {
+        _resolved: true,
+        cwd: '',
+        path: 'data/**',
+      },
     })
 
     expect(collection.schema.shape).toHaveProperty('customField')
diff --git a/test/unit/generateCollectionInsert.test.ts b/test/unit/generateCollectionInsert.test.ts
@@ -14,7 +14,7 @@ describe('generateCollectionInsert', () => {
         otherField2: z.boolean().default(true),
         date: z.date().default(new Date('2022-01-01')),
       }),
-    }), { rootDir: '~' })!
+    }))!
     const sql = generateCollectionInsert(collection, {
       _id: 'foo.md',
       stem: 'foo',
@@ -39,7 +39,7 @@ describe('generateCollectionInsert', () => {
         otherField2: z.boolean().default(true),
         date: z.date().default(new Date('2022-01-01')),
       }),
-    }), { rootDir: '~' })!
+    }))!
     const sql = generateCollectionInsert(collection, {
       _id: 'foo.md',
       stem: 'foo',
diff --git a/test/unit/parseContent.csv.test.ts b/test/unit/parseContent.csv.test.ts
@@ -72,7 +72,7 @@ describe('Parser (.csv)', () => {
     schema: z.object({
       body: z.any(),
     }),
-  }), { rootDir: '~' })!
+  }))!
   for (const csv of csvs) {
     test(`${csv.replace(/\n/g, '-')}`, async () => {
       const parsed = await parseContent('content/index.csv', csv, collection)
diff --git a/test/unit/parseContent.json.test.ts b/test/unit/parseContent.json.test.ts
@@ -20,7 +20,7 @@ describe('Parser (json)', () => {
     schema: z.object({
       body: z.any(),
     }),
-  }), { rootDir: '~' })!
+  }))!
   test('key:value', async () => {
     const parsed = await parseContent('content/index.json', json, collection)
 
diff --git a/test/unit/parseContent.md-highlighter.test.ts b/test/unit/parseContent.md-highlighter.test.ts
@@ -28,7 +28,7 @@ describe('Highlighter', () => {
     source: 'content/**',
     schema: z.object({
     }),
-  }), { rootDir: '~' })!
+  }))!
 
   test('themed', async () => {
     const parsed = await parseContent('content/index.md', [
diff --git a/test/unit/parseContent.md.test.ts b/test/unit/parseContent.md.test.ts
@@ -22,7 +22,7 @@ describe('Parser (.md)', () => {
     source: 'content/**',
     schema: z.object({
     }),
-  }), { rootDir: '~' })!
+  }))!
 
   test('Index file', async () => {
     const parsed = await parseContent('content/index.md', '# Index', collection, nuxtMock)
diff --git a/test/unit/parseContent.path-meta.test.ts b/test/unit/parseContent.path-meta.test.ts
@@ -79,7 +79,7 @@ describe('Transformer (path-meta)', () => {
     source: 'content/**',
     schema: z.object({
     }),
-  }), { rootDir: '~' })!
+  }))!
 
   Object.entries(testCases).forEach(([id, expected]) => {
     test(id, async () => {
diff --git a/test/unit/parseContent.yaml.test.ts b/test/unit/parseContent.yaml.test.ts
@@ -11,7 +11,7 @@ describe('Parser (.yml)', () => {
     schema: z.object({
       body: z.any(),
     }),
-  }), { rootDir: '~' })!
+  }))!
   test('key:value', async () => {
     const parsed = await parseContent('content/index.yml', 'key: value', collection)
 
diff --git a/test/unit/resolveCollection.test.ts b/test/unit/resolveCollection.test.ts
@@ -7,7 +7,7 @@ describe('resolveCollection', () => {
       type: 'page',
       source: 'pages/**',
     })
-    const resolvedCollection = resolveCollection('invalid-name', collection, { rootDir: '' })
+    const resolvedCollection = resolveCollection('invalid-name', collection)
     expect(resolvedCollection).toBeUndefined()
   })
 })

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ export type CollectionSource = {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`export interface ResolvedCollectionSource extends CollectionSource {`
	`20`	`+ _resolved: true`
`20`	`21`	`prepare?: (nuxt: Nuxt) => Promise<void>`
`21`	`22`	`cwd: string`
`22`	`23`	`}`
`@@ -37,7 +38,7 @@ export type Collection<T extends ZodRawShape = ZodRawShape> = PageCollection<T>`
`37`	`38`
`38`	`39`	`export interface DefinedCollection<T extends ZodRawShape = ZodRawShape> {`
`39`	`40`	`type: CollectionType`
`40`		`- source: CollectionSource \| string \| undefined`
	`41`	`+ source: ResolvedCollectionSource \| undefined`
`41`	`42`	`schema: ZodObject<T>`
`42`	`43`	`extendedSchema: ZodObject<T>`
`43`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,14 +14,14 @@ const defaultConfig = {`
`14`	`14`	`export async function loadContentConfig(rootDir: string, opts: { defaultFallback?: boolean } = {}) {`
`15`	`15`	`const { config, configFile } = await loadConfig({ name: 'content', cwd: rootDir })`
`16`	`16`
`17`		`- if (!configFile && opts?.defaultFallback) {`
	`17`	`+ if ((!configFile \|\| configFile === 'content.config') && opts.defaultFallback) {`
`18`	`18`	logger.warn('`content.config.ts` is not found, falling back to default collection. In order to have full control over your collections, create the config file in project root. See: https://content.nuxt.com/getting-started/installation')
`19`	`19`	`return {`
`20`		`- collections: resolveCollections(defaultConfig.collections, { rootDir }),`
	`20`	`+ collections: resolveCollections(defaultConfig.collections),`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`return {`
`25`		`- collections: resolveCollections(config.collections \|\| {}, { rootDir }),`
	`25`	`+ collections: resolveCollections(config.collections \|\| {}),`
`26`	`26`	`}`
`27`	`27`	`}`