Releases · n1ru4l/envelop

This new API differs from already existing Hooks by not having access to intup/output of phases.
The goal of Instruments is to run allow running code before, after or araound the whole
process of a phase, incuding plugins hooks executions.

The main use case of this new API is observability (monitoring, tracing, etc...).

Basic usage

import { envelop } from '@envelop/core'
import Sentry from '@sentry/node'

const getEnveloped = envelop({
  plugins: [
    {
      instruments: {
        execute: ({ context }, wrapped) =>
          Sentry.startSpan({ name: 'Graphql Operation' }, async () => {
            try {
              await wrapped()
            } catch (err) {
              Sentry.captureException(err)
            }
          })
      }
    }
  ]
})

Mutliple instruments plugins

It is possilbe to have multiple instruments plugins (Prometheus and Sentry for example), they will
be automatically composed by envelop in the same order than the plugin array (first is outtermost,
last is inner most).

import { useOpentelemetry } from '@envelop/opentelemetry'
import { useSentry } from '@envelop/sentry'

const getEnveloped = envelop({
  plugins: [useSentry(), useOpentelemetry()]
})

sequenceDiagram
  Sentry->>Opentelemetry: ;
  Opentelemetry->>Envelop: ;
  Envelop->>Opentelemetry: ;
  Opentelemetry->>Sentry: ;

Custom instruments ordering

If the default composition ordering doesn't suite your need, you can mannually compose
instruments. This allows to have a different execution order of hooks and instruments.

import { useOpentelemetry } from '@envelop/opentelemetry'
import { composeInstruments, useSentry } from '@envelop/sentry'

const { instruments: sentryInstruments, ...sentryPlugin } = useSentry()
const { instruments: otelInstruments, ...otelPlugin } = useOpentelemetry()
const instruments = composeInstruments([otelInstruments, sentryInstruments])

const getEnveloped = envelop({
  plugins: [{ instruments }, sentryPlugin, otelPlugin]
})

sequenceDiagram
  Opentelemetry->>Sentry: ;
  Sentry->>Envelop: ;
  Envelop->>Sentry: ;
  Sentry->>Opentelemetry: ;

Patch Changes

#2430
a107c89
Thanks @EmrysMyrddin! - dependencies updates:
- Added dependency
  @envelop/instruments@workspace:^ ↗︎
  (to dependencies)
Updated dependencies
[a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
a107c89]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[a107c89,
[a107c89](a107...

Assets 2

25 Feb 13:49

theguild-bot

release-1740491371002

adad2da

February 25, 2025

@envelop/[email protected]

Patch Changes

#2455
5b6a166
Thanks @ardatan! - dependencies updates:
- Added dependency
  @whatwg-node/promise-helpers@^1.0.0 ↗︎
  (to dependencies)
Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166,
5b6a166,
5b6a166]:
- @envelop/[email protected]
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166,
5b6a166]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

#2455
5b6a166
Thanks @ardatan! - dependencies updates:
- Added dependency
  @whatwg-node/promise-helpers@^1.0.0 ↗︎
  (to dependencies)
Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166,
5b6a166]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166,
5b6a166]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

#2455
5b6a166
Thanks @ardatan! - dependencies updates:
- Added dependency
  @whatwg-node/promise-helpers@^1.0.0 ↗︎
  (to dependencies)
Updated dependencies
[5b6a166,
5b6a166]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies []:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166]:
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

Updated dependencies
[5b6a166,
5b6a166]:
- @envelop/[email protected]
- @envelop/[email protected]

@envelop/[email protected]

Patch Changes

#2455
5b6a166
Thanks @ardatan! - dependencies updates:
- Added dependency
  [@whatwg-node/promise-helpers@^1.0.0 ↗︎](https://www.npmjs.com/package/@whatwg-node/promise-helpers/v/1...

Assets 2

20 Feb 12:44

theguild-bot

release-1740055470785

08fff3b

February 20, 2025

@envelop/[email protected]

Patch Changes

#2443
75ae40e
Thanks @ardatan! - dependencies updates:
- Added dependency lodash.get@^4.4.2 ↗︎ (to
  dependencies)
- Added dependency ms@^2.1.3 ↗︎ (to dependencies)
- Removed dependency
  graphql-middleware@^6.1.35 ↗︎
  (from dependencies)
- Removed dependency
  graphql-rate-limit@^3.3.0 ↗︎
  (from dependencies)

Assets 2

19 Feb 11:15

theguild-bot

release-1739963732059

0b8fb8d

February 19, 2025

@envelop/[email protected]

Patch Changes

#2440
61a88d8
Thanks @renovate! - dependencies updates:
- Updated dependency
  graphql-modules@^1 || ^2.0.0 || ^3.0.0 ↗︎
  (from ^1 || ^2.0.0, in peerDependencies)

Assets 2

19 Feb 00:30

theguild-bot

release-1739925011657

57a6fea

February 19, 2025

@envelop/[email protected]

Minor Changes

#2438
9bd1b20
Thanks @ardatan! - Add context field to onExecute and
onSubscribe hooks payloads. This harmonize all the hooks invovled in the handling of a graphql
operation.