Merge pull request #9 from 0b10/major-v2.0.0

v2.0.0 - update dataloader to v2.0.0

Author: krislefeber

README.md

@@ -1,24 +1,29 @@
 # NestJS Dataloader
+
 NestJS dataloader simplifies adding [graphql/dataloader](https://github.com/graphql/dataloader) to your NestJS project. DataLoader aims to solve the common N+1 loading problem.
 
 ## Installation
 
 Install with yarn
-``` bash
+
+```bash
 yarn add nestjs-dataloader
 ```
 
 Install with npm
-``` bash
+
+```bash
 npm install --save nestjs-dataloader
-``` 
+```
 
 ## Usage
+
 ### NestDataLoader Creation
-We start by implementing the ```NestDataLoader``` interface. This tells ```DataLoader``` how to load our objects.
 
-``` typescript
-import * as DataLoader from 'dataloader';
+We start by implementing the `NestDataLoader` interface. This tells `DataLoader` how to load our objects.
+
+```typescript
+import DataLoader from 'dataloader';
 import { Injectable } from '@nestjs/common';
 import { NestDataLoader } from 'nestjs-dataloader';
 ...
@@ -27,18 +32,19 @@ import { NestDataLoader } from 'nestjs-dataloader';
 export class AccountLoader implements NestDataLoader<string, Account> {
   constructor(private readonly accountService: AccountService) { }
 
-  generateDataLoader(): DataLoader<string, Account> {      
+  generateDataLoader(): DataLoader<string, Account> {
     return new DataLoader<string, Account>(keys => this.accountService.findByIds(keys));
   }
 }
 ```
 
-The first generic of the interface is the type of ID the datastore uses. The second generic is the type of object that will be returned. In the above instance, we want ```DataLoader``` to return instances of the ```Account``` class.
+The first generic of the interface is the type of ID the datastore uses. The second generic is the type of object that will be returned. In the above instance, we want `DataLoader` to return instances of the `Account` class.
 
 ### Providing the NestDataLoader
+
 For each NestDataLoader we create, we need to provide it to our module.
 
-``` typescript
+```typescript
 import { Module } from '@nestjs/common';
 import { APP_INTERCEPTOR } from '@nestjs/core';
 import {DataLoaderInterceptor} from 'nestjs-dataloader'
@@ -59,9 +65,11 @@ export class ResolversModule { }
 ```
 
 ### Using the NestDataLoader
+
 Now that we have a dataloader and our module is aware of it, we need to pass it as a parameter to an endpoint in our graphQL resolver.
-``` typescript
-import * as DataLoader from 'dataloader';
+
+```typescript
+import DataLoader from 'dataloader';
 import { Loader } from 'nestjs-dataloader';
 ...
 
@@ -76,6 +84,9 @@ export class AccountResolver {
     }
 }
 ```
-The important thing to note is that the parameter of the ```@Loader``` decorator is the name of the ```NestDataLoader``` class we want to be injected to the method. The DataLoader library will handle bulk retrieval and caching of our requests. Note that the caching is stored on a per-request basis.
+
+The important thing to note is that the parameter of the `@Loader` decorator is the name of the `NestDataLoader` class we want to be injected to the method. The DataLoader library will handle bulk retrieval and caching of our requests. Note that the caching is stored on a per-request basis.
+
 ## Contributing
+
 Pull requests are always welcome. For major changes, please open an issue first to discuss what you would like to change.

index.ts

@@ -1,19 +1,25 @@
-import * as DataLoader from 'dataloader';
-import { NestInterceptor, ExecutionContext, CallHandler, InternalServerErrorException, createParamDecorator } from '@nestjs/common';
-import { Injectable } from '@nestjs/common';
-import { ModuleRef, APP_INTERCEPTOR } from '@nestjs/core';
+import {
+  CallHandler,
+  createParamDecorator,
+  ExecutionContext,
+  Injectable,
+  InternalServerErrorException,
+  NestInterceptor,
+} from '@nestjs/common';
+import { APP_INTERCEPTOR, ModuleRef } from '@nestjs/core';
 import { GqlExecutionContext } from '@nestjs/graphql';
+import DataLoader from 'dataloader';
 import { Observable } from 'rxjs';
 
 /**
  * This interface will be used to generate the initial data loader.
  * The concrete implementation should be added as a provider to your module.
  */
 export interface NestDataLoader<ID, Type> {
-    /**
-     * Should return a new instance of dataloader each time
-     */
-    generateDataLoader(): DataLoader<ID, Type>;
+  /**
+   * Should return a new instance of dataloader each time
+   */
+  generateDataLoader(): DataLoader<ID, Type>;
 }
 
 /**
@@ -28,51 +34,43 @@ const NEST_LOADER_CONTEXT_KEY: string = 'NEST_LOADER_CONTEXT_KEY';
 
 @Injectable()
 export class DataLoaderInterceptor implements NestInterceptor {
+  constructor(private readonly moduleRef: ModuleRef) {}
 
-    constructor(
-        private readonly moduleRef: ModuleRef,
-    ) { }
+  /**
+   * @inheritdoc
+   */
+  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
+    const graphqlExecutionContext = GqlExecutionContext.create(context);
+    const ctx: any = graphqlExecutionContext.getContext();
 
-    /**
-     * @inheritdoc
-     */
-    intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
-        const graphqlExecutionContext = GqlExecutionContext.create(context);
-        const ctx: any = graphqlExecutionContext.getContext();
-
-        if (ctx[NEST_LOADER_CONTEXT_KEY] === undefined) {
-
-            ctx[NEST_LOADER_CONTEXT_KEY] = (type: string): NestDataLoader<any, any> => {
-
-                if (ctx[type] === undefined) {
-                    try {
-                        ctx[type] = this.moduleRef
-                            .get<NestDataLoader<any, any>>(type, { strict: false })
-                            .generateDataLoader();
-                    } catch (e) {
-                        throw new InternalServerErrorException(`The loader ${type} is not provided`);
-                    }
-                }
-
-                return ctx[type];
-            };
+    if (ctx[NEST_LOADER_CONTEXT_KEY] === undefined) {
+      ctx[NEST_LOADER_CONTEXT_KEY] = (type: string): NestDataLoader<any, any> => {
+        if (ctx[type] === undefined) {
+          try {
+            ctx[type] = this.moduleRef
+              .get<NestDataLoader<any, any>>(type, { strict: false })
+              .generateDataLoader();
+          } catch (e) {
+            throw new InternalServerErrorException(`The loader ${type} is not provided`);
+          }
         }
-        return next.handle();
+
+        return ctx[type];
+      };
     }
+    return next.handle();
+  }
 }
 
 /**
  * The decorator to be used within your graphql method.
  */
-export const Loader = createParamDecorator(
-    (data: string, [_, __, ctx]) => {
-
-        if (ctx[NEST_LOADER_CONTEXT_KEY] === undefined) {
-            throw new InternalServerErrorException(`
+export const Loader = createParamDecorator((data: string, [_, __, ctx]) => {
+  if (ctx[NEST_LOADER_CONTEXT_KEY] === undefined) {
+    throw new InternalServerErrorException(`
             You should provide interceptor ${DataLoaderInterceptor.name} globaly with ${APP_INTERCEPTOR}
           `);
-        }
+  }
 
-        return ctx[NEST_LOADER_CONTEXT_KEY](data);
-    },
-);
+  return ctx[NEST_LOADER_CONTEXT_KEY](data);
+});

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-dataloader",
-  "version": "1.0.13",
+  "version": "2.0.0",
   "description": "A NestJS decorator for dataloader",
   "author": "Kris Lefeber <[email protected]>",
   "license": "MIT",
@@ -14,7 +14,7 @@
     "@nestjs/common": "^6.4.0",
     "@nestjs/core": "^6.4.0",
     "@nestjs/graphql": "^6.5.3",
-    "dataloader": "^1.4.0",
+    "dataloader": "^2.0.0",
     "rxjs": "^6.5.4"
   },
   "peerDependencies": {

yarn.lock

@@ -802,10 +802,10 @@ d@1, d@^1.0.1:
     es5-ext "^0.10.50"
     type "^1.0.1"
 
-dataloader@^1.4.0:
-  version "1.4.0"
-  resolved "https://registry.yarnpkg.com/dataloader/-/dataloader-1.4.0.tgz#bca11d867f5d3f1b9ed9f737bd15970c65dff5c8"
-  integrity sha512-68s5jYdlvasItOJnCuI2Q9s4q98g0pCyL3HrcKJu8KNugUl8ahgmZYg38ysLTgQjjXX3H8CJLkAvWrclWfcalw==
+dataloader@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/dataloader/-/dataloader-2.0.0.tgz#41eaf123db115987e21ca93c005cd7753c55fe6f"
+  integrity sha512-YzhyDAwA4TaQIhM5go+vCLmU0UikghC/t9DTQYZR2M/UvZ1MdOhPezSDZcjj9uqQJOMqjLcpWtyW2iNINdlatQ==
 
 [email protected]:
   version "2.6.9"