unisonweb/unison

`manageLinks` in `HandleInput` should have a stronger type

Open

#1,443 opened on Apr 20, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (304 forks)batch import
help wantedtech debt

Repository metrics

Stars
 (6,624 stars)
PR merge metrics
 (Avg merge 12d 19h) (6 merged PRs in 30d)

Description

The current type of this function is:

    manageLinks :: [(Path', NameSegment.HQSegment)]
                -> [HQ.HashQualified]
                -> (forall r. Ord r
                    => (r, Reference, Reference)
                    ->  Branch.Star r NameSegment
                    ->  Branch.Star r NameSegment)
                -> Action m (Either Event Input) v ()

Since it takes names rather than references, it has to parse those names. This is probably OK for now, but may run into strange corner cases later.

Contributor guide

Research direction
Examine the existing type signature of manageLinks and the types it uses (NameSegment.HQSegment, Reference, etc.) to understand how to replace name parsing with reference handling. Consider the impact on the rest of the codebase and ensure backward compatibility.
Tech stack
None
Domain
backend
Issue type
Refactor
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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
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.
60