[server] generate better workspace ids

Author: svenefftinge

components/gitpod-protocol/src/util/gitpod-host-url.ts

@@ -12,7 +12,7 @@ export interface UrlChange {
 }
 export type UrlUpdate = UrlChange | Partial<URL>;
 
-export const workspaceIDRegex = /([a-z0-9]{4,8}-)+([a-z0-9]{12})/;
+export const workspaceIDRegex = /([a-z]+-[a-z]+-[a-z]+-[0-9a-f]{8})/;
 
 export class GitpodHostUrl {
     readonly url: URL;

components/gitpod-protocol/src/util/parse-workspace-id.spec.ts

@@ -13,23 +13,23 @@ const expect = chai.expect;
 export class ParseWorkspaceIdTest {
 
     @test public parseWorkspaceIdFromHostname_fromWorkspaceLocation() {
-        const actual = parseWorkspaceIdFromHostname("b7e0eaf8-ec73-44ec-81ea-04859263b656.ws-eu01.gitpod.io");
-        expect(actual).to.equal("b7e0eaf8-ec73-44ec-81ea-04859263b656");
+        const actual = parseWorkspaceIdFromHostname("tight-moccasin-ferret-155799b3.ws-eu01.gitpod.io");
+        expect(actual).to.equal("tight-moccasin-ferret-155799b3");
     }
 
     @test public parseWorkspaceIdFromHostname_fromWorkspacePortLocation() {
-        const actual = parseWorkspaceIdFromHostname("3000-b7e0eaf8-ec73-44ec-81ea-04859263b656.ws-eu01.gitpod.io");
-        expect(actual).to.equal("b7e0eaf8-ec73-44ec-81ea-04859263b656");
+        const actual = parseWorkspaceIdFromHostname("3000-tight-moccasin-ferret-155799b3.ws-eu01.gitpod.io");
+        expect(actual).to.equal("tight-moccasin-ferret-155799b3");
     }
 
     @test public parseWorkspaceIdFromHostname_fromWorkspacePortLocationWithWebviewPrefix() {
-        const actual = parseWorkspaceIdFromHostname("webview-3000-b7e0eaf8-ec73-44ec-81ea-04859263b656.ws-eu01.gitpod.io");
-        expect(actual).to.equal("b7e0eaf8-ec73-44ec-81ea-04859263b656");
+        const actual = parseWorkspaceIdFromHostname("webview-3000-tight-moccasin-ferret-155799b3.ws-eu01.gitpod.io");
+        expect(actual).to.equal("tight-moccasin-ferret-155799b3");
     }
 
     @test public parseWorkspaceIdFromHostname_fromWorkspacePortLocationWithWebviewPrefixCustomHost() {
-        const actual = parseWorkspaceIdFromHostname("webview-3000-ca81a50f-09d7-465c-acd9-264a747d5351.ws-eu01.some.subdomain.somehost.com");
-        expect(actual).to.equal("ca81a50f-09d7-465c-acd9-264a747d5351");
+        const actual = parseWorkspaceIdFromHostname("webview-3000-tight-moccasin-ferret-155799b3.ws-eu01.some.subdomain.somehost.com");
+        expect(actual).to.equal("tight-moccasin-ferret-155799b3");
     }
 }
 module.exports = new ParseWorkspaceIdTest()

components/gitpod-protocol/src/util/parse-workspace-id.ts

@@ -7,17 +7,17 @@
 
 /**
  * Hostname may be of the form:
- *  - b7e0eaf8-ec73-44ec-81ea-04859263b656.ws-eu01.gitpod.io
- *  - 1234-b7e0eaf8-ec73-44ec-81ea-04859263b656.ws-eu01.gitpod.io
- *  - webview-1234-b7e0eaf8-ec73-44ec-81ea-04859263b656.ws-eu01.gitpod.io (or any other string replacing webview)
+ *  - tight-moccasin-ferret-155799b3.ws-eu01.gitpod.io
+ *  - 1234-tight-moccasin-ferret-155799b3.ws-eu01.gitpod.io
+ *  - webview-1234-tight-moccasin-ferret-155799b3.ws-eu01.gitpod.io (or any other string replacing webview)
  * @param hostname The hostname the request is headed to
  */
 export const parseWorkspaceIdFromHostname = function(hostname: string) {
     // We need to parse the workspace id precisely here to get the case '<some-str>-<port>-<wsid>.ws.' right
-    const wsIdExpression = /([a-z][0-9a-z]+\-([0-9a-z]+\-){3}[0-9a-z]+)\.ws/g;
+    const wsIdExpression = /([a-z]+\-)?([0-9]+\-)?(([a-z]+\-){3}[0-9a-z]{8})\.ws/g;
     const match = wsIdExpression.exec(hostname);
     if (match && match.length >= 2) {
-        return match[1];
+        return match[3];
     } else {
         return undefined;
     }

components/server/package.json

@@ -76,6 +76,7 @@
     "request": "^2.87.0",
     "request-promise": "^4.2.2",
     "swot-js": "^1.0.3",
+    "unique-names-generator": "^4.3.1",
     "uuid": "^3.1.0",
     "vscode-ws-jsonrpc": "^0.2.0",
     "ws": "^5.2.2"

components/server/src/express-util.spec.ts

@@ -13,12 +13,12 @@ const HOSTURL_HOSTNAME = "gpl-2732-ws-csrf.staging.gitpod.io";
 describe('express-util', function() {
   describe('isAllowedWebsocketDomain', function() {
     it('should return false for workspace-port locations', function() {
-      const result = isAllowedWebsocketDomain("http://3000-aee7da59-2b15-42a6-9773-2546ed487149.ws-eu.gpl-2732-ws-csrf.staging.gitpod.io", HOSTURL_HOSTNAME);
+      const result = isAllowedWebsocketDomain("http://3000-tight-moccasin-ferret-155799b3.ws-eu.gpl-2732-ws-csrf.staging.gitpod.io", HOSTURL_HOSTNAME);
       expect(result).to.be.false;
     });
 
     it('should return true for workspace locations', function() {
-      const result = isAllowedWebsocketDomain("http://aee7da59-2b15-42a6-9773-2546ed487149.ws-eu.gpl-2732-ws-csrf.staging.gitpod.io", HOSTURL_HOSTNAME);
+      const result = isAllowedWebsocketDomain("http://tight-moccasin-ferret-155799b3.ws-eu.gpl-2732-ws-csrf.staging.gitpod.io", HOSTURL_HOSTNAME);
       expect(result).to.be.true;
     });
 

components/server/src/express-util.ts

@@ -95,7 +95,7 @@ const looksLikeWorkspaceHostname = (originHostname: string, gitpodHostName: stri
         return false;
     }
 
-    return parts[0].split("-").length === 5;
+    return parts[0].split("-").length === 4;
 };
 
 export function saveSession(reqOrSession: express.Request | Express.Session): Promise<void> {

components/server/src/workspace/workspace-factory.ts

@@ -21,6 +21,7 @@ import { ImageBuilderClientProvider } from '@gitpod/image-builder/lib';
 import { TracedWorkspaceDB, DBWithTracing } from '@gitpod/gitpod-db/lib/traced-db';
 import { ImageSourceProvider } from './image-source-provider';
 import { TheiaPluginService } from '../theia-plugin/theia-plugin-service';
+import { uniqueNamesGenerator, adjectives, colors, animals } from 'unique-names-generator';
 
 @injectable()
 export class WorkspaceFactory {
@@ -188,12 +189,13 @@ export class WorkspaceFactory {
     }
 
     protected generateWorkspaceId(): string {
-        var uuid
-        do {
-            uuid = uuidv4()
-        }
-        while (uuid.charAt(0).match("[0-9]") != null)   // No numbers as first char, as we use this id as DNS name
-        return uuid
+        const randomName: string = uniqueNamesGenerator({
+            dictionaries: [adjectives, colors, animals],
+            separator: '-',
+            length: 3,
+        });
+        
+        return randomName + "-" + uuidv4().substring(0,8);
     }
 
 }

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

@@ -40,10 +40,10 @@ var (
 			IDEPublicPort: "23000",
 			InstanceID:    "1943c611-a014-4f4d-bf5d-14ccf0123c60",
 			Ports: []PortInfo{
-				{PortSpec: api.PortSpec{Port: 28080, Target: 38080, Url: "https://28080-c95fd41c-13d9-4d51-b282-e2be09de207f.test-domain.com/", Visibility: api.PortVisibility_PORT_VISIBILITY_PUBLIC}},
+				{PortSpec: api.PortSpec{Port: 28080, Target: 38080, Url: "https://28080-regional-amaranth-smelt-9ba20cc1.test-domain.com/", Visibility: api.PortVisibility_PORT_VISIBILITY_PUBLIC}},
 			},
-			URL:         "https://c95fd41c-13d9-4d51-b282-e2be09de207f.test-domain.com/",
-			WorkspaceID: "c95fd41c-13d9-4d51-b282-e2be09de207f",
+			URL:         "https://regional-amaranth-smelt-9ba20cc1.test-domain.com/",
+			WorkspaceID: "regional-amaranth-smelt-9ba20cc1",
 		},
 	}
 
@@ -413,31 +413,31 @@ func TestRoutes(t *testing.T) {
 		},
 		{
 			Desc: "non-existent authorized GET /",
-			Request: modifyRequest(httptest.NewRequest("GET", strings.ReplaceAll(workspaces[0].URL, "c95fd41c", "00000000"), nil),
+			Request: modifyRequest(httptest.NewRequest("GET", strings.ReplaceAll(workspaces[0].URL, "regional", "blabla"), nil),
 				addHostHeader,
 				addOwnerToken(workspaces[0].InstanceID, workspaces[0].Auth.OwnerToken),
 			),
 			Expectation: Expectation{
 				Status: http.StatusFound,
 				Header: http.Header{
 					"Content-Type": {"text/html; charset=utf-8"},
-					"Location":     {"https://test-domain.com/start/#00000000-13d9-4d51-b282-e2be09de207f"},
+					"Location":     {"https://test-domain.com/start/#blabla-amaranth-smelt-9ba20cc1"},
 				},
-				Body: ("<a href=\"https://test-domain.com/start/#00000000-13d9-4d51-b282-e2be09de207f\">Found</a>.\n\n"),
+				Body: ("<a href=\"https://test-domain.com/start/#blabla-amaranth-smelt-9ba20cc1\">Found</a>.\n\n"),
 			},
 		},
 		{
 			Desc: "non-existent unauthorized GET /",
-			Request: modifyRequest(httptest.NewRequest("GET", strings.ReplaceAll(workspaces[0].URL, "c95fd41c", "00000000"), nil),
+			Request: modifyRequest(httptest.NewRequest("GET", strings.ReplaceAll(workspaces[0].URL, "regional", "blabla"), nil),
 				addHostHeader,
 			),
 			Expectation: Expectation{
 				Status: http.StatusFound,
 				Header: http.Header{
 					"Content-Type": {"text/html; charset=utf-8"},
-					"Location":     {"https://test-domain.com/start/#00000000-13d9-4d51-b282-e2be09de207f"},
+					"Location":     {"https://test-domain.com/start/#blabla-amaranth-smelt-9ba20cc1"},
 				},
-				Body: ("<a href=\"https://test-domain.com/start/#00000000-13d9-4d51-b282-e2be09de207f\">Found</a>.\n\n"),
+				Body: ("<a href=\"https://test-domain.com/start/#blabla-amaranth-smelt-9ba20cc1\">Found</a>.\n\n"),
 			},
 		},
 		{

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

@@ -31,7 +31,7 @@ const (
 	// Used to communicate router error happening in the matcher with the error handler which set the code to the HTTP response
 	routerErrorCode = "routerErrorCode"
 
-	workspaceIDRegex   = "(?P<" + workspaceIDIdentifier + ">[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})"
+	workspaceIDRegex   = "(?P<" + workspaceIDIdentifier + ">[a-z]+-[a-z]+-[a-z]+-[0-9a-f]{8})"
 	workspacePortRegex = "(?P<" + workspacePortIdentifier + ">[0-9]+)-"
 )