oslabs-beta/DeSolver

DeSolver is a lightweight, Node.js, GraphQL library providing a powerful yet approachable API for composing modular resolver business logic.

DeSolver

 

Table of Contents

• About
• Getting Started
• How to Use
  • DeSolver Instance
  • Cache
  • Desolver Fragments
  • Creating Middleware Pipeline
  • Targeting a specific resolver type
  • Define resolvers as multiple fragments
• Contributors
• License

About

DeSolver for GraphQL: a lightweight, minimalist, unopinionated Node.js GraphQL framework providing a powerful yet approachable API for composing modular and reusable resolver business logic. DeSolver utilizes the middleware pattern as seen in other popular frameworks as a way to create "routing" for your resolvers.

The DeSolver instance methods allow a pipeline to be loaded with mini-resolver functions, and a wrapper forms around the resolver map object, permitting a series of functions in a chain or "pre-hook" functions to execute prior to a query or mutation. This minimizes the need to wrap individual resolver functions manually, thereby reducing templating and additional boilerplate. Composing resolvers in this way can help keep resolver code more maintainable, scalable and testable. DeSolver follows the "write once, run everywhere" mantra.

Getting Started

1. Installing DeSolver

• Start by running the npm command:

npm install desolver

• The DeSolver framework works best when combined with GraphQL tools Executable Schema package. It is recommended to download that package and use that to generate your type definitions, resolver map and schema.

• The DeSolver framework is compatible with the popular Apollo Server API. DeSolver can be utilized when combined with the resolver map object in Apollo Server.

• Redis is used for caching resolvers. Check out Redis and node-redis for installation details. When not using Redis or when using custom caching logic, DeSolver provides a configuration option to disable this default behavior.

How to use

Desolver Instance and Configuration

In your GraphQL server or resolvers file create a new instance of DeSolver:

const desolver = new Desolver(desolverConfig)

The following optional configuration object can be declared as the argument of the DeSolver constructor:

const desolverConfig = {
 cacheDesolver?: boolean, // set to true to enable Redis caching
 applyResolverType?: string // resolver type to target for running prehooks
}

• cacheDesolver: Set to true to enable Redis caching, by default if nothing is passed, the default redis instance will be started. Set to false to disable this behavior.

The desolverConfig object can also be defined with configuration options from Redis. See node-redis for a list of additional custom configuration options that can be defined from Redis.

Cache

DeSolver utilizes Redis caching for greater query optimization. If cacheDesolver option is set to true, this will enable automated caching of resolver queries. DeSolver will automatically generate a unique key for the Redis cache based on path property from within the info argument. Set the cacheDesolver property to false if you would like to disable this default behavior and provide your own caching logic.

DeSolver Fragments

DeSolver Fragments are used as versions of middleware functions. Each resolver can be decomposed into a series of "fragment" functions. To maintain full functionality of a normal resolver, it provides the current field resolvers first four arguments (root/parent, arguments, context, and info), as well as three additional custom parameters (next, escape, and ds).

const desolverFragment = (parent, args, context, info, next, escapeHatch, ds) => {
 // write your resolver business logic here
 // parent, args, context and info are available for use here
 // ds context object is also provided by this framework
 
 // @return
   // next() - calls the next function in the middleware chain
   // escapeHatch(input) - pass a value to input to resolve immediately
}

The DeSolver Parameters are as follows:

The first four parameters are the normal parameters for any resolver:

• parent: Sometimes referred to as the root object. The same parent/root object which is the result of the previous parent/type.
• arguments: Arguments provided to the root or field resolver.
• context: an object that is provided to all resolvers.
• info: field specific information relevant to the query.

The final three parameters are additional parameters provided by the DeSolver framework:

• next: Calls the next DeSolver Fragment in the middleware chain.
• escapeHatch: Immediately resolves the current root or field resolver.
• ds: A context object that can be passed from one DeSolver Fragment to the next. Similar in functionality to res.locals in the Express framework.
  
  

Creating the middleware pipeline

Utilize the desolver.use() method on the desolver instance to generate your pipeline of prehook functions.

The desolver.use() method has the following parameters:

• ResolverType: A string which matches the Resolver Type in your Resolver Map object. Pass the string 'All' if you want to chain the prehook functions to all your resolvers.
• DeSolverFragments: Add any number of functions in the form of DeSolver Fragments to chain to the target Resolver Type.

Multiple successive invocations of desolver.use() will also add additional functions to the pipeline.

The following is an example use case for the desolver middleware pipeline involving guarding root queries with authentication logic:

const desolver = new Desolver()
 
// Declare authentication Desolver Fragment Function
const authentication = (parent, args, context, info, next, escapeHatch, ds) => {
 // Define some authentication logic here using args or context
 // throw error if not authenticated
}
 
// Add the authentication function to pipeline with desolver.use()
// This function will execute prior to all Query resolvers
desolver.use('Query', authentication)
 
// Invoke desolver.apply() method with the resolver map object passed
const resolvers = desolver.apply({
 Query: {
   getUserById: (parent, args, context, info) => {
     // this root query is now guarded by the authentication function
   },
 
   getPostsById: (parent, args, context, info) => {
     // this root query is now guarded by the authentication function
   },
 }
 
 // Additional resolvers here
})

Define resolvers as multiple DeSolver fragments

Defining root or field level resolvers as a chain of DeSolver fragments is a resolver function declared utilizing desolver.useRoute(). The useRoute method takes any number of Desolver Fragment middleware functions and forms a "route" for the root or field resolver.

All methods desolver.use(), desolver.apply(), and desolver.useRoute() can be utilized together to form a more modular and scalable way to compose resolvers.

See the example below:

// desolver.use(), desolver.apply() and desolver.useRoute() can
// be used together to create longer chains
 
desolver.use('Query', authentication)
 
const resolvers = desolver.apply({
 Query: {
   // Define your resolver using desolver.useRoute() and add
   // any number of desolver fragments to modularize resolver logic
   // The authentication function will execute followed by desolverFragment1
   // and desolverFragment2
   getUserById: desolver.useRoute(desolverFragment1, desolverFragment2),
 
   // desolver.use(), desolver.apply(), desolver.useRoute() and
   // normal resolver functions used together seamlessly throughout the
   // resolver map
   getPostsById: (parent, { id }, context, info) => {
     return ctx.db.findPosts(id)
   },
 }
})

Targeting a specific resolver type

To chain Desolver Fragments to a specific root type or field resolvers, multiple invocations of desolver.use() can be called with different Resolver Type targets.

See the example below:

desolver.use('Query', authentication)

desolver.use('Mutation', authentication, authorization)
 
const resolvers = desolver.apply({
 Query: {
   // Query resolvers are guarded only by authentication function
   getUserById: desolver.useRoute(desolverFragment1, desolverFragment2),
 
   getPostsById: (parent, { id }, context, info) => {
     return ctx.db.findPosts(id)
   },
 }
 
 Mutation: {
   createUser: (parent, root, args, context, info) => {
    // This mutation resolver is now guarded by both authentication and authorization functions
   }
 }
})

Contributors

DeSolver is an open-source community project on Github and accelerated by OS Labs. We are maintained by a small group of dedicated software engineers. We appreciate your participation, feedback, bug fixes and feature developments.

	GitHub	LinkedIn
Michael Chan	https://github.com/mckchan13	https://www.linkedin.com/in/michael-ck-chan/
Mia Kang	https://github.com/jcmiakang	https://www.linkedin.com/in/mia-kang/
Alexander Gurfinkel	https://github.com/AlexGurfinkel	https://www.linkedin.com/in/alexandergurfinkel/
Julia Hickey	https://github.com/hijulia1136	https://www.linkedin.com/in/juliahickey/

If you are interested in creating an open-source project that builds on top of DeSolver, please don't hesitate to reach out, and we'd be happy to provide feedback and support here or via DeSolver LinkedIn.

License

This product is licensed under the MIT License - see the LICENSE.md file for details.

This is an open source product.

This product is accelerated by OS Labs.