@bagaar/ember-graphql-mocking 0.5.0 → 0.7.0

package/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 
 
+
+
+## v0.7.0 (2023-02-22)
+
+#### :boom: Breaking Change
+* [#104](https://github.com/Bagaar/ember-graphql-mocking/pull/104) Update `msw` to v1 and make it a peer dependency ([@gvdp](https://github.com/gvdp))
+
+#### :rocket: Enhancement
+* [#104](https://github.com/Bagaar/ember-graphql-mocking/pull/104) Update `msw` to v1 and make it a peer dependency ([@gvdp](https://github.com/gvdp))
+* [#100](https://github.com/Bagaar/ember-graphql-mocking/pull/100) Speed up requiring `index.js` file ([@bertdeblock](https://github.com/bertdeblock))
+
+#### :memo: Documentation
+* [#106](https://github.com/Bagaar/ember-graphql-mocking/pull/106) Update compatibility and installation section ([@bertdeblock](https://github.com/bertdeblock))
+
+#### Committers: 2
+- Bert De Block ([@bertdeblock](https://github.com/bertdeblock))
+- [@gvdp](https://github.com/gvdp)
+
+## v0.6.0 (2022-09-05)
+
+#### :boom: Breaking Change
+* [#38](https://github.com/Bagaar/ember-graphql-mocking/pull/38) Make `setupEmberGraphqlMocking` async ([@bertdeblock](https://github.com/bertdeblock))
+* [#37](https://github.com/Bagaar/ember-graphql-mocking/pull/37) Update `graphql` and `msw` dependencies ([@bertdeblock](https://github.com/bertdeblock))
+* [#34](https://github.com/Bagaar/ember-graphql-mocking/pull/34) Update `msw` to v0.43.0 ([@bertdeblock](https://github.com/bertdeblock))
+
+#### :bug: Bug Fix
+* [#38](https://github.com/Bagaar/ember-graphql-mocking/pull/38) Make `setupEmberGraphqlMocking` async ([@bertdeblock](https://github.com/bertdeblock))
+
+#### Committers: 1
+- Bert De Block ([@bertdeblock](https://github.com/bertdeblock))
+
 ## v0.5.0 (2022-06-24)
 
 #### :boom: Breaking Change

package/README.md

@@ -11,11 +11,20 @@ Ember addon for mocking GraphQL requests using [Mock Service Worker (MSW)](https
 - Ember.js v3.28 or above
 - Ember CLI v3.28 or above
 - Node.js v14 or above
+- MSW v1 or above
 
 ## Installation
 
 ```shell
-ember install @bagaar/ember-graphql-mocking
+npm install -D @bagaar/ember-graphql-mocking msw
+```
+
+```shell
+pnpm add -D @bagaar/ember-graphql-mocking msw
+```
+
+```shell
+yarn add -D @bagaar/ember-graphql-mocking msw
 ```
 
 ## Usage
@@ -25,7 +34,7 @@ ember install @bagaar/ember-graphql-mocking
 In `tests/test-helper.js`:
 1. Import `setupEmberGraphqlMocking`
 2. Import your GraphQL schema
-3. Call `setupEmberGraphqlMocking` with your GraphQL schema, _before_ calling `start`
+3. Call `setupEmberGraphqlMocking` with your GraphQL schema
 
 ```javascript
 // tests/test-helper.js
@@ -39,24 +48,28 @@ import { start } from 'ember-qunit';
 import { setupEmberGraphqlMocking } from '@bagaar/ember-graphql-mocking/test-support'; // 1.
 import schema from 'my-app/graphql/schema'; // 2.
 
+QUnit.begin(() => setupEmberGraphqlMocking(schema)); // 3.
+
 setApplication(Application.create(config.APP));
 
 setup(QUnit.assert);
 
-setupEmberGraphqlMocking(schema); // 3.
-
 start();
 ```
 
+> **NOTE:** Make sure to use `QUnit.begin`, as `setupEmberGraphqlMocking` returns a Promise.
+
 If you want to pass along additional [start options](https://mswjs.io/docs/api/setup-worker/start#options)
 to MSW's service worker, you can do so by defining an `mswStartOptions` object:
 
 ```js
-setupEmberGraphqlMocking(schema, {
-  mswStartOptions: {
-    // Additional MSW start options...
-  },
-});
+QUnit.begin(() =>
+  setupEmberGraphqlMocking(schema, {
+    mswStartOptions: {
+      // Additional MSW start options...
+    },
+  })
+);
 ```
 
 ### 2. Write an Acceptance Test

package/addon-test-support/index.js

@@ -22,8 +22,10 @@ let worker = null;
 export function setupEmberGraphqlMocking(schemaDocument, providedOptions) {
   const options = merge({}, DEFAULT_OPTIONS, providedOptions);
 
-  createWorker(options);
+  createWorker();
   createGraphqlOperationHandler(schemaDocument);
+
+  return startWorker(options.mswStartOptions);
 }
 
 export function setupGraphqlTest(hooks) {
@@ -51,10 +53,8 @@ export function destroyWorker() {
   worker = null;
 }
 
-function createWorker(options) {
+function createWorker() {
   worker = setupWorker();
-
-  worker.start(options.mswStartOptions);
 }
 
 function createGraphqlOperationHandler(schemaDocument) {
@@ -73,6 +73,10 @@ function createGraphqlOperationHandler(schemaDocument) {
   worker.use(graphqlOperation);
 }
 
+function startWorker(mswStartOptions) {
+  return worker.start(mswStartOptions);
+}
+
 function clearRoot() {
   root = null;
 }

package/index.js

@@ -1,8 +1,5 @@
 'use strict';
 
-const funnel = require('broccoli-funnel');
-const mergeTrees = require('broccoli-merge-trees');
-
 module.exports = {
   name: require('./package').name,
 
@@ -14,6 +11,9 @@ module.exports = {
       return;
     }
 
+    const funnel = require('broccoli-funnel');
+    const mergeTrees = require('broccoli-merge-trees');
+
     return mergeTrees([tree, funnel(host.trees.public)], {
       overwrite: true,
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bagaar/ember-graphql-mocking",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Ember addon for mocking GraphQL requests using Mock Service Worker (MSW).",
   "keywords": [
     "ember-addon"
@@ -14,15 +14,15 @@
   },
   "scripts": {
     "build": "ember build --environment=production",
-    "lint": "npm-run-all --aggregate-output --continue-on-error --parallel \"lint:!(fix)\"",
-    "lint:fix": "npm-run-all --aggregate-output --continue-on-error --parallel lint:*:fix",
+    "lint": "concurrently \"npm:lint:*(!fix)\" --names \"lint:\"",
+    "lint:fix": "concurrently \"npm:lint:*:fix\" --names \"fix:\"",
     "lint:hbs": "ember-template-lint .",
     "lint:hbs:fix": "ember-template-lint . --fix",
     "lint:js": "eslint . --cache",
     "lint:js:fix": "eslint . --fix",
     "prepare": "husky install",
     "start": "ember serve",
-    "test": "npm-run-all lint test:*",
+    "test": "concurrently \"npm:lint\" \"npm:test:*\" --names \"lint,test:\"",
     "test:ember": "ember test",
     "test:ember-compatibility": "ember try:each"
   },
@@ -31,61 +31,64 @@
       "@commitlint/config-conventional"
     ]
   },
+  "peerDependencies": {
+    "ember-source": "^3.28.0 || ^4.0.0",
+    "msw": "^1.0.1"
+  },
   "dependencies": {
     "broccoli-funnel": "^3.0.5",
     "broccoli-merge-trees": "^4.2.0",
-    "ember-auto-import": "^2.4.1",
+    "ember-auto-import": "^2.5.0",
     "ember-cli-babel": "^7.26.11",
-    "graphql": "^16.3.0",
-    "lodash.merge": "^4.6.2",
-    "msw": "^0.42.3"
+    "graphql": "^16.6.0",
+    "lodash.merge": "^4.6.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.0.2",
-    "@commitlint/config-conventional": "^17.0.2",
+    "@commitlint/cli": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
     "@ember/optional-features": "^2.0.0",
-    "@ember/test-helpers": "^2.7.0",
-    "@embroider/test-setup": "^1.6.0",
+    "@ember/string": "^3.0.1",
+    "@ember/test-helpers": "^2.9.3",
+    "@embroider/test-setup": "^2.0.2",
     "@glimmer/component": "^1.1.2",
     "@glimmer/tracking": "^1.1.2",
+    "@release-it-plugins/lerna-changelog": "^5.0.0",
     "babel-eslint": "^10.1.0",
     "broccoli-asset-rev": "^3.0.0",
-    "ember-apollo-client": "^4.0.2",
-    "ember-cli": "~4.4.0",
+    "concurrently": "^7.6.0",
+    "ember-apollo-client": "^4.1.0",
+    "ember-cli": "~4.10.0",
     "ember-cli-dependency-checker": "^3.3.1",
-    "ember-cli-htmlbars": "^6.0.1",
+    "ember-cli-htmlbars": "^6.2.0",
     "ember-cli-inject-live-reload": "^2.1.0",
     "ember-cli-sri": "^2.1.1",
     "ember-cli-terser": "^4.0.2",
-    "ember-disable-prototype-extensions": "^1.1.3",
-    "ember-export-application-global": "^2.0.1",
-    "ember-fetch": "^8.0.4",
+    "ember-fetch": "^8.1.2",
     "ember-load-initializers": "^2.1.2",
     "ember-page-title": "^7.0.0",
-    "ember-qunit": "^5.1.5",
-    "ember-resolver": "^8.0.3",
-    "ember-source": "~4.4.0",
+    "ember-qunit": "^6.1.1",
+    "ember-resolver": "^10.0.0",
+    "ember-source": "~4.10.0",
     "ember-source-channel-url": "^3.0.0",
-    "ember-template-lint": "^4.8.0",
+    "ember-template-lint": "^5.3.1",
     "ember-try": "^2.0.0",
     "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-ember": "^10.6.1",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-qunit": "^7.2.0",
-    "husky": "^8.0.1",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-ember": "^11.4.3",
+    "eslint-plugin-n": "^15.6.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-qunit": "^7.3.4",
+    "husky": "^8.0.3",
     "loader.js": "^4.7.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^2.6.2",
-    "qunit": "^2.19.1",
+    "msw": "^1.0.1",
+    "prettier": "^2.8.3",
+    "qunit": "^2.19.3",
     "qunit-dom": "^2.0.0",
-    "release-it": "^14.14.3",
-    "release-it-lerna-changelog": "^4.0.1",
-    "webpack": "^5.72.1"
+    "release-it": "^15.6.0",
+    "webpack": "^5.75.0"
   },
   "engines": {
-    "node": "14.* || >= 16"
+    "node": "14.* || 16.* || >= 18"
   },
   "publishConfig": {
     "access": "public",
@@ -102,7 +105,7 @@
   },
   "release-it": {
     "plugins": {
-      "release-it-lerna-changelog": {
+      "@release-it-plugins/lerna-changelog": {
         "infile": "CHANGELOG.md",
         "launchEditor": false
       }

package/public/mockServiceWorker.js

@@ -2,22 +2,21 @@
 /* tslint:disable */
 
 /**
- * Mock Service Worker (0.42.3).
+ * Mock Service Worker (1.0.1).
  * @see https://github.com/mswjs/msw
  * - Please do NOT modify this file.
  * - Please do NOT serve this file on production.
  */
 
-const INTEGRITY_CHECKSUM = '02f4ad4a2797f85668baf196e553d929'
-const bypassHeaderName = 'x-msw-bypass'
+const INTEGRITY_CHECKSUM = '3d6b9f06410d179a7f7404d4bf4c3c70'
 const activeClientIds = new Set()
 
 self.addEventListener('install', function () {
-  return self.skipWaiting()
+  self.skipWaiting()
 })
 
-self.addEventListener('activate', async function (event) {
-  return self.clients.claim()
+self.addEventListener('activate', function (event) {
+  event.waitUntil(self.clients.claim())
 })
 
 self.addEventListener('message', async function (event) {
@@ -33,7 +32,9 @@ self.addEventListener('message', async function (event) {
     return
   }
 
-  const allClients = await self.clients.matchAll()
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
 
   switch (event.data) {
     case 'KEEPALIVE_REQUEST': {
@@ -83,30 +84,58 @@ self.addEventListener('message', async function (event) {
   }
 })
 
-// Resolve the "main" client for the given event.
-// Client that issues a request doesn't necessarily equal the client
-// that registered the worker. It's with the latter the worker should
-// communicate with during the response resolving phase.
-async function resolveMainClient(event) {
-  const client = await self.clients.get(event.clientId)
+self.addEventListener('fetch', function (event) {
+  const { request } = event
+  const accept = request.headers.get('accept') || ''
 
-  if (client.frameType === 'top-level') {
-    return client
+  // Bypass server-sent events.
+  if (accept.includes('text/event-stream')) {
+    return
   }
 
-  const allClients = await self.clients.matchAll()
+  // Bypass navigation requests.
+  if (request.mode === 'navigate') {
+    return
+  }
 
-  return allClients
-    .filter((client) => {
-      // Get only those clients that are currently visible.
-      return client.visibilityState === 'visible'
-    })
-    .find((client) => {
-      // Find the client ID that's recorded in the
-      // set of clients that have registered the worker.
-      return activeClientIds.has(client.id)
-    })
-}
+  // Opening the DevTools triggers the "only-if-cached" request
+  // that cannot be handled by the worker. Bypass such requests.
+  if (request.cache === 'only-if-cached' && request.mode !== 'same-origin') {
+    return
+  }
+
+  // Bypass all requests when there are no active clients.
+  // Prevents the self-unregistered worked from handling requests
+  // after it's been deleted (still remains active until the next reload).
+  if (activeClientIds.size === 0) {
+    return
+  }
+
+  // Generate unique request ID.
+  const requestId = Math.random().toString(16).slice(2)
+
+  event.respondWith(
+    handleRequest(event, requestId).catch((error) => {
+      if (error.name === 'NetworkError') {
+        console.warn(
+          '[MSW] Successfully emulated a network error for the "%s %s" request.',
+          request.method,
+          request.url,
+        )
+        return
+      }
+
+      // At this point, any exception indicates an issue with the original request/response.
+      console.error(
+        `\
+[MSW] Caught an exception from the "%s %s" request (%s). This is probably not a problem with Mock Service Worker. There is likely an additional logging output above.`,
+        request.method,
+        request.url,
+        `${error.name}: ${error.message}`,
+      )
+    }),
+  )
+})
 
 async function handleRequest(event, requestId) {
   const client = await resolveMainClient(event)
@@ -128,7 +157,7 @@ async function handleRequest(event, requestId) {
           statusText: clonedResponse.statusText,
           body:
             clonedResponse.body === null ? null : await clonedResponse.text(),
-          headers: serializeHeaders(clonedResponse.headers),
+          headers: Object.fromEntries(clonedResponse.headers.entries()),
           redirected: clonedResponse.redirected,
         },
       })
@@ -138,14 +167,54 @@ async function handleRequest(event, requestId) {
   return response
 }
 
+// Resolve the main client for the given event.
+// Client that issues a request doesn't necessarily equal the client
+// that registered the worker. It's with the latter the worker should
+// communicate with during the response resolving phase.
+async function resolveMainClient(event) {
+  const client = await self.clients.get(event.clientId)
+
+  if (client?.frameType === 'top-level') {
+    return client
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  return allClients
+    .filter((client) => {
+      // Get only those clients that are currently visible.
+      return client.visibilityState === 'visible'
+    })
+    .find((client) => {
+      // Find the client ID that's recorded in the
+      // set of clients that have registered the worker.
+      return activeClientIds.has(client.id)
+    })
+}
+
 async function getResponse(event, client, requestId) {
   const { request } = event
-  const requestClone = request.clone()
-  const getOriginalResponse = () => fetch(requestClone)
+  const clonedRequest = request.clone()
+
+  function passthrough() {
+    // Clone the request because it might've been already used
+    // (i.e. its body has been read and sent to the client).
+    const headers = Object.fromEntries(clonedRequest.headers.entries())
+
+    // Remove MSW-specific request headers so the bypassed requests
+    // comply with the server's CORS preflight check.
+    // Operate with the headers as an object because request "Headers"
+    // are immutable.
+    delete headers['x-msw-bypass']
 
-  // Bypass mocking when the request client is not active.
+    return fetch(clonedRequest, { headers })
+  }
+
+  // Bypass mocking when the client is not active.
   if (!client) {
-    return getOriginalResponse()
+    return passthrough()
   }
 
   // Bypass initial page load requests (i.e. static assets).
@@ -153,34 +222,23 @@ async function getResponse(event, client, requestId) {
   // means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
   // and is not ready to handle requests.
   if (!activeClientIds.has(client.id)) {
-    return await getOriginalResponse()
+    return passthrough()
   }
 
-  // Bypass requests with the explicit bypass header
-  if (requestClone.headers.get(bypassHeaderName) === 'true') {
-    const cleanRequestHeaders = serializeHeaders(requestClone.headers)
-
-    // Remove the bypass header to comply with the CORS preflight check.
-    delete cleanRequestHeaders[bypassHeaderName]
-
-    const originalRequest = new Request(requestClone, {
-      headers: new Headers(cleanRequestHeaders),
-    })
-
-    return fetch(originalRequest)
+  // Bypass requests with the explicit bypass header.
+  // Such requests can be issued by "ctx.fetch()".
+  if (request.headers.get('x-msw-bypass') === 'true') {
+    return passthrough()
   }
 
-  // Send the request to the client-side MSW.
-  const reqHeaders = serializeHeaders(request.headers)
-  const body = await request.text()
-
+  // Notify the client that a request has been intercepted.
   const clientMessage = await sendToClient(client, {
     type: 'REQUEST',
     payload: {
       id: requestId,
       url: request.url,
       method: request.method,
-      headers: reqHeaders,
+      headers: Object.fromEntries(request.headers.entries()),
       cache: request.cache,
       mode: request.mode,
       credentials: request.credentials,
@@ -189,115 +247,32 @@ async function getResponse(event, client, requestId) {
       redirect: request.redirect,
       referrer: request.referrer,
       referrerPolicy: request.referrerPolicy,
-      body,
+      body: await request.text(),
       bodyUsed: request.bodyUsed,
       keepalive: request.keepalive,
     },
   })
 
   switch (clientMessage.type) {
-    case 'MOCK_SUCCESS': {
-      return delayPromise(
-        () => respondWithMock(clientMessage),
-        clientMessage.payload.delay,
-      )
+    case 'MOCK_RESPONSE': {
+      return respondWithMock(clientMessage.data)
     }
 
     case 'MOCK_NOT_FOUND': {
-      return getOriginalResponse()
+      return passthrough()
     }
 
     case 'NETWORK_ERROR': {
-      const { name, message } = clientMessage.payload
+      const { name, message } = clientMessage.data
       const networkError = new Error(message)
       networkError.name = name
 
-      // Rejecting a request Promise emulates a network error.
+      // Rejecting a "respondWith" promise emulates a network error.
       throw networkError
     }
-
-    case 'INTERNAL_ERROR': {
-      const parsedBody = JSON.parse(clientMessage.payload.body)
-
-      console.error(
-        `\
-[MSW] Uncaught exception in the request handler for "%s %s":
-
-${parsedBody.location}
-
-This exception has been gracefully handled as a 500 response, however, it's strongly recommended to resolve this error, as it indicates a mistake in your code. If you wish to mock an error response, please see this guide: https://mswjs.io/docs/recipes/mocking-error-responses\
-`,
-        request.method,
-        request.url,
-      )
-
-      return respondWithMock(clientMessage)
-    }
-  }
-
-  return getOriginalResponse()
-}
-
-self.addEventListener('fetch', function (event) {
-  const { request } = event
-  const accept = request.headers.get('accept') || ''
-
-  // Bypass server-sent events.
-  if (accept.includes('text/event-stream')) {
-    return
-  }
-
-  // Bypass navigation requests.
-  if (request.mode === 'navigate') {
-    return
   }
 
-  // Opening the DevTools triggers the "only-if-cached" request
-  // that cannot be handled by the worker. Bypass such requests.
-  if (request.cache === 'only-if-cached' && request.mode !== 'same-origin') {
-    return
-  }
-
-  // Bypass all requests when there are no active clients.
-  // Prevents the self-unregistered worked from handling requests
-  // after it's been deleted (still remains active until the next reload).
-  if (activeClientIds.size === 0) {
-    return
-  }
-
-  const requestId = uuidv4()
-
-  return event.respondWith(
-    handleRequest(event, requestId).catch((error) => {
-      if (error.name === 'NetworkError') {
-        console.warn(
-          '[MSW] Successfully emulated a network error for the "%s %s" request.',
-          request.method,
-          request.url,
-        )
-        return
-      }
-
-      // At this point, any exception indicates an issue with the original request/response.
-      console.error(
-        `\
-[MSW] Caught an exception from the "%s %s" request (%s). This is probably not a problem with Mock Service Worker. There is likely an additional logging output above.`,
-        request.method,
-        request.url,
-        `${error.name}: ${error.message}`,
-      )
-    }),
-  )
-})
-
-function serializeHeaders(headers) {
-  const reqHeaders = {}
-  headers.forEach((value, name) => {
-    reqHeaders[name] = reqHeaders[name]
-      ? [].concat(reqHeaders[name]).concat(value)
-      : value
-  })
-  return reqHeaders
+  return passthrough()
 }
 
 function sendToClient(client, message) {
@@ -312,27 +287,17 @@ function sendToClient(client, message) {
       resolve(event.data)
     }
 
-    client.postMessage(JSON.stringify(message), [channel.port2])
+    client.postMessage(message, [channel.port2])
   })
 }
 
-function delayPromise(cb, duration) {
+function sleep(timeMs) {
   return new Promise((resolve) => {
-    setTimeout(() => resolve(cb()), duration)
+    setTimeout(resolve, timeMs)
   })
 }
 
-function respondWithMock(clientMessage) {
-  return new Response(clientMessage.payload.body, {
-    ...clientMessage.payload,
-    headers: clientMessage.payload.headers,
-  })
-}
-
-function uuidv4() {
-  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
-    const r = (Math.random() * 16) | 0
-    const v = c == 'x' ? r : (r & 0x3) | 0x8
-    return v.toString(16)
-  })
+async function respondWithMock(response) {
+  await sleep(response.delay)
+  return new Response(response.body, response)
 }

package/config/environment.js

@@ -1,5 +0,0 @@
-'use strict';
-
-module.exports = function (/* environment, appConfig */) {
-  return {};
-};