Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modernizing Apollo Resolvers #67

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
checkpoint
thebigredgeek committed Mar 7, 2020

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 2fd0faa5ac7a23c5ac7577cead7e5f77957dbff6
24 changes: 6 additions & 18 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -1,20 +1,8 @@
{
"ecmaFeatures": {
"modules": true
},
"env": {
"browser": true,
"node": true
},
"parser": "babel-eslint",
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"extends": ["plugin:@typescript-eslint/recommended"],
"rules": {
"quotes": [2, "single"],
"strict": [2, "never"],
"babel/new-cap": 1,
"babel/object-shorthand": 0,
"babel/arrow-parens": 0
},
"plugins": [
"babel"
]
}
"@typescript-eslint/no-explicit-any": "off"
}
}
2,252 changes: 2,252 additions & 0 deletions package-lock.json

Large diffs are not rendered by default.

13 changes: 5 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@
"scripts": {
"test": "mocha",
"build": "tsc",
"lint": "eslint src test",
"lint": "eslint src/**/*.ts test/**/*.ts",
"clean": "rimraf dist"
},
"repository": {
@@ -23,9 +23,6 @@
"api"
],
"author": "Andrew E. Rhyne",
"contributors": [
"Zach Tratar <ztratar@gmail.com"
],
"license": "MIT",
"bugs": {
"url": "https://github.com/thebigredgeek/apollo-resolvers/issues"
@@ -36,18 +33,18 @@
"deepmerge": "^3.0.0"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^2.22.0",
"@typescript-eslint/parser": "^2.22.0",
"bluebird": "3.5.4",
"chai": "3.5.0",
"eslint": "3.19.0",
"eslint-plugin-babel": "3.3.0",
"eslint": "^6.8.0",
"express": "4.16.4",
"graphql-server-express": "0.6.0",
"jest": "^25.1.0",
"mocha": "3.5.3",
"rimraf": "2.6.3",
"sinon": "1.17.7",
"supertest": "3.4.2",
"typescript": "2.9.2",
"typings": "2.1.1"
"typescript": "^3.8.3"
}
}
38 changes: 20 additions & 18 deletions src/context.ts
Original file line number Diff line number Diff line change
@@ -1,35 +1,37 @@
import * as assert from 'assert';

export interface ContextData {
models: Object;
user: Object;
};
export const createExpressContext = (data, res) => {
data = data || {};
data.user = data.user || null;
data.models = data.models || {};
const context = new Context(data);
if (res) {
assert(typeof res.once === 'function', 'createExpressContext takes response as second parameter that implements "res.once"');
// Bind the response finish event to the context disposal method
res.once('finish', () => context && context.dispose ? context.dispose() : null);
}
return context;
models: Record<string, any>;
user: any;
};


export class Context {
models: Object;
user: Object;
models: Record<string, any>;
user: any;
constructor (data: ContextData) {
Object.keys(data).forEach(key => {
this[key] = data[key]
});
}
dispose () {
dispose (): void {
const models = this.models;
const user = this.user;
this.models = null;
this.user = null;
// Call dispose on every attached model that contains a dispose method
Object.keys(models).forEach((key) => models[key].dispose ? models[key].dispose() : null);
}
}

export const createExpressContext = (data, res): Context => {
data = data || {};
data.user = data.user || null;
data.models = data.models || {};
const context = new Context(data);
if (res) {
assert(typeof res.once === 'function', 'createExpressContext takes response as second parameter that implements "res.once"');
// Bind the response finish event to the context disposal method
res.once('finish', () => context && context.dispose ? context.dispose() : null);
}
return context;
};
5 changes: 3 additions & 2 deletions src/promise.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import * as assert from 'assert';
import Bluebird from 'bluebird';

// Expose the Promise constructor so that it can be overwritten by a different lib like Bluebird
let p = Promise;

// Allow overload with compliant promise lib
export const usePromise = pLib => {
export const usePromise = (pLib: PromiseLike<any> | Promise<any> | Bluebird): void => {
assert(pLib && pLib.prototype, 'apollo-errors#usePromise expects a valid Promise library');
assert(!!pLib.resolve, 'apollo-errors#usePromise expects a Promise library that implements static method "Promise.resolve"');
assert(!!pLib.reject, 'apollo-errors#usePromise expects a Promise library that implements static method "Promise.reject"');
@@ -15,4 +16,4 @@ export const usePromise = pLib => {
};

// Return the currently selected promise lib
export const getPromise = () => p;
export const getPromise = (): PromiseLike<any> | Promise<any> | Bluebird => p;
39 changes: 21 additions & 18 deletions src/resolver.ts
Original file line number Diff line number Diff line change
@@ -2,30 +2,33 @@ import { getPromise } from './promise';
import { isFunction, Promisify, isNotNullOrUndefined } from './util';

export interface ResultFunction<ResulType> {
(root, args, context, info): Promise<ResulType> | ResulType | void
(root: any, args: any, context: any, info: any): PromiseLike<ResulType | void> | ResulType | void;
}

export interface ErrorFunction<ErrorType> {
(root, args, context, err): ErrorType | void
(root: any, args: any, context: any, info: any, err: any): PromiseLike<ErrorType | void> | ErrorType | void;
}

export interface CreateResolverFunction {
<R, E>(resFn: ResultFunction<R> | null, errFn?: ErrorFunction<E>): Resolver<R>
<R, E>(resFn: ResultFunction<R> | null, errFn?: ErrorFunction<E>): Resolver<R>;
}

export interface ComposeResolversFunction {
( resolvers: any ): {} // { [name: string]: Resolver<R> | {} }
( resolvers: { }): {}; // { [name: string]: Resolver<R> | {} }
}

export type ResolverHeader<R> = (root: any, args: any, context: any, info: any) => PromiseLike<R> | R;

export interface Resolver<ResulType> {
(root, args: {}, context: {}, info: {}): Promise<ResulType>
createResolver: CreateResolverFunction
compose: ComposeResolversFunction
(root: any, args: any, context: any, info: any): PromiseLike<ResulType> | ResulType;
createResolver: CreateResolverFunction;
compose: ComposeResolversFunction;
}

export const createResolver: CreateResolverFunction = <R, E>(resFn: ResultFunction<R>, errFn: ErrorFunction<E>) => {
export const createResolver: CreateResolverFunction = <R, E>(resFn: ResultFunction<R>, errFn: ErrorFunction<E>): Resolver<R> => {
const Promise = getPromise();
const baseResolver: Resolver<R> = ((root, args = {}, context = {}, info = {}) => {

const baseResolver: Resolver<R> = ((root: any = {}, args: any = {}, context: any = {}, info: any = {}) => {
// Return resolving promise with `null` if the resolver function param is not a function
if (!isFunction(resFn)) return Promise.resolve(null);
return Promisify(resFn)(root, args, context, info).catch(e => {
@@ -40,14 +43,14 @@ export const createResolver: CreateResolverFunction = <R, E>(resFn: ResultFuncti
throw parsedError || e
});
});
}) as any;
}) as Resolver<R>;

baseResolver.createResolver = (cResFn, cErrFn) => {
baseResolver.createResolver = <R, E>(cResFn: ResultFunction<R>, cErrFn: ErrorFunction<E>): Resolver<R> => {
const Promise = getPromise();

const childResFn = (root, args, context, info = {}) => {
const childResFn: ResultFunction<R> = (root: any, args: any, context: any, info: any): PromiseLike<R | void> => {
// Start with either the parent resolver function or a no-op (returns null)
const entry = isFunction(resFn) ? Promisify(resFn)(root, args, context, info) : Promise.resolve(null);
const entry: PromiseLike<R> = isFunction(resFn) ? Promisify(resFn)(root, args, context, info) : Promise.resolve(null);
return entry.then(r => {
// If the parent returns a value, continue
if (isNotNullOrUndefined(r)) return r;
@@ -56,15 +59,15 @@ export const createResolver: CreateResolverFunction = <R, E>(resFn: ResultFuncti
});
};

const childErrFn = (root, args, context, err) => {
const childErrFn: ErrorFunction<E> = (root: any, args: any, context: any, info: any, err: E): PromiseLike<E | void> => {
// Start with either the child error handler or a no-op (returns null)
const entry = isFunction(cErrFn) ? Promisify(cErrFn)(root, args, context, err) : Promise.resolve(null);
const entry: PromiseLike<E> = isFunction(cErrFn) ? Promisify(cErrFn)(root, args, context, info, err) : Promise.resolve(null);

return entry.then(r => {
// If the child returns a value, throw it
if (isNotNullOrUndefined(r)) throw r;
// Call the parent error handler or a no-op (returns null)
return isFunction(errFn) ? Promisify(errFn)(root, args, context, err).then(e => {
return isFunction(errFn) ? Promisify(errFn)(root, args, context, info, err).then(e => {
// If it resolves, throw the resolving value or the original error
throw e || err;
}, e => {
@@ -78,7 +81,7 @@ export const createResolver: CreateResolverFunction = <R, E>(resFn: ResultFuncti
return createResolver(childResFn, childErrFn);
}

baseResolver.compose = ( resolvers: {} ) => {
baseResolver.compose = ( resolvers: Record<string, { resolve: ResultFunction<any>; error: ErrorFunction<any> }> | ResultFunction<any>): Record<string, { resolve: ResultFunction<any>; error: ErrorFunction<any> }> {
const composed = {};
Object.keys(resolvers).forEach(key => {
const _resolver = resolvers[key];
@@ -89,7 +92,7 @@ export const createResolver: CreateResolverFunction = <R, E>(resFn: ResultFuncti
: baseResolver.createResolver(_resolver);
});
return composed;
}
};

return baseResolver;
};
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.