feat: initial OSS commit

Author: jlengstorf

src/connector.js

@@ -1,4 +1,4 @@
-import { GraphQLConnector } from '@console/gramps';
+import { GraphQLConnector } from '@gramps/gramps-express';
 
 // TODO: change `YourDataSourceConnector` to a descriptive name
 export default class YourDataSourceConnector extends GraphQLConnector {

src/model.js

@@ -1,4 +1,4 @@
-import { GraphQLModel, GrampsError } from '@console/gramps';
+import { GraphQLModel, GrampsError } from '@gramps/gramps-express';
 
 /*
  * For more information on data source models, see
@@ -13,32 +13,35 @@ export default class YourDataSourceModel extends GraphQLModel {
    * @return {Promise}     resolves with the loaded user data
    */
   getById(id) {
-    return this.connector
-      .get(`/data/${id}`)
-      .catch(res => this.handleError(res));
+    return this.connector.get(`/data/${id}`).catch(res =>
+      this.throwError(res, {
+        description: 'This is an example call. Add your own!',
+        docsLink:
+          'https://gramps-graphql.github.io/gramps-express/data-source/tutorial/',
+      }),
+    );
   }
 
   /**
-   * Throws a GrampsError using information from the error response.
-   *
-   * @see https://ibm.biz/graphql-helpers
-   *
-   * @param  {object} response  an error response
+   * Throws a custom GrAMPS error.
+   * @param  {Object}  error            the API error
+   * @param  {Object?} customErrorData  additional error data to display
    * @return {void}
    */
-  handleError(response) {
-    // TODO: map your endpoint’s error response to the GrampsError format.
-    throw GrampsError({
-      // An HTTP status code (e.g. 404).
-      statusCode: response.statusCode,
-      // A human-readable description of what went wrong (e.g. "Page not found").
-      description: response.error.description,
-      // An error code for looking up troubleshooting info (e.g. "MyApp_Err_NotFound").
-      errorCode: response.error.error_code,
-      // The endpoint that GraphQL was attempting to load (e.g. "https://api.example.org/user/123").
-      targetEndpoint: response.options.uri,
-      // The class where the error originated. (Don’t change this.)
+  throwError(error, customErrorData = {}) {
+    // TODO Edit these defaults to be helpful for people using your data source.
+    const defaults = {
+      statusCode: error.statusCode || 500,
+      errorCode: `${this.constructor.name}_Error`,
+      description: error.message || 'Something went wrong.',
+      targetEndpoint: error.options ? error.options.uri : null,
       graphqlModel: this.constructor.name,
+      docsLink: null,
+    };
+
+    throw GrampsError({
+      ...defaults,
+      ...customErrorData,
     });
   }
 }

src/resolvers.js

@@ -13,7 +13,10 @@ export default {
     YourDataSource: (rootValue, { id }, context) =>
       new Promise((resolve, reject) => {
         // TODO: Update to use the model and call the proper method.
-        context.YourDataSource.getById(id).then(resolve).catch(reject);
+        context.YourDataSource
+          .getById(id)
+          .then(resolve)
+          .catch(reject);
       }),
   },
 

test/__mocks__/console-platform-key-value-store.js

@@ -1,4 +1,4 @@
-import { GraphQLConnector } from '@console/gramps';
+import { GraphQLConnector } from '@gramps/gramps-express';
 import Connector from '../src/connector';
 
 // TODO: Update the data source name.

test/connector-test.js test/connector.test.jstest/connector-test.js renamed to test/connector.test.js

@@ -1,4 +1,4 @@
-import { GraphQLModel } from '@console/gramps';
+import { GraphQLModel } from '@gramps/gramps-express';
 import Model from '../src/model';
 import Connector from '../src/connector';
 
@@ -16,18 +16,6 @@ const DATA_SOURCE_NAME = 'YourDataSource';
 const connector = new Connector();
 const model = new Model({ connector });
 
-// TODO: Update this error to match the error format returned by your endpoint.
-const mockError = {
-  statusCode: 401,
-  error: {
-    description: 'test error',
-    error_code: 'TEST_ERROR',
-  },
-  options: {
-    uri: 'https://example.org/',
-  },
-};
-
 describe(`${DATA_SOURCE_NAME}Model`, () => {
   it('inherits the GraphQLModel class', () => {
     expect(model).toBeInstanceOf(GraphQLModel);
@@ -42,11 +30,11 @@ describe(`${DATA_SOURCE_NAME}Model`, () => {
       expect(spy).toHaveBeenCalledWith('/data/1234');
     });
 
-    it('throws a BluemixGraphQLError if something goes wrong', async () => {
+    it('throws a GrampsError if something goes wrong', async () => {
       expect.assertions(1);
 
       model.connector.get.mockImplementationOnce(() =>
-        Promise.reject(mockError),
+        Promise.reject({ no: 'good' }),
       );
 
       try {
@@ -58,9 +46,17 @@ describe(`${DATA_SOURCE_NAME}Model`, () => {
     });
   });
 
-  describe('handleError()', () => {
-    it('converts an error from the endpoint into a BluemixGraphQLError', async () => {
-      expect.assertions(6);
+  describe('throwError()', () => {
+    // TODO: Update this error to match the error format returned by your endpoint.
+    const mockError = {
+      statusCode: 401,
+      options: {
+        uri: 'https://example.org/',
+      },
+    };
+
+    it('converts an error from the endpoint into a GrampsError', async () => {
+      expect.assertions(4);
 
       /*
        * To simulate a failed call, we tell Jest to return a rejected Promise
@@ -74,14 +70,9 @@ describe(`${DATA_SOURCE_NAME}Model`, () => {
         // TODO: Update to use one of your model’s methods.
         await model.getById(1234);
       } catch (error) {
-        // Check that BluemixGraphQLError properly received the error detail.
+        // Check that GrampsError properly received the error detail.
         expect(error).toHaveProperty('isBoom', true);
         expect(error.output).toHaveProperty('statusCode', 401);
-        expect(error.output.payload).toHaveProperty(
-          'description',
-          'test error',
-        );
-        expect(error.output.payload).toHaveProperty('errorCode', 'TEST_ERROR');
         expect(error.output.payload).toHaveProperty(
           'targetEndpoint',
           'https://example.org/',
@@ -92,5 +83,21 @@ describe(`${DATA_SOURCE_NAME}Model`, () => {
         );
       }
     });
+
+    it('creates a default GrampsError if no custom error data is supplied', async () => {
+      try {
+        await model.throwError({});
+      } catch (error) {
+        expect(error.output.statusCode).toBe(500);
+        expect(error.output.payload.errorCode).toBe(
+          `${DATA_SOURCE_NAME}Model_Error`,
+        );
+        expect(error.output.payload.description).toBe('Something went wrong.');
+        expect(error.output.payload.graphqlModel).toBe(
+          `${DATA_SOURCE_NAME}Model`,
+        );
+        expect(error.output.payload.targetEndpoint).toBeNull();
+      }
+    });
   });
 });