feat: useApolloInlineTrace plugin for Apollo's federated tracing

.changeset/khaki-coins-tie.md

@@ -0,0 +1,5 @@
+---
+'@envelop/apollo-inline-trace': major
+---
+
+Implementation of Apollo's federated inline tracing

packages/plugins/apollo-inline-trace/README.md

@@ -0,0 +1,54 @@
+## `@envelop/apollo-inline-trace`
+
+This plugin integrates Apollo's FTV1 tracing. Read more about it on [Apollo's website about federated trace data](https://www.apollographql.com/docs/federation/metrics/).
+
+## Getting Started
+
+```
+yarn add @envelop/apollo-inline-trace
+```
+
+## Usage Example
+
+```ts
+import { parse, validate, execute, subscribe } from 'graphql'
+import { envelop } from '@envelop/core'
+import { useApolloInlineTrace } from '@envelop/apollo-inline-trace'
+
+const getEnveloped = envelop({
+  parse,
+  validate,
+  execute,
+  subscribe,
+  plugins: [
+    useApolloInlineTrace({
+      // request must specify the ftv1 tracing protocol
+      shouldTrace: ctx => ctx.req.headers['apollo-federation-include-trace'] === 'ftv1'
+    })
+  ]
+})
+
+const server = createServer((req, res) => {
+  let payload = ''
+
+  req.on('data', chunk => {
+    payload += chunk.toString()
+  })
+
+  req.on('end', async () => {
+    const { perform } = getEnveloped({ req })
+
+    const { query, variables } = JSON.parse(payload)
+
+    const result = await perform({ query, variables })
+
+    res.end(JSON.stringify(result))
+  })
+})
+
+server.listen(3000)
+```
+
+## Note
+
+For accurate tracing behaviour, you MUST use the `perform` function from `getEnveloped`.

packages/plugins/apollo-inline-trace/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@envelop/apollo-inline-trace",
+  "version": "0.0.0",
+  "description": "Apollo's federated tracing plugin.",
+  "license": "MIT",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/n1ru4l/envelop.git",
+    "directory": "packages/plugins/apollo-inline-trace"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/typings/index.d.cts",
+        "default": "./dist/cjs/index.js"
+      },
+      "import": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "default": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    },
+    "./*": {
+      "require": {
+        "types": "./dist/typings/*.d.cts",
+        "default": "./dist/cjs/*.js"
+      },
+      "import": {
+        "types": "./dist/typings/*.d.ts",
+        "default": "./dist/esm/*.js"
+      },
+      "default": {
+        "types": "./dist/typings/*.d.ts",
+        "default": "./dist/esm/*.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "typings": "dist/typings/index.d.ts",
+  "typescript": {
+    "definition": "dist/typings/index.d.ts"
+  },
+  "peerDependencies": {
+    "@envelop/core": "^2.5.0",
+    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
+  },
+  "dependencies": {
+    "@envelop/on-resolve": "^1.0.0",
+    "apollo-reporting-protobuf": "^3.3.2"
+  },
+  "buildOptions": {
+    "input": "./src/index.ts"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "access": "public"
+  },
+  "type": "module"
+}