fix(config): fix issue with --config cli arg (prisma#26336)

The arg had to be "allowlisted" for each command individually.

packages/cli/src/CLI.ts

@@ -22,6 +22,7 @@ export class CLI implements Command {
       '-h': '--help',
       '--version': Boolean,
       '-v': '--version',
+      '--config': String,
       '--json': Boolean, // for -v
       '--experimental': Boolean,
       '--preview-feature': Boolean,

packages/cli/src/DebugInfo.ts

@@ -42,6 +42,7 @@ export class DebugInfo implements Command {
       '--help': Boolean,
       '-h': '--help',
       '--schema': String,
+      '--config': String,
       '--telemetry-information': String,
     })
 

packages/cli/src/Format.ts

@@ -43,6 +43,7 @@ Or specify a Prisma schema path
       '--help': Boolean,
       '-h': '--help',
       '--schema': String,
+      '--config': String,
       '--telemetry-information': String,
       '--check': Boolean,
     })

packages/cli/src/Generate.ts

@@ -110,6 +110,7 @@ ${bold('Examples')}
       '-h': '--help',
       '--watch': Boolean,
       '--schema': String,
+      '--config': String,
       '--data-proxy': Boolean,
       '--accelerate': Boolean,
       '--no-engine': Boolean,

packages/cli/src/Validate.ts

@@ -56,6 +56,7 @@ ${bold('Examples')}
       '--help': Boolean,
       '-h': '--help',
       '--schema': String,
+      '--config': String,
       '--telemetry-information': String,
     })
 

packages/cli/src/Version.ts

@@ -53,6 +53,7 @@ export class Version implements Command {
       '-h': '--help',
       '--version': Boolean,
       '-v': '--version',
+      '--config': String,
       '--json': Boolean,
       '--telemetry-information': String,
     })

packages/cli/src/__tests__/config.test.ts

@@ -0,0 +1,48 @@
+import { jestConsoleContext, jestContext } from '@prisma/get-platform'
+
+const ctx = jestContext.new().add(jestConsoleContext()).assemble()
+
+function cleanSnapshot(str: string): string {
+  str = str.replace(/\\/g, '/').replace(/"\/.*(\/config\/prisma.config.ts)"/g, '"REDACTED_ROOT$1"')
+  str = str.replace(/\\/g, '/').replace(/"\/.*(\/prisma.config.ts)"/g, '"REDACTED_ROOT$1"')
+  return str
+}
+
+const COMMANDS = [
+  ['validate'],
+  ['migrate', 'dev'],
+  ['migrate', 'status'],
+  ['migrate', 'resolve'],
+  ['migrate', 'reset'],
+  ['migrate', 'deploy'],
+  ['migrate', 'diff'],
+  ['db', 'execute'],
+  ['db', 'pull'],
+  ['db', 'push'],
+  ['db', 'seed'],
+  ['studio'],
+  ['generate'],
+  ['version'],
+  ['validate'],
+  ['format'],
+  ['debug'],
+]
+
+COMMANDS.forEach((command) => {
+  it(`test 'prisma ${command.join(' ')}' automatically detects config file`, async () => {
+    ctx.fixture('prisma-config')
+
+    // Running with --help to not run further actions beyond config loading
+    const res = await ctx.cli(...command, '--help')
+    expect(cleanSnapshot(res.stdout)).toContain(`Loaded Prisma config from "REDACTED_ROOT/prisma.config.ts".`)
+  })
+
+  it(`test 'prisma ${command.join(' ')}' picks up custom --config option`, async () => {
+    ctx.fixture('prisma-config-nested')
+
+    // Running with --help to not run further actions beyond config loading
+    const res = await ctx.cli(...command, '--config=./config/prisma.config.ts', '--help')
+    console.log(res.stdout)
+    expect(cleanSnapshot(res.stdout)).toContain(`Loaded Prisma config from "REDACTED_ROOT/config/prisma.config.ts".`)
+  })
+})

packages/cli/src/__tests__/fixtures/prisma-config-nested/config/prisma.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from '@prisma/config/src'
+
+export default defineConfig({
+  earlyAccess: true,
+})

packages/cli/src/__tests__/fixtures/prisma-config-nested/config/schema.prisma

@@ -0,0 +1,13 @@
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgres"
+  url      = "postgresql://foo:[email protected]"
+}
+
+model User {
+  id   Int @id @default(autoincrement())
+  name String
+}

packages/cli/src/__tests__/fixtures/prisma-config/schema.prisma

@@ -0,0 +1,13 @@
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgres"
+  url      = "postgresql://foo:[email protected]"
+}
+
+model User {
+  id   Int @id @default(autoincrement())
+  name String
+}

packages/cli/src/utils/checkpoint.ts

@@ -160,6 +160,7 @@ export const SENSITIVE_CLI_OPTIONS = [
   '--to-url',
   // 2. Paths
   '--schema',
+  '--config',
   '--file',
   '--from-schema-datamodel',
   '--to-schema-datamodel',

packages/config/src/loadConfigFromFile.ts

@@ -118,6 +118,8 @@ export async function loadConfigFromFile({
       }
     }
 
+    process.stdout.write(`Loaded Prisma config from "${resolvedPath}".\n`)
+
     // Success case
     const prismaConfig = transformPathsInConfigToAbsolute(parseResultEither.right, resolvedPath)
 

packages/migrate/src/CLI.ts

@@ -18,6 +18,7 @@ export class CLI implements Command {
     const args = arg(argv, {
       '--help': Boolean,
       '-h': '--help',
+      '--config': String,
       '--json': Boolean, // for -v
       '--experimental': Boolean,
       '--preview-feature': Boolean,

packages/migrate/src/__tests__/config.test.ts

@@ -0,0 +1,52 @@
+import { jestConsoleContext, jestContext } from '@prisma/get-platform'
+import execa from 'execa'
+import path from 'path'
+
+const ctx = jestContext.new().add(jestConsoleContext()).assemble()
+
+function cleanSnapshot(str: string): string {
+  str = str.replace(/\\/g, '/').replace(/"\/.*(\/config\/prisma.config.ts)"/g, '"REDACTED_ROOT$1"')
+  str = str.replace(/\\/g, '/').replace(/"\/.*(\/prisma.config.ts)"/g, '"REDACTED_ROOT$1"')
+  return str
+}
+
+const originalCwd = process.cwd()
+
+const migrateCli = (...input: string[]) => {
+  return execa.node(path.join(originalCwd, '../migrate/dist/bin.js'), input, {
+    cwd: ctx.fs.cwd(),
+    stdio: 'pipe',
+    all: true,
+  })
+}
+
+const COMMANDS = [
+  ['migrate', 'dev'],
+  ['migrate', 'status'],
+  ['migrate', 'resolve'],
+  ['migrate', 'reset'],
+  ['migrate', 'deploy'],
+  ['migrate', 'diff'],
+  ['db', 'execute'],
+  ['db', 'pull'],
+  ['db', 'push'],
+  ['db', 'seed'],
+]
+
+COMMANDS.forEach((command) => {
+  it(`test 'prisma ${command.join(' ')}' automatically detects config file`, async () => {
+    ctx.fixture('prisma-config')
+
+    // Running with --help to not run further actions beyond config loading
+    const res = await migrateCli(...command, '--help')
+    expect(cleanSnapshot(res.stdout)).toContain(`Loaded Prisma config from "REDACTED_ROOT/prisma.config.ts".`)
+  })
+
+  it(`test 'prisma ${command.join(' ')}' picks up custom --config option`, async () => {
+    ctx.fixture('prisma-config-nested')
+
+    // Running with --help to not run further actions beyond config loading
+    const res = await migrateCli(...command, '--config=./config/prisma.config.ts', '--help')
+    expect(cleanSnapshot(res.stdout)).toContain(`Loaded Prisma config from "REDACTED_ROOT/config/prisma.config.ts".`)
+  })
+})

packages/migrate/src/__tests__/fixtures/prisma-config-nested/config/prisma.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from '@prisma/config/src'
+
+export default defineConfig({
+  earlyAccess: true,
+})

packages/migrate/src/__tests__/fixtures/prisma-config-nested/config/schema.prisma

@@ -0,0 +1,13 @@
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgres"
+  url      = "postgresql://foo:[email protected]"
+}
+
+model User {
+  id   Int @id @default(autoincrement())
+  name String
+}

packages/migrate/src/__tests__/fixtures/prisma-config/prisma.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from '@prisma/config/src'
+
+export default defineConfig({
+  earlyAccess: true,
+})

packages/migrate/src/__tests__/fixtures/prisma-config/schema.prisma

@@ -0,0 +1,13 @@
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgres"
+  url      = "postgresql://foo:[email protected]"
+}
+
+model User {
+  id   Int @id @default(autoincrement())
+  name String
+}

packages/migrate/src/commands/DbCommand.ts

@@ -48,6 +48,7 @@ ${bold('Examples')}
     const args = arg(argv, {
       '--help': Boolean,
       '-h': '--help',
+      '--config': String,
       '--preview-feature': Boolean,
       '--telemetry-information': String,
     })

packages/migrate/src/commands/DbDrop.ts

@@ -65,6 +65,7 @@ ${bold('Examples')}
       '--force': Boolean,
       '-f': '--force',
       '--schema': String,
+      '--config': String,
       '--telemetry-information': String,
     })
 

packages/migrate/src/commands/DbExecute.ts

@@ -92,6 +92,7 @@ ${bold('Examples')}
       {
         '--help': Boolean,
         '-h': '--help',
+        '--config': String,
         '--stdin': Boolean,
         '--file': String,
         '--schema': String,

packages/migrate/src/commands/DbPull.ts

@@ -105,6 +105,7 @@ Set composite types introspection depth to 2 levels
       '--url': String,
       '--print': Boolean,
       '--schema': String,
+      '--config': String,
       '--schemas': String,
       '--force': Boolean,
       '--composite-type-depth': Number, // optional, only on mongodb

packages/migrate/src/commands/DbPush.ts

@@ -65,6 +65,7 @@ ${bold('Examples')}
         '--force-reset': Boolean,
         '--skip-generate': Boolean,
         '--schema': String,
+        '--config': String,
         '--telemetry-information': String,
       },
       false,

packages/migrate/src/commands/DbSeed.ts

@@ -35,6 +35,7 @@ ${bold('Examples')}
         '--help': Boolean,
         '-h': '--help',
         '--schema': String,
+        '--config': String,
         '--telemetry-information': String,
       },
       false,

packages/migrate/src/commands/MigrateCommand.ts

@@ -67,6 +67,7 @@ ${bold('Examples')}
     const args = arg(argv, {
       '--help': Boolean,
       '-h': '--help',
+      '--config': String,
       '--preview-feature': Boolean,
       '--telemetry-information': String,
     })

packages/migrate/src/commands/MigrateDeploy.ts

@@ -46,6 +46,7 @@ ${bold('Examples')}
         '--help': Boolean,
         '-h': '--help',
         '--schema': String,
+        '--config': String,
         '--telemetry-information': String,
       },
       false,

packages/migrate/src/commands/MigrateDev.ts

@@ -80,6 +80,7 @@ ${bold('Examples')}
       // '-f': '--force',
       '--create-only': Boolean,
       '--schema': String,
+      '--config': String,
       '--skip-generate': Boolean,
       '--skip-seed': Boolean,
       '--telemetry-information': String,

packages/migrate/src/commands/MigrateDiff.ts

@@ -172,6 +172,7 @@ ${bold('Examples')}
         '--script': Boolean,
         '--exit-code': Boolean,
         '--telemetry-information': String,
+        '--config': String,
       },
       false,
     )

packages/migrate/src/commands/MigrateReset.ts

@@ -63,6 +63,7 @@ ${bold('Examples')}
       '--skip-generate': Boolean,
       '--skip-seed': Boolean,
       '--schema': String,
+      '--config': String,
       '--telemetry-information': String,
     })
 

packages/migrate/src/commands/MigrateResolve.ts

@@ -65,6 +65,7 @@ ${bold('Examples')}
         '--applied': String,
         '--rolled-back': String,
         '--schema': String,
+        '--config': String,
         '--telemetry-information': String,
       },
       false,

packages/migrate/src/commands/MigrateStatus.ts

@@ -55,6 +55,7 @@ Check the status of your database migrations
         '--help': Boolean,
         '-h': '--help',
         '--schema': String,
+        '--config': String,
         '--telemetry-information': String,
       },
       false,