Plan of dfget's refactoring plan

[allencloud]

Background

This is one part of Golang Refactoring Plan of the Whole Dragonfly Project

dfget is the client of Dragonfly's Client/Server Architecture. It is called by dfdaemon and used to interact with supernode of Dragonfly.

Although dfget is built by golang currently, the interact way with user and its calling API is not so ready in terms of scalability. So we split the dfget refactoring with the following details.

Refactoring Details

• API client refactoring
  • Golang SDK of Dragonfly's API
• CLI client refactoring
  • cobra command adoption of dfget, issue: Fix lint dragonfly#249, pr: Should not use *time.Time dragonfly#257.
  • detailed description of every essential cobra command's fields
• base and advanced features
  • support pull images from multiple remote registries. issue: Feature : Df-daemon support multi-registrys #142 , pr: feature: add trust hosts params for dfdaemon #389
  • support downloading an empty file; issue: [bug] cannot use dfget to download an empty file #44 pr: fix: cannot use dragonfly to download an empty file #350
  • private image support with no invasiveness; pr: feature: dfdaemon supports proxing https registries #410
  • HTTPS connection support for registry. issue: [feature request] dfdaemon support private registry with HTTPS protocol #205 , pr: feature: dfdaemon supports proxing https registries #410
  • download/upload rate limit. issue:x pr: feature: implement the rate limit feature #353
  • use bytebufferpool instead of bytes.Buffer to minimizing memory allocations.
  • report peer down when peer passively exists. pr: feature: report peer server down when it passively exits #378
  • update access and modify time of cache file when it used for uploading.
• Type uniformity refactoring
  • unify the same field type definition in different places
  • use int32 or int64 instead of int
• Unify the log style
  • align the log's prefix and message to make it more readable. pr: style: make log's output more clear and readable #357
  • output message should follow uniform rules
• fields comments
  • add a clear comment for each field issue: [comments request] Add comments to the fields of the struct. #161 pr: comments: add comments for struct fields #418

[fengzixu]

Let me do it. If someone wants to participate in this issue together with me, please contact me.

[fengzixu]

I found that you submit the PR: dragonflyoss/dragonfly#353. Is it conflict with the refactor of dfget ? @starnop @lowzj . For the refactor of dfget, do you have any requirement? @allencloud

[starnop]

@fengzixu The task list has been updated. I think it's also an important feature of the refactor of dfget.

[starnop]

Let me do it. If someone wants to participate in this issue together with me, please contact me.

So glad for your active participation. However, there is a small advice :
This issue is a task list. I think you should focus on one task at a time.
In addition, you should assign yourself before you focus on completing an issue.
WDYT? 😄

[fengzixu]

Sure. I think that before we want to begin to resolve one of those tasks, we must comment in this issue. It is convenient and clear for us. @starnop

[fengzixu]

I would like to handle the task "unify the same field type definition in different places" @starnop @lowzj

[lowzj]

I will open a pull request to implement this feature: HTTPS connection support for registry, it's actually a feature of dfdaemon.

see: #410