Remove trail package #112
Open
Remove trail package #112
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The trail package is the only reason that grpc-go was a dependency of trace. grpc-go is quite a heavy dependency and can cause problems for downstream consumers which don't make use of trail, see https://github.com/vulcand/predicate/blob/master/go.mod#L5-L8. By moving trail from gravitational/trace to gravitational/teleport/api the functionality will still be available in a consumable module while drastically reducing the functionality and size of trace. Since api already depends on grpc-go the move should not impact the dependency tree there any. From an audit of all non-teleport forks/mirrors on GitHub I could not find any direct dependents of trace that actually made use of trail. So while removing the package is a breaking change the impact should be minimal for the community at large.
rosstimothy
force-pushed
the
tross/remove_trail
branch
from
2f478b3 to
8cc96d5
Compare
rosstimothy
added a commit
to gravitational/teleport
that referenced
this pull request
Jan 14, 2025
Pulling in the trail package directly in api will allow the trace module to shed the grpc-go dependency. This needs to land prior to gravitational/trace#112 being included in a new version of trace. There should be no noticable change in the api depdency tree since it already depends on grpc-go. Some additional items from the trace/internal package were also vendored within trail as needed. Additionally, some of the public api of trail that was not being consumed has been made private.
|
This accompanied by gravitational/teleport#51032 and https://github.com/gravitational/teleport.e/pull/5843 should allow trail to be removed without breaking gravitational/teleport. |
hugoShaka
approved these changes
Jan 14, 2025
creack
approved these changes
Jan 14, 2025
github-merge-queue bot
pushed a commit
to gravitational/teleport
that referenced
this pull request
Jan 14, 2025
* Vendor gravitational/trace/trail in api Pulling in the trail package directly in api will allow the trace module to shed the grpc-go dependency. This needs to land prior to gravitational/trace#112 being included in a new version of trace. There should be no noticable change in the api depdency tree since it already depends on grpc-go. Some additional items from the trace/internal package were also vendored within trail as needed. Additionally, some of the public api of trail that was not being consumed has been made private. * fix: appease linters
github-merge-queue bot
pushed a commit
to gravitational/teleport
that referenced
this pull request
Jan 14, 2025
* Vendor gravitational/trace/trail in api Pulling in the trail package directly in api will allow the trace module to shed the grpc-go dependency. This needs to land prior to gravitational/trace#112 being included in a new version of trace. There should be no noticable change in the api depdency tree since it already depends on grpc-go. Some additional items from the trace/internal package were also vendored within trail as needed. Additionally, some of the public api of trail that was not being consumed has been made private. * fix: appease linters
codingllama
approved these changes
Jan 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The trail package is the only reason that grpc-go was a dependency of trace. grpc-go is quite a heavy dependency and can cause problems for downstream consumers which don't make use of trail, see https://github.com/vulcand/predicate/blob/master/go.mod#L5-L8.
By moving trail from gravitational/trace to gravitational/teleport/api the functionality will still be available in a consumable module while drastically reducing the functionality and size of trace. Since api already depends on grpc-go the move should not impact the dependency tree there any.
From an audit of all non-teleport forks/mirrors on GitHub I could not find any direct dependents of trace that actually made use of trail. So while removing the package is a breaking change the impact should be minimal for the community at large.