Merge pull request #149 from dreamit-de/148-prom-fix

148 Switch to graphql-server-base

README.md

@@ -13,16 +13,16 @@ TypeScript declarations are provided within the project.
 
 ## Compatibility
 
-The following table shows which version of [graphql-js][1] library is compatible with which version of
-`@dreamit/graphql-server`. As `@dreamit/graphql-server` defines [graphql-js][1] as peerDependency you might want to
-choose a fitting version according to the [graphql-js][1] version used in your project and by other libraries depending
-on [graphql-js][1].
+The following table shows which version of [graphql-js][1] and [@sgohlke/graphql-server-base][12] are compatible with which version of
+`@dreamit/graphql-server`. As `@dreamit/graphql-server` defines them as peerDependency you might want to
+choose a fitting version used in your project and by other libraries depending
+on them.
 
-| graphql-js version | graphql-server version |                                       Github branch                                        | Development Status |
-|--------------------|:----------------------:|:------------------------------------------------------------------------------------------:|:------------------:|
-| ~~^15.2.0~~        |        ~~1.x~~         | [~~legacy-graphql15~~](https://github.com/dreamit-de/graphql-server/tree/legacy-graphql15) |    end of life     |
-| ^16.0.0            |          2.x           |   [legacy-server-v2](https://github.com/dreamit-de/graphql-server/tree/legacy-server-v2)   |    maintenance     |
-| ^16.0.0            |          3.x           |                    [main](https://github.com/dreamit-de/graphql-server)                    |       active       |
+| graphql-js version | graphql-server version |  graphql-server-base version |                                       Github branch                                        | Development Status |
+|--------------------|:----------------------:|:----------------------:|:------------------------------------------------------------------------------------------:|:------------------:|
+| ~~^15.2.0~~        |        ~~1.x~~         |        ~~n.a.~~        | [~~legacy-graphql15~~](https://github.com/dreamit-de/graphql-server/tree/legacy-graphql15) |    end of life     |
+| ^16.0.0            |          2.x           |          n.a.          |   [legacy-server-v2](https://github.com/dreamit-de/graphql-server/tree/legacy-server-v2)   |    maintenance     |
+| ^16.0.0            |          3.x           |          ^1.0          |                    [main](https://github.com/dreamit-de/graphql-server)                    |       active       |
 
 ## Features
 
@@ -31,7 +31,7 @@ on [graphql-js][1].
 - Uses out-of-the-box default options to ease use and keep code short
 - Provides hot reloading for schema and options
 - Provides out-of-the-box metrics for GraphQLServer
-- Uses only 2 peerDependencies: [graphql-js][1] version 16 and [graphql-prom-metrics][11] version 1 (no other production
+- Uses only 3 peerDependencies: [graphql-js][1] version 16, [graphql-prom-metrics][11] version 1 and [graphql-server-base][12] (no other production
   dependencies)
 
 ## Core Functions
@@ -196,7 +196,7 @@ from [graphql-prom-metrics][11]
 **Warning!**:
 If you are using **PromMetricsClient** you should avoid creating multiple **GraphQLServer** instances that all use 
 the **PromMetricsClient**. Because of the usage of a global object in the [prom-client][3] library this might result 
-in unexpected behaviour or malfunction. You can set another metrics client like **SimpleMetricsClient** 
+in unexpected behavior or malfunction. You can set another metrics client like **SimpleMetricsClient** 
 by calling **GraphQLServer setOptions()** or **GraphQLServer setMetricsClient()**.   
 
 The **SimpleMetricsClient** provides three custom metrics for the GraphQL server:
@@ -467,3 +467,5 @@ graphql-server is under [MIT-License](./LICENSE).
 [10]: https://hapi.dev/
 
 [11]: https://github.com/sgohlke/graphql-prom-metrics
+
+[12]: https://github.com/sgohlke/graphql-server-base

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreamit/graphql-server",
-  "version": "3.2.3",
+  "version": "3.3.0",
   "description": "A GraphQL server written in NodeJS/Typescript.",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
@@ -37,6 +37,7 @@
   },
   "peerDependencies": {
     "graphql": "^16.0.0",
-    "@sgohlke/graphql-prom-metrics": "^1.0.2"
+    "@sgohlke/graphql-prom-metrics": "^1.0.2",
+    "@sgohlke/graphql-server-base": "^1.0.0"
   }
 }

src/error/DetermineGraphQLOrFetchError.ts

@@ -1,7 +1,7 @@
 import {
     FETCH_ERROR,
     GRAPHQL_ERROR
-} from '..'
+} from '@sgohlke/graphql-server-base'
 
 /**
  * Determines if an error is a GraphQLError or

src/error/DetermineValidationOrIntrospectionDisabledError.ts

@@ -1,7 +1,7 @@
 import {
     INTROSPECTION_DISABLED_ERROR,
     VALIDATION_ERROR
-} from '..'
+} from '@sgohlke/graphql-server-base'
 
 /**
  * Determines if an error is a ValidationError or

src/index.ts

@@ -5,37 +5,32 @@
  * requests and send back appropriate responses.
  */
 export * from './error/AggregateError'
-export * from './error/ErrorNameConstants'
 export * from './error/DetermineGraphQLOrFetchError'
 export * from './error/DetermineValidationOrIntrospectionDisabledError'
-export * from './error/GraphQLErrorWithInfo'
 export * from './error/RemoveValidationRecommendationsFromErrors'
 
 export * from './logger/JsonLogger'
 export * from './logger/LogEntry'
-export * from './logger/Logger'
 export * from './logger/LogHelper'
 export * from './logger/LogLevel'
 export * from './logger/TextLogger'
 
 export * from './metrics/DefaultMetricsClient'
 export * from './metrics/IncreaseFetchOrGraphQLErrorMetric'
-export * from './metrics/MetricsClient'
 export * from './metrics/NoMetricsClient'
 export * from './metrics/SimpleMetricsClient'
 
 export * from './request/ContentType'
 export * from './request/DefaultRequestInformationExtractor'
 export * from './request/RequestInformationExtractor'
-export * from './request/GraphQLServerRequest'
-export * from './request/GraphQLRequestInfo'
 
 export * from './response/DefaultResponseHandler'
 export * from './response/GraphQLExecutionResult'
-export * from './response/GraphQLServerResponse'
 export * from './response/ResponseHandler'
 
 export * from './server/DefaultGraphQLServerOptions'
 export * from './server/GraphQLServer'
 export * from './server/GraphQLServerOptions'
 
+// For backwards-compatibility with graphql-server v3 versions and extensions
+export * from '@sgohlke/graphql-server-base'

src/logger/JsonLogger.ts

@@ -1,6 +1,6 @@
+import {Logger} from '@sgohlke/graphql-server-base'
 import {Console} from 'node:console'
 import {
-    Logger,
     LogEntry,
     LogHelper,
     LogLevel

src/logger/TextLogger.ts

@@ -1,5 +1,5 @@
+import {Logger} from '@sgohlke/graphql-server-base'
 import {
-    Logger,
     LogLevel,
     LogEntry,
     LogHelper,

src/metrics/IncreaseFetchOrGraphQLErrorMetric.ts

@@ -1,7 +1,9 @@
+import { 
+    Logger, 
+    MetricsClient 
+} from '@sgohlke/graphql-server-base'
 import {
     determineGraphQLOrFetchError,
-    Logger,
-    MetricsClient
 } from '..'
 
 /**

src/metrics/NoMetricsClient.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-empty-function */
-import { MetricsClient } from '..'
+import { MetricsClient } from '@sgohlke/graphql-server-base'
 
 /**
  * Metrics client that does not collect any metrics.

src/metrics/SimpleMetricsClient.ts

@@ -9,7 +9,7 @@ import {
     SCHEMA_VALIDATION_ERROR,
     SYNTAX_ERROR,
     VALIDATION_ERROR
-} from '..'
+} from '@sgohlke/graphql-server-base'
 
 /**
  * Simple metrics client.

src/request/ContentType.ts

@@ -1,9 +1,4 @@
-export enum ContentType {
-    graphql = 'application/graphql',
-    json = 'application/json',
-    unknown = '',
-    urlencoded = 'application/x-www-form-urlencoded'
-}
+import { ContentType } from '@sgohlke/graphql-server-base'
 
 export function getContentType(contentType?: string): ContentType {
     if (contentType) {

src/request/DefaultRequestInformationExtractor.ts

@@ -1,13 +1,15 @@
 import {
-    ContentType,
     getContentType,
-    GraphQLRequestInfo,
-    GraphQLServerRequest,
     RequestInformationExtractor
 } from '..'
 import {URLSearchParams} from 'node:url'
 import {GraphQLError} from 'graphql'
 import {Buffer} from 'node:buffer'
+import { 
+    ContentType, 
+    GraphQLRequestInfo, 
+    GraphQLServerRequest 
+} from '@sgohlke/graphql-server-base'
 
 /**
  * Default implementation of RequestInformationExtractor interface

src/request/RequestInformationExtractor.ts

@@ -1,7 +1,7 @@
 import {
     GraphQLRequestInfo,
     GraphQLServerRequest
-} from '..'
+} from '@sgohlke/graphql-server-base'
 
 /**
  * Interface for RequestInformationExtractor.

src/response/DefaultResponseHandler.ts

@@ -1,10 +1,10 @@
 import {Buffer} from 'node:buffer'
 import {
-    GraphQLExecutionResult,
     ResponseHandler,
     ResponseParameters
 } from '..'
 import {GraphQLError} from 'graphql'
+import { GraphQLExecutionResult } from '@sgohlke/graphql-server-base'
 
 /**
  * Default implementation of ResponseHandler interface

src/response/GraphQLExecutionResult.ts

@@ -1,21 +1,7 @@
 import {
-    ExecutionResult,
     GraphQLError
 } from 'graphql'
-import {GraphQLRequestInfo} from '..'
-
-/**
- * Interface for execution results.
- * Contains the GraphQL related ExecutionResult as well as statusCode and customHeaders that might
- * contain additional information for handling responses. The requestInformation is available
- * to have both the result and request information in one interface, e.g. to use it for caching.
- */
-export interface GraphQLExecutionResult {
-    executionResult: ExecutionResult
-    statusCode?: number
-    customHeaders?: Record<string, string>
-    requestInformation?: GraphQLRequestInfo
-}
+import {GraphQLExecutionResult} from '@sgohlke/graphql-server-base'
 
 export function getFirstErrorFromExecutionResult(result: GraphQLExecutionResult)
     : GraphQLError {

src/response/ResponseHandler.ts

@@ -3,7 +3,7 @@ import {
     GraphQLServerRequest,
     GraphQLServerResponse,
     Logger
-} from '..'
+} from '@sgohlke/graphql-server-base'
 import {
     ExecutionResult,
     GraphQLError,

src/server/DefaultGraphQLServerOptions.ts

@@ -2,12 +2,7 @@ import {
     GraphQLServerOptions,
     DefaultRequestInformationExtractor,
     TextLogger,
-    GraphQLServerRequest,
-    GraphQLServerResponse,
-    GraphQLRequestInfo,
-    Logger,
     RequestInformationExtractor,
-    MetricsClient,
     SimpleMetricsClient,
     DefaultResponseHandler,
     ResponseHandler
@@ -31,6 +26,13 @@ import {
     GraphQLFieldResolver,
     GraphQLTypeResolver
 } from 'graphql/type/definition'
+import { 
+    GraphQLRequestInfo, 
+    GraphQLServerRequest, 
+    GraphQLServerResponse, 
+    Logger, 
+    MetricsClient 
+} from '@sgohlke/graphql-server-base'
 
 export const fallbackTextLogger = new TextLogger('fallback-logger', 'fallback-service')
 export const defaultRequestInformationExtractor = new DefaultRequestInformationExtractor()