OpenFn/kit

Tests: suppress the OPENFN_REPO_DIR env var warning

Open

#846 opened on Dec 17, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (19 forks)auto 404
DevXgood first issuetech debt

Repository metrics

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

Description

The CLI tests don't set the OPENFN_REPO_DIR env var

That means that each test logs a warning:

WARNING: no repo module dir found! Using the default (/tmp/repo)
packages/cli test: You should set OPENFN_REPO_DIR or pass --repoDir=some/path in to the CLI

This happens before the CLI has created a logger, so we can't put a mock logger here to test or suppress this is message. And while this logging doesn't actually matter, it is pretty annoying.

Options:

  1. Force the env var value in unit tests. Not unreasonable. We should set to the default value though.
  2. Add an option somewhere to supress this warning, like --no-warnings
  3. Remove the warning. Is it really necessary? Well maybe, I'm not wild about the tmp dir being used for the repo, and would prefer users set a sensible location on their machine

Contributor guide

Research direction
Investigate the test setup in the CLI package to understand where the OPENFN REPO DIR env var is missing and how to set it to a default value to suppress the warning.
Tech stack
typescript
Domain
cli
Issue type
Test
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70