sinonjs/sinon

Document how to stub out the network layer

Open

#1,459 opened on Jun 15, 2017

View on GitHub
 (4 comments) (2 reactions) (1 assignee)JavaScript (764 forks)batch import
DocumentationHelp wantedhacktoberfestpinned

Repository metrics

Stars
 (9,548 stars)
PR merge metrics
 (Avg merge 6d 16h) (15 merged PRs in 30d)

Description

If one tracks the sinon tag on Stack Overflow one can see that a lot of the questions involve stubbing out the network layer. A lot of people try using the networking utilities in Sinon when doing testing in Node - ultimately failing as they fail to see that XHR is not supported in Node. Example question.

We should create a how-to on stubbing out network requests in Node and the browser (perhaps even for the same module).

Contributor guide

Research direction
Research Sinon's documentation on faking XMLHttpRequest and stubbing network modules in Node.js. Document how to stub the network layer in both Node.js and browser environments, including handling of XHR and HTTP modules. Provide examples for common use cases.
Tech stack
javascript
Domain
testing
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80