fix: errorFormatter relative to project root and improved merging o…

…f protocol config (#129)

* Create a symlink to self to enable test projects to require `@cap-js/graphql`

* Revert "Create a symlink to self to enable test projects to require `@cap-js/graphql`"

This reverts commit 60d7d0f.

* Add dev dependency to self

* Re-add self requires in tests

* Configure protocol path in test project `package.json`

* Improve merging of protocol configuration with plugin defaults

* Replace more programmatic with declarative configs

* Load custom `errorFormatter` relative to CDS project root

* Single quotes instead of double quotes

* Remove `impl` from config

* Improve readability of loading error formatter

* Another declarative instead of programmatic config

* Simpler programmatic config that points to module name

* Reorder imports

CHANGELOG.md

@@ -12,9 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Moved registration of `cds.compile.to.gql` and `cds.compile.to.graphql` targets from `@sap/cds` to `@cap-js/graphql`
+- Improve merging of custom `graphql` protocol configuration with plugin default configuration
 
 ### Fixed
 
+- Load custom `errorFormatter` relative to CDS project root
+
 ### Removed
 
 ## Version 0.8.0 - 2023-10-06

cds-plugin.js

@@ -1,6 +1,6 @@
 const cds = require('@sap/cds')
 require('./lib/api').registerCompileTargets()
+const defaults = { path: '/graphql', impl: '@cap-js/graphql' }
 const protocols = cds.env.protocols ??= {}
-if (!protocols.graphql) protocols.graphql = {
-  path: "/graphql", impl: "@cap-js/graphql"
-}
+protocols.graphql ??= {}
+protocols.graphql = { ...defaults, ...protocols.graphql}

lib/GraphQLAdapter.js

@@ -1,5 +1,8 @@
 const express = require('express')
 const { generateSchema4 } = require('./schema')
+const path = require('path')
+const cds = require('@sap/cds')
+const defaultErrorFormatter = require('./errorFormatter')
 const queryLogger = require('./logger')
 const graphiql = require('../app/graphiql')
 const { createHandler } = require('graphql-http/lib/use/express')
@@ -8,11 +11,13 @@ const { formatError } = require('./resolvers/error')
 function GraphQLAdapter(options) {
   const router = express.Router()
   const { services } = options
-  const defaults = { graphiql: true, errorFormatter: './errorFormatter' }
+  const defaults = { graphiql: true }
   const schema = generateSchema4(services)
   options = { ...defaults, ...options }
 
-  const errorFormatter = require(options.errorFormatter)
+  const errorFormatter = options.errorFormatter
+    ? require(path.join(cds.root, options.errorFormatter))
+    : defaultErrorFormatter
 
   router
     .use(express.json()) //> required by logger below

package.json

@@ -39,6 +39,7 @@
     "@sap/cds": ">=7.3"
   },
   "devDependencies": {
+    "@cap-js/graphql": "file:.",
     "axios": "^1",
     "eslint": "^8",
     "express": "^4.17.1",

test/resources/annotations/package.json

@@ -0,0 +1,12 @@
+{
+  "dependencies": {
+    "@cap-js/graphql": "*"
+  },
+  "cds": {
+    "protocols": {
+      "graphql": {
+        "path": "/custom-graphql-path"
+      }
+    }
+  }
+}

test/resources/bookshop-graphql/package.json

@@ -1,6 +1,6 @@
 {
   "dependencies": {
-    "@cap-js/graphql": "../../.."
+    "@cap-js/graphql": "*"
   },
   "cds": {
     "requires": {

test/resources/cds.Request/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@cap-js/graphql": "*"
+  }
+}

test/resources/concurrency/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@cap-js/graphql": "*"
+  }
+}

test/resources/custom-error-formatter/package.json

@@ -0,0 +1,13 @@
+{
+  "dependencies": {
+    "@cap-js/graphql": "*"
+  },
+  "cds": {
+    "protocols": {
+      "graphql": {
+        "path": "/graphql",
+        "errorFormatter": "customErrorFormatter"
+      }
+    }
+  }
+}

test/resources/custom-handlers/server.js

@@ -1,6 +1,4 @@
 const cds = require('@sap/cds')
-const path = require('path')
+// Programmatic configuration of GraphQL protocol adapter
 const protocols = cds.env.protocols ??= {}
-if (!protocols.graphql) protocols.graphql = {
-  path: '/graphql', impl: path.join(__dirname, '../../../index.js')
-}
+protocols.graphql = { path: '/graphql', impl: '@cap-js/graphql' }

test/resources/error-handling/package.json

@@ -1,4 +1,7 @@
 {
+  "dependencies": {
+    "@cap-js/graphql": "*"
+  },
   "cds": {
     "requires": {
       "db": {