feat: change loader to be async and add tests

change loader to be async and add tests

Author: schickling

README.md

@@ -11,19 +11,47 @@ Webpack loader for [`graphql-import`](https://github.com/graphcool/graphql-impor
 yarn add --dev graphql-import-loader
 ```
 
-Add the following to the `rules` section in your `webpack.config.js`
+## Usage
+
+Resolve GraphQL file import statements as a string. See the tests for more details
+
+```graphql
+# import { A } from 'src/schema/a.graphql'
+# import { B } from 'src/schema/b.graphql'
+# import { C D } from 'src/schema/cd.graphql'
+
+type Complex  {
+  id: ID!
+  a: A!
+  b: B!
+  c: C!
+  d: D!
+}
+```
 
 ```js
-    rules: [{
-      exclude: /node_modules/,
-      test: /\.graphql$/,
-      use: [{ loader: 'graphql-import-loader' }]
-    }],
+import typeDefs from './schema.graphql'
 ```
 
-## Usage
+```js
+// webpack.config.js
 
-You can now `require` or `import` `.graphql` files (resolved as strings) in your application:
+module.exports = {
+  module: {
+    rules: [
+      {
+        exclude: /node_modules/,
+        test: /\.graphql$/,
+        use: [{ loader: 'graphql-import-loader' }]
+      }
+    ]
+  }
+}
+```
+
+## Examples
+
+Simple Server:
 
 ```ts
 import { GraphQLServer } from 'graphql-yoga'
@@ -32,4 +60,9 @@ import typeDefs from './schema.graphql'
 
 const server = new GraphQLServer({ typeDefs, resolvers })
 server.start(() => console.log('Server running on :4000'))
-```
+```
+
+
+Advanced:
+
+[serverless-prisma](https://github.com/jgeschwendt/serverless-prisma): Serverless starter kit using Prisma (early-stages)

jest.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  "roots": [
+    "<rootDir>"
+  ],
+  "transform": {
+    "^.+\\.ts?$": "ts-jest"
+  },
+  "testRegex": "test/.*\\.test\\.ts$",
+  "moduleFileExtensions": [
+    "js",
+    "ts",
+    "node"
+  ]
+}

package.json

@@ -25,12 +25,20 @@
   "scripts": {
     "prepare": "npm run build",
     "build": "rm -rf dist && tsc -d",
-    "test": "npm run build"
-  },
-  "devDependencies": {
-    "typescript": "2.7.2"
+    "pretest": "npm run build",
+    "test": "jest"
   },
   "dependencies": {
     "graphql-import": "^0.4.5"
+  },
+  "devDependencies": {
+    "@types/jest": "^22.1.4",
+    "@types/node": "^9.4.6",
+    "ts-jest": "^22.4.1",
+    "graphql": "^0.13.1",
+    "jest": "^22.4.2",
+    "memory-fs": "^0.4.1",
+    "typescript": "^2.7.2",
+    "webpack": "^4.0.1"
   }
 }

src/index.ts

@@ -1,6 +1,9 @@
 import { importSchema } from 'graphql-import'
 
-export default source => {
-  this.value = source
-  return `module.exports = \`${importSchema(source)}\``
+export default function(source) {
+  const callback = this.async();
+
+  this.cacheable()
+
+  callback(null, `module.exports = \`${importSchema(source)}\``)
 }

test/compiler.ts

@@ -0,0 +1,34 @@
+import * as memoryfs from 'memory-fs'
+import * as path from 'path'
+import * as webpack from 'webpack'
+import { Stats } from 'webpack'
+
+export default (fixture, options = {}) => {
+  const compiler = webpack({
+    mode: 'development',
+    context: path.resolve(__dirname),
+    entry: `./fixtures/${fixture}`,
+    output: {
+      path: path.resolve(__dirname),
+      filename: 'bundle.js',
+    },
+    module: {
+      rules: [{
+        test: /\.graphql$/,
+        use: [
+          { loader: path.resolve(__dirname, '..', 'dist/src') }
+        ]
+      }]
+    }
+  })
+
+  compiler.outputFileSystem = new memoryfs()
+
+  return new Promise<Stats>((resolve, reject) => {
+    compiler.run((err, stats) => {
+      if (err) reject(err)
+
+      resolve(stats)
+    })
+  })
+}

test/fixtures/a.graphql

@@ -0,0 +1,4 @@
+type A {
+  id: ID!
+  valueA: String
+}

test/fixtures/b.graphql

@@ -0,0 +1,4 @@
+type B {
+  id: ID!
+  valueB: String
+}

test/fixtures/cd.graphql

@@ -0,0 +1,9 @@
+type C {
+  id: ID!
+  valueC: String
+}
+
+type D {
+  id: ID!
+  valueD: String
+}

test/fixtures/complex.graphql

@@ -0,0 +1,11 @@
+# import { A } from 'test/fixtures/a.graphql'
+# import { B } from 'test/fixtures/b.graphql'
+# import { C D } from 'test/fixtures/cd.graphql'
+
+type Complex  {
+  id: ID!
+  a: A!
+  b: B!
+  c: C!
+  d: D!
+}

test/fixtures/simple.graphql

@@ -0,0 +1,4 @@
+type Simple {
+  id: ID!
+  value: String
+}

test/loader.test.ts

@@ -0,0 +1,49 @@
+import compiler from './compiler'
+
+const simple = `module.exports = \`type Simple {
+  id: ID!
+  value: String
+}
+\``
+
+const complex = `module.exports = \`type Complex {
+  id: ID!
+  a: A!
+  b: B!
+  c: C!
+  d: D!
+}
+
+type A {
+  id: ID!
+  valueA: String
+}
+
+type B {
+  id: ID!
+  valueB: String
+}
+
+type C {
+  id: ID!
+  valueC: String
+}
+
+type D {
+  id: ID!
+  valueD: String
+}
+\``
+
+const fixtures = {
+  'simple.graphql': simple,
+  'complex.graphql': complex,
+}
+
+Object.keys(fixtures).forEach(fixture => {
+  test(`Fixture: ${fixture}`, async () => {
+    const stats = await compiler(fixture)
+    const output = stats.toJson().modules[0].source
+    expect(output).toBe(fixtures[fixture])
+  })
+})

tsconfig.json

@@ -10,5 +10,9 @@
     "outDir": "dist",
     "lib": ["es2015"]
   },
-  "exclude": ["node_modules"]
+  "exclude": [
+    "dist",
+    "node_modules",
+    "test"
+  ]
 }