feat: perform function that does parsing, validation, context assembly and execution/subscription

.changeset/@envelop_apollo-tracing-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/apollo-tracing': patch
+---
+
+dependencies updates:
+
+- Added dependency [`@envelop/types@^2.3.1` ↗︎](https://www.npmjs.com/package/@envelop/types/v/null) (to `peerDependencies`)

.changeset/@envelop_auth0-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/auth0': patch
+---
+
+dependencies updates:
+
+- Removed dependency [`graphql@^14.0.0 || ^15.0.0 || ^16.0.0` ↗︎](https://www.npmjs.com/package/graphql/v/null) (from `peerDependencies`)

.changeset/@envelop_core-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/core': patch
+---
+
+dependencies updates:
+
+- Removed dependency [`graphql@^14.0.0 || ^15.0.0 || ^16.0.0` ↗︎](https://www.npmjs.com/package/graphql/v/null) (from `peerDependencies`)

.changeset/@envelop_dataloader-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/dataloader': patch
+---
+
+dependencies updates:
+
+- Removed dependency [`graphql@^14.0.0 || ^15.0.0 || ^16.0.0` ↗︎](https://www.npmjs.com/package/graphql/v/null) (from `peerDependencies`)

.changeset/@envelop_opentelemetry-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/opentelemetry': patch
+---
+
+dependencies updates:
+
+- Added dependency [`@envelop/types@^2.3.1` ↗︎](https://www.npmjs.com/package/@envelop/types/v/null) (to `peerDependencies`)

.changeset/@envelop_preload-assets-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/preload-assets': patch
+---
+
+dependencies updates:
+
+- Removed dependency [`graphql@^14.0.0 || ^15.0.0 || ^16.0.0` ↗︎](https://www.npmjs.com/package/graphql/v/null) (from `peerDependencies`)

.changeset/@envelop_prometheus-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/prometheus': patch
+---
+
+dependencies updates:
+
+- Added dependency [`@envelop/types@^2.3.1` ↗︎](https://www.npmjs.com/package/@envelop/types/v/null) (to `peerDependencies`)

.changeset/@envelop_rate-limiter-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/rate-limiter': patch
+---
+
+dependencies updates:
+
+- Added dependency [`@envelop/types@^2.3.1` ↗︎](https://www.npmjs.com/package/@envelop/types/v/null) (to `peerDependencies`)

.changeset/@envelop_statsd-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/statsd': patch
+---
+
+dependencies updates:
+
+- Removed dependency [`graphql@^14.0.0 || ^15.0.0 || ^16.0.0` ↗︎](https://www.npmjs.com/package/graphql/v/null) (from `peerDependencies`)

.changeset/@envelop_types-1487-dependencies.md

@@ -0,0 +1,7 @@
+---
+'@envelop/types': patch
+---
+
+dependencies updates:
+
+- Removed dependency [`graphql@^14.0.0 || ^15.0.0 || ^16.0.0` ↗︎](https://www.npmjs.com/package/graphql/v/null) (from `peerDependencies`)

.changeset/curvy-bottles-repeat.md

@@ -0,0 +1,5 @@
+---
+'@envelop/core': major
+---
+
+Remove async schema loading plugin. This was a mistake from beginning as we cannot asynchronously `validate` and `parse` since with GraphQL.js are synchronous in nature.

.changeset/four-masks-jam.md

@@ -0,0 +1,5 @@
+---
+'@envelop/core': minor
+---
+
+`perform` function that does parsing, validation, context assembly and execution/subscription

.changeset/neat-spoons-play.md

@@ -0,0 +1,5 @@
+---
+'@envelop/on-resolve': major
+---
+
+Plugin allowing you to hook into resolves of every field in the GraphQL schema.

.changeset/nervous-seas-own.md

@@ -0,0 +1,5 @@
+---
+'@envelop/core': major
+---
+
+Renmae `useLazyLoadedSchema` to `useSchemaByContext` since the original name was vert misleading.

.changeset/quiet-mice-jam.md

@@ -0,0 +1,27 @@
+---
+'@envelop/core': major
+---
+
+Remove `enableIf` utility in favor of more type safe way to conditionally enable plugins. It wasn't a great experience to have a utility
+
+We can easily replace usage like this:
+
+```diff
+- import { envelop, useMaskedErrors, enableIf } from '@envelop/core'
++ import { envelop, useMaskedErrors } from '@envelop/core'
+import { parse, validate, execute, subscribe } from 'graphql'
+
+const isProd = process.env.NODE_ENV === 'production'
+
+const getEnveloped = envelop({
+  parse,
+  validate,
+  execute,
+  subscribe,
+  plugins: [
+    // This plugin is enabled only in production
+-    enableIf(isProd, useMaskedErrors())
++    isProd && useMaskedErrors()
+  ]
+})
+```

.changeset/rude-cats-peel.md

@@ -0,0 +1,10 @@
+---
+'@envelop/core': major
+---
+
+Remove `handleValidationErrors` and `handleParseErrors` options from `useMaskedErrors`.
+
+> ONLY masking validation errors OR ONLY disabling introspection errors does not make sense, as both can be abused for reverse-engineering the GraphQL schema (see https://github.com/nikitastupin/clairvoyance for reverse-engineering the schema based on validation error suggestions).
+> https://github.com/n1ru4l/envelop/issues/1482#issue-1340015060
+
+Rename `formatError` function option to `maskErrorFn`

.eslintrc.json

@@ -1,17 +1,33 @@
 {
   "parser": "@typescript-eslint/parser",
-  "extends": ["eslint:recommended", "standard", "prettier", "plugin:@typescript-eslint/recommended"],
-  "plugins": ["@typescript-eslint", "unicorn"],
+  "extends": [
+    "eslint:recommended",
+    "standard",
+    "prettier",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:package-json/recommended"
+  ],
+  "plugins": ["@typescript-eslint", "unicorn", "package-json"],
   "rules": {
     "unicorn/filename-case": "error",
     "no-lonely-if": "error",
     "unicorn/no-lonely-if": "error",
     "no-empty": "off",
     "no-console": "error",
     "no-prototype-builtins": "off",
-    "prefer-arrow-callback": ["error", { "allowNamedFunctions": true }],
+    "prefer-arrow-callback": [
+      "error",
+      {
+        "allowNamedFunctions": true
+      }
+    ],
     "no-useless-constructor": "off",
-    "@typescript-eslint/no-unused-vars": ["warn", { "args": "none" }],
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        "args": "none"
+      }
+    ],
     "@typescript-eslint/no-use-before-define": "off",
     "@typescript-eslint/no-namespace": "off",
     "@typescript-eslint/no-empty-interface": "off",
@@ -26,7 +42,9 @@
     "unicorn/no-useless-fallback-in-spread": "error",
     "import/no-extraneous-dependencies": [
       "error",
-      { "devDependencies": ["**/*.test.ts", "**/*.spec.ts", "**/test/**/*.ts"] }
+      {
+        "devDependencies": ["**/*.test.ts", "**/*.spec.ts", "**/test/**/*.ts"]
+      }
     ]
   },
   "env": {
@@ -43,6 +61,38 @@
         "@typescript-eslint/no-unused-vars": "off",
         "import/no-extraneous-dependencies": "off"
       }
+    },
+    // Disallow `graphql-js` specific things to get re-introduced in agnostic packages.
+    {
+      "files": [
+        "packages/core/**",
+        "packages/types/**",
+        "packages/plugins/apollo-datasources/**",
+        "packages/plugins/auth0/**",
+        "packages/plugins/dataloader/**",
+        "packages/plugins/preload-assets/**",
+        "packages/plugins/statsd/**"
+      ],
+      "env": {
+        "jest": true
+      },
+      "rules": {
+        "no-restricted-imports": [
+          "error",
+          {
+            "paths": [
+              {
+                "name": "graphql",
+                "message": "You chose violence. Try to make it work without using GraphQL.js"
+              },
+              {
+                "name": "@graphql-tools/*",
+                "message": "You chose violence. Try to make it work without using `graphql-tools`"
+              }
+            ]
+          }
+        ]
+      }
     }
   ],
   "ignorePatterns": ["dist", "node_modules", "dev-test", "website"]

.github/workflows/pr.yml

@@ -5,10 +5,10 @@ on:
       - main
 
 jobs:
-  dependencies:
-    uses: the-guild-org/shared-config/.github/workflows/changesets-dependencies.yaml@main
-    secrets:
-      githubToken: ${{ secrets.GITHUB_TOKEN }}
+  # dependencies:
+  #   uses: the-guild-org/shared-config/.github/workflows/changesets-dependencies.yaml@main
+  #   secrets:
+  #     githubToken: ${{ secrets.GITHUB_TOKEN }}
 
   release:
     uses: the-guild-org/shared-config/.github/workflows/release-snapshot.yml@main

.github/workflows/tests.yml

@@ -48,13 +48,38 @@ jobs:
         run: yarn ts:check
 
   unit:
-    name: unit / ${{matrix.os}} / node v${{matrix.node-version}} / graphql v${{matrix.graphql_version}}
+    name: Unit Test
     runs-on: ${{matrix.os}}
     strategy:
       matrix:
         os: [ubuntu-latest] # remove windows to speed up the tests
-        node-version: [12, 17]
-        graphql_version: [15, 16]
+    steps:
+      - name: Checkout Master
+        uses: actions/checkout@v2
+      - name: Setup env
+        uses: the-guild-org/shared-config/setup@main
+        with:
+          nodeVersion: 18
+      - name: Install Dependencies
+        run: yarn install --ignore-engines && git checkout yarn.lock
+      - name: Cache Jest
+        uses: actions/cache@v2
+        with:
+          path: .cache/jest
+          key: ${{ runner.os }}-${{matrix.node-version}}-${{matrix.graphql_version}}-jest-${{ hashFiles('yarn.lock') }}-${{ hashFiles('patches/*.patch') }}
+      - name: Test
+        run: yarn test
+        env:
+          CI: true
+
+  core:
+    name: Core Test / ${{matrix.os}} / node v${{matrix.node-version}} / graphql v${{matrix.graphql_version}}
+    runs-on: ${{matrix.os}}
+    strategy:
+      matrix:
+        os: [ubuntu-latest] # remove windows to speed up the tests
+        node-version: [14, 16, 17, 18]
+        graphql_version: [15, 16, 'npm:@graphql-tools/graphql@0.1.0-alpha-20220815193214-83898018']
     steps:
       - name: Checkout Master
         uses: actions/checkout@v2
@@ -71,8 +96,8 @@ jobs:
         with:
           path: .cache/jest
           key: ${{ runner.os }}-${{matrix.node-version}}-${{matrix.graphql_version}}-jest-${{ hashFiles('yarn.lock') }}-${{ hashFiles('patches/*.patch') }}
-      - name: Test
-        run: yarn test --ci
+      - name: Test Core
+        run: yarn test:core --ci
         env:
           CI: true
 

README.md

@@ -46,33 +46,21 @@ const getEnveloped = envelop({
 })
 ```
 
-The result of `envelop` is a function that allows you to get everything you need for the GraphQL execution: `parse`, `validate`, `contextBuilder` and `execute`. Use that to run the client's GraphQL queries. Here's a pseudo-code example of how it should look like:
+The result of `envelop` is a function that allows you to get everything you need for the GraphQL execution. It's recommended to use the `perform` function which does parsing, validation, context assembly and execution/subscription, and returns a ready result. Here's a pseudo-code example of how it should look like:
 
 ```ts
 const httpServer = createServer()
 
 httpServer.on('request', async (req, res) => {
   // Here you get the alternative methods that are bundled with your plugins
   // You can also pass the "req" to make it available for your plugins or GraphQL context.
-  const { parse, validate, contextFactory, execute, schema } = getEnveloped({ req })
+  const { perform } = getEnveloped({ req })
 
-  // Parse the initial request and validate it
+  // Parse the initial request
   const { query, variables } = JSON.parse(req.payload)
-  const document = parse(query)
-  const validationErrors = validate(schema, document)
 
-  if (validationErrors.length > 0) {
-    return res.end(JSON.stringify({ errors: validationErrors }))
-  }
-
-  // Build the context and execute
-  const context = await contextFactory(req)
-  const result = await execute({
-    document,
-    schema,
-    variableValues: variables,
-    contextValue: context
-  })
+  // Perform the GraphQL operation
+  const result = await perform({ query, variables })
 
   // Send the response
   res.end(JSON.stringify(result))

examples/simple-http/index.ts

@@ -20,7 +20,7 @@ const getEnveloped = envelop({
 });
 
 const server = createServer((req, res) => {
-  const { parse, validate, contextFactory, execute, schema } = getEnveloped({ req });
+  const { perform } = getEnveloped({ req });
   let payload = '';
 
   req.on('data', chunk => {
@@ -29,26 +29,8 @@ const server = createServer((req, res) => {
 
   req.on('end', async () => {
     const { query, variables } = JSON.parse(payload);
-    const document = parse(query);
-    const validationErrors = validate(schema, document);
 
-    if (validationErrors.length > 0) {
-      res.end(
-        JSON.stringify({
-          errors: validationErrors,
-        })
-      );
-
-      return;
-    }
-
-    const context = await contextFactory();
-    const result = await execute({
-      document,
-      schema,
-      variableValues: variables,
-      contextValue: context,
-    });
+    const result = await perform({ query, variables });
 
     res.end(JSON.stringify(result));
   });