Open KateGo520 opened 4 years ago
@ocket8888 @shamrickus Could you help me review this issue? Thx :p
Because we have tons of vendored dependencies, migrating to Go modules - while something we want to do - is a huge effort. Many of the dependencies offer different APIs than those exposed in their vendored versions, one dependency we're using is currently imported through a non-canonical import path, and all of that is to say nothing of the amount of regression testing necessary to ensure nothing has been broken.
@ocket8888 Thanks for your reply. This report is a warm prompt for you to prevent or combat this issue. Just let you know the problem if you upgrade this dependency in near future.
Hope this can help you. Thanks again. Kate
(The purpose of this report is to alert
apache/trafficcontrol
to the possible problems whenapache/trafficcontrol
try to upgrade the following dependencies)An error will happen when upgrading library go-acme/lego:
github.com/go-acme/lego
-Latest Version: v3.7.0 (Latest commit 7bd2666 1 hour ago) -Where did you use it: https://github.com/apache/trafficcontrol/search?q=go-acme%2Flego%2Fchallenge%2Fhttp01&unscoped_q=go-acme%2Flego%2Fchallenge%2Fhttp01 -Detail:
I investigated the libraries (go-acme/lego >= v3.0.0.) release information and found the root cause of this issue is that----
These dependencies all added Go modules in the recent versions.
They all comply with the specification of "Releasing Modules for v2 or higher" available in the Modules documentation. Quoting the specification:
This "github.com/my/module/v3/mypkg" is not the
physical path
. So earlier versions of Go (including those that don't have minimal module awareness) plus all tooling (like dep, glide, govendor, etc) don't haveminimal module awareness
as of now and therefore don't handle import paths correctly See golang/dep#1962, golang/dep#2139.Solution
1. Migrate to Go Modules.
Go Modules is the general trend of ecosystem, if you want a better upgrade package experience, migrating to Go Modules is a good choice.
Migrate to modules will be accompanied by the introduction of virtual paths(It was discussed above).
Then the downstream projects might be negatively affected in their building if they are module-unaware (Go versions older than 1.9.7 and 1.10.3; Or use third-party dependency management tools, such as: Dep, glide, govendor…).
*[]** You can see who will be affected here: [2 module-unaware users, i.e., zrhoffman/tc-docker-hub, zrhoffman/atc-gha] https://github.com/search?q=apache%2Ftrafficcontrol+filename%3Avendor.conf+filename%3Avendor.json+filename%3Aglide.toml+filename%3AGodep.toml+filename%3AGodep.json
2. Maintaining v2+ libraries that use Go Modules in Vendor directories.
If
apache/trafficcontrol
want to keep using the dependency manage tools (like dep, glide, govendor, etc), and still want to upgrade the dependencies, can choose this fix strategy. Manually download the dependencies into the vendor directory and do compatibility dispose(materialize the virtual path or delete the virtual part of the path). Avoid fetching the dependencies by virtual import paths. This may add some maintenance overhead compared to using modules.As the import paths have different meanings between the projects adopting module repos and the non-module repos, materialize the virtual path is a better way to solve the issue, while ensuring compatibility with downstream module users. A textbook example provided by repo
github.com/moby/moby
is here: https://github.com/moby/moby/blob/master/VENDORING.md https://github.com/moby/moby/blob/master/vendor.conf In the vendor directory,github.com/moby/moby
adds the /vN subdirectory in the corresponding dependencies. This will help more downstream module users to work well with your package.3. Request upstream to do compatibility processing.
The
go-acme/lego
have 2 module-unaware users in github, such as: qnsoft/nging, MoonMonsters/microlearn… https://github.com/search?q=go-acme%2Flego+filename%3Avendor.conf+filename%3Avendor.json+filename%3Aglide.toml+filename%3AGodep.toml+filename%3AGodep.jsonSummary
You can make a choice when you meet this DM issues by balancing your own development schedules/mode against the affects on the downstream projects.
For this issue, Solution 1 can maximize your benefits and with minimal impacts to your downstream projects the ecosystem.
References
Do you plan to upgrade the libraries in near future? Hope this issue report can help you ^_^ Thank you very much for your attention.
Best regards, Kate