feat: GraphQL support (#31)

* feat: GraphQL support

* chore: Added GraphQL throw examples

* fix: captureException mocks

* chore: Added GraphQL warning error

* docs(readme): remove context options, and fixed typo

* chore: update dependencies

* chore: Added withGraphQL options

* fix: use getContext

* docs(readme): apply prettier

.travis.yml

@@ -13,4 +13,5 @@ cache:
   directories:
     - node_modules
 
-after_success: npm run coverage
+before_script: npm run lint
+after_success: npm run coverage

README.md

@@ -48,7 +48,7 @@ this should be done in your `main.ts` file where you initialize the NestJS appli
 
 ```ts
 @Module({
-  imports: [...RavenModule]
+  imports: [RavenModule],
 })
 export class ApplicationModule implements NestModule {}
 ```
@@ -76,16 +76,16 @@ this. This only works for Controllers not for Gateways (limitation by NestJS):
 > app.module.ts
 
 ```ts
-import { APP_INTERCEPTOR } from "@nestjs/core";
+import { APP_INTERCEPTOR } from '@nestjs/core';
 
 @Module({
   imports: [RavenModule],
   providers: [
     {
       provide: APP_INTERCEPTOR,
-      useValue: new RavenInterceptor()
-    }
-  ]
+      useValue: new RavenInterceptor(),
+    },
+  ],
 })
 export class ApplicationModule {}
 ```
@@ -126,11 +126,13 @@ Other additional data can be added for each interceptor.
 > app.controller.ts
 
 ```ts
+import { Severity } from '@sentry/node';
+
   @UseInterceptors(new RavenInterceptor({
     tags: {
       type: 'fileUpload',
     },
-    level: 'warning',
+    level: Severity.Warning,
   }))
   @Get('/some/route')
   public async someRoute()
@@ -142,17 +144,12 @@ Other additional data can be added for each interceptor.
 
 > **Note:** Websockets ignore Global interceptors.
 
-When using with websockets, you should provide context, as we cannot autmaticly detarmin if
-we are capturing http or websocket exception.
-
 It will add `ws_client` and `ws_data` extras.
 
 > app.gateway.ts
 
 ```ts
-  @UseInterceptors(new RavenInterceptor({
-    context: 'Ws'
-  }))
+  @UseInterceptors(new RavenInterceptor())
   @SubscribeMessage('message_name')
   public someMessage(client, data: string): string {
     ...
@@ -161,20 +158,13 @@ It will add `ws_client` and `ws_data` extras.
 
 #### GraphQL
 
-> **Warning**: This is an ALPHA level of support. There are bugs, not intended for production.
-
-When using with graphql, you should provide context, as we cannot automatically determine if
-we are capturing http or graphql exception.
-
-It will add `fieldname` and `args` extras.
+It will add `fieldName` and `args` extras.
 
 > app.gateway.ts
 
 ```ts
   @Mutation()
-  @UseInterceptors(new RavenInterceptor({
-    context: 'GraphQL'
-  }))
+  @UseInterceptors(new RavenInterceptor())
   async upvotePost(@Args('postId') postId: number) {
     ...
   }

example/__tests__/app.e2e-spec.ts

@@ -0,0 +1,75 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import * as request from 'supertest';
+import { INestApplication } from '@nestjs/common';
+import { GraphQLModule } from '@nestjs/graphql';
+import { createTestClient } from 'apollo-server-testing';
+import gql from 'graphql-tag';
+import { AppModule } from './../src/app.module';
+
+describe('AppModule', () => {
+  let app: INestApplication;
+  let apolloClient: ReturnType<typeof createTestClient>;
+
+  beforeAll(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+
+    const module: GraphQLModule = moduleFixture.get<GraphQLModule>(
+      GraphQLModule,
+    );
+    // apolloServer is protected, we need to cast module to any to get it
+    apolloClient = createTestClient((module as any).apolloServer);
+  });
+
+  afterAll(() => app.close());
+
+  it('defined', () => expect(app).toBeDefined());
+
+  it('/ (GET)', () =>
+    request(app.getHttpServer())
+      .get('/')
+      .expect(500));
+
+  it('/graphql (GET)', () =>
+    request(app.getHttpServer())
+      .get('/graphql')
+      .expect(400));
+
+  it('/graphql(POST) forbiddenError warning', async () => {
+    const { query } = apolloClient;
+    const result = await query({
+      query: gql`
+        query {
+          authenticationError
+        }
+      `,
+      variables: {},
+    });
+    expect(result.errors).toMatchInlineSnapshot(`
+      Array [
+        [GraphQLError: AuthenticationError],
+      ]
+    `);
+  });
+
+  it('/graphql(POST) forbiddenError', async () => {
+    const { query } = apolloClient;
+    const result = await query({
+      query: gql`
+        query {
+          forbiddenError
+        }
+      `,
+      variables: {},
+    });
+    expect(result.errors).toMatchInlineSnapshot(`
+      Array [
+        [GraphQLError: forbidden],
+      ]
+    `);
+  });
+});

test/test-project/src/app.controller.ts → example/src/app.controller.ts

@@ -1,6 +1,6 @@
 import { Controller, Get, UseInterceptors } from '@nestjs/common';
 import { AppService } from './app.service';
-import { RavenInterceptor } from 'nest-raven';
+import { RavenInterceptor } from '../../lib';
 
 @Controller()
 @UseInterceptors(new RavenInterceptor())

example/src/app.module.ts

@@ -0,0 +1,29 @@
+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { APP_INTERCEPTOR } from '@nestjs/core';
+import { GraphQLModule } from '@nestjs/graphql';
+import { RavenInterceptor } from '../../lib';
+import { GqlModule } from './gql/gql.module';
+
+@Module({
+  imports: [
+    GraphQLModule.forRoot({
+      autoSchemaFile: 'example/src/schema.gql',
+      debug: true,
+      playground: true,
+    }),
+    GqlModule,
+  ],
+  controllers: [AppController],
+  providers: [
+    AppService,
+    {
+      provide: APP_INTERCEPTOR,
+      useValue: new RavenInterceptor({
+        withGraphQL: true,
+      }),
+    },
+  ],
+})
+export class AppModule {}

test/test-project/src/app.service.ts → example/src/app.service.ts

@@ -4,6 +4,5 @@ import { Injectable, InternalServerErrorException } from '@nestjs/common';
 export class AppService {
   getHello(): string {
     throw new InternalServerErrorException('This is not good?');
-    return 'Hello World!';
   }
 }

example/src/gql/gql.module.ts

@@ -0,0 +1,7 @@
+import { Module } from '@nestjs/common';
+import { GqlResolver } from './gql.resolver';
+
+@Module({
+  providers: [GqlResolver],
+})
+export class GqlModule {}

example/src/gql/gql.resolver.spec.ts

@@ -0,0 +1,35 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { GqlResolver } from './gql.resolver';
+
+describe('GqlResolver', () => {
+  let resolver: GqlResolver;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [GqlResolver],
+    }).compile();
+
+    resolver = module.get<GqlResolver>(GqlResolver);
+  });
+
+  it('should be defined', () => expect(resolver).toBeDefined());
+
+  it('apollo-server-errors (AuthenticationError)', () =>
+    expect(
+      resolver.authenticationError(),
+    ).rejects.toThrowErrorMatchingInlineSnapshot(`"AuthenticationError"`));
+
+  it('apollo-server-errors (Forbidden)', () =>
+    expect(
+      resolver.forbiddenError(),
+    ).rejects.toThrowErrorMatchingInlineSnapshot(`"forbidden"`));
+
+  it('@nestjs/common (Forbidden)', () =>
+    expect(resolver.forbiddenException()).rejects
+      .toThrowErrorMatchingInlineSnapshot(`
+Object {
+  "error": "Forbidden",
+  "statusCode": 403,
+}
+`));
+});

example/src/gql/gql.resolver.ts

@@ -0,0 +1,24 @@
+import { Resolver, Query } from '@nestjs/graphql';
+import { ForbiddenError, AuthenticationError } from 'apollo-server-errors';
+import { ForbiddenException, UseInterceptors } from '@nestjs/common';
+import { Severity } from '@sentry/node';
+import { RavenInterceptor } from '../../../lib';
+
+@Resolver('Gql')
+export class GqlResolver {
+  @Query(() => Boolean)
+  async forbiddenError() {
+    throw new ForbiddenError('forbidden');
+  }
+
+  @Query(() => Boolean)
+  async forbiddenException() {
+    throw new ForbiddenException();
+  }
+
+  @UseInterceptors(new RavenInterceptor({ level: Severity.Warning }))
+  @Query(() => Boolean)
+  async authenticationError() {
+    throw new AuthenticationError('AuthenticationError');
+  }
+}

example/src/schema.gql

@@ -0,0 +1,10 @@
+# -----------------------------------------------
+# !!! THIS FILE WAS GENERATED BY TYPE-GRAPHQL !!!
+# !!!   DO NOT MODIFY THIS FILE BY YOURSELF   !!!
+# -----------------------------------------------
+
+type Query {
+  forbiddenError: Boolean!
+  forbiddenException: Boolean!
+  authenticationError: Boolean!
+}

test/test-project/tsconfig.json → example/tsconfig.json

@@ -8,7 +8,6 @@
     "target": "es6",
     "sourceMap": true,
     "outDir": "./dist",
-    "baseUrl": "./",
     "incremental": true
   },
   "exclude": ["node_modules"]

lib/index.ts

@@ -1,3 +1,3 @@
-export * from './raven.interceptor'
+export * from './raven.interceptor';
 export * from './raven.interfaces';
 export * from './raven.module';