haskell/cabal

Local no-index repositories cache leads to bad UX

Open

#9.136 geöffnet am 18. Juli 2023

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Haskell (732 Forks)batch import
good first issuere: user experiencetype: enhancement

Repository-Metriken

Stars
 (1.731 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 36T 23h) (47 gemergte PRs in 30 T)

Beschreibung

Describe the bug

It's documented that, when using local no-index repositories.

cabal-install creates a .cache file, and will aggressively use its contents if it exists. Therefore if you change the contents of the directory, remember to wipe the cache too.

but cabal-install offers no warning or message about this leaving the user staring, confused, at a solver failure. See for example #9133.

Expected behavior

Cabal should either

  1. Provide a better caching mechanism, detecting changes to the local repository.
  2. Remnind the user that it will only look at the cache file and that the user should manually delete the cache file if the repository has changed.

Contributor Guide

Research-Richtung
Die cabal Dokumentation zu lokalen Repositorys ohne Index überprüfen, um das Cache Verhalten zu verstehen. Den cabal Quellcode untersuchen, wahrscheinlich in den Modulen Cabal oder cabal install, um herauszufinden, wo die Cache Datei geschrieben und gelesen wird. Eine Warnmeldung implementieren, die den Benutzer daran erinnert, den Cache zu löschen, wenn sich das Repository ändert, als Alternative zur komplexeren Cache Verbesserung. Issue #9133 bietet zusätzlichen Kontext.
Tech Stack
Keine
Domain
clideveloper experiencetooling
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Knowledge of cabal configurationAbility to read Haskell codeFamiliarity with caching mechanisms
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
55