api/types/container: remove PortSet, PortMap#50681
Draft
thaJeztah wants to merge 6 commits intomoby:masterfrom
Draft
api/types/container: remove PortSet, PortMap#50681thaJeztah wants to merge 6 commits intomoby:masterfrom
PortSet, PortMap#50681thaJeztah wants to merge 6 commits intomoby:masterfrom
Conversation
bc11ee0 to
f5d3b32
Compare
Member
Author
|
Fun failure ("page not found"); looks like something fell through and created a generic |
The `PortSet` and `PortMap` types don't carry a real meaning on their
own. Their purpose is defined at locations where they're used, such as
`Container.ExposedPorts` or `Container.PortBindings`.
Their documentation also shows this;
// PortSet is a collection of structs indexed by [PortRangeProto].
// PortMap is a collection of [PortBinding] indexed by [PortRangeProto].
Which, almost literally, describes what a map is. Substituting the types
for their implementation doesn't lose any meaning;
// map[PortRangeProto]struct{} is a collection of structs indexed by [PortRangeProto].
// map[PortRangeProto][]PortBinding is a collection of [PortBinding] indexed by [PortRangeProto].
Neither type has any special handling connected to them (no methods or
otherwise), so they are just maps with a fancy name attached. Worse,
using the extra indirect induces cognitive load; it's not clear from
the type that it's "just" a map, indexed by `PortBinding`, and it's
not clear what (kind of) values are in the map.
There are cases where having a type defined can add value to provide
a more in-depth description of their intent, but (as shown above) even
that is not the case here.
I'm considering these types to be premature abstraction with no good
value. As they are a "straight" copy of a map with the same signature,
replacing these types preserves backward compatibility; existing code
can assign either a `PortSet` or `PortMap`, or a `map[PortRangeProto]..`
with the same signature, but we can deprecate the types to give users
a nudge to use a regular map instead. The following shows that they are
interchangeable;
type config1 struct {
ExposedPorts container.PortSet
PortBindings container.PortMap
}
type config2 struct {
ExposedPorts map[container.PortRangeProto]struct{}
PortBindings map[container.PortRangeProto][]container.PortBinding
}
var (
ports map[container.PortRangeProto]struct{}
portBindings map[container.PortRangeProto][]container.PortBinding
ports2 container.PortSet
portBindings2 container.PortMap
)
_ = config1{
ExposedPorts: ports,
PortBindings: portBindings,
}
_ = config1{
ExposedPorts: ports2,
PortBindings: portBindings2,
}
_ = config2{
ExposedPorts: ports,
PortBindings: portBindings,
}
_ = config2{
ExposedPorts: ports2,
PortBindings: portBindings2,
}
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Use the underlying definition in types, instead of the `PortSet` and `PortMap`
types as intermediates.
This also shows that there's ambiguity in these definitions, because `nat.Port`
(`container.PortRangeProto`) allows either a individual port ("8080/tcp")
or a range of ports ("8080-8090/tcp"). The latter unlikely is supported
by our code.
That behavior was introduced in [moby/moby@47272f9], which changed `nat.Port` to
either be a Port, or a range of ports. However, it's debatable if that should
have modified the existing type or introduced a new type that's only used
for places where a range is expected.
To reduce ambiguity, we need to evaluate where the `nat.Port` / `PortRangeProto`
type is used, and if there's any places where it SHOULD accept a range.
For other places, we should consider having an alias with a more suitable
name (`PortProto`) - at least to be clearer on intent.
[moby/moby@47272f9]: moby@47272f9
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This one may need more discussion; we could keep it for convenience Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
f5d3b32 to
1616547
Compare
This file contains hidden or 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
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
PortSetandPortMaptypes don't carry a real meaning on their own. Their purpose is defined at locations where they're used, such asContainer.ExposedPortsorContainer.PortBindings.Their documentation also shows this;
Which, almost literally, describes what a map is. Substituting the types for their implementation doesn't lose any meaning;
Neither type has any special handling connected to them (no methods or otherwise), so they are just maps with a fancy name attached. Worse, using the extra indirect induces cognitive load; it's not clear from the type that it's "just" a map, indexed by
PortBinding, and it's not clear what (kind of) values are in the map.There are cases where having a type defined can add value to provide a more in-depth description of their intent, but (as shown above) even that is not the case here.
I'm considering these types to be premature abstraction with no good value. As they are a "straight" copy of a map with the same signature, replacing these types preserves backward compatibility; existing code can assign either a
PortSetorPortMap, or amap[PortRangeProto]..with the same signature, but we can deprecate the types to give users a nudge to use a regular map instead. The following shows that they are interchangeable;api/types/container: inline PortSet, PortMap in types
Use the underlying definition in types, instead of the
PortSetandPortMaptypes as intermediates.
This also shows that there's ambiguity in these definitions, because
nat.Port(
container.PortRangeProto) allows either a individual port ("8080/tcp")or a range of ports ("8080-8090/tcp"). The latter unlikely is supported
by our code.
That behavior was introduced in moby@47272f9, which changed
nat.Porttoeither be a Port, or a range of ports. However, it's debatable if that should
have modified the existing type or introduced a new type that's only used
for places where a range is expected.
To reduce ambiguity, we need to evaluate where the
nat.Port/PortRangePrototype is used, and if there's any places where it SHOULD accept a range.
For other places, we should consider having an alias with a more suitable
name (
PortProto) - at least to be clearer on intent.- What I did
- How I did it
- How to verify it
- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)