@platformatic/db 2.72.0 → 3.0.0-alpha.1

package/lib/commands/seed.js

@@ -0,0 +1,88 @@
+import tsCompiler from '@platformatic/ts-compiler'
+import { loadConfiguration, loadModule } from '@platformatic/utils'
+import { access, readFile } from 'fs/promises'
+import { createRequire } from 'node:module'
+import { join, resolve } from 'node:path'
+import { MissingSeedFileError } from '../errors.js'
+import { Migrator } from '../migrator.js'
+import { schema } from '../schema.js'
+import { setupDB } from '../utils.js'
+
+export async function seed (logger, configFile, args, { colorette: { bold }, logFatalError }) {
+  const config = await loadConfiguration(configFile, schema)
+
+  if (config.migrations !== undefined) {
+    const migrator = new Migrator(config.migrations, config.db, logger)
+
+    try {
+      const hasMigrationsToApply = await migrator.hasMigrationsToApply()
+      if (hasMigrationsToApply) {
+        logFatalError(logger, 'You must apply migrations before seeding the database.')
+        return
+      }
+    } finally {
+      await migrator.close()
+    }
+  }
+
+  if (!args.length) {
+    throw new MissingSeedFileError()
+  }
+
+  let seedFile = resolve(process.cwd(), args[0])
+
+  // check if we are in Typescript and, in case, compile it
+  if (seedFile.endsWith('.ts')) {
+    await tsCompiler.compile({
+      cwd: process.cwd(),
+      logger,
+      tsConfig: config.plugins?.typescript?.tsConfig,
+      flags: config.plugins?.typescript?.flags
+    })
+    const tsConfigPath = config?.plugins?.typescript?.tsConfig || resolve(process.cwd(), 'tsconfig.json')
+    const tsConfig = JSON.parse(await readFile(tsConfigPath, 'utf8'))
+    const outDir = tsConfig.compilerOptions.outDir
+    seedFile = join(outDir, seedFile.replace('.ts', '.js'))
+  }
+
+  await access(seedFile)
+
+  logger.info(`Seeding from ${bold(seedFile)}`)
+
+  const importedModule = await loadModule(createRequire(resolve(process.cwd(), 'noop.js')), seedFile)
+
+  const seedFunction = typeof importedModule?.seed !== 'function' ? importedModule : importedModule
+
+  if (typeof seedFunction !== 'function') {
+    logFatalError(logger, 'Cannot find seed function.')
+    logFatalError(logger, "If you use an ESM module use the signature 'export async function seed (opts)'.")
+    logFatalError(logger, "If you use a CJS module use the signature 'module.exports = async function seed (opts)'.")
+    logFatalError(logger, "If you use Typescript use the signature 'export async function seed(opts)'")
+    return
+  }
+
+  const { db, sql, entities } = await setupDB(logger, config.db)
+  await seedFunction({ db, sql, entities, logger })
+  logger.info('Seeding complete.')
+
+  // Once done seeding, close your connection.
+  await db.dispose()
+}
+
+export const helpFooter = `
+This is a convenience method that loads a JavaScript file and configure @platformatic/sql-mapper to connect to the database specified in the configuration file.
+
+Here is an example of a seed file:
+
+\`\`\`
+'use strict'
+
+module.exports = async function ({ entities, db, sql }) {
+  await entities.graph.save({ input: { name: 'Hello' } })
+  await db.query(sql\`INSERT INTO graphs (name) VALUES ('Hello 2');\`)
+}
+\`\`\`
+
+You can find more details about the configuration format here:
+* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
+`

package/lib/commands/types.js

@@ -0,0 +1,21 @@
+import { loadConfiguration } from '@platformatic/utils'
+import { schema } from '../schema.js'
+import { execute } from '../types.js'
+
+export async function generateTypes (logger, configFile, _args) {
+  const config = await loadConfiguration(configFile, schema)
+
+  const count = await execute({ logger, config })
+
+  if (count === 0) {
+    logger.warn('No entities found in your schema. Types were NOT generated.')
+    logger.warn('Make sure you have applied all the migrations and try again.')
+  }
+}
+
+export const helpFooter = `
+As a result of executing this command, the Platformatic DB will generate a \`types\` folder with a typescript file for each database entity. It will also generate a \`plt-env.d.ts\` file that injects the types into the Application instance.
+
+You can find more details about the configuration format here:
+* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
+`

package/lib/errors.js

@@ -1,14 +1,18 @@
-'use strict'
-
-const createError = require('@fastify/error')
+import createError from '@fastify/error'
 
 const ERROR_PREFIX = 'PLT_DB'
 
-module.exports = {
-  MigrateMissingMigrationsError: createError(`${ERROR_PREFIX}_MIGRATE_ERROR`, 'Missing "migrations" section in config file'),
-  UnknownDatabaseError: createError(`${ERROR_PREFIX}_UNKNOWN_DATABASE_ERROR`, 'Unknown database'),
-  MigrateMissingMigrationsDirError: createError(`${ERROR_PREFIX}_MIGRATE_ERROR`, 'Migrations directory %s does not exist'),
-  MissingSeedFileError: createError(`${ERROR_PREFIX}_MISSING_SEED_FILE_ERROR`, 'Missing seed file'),
-  MigrationsToApplyError: createError(`${ERROR_PREFIX}_MIGRATIONS_TO_APPLY_ERROR`, 'You have migrations to apply. Please run `platformatic db migrations apply` first.'),
-
-}
+export const MigrateMissingMigrationsError = createError(
+  `${ERROR_PREFIX}_MIGRATE_ERROR`,
+  'Missing "migrations" section in config file'
+)
+export const UnknownDatabaseError = createError(`${ERROR_PREFIX}_UNKNOWN_DATABASE_ERROR`, 'Unknown database')
+export const MigrateMissingMigrationsDirError = createError(
+  `${ERROR_PREFIX}_MIGRATE_ERROR`,
+  'Migrations directory %s does not exist'
+)
+export const MissingSeedFileError = createError(`${ERROR_PREFIX}_MISSING_SEED_FILE_ERROR`, 'Missing seed file')
+export const MigrationsToApplyError = createError(
+  `${ERROR_PREFIX}_MIGRATIONS_TO_APPLY_ERROR`,
+  'You have migrations to apply.'
+)

package/lib/{generator/db-generator.js → generator.js}

@@ -1,21 +1,18 @@
-'use strict'
+import { BaseGenerator, generateTests } from '@platformatic/generators'
+import { join } from 'node:path'
+import { jsHelperMySQL, jsHelperPostgres, jsHelperSqlite, moviesTestJS, moviesTestTS, README } from './templates.js'
 
-const { BaseGenerator, generateTests } = require('@platformatic/generators')
-const { jsHelperSqlite, jsHelperMySQL, jsHelperPostgres, moviesTestTS, moviesTestJS } = require('./code-templates')
-const { join } = require('node:path')
-const { readFile } = require('node:fs/promises')
-
-class DBGenerator extends BaseGenerator {
+export class Generator extends BaseGenerator {
   constructor (opts = {}) {
     super({
       ...opts,
-      module: '@platformatic/db',
+      module: '@platformatic/db'
     })
     this.connectionStrings = {
       postgres: 'postgres://postgres:postgres@127.0.0.1:5432/postgres',
       sqlite: 'sqlite://./db.sqlite',
       mysql: 'mysql://root@127.0.0.1:3306/platformatic',
-      mariadb: 'mysql://root@127.0.0.1:3306/platformatic',
+      mariadb: 'mysql://root@127.0.0.1:3306/platformatic'
     }
   }
 
@@ -29,7 +26,7 @@ class DBGenerator extends BaseGenerator {
       tests: true,
       types: true,
       migrations: 'migrations',
-      createMigrations: true,
+      createMigrations: true
     }
   }
 
@@ -43,11 +40,11 @@ class DBGenerator extends BaseGenerator {
         connectionString: `{${this.getEnvVarName('DATABASE_URL')}}`,
         graphql: true,
         openapi: true,
-        schemalock: true,
+        schemalock: true
       },
       watch: {
-        ignore: ['*.sqlite', '*.sqlite-journal'],
-      },
+        ignore: ['*.sqlite', '*.sqlite-journal']
+      }
     }
 
     if (!isRuntimeContext) {
@@ -55,15 +52,15 @@ class DBGenerator extends BaseGenerator {
         hostname: '{PLT_SERVER_HOSTNAME}',
         port: '{PORT}',
         logger: {
-          level: '{PLT_SERVER_LOGGER_LEVEL}',
-        },
+          level: '{PLT_SERVER_LOGGER_LEVEL}'
+        }
       }
     }
 
     if (migrations) {
       config.migrations = {
         dir: migrations,
-        autoApply: `{${this.getEnvVarName('PLT_APPLY_MIGRATIONS')}}`,
+        autoApply: `{${this.getEnvVarName('PLT_APPLY_MIGRATIONS')}}`
       }
 
       this.addFile({ path: 'migrations', file: '.gitkeep', contents: '' })
@@ -71,19 +68,22 @@ class DBGenerator extends BaseGenerator {
 
     if (plugin === true) {
       config.plugins = {
-        paths: [{
-          path: './plugins',
-          encapsulate: false,
-        }, {
-          path: './routes',
-        }],
-        typescript: `{${this.getEnvVarName('PLT_TYPESCRIPT')}}`,
+        paths: [
+          {
+            path: './plugins',
+            encapsulate: false
+          },
+          {
+            path: './routes'
+          }
+        ],
+        typescript: `{${this.getEnvVarName('PLT_TYPESCRIPT')}}`
       }
     }
 
     if (types === true) {
       config.types = {
-        autogenerate: true,
+        autogenerate: true
       }
     }
 
@@ -94,22 +94,28 @@ class DBGenerator extends BaseGenerator {
     if (!this.config.isUpdating) {
       this.config.connectionString = this.config.connectionString || this.connectionStrings[this.config.database]
       this.config.dependencies = {
-        '@platformatic/db': `^${this.platformaticVersion}`,
+        '@platformatic/db': `^${this.platformaticVersion}`
       }
 
       if (!this.config.isRuntimeContext) {
-        this.addEnvVars({
-          PLT_SERVER_HOSTNAME: this.config.hostname,
-          PLT_SERVER_LOGGER_LEVEL: 'info',
-          PORT: 3042,
-        }, { overwrite: false, default: true })
+        this.addEnvVars(
+          {
+            PLT_SERVER_HOSTNAME: this.config.hostname,
+            PLT_SERVER_LOGGER_LEVEL: 'info',
+            PORT: 3042
+          },
+          { overwrite: false, default: true }
+        )
       }
 
-      this.addEnvVars({
-        PLT_TYPESCRIPT: this.config.typescript,
-        DATABASE_URL: this.connectionStrings[this.config.database],
-        PLT_APPLY_MIGRATIONS: 'true',
-      }, { overwrite: false, default: true })
+      this.addEnvVars(
+        {
+          PLT_TYPESCRIPT: this.config.typescript,
+          DATABASE_URL: this.connectionStrings[this.config.database],
+          PLT_APPLY_MIGRATIONS: 'true'
+        },
+        { overwrite: false, default: true }
+      )
     }
   }
 
@@ -119,7 +125,7 @@ class DBGenerator extends BaseGenerator {
         this.createMigrationFiles()
       }
 
-      this.addFile({ path: '', file: 'README.md', contents: await readFile(join(__dirname, 'README.md'), 'utf-8') })
+      this.addFile({ path: '', file: 'README.md', contents: README })
 
       if (this.config.plugin) {
         let jsHelper = { pre: '', config: '', post: '' }
@@ -148,7 +154,7 @@ class DBGenerator extends BaseGenerator {
 
         // TODO(leorossi): this is unfortunate. We have already generated tests in BaseGenerator
         // next line will override the test files
-        generateTests(this.config.typescript, '@platformatic/db', jsHelper).forEach((fileObject) => {
+        generateTests(this.config.typescript, '@platformatic/db', jsHelper).forEach(fileObject => {
           this.addFile(fileObject)
         })
 
@@ -161,17 +167,17 @@ class DBGenerator extends BaseGenerator {
         }
       }
 
-      const GLOBAL_TYPES_TEMPLATE = `
+      const ENVIRONMENT_TEMPLATE = `
 import { FastifyInstance } from 'fastify'
-import { PlatformaticApp, PlatformaticDBConfig, PlatformaticDBMixin, Entities } from '@platformatic/db'
+import { PlatformaticApplication, PlatformaticDatabaseConfig, PlatformaticDatabaseMixin, Entities } from '@platformatic/db'
 
 declare module 'fastify' {
   interface FastifyInstance {
-    platformatic: PlatformaticApp<PlatformaticDBConfig> & PlatformaticDBMixin<Entities>
+    platformatic: PlatformaticApplication<PlatformaticDatabaseConfig> & PlatformaticDatabaseMixin<Entities>
   }
 }
 `
-      this.addFile({ path: '', file: 'global.d.ts', contents: GLOBAL_TYPES_TEMPLATE })
+      this.addFile({ path: '', file: 'plt-env.d.ts', contents: ENVIRONMENT_TEMPLATE })
     }
   }
 
@@ -185,7 +191,7 @@ declare module 'fastify' {
       postgres: 'SERIAL',
       sqlite: 'INTEGER',
       mysql: 'INTEGER UNSIGNED AUTO_INCREMENT',
-      mariadb: 'INTEGER UNSIGNED AUTO_INCREMENT',
+      mariadb: 'INTEGER UNSIGNED AUTO_INCREMENT'
     }
 
     return `
@@ -224,26 +230,26 @@ declare module 'fastify' {
         label: 'What is the connection string?',
         default: this.connectionStrings.sqlite,
         type: 'string',
-        configValue: 'connectionString',
+        configValue: 'connectionString'
       },
       {
         var: 'PLT_APPLY_MIGRATIONS',
         label: 'Should migrations be applied automatically on startup?',
         default: true,
-        type: 'boolean',
-      },
+        type: 'boolean'
+      }
     ]
   }
 
   async prepareQuestions () {
     await super.prepareQuestions()
     if (!this.config.connectionString) {
-      const def = this.getConfigFieldsDefinitions().find((q) => q.var === 'DATABASE_URL')
+      const def = this.getConfigFieldsDefinitions().find(q => q.var === 'DATABASE_URL')
       this.questions.push({
         type: 'input',
         name: def.configValue,
         message: def.label,
-        default: def.default,
+        default: def.default
       })
     }
 
@@ -252,11 +258,10 @@ declare module 'fastify' {
       name: 'createMigrations',
       message: 'Do you want to create default migrations?',
       default: true,
-      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }],
+      choices: [
+        { name: 'yes', value: true },
+        { name: 'no', value: false }
+      ]
     })
   }
 }
-
-module.exports = DBGenerator
-module.exports.DBGenerator = DBGenerator
-module.exports.Generator = DBGenerator

package/lib/{migrator.mjs → migrator.js}

@@ -1,10 +1,9 @@
-import { basename } from 'path'
-import Postgrator from 'postgrator'
 import { createConnectionPool } from '@platformatic/sql-mapper'
-import { stat, readdir } from 'fs/promises'
-import errors from './errors.js'
+import { readdir, stat } from 'node:fs/promises'
+import { basename } from 'node:path'
+import { MigrateMissingMigrationsDirError, MigrateMissingMigrationsError } from './errors.js'
 
-class Migrator {
+export class Migrator {
   constructor (migrationConfig, coreConfig, logger) {
     this.coreConfig = coreConfig
     this.migrationDir = migrationConfig.dir
@@ -21,6 +20,8 @@ class Migrator {
   }
 
   async setupPostgrator () {
+    const { default: Postgrator } = await import('postgrator')
+
     this.appliedMigrationsCount = 0
     if (this.postgrator instanceof Postgrator) return
 
@@ -28,7 +29,7 @@ class Migrator {
 
     const { db, sql } = await createConnectionPool({
       ...this.coreConfig,
-      log: this.logger,
+      log: this.logger
     })
 
     let driver
@@ -44,9 +45,7 @@ class Migrator {
       driver = 'sqlite3'
     }
 
-    const database = driver !== 'sqlite3'
-      ? new URL(this.coreConfig.connectionString).pathname.replace(/^\//, '')
-      : ''
+    const database = driver !== 'sqlite3' ? new URL(this.coreConfig.connectionString).pathname.replace(/^\//, '') : ''
 
     this.db = db
 
@@ -59,40 +58,31 @@ class Migrator {
       driver,
       database,
       schemaTable: this.migrationsTable || 'versions',
-      execQuery: async (query) => {
+      execQuery: async query => {
         const res = await db.query(sql`${sql.__dangerous__rawValue(query)}`)
         return { rows: res }
       },
       validateChecksums: this.validateChecksums,
       newline: this.newline,
-      currentSchema: ['pg', 'mysql'].includes(driver) ? this.currentSchema : undefined,
+      currentSchema: ['pg', 'mysql'].includes(driver) ? this.currentSchema : undefined
     })
 
     if (this.validateChecksums === true) {
-      this.postgrator.on(
-        'validation-started',
-        (migration) => {
-          /* c8 ignore next 3 */
-          const migrationName = basename(migration.filename)
-          this.logger.info(`verifying checksum of migration ${migrationName}`)
-        }
-      )
-    }
-    this.postgrator.on(
-      'migration-started',
-      (migration) => {
-        const migrationName = basename(migration.filename)
-        this.logger.info(`running ${migrationName}`)
-      }
-    )
-    this.postgrator.on(
-      'migration-finished',
-      (migration) => {
-        this.appliedMigrationsCount++
+      this.postgrator.on('validation-started', migration => {
+        /* c8 ignore next 3 */
         const migrationName = basename(migration.filename)
-        this.logger.debug(`completed ${migrationName}`)
-      }
-    )
+        this.logger.info(`verifying checksum of migration ${migrationName}`)
+      })
+    }
+    this.postgrator.on('migration-started', migration => {
+      const migrationName = basename(migration.filename)
+      this.logger.info(`running ${migrationName}`)
+    })
+    this.postgrator.on('migration-finished', migration => {
+      this.appliedMigrationsCount++
+      const migrationName = basename(migration.filename)
+      this.logger.debug(`completed ${migrationName}`)
+    })
   }
 
   async checkMigrationsDirectoryExists () {
@@ -100,7 +90,7 @@ class Migrator {
       await stat(this.migrationDir)
     } catch (err) {
       if (err.code === 'ENOENT') {
-        throw new errors.MigrateMissingMigrationsDirError(this.migrationDir)
+        throw new MigrateMissingMigrationsDirError(this.migrationDir)
       }
     }
   }
@@ -178,7 +168,7 @@ class Migrator {
       }
     } catch (err) {
       if (err.code === 'ENOENT') {
-        throw new errors.MigrateMissingMigrationsDirError(this.migrationDir)
+        throw new MigrateMissingMigrationsDirError(this.migrationDir)
       }
     }
   }
@@ -192,4 +182,22 @@ class Migrator {
   }
 }
 
-export { Migrator }
+export async function execute (logger, config, to, rollback) {
+  const migrationsConfig = config.migrations
+  if (migrationsConfig === undefined) {
+    throw new MigrateMissingMigrationsError()
+  }
+
+  const migrator = new Migrator(migrationsConfig, config.db, logger)
+
+  try {
+    if (rollback) {
+      await migrator.rollbackMigration()
+    } else {
+      await migrator.applyMigrations(to)
+    }
+    return migrator.appliedMigrationsCount > 0
+  } finally {
+    await migrator.close()
+  }
+}

package/lib/{root-endpoint/index.js → root.js}

@@ -1,11 +1,10 @@
-'use strict'
-const path = require('path')
-const fastifyStatic = require('@fastify/static')
-const userAgentParser = require('my-ua-parser')
+import fastifyStatic from '@fastify/static'
+import userAgentParser from 'my-ua-parser'
+import path from 'node:path'
 
-module.exports = async (app, opts) => {
+export async function root (app) {
   app.register(fastifyStatic, {
-    root: path.join(__dirname, 'public'),
+    root: path.join(import.meta.dirname, '../public')
   })
   // root endpoint
   app.route({
@@ -21,6 +20,6 @@ module.exports = async (app, opts) => {
         }
       }
       return { message: 'Welcome to Platformatic! Please visit https://docs.platformatic.dev' }
-    },
+    }
   })
 }

package/lib/schema.js

@@ -1,12 +1,16 @@
 #! /usr/bin/env node
-'use strict'
 
-const { metrics, server, plugins, watch, openApiDefs, openApiBase, clients } = require('@platformatic/service').schemas
-const { schemaComponents } = require('@platformatic/utils')
-const telemetry = require('@platformatic/telemetry').schema
-const pkg = require('../package.json')
+import { schemaComponents as serviceSchemaComponents } from '@platformatic/service'
+import { fastifyServer as server, schemaComponents as utilsSchemaComponents, watch, wrappedRuntime } from '@platformatic/utils'
+import { readFileSync } from 'node:fs'
+import { resolve } from 'node:path'
 
-const db = {
+export const packageJson = JSON.parse(readFileSync(resolve(import.meta.dirname, '../package.json'), 'utf8'))
+export const version = packageJson.version
+
+const { plugins, openApiBase, clients, $defs } = serviceSchemaComponents
+
+export const db = {
   type: 'object',
   properties: {
     connectionString: {
@@ -235,7 +239,7 @@ const db = {
   required: ['connectionString']
 }
 
-const sharedAuthorizationRule = {
+export const sharedAuthorizationRule = {
   role: {
     type: 'string',
     description: 'the role name to match the rule'
@@ -261,7 +265,7 @@ const sharedAuthorizationRule = {
   }
 }
 
-const authorization = {
+export const authorization = {
   type: 'object',
   properties: {
     adminSecret: {
@@ -367,7 +371,7 @@ const authorization = {
   additionalProperties: false
 }
 
-const migrations = {
+export const migrations = {
   type: 'object',
   properties: {
     dir: {
@@ -410,7 +414,7 @@ const migrations = {
   required: ['dir']
 }
 
-const types = {
+export const types = {
   type: 'object',
   properties: {
     autogenerate: {
@@ -433,10 +437,18 @@ const types = {
   additionalProperties: false
 }
 
-const platformaticDBschema = {
-  $id: `https://schemas.platformatic.dev/@platformatic/db/${pkg.version}.json`,
+export const schemaComponents = {
+  db,
+  sharedAuthorizationRule,
+  authorization,
+  migrations,
+  types
+}
+
+export const schema = {
+  $id: `https://schemas.platformatic.dev/@platformatic/db/${packageJson.version}.json`,
   $schema: 'http://json-schema.org/draft-07/schema#',
-  title: 'Platformatic DB',
+  title: 'Platformatic Database Config',
   type: 'object',
   properties: {
     basePath: {
@@ -455,12 +467,11 @@ const platformaticDBschema = {
     db,
     authorization,
     migrations,
-    metrics,
     types,
     plugins,
-    telemetry,
+    telemetry: utilsSchemaComponents.telemetry,
     clients,
-    runtime: schemaComponents.wrappedRuntime,
+    runtime: wrappedRuntime,
     watch: {
       anyOf: [
         watch,
@@ -482,7 +493,7 @@ const platformaticDBschema = {
   additionalProperties: false,
   required: ['db'],
   $defs: {
-    ...openApiDefs,
+    ...$defs,
     'crud-operation-auth': {
       oneOf: [
         {
@@ -534,8 +545,7 @@ const platformaticDBschema = {
   }
 }
 
-module.exports.schema = platformaticDBschema
-
-if (require.main === module) {
-  console.log(JSON.stringify(platformaticDBschema, null, 2))
+/* c8 ignore next 3 */
+if (process.argv[1] === import.meta.filename) {
+  console.log(JSON.stringify(schema, null, 2))
 }