https://github.com/zendesk/laika

Log, test, intercept and modify Apollo Client's operations
https://github.com/zendesk/laika

apollo apollo-client apollo-link graphql mock mocking test testing testing-tools utility

Last synced: 2 days ago
JSON representation

Log, test, intercept and modify Apollo Client's operations

• Host: GitHub
• URL: https://github.com/zendesk/laika
• Owner: zendesk
• License: apache-2.0
• Created: 2021-10-19T19:38:18.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-13T16:31:23.000Z (8 months ago)
• Last Synced: 2025-01-12T01:09:44.461Z (10 days ago)
• Topics: apollo, apollo-client, apollo-link, graphql, mock, mocking, test, testing, testing-tools, utility
• Language: TypeScript
• Homepage: https://zendesk.github.io/laika
• Size: 7.62 MB
• Stars: 124
• Watchers: 33
• Forks: 7
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![Laika logo](./media/logo-laika-bg.png)

[![Try Laika on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/laika-example-3yyq0?fontsize=14&hidenavigation=1&theme=dark)

Test, mock, intercept and modify Apollo Client's operations — in both browser and unit tests!

Read the Medium article about Laika: [Mock GraphQL Subscriptions with Laika — the only Apollo Client mocking tool you’ll need](https://medium.com/zendesk-engineering/mock-graphql-operations-with-laika-the-only-apollo-client-mocking-tool-youll-need-c116e1f62128)

![Example recording output](./media/example-recording.png)

## Features

- **mock** responses in either unit tests or browser tests (think Puppeteer or Cypress)

  - simulate error state

  - simulate loading state

  - simulate subscriptions (pushing data to the client at any given point)

- it can work in production code without affecting the size of the bundle (laika is lazily loaded)

- captures the variables that were called for a given operation for assertions

- **log** all the data passing through from the network (or whatever Links are after this one)

- **record** your user story

- **generate fixtures and working mock code** for use in your tests

- **modify** backend responses before they reach your components (e.g. to fuzz-test unexpected behavior)

## Usage

- [How to install](https://zendesk.github.io/laika/docs/how-to-install)

- [Usage in Cypress](https://zendesk.github.io/laika/docs/usage-in-cypress)

- [Logging and recording](https://zendesk.github.io/laika/docs/logging-and-recording)

- [Pitfalls](https://zendesk.github.io/laika/docs/pitfalls)

- [API reference](https://zendesk.github.io/laika/docs/modules/Laika)

## Alternatives

- [`MockedProvider`](https://www.apollographql.com/docs/react/development-testing/testing/) - the official Apollo mocking tool designed for unit tests; offers no subscription mocking or recording functionality

## Contribution

Thanks for your interest in our tool! Community involvement helps make our

design system fresh and tasty for everyone.

Got issues with what you find here? Please feel free to create an

[issue](https://github.com/zendesk/laika/issues/new).

If you'd like to take a crack at making some changes, please follow our

[contributing](https://github.com/zendesk/laika/blob/main/.github/CONTRIBUTING.md) documentation for details

needed to submit a PR.

Community behavior is benevolently ruled by a [code of

conduct](https://github.com/zendesk/laika/blob/main/.github/CODE_OF_CONDUCT.md). Please participate accordingly.

## License

Copyright 2021 Zendesk

Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)