[orgs] Persist slug

Author: AlexTugarev

components/gitpod-db/package.json

@@ -27,6 +27,7 @@
     "@jmondi/oauth2-server": "^2.6.1",
     "mysql": "^2.18.1",
     "reflect-metadata": "^0.1.13",
+    "slugify": "^1.6.5",
     "the-big-username-blacklist": "^1.5.2",
     "typeorm": "0.2.38"
   },

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

@@ -6,7 +6,6 @@
 
 import { Team } from "@gitpod/gitpod-protocol";
 import { Entity, Column, PrimaryColumn } from "typeorm";
-import { Transformer } from "../transformer";
 import { TypeORM } from "../typeorm";
 
 @Entity()
@@ -18,12 +17,8 @@ export class DBTeam implements Team {
     @Column("varchar")
     name: string;
 
-    // Deprecated.
-    @Column({
-        type: "varchar",
-        transformer: Transformer.ALWAYS_EMPTY_STRING,
-    })
-    slug: string = "";
+    @Column("varchar")
+    slug: string;
 
     @Column("varchar")
     creationTime: string;

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

@@ -9,13 +9,15 @@ import { inject, injectable } from "inversify";
 import { TypeORM } from "./typeorm";
 import { Repository } from "typeorm";
 import { v4 as uuidv4 } from "uuid";
+import { randomBytes } from "crypto";
 import { TeamDB } from "../team-db";
 import { DBTeam } from "./entity/db-team";
 import { DBTeamMembership } from "./entity/db-team-membership";
 import { DBUser } from "./entity/db-user";
 import { DBTeamMembershipInvite } from "./entity/db-team-membership-invite";
 import { ResponseError } from "vscode-jsonrpc";
 import { ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
+import slugify from "slugify";
 
 @injectable()
 export class TeamDBImpl implements TeamDB {
@@ -121,18 +123,53 @@ export class TeamDBImpl implements TeamDB {
         return soleOwnedTeams;
     }
 
-    public async updateTeam(teamId: string, team: Pick<Team, "name">): Promise<Team> {
-        const teamRepo = await this.getTeamRepo();
-        const existingTeam = await teamRepo.findOne({ id: teamId, deleted: false, markedDeleted: false });
-        if (!existingTeam) {
-            throw new ResponseError(ErrorCodes.NOT_FOUND, "Organization not found");
-        }
+    public async updateTeam(teamId: string, team: Pick<Team, "name" | "slug">): Promise<Team> {
         const name = team.name && team.name.trim();
-        if (!name || name.length === 0 || name.length > 32) {
-            throw new ResponseError(ErrorCodes.INVALID_VALUE, "The name must be between 1 and 32 characters long");
+        const slug = team.slug && team.slug.trim();
+        if (!name && !slug) {
+            throw new ResponseError(ErrorCodes.BAD_REQUEST, "No update provided");
         }
-        existingTeam.name = name;
-        return teamRepo.save(existingTeam);
+
+        // Storing entry in a TX to avoid potential slug dupes caused by racing requests.
+        const em = await this.getEntityManager();
+        return await em.transaction<DBTeam>(async (em) => {
+            const teamRepo = em.getRepository<DBTeam>(DBTeam);
+
+            const existingTeam = await teamRepo.findOne({ id: teamId, deleted: false, markedDeleted: false });
+            if (!existingTeam) {
+                throw new ResponseError(ErrorCodes.NOT_FOUND, "Organization not found");
+            }
+
+            // no changes
+            if (existingTeam.name === name && existingTeam.slug === slug) {
+                return existingTeam;
+            }
+
+            if (!!name) {
+                if (name.length > 32) {
+                    throw new ResponseError(
+                        ErrorCodes.INVALID_VALUE,
+                        "The name must be between 1 and 32 characters long",
+                    );
+                }
+                existingTeam.name = name;
+            }
+            if (!!slug && existingTeam.slug != slug) {
+                if (slug.length > 100) {
+                    throw new ResponseError(ErrorCodes.INVALID_VALUE, "Slug must be between 1 and 100 characters long");
+                }
+                if (!/^[A-Za-z0-9-]+$/.test(slug)) {
+                    throw new ResponseError(ErrorCodes.BAD_REQUEST, "Slug must contain only letters, or numbers");
+                }
+                const anotherTeamWithThatSlug = await teamRepo.findOne({ slug, deleted: false, markedDeleted: false });
+                if (anotherTeamWithThatSlug) {
+                    throw new ResponseError(ErrorCodes.INVALID_VALUE, "Slug must be unique");
+                }
+                existingTeam.slug = slug;
+            }
+
+            return teamRepo.save(existingTeam);
+        });
     }
 
     public async createTeam(userId: string, name: string): Promise<Team> {
@@ -146,13 +183,27 @@ export class TeamDBImpl implements TeamDB {
             );
         }
 
-        const teamRepo = await this.getTeamRepo();
-        const team: Team = {
-            id: uuidv4(),
-            name,
-            creationTime: new Date().toISOString(),
-        };
-        await teamRepo.save(team);
+        let slug = slugify(name, { lower: true });
+
+        // Storing new entry in a TX to avoid potential dupes caused by racing requests.
+        const em = await this.getEntityManager();
+        const team = await em.transaction<DBTeam>(async (em) => {
+            const teamRepo = em.getRepository<DBTeam>(DBTeam);
+
+            const existingTeam = await teamRepo.findOne({ slug, deleted: false, markedDeleted: false });
+            if (!!existingTeam) {
+                slug = slug + "-" + randomBytes(4).toString("hex");
+            }
+
+            const team: Team = {
+                id: uuidv4(),
+                name,
+                slug,
+                creationTime: new Date().toISOString(),
+            };
+            return await teamRepo.save(team);
+        });
+
         const membershipRepo = await this.getMembershipRepo();
         await membershipRepo.save({
             id: uuidv4(),

components/gitpod-protocol/src/gitpod-service.ts

@@ -174,7 +174,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
 
     // Teams
     getTeam(teamId: string): Promise<Team>;
-    updateTeam(teamId: string, team: Pick<Team, "name">): Promise<Team>;
+    updateTeam(teamId: string, team: Pick<Team, "name" | "slug">): Promise<Team>;
     getTeams(): Promise<Team[]>;
     getTeamMembers(teamId: string): Promise<TeamMemberInfo[]>;
     createTeam(name: string): Promise<Team>;

components/gitpod-protocol/src/teams-projects-protocol.ts

@@ -135,6 +135,7 @@ export type Team = Organization;
 export interface Organization {
     id: string;
     name: string;
+    slug?: string;
     creationTime: string;
     markedDeleted?: boolean;
     /** This is a flag that triggers the HARD DELETION of this entity */

components/server/src/workspace/gitpod-server-impl.ts

@@ -2243,7 +2243,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         return team;
     }
 
-    public async updateTeam(ctx: TraceContext, teamId: string, team: Pick<Team, "name">): Promise<Team> {
+    public async updateTeam(ctx: TraceContext, teamId: string, team: Pick<Team, "name" | "slug">): Promise<Team> {
         traceAPIParams(ctx, { teamId });
         this.checkUser("updateTeam");
 

yarn.lock

@@ -16257,6 +16257,11 @@ slice-ansi@^4.0.0:
     astral-regex "^2.0.0"
     is-fullwidth-code-point "^3.0.0"
 
+slugify@^1.6.5:
+  version "1.6.5"
+  resolved "https://registry.yarnpkg.com/slugify/-/slugify-1.6.5.tgz#c8f5c072bf2135b80703589b39a3d41451fbe8c8"
+  integrity sha512-8mo9bslnBO3tr5PEVFzMPIWwWnipGS0xVbYf65zxDqfNwmzYn1LpiKNrR6DlClusuvo+hDHd1zKpmfAe83NQSQ==
+
 snakeize@^0.1.0:
   version "0.1.0"
   resolved "https://registry.npmjs.org/snakeize/-/snakeize-0.1.0.tgz"