Skip to content

Commit

Permalink
Make types not used outside of membership unexported (#3998)
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelSnowden committed Mar 1, 2023
1 parent 13e3170 commit 7086b94
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 24 deletions.
6 changes: 3 additions & 3 deletions common/membership/grpc_resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ import (
"go.temporal.io/server/common/primitives"
)

const GRPCResolverScheme = "membership"
const grpcResolverScheme = "membership"

// Empty type used to enforce a dependency using fx so that we're guaranteed to have
// initialized the global builder before we use it.
Expand All @@ -62,15 +62,15 @@ func initializeBuilder(monitor Monitor) GRPCResolver {
}

func (g *GRPCResolver) MakeURL(service primitives.ServiceName) string {
return fmt.Sprintf("%s://%s", GRPCResolverScheme, string(service))
return fmt.Sprintf("%s://%s", grpcResolverScheme, string(service))
}

type grpcBuilder struct {
monitor atomic.Value // Monitor
}

func (m *grpcBuilder) Scheme() string {
return GRPCResolverScheme
return grpcResolverScheme
}

func (m *grpcBuilder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOptions) (resolver.Resolver, error) {
Expand Down
16 changes: 8 additions & 8 deletions common/membership/hostinfo_provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,24 @@ import (
)

var HostInfoProviderModule = fx.Options(
fx.Provide(NewHostInfoProvider),
fx.Invoke(HostInfoProviderLifetimeHooks),
fx.Provide(newHostInfoProvider),
fx.Invoke(hostInfoProviderLifetimeHooks),
)

type (
CachingHostInfoProvider struct {
cachingHostInfoProvider struct {
hostInfo *HostInfo
membershipMonitor Monitor
}
)

func NewHostInfoProvider(membershipMonitor Monitor) HostInfoProvider {
return &CachingHostInfoProvider{
func newHostInfoProvider(membershipMonitor Monitor) HostInfoProvider {
return &cachingHostInfoProvider{
membershipMonitor: membershipMonitor,
}
}

func (hip *CachingHostInfoProvider) Start() error {
func (hip *cachingHostInfoProvider) Start() error {
var err error
hip.hostInfo, err = hip.membershipMonitor.WhoAmI()
if err != nil {
Expand All @@ -57,11 +57,11 @@ func (hip *CachingHostInfoProvider) Start() error {
return nil
}

func (hip *CachingHostInfoProvider) HostInfo() *HostInfo {
func (hip *cachingHostInfoProvider) HostInfo() *HostInfo {
return hip.hostInfo
}

func HostInfoProviderLifetimeHooks(
func hostInfoProviderLifetimeHooks(
lc fx.Lifecycle,
provider HostInfoProvider,
) {
Expand Down
2 changes: 1 addition & 1 deletion common/membership/rp.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ func NewRingPop(
}

// Start start ring pop
func (r *RingPop) Start(
func (r *RingPop) start(
bootstrapHostPostRetriever func() ([]string, error),
bootstrapRetryBackoffInterval time.Duration,
) {
Expand Down
14 changes: 7 additions & 7 deletions common/membership/rp_monitor.go
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ func (rpo *ringpopMonitor) Start() {
rpo.logger.Fatal("unable to initialize membership heartbeats", tag.Error(err))
}

rpo.rp.Start(
rpo.rp.start(
func() ([]string, error) { return rpo.fetchCurrentBootstrapHostports() },
healthyHostLastHeartbeatCutoff/2)

Expand All @@ -144,7 +144,7 @@ func (rpo *ringpopMonitor) Start() {
rpo.logger.Fatal("unable to get ring pop labels", tag.Error(err))
}

if err = labels.Set(RolePort, strconv.Itoa(rpo.services[rpo.serviceName])); err != nil {
if err = labels.Set(rolePort, strconv.Itoa(rpo.services[rpo.serviceName])); err != nil {
rpo.logger.Fatal("unable to set ring pop ServicePort label", tag.Error(err))
}

Expand All @@ -164,7 +164,7 @@ func (rpo *ringpopMonitor) WaitUntilInitialized(ctx context.Context) error {
return err
}

func ServiceNameToServiceTypeEnum(name primitives.ServiceName) (persistence.ServiceType, error) {
func serviceNameToServiceTypeEnum(name primitives.ServiceName) (persistence.ServiceType, error) {
switch name {
case primitives.AllServices:
return persistence.All, nil
Expand Down Expand Up @@ -199,8 +199,8 @@ func (rpo *ringpopMonitor) upsertMyMembership(
return err
}

// SplitHostPortTyped expands upon net.SplitHostPort by providing type parsing.
func SplitHostPortTyped(hostPort string) (net.IP, uint16, error) {
// splitHostPortTyped expands upon net.SplitHostPort by providing type parsing.
func splitHostPortTyped(hostPort string) (net.IP, uint16, error) {
ipstr, portstr, err := net.SplitHostPort(hostPort)
if err != nil {
return nil, 0, err
Expand All @@ -225,13 +225,13 @@ func (rpo *ringpopMonitor) startHeartbeat(broadcastHostport string) error {
sessionStarted := time.Now().UTC()

// Parse and validate broadcast hostport
broadcastAddress, broadcastPort, err := SplitHostPortTyped(broadcastHostport)
broadcastAddress, broadcastPort, err := splitHostPortTyped(broadcastHostport)
if err != nil {
return err
}

// Parse and validate existing service name
role, err := ServiceNameToServiceTypeEnum(rpo.serviceName)
role, err := serviceNameToServiceTypeEnum(rpo.serviceName)
if err != nil {
return err
}
Expand Down
6 changes: 3 additions & 3 deletions common/membership/rp_service_resolver.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ const (
// ringpop instance. The data for this key is the service name
RoleKey = "serviceName"

// RolePort label is set by every single service as soon as it bootstraps its
// rolePort label is set by every single service as soon as it bootstraps its
// ringpop instance. The data for this key represents the TCP port through which
// the service can be accessed.
RolePort = "servicePort"
rolePort = "servicePort"

minRefreshInternal = time.Second * 4
defaultRefreshInterval = time.Second * 10
Expand Down Expand Up @@ -299,7 +299,7 @@ func (r *ringpopServiceResolver) getReachableMembers() ([]string, error) {
// Each temporal service in the ring should advertise which port it has its gRPC listener
// on via a RingPop label. If we cannot find the label, we will assume that that the
// temporal service is listening on the same port that this node is listening on.
servicePortLabel, ok := member.Label(RolePort)
servicePortLabel, ok := member.Label(rolePort)
if ok {
servicePort, err = strconv.Atoi(servicePortLabel)
if err != nil {
Expand Down
4 changes: 2 additions & 2 deletions common/membership/rp_test_cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ func NewTestRingpopCluster(
}
logger.Info("seedNode", tag.Name(cluster.seedNode))

seedAddress, seedPort, err := SplitHostPortTyped(cluster.seedNode)
seedAddress, seedPort, err := splitHostPortTyped(cluster.seedNode)
if err != nil {
logger.Error("unable to split host port", tag.Error(err))
return nil
Expand Down Expand Up @@ -154,7 +154,7 @@ func NewTestRingpopCluster(
return nil
}
rpWrapper := NewRingPop(ringPop, time.Second*2, logger)
_, port, _ := SplitHostPortTyped(cluster.hostAddrs[i])
_, port, _ := splitHostPortTyped(cluster.hostAddrs[i])
cluster.rings[i] = NewRingpopMonitor(
serviceName,
map[primitives.ServiceName]int{serviceName: int(port)}, // use same port for "grpc" port
Expand Down

0 comments on commit 7086b94

Please sign in to comment.