Upcoming Release Changes

[theguild-bot]

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.

Releases

@envelop/rate-limiter@6.2.0

Minor Changes

• #2292 c3dd2c3 Thanks @ardatan! - Now you can define a custom string interpolation function to be used in the rate limit message. This is useful when you want to include dynamic values in the message.

  useRateLimiter({
    configByField: [
      {
        type: 'Query',
        field: 'search', // You can also use glob patterns
        max: 10,
        window: '1m',
        message:
          'My custom message with interpolated values: ${args.searchTerm} and ${context.user.id}'
      }
    ],
    interpolateMessage: (message, args, context) => {
      return message.replace(/\${(.*?)}/g, (_, key) => {
        return key.split('.').reduce((acc, part) => acc[part], { args, context })
      })
    }
  })

• #2292 c3dd2c3 Thanks @ardatan! - New directive SDL;

  directive @rateLimit(
    max: Int
    window: String
    message: String
    identityArgs: [String]
    arrayLengthField: String
    readOnly: Boolean
    uncountRejected: Boolean
  ) on FIELD_DEFINITION

• #2292 c3dd2c3 Thanks @ardatan! - Programmatic API to define rate limit configuration in addition to directives

  useRateLimiter({
    configByField: [
      {
        type: 'Query',
        field: 'search', // You can also use glob patterns
        max: 10,
        window: '1m'
      }
    ]
  })

Patch Changes

• #2292 c3dd2c3 Thanks @ardatan! - dependencies updates:

  • Updated dependency graphql-rate-limit@^3.3.0 ↗︎ (from 3.3.0, in dependencies)
  • Added dependency @graphql-tools/utils@^10.5.4 ↗︎ (to dependencies)
  • Added dependency minimatch@^10.0.1 ↗︎ (to dependencies)

• #2276 ba368ba Thanks @deggertsen! - useRateLimiter will now accept all options available to graphql-rate-limit getGraphQLRateLimiter function so that they are usable.

• Updated dependencies [c3dd2c3, c3dd2c3]:

  • @envelop/on-resolve@4.1.1
  • @envelop/core@5.0.2

@envelop/core@5.0.2

Patch Changes

• #2292 c3dd2c3 Thanks @ardatan! - Export mapMaybePromise and isPromise

@envelop/on-resolve@4.1.1

Patch Changes

• #2292 c3dd2c3 Thanks @ardatan! - Refactor the plugin to avoid extra promises with `mapMaybePromise`

• Updated dependencies [c3dd2c3]:

  • @envelop/core@5.0.2

[github-actions[bot]]

🚀 Snapshot Release (rc)

The latest changes of this PR are available as rc on npm (based on the declared changesets):	Package	Version	Info
@envelop/rate-limiter	6.1.1-rc-20240820084114-e4d069a64c2fcf0911a1eca73c890680f1a13c4a	npm ↗︎ unpkg ↗︎

[github-actions[bot]]

### 💻 Website Preview The latest changes are available as preview in: [https://c7466d5d.envelop.pages.dev](https://c7466d5d.envelop.pages.dev)

[theguild-bot]

✅ Benchmark Results

     ✓ no_errors
     ✓ expected_result

     checks.............................................: 100.00% ✓ 773636      ✗ 0     
     ✓ { mode:envelop-cache-and-no-internal-tracing }...: 100.00% ✓ 163556      ✗ 0     
     ✓ { mode:envelop-cache-jit }.......................: 100.00% ✓ 342404      ✗ 0     
     ✓ { mode:envelop-just-cache }......................: 100.00% ✓ 164290      ✗ 0     
     ✓ { mode:graphql-js }..............................: 100.00% ✓ 103386      ✗ 0     
     data_received......................................: 3.0 GB  25 MB/s
     data_sent..........................................: 168 MB  1.4 MB/s
     envelop_init.......................................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     envelop_total......................................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     event_loop_lag.....................................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-and-no-internal-tracing }...: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     graphql_context....................................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     graphql_execute....................................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     graphql_parse......................................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     graphql_validate...................................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-cache-jit }.......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:envelop-just-cache }......................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     ✓ { mode:graphql-js }..............................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     http_req_blocked...................................: avg=1.95µs  min=662ns    med=1.79µs  max=3.22ms  p(90)=2.29µs  p(95)=2.57µs 
     http_req_connecting................................: avg=23ns    min=0s       med=0s      max=1.01ms  p(90)=0s      p(95)=0s     
     http_req_duration..................................: avg=2.82ms  min=165.68µs med=2.8ms   max=36.28ms p(90)=5.11ms  p(95)=6.12ms 
       { expected_response:true }.......................: avg=2.82ms  min=165.68µs med=2.8ms   max=36.28ms p(90)=5.11ms  p(95)=6.12ms 
     ✓ { mode:envelop-cache-and-no-internal-tracing }...: avg=3.4ms   min=493.53µs med=3.05ms  max=18.5ms  p(90)=5.72ms  p(95)=6.27ms 
     ✓ { mode:envelop-cache-jit }.......................: avg=1.45ms  min=165.68µs med=1.21ms  max=18.56ms p(90)=2.43ms  p(95)=2.59ms 
     ✓ { mode:envelop-just-cache }......................: avg=3.37ms  min=362.71µs med=3.02ms  max=21.94ms p(90)=5.7ms   p(95)=6.21ms 
     ✓ { mode:graphql-js }..............................: avg=5.54ms  min=878.62µs med=4.76ms  max=36.28ms p(90)=9.24ms  p(95)=10.03ms
     http_req_failed....................................: 0.00%   ✓ 0           ✗ 386818
     http_req_receiving.................................: avg=34.3µs  min=12.42µs  med=30.36µs max=8.49ms  p(90)=45.54µs p(95)=49.07µs
     http_req_sending...................................: avg=13.41µs min=4.16µs   med=10.85µs max=13.25ms p(90)=20.14µs p(95)=21.42µs
     http_req_tls_handshaking...........................: avg=0s      min=0s       med=0s      max=0s      p(90)=0s      p(95)=0s     
     http_req_waiting...................................: avg=2.77ms  min=135.5µs  med=2.75ms  max=36.21ms p(90)=5.06ms  p(95)=6.07ms 
     http_reqs..........................................: 386818  3223.344165/s
     iteration_duration.................................: avg=3.09ms  min=354.9µs  med=3.05ms  max=37.14ms p(90)=5.39ms  p(95)=6.4ms  
     iterations.........................................: 386818  3223.344165/s
     vus................................................: 10      min=10        max=10  
     vus_max............................................: 20      min=20        max=20