feat(base): data source template 💥

- Adds templates for npm and DevOps
- TODOs for all items that need to be edited
- Simplest possible example data source to limit how much boilerplate editing is required
- Starts with test coverage at 💯
- Provides testing helpers for common resolver testing patterns
- Comes with docs! https://ibm.biz/graphql-data-source

closes bluemix/graphql#125

Author: jlengstorf

.travis.yml

@@ -1,7 +1,12 @@
 {
-  "name": "@console/graphql-data-source-base",
-  "version": "0.0.0-semantic-release",
+  "name": "@console/graphql-data-source-[DATA_SOURCE_NAME]",
   "description": "This is a data source for the Bluemix GraphQL µ-service.",
+  "author": "Your Name <[email protected]>",
+  "repository": {
+    "type": "git",
+    "url": "[email protected]:bluemix/[REPO_NAME].git"
+  },
+  "version": "0.0.0-semantic-release",
   "main": "src/index.js",
   "directories": {
     "test": "test"
@@ -21,14 +26,9 @@
     "test:unit": "NODE_ENV=test LOG4JS_LEVEL='OFF' jest --coverage",
     "test": "npm run lint --silent && npm run test:unit --silent"
   },
-  "repository": {
-    "type": "git",
-    "url": "[email protected]:bluemix/graphql-data-source-base.git"
-  },
   "keywords": [
     "graphql"
   ],
-  "author": "Jason Lengstorf <[email protected]> (https://lengstorf.com)",
   "license": "ISC",
   "dependencies": {
     "@console/graphql-data-source-helpers": "^1.0.2",

package.json package.TEMPLATE.jsonpackage.json renamed to package.TEMPLATE.json

@@ -1,9 +1,10 @@
 import { GraphQLConnector } from '@console/graphql-data-source-helpers';
 
-export default class CloudFoundryAppConnector extends GraphQLConnector {
+// TODO: change `YourDataSourceConnector` to a descriptive name
+export default class YourDataSourceConnector extends GraphQLConnector {
   /**
-   * Env-specific API endpoint for Cloud Foundry.
+   * TODO: describe this API endpoint
    * @member {string}
    */
-  apiBaseUri = `https://api.${process.env.cfDomain}/v2`;
+  apiBaseUri = `https://example.org/v2`;
 }

sonar-project.properties

@@ -3,9 +3,13 @@ import resolvers from './resolvers';
 import Connector from './connector';
 import Model from './model';
 
+/*
+ * For more information on the main data source object, see
+ * https://ibm.biz/graphql-data-source-main
+ */
 export default {
-  // This is used to reference the model (e.g. context.YourModel.getAll())
-  context: 'CloudFoundryApp',
+  // TODO: Rename the context to describe the data source.
+  context: 'YourDataSource',
   model: new Model({ connector: new Connector() }),
   schema,
   resolvers,

src/connector.js

@@ -3,49 +3,44 @@ import {
   BluemixGraphQLError,
 } from '@console/graphql-data-source-helpers';
 
-const formatEnvVars = unformattedVars => {
-  const envVars = {};
+/*
+ * For more information on data source models, see
+ * https://ibm.biz/graphql-data-source-model
+ */
 
-  unformattedVars.forEach(keyValuePair => {
-    envVars[keyValuePair.key] = keyValuePair.value;
-  });
-
-  return envVars;
-};
-
-export default class CloudFoundryAppModel extends GraphQLModel {
+// TODO: change `YourDataSourceModel` to a descriptive name
+export default class YourDataSourceModel extends GraphQLModel {
   /**
-   * Loads GitHub data for a given user
-   * @param  {String}  username the username to load
-   * @return {Promise}          resolves with the loaded user data
+   * Loads a thing by its ID
+   * @param  {String}  id  the ID of the thing to load
+   * @return {Promise}     resolves with the loaded user data
    */
-  getAppByGuid(appGuid) {
+  getById(id) {
     return this.connector
-      .get(`/apps/${appGuid}/summary`)
-      .catch(res => this.handleError(res));
-  }
-
-  updateAppByGuid(appGuid, updates) {
-    // Only include env vars if they are passed-in/defined to avoid overriding them.
-    const safeUpdates =
-      updates.environment_json !== undefined
-        ? {
-            ...updates,
-            environment_json: formatEnvVars(updates.environment_json),
-          }
-        : updates;
-
-    return this.connector
-      .put(`/apps/${appGuid}`, safeUpdates)
+      .get(`/data/${id}`)
       .catch(res => this.handleError(res));
   }
 
+  /**
+   * Throws a BluemixGraphQLError using information from the error response.
+   *
+   * @see https://ibm.biz/graphql-helpers
+   *
+   * @param  {object} response  an error response
+   * @return {void}
+   */
   handleError(response) {
+    // TODO: map your endpoint’s error response to the BluemixGraphQL
     throw BluemixGraphQLError({
+      // 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.)
       graphqlModel: this.constructor.name,
     });
   }