[ws-proxy] Do not stomp on newer workspaces when handling events

Author: rl-gitpod

components/ws-proxy/pkg/proxy/infoprovider.go

@@ -78,8 +78,9 @@ type WorkspaceInfo struct {
 	// (parsed from URL)
 	IDEPublicPort string
 
-	Ports []PortInfo
-	Auth  *wsapi.WorkspaceAuthentication
+	Ports     []PortInfo
+	Auth      *wsapi.WorkspaceAuthentication
+	StartedAt time.Time
 }
 
 // PortInfo contains all information ws-proxy needs to know about a workspace port
@@ -265,7 +266,7 @@ func (p *RemoteWorkspaceInfoProvider) listen(client wsapi.WorkspaceManagerClient
 		}
 
 		if status.Phase == wsapi.WorkspacePhase_STOPPED {
-			p.cache.Delete(status.Metadata.MetaId)
+			p.cache.Delete(status.Metadata.MetaId, status.Metadata.StartedAt.AsTime())
 		} else {
 			info := mapWorkspaceStatusToInfo(status)
 			p.cache.Insert(info)
@@ -309,6 +310,7 @@ func mapWorkspaceStatusToInfo(status *wsapi.WorkspaceStatus) *WorkspaceInfo {
 		IDEPublicPort: getPortStr(status.Spec.Url),
 		Ports:         portInfos,
 		Auth:          status.Auth,
+		StartedAt:     status.Metadata.StartedAt.AsTime(),
 	}
 }
 
@@ -400,6 +402,18 @@ func (c *workspaceInfoCache) Insert(info *WorkspaceInfo) {
 }
 
 func (c *workspaceInfoCache) doInsert(info *WorkspaceInfo) {
+	existing := c.infos[info.WorkspaceID]
+	if existing != nil {
+		// Do not insert if the current workspace is newer
+		// This works around issues when a workspace is deleted then restarted in quick succession
+		// and the stopping event occurs after the replocement pod is started
+		if !existing.StartedAt.IsZero() && !info.StartedAt.IsZero() {
+			if existing.StartedAt.After(info.StartedAt) {
+				log.WithField("workspaceID", existing.WorkspaceID).Debug("ignoring insert of older workspace")
+				return
+			}
+		}
+	}
 	c.infos[info.WorkspaceID] = info
 	c.coordsByPublicPort[info.IDEPublicPort] = &WorkspaceCoords{
 		ID: info.WorkspaceID,
@@ -413,14 +427,23 @@ func (c *workspaceInfoCache) doInsert(info *WorkspaceInfo) {
 	}
 }
 
-func (c *workspaceInfoCache) Delete(workspaceID string) {
+func (c *workspaceInfoCache) Delete(workspaceID string, startedAt time.Time) {
 	c.cond.L.Lock()
 	defer c.cond.L.Unlock()
 
 	info, present := c.infos[workspaceID]
 	if !present || info == nil {
 		return
 	}
+	// Do not delete if the current workspace info is newer
+	// This works around issues when a workspace is deleted then restarted in quick succession
+	// and the delete event occurs after the replocement pod is started
+	if !startedAt.IsZero() && !info.StartedAt.IsZero() {
+		if info.StartedAt.After(startedAt) {
+			log.WithField("workspaceID", workspaceID).WithField("startedAt", startedAt).WithField("info", info).Debug("ignoring delete of older workspace")
+			return
+		}
+	}
 	delete(c.coordsByPublicPort, info.IDEPublicPort)
 	delete(c.infos, workspaceID)
 }

components/ws-proxy/pkg/proxy/infoprovider_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/google/go-cmp/cmp/cmpopts"
 	"google.golang.org/grpc"
+	"google.golang.org/protobuf/types/known/timestamppb"
 
 	wsapi "github.com/gitpod-io/gitpod/ws-manager/api"
 	wsmock "github.com/gitpod-io/gitpod/ws-manager/api/mock"
@@ -178,10 +179,12 @@ func TestRemoteInfoProvider(t *testing.T) {
 }
 
 var (
+	startedAt           = time.Date(2021, 1, 1, 00, 00, 00, 00, time.UTC)
 	testWorkspaceStatus = &wsapi.WorkspaceStatus{
 		Id: "e63cb5ff-f4e4-4065-8554-b431a32c0000",
 		Metadata: &wsapi.WorkspaceMetadata{
-			MetaId: "e63cb5ff-f4e4-4065-8554-b431a32c2714",
+			MetaId:    "e63cb5ff-f4e4-4065-8554-b431a32c2714",
+			StartedAt: timestamppb.New(startedAt),
 		},
 		Auth: &wsapi.WorkspaceAuthentication{
 			Admission:  wsapi.AdmissionLevel_ADMIT_OWNER_ONLY,
@@ -216,5 +219,6 @@ var (
 		},
 		URL:         testWorkspaceStatus.Spec.Url,
 		WorkspaceID: testWorkspaceStatus.Metadata.MetaId,
+		StartedAt:   startedAt,
 	}
 )