[supervisor] respond PortsStatus with order

Author: mustard-mh

components/gitpod-protocol/go/gitpod-service.go

@@ -1756,6 +1756,7 @@ type PortConfig struct {
 	Visibility  string  `json:"visibility,omitempty"`
 	Description string  `json:"description,omitempty"`
 	Name        string  `json:"name,omitempty"`
+	Sort        uint32  `json:"sort,omitempty"`
 }
 
 // TaskConfig is the TaskConfig message type

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

@@ -21,6 +21,7 @@ type RangeConfig struct {
 	*gitpod.PortsItems
 	Start uint32
 	End   uint32
+	Sort  uint32
 }
 
 // Configs provides access to port configurations.
@@ -79,6 +80,7 @@ func (configs *Configs) Get(port uint32) (*gitpod.PortConfig, ConfigKind, bool)
 				Visibility:  rangeConfig.Visibility,
 				Description: rangeConfig.Description,
 				Name:        rangeConfig.Name,
+				Sort:        rangeConfig.Sort,
 			}, RangeConfigKind, true
 		}
 	}
@@ -184,7 +186,7 @@ func parseWorkspaceConfigs(ports []*gitpod.PortConfig) (portConfigs map[uint32]*
 }
 
 func parseInstanceConfigs(ports []*gitpod.PortsItems) (portConfigs map[uint32]*gitpod.PortConfig, rangeConfigs []*RangeConfig) {
-	for _, config := range ports {
+	for index, config := range ports {
 		if config == nil {
 			continue
 		}
@@ -204,6 +206,7 @@ func parseInstanceConfigs(ports []*gitpod.PortsItems) (portConfigs map[uint32]*g
 					Visibility:  config.Visibility,
 					Description: config.Description,
 					Name:        config.Name,
+					Sort:        uint32(index),
 				}
 			}
 			continue
@@ -224,6 +227,7 @@ func parseInstanceConfigs(ports []*gitpod.PortsItems) (portConfigs map[uint32]*g
 			PortsItems: config,
 			Start:      uint32(start),
 			End:        uint32(end),
+			Sort:       uint32(index),
 		})
 	}
 	return portConfigs, rangeConfigs

components/supervisor/pkg/ports/ports.go

@@ -740,8 +740,29 @@ func (pm *Manager) Subscribe() (*Subscription, error) {
 func (pm *Manager) getStatus() []*api.PortsStatus {
 	res := make([]*api.PortsStatus, 0, len(pm.state))
 	for port := range pm.state {
-		res = append(res, pm.getPortStatus(port))
+		portStatus := pm.getPortStatus(port)
+		// Filter out ports that not served and not inside `.gitpod.yml`
+		if _, _, ok := pm.configs.Get(port); !ok && !portStatus.Served {
+			continue
+		}
+		res = append(res, portStatus)
 	}
+	sort.SliceStable(res, func(i, j int) bool {
+		// Max number of port 65536
+		score1 := 100000 + res[i].LocalPort
+		score2 := 100000 + res[j].LocalPort
+		if c, _, ok := pm.configs.Get(res[i].LocalPort); ok {
+			score1 = c.Sort
+		}
+		if c, _, ok := pm.configs.Get(res[j].LocalPort); ok {
+			score2 = c.Sort
+		}
+		if score1 != score2 {
+			return score1 < score2
+		}
+		// Ranged ports
+		return res[i].LocalPort < res[j].LocalPort
+	})
 	return res
 }