install @netlify/neon package if not found in package.json

Author: CalebBarnes

src/commands/database/constants.ts

@@ -1,2 +1,3 @@
 export const NEON_DATABASE_EXTENSION_SLUG = process.env.NEON_DATABASE_EXTENSION_SLUG ?? 'neon'
 export const JIGSAW_URL = process.env.JIGSAW_URL ?? 'https://api.netlifysdk.com'
+export const NETLIFY_NEON_PACKAGE_NAME = '@netlify/neon'

src/commands/database/drizzle.ts

@@ -1,9 +1,9 @@
-import { spawn } from 'child_process'
-import { carefullyWriteFile } from './utils.js'
+import { carefullyWriteFile, getPackageJSON, spawnAsync } from './utils.js'
 import BaseCommand from '../base-command.js'
 import path from 'path'
 import fs from 'fs/promises'
 import inquirer from 'inquirer'
+import { NETLIFY_NEON_PACKAGE_NAME } from './constants.js'
 
 export const initDrizzle = async (command: BaseCommand) => {
   if (!command.project.root) {
@@ -29,12 +29,9 @@ export const initDrizzle = async (command: BaseCommand) => {
   }
 
   const packageJsonPath = path.resolve(command.project.root, 'package.json')
+  const packageJson = getPackageJSON(command.workingDir)
 
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-  const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf-8'))
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
   packageJson.scripts = {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
     ...(packageJson.scripts ?? {}),
     ...packageJsonScripts,
   }
@@ -59,15 +56,14 @@ export const initDrizzle = async (command: BaseCommand) => {
     }
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
-  if (!Object.keys(packageJson?.devDependencies ?? {}).includes('drizzle-kit')) {
+  if (!Object.keys(packageJson.devDependencies ?? {}).includes('drizzle-kit')) {
     await spawnAsync(command.project.packageManager?.installCommand ?? 'npm install', ['drizzle-kit@latest', '-D'], {
       stdio: 'inherit',
       shell: true,
     })
   }
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
-  if (!Object.keys(packageJson?.dependencies ?? {}).includes('drizzle-orm')) {
+
+  if (!Object.keys(packageJson.dependencies ?? {}).includes('drizzle-orm')) {
     await spawnAsync(command.project.packageManager?.installCommand ?? 'npm install', ['drizzle-orm@latest'], {
       stdio: 'inherit',
       shell: true,
@@ -94,7 +90,7 @@ export const posts = pgTable('posts', {
     content: text().notNull().default('')
 });`
 
-const dbIndex = `import { neon } from '@netlify/neon';
+const dbIndex = `import { neon } from '${NETLIFY_NEON_PACKAGE_NAME}';
 import { drizzle } from 'drizzle-orm/neon-http';
 
 import * as schema from './schema';
@@ -109,17 +105,3 @@ const packageJsonScripts = {
   'db:migrate': 'netlify dev:exec drizzle-kit migrate',
   'db:studio': 'netlify dev:exec drizzle-kit studio',
 }
-
-const spawnAsync = (command: string, args: string[], options: Parameters<typeof spawn>[2]): Promise<number> => {
-  return new Promise((resolve, reject) => {
-    const child = spawn(command, args, options)
-    child.on('error', reject)
-    child.on('exit', (code) => {
-      if (code === 0) {
-        resolve(code)
-      }
-      const errorMessage = code ? `Process exited with code ${code.toString()}` : 'Process exited with no code'
-      reject(new Error(errorMessage))
-    })
-  })
-}

src/commands/database/init.ts

@@ -1,14 +1,26 @@
 import { OptionValues } from 'commander'
 import inquirer from 'inquirer'
 import BaseCommand from '../base-command.js'
-import { getAccount, getExtension, getJigsawToken, installExtension } from './utils.js'
+import { getAccount, getExtension, getJigsawToken, getPackageJSON, installExtension, spawnAsync } from './utils.js'
 import { initDrizzle } from './drizzle.js'
-import { NEON_DATABASE_EXTENSION_SLUG } from './constants.js'
+import { NEON_DATABASE_EXTENSION_SLUG, NETLIFY_NEON_PACKAGE_NAME } from './constants.js'
 import prettyjson from 'prettyjson'
 import { log } from '../../utils/command-helpers.js'
 import { SiteInfo } from './database.js'
 
 export const init = async (_options: OptionValues, command: BaseCommand) => {
+  try {
+    const packageJson = getPackageJSON(command.workingDir)
+    if (packageJson.dependencies && !Object.keys(packageJson.dependencies).includes(NETLIFY_NEON_PACKAGE_NAME)) {
+      await spawnAsync(command.project.packageManager?.installCommand ?? 'npm install', ['@netlify/neon@latest'], {
+        stdio: 'inherit',
+        shell: true,
+      })
+    }
+  } catch (e) {
+    console.error(`Failed to install @netlify/neon in ${command.workingDir}:`, e)
+  }
+
   const siteInfo = command.netlify.siteInfo as SiteInfo
   if (!command.siteId) {
     console.error(`The project must be linked with netlify link before initializing a database.`)

src/commands/database/utils.ts

@@ -1,10 +1,52 @@
+import { createRequire } from 'module'
+import { join } from 'path'
+
 import fsPromises from 'fs/promises'
 import fs from 'fs'
 import inquirer from 'inquirer'
 
 import { JIGSAW_URL } from './constants.js'
 import BaseCommand from '../base-command.js'
 import { Extension } from './database.js'
+import { spawn } from 'child_process'
+
+type PackageJSON = {
+  dependencies?: Record<string, string>
+  devDependencies?: Record<string, string>
+  scripts?: Record<string, string>
+}
+
+export function getPackageJSON(directory: string) {
+  const require = createRequire(join(directory, 'package.json'))
+  const packageJson = require('./package.json') as unknown
+  if (typeof packageJson !== 'object' || packageJson === null) {
+    throw new Error('Failed to load package.json')
+  }
+  if ('dependencies' in packageJson && typeof packageJson.dependencies !== 'object') {
+    throw new Error(`Expected object at package.json#dependencies, got ${typeof packageJson.dependencies}`)
+  }
+  if ('devDependencies' in packageJson && typeof packageJson.devDependencies !== 'object') {
+    throw new Error(`Expected object at package.json#devDependencies, got ${typeof packageJson.devDependencies}`)
+  }
+  if ('scripts' in packageJson && typeof packageJson.scripts !== 'object') {
+    throw new Error(`Expected object at package.json#scripts, got ${typeof packageJson.scripts}`)
+  }
+  return packageJson as PackageJSON
+}
+
+export const spawnAsync = (command: string, args: string[], options: Parameters<typeof spawn>[2]): Promise<number> => {
+  return new Promise((resolve, reject) => {
+    const child = spawn(command, args, options)
+    child.on('error', reject)
+    child.on('exit', (code) => {
+      if (code === 0) {
+        resolve(code)
+      }
+      const errorMessage = code ? `Process exited with code ${code.toString()}` : 'Process exited with no code'
+      reject(new Error(errorMessage))
+    })
+  })
+}
 
 export const getExtension = async ({
   accountId,