Skip to content
This repository has been archived by the owner on Aug 18, 2020. It is now read-only.

[CBR-207] Remove log warper dependency #3476

Merged
merged 1 commit into from
Aug 25, 2018

Conversation

365andreas
Copy link
Contributor

@365andreas 365andreas commented Aug 24, 2018

Description

In total 163 source code files import ‘System.Wlog’ directly from ‘log-warper’ and 16 modules in cardano-sl link to this library (as indicated in their cabals). We want to reduce the dependency on this external library.

As a first step we introduce module ‘Pos.Util.Wlog’ in ‘util’ that exports all of ‘System.Wlog’ and change the import statement in all 163 source files.

This way we can get rid of the direct dependency on ‘log-warper’ in ‘cardano-sl’ modules and only refer to it from module ‘util’.

Linked issue

https://iohk.myjetbrains.com/youtrack/issue/CBR-207

Type of change

  • [~] 🐞 Bug fix (non-breaking change which fixes an issue)
  • [~] 🛠 New feature (non-breaking change which adds functionality)
  • [~] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
  • 🏭 Refactoring that does not change existing functionality but does improve things like code readability, structure etc
  • [~] 🔨 New or improved tests for existing code
  • [~] ⛑ git-flow chore (backport, hotfix, etc)

Developer checklist

  • I have read the style guide document, and my code follows the code style of this project.
  • If my code deals with exceptions, it follows the guidelines.
  • I have updated any documentation accordingly, if needed. Documentation changes can be reflected in opening a PR on cardanodocs.com, amending the inline Haddock comments, any relevant README file or one of the document listed in the docs directory.
  • [~] CHANGELOG entry has been added and is linked to the correct PR on GitHub.

Testing checklist

  • [~] I have added tests to cover my changes.
  • All new and existing tests passed.

QA Steps

Screenshots (if available)

@365andreas 365andreas requested a review from CodiePP August 24, 2018 15:04
@365andreas 365andreas changed the title [CBR-207] Rremove log warper dependency [CBR-207] Remove log warper dependency Aug 24, 2018
@CodiePP CodiePP requested a review from erikd August 24, 2018 15:42
@CodiePP CodiePP removed their request for review August 24, 2018 15:59
@365andreas 365andreas force-pushed the andreas/CBR-207/remove_log_warper_dependency branch 2 times, most recently from 5c9d7a8 to a8a2f24 Compare August 24, 2018 16:31
@@ -0,0 +1,23 @@
module Pos.Util.Wlog
Copy link
Contributor

@CodiePP CodiePP Aug 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this abstracts 'log-warper' such that the direct import of it in other cardano-sl modules can be removed.

@CodiePP CodiePP mentioned this pull request Aug 24, 2018
7 tasks
@CodiePP CodiePP force-pushed the andreas/CBR-207/remove_log_warper_dependency branch from a8a2f24 to a69e401 Compare August 24, 2018 20:58
@365andreas 365andreas force-pushed the andreas/CBR-207/remove_log_warper_dependency branch from a69e401 to af5aa9a Compare August 24, 2018 22:39
Copy link
Member

@erikd erikd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@CodiePP CodiePP merged commit cbf87eb into develop Aug 25, 2018
@CodiePP CodiePP mentioned this pull request Aug 25, 2018
7 tasks
@365andreas 365andreas deleted the andreas/CBR-207/remove_log_warper_dependency branch August 27, 2018 09:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants