Skip to content

allow formatErrorMessage callback #3

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.

Sign up for GitHub

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

Merged
merged 9 commits into from
Jun 27, 2017
Merged

allow formatErrorMessage callback #3

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4226b58
allow onCost callback for logging
chirag04 Jun 21, 2017
b3e65aa
formatErrorMessage
chirag04 Jun 21, 2017
a208710
include cost in default message
chirag04 Jun 21, 2017
59e4afd
fix test
chirag04 Jun 21, 2017
b444cb3
bring onCost back
chirag04 Jun 22, 2017
eff4dee
update readme
chirag04 Jun 22, 2017
a2f8182
address feedback
chirag04 Jun 26, 2017
109841b
update package-lock
chirag04 Jun 26, 2017
5ec7917
Clean things up a bit
taion Jun 27, 2017
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
4 changes: 3 additions & 1 deletion src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,9 @@ export function createComplexityLimitRule(maxCost, options = {}) {
}

if (node.kind === 'Document') {
if (visitor.getCost() > maxCost) {
const cost = visitor.getCost();
if (options.onCost) options.onCost(cost);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe also pass the query as arg to onCost?

Copy link
Contributor Author

@chirag04 chirag04 Jun 22, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@taion I still think passing the document node might be useful to both these functions. we maybe want to log queries that fail in prod as well?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

split out these properties before passing down to visitor

if (cost > maxCost) {
context.reportError(new GraphQLError(
'query exceeds complexity limit', [node],
));
Expand Down
17 changes: 17 additions & 0 deletions test/createComplexityLimitRule.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,21 @@ describe('createComplexityLimitRule', () => {
message: 'query exceeds complexity limit',
});
});

it('should call onCost with complexity score', () => {
const ast = parse(`
query {
list {
name
}
}
`);

const onCost = jest.fn();
const errors = validate(schema, ast, [
createComplexityLimitRule(9, { onCost }),
]);
expect(onCost).toBeCalledWith(10);
expect(errors).toHaveLength(1);
});
});