refactor: remove DetailledError, not supported by Listr renderer (#8525)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: charlypoly

.changeset/@graphql-codegen_flutter-freezed-8525-dependencies.md

@@ -0,0 +1,5 @@
+---
+"@graphql-codegen/flutter-freezed": patch
+---
+dependencies updates:
+ - Updated dependency [`@graphql-codegen/visitor-plugin-common@2.13.0` ↗︎](https://www.npmjs.com/package/@graphql-codegen/visitor-plugin-common/v/2.13.0) (from `2.12.0`, in `dependencies`)

.changeset/great-mails-yawn.md

@@ -0,0 +1,9 @@
+---
+'@graphql-codegen/cli': patch
+'@graphql-codegen/core': patch
+'@graphql-codegen/visitor-plugin-common': patch
+'@graphql-codegen/near-operation-file-preset': patch
+'@graphql-codegen/plugin-helpers': patch
+---
+
+remove `DetailledError`, not supported by Listr renderer

packages/graphql-codegen-cli/src/cli.ts

@@ -2,7 +2,6 @@ import { generate } from './generate-and-save.js';
 import { init } from './init/index.js';
 import { createContext } from './config.js';
 import { lifecycleHooks } from './hooks.js';
-import { DetailedError } from '@graphql-codegen/plugin-helpers';
 
 export async function runCli(cmd: string): Promise<number> {
  await ensureGraphQlPackage();
@@ -33,14 +32,12 @@ export async function ensureGraphQlPackage() {
  try {
  await import('graphql');
  } catch (e) {
- throw new DetailedError(
- `Unable to load "graphql" package. Please make sure to install "graphql" as a dependency!`,
- `
- To install "graphql", run:
- yarn add graphql
- Or, with NPM:
- npm install --save graphql
-`
+ throw new Error(
+ `Unable to load "graphql" package. Please make sure to install "graphql" as a dependency! \n
+ To install "graphql", run:
+ yarn add graphql
+ Or, with NPM:
+ npm install --save graphql`
  );
  }
 }

packages/graphql-codegen-cli/src/codegen.ts

@@ -1,12 +1,10 @@
 import {
- DetailedError,
  Types,
  CodegenPlugin,
  normalizeOutputParam,
  normalizeInstanceOrArray,
  normalizeConfig,
  getCachedDocumentNodeFromSchema,
- isDetailedError,
 } from '@graphql-codegen/plugin-helpers';
 import { codegen } from '@graphql-codegen/core';
 
@@ -51,7 +49,7 @@ const makeDefaultLoader = (from: string) => {
  };
 };
 
-type Ctx = { errors: DetailedError[] | Error[] };
+type Ctx = { errors: Error[] };
 
 function createCache(): <T>(namespace: string, key: string, factory: () => Promise<T>) => Promise<T> {
  const cache = new Map<string, Promise<unknown>>();
@@ -123,9 +121,8 @@ export async function executeCodegen(input: CodegenContext | Types.Config): Prom
  const generateKeys = Object.keys(config.generates || {});
 
  if (generateKeys.length === 0) {
- throw new DetailedError(
- 'Invalid Codegen Configuration!',
- `
+ throw new Error(
+ `Invalid Codegen Configuration! \n
  Please make sure that your codegen config file contains the "generates" field, with a specification for the plugins you need.
 
  It should looks like that:
@@ -136,18 +133,16 @@ export async function executeCodegen(input: CodegenContext | Types.Config): Prom
  my-file.ts:
  - plugin1
  - plugin2
- - plugin3
- `
+ - plugin3`
  );
  }
 
  for (const filename of generateKeys) {
  const output = (generates[filename] = normalizeOutputParam(config.generates[filename]));
 
  if (!output.preset && (!output.plugins || output.plugins.length === 0)) {
- throw new DetailedError(
- 'Invalid Codegen Configuration!',
- `
+ throw new Error(
+ `Invalid Codegen Configuration! \n
  Please make sure that your codegen config file has defined plugins list for output "${filename}".
 
  It should looks like that:
@@ -173,9 +168,8 @@ export async function executeCodegen(input: CodegenContext | Types.Config): Prom
  (generates[filename].schema as unknown as any[]).length === 0)
  )
  ) {
- throw new DetailedError(
- 'Invalid Codegen Configuration!',
- `
+ throw new Error(
+ `Invalid Codegen Configuration! \n
  Please make sure that your codegen config file contains either the "schema" field
  or every generated file has its own "schema" field.
 
@@ -419,11 +413,7 @@ export async function executeCodegen(input: CodegenContext | Types.Config): Prom
  }
 
  if (executedContext.errors.length > 0) {
- const errors = executedContext.errors.map(subErr =>
- isDetailedError(subErr)
- ? `${subErr.message} for "${subErr.source}"${subErr.details}`
- : subErr.message || subErr.toString()
- );
+ const errors = executedContext.errors.map(subErr => subErr.message || subErr.toString());
  const newErr = new AggregateError(executedContext.errors, `${errors.join('\n\n')}`);
  // Best-effort to all stack traces for debugging
  newErr.stack = `${newErr.stack}\n\n${executedContext.errors.map(subErr => subErr.stack).join('\n\n')}`;

packages/graphql-codegen-cli/src/config.ts

@@ -2,7 +2,6 @@ import { cosmiconfig, defaultLoaders } from 'cosmiconfig';
 import { TypeScriptLoader } from 'cosmiconfig-typescript-loader';
 import { resolve } from 'path';
 import {
- DetailedError,
  Types,
  Profiler,
  createProfiler,
@@ -156,8 +155,7 @@ export async function loadContext(configFilePath?: string): Promise<CodegenConte
 
  if (!result) {
  if (configFilePath) {
- throw new DetailedError(
- `Config ${configFilePath} does not exist`,
+ throw new Error(
  `
  Config ${configFilePath} does not exist.
 
@@ -168,18 +166,16 @@ export async function loadContext(configFilePath?: string): Promise<CodegenConte
  );
  }
 
- throw new DetailedError(
- `Unable to find Codegen config file!`,
- `
+ throw new Error(
+ `Unable to find Codegen config file! \n
  Please make sure that you have a configuration file under the current directory!
  `
  );
  }
 
  if (result.isEmpty) {
- throw new DetailedError(
- `Found Codegen config file but it was empty!`,
- `
+ throw new Error(
+ `Found Codegen config file but it was empty! \n
  Please make sure that you have a valid configuration file under the current directory!
  `
  );

packages/graphql-codegen-cli/src/plugins.ts

@@ -1,4 +1,4 @@
-import { DetailedError, Types, CodegenPlugin } from '@graphql-codegen/plugin-helpers';
+import { Types, CodegenPlugin } from '@graphql-codegen/plugin-helpers';
 import { resolve } from 'path';
 
 export async function getPluginByName(
@@ -23,8 +23,7 @@ export async function getPluginByName(
  return await pluginLoader(moduleName);
  } catch (err) {
  if (err.code !== 'MODULE_NOT_FOUND' && err.code !== 'ERR_MODULE_NOT_FOUND') {
- throw new DetailedError(
- `Unable to load template plugin matching ${name}`,
+ throw new Error(
  `
  Unable to load template plugin matching '${name}'.
  Reason:
@@ -43,8 +42,7 @@ export async function getPluginByName(
  )
  .join('');
 
- throw new DetailedError(
- `Unable to find template plugin matching ${name}`,
+ throw new Error(
  `
  Unable to find template plugin matching '${name}'
  Install one of the following packages:

packages/graphql-codegen-cli/src/utils/cli-error.ts

@@ -1,6 +1,4 @@
-import { DetailedError } from '@graphql-codegen/plugin-helpers';
-
-type CompositeError = Error | DetailedError;
+type CompositeError = Error;
 type ListrError = Error & { errors: CompositeError[] };
 export function isListrError(err: Error & { name?: unknown; errors?: unknown }): err is ListrError {
  return err.name === 'ListrError' && Array.isArray(err.errors) && err.errors.length > 0;

packages/graphql-codegen-cli/tests/codegen.spec.ts

@@ -112,7 +112,7 @@ describe('Codegen Executor', () => {
  throw new Error(SHOULD_NOT_THROW_STRING);
  } catch (e) {
  expect(e.message).not.toBe(SHOULD_NOT_THROW_STRING);
- expect(e.message).toBe('Invalid Codegen Configuration!');
+ expect(e.message).toMatch('Invalid Codegen Configuration!');
  }
  });
 
@@ -143,7 +143,7 @@ describe('Codegen Executor', () => {
  expect(output.length).toBe(1);
  } catch (e) {
  expect(e.message).not.toBe(SHOULD_NOT_THROW_STRING);
- expect(e.message).not.toBe('Invalid Codegen Configuration!');
+ expect(e.message).not.toMatch('Invalid Codegen Configuration!');
  }
  });
 
@@ -159,7 +159,7 @@ describe('Codegen Executor', () => {
 
  throw new Error(SHOULD_NOT_THROW_STRING);
  } catch (e) {
- expect(e.message).toBe('Invalid Codegen Configuration!');
+ expect(e.message).toMatch('Invalid Codegen Configuration!');
  expect(e.message).not.toBe(SHOULD_NOT_THROW_STRING);
  }
  });
@@ -177,7 +177,7 @@ describe('Codegen Executor', () => {
  throw new Error(SHOULD_NOT_THROW_STRING);
  } catch (e) {
  expect(e.message).not.toBe(SHOULD_NOT_THROW_STRING);
- expect(e.message).toBe('Invalid Codegen Configuration!');
+ expect(e.message).toMatch('Invalid Codegen Configuration!');
  }
  });
 

packages/graphql-codegen-core/src/codegen.ts

@@ -1,5 +1,4 @@
 import {
- DetailedError,
  Types,
  isComplexPluginOutput,
  federationSpec,
@@ -283,10 +282,8 @@ function validateDuplicateDocuments(files: Types.DocumentFile[]) {
  .join('');
 
  const definitionKindName = kind.replace('Definition', '').toLowerCase();
- throw new DetailedError(
- `Not all ${definitionKindName}s have an unique name: ${duplicated.join(', ')}`,
- `
- Not all ${definitionKindName}s have an unique name
+ throw new Error(
+ `Not all ${definitionKindName}s have an unique name: ${duplicated.join(', ')}: \n
  ${list}
  `
  );

packages/graphql-codegen-core/src/execute-plugin.ts

@@ -1,4 +1,4 @@
-import { DetailedError, Types, CodegenPlugin, Profiler, createNoopProfiler } from '@graphql-codegen/plugin-helpers';
+import { Types, CodegenPlugin, Profiler, createNoopProfiler } from '@graphql-codegen/plugin-helpers';
 import { DocumentNode, GraphQLSchema, buildASTSchema } from 'graphql';
 
 export interface ExecutePluginOptions {
@@ -17,9 +17,8 @@ export interface ExecutePluginOptions {
 
 export async function executePlugin(options: ExecutePluginOptions, plugin: CodegenPlugin): Promise<Types.PluginOutput> {
  if (!plugin || !plugin.plugin || typeof plugin.plugin !== 'function') {
- throw new DetailedError(
- `Invalid Custom Plugin "${options.name}"`,
- `
+ throw new Error(
+ `Invalid Custom Plugin "${options.name}" \n
  Plugin ${options.name} does not export a valid JS object with "plugin" function.
 
  Make sure your custom plugin is written in the following form:
@@ -54,9 +53,8 @@ export async function executePlugin(options: ExecutePluginOptions, plugin: Codeg
  `Plugin ${options.name} validate`
  );
  } catch (e) {
- throw new DetailedError(
- `Plugin "${options.name}" validation failed:`,
- `
+ throw new Error(
+ `Plugin "${options.name}" validation failed: \n
  ${e.message}
  `
  );