@graphql-codegen/core 2.4.0 → 2.5.0-alpha-c9cbc7d69.0

package/execute-plugin.d.ts

@@ -1,4 +1,4 @@
-import { Types, CodegenPlugin } from '@graphql-codegen/plugin-helpers';
+import { Types, CodegenPlugin, Profiler } from '@graphql-codegen/plugin-helpers';
 import { DocumentNode, GraphQLSchema } from 'graphql';
 export interface ExecutePluginOptions {
     name: string;
@@ -13,5 +13,6 @@ export interface ExecutePluginOptions {
     pluginContext?: {
         [key: string]: any;
     };
+    profiler?: Profiler;
 }
 export declare function executePlugin(options: ExecutePluginOptions, plugin: CodegenPlugin): Promise<Types.PluginOutput>;

package/index.js

@@ -8,6 +8,7 @@ const utils = require('@graphql-tools/utils');
 const schema = require('@graphql-tools/schema');
 
 async function executePlugin(options, plugin) {
+    var _a;
     if (!plugin || !plugin.plugin || typeof plugin.plugin !== 'function') {
         throw new pluginHelpers.DetailedError(`Invalid Custom Plugin "${options.name}"`, `
         Plugin ${options.name} does not export a valid JS object with "plugin" function.
@@ -24,10 +25,11 @@ async function executePlugin(options, plugin) {
     const outputSchema = options.schemaAst || graphql.buildASTSchema(options.schema, options.config);
     const documents = options.documents || [];
     const pluginContext = options.pluginContext || {};
+    const profiler = (_a = options.profiler) !== null && _a !== void 0 ? _a : pluginHelpers.createNoopProfiler();
     if (plugin.validate && typeof plugin.validate === 'function') {
         try {
             // FIXME: Sync validate signature with plugin signature
-            await plugin.validate(outputSchema, documents, options.config, options.outputFilename, options.allPlugins, pluginContext);
+            await profiler.run(async () => plugin.validate(outputSchema, documents, options.config, options.outputFilename, options.allPlugins, pluginContext), `Plugin ${options.name} validate`);
         }
         catch (e) {
             throw new pluginHelpers.DetailedError(`Plugin "${options.name}" validation failed:`, `
@@ -35,11 +37,11 @@ async function executePlugin(options, plugin) {
           `);
         }
     }
-    return Promise.resolve(plugin.plugin(outputSchema, documents, typeof options.config === 'object' ? { ...options.config } : options.config, {
+    return profiler.run(() => Promise.resolve(plugin.plugin(outputSchema, documents, typeof options.config === 'object' ? { ...options.config } : options.config, {
         outputFile: options.outputFilename,
         allPlugins: options.allPlugins,
         pluginContext,
-    }));
+    })), `Plugin ${options.name} execution`);
 }
 
 function isObjectMap(obj) {
@@ -103,10 +105,12 @@ function hasFederationSpec(schemaOrAST) {
 }
 
 async function codegen(options) {
+    var _a;
     const documents = options.documents || [];
+    const profiler = (_a = options.profiler) !== null && _a !== void 0 ? _a : pluginHelpers.createNoopProfiler();
     const skipDocumentsValidation = getSkipDocumentsValidationOption(options);
     if (documents.length > 0 && shouldValidateDuplicateDocuments(skipDocumentsValidation)) {
-        validateDuplicateDocuments(documents);
+        await profiler.run(async () => validateDuplicateDocuments(documents), 'validateDuplicateDocuments');
     }
     const pluginPackages = Object.keys(options.pluginMap).map(key => options.pluginMap[key]);
     // merged schema with parts added by plugins
@@ -124,18 +128,20 @@ async function codegen(options) {
     }
     // Use mergeSchemas, only if there is no GraphQLSchema provided or the schema should be extended
     const mergeNeeded = !options.schemaAst || additionalTypeDefs.length > 0;
-    const schemaInstance = mergeNeeded
-        ? schema.mergeSchemas({
-            // If GraphQLSchema provided, use it
-            schemas: options.schemaAst ? [options.schemaAst] : [],
-            // If GraphQLSchema isn't provided but DocumentNode is, use it to get the final GraphQLSchema
-            typeDefs: options.schemaAst ? additionalTypeDefs : [options.schema, ...additionalTypeDefs],
-            convertExtensions: true,
-            assumeValid: true,
-            assumeValidSDL: true,
-            ...options.config,
-        })
-        : options.schemaAst;
+    const schemaInstance = await profiler.run(async () => {
+        return mergeNeeded
+            ? schema.mergeSchemas({
+                // If GraphQLSchema provided, use it
+                schemas: options.schemaAst ? [options.schemaAst] : [],
+                // If GraphQLSchema isn't provided but DocumentNode is, use it to get the final GraphQLSchema
+                typeDefs: options.schemaAst ? additionalTypeDefs : [options.schema, ...additionalTypeDefs],
+                convertExtensions: true,
+                assumeValid: true,
+                assumeValidSDL: true,
+                ...options.config,
+            })
+            : options.schemaAst;
+    }, 'Create schema instance');
     const schemaDocumentNode = mergeNeeded || !options.schema ? pluginHelpers.getCachedDocumentNodeFromSchema(schemaInstance) : options.schema;
     if (schemaInstance && documents.length > 0 && shouldValidateDocumentsAgainstSchema(skipDocumentsValidation)) {
         const ignored = ['NoUnusedFragments', 'NoUnusedVariables', 'KnownDirectives'];
@@ -143,13 +149,13 @@ async function codegen(options) {
             ignored.push(...utils.asArray(skipDocumentsValidation.ignoreRules));
         }
         const extraFragments = pickFlag('externalFragments', options.config) || [];
-        const errors = await utils.validateGraphQlDocuments(schemaInstance, [
+        const errors = await profiler.run(() => utils.validateGraphQlDocuments(schemaInstance, [
             ...documents,
             ...extraFragments.map(f => ({
                 location: f.importFrom,
                 document: { kind: graphql.Kind.DOCUMENT, definitions: [f.node] },
             })),
-        ], graphql.specifiedRules.filter(rule => !ignored.some(ignoredRule => rule.name.startsWith(ignoredRule))));
+        ], graphql.specifiedRules.filter(rule => !ignored.some(ignoredRule => rule.name.startsWith(ignoredRule)))), 'Validate documents against schema');
         utils.checkValidationErrors(errors);
     }
     const prepend = new Set();
@@ -164,7 +170,7 @@ async function codegen(options) {
                 ...options.config,
                 ...pluginConfig,
             };
-        const result = await executePlugin({
+        const result = await profiler.run(() => executePlugin({
             name,
             config: execConfig,
             parentConfig: options.config,
@@ -175,7 +181,8 @@ async function codegen(options) {
             allPlugins: options.plugins,
             skipDocumentsValidation: options.skipDocumentsValidation,
             pluginContext: options.pluginContext,
-        }, pluginPackage);
+            profiler,
+        }, pluginPackage), `Plugin ${name}`);
         if (typeof result === 'string') {
             return result || '';
         }

package/index.mjs

@@ -1,9 +1,10 @@
-import { DetailedError, getCachedDocumentNodeFromSchema, isComplexPluginOutput, federationSpec } from '@graphql-codegen/plugin-helpers';
+import { DetailedError, createNoopProfiler, getCachedDocumentNodeFromSchema, isComplexPluginOutput, federationSpec } from '@graphql-codegen/plugin-helpers';
 import { buildASTSchema, isSchema, Kind, specifiedRules, visit, print } from 'graphql';
 import { isDocumentNode, asArray, validateGraphQlDocuments, checkValidationErrors } from '@graphql-tools/utils';
 import { mergeSchemas } from '@graphql-tools/schema';
 
 async function executePlugin(options, plugin) {
+    var _a;
     if (!plugin || !plugin.plugin || typeof plugin.plugin !== 'function') {
         throw new DetailedError(`Invalid Custom Plugin "${options.name}"`, `
         Plugin ${options.name} does not export a valid JS object with "plugin" function.
@@ -20,10 +21,11 @@ async function executePlugin(options, plugin) {
     const outputSchema = options.schemaAst || buildASTSchema(options.schema, options.config);
     const documents = options.documents || [];
     const pluginContext = options.pluginContext || {};
+    const profiler = (_a = options.profiler) !== null && _a !== void 0 ? _a : createNoopProfiler();
     if (plugin.validate && typeof plugin.validate === 'function') {
         try {
             // FIXME: Sync validate signature with plugin signature
-            await plugin.validate(outputSchema, documents, options.config, options.outputFilename, options.allPlugins, pluginContext);
+            await profiler.run(async () => plugin.validate(outputSchema, documents, options.config, options.outputFilename, options.allPlugins, pluginContext), `Plugin ${options.name} validate`);
         }
         catch (e) {
             throw new DetailedError(`Plugin "${options.name}" validation failed:`, `
@@ -31,11 +33,11 @@ async function executePlugin(options, plugin) {
           `);
         }
     }
-    return Promise.resolve(plugin.plugin(outputSchema, documents, typeof options.config === 'object' ? { ...options.config } : options.config, {
+    return profiler.run(() => Promise.resolve(plugin.plugin(outputSchema, documents, typeof options.config === 'object' ? { ...options.config } : options.config, {
         outputFile: options.outputFilename,
         allPlugins: options.allPlugins,
         pluginContext,
-    }));
+    })), `Plugin ${options.name} execution`);
 }
 
 function isObjectMap(obj) {
@@ -99,10 +101,12 @@ function hasFederationSpec(schemaOrAST) {
 }
 
 async function codegen(options) {
+    var _a;
     const documents = options.documents || [];
+    const profiler = (_a = options.profiler) !== null && _a !== void 0 ? _a : createNoopProfiler();
     const skipDocumentsValidation = getSkipDocumentsValidationOption(options);
     if (documents.length > 0 && shouldValidateDuplicateDocuments(skipDocumentsValidation)) {
-        validateDuplicateDocuments(documents);
+        await profiler.run(async () => validateDuplicateDocuments(documents), 'validateDuplicateDocuments');
     }
     const pluginPackages = Object.keys(options.pluginMap).map(key => options.pluginMap[key]);
     // merged schema with parts added by plugins
@@ -120,18 +124,20 @@ async function codegen(options) {
     }
     // Use mergeSchemas, only if there is no GraphQLSchema provided or the schema should be extended
     const mergeNeeded = !options.schemaAst || additionalTypeDefs.length > 0;
-    const schemaInstance = mergeNeeded
-        ? mergeSchemas({
-            // If GraphQLSchema provided, use it
-            schemas: options.schemaAst ? [options.schemaAst] : [],
-            // If GraphQLSchema isn't provided but DocumentNode is, use it to get the final GraphQLSchema
-            typeDefs: options.schemaAst ? additionalTypeDefs : [options.schema, ...additionalTypeDefs],
-            convertExtensions: true,
-            assumeValid: true,
-            assumeValidSDL: true,
-            ...options.config,
-        })
-        : options.schemaAst;
+    const schemaInstance = await profiler.run(async () => {
+        return mergeNeeded
+            ? mergeSchemas({
+                // If GraphQLSchema provided, use it
+                schemas: options.schemaAst ? [options.schemaAst] : [],
+                // If GraphQLSchema isn't provided but DocumentNode is, use it to get the final GraphQLSchema
+                typeDefs: options.schemaAst ? additionalTypeDefs : [options.schema, ...additionalTypeDefs],
+                convertExtensions: true,
+                assumeValid: true,
+                assumeValidSDL: true,
+                ...options.config,
+            })
+            : options.schemaAst;
+    }, 'Create schema instance');
     const schemaDocumentNode = mergeNeeded || !options.schema ? getCachedDocumentNodeFromSchema(schemaInstance) : options.schema;
     if (schemaInstance && documents.length > 0 && shouldValidateDocumentsAgainstSchema(skipDocumentsValidation)) {
         const ignored = ['NoUnusedFragments', 'NoUnusedVariables', 'KnownDirectives'];
@@ -139,13 +145,13 @@ async function codegen(options) {
             ignored.push(...asArray(skipDocumentsValidation.ignoreRules));
         }
         const extraFragments = pickFlag('externalFragments', options.config) || [];
-        const errors = await validateGraphQlDocuments(schemaInstance, [
+        const errors = await profiler.run(() => validateGraphQlDocuments(schemaInstance, [
             ...documents,
             ...extraFragments.map(f => ({
                 location: f.importFrom,
                 document: { kind: Kind.DOCUMENT, definitions: [f.node] },
             })),
-        ], specifiedRules.filter(rule => !ignored.some(ignoredRule => rule.name.startsWith(ignoredRule))));
+        ], specifiedRules.filter(rule => !ignored.some(ignoredRule => rule.name.startsWith(ignoredRule)))), 'Validate documents against schema');
         checkValidationErrors(errors);
     }
     const prepend = new Set();
@@ -160,7 +166,7 @@ async function codegen(options) {
                 ...options.config,
                 ...pluginConfig,
             };
-        const result = await executePlugin({
+        const result = await profiler.run(() => executePlugin({
             name,
             config: execConfig,
             parentConfig: options.config,
@@ -171,7 +177,8 @@ async function codegen(options) {
             allPlugins: options.plugins,
             skipDocumentsValidation: options.skipDocumentsValidation,
             pluginContext: options.pluginContext,
-        }, pluginPackage);
+            profiler,
+        }, pluginPackage), `Plugin ${name}`);
         if (typeof result === 'string') {
             return result || '';
         }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@graphql-codegen/core",
-  "version": "2.4.0",
+  "version": "2.5.0-alpha-c9cbc7d69.0",
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@graphql-codegen/plugin-helpers": "^2.3.2",
+    "@graphql-codegen/plugin-helpers": "2.4.0-alpha-c9cbc7d69.0",
     "@graphql-tools/schema": "^8.1.2",
     "@graphql-tools/utils": "^8.1.1",
     "tslib": "~2.3.0"