[orgs] Persist slug

Author: AlexTugarev

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

@@ -4,11 +4,13 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
+import { list as blocklist } from "the-big-username-blacklist";
 import { Team, TeamMemberInfo, TeamMemberRole, TeamMembershipInvite, User } from "@gitpod/gitpod-protocol";
 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";
@@ -121,17 +123,37 @@ export class TeamDBImpl implements TeamDB {
         return soleOwnedTeams;
     }
 
-    public async updateTeam(teamId: string, team: Pick<Team, "name">): Promise<Team> {
+    public async updateTeam(teamId: string, team: Pick<Team, "name" | "slug">): Promise<Team> {
+        const name = team.name && team.name.trim();
+        const slug = team.slug && team.slug.trim();
+        if (!name && !slug) {
+            throw new ResponseError(ErrorCodes.BAD_REQUEST, "No update provided");
+        }
+
         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");
         }
-        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");
+
+        // 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) {
+            if (slug.length > 100) {
+                throw new ResponseError(ErrorCodes.INVALID_VALUE, "Slug must be between 1 and 100 characters long");
+            }
+            existingTeam.slug = slug;
         }
-        existingTeam.name = name;
+
         return teamRepo.save(existingTeam);
     }
 
@@ -145,8 +167,17 @@ export class TeamDBImpl implements TeamDB {
                 "Please choose a name containing only letters, numbers, -, _, ', or spaces.",
             );
         }
+        const slug = name.toLocaleLowerCase().replace(/[^a-zA-Z0-9]+/g, "-") + "-" + randomBytes(10).toString("hex");
+        if (blocklist.indexOf(slug) !== -1) {
+            throw new ResponseError(ErrorCodes.BAD_REQUEST, "Creating a team with this name is not allowed");
+        }
 
         const teamRepo = await this.getTeamRepo();
+        const existingTeam = await teamRepo.findOne({ slug, deleted: false, markedDeleted: false });
+        if (!!existingTeam) {
+            throw new ResponseError(ErrorCodes.CONFLICT, "A team with this name already exists");
+        }
+
         const team: Team = {
             id: uuidv4(),
             name,

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

@@ -2246,7 +2246,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");