refactor(*): Polish Node-API library implementation (#7898)

Co-authored-by: Joël Galeran <Jolg42@users.noreply.github.com>
Co-authored-by: Pierre-Antoine Mills <pierreantoine.urvoy@gmail.com>

src/packages/cli/src/Version.ts

@@ -84,7 +84,7 @@ export class Version implements Command {
       ['@prisma/client', prismaClientVersion ?? 'Not found'],
       ['Current platform', platform],
       [
-        `${useNAPI ? 'N-API ' : ''}Query Engine`,
+        `Query Engine${useNAPI ? ' (Node-API)' : ''}`,
         this.printBinaryInfo(queryEngine),
       ],
       ['Migration Engine', this.printBinaryInfo(migrationEngine)],

src/packages/cli/src/__tests__/__snapshots__/version.test.ts.snap

@@ -1,15 +1,15 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`version basic version (N-API) 1`] = `
-prisma               : placeholder
-@prisma/client       : placeholder
-Current platform     : placeholder
-N-API Query Engine   : placeholder
-Migration Engine     : placeholder
-Introspection Engine : placeholder
-Format Binary        : placeholder
-Default Engines Hash : placeholder
-Studio               : placeholder
+prisma                  : placeholder
+@prisma/client          : placeholder
+Current platform        : placeholder
+Query Engine (Node-API) : placeholder
+Migration Engine        : placeholder
+Introspection Engine    : placeholder
+Format Binary           : placeholder
+Default Engines Hash    : placeholder
+Studio                  : placeholder
 `;
 
 exports[`version basic version 1`] = `
@@ -25,15 +25,15 @@ Studio               : placeholder
 `;
 
 exports[`version version with custom binaries (N-API) 1`] = `
-prisma               : placeholder
-@prisma/client       : placeholder
-Current platform     : placeholder
-N-API Query Engine   : placeholder
-Migration Engine     : placeholder
-Introspection Engine : placeholder
-Format Binary        : placeholder
-Default Engines Hash : placeholder
-Studio               : placeholder
+prisma                  : placeholder
+@prisma/client          : placeholder
+Current platform        : placeholder
+Query Engine (Node-API) : placeholder
+Migration Engine        : placeholder
+Introspection Engine    : placeholder
+Format Binary           : placeholder
+Default Engines Hash    : placeholder
+Studio                  : placeholder
 `;
 
 exports[`version version with custom binaries 1`] = `

src/packages/client/src/__tests__/nodeEngine.test.ts → src/packages/client/src/__tests__/binaryEngine.test.ts

@@ -1,7 +1,7 @@
-import { NodeEngine } from '@prisma/engine-core/dist/NodeEngine'
+import { BinaryEngine } from '@prisma/engine-core/dist/BinaryEngine'
 import path from 'path'
 
-describe('NodeEngine', () => {
+describe('BinaryEngine', () => {
   test('should error correctly with invalid flags', async () => {
 
     // Skip for Node-API library
@@ -11,7 +11,7 @@ describe('NodeEngine', () => {
     }
 
     try {
-      const engine = new NodeEngine({
+      const engine = new BinaryEngine({
         flags: ['--flag-that-does-not-exist'],
         datamodelPath: path.join(
           __dirname,

src/packages/client/src/generation/generateClient.ts

@@ -12,6 +12,7 @@ import makeDir from 'make-dir'
 import path from 'path'
 import pkgUp from 'pkg-up'
 import { promisify } from 'util'
+import { BinaryType } from '@prisma/fetch-engine'
 import { DMMF as PrismaClientDMMF } from '../runtime/dmmf-types'
 import { Dictionary } from '../runtime/utils/common'
 import { resolveDatasources } from '../utils/resolveDatasources'
@@ -279,11 +280,13 @@ export async function generateClient({
         await copyFile(filePath, target)
         continue
       }
-
+      const binaryName = useNAPI
+        ? BinaryType.libqueryEngineNapi
+        : BinaryType.queryEngine
       // They must have an equal size now, let's check for the hash
       const [sourceVersion, targetVersion] = await Promise.all([
-        getVersion(filePath).catch(() => null),
-        getVersion(target).catch(() => null),
+        getVersion(filePath, binaryName).catch(() => null),
+        getVersion(target, binaryName).catch(() => null),
       ])
 
       if (sourceVersion && targetVersion && sourceVersion === targetVersion) {

src/packages/client/src/runtime/getPrismaClient.ts

@@ -5,8 +5,8 @@ import {
   EngineConfig,
   EngineEventType,
 } from '@prisma/engine-core/dist/Engine'
-import { NAPIEngine } from '@prisma/engine-core/dist/NAPIEngine'
-import { NodeEngine } from '@prisma/engine-core/dist/NodeEngine'
+import { LibraryEngine } from '@prisma/engine-core/dist/LibraryEngine'
+import { BinaryEngine } from '@prisma/engine-core/dist/BinaryEngine'
 import {
   DataSource,
   GeneratorConfig,
@@ -425,9 +425,9 @@ export function getPrismaClient(config: GetPrismaClientOptions): any {
         this._previewFeatures.includes('nApi') ||
         process.env.PRISMA_FORCE_NAPI === 'true'
       ) {
-        return new NAPIEngine(this._engineConfig)
+        return new LibraryEngine(this._engineConfig)
       } else {
-        return new NodeEngine(this._engineConfig)
+        return new BinaryEngine(this._engineConfig)
       }
     }
 

src/packages/engine-core/src/NodeEngine.ts → src/packages/engine-core/src/BinaryEngine.ts

@@ -67,13 +67,13 @@ export type StopDeferred = {
   reject: (err: Error) => void
 }
 
-const engines: NodeEngine[] = []
+const engines: BinaryEngine[] = []
 const socketPaths: string[] = []
 
 const MAX_STARTS = process.env.PRISMA_CLIENT_NO_RETRY ? 1 : 2
 const MAX_REQUEST_RETRIES = process.env.PRISMA_CLIENT_NO_RETRY ? 1 : 2
 
-export class NodeEngine implements Engine {
+export class BinaryEngine implements Engine {
   private logEmitter: EventEmitter
   private showColors: boolean
   private logQueries: boolean
@@ -351,7 +351,7 @@ You may have to run ${chalk.greenBright(
 
     this.platform = this.platform || platform
 
-    if (__filename.includes('NodeEngine')) {
+    if (__filename.includes('BinaryEngine')) {
       enginePath = this.getQueryEnginePath(this.platform, getEnginesPath())
       return { prismaPath: enginePath, searchedLocations }
     }

src/packages/engine-core/src/NAPIEngine.ts → src/packages/engine-core/src/LibraryEngine.ts

@@ -27,7 +27,7 @@ import {
 } from './errors'
 import {
   ConfigMetaFormat,
-  NAPI,
+  Library,
   QueryEngine,
   QueryEngineBatchRequest,
   QueryEngineConstructor,
@@ -39,7 +39,7 @@ import {
   QueryEngineRequestHeaders,
   RustRequestError,
   SyncRustError,
-} from './napi-types'
+} from './NodeAPILibraryTypes'
 import { printGeneratorConfig } from './printGeneratorConfig'
 import { fixBinaryTargets } from './util'
 
@@ -53,7 +53,7 @@ function isPanicEvent(event: QueryEngineEvent): event is QueryEnginePanicEvent {
 }
 
 const knownPlatforms: Platform[] = [...platforms, 'native']
-export class NAPIEngine implements Engine {
+export class LibraryEngine implements Engine {
   private engine?: QueryEngine
   private libraryInstantiationPromise?: Promise<void>
   private libraryStartingPromise?: Promise<void>
@@ -62,7 +62,7 @@ export class NAPIEngine implements Engine {
   private executingQueryPromise?: Promise<any>
   private config: EngineConfig
   private QueryEngineConstructor?: QueryEngineConstructor
-  private library?: NAPI
+  private library?: Library
   private logEmitter: EventEmitter
   libQueryEnginePath?: string
   platform?: Platform
@@ -170,7 +170,7 @@ You may have to run ${chalk.greenBright(
       if (!this.QueryEngineConstructor) {
         try {
           // this require needs to be resolved at runtime, tell webpack to ignore it
-          this.library = eval('require')(this.libQueryEnginePath) as NAPI
+          this.library = eval('require')(this.libQueryEnginePath) as Library
           this.QueryEngineConstructor = this.library.QueryEngine
         } catch (e) {
           if (fs.existsSync(this.libQueryEnginePath)) {
@@ -365,7 +365,7 @@ You may have to run ${chalk.greenBright(
     return this.libraryStoppingPromise
   }
 
-  async getConfig(): Promise<ConfigMetaFormat> {
+  getConfig(): Promise<ConfigMetaFormat> {
     return this.library!.getConfig({
       datamodel: this.datamodel,
       datasourceOverrides: this.datasourceOverrides,
@@ -511,7 +511,7 @@ You may have to run ${chalk.greenBright(
 
     this.platform = this.platform ?? (await getPlatform())
 
-    if (__filename.includes('NAPIEngine')) {
+    if (__filename.includes('LibraryEngine')) {
       enginePath = path.join(getEnginesPath(), getNapiName(this.platform, 'fs'))
       return { enginePath, searchedLocations }
     }
@@ -648,7 +648,7 @@ Read more about deploying Prisma Client: https://pris.ly/d/client-generator`
   }
 }
 
-function hookProcess(engine: NAPIEngine, handler: string, exit = false) {
+function hookProcess(engine: LibraryEngine, handler: string, exit = false) {
   process.once(handler as any, async () => {
     debug(`hookProcess received: ${handler}`)
     await engine.runBeforeExit()
@@ -660,7 +660,7 @@ function hookProcess(engine: NAPIEngine, handler: string, exit = false) {
   })
 }
 
-function initHooks(engine: NAPIEngine) {
+function initHooks(engine: LibraryEngine) {
   hookProcess(engine, 'beforeExit')
   hookProcess(engine, 'exit')
   hookProcess(engine, 'SIGINT', true)

src/packages/engine-core/src/napi-types.ts → src/packages/engine-core/src/NodeAPILibraryTypes.ts

@@ -99,7 +99,7 @@ export type ConfigMetaFormat = {
   warnings: string[]
 }
 // Main
-export type NAPI = {
+export type Library = {
   QueryEngine: QueryEngineConstructor
   version: () => {
     commit: string

src/packages/engine-core/src/index.ts

@@ -5,11 +5,12 @@ export {
   PrismaClientUnknownRequestError,
 } from './errors'
 export { getInternalDatamodelJson } from './getInternalDatamodelJson'
-export { NAPIEngine } from './NAPIEngine'
-export { NodeEngine as Engine } from './NodeEngine'
+export { LibraryEngine } from './LibraryEngine'
+export { BinaryEngine } from './BinaryEngine'
+export { Engine } from './Engine'
 export {
   printGeneratorConfig,
   getOriginalBinaryTargetsValue,
 } from './printGeneratorConfig'
-export * as NApiEngineTypes from './napi-types'
+export * as NodeAPILibraryTypes from './NodeAPILibraryTypes'
 export { fixBinaryTargets } from './util'

src/packages/fetch-engine/src/download.ts

@@ -218,10 +218,11 @@ function getCollectiveBar(options: DownloadOptions): {
   finishBar: () => void
   setProgress: (sourcePath: string) => (progress: number) => void
 } {
+  const hasNodeAPI = 'libquery-engine' in options.binaries
   const bar = getBar(
-    `Downloading Prisma engines for ${options.binaryTargets
-      ?.map((p) => chalk.bold(p))
-      .join(' and ')}`,
+    `Downloading Prisma engines${
+      hasNodeAPI ? ' for Node-API' : ''
+    } for ${options.binaryTargets?.map((p) => chalk.bold(p)).join(' and ')}`,
   )
 
   const progressMap: { [key: string]: number } = {}

src/packages/sdk/src/engine-commands/getConfig.ts

@@ -1,5 +1,5 @@
 import Debug from '@prisma/debug'
-import { NApiEngineTypes } from '@prisma/engine-core'
+import { NodeAPILibraryTypes } from '@prisma/engine-core'
 import { BinaryType } from '@prisma/fetch-engine'
 import { DataSource, GeneratorConfig } from '@prisma/generator-helper'
 import chalk from 'chalk'
@@ -9,6 +9,7 @@ import tmpWrite from 'temp-write'
 import { promisify } from 'util'
 import { resolveBinary } from '../resolveBinary'
 import { isNodeAPISupported } from '@prisma/get-platform'
+import { load } from '../utils/load'
 
 const debug = Debug('prisma:getConfig')
 
@@ -75,7 +76,7 @@ async function getConfigNAPI(
   await isNodeAPISupported()
   debug(`Using N-API Query Engine at: ${queryEnginePath}`)
   try {
-    const NApiQueryEngine = require(queryEnginePath) as NApiEngineTypes.NAPI
+    const NApiQueryEngine = load<NodeAPILibraryTypes.Library>(queryEnginePath)
     data = await NApiQueryEngine.getConfig({
       datamodel: options.datamodel,
       datasourceOverrides: {},

src/packages/sdk/src/engine-commands/getDmmf.ts

@@ -1,5 +1,5 @@
 import Debug from '@prisma/debug'
-import { NApiEngineTypes } from '@prisma/engine-core'
+import { NodeAPILibraryTypes } from '@prisma/engine-core'
 import { BinaryType } from '@prisma/fetch-engine'
 import { DataSource, DMMF, GeneratorConfig } from '@prisma/generator-helper'
 import chalk from 'chalk'
@@ -9,6 +9,7 @@ import tmpWrite from 'temp-write'
 import { promisify } from 'util'
 import { resolveBinary } from '../resolveBinary'
 import { isNodeAPISupported } from '@prisma/get-platform'
+import { load } from '../utils/load'
 
 const debug = Debug('prisma:getDMMF')
 
@@ -53,7 +54,7 @@ async function getDmmfNapi(options: GetDMMFOptions): Promise<DMMF.Document> {
   await isNodeAPISupported()
 
   debug(`Using N-API Query Engine at: ${queryEnginePath}`)
-  const NApiQueryEngine = require(queryEnginePath) as NApiEngineTypes.NAPI
+  const NApiQueryEngine = load<NodeAPILibraryTypes.Library>(queryEnginePath)
   const datamodel =
     options.datamodel ?? fs.readFileSync(options.datamodelPath!, 'utf-8')
   let dmmf: DMMF.Document | undefined

src/packages/sdk/src/engine-commands/getVersion.ts

@@ -1,23 +1,31 @@
 import Debug from '@prisma/debug'
-import { NApiEngineTypes } from '@prisma/engine-core'
+import { NodeAPILibraryTypes } from '@prisma/engine-core'
 import { BinaryType } from '@prisma/fetch-engine'
 import { isNodeAPISupported } from '@prisma/get-platform'
 import execa from 'execa'
 import { resolveBinary } from '../resolveBinary'
+import { load } from '../utils/load'
 
 const debug = Debug('prisma:getVersion')
 
 const MAX_BUFFER = 1_000_000_000
 
 export async function getVersion(
   enginePath?: string,
-  binaryName: BinaryType = BinaryType.queryEngine,
+  binaryName?: BinaryType,
 ): Promise<string> {
+  const useNapi = process.env.PRISMA_FORCE_NAPI === 'true'
+
+  if (!binaryName) {
+    binaryName = useNapi
+      ? BinaryType.libqueryEngineNapi
+      : BinaryType.queryEngine
+  }
   enginePath = await resolveBinary(binaryName, enginePath)
   if (binaryName === BinaryType.libqueryEngineNapi) {
     await isNodeAPISupported()
 
-    const QE = require(enginePath) as NApiEngineTypes.NAPI
+    const QE = load<NodeAPILibraryTypes.Library>(enginePath)
     return `libquery-engine ${QE.version().commit}`
   } else {
     const result = await execa(enginePath, ['--version'], {

src/packages/sdk/src/index.ts

@@ -68,6 +68,7 @@ export {
   parseEnvValue,
 } from './utils/parseEnvValue'
 export { printConfigWarnings } from './utils/printConfigWarnings'
+export { load } from './utils/load'
 export {
   Position,
   trimBlocksFromSchema,

src/packages/sdk/src/utils/load.ts

@@ -0,0 +1,11 @@
+/** 
+ * This is a wrapper around `require` 
+ * This is to avoid eval and hide require away from bundlers
+ */
+export function load<T>(id: string): T {
+  try {
+    return require(id) as T
+  } catch (e) {
+    throw new Error(`Unable to require(\`${id}\`)\n ${e.message}`)
+  }
+}