fix(client): improve error links (#4753)

src/docker/docker-compose.yml

@@ -46,7 +46,7 @@ services:
     command: --default-authentication-plugin=mysql_native_password
     restart: always
     environment:
-      - MYSQL_ROOT_PASSWORD=my-root-pw
+      - MYSQL_ROOT_PASSWORD=root
       - MYSQL_DATABASE=tests
       - MYSQL_USER=prisma
       - MYSQL_PASSWORD=prisma

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

@@ -48,5 +48,5 @@ describe('version', () => {
 })
 
 function cleanSnapshot(str: string): string {
-  return str.replaceAll(/\(at .*/g, '')
+  return str.replace(/\(at .*/g, '')
 }

src/packages/client/src/__tests__/integration/errors/error-link/test.ts

@@ -22,6 +22,8 @@ test('error-link', async () => {
           TEST_GITHUB_LINK
 
           If you want the Prisma team to look into it, please open the link above 🙏
+          To increase the chance of success, please post your schema and a snippet of
+          how you used Prisma Client in the issue. 
 
         `)
 

src/packages/client/src/__tests__/integration/errors/missing-relation/test.ts

@@ -28,8 +28,34 @@ test('missing-relation', async () => {
           TEST_GITHUB_LINK
 
           If you want the Prisma team to look into it, please open the link above 🙏
+          To increase the chance of success, please post your schema and a snippet of
+          how you used Prisma Client in the issue. 
 
         `)
+  // try {
+  // } catch (e) {
+  //   expect(e).toMatchInlineSnapshot(`
+
+  //     Invalid \`prisma.post.findMany()\` invocation in
+  //     /client/src/__tests__/integration/errors/missing-relation/test.ts:9:23
+
+  //        6 const prisma = new PrismaClient()
+  //        7
+  //        8 try {
+  //     →  9   await prisma.post.findMany(
+  //       PANIC in query-engine/core/src/response_ir/internal.rs:348:26
+  //     Application logic invariant error: received null value for field author which may not be null
+
+  //     This is a non-recoverable error which probably happens when the Prisma Query Engine has a panic.
+
+  //     TEST_GITHUB_LINK
+
+  //     If you want the Prisma team to look into it, please open the link above 🙏
+  //     To increase the chance of success, please post your schema and a snippet of
+  //     how you used Prisma Client in the issue.
+
+  //   `)
+  // }
 
   prisma.$disconnect()
 })

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

@@ -31,6 +31,7 @@ export interface TSClientOptions {
   sqliteDatasourceOverrides?: DatasourceOverwrite[]
   schemaDir: string
   outputDir: string
+  activeProvider: string
 }
 
 export class TSClient implements Generatable {
@@ -65,6 +66,7 @@ export class TSClient implements Generatable {
       clientVersion: this.options.clientVersion,
       engineVersion: this.options.engineVersion,
       datasourceNames: this.options.datasources.map((d) => d.name),
+      activeProvider: this.options.activeProvider,
     }
     // used for the __dirname polyfill needed for Next.js
     const cwdDirname = path.relative(this.options.projectRoot, outputDir)

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

@@ -51,6 +51,7 @@ export interface GenerateClientOptions {
   copyRuntime?: boolean
   engineVersion: string
   clientVersion: string
+  activeProvider: string
 }
 
 export interface BuildClientResult {
@@ -72,6 +73,7 @@ export async function buildClient({
   engineVersion,
   clientVersion,
   projectRoot,
+  activeProvider,
 }: GenerateClientOptions): Promise<BuildClientResult> {
   const document = getPrismaClientDMMF(dmmf)
 
@@ -92,6 +94,7 @@ export async function buildClient({
     clientVersion,
     engineVersion,
     projectRoot: projectRoot!,
+    activeProvider,
   })
 
   const fileMap = {
@@ -143,6 +146,7 @@ export async function generateClient({
   copyRuntime,
   clientVersion,
   engineVersion,
+  activeProvider,
 }: GenerateClientOptions): Promise<BuildClientResult | undefined> {
   const useDotPrisma = testMode ? !runtimePath : !generator?.isCustomOutput
 
@@ -171,6 +175,7 @@ export async function generateClient({
     clientVersion,
     engineVersion,
     projectRoot,
+    activeProvider,
   })
 
   const denylistsErrors = validateDmmfAgainstDenylists(prismaClientDmmf)

src/packages/client/src/generator.ts

@@ -39,6 +39,7 @@ generatorHandler({
       engineVersion: options.version,
       clientVersion,
       transpile: true,
+      activeProvider: options.datasources[0].activeProvider,
     })
   },
 })

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

@@ -209,6 +209,7 @@ export interface GetPrismaClientOptions {
   clientVersion?: string
   engineVersion?: string
   datasourceNames: string[]
+  activeProvider: string
 }
 
 export type Action =
@@ -372,7 +373,8 @@ export function getPrismaClient(config: GetPrismaClientOptions): any {
           flags: [],
           clientVersion: config.clientVersion,
           enableExperimental: mapPreviewFeatures(this._previewFeatures),
-          useUds: internal.useUds
+          useUds: internal.useUds,
+          activeProvider: config.activeProvider,
         }
 
         debug({ clientVersion: config.clientVersion })

src/packages/client/src/utils/generateInFolder.ts

@@ -119,6 +119,7 @@ export async function generateInFolder({
     generator: config.generators[0],
     clientVersion: 'local',
     engineVersion: 'local',
+    activeProvider: 'sqlite',
   })
 
   const time = performance.now() - before

src/packages/client/src/utils/getTestClient.ts

@@ -63,6 +63,7 @@ export async function getTestClient(
       schemaDir,
       outputDir,
     ),
+    activeProvider: config.datasources[0].activeProvider,
   }
 
   return getPrismaClient(options)

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

@@ -7,6 +7,8 @@ import {
 import { getLogs } from '@prisma/debug'
 import { getGithubIssueUrl, link } from './util'
 import stripAnsi from 'strip-ansi'
+import { ConnectorType } from '@prisma/generator-helper'
+import { maskQuery } from './maskQuery'
 
 export interface RequestError {
   error: string
@@ -82,7 +84,7 @@ export class PrismaClientRustError extends Error {
   constructor({ clientVersion, log, error }: PrismaClientRustErrorArgs) {
     if (log) {
       const backtrace = getBacktraceFromLog(log)
-      super(backtrace)
+      super(backtrace ?? 'Unkown error')
     } else if (error) {
       const backtrace = getBacktraceFromRustError(error)
       super(backtrace)
@@ -113,6 +115,9 @@ export class PrismaClientInitializationError extends Error {
 
 export interface ErrorWithLinkInput {
   version: string
+  engineVersion?: string
+  database?: ConnectorType
+  query: string
   platform?: string
   title: string
   description?: string
@@ -123,8 +128,11 @@ export function getErrorMessageWithLink({
   platform,
   title,
   description,
+  engineVersion,
+  database,
+  query,
 }: ErrorWithLinkInput) {
-  const gotLogs = getLogs()
+  const gotLogs = getLogs(6000 - query.length)
   const logs = normalizeLogs(stripAnsi(gotLogs))
   const moreInfo = description
     ? `# Description\n\`\`\`\n${description}\n\`\`\``
@@ -138,13 +146,31 @@ export function getErrorMessageWithLink({
 | Node            | ${process.version?.padEnd(19)}| 
 | OS              | ${platform?.padEnd(19)}|
 | Prisma Client   | ${version?.padEnd(19)}|
+| Query Engine    | ${engineVersion?.padEnd(19)}|
+| Database        | ${database?.padEnd(19)}|
 
 ${moreInfo}
 
+## Query
+\`\`\`
+${query ? maskQuery(query) : ''}
+\`\`\`
+
 ## Logs
 \`\`\`
 ${logs}
-\`\`\``,
+\`\`\`
+
+## Client Snippet
+\`\`\`ts
+// PLEASE FILL YOUR CODE SNIPPET HERE
+\`\`\`
+
+## Schema
+\`\`\`prisma
+// PLEASE ADD YOUR SCHEMA HERE IF POSSIBLE
+\`\`\`
+`,
   )
 
   const url = getGithubIssueUrl({ title, body })
@@ -155,6 +181,8 @@ This is a non-recoverable error which probably happens when the Prisma Query Eng
 ${link(url)}
 
 If you want the Prisma team to look into it, please open the link above 🙏
+To increase the chance of success, please post your schema and a snippet of
+how you used Prisma Client in the issue. 
 `
 }