Generate better workspace ids

Author: svenefftinge

components/common-go/namegen/workspaceid.go

@@ -0,0 +1,24 @@
+// Copyright (c) 2020 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package namegen_test
+
+import (
+	"testing"
+
+	"github.com/gitpod-io/gitpod/common-go/namegen"
+)
+
+func TestGenerateWorkspaceID(t *testing.T) {
+
+	for i := 0; i < 1000; i++ {
+		name, err := namegen.GenerateWorkspaceID()
+		if err != nil {
+			t.Error(err)
+		}
+		if !namegen.WorkspaceIdPattern.MatchString(name) {
+			t.Errorf("The workspace id \"%s\" didn't met the expectation.", name)
+		}
+	}
+}

components/common-go/namegen/workspaceid_test.go

@@ -11,6 +11,7 @@ import (
 	"time"
 
 	"github.com/gitpod-io/gitpod/common-go/log"
+	"github.com/gitpod-io/gitpod/common-go/namegen"
 	"github.com/gitpod-io/gitpod/common-go/util"
 	csapi "github.com/gitpod-io/gitpod/content-service/api"
 	"github.com/gitpod-io/gitpod/ws-manager/api"
@@ -241,11 +242,10 @@ func (wspd *WorkspaceManagerPrescaleDriver) startGhostWorkspaces(ctx context.Con
 		}
 		instanceID := instanceUUID.String()
 		ids[i] = instanceID
-		metaUUID, err := uuid.NewRandom()
+		metaID, err := namegen.GenerateWorkspaceID()
 		if err != nil {
 			return nil, err
 		}
-		metaID := metaUUID.String()
 
 		_, err = wspd.Client.StartWorkspace(ctx, &api.StartWorkspaceRequest{
 			Type: api.WorkspaceType_GHOST,

components/ee/ws-scheduler/pkg/scaler/driver.go

@@ -7,13 +7,13 @@
 import { PrimaryColumn, Column, Entity } from "typeorm";
 
 import { LayoutData } from "@gitpod/gitpod-protocol";
-import { TypeORM } from "../typeorm";
 import { Transformer } from "../transformer";
+import { TypeORM } from "../typeorm";
 
 @Entity()
 export class DBLayoutData implements LayoutData {
 
-    @PrimaryColumn(TypeORM.UUID_COLUMN_TYPE)
+    @PrimaryColumn(TypeORM.WORKSPACE_ID_COLUMN_TYPE)
     workspaceId: string;
 
     @Column({

components/gitpod-db/src/typeorm/entity/db-layout-data.ts

@@ -35,7 +35,7 @@ export class DBPrebuiltWorkspace implements PrebuiltWorkspace {
     })
     creationTime: string;
 
-    @Column(TypeORM.UUID_COLUMN_TYPE)
+    @Column(TypeORM.WORKSPACE_ID_COLUMN_TYPE)
     @Index('ind_buildWorkspaceId')
     buildWorkspaceId: string;
 

components/gitpod-db/src/typeorm/entity/db-prebuilt-workspace.ts

@@ -24,7 +24,7 @@ export class DBSnapshot implements Snapshot {
     })
     creationTime: string;
 
-    @Column(TypeORM.UUID_COLUMN_TYPE)
+    @Column(TypeORM.WORKSPACE_ID_COLUMN_TYPE)
     @Index("ind_originalWorkspaceId")
     originalWorkspaceId: string;
 

components/gitpod-db/src/typeorm/entity/db-snapshot.ts

@@ -18,7 +18,7 @@ export class DBWorkspaceInstance implements WorkspaceInstance {
     @PrimaryColumn(TypeORM.UUID_COLUMN_TYPE)
     id: string;
 
-    @Column(TypeORM.UUID_COLUMN_TYPE)
+    @Column(TypeORM.WORKSPACE_ID_COLUMN_TYPE)
     @Index()
     workspaceId: string;
 

components/gitpod-db/src/typeorm/entity/db-workspace-instance.ts

@@ -13,7 +13,7 @@ import { Transformer } from "../transformer";
 @Entity()
 // on DB but not Typeorm: @Index("ind_lastModified", ["_lastModified"])   // DBSync
 export class DBWorkspace implements Workspace {
-    @PrimaryColumn(TypeORM.UUID_COLUMN_TYPE)
+    @PrimaryColumn(TypeORM.WORKSPACE_ID_COLUMN_TYPE)
     id: string;
 
     @Column("varchar")

components/gitpod-db/src/typeorm/entity/db-workspace.ts

@@ -18,6 +18,10 @@ export class TypeORM {
         type: 'char',
         length: 36
     };
+    static readonly WORKSPACE_ID_COLUMN_TYPE: ColumnOptions = {
+        type: 'char',
+        length: 36
+    };
 
     static defaultOptions(dir: string): ConnectionOptions {
         console.log(`Loading TypeORM entities and migrations from ${dir}`);

components/gitpod-db/src/typeorm/typeorm.ts

@@ -12,6 +12,7 @@
     "devDependencies": {
         "@types/chai-subset": "^1.3.1",
         "@types/js-yaml": "^3.10.1",
+        "@types/random-number-csprng": "^1.0.0",
         "@types/uuid": "^3.4.5",
         "@types/ws": "^5.1.2",
         "chai": "^4.1.2",
@@ -38,6 +39,7 @@
         "js-yaml": "^3.10.0",
         "opentracing": "^0.14.4",
         "prom-client": "^10.2.0",
+        "random-number-csprng": "^1.0.2",
         "reconnecting-websocket": "^4.2.0",
         "reflect-metadata": "^0.1.10",
         "uuid": "^3.3.3",