polen 0.11.0-next.13 → 0.11.0-next.15

package/src/api/schema/input-sources/directory.ts

@@ -0,0 +1,259 @@
+import { InputSource } from '#api/schema/input-source/$'
+import { Catalog } from '#lib/catalog/$'
+import { Change } from '#lib/change/$'
+import { DateOnly } from '#lib/date-only/$'
+import { Grafaid } from '#lib/grafaid'
+import { Revision } from '#lib/revision/$'
+import { Schema } from '#lib/schema/$'
+import { debugPolen } from '#singletons/debug'
+import { PlatformError } from '@effect/platform/Error'
+import { FileSystem } from '@effect/platform/FileSystem'
+import { Arr, Path } from '@wollybeard/kit'
+import { Array, Effect, Order } from 'effect'
+
+// const debug = debugPolen.sub([`schema`, `data-source-schema-directory`])
+const debug = debugPolen.sub(`schema:data-source-schema-directory`)
+
+const defaultPaths = {
+  schemaDirectory: `./schema`,
+}
+
+/**
+ * Configuration for loading schema(s) from a directory.
+ *
+ * Supports two modes:
+ * 1. Multiple versioned schemas with date prefixes (enables changelog feature)
+ * 2. Single schema file named 'schema.graphql' (non-versioned, like file data source)
+ */
+export interface Options {
+  /**
+   * Path to the directory containing schema files.
+   *
+   * Supports two patterns:
+   * 1. Multiple versioned files with ISO date prefixes: `YYYY-MM-DD.graphql`
+   * 2. Single file named: `schema.graphql`
+   *
+   * @default './schema'
+   *
+   * @example
+   * ```ts
+   * // Default location
+   * path: './schema'
+   *
+   * // Custom location
+   * path: './graphql/versions'
+   * ```
+   *
+   * Directory structure examples:
+   * ```
+   * // Versioned schemas (enables changelog)
+   * schema/
+   *   2024-01-15.graphql
+   *   2024-03-20.graphql
+   *   2024-06-10.graphql
+   *
+   * // Single schema (non-versioned)
+   * schema/
+   *   schema.graphql
+   * ```
+   */
+  path?: string
+}
+
+export interface Config {
+  path: string
+}
+
+export const normalizeOptions = (options: Options, projectRoot: string): Config => {
+  const config: Config = {
+    path: options.path
+      ? Path.ensureAbsolute(options.path, projectRoot)
+      : Path.join(projectRoot, defaultPaths.schemaDirectory),
+  }
+
+  return config
+}
+
+export const loader = InputSource.createEffect({
+  name: 'directory',
+  isApplicable: (options: Options, context) =>
+    Effect.gen(function*() {
+      const config = normalizeOptions(options, context.paths.project.rootDir)
+
+      // Check if directory exists
+      const fs = yield* FileSystem
+      const dirStatsResult = yield* Effect.either(fs.stat(config.path))
+      if (dirStatsResult._tag === 'Left') {
+        return false
+      }
+
+      const dirStats = dirStatsResult.right
+      if (dirStats.type !== 'Directory') {
+        return false
+      }
+
+      // Get all files in directory
+      const files = yield* fs.readDirectory(config.path)
+
+      // Check if we have either:
+      // 1. A single schema.graphql file (non-versioned mode)
+      // 2. Any .graphql files with valid date names (versioned mode)
+      const hasSchemaFile = files.some(file => file === 'schema.graphql')
+      const hasVersionedFiles = files.some(file => {
+        if (!file.endsWith('.graphql')) return false
+        const name = Path.basename(file, '.graphql')
+        return /^\d{4}-\d{2}-\d{2}$/.test(name)
+      })
+
+      return hasSchemaFile || hasVersionedFiles
+    }),
+  readIfApplicableOrThrow: (options: Options, context) =>
+    Effect.gen(function*() {
+      const config = normalizeOptions(options, context.paths.project.rootDir)
+
+      debug(`will search`, config)
+
+      // Get FileSystem service
+      const fs = yield* FileSystem
+
+      // Get all files in directory
+      const filesResult = yield* Effect.either(fs.readDirectory(config.path))
+      if (filesResult._tag === 'Left') {
+        debug(`error searching directory:`, filesResult.left)
+        return null
+      }
+
+      const files = filesResult.right
+      const graphqlFiles = files.filter((file: string) => file.endsWith('.graphql'))
+
+      if (!Arr.isntEmpty(graphqlFiles)) {
+        return null
+      }
+
+      const filePaths = graphqlFiles.map(file => Path.join(config.path, file))
+      debug(`did find`, filePaths)
+
+      // Check for single schema.graphql file (non-versioned mode)
+      const singleSchemaPath = filePaths.find(p => Path.basename(p) === 'schema.graphql')
+      if (singleSchemaPath) {
+        // Use today's date for single schema file
+        const today = DateOnly.fromDate(new Date())
+        const revisionInputs = [{
+          date: today,
+          filePath: singleSchemaPath,
+        }]
+        debug(`using single schema.graphql as non-versioned schema`)
+        const schema = yield* read(revisionInputs)
+        return Catalog.Unversioned.make({
+          schema,
+        })
+      }
+
+      // Otherwise, look for versioned files with date prefixes
+      const revisionInputs = Arr.map(filePaths, (filePath) => {
+        const name = Path.basename(filePath, '.graphql')
+        // Validate date format YYYY-MM-DD
+        const dateMatch = name.match(/^\d{4}-\d{2}-\d{2}$/)
+        if (!dateMatch) return null
+        return {
+          date: DateOnly.make(name),
+          filePath,
+        }
+      }).filter((x): x is NonNullable<typeof x> => x !== null)
+
+      if (!Arr.isntEmpty(revisionInputs)) {
+        return null
+      }
+
+      debug(`parsed revision inputs`, revisionInputs)
+
+      // Load and process all revisions
+      const schema = yield* read(revisionInputs)
+
+      return Catalog.Unversioned.make({
+        schema,
+      })
+    }),
+})
+
+const read = (
+  revisionInputs: { date: DateOnly.DateOnly; filePath: string }[],
+): Effect.Effect<Schema.Unversioned.Unversioned, InputSource.InputSourceError | PlatformError, FileSystem> =>
+  Effect.gen(function*() {
+    const revisionInputsLoaded = yield* Effect.all(
+      Arr.map(revisionInputs, (revisionInput) =>
+        Effect.gen(function*() {
+          const fs = yield* FileSystem
+          const content = yield* fs.readFileString(revisionInput.filePath)
+          const ast = yield* Grafaid.Schema.AST.parse(content).pipe(
+            Effect.mapError((error) =>
+              InputSource.InputSourceError(
+                'directory',
+                `Failed to parse schema file ${revisionInput.filePath}: ${error}`,
+                error,
+              )
+            ),
+          )
+          const schema = yield* Grafaid.Schema.fromAST(ast).pipe(
+            Effect.mapError((error) =>
+              InputSource.InputSourceError(
+                'directory',
+                `Failed to build schema from ${revisionInput.filePath}: ${error}`,
+                error,
+              )
+            ),
+          )
+
+          return {
+            ...revisionInput,
+            schema,
+          }
+        })),
+      { concurrency: 'unbounded' },
+    )
+    debug(`read revisions`)
+
+    // Sort by date descending (newest first for consistent catalog structure)
+    const revisionInputsSorted = Array.sort(
+      revisionInputsLoaded,
+      Order.reverse(Order.mapInput(DateOnly.order, (item: typeof revisionInputsLoaded[0]) => item.date)),
+    )
+
+    const revisions = yield* Effect.all(
+      Arr.map(revisionInputsSorted, (item, index) =>
+        Effect.gen(function*() {
+          const current = item
+          const previous = revisionInputsSorted[index - 1]
+
+          const before = previous?.schema ?? Grafaid.Schema.empty
+          const after = current.schema
+
+          const changes = yield* Change.calcChangeset({ before, after }).pipe(
+            Effect.mapError((error) =>
+              InputSource.InputSourceError('directory', `Failed to calculate changeset: ${error}`, error)
+            ),
+          )
+
+          return Revision.make({
+            date: current.date,
+            changes,
+          })
+        })),
+      { concurrency: 1 }, // Keep sequential for correct changeset calculation
+    )
+
+    // Get the latest schema (first in the array after sorting newest first)
+    const latestSchemaData = revisionInputsSorted[0]?.schema
+    if (!latestSchemaData) {
+      return yield* Effect.fail(InputSource.InputSourceError('directory', 'No schema files found'))
+    }
+
+    // Create unversioned schema with full revisions
+    const schema = Schema.Unversioned.make({
+      revisions: revisions, // Already sorted newest first
+      definition: latestSchemaData, // GraphQLSchema object
+    })
+
+    debug(`computed revisions`)
+    return schema
+  })

package/src/api/schema/input-sources/file.ts

@@ -0,0 +1,113 @@
+import { InputSource } from '#api/schema/input-source/$'
+import { Catalog } from '#lib/catalog/$'
+import { Change } from '#lib/change/$'
+import { DateOnly } from '#lib/date-only/$'
+import { Grafaid } from '#lib/grafaid'
+import { Revision } from '#lib/revision/$'
+import { Schema } from '#lib/schema/$'
+import { PlatformError } from '@effect/platform/Error'
+import { FileSystem } from '@effect/platform/FileSystem'
+import { Path } from '@wollybeard/kit'
+import { Effect } from 'effect'
+
+const defaultPaths = {
+  schemaFile: `./schema.graphql`,
+}
+
+/**
+ * Configuration for loading schema from a single SDL file.
+ */
+export interface Options {
+  /**
+   * Path to the GraphQL SDL file.
+   *
+   * Can be absolute or relative to the project root.
+   *
+   * @default './schema.graphql'
+   *
+   * @example
+   * ```ts
+   * // Default location
+   * path: './schema.graphql'
+   *
+   * // Custom location
+   * path: './src/graphql/schema.sdl'
+   * ```
+   */
+  path?: string
+}
+
+export interface Config {
+  path: string
+}
+
+export const normalizeConfig = (options: Options, projectRoot: string): Config => {
+  const config: Config = {
+    path: options.path
+      ? Path.ensureAbsolute(options.path, projectRoot)
+      : Path.join(projectRoot, defaultPaths.schemaFile),
+  }
+
+  return config
+}
+
+export const loader = InputSource.createEffect({
+  name: 'file',
+  isApplicable: (options: Options, context) =>
+    Effect.gen(function*() {
+      const config = normalizeConfig(options, context.paths.project.rootDir)
+
+      // Check if file exists and is a .graphql file
+      const fs = yield* FileSystem
+      const result = yield* Effect.either(fs.stat(config.path))
+      if (result._tag === 'Left') {
+        return false
+      }
+
+      const stats = result.right
+      return stats.type === 'File' && config.path.endsWith('.graphql')
+    }),
+  readIfApplicableOrThrow: (options: Options, context) =>
+    Effect.gen(function*() {
+      const config = normalizeConfig(options, context.paths.project.rootDir)
+
+      const fs = yield* FileSystem
+      const content = yield* fs.readFileString(config.path)
+
+      const ast = yield* Grafaid.Schema.AST.parse(content).pipe(
+        Effect.mapError((error) =>
+          InputSource.InputSourceError('file', `Failed to parse schema file: ${error}`, error)
+        ),
+      )
+      const after = yield* Grafaid.Schema.fromAST(ast).pipe(
+        Effect.mapError((error) => InputSource.InputSourceError('file', `Failed to build schema: ${error}`, error)),
+      )
+
+      const date = new Date()
+      const before = Grafaid.Schema.empty
+      const changes = yield* Change.calcChangeset({ before, after }).pipe(
+        Effect.mapError((error) =>
+          InputSource.InputSourceError('file', `Failed to calculate changeset: ${error}`, error)
+        ),
+      )
+
+      // Create the date string for revision
+      const dateString = date.toISOString().split('T')[0]!
+
+      const revision = Revision.make({
+        date: DateOnly.make(dateString),
+        changes,
+      })
+
+      // Create the unversioned schema with full revision
+      const schema = Schema.Unversioned.make({
+        revisions: [revision],
+        definition: after, // GraphQLSchema object
+      })
+
+      // Return the unversioned catalog
+      return Catalog.Unversioned.make({
+        schema,
+      })
+    }),
+})

package/src/api/schema/input-sources/introspection-file.ts

@@ -0,0 +1,179 @@
+import { InputSource } from '#api/schema/input-source/$'
+import { Catalog } from '#lib/catalog/$'
+import { Change } from '#lib/change/$'
+import { DateOnly } from '#lib/date-only/$'
+import { Grafaid } from '#lib/grafaid'
+import { Revision } from '#lib/revision/$'
+import { Schema } from '#lib/schema/$'
+import { FileSystem } from '@effect/platform/FileSystem'
+import { Fs, Json, Path } from '@wollybeard/kit'
+import { Effect } from 'effect'
+
+/**
+ * Configuration for loading schema from an existing introspection file.
+ *
+ * This source reads a pre-existing `schema.introspection.json` file from your
+ * project root. The file should contain a standard GraphQL introspection query
+ * result as defined in the GraphQL specification.
+ *
+ * This is useful when:
+ * - You have an introspection file generated by other tools (GraphQL Codegen, Apollo CLI, etc.)
+ * - You want to commit the introspection file to version control
+ * - You prefer to manage the introspection process separately
+ *
+ * The file must be in the standard GraphQL introspection format with a
+ * `data.__schema` structure.
+ *
+ * @see https://spec.graphql.org/draft/#sec-Introspection - GraphQL Introspection spec
+ *
+ * @example
+ * ```ts
+ * // Uses default path: ./schema.introspection.json
+ * introspectionFile: {}
+ *
+ * // Custom path
+ * introspectionFile: {
+ *   path: './graphql/introspection.json'
+ * }
+ * ```
+ */
+export interface Options {
+  /**
+   * Path to the introspection file.
+   *
+   * @default './schema.introspection.json'
+   */
+  path?: string
+}
+
+export interface Config {
+  path: string
+}
+
+export const normalizeOptions = (options: Options, projectRoot: string): Config => {
+  const config: Config = {
+    path: options.path
+      ? Path.ensureAbsolute(options.path, projectRoot)
+      : Path.join(projectRoot, INTROSPECTION_FILE_NAME),
+  }
+
+  return config
+}
+
+const INTROSPECTION_FILE_NAME = `schema.introspection.json`
+
+// Removed - path is now part of config
+
+export const read = (
+  options: Options,
+  projectRoot: string,
+): Effect.Effect<Catalog.Unversioned.Unversioned | null, InputSource.InputSourceError, FileSystem> =>
+  Effect.gen(function*() {
+    const config = normalizeOptions(options, projectRoot)
+    const fs = yield* FileSystem
+
+    // Check if introspection file exists
+    const exists = yield* Effect.either(fs.exists(config.path))
+    if (exists._tag === 'Left' || !exists.right) {
+      return null
+    }
+
+    const introspectionFileContent = yield* fs.readFileString(config.path).pipe(
+      Effect.mapError((error) =>
+        InputSource.InputSourceError('introspectionFile', `Failed to read file ${config.path}: ${error}`, error)
+      ),
+    )
+
+    let schema: Grafaid.Schema.Schema
+
+    const introspectionData = yield* Effect.try({
+      try: () => Json.codec.decode(introspectionFileContent),
+      catch: (error) => {
+        if (error instanceof SyntaxError) {
+          return InputSource.InputSourceError(
+            'introspectionFile',
+            `Invalid JSON in ${config.path}: ${error.message}`,
+            error,
+          )
+        }
+        return InputSource.InputSourceError(
+          'introspectionFile',
+          `Failed to parse JSON in ${config.path}: ${error}`,
+          error,
+        )
+      },
+    })
+
+    // Validate introspection data structure before passing to fromIntrospectionQuery
+    if (!introspectionData || typeof introspectionData !== 'object') {
+      return yield* Effect.fail(
+        InputSource.InputSourceError('introspectionFile', 'Introspection data must be a valid JSON object'),
+      )
+    }
+
+    // Allow fromIntrospectionQuery to handle validation of the introspection format
+    // It will provide more specific GraphQL-related error messages
+    if (!('data' in introspectionData)) {
+      return yield* Effect.fail(
+        InputSource.InputSourceError(
+          'introspectionFile',
+          'Introspection data missing required "data" property (expected GraphQL introspection result format)',
+        ),
+      )
+    }
+
+    schema = Grafaid.Schema.fromIntrospectionQuery(introspectionData as any)
+
+    return yield* createCatalogFromSchema(schema)
+  })
+
+/**
+ * Create a catalog from a schema object.
+ * This is the core logic for handling single (unversioned) schemas from introspection.
+ */
+const createCatalogFromSchema = (
+  schemaData: Grafaid.Schema.Schema,
+): Effect.Effect<Catalog.Unversioned.Unversioned, InputSource.InputSourceError> =>
+  Effect.gen(function*() {
+    const date = new Date()
+    const dateString = date.toISOString().split('T')[0]!
+    const after = schemaData
+    const before = Grafaid.Schema.empty
+    const changes = yield* Change.calcChangeset({
+      before,
+      after,
+    }).pipe(
+      Effect.mapError((error) =>
+        InputSource.InputSourceError('introspectionFile', `Failed to calculate changeset: ${error}`, error)
+      ),
+    )
+
+    const revision = Revision.make({
+      date: DateOnly.make(dateString),
+      changes,
+    })
+
+    // Create unversioned schema
+    const schema = Schema.Unversioned.make({
+      revisions: [revision],
+      definition: after, // GraphQLSchema object
+    })
+
+    // Return catalog
+    return Catalog.Unversioned.make({
+      schema,
+    })
+  })
+
+export const loader = InputSource.createEffect({
+  name: 'introspectionFile',
+  isApplicable: (options: Options, context) =>
+    Effect.gen(function*() {
+      // Check if the introspection file exists
+      const normalizedConfig = normalizeOptions(options, context.paths.project.rootDir)
+      const fs = yield* FileSystem
+      const exists = yield* Effect.either(fs.exists(normalizedConfig.path))
+      return exists._tag === 'Right' && exists.right
+    }),
+  readIfApplicableOrThrow: (options: Options, context) => read(options, context.paths.project.rootDir),
+})