Merge pull request #37 from relay-tools/relay-modern

taion · web-flow · commit e6fb4a20ebd5 · 2017-06-02T14:21:55.000-04:00
Support Relay Modern
diff --git a/.babelrc b/.babelrc
@@ -1,6 +1,9 @@
 {
   "presets": [
-    ["es2015", { "loose": true }]
+    ["latest", {
+      "es2015": { "loose": true }
+    }],
+    "stage-1"
   ],
   "plugins": ["add-module-exports"]
 }
diff --git a/.gitignore b/.gitignore
@@ -26,5 +26,8 @@ build/Release
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
-# Transpiled code
+# Transpiled code.
 /lib
+
+# Generated files.
+__generated__
diff --git a/.travis.yml b/.travis.yml
@@ -1,21 +1,22 @@
-sudo: false
+# We need sudo to properly install Watchman.
+sudo: required
 
 language: node_js
 node_js:
   - stable
 
-env:
-  - BROWSER=ChromeCi
-  - BROWSER=Firefox
-
 cache:
   directories:
     - node_modules
 
 before_install:
-  - export CHROME_BIN=chromium-browser
-  - export DISPLAY=:99.0
-  - sh -e /etc/init.d/xvfb start
+  # Relay Compiler requires Watchman.
+  # TODO: Cache this? The Watchman build is pretty quick, though.
+  - git clone https://github.com/facebook/watchman.git ~/facebook/watchman
+  - pushd ~/facebook/watchman
+  - git checkout v4.7.0
+  - ./autogen.sh && ./configure && make && sudo make install
+  - popd
 
 branches:
   only:
diff --git a/README.md b/README.md
@@ -1,16 +1,42 @@
-# relay-local-schema [![Travis][build-badge]][build] [![npm][npm-badge]][npm]
+# Relay Local Schema [![Travis][build-badge]][build] [![npm][npm-badge]][npm]
 Use [Relay](http://facebook.github.io/relay/) without a GraphQL server.
 
 [![Discord][discord-badge]][discord]
 
 ## Usage
 
-Use `RelayLocalSchema.NetworkLayer` to execute GraphQL queries locally, rather than against a separate GraphQL server.
+### Relay Modern
 
-This is intended for exploratory work, integration tests, demos, and working with local data. This is not generally intended as a substitute for a remote backend, except possibly when using local data as a persistent cache.
+```js
+import { Network } from 'relay-local-schema';
+
+import schema from './data/schema';
+
+const environment = new Environment({
+  network: Network.create({ schema }),
+  /* ... */
+});
+```
+
+This will execute queries against the specified schema locally, rather than against a separate GraphQL server.
+
+You can also specify a GraphQL.js `rootValue` or `contextValue`:
+
+```js
+const environment = new Environment({
+  network: Network.create({
+    schema,
+    rootValue: 'foo',
+    contextValue: 'bar',
+  }),
+  /* ... */
+});
+```
+
+### Relay Classic
 
 ```js
-import RelayLocalSchema from 'relay-local-schema';
+import RelayLocalSchema from 'relay-local-schema/lib/classic';
 
 import schema from './data/schema';
 
@@ -19,19 +45,25 @@ Relay.injectNetworkLayer(
 );
 ```
 
-You can also supply a GraphQL.js `rootValue` or an `onError` callback to the
-constructor:
+This will execute queries against the specified schema locally, rather than against a separate GraphQL server.
+
+You can also supply a GraphQL.js `rootValue` or `contextValue`, or an `onError` callback:
 
 ```js
 Relay.injectNetworkLayer(
   new RelayLocalSchema.NetworkLayer({
     schema,
     rootValue: 'foo',
+    contextValue: 'bar',
     onError: (errors, request) => console.error(errors, request),
   })
 );
 ```
 
+## Caveat
+
+This is intended for exploratory work, integration tests, demos, and working with local data. This is not generally intended as a substitute for a remote GraphQL back end in production.
+
 [build-badge]: https://img.shields.io/travis/relay-tools/relay-local-schema/master.svg
 [build]: https://travis-ci.org/relay-tools/relay-local-schema
 
diff --git a/karma.conf.js b/karma.conf.js
diff --git a/package.json b/package.json
@@ -8,12 +8,14 @@
   "main": "lib/index.js",
   "scripts": {
     "build": "rimraf lib && babel src -d lib",
-    "build-fixtures": "babel-node test/fixtures/updateSchema.js",
+    "build-fixtures": "npm run update-schema && npm run relay-compiler",
     "lint": "eslint src test *.js",
     "prepublish": "npm run build",
-    "tdd": "karma start",
+    "relay-compiler": "relay-compiler --src test/modern --schema test/fixtures/schema.graphql",
+    "tdd": "jest --watch",
     "test": "npm run build-fixtures && npm run lint && npm run testonly",
-    "testonly": "npm run tdd -- --single-run"
+    "testonly": "jest --runInBand --verbose",
+    "update-schema": "babel-node test/fixtures/updateSchema.js"
   },
   "repository": {
     "type": "git",
@@ -30,45 +32,35 @@
     "url": "https://github.com/relay-tools/relay-local-schema/issues"
   },
   "homepage": "https://github.com/relay-tools/relay-local-schema#readme",
+  "dependencies": {
+    "relay-runtime": "^1.0.0"
+  },
   "peerDependencies": {
     "graphql": ">=0.5.0",
     "react-relay": ">=0.8.0"
   },
   "devDependencies": {
     "babel-cli": "^6.24.1",
-    "babel-core": "^6.24.1",
     "babel-eslint": "^7.2.3",
-    "babel-loader": "^7.0.0",
+    "babel-jest": "^20.0.3",
     "babel-plugin-add-module-exports": "^0.2.1",
     "babel-plugin-relay": "^1.0.1",
     "babel-polyfill": "^6.23.0",
-    "babel-preset-es2015": "^6.24.1",
     "babel-preset-latest": "^6.24.1",
     "babel-preset-react": "^6.24.1",
-    "babel-preset-stage-2": "^6.24.1",
-    "chai": "^3.5.0",
+    "babel-preset-stage-1": "^6.24.1",
     "eslint": "^3.19.0",
     "eslint-config-4catalyzer-react": "^0.2.0",
     "eslint-plugin-import": "^2.3.0",
     "eslint-plugin-jsx-a11y": "^2.2.3",
     "eslint-plugin-react": "^6.7.1",
     "graphql": "^0.10.1",
     "graphql-relay": "^0.5.1",
-    "karma": "^1.7.0",
-    "karma-chrome-launcher": "^2.1.1",
-    "karma-firefox-launcher": "^1.0.1",
-    "karma-mocha": "^1.3.0",
-    "karma-mocha-reporter": "^2.2.3",
-    "karma-sinon-chai": "^1.3.1",
-    "karma-sourcemap-loader": "^0.3.7",
-    "karma-webpack": "^2.0.3",
-    "mocha": "^3.4.2",
+    "jest": "^20.0.4",
     "react": "^15.5.4",
     "react-dom": "^15.5.4",
     "react-relay": "^1.0.0",
-    "rimraf": "^2.6.1",
-    "sinon": "^2.3.2",
-    "sinon-chai": "^2.10.0",
-    "webpack": "^2.6.1"
+    "relay-compiler": "^1.0.0",
+    "rimraf": "^2.6.1"
   }
 }
diff --git a/src/classic/NetworkLayer.js b/src/classic/NetworkLayer.js
diff --git a/src/classic/__forks__/createRequestError.js b/src/classic/__forks__/createRequestError.js
diff --git a/src/classic/__forks__/formatRequestErrors.js b/src/classic/__forks__/formatRequestErrors.js
diff --git a/src/classic/index.js b/src/classic/index.js
@@ -0,0 +1,3 @@
+import NetworkLayer from './NetworkLayer';
+
+export default { NetworkLayer };
diff --git a/src/index.js b/src/index.js
@@ -1,3 +1 @@
-import NetworkLayer from './NetworkLayer';
-
-export default { NetworkLayer };
+export * from './modern';
diff --git a/src/modern/Network.js b/src/modern/Network.js
@@ -0,0 +1,24 @@
+import { graphql } from 'graphql';
+import { Network as NetworkBase } from 'relay-runtime';
+
+export default {
+  create({ schema, rootValue, contextValue }) {
+    function fetchQuery(operation, variables) {
+      return graphql(
+        schema,
+        operation.text,
+        rootValue,
+        contextValue,
+        variables,
+      ).then((payload) => {
+        if (payload.errors) {
+          throw new Error(payload.errors);
+        }
+
+        return payload;
+      });
+    }
+
+    return NetworkBase.create(fetchQuery);
+  },
+};
diff --git a/src/modern/index.js b/src/modern/index.js
@@ -0,0 +1 @@
+export Network from './Network';
diff --git a/test/.eslintrc b/test/.eslintrc
@@ -1,10 +1,7 @@
 {
   "extends": "4catalyzer-react",
   "env": {
-    "mocha": true
-  },
-  "globals": {
-    "expect": true
+    "jest": true
   },
   "rules": {
     "react/no-multi-comp": "off",
diff --git a/test/classic/.babelrc b/test/classic/.babelrc
@@ -3,7 +3,7 @@
     ["latest", {
       "es2015": { "loose": true }
     }],
-    "stage-2",
+    "stage-1",
     "react"
   ],
   "plugins": [
diff --git a/test/classic/NetworkLayer.test.js b/test/classic/NetworkLayer.test.js
@@ -3,9 +3,9 @@ import ReactDOM from 'react-dom';
 import ReactTestUtils from 'react-dom/test-utils';
 import Relay from 'react-relay/classic';
 
-import RelayLocalSchema from '../src';
+import RelayLocalSchema from '../../src/classic';
 
-import schema, { resetData } from './fixtures/schema';
+import schema, { resetData } from '../fixtures/schema';
 
 describe('NetworkLayer', () => {
   let environment;
@@ -51,7 +51,7 @@ describe('NetworkLayer', () => {
             return;
           }
 
-          expect(ReactDOM.findDOMNode(this).innerHTML).to.equal('foo');  // eslint-disable-line react/no-find-dom-node
+          expect(ReactDOM.findDOMNode(this).innerHTML).toBe('foo');  // eslint-disable-line react/no-find-dom-node
           done();
         };
 
@@ -99,7 +99,7 @@ describe('NetworkLayer', () => {
         environment={environment}
         render={({ error }) => {
           if (error) {
-            expect(error.source.errors[0].message).to.equal('Always fail');
+            expect(error.source.errors[0].message).toBe('Always fail');
             done();
           }
         }}
@@ -150,7 +150,7 @@ describe('NetworkLayer', () => {
 
       class Widget extends React.Component {
         componentDidMount() {
-          expect(this.node.innerHTML).to.equal('foo');
+          expect(this.node.innerHTML).toBe('foo');
 
           const { relay, widget } = this.props;
 
@@ -160,7 +160,7 @@ describe('NetworkLayer', () => {
         }
 
         componentDidUpdate() {
-          expect(this.node.innerHTML).to.equal('bar');
+          expect(this.node.innerHTML).toBe('bar');
           done();
         }
 
diff --git a/test/index.js b/test/index.js
diff --git a/test/modern/.babelrc b/test/modern/.babelrc
@@ -0,0 +1,10 @@
+{
+  "presets": [
+    ["latest", {
+      "es2015": { "loose": true }
+    }],
+    "stage-1",
+    "react"
+  ],
+  "plugins": ["relay"]
+}
diff --git a/test/modern/Network.test.js b/test/modern/Network.test.js

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"presets": [`
`3`		`- ["es2015", { "loose": true }]`
	`3`	`+ ["latest", {`
	`4`	`+ "es2015": { "loose": true }`
	`5`	`+ }],`
	`6`	`+ "stage-1"`
`4`	`7`	`],`
`5`	`8`	`"plugins": ["add-module-exports"]`
`6`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import NetworkLayer from './NetworkLayer';`
	`2`	`+`
	`3`	`+export default { NetworkLayer };`