[supervisor] add new .gitpod.yml on-port option ignore-completely (#20828)

* [supervisor] add new .gitpod.yml on-port option `ignore-completely`

* fixup

* fix serve

* fixup

Author: mustard-mh

components/gitpod-protocol/data/gitpod-schema.json

@@ -24,9 +24,10 @@
                             "open-browser",
                             "open-preview",
                             "notify",
-                            "ignore"
+                            "ignore",
+                            "ignore-completely"
                         ],
-                        "description": "What to do when a service on this port was detected. 'notify' (default) will show a notification asking the user what to do. 'open-browser' will open a new browser tab. 'open-preview' will open in the preview on the right of the IDE. 'ignore' will do nothing."
+                        "description": "What to do when a service on this port was detected. 'notify' (default) will show a notification asking the user what to do. 'open-browser' will open a new browser tab. 'open-preview' will open in the preview on the right of the IDE. 'ignore' will do nothing. 'ignore-completely' will do nothing and prevent port forwarding."
                     },
                     "visibility": {
                         "type": "string",

components/gitpod-protocol/go/gitpod-config-types.go

@@ -1001,7 +1001,7 @@ export interface PrebuiltWorkspaceUpdatable {
     contextUrl?: string;
 }
 
-export type PortOnOpen = "open-browser" | "open-preview" | "notify" | "ignore";
+export type PortOnOpen = "open-browser" | "open-preview" | "notify" | "ignore" | "ignore-completely";
 
 export interface PortConfig {
     port: number;

components/gitpod-protocol/src/protocol.ts

@@ -223,6 +223,7 @@ message PortsStatus {
         open_preview = 2;
         notify = 3;
         notify_private = 4;
+        ignore_completely = 5;
     }
 
     // Action hint on open

components/supervisor-api/go/status.pb.go

@@ -272,6 +272,12 @@ func (pm *Manager) updateState(ctx context.Context, exposed []ExposedPort, serve
 				continue
 			}
 
+			config, _, exists := pm.configs.Get(port.Port)
+			// don't serve ports that are configured to be ignored-completely
+			if exists && config.OnOpen == "ignore-completely" {
+				continue
+			}
+
 			current, exists := servedMap[port.Port]
 			if !exists || (!port.BoundToLocalhost && current.BoundToLocalhost) {
 				servedMap[port.Port] = port
@@ -624,6 +630,9 @@ func getOnOpenAction(config *gitpod.PortConfig, port uint32) api.PortsStatus_OnO
 		}
 		return api.PortsStatus_notify_private
 	}
+	if config.OnOpen == "ignore-completely" {
+		return api.PortsStatus_ignore_completely
+	}
 	if config.OnOpen == "ignore" {
 		return api.PortsStatus_ignore
 	}
@@ -785,7 +794,12 @@ 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))
+		status := pm.getPortStatus(port)
+		// make sure they are not listed in ports list
+		if status.OnOpen == api.PortsStatus_ignore_completely {
+			continue
+		}
+		res = append(res, status)
 	}
 	sort.SliceStable(res, func(i, j int) bool {
 		// Max number of port 65536