chore: add prisma generate errors and plugin options to telemetry (#491)

Author: ymc9

packages/schema/package.json

@@ -75,7 +75,7 @@
         "lint": "eslint src tests --ext ts",
         "test": "jest",
         "prepublishOnly": "pnpm build",
-        "publish-dev": "pnpm publish --tag dev",
+        "publish-dev": "pnpm publish --registry http://localhost:4873",
         "postinstall": "node bin/post-install.js"
     },
     "peerDependencies": {
@@ -101,6 +101,7 @@
         "promisify": "^0.0.3",
         "semver": "^7.3.8",
         "sleep-promise": "^9.1.0",
+        "strip-color": "^0.1.0",
         "ts-morph": "^16.0.0",
         "upper-case-first": "^2.0.2",
         "uuid": "^9.0.0",
@@ -119,6 +120,7 @@
         "@types/node": "^14.18.32",
         "@types/pluralize": "^0.0.29",
         "@types/semver": "^7.3.13",
+        "@types/strip-color": "^0.1.0",
         "@types/tmp": "^0.2.3",
         "@types/upper-case-first": "^1.1.2",
         "@types/uuid": "^8.3.4",

packages/schema/src/cli/plugin-runner.ts

@@ -136,6 +136,7 @@ export class PluginRunner {
                 'cli:plugin:error',
                 {
                     plugin: name,
+                    options,
                 },
                 async () => {
                     let result = run(context.schema, options, dmmf, config);

packages/schema/src/plugins/prisma/schema-generator.ts

@@ -1,3 +1,4 @@
+import { getDMMF } from '@prisma/internals';
 import {
     ArrayExpr,
     AstNode,
@@ -35,8 +36,10 @@ import {
 import fs from 'fs';
 import { writeFile } from 'fs/promises';
 import path from 'path';
+import stripColor from 'strip-color';
 import { name } from '.';
 import { getStringLiteral } from '../../language-server/validator/utils';
+import telemetry from '../../telemetry';
 import { execSync } from '../../utils/exec-utils';
 import {
     ModelFieldType,
@@ -76,6 +79,7 @@ export default class PrismaSchemaGenerator {
 
     async generate(model: Model, options: PluginOptions, config?: Record<string, string>) {
         const prisma = new PrismaModel();
+        const warnings: string[] = [];
 
         for (const decl of model.declarations) {
             switch (decl.$type) {
@@ -106,15 +110,37 @@ export default class PrismaSchemaGenerator {
         await writeFile(outFile, this.PRELUDE + prisma.toString());
 
         if (options.format === true) {
-            // run 'prisma format'
-            await execSync(`npx prisma format --schema ${outFile}`);
+            try {
+                // run 'prisma format'
+                await execSync(`npx prisma format --schema ${outFile}`);
+            } catch {
+                warnings.push(`Failed to format Prisma schema file`);
+            }
         }
 
         const generateClient = options.generateClient !== false;
 
         if (generateClient) {
-            // run 'prisma generate'
-            await execSync(`npx prisma generate --schema ${outFile}`);
+            try {
+                // run 'prisma generate'
+                await execSync(`npx prisma generate --schema ${outFile}`);
+            } catch {
+                await this.trackPrismaSchemaError(outFile);
+                throw new PluginError(name, `Failed to run "prisma generate"`);
+            }
+        }
+
+        return warnings;
+    }
+
+    private async trackPrismaSchemaError(schema: string) {
+        try {
+            await getDMMF({ datamodel: fs.readFileSync(schema, 'utf-8') });
+        } catch (err) {
+            if (err instanceof Error) {
+                // eslint-disable-next-line @typescript-eslint/no-var-requires
+                telemetry.track('prisma:error', { command: 'generate', message: stripColor(err.message) });
+            }
         }
     }
 

packages/schema/src/telemetry.ts

@@ -22,7 +22,8 @@ export type TelemetryEvents =
     | 'cli:command:error'
     | 'cli:plugin:start'
     | 'cli:plugin:complete'
-    | 'cli:plugin:error';
+    | 'cli:plugin:error'
+    | 'prisma:error';
 
 /**
  * Utility class for sending telemetry