GraphQL Yoga 5.13.0 版本发布：新增 Instruments API 与多项改进

GraphQL Yoga 是一个功能强大且灵活的 GraphQL 服务器实现，它基于现代 Web 标准构建，提供了简单易用的 API 和丰富的插件生态系统。在最新发布的 5.13.0 版本中，GraphQL Yoga 引入了一个重要的新特性——Instruments API，同时对多个核心组件进行了升级和优化。

Instruments API：全新的可观测性解决方案

5.13.0 版本最显著的改进是新增了 Instruments API，这是一个专门为监控、追踪等可观测性需求设计的全新接口。与现有的 Hooks 系统不同，Instruments API 能够在整个阶段处理过程（包括插件钩子执行）的前后运行自定义代码，而不直接访问阶段的输入输出。

Instruments API 的核心特点

1. 执行范围更广：可以包装整个阶段的处理流程，包括所有插件钩子的执行
2. 专注可观测性：特别适合用于监控、错误追踪和性能分析
3. 灵活的组合方式：支持多个 Instruments 插件的有序组合

基本使用示例

import { createYoga } from 'graphql-yoga'
import Sentry from '@sentry/node'
import schema from './schema'

const server = createYoga({
  schema,
  plugins: [
    {
      instruments: {
        request: ({ request }, wrapped) =>
          Sentry.startSpan({ name: 'Graphql Operation' }, async () => {
            try {
              await wrapped()
            } catch (err) {
              Sentry.captureException(err)
            }
          })
      }
    }
  ]
})

多 Instruments 插件的组合

当使用多个 Instruments 插件（如同时使用 Prometheus 和 Sentry）时，它们会按照插件数组的顺序自动组合——第一个插件是最外层，最后一个插件是最内层。

如果需要自定义组合顺序，可以使用 composeInstruments 方法手动组合：

import { composeInstruments, createYoga } from 'graphql-yoga'
import schema from './schema'

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

const server = createYoga({
  schema,
  plugins: [{ instruments }, useSentry(), useOpentelemetry()]
})

其他重要改进

除了引入 Instruments API 外，5.13.0 版本还包含以下重要更新：

1. 依赖项升级：

   • 更新了 @envelop/core 到 5.2.1 版本
   • 新增了 @envelop/instruments 和 @whatwg-node/promise-helpers 依赖
   • 升级 @whatwg-node/server 到 0.10.0 版本

2. 插件兼容性更新：

   • 多个官方插件（如 Apollo Federation、Prometheus、Response Cache 等）都进行了相应的依赖更新，确保与新版本核心的兼容性

3. 性能优化：

   • 通过更新底层依赖，整体性能有所提升
   • 改进了异步处理的效率

升级建议

对于现有用户，升级到 5.13.0 版本通常是安全的，因为大部分变更都是向后兼容的。特别是对于需要增强可观测性的项目，建议尝试新的 Instruments API 来替代或补充现有的监控方案。

对于新项目，5.13.0 版本提供了更完善的工具链和更好的性能，是理想的起点。开发者可以根据项目需求选择合适的插件组合，构建高效、可观测的 GraphQL 服务。

GraphQL Yoga 持续致力于提供简单而强大的 GraphQL 服务器解决方案，5.13.0 版本的发布进一步巩固了它在这一领域的地位。