removed TODOs which probably should not be fixed before merge #1637

Eknir · 2019-08-02T09:04:41Z

I removed the TODOs which should probably not be fixed before the merge into master. Created issues where needed, to not to forget about the TODOs. See comments to map the created issues to the removed TODOs

Not all TODO's are removed. Some I left because I think we can/should fix them before the merge. Some I left because I don't know how to make an issue out of them.

Kind request for the reviewers: Look at TODO's which are left and if you think an issue should be made out of it mention me (and I remove it) or do it yourself (permission hereby granted ;))

mortelli

@Eknir, would it be too much trouble to add a comment to the removed TODOs linking the issues where they exist?

Eknir · 2019-08-02T12:57:43Z

@mortelli , I did that. Please look at files changed. There you find the comments to all TODOs which I deleted

swap/defaults.go

Eknir · 2019-08-02T09:14:00Z

swap/defaults.go

@@ -25,13 +25,11 @@ const (
 	DefaultPaymentThreshold    = 1000000
 	DefaultDisconnectThreshold = 1500000
 	// DefaultInitialDepositAmount is the default amount to send to the contract when initially deploying
-	// TODO: deliberate value for now; needs experimentation


It is fine to relate this point to that issue, but really this is about experimenting with the values, which I feel that issue is not about. And this is not about actually having to do an issue with it, but for readers of the code to be aware of that these values are totally arbitrary for now.

I would suggest to keep it but to rename it to NOTE: instead of TODO:

Done that! The issue which I created is still relevant though

Yes, but you did not put the note at the correct spot. It is now above deployRetries which funny enough is not a deliberate value

Eknir · 2019-08-02T09:35:30Z

swap/oracle.go

@@ -22,7 +22,6 @@ type PriceOracle interface {
 }

 // NewPriceOracle returns the actual oracle to be used for discovering the price
-// TODO: Add a config flag so that this can be configured via command line


This one is part of the SWIP: payment module preferences. I chose not to make an issue for this one, as it is already kind-of in our backlog due to the SWIP.

#1632
This one is somehow related and should (I think) be implemented first

Although does the SWIP explicitly describe that the oracle be configurable via config flag?
If not, a separate issue might well be useful.

It does not explicitly mention this and I think this is also still up to debate. My personal preference would be to set it in a config file (as it is not just mentioning the oracle, but actually a preference list for oracles). Anyways, the SWIP ensures we won't forget this and implementation details will be discussed for sure!

OK. Fyi, Swarm supports different levels of configuration. It is possible to config via a config file with a define structure, and then this can be overridden by command line parameters and/or environment variables.

Thus whatever will be done for this will need to comply to this structure, don't invent a separate config file or something.

swap/peer.go

swap/swap.go

swap/types.go

swap/peer.go

mortelli

A few more TODOs:

/contracts/swap/swap.go:46: I would remove this one. It appears the function is indeed not needed.
/contracts/swap/swap.go:94: not sure about this one.
swap/types.go:34: remove, we no longer request cheques.
swap/swap.go:222: remove, covered by Review error and exception handling #1601.
swap/swap.go:232: remove, covered by Review error and exception handling #1601.
swap/protocol_test.go:214: unsure about this one, not familiar enough with the tests here. Seems like suitable for a new issue, though.
swap/peer.go:68: leaning towards removing this one, where is the block?
swap/peer.go:122: not sure about this one.
swap/peer.go:135: remove, covered by Review error and exception handling #1601.
swap/peer.go:182: create a new issue for this one, then remove it.

Comments are appreciated 👍

Eknir · 2019-08-02T15:39:02Z

/contracts/swap/swap.go:46: removed
/contracts/swap/swap.go:94: Removed although not sure about this one too. Does somebody object? @holisticode ?
swap/types.go:34: removed
swap/swap.go:222: remove, covered by #1601.
swap/swap.go:232: remove, covered by #1601.
swap/protocol_test.go:214: Removed, I will create an issue copying this code.
swap/peer.go:68:removed, the function calling this function (swap/peer.go handleMsg) is concurrent (it probably was not like this previously)
swap/peer.go:122: I leave it in, asking @holisticode for his advice
swap/peer.go:135: removed
swap/peer.go:182:removed, will create an issue

contracts/swap/swap.go

swap/peer.go

swap/swap.go

holisticode

Thanks for this tedious work!

There are a couple of things I don't agree with, please address them.

It is not necessarily a bad practice to leave TODOs in the code. Not everyone who actually looks at the code is in our team and knows all open issues. It is an open source project thus it may be a hint for a third party that things need to be done still.

contracts/swap/swap.go

holisticode · 2019-08-02T15:56:26Z

swap/defaults.go

@@ -25,13 +25,11 @@ const (
 	DefaultPaymentThreshold    = 1000000
 	DefaultDisconnectThreshold = 1500000
 	// DefaultInitialDepositAmount is the default amount to send to the contract when initially deploying
-	// TODO: deliberate value for now; needs experimentation


It is fine to relate this point to that issue, but really this is about experimenting with the values, which I feel that issue is not about. And this is not about actually having to do an issue with it, but for readers of the code to be aware of that these values are totally arbitrary for now.

I would suggest to keep it but to rename it to NOTE: instead of TODO:

swap/defaults.go

holisticode · 2019-08-02T16:03:17Z

swap/oracle.go

@@ -22,7 +22,6 @@ type PriceOracle interface {
 }

 // NewPriceOracle returns the actual oracle to be used for discovering the price
-// TODO: Add a config flag so that this can be configured via command line


Although does the SWIP explicitly describe that the oracle be configurable via config flag?
If not, a separate issue might well be useful.

swap/peer.go

holisticode · 2019-08-02T16:07:29Z

swap/protocol_test.go

-			t.Fatalf("Expected exactly one cheque at creditor, but there are %d:", len(creditorSwap.cheques))
-		}
-	*/
-


This needs to remain there. I added it, the test actually only checks that the balance is reset, but not that the cheque arrived.

@holisticode , I removed it and created a issue for it instead. Isn't it clearer when we keep all TODOs as issues? Obviously, if you want it back I will do so!

Created an issue AND put the TODO back in the code with a reference to the issue

You did not put it back into the code though.

I personally don't think it's a good idea to put links to issues into the code. I preferred to have the code back instead of the issue number.

I put it back.

holisticode · 2019-08-02T16:07:57Z

swap/swap.go

@@ -229,7 +228,6 @@ func (s *Swap) sendCheque(peer enode.ID) error {
 	}

 	// reset balance;
-	// TODO: if sending fails it should actually be roll backed...


Leave this one.

I created an issue for this.

Thanks for the issue but I had requested it to be left in the code. Nevermind.

swap/types.go

swap/protocol_test.go

holisticode · 2019-08-02T18:22:35Z

swap/defaults.go

@@ -25,13 +25,11 @@ const (
 	DefaultPaymentThreshold    = 1000000
 	DefaultDisconnectThreshold = 1500000
 	// DefaultInitialDepositAmount is the default amount to send to the contract when initially deploying
-	// TODO: deliberate value for now; needs experimentation


Yes, but you did not put the note at the correct spot. It is now above deployRetries which funny enough is not a deliberate value

mortelli · 2019-08-05T15:00:00Z

Even though we have issue #1635, I added 2 comments back to the handleEmitChequeMsg function, lest we forget about them: they are particularly tricky problems.

Unless there are objections, let's remove them in the PR for issue #1635.

* removed TODOs which probably should not be fixed before merge * more TODOs removed * removed one more TODO * removed more TODOs * after review holisticode * referenced issue at put back TODO * swap: put in-code TODO back and changed position of NOTE * swap: restore 2 comments in handleEmitChequeMsg function

removed TODOs which probably should not be fixed before merge

0046536

Eknir requested review from holisticode and mortelli August 2, 2019 09:04

Eknir added incentives ready for review labels Aug 2, 2019

Eknir added 2 commits August 2, 2019 11:56

more TODOs removed

2e7363e

removed one more TODO

7011e9e

mortelli reviewed Aug 2, 2019

View reviewed changes