fix: add crash report prompt

Author: mrlubos

.changeset/bright-rats-mix.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix: add crash report prompt

.changeset/twenty-numbers-talk.md

@@ -1,10 +1,9 @@
 ---
-'@hey-api/client-custom': minor
 '@hey-api/client-axios': minor
-'@hey-api/client-fetch': minor
 '@hey-api/client-core': minor
+'@hey-api/client-custom': minor
+'@hey-api/client-fetch': minor
 '@hey-api/client-next': minor
-'@hey-api/client-nuxt': minor
 ---
 
-feat: export buildClientParams function
+feat: export `buildClientParams` function

packages/openapi-ts-tests/test/openapi-ts.config.ts

@@ -51,7 +51,7 @@ export default defineConfig(() => {
       //   'invalid',
       //   'servers-entry.yaml',
       // ),
-      path: path.resolve(__dirname, 'spec', '3.1.x', 'sdk-instance.yaml'),
+      path: path.resolve(__dirname, 'spec', '3.0.x', 'bug.yaml'),
       // path: 'http://localhost:4000/',
       // path: 'https://get.heyapi.dev/',
       // path: 'https://get.heyapi.dev/hey-api/backend?branch=main&version=1.0.0',

packages/openapi-ts-tests/test/spec/3.0.x/bug.yaml

@@ -0,0 +1,17 @@
+openapi: 3.0.3
+info:
+  description: TODO
+  version: 1
+components:
+  schemas:
+    Foo:
+      type: object
+      properties:
+        foo:
+          type: string
+        bar:
+          type: object
+          properties:
+            baz:
+              type: boolean
+              readOnly: true

packages/openapi-ts/package.json

@@ -93,7 +93,8 @@
     "c12": "2.0.1",
     "color-support": "1.1.3",
     "commander": "13.0.0",
-    "handlebars": "4.7.8"
+    "handlebars": "4.7.8",
+    "open": "10.1.2"
   },
   "peerDependencies": {
     "typescript": "^5.5.3"

packages/openapi-ts/src/error.ts

@@ -0,0 +1,130 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+import colors from 'ansi-colors';
+
+import { ensureDirSync } from './generate/utils';
+
+export const isInteractive = process.stdin.isTTY && process.stdout.isTTY;
+
+export class HeyApiError extends Error {
+  args: ReadonlyArray<unknown>;
+  event: string;
+  pluginName: string;
+
+  constructor({
+    args,
+    error,
+    event,
+    name,
+    pluginName,
+  }: {
+    args: unknown[];
+    error: Error;
+    event: string;
+    name: string;
+    pluginName: string;
+  }) {
+    const message = error instanceof Error ? error.message : 'Unknown error';
+    super(message);
+
+    this.args = args;
+    this.cause = error.cause;
+    this.event = event;
+    this.name = name || error.name;
+    this.pluginName = pluginName;
+    this.stack = error.stack;
+  }
+}
+
+export const logCrashReport = (error: unknown, logsDir: string): string => {
+  const logName = `openapi-ts-error-${Date.now()}.log`;
+  const fullDir = path.resolve(process.cwd(), logsDir);
+  ensureDirSync(fullDir);
+  const logPath = path.resolve(fullDir, logName);
+
+  let logContent = `[${new Date().toISOString()}] `;
+
+  if (error instanceof HeyApiError) {
+    logContent += `${error.name} during event "${error.event}"\n`;
+    if (error.pluginName) {
+      logContent += `Plugin: ${error.pluginName}\n`;
+    }
+    logContent += `Arguments: ${JSON.stringify(error.args, null, 2)}\n\n`;
+  }
+
+  const message = error instanceof Error ? error.message : String(error);
+  const stack = error instanceof Error ? error.stack : undefined;
+
+  logContent += `Error: ${message}\n`;
+  if (stack) {
+    logContent += `Stack:\n${stack}\n`;
+  }
+
+  fs.writeFileSync(logPath, logContent);
+
+  return logPath;
+};
+
+export const openGitHubIssueWithCrashReport = async (error: unknown) => {
+  let body = '';
+
+  if (error instanceof HeyApiError) {
+    if (error.pluginName) {
+      body += `**Plugin**: \`${error.pluginName}\`\n`;
+    }
+    body += `**Event**: \`${error.event}\`\n`;
+    body += `**Arguments**:\n\`\`\`ts\n${JSON.stringify(error.args, null, 2)}\n\`\`\`\n\n`;
+  }
+
+  const message = error instanceof Error ? error.message : String(error);
+  const stack = error instanceof Error ? error.stack : undefined;
+
+  body += `**Error**: \`${message}\`\n`;
+  if (stack) {
+    body += `\n**Stack Trace**:\n\`\`\`\n${stack}\n\`\`\``;
+  }
+
+  const search = new URLSearchParams({
+    body,
+    labels: 'bug 🔥',
+    title: 'Crash Report',
+  });
+
+  const url = `https://github.com/hey-api/openapi-ts/issues/new?${search.toString()}`;
+
+  const open = (await import('open')).default;
+  await open(url);
+};
+
+export const printCrashReport = ({
+  error,
+  logPath,
+}: {
+  error: unknown;
+  logPath: string | undefined;
+}) => {
+  process.stdout.write(
+    `\n🛑 ${colors.cyan('@hey-api/openapi-ts')} ${colors.red('encountered an error.')}` +
+      `\n\n${colors.red('❗️ Error:')} ${colors.white(typeof error === 'string' ? error : error instanceof Error ? error.message : 'Unknown error')}` +
+      (logPath
+        ? `\n\n${colors.cyan('📄 Crash log saved to:')} ${colors.gray(logPath)}`
+        : ''),
+  );
+};
+
+export const shouldReportCrash = async (): Promise<boolean> => {
+  if (!isInteractive) {
+    return false;
+  }
+
+  return new Promise((resolve) => {
+    process.stdout.write(
+      `${colors.yellow('\n\n📢 Open a GitHub issue with crash details?')} ${colors.yellow('(y/N):')}`,
+    );
+    process.stdin.setEncoding('utf8');
+    process.stdin.once('data', (data: string) => {
+      resolve(data.trim().toLowerCase() === 'y');
+    });
+  });
+};

packages/openapi-ts/src/generate/output.ts

@@ -3,6 +3,7 @@ import path from 'node:path';
 import ts from 'typescript';
 
 import { compiler } from '../compiler';
+import type { Events } from '../ir/context';
 import { parseIR } from '../ir/parser';
 import type { IR } from '../ir/types';
 import { getClientPlugin } from '../plugins/@hey-api/client-core/utils';
@@ -27,6 +28,13 @@ export const generateOutput = async ({ context }: { context: IR.Context }) => {
 
   for (const name of context.config.pluginOrder) {
     const plugin = context.config.plugins[name]!;
+    const _subscribe = context.subscribe.bind(context);
+    context.subscribe = <T extends keyof Events>(
+      event: T,
+      callbackFn: Events[T],
+    ): void => {
+      _subscribe(event, callbackFn, name);
+    };
     plugin._handler({
       context,
       plugin: plugin as never,

packages/openapi-ts/src/index.ts

@@ -1,12 +1,14 @@
-import fs from 'node:fs';
-import path from 'node:path';
-
 import colors from 'ansi-colors';
 // @ts-expect-error
 import colorSupport from 'color-support';
 
 import { createClient as pCreateClient } from './createClient';
-import { ensureDirSync } from './generate/utils';
+import {
+  logCrashReport,
+  openGitHubIssueWithCrashReport,
+  printCrashReport,
+  shouldReportCrash,
+} from './error';
 import { getLogs } from './getLogs';
 import { initConfigs } from './initConfigs';
 import type { IR } from './ir/types';
@@ -73,20 +75,17 @@ export const createClient = async (
   } catch (error) {
     const config = configs[0] as Config | undefined;
     const dryRun = config ? config.dryRun : resolvedConfig?.dryRun;
-
-    // TODO: add setting for log output
-    if (!dryRun) {
-      const logs = config?.logs ?? getLogs(resolvedConfig);
-      if (logs.level !== 'silent' && logs.file) {
-        const logName = `openapi-ts-error-${Date.now()}.log`;
-        const logsDir = path.resolve(process.cwd(), logs.path ?? '');
-        ensureDirSync(logsDir);
-        const logPath = path.resolve(logsDir, logName);
-        fs.writeFileSync(logPath, `${error.message}\n${error.stack}`);
-        console.error(`🔥 Unexpected error occurred. Log saved to ${logPath}`);
+    const logs = config?.logs ?? getLogs(resolvedConfig);
+    const shouldLog = !dryRun && logs.level !== 'silent' && logs.file;
+
+    if (shouldLog) {
+      const logPath = logCrashReport(error, logs.path ?? '');
+      printCrashReport({ error, logPath });
+      if (await shouldReportCrash()) {
+        await openGitHubIssueWithCrashReport(error);
       }
     }
-    console.error(`🔥 Unexpected error occurred. ${error.message}`);
+
     throw error;
   }
 };

packages/openapi-ts/src/ir/context.ts

@@ -1,5 +1,6 @@
 import path from 'node:path';
 
+import { HeyApiError } from '../error';
 import { TypeScriptFile } from '../generate/files';
 import type { Config, StringCase } from '../types/config';
 import type { Files } from '../types/utils';
@@ -27,7 +28,7 @@ interface ContextFile {
   path: string;
 }
 
-interface Events {
+export interface Events {
   /**
    * Called after parsing.
    */
@@ -59,8 +60,13 @@ interface Events {
   server: (args: { server: IR.ServerObject }) => void;
 }
 
+type ListenerWithMeta<T extends keyof Events> = {
+  callbackFn: Events[T];
+  pluginName: string;
+};
+
 type Listeners = {
-  [T in keyof Events]?: Array<Events[T]>;
+  [T in keyof Events]?: Array<ListenerWithMeta<T>>;
 };
 
 export class IRContext<Spec extends Record<string, any> = any> {
@@ -102,24 +108,28 @@ export class IRContext<Spec extends Record<string, any> = any> {
     event: T,
     ...args: Parameters<Events[T]>
   ): Promise<void> {
-    if (!this.listeners[event]) {
-      return;
-    }
+    const eventListeners = this.listeners[event];
 
-    await Promise.all(
-      this.listeners[event].map((callbackFn, index) => {
+    if (eventListeners) {
+      for (const listener of eventListeners) {
         try {
-          // @ts-expect-error
-          const response = callbackFn(...args);
-          return Promise.resolve(response);
-        } catch (error) {
-          console.error(
-            `🔥 Event broadcast: "${event}"\nindex: ${index}\narguments: ${JSON.stringify(args, null, 2)}`,
+          await listener.callbackFn(
+            // @ts-expect-error
+            ...args,
           );
-          throw error;
+        } catch (error) {
+          const originalError =
+            error instanceof Error ? error : new Error(String(error));
+          throw new HeyApiError({
+            args,
+            error: originalError,
+            event,
+            name: 'BroadcastError',
+            pluginName: listener.pluginName,
+          });
         }
-      }),
-    );
+      }
+    }
   }
 
   /**
@@ -192,10 +202,14 @@ export class IRContext<Spec extends Record<string, any> = any> {
   public subscribe<T extends keyof Events>(
     event: T,
     callbackFn: Events[T],
+    pluginName?: string,
   ): void {
     if (!this.listeners[event]) {
       this.listeners[event] = [];
     }
-    this.listeners[event].push(callbackFn);
+    this.listeners[event].push({
+      callbackFn,
+      pluginName: pluginName ?? '',
+    });
   }
 }