Fix supervisor send empty port name and desc

gitpod-io · May 24, 2022 · 37a1d8e · 37a1d8e
1 parent e148325
commit 37a1d8e
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 26 deletions.
diff --git a/components/gitpod-protocol/go/gitpod-config-types.go b/components/gitpod-protocol/go/gitpod-config-types.go
diff --git a/components/supervisor/pkg/ports/ports-config.go b/components/supervisor/pkg/ports/ports-config.go
@@ -74,9 +74,11 @@ func (configs *Configs) Get(port uint32) (*gitpod.PortConfig, ConfigKind, bool)
 	for _, rangeConfig := range configs.instanceRangeConfigs {
 		if rangeConfig.Start <= port && port <= rangeConfig.End {
 			return &gitpod.PortConfig{
-				Port:       float64(port),
-				OnOpen:     rangeConfig.OnOpen,
-				Visibility: rangeConfig.Visibility,
+				Port:        float64(port),
+				OnOpen:      rangeConfig.OnOpen,
+				Visibility:  rangeConfig.Visibility,
+				Description: rangeConfig.Description,
+				Name:        rangeConfig.Name,
 			}, RangeConfigKind, true
 		}
 	}
@@ -197,9 +199,11 @@ func parseInstanceConfigs(ports []*gitpod.PortsItems) (portConfigs map[uint32]*g
 			_, exists := portConfigs[port]
 			if !exists {
 				portConfigs[port] = &gitpod.PortConfig{
-					OnOpen:     config.OnOpen,
-					Port:       float64(Port),
-					Visibility: config.Visibility,
+					OnOpen:      config.OnOpen,
+					Port:        float64(Port),
+					Visibility:  config.Visibility,
+					Description: config.Description,
+					Name:        config.Name,
 				}
 			}
 			continue

diff --git a/components/supervisor/pkg/ports/ports-config_test.go b/components/supervisor/pkg/ports/ports-config_test.go
@@ -29,17 +29,21 @@ func TestPortsConfig(t *testing.T) {
 			Desc: "workspace port config",
 			WorkspacePorts: []*gitpod.PortConfig{
 				{
-					Port:       9229,
-					OnOpen:     "ignore",
-					Visibility: "public",
+					Port:        9229,
+					OnOpen:      "ignore",
+					Visibility:  "public",
+					Name:        "Nice Port Name",
+					Description: "Nice Port Description",
 				},
 			},
 			Expectation: &PortConfigTestExpectations{
 				WorkspaceConfigs: []*gitpod.PortConfig{
 					{
-						Port:       9229,
-						OnOpen:     "ignore",
-						Visibility: "public",
+						Port:        9229,
+						OnOpen:      "ignore",
+						Visibility:  "public",
+						Name:        "Nice Port Name",
+						Description: "Nice Port Description",
 					},
 				},
 			},
@@ -49,18 +53,22 @@ func TestPortsConfig(t *testing.T) {
 			GitpodConfig: &gitpod.GitpodConfig{
 				Ports: []*gitpod.PortsItems{
 					{
-						Port:       9229,
-						OnOpen:     "ignore",
-						Visibility: "public",
+						Port:        9229,
+						OnOpen:      "ignore",
+						Visibility:  "public",
+						Name:        "Nice Port Name",
+						Description: "Nice Port Description",
 					},
 				},
 			},
 			Expectation: &PortConfigTestExpectations{
 				InstancePortConfigs: []*gitpod.PortConfig{
 					{
-						Port:       9229,
-						OnOpen:     "ignore",
-						Visibility: "public",
+						Port:        9229,
+						OnOpen:      "ignore",
+						Visibility:  "public",
+						Name:        "Nice Port Name",
+						Description: "Nice Port Description",
 					},
 				},
 			},
@@ -70,19 +78,23 @@ func TestPortsConfig(t *testing.T) {
 			GitpodConfig: &gitpod.GitpodConfig{
 				Ports: []*gitpod.PortsItems{
 					{
-						Port:       "9229-9339",
-						OnOpen:     "ignore",
-						Visibility: "public",
+						Port:        "9229-9339",
+						OnOpen:      "ignore",
+						Visibility:  "public",
+						Name:        "Nice Port Name",
+						Description: "Nice Port Description",
 					},
 				},
 			},
 			Expectation: &PortConfigTestExpectations{
 				InstanceRangeConfigs: []*RangeConfig{
 					{
 						PortsItems: &gitpod.PortsItems{
-							Port:       "9229-9339",
-							OnOpen:     "ignore",
-							Visibility: "public",
+							Port:        "9229-9339",
+							OnOpen:      "ignore",
+							Visibility:  "public",
+							Description: "Nice Port Description",
+							Name:        "Nice Port Name",
 						},
 						Start: 9229,
 						End:   9339,

diff --git a/components/supervisor/pkg/ports/ports.go b/components/supervisor/pkg/ports/ports.go
@@ -411,6 +411,12 @@ func (pm *Manager) nextState(ctx context.Context) map[uint32]*managedPort {
 
 		var public bool
 		config, kind, exists := pm.configs.Get(mp.LocalhostPort)
+		if exists {
+			mp.Name = config.Name
+			mp.Description = config.Description
+			mp.OnExposed = getOnExposedAction(config, mp.LocalhostPort)
+		}
+
 		configured := exists && kind == PortConfigKind
 		if mp.Exposed || configured {
 			public = mp.Visibility == api.PortVisibility_public