feat(sdk): improved error reporting by adding detail to getConfig and getDmmf error

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

@@ -348,7 +348,8 @@ describe('dmmf', () => {
       await getDMMF({ datamodel })
     } catch (e) {
       expect(stripAnsi(e.message)).toMatchInlineSnapshot(`
-        Get DMMF: Schema parsing
+        Get DMMF: Schema parsing - Error while interacting with query-engine-node-api library
+        Error code: P1012
         error: Error validating: You defined the enum \`PostKind\`. But the current connector does not support enums.
           -->  schema.prisma:14
            | 

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

@@ -117,7 +117,8 @@ describe('generator', () => {
       })
     } catch (e) {
       expect(stripAnsi(e.message)).toMatchInlineSnapshot(`
-        Get DMMF: Schema parsing
+        Get DMMF: Schema parsing - Error while interacting with query-engine-node-api library
+        Error code: P1012
         error: Error validating model "public": The model name \`public\` is invalid. It is a reserved name. Please change it. Read more at https://pris.ly/d/naming-models
           -->  schema.prisma:10
            | 

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

@@ -1,6 +1,9 @@
 import { formatTable } from '../utils/formatTable'
 import { version } from '../utils/getVersion'
 
+/**
+ * Adds `Prisma CLI Version : x.x.x` at the bottom of the error output.
+ */
 export function addVersionDetailsToErrorMessage(message: string) {
   const rows = [['Prisma CLI Version', version]]
   return `${message}

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

@@ -37,9 +37,44 @@ export type GetConfigOptions = {
   retry?: number
   ignoreEnvVarErrors?: boolean
 }
+
+type GetConfigErrorInit = {
+  // e.g., `Schema parsing - Error while interacting with query-engine-node-api library`
+  reason: string
+
+  // e.g., Error validating model "public": The model name \`public\` is invalid.
+  message: string
+} & (
+  | {
+      readonly _tag: 'parsed'
+
+      // e.g., `P1012`
+      errorCode?: string
+    }
+  | {
+      readonly _tag: 'unparsed'
+    }
+)
+
 export class GetConfigError extends Error {
-  constructor(message: string, public readonly _error?: Error) {
-    super(addVersionDetailsToErrorMessage(`${chalk.redBright.bold('Get config: ')}${message}`))
+  constructor(params: GetConfigErrorInit) {
+    const headline = chalk.redBright.bold('Get Config: ')
+
+    const constructedErrorMessage = match(params)
+      .with({ _tag: 'parsed' }, ({ errorCode, message, reason }) => {
+        const errorCodeMessage = errorCode ? `Error code: ${errorCode}` : ''
+        return `${reason}
+${errorCodeMessage}
+${message}`
+      })
+      .with({ _tag: 'unparsed' }, ({ message, reason }) => {
+        const detailsHeader = chalk.red.bold('Details:')
+        return `${reason}
+${detailsHeader}${message}`
+      })
+      .exhaustive()
+
+    super(addVersionDetailsToErrorMessage(`${headline}${constructedErrorMessage}`))
   }
 }
 
@@ -67,7 +102,7 @@ async function getConfigNodeAPI(options: GetConfigOptions) {
   if (E.isLeft(preliminaryEither)) {
     const { left: e } = preliminaryEither
     debugErrorType(e)
-    throw new GetConfigError(e.reason, e.error)
+    throw new GetConfigError({ _tag: 'unparsed', message: e.error.message, reason: e.reason })
   }
   const { queryEnginePath } = preliminaryEither.right
   debug(`Using CLI Query Engine (Node-API Library) at: ${queryEnginePath}`)
@@ -129,7 +164,7 @@ async function getConfigNodeAPI(options: GetConfigOptions) {
           () => JSON.parse(errorOutput),
           () => {
             debug(`Coudln't apply JSON.parse to "${errorOutput}"`)
-            return new GetConfigError(errorOutput, e.error)
+            return new GetConfigError({ _tag: 'unparsed', message: errorOutput, reason: e.reason })
           },
         ),
         E.map((errorOutputAsJSON: Record<string, string>) => {
@@ -153,7 +188,10 @@ async function getConfigNodeAPI(options: GetConfigOptions) {
             .otherwise((error: any) => {
               return chalk.redBright(`${error.error_code}\n\n`) + error
             })
-          return new GetConfigError(message, e.error)
+
+          const { error_code: errorCode } = errorOutputAsJSON as { error_code: string | undefined }
+
+          return new GetConfigError({ _tag: 'parsed', message, reason: e.reason, errorCode })
         }),
         E.getOrElseW(identity),
       )
@@ -162,7 +200,7 @@ async function getConfigNodeAPI(options: GetConfigOptions) {
     })
     .otherwise((e) => {
       debugErrorType(e)
-      return new GetConfigError(e.reason, e.error)
+      return new GetConfigError({ _tag: 'unparsed', message: e.error.message, reason: e.reason })
     })
 
   throw error
@@ -179,7 +217,7 @@ async function getConfigBinary(options: GetConfigOptions) {
   if (E.isLeft(preliminaryEither)) {
     const { left: e } = preliminaryEither
     debugErrorType(e)
-    throw new GetConfigError(e.reason, e.error)
+    throw new GetConfigError({ _tag: 'unparsed', message: e.error.message, reason: e.reason })
   }
   const { queryEnginePath, tempDatamodelPath } = preliminaryEither.right
   debug(`Using CLI Query Engine (Binary) at: ${queryEnginePath}`)
@@ -287,31 +325,39 @@ async function getConfigBinary(options: GetConfigOptions) {
           () => JSON.parse(errorOutput),
           () => {
             debug(`Coudln't apply JSON.parse to "${errorOutput}"`)
-            return new GetConfigError(errorOutput, e.error)
+            return new GetConfigError({ _tag: 'unparsed', message: errorOutput, reason: e.reason })
           },
         ),
         E.map((errorOutputAsJSON: Record<string, string>) => {
           const defaultMessage = `${chalk.redBright(errorOutputAsJSON.message)}\n`
-          const message = match(errorOutputAsJSON)
-            .with({ error_code: 'P1012' }, (error) => {
-              return chalk.redBright(`Schema Parsing ${error.error_code}\n\n`) + defaultMessage
+          const getConfigErrorInit = match(errorOutputAsJSON)
+            .with({ error_code: 'P1012' }, (eJSON) => {
+              return {
+                reason: `${chalk.redBright.bold('Schema parsing')} - ${e.reason}`,
+                errorCode: eJSON.error_code,
+              }
             })
-            .with({ error_code: P.string }, (error) => {
-              return chalk.redBright(`${error.error_code}\n\n`) + defaultMessage
+            .with({ error_code: P.string }, (eJSON) => {
+              return {
+                reason: e.reason,
+                errorCode: eJSON.error_code,
+              }
             })
             .otherwise(() => {
-              return defaultMessage
+              return {
+                reason: e.reason,
+              }
             })
 
-          return new GetConfigError(message, e.error)
+          return new GetConfigError({ _tag: 'parsed', message: defaultMessage, ...getConfigErrorInit })
         }),
         E.getOrElse(identity),
       )
       return actualError
     })
     .otherwise((e) => {
       debugErrorType(e)
-      return new GetConfigError(e.reason, e.error)
+      return new GetConfigError({ _tag: 'unparsed', message: e.error.message, reason: e.reason })
     })
 
   throw error

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

@@ -39,9 +39,43 @@ export type GetDMMFOptions = {
   previewFeatures?: string[]
 }
 
+type GetDmmfErrorInit = {
+  // e.g., `Schema parsing - Error while interacting with query-engine-node-api library`
+  reason: string
+
+  // e.g., Error validating model "public": The model name \`public\` is invalid.
+  message: string
+} & (
+  | {
+      readonly _tag: 'parsed'
+
+      // e.g., `P1012`
+      errorCode?: string
+    }
+  | {
+      readonly _tag: 'unparsed'
+    }
+)
+
 export class GetDmmfError extends Error {
-  constructor(message: string, public readonly _error?: Error) {
-    super(addVersionDetailsToErrorMessage(`${chalk.redBright.bold('Get DMMF: ')}${message}`))
+  constructor(params: GetDmmfErrorInit) {
+    const headline = chalk.redBright.bold('Get DMMF: ')
+
+    const constructedErrorMessage = match(params)
+      .with({ _tag: 'parsed' }, ({ errorCode, message, reason }) => {
+        const errorCodeMessage = errorCode ? `Error code: ${errorCode}` : ''
+        return `${reason}
+${errorCodeMessage}
+${message}`
+      })
+      .with({ _tag: 'unparsed' }, ({ message, reason }) => {
+        const detailsHeader = chalk.red.bold('Details:')
+        return `${reason}
+${detailsHeader}${message}`
+      })
+      .exhaustive()
+
+    super(addVersionDetailsToErrorMessage(`${headline}${constructedErrorMessage}`))
   }
 }
 
@@ -73,7 +107,7 @@ async function getDmmfNodeAPI(options: GetDMMFOptions) {
   if (E.isLeft(preliminaryEither)) {
     const { left: e } = preliminaryEither
     debugErrorType(e)
-    throw new GetDmmfError(e.reason, e.error)
+    throw new GetDmmfError({ _tag: 'unparsed', message: e.error.message, reason: e.reason })
   }
   const { queryEnginePath } = preliminaryEither.right
   debug(`Using CLI Query Engine (Node-API Library) at: ${queryEnginePath}`)
@@ -170,7 +204,7 @@ async function getDmmfNodeAPI(options: GetDMMFOptions) {
           () => JSON.parse(errorOutput),
           () => {
             debug(`Coudln't apply JSON.parse to "${errorOutput}"`)
-            return new GetDmmfError(errorOutput, e.error)
+            return new GetDmmfError({ _tag: 'unparsed', message: errorOutput, reason: e.reason })
           },
         ),
         E.map((errorOutputAsJSON: Record<string, string>) => {
@@ -188,7 +222,14 @@ async function getDmmfNodeAPI(options: GetDMMFOptions) {
           }
 
           const defaultMessage = addMissingOpenSSLInfo(errorOutputAsJSON.message)
-          return new GetDmmfError(chalk.redBright.bold('Schema parsing\n') + defaultMessage, e.error)
+          const { error_code: errorCode } = errorOutputAsJSON as { error_code: string | undefined }
+
+          return new GetDmmfError({
+            _tag: 'parsed',
+            message: defaultMessage,
+            reason: `${chalk.redBright.bold('Schema parsing')} - ${e.reason}`,
+            errorCode,
+          })
         }),
         E.getOrElseW(identity),
       )
@@ -197,7 +238,7 @@ async function getDmmfNodeAPI(options: GetDMMFOptions) {
     })
     .otherwise((e) => {
       debugErrorType(e)
-      return new GetDmmfError(e.reason, e.error)
+      return new GetDmmfError({ _tag: 'unparsed', message: e.error.message, reason: e.reason })
     })
 
   throw error
@@ -214,7 +255,7 @@ async function getDmmfBinary(options: GetDMMFOptions): Promise<DMMF.Document> {
   if (E.isLeft(preliminaryEither)) {
     const { left: e } = preliminaryEither
     debugErrorType(e)
-    throw new GetDmmfError(e.reason, e.error)
+    throw new GetDmmfError({ _tag: 'unparsed', message: e.error.message, reason: e.reason })
   }
   const { queryEnginePath, tempDatamodelPath } = preliminaryEither.right
   debug(`Using CLI Query Engine (Binary) at: ${queryEnginePath}`)
@@ -363,13 +404,18 @@ async function getDmmfBinary(options: GetDMMFOptions): Promise<DMMF.Document> {
           () => JSON.parse(errorOutput),
           () => {
             debug(`Coudln't apply JSON.parse to "${errorOutput}"`)
-            return new GetDmmfError(errorOutput, e.error)
+            return new GetDmmfError({ _tag: 'unparsed', message: errorOutput, reason: e.reason })
           },
         ),
         E.map((errorOutputAsJSON: Record<string, string>) => {
-          const defaultMessage = `${chalk.redBright(errorOutputAsJSON.message)}`
-          const message = addMissingOpenSSLInfo(defaultMessage)
-          return new GetDmmfError(chalk.redBright.bold('Schema parsing\n') + message, e.error)
+          const defaultMessage = addMissingOpenSSLInfo(`${chalk.redBright(errorOutputAsJSON.message)}`)
+          const { error_code: errorCode } = errorOutputAsJSON as { error_code: string | undefined }
+          return new GetDmmfError({
+            _tag: 'parsed',
+            message: defaultMessage,
+            reason: `${chalk.redBright.bold('Schema parsing')} - ${e.reason}`,
+            errorCode,
+          })
         }),
         E.getOrElse(identity),
       )
@@ -379,7 +425,11 @@ async function getDmmfBinary(options: GetDMMFOptions): Promise<DMMF.Document> {
     .with({ type: 'parse-json' }, (e) => {
       debugErrorType(e)
       const message = `Problem while parsing the query engine response at ${queryEnginePath}. ${e.result.stdout}\n${e.error?.stack}`
-      const error = new GetDmmfError(chalk.redBright.bold('JSON parsing\n') + message, e.error)
+      const error = new GetDmmfError({
+        _tag: 'unparsed',
+        message: message,
+        reason: `${chalk.redBright.bold('JSON parsing')} - ${e.reason}\n`,
+      })
       return E.right(error)
     })
     .with({ type: 'retry' }, (e) => {

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

@@ -6,6 +6,7 @@ import { pipe } from 'fp-ts/lib/function'
 import * as TE from 'fp-ts/TaskEither'
 import fs from 'fs'
 import tmpWrite from 'temp-write'
+import { match } from 'ts-pattern'
 
 import { resolveBinary } from '../resolveBinary'
 import { load } from '../utils/load'
@@ -75,11 +76,24 @@ export function loadNodeAPILibrary(queryEnginePath: string) {
   return pipe(
     E.tryCatch(
       () => load<NodeAPILibraryTypes.Library>(queryEnginePath),
-      (e) => ({
-        type: 'connection-error' as const,
-        reason: 'Unable to establish a connection to query-engine-node-api library',
-        error: e as Error,
-      }),
+      (e) => {
+        const error = e as Error
+        const defaultErrorMessage = `Unable to establish a connection to query-engine-node-api library.`
+        const proposedErrorFixMessage = match(error.message)
+          .when(
+            (errMessage) => errMessage.includes('openssl'),
+            () => {
+              return ` Have you tried installing 'openssl'?`
+            },
+          )
+          .otherwise(() => '')
+        const reason = `${defaultErrorMessage}${proposedErrorFixMessage}`
+        return {
+          type: 'connection-error' as const,
+          reason,
+          error,
+        }
+      },
     ),
     TE.fromEither,
     TE.map((NodeAPIQueryEngineLibrary) => ({ NodeAPIQueryEngineLibrary })),