haskell/cabal

Local no-index repositories cache leads to bad UX

Open

#9.136 aberto em 18 de jul. de 2023

Ver no GitHub
 (5 comments) (0 reactions) (0 assignees)Haskell (732 forks)batch import
good first issuere: user experiencetype: enhancement

Métricas do repositório

Stars
 (1.731 stars)
Métricas de merge de PR
 (Mesclagem média 36d 23h) (47 fundiu PRs em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Revisar a documentação do cabal sobre repositórios locais sem índice para entender o comportamento de cache. Examinar o código fonte do cabal, provavelmente nos módulos Cabal ou cabal install, para encontrar onde o arquivo de cache é gravado e lido. Implementar uma mensagem de aviso para lembrar o usuário de excluir o cache se o repositório mudar, como uma alternativa à melhoria de cache mais complexa. A issue #9133 fornece contexto adicional.
Pilha de tecnologia
None
Domain
clideveloper experiencetooling
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Knowledge of cabal configurationAbility to read Haskell codeFamiliarity with caching mechanisms
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
55