@envelop/prometheus 6.4.0-alpha-c0cc559.0 → 6.4.0-alpha-e9434aa.0

package/cjs/config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/{index.mjs → cjs/index.js}

@@ -1,97 +1,31 @@
-import { isIntrospectionOperationString, isAsyncIterable } from '@envelop/core';
-import { visit, visitWithTypeInfo, TypeInfo } from 'graphql';
-import { Histogram, register, Summary, Counter } from 'prom-client';
-
-function shouldTraceFieldResolver(info, whitelist) {
-    if (!whitelist) {
-        return true;
-    }
-    const parentType = info.parentType.name;
-    const fieldName = info.fieldName;
-    const coordinate = `${parentType}.${fieldName}`;
-    return whitelist.includes(coordinate) || whitelist.includes(`${parentType}.*`);
-}
-function getOperation(document) {
-    return document.definitions[0];
-}
-function createInternalContext(parseResult) {
-    var _a;
-    if (parseResult === null) {
-        return null;
-    }
-    else if (parseResult instanceof Error) {
-        return null;
-    }
-    else {
-        const operation = getOperation(parseResult);
-        return {
-            document: parseResult,
-            operationName: ((_a = operation.name) === null || _a === void 0 ? void 0 : _a.value) || 'Anonymous',
-            operationType: operation.operation,
-        };
-    }
-}
-function createHistogram(options) {
-    return options;
-}
-function createSummary(options) {
-    return options;
-}
-function createCounter(options) {
-    return options;
-}
-function getHistogramFromConfig(config, phase, name, help) {
-    return typeof config[phase] === 'object'
-        ? config[phase]
-        : config[phase] === true
-            ? createHistogram({
-                histogram: new Histogram({
-                    name,
-                    help,
-                    labelNames: ['operationType', 'operationName'],
-                    registers: [config.registry || register],
-                }),
-                fillLabelsFn: params => ({
-                    operationName: params.operationName,
-                    operationType: params.operationType,
-                }),
-            })
-            : undefined;
-}
-function extractDeprecatedFields(node, typeInfo) {
-    const found = [];
-    visit(node, visitWithTypeInfo(typeInfo, {
-        Field: () => {
-            const field = typeInfo.getFieldDef();
-            if (field && (field.deprecationReason != null || field.isDeprecated)) {
-                found.push({
-                    fieldName: field.name,
-                    typeName: typeInfo.getParentType().name || '',
-                });
-            }
-        },
-    }));
-    return found;
-}
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePrometheus = exports.createSummary = exports.createHistogram = exports.createCounter = void 0;
 /* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
+const core_1 = require("@envelop/core");
+const graphql_1 = require("graphql");
+const prom_client_1 = require("prom-client");
+const utils_js_1 = require("./utils.js");
+Object.defineProperty(exports, "createHistogram", { enumerable: true, get: function () { return utils_js_1.createHistogram; } });
+Object.defineProperty(exports, "createCounter", { enumerable: true, get: function () { return utils_js_1.createCounter; } });
+Object.defineProperty(exports, "createSummary", { enumerable: true, get: function () { return utils_js_1.createSummary; } });
 const promPluginContext = Symbol('promPluginContext');
 const promPluginExecutionStartTimeSymbol = Symbol('promPluginExecutionStartTimeSymbol');
 const usePrometheus = (config = {}) => {
     let typeInfo = null;
-    const parseHistogram = getHistogramFromConfig(config, 'parse', 'graphql_envelop_phase_parse', 'Time spent on running GraphQL "parse" function');
-    const validateHistogram = getHistogramFromConfig(config, 'validate', 'graphql_envelop_phase_validate', 'Time spent on running GraphQL "validate" function');
-    const contextBuildingHistogram = getHistogramFromConfig(config, 'contextBuilding', 'graphql_envelop_phase_context', 'Time spent on building the GraphQL context');
-    const executeHistogram = getHistogramFromConfig(config, 'execute', 'graphql_envelop_phase_execute', 'Time spent on running the GraphQL "execute" function');
+    const parseHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'parse', 'graphql_envelop_phase_parse', 'Time spent on running GraphQL "parse" function');
+    const validateHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'validate', 'graphql_envelop_phase_validate', 'Time spent on running GraphQL "validate" function');
+    const contextBuildingHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'contextBuilding', 'graphql_envelop_phase_context', 'Time spent on building the GraphQL context');
+    const executeHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'execute', 'graphql_envelop_phase_execute', 'Time spent on running the GraphQL "execute" function');
     const resolversHistogram = typeof config.resolvers === 'object'
         ? config.resolvers
         : config.resolvers === true
-            ? createHistogram({
-                histogram: new Histogram({
+            ? (0, utils_js_1.createHistogram)({
+                histogram: new prom_client_1.Histogram({
                     name: 'graphql_envelop_execute_resolver',
                     help: 'Time spent on running the GraphQL resolvers',
                     labelNames: ['operationType', 'operationName', 'fieldName', 'typeName', 'returnType'],
-                    registers: [config.registry || register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => {
                     var _a, _b, _c;
@@ -108,12 +42,12 @@ const usePrometheus = (config = {}) => {
     const requestTotalHistogram = typeof config.requestTotalDuration === 'object'
         ? config.requestTotalDuration
         : config.requestTotalDuration === true
-            ? createHistogram({
-                histogram: new Histogram({
+            ? (0, utils_js_1.createHistogram)({
+                histogram: new prom_client_1.Histogram({
                     name: 'graphql_envelop_request_duration',
                     help: 'Time spent on running the GraphQL operation from parse to execute',
                     labelNames: ['operationType', 'operationName'],
-                    registers: [config.registry || register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => ({
                     operationName: params.operationName,
@@ -124,12 +58,12 @@ const usePrometheus = (config = {}) => {
     const requestSummary = typeof config.requestSummary === 'object'
         ? config.requestSummary
         : config.requestSummary === true
-            ? createSummary({
-                summary: new Summary({
+            ? (0, utils_js_1.createSummary)({
+                summary: new prom_client_1.Summary({
                     name: 'graphql_envelop_request_time_summary',
                     help: 'Summary to measure the time to complete GraphQL operations',
                     labelNames: ['operationType', 'operationName'],
-                    registers: [config.registry || register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => ({
                     operationName: params.operationName,
@@ -140,12 +74,12 @@ const usePrometheus = (config = {}) => {
     const errorsCounter = typeof config.errors === 'object'
         ? config.errors
         : config.errors === true
-            ? createCounter({
-                counter: new Counter({
+            ? (0, utils_js_1.createCounter)({
+                counter: new prom_client_1.Counter({
                     name: 'graphql_envelop_error_result',
                     help: 'Counts the amount of errors reported from all phases',
                     labelNames: ['operationType', 'operationName', 'path', 'phase'],
-                    registers: [config.registry || register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => {
                     var _a, _b;
@@ -161,12 +95,12 @@ const usePrometheus = (config = {}) => {
     const reqCounter = typeof config.requestCount === 'object'
         ? config.requestCount
         : config.requestCount === true
-            ? createCounter({
-                counter: new Counter({
+            ? (0, utils_js_1.createCounter)({
+                counter: new prom_client_1.Counter({
                     name: 'graphql_envelop_request',
                     help: 'Counts the amount of GraphQL requests executed through Envelop',
                     labelNames: ['operationType', 'operationName'],
-                    registers: [config.registry || register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => ({
                     operationName: params.operationName,
@@ -177,12 +111,12 @@ const usePrometheus = (config = {}) => {
     const deprecationCounter = typeof config.deprecatedFields === 'object'
         ? config.deprecatedFields
         : config.deprecatedFields === true
-            ? createCounter({
-                counter: new Counter({
+            ? (0, utils_js_1.createCounter)({
+                counter: new prom_client_1.Counter({
                     name: 'graphql_envelop_deprecated_field',
                     help: 'Counts the amount of deprecated fields used in selection sets',
                     labelNames: ['operationType', 'operationName', 'fieldName', 'typeName'],
-                    registers: [config.registry || register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => {
                     var _a, _b;
@@ -196,20 +130,20 @@ const usePrometheus = (config = {}) => {
             })
             : undefined;
     const onParse = ({ context, extendContext, params }) => {
-        if (config.skipIntrospection && isIntrospectionOperationString(params.source)) {
+        if (config.skipIntrospection && (0, core_1.isIntrospectionOperationString)(params.source)) {
             return;
         }
         const startTime = Date.now();
         return params => {
             const totalTime = (Date.now() - startTime) / 1000;
-            const internalContext = createInternalContext(params.result);
+            const internalContext = (0, utils_js_1.createInternalContext)(params.result);
             if (internalContext) {
                 extendContext({
                     [promPluginContext]: internalContext,
                 });
                 parseHistogram === null || parseHistogram === void 0 ? void 0 : parseHistogram.histogram.observe(parseHistogram.fillLabelsFn(internalContext, context), totalTime);
                 if (deprecationCounter && typeInfo) {
-                    const deprecatedFields = extractDeprecatedFields(internalContext.document, typeInfo);
+                    const deprecatedFields = (0, utils_js_1.extractDeprecatedFields)(internalContext.document, typeInfo);
                     if (deprecatedFields.length > 0) {
                         for (const depField of deprecatedFields) {
                             deprecationCounter.counter
@@ -277,7 +211,7 @@ const usePrometheus = (config = {}) => {
                         const summaryTime = (Date.now() - args.contextValue[promPluginExecutionStartTimeSymbol]) / 1000;
                         requestSummary.summary.observe(requestSummary.fillLabelsFn(args.contextValue[promPluginContext], args.contextValue), summaryTime);
                     }
-                    if (errorsCounter && !isAsyncIterable(result) && result.errors && result.errors.length > 0) {
+                    if (errorsCounter && !(0, core_1.isAsyncIterable)(result) && result.errors && result.errors.length > 0) {
                         for (const error of result.errors) {
                             errorsCounter.counter
                                 .labels(errorsCounter.fillLabelsFn({
@@ -296,7 +230,7 @@ const usePrometheus = (config = {}) => {
     return {
         onResolverCalled: resolversHistogram
             ? ({ info, context }) => {
-                const shouldTrace = shouldTraceFieldResolver(info, config.resolversWhitelist);
+                const shouldTrace = (0, utils_js_1.shouldTraceFieldResolver)(info, config.resolversWhitelist);
                 if (!shouldTrace) {
                     return undefined;
                 }
@@ -317,7 +251,7 @@ const usePrometheus = (config = {}) => {
             });
         },
         onSchemaChange({ schema }) {
-            typeInfo = new TypeInfo(schema);
+            typeInfo = new graphql_1.TypeInfo(schema);
         },
         onParse,
         onValidate,
@@ -325,5 +259,4 @@ const usePrometheus = (config = {}) => {
         onExecute,
     };
 };
-
-export { createCounter, createHistogram, createSummary, usePrometheus };
+exports.usePrometheus = usePrometheus;

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/cjs/utils.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractDeprecatedFields = exports.getHistogramFromConfig = exports.createCounter = exports.createSummary = exports.createHistogram = exports.createInternalContext = exports.shouldTraceFieldResolver = void 0;
+const graphql_1 = require("graphql");
+const prom_client_1 = require("prom-client");
+function shouldTraceFieldResolver(info, whitelist) {
+    if (!whitelist) {
+        return true;
+    }
+    const parentType = info.parentType.name;
+    const fieldName = info.fieldName;
+    const coordinate = `${parentType}.${fieldName}`;
+    return whitelist.includes(coordinate) || whitelist.includes(`${parentType}.*`);
+}
+exports.shouldTraceFieldResolver = shouldTraceFieldResolver;
+function getOperation(document) {
+    return document.definitions[0];
+}
+function createInternalContext(parseResult) {
+    var _a;
+    if (parseResult === null) {
+        return null;
+    }
+    if (parseResult instanceof Error) {
+        return null;
+    }
+    const operation = getOperation(parseResult);
+    return {
+        document: parseResult,
+        operationName: ((_a = operation.name) === null || _a === void 0 ? void 0 : _a.value) || 'Anonymous',
+        operationType: operation.operation,
+    };
+}
+exports.createInternalContext = createInternalContext;
+function createHistogram(options) {
+    return options;
+}
+exports.createHistogram = createHistogram;
+function createSummary(options) {
+    return options;
+}
+exports.createSummary = createSummary;
+function createCounter(options) {
+    return options;
+}
+exports.createCounter = createCounter;
+function getHistogramFromConfig(config, phase, name, help) {
+    return typeof config[phase] === 'object'
+        ? config[phase]
+        : config[phase] === true
+            ? createHistogram({
+                histogram: new prom_client_1.Histogram({
+                    name,
+                    help,
+                    labelNames: ['operationType', 'operationName'],
+                    registers: [config.registry || prom_client_1.register],
+                }),
+                fillLabelsFn: params => ({
+                    operationName: params.operationName,
+                    operationType: params.operationType,
+                }),
+            })
+            : undefined;
+}
+exports.getHistogramFromConfig = getHistogramFromConfig;
+function extractDeprecatedFields(node, typeInfo) {
+    const found = [];
+    (0, graphql_1.visit)(node, (0, graphql_1.visitWithTypeInfo)(typeInfo, {
+        Field: () => {
+            const field = typeInfo.getFieldDef();
+            if (field && (field.deprecationReason != null || field.isDeprecated)) {
+                found.push({
+                    fieldName: field.name,
+                    typeName: typeInfo.getParentType().name || '',
+                });
+            }
+        },
+    }));
+    return found;
+}
+exports.extractDeprecatedFields = extractDeprecatedFields;

package/esm/config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/{index.js → esm/index.js}

@@ -1,101 +1,31 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const core = require('@envelop/core');
-const graphql = require('graphql');
-const promClient = require('prom-client');
-
-function shouldTraceFieldResolver(info, whitelist) {
-    if (!whitelist) {
-        return true;
-    }
-    const parentType = info.parentType.name;
-    const fieldName = info.fieldName;
-    const coordinate = `${parentType}.${fieldName}`;
-    return whitelist.includes(coordinate) || whitelist.includes(`${parentType}.*`);
-}
-function getOperation(document) {
-    return document.definitions[0];
-}
-function createInternalContext(parseResult) {
-    var _a;
-    if (parseResult === null) {
-        return null;
-    }
-    else if (parseResult instanceof Error) {
-        return null;
-    }
-    else {
-        const operation = getOperation(parseResult);
-        return {
-            document: parseResult,
-            operationName: ((_a = operation.name) === null || _a === void 0 ? void 0 : _a.value) || 'Anonymous',
-            operationType: operation.operation,
-        };
-    }
-}
-function createHistogram(options) {
-    return options;
-}
-function createSummary(options) {
-    return options;
-}
-function createCounter(options) {
-    return options;
-}
-function getHistogramFromConfig(config, phase, name, help) {
-    return typeof config[phase] === 'object'
-        ? config[phase]
-        : config[phase] === true
-            ? createHistogram({
-                histogram: new promClient.Histogram({
-                    name,
-                    help,
-                    labelNames: ['operationType', 'operationName'],
-                    registers: [config.registry || promClient.register],
-                }),
-                fillLabelsFn: params => ({
-                    operationName: params.operationName,
-                    operationType: params.operationType,
-                }),
-            })
-            : undefined;
-}
-function extractDeprecatedFields(node, typeInfo) {
-    const found = [];
-    graphql.visit(node, graphql.visitWithTypeInfo(typeInfo, {
-        Field: () => {
-            const field = typeInfo.getFieldDef();
-            if (field && (field.deprecationReason != null || field.isDeprecated)) {
-                found.push({
-                    fieldName: field.name,
-                    typeName: typeInfo.getParentType().name || '',
-                });
-            }
-        },
-    }));
-    return found;
-}
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePrometheus = exports.createSummary = exports.createHistogram = exports.createCounter = void 0;
 /* eslint-disable @typescript-eslint/no-non-null-asserted-optional-chain */
+const core_1 = require("@envelop/core");
+const graphql_1 = require("graphql");
+const prom_client_1 = require("prom-client");
+const utils_js_1 = require("./utils.js");
+Object.defineProperty(exports, "createHistogram", { enumerable: true, get: function () { return utils_js_1.createHistogram; } });
+Object.defineProperty(exports, "createCounter", { enumerable: true, get: function () { return utils_js_1.createCounter; } });
+Object.defineProperty(exports, "createSummary", { enumerable: true, get: function () { return utils_js_1.createSummary; } });
 const promPluginContext = Symbol('promPluginContext');
 const promPluginExecutionStartTimeSymbol = Symbol('promPluginExecutionStartTimeSymbol');
 const usePrometheus = (config = {}) => {
     let typeInfo = null;
-    const parseHistogram = getHistogramFromConfig(config, 'parse', 'graphql_envelop_phase_parse', 'Time spent on running GraphQL "parse" function');
-    const validateHistogram = getHistogramFromConfig(config, 'validate', 'graphql_envelop_phase_validate', 'Time spent on running GraphQL "validate" function');
-    const contextBuildingHistogram = getHistogramFromConfig(config, 'contextBuilding', 'graphql_envelop_phase_context', 'Time spent on building the GraphQL context');
-    const executeHistogram = getHistogramFromConfig(config, 'execute', 'graphql_envelop_phase_execute', 'Time spent on running the GraphQL "execute" function');
+    const parseHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'parse', 'graphql_envelop_phase_parse', 'Time spent on running GraphQL "parse" function');
+    const validateHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'validate', 'graphql_envelop_phase_validate', 'Time spent on running GraphQL "validate" function');
+    const contextBuildingHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'contextBuilding', 'graphql_envelop_phase_context', 'Time spent on building the GraphQL context');
+    const executeHistogram = (0, utils_js_1.getHistogramFromConfig)(config, 'execute', 'graphql_envelop_phase_execute', 'Time spent on running the GraphQL "execute" function');
     const resolversHistogram = typeof config.resolvers === 'object'
         ? config.resolvers
         : config.resolvers === true
-            ? createHistogram({
-                histogram: new promClient.Histogram({
+            ? (0, utils_js_1.createHistogram)({
+                histogram: new prom_client_1.Histogram({
                     name: 'graphql_envelop_execute_resolver',
                     help: 'Time spent on running the GraphQL resolvers',
                     labelNames: ['operationType', 'operationName', 'fieldName', 'typeName', 'returnType'],
-                    registers: [config.registry || promClient.register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => {
                     var _a, _b, _c;
@@ -112,12 +42,12 @@ const usePrometheus = (config = {}) => {
     const requestTotalHistogram = typeof config.requestTotalDuration === 'object'
         ? config.requestTotalDuration
         : config.requestTotalDuration === true
-            ? createHistogram({
-                histogram: new promClient.Histogram({
+            ? (0, utils_js_1.createHistogram)({
+                histogram: new prom_client_1.Histogram({
                     name: 'graphql_envelop_request_duration',
                     help: 'Time spent on running the GraphQL operation from parse to execute',
                     labelNames: ['operationType', 'operationName'],
-                    registers: [config.registry || promClient.register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => ({
                     operationName: params.operationName,
@@ -128,12 +58,12 @@ const usePrometheus = (config = {}) => {
     const requestSummary = typeof config.requestSummary === 'object'
         ? config.requestSummary
         : config.requestSummary === true
-            ? createSummary({
-                summary: new promClient.Summary({
+            ? (0, utils_js_1.createSummary)({
+                summary: new prom_client_1.Summary({
                     name: 'graphql_envelop_request_time_summary',
                     help: 'Summary to measure the time to complete GraphQL operations',
                     labelNames: ['operationType', 'operationName'],
-                    registers: [config.registry || promClient.register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => ({
                     operationName: params.operationName,
@@ -144,12 +74,12 @@ const usePrometheus = (config = {}) => {
     const errorsCounter = typeof config.errors === 'object'
         ? config.errors
         : config.errors === true
-            ? createCounter({
-                counter: new promClient.Counter({
+            ? (0, utils_js_1.createCounter)({
+                counter: new prom_client_1.Counter({
                     name: 'graphql_envelop_error_result',
                     help: 'Counts the amount of errors reported from all phases',
                     labelNames: ['operationType', 'operationName', 'path', 'phase'],
-                    registers: [config.registry || promClient.register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => {
                     var _a, _b;
@@ -165,12 +95,12 @@ const usePrometheus = (config = {}) => {
     const reqCounter = typeof config.requestCount === 'object'
         ? config.requestCount
         : config.requestCount === true
-            ? createCounter({
-                counter: new promClient.Counter({
+            ? (0, utils_js_1.createCounter)({
+                counter: new prom_client_1.Counter({
                     name: 'graphql_envelop_request',
                     help: 'Counts the amount of GraphQL requests executed through Envelop',
                     labelNames: ['operationType', 'operationName'],
-                    registers: [config.registry || promClient.register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => ({
                     operationName: params.operationName,
@@ -181,12 +111,12 @@ const usePrometheus = (config = {}) => {
     const deprecationCounter = typeof config.deprecatedFields === 'object'
         ? config.deprecatedFields
         : config.deprecatedFields === true
-            ? createCounter({
-                counter: new promClient.Counter({
+            ? (0, utils_js_1.createCounter)({
+                counter: new prom_client_1.Counter({
                     name: 'graphql_envelop_deprecated_field',
                     help: 'Counts the amount of deprecated fields used in selection sets',
                     labelNames: ['operationType', 'operationName', 'fieldName', 'typeName'],
-                    registers: [config.registry || promClient.register],
+                    registers: [config.registry || prom_client_1.register],
                 }),
                 fillLabelsFn: params => {
                     var _a, _b;
@@ -200,20 +130,20 @@ const usePrometheus = (config = {}) => {
             })
             : undefined;
     const onParse = ({ context, extendContext, params }) => {
-        if (config.skipIntrospection && core.isIntrospectionOperationString(params.source)) {
+        if (config.skipIntrospection && (0, core_1.isIntrospectionOperationString)(params.source)) {
             return;
         }
         const startTime = Date.now();
         return params => {
             const totalTime = (Date.now() - startTime) / 1000;
-            const internalContext = createInternalContext(params.result);
+            const internalContext = (0, utils_js_1.createInternalContext)(params.result);
             if (internalContext) {
                 extendContext({
                     [promPluginContext]: internalContext,
                 });
                 parseHistogram === null || parseHistogram === void 0 ? void 0 : parseHistogram.histogram.observe(parseHistogram.fillLabelsFn(internalContext, context), totalTime);
                 if (deprecationCounter && typeInfo) {
-                    const deprecatedFields = extractDeprecatedFields(internalContext.document, typeInfo);
+                    const deprecatedFields = (0, utils_js_1.extractDeprecatedFields)(internalContext.document, typeInfo);
                     if (deprecatedFields.length > 0) {
                         for (const depField of deprecatedFields) {
                             deprecationCounter.counter
@@ -281,7 +211,7 @@ const usePrometheus = (config = {}) => {
                         const summaryTime = (Date.now() - args.contextValue[promPluginExecutionStartTimeSymbol]) / 1000;
                         requestSummary.summary.observe(requestSummary.fillLabelsFn(args.contextValue[promPluginContext], args.contextValue), summaryTime);
                     }
-                    if (errorsCounter && !core.isAsyncIterable(result) && result.errors && result.errors.length > 0) {
+                    if (errorsCounter && !(0, core_1.isAsyncIterable)(result) && result.errors && result.errors.length > 0) {
                         for (const error of result.errors) {
                             errorsCounter.counter
                                 .labels(errorsCounter.fillLabelsFn({
@@ -300,7 +230,7 @@ const usePrometheus = (config = {}) => {
     return {
         onResolverCalled: resolversHistogram
             ? ({ info, context }) => {
-                const shouldTrace = shouldTraceFieldResolver(info, config.resolversWhitelist);
+                const shouldTrace = (0, utils_js_1.shouldTraceFieldResolver)(info, config.resolversWhitelist);
                 if (!shouldTrace) {
                     return undefined;
                 }
@@ -321,7 +251,7 @@ const usePrometheus = (config = {}) => {
             });
         },
         onSchemaChange({ schema }) {
-            typeInfo = new graphql.TypeInfo(schema);
+            typeInfo = new graphql_1.TypeInfo(schema);
         },
         onParse,
         onValidate,
@@ -329,8 +259,4 @@ const usePrometheus = (config = {}) => {
         onExecute,
     };
 };
-
-exports.createCounter = createCounter;
-exports.createHistogram = createHistogram;
-exports.createSummary = createSummary;
 exports.usePrometheus = usePrometheus;

package/esm/utils.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractDeprecatedFields = exports.getHistogramFromConfig = exports.createCounter = exports.createSummary = exports.createHistogram = exports.createInternalContext = exports.shouldTraceFieldResolver = void 0;
+const graphql_1 = require("graphql");
+const prom_client_1 = require("prom-client");
+function shouldTraceFieldResolver(info, whitelist) {
+    if (!whitelist) {
+        return true;
+    }
+    const parentType = info.parentType.name;
+    const fieldName = info.fieldName;
+    const coordinate = `${parentType}.${fieldName}`;
+    return whitelist.includes(coordinate) || whitelist.includes(`${parentType}.*`);
+}
+exports.shouldTraceFieldResolver = shouldTraceFieldResolver;
+function getOperation(document) {
+    return document.definitions[0];
+}
+function createInternalContext(parseResult) {
+    var _a;
+    if (parseResult === null) {
+        return null;
+    }
+    if (parseResult instanceof Error) {
+        return null;
+    }
+    const operation = getOperation(parseResult);
+    return {
+        document: parseResult,
+        operationName: ((_a = operation.name) === null || _a === void 0 ? void 0 : _a.value) || 'Anonymous',
+        operationType: operation.operation,
+    };
+}
+exports.createInternalContext = createInternalContext;
+function createHistogram(options) {
+    return options;
+}
+exports.createHistogram = createHistogram;
+function createSummary(options) {
+    return options;
+}
+exports.createSummary = createSummary;
+function createCounter(options) {
+    return options;
+}
+exports.createCounter = createCounter;
+function getHistogramFromConfig(config, phase, name, help) {
+    return typeof config[phase] === 'object'
+        ? config[phase]
+        : config[phase] === true
+            ? createHistogram({
+                histogram: new prom_client_1.Histogram({
+                    name,
+                    help,
+                    labelNames: ['operationType', 'operationName'],
+                    registers: [config.registry || prom_client_1.register],
+                }),
+                fillLabelsFn: params => ({
+                    operationName: params.operationName,
+                    operationType: params.operationType,
+                }),
+            })
+            : undefined;
+}
+exports.getHistogramFromConfig = getHistogramFromConfig;
+function extractDeprecatedFields(node, typeInfo) {
+    const found = [];
+    (0, graphql_1.visit)(node, (0, graphql_1.visitWithTypeInfo)(typeInfo, {
+        Field: () => {
+            const field = typeInfo.getFieldDef();
+            if (field && (field.deprecationReason != null || field.isDeprecated)) {
+                found.push({
+                    fieldName: field.name,
+                    typeName: typeInfo.getParentType().name || '',
+                });
+            }
+        },
+    }));
+    return found;
+}
+exports.extractDeprecatedFields = extractDeprecatedFields;

package/package.json

@@ -1,34 +1,55 @@
 {
   "name": "@envelop/prometheus",
-  "version": "6.4.0-alpha-c0cc559.0",
+  "version": "6.4.0-alpha-e9434aa.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.0-alpha-c0cc559.0",
-    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0",
-    "prom-client": "^13 || ^14.0.0"
+    "@envelop/core": "2.4.0-alpha-e9434aa.0",
+    "prom-client": "^13 || ^14.0.0",
+    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/dotansimha/envelop.git",
+    "url": "https://github.com/n1ru4l/envelop.git",
     "directory": "packages/plugins/prometheus"
   },
   "author": "Dotan Simha <dotansimha@gmail.com>",
   "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
   "typescript": {
-    "definition": "index.d.ts"
+    "definition": "typings/index.d.ts"
   },
+  "type": "module",
   "exports": {
     ".": {
-      "require": "./index.js",
-      "import": "./index.mjs"
+      "require": {
+        "types": "./typings/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "import": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      }
     },
     "./*": {
-      "require": "./*.js",
-      "import": "./*.mjs"
+      "require": {
+        "types": "./typings/*.d.ts",
+        "default": "./cjs/*.js"
+      },
+      "import": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      },
+      "default": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      }
     },
     "./package.json": "./package.json"
   }
-}
+}

package/{config.d.ts → typings/config.d.ts}

@@ -1,4 +1,4 @@
-import { createCounter, createHistogram, createSummary } from './utils';
+import { createCounter, createHistogram, createSummary } from './utils.js';
 import { Registry } from 'prom-client';
 export declare type PrometheusTracingPluginConfig = {
     requestCount?: boolean | ReturnType<typeof createCounter>;

package/{index.d.ts → typings/index.d.ts}

@@ -1,6 +1,6 @@
 import { Plugin } from '@envelop/core';
-import { createHistogram, createCounter, FillLabelsFnParams, createSummary } from './utils';
-import { PrometheusTracingPluginConfig } from './config';
+import { createHistogram, createCounter, FillLabelsFnParams, createSummary } from './utils.js';
+import { PrometheusTracingPluginConfig } from './config.js';
 export { PrometheusTracingPluginConfig, createCounter, createHistogram, createSummary, FillLabelsFnParams };
 declare const promPluginContext: unique symbol;
 declare const promPluginExecutionStartTimeSymbol: unique symbol;

package/{utils.d.ts → typings/utils.d.ts}

@@ -1,6 +1,6 @@
 import { GraphQLError, DocumentNode, OperationDefinitionNode, GraphQLResolveInfo, TypeInfo, ASTNode } from 'graphql';
 import { AfterParseEventPayload } from '@envelop/core';
-import { PrometheusTracingPluginConfig } from './config';
+import { PrometheusTracingPluginConfig } from './config.js';
 import { Counter, Histogram, Summary } from 'prom-client';
 export declare type DeprecatedFieldInfo = {
     fieldName: string;

package/README.md

@@ -1,112 +0,0 @@
-## `@envelop/prometheus`
-
-This plugin tracks the complete execution flow, and reports metrics using Prometheus tracing (based on `prom-client`).
-
-You can opt-in to collect tracing from the following phases:
-
-- Sucessfull requests (`requestCount`)
-- Request summary (`requestSummary`)
-- errors (categorized by `phase`)
-- resolvers tracing and runtime
-- deprecated fields usage
-- count of graphql operations
-- `parse` execution time
-- `validate` execution time
-- `contextBuilding` execution time
-- `execute` execution time
-
-> You can also customize each phase reporter, and add custom metadata and labels to the metrics.
-
-## Getting Started
-
-```
-yarn add prom-client @envelop/prometheus
-```
-
-## Usage Example
-
-```ts
-import { envelop } from '@envelop/core';
-import { usePrometheus } from '@envelop/prometheus';
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    usePrometheus({
-      // all optional, and by default, all set to false, please opt-in to the metrics you wish to get
-      requestCount: true, // requries `execute` to be true as well
-      requestSummary: true, // requries `execute` to be true as well
-      parse: true,
-      validate: true,
-      contextBuilding: true,
-      execute: true,
-      errors: true,
-      resolvers: true, // requires "execute" to be `true` as well
-      resolversWhitelist: ['Mutation.*', 'Query.user'], // reports metrics als for these resolvers, leave `undefined` to report all fields
-      deprecatedFields: true,
-      registry: myRegistry, // If you are using a custom prom-client registry, please set it here
-    }),
-  ],
-});
-```
-
-> Note: Tracing resolvers using `resovlers: true` might have a performance impact on your GraphQL runtime. Please consider to test it locally first and then decide if it's needed.
-
-### Custom registry
-
-You can customize the `prom-client` `Registry` object if you are using a custom one, by passing it along with the configuration object:
-
-```ts
-import { Registry } from 'prom-client';
-
-const myRegistry = new Registry();
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    usePrometheus({
-      // ... config ...
-      registry: myRegistry,
-    }),
-  ],
-});
-```
-
-> Note: if you are using custom `prom-client` instances, you need to make sure to pass your registry there as well.
-
-### Introspection
-
-If you wish to disable introspection logging, you can use `skipIntrospection: true` in your config object.
-
-### Custom `prom-client` instances
-
-Each tracing field supports custom `prom-client` objects, and custom `labels` a metadata, you can create a custom extraction function for every `Histogram` / `Summary` / `Counter`:
-
-```ts
-import { Histogram } from 'prom-client';
-import { envelop } from '@envelop/core';
-import { createHistogram, usePrometheus } from '@envelop/prometheus';
-
-const getEnveloped = envelop({
-  plugins: [
-    // ... other plugins ...
-    usePrometheus({
-      // all optional, and by default, all set to false, please opt-in to the metrics you wish to get
-      parse: createHistogram({
-        histogram: new Histogram({
-          name: 'my_custom_name',
-          help: 'HELP ME',
-          labelNames: ['opText'] as const,
-          registers: [registry], // make sure to add your custom registry, if you are not using the default one
-        }),
-        fillLabelsFn: params => {
-          // if you wish to fill your `lables` with metadata, you can use the params in order to get access to things like DocumentNode, operationName, operationType, `error` (for error metrics) and `info` (for resolvers metrics)
-          return {
-            opText: print(params.document),
-          };
-        },
-      }),
-    }),
-  ],
-});
-```