chore(client): [DPGA] implement --data-proxy

helpers/compile/build.ts

@@ -183,7 +183,7 @@ const watch =
     }, 10)
 
     // triggers a full rebuild on added file
-    const onAdd = debounce(async () => {
+    const onAddOrUnlink = debounce(async () => {
       void changeWatcher.close() // stop all
 
       // only one watcher will do this task
@@ -194,7 +194,8 @@ const watch =
     }, 10)
 
     changeWatcher.on('change', onChange)
-    restartWatcher.once('add', onAdd)
+    restartWatcher.once('add', onAddOrUnlink)
+    restartWatcher.once('unlink', onAddOrUnlink)
 
     return undefined
   }

packages/cli/src/Generate.ts

@@ -9,7 +9,6 @@ import {
   getCommandWithExecutor,
   getGenerators,
   getGeneratorSuccessMessage,
-  getPlatform,
   HelpError,
   highlightTS,
   isError,
@@ -18,7 +17,6 @@ import {
   logger,
   missingGeneratorMessage,
   parseEnvValue,
-  Platform,
 } from '@prisma/sdk'
 import chalk from 'chalk'
 import fs from 'fs'
@@ -49,9 +47,10 @@ ${chalk.bold('Usage')}
 
 ${chalk.bold('Options')}
 
-  -h, --help   Display this help message
-    --schema   Custom path to your Prisma schema
-     --watch   Watch the Prisma schema and rerun after a change
+    -h, --help   Display this help message
+      --schema   Custom path to your Prisma schema
+  --data-proxy   Enable the Data Proxy in the Prisma Client
+       --watch   Watch the Prisma schema and rerun after a change
 
 ${chalk.bold('Examples')}
 
@@ -102,6 +101,7 @@ ${chalk.bold('Examples')}
       '-h': '--help',
       '--watch': Boolean,
       '--schema': String,
+      '--data-proxy': Boolean,
       // Only used for checkpoint information
       '--postinstall': String,
       '--telemetry-information': String,
@@ -137,6 +137,7 @@ ${chalk.bold('Examples')}
         printDownloadProgress: !watchMode,
         version: enginesVersion,
         cliVersion: pkg.version,
+        dataProxy: !!args['--data-proxy'],
       })
 
       if (!generators || generators.length === 0) {
@@ -259,6 +260,7 @@ Please run \`${getCommandWithExecutor('prisma generate')}\` to see the errors.`)
               printDownloadProgress: !watchMode,
               version: enginesVersion,
               cliVersion: pkg.version,
+              dataProxy: !!args['--data-proxy'],
             })
 
             if (!generatorsWatch || generatorsWatch.length === 0) {

packages/client/fixtures/dataproxy/prisma/schema.prisma

@@ -5,7 +5,6 @@ datasource db {
 
 generator client {
   provider   = "prisma-client-js"
-  engineType = "dataproxy"
 }
 
 model Post {

packages/client/src/__tests__/buildNFTAnnotations.test.ts

@@ -11,7 +11,7 @@ function normalizePaths(snapshot: string): string {
 
 describe('library', () => {
   it('generates annotations for a schema and a single engine', () => {
-    const annotations = buildNFTAnnotations(ClientEngineType.Library, ['debian-openssl-1.1.x'], 'out')
+    const annotations = buildNFTAnnotations(false, ClientEngineType.Library, ['debian-openssl-1.1.x'], 'out')
 
     expect(normalizePaths(annotations)).toMatchInlineSnapshot(`
 
@@ -24,6 +24,7 @@ describe('library', () => {
 
   it('generates annotations for a schema and multiple engines', () => {
     const annotations = buildNFTAnnotations(
+      false,
       ClientEngineType.Library,
       ['debian-openssl-1.1.x', 'darwin', 'windows'],
       'out',
@@ -47,7 +48,7 @@ describe('library', () => {
 
 describe('binary', () => {
   it('generates annotations for a schema and a single engine', () => {
-    const annotations = buildNFTAnnotations(ClientEngineType.Binary, ['debian-openssl-1.1.x'], 'out')
+    const annotations = buildNFTAnnotations(false, ClientEngineType.Binary, ['debian-openssl-1.1.x'], 'out')
 
     expect(normalizePaths(annotations)).toMatchInlineSnapshot(`
 
@@ -60,6 +61,7 @@ describe('binary', () => {
 
   it('generates annotations for a schema and multiple engines', () => {
     const annotations = buildNFTAnnotations(
+      false,
       ClientEngineType.Binary,
       ['debian-openssl-1.1.x', 'darwin', 'windows'],
       'out',
@@ -84,16 +86,15 @@ describe('binary', () => {
 describe('dataproxy', () => {
   it('generates no annotations', () => {
     const annotations = buildNFTAnnotations(
-      ClientEngineType.DataProxy,
+      true,
+      ClientEngineType.Library,
       ['debian-openssl-1.1.x', 'darwin', 'windows'],
       'out',
     )
 
     // TODO: when using .toMatchInlineSnapshot(), this fails after updating snapshots.
     // Probably an issue with the snapshot serializer?
-    expect(normalizePaths(annotations)).toBe(`
-
-`)
+    expect(normalizePaths(annotations)).toBe('')
   })
 })
 
@@ -106,6 +107,7 @@ describe('special cases', () => {
     process.env.NETLIFY = 'true'
 
     const annotations = buildNFTAnnotations(
+      false,
       ClientEngineType.Library,
       ['debian-openssl-1.1.x', 'darwin', 'windows'],
       'out',

packages/client/src/__tests__/generation/generator.test.ts

@@ -33,6 +33,7 @@ describe('generator', () => {
       baseDir: __dirname,
       printDownloadProgress: false,
       skipDownload: true,
+      dataProxy: false,
     })
 
     const manifest = omit<any, any>(generator.manifest, ['version']) as any
@@ -114,6 +115,7 @@ describe('generator', () => {
         baseDir: __dirname,
         printDownloadProgress: false,
         skipDownload: true,
+        dataProxy: false,
       })
     } catch (e) {
       expect(stripAnsi(e.message)).toMatchInlineSnapshot(`
@@ -163,6 +165,7 @@ describe('generator', () => {
         baseDir: __dirname,
         printDownloadProgress: false,
         skipDownload: true,
+        dataProxy: false,
       })
     } catch (e) {
       doesnNotExistError = e
@@ -192,6 +195,7 @@ describe('generator', () => {
       baseDir: __dirname,
       printDownloadProgress: false,
       skipDownload: true,
+      dataProxy: false,
     })
 
     const manifest = omit<any, any>(generator.manifest, ['version']) as any

packages/client/src/__tests__/integration/happy/custom-engine-binary/test.ts

@@ -5,11 +5,6 @@ import path from 'path'
 
 import { generateTestClient } from '../../../../utils/getTestClient'
 
-if (getClientEngineType() === ClientEngineType.DataProxy) {
-  // eslint-disable-next-line no-global-assign
-  test = test.skip
-}
-
 test('custom engine binary path (internal API)', async () => {
   await generateTestClient()
 

packages/client/src/generation/TSClient/TSClient.ts

@@ -42,6 +42,7 @@ export interface TSClientOptions {
   schemaDir: string
   outputDir: string
   activeProvider: string
+  dataProxy: boolean
 }
 
 export class TSClient implements Generatable {
@@ -62,6 +63,7 @@ export class TSClient implements Generatable {
       runtimeDir,
       runtimeName,
       datasources,
+      dataProxy,
     } = this.options
     const schemaPath = path.join(schemaDir, 'schema.prisma')
     const envPaths = getEnvPaths(schemaPath, { cwd: outputDir })
@@ -86,15 +88,16 @@ export class TSClient implements Generatable {
       engineVersion: this.options.engineVersion,
       datasourceNames: datasources.map((d) => d.name),
       activeProvider: this.options.activeProvider,
+      dataProxy: this.options.dataProxy,
     }
 
     // get relative output dir for it to be preserved even after bundling, or
     // being moved around as long as we keep the same project dir structure.
     const relativeOutdir = path.relative(process.cwd(), outputDir)
 
     const code = `${commonCodeJS({ ...this.options, browser: false })}
-${buildRequirePath(engineType)}
-${buildDirname(engineType, relativeOutdir, runtimeDir)}
+${buildRequirePath(dataProxy)}
+${buildDirname(dataProxy, relativeOutdir, runtimeDir)}
 /**
  * Enums
  */
@@ -112,22 +115,22 @@ ${new Enum(
   },
   true,
 ).toJS()}
-${buildDMMF(engineType, this.dmmfString)}
+${buildDMMF(dataProxy, this.dmmfString)}
 
 /**
  * Create the Client
  */
 const config = ${JSON.stringify(config, null, 2)}
 config.document = dmmf
 config.dirname = dirname
-${buildInlineDatasource(engineType, datasources)}
-${await buildInlineSchema(engineType, schemaPath)}
-${buildInlineEnv(engineType, datasources, envPaths)}
-${buildWarnEnvConflicts(engineType, runtimeDir, runtimeName)}
+${buildInlineDatasource(dataProxy, datasources)}
+${await buildInlineSchema(dataProxy, schemaPath)}
+${buildInlineEnv(dataProxy, datasources, envPaths)}
+${buildWarnEnvConflicts(dataProxy, runtimeDir, runtimeName)}
 const PrismaClient = getPrismaClient(config)
 exports.PrismaClient = PrismaClient
 Object.assign(exports, Prisma)
-${buildNFTAnnotations(engineType, platforms, relativeOutdir)}
+${buildNFTAnnotations(dataProxy, engineType, platforms, relativeOutdir)}
 `
     return code
   }

packages/client/src/generation/generateClient.ts

@@ -48,6 +48,7 @@ export interface GenerateClientOptions {
   engineVersion: string
   clientVersion: string
   activeProvider: string
+  dataProxy: boolean
 }
 
 export interface BuildClientResult {
@@ -57,7 +58,6 @@ export interface BuildClientResult {
 
 // eslint-disable-next-line @typescript-eslint/require-await
 export async function buildClient({
-  datamodel,
   schemaDir = process.cwd(),
   runtimeDir = '@prisma/client/runtime',
   runtimeName = 'index',
@@ -70,6 +70,7 @@ export async function buildClient({
   clientVersion,
   projectRoot,
   activeProvider,
+  dataProxy,
 }: GenerateClientOptions): Promise<BuildClientResult> {
   const document = getPrismaClientDMMF(dmmf)
   const clientEngineType = getClientEngineType(generator!)
@@ -90,6 +91,7 @@ export async function buildClient({
     engineVersion,
     projectRoot: projectRoot!,
     activeProvider,
+    dataProxy,
   })
 
   const fileMap = {
@@ -146,14 +148,15 @@ export async function generateClient({
   clientVersion,
   engineVersion,
   activeProvider,
+  dataProxy,
 }: GenerateClientOptions): Promise<void> {
   const useDotPrisma = testMode ? !runtimeDir : !generator?.isCustomOutput
   const clientEngineType = getClientEngineType(generator!)
   runtimeDir = runtimeDir || (useDotPrisma ? '@prisma/client/runtime' : './runtime')
 
   // we make sure that we point to the right engine build
-  if (clientEngineType === ClientEngineType.DataProxy) {
-    runtimeName = 'proxy'
+  if (dataProxy === true) {
+    runtimeName = 'proxy' // TODO: decouple the runtimes
   }
 
   const finalOutputDir = useDotPrisma ? await getDotPrismaDir(outputDir) : outputDir
@@ -177,6 +180,7 @@ export async function generateClient({
     engineVersion,
     projectRoot,
     activeProvider,
+    dataProxy,
   })
 
   const denylistsErrors = validateDmmfAgainstDenylists(prismaClientDmmf)
@@ -238,7 +242,8 @@ export async function generateClient({
       }\` in the \`binaryPaths\` object.`,
     )
   }
-  if (transpile) {
+
+  if (transpile === true && dataProxy === false) {
     if (process.env.NETLIFY) {
       await makeDir('/tmp/prisma-engines')
     }

packages/client/src/generation/generator.ts

@@ -51,6 +51,7 @@ if (process.argv[1] === __filename) {
         clientVersion,
         transpile: true,
         activeProvider: options.datasources[0]?.activeProvider,
+        dataProxy: options.dataProxy,
       })
     },
   })

packages/client/src/generation/utils/buildDMMF.ts

@@ -1,4 +1,3 @@
-import { ClientEngineType } from '@prisma/sdk'
 import lzString from 'lz-string'
 
 /**
@@ -8,8 +7,8 @@ import lzString from 'lz-string'
  * @param dmmf
  * @returns
  */
-export function buildDMMF(engineType: ClientEngineType, dmmf: string) {
-  if (engineType === ClientEngineType.DataProxy) {
+export function buildDMMF(dataProxy: boolean, dmmf: string) {
+  if (dataProxy === true) {
     return buildCompressedDMMF(dmmf)
   }
 

packages/client/src/generation/utils/buildDirname.ts

@@ -1,15 +1,14 @@
-import { ClientEngineType } from '@prisma/sdk'
 import path from 'path'
 
 /**
  * Builds a `dirname` variable that holds the location of the generated client.
- * @param clientEngineType
+ * @param dataProxy
  * @param relativeOutdir
  * @param runtimeDir
  * @returns
  */
-export function buildDirname(clientEngineType: ClientEngineType, relativeOutdir: string, runtimeDir: string) {
-  if (clientEngineType !== ClientEngineType.DataProxy) {
+export function buildDirname(dataProxy: boolean, relativeOutdir: string, runtimeDir: string) {
+  if (dataProxy === false) {
     return buildDirnameFind(relativeOutdir, runtimeDir)
   }
 

packages/client/src/generation/utils/buildInlineDatasources.ts

@@ -1,5 +1,3 @@
-import { ClientEngineType } from '@prisma/sdk'
-
 import type { InternalDatasource } from '../../runtime/utils/printDatasources'
 
 // that is all we need for the data proxy
@@ -16,8 +14,8 @@ export type InlineDatasources = {
  * @param internalDatasources
  * @returns
  */
-export function buildInlineDatasource(engineType: ClientEngineType, internalDatasources: InternalDatasource[]) {
-  if (engineType === ClientEngineType.DataProxy) {
+export function buildInlineDatasource(dataProxy: boolean, internalDatasources: InternalDatasource[]) {
+  if (dataProxy === true) {
     const datasources = internalToInlineDatasources(internalDatasources)
 
     return `