fix: further exclude common context values

rocket-connect · Sep 1, 2023 · 5821093 · 5821093
1 parent 4fc898c
commit 5821093
Show file tree

Hide file tree

Showing 5 changed files with 182 additions and 7 deletions.
diff --git a/graphql-otel.com/package-lock.json b/graphql-otel.com/package-lock.json
diff --git a/package/package-lock.json b/package/package-lock.json
diff --git a/package/package.json b/package/package.json
@@ -1,6 +1,6 @@
 {
   "name": "graphql-otel",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Opentelemetry GraphQL Schema Directives.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

diff --git a/package/src/utils.ts b/package/src/utils.ts
@@ -1,12 +1,23 @@
 import safeJsonStringify from "safe-json-stringify";
 
+export const excludedKeys = [
+  "req",
+  "_req",
+  "request",
+  "_request",
+  "res",
+  "_res",
+  "params",
+  "_params",
+];
+
 export function safeJson(object: any) {
   return safeJsonStringify(object || {}, (key, value) => {
     if (typeof value === "bigint") {
       return value.toString();
     }
 
-    if (["req", "_req", "request", "_request"].includes(key)) {
+    if (excludedKeys.includes(key)) {
       return undefined;
     }
 

diff --git a/package/tests/trace.test.ts b/package/tests/trace.test.ts
@@ -19,6 +19,8 @@ import { GraphQLOTELContext } from "../src/context";
 import { SpanStatusCode } from "@opentelemetry/api";
 import { AttributeName } from "../src/trace-directive";
 import { describe, beforeEach, test, expect } from "@jest/globals";
+import { excludedKeys } from "../src/utils";
+import exp from "constants";
 
 const util = require("util");
 const sleep = util.promisify(setTimeout);
@@ -443,6 +445,24 @@ describe("@trace directive", () => {
         _req: {
           url: "http://localhost:3000/graphql",
         },
+        request: {
+          url: "http://localhost:3000/graphql",
+        },
+        _request: {
+          url: "http://localhost:3000/graphql",
+        },
+        res: {
+          statusCode: 200,
+        },
+        _res: {
+          statusCode: 200,
+        },
+        params: {
+          statusCode: 200,
+        },
+        _params: {
+          statusCode: 200,
+        },
         someFunction: () => {},
       },
     });
@@ -471,7 +491,7 @@ describe("@trace directive", () => {
     const context = JSON.parse(
       spanTree.span.attributes[AttributeName.OPERATION_CONTEXT] as string
     );
-    expect(context).toMatchObject({
+    expect(context).toEqual({
       name: randomName,
       someFunction: "Function",
     });