Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactored sdk functions to always return &alpha.Bool{} instead of nil #1958

Merged
merged 2 commits into from
Jan 25, 2021
Merged

Refactored sdk functions to always return &alpha.Bool{} instead of nil #1958

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eec8942
refactored sdk functions to always return &alpha.Bool{} instead of nil
justjoeyuk Jan 20, 2021
443e54e
Merge branch 'master' into bug/1957-player-connect-capacity-panic
markmandel Jan 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pkg/sdkserver/localsdk.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ func (l *LocalSDKServer) stopReserveTimer() {
// [FeatureFlag:PlayerTracking]
func (l *LocalSDKServer) PlayerConnect(ctx context.Context, id *alpha.PlayerID) (*alpha.Bool, error) {
if !runtime.FeatureEnabled(runtime.FeaturePlayerTracking) {
return nil, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
return &alpha.Bool{Bool: false}, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
}
l.logger.WithField("playerID", id.PlayerID).Info("Player Connected")
l.gsMutex.Lock()
Expand All @@ -417,7 +417,7 @@ func (l *LocalSDKServer) PlayerConnect(ctx context.Context, id *alpha.PlayerID)
}

if l.gs.Status.Players.Count >= l.gs.Status.Players.Capacity {
return &alpha.Bool{}, errors.New("Players are already at capacity")
return &alpha.Bool{Bool: false}, errors.New("Players are already at capacity")
}

l.gs.Status.Players.Ids = append(l.gs.Status.Players.Ids, id.PlayerID)
Expand All @@ -433,7 +433,7 @@ func (l *LocalSDKServer) PlayerConnect(ctx context.Context, id *alpha.PlayerID)
// [FeatureFlag:PlayerTracking]
func (l *LocalSDKServer) PlayerDisconnect(ctx context.Context, id *alpha.PlayerID) (*alpha.Bool, error) {
if !runtime.FeatureEnabled(runtime.FeaturePlayerTracking) {
return nil, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
return &alpha.Bool{Bool: false}, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
}
l.logger.WithField("playerID", id.PlayerID).Info("Player Disconnected")
l.gsMutex.Lock()
Expand Down Expand Up @@ -467,7 +467,7 @@ func (l *LocalSDKServer) PlayerDisconnect(ctx context.Context, id *alpha.PlayerI
// [FeatureFlag:PlayerTracking]
func (l *LocalSDKServer) IsPlayerConnected(c context.Context, id *alpha.PlayerID) (*alpha.Bool, error) {
if !runtime.FeatureEnabled(runtime.FeaturePlayerTracking) {
return nil, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
return &alpha.Bool{Bool: false}, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
}

result := &alpha.Bool{Bool: false}
Expand Down
38 changes: 38 additions & 0 deletions pkg/sdkserver/localsdk_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,44 @@ func TestLocalSDKServerPlayerCapacity(t *testing.T) {
assert.Equal(t, int64(10), gs.Status.Players.Capacity)
}

func TestLocalSDKServerPlayerConnectAndDisconnectWithoutPlayerTracking(t *testing.T) {
t.Parallel()
runtime.FeatureTestMutex.Lock()
defer runtime.FeatureTestMutex.Unlock()

assert.NoError(t, runtime.ParseFeatures(string(runtime.FeaturePlayerTracking)+"=false"))

l, err := NewLocalSDKServer("")
assert.Nil(t, err)

e := &alpha.Empty{}
capacity, err := l.GetPlayerCapacity(context.Background(), e)
assert.Nil(t, capacity)
assert.Error(t, err)

count, err := l.GetPlayerCount(context.Background(), e)
assert.Error(t, err)
assert.Nil(t, count)

list, err := l.GetConnectedPlayers(context.Background(), e)
assert.Error(t, err)
assert.Nil(t, list)

id := &alpha.PlayerID{PlayerID: "test-player"}

ok, err := l.PlayerConnect(context.Background(), id)
assert.Error(t, err)
assert.False(t, ok.Bool)

ok, err = l.IsPlayerConnected(context.Background(), id)
assert.Error(t, err)
assert.False(t, ok.Bool)

ok, err = l.PlayerDisconnect(context.Background(), id)
assert.Error(t, err)
assert.False(t, ok.Bool)
}

func TestLocalSDKServerPlayerConnectAndDisconnect(t *testing.T) {
t.Parallel()

Expand Down
8 changes: 4 additions & 4 deletions pkg/sdkserver/sdkserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,7 +568,7 @@ func (s *SDKServer) stopReserveTimer() {
// [FeatureFlag:PlayerTracking]
func (s *SDKServer) PlayerConnect(ctx context.Context, id *alpha.PlayerID) (*alpha.Bool, error) {
if !runtime.FeatureEnabled(runtime.FeaturePlayerTracking) {
return nil, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
return &alpha.Bool{Bool: false}, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
}
s.logger.WithField("PlayerId", id.PlayerID).Debug("Player Connected")

Expand All @@ -583,7 +583,7 @@ func (s *SDKServer) PlayerConnect(ctx context.Context, id *alpha.PlayerID) (*alp
}

if int64(len(s.gsConnectedPlayers)) >= s.gsPlayerCapacity {
return &alpha.Bool{}, errors.New("players are already at capacity")
return &alpha.Bool{Bool: false}, errors.New("players are already at capacity")
}

// let's retain the original order, as it should be a smaller patch on data change
Expand All @@ -598,7 +598,7 @@ func (s *SDKServer) PlayerConnect(ctx context.Context, id *alpha.PlayerID) (*alp
// [FeatureFlag:PlayerTracking]
func (s *SDKServer) PlayerDisconnect(ctx context.Context, id *alpha.PlayerID) (*alpha.Bool, error) {
if !runtime.FeatureEnabled(runtime.FeaturePlayerTracking) {
return nil, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
return &alpha.Bool{Bool: false}, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
}
s.logger.WithField("PlayerId", id.PlayerID).Debug("Player Disconnected")

Expand Down Expand Up @@ -629,7 +629,7 @@ func (s *SDKServer) PlayerDisconnect(ctx context.Context, id *alpha.PlayerID) (*
// [FeatureFlag:PlayerTracking]
func (s *SDKServer) IsPlayerConnected(ctx context.Context, id *alpha.PlayerID) (*alpha.Bool, error) {
if !runtime.FeatureEnabled(runtime.FeaturePlayerTracking) {
return nil, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
return &alpha.Bool{Bool: false}, errors.Errorf("%s not enabled", runtime.FeaturePlayerTracking)
}
s.gsUpdateMutex.RLock()
defer s.gsUpdateMutex.RUnlock()
Expand Down
71 changes: 71 additions & 0 deletions pkg/sdkserver/sdkserver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1083,6 +1083,77 @@ func TestSDKServerPlayerCapacity(t *testing.T) {
agtesting.AssertEventContains(t, m.FakeRecorder.Events, "PlayerCapacity Set to 20")
}

func TestSDKServerPlayerConnectAndDisconnectWithoutPlayerTracking(t *testing.T) {
t.Parallel()
agruntime.FeatureTestMutex.Lock()
defer agruntime.FeatureTestMutex.Unlock()

err := agruntime.ParseFeatures(string(agruntime.FeaturePlayerTracking) + "=false")
require.NoError(t, err, "Can not parse FeaturePlayerTracking feature")

fixture := &agonesv1.GameServer{
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Namespace: "default",
},
Status: agonesv1.GameServerStatus{
State: agonesv1.GameServerStateReady,
},
}

m := agtesting.NewMocks()
m.AgonesClient.AddReactor("list", "gameservers", func(action k8stesting.Action) (bool, runtime.Object, error) {
return true, &agonesv1.GameServerList{Items: []agonesv1.GameServer{*fixture}}, nil
})

stop := make(chan struct{})
defer close(stop)

sc, err := defaultSidecar(m)
require.NoError(t, err)

sc.informerFactory.Start(stop)
assert.True(t, cache.WaitForCacheSync(stop, sc.gameServerSynced))

go func() {
err = sc.Run(stop)
assert.NoError(t, err)
}()

// check initial value comes through
// async, so check after a period
e := &alpha.Empty{}
err = wait.Poll(time.Second, 10*time.Second, func() (bool, error) {
count, err := sc.GetPlayerCapacity(context.Background(), e)

assert.Nil(t, count)
return false, err
})
assert.Error(t, err)

count, err := sc.GetPlayerCount(context.Background(), e)
require.Error(t, err)
assert.Nil(t, count)

list, err := sc.GetConnectedPlayers(context.Background(), e)
require.Error(t, err)
assert.Nil(t, list)

id := &alpha.PlayerID{PlayerID: "test-player"}

ok, err := sc.PlayerConnect(context.Background(), id)
require.Error(t, err)
assert.False(t, ok.Bool)

ok, err = sc.IsPlayerConnected(context.Background(), id)
require.Error(t, err)
assert.False(t, ok.Bool)

ok, err = sc.PlayerDisconnect(context.Background(), id)
require.Error(t, err)
assert.False(t, ok.Bool)
}

func TestSDKServerPlayerConnectAndDisconnect(t *testing.T) {
t.Parallel()
agruntime.FeatureTestMutex.Lock()
Expand Down