Skip to content

Document common pitfalls #919

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 15 commits into from
Jul 1, 2016
Merged

Document common pitfalls #919

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
ba855b6
Document common pitfalls
Jun 14, 2016
0db5273
Fix typo
Jun 14, 2016
129e806
Document AVA and connected client limits
Jun 17, 2016
d663cd6
Update AVA and connected client limits
Jun 19, 2016
a777ffd
Add call for others to contribute
Jun 19, 2016
c9fa25c
Document async operations
Jun 19, 2016
da9c034
Various improvements
Jun 22, 2016
96685ba
Fix wrong word
Jun 23, 2016
349543f
Link from the readme
Jun 25, 2016
6434804
Move common pitfalls link to Tips
Jun 25, 2016
10cb03b
Make common pitfalls link relative
Jun 26, 2016
b79f347
Fix conflicts
Jun 26, 2016
6d71cbe
Attempt to fix more merge conflict stuff
Jun 26, 2016
f4a179c
on => in
Jun 29, 2016
691cecc
Fix spacing
Jun 30, 2016
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
6 changes: 6 additions & 0 deletions docs/common-pitfalls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@
If you run AVA in Docker as part of your CI, you need to fix the appropriate environment variables. Specifically, adding `-e CI=true` in the `docker exec` command. See [https://github.com/avajs/ava/issues/751](#751).

AVA uses [is-ci](https://github.com/watson/is-ci) to decide if it's in a CI environment or not using [these](https://github.com/watson/is-ci/blob/master/index.js) variables.
Copy link
Member

@sindresorhus sindresorhus Jun 17, 2016

Choose a reason for hiding this comment

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

AVA uses is-ci to decide whether it's in a CI environment using these environment variables.

Copy link
Member

@novemberborn novemberborn Jun 19, 2016

Choose a reason for hiding this comment

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

Maybe link these variables? It makes the link more descriptive.


## AVA and connected client limits

You may be using a service that only allows a limited number of concurrent connections. For example, many database-as-a-service businesses offer a free plan with a limit on how many clients can be using it at the same time. AVA can hit those limits and cause the tests to hang because it runs multiple processes, each of which is a different client.
Copy link
Member

@sindresorhus sindresorhus Jun 17, 2016

Choose a reason for hiding this comment

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

I think we should be clear that it's those services that are being bad and not AVA. They shouldn't hang AVA just because it's concurrency greedy.

Copy link
Contributor

@jamestalmage jamestalmage Jun 17, 2016

Choose a reason for hiding this comment

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

Well written clients / services should emit errors if concurrency limits are exceeded, instead of transparently hanging execution. If they don't, you should consider submitting an issue request asking that they do.

Copy link
Member

@sindresorhus sindresorhus Jun 17, 2016

Choose a reason for hiding this comment

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

@jamestalmage No, they should just handle it with throttling, but very few do...

Copy link
Contributor

@jamestalmage jamestalmage Jun 17, 2016

Choose a reason for hiding this comment

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

IDK, the whole point seems a little unnecessary. Services are going to do what they do, we are just explaining the reality of how to make AVA work with services that behave this way.

Copy link
Member

@sindresorhus sindresorhus Jun 18, 2016

Choose a reason for hiding this comment

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

Sure. I just want to make it clear they're working around the service, not AVA, when they follow this.

Copy link
Contributor Author

@sotojuan sotojuan Jun 18, 2016

Choose a reason for hiding this comment

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

👍


To fix this, use the `concurrency` flag to limit the number of processes ran. For example, if your service plan allows 5 clients, you should run AVA with `concurrency=5` or less.