OpenFn/kit

cli: unit tests for apollo command

Open

#702 opened on May 28, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (19 forks)auto 404
DevXgood first issue

Repository metrics

Stars
 (20 stars)
PR merge metrics
 (PR metrics pending)

Description

I am not planning to do this before the apollo release, so here's some notes:

  • Unit tests need to mock an apollo server. Not totally easy as it needs to be a websocket server.
  • Don't test services, but test CLI behaviours. Like how to handle a { files } result
  • Ideally I'd like tests against the echo service which can be easily reproduced with the actual CLI. So I can copy and paste the test name and just run it - a bit like how our integration tests work
  • I don't want any integration tests on this right now

Contributor guide

Research direction
Investigate how to mock a WebSocket based Apollo Server for unit tests. Study the existing integration test patterns and apply similar approach to CLI command unit tests, specifically handling `{ files }` results. Look into WebSocket mocking libraries or create a simple mock server.
Tech stack
typescriptnodejsgraphql
Domain
clibackend
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
GitNode.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50