[supervisor] respond PortsStatus with ordering

Author: mustard-mh

components/supervisor/pkg/ports/ports-config.go

@@ -25,9 +25,10 @@ type RangeConfig struct {
 
 // Configs provides access to port configurations.
 type Configs struct {
-	workspaceConfigs     map[uint32]*gitpod.PortConfig
-	instancePortConfigs  map[uint32]*gitpod.PortConfig
-	instanceRangeConfigs []*RangeConfig
+	workspaceConfigs      map[uint32]*gitpod.PortConfig
+	instancePortConfigs   map[uint32]*gitpod.PortConfig
+	instanceRangeConfigs  []*RangeConfig
+	workspaceConfigsOrder []uint32
 }
 
 // ForEach iterates over all configured ports.
@@ -124,7 +125,7 @@ func (service *ConfigService) Observe(ctx context.Context) (<-chan *Configs, <-c
 			if err != nil {
 				errorsChan <- err
 			} else {
-				current.workspaceConfigs = parseWorkspaceConfigs(info.Workspace.Config.Ports)
+				current.workspaceConfigs, current.workspaceConfigsOrder = parseWorkspaceConfigs(info.Workspace.Config.Ports)
 				updatesChan <- &Configs{workspaceConfigs: current.workspaceConfigs}
 			}
 		} else {
@@ -144,9 +145,10 @@ func (service *ConfigService) Observe(ctx context.Context) (<-chan *Configs, <-c
 					continue
 				}
 				updatesChan <- &Configs{
-					workspaceConfigs:     current.workspaceConfigs,
-					instancePortConfigs:  current.instancePortConfigs,
-					instanceRangeConfigs: current.instanceRangeConfigs,
+					workspaceConfigs:      current.workspaceConfigs,
+					instancePortConfigs:   current.instancePortConfigs,
+					instanceRangeConfigs:  current.instanceRangeConfigs,
+					workspaceConfigsOrder: current.workspaceConfigsOrder,
 				}
 			}
 		}
@@ -168,19 +170,20 @@ func (service *ConfigService) update(config *gitpod.GitpodConfig, current *Confi
 
 var portRangeRegexp = regexp.MustCompile(`^(\d+)[-:](\d+)$`)
 
-func parseWorkspaceConfigs(ports []*gitpod.PortConfig) (portConfigs map[uint32]*gitpod.PortConfig) {
+func parseWorkspaceConfigs(ports []*gitpod.PortConfig) (portConfigs map[uint32]*gitpod.PortConfig, portsOrder []uint32) {
 	if len(ports) == 0 {
-		return nil
+		return
 	}
 	portConfigs = make(map[uint32]*gitpod.PortConfig)
 	for _, config := range ports {
 		port := uint32(config.Port)
 		_, exists := portConfigs[port]
 		if !exists {
 			portConfigs[port] = config
+			portsOrder = append(portsOrder, port)
 		}
 	}
-	return portConfigs
+	return
 }
 
 func parseInstanceConfigs(ports []*gitpod.PortsItems) (portConfigs map[uint32]*gitpod.PortConfig, rangeConfigs []*RangeConfig) {

components/supervisor/pkg/ports/ports.go

@@ -739,9 +739,26 @@ func (pm *Manager) Subscribe() (*Subscription, error) {
 // Callers are expected to hold mu.
 func (pm *Manager) getStatus() []*api.PortsStatus {
 	res := make([]*api.PortsStatus, 0, len(pm.state))
+
+	stateKeys := []uint32{}
 	for port := range pm.state {
-		res = append(res, pm.getPortStatus(port))
+		stateKeys = append(stateKeys, port)
+	}
+	sort.SliceStable(stateKeys, func(i, j int) bool {
+		return stateKeys[i] < stateKeys[j]
+	})
+
+	appended := make(map[uint32]struct{})
+	for _, list := range [][]uint32{pm.configs.workspaceConfigsOrder, stateKeys} {
+		for _, port := range list {
+			if _, ok := appended[port]; ok {
+				continue
+			}
+			appended[port] = struct{}{}
+			res = append(res, pm.getPortStatus(port))
+		}
 	}
+
 	return res
 }