refactor: rename gqlErrorsMiddleware to errorMiddleware

BREAKING CHANGE: rename `gqlErrorsMiddleware` to `errorMiddleware`
relay-tools · Mar 3, 2018 · 5a5c3f5 · 5a5c3f5
1 parent de1cacb
commit 5a5c3f5
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -97,7 +97,7 @@ Middlewares
   - An example of req/res output in console: <img width="968" alt="screen shot 2017-11-19 at 23 05 19" src="https://user-images.githubusercontent.com/1946920/33159466-557517e0-d03d-11e7-9711-ebdfe6e789c8.png">
 - **perfMiddleware** - simple time measure for network request.
   - `logger` - log function (default: `console.log.bind(console, '[RELAY-NETWORK]')`)
-- **gqlErrorsMiddleware** - display `errors` data to console from graphql response. If you want see stackTrace for errors, you should provide `formatError` to `express-graphql` (see example below where `graphqlServer` accept `formatError` function).
+- **errorMiddleware** - display `errors` data to console from graphql response. If you want see stackTrace for errors, you should provide `formatError` to `express-graphql` (see example below where `graphqlServer` accept `formatError` function).
   - `logger` - log function (default: `console.error.bind(console)`)
   - `prefix` - prefix message (default: `[RELAY-NETWORK] GRAPHQL SERVER ERROR:`)
 
@@ -109,7 +109,7 @@ import {
   urlMiddleware,
   batchMiddleware,
   loggerMiddleware,
-  gqlErrorsMiddleware,
+  errorMiddleware,
   perfMiddleware,
   retryMiddleware,
   authMiddleware,
@@ -129,7 +129,7 @@ const network = new RelayNetworkLayer([
     batchTimeout: 10,
   }),
   __DEV__ ? loggerMiddleware() : null,
-  __DEV__ ? gqlErrorsMiddleware() : null,
+  __DEV__ ? errorMiddleware() : null,
   __DEV__ ? perfMiddleware() : null,
   retryMiddleware({
     fetchTimeout: 15000,

diff --git a/src/index.js b/src/index.js
@@ -7,7 +7,7 @@ import urlMiddleware from './middlewares/url';
 import authMiddleware from './middlewares/auth';
 import perfMiddleware from './middlewares/perf';
 import loggerMiddleware from './middlewares/logger';
-import gqlErrorsMiddleware from './middlewares/gqlErrors';
+import errorMiddleware from './middlewares/error';
 import cacheMiddleware from './middlewares/cache';
 import graphqlBatchHTTPWrapper from './express-middleware/graphqlBatchHTTPWrapper';
 import RelayNetworkLayerRequest from './RelayRequest';
@@ -25,7 +25,7 @@ export {
   authMiddleware,
   perfMiddleware,
   loggerMiddleware,
-  gqlErrorsMiddleware,
+  errorMiddleware,
   cacheMiddleware,
   graphqlBatchHTTPWrapper,
 };
diff --git a/...ts__/__snapshots__/gqlErrors-test.js.snap → ..._tests__/__snapshots__/error-test.js.snap b/...ts__/__snapshots__/gqlErrors-test.js.snap → ..._tests__/__snapshots__/error-test.js.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`middlewares/gqlErrors should display graphql errors 1`] = `
+exports[`middlewares/error should display graphql errors 1`] = `
 "[RELAY-NETWORK] GRAPHQL SERVER ERROR:
 
 %cError: Wow!

diff --git a/src/middlewares/__tests__/gqlErrors-test.js → src/middlewares/__tests__/error-test.js b/src/middlewares/__tests__/gqlErrors-test.js → src/middlewares/__tests__/error-test.js
@@ -3,9 +3,9 @@
 import fetchMock from 'fetch-mock';
 import RelayNetworkLayer from '../../RelayNetworkLayer';
 import { mockReq } from '../../__mocks__/mockReq';
-import gqlErrorsMiddleware from '../gqlErrors';
+import errorMiddleware from '../error';
 
-describe('middlewares/gqlErrors', () => {
+describe('middlewares/error', () => {
   beforeEach(() => {
     fetchMock.restore();
   });
@@ -43,7 +43,7 @@ describe('middlewares/gqlErrors', () => {
 
     const logger = jest.fn();
     const rnl = new RelayNetworkLayer([
-      gqlErrorsMiddleware({
+      errorMiddleware({
         logger,
       }),
     ]);

diff --git a/src/middlewares/gqlErrors.js → src/middlewares/error.js b/src/middlewares/gqlErrors.js → src/middlewares/error.js
@@ -12,7 +12,7 @@ export type GqlErrorMiddlewareOpts = {|
   disableServerMiddlewareTip?: boolean,
 |};
 
-export default function gqlErrorsMiddleware(options?: GqlErrorMiddlewareOpts): Middleware {
+export default function errorMiddleware(options?: GqlErrorMiddlewareOpts): Middleware {
   const opts = options || {};
   const logger = opts.logger || console.error.bind(console);
   const prefix = opts.prefix || '[RELAY-NETWORK] GRAPHQL SERVER ERROR:\n\n';