@platformatic/sql-graphql 1.3.0 → 1.4.0

package/index.js

@@ -8,6 +8,7 @@ const { mercuriusFederationPlugin } = require('@mercuriusjs/federation')
 const { findNearestString } = require('@platformatic/utils')
 const establishRelations = require('./lib/relationship')
 const setupSubscriptions = require('./lib/subscriptions')
+const setupTelemetry = require('./lib/telemetry')
 const scalars = require('graphql-scalars')
 const errors = require('./lib/errors')
 
@@ -186,6 +187,10 @@ async function mapperToGraphql (app, opts) {
     resolvers
   })
 
+  if (app.openTelemetry) {
+    setupTelemetry(app)
+  }
+
   app.log.debug({ schema: sdl }, 'computed schema')
 }
 

package/lib/telemetry.js

@@ -0,0 +1,55 @@
+'use strict'
+
+const telemetryWrapper = (app, fn, operationType, operationName) => async (...args) => {
+  const { startInternalSpan, endInternalSpan } = app.openTelemetry
+  const context = args[2]
+  const request = context?.reply?.request
+  const document = JSON.stringify(request?.body)
+
+  // GraphQL semantic conventions, see: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/graphql.md#semantic-conventions-for-graphql-server
+  const telemetryAttributes = {
+    'graphql.document': document,
+    'graphql.operation.name': operationName,
+    'graphql.operation.type': operationType
+  }
+  const spanName = `${operationType} ${operationName}`
+  const ctx = request.span?.context
+
+  const span = startInternalSpan(spanName, ctx, telemetryAttributes)
+  try {
+    const result = await fn(...args)
+    endInternalSpan(span)
+    return result
+  // We ignore this because in sqlite it's HARD to have a resolver exception without a schema validation exception first.
+  } catch (err) /* istanbul ignore next */ {
+    endInternalSpan(span, err)
+    throw err
+  }
+}
+
+const setupTelemetry = app => {
+  /* istanbul ignore next */
+  if (!app || !app.graphql) {
+    app.log.warn('No graphql plugin found, skipping telemetry setup')
+    return
+  }
+  const schema = app.graphql.schema
+  /* istanbul ignore next */
+  if (!schema) {
+    app.log.warn('No graphql schema found, skipping telemetry setup')
+    return
+  }
+  const schemaTypeMap = schema.getTypeMap()
+  for (const schemaType of Object.values(schemaTypeMap)) {
+    const schemaTypeName = schemaType.name.toLowerCase() // query, mutation, subscription
+    if (typeof schemaType.getFields === 'function') {
+      for (const [fieldName, field] of Object.entries(schemaType.getFields())) {
+        if (typeof field.resolve === 'function') {
+          field.resolve = telemetryWrapper(app, field.resolve, schemaTypeName, fieldName)
+        }
+      }
+    }
+  }
+}
+
+module.exports = setupTelemetry

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-graphql",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Map SQL dbs to GraphQL",
   "main": "index.js",
   "types": "index.d.ts",
@@ -22,8 +22,9 @@
     "tap": "^16.3.9",
     "tsd": "^0.29.0",
     "ws": "^8.14.2",
-    "@platformatic/sql-events": "1.3.0",
-    "@platformatic/sql-mapper": "1.3.0"
+    "@platformatic/sql-events": "1.4.0",
+    "@platformatic/sql-mapper": "1.4.0",
+    "@platformatic/telemetry": "1.4.0"
   },
   "dependencies": {
     "@fastify/error": "^3.3.0",
@@ -35,7 +36,7 @@
     "graphql-type-json": "^0.3.2",
     "inflected": "^2.1.0",
     "mercurius": "^13.1.0",
-    "@platformatic/utils": "1.3.0"
+    "@platformatic/utils": "1.4.0"
   },
   "tsd": {
     "directory": "test/types"