Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jihchi/res-msw
Mock Service Worker (MSW) bindings for ReScript
https://github.com/jihchi/res-msw
bindings bucklescript bucklescript-bindings mock mocking mocking-framework mocking-library msw reasonml rescript rescript-bindings service-worker
Last synced: 10 days ago
JSON representation
Mock Service Worker (MSW) bindings for ReScript
- Host: GitHub
- URL: https://github.com/jihchi/res-msw
- Owner: jihchi
- License: mit
- Archived: true
- Created: 2020-05-16T13:07:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T11:51:32.000Z (8 months ago)
- Last Synced: 2024-10-29T22:00:53.881Z (11 days ago)
- Topics: bindings, bucklescript, bucklescript-bindings, mock, mocking, mocking-framework, mocking-library, msw, reasonml, rescript, rescript-bindings, service-worker
- Language: ReScript
- Homepage:
- Size: 1.2 MB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# res-msw
[](https://travis-ci.org/jihchi/res-msw) [](https://www.npmjs.com/package/res-msw) [](https://coveralls.io/github/jihchi/res-msw)  
> [msw](https://github.com/mswjs/msw) bindings for [ReScript](https://rescript-lang.org/) (formerly known as [BuckleScript](https://github.com/bloomberg/bucklescript) in [Reason](https://github.com/facebook/reason))
# Installation
**Prerequisite**: you have installed [msw](https://github.com/mswjs/msw).
```sh
npm install -D res-msw
```
Or if you are using yarn:
```sh
yarn add -D res-msw
```
# Usage
Add `res-msw` to your `bsconfig.json`:
```diff
...
"bs-dependencies": [
+ "res-msw"
]
...
```
## API
`ResMsW.MSW` is the root namespace, includes following namespaces and modules:
- `rest`
- `graphql`
- `Node` module
- `ServiceWorker` module
- `Rest` module
- `GraphQL` module
### `Node` module
- `setup(array(requestHandler))`
- `server |> listen()`
- `server |> close()`
- `server |> resetHandlers()`
- `server |> restoreHandlers()`
- `server |> user(requestHandler)`
- `rest |> get(string, (req, res, ctx) => { });`
- `rest |> post(string, (req, res, ctx) => { });`
- `rest |> put(string, (req, res, ctx) => { });`
- `rest |> patch(string, (req, res, ctx) => { });`
- `rest |> delete(string, (req, res, ctx) => { });`
- `rest |> options(string, (req, res, ctx) => { });`
### `ServiceWorker` module
- `setup(array(requestHandler))`
- `worker |> start()`
- `worker |> stop()`
- `worker |> resetHandlers()`
- `worker |> restoreHandlers()`
- `worker |> user(requestHandler)`
- `graphql |> query(string, (req, res, ctx) => { });`
- `graphql |> mutation(string, (req, res, ctx) => { });`
### `Rest` module
- `res |> mock(array(responseTransformer))`
- `res |> mockOnce(array(responseTransformer))`
- `ctx |> status(int)`
- `ctx |> set(string, string)`
- `ctx |> delay(int)`
- `ctx |> fetch(req)`
- `ctx |> text(string)`
- `ctx |> json(Js.Json.t)`
- `ctx |> xml(string)`
### `GraphQL` module
- `res |> mock(array(responseTransformer))`
- `res |> mockOnce(array(responseTransformer))`
- `ctx |> status(int)`
- `ctx |> set(string, string)`
- `ctx |> delay(int)`
- `ctx |> fetch(req)`
- `ctx |> data(Js.Json.t)`
- `ctx |> errors(array(Js.Json.t))`
### Example of Rest
> For more example, please refer to [`MSW_node_test.re`](/__tests__/MSW_node_test.re) and [`mocks.re`](/__tests__/support/mocks.re).
```res
open ResMsw.MSW
let getRepoInfo = rest |> get("https://api.github.com/repos/:owner/:repo", (
req,
res,
ctx,
) => {
let {params} = req
let owner = params->Js.Dict.get("owner")->Belt.Option.getWithDefault("N/A")
let repo = params->Js.Dict.get("repo")->Belt.Option.getWithDefault("N/A")
res |> Rest.mock([
ctx |> Rest.status(200),
ctx |> Rest.text(`owner: ${owner}, repo: ${repo}`),
])
})
let getRepoInfoError =
rest |> get("https://api.github.com/repos/:owner/:repo", (req, res, ctx) =>
res |> Rest.mock([ctx |> Rest.status(500), ctx |> Rest.text("Oops")])
)
let server = Node.setup([getRepoInfo])
server->listen()
server->use(getRepoInfoError)
server->restoreHandlers()
server->resetHandlers()
server->close()
```
### Example of GraphQL
For more example, please refer to [`MSW_browser.re`](/__tests__/support/MSW_browser.re) and [`mocks.re`](/__tests__/support/mocks.re).
```res
open ResMsw.MSW
let queryUserDetail = graphql |> query("GetUserDetail", (req, res, ctx) => {
let name = ("name", req.variables["name"])
let data = Js.Dict.fromList(list{name}) |> Js.Json.object_
res |> GraphQL.mock([ctx |> GraphQL.status(200), ctx |> GraphQL.data(data)])
})
let queryUserDetailError = graphql |> query("GetUserDetail", (
req,
res,
ctx,
) => {
let message = (
"message",
Js.Json.string(`This is a mocked error: ${req.variables["name"]}`),
)
let location = Js.Dict.fromList(list{
("line", Js.Json.number(1.0)),
("column", Js.Json.number(2.0)),
})
let locations = ("locations", Js.Json.objectArray([location]))
let error = Js.Dict.fromList(list{message, locations}) |> Js.Json.object_
res |> GraphQL.mock([
ctx |> GraphQL.status(200),
ctx |> GraphQL.errors([error]),
])
})
let worker = ServiceWorker.setup([queryUserDetail])
worker->start()
worker->use(GetUserDetailError)
worker->restoreHandlers()
worker->resetHandlers()
worker->stop()
```
# Testing the library
```
npm test
```
this will compile and execute tests with `bs-jest`
# Contributions
Don't hesitate to open a PR with a new binding - while bumping up the amount of covered bindings in the README.
There are tests, use them and write the most simple test you can think of to make sure that the bindings work correctly.