avh4/elm-format

Use stm-conduit for logging

Open

#788 opened on 2023年2月11日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Haskell (1,329 stars) (148 forks)batch import
help wantedmaintenance

説明

From https://github.com/avh4/elm-format/pull/770#issuecomment-1230725117, this is a low-priority issue to try using a cleaner design for coherent logging now that we process files in parallel.

The user-visible goal of this is to restore the pre-0.8.6 feature of elm-format --validate streaming the log output as it progresses, instead of the 0.8.6 behavior of waiting until all files are processed before printing the log.

To capture my incomplete thoughts on this:

  • the World action for validating a file should return Either (Loggable info) ()
  • the mapMConcurrently will need to be orchestrated from a new thread so that the main thread can listen for results and to the logging (and manage the state of the streaming JSON output)
  • the Eithers should be sent via an stm queue (preferably a bounded queue, most likely TBMQueue) to the main thread
  • probably conduit and stm-conduit are worth making use of

コントリビューターガイド

技術スタック
なし
領域
toolingdeveloper experience
Issue 種別
refactor
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
5
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
3-5 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
needs investigation
前提条件
HaskellSTM and conduitElm format codebase
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
10
調査方針
This issue proposes using stm conduit for logging in elm format. The key ideas are derived from PR #770. To start, review the linked comment and the existing parallel processing code. The main challenge is orchestrating mapMConcurrently with logging, likely requiring a new thread and a TBMQueue. Examine the World action for file validation and consider how to return Either (Loggable info) (). The stm conduit library may be helpful. Look at the current logging implementation and the pre 0.8.6 streaming behavior.