posit-dev / posit-dev/connectapi

chore: reorganize mocks

Open
#401 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
54
Forks
27
Avg merge
1d 3m
Merged PRs (30d)
1

Description

Most of the mocks are organized into subdirectories by Connect version. The default mock directory is named 2024.08.0 but it actually does not contain a version number in its server settings. The other mock directories do respond like the named Connect version.

Some options:

  • At the very least, the default mock directory should be renamed something like unversioned (with a note in a README to describe what that means). This might be fine for tests that use code that doesn't explicitly check the Connect version.
  • Another option would be to remove the default mock path and always be explicit (described by @nealrichardson here). Even code that doesn't explicitly check a version of Connect is written against some version, so it might just be good practice to put any mock in a directory for the version of Connect it was captured from.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the mock subdirectories, especially the default 2024.08.0 directory, with their server settings and versioned peers. Read the discussion linked in the issue before choosing between renaming the default directory or removing the default mock path; done means the layout and README or test references consistently reflect the decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
testing
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.